[No QA] Lint bash scripts with shellcheck #13387

roryabraham · 2022-12-07T01:32:39Z

Details

This PR sets up a linter for bash scripts (using ShellCheck, which we also use for other repos such as Ops-Configs) to avoid common errors and help promote a more consistent bash style.

Fixed Issues

$ n/a

Tests

Run npm run shellcheck – the tests should pass.
Put a lint error in a shell script, most easily done by removing double quote wrappers from a variable used as a string.
Run npm run shellcheck – the tests should fail.
Remove the lint error.
Run npm run shellcheck – the tests should pass.
For good measure, also run ./scripts/shellCheck.sh from the root, and it should pass.
Run cd scripts && ./shellCheck.sh && cd .., the tests should pass.
Run cd .github && ../scripts/shellCheck.sh && cd .., the tests should pass.

Verify that no errors appear in the JS console

Offline tests

None.

QA Steps

None

PR Author Checklist

I linked the correct issue in the ### Fixed Issues section above
I wrote clear testing steps that cover the changes made in this PR
- I added steps for local testing in the Tests section
- I added steps for the expected offline behavior in the Offline steps section
- I added steps for Staging and/or Production testing in the QA steps section
- I added steps to cover failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
- I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
- I tested this PR with a High Traffic account against the staging or production API to ensure there are no regressions (e.g. long loading states that impact usability).
I included screenshots or videos for tests on all platforms
I ran the tests on all platforms & verified they passed on:
- iOS / native
- Android / native
- iOS / Safari
- Android / Chrome
- MacOS / Chrome
- MacOS / Desktop
I verified there are no console errors (if there's a console error not related to the PR, report it or open an issue for it to be fixed)
I followed proper code patterns (see Reviewing the code)
- I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick)
- I verified that comments were added to code that is not self explanatory
- I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
- I verified any copy / text shown in the product was added in all src/languages/* files
- I verified any copy / text that was added to the app is correct English and approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
- I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
- I verified the JSDocs style guidelines (in STYLE.md) were followed
If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
I followed the guidelines as stated in the Review Guidelines
I tested other components that can be impacted by my changes (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar are working as expected)
I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
I verified any variables that can be defined as constants (ie. in CONST.js or at the top of the file that uses the constant) are defined as such
I verified that if a function's arguments changed that all usages have also been updated correctly
If a new component is created I verified that:
- A similar component doesn't exist in the codebase
- All props are defined accurately and each prop has a /** comment above it */
- The file is named correctly
- The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
- The only data being stored in the state is data necessary for rendering and nothing else
- For Class Components, any internal methods passed to components event handlers are bound to this properly so there are no scoping issues (i.e. for onClick={this.submit} the method this.submit should be bound to this in the constructor)
- Any internal methods bound to this are necessary to be bound (i.e. avoid this.submit = this.submit.bind(this); if this.submit is never passed to a component event handler like onClick)
- All JSX used for rendering exists in the render method
- The component has the minimum amount of code necessary for its purpose, and it is broken down into smaller components in order to separate concerns and functions
If a new CSS style is added I verified that:
- A similar style doesn't already exist
- The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(themeColors.componentBG)
If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
I have checked off every checkbox in the PR author checklist, including those that don't apply to this PR.

Screenshots/Videos

melvin-bot · 2022-12-07T01:37:25Z

@marcaaron Please copy/paste the Reviewer Checklist from here into a new comment on this PR and complete it. If you have the K2 extension, you can simply click: [this button]

marcaaron · 2022-12-07T20:30:27Z

Looking at this now.

marcaaron · 2022-12-07T20:32:32Z

I'm not sure if this means the tests are passing or not... @roryabraham can you please advise?

➜  App git:(Rory-ShellCheck) npm run shellcheck

> new.expensify@1.2.36-2 shellcheck
> ./scripts/shellCheck.sh

👀 Linting the following shell scripts using ShellCheck: ./.husky/_/husky.sh
./tests/unit/getPullRequestsMergedBetweenTest.sh
./scripts/shellCheck.sh
./scripts/build-desktop.sh
./scripts/set-pusher-suffix.sh
./scripts/shellUtils.sh
./.github/scripts/validateActionsAndWorkflows.sh
./.github/scripts/verifyPodfile.sh
./.github/scripts/buildActions.sh
./.github/scripts/verifyActions.sh


In ./.husky/_/husky.sh line 9:
  readonly hook_name="$(basename -- "$0")"
           ^-------^ SC2155 (warning): Declare and assign separately to avoid masking return values.


In ./.husky/_/husky.sh line 19:
    . ~/.huskyrc
      ^--------^ SC1090 (warning): ShellCheck can't follow non-constant source. Use a directive to specify location.

