Add unit test for featureSupport.ts (#14)

Author: mustard-mh

.mocharc.json

@@ -0,0 +1,7 @@
+{
+    "extension": [
+        "ts"
+    ],
+    "spec": "src/**/*.test.ts",
+    "require": "ts-node/register"
+}

package.json

@@ -105,18 +105,20 @@
 	"main": "./out/extension.js",
 	"segmentKey": "YErmvd89wPsrCuGcVnF2XAl846W9WIGl",
 	"scripts": {
-		"vscode:prepublish": "webpack --mode production",
+		"vscode:prepublish": "yarn test && webpack --mode production",
 		"webpack": "webpack --mode development",
 		"compile": "tsc -b",
 		"watch": "tsc -b -w",
 		"package": "npx vsce package --yarn",
-		"lint": "eslint . --ext .ts"
+		"lint": "eslint . --ext .ts",
+		"test": "env TS_NODE_COMPILER_OPTIONS='{\"module\": \"commonjs\" }' mocha"
 	},
 	"devDependencies": {
 		"@types/analytics-node": "^3.1.9",
 		"@types/crypto-js": "4.1.1",
 		"@types/google-protobuf": "^3.7.4",
 		"@types/js-yaml": "^4.0.5",
+		"@types/mocha": "^9.1.1",
 		"@types/node": "16.x",
 		"@types/node-fetch": "^2.5.12",
 		"@types/semver": "^7.3.10",
@@ -133,7 +135,9 @@
 		"eslint-plugin-header": "3.1.1",
 		"eslint-plugin-jsdoc": "^19.1.0",
 		"minimist": "^1.2.6",
+		"mocha": "^10.0.0",
 		"ts-loader": "^9.2.7",
+		"ts-node": "^10.9.1",
 		"typescript": "^4.6.3",
 		"webpack": "^5.42.0",
 		"webpack-cli": "^4.7.2"

src/featureSupport.test.ts

@@ -0,0 +1,56 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Gitpod. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+import { equal } from 'assert';
+import Log from './common/logger';
+import { getGitpodVersion, GitpodVersion, isFeatureSupported } from './featureSupport';
+
+describe('feature support', () => {
+    it('isFeatureSupported with versions', () => {
+        const cases: Array<{ str?: string; version: GitpodVersion; supported: boolean }> = [
+            { version: new GitpodVersion('release-2022.06.1.7'), str: '2022.6.1', supported: false },
+            { version: new GitpodVersion('release-2022.06.1.0'), str: '2022.6.1', supported: false },
+            { version: new GitpodVersion('release-2022.77.1.0'), str: '2022.77.1', supported: true },
+            { version: new GitpodVersion('release-0.0.0.0'), str: '0.0.0', supported: false },
+            { version: new GitpodVersion('abcd.0123.0.0.0'), str: '0.0.0', supported: false },
+            { version: new GitpodVersion('abcd.123.0.0'), supported: false },
+            { version: new GitpodVersion('123'), supported: false },
+            { version: new GitpodVersion('123..'), supported: false },
+            { version: new GitpodVersion('123.0'), supported: false },
+            { version: new GitpodVersion('123.0.1'), supported: false },
+            { version: new GitpodVersion('9123.0.1'), supported: true },
+            { version: new GitpodVersion(), str: '0.0.0', supported: false },
+            { version: GitpodVersion.Max, str: GitpodVersion.MAX_VERSION, supported: true },
+            { version: GitpodVersion.Min, str: GitpodVersion.MIN_VERSION, supported: false },
+
+            // SaaS is processed in `getOrFetchVersionInfo` function
+            { version: new GitpodVersion('main.123'), supported: false },
+            { version: new GitpodVersion('main.9999'), supported: false },
+        ];
+        for (let i = 0; i < cases.length; i++) {
+            const { version, str, supported } = cases[i];
+            equal(isFeatureSupported(version, 'localHeartbeat'), supported, `isFeatureSupported index: ${i}`);
+            if (str) {
+                equal(version.version, str, `version check index: ${i}`);
+            }
+        }
+    });
+
+    describe('fetch version info', function () {
+        this.timeout(10000);
+        // const logger = { info: console.log, error: console.error } as Log;
+        // @ts-ignore
+        const logger = { info: (...args: any) => { }, error: (...args: any) => { } } as Log;
+
+        it.skip('unknown host retry and fallback to min', async () => {
+            const version = await getGitpodVersion('https://unknown.gitpod.io', logger);
+            equal(version.version, GitpodVersion.Min.version);
+        });
+
+        it('SaaS Gitpod return max', async () => {
+            const version = await getGitpodVersion('https://gitpod.io', logger);
+            equal(version.version, GitpodVersion.Max.version);
+        });
+    });
+});

tsconfig.json

@@ -40,6 +40,7 @@
 	},
 	"exclude": [
 		"node_modules",
-		".vscode-test"
+		".vscode-test",
+		"**/*.test.ts"
 	]
 }