CCM-7478: Enable Test Coverage Reporting in Sonar (#1007)

* CCM-7478: Remove unnecessary sandbox dependency

* CCM-7478: Configure test coverage reporting

* CCM-7478: Don't set Node.js path for Sonar

* CCM-7478: Make Sonar scan fail if quality gate fails

Author: gareth-allan

.github/workflows/build.yml

@@ -57,6 +57,10 @@ jobs:
         run: |
           cd sandbox
           npm run test
+          cd -
+          mkdir coverage coverage-temp
+          TMPDIR="./coverage-temp" npx lcov-result-merger sandbox/coverage/lcov.info coverage/lcov.info --prepend-source-files
+          rm -r coverage-temp
 
       - name: Check licenses
         run: make check-licenses

.gitignore

@@ -25,6 +25,7 @@ env
 *.pem
 sandbox/coverage
 sandbox/.nyc_output
+coverage
 zap-report/
 zap-report.json
 zap-report.xml

sandbox/package-lock.json

@@ -24,7 +24,6 @@
     "license-checker": "^25.0.1",
     "mocha": "^11.7.2",
     "mocha-junit-reporter": "^2.2.1",
-    "mocha-multi": "^1.1.3",
     "nodemon": "^3.1.10",
     "supertest": "^7.1.4"
   }

sandbox/package.json

@@ -3,14 +3,18 @@ sonar.organization=nhsdigital
 sonar.projectKey=NHSDigital_communications-manager-api
 sonar.sourceEncoding=UTF-8
 sonar.language=js,python
+sonar.qualitygate.wait=true
 
+sonar.sources=.
+sonar.tests=tests/, sandbox/__test__
+sonar.test.inclusions=tests/**.py, sandbox/__test__/**
 sonar.exclusions=.venv/**,proxies/utils/performance/*
 
-#exclude everything from test coverage, this is covered by other tools
-sonar.coverage.exclusions=**/*
-#sonar.nodejs.executable=/usr/bin/node
 sonar.python.version=3.10.8
 
+# Configure test coverage reporting
+sonar.javascript.lcov.reportPaths=coverage/lcov.info
+
 #exclusion rules for our proxy JS - rhinojs 1.7.12 -https://mozilla.github.io/rhino/compat/engines.html
 sonar.issue.ignore.multicriteria=optChain,useLet