Add support for Clojure with clj-kondo

.automation/test/clojure/README.md

@@ -0,0 +1,13 @@
+# Clojure Test Cases
+This folder holds the test cases for **Clojure**.  
+
+## Additional Docs
+No Additional information is needed for this test case.
+
+## Good Test Cases
+The test cases denoted: `LANGUAGE_good_FILE.EXTENSION` are all valid, and should pass successfully when linted.
+- **Note:** They are linted utilizing the default linter rules.
+
+## Bad Test Cases
+The test cases denoted: `LANGUAGE_bad_FILE.EXTENSION` are **NOT** valid, and should trigger errors when linted.
+- **Note:** They are linted utilizing the default linter rules.

.automation/test/clojure/clojure_bad_1.clj

@@ -0,0 +1,64 @@
+(ns foo
+  (:require
+   [clojure.string :as str]
+    ;; We're never using this namespace. Also, the namespaces aren't sorted.
+   [clojure.set :as set]))
+
+;; Here we made a typo, so the symbol is unresolved:
+(but-last [1 2 3])
+
+;; Clj-kondo knows about arities of clojure namespaces, but you can also teach
+;; it about your libraries or own namespaces
+(str/join)
+
+;; foo has an arity of 2, but we're not actually using y
+(defn foo-fn [x y]
+  ;; this do is redundant:
+  (do
+    ;; this is handy for debugging, but please remove it before pushing your code:
+    (def tmp_x x)
+    (let [y (fn [] (inc x))]
+      ;; the next let can be squashed together with the previous:
+      (let [z y]
+        ;; whoopsy, calling a local function with an incorrect number of args:
+        (y x)
+        ;; also wrong:
+        (recur)))))
+
+(letfn
+ [(f [] (h 1))
+  (h [] (f 1))])
+
+(defn- private-fn [])
+;; redefining it...
+(defn- private-fn [])
+
+(defn foo [] :foo)
+;; Type error, because foo doesn't return a number!
+(inc (foo))
+
+;; I'm tired now, let's sleep...
+;; Oops, not happening because of wrong amount of args:
+(Thread/sleep 1000 1 2)
+
+;; Here we switch to another namespace and require the previous:
+(ns bar (:require [foo :as f]))
+
+;; Wrong arity when calling a function from the previous namespace:
+(f/foo-fn)
+
+;; private:
+(f/private-fn)
+
+;; this won't pass the reader:
+{:a 1 :a 2}
+;; and neither will this:
+#{1 1}
+;; nor this:
+{:a 1 :b}
+
+(ns bar-test (:require [clojure.test :as t]))
+
+(t/deftest my-tests
+  ;; you're not actually testing something here:
+  (odd? (inc 1)))

.automation/test/clojure/clojure_good_1.clj

@@ -0,0 +1,35 @@
+(ns foo
+  (:require
+   [clojure.string :as str]))
+
+(butlast [1 2 3])
+
+(str/join "" "")
+
+(defn foo-fn [x]
+    (let [y (fn [] (inc x))
+          z y]
+        (y)))
+
+(letfn
+ [(f [g] (h g))
+  (h [i] (f i))])
+
+(defn foo [] 1)
+(inc (foo))
+
+(Thread/sleep 1000 1)
+
+;; Here we switch to another namespace and require the previous:
+(ns bar (:require [foo :as f]))
+
+(f/foo-fn 1)
+
+{:a 1 :b 2}
+#{1 2}
+{:a 1 :b 2}
+
+(ns bar-test (:require [clojure.test :as t]))
+
+(t/deftest my-tests
+  (t/is (odd? (inc 1))))

Dockerfile

@@ -102,6 +102,14 @@ RUN wget -O- -nvq https://raw.githubusercontent.com/golangci/golangci-lint/maste
 RUN curl -Ls "$(curl -Ls https://api.github.com/repos/terraform-linters/tflint/releases/latest | grep -o -E "https://.+?_linux_amd64.zip")" -o tflint.zip && unzip tflint.zip && rm tflint.zip \
     && mv "tflint" /usr/bin/
 
+#####################
+# Install clj-kondo #
+#####################
+RUN curl -sLO https://github.com/borkdude/clj-kondo/releases/download/v2020.06.12/clj-kondo-2020.06.12-linux-static-amd64.zip \
+    && unzip clj-kondo-2020.06.12-linux-static-amd64.zip \
+    && rm clj-kondo-2020.06.12-linux-static-amd64.zip \
+    && mv clj-kondo /usr/bin/
+
 ###########################################
 # Load GitHub Env Vars for GitHub Actions #
 ###########################################
@@ -128,6 +136,7 @@ ENV GITHUB_SHA=${GITHUB_SHA} \
     VALIDATE_GO=${VALIDATE_GO} \
     VALIDATE_TERRAFORM=${VALIDATE_TERRAFORM} \
     VALIDATE_CSS=${VALIDATE_CSS} \