For more information:
  https://www.shellcheck.net/wiki/SC1090 -- ShellCheck can't follow non-const...
  https://www.shellcheck.net/wiki/SC2155 -- Declare and assign separately to ...
➜  App git:(Rory-ShellCheck)

This happens for me while executing step 1

roryabraham · 2022-12-07T20:40:29Z

Oh, @marcaaron that looks like a failure, but I don't have anything in Expensidev/App/.husky. Do you use husky for pre-commit hooks?

I think probably the best solution then would be to just ignore the .husky directory.

marcaaron · 2022-12-07T20:47:47Z

I don't even know what a husky is or how it got on my computer 🐶

marcaaron · 2022-12-07T20:50:14Z

Last step failed for me:

➜  App git:(Rory-ShellCheck) vssh ./scripts/shellCheck.sh
👀 Linting the following shell scripts using ShellCheck: ./tests/unit/getPullRequestsMergedBetweenTest.sh
./scripts/shellCheck.sh
./scripts/build-desktop.sh
./scripts/set-pusher-suffix.sh
./scripts/shellUtils.sh
./.github/scripts/validateActionsAndWorkflows.sh
./.github/scripts/verifyPodfile.sh
./.github/scripts/buildActions.sh
./.github/scripts/verifyActions.sh

/vagrant/App/node_modules/.bin/shellcheck: 1: Syntax error: "(" unexpected
/vagrant/App/node_modules/.bin/shellcheck: 1: Syntax error: "(" unexpected
/vagrant/App/node_modules/.bin/shellcheck: 1: Syntax error: "(" unexpected
/vagrant/App/node_modules/.bin/shellcheck: 1: Syntax error: "(" unexpected
/vagrant/App/node_modules/.bin/shellcheck: 1: Syntax error: "(" unexpected
/vagrant/App/node_modules/.bin/shellcheck: 1: Syntax error: "(" unexpected
/vagrant/App/node_modules/.bin/shellcheck: 1: Syntax error: "(" unexpected
/vagrant/App/node_modules/.bin/shellcheck: 1: Syntax error: "(" unexpected
/vagrant/App/node_modules/.bin/shellcheck: 1: Syntax error: "(" unexpected
➜  App git:(Rory-ShellCheck)

roryabraham · 2022-12-07T21:26:34Z

@marcaaron I think that last step failure you were seeing is probably because node modules were not installed inside the VM. The whole point of that last step was to ensure that this script works on Linux (so that we know it will also work in the GitHub Actions runner). Given that we can see it working correctly in an ubuntu here, we are safe to remove that testing step.

roryabraham · 2022-12-07T21:27:39Z

Removed that last failing test step since it wasn't needed and also made it more obvious how to add more directories to ignore in the future by moving them into an array.

marcaaron · 2022-12-07T21:38:32Z

Reviewer Checklist

I have verified the author checklist is complete (all boxes are checked off).
I verified the correct issue is linked in the ### Fixed Issues section above
I verified testing steps are clear and they cover the changes made in this PR
- I verified the steps for local testing are in the Tests section
- I verified the steps for Staging and/or Production testing are in the QA steps section
- I verified the steps cover any possible failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
- I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
I checked that screenshots or videos are included for tests on all platforms
I included screenshots or videos for tests on all platforms
I verified tests pass on all platforms & I tested again on:
- iOS / native
- Android / native
- iOS / Safari
- Android / Chrome
- MacOS / Chrome
- MacOS / Desktop
If there are any errors in the console that are unrelated to this PR, I either fixed them (preferred) or linked to where I reported them in Slack
I verified proper code patterns were followed (see Reviewing the code)
- I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick).
- I verified that comments were added to code that is not self explanatory
- I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
- I verified any copy / text shown in the product was added in all src/languages/* files
- I verified any copy / text that was added to the app is correct English and approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
- I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
- I verified the JSDocs style guidelines (in STYLE.md) were followed
If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
I verified that this PR follows the guidelines as stated in the Review Guidelines
I verified other components that can be impacted by these changes have been tested, and I retested again (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar have been tested & I retested again)
I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
I verified any variables that can be defined as constants (ie. in CONST.js or at the top of the file that uses the constant) are defined as such
If a new component is created I verified that:
- A similar component doesn't exist in the codebase
- All props are defined accurately and each prop has a /** comment above it */
- The file is named correctly
- The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
- The only data being stored in the state is data necessary for rendering and nothing else
- For Class Components, any internal methods passed to components event handlers are bound to this properly so there are no scoping issues (i.e. for onClick={this.submit} the method this.submit should be bound to this in the constructor)
- Any internal methods bound to this are necessary to be bound (i.e. avoid this.submit = this.submit.bind(this); if this.submit is never passed to a component event handler like onClick)
- All JSX used for rendering exists in the render method
- The component has the minimum amount of code necessary for its purpose, and it is broken down into smaller components in order to separate concerns and functions
If a new CSS style is added I verified that:
- A similar style doesn't already exist
- The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(themeColors.componentBG)
If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Web

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

