Adding unit tests to improve the code coverage of jest unit tests in ZAP

.github/workflows/release.yml

@@ -130,13 +130,33 @@ jobs:
         with:
           node-version: ${{ matrix.node-version }}
           cache: 'npm'
+
+      # Download Jest coverage from generate-and-backend-tests job
       - name: Download jest coverage artifact
         uses: actions/download-artifact@v4
         with:
           name: jest-coverage
+          path: jest-coverage/
+
+      # Download Cypress coverage from cypress-zigbee job
+      - name: Download cypress-zigbee coverage artifact
+        uses: actions/download-artifact@v4
+        with:
+          name: cypress-zigbee-coverage
+          path: cypress-coverage/
+        continue-on-error: true
+
       - run: sudo ./src-script/install-packages-ubuntu
+      - run: sudo apt-get install --fix-missing xvfb
       - run: npm ci
-      - run: npm run report
+      - run: npm run version-stamp
+      - run: npm rebuild canvas --update-binary
+      - run: npm rebuild libxmljs --update-binary
+
+      # Combine Jest and Cypress coverage and enforce 80% threshold
+      - name: Combine coverage and check 80% threshold
+        run: npm run coverage:combine
+
       - name: Codecov
         uses: codecov/[email protected]
 

babel.config.js

@@ -17,6 +17,12 @@ module.exports = (api) => {
     presets: [
       ['@quasar/babel-preset-app', envOptions],
       '@babel/preset-typescript'
-    ]
+    ],
+    plugins: [
+      // Add Istanbul plugin for code coverage instrumentation when testing
+      process.env.NODE_ENV === 'test' && 'istanbul',
+      // Add coverage plugin for Cypress
+      process.env.CYPRESS_COVERAGE && 'istanbul'
+    ].filter(Boolean)
   }
 }

cypress.config.js