+    VALIDATE_CLOJURE=${VALIDATE_CLOJURE} \
     ANSIBLE_DIRECTORY=${ANSIBLE_DIRECTORY} \
     RUN_LOCAL=${RUN_LOCAL} \
     TEST_CASE_RUN=${TEST_CASE_RUN} \

README.md

@@ -20,6 +20,7 @@ Developers on **GitHub** can call the **GitHub Action** to lint their code base
 | ---              | ---                                                                      |
 | **Ansible**      | [ansible-lint](https://github.com/ansible/ansible-lint)                  |
 | **CSS**          | [stylelint](https://stylelint.io/)                                       |
+| **Clojure**      | [clj-kondo](https://github.com/borkdude/clj-kondo)                       |
 | **CoffeeScript** | [coffeelint](https://coffeelint.github.io/)                              |
 | **Dockerfile**   | [dockerfilelint](https://github.com/replicatedhq/dockerfilelint.git)     |
 | **Golang**       | [golangci-lint](https://github.com/golangci/golangci-lint)               |
@@ -135,6 +136,7 @@ and won't run anything unexpected.
 | **VALIDATE_GO** | `true` | Flag to enable or disable the linting process of the language. |
 | **VALIDATE_TERRAFORM** | `true` | Flag to enable or disable the linting process of the language. |
 | **VALIDATE_CSS** | `true` | Flag to enable or disable the linting process of the language. |
+| **VALIDATE_CLOJURE** | `true` | Flag to enable or disable the linting process of the language. |
 | **ANSIBLE_DIRECTORY** | `/ansible` | Flag to set the root directory for Ansible file location(s). |
 | **ACTIONS_RUNNER_DEBUG** | `false` | Flag to enable additional information about the linter, versions, and additional output. |
 | **DEFAULT_WORKSPACE** | `/tmp/lint` | The location containing files to lint if you are running locally. |

lib/linter.sh

@@ -51,6 +51,9 @@ TERRAFORM_LINTER_RULES="$DEFAULT_RULES_LOCATION/$TERRAFORM_FILE_NAME"    # Path
 # CSS Vars
 CSS_FILE_NAME='.stylelintrc.json'                                   # Name of the file
 CSS_LINTER_RULES="$DEFAULT_RULES_LOCATION/$CSS_FILE_NAME"           # Path to the CSS lint rules
+# Clojure Vars
+CLOJURE_FILE_NAME='.clj-kondo/config.edn'
+CLOJURE_LINTER_RULES="$DEFAULT_RULES_LOCATION/$CLOJURE_FILE_NAME"
 
 
 #######################################
@@ -59,14 +62,15 @@ CSS_LINTER_RULES="$DEFAULT_RULES_LOCATION/$CSS_FILE_NAME"           # Path to th
 LINTER_ARRAY=("jsonlint" "yamllint" "xmllint" "markdownlint" "shellcheck"
   "pylint" "perl" "rubocop" "coffeelint" "eslint" "standard"
   "ansible-lint" "/dockerfilelint/bin/dockerfilelint" "golangci-lint" "tflint"
-  "stylelint")
+  "stylelint" "clj-kondo")
 
 #############################
 # Language array for prints #
 #############################
 LANGUAGE_ARRAY=('YML' 'JSON' 'XML' 'MARKDOWN' 'BASH' 'PERL' 'RUBY' 'PYTHON'
   'COFFEESCRIPT' 'ANSIBLE' 'JAVASCRIPT_STANDARD' 'JAVASCRIPT_ES'
-  'TYPESCRIPT_STANDARD' 'TYPESCRIPT_ES' 'DOCKER' 'GO' 'TERRAFORM' 'CSS')
+  'TYPESCRIPT_STANDARD' 'TYPESCRIPT_ES' 'DOCKER' 'GO' 'TERRAFORM' 'CSS'
+  'CLOJURE')
 
 ###################
 # GitHub ENV Vars #
@@ -95,6 +99,7 @@ VALIDATE_DOCKER="${VALIDATE_DOCKER}"                  # Boolean to validate lang
 VALIDATE_GO="${VALIDATE_GO}"                          # Boolean to validate language
 VALIDATE_TERRAFORM="${VALIDATE_TERRAFORM}"            # Boolean to validate language
 VALIDATE_CSS="${VALIDATE_CSS}"                        # Boolean to validate language
+VALIDATE_CLOJURE="${VALIDATE_CLOJURE}"                # Boolean to validate language
 TEST_CASE_RUN="${TEST_CASE_RUN}"                      # Boolean to validate only test cases
 
 ##############
@@ -136,6 +141,7 @@ FILE_ARRAY_DOCKER=()                # Array of files to check
 FILE_ARRAY_GO=()                    # Array of files to check
 FILE_ARRAY_TERRAFORM=()             # Array of files to check
 FILE_ARRAY_CSS=()                   # Array of files to check
+FILE_ARRAAY_CLOJURE=()              # Array of files to check
 
 ############
 # Counters #
@@ -158,6 +164,7 @@ ERRORS_FOUND_DOCKER=0               # Count of errors found
 ERRORS_FOUND_GO=0                   # Count of errors found
 ERRORS_FOUND_TERRAFORM=0            # Count of errors found
 ERRORS_FOUND_CSS=0                  # Count of errors found
+ERRORS_FOUND_CLOJURE=0              # Count of errors found
 
 ################################################################################
 ########################## FUNCTIONS BELOW #####################################
@@ -735,6 +742,7 @@ GetValidationInfo()
   VALIDATE_GO=$(echo "$VALIDATE_GO" | awk '{print tolower($0)}')
   VALIDATE_TERRAFORM=$(echo "$VALIDATE_TERRAFORM" | awk '{print tolower($0)}')
   VALIDATE_CSS=$(echo "$VALIDATE_CSS" | awk '{print tolower($0)')
+  VALIDATE_CLOJURE=$(echo "$VALIDATE_CLOJURE" | awk '{print tolower($0)')
 
   ################################################
   # Determine if any linters were explicitly set #
@@ -757,7 +765,8 @@ GetValidationInfo()
         -n "$VALIDATE_DOCKER" || \
         -n "$VALIDATE_GO" || \
         -n "$VALIDATE_TERRAFORM" || \
-        -n "$VALIDATE_CSS" ]]; then
+        -n "$VALIDATE_CSS" || \
+        -n "$VALIDATE_CLOJURE" ]]; then
     ANY_SET="true"
   fi
 
