Integrate repo with Sonar

.github/workflows/prettier.yaml

@@ -19,8 +19,15 @@ jobs:
       - name: Install dependencies
         run: npm install # npm install instead of npm ci is used to prevent unsupported platform errors due to the fsevents sub-dependency --no-optional
 
-      - name: Run Prettier check
-        run: npm run prettier:check
-
       - name: Run lint check
-        run: npm run lint:check
+        run: npm run lint:ci
+
+      - name: Upload ESLint report
+        if: always()
+        uses: actions/upload-artifact@3cea5372237819ed00197afe530f5a7ea3e805c8 # v3.1.0
+        with:
+          name: eslint-report
+          path: ./eslint-report.json
+
+      - name: Run Prettier
+        run: npm run prettier:check

.github/workflows/sonar-scan.yaml

@@ -0,0 +1,78 @@
+name: SonarQube Scan
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+jobs:
+  wait_for_workflows:
+    name: Wait for workflows
+    runs-on: ubuntu-latest
+    if: always()
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v3
+        with:
+          ref: ${{ github.event.pull_request.head.sha || github.event.merge_group.head_sha }}
+
+      - name: Wait for workflows
+        uses: smartcontractkit/chainlink-github-actions/utils/wait-for-workflows@main
+        with:
+          max-timeout: '900'
+          polling-interval: '30'
+          exclude-workflow-names: 'Package Artifact Tests'
+          exclude-workflow-ids: ''
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+        env:
+          DEBUG: 'true'
+
+  sonarqube:
+    name: SonarQube Scan
+    needs: [wait_for_workflows]
+    runs-on: ubuntu-latest
+    if: always()
+    steps:
+      - name: Checkout the repo
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0 # fetches all history for all tags and branches to provide more metadata for sonar reports
+
+      - name: Download ESLint report
+        uses: dawidd6/[email protected]
+        with:
+          workflow: lint.yaml
+          workflow_conclusion: ''
+          name: eslint-report
+          if_no_artifact_found: warn
+
+      - name: Download unit-tests report
+        uses: dawidd6/[email protected]
+        with:
+          workflow: unit-test.yaml
+          workflow_conclusion: ''
+          name: unit-tests-coverage
+          if_no_artifact_found: warn
+
+      - name: Set SonarQube Report Paths
+        if: always()
+        id: sonarqube_report_paths
+        shell: bash
+        run: |
+          echo "sonarqube_coverage_report_paths=$(find -type f -name 'lcov.info' -printf "%p,")" >> $GITHUB_OUTPUT
+          echo "sonarqube_eslint_report_paths=$(find -type f -name 'eslint-report.json' -printf "%p")" >> $GITHUB_OUTPUT
+      - name: Update ESLint report symlinks
+        continue-on-error: true
+        run: sed -i 's+/home/runner/work/functions-toolkit/functions-toolkit/+/github/workspace/+g' ${{ steps.sonarqube_report_paths.outputs.sonarqube_eslint_report_paths }}
+
+      - name: SonarQube Scan
+        if: always()
+        uses: sonarsource/[email protected]
+        with:
+          args: >
+            -Dsonar.javascript.lcov.reportPaths=${{ steps.sonarqube_report_paths.outputs.sonarqube_coverage_report_paths }}
+            -Dsonar.eslint.reportPaths=${{ steps.sonarqube_report_paths.outputs.sonarqube_eslint_report_paths }}
+        env:
+          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
+          SONAR_HOST_URL: ${{ secrets.SONAR_HOST_URL }}

.github/workflows/test.yaml

@@ -1,7 +1,10 @@
-name: Jest Tests
+name: Unit Tests
 
 on:
   pull_request:
+  push:
+    branches:
+      - main
 
 jobs:
   tests:
@@ -11,20 +14,27 @@ jobs:
 
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
 
       - name: Set up Node.js
-        uses: actions/setup-node@v2
+        uses: actions/setup-node@v3
         with:
           node-version: 18
 
       - name: Install dependencies
         run: npm install # npm install instead of npm ci is used to prevent unsupported platform errors due to the fsevents sub-dependency
-
       - name: Setup Deno
         uses: denolib/setup-deno@v2
         with:
           deno-version: '1.36.2'
 
-      - name: Run Jest tests
-        run: npm test
+      # 'integration' are the Jest tests that cover code in unit-testing way, so both are included
+      - name: Run unit tests
+        run: npm run test:ci
+
+      - name: Upload unit-test coverage report
+        if: always()
+        uses: actions/[email protected]
+        with:
+          name: unit-tests-coverage
+          path: ./coverage/lcov.info

.gitignore

@@ -2,7 +2,10 @@ node_modules
 /test/hardhat/node_modules
 /test/hardhat/build
 /test/hardhat/.openzeppelin
+.DS_Store
+dist
+
+# Reports
 /coverage
 coverage.json
-.DS_Store
-dist
+*report.json

.prettierignore

@@ -1,2 +1,3 @@
 dist
 node_modules
+*report.json

jest.config.js

@@ -5,7 +5,7 @@ module.exports = {
   testMatch: ['**/test/**/*.test.ts'],
   testTimeout: 2 * 60 * 1000,
 
-  coverageReporters: ['html'],
+  coverageReporters: ['html', 'lcov'],
   collectCoverageFrom: ['src/**/*.ts', '!src/test/*.ts', '!src/simulateScript/deno-sandbox/*.ts'],
   coverageThreshold: {
     global: {

package.json

@@ -8,11 +8,11 @@
     "build": "rimraf dist && tsc -P tsconfig.build.json && cpy src/simulateScript/deno-sandbox/**/* dist/simulateScript/deno-sandbox",
     "build:browser": "webpack && browserify dist/simulateScript.bundle.js -o dist/simulateScript.browser.js -p esmify --standalone simulateScript && rm dist/simulateScript.bundle.js",
     "test": "jest",
-    "test:unit": "jest --testPathPattern=unit",
-    "test:integration": "jest --testPathPattern=integration",
+    "test:ci": "jest --coverage",
     "test:package": "jest --config jest.config.package.js",
-    "lint:check": "eslint 'src/**/*.{ts,tsx}'",
-    "lint:fix": "eslint 'src/**/*.{ts,tsx}' --fix",
+    "lint:check": "eslint --ext js,jsx,ts,tsx .",
+    "lint:ci": "eslint --ext js,jsx,ts,tsx . -f json -o eslint-report.json",
+    "lint:fix": "eslint --ext js,jsx,ts,tsx . --fix",
     "prettier:check": "prettier --check . && tsc --noEmit",
     "prettier:fix": "npx prettier -w ."
   },

sonar-project.properties

@@ -0,0 +1,11 @@
+sonar.projectKey=smartcontractkit_functions-toolkit
+sonar.sources=.
+
+# Full exclusions from the static analysis
+sonar.exclusions=**/node_modules/**/*, **/mocks/**/*, **/testdata/**/*, **/demo/**/*, **/contracts/**/*, **/generated/**/*, **/fixtures/**/*, **/docs/**/*, **/tools/**/*, **/*.fixtures.ts, **/apiFixture.ts, **/*report.xml, **/*.config.ts, **/*.txt, **/*.abi, **/*.bin
+# Coverage exclusions
+sonar.coverage.exclusions=**/*.test.ts, **/test/**/*,  **/contracts/**/*, **/testutils/**/*, **/test/integration/**/*, **/*.config.js, **/*.config.ts,
+
+# Tests' root folder, inclusions (tests to check and count) and exclusions
+sonar.tests=.
+sonar.test.inclusions=**/*.test.ts