ci: Integrate Sonar analysis with test coverage on PRs into CI (#2182)

* Integrate Sonar analysis with test coverage on PRs into CI

* Force CI to run again

* Fix project name

* Add comments and be consistent with projectName

.github/workflows/ci.yml

@@ -18,3 +18,46 @@ jobs:
           cache: npm
       - run: npm ci
       - run: npm run test
+
+      # Sonar analysis needs the full history for features like automatic assignment of bugs. If the following step
+      # is not included the project will show a warning about incomplete information.
+      - run: git fetch --unshallow
+        if: ${{ matrix.node-version == '16' }}
+
+      # Since this is a monorepo, the Sonar scan must be run on each of the packages but this will pull in the test
+      # coverage information produced by the tests already run.
+      - name: SonarCloud Scan - Browser
+        if: ${{ matrix.node-version == '16' }}
+        uses: SonarSource/sonarcloud-github-action@v1.6
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
+        with:
+          projectBaseDir: packages/browser
+
+      - name: SonarCloud Scan - Core
+        if: ${{ matrix.node-version == '16' }}
+        uses: SonarSource/sonarcloud-github-action@v1.6
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
+        with:
+          projectBaseDir: packages/core
+
+      - name: SonarCloud Scan - Node
+        if: ${{ matrix.node-version == '16' }}
+        uses: SonarSource/sonarcloud-github-action@v1.6
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
+        with:
+          projectBaseDir: packages/node
+
+      - name: SonarCloud Scan - OIDC
+        if: ${{ matrix.node-version == '16' }}
+        uses: SonarSource/sonarcloud-github-action@v1.6
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
+        with:
+          projectBaseDir: packages/oidc

jest.config.js

@@ -13,7 +13,7 @@ module.exports = {
   ],
   reporters: ["default"],
   collectCoverage: true,
-  coverageReporters: ["text"],
+  coverageReporters: process.env.CI ? ["text", "lcov"] : ["text"],
   coverageThreshold: {
     global: {
       branches: 100,

packages/browser/sonar-project.properties

@@ -0,0 +1,15 @@
+sonar.projectKey=inrupt_solid-client-authn-browser
+sonar.projectName=solid-client-authn-browser
+sonar.organization=inrupt
+
+# Path is relative to the sonar-project.properties file. Defaults to .
+sonar.sources=src
+
+# Typescript tsconfigPath JSON file
+sonar.typescript.tsconfigPath=.
+
+# Comma-delimited list of paths to LCOV coverage report files. Paths may be absolute or relative to the project root.
+sonar.javascript.lcov.reportPaths=./coverage/lcov.info
+
+# Exclude tests from analysis
+sonar.exclusions=**/*.test.ts

packages/core/sonar-project.properties

@@ -0,0 +1,15 @@
+sonar.projectKey=inrupt_solid-client-authn-core
+sonar.projectName=solid-client-authn-core
+sonar.organization=inrupt
+
+# Path is relative to the sonar-project.properties file. Defaults to .
+sonar.sources=src
+
+# Typescript tsconfigPath JSON file
+sonar.typescript.tsconfigPath=.
+
+# Comma-delimited list of paths to LCOV coverage report files. Paths may be absolute or relative to the project root.
+sonar.javascript.lcov.reportPaths=./coverage/lcov.info
+
+# Exclude tests from analysis
+sonar.exclusions=**/*.test.ts

packages/node/sonar-project.properties

@@ -0,0 +1,15 @@
+sonar.projectKey=inrupt_solid-client-authn-node
+sonar.projectName=solid-client-authn-node
+sonar.organization=inrupt
+
+# Path is relative to the sonar-project.properties file. Defaults to .
+sonar.sources=src
+
+# Typescript tsconfigPath JSON file
+sonar.typescript.tsconfigPath=.
+
+# Comma-delimited list of paths to LCOV coverage report files. Paths may be absolute or relative to the project root.
+sonar.javascript.lcov.reportPaths=./coverage/lcov.info
+
+# Exclude tests from analysis
+sonar.exclusions=**/*.test.ts

packages/oidc/sonar-project.properties

@@ -0,0 +1,15 @@
+sonar.projectKey=inrupt_oidc-client-ext
+sonar.projectName=oidc-client-ext
+sonar.organization=inrupt
+
+# Path is relative to the sonar-project.properties file. Defaults to .
+sonar.sources=src
+
+# Typescript tsconfigPath JSON file
+sonar.typescript.tsconfigPath=.
+
+# Comma-delimited list of paths to LCOV coverage report files. Paths may be absolute or relative to the project root.
+sonar.javascript.lcov.reportPaths=./coverage/lcov.info
+
+# Exclude tests from analysis
+sonar.exclusions=**/*.test.ts