Merge pull request #1119 from berquist/summer-cleaning

Set up pre-commit and apply fixes

.git-blame-ignore-revs

@@ -8,3 +8,5 @@ e5f8163d5e58fff75ab276418686353a52977727
 bf8f1ee98d609edc5b4255eb0f39574ca8392772
 # Indentation
 a278d60eb48a083919b18c1918af574f683e4acc
+# pre-commit fixes
+1fbf9b9d7c1d76a1191eaa11ad23e67506103225

.github/workflows/pre-commit.yml

@@ -0,0 +1,16 @@
+---
+# In the absence of using the pre-commit.ci service...
+name: pre-commit
+
+# yamllint disable-line rule:truthy
+on:
+  pull_request:
+  push:
+
+jobs:
+  pre-commit:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v3
+      - uses: pre-commit/action@v3.0.0

.pre-commit-config.yaml

@@ -0,0 +1,62 @@
+---
+fail_fast: false
+repos:
+  - repo: meta
+    hooks:
+      - id: check-hooks-apply
+      - id: check-useless-excludes
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: "v4.6.0"
+    hooks:
+      - id: check-added-large-files
+      - id: check-case-conflict
+      - id: check-merge-conflict
+      - id: check-yaml
+      - id: end-of-file-fixer
+      - id: fix-byte-order-marker
+      - id: mixed-line-ending
+        args: [--fix, "lf"]
+      - id: no-commit-to-branch
+        args: [--branch, main, --branch, master, --branch, devel]
+      - id: trailing-whitespace
+        exclude: |
+          (?x)(
+              \.diff$|
+              \.patch$
+          )
+  - repo: https://github.com/adrienverge/yamllint
+    rev: "v1.35.1"
+    hooks:
+      - id: yamllint
+  - repo: https://github.com/shellcheck-py/shellcheck-py
+    rev: v0.10.0.1
+    hooks:
+      - id: shellcheck
+        exclude: |
+          (?x)(
+              buildsys/bamboo.sh|
+              buildsys/deps/bin/sstDep_dramsim3_stabledevel.sh|
+              buildsys/deps/bin/sstDep_dramsim_masterlatest.sh|
+              buildsys/deps/bin/sstDep_dramsim_r4b00b22.sh|
+              buildsys/deps/bin/sstDep_dramsim_stabledevel.sh|
+              buildsys/deps/bin/sstDep_dramsim_static.sh|
+              buildsys/deps/bin/sstDep_dramsim_v2.2.1.sh|
+              buildsys/deps/bin/sstDep_dramsim_v2.2.2.sh|
+              buildsys/deps/bin/sstDep_dramsim_v2.2.sh|
+              buildsys/deps/bin/sstDep_goblin_hmcsim_stabledevel.sh|
+              buildsys/deps/bin/sstDep_GPGPUSim.sh|
+              buildsys/deps/bin/sstDep_hbm_dramsim2_stabledevel.sh|
+              buildsys/deps/bin/sstDep_hybridsim.sh|
+              buildsys/deps/bin/sstDep_nvdimmsim.sh|
+              buildsys/deps/bin/sstDep_ramulator_stabledevel.sh|
+              test/utilities/shunit2/|
+              test/include/testSubroutines.sh|
+              test/testSuites/testSuite_gpgpu.sh|
+              test/testSuites/testSuite_macro.sh|
+              test/utilities/moduleex.sh|
+              test/utilities/TimeoutEx.sh
+          )
+  - repo: https://github.com/Mateusz-Grzelinski/actionlint-py
+    rev: "v1.7.1.15"
+    hooks:
+      - id: actionlint

.shellcheckrc

@@ -0,0 +1,2 @@
+disable=SC2164
+external-sources=true

README.md

@@ -2,7 +2,7 @@
 
 These tests are used to validate changes to `sst-core` prior to accepting those changes into the development and then master branch of `sst-core`.
 
