Task 5442/add automated tests to vscode extension (#5540)

* Setup unittests wip * initial coverage setup Improve coverage configs checkpoint 1 checkpoint 2 checkpoint 3 add task to run test in build-extension workflow Add sonar cloud analysis step Remove unused libraries Add projectKey to sonar properties * test monorepo setup * use paths for pull_request trigger
microsoft · Nov 11, 2024 · e843dce · e843dce
1 parent 5922724
commit e843dce
Show file tree

Hide file tree

Showing 18 changed files with 2,084 additions and 668 deletions.
diff --git a/.github/workflows/build-vscode-extension.yml b/.github/workflows/build-vscode-extension.yml
@@ -31,6 +31,21 @@ jobs:
         working-directory: vscode/microsoft-kiota
       - run: npm run lint
         working-directory: vscode/microsoft-kiota
+      - name: run tests(linux)
+        if: runner.os == 'Linux'
+        run: xvfb-run -a npm run test-with-coverage
+        working-directory: vscode/microsoft-kiota
+      - name: run tests
+        if: runner.os != 'Linux'
+        run: npm run test-with-coverage
+        working-directory: vscode/microsoft-kiota
+      - name: Run sonar cloud analysis
+        uses: SonarSource/sonarcloud-github-action@master
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # Needed to get PR information, if any
+          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
+        with:
+          projectBaseDir: vscode/microsoft-kiota
       - run: npm run package
         working-directory: vscode/microsoft-kiota
       - run: npm i -g @vscode/vsce

diff --git a/.github/workflows/sonarcloud.yml b/.github/workflows/sonarcloud.yml
@@ -13,18 +13,20 @@ on:
         "**.md",
         ".vscode/**",
         "**.svg",
+        "vscode/**",
       ]
   pull_request:
     types: [opened, synchronize, reopened]
-    paths-ignore:
+    paths:
       [
-        "abstractions/**",
-        "authentication/**",
-        "serialization/**",
-        "http/**",
-        "**.md",
-        ".vscode/**",
-        "**.svg",
+        "!abstractions/**",
+        "!authentication/**",
+        "!serialization/**",
+        "!http/**",
+        "!**.md",
+        "!.vscode/**",
+        "!**.svg",
+        "!vscode/**",
       ]
 
 permissions:

diff --git a/vscode/microsoft-kiota/.gitignore b/vscode/microsoft-kiota/.gitignore
@@ -1,4 +1,6 @@
 dist/
 out/
 .kiotabin/
-*.vsix
+*.vsix
+.vscode-test
+coverage/
diff --git a/vscode/microsoft-kiota/.vscode-test.mjs b/vscode/microsoft-kiota/.vscode-test.mjs
@@ -0,0 +1,14 @@
+import { defineConfig } from '@vscode/test-cli';
+
+export default defineConfig({
+    tests:[
+        {
+            files: 'out/test/**/*.test.js'
+        }
+    ],
+    coverage: {
+        includeAll: true,
+        exclude: ["**/src/test", "**/dist", "**/*.test.[tj]s", "**/*.ts"],
+        reporter: ["text-summary", "html", "json-summary", "lcov", "cobertura"],
+    },
+});
diff --git a/vscode/microsoft-kiota/.vscode/launch.json b/vscode/microsoft-kiota/.vscode/launch.json
@@ -3,33 +3,35 @@
 // Hover to view descriptions of existing attributes.
 // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
 {
-	"version": "0.2.0",
-	"configurations": [
-		{
-			"name": "Run Extension",
-			"type": "extensionHost",
-			"request": "launch",
-			"args": [
-				"--extensionDevelopmentPath=${workspaceFolder}"
-			],
-			"outFiles": [
-				"${workspaceFolder}/dist/**/*.js"
-			],
-			"preLaunchTask": "${defaultBuildTask}"
-		},
-		{
-			"name": "Extension Tests",
-			"type": "extensionHost",
-			"request": "launch",
-			"args": [
-				"--extensionDevelopmentPath=${workspaceFolder}",
-				"--extensionTestsPath=${workspaceFolder}/out/test/suite/index"
-			],
-			"outFiles": [
-				"${workspaceFolder}/out/**/*.js",
-				"${workspaceFolder}/dist/**/*.js"
-			],
-			"preLaunchTask": "tasks: watch-tests"
-		}
-	]
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "name": "Run Extension",
+      "type": "extensionHost",
+      "request": "launch",
+      "args": [
+        "--extensionDevelopmentPath=${workspaceFolder}"
+      ],
+      "outFiles": [
+        "${workspaceFolder}/dist/**/*.js"
+      ],
+      "preLaunchTask": "${defaultBuildTask}"
+    },
+    {
+      "name": "Extension Tests",
+      "type": "extensionHost",
+      "request": "launch",
+      "runtimeExecutable": "${execPath}",
+      "args": [
+        "--disable-extensions",
+        "--extensionDevelopmentPath=${workspaceFolder}",
+        "--extensionTestsPath=${workspaceFolder}/out/test/suite/index"
+      ],
+      "outFiles": [
+        "${workspaceFolder}/out/**/*.js",
+        "${workspaceFolder}/dist/**/*.js"
+      ],
+      "preLaunchTask": "tasks: watch-tests"
+    }
+  ]
 }
diff --git a/vscode/microsoft-kiota/.vscodeignore b/vscode/microsoft-kiota/.vscodeignore
@@ -14,3 +14,5 @@ vsc-extension-quickstart.md
 .kiotabin/
 .vsix
 images/samples/
+.vscode-test
+coverage/
diff --git a/vscode/microsoft-kiota/eslint.config.mjs b/vscode/microsoft-kiota/eslint.config.mjs
@@ -1,9 +1,9 @@
-import stylisticTs from '@stylistic/eslint-plugin-ts'
+import stylisticTs from '@stylistic/eslint-plugin-ts';
 import typescriptEslint from "@typescript-eslint/eslint-plugin";
 import tsParser from "@typescript-eslint/parser";
 
 export default [{
-    ignores: ["**/out", "**/dist", "**/*.d.ts", ".vscode-test", "node_modules", "eslint.config.mjs", "webpack.config.cjs"],
+    ignores: ["**/out", "**/dist", "**/*.d.ts", ".vscode-test", "node_modules", "eslint.config.mjs", "webpack.config.cjs", "coverage"],
 }, {
     files: ["**/*.ts"],
     plugins: {
@@ -31,4 +31,4 @@ export default [{
         "no-throw-literal": "warn",
         semi: "off",
     },
-}];
+}];