@@ -1013,6 +1022,20 @@ GetValidationInfo()
     VALIDATE_CSS="true"
   fi
 
+  #######################################
+  # Validate if we should check Clojure #
+  #######################################
+  if [[ "$ANY_SET" == "true" ]]; then
+    # Some linter flags were set - only run those set to true
+    if [[ -z "$VALIDATE_CLOJURE" ]]; then
+      # Clojure flag was not set - default to false
+      VALIDATE_CLOJURE="false"
+    fi
+  else
+    # No linter flags were set - default all to true
+    VALIDATE_CLOJURE="true"
+  fi
+
   #######################################
   # Print which linters we are enabling #
   #######################################
@@ -1106,6 +1129,11 @@ GetValidationInfo()
   else
     PRINT_ARRAY+=("- Excluding [CSS] files in code base...")
   fi
+  if [[ "$VALIDATE_CLOJURE" == "true" ]]; then
+    PRINT_ARRAY+=("- Validating [CLOJURE] files in code base...")
+  else
+    PRINT_ARRAY+=("- Excluding [CLOJURE] files in code base...")
+  fi
 
   ##############################
   # Validate Ansible Directory #
@@ -1431,6 +1459,15 @@ BuildFileList()
       # Set the READ_ONLY_CHANGE_FLAG since this could be exec #
       ##########################################################
       READ_ONLY_CHANGE_FLAG=1
+    elif [ "$FILE" == "clj" ] || [ "$FILE" == "cljs" ] || [ "$FILE" == "cljc" ] || [ "$FILE" == "edn" ]; then
+      ################################
+      # Append the file to the array #
+      ################################
+      FILE_ARRAY_CLOJURE+=("$FILE")
+      ##########################################################
+      # Set the READ_ONLY_CHANGE_FLAG since this could be exec #
+      ##########################################################
+      READ_ONLY_CHANGE_FLAG=1
     else
       ##############################################
       # Use file to see if we can parse what it is #
@@ -1986,6 +2023,7 @@ RunTestCases()
   TestCodebase "ANSIBLE" "ansible-lint" "ansible-lint -v -c $ANSIBLE_LINTER_RULES" "ansible-lint"
   TestCodebase "TERRAFORM" "tflint" "tflint -c $TERRAFORM_LINTER_RULES" ".*\.\(tf\)\$"
   TestCodebase "CSS" "stylelint" "stylelint --config $CSS_LINTER_RULES" ".*\.\(css\)\$"
+  TestCodebase "CLOJURE" "clj-kondo" "clj-kondo --config $CLOJURE_LINTER_RULES" ".*\.\(clj\)\$"
 
   #################
   # Footer prints #
@@ -2282,6 +2320,20 @@ if [ "$VALIDATE_DOCKER" == "true" ]; then
   LintCodebase "DOCKER" "/dockerfilelint/bin/dockerfilelint" "/dockerfilelint/bin/dockerfilelint" ".*\(Dockerfile\)\$" "${FILE_ARRAY_DOCKER[@]}"
 fi
 
+###################
+# CLOJURE LINTING #
+###################
+if [ "$VALIDATE_CLOJURE" == "true" ]; then
+  #################################
+  # Get Clojure standard rules #
+  #################################
+  GetStandardRules "clj-kondo"
+  #########################
+  # Lint the Clojure files #
+  #########################
+  LintCodebase "CLOJURE" "clj-kondo" "clj-kondo --config $CLOJURE_LINTER_RULES" ".*\.\(clj\)\$" "${FILE_ARRAY_CLOJURE[@]}"
+fi
+
 ##########
 # Footer #
 ##########