Introduce unit/integration tests

base configuration coming from:
https://github.com/microsoft/vscode-extension-samples/tree/main/helloworld-test-sample

fixes KaotoIO#658

Signed-off-by: Aurélien Pupier <[email protected]>

.github/workflows/ci.yaml

@@ -34,6 +34,12 @@ jobs:
       run: yarn build:prod
     - name: vsix package
       run: yarn vsce package --no-dependencies --yarn
+    - name: Run Unit tests on Linux
+      run: xvfb-run -a yarn test:unit
+      if: ${{ matrix.os == 'ubuntu-latest' }}
+    - name: Run Unit tests on Other OSes than Linux
+      run: yarn test:unit
+      if: ${{ matrix.os != 'ubuntu-latest' }}
     - name: Run UI Tests on Linux
       run: xvfb-run -a yarn run test:it:with-prebuilt-vsix
       if: ${{ matrix.os == 'ubuntu-latest' }}

.github/workflows/main-kaoto.yaml

@@ -53,6 +53,9 @@ jobs:
     - name: vsix package
       working-directory: vscode-kaoto
       run: yarn vsce package --no-dependencies --yarn
+    - name: Run Unit tests
+      working-directory: vscode-kaoto
+      run: xvfb-run -a yarn test:unit
     - name: Run UI Tests
       working-directory: vscode-kaoto
       run: xvfb-run -a yarn run test:it:with-prebuilt-vsix

.gitignore

@@ -15,6 +15,7 @@ dist
 # testing
 /coverage
 .vscode-test-web
+.vscode-test
 /uitest-resources
 /test-extensions
 /test-resources

.vscode-test.mjs

@@ -0,0 +1,12 @@
+import { defineConfig } from '@vscode/test-cli';
+
+export default defineConfig({
+	files: 'out/test/**/*.test.js',
+	workspaceFolder: './test Fixture with speci@l chars',
+	mocha: {
+		ui: 'tdd',
+		color: true,
+		timeout: 100000,
+		reporter: 'mocha-jenkins-reporter'
+	}
+});

Jenkinsfile

@@ -21,7 +21,12 @@ node('rhel8'){
 	sh "yarn build:dev"
 	sh "yarn build:prod"
 
-	stage('Test') {
+	stage('Unit Tests') {
+		wrap([$class: 'Xvnc']) {
+			sh "yarn test:unit"
+		}
+	}
+	stage('UI Tests') {
 		wrap([$class: 'Xvnc']) {
 			sh "yarn test:it"
 		}

package.json

@@ -21,10 +21,12 @@
     "lint": "yarn eslint ./src --ext .ts,.tsx",
     "build:prod": "rimraf dist && webpack",
     "build:dev": "rimraf dist && webpack --env dev",
-    "build:test:it": "tsc --project tsconfig.it-tests.json --skipLibCheck --sourceMap true",
+    "build:test:it": "rimraf ./out && tsc --project tsconfig.it-tests.json --skipLibCheck --sourceMap true",
+    "build:test:unit": "rimraf ./out && tsc --project tsconfig.unit-tests.json --skipLibCheck --sourceMap true",
     "compile": "webpack",
     "watch": "webpack --env dev",
     "run:webmode": "yarn vscode-test-web --browserType=chromium --extensionDevelopmentPath=. --open-devtools ./resources",
+    "test:unit": "yarn build:test:unit && vscode-test",
     "test:it": "yarn build:test:it && extest setup-and-run --yarn --uninstall_extension --extensions_dir ./test-resources 'out/**/*.test.js' --open_resource './test Fixture with speci@l chars'",
     "test:it:with-prebuilt-vsix": "yarn build:test:it && extest get-vscode && extest get-chromedriver && extest install-vsix --vsix_file vscode-kaoto-$npm_package_version.vsix --extensions_dir ./test-resources && extest run-tests --uninstall_extension --extensions_dir ./test-resources 'out/**/*.test.js' --open_resource './test Fixture with speci@l chars'",
     "test:it:clean": "rimraf ./test-resources && rimraf ./out && rimraf *.vsix"
@@ -184,6 +186,8 @@
     "@types/fs-extra": "^11.0.4",
     "@types/mocha": "^10.0.8",
     "@types/react": "18.2.79",
+    "@vscode/test-cli": "^0.0.10",
+    "@vscode/test-electron": "^2.4.1",
     "@vscode/test-web": "^0.0.60",
     "@vscode/vsce": "^3.1.0",
     "async-wait-until": "^2.0.12",
@@ -194,6 +198,7 @@
     "css-loader": "6.8.1",
     "fs-extra": "^11.2.0",
     "mocha": "^10.7.3",
+    "mocha-jenkins-reporter": "^0.4.8",
     "node-fetch": "2",
     "npm-link-shared": "^0.5.6",
     "os-browserify": "^0.3.0",

src/test/activation.test.ts

@@ -0,0 +1,26 @@
+/**
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License", destination); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *      https://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 { assert } from 'chai';
+import * as vscode from 'vscode';
+
+suite('Extension is activated', () => {
+    test('Extension is activated', async() => {
+        const extension = await vscode.extensions.getExtension('redhat.vscode-kaoto');
+        assert.isNotNull(extension, 'VS Code Kaoto not found');
+        assert.isTrue(extension?.isActive, 'VS Code Kaoto is not activated despite the workspace used for tests contains yaml files');
+    });
+})

tsconfig.unit-tests.json

@@ -0,0 +1,12 @@
+{
+	"extends": "./tsconfig.json",
+	"compilerOptions": {
+		"module": "CommonJS",
+		"moduleResolution": "Node",
+		"declaration": false,
+		"declarationMap": false,
+		"resolveJsonModule": true,
+		"outDir": "out/test"
+	},
+	"include": ["src/test"]
+}