-All of the tests used for SST are available on github, specifically 
+All of the tests used for SST are available on github, specifically
 - this repo, and
-- <https://github.com/sstsimulator/sst-elements>, and 
+- <https://github.com/sstsimulator/sst-elements>, and
 - network traces from <https://github.com/sstsimulator/sst-downloads/releases/tag/TestFiles>

buildsys/deps/bin/sstDep_dramsim_masterlatest.sh

@@ -1,7 +1,7 @@
 # !/bin/bash
 # sstDep_dramsim_masterlatest.sh
 
-# Description: 
+# Description:
 
 # A bash script containing functions to process SST's DRAMSim
 # dependency.

buildsys/deps/bin/sstDep_dramsim_r4b00b22.sh

@@ -1,7 +1,7 @@
 # !/bin/bash
 # sstDep_dramsim_r4b00b22.sh
 
-# Description: 
+# Description:
 
 # A bash script containing functions to process SST's DRAMSim
 # dependency.
@@ -57,7 +57,7 @@ sstDepsStage_dramsim ()
     pushd ${SST_DEPS_SRC_STAGED_DRAMSIM}
 
     git reset --hard 4b00b228abaa9d9dcd27ffbb48cfa71db53d520f
-    
+
 #    local dramsimHeadRevision=`git log -1 HEAD | head -1`
     popd
     sstDepsAnnounce -h $FUNCNAME -m "Fetched DRAMSim2 rev 4b00b228abaa9d9dcd27ffbb48cfa71db53d520f"

buildsys/deps/bin/sstDep_dramsim_stabledevel.sh

@@ -1,7 +1,7 @@
 # !/bin/bash
 # sstDep_dramsim_stabledevel.sh
 
-# Description: 
+# Description:
 
 # A bash script containing functions to process SST's DRAMSim
 # dependency.

buildsys/deps/bin/sstDep_dramsim_static.sh

@@ -1,7 +1,7 @@
 # !/bin/bash
 # sstDep_dramsim_static.sh
 
-# Description: 
+# Description:
 
 # A bash script containing functions to process SST's DRAMSim
 # dependency.

buildsys/deps/bin/sstDep_dramsim_v2.2.1.sh

@@ -1,7 +1,7 @@
 # !/bin/bash
 # sstDep_dramsim_v2.2.1.sh
 
-# Description: 
+# Description:
 
 # A bash script containing functions to process SST's DRAMSim
 # dependency.

buildsys/deps/bin/sstDep_dramsim_v2.2.2.sh

@@ -1,7 +1,7 @@
 # !/bin/bash
 # sstDep_dramsim_v2.2.2.sh
 
-# Description: 
+# Description:
 
 # A bash script containing functions to process SST's DRAMSim
 # dependency.
@@ -117,7 +117,7 @@ CXX=clang++\
         # if using Intel compiler
         if [[ ${compiler} =~ icpc.* ]]
         then
-            # patch Makefile for Intel compiler on Linux 
+            # patch Makefile for Intel compiler on Linux
             echo "INFO: (${FUNCNAME})  Intel compiler detected in CXX. Patching Makefile for icc/icpc..."
             sed -i.bak1 -e 's/g++/$(CXX)/' Makefile
             # I know the alignment looks awful here.

buildsys/deps/bin/sstDep_dramsim_v2.2.sh

@@ -1,7 +1,7 @@
 # !/bin/bash
 # sstDep_dramsim_v2.2.sh
 
-# Description: 
+# Description:
 
 # A bash script containing functions to process SST's DRAMSim
 # dependency.

buildsys/deps/bin/sstDep_goblin_hmcsim_stabledevel.sh

@@ -1,7 +1,7 @@
 # !/bin/bash
 # sstDep_goblin_hmcsim_stabledevel.sh
 
-# Description: 
+# Description:
 
 # A bash script containing functions to process SST's Goblin_HMCSIM
 # dependency.
