add test to ensure that settings are correctly added to registries

.github/workflows/code_layout.yml

@@ -129,6 +129,14 @@ jobs:
       - name: Doxygen Layout Test
         run: ./tests/code_layout/test_doxygen_layout.sh
 
+  settings_registry_check:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Settings Registries Test
+        run: ./tests/code_layout/test_settings_registry.sh
+
   indentation_check:
     if: github.event_name == 'pull_request'
     runs-on: ubuntu-latest

tests/code_layout/test_settings_registry.sh

@@ -0,0 +1,68 @@
+#!/usr/bin/env bash
+
+set -e
+
+# GNU prefix command for mac os support (gsed, gsplit)
+GP=
+if [[ "$OSTYPE" =~ darwin* ]]; then
+  GP=g
+fi
+
+RED='\033[0;31m'
+NC='\033[0m' # No Color
+
+DEBUG=$1
+
+RETURN_CODE=0
+MODULES=()
+
+while read -r LINE; do
+  FILE=$(echo "${LINE}" | cut -d: -f1)
+  SETTING=$(echo "${LINE}" | cut -d: -f2,3,4,5,6 | ${GP}sed -r 's/^.*static +const +inline +QgsSettingsEntry[^ ]+ +(\w+).*$/\1/')
+  MODULE=$(echo "${FILE}" | cut -d/ -f2)
+  SUBFOLDER=$([[ ${MODULE} =~ (core|gui) ]] && echo "settings" || echo "")
+  REG_FILE="src/${MODULE}/${SUBFOLDER}/qgssettingsregistry${MODULE}.cpp"
+  COUNT_VAR="COUNT_${MODULE}"
+
+  if [[ ${DEBUG} -eq 1 ]]; then
+    echo LINE: "${LINE}"
+    echo SETTING: "${SETTING}"
+    echo MODULE: "${MODULE}"
+    echo SUBFOLDER: "${SUBFOLDER}"
+    echo REG_FILE: "${REG_FILE}"
+    echo COUNT_VAR: "${COUNT_VAR} => ${!COUNT_VAR}"
+  fi
+
+  if [[ -z "${!COUNT_VAR}" ]]; then
+    MODULES+=("${MODULE}")
+    declare "COUNT_${MODULE}"=1
+  else
+    declare "COUNT_${MODULE}=$(( ${!COUNT_VAR} + 1 ))"
+  fi
+
+  if ( ! grep -E -q "addSettingsEntry. \&(\w+::)?${SETTING} " "${REG_FILE}" ); then
+    echo -e "ERROR: setting ${RED}${SETTING}${NC} defined in ${RED}${FILE}${NC} not added to the registry (${REG_FILE})"
+    RETURN_CODE=1
+  fi
+
+done <<< $(git grep -E 'static +const +inline +QgsSettingsEntry[^ ]+ +\w+' src)
+
+echo "*** Self-check"
+# check that the number of items in each registry corresponds to what was found (for safety on this script)
+for MODULE in "${MODULES[@]}"; do
+  SUBFOLDER=$([[ ${MODULE} =~ (core|gui) ]] && echo "settings" || echo "")
+  REG_FILE="src/${MODULE}/${SUBFOLDER}/qgssettingsregistry${MODULE}.cpp"
+  COUNT=$(grep --only-matching -c 'addSettingsEntry' "${REG_FILE}")
+  COUNT_VAR="COUNT_${MODULE}"
+  if [[ ${COUNT} == "${!COUNT_VAR}" ]]; then
+    echo "${MODULE}: OK: ${COUNT} settings"
+  else
+    echo "${MODULE}: ERROR settings count mismatch for (${COUNT} vs ${!COUNT_VAR})"
+    if [[ ${RETURN_CODE} == 0 ]]; then
+      echo "Hmmm it looks like this test is broken! (some errors should have been raised before)"
+    fi
+    RETURN_CODE=1
+  fi
+done
+
+exit ${RETURN_CODE}