-
Notifications
You must be signed in to change notification settings - Fork 9
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #26 from kdelange/master
shellcheck updates
- Loading branch information
Showing
21 changed files
with
587 additions
and
386 deletions.
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| #!/bin/bash | ||
|
|
||
| echo '#####################################################################################' | ||
| echo ' Bash code must be indented with TABs. Checking for lines indented with spaces ... ' | ||
| echo '#####################################################################################' | ||
| grep -n '^[[:space:]]* [[:space:]]*' "${WORKSPACE:-../}"/protocols/*.*sh | ||
| grep_exit_status="${?}" | ||
| if [[ "${grep_exit_status}" -eq 0 ]]; then | ||
| echo '#####################################################################################' | ||
| echo ' ERROR: found Bash files containing lines (partially) indented with spaces.' | ||
| echo '#####################################################################################' | ||
| exit 1 | ||
| elif [[ "${grep_exit_status}" -eq 1 ]]; then | ||
| echo ' Ok: all Bash files indented with TABs.' | ||
| echo '####################################################################################' | ||
| exit 0 | ||
| else | ||
| echo ' FAILED: indentation sanity check failed.' | ||
| echo '####################################################################################' | ||
| exit 1 | ||
| fi |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,104 @@ | ||
| #!/bin/bash | ||
|
|
||
| # | ||
| # Disable some shellcheck warnings: | ||
| # * SC2004: $/${} is unnecessary on arithmetic variables. | ||
| # But for consistency we prefer to always use ${} anyway. | ||
| # * SC2015: Note that A && B || C is not if-then-else. C may run when A is true. | ||
| # We know and use this construct regularly to create "transactions" | ||
| # where C is only executed when both A and B have succeeded. | ||
| # | ||
| export SHELLCHECK_OPTS="-e SC2004 -e SC2015" | ||
|
|
||
| function showHelp() { | ||
| # | ||
| # Display commandline help on STDOUT. | ||
| # | ||
| cat <<EOH | ||
| =============================================================================================================== | ||
| Script for sanity checking of Bash code of this repo using ShellCheck. | ||
| Usage: | ||
| $(basename "${0}") OPTIONS | ||
| Options: | ||
| -h Show this help. | ||
| -v Enables verbose output. | ||
| =============================================================================================================== | ||
| EOH | ||
| exit 0 | ||
| } | ||
|
|
||
|
|
||
| # | ||
| # Parse commandline options | ||
| # | ||
| while getopts "hv" opt | ||
| do | ||
| case "${opt}" in | ||
| h) | ||
| showHelp | ||
| ;; | ||
| v) | ||
| verbose='1' | ||
| ;; | ||
| \?) | ||
| printf '%s\n' "FATAL: Invalid option -${OPTARG}. Try $(basename "${0}") -h for help." | ||
| exit 1 | ||
| ;; | ||
| :) | ||
| printf '%s\n' "FATAL: Option -${OPTARG} requires an argument. Try $(basename "${0}") -h for help." | ||
| exit 1 | ||
| ;; | ||
| *) | ||
| printf '%s\n' "FATAL Unhandled option. Try $(basename "${0}") -h for help." | ||
| exit 1 | ||
| ;; | ||
| esac | ||
| done | ||
|
|
||
| # | ||
| # Check if ShellCheck is installed. | ||
| # | ||
| which shellcheck 2>&1 >/dev/null \ | ||
| || { | ||
| printf '%s\n' 'FATAL: cannot find shellcheck; make sure it is installed and can be found in ${PATH}.' | ||
| exit 1 | ||
| } | ||
|
|
||
| # | ||
| # Run ShellCheck for all Bash scripts in the bin/ subdir. | ||
| # * Includes sourced files, so the libraries from the lib/ subfolder | ||
| # are checked too as long a they are used in at least one script. | ||
| # * Select format and output based on whether this script is | ||
| # executed by Jenkins or by a regular user. | ||
| # | ||
| if [[ -n "${WORKSPACE:-}" ]] | ||
| then | ||
| # | ||
| # Exclude SC2154 (warning for variables that are referenced but not assigned), | ||
| # because we cannot easily resolve variables sourced from etc/*.cfg config files. | ||
| # | ||
| export SHELLCHECK_OPTS="${SHELLCHECK_OPTS} -e SC2154" | ||
| # | ||
| # ShellCheck for Jenkins. | ||
| # | ||
| shellcheck -a -x -o all -f checkstyle "${WORKSPACE}"/protocols/*.sh | tee checkstyle-result.xml | ||
| # | ||
| # Reformat the generated report to add hyperlinks to the ShellCheck issues on the wiki: | ||
| # https://github.com/koalaman/shellcheck/wiki/SC${ISSUENUMBER} | ||
| # explaining whatis wrong with the code / style and how to improve it. | ||
| # | ||
| perl -pi -e "s|message='([^']+)'\s+source='ShellCheck.(SC[0-9]+)'|message='<a href="https://github.com/koalaman/shellcheck/wiki/\$2">\$2: \$1</a>' source='ShellCheck.\$2'|" checkstyle-result.xml | ||
| else | ||
| # | ||
| # ShellCheck for regular user on the commandline. | ||
| # | ||
| MYDIR="$(cd -P "$(dirname "${0}")" && pwd)" | ||
| if [[ "${verbose:-0}" -eq 1 ]] | ||
| then | ||
| cd "${MYDIR}/.." | ||
| shellcheck -a -x -o all -f tty protocols/*.sh # cannot use the printf construct used below for non-vebose output as it destroys the terminal colors. | ||
| cd '-' # Goes back to previous directory before we changed to ${MYDIR}. | ||
| else | ||
| printf '%s\n' "$(cd "${MYDIR}/.." && shellcheck -a -x -o all -f gcc protocols/*.sh)" | ||
| fi | ||
| fi |
This file was deleted.
Oops, something went wrong.
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
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
Oops, something went wrong.