Run pmd checks from pre-commit hooks. (#2694)

Add pmd cache.

Signed-off-by: Jakub Dardzinski <[email protected]>

.circleci/continue_config.yml

@@ -1001,6 +1001,7 @@ jobs:
           name: Run pre-commit
           command: |
             . venv/bin/activate
+            SKIP= && [ -n "${CI}" ] && export SKIP="pmd"
             pre-commit run --show-diff-on-failure --all-files
 
   always_run:

.gitignore

@@ -169,3 +169,6 @@ __pycache__
 
 # Dev
 changes.txt
+
+# pre-commit pmd hook cache
+.pmd_cache

.pre-commit-config.yaml

@@ -99,3 +99,11 @@ repos:
         entry: python ./.pre_commit/check-redactions.py
         always_run: true
         pass_filenames: false
+      - id: pmd
+        name: pmd
+        description: "Runs the PMD static code analyzer."
+        language: docker_image
+        entry: -v ./.pmd_cache:/opt/.pmd_cache --entrypoint .pre_commit/run-pmd.sh cimg/openjdk:8.0
+        files: ^client/java/src/.*\.java$|^integration/spark/spark-interfaces-scala/.*\.java$
+        exclude: ".*test.*"
+        require_serial: true

.pre_commit/run-pmd.sh

@@ -0,0 +1,43 @@
+#!/bin/bash
+
+set -e
+
+PMD_RELEASE="https://github.com/pmd/pmd/releases/download/pmd_releases%2F6.46.0/pmd-bin-6.46.0.zip"
+
+cd /opt/.pmd_cache
+
+# check if there is a pmd folder
+if [ ! -d "pmd" ]; then
+  wget -nc -O pmd.zip "$PMD_RELEASE" > /dev/null 2>&1 \
+    && unzip pmd.zip > /dev/null 2>&1 \
+    && rm pmd.zip > /dev/null 2>&1 \
+    && mv pmd-bin* pmd > /dev/null 2>&1 \
+    && chmod -R +x pmd > /dev/null 2>&1
+fi
+
+idx=1
+for (( i=1; i <= "$#"; i++ )); do
+    if [[ ${!i} == *.java ]]; then
+        idx=${i}
+        break
+    fi
+done
+
+# add default ruleset if not specified
+if [[ ! $pc_args == *"-R "* ]]; then
+  pc_args="$pc_args -R /src/client/java/pmd-openlineage.xml"
+fi
+
+# populate list of files to analyse
+files=""
+prefix="/src/"
+for arg in "${@:idx}"; do
+  files="$files $prefix$arg"
+done
+
+# Remove leading space (optional)
+files="${files:1}"
+eol=$'\n'
+echo "${files// /$eol}" > /tmp/list
+
+./pmd/bin/run.sh pmd -f textcolor -min 5 --file-list /tmp/list $pc_args