From 6a96badeb1c6b8ddb2b946eec2b9d8ebac96e1fd Mon Sep 17 00:00:00 2001
From: David LJ <mail@davidlj95.com>
Date: Sun, 7 Jul 2024 20:16:23 +0200
Subject: [PATCH] test: report merged tests coverage (#656)

* test: merge tests coverage

* test: use coverage:report run script

* ci: add job to collect & publish coverage results

* ci: add coverage dir to codecov action

* test: create lcov merged report for Codecov

* ci: keep old component tests job name

* ci: use previous unit tests name
---
 .github/workflows/main.yml                    |  2 +
 .github/workflows/pull-request.yml            |  2 +
 .github/workflows/reusable-test.yml           | 50 +++++++++++++++++--
 .../Cypress__all_component_tests.xml          |  2 +-
 karma.conf.js                                 |  7 ++-
 package.json                                  | 11 +++-
 pnpm-lock.yaml                                | 48 ++++++++++++++++--
 7 files changed, 109 insertions(+), 13 deletions(-)

diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
index 38c436dc..dd5b3ca8 100644
--- a/.github/workflows/main.yml
+++ b/.github/workflows/main.yml
@@ -20,6 +20,8 @@ jobs:
     uses: ./.github/workflows/reusable-test.yml
     permissions:
       checks: write
+    secrets:
+      codecov-token: ${{ secrets.CODECOV_TOKEN }}
   lint:
     name: Lint
     uses: ./.github/workflows/reusable-lint.yml
diff --git a/.github/workflows/pull-request.yml b/.github/workflows/pull-request.yml
index a780ef19..51d6f683 100644
--- a/.github/workflows/pull-request.yml
+++ b/.github/workflows/pull-request.yml
@@ -15,6 +15,8 @@ jobs:
   test:
     name: Test
     uses: ./.github/workflows/reusable-test.yml
+    secrets:
+      codecov-token: ${{ secrets.CODECOV_TOKEN }}
   lint:
     name: Lint
     uses: ./.github/workflows/reusable-lint.yml
diff --git a/.github/workflows/reusable-test.yml b/.github/workflows/reusable-test.yml
index ac736777..790bfd56 100644
--- a/.github/workflows/reusable-test.yml
+++ b/.github/workflows/reusable-test.yml
@@ -7,12 +7,20 @@ on:
         type: string
         required: false
         default: ''
+    secrets:
+      codecov-token:
+        description: Token to use to upload coverage to Codecov. Can be empty for forks https://about.codecov.io/blog/january-product-update-updating-the-codecov-ci-uploaders-to-the-codecov-cli/
+        required: true
 
 # Add those permissions if reporting test results
 # https://github.com/dorny/test-reporter/issues/229
 # permissions:
 #   checks: write
 
+env:
+  COVERAGE_ARTIFACT_NAME_PREFIX: coverage-
+  COVERAGE_DIR: coverage
+
 jobs:
   templates-have-been-rendered:
     name: Templated files are rendered
@@ -49,12 +57,12 @@ jobs:
           name: Test results
           path: '*.xml'
           reporter: java-junit
-      - name: Report coverage
-        # noinspection SpellCheckingInspection
-        uses: livewing/lcov-job-summary@0a9952db27f98def2ba2de3189c6b24acc4c5501 # v1.1.0
-        if: success() || failure()
+      - name: Upload coverage results
+        uses: actions/upload-artifact@65462800fd760344b1a7b4382951275a0abb4808 # v4
         with:
-          lcov: coverage/davidlj95/website/lcov.info
+          name: ${{ env.COVERAGE_ARTIFACT_NAME_PREFIX }}${{ github.job }}
+          path: ${{ env.COVERAGE_DIR }}
+          retention-days: 5
 
   component-test:
     name: Component tests
@@ -102,3 +110,35 @@ jobs:
           # Given we're doing caching manually, installing apart to leverage cache
           install: false
           component: true
+      - name: Upload coverage results
+        uses: actions/upload-artifact@65462800fd760344b1a7b4382951275a0abb4808 # v4
+        with:
+          name: ${{ env.COVERAGE_ARTIFACT_NAME_PREFIX }}${{ github.job }}
+          path: ${{ env.COVERAGE_DIR }}
+          retention-days: 5
+
+  coverage:
+    name: Coverage
+    needs: [test, component-test]
+    runs-on: ubuntu-latest
+    timeout-minutes: 5
+    steps:
+      - name: Checkout
+        uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4
+        with:
+          ref: ${{ inputs.ref }}
+      - name: Setup
+        uses: ./.github/actions/setup
+      - name: Download code coverage reports
+        uses: actions/download-artifact@65a9edc5881444af0b9093a5e628f2fe47ea3b2e # v4
+        with:
+          pattern: ${{ env.COVERAGE_ARTIFACT_NAME_PREFIX }}*
+          path: ${{ env.COVERAGE_DIR }}
+          merge-multiple: true
+      - name: Merge coverage reports
+        run: pnpm run coverage:report:all
+      - name: Upload to Codecov
+        uses: codecov/codecov-action@v4.0.1
+        with:
+          directory: ${{ env.COVERAGE_DIR }}
+          token: ${{ secrets.codecov-token }}
diff --git a/.idea/runConfigurations/Cypress__all_component_tests.xml b/.idea/runConfigurations/Cypress__all_component_tests.xml
index 1e0fe0b4..b3d378ec 100644
--- a/.idea/runConfigurations/Cypress__all_component_tests.xml
+++ b/.idea/runConfigurations/Cypress__all_component_tests.xml
@@ -3,7 +3,7 @@
     <package-json value="$PROJECT_DIR$/package.json" />
     <command value="run" />
     <scripts>
-      <script value="cypress:run-ct" />
+      <script value="cypress:run:ct" />
     </scripts>
     <node-interpreter value="project" />
     <envs />
diff --git a/karma.conf.js b/karma.conf.js
index 0ef15a40..f73bb16f 100644
--- a/karma.conf.js
+++ b/karma.conf.js
@@ -26,9 +26,12 @@ module.exports = function (config) {
       suppressAll: true, // removes the duplicated traces
     },
     coverageReporter: {
-      dir: require('path').join(__dirname, './coverage/davidlj95/website'),
+      dir: require('path').join(__dirname, './coverage'),
       subdir: '.',
-      reporters: [{ type: 'text-summary' }, { type: 'lcov' }],
+      reporters: [
+        { type: 'text-summary' },
+        { type: 'json', file: 'unit-testing.json' },
+      ],
       check: {
         global: {
           statements: 80,
diff --git a/package.json b/package.json
index eb6430ed..0ad57bbe 100644
--- a/package.json
+++ b/package.json
@@ -15,6 +15,10 @@
     "build:pullRequest": "pnpm run build --configuration pullRequest,production",
     "watch": "ng build --watch --configuration development",
     "test": "ng test",
+    "test:coverage": "ng test --code-coverage --watch false",
+    "//0": "👇 Can't be 'coverage:report', look for that run script comments for reason",
+    "coverage:report:all": "pnpm run coverage:move-to-nyc-output && nyc report --reporter lcov --report-dir coverage",
+    "coverage:move-to-nyc-output": "rm -rf .nyc_output && mkdir .nyc_output && cp -f coverage/*.json .nyc_output",
     "security-txt": "tsm scripts/src/generate-security-txt.ts",
     "lint": "ng lint",
     "lint-staged": "lint-staged",
@@ -36,7 +40,11 @@
     "e2e": "ng e2e",
     "cypress:open": "cypress open",
     "cypress:run": "cypress run",
-    "cypress:run-ct": "cypress run --component"
+    "cypress:run:ct": "cypress run --component",
+    "//2": "👇 Cypress executes it to perform custom reporting. With this:",
+    "//3": "    - **same filename for local/CI**: the 'mv' command is run in both local & CI, so JSON coverage filename is the same",
+    "//4": "    - **.nycrc* config files avoided:** could be mistakenly used by other tools",
+    "coverage:report": "nyc report --reporter json --report-dir coverage && mv -f coverage/coverage-final.json coverage/component-testing.json"
   },
   "dependencies": {
     "@angular/animations": "18.0.5",
@@ -106,6 +114,7 @@
     "lint-staged": "15.2.7",
     "liquidjs": "10.14.0",
     "ng-mocks": "14.13.0",
+    "nyc": "17.0.0",
     "prettier": "3.3.2",
     "semantic-release": "24.0.0",
     "subset-font": "2.3.0",
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
index 9ae72389..57932c6d 100644
--- a/pnpm-lock.yaml
+++ b/pnpm-lock.yaml
@@ -110,7 +110,7 @@ importers:
         version: 19.0.3
       '@cypress/code-coverage':
         specifier: 3.12.41
-        version: 3.12.41(@babel/core@7.24.7)(@babel/preset-env@7.24.5(@babel/core@7.24.7))(babel-loader@9.1.3(@babel/core@7.24.7)(webpack@5.91.0))(cypress@13.13.0)(webpack@5.91.0)
+        version: 3.12.41(@babel/core@7.24.7)(@babel/preset-env@7.24.5(@babel/core@7.24.7))(babel-loader@9.1.3(@babel/core@7.24.7)(webpack@5.91.0))(cypress@13.13.0)(webpack@5.91.0(esbuild@0.21.3))
       '@lhci/cli':
         specifier: 0.14.0
         version: 0.14.0(encoding@0.1.13)
@@ -204,6 +204,9 @@ importers:
       ng-mocks:
         specifier: 14.13.0
         version: 14.13.0(@angular/common@18.0.5(@angular/core@18.0.5(rxjs@7.8.1)(zone.js@0.14.7))(rxjs@7.8.1))(@angular/core@18.0.5(rxjs@7.8.1)(zone.js@0.14.7))(@angular/forms@18.0.5(@angular/common@18.0.5(@angular/core@18.0.5(rxjs@7.8.1)(zone.js@0.14.7))(rxjs@7.8.1))(@angular/core@18.0.5(rxjs@7.8.1)(zone.js@0.14.7))(@angular/platform-browser@18.0.5(@angular/animations@18.0.5(@angular/core@18.0.5(rxjs@7.8.1)(zone.js@0.14.7)))(@angular/common@18.0.5(@angular/core@18.0.5(rxjs@7.8.1)(zone.js@0.14.7))(rxjs@7.8.1))(@angular/core@18.0.5(rxjs@7.8.1)(zone.js@0.14.7)))(rxjs@7.8.1))(@angular/platform-browser@18.0.5(@angular/animations@18.0.5(@angular/core@18.0.5(rxjs@7.8.1)(zone.js@0.14.7)))(@angular/common@18.0.5(@angular/core@18.0.5(rxjs@7.8.1)(zone.js@0.14.7))(rxjs@7.8.1))(@angular/core@18.0.5(rxjs@7.8.1)(zone.js@0.14.7)))
+      nyc:
+        specifier: 17.0.0
+        version: 17.0.0
       prettier:
         specifier: 3.3.2
         version: 3.3.2
@@ -5650,6 +5653,11 @@ packages:
     engines: {node: '>=8.9'}
     hasBin: true
 
+  nyc@17.0.0:
+    resolution: {integrity: sha512-ISp44nqNCaPugLLGGfknzQwSwt10SSS5IMoPR7GLoMAyS18Iw5js8U7ga2VF9lYuMZ42gOHr3UddZw4WZltxKg==}
+    engines: {node: '>=18'}
+    hasBin: true
+
   object-assign@4.1.1:
     resolution: {integrity: sha512-rJgTQnkUnH1sFw8yT6VSU3zD3sWmu6sZhIseY8VX+GRu3P6F7Fu+JNDoXfklElbLJSnc3FUQHVe4cU5hj+BcUg==}
     engines: {node: '>=0.10.0'}
@@ -9364,11 +9372,11 @@ snapshots:
       '@types/conventional-commits-parser': 5.0.0
       chalk: 5.3.0
 
-  '@cypress/code-coverage@3.12.41(@babel/core@7.24.7)(@babel/preset-env@7.24.5(@babel/core@7.24.7))(babel-loader@9.1.3(@babel/core@7.24.7)(webpack@5.91.0))(cypress@13.13.0)(webpack@5.91.0)':
+  '@cypress/code-coverage@3.12.41(@babel/core@7.24.7)(@babel/preset-env@7.24.5(@babel/core@7.24.7))(babel-loader@9.1.3(@babel/core@7.24.7)(webpack@5.91.0))(cypress@13.13.0)(webpack@5.91.0(esbuild@0.21.3))':
     dependencies:
       '@babel/core': 7.24.7
       '@babel/preset-env': 7.24.5(@babel/core@7.24.7)
-      '@cypress/webpack-preprocessor': 6.0.2(@babel/core@7.24.7)(@babel/preset-env@7.24.5(@babel/core@7.24.7))(babel-loader@9.1.3(@babel/core@7.24.7)(webpack@5.91.0))(webpack@5.91.0)
+      '@cypress/webpack-preprocessor': 6.0.2(@babel/core@7.24.7)(@babel/preset-env@7.24.5(@babel/core@7.24.7))(babel-loader@9.1.3(@babel/core@7.24.7)(webpack@5.91.0))(webpack@5.91.0(esbuild@0.21.3))
       babel-loader: 9.1.3(@babel/core@7.24.7)(webpack@5.91.0)
       chalk: 4.1.2
       cypress: 13.13.0
@@ -9404,7 +9412,7 @@ snapshots:
       tunnel-agent: 0.6.0
       uuid: 8.3.2
 
-  '@cypress/webpack-preprocessor@6.0.2(@babel/core@7.24.7)(@babel/preset-env@7.24.5(@babel/core@7.24.7))(babel-loader@9.1.3(@babel/core@7.24.7)(webpack@5.91.0))(webpack@5.91.0)':
+  '@cypress/webpack-preprocessor@6.0.2(@babel/core@7.24.7)(@babel/preset-env@7.24.5(@babel/core@7.24.7))(babel-loader@9.1.3(@babel/core@7.24.7)(webpack@5.91.0))(webpack@5.91.0(esbuild@0.21.3))':
     dependencies:
       '@babel/core': 7.24.7
       '@babel/preset-env': 7.24.5(@babel/core@7.24.7)
@@ -14201,6 +14209,38 @@ snapshots:
     transitivePeerDependencies:
       - supports-color
 
+  nyc@17.0.0:
+    dependencies:
+      '@istanbuljs/load-nyc-config': 1.1.0
+      '@istanbuljs/schema': 0.1.3
+      caching-transform: 4.0.0
+      convert-source-map: 1.9.0
+      decamelize: 1.2.0
+      find-cache-dir: 3.3.2
+      find-up: 4.1.0
+      foreground-child: 2.0.0
+      get-package-type: 0.1.0
+      glob: 7.2.3
+      istanbul-lib-coverage: 3.2.2
+      istanbul-lib-hook: 3.0.0
+      istanbul-lib-instrument: 6.0.2
+      istanbul-lib-processinfo: 2.0.3
+      istanbul-lib-report: 3.0.1
+      istanbul-lib-source-maps: 4.0.1
+      istanbul-reports: 3.1.7
+      make-dir: 3.1.0
+      node-preload: 0.2.1
+      p-map: 3.0.0
+      process-on-spawn: 1.0.0
+      resolve-from: 5.0.0
+      rimraf: 3.0.2
+      signal-exit: 3.0.7
+      spawn-wrap: 2.0.0
+      test-exclude: 6.0.0
+      yargs: 15.4.1
+    transitivePeerDependencies:
+      - supports-color
+
   object-assign@4.1.1: {}
 
   object-inspect@1.13.1: {}