Some example tests added and basic unit tests architecture setup

added unit tests for JDK Downloader view

Author: Achal1607

vscode/.nycrc.json

@@ -1,15 +1,21 @@
 {
     "extends": "@istanbuljs/nyc-config-typescript",
-    "reporter":[
+    "reporter": [
         "text",
         "html",
         "text-summary",
         "cobertura"
     ],
-    "all": true,
-    "cache": false,
+    "all": false,
     "include": [
-        "src/**/*.ts", "out/**/*.js"
+        "src/**/*.ts",
+        "out/**/*.js"
     ],
-    "exclude": [ "src/test/**/*.ts", "out/test/**/*.js"]
+    "exclude": [
+        "src/test/**/*.ts",
+        "out/test/**/*.js",
+        "out/utils.js",
+        "out/logger.js",
+        "out/constants.js"
+    ]
 }

vscode/src/test/unit/mocks/README.md

@@ -0,0 +1,2 @@
+## Important Note:
+Every entity exported from this directory should be prefixed with `Mock` or `Mocked` so that any developer doesn't import mocked VS Code or mocked elements in the extension main logic code.

vscode/src/test/unit/mocks/init.ts

@@ -0,0 +1,37 @@
+import { initMockedLocaliser } from "./mockLocaliser";
+import { initMockedVSCode } from "./vscode/mockVscode";
+
+const Module = require('module');
+const originalLoad = Module._load;
+
+export const initMocks = () => {
+   const mockedVSCode = initMockedVSCode();
+   const mockedLocaliser = initMockedLocaliser();
+   
+   const mocks = {
+    vscode: mockedVSCode,
+    localiser: mockedLocaliser
+   };
+
+   replaceImportsWithMocks(mocks);
+}
+
+
+const replaceImportsWithMocks = (mocks: any) => {
+    Module._load = function (request: any, _parent: any) {
+        if (request === 'vscode') {
+            return mocks.vscode;
+        } else if (request.includes('localiser')) {
+            return mocks.localiser;
+        }
+
+        if (/\.less$/.test(request)) {
+            return;
+        }
+        return originalLoad.apply(this, arguments);
+    };
+}
+
+export function restore() {
+    Module._load = originalLoad;
+}

vscode/src/test/unit/mocks/mockLocaliser.ts

@@ -0,0 +1,14 @@
+const mockedL10n = {
+    l10n: {
+        value(key: string) {
+            return key;
+        },
+        nbLocaleCode() {
+            return 'en';
+        },
+    }
+};
+
+export const initMockedLocaliser = () => {
+    return mockedL10n;
+}

vscode/src/test/unit/mocks/vscode/mockVscode.ts

@@ -0,0 +1,24 @@
+import * as vscode from 'vscode';
+import { URI } from './uri';
+import { mockWindowNamespace } from './namespaces/window';
+import { mockedEnums } from './vscodeHostedTypes';
+
+type VSCode = typeof vscode;
+const mockedVSCode: Partial<VSCode> = {};
+
+const mockedVscodeClassesAndTypes = () => {
+    mockedVSCode.Uri = URI as any;
+    mockedVSCode.ViewColumn = mockedEnums.viewColumn;
+}
+
+const mockNamespaces = () => {
+    mockWindowNamespace(mockedVSCode);
+}
+
+export const initMockedVSCode = () => {
+    mockedVscodeClassesAndTypes();
+    mockNamespaces();
+
+    return mockedVSCode;
+}
+

vscode/src/test/unit/mocks/vscode/namespaces/window.ts

@@ -0,0 +1,36 @@
+import * as vscode from 'vscode';
+import { mock, when, anyString, anyOfClass, anything, instance } from "ts-mockito";
+
+type VSCode = typeof vscode;
+
+let mockedWindow: typeof vscode.window;
+export const mockWindowNamespace = (mockedVSCode: Partial<VSCode>) => {
+    mockedWindow = mock<typeof vscode.window>();
+    mockedVSCode.window = instance(mockedWindow);
+    mockCreateWebViewPanel();
+    mockCreateOutputChannel();
+    mockMessageView();
+}
+
+const mockCreateWebViewPanel = () => {
+    const mockedWebviewPanel = mock<vscode.WebviewPanel>();
+    when(mockedWindow.createWebviewPanel(
+        anyString(),
+        anyString(),
+        anyOfClass(Number),
+        anything()
+    )).thenReturn(instance(mockedWebviewPanel));
+} 
+
+const mockCreateOutputChannel = () => {
+    const mockedOutputChannel = mock<vscode.OutputChannel>();
+    when(mockedWindow.createOutputChannel(
+        anyString()
+    )).thenReturn(instance(mockedOutputChannel));
+} 
+
+const mockMessageView = () => {
+    when(mockedWindow.showErrorMessage(anyString())).thenReturn(Promise.resolve(anyString()));
+    when(mockedWindow.showInformationMessage(anyString())).thenReturn(Promise.resolve(anyString()));
+    when(mockedWindow.showWarningMessage(anyString())).thenReturn(Promise.resolve(anyString()));
+}

vscode/src/test/unit/mocks/vscode/vscodeHostedTypes.ts

@@ -0,0 +1,17 @@
+enum ViewColumn {
+    Active = -1,
+    Beside = -2,
+    One = 1,
+    Two = 2,
+    Three = 3,
+    Four = 4,
+    Five = 5,
+    Six = 6,
+    Seven = 7,
+    Eight = 8,
+    Nine = 9,
+}
+
+export const mockedEnums = {
+    viewColumn: ViewColumn
+}

vscode/src/test/unit/mocks/vscode/vscodeMock.ts

@@ -1,12 +1,12 @@
 import * as Mocha from 'mocha';
 import { glob } from 'glob';
 import * as path from 'path';
-import { vscodeMockInit } from './mocks/vscode/vscodeMock';
-
+import { initMocks } from './mocks/init';
 
 const mocha = new Mocha({
     ui: 'tdd',
-    color: true
+    color: true,
+    timeout: 600 * 1000
 });
 
 
@@ -46,7 +46,7 @@ try {
     if (args.length) {
         console.log(`Running unit tests for following speicified modules: ${args.map(el => el)}`);
     }
-    vscodeMockInit();
+    initMocks();
     testRunner(args);
 } catch (err: any) {
     console.error("Exception occurred while running tests");

vscode/src/test/unit/runTest.ts

@@ -0,0 +1,44 @@
+import { LOGGER } from "../../logger";
+
+export const getOsType = (): string => {
+    switch (process.platform) {
+        case "linux":
+            return "linux";
+        case "darwin":
+            return "macOS";
+        default:
+            return "windows";
+    }
+}
+
+export const getMachineArch = (): string => {
+    switch (process.arch) {
+        case "arm64":
+            return "aarch64";
+        default:
+            return "x64";
+    }
+}
+
+export const getHtmlTagContent = (html: string, tagName: string): string => {
+    const regex = new RegExp(`<${tagName}[^>]*>(.*?)<\/${tagName}>`, 'is');
+    const match = html.match(regex);
+    return match?.[1]?.trim() || '';
+}
+
+export const checkTagContentNotEmpty = (html: string, tagName: string): boolean => {
+    const content = getHtmlTagContent(html, tagName);
+    return content.length !== 0;
+}
+
+export const enableMockedLoggers = (sandbox: sinon.SinonSandbox) => {
+    sandbox.stub(LOGGER, 'log').callsFake((message) => {
+        console.log(message);
+      });
+      sandbox.stub(LOGGER, 'error').callsFake((message) => {
+        console.error(message);
+      });
+      sandbox.stub(LOGGER, 'warn').callsFake((message) => {
+        console.warn(message);
+      });
+}