Enable coverage and codeclimate (#31)

Author: JonatanAntoni

.github/workflows/ci.yml

@@ -82,14 +82,22 @@ jobs:
           git commit -m "Update CHANGELOG.md after release [skip ci]"
           git push
 
+      - name: Publish coverage report to Code Climate
+        uses: paambaati/codeclimate-action@f429536ee076d758a24705203199548125a28ca7 # v9.0.0
+        env:
+          CC_TEST_REPORTER_ID: ${{secrets.CC_TEST_REPORTER_ID}}
+        with:
+          debug: true
+          coverageLocations: coverage/lcov.info:lcov
+
   package:
     name: Package
     runs-on: [ubuntu-latest]
     needs: build
     strategy:
       fail-fast: true
       matrix:
-        target: 
+        target:
           - win32-x64
           - win32-arm64
           - linux-x64
@@ -146,8 +154,8 @@ jobs:
       - name: Download packages
         uses: actions/download-artifact@fa0a91b85d4f404e444e00e005971372dc801d16 # v4.1.8
         with:
-          pattern: vsix-package-* 
-        
+          pattern: vsix-package-*
+
       - name: Attach packages
         uses: softprops/action-gh-release@c95fe1489396fe8a9eb87c0abf8aa5b2ef267fda # v2.2.1
         with:

.gitignore

@@ -5,3 +5,4 @@ dist
 test-workspace/*
 !test-workspace/.vscode
 tools
+coverage

.vscodeignore

@@ -4,14 +4,16 @@
 .vscodeignore
 *.vsix
 DEVELOPMENT.md
+__mocks__/**/*
 dist/**/*.js.map
-eslint.config.mjs
 node_modules
 src
 test-workspace
 tsconfig.json
-webpack.config.js
 scripts
 tools/**/version.txt
 tools/**/target.txt
 tools/**/sha256.txt
+coverage
+*.config.{mjs,js,mts,ts}
+*.setup.{mjs,js,mts,ts}

__mocks__/vscode.js

@@ -0,0 +1,32 @@
+/**
+ * Copyright 2025 Arm Limited
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+const { URI } = require('vscode-uri');
+
+module.exports = {
+    Uri: URI,
+    workspace: {
+        getConfiguration: jest.fn(() => ({
+            get: jest.fn(),
+        })),
+    },
+    extensions: {
+        getExtension: jest.fn(),
+    },
+    commands: {
+        executeCommand: jest.fn(),
+    }
+};

eslint.config.mjs

@@ -20,12 +20,14 @@ import tseslint from 'typescript-eslint';
 export default [
     {
         ignores: [
+            "__mocks__/**/*",
+            "coverage/**/*",
             "dist",
             "scripts",
             "**/*.d.ts",
-            "jest.config.js",
+            "*.config.{ts,js,mjs}",
+            "*.setup.{ts,js}",
             "node_modules",
-            "webpack.config.js"
         ]
     },
     js.configs.recommended,

jest.config.js

@@ -0,0 +1,41 @@
+/**
+ * Copyright 2025 Arm Limited
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import type { Config } from 'jest';
+
+const config: Config = {  
+  testEnvironment: "node",
+  preset: "ts-jest",
+  transform: {
+    "^.+\\.tsx?$": [
+      "ts-jest", {
+      }
+    ],
+  },
+  setupFiles: ["<rootDir>/jest.setup.ts"],
+  clearMocks: true,
+  collectCoverage: true,
+  collectCoverageFrom: [
+    "src/**/*.{ts,tsx}",
+    "!**/*.d.ts",
+    "!**/*.factories.{ts,tsx}",
+    "!src/desktop/extension.ts",
+  ],
+  coverageDirectory: "./coverage",
+  coverageReporters: ["lcov", "text"],
+};
+
+export default config;

jest.config.ts

@@ -0,0 +1,16 @@
+/**
+ * Copyright 2025 Arm Limited
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+

jest.setup.ts

@@ -227,7 +227,7 @@
     "build": "webpack --mode production && yarn lint",
     "watch": "webpack -w",
     "lint": "eslint .",
-    "test": "jest --passWithNoTests",
+    "test": "jest",
     "package": "vsce package --yarn"
   },
   "vsce": {
@@ -254,6 +254,7 @@
     "ts-node": "^10.9.2",
     "typescript": "^5.4.5",
     "typescript-eslint": "8.24.1",
+    "vscode-uri": "^3.1.0",
     "webpack": "^5.98.0",
     "webpack-cli": "^6.0.1",
     "yargs": "^17.7.2"

package.json

@@ -0,0 +1,60 @@
+/**
+ * Copyright 2025 Arm Limited
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import * as vscode from 'vscode';
+import * as fs from 'fs';
+import * as os from 'os';
+import * as path from 'path';
+import { BuiltinToolPath } from './builtin-tool-path';
+
+const TOOL_EXTENSION = os.platform() === 'win32' ? '.exe' : '';
+
+describe('BuiltinToolPath', () => {
+
+    let testFolder: string;
+
+    beforeEach(() => {
+        testFolder = fs.mkdtempSync(path.join(os.tmpdir(), 'jest-'));
+        (vscode.extensions.getExtension as jest.Mock).mockReturnValue({
+            extensionUri: vscode.Uri.file(testFolder),
+        });
+    });
+
+    afterEach(() => {
+        jest.clearAllMocks();
+        fs.rmSync(testFolder, { recursive: true, force: true });
+    });
+
+    it('should return the correct path for a given tool', () => {
+        const builtinToolPath = new BuiltinToolPath('tools/pyocd/pyocd');
+
+        fs.mkdirSync(`${testFolder}/tools/pyocd`, { recursive: true });
+        fs.writeFileSync(`${testFolder}/tools/pyocd/pyocd${TOOL_EXTENSION}`, '');
+
+        const expected = vscode.Uri.file(`${testFolder}/tools/pyocd/pyocd${TOOL_EXTENSION}`);
+        const result = builtinToolPath.getAbsolutePath();
+        expect(result?.fsPath).toBe(expected.fsPath);
+    });
+
+    it('should return undefined if tool does not exist', () => {
+        const builtinToolPath = new BuiltinToolPath('tools/pyocd/pyocd');
+
+        const result = builtinToolPath.getAbsolutePath();
+        expect(result).toBeUndefined();
+    });
+
+});
+