From 11d20e6fa483fc6fcb8abe1b525e86a3911c2e87 Mon Sep 17 00:00:00 2001
From: Lenin Mehedy <lenin.mehedy@swirldslabs.com>
Date: Thu, 16 Nov 2023 12:39:59 +1100
Subject: [PATCH] chore: disable Codacy PMD rule UnnecessaryBlock for
 ECMAScripts (#557)

Signed-off-by: Lenin Mehedy <lenin.mehedy@swirldslabs.com>
---
 .github/workflows/zxc-compile-code.yaml | 10 +++++++++-
 ruleset.xml                             | 25 +++++++++++++++++++++++++
 2 files changed, 34 insertions(+), 1 deletion(-)
 create mode 100644 ruleset.xml

diff --git a/.github/workflows/zxc-compile-code.yaml b/.github/workflows/zxc-compile-code.yaml
index 16d333f6b..e5370e75c 100644
--- a/.github/workflows/zxc-compile-code.yaml
+++ b/.github/workflows/zxc-compile-code.yaml
@@ -116,7 +116,7 @@ jobs:
         uses: azure/setup-helm@5119fcb9089d432beecbf79bb2c7915207344b78 # v3.5
         if: ${{ (inputs.enable-unit-tests || inputs.enable-nodejs-tests) && !cancelled() && !failure() }}
         with:
-          version: "v3.12.3" # helm version
+          version: "v3.12.3" #  helm version
 
       # Technically, this step is not required for the unit tests to run, but it is useful for debugging setup issues.
       - name: Kubernetes Cluster Info
@@ -213,6 +213,14 @@ jobs:
           arguments: spotlessCheck --scan
           build-root-directory: fullstack-gradle-plugin
 
+      # This step is to cache the helm charts before we start unit tests
+      - name: Setup Helm Charts
+        if: ${{ (inputs.enable-unit-tests || inputs.enable-nodejs-tests) && !cancelled() && !failure() }}
+        run: |
+          helm repo add haproxytech https://haproxytech.github.io/helm-charts
+          helm repo add ingress-nginx https://kubernetes.github.io/ingress-nginx
+          helm repo update
+
       - name: Unit Tests
         id: gradle-test
         uses: gradle/gradle-build-action@842c587ad8aa4c68eeba24c396e15af4c2e9f30a # v2.9.0
diff --git a/ruleset.xml b/ruleset.xml
new file mode 100644
index 000000000..70e99a518
--- /dev/null
+++ b/ruleset.xml
@@ -0,0 +1,25 @@
+<?xml version="1.0"?>
+
+<ruleset name="Custom Rules"
+         xmlns="http://pmd.sourceforge.net/ruleset/2.0.0"
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://pmd.sourceforge.net/ruleset/2.0.0 https://pmd.sourceforge.io/ruleset_2_0_0.xsd">
+
+    <description>
+        FST custom PMD rule for Codacy analyzer
+    </description>
+
+
+    <!--
+        Codacy seems to fail to detect correct import statement for ECMAScripts
+        See:
+            - https://github.com/pmd/pmd/issues/2305
+            - https://github.com/pmd/pmd/issues/4129
+    -->
+    <rule ref="category/ecmascript/codestyle.xml">
+        <exclude name="UnnecessaryBlock"/>
+    </rule>
+    <rule ref="category/ecmascript/errorprone.xml"/>
+    <rule ref="category/ecmascript/bestpractices.xml"/>
+
+</ruleset>
\ No newline at end of file