[CICD-48] Add shell script and yaml linting to GHA

Author: marksabbath

.github/workflows/e2e-deploy.yml

@@ -27,10 +27,10 @@ jobs:
           # Deploy Options
           SRC_PATH: "tests/data/plugins/test-plugin"
           REMOTE_PATH: "wp-content/plugins/"
-          PHP_LINT: TRUE
+          PHP_LINT: true
           FLAGS: -r --backup --backup-dir=/tmp --itemize-changes
           SCRIPT: "tests/data/post-deploy/test-plugin.sh"
-          CACHE_CLEAR: TRUE
+          CACHE_CLEAR: true
   validate_result:
     runs-on: ubuntu-latest
     needs: run_action

.github/workflows/lint-files.yml

@@ -0,0 +1,20 @@
+---
+name: Lint GHA Files
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Lint files
+        uses: actions/checkout@v3
+      - run: echo "Running shell script lint!"
+      - run: find . -name "*.sh" -type f | xargs -I {} shellcheck --severity=error {}
+      - run: echo "Running yml file lint!"
+      - run: find . -name "*.yml" -type f | xargs -I {} yamllint {}

.yamllint

@@ -0,0 +1,5 @@
+---
+rules:
+  line-length:
+    max: 120
+  truthy: {check-keys: false}

action.yml

@@ -1,3 +1,4 @@
+---
 name: "Deploy WordPress to WP Engine"
 branding:
   icon: "upload-cloud"
@@ -11,7 +12,7 @@ inputs:
     description: "optional php syntax check"
     required: false
     default: false
-  FLAGS: 
+  FLAGS:
     description: "Optional flags for the deployment"
     required: true
     default: '-azvr --inplace --exclude=".*"'
@@ -39,10 +40,10 @@ inputs:
   DEV_ENV:
     description: "Destination to deploy to WPE Dev"
     required: false
-  SCRIPT: 
+  SCRIPT:
     description: "File containing custom scripts run after the rsync"
     required: false
 
 runs:
   using: "docker"
-  image: "Dockerfile"
+  image: "Dockerfile"

entrypoint.sh

@@ -2,7 +2,7 @@
 
 set -e
 
-: ${INPUT_WPE_SSHG_KEY_PRIVATE?Required secret not set.}
+: "${INPUT_WPE_SSHG_KEY_PRIVATE?Required secret not set.}"
 
 #Alias logic for ENV names 
 if [[ -n ${INPUT_WPE_ENV} ]]; then
@@ -30,7 +30,7 @@ WPE_DESTINATION=wpe_gha+"$WPE_SSH_USER":sites/"$WPE_ENV_NAME"/"$DIR_PATH"
 
 
 # Setup our SSH Connection & use keys
-if [ ! -d ${HOME}/.ssh ]; then 
+if [ ! -d "${HOME}"/.ssh ]; then 
     mkdir "${HOME}/.ssh" 
     SSH_PATH="${HOME}/.ssh" 
     mkdir "${SSH_PATH}/ctl/"
@@ -52,15 +52,15 @@ ssh-keyscan -t rsa "$WPE_SSH_HOST" >> "$KNOWN_HOSTS_PATH"
 chmod 644 "$KNOWN_HOSTS_PATH"
 
 echo "prepping file perms..."
-find $SRC_PATH -type d -exec chmod -R 775 {} \;
-find $SRC_PATH -type f -exec chmod -R 664 {} \;
+find "$SRC_PATH" -type d -exec chmod -R 775 {} \;
+find "$SRC_PATH" -type f -exec chmod -R 664 {} \;
 echo "file perms set..."
 
 # pre deploy php lint
 if [ "${INPUT_PHP_LINT^^}" == "TRUE" ]; then
     echo "Begin PHP Linting."
-    for file in $(find $SRC_PATH/ -name "*.php"); do
-        php -l $file
+    find "$SRC_PATH"/ -name "*.php" -type f -print0 | while IFS= read -r -d '' file; do
+        php -l "$file"
         status=$?
         if [[ $status -ne 0 ]]; then
             echo "FAILURE: Linting failed - $file :: $status" && exit 1
@@ -88,31 +88,31 @@ fi
 
 # Deploy via SSH
 # setup master ssh connection 
-ssh -nNf -v -i ${WPE_SSHG_KEY_PRIVATE_PATH} -o StrictHostKeyChecking=no -o ControlMaster=yes -o ControlPath="$SSH_PATH/ctl/%C" $WPE_FULL_HOST
+ssh -nNf -v -i "${WPE_SSHG_KEY_PRIVATE_PATH}" -o StrictHostKeyChecking=no -o ControlMaster=yes -o ControlPath="$SSH_PATH/ctl/%C" "$WPE_FULL_HOST"
 
 echo "!!! MASTER SSH CONNECTION ESTABLISHED !!!"
 #rsync 