OSBotify · 2022-12-07T21:44:50Z

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

neil-marcellini · 2022-12-08T23:29:21Z

scripts/set-pusher-suffix.sh

@@ -6,7 +6,7 @@ CONFIG_FILE="../Web-Expensify/_config.local.php"

 if [ -f ".env" ]; then
    # Export vars from the .env file to access the $EXPENSIFY_URL
-    export $(grep -v '^#' .env | xargs)
+    export "$(grep -v '^#' .env | xargs)"


@roryabraham adding the quotes broke this. Can we make this work and make the linter happy?

@neil-marcellini Sorry about that ... created a PR here that should fix it. It's a bit more verbose but in my opinion also a bit clearer what it's doing. We can clean up and merge that PR or remove the quotes and suppress the warning. I'm good with either approach.

OSBotify · 2022-12-13T22:38:44Z

🚀 Deployed to production by @chiragsalian in version: 1.2.38-6 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	success ✅
🕸 web 🕸	success ✅

roryabraham added 6 commits December 6, 2022 16:37

Install shellcheck npm wrapper as a dev dependency

d899813

Add shellCheck script

9fad811

Add proper handling of exit code

ec1f277

Add shellcheck to lint workflow

b212e02

Fix shellcheck linter warnings

d9f5d05

Add nicer output

0eb1450

roryabraham self-assigned this Dec 7, 2022

Add names to steps in lint workflow

9bb94d3

roryabraham marked this pull request as ready for review December 7, 2022 01:36

roryabraham requested a review from a team as a code owner December 7, 2022 01:36

melvin-bot bot removed the request for review from a team December 7, 2022 01:37

melvin-bot bot requested a review from marcaaron December 7, 2022 01:37

roryabraham mentioned this pull request Dec 7, 2022

[NoQA] Web job for the testBuild workflow #13354

Merged

53 tasks

AndrewGable previously approved these changes Dec 7, 2022

View reviewed changes

Add husky to ignored directories

6255829

roryabraham dismissed AndrewGable’s stale review via 6255829 December 7, 2022 20:42

roryabraham added 2 commits December 7, 2022 12:54

Make DIRECTORIES_TO_IGNORE into an array

1400dd7

Fix word splitting

ad4024c

roryabraham requested a review from AndrewGable December 7, 2022 21:26

add more examples to join_by_string

59b7c9d

marcaaron approved these changes Dec 7, 2022

View reviewed changes

marcaaron merged commit 4ffd3c3 into main Dec 7, 2022

marcaaron deleted the Rory-ShellCheck branch December 7, 2022 21:40

francoisl mentioned this pull request Dec 8, 2022

Deploy Checklist: New Expensify 2022-12-07 #13431

Closed

72 tasks

neil-marcellini reviewed Dec 8, 2022

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[No QA] Lint bash scripts with shellcheck #13387

[No QA] Lint bash scripts with shellcheck #13387

roryabraham commented Dec 7, 2022 •

edited

Loading

melvin-bot bot commented Dec 7, 2022

marcaaron commented Dec 7, 2022

marcaaron commented Dec 7, 2022

roryabraham commented Dec 7, 2022

marcaaron commented Dec 7, 2022

marcaaron commented Dec 7, 2022

roryabraham commented Dec 7, 2022

roryabraham commented Dec 7, 2022 •

edited

Loading

marcaaron commented Dec 7, 2022 •

edited

Loading

OSBotify commented Dec 7, 2022

neil-marcellini Dec 8, 2022

roryabraham Dec 10, 2022

OSBotify commented Dec 13, 2022

[No QA] Lint bash scripts with shellcheck #13387

[No QA] Lint bash scripts with shellcheck #13387

Conversation

roryabraham commented Dec 7, 2022 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Dec 7, 2022

marcaaron commented Dec 7, 2022

marcaaron commented Dec 7, 2022

roryabraham commented Dec 7, 2022

marcaaron commented Dec 7, 2022

marcaaron commented Dec 7, 2022

roryabraham commented Dec 7, 2022

roryabraham commented Dec 7, 2022 • edited Loading

marcaaron commented Dec 7, 2022 • edited Loading

Reviewer Checklist

Screenshots/Videos

OSBotify commented Dec 7, 2022

neil-marcellini Dec 8, 2022

Choose a reason for hiding this comment

roryabraham Dec 10, 2022

Choose a reason for hiding this comment

OSBotify commented Dec 13, 2022

roryabraham commented Dec 7, 2022 •

edited

Loading

roryabraham commented Dec 7, 2022 •

edited

Loading

marcaaron commented Dec 7, 2022 •

edited

Loading