Fix install script's check for previous installation #189
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The "template" installation script stored in this repository prints advice to the user about adding the installation to their PATH environment variable. This advice is adjusted according to whether a previous installation was found in the PATH and according to the path(s) of their installation(s) so it is fairly complex. For this reason, it will be good to have a check in the "Test install script" CI workflow to ensure the output is as expected.
The "template" installation script stored in this repository checks for an existing installation in the PATH in order to provide appropriate advice to the user about adding the installation to their their PATH environment variable. This check is done using `command -v`. It turns out that the exit status is shell dependent in the event the command is not found, so that it might be either 1 or 127 depending on the user's system. The script previously assumed that the exit status would be 1 when the command was not found in PATH, which resulted in spurious advice under these conditions: ``` An existing arduino-lint was found at . Please prepend "/home/runner/work/tooling-project-assets/tooling-project-assets/bin" to your $PATH or remove the existing one. ``` It seems safest to invert the logic so that the advice about an existing installation in PATH is only printed when one was found.
The "template" installation script stored in this repository checks for an existing installation in the PATH in order to provide appropriate advice to the user about adding the installation to their their PATH environment variable. This check is done by checking the exit status of `command -v`. The previous use of `$?` for that check was unnecessary since the command itself can be checked. This change is required for compliance with ShellCheck rule SC2181: https://github.com/koalaman/shellcheck/wiki/SC2181
per1234
added
type: imperfection
silvanocerza
approved these changes
Dec 20, 2021
This was referenced Dec 20, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The "template" installation script stored in this repository checks for an existing installation in the
PATHin order to provide appropriate advice to the user about adding the installation to their theirPATHenvironment variable.This check is done using
command -v. It turns out that the exit status is shell dependent in the event the command is not found, so that it might be either1or127depending on the user's system. The script previously assumed that the exit status would be1when the command was not found inPATH, which resulted in spurious advice under these conditions:https://github.com/arduino/tooling-project-assets/runs/4556007479?check_suite_focus=true#step:4:13
It seems safest to fix this by inverting the logic so that the advice about an existing installation in
PATHis only printed when one was found.Originally reported at https://forum.arduino.cc/t/failing-to-instlal-arduino-cli-on-raspberry/936871