-rsync --rsh="ssh -v -p 22 -i ${WPE_SSHG_KEY_PRIVATE_PATH} -o StrictHostKeyChecking=no -o 'ControlPath=$SSH_PATH/ctl/%C'" $INPUT_FLAGS --exclude-from='/exclude.txt' $SRC_PATH "$WPE_DESTINATION"
+rsync --rsh="ssh -v -p 22 -i ${WPE_SSHG_KEY_PRIVATE_PATH} -o StrictHostKeyChecking=no -o 'ControlPath=$SSH_PATH/ctl/%C'" $INPUT_FLAGS --exclude-from='/exclude.txt' "$SRC_PATH" "$WPE_DESTINATION"
 
 # post deploy script and cache clear
 if [[ -n ${SCRIPT} || -n ${CACHE_CLEAR} ]]; then
 
     if [[ -n ${SCRIPT} ]]; then
-      if ! ssh -v -p 22 -i ${WPE_SSHG_KEY_PRIVATE_PATH} -o StrictHostKeyChecking=no -o ControlPath="$SSH_PATH/ctl/%C" $WPE_FULL_HOST "test -s sites/${WPE_ENV_NAME}/${INPUT_SCRIPT}"; then
+      if ! ssh -v -p 22 -i "${WPE_SSHG_KEY_PRIVATE_PATH}" -o StrictHostKeyChecking=no -o ControlPath="$SSH_PATH/ctl/%C" "$WPE_FULL_HOST" "test -s sites/${WPE_ENV_NAME}/${INPUT_SCRIPT}"; then
         status=1
       fi
 
       if [[ $status -ne 0 && -f ${INPUT_SCRIPT} ]]; then
-        ssh -v -p 22 -i ${WPE_SSHG_KEY_PRIVATE_PATH} -o StrictHostKeyChecking=no -o ControlPath="$SSH_PATH/ctl/%C" $WPE_FULL_HOST "mkdir -p sites/${WPE_ENV_NAME}/$(dirname ${INPUT_SCRIPT})"
+        ssh -v -p 22 -i "${WPE_SSHG_KEY_PRIVATE_PATH}" -o StrictHostKeyChecking=no -o ControlPath="$SSH_PATH/ctl/%C" "$WPE_FULL_HOST" "mkdir -p sites/${WPE_ENV_NAME}/$(dirname "${INPUT_SCRIPT}")"
 
-        rsync --rsh="ssh -v -p 22 -i ${WPE_SSHG_KEY_PRIVATE_PATH} -o StrictHostKeyChecking=no -o 'ControlPath=$SSH_PATH/ctl/%C'" ${INPUT_SCRIPT} wpe_gha+"$WPE_SSH_USER":sites/"$WPE_ENV_NAME"/$(dirname ${INPUT_SCRIPT})
+        rsync --rsh="ssh -v -p 22 -i ${WPE_SSHG_KEY_PRIVATE_PATH} -o StrictHostKeyChecking=no -o 'ControlPath=$SSH_PATH/ctl/%C'" "${INPUT_SCRIPT}" "wpe_gha+$WPE_SSH_USER:sites/$WPE_ENV_NAME/$(dirname "${INPUT_SCRIPT}")"
       fi
     fi
 
-    ssh -v -p 22 -i ${WPE_SSHG_KEY_PRIVATE_PATH} -o StrictHostKeyChecking=no -o ControlPath="$SSH_PATH/ctl/%C" $WPE_FULL_HOST "cd sites/${WPE_ENV_NAME} ${SCRIPT} ${CACHE_CLEAR}"
+    ssh -v -p 22 -i "${WPE_SSHG_KEY_PRIVATE_PATH}" -o StrictHostKeyChecking=no -o ControlPath="$SSH_PATH/ctl/%C" "$WPE_FULL_HOST" "cd sites/${WPE_ENV_NAME} ${SCRIPT} ${CACHE_CLEAR}"
 fi 
 
 #close master ssh 
-ssh -O exit -o ControlPath="$SSH_PATH/ctl/%C" $WPE_FULL_HOST
+ssh -O exit -o ControlPath="$SSH_PATH/ctl/%C" "$WPE_FULL_HOST"
 
 echo "SUCCESS: Your code has been deployed to WP Engine!"

tests/data/post-deploy/test-plugin.sh

@@ -14,7 +14,7 @@ AFTER_PLUGIN_VERSION=$(wp plugin get $PLUGIN_NAME | sed -n "/version/p" | cut -f
 echo "New test plugin version: $AFTER_PLUGIN_VERSION"
 
 # Revert to backup created by rsync if it exists
-if [ -d $BACKUP_DIR/$PLUGIN_NAME ]; then 
+if [ -d $BACKUP_DIR/$PLUGIN_NAME ]; then
     rm -rf $PLUGINS_DIR/$PLUGIN_NAME && mv $BACKUP_DIR/$PLUGIN_NAME $PLUGINS_DIR/
 fi
 
@@ -29,4 +29,4 @@ if [ -z "$BEFORE_PLUGIN_VERSION" ] || [ -z "$AFTER_PLUGIN_VERSION" ] || [ "$BEFO
 else
     echo "Success: Test plugin successfully updated from $BEFORE_PLUGIN_VERSION to $AFTER_PLUGIN_VERSION!"
     echo "::set-output name=status::pass"
-fi
+fi