Merge pull request #1480 from adamjstewart/features/run-flake8

Various improvements to run-flake8

share/spack/qa/run-flake8

@@ -2,11 +2,6 @@
 #
 # This script runs source code style checks on Spack.
 #
-# It should be executed from the top-level directory of the repo,
-# e.g.:
-#
-#    share/spack/qa/run-flake8
-#
 # To run it, you'll need to have the Python flake8 installed locally.
 #
 PYTHONPATH=./lib/spack:$PYTHONPATH
@@ -17,11 +12,33 @@ if [[ ! $flake8 ]]; then
     exit 1
 fi
 
-# Check if changed files are flake8 conformant [framework]
-changed=$(git diff --name-only --find-renames develop... | grep '.py$')
+# Move to Spack root; allows script to be run from anywhere
+cd "$(dirname "$0")/../../.."
+
+# Add changed files that have been committed since branching off of develop
+changed=($(git diff --name-only --find-renames develop... -- '*.py'))
+# Add changed files that have been staged but not yet committed
+changed+=($(git diff --name-only --find-renames --cached -- '*.py'))
+# Add changed files that are unstaged
+changed+=($(git diff --name-only --find-renames -- '*.py'))
+
+# Ensure that each file in the array is unique
+changed=($(printf '%s\n' "${changed[@]}" | sort -u))
+
+function cleanup {
+    # Restore original package files after modifying them.
+    for file in "${changed[@]}"; do
+        if [[ -e "${file}.sbak~" ]]; then
+            mv "${file}.sbak~" "${file}"
+        fi
+    done
+}
+
+# Cleanup temporary files upon exit or when script is killed
+trap cleanup EXIT SIGINT SIGTERM
 
 # Add approved style exemptions to the changed packages.
-for file in $changed; do
+for file in "${changed[@]}"; do
     # Make a backup to restore later
     cp "$file" "$file.sbak~"
 
@@ -47,29 +64,21 @@ for file in $changed; do
     perl -i -pe 's/^(.*(https?|file)\:.*)$/\1  # NOQA: ignore=E501/' $file
 done
 
-return_code=0
-if [[ $changed ]]; then
+if [[ "${changed[@]}" ]]; then
     echo =======================================================
     echo  flake8: running flake8 code checks on spack.
     echo
     echo  Modified files:
-    echo  $changed | perl -pe 's/^/  /;s/ +/\n  /g'
+    echo  "${changed[@]}" | perl -pe 's/^/  /;s/ +/\n  /g'
     echo =======================================================
-    if flake8 --format pylint $changed; then
+    if flake8 --format pylint "${changed[@]}"; then
         echo "Flake8 checks were clean."
     else
         echo "Flake8 found errors."
-        return_code=1
+        exit 1
     fi
 else
     echo No core framework files modified.
 fi
 
-# Restore original package files after modifying them.
-for file in $changed; do
-    if [[ -e "${file}.sbak~" ]]; then
-        mv "${file}.sbak~" "${file}"
-    fi
-done
-
-exit $return_code
+exit 0