[FAB-15316] Shellcheck script improvements

- get git changes in last commit without using commit shas - stop using backticks for execution - use grep -Ev instead of piping through multiple grep commands - consolidate filter logic to one function in scripts/check_license - consolidate filter logic in scripts/check_spelling - this is in one commit in a series of commits for FAB-15316 Change-Id: I45f81913acc408fbe2c698bb3c2ec58005bdf0d9 Signed-off-by: Swetha Repakula <[email protected]>
CanisMinor-1037 · May 24, 2019 · 8379122 · 8379122
1 parent b58b76e
commit 8379122
Show file tree

Hide file tree

Showing 2 changed files with 48 additions and 42 deletions.
diff --git a/scripts/check_license.sh b/scripts/check_license.sh
@@ -5,52 +5,55 @@
 # SPDX-License-Identifier: Apache-2.0
 #
 
-function filterGeneratedFiles {
-    for f in $@; do
-        head -n2 $f | grep -qE '// Code generated by' || echo $f
-    done
-}
+function filterExcludedAndGeneratedFiles {
+    excluded_files=(
+        '\.block$'
+        '^\.build/'
+        'ci\.properties'
+        '^\.git/'
+        '\.gen\.go$'
+        '^Gopkg\.lock$'
+        '\.key$'
+        '^LICENSE$'
+        '\.md$'
+        '\.pb\.go$'
+        '\.pem$'
+        '\.png$'
+        '\.pptx$'
+        '\.rst$'
+        '_sk$'
+        '\.tx$'
+        '\.txt$'
+        'testdata\/'
+        '^vendor\/'
+    )
+
+    local filter
+    filter=$(local IFS='|' ; echo "${excluded_files[*]}")
 
-function filterExcludedFiles {
-    CHECK=`echo "$CHECK" \
-        | grep -v "^\.git/" \
-        | grep -v "^\.build/" \
-        | grep -v "^vendor/" \
-        | grep -v "testdata/" \
-        | grep -v "^LICENSE$" \
-        | grep -v "\.png$" \
-        | grep -v "\.rst$" \
-        | grep -v "\.txt$" \
-        | grep -v "\.pem$" \
-        | grep -v "\.block$" \
-        | grep -v "\.tx$" \
-        | grep -v "_sk$" \
-        | grep -v "\.key$" \
-        | grep -v "\.gen\.go$" \
-        | grep -v "^Gopkg\.lock$" \
-        | grep -v "\.md$" \
-        | grep -v "\.pb\.go$" \
-        | grep -v "\.pptx$" \
-        | grep -v "ci.properties" \
-        | sort -u`
+    read -ra files <<<"$@"
+    for f in "${files[@]}"; do
+        file=$(echo "$f" | grep -Ev "$filter" | sort -u)
 
-    CHECK=$(filterGeneratedFiles "$CHECK")
+        if [ -n "$file" ]; then
+            head -n2 "$file" | grep -qE '// Code generated by' || echo "$file"
+        fi
+    done
 }
 
-CHECK=$(git diff --name-only --diff-filter=ACMRTUXB HEAD)
-filterExcludedFiles
+CHECK=$(git diff --name-only --diff-filter=ACMRTUXB HEAD | tr '\n' ' ')
 if [[ -z "$CHECK" ]]; then
-    LAST_COMMITS=($(git log -2 --pretty=format:"%h"))
-    CHECK=$(git diff-tree --no-commit-id --name-only --diff-filter=ACMRTUXB -r ${LAST_COMMITS[1]} ${LAST_COMMITS[0]})
-    filterExcludedFiles
+    CHECK=$(git diff-tree --no-commit-id --name-only --diff-filter=ACMRTUXB -r "HEAD^..HEAD" | tr '\n' ' ')
 fi
 
-if [[ -z "$CHECK" ]]; then
+FILTERED=$(filterExcludedAndGeneratedFiles "$CHECK")
+
+if [[ -z "$FILTERED" ]]; then
     echo "All files are excluded from having license headers"
     exit 0
 fi
 
-missing=`echo "$CHECK" | xargs ls -d 2>/dev/null | xargs grep -L "SPDX-License-Identifier"`
+missing=$(echo "$FILTERED" | sort -u |  xargs ls -d 2>/dev/null | xargs grep -L "SPDX-License-Identifier")
 if [[ -z "$missing" ]]; then
     echo "All files have SPDX-License-Identifier headers"
     exit 0
@@ -63,7 +66,7 @@ echo "SPDX-License-Identifier: Apache-2.0"
 
 echo
 echo "Checking committed files for traditional Apache License headers ..."
-missing=`echo "$missing" | xargs ls -d 2>/dev/null | xargs grep -L "http://www.apache.org/licenses/LICENSE-2.0"`
+missing=$(echo "$missing" | xargs ls -d 2>/dev/null | xargs grep -L "http://www.apache.org/licenses/LICENSE-2.0")
 if [[ -z "$missing" ]]; then
     echo "All remaining files have Apache 2.0 headers"
     exit 0

diff --git a/scripts/check_spelling.sh b/scripts/check_spelling.sh
@@ -5,17 +5,20 @@
 # SPDX-License-Identifier: Apache-2.0
 #
 
-CHECK=$(git diff --name-only HEAD * | grep -v .png$ | grep -v .git | grep -v ^CHANGELOG \
-| grep -v ^vendor/ | grep -v ^build/ | sort -u)
+filter() {
+    while read -r data; do
+        grep -Ev '^CHANGELOG|\.git|\.png$|^vendor/' <<< "$data"
+    done
+}
+
+CHECK=$(git diff --name-only HEAD -- * | filter)
 
 if [[ -z "$CHECK" ]]; then
-    CHECK=$(git diff-tree --no-commit-id --name-only -r $(git log -2 \
-    --pretty=format:"%h") | grep -v .png$ | grep -v .git | grep -v ^CHANGELOG \
-    | grep -v ^vendor/ | grep -v ^build/ | sort -u)
+    CHECK=$(git diff-tree --no-commit-id --name-only -r HEAD^..HEAD | filter)
 fi
 
 echo "Checking changed go files for spelling errors ..."
-errs=`echo $CHECK | xargs misspell -source=text`
+errs=$(echo "$CHECK" | xargs misspell -source=text)
 if [ -z "$errs" ]; then
     echo "spell checker passed"
     exit 0