-
Notifications
You must be signed in to change notification settings - Fork 8
Initial unit test framework #45
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
21b743a
Initial unit test framework
JonatanAntoni 6c6761b
Fixup: eslint
JonatanAntoni 7b127f2
Add CodeClimate badges
JonatanAntoni c3a2851
Enhance test cases
JonatanAntoni b54b49a
Merge branch 'main' into unittest
jreineckearm 391e131
Merge branch 'main' into unittest
jreineckearm File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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); | ||
| }); | ||
|
|
||
| }); |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,50 @@ | ||
| /** | ||
jreineckearm marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| * 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)); | ||
| }; | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,70 @@ | ||
| /** | ||
| * 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, | ||
| // eslint-disable-next-line @typescript-eslint/no-explicit-any | ||
| } as unknown as vscode.Extension<any>, | ||
| languageModelAccessInformation: { | ||
| getLanguageModel: jest.fn(), | ||
| } as unknown as vscode.LanguageModelAccessInformation, | ||
| }; | ||
| }; |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,60 @@ | ||
| /** | ||
| * 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, TargetConfiguration } from './gdbtarget-configuration'; | ||
|
|
||
| export const debugConfigurationFactory = makeFactory<vscode.DebugConfiguration>({ | ||
| type: () => 'cppdbg', | ||
| name: () => 'Debug', | ||
| request: () => 'launch', | ||
| }); | ||
|
|
||
| export const targetConfigurationFactory = makeFactory<TargetConfiguration>({ | ||
| type: () => undefined, | ||
| parameters: () => undefined, | ||
| host: () => undefined, | ||
| port: () => undefined, | ||
| cwd: () => undefined, | ||
| environment: () => undefined, | ||
| server: () => undefined, | ||
| serverParameters: () => undefined, | ||
| serverPortRegExp: () => undefined, | ||
| serverStartupDelay: () => undefined, | ||
| automaticallyKillServer: () => false, | ||
| uart: () => undefined, | ||
| }); | ||
|
|
||
| export const gdbTargetConfiguration = makeFactory<GDBTargetConfiguration>({ | ||
| type: () => 'gdb', | ||
| name: () => 'Debug', | ||
| request: () => 'launch', | ||
| program: () => undefined, | ||
| gdb: () => undefined, | ||
| cwd: () => undefined, | ||
| environment: () => undefined, | ||
| gdbAsync: () => undefined, | ||
| gdbNonStop: () => undefined, | ||
| verbose: () => undefined, | ||
| logFile: () => undefined, | ||
| openGdbConsole: () => undefined, | ||
| initCommands: () => undefined, | ||
| preRunCommands: () => undefined, | ||
| imageAndSymbols: () => undefined, | ||
| target: () => undefined, | ||
| cmsis: () => undefined, | ||
| }); |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.