@@ -9,7 +9,17 @@ export default defineConfig({
     // We've imported your old cypress plugins here.
     // You may want to clean this up later by importing these.
     setupNodeEvents(on, config) {
-      return require('./cypress/plugins/index.js')(on, config)
+      require('@cypress/code-coverage/task')(on, config)
+
+      // Optional: Add coverage configuration
+      on('task', {
+        coverage(coverage) {
+          // Custom coverage processing if needed
+          return null
+        }
+      })
+
+      return config
     },
     testIsolation: false,
     excludeSpecPattern: [

cypress/support/e2e.js

@@ -19,3 +19,11 @@ import './commands'
 // Alternatively you can use CommonJS syntax:
 // require('./commands')
 import '@cypress/code-coverage/support'
+
+// Collect coverage from window object
+Cypress.on('window:before:load', (win) => {
+  if (win.__coverage__) {
+    // Coverage data is available
+    console.log('Coverage data found on window object')
+  }
+})

jest.config.js

@@ -58,5 +58,6 @@ module.exports = {
   coveragePathIgnorePatterns: [
     '/node_modules/',
     '<rootDir>/src-electron/generator/matter/darwin/Framework/CHIP/templates/helper.js'
-  ]
+  ],
+  testEnvironment: 'jsdom'
 }

package.json

@@ -36,7 +36,10 @@
     "test:unit:watch": "jest --watch",
     "test:unit:watchAll": "jest --watchAll",
     "test:e2e": "node src-script/zap-uitest.js open zigbee",
-    "test:e2e-ci": "node src-script/zap-uitest.js run zigbee",
+    "test:e2e-ci": "cross-env NODE_ENV=test CYPRESS_COVERAGE=true node src-script/zap-uitest.js run zigbee",
+    "test:e2e-coverage": "npm run test:e2e-ci && npm run coverage:combine",
+    "coverage:combine": "node src-script/zap-combine-reports.js",
+    "test:coverage": "npm run test:unit:coverage && npm run test:e2e-ci && npm run coverage:combine",
     "test:e2e-matter": "node src-script/zap-uitest.js open matter",
     "test:e2e-matter-ci": "node src-script/zap-uitest.js run matter",
     "report": "node src-script/zap-combine-reports.js",
@@ -173,6 +176,7 @@
     "@vue/test-utils": "^2.4.6",
     "7zip-bin": "^5.2.0",
     "autoprefixer": "^10.4.20",
+    "babel-plugin-istanbul": "^7.0.1",
     "cross-env": "^7.0.3",
     "cross-spawn": "^7.0.3",
     "cypress": "^13.6.6",
@@ -206,10 +210,10 @@
     "pkg": "^5.8.1",
     "prettier": "^3.3.3",
     "pretty-quick": "^4.0.0",
+    "sonar-scanner": "^3.1.0",
     "test-utils": "^1.1.1",
     "typescript": "4.6",
-    "workbox-webpack-plugin": "^7.1.0",
-    "sonar-scanner": "^3.1.0"
+    "workbox-webpack-plugin": "^7.1.0"
   },
   "engines": {
     "node": ">= 8.9.0",
@@ -314,13 +318,30 @@
   },
   "nyc": {
     "report-dir": "cypress-coverage",
+    "reporter": [
+      "json",
+      "lcov",
+      "text"
+    ],
     "include": [
       "src/**/*.js",
-      "src/**/*.ts",
       "src-electron/**/*.js",
-      "src-electron/**/*.ts",
-      "src-shared/**/*.js",
-      "src-shared/**/*.ts"
+      "src-shared/**/*.js"
+    ],
+    "exclude": [
+      "**/*.test.js",
+      "**/*.spec.js",
+      "**/node_modules/**",
+      "cypress/**/*",
+      "dist/**/*"
+    ],
+    "all": true,
+    "cache": false,
+    "instrument": true,
+    "sourceMap": false,
+    "extension": [
+      ".js",
+      ".vue"
     ]
   },
   "pkg": {

quasar.conf.js

@@ -2,6 +2,7 @@
 // https://quasar.dev/quasar-cli/quasar-conf-js
 const ESLintPlugin = require('eslint-webpack-plugin')
 const { configure } = require('quasar/wrappers')
+const path = require('path')
 
 module.exports = configure(function (ctx) {
   return {
@@ -84,6 +85,39 @@ module.exports = configure(function (ctx) {
           loader: 'file-loader',
           exclude: /node_modules/
         })
+      },
+      chainWebpack(chain, { isServer, isClient }) {
+        // Add Istanbul loader for coverage when testing
+        if (process.env.CYPRESS_COVERAGE) {
+          // Handle JS files
+          chain.module
+            .rule('istanbul-js')
+            .test(/\.js$/)
+            .enforce('post')
+            .include.add(path.resolve(__dirname, 'src'))
+            .add(path.resolve(__dirname, 'src-electron'))
+            .add(path.resolve(__dirname, 'src-shared'))
+            .end()
+            .exclude.add(/node_modules/)
+            .add(/\.spec\.js$/)
+            .add(/cypress/)
+            .end()
+            .use('istanbul-instrumenter-loader')
+            .loader('istanbul-instrumenter-loader')
+            .options({
+              esModules: true
+            })
+
+          // Handle Vue files - target the compiled JavaScript from vue-loader
+          chain.module
+            .rule('vue')
+            .use('istanbul-instrumenter-loader')
+            .loader('istanbul-instrumenter-loader')
+            .options({
+              esModules: true
+            })
+            .before('vue-loader')
+        }
       }
     },
 

sonar-project.properties

@@ -13,7 +13,7 @@ sonar.organization=project-chip
 #sonar.projectKey=watt_zap
 sonar.projectName=Zcl Advanced Platform
 sonar.sources=src,src-electron,src-shared
-sonar.javascript.lcov.reportPaths=jest-coverage/lcov.info,cypress-coverage/lcov.info
+sonar.javascript.lcov.reportPaths=coverage/lcov.info
 sonar.host.url=https://sonarqube.silabs.net
 sonar.token=put your token here which can be created from the above url
 # sonar.plsql.jdbc.url=test/.zap/test-server.sqlite