@@ -28,15 +28,15 @@ export SST_BUILD_GOBLIN_HMCSIM_STABLEDEVEL=1
 # Outputs:
 #     Pass/fail
 # Expected Results
-#     Staged Goblin_HMCSIM code 
+#     Staged Goblin_HMCSIM code
 # Caveats:
 #     None
 #-------------------------------------------------------------------------------
 export SST_DEPS_SRC_STAGED_GOBLIN_HMCSIM=${SST_DEPS_SRC_STAGING}/goblin_hmcsim
 sstDepsStage_goblin_hmcsim ()
 {
     sstDepsAnnounce -h $FUNCNAME -m "Staging goblin_hmcsim stabledevel"
-    
+
     pushd ${SST_DEPS_SRC_STAGING}
 
    Num_Tries_remaing=3
@@ -61,7 +61,7 @@ sstDepsStage_goblin_hmcsim ()
          return $retVal
       fi
    done
-    
+
     if [ $retVal -ne 0 ]                      # retVal from git clone
     then
         # bail out on error
@@ -71,7 +71,7 @@ sstDepsStage_goblin_hmcsim ()
         popd
         return $retVal
     fi
-    
+
     #  Move into the goblin_hmcsim directory
     pushd ${SST_DEPS_SRC_STAGED_GOBLIN_HMCSIM}
     echo "gc64-hmcsim.git" `git log HEAD | sed 4q` >&2
@@ -102,7 +102,7 @@ sstDepsDeploy_goblin_hmcsim ()
     pushd ${SST_DEPS_SRC_STAGED_GOBLIN_HMCSIM}
 
     # Build and install GOBLIN_HMCSIM
-    make 
+    make
     retval=$?
     if [ $retval -ne 0 ]
     then
@@ -111,18 +111,18 @@ sstDepsDeploy_goblin_hmcsim ()
         popd
         return $retval
     fi
-    
+
     popd
-    
-    # NOTE: There is no "make install" for Goblin_HMCSIM.  Instead make a 
+
+    # NOTE: There is no "make install" for Goblin_HMCSIM.  Instead make a
     #       link to the compilied directory
     if [ ! -d ${SST_DEPS_INSTALL_DEPS}/packages ]
     then
         mkdir -p ${SST_DEPS_INSTALL_DEPS}/packages
     fi
 
     ln -s ${SST_DEPS_SRC_STAGED_GOBLIN_HMCSIM} ${SST_DEPS_INSTALL_DEPS}/packages/Goblin_HMCSIM
-    
+
 }
 
 # Installation location as used by SST's "./configure --with-goblin_hmcsim=..."

buildsys/deps/bin/sstDep_hbm_dramsim2_stabledevel.sh

@@ -1,7 +1,7 @@
 # !/bin/bash
 # sstDep_hbm_dramsim2_stabledevel.sh
 
-# Description: 
+# Description:
 
 # A bash script containing functions to process SST's HBM_DRAMSim2
 # dependency.
@@ -28,15 +28,15 @@ export SST_BUILD_HBM_DRAMSIM2_STABLEDEVEL=1
 # Outputs:
 #     Pass/fail
 # Expected Results
