test: add code coverage report (#1336)

streetsidesoftware · Aug 16, 2023 · 2761a13 · 2761a13
1 parent 0ece0f5
commit 2761a13
Show file tree

Hide file tree

Showing 10 changed files with 50 additions and 6 deletions.
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -44,3 +44,26 @@ jobs:
       # Ensure the repository is clean after build
       - run: yarn clean-build
       - run: git --no-pager diff --compact-summary --exit-code
+
+  coverage: # run coverage
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Use Node.js
+        uses: actions/setup-node@v3
+        with:
+          cache: yarn
+      - run: yarn install --frozen-lockfile
+      - run: GITHUB_TOKEN=${{ secrets.GITHUB_TOKEN }} GITHUB_OUTPUT="" yarn coverage
+
+      - name: Upload coverage Coveralls
+        uses: coverallsapp/github-action@95b1a2355bd0e526ad2fd62da9fd386ad4c98474 # 2.2.1
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          path-to-lcov: ./action-src/coverage/lcov.info
+
+      - name: Upload coverage to Codecov
+        uses: codecov/codecov-action@eaaf4bedf32dbdc6b720b63067d99c4d77d6047d # v3
+        with:
+          directory: "./action-src"
+          files: ./coverage/lcov.info
diff --git a/action-src/package.json b/action-src/package.json
@@ -11,7 +11,8 @@
     "prepublishOnly": "yarn build",
     "smoke-test-push": "env-cmd -f ./fixtures/push.json node ./action/lib/main_root.js",
     "smoke-test": "env-cmd -f ./fixtures/pull_request.json node ./action/lib/main_root.js",
-    "test": "vitest run"
+    "test": "vitest run",
+    "coverage": "vitest run --coverage"
   },
   "bin": {
     "build": "./build.mjs"

diff --git a/action-src/src/index.ts b/action-src/src/index.ts
diff --git a/action-src/src/main_root.test.ts b/action-src/src/main_root.test.ts
@@ -0,0 +1,14 @@
+import { describe, test, expect, vi } from 'vitest';
+import { run } from './main';
+
+vi.mock('./main');
+
+import './main_root';
+
+const runMocked = vi.mocked(run);
+
+describe('main_root', () => {
+    test('run called', () => {
+        expect(runMocked).toHaveBeenCalled();
+    });
+});
diff --git a/action-src/src/main_root.ts b/action-src/src/main_root.ts
@@ -1,3 +1,3 @@
-import { run } from '.';
+import { run } from './main';
 
 run();
diff --git a/action-src/src/spell.test.ts b/action-src/src/spell.test.ts
@@ -53,7 +53,7 @@ describe('Validate Spell Checking', () => {
 
     test.each`
         glob                                  | checkDotFiles | expected
-        ${'fixtures/sampleDotFiles/**'}       | ${undefined}  | ${[sc('ts/sample.ts')]}
+        ${'fixtures/sampleDotFiles/**'}       | ${undefined}  | ${[sc('.dot_dir/sample_nested.ts'), sc('.dot_sample.ts'), sc('ts/sample.ts')]}
         ${'fixtures/sampleDotFiles/**'}       | ${true}       | ${[sc('.dot_dir/sample_nested.ts'), sc('.dot_sample.ts'), sc('ts/sample.ts')]}
         ${'fixtures/sampleDotFiles/**'}       | ${false}      | ${[sc('ts/sample.ts')]}
         ${'fixtures/sampleDotFiles/**/.*.ts'} | ${undefined}  | ${[sc('.dot_sample.ts')]}

diff --git a/action-src/src/test/helper.ts b/action-src/src/test/helper.ts
@@ -11,6 +11,7 @@ Polly.register(FSPersister);
 const tsconfig = require('../../tsconfig.json');
 
 export const sourceDir = path.resolve(path.join(__dirname, '..', '..'));
+/** Repo Root */
 export const root = path.resolve(path.join(sourceDir, '..'));
 export const fixturesLocation = path.join(sourceDir, 'fixtures');
 

diff --git a/action-src/vitest.config.ts b/action-src/vitest.config.ts
@@ -15,6 +15,8 @@ export default defineConfig({
                 'bin.mjs',
                 'bin.js',
                 'bin.cjs',
+                'build.mjs',
+                'fixtures/**',
                 '.coverage/**',
                 'coverage',
                 '_snapshots_',

diff --git a/cspell.json b/cspell.json
@@ -1,10 +1,14 @@
 {
     "version": "0.2",
     "$schema": "https://github.com/streetsidesoftware/cspell/main/cspell.schema.json",
+    "enableGlobDot": true,
     "words": [
-        "EDITMSG",
         "camelcase",
+        "codecov",
         "cosmiconfig",
+        "coverallsapp",
+        "EDITMSG",
+        "lcov",
         "octokit",
         "openapi",
         "pollyjs",

diff --git a/package.json b/package.json
@@ -11,8 +11,8 @@
     "clean-build": "yarn workspace action-src clean-build",
     "smoke-test-push": "env-cmd -f ./fixtures/push.json node ./action/lib/main_root.js",
     "smoke-test": "env-cmd -f ./fixtures/pull_request.json node ./action/lib/main_root.js",
-    "watch": "tsc -p . --watch",
     "test": "yarn workspace action-src test",
+    "coverage": "yarn workspace action-src coverage",
     "update-packages": "yarn upgrade && npx package-json-dependency-updater -u && yarn"
   },
   "workspaces": {