Fixes #19354: Add ci checks on rudder-agent repo

Author: amousset

Jenkinsfile

@@ -0,0 +1,46 @@
+@Library('slack-notification')
+import org.gradiant.jenkins.slack.SlackNotifier
+
+pipeline {
+    agent none
+
+    stages {
+        stage('Tests') {
+            parallel {
+                stage('shell') {
+                    agent { label 'script' }
+                    steps {
+                        sh script: 'typos', label: 'check typos'
+                        sh script: './qa-test --shell', label: 'shell scripts lint'
+                    }
+                    post {
+                        always {
+                            // linters results
+                            recordIssues enabledForFailure: true, failOnError: true, sourceCodeEncoding: 'UTF-8',
+                                         tool: checkStyle(pattern: '.shellcheck/*.log', reportEncoding: 'UTF-8', name: 'Shell scripts')
+
+                            script {
+                                new SlackNotifier().notifyResult("shell-team")
+                            }
+                        }
+                    }
+                }
+                stage('man') {
+                    agent { label 'script' }
+                    steps {
+                        dir("man") {
+                            sh script: 'make', label: 'man page'
+                        }
+                    }
+                    post {
+                        always {
+                            script {
+                                new SlackNotifier().notifyResult("shell-team")
+                            }
+                        }
+                    }                
+                }
+            }
+        }
+    }
+}

qa-test

@@ -2,11 +2,36 @@
 
 set -ex
 
-# Shellcheck
-find * -type f -exec bash -c "head -n1 {} | grep -Eq '^#!(.*/|.*env +)(sh|bash|ksh)'" \; -print |
-  while IFS="" read -r file
-  do
-    # with recent shellcheck, "-S error" replaces this hack
-    shellcheck -f gcc "$file" | grep " error: " && exit 1 || true
-  done
+test_shell()
+{
+  mkdir -p .shellcheck
+  find . -path ./.git -prune -o -type f -exec grep -Eq '^#!(.*/|.*env +)(sh|bash|ksh)' {} \; -print |
+    while IFS="" read -r file
+    do
+      # collect all warnings
+      shellcheck --format=checkstyle "$file" > .shellcheck/$(basename ${file}).log || true
+      # fail on >=error
+      shellcheck --severity error "$file"
+    done
+}
 
+# fails on error and ignores other levels
+test_shell_error()
+{
+  # Shellcheck
+  find . -path ./.git -prune -o -type f -exec grep -Eq '^#!(.*/|.*env +)(sh|bash|ksh)' {} \; -print |
+    while IFS="" read -r file
+    do
+      # with recent shellcheck, "-S error" replaces this hack
+      # kept as this runs on machines running rudder-dev
+      shellcheck --format gcc "$file" | grep " error: " && exit 1 || true
+    done
+}
+
+if [ "$1" = "--shell" ]; then
+  test_shell
+  exit 0
+else
+  # quick tests to be launched during merge
+  test_shell_error
+fi

share/commands/agent-inventory

@@ -31,7 +31,7 @@
 
 bootstrap_check
 
-# We cannnot start an inventory in bootstrap policies
+# We cannot start an inventory in bootstrap policies
 if cmp -s "/var/rudder/cfengine-community/inputs/failsafe.cf" "/opt/rudder/share/bootstrap-promises/failsafe.cf"
 then
   >&2 echo "Agent is currently in bootstrap policies, cannot run an inventory. Please download initial policies from the server with command \"rudder agent update\" first. If problem persists, use \"rudder agent check\" for diagnostic"

share/commands/remote-run

@@ -140,7 +140,7 @@ while getopts "iIvdqwrRcTD:j:g:at:u:C:eE" opt; do
   esac
 done
 
-# to read remaing arguments with $*
+# to read remaining arguments with $*
 shift `expr ${OPTIND} - 1`
 
 # Define node list method 

share/commands/server-directive-migrate-package

@@ -34,7 +34,7 @@ print_result() {
   if [ "${STATUS}" == "success" ]
   then
     NEW_DIRECTIVE_ID=$(filtered_api_call "${API_URL}/api/latest/directives" "${TOKEN}" "GET" "" "${DISPLAY_COMMAND}" | jq -r " .data.directives[] | select(.displayName==\"${DISPLAY_NAME}_migrated\") | .id")
-    printf "[${GREEN}SUCCESS${NORMAL}] Directive created. You can execute the following command to change all occurence of the old directive to the new one in your rules:\n"
+    printf "[${GREEN}SUCCESS${NORMAL}] Directive created. You can execute the following command to change all occurrence of the old directive to the new one in your rules:\n"
     printf "${WHITE}rudder server directive-replace -o ${OLD_DIRECTIVE_ID} -n ${NEW_DIRECTIVE_ID}${NORMAL}\n"
   elif [ "${STATUS}" == "error" ]
   then

share/commands/server-directive-replace

@@ -1,6 +1,6 @@
 #!/bin/bash
-# @description replace a directive occurence in all the Rudder rules by another directive.
-# @man replace a directive occurence in all the Rudder rules by another directive.
+# @description replace a directive occurrence in all the Rudder rules by another directive.
+# @man replace a directive occurrence in all the Rudder rules by another directive.
 # @man +
 # @man *Arguments*:
 # @man +