Initial unit test framework

Author: JonatanAntoni

__mocks__/vscode.js

@@ -14,10 +14,32 @@
  * limitations under the License.
  */
 
+require('domain');
 const { URI } = require('vscode-uri');
 
 module.exports = {
+    EventEmitter: jest.fn(() => {
+        const callbacks = [];
+        return {
+            dispose: jest.fn(),
+            event: (callback, thisArg) => {
+                callbacks.push(thisArg ? callback.bind(thisArg) : callback);
+                return { dispose: jest.fn() };
+            },
+            fire: event => callbacks.forEach(callback => callback(event))
+        };
+    }),
     Uri: URI,
+    window: {
+        createOutputChannel: jest.fn(() => ({
+            appendLine: jest.fn(),
+            trace: jest.fn(),
+            debug: jest.fn(),
+            info: jest.fn(),
+            warn: jest.fn(),
+            error: jest.fn(),
+        })),
+    },
     workspace: {
         getConfiguration: jest.fn(() => ({
             get: jest.fn(),
@@ -28,5 +50,8 @@ module.exports = {
     },
     commands: {
         executeCommand: jest.fn(),
-    }
+    },
+    debug: {
+        registerDebugConfigurationProvider: jest.fn(),
+    },
 };

src/__test__/test-data-factory.test.ts

@@ -0,0 +1,84 @@
+/**
+ * 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 { makeFactory, StubEvents } from './test-data-factory';
+import { Event, EventEmitter } from 'vscode';
+
+describe('makeFactory', () => {
+
+    it('returns default values when used without options', () => {
+        type Type = {
+            value: number;
+            text: string;
+        }
+
+        const expected : Type = {
+            value: 42,
+            text: 'the answer'
+        };
+
+        const factory = makeFactory<Type>({
+            value: () => expected.value,
+            text: () => expected.text,
+        });
+
+        const value = factory();
+
+        expect(value).toEqual(expected);
+    });
+
+    it('returns explicit values passed by options', () => {
+        type Type = {
+            value: number;
+            text: string;
+        }
+
+        const expected : Type = {
+            value: 42,
+            text: 'the answer'
+        };
+
+        const factory = makeFactory<Type>({
+            value: () => 43,
+            text: () => expected.text,
+        });
+
+        const value = factory({ value: expected.value });
+
+        expect(value).toEqual(expected);
+    });
+
+    it('stubs vscode.Event|s by exposing vscode.EventEmitter', () => {
+        type Type = {
+            event: Event<number>,
+        }
+
+        const factory = makeFactory<StubEvents<Type>>({
+            eventEmitter: () => new EventEmitter(),
+            event: (r) => jest.fn(r.eventEmitter?.event),
+        });
+
+        const value = factory();
+
+        const listener = jest.fn();
+        value.event(listener);
+        value.eventEmitter.fire(42);
+
+        expect(listener).toHaveBeenCalledTimes(1);
+        expect(listener).toHaveBeenCalledWith(42);
+    });
+
+});

src/__test__/test-data-factory.ts

@@ -0,0 +1,50 @@
+/**
+ * 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 { Event, EventEmitter } from 'vscode';
+
+type Mutable<T> = {
+    -readonly [P in keyof T]: T[P];
+}
+
+type Factory<T> = (options?: Partial<T>) => Mutable<T>;
+
+type Initializer<T> = {
+    [P in keyof T]: (result: Partial<T>) => T[P]
+};
+
+export type StubEvents<T, S extends string = 'Emitter'> = {
+    [P in keyof T as T[P] extends Event<unknown> ? `${string & P}${S}` : never]: T[P] extends Event<infer U> ? EventEmitter<U> : never
+} & T;
+
+export function makeFactory<T extends object>(initializer: Initializer<T>): Factory<T> {
+    const factory = (options?: Partial<T>) => {
+        const result = { ...options } as Mutable<T>;
+        for (const key in initializer) {
+            if (!(key in result)) {
+                result[key] = initializer[key].call(result, result);
+            }
+        }
+        return result;
+    };
+    return factory;
+}
+
+export function makeGenerator<T>(factory: Factory<T>) {
+    return (count: number = 1, options?: Partial<T>): T[] => {
+        return [...Array(count)].map(_ => factory(options));
+    };
+}

src/__test__/vscode.factory.ts

@@ -0,0 +1,69 @@
+/**
+ * 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';
+
+export function extensionContextFactory(): jest.Mocked<vscode.ExtensionContext> {
+    return {
+        subscriptions: [],
+        workspaceState: {
+            get: jest.fn(),
+            update: jest.fn(),
+        } as unknown as vscode.Memento,
+        globalState: {
+            get: jest.fn(),
+            update: jest.fn(),
+            setKeysForSync: jest.fn(),
+        } as unknown as vscode.Memento & { setKeysForSync(keys: readonly string[]): void } ,
+        secrets: {
+            store: jest.fn(),
+            get: jest.fn(),
+            delete: jest.fn(),
+        } as unknown as vscode.SecretStorage,
+        extensionUri: vscode.Uri.file('/mock/uri'),
+        extensionPath: '/mock/path',
+        environmentVariableCollection: {
+            persistent: true,
+            replace: jest.fn(),
+            append: jest.fn(),
+            prepend: jest.fn(),
+            get: jest.fn(),
+            forEach: jest.fn(),
+            getScoped: jest.fn(),
+        } as unknown as vscode.GlobalEnvironmentVariableCollection,
+        storageUri: vscode.Uri.file('/mock/storageUri'),
+        globalStorageUri: vscode.Uri.file('/mock/globalStorageUri'),
+        logUri: vscode.Uri.file('/mock/logUri'),
+        storagePath: '/mock/storagePath',
+        globalStoragePath: '/mock/globalStoragePath',
+        logPath: '/mock/logPath',
+        asAbsolutePath: jest.fn((relativePath: string) => `/mock/path/${relativePath}`),
+        extensionMode: 3,
+        extension: {
+            id: 'mock.extension',
+            extensionUri: vscode.Uri.file('/mock/uri'),
+            extensionPath: '/mock/path',
+            isActive: true,
+            packageJSON: {},
+            activate: jest.fn(),
+            exports: {},
+            extensionKind: 2,
+        } as unknown as vscode.Extension<any>,
+        languageModelAccessInformation: {
+            getLanguageModel: jest.fn(),
+        } as unknown as vscode.LanguageModelAccessInformation,
+    };
+};

src/debug-configuration/debug-configuration.factory.ts

@@ -0,0 +1,45 @@
+/**
+ * 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 { makeFactory } from '../__test__/test-data-factory';
+import { GDBTargetConfiguration } from './gdbtarget-configuration';
+
+export const debugConfigurationFactory = makeFactory<vscode.DebugConfiguration>({
+    type: () => 'cppdbg',
+    name: () => 'Debug',
+    request: () => 'launch',
+});
+
+export const gdbTargetConfiguration = makeFactory<GDBTargetConfiguration>({
+    type: () => 'gdb',
+    name: () => 'Debug',
+    request: () => 'launch',
+    program: () => 'program',
+    gdb: () => 'gdb',
+    cwd: () => 'cwd',
+    environment: () => ({ additionalProperties: 'additionalProperties' }),
+    gdbAsync: () => false,
+    gdbNonStop: () => false,
+    verbose: () => false,
+    logFile: () => 'logFile',
+    openGdbConsole: () => false,
+    initCommands: () => [],
+    preRunCommands: () => [],
+    imageAndSymbols: () => undefined,
+    target: () => undefined,
+    cmsis: () => undefined,
+});

src/debug-configuration/gdbtarget-configuration-provider.test.ts

@@ -0,0 +1,52 @@
+/**
+ * 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 { GDBTargetConfigurationProvider } from './gdbtarget-configuration-provider';
+import { extensionContextFactory } from '../__test__/vscode.factory';
+
+import * as vscode from 'vscode';
+import { debugConfigurationFactory } from './debug-configuration.factory';
+
+describe('GDBTargetConfigurationProvider', () => {
+
+    it('should activate', async () => {
+        const configProvider = new GDBTargetConfigurationProvider([]);
+        const contextMock = extensionContextFactory();
+
+        configProvider.activate(contextMock);
+
+        expect(contextMock.subscriptions).toHaveLength(1);
+        expect(vscode.debug.registerDebugConfigurationProvider as jest.Mock).toHaveBeenCalledWith('gdbtarget', configProvider);
+    });
+
+    it('resolveDebugConfiguration', async () => {
+        const configProvider = new GDBTargetConfigurationProvider([]);
+        const debugConfig = debugConfigurationFactory();
+
+        const resolvedDebugConfig = await configProvider.resolveDebugConfiguration(undefined, debugConfig, undefined);
+
+        expect(resolvedDebugConfig).toBeDefined();
+    });
+
+    it('resolveDebugConfigurationWithSubstitutedVariables', async () => {
+        const configProvider = new GDBTargetConfigurationProvider([]);
+        const debugConfig = debugConfigurationFactory();
+
+        const resolvedDebugConfig = await configProvider.resolveDebugConfigurationWithSubstitutedVariables(undefined, debugConfig, undefined);
+
+        expect(resolvedDebugConfig).toBeDefined();
+    });
+});

src/debug-configuration/subproviders/jlink-configuration-provider.test.ts

@@ -0,0 +1,29 @@
+/**
+ * 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 { debugConfigurationFactory } from '../debug-configuration.factory';
+import { JlinkConfigurationProvider } from './jlink-configuration-provider';
+
+describe('JlinkConfigurationProvider', () => {
+
+    it('resolveDebugConfigurationWithSubstitutedVariables', async () => {
+        const configProvider = new JlinkConfigurationProvider();
+        const config = debugConfigurationFactory();
+        const debugConfig = await configProvider.resolveDebugConfigurationWithSubstitutedVariables(undefined, config, undefined);
+        expect(debugConfig).toBeDefined();
+    });
+
+});