SonarCloud integration

.eslintrc.yaml

@@ -10,6 +10,7 @@ ignorePatterns:
   - "packages/**/wasm/*.js"
   - "!.storybook"
   - storybook-static
+  - coverage
 
 plugins:
   - file-progress

.github/workflows/sonarqube.yml

@@ -0,0 +1,46 @@
+name: SonarCloud
+
+on:
+  push:
+    branches: ["main"]
+  pull_request:
+    branches: ["main"]
+    types: [opened, synchronize, reopened]
+  workflow_dispatch:
+
+jobs:
+  build:
+    name: SonarCloud
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/[email protected]
+        with:
+          fetch-depth: 0 # Shallow clones should be disabled for a better relevancy of analysis
+          lfs: true
+
+      - name: Set up Node.js
+        uses: actions/[email protected]
+        with:
+          node-version: 16.17
+
+      - name: Enable corepack
+        run: corepack enable yarn
+
+      - name: Install dependencies
+        run: yarn install
+
+      - name: Generates lint report and file path formatting
+        run: |
+          yarn lint:ci:report
+          sed -i 's|/home/runner/work/lichtblick/lichtblick/|./|g' eslint-report.json
+        continue-on-error: true
+
+      - name: Test and coverage
+        run: yarn test:coverage
+        continue-on-error: true
+
+      - name: ScanCloud Scan
+        uses: SonarSource/sonarcloud-github-action@master
+        env:
+          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
+          SONAR_HOST_URL: ${{ vars.SONAR_HOST_URL }}

.gitignore

@@ -19,3 +19,8 @@ coverage/
 
 # Extensions
 *.foxe
+
+# SonarQube files
+.sonar_lock
+.scannerwork
+eslint-report.json

jest.config.json

@@ -4,5 +4,13 @@
     "<rootDir>/ci/jest.config.json",
     "<rootDir>/desktop/jest.config.json",
     "<rootDir>/packages/*/jest.config.json"
-  ]
+  ],
+  "collectCoverage": true,
+  "coverageReporters": [
+    "text",
+    "lcov",
+    "json",
+    "xml"
+  ],
+  "coverageDirectory": "coverage"
 }

package.json

@@ -20,7 +20,7 @@
     "node": ">=16"
   },
   "scripts": {
-    "clean": "tsc --build --clean packages/**/tsconfig.json && rimraf .webpack */.webpack dist storybook-screenshots storybook-static",
+    "clean": "tsc --build --clean packages/**/tsconfig.json && rimraf .webpack */.webpack dist storybook-screenshots storybook-static coverage",
     "build:packages": "tsc --build --verbose packages/*/tsconfig.json packages/*/src/*/tsconfig.json",
     "desktop:build:dev": "webpack --mode development --progress --config desktop/webpack.config.ts",
     "desktop:build:prod": "webpack --mode production --progress --config desktop/webpack.config.ts",
@@ -35,9 +35,11 @@
     "license-check": "ts-node ci/license-check.ts",
     "lint": "TIMING=1 eslint --report-unused-disable-directives --fix .",
     "lint:ci": "TIMING=1 eslint --report-unused-disable-directives --config .eslintrc.ci.yaml .",
+    "lint:ci:report": "yarn lint:ci -f json -o eslint-report.json --quiet",
     "lint:unused-exports": "ts-node ./ci/lint-unused-exports.ts",
     "lint:dependencies": "ts-node ./ci/lint-dependencies.ts .",
     "test": "jest",
+    "test:coverage": "jest --coverage",
     "test:debug": "cross-env NODE_OPTIONS='--inspect-brk' jest",
     "test:watch": "jest --watch",
     "test:integration": "jest --forceExit --projects desktop/integration-test",

sonar-project.properties

@@ -0,0 +1,24 @@
+# General
+sonar.projectKey=Lichtblick-Suite_lichtblick
+sonar.organization=lichtblick-suite
+
+# TS and Lint
+sonar.typescript.tsconfigPath=tsconfig.json
+sonar.eslint.reportPaths=eslint-report.json
+
+# Path to sources
+sonar.sources=benchmark,ci,desktop,packages,web
+sonar.exclusions=**/*.test.ts,**/*.test.tsx
+sonar.inclusions=\
+  **/*.ts,\
+  **/*.tsx,\
+  **/*.js,\
+  **/package.json
+
+# Path to tests
+sonar.tests=benchmark,ci,desktop,packages,web
+sonar.test.inclusions=**/*.test.ts,**/*.test.tsx
+
+# Code coverage
+sonar.javascript.lcov.reportPaths=coverage/lcov.info
+sonar.typescript.lcov.reportPaths=coverage/lcov.info

tsconfig.json

@@ -8,7 +8,6 @@
     "./*.js",
     "./**/jest.config.ts",
     "./ci/**/*.ts",
-    "./resources/notarize.ts",
     "./package.json"
   ],
   "compilerOptions": {