-#     Staged HBM_DRAMSim2 code 
+#     Staged HBM_DRAMSim2 code
 # Caveats:
 #     None
 #-------------------------------------------------------------------------------
 export SST_DEPS_SRC_STAGED_HBM_DRAMSIM2=${SST_DEPS_SRC_STAGING}/hbm_dramsim2
 sstDepsStage_hbm_dramsim2 ()
 {
     sstDepsAnnounce -h $FUNCNAME -m "Staging hbm_dramsim2 stabledevel"
-    
+
     pushd ${SST_DEPS_SRC_STAGING}
 
    Num_Tries_remaing=3
@@ -45,7 +45,7 @@ sstDepsStage_hbm_dramsim2 ()
       echo " "
       echo "git clone https://github.com/tactcomplabs/HBM.git hbm_dramsim2"
       git clone https://github.com/tactcomplabs/HBM.git hbm_dramsim2
-    
+
       retVal=$?
       if [ $retVal == 0 ] ; then
          Num_Tries_remaing=-1
@@ -69,12 +69,12 @@ sstDepsStage_hbm_dramsim2 ()
         popd
         return $retval
     fi
-    
+
     #  Move into the hbm_dramsim2 directory
     pushd ${SST_DEPS_SRC_STAGED_HBM_DRAMSIM2}
     git checkout hbm-1.0.0-release
 
-    
+
     echo "HBM.git" `git log HEAD | sed 4q` >&2
 
     popd
@@ -103,7 +103,7 @@ sstDepsDeploy_hbm_dramsim2 ()
     pushd ${SST_DEPS_SRC_STAGED_HBM_DRAMSIM2}
 
     # Build and install HBM_DRAMSIM2
-    make 
+    make
     retval=$?
     if [ $retval -ne 0 ]
     then
@@ -112,18 +112,18 @@ sstDepsDeploy_hbm_dramsim2 ()
         popd
         return $retval
     fi
-    
+
     popd
-    
-    # NOTE: There is no "make install" for HBM_DRAMSim2.  Instead make a 
+
+    # NOTE: There is no "make install" for HBM_DRAMSim2.  Instead make a
     #       link to the compilied directory
     if [ ! -d ${SST_DEPS_INSTALL_DEPS}/packages ]
     then
         mkdir -p ${SST_DEPS_INSTALL_DEPS}/packages
     fi
 
     ln -s ${SST_DEPS_SRC_STAGED_HBM_DRAMSIM2} ${SST_DEPS_INSTALL_DEPS}/packages/HBM_DRAMSim2
-    
+
 }
 
 # Installation location as used by SST's "./configure --with-hbmdramsim=..."

buildsys/deps/bin/sstDep_hybridsim.sh

@@ -1,7 +1,7 @@
 # !/bin/bash
 # sstDep_hybridsim.sh
 
-# Description: 
+# Description:
 
 # A bash script containing functions to process SST's HybridSim
 # dependency.
@@ -143,7 +143,7 @@ CXX=clang++\
         # if using Intel compiler
         if [[ ${compiler} =~ icpc.* ]]
         then
-            # patch Makefile for Intel compiler on Linux 
+            # patch Makefile for Intel compiler on Linux
             echo "INFO: (${FUNCNAME})  Intel compiler detected in CXX. Patching Makefile for icc/icpc..."
             sed -i.bak1 -e 's/g++/$(CXX)/' Makefile
             # I know the alignment looks awful here.

buildsys/deps/bin/sstDep_nvdimmsim.sh

@@ -1,7 +1,7 @@
 
 # sstDep_nvdimmsim.sh
 
-# Description: 
+# Description:
 
 # A bash script containing functions to process SST's NVDIMMSim
 # dependency.
@@ -40,7 +40,7 @@ sstDepsStage_nvdimmsim ()
 
 
 #      New May 5, 2014  using 2.0.0 release
-  
+
     tarFile="NVDIMMSim-2.0.0.tar.gz"
     sstDepsAnnounce -h $FUNCNAME -m "Staging ${tarFile}."
 
@@ -119,7 +119,7 @@ sstDepsDeploy_nvdimmsim ()
         # if using Intel compiler
         if [[ ${compiler} =~ icpc.* ]]
         then
-            # patch Makefile for Intel compiler on Linux 
+            # patch Makefile for Intel compiler on Linux
             echo "INFO: (${FUNCNAME})  Intel compiler detected in CXX. Patching Makefile for icc/icpc..."
             sed -i.bak1 -e 's/g++/$(CXX)/' Makefile
             # I know the alignment looks awful here.