renovate-config-validator: validate shareable config preset (super-li…

…nter#4674)

* renovate-config-validator: validate default.json

* Add RENOVATE_SHAREABLE_CONFIG_PRESET_FILE

* Allow specifying multiple additional files with a environment variable

* Add break

.automation/test/renovate/README.md

@@ -4,17 +4,15 @@ This folder holds the test cases for **renovate**.
 
 ## Additional Docs
 
-No Additional information is needed for this test case.
+Due to the nature of the naming of files, we have `2` subfolders in this directory.
 
-## Good Test Cases
+- `good` is for working, and correct renovate config files
+- `bad` is for invalid, and incorrect renovate config files
 
-The test cases denoted: `LANGUAGE_good_FILE.EXTENSION` are all valid, and should pass successfully when linted.
+## Good Test Cases
 
 - **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.
-{"mode":"full","isActive":false}

.automation/test/renovate/bad/renovate.json

@@ -0,0 +1,18 @@
+{
+  "ignooooooooorePaths": [
+    "**/node_modules/**",
+    "**/bower_components/**",
+    "**/vendor/**",
+    "**/examples/**",
+    "**/__tests__/**",
+    "**/tests/**",
+    "**/__fixtures__/**"
+  ],
+  "iggggggggnoreDeps": [
+    "go",
+    "node-fetch"
+  ],
+  "constraaaaaaaaaints": {
+    "go": "1.20"
+  }
+}

.automation/test/renovate/bad/renovate.json5

@@ -0,0 +1,18 @@
+{
+  "ignooooooooorePaths": [
+    "**/node_modules/**",
+    "**/bower_components/**",
+    "**/vendor/**",
+    "**/examples/**",
+    "**/__tests__/**",
+    "**/tests/**",
+    "**/__fixtures__/**"
+  ],
+  "iggggggggnoreDeps": [
+    "go",
+    "node-fetch"
+  ],
+  "constraaaaaaaaaints": {
+    "go": "1.20"
+  }
+}

.automation/test/renovate/good/renovate.json

@@ -0,0 +1,18 @@
+{
+  "ignorePaths": [
+    "**/node_modules/**",
+    "**/bower_components/**",
+    "**/vendor/**",
+    "**/examples/**",
+    "**/__tests__/**",
+    "**/tests/**",
+    "**/__fixtures__/**"
+  ],
+  "ignoreDeps": [
+    "go",
+    "node-fetch"
+  ],
+  "constraints": {
+    "go": "1.20"
+  }
+}

.automation/test/renovate/good/renovate.json5

@@ -0,0 +1,18 @@
+{
+  "ignorePaths": [
+    "**/node_modules/**",
+    "**/bower_components/**",
+    "**/vendor/**",
+    "**/examples/**",
+    "**/__tests__/**",
+    "**/tests/**",
+    "**/__fixtures__/**"
+  ],
+  "ignoreDeps": [
+    "go",
+    "node-fetch"
+  ],
+  "constraints": {
+    "go": "1.20"
+  }
+}

.github/workflows/ci.yml

@@ -58,6 +58,7 @@ jobs:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           DEFAULT_BRANCH: main
           LOCAL_UPDATES: true
+          RENOVATE_SHAREABLE_CONFIG_PRESET_FILE_NAMES: "default.json,hoge.json"
 
       - name: Run Test Suite
         run: make IMAGE=${{ matrix.images.target }} test
@@ -76,6 +77,7 @@ jobs:
           -e TEST_CASE_RUN=true \
           -e ANSIBLE_DIRECTORY=.automation/test/ansible \
           -e ACTIONS_RUNNER_DEBUG=true \
+          -e RENOVATE_SHAREABLE_CONFIG_PRESET_FILE_NAMES="default.json,hoge.json" \
           -e ERROR_ON_MISSING_EXEC_BIT=true \
           -v "${GITHUB_WORKSPACE}:/tmp/lint" \
           "ghcr.io/super-linter/super-linter:${tag}"
@@ -88,6 +90,7 @@ jobs:
           -e RUN_LOCAL=true \
           -e OUTPUT_DETAILS=detailed \
           -e ACTIONS_RUNNER_DEBUG=true \
+          -e RENOVATE_SHAREABLE_CONFIG_PRESET_FILE_NAMES="default.json,hoge.json" \
           -e ERROR_ON_MISSING_EXEC_BIT=true \
           -v "${GITHUB_WORKSPACE}:/tmp/lint" \
           "ghcr.io/super-linter/super-linter:${tag}"

lib/functions/buildFileList.sh

@@ -337,11 +337,20 @@ function BuildFileList() {
     fi
 
     # See https://docs.renovatebot.com/configuration-options/
-    if [[ "${BASE_FILE}" =~ renovate.+json5? ]] ||
-      [ "${BASE_FILE}" == ".renovaterc" ] || [[ "${BASE_FILE}" =~ .renovaterc.+json5? ]]; then
+    if [[ "${BASE_FILE}" =~ renovate.json5? ]] ||
+      [ "${BASE_FILE}" == ".renovaterc" ] || [[ "${BASE_FILE}" =~ .renovaterc.json5? ]]; then
       FILE_ARRAY_RENOVATE+=("${FILE}")
     fi
 
+    # See https://docs.renovatebot.com/config-presets/
+    IFS="," read -r -a RENOVATE_SHAREABLE_CONFIG_PRESET_FILE_NAMES_ARRAY <<<"${RENOVATE_SHAREABLE_CONFIG_PRESET_FILE_NAMES}"
+    for file_name in "${RENOVATE_SHAREABLE_CONFIG_PRESET_FILE_NAMES_ARRAY[@]}"; do
+      if [ "${BASE_FILE}" == "${file_name}" ]; then
+        FILE_ARRAY_RENOVATE+=("${FILE}")
+        break
+      fi
+    done
+
     #######################
     # Get the shell files #
     #######################

lib/functions/worker.sh

@@ -130,6 +130,26 @@ function LintCodebase() {
         fi
       fi
 
+      #####################
+      # Check if Renovate #
+      #####################
+      if [[ ${FILE_TYPE} == *"RENOVATE"* ]]; then
+        debug "FILE_TYPE for FILE ${FILE} is related to Renovate: ${FILE_TYPE}"
+        if [[ ${FILE} == *"good"* ]]; then
+          debug "Setting FILE_STATUS for FILE ${FILE} to 'good'"
+          #############
+          # Good file #
+          #############
+          FILE_STATUS='good'
+        elif [[ ${FILE} == *"bad"* ]]; then
+          debug "Setting FILE_STATUS for FILE ${FILE} to 'bad'"
+          ############
+          # Bad file #
+          ############
+          FILE_STATUS='bad'
+        fi
+      fi
+
       #######################################
       # Check if Cargo.toml for Rust Clippy #
       #######################################