diff --git a/news/2 Fixes/6303.md b/news/2 Fixes/6303.md deleted file mode 100644 index 1926ad186b2c..000000000000 --- a/news/2 Fixes/6303.md +++ /dev/null @@ -1 +0,0 @@ -Fix code lenses shown for pytest diff --git a/src/client/testing/codeLenses/main.ts b/src/client/testing/codeLenses/main.ts index 7b54d0ffe00c..9f955d485f34 100644 --- a/src/client/testing/codeLenses/main.ts +++ b/src/client/testing/codeLenses/main.ts @@ -1,5 +1,4 @@ import * as vscode from 'vscode'; -import { IServiceContainer } from '../../../client/ioc/types'; import { PYTHON } from '../../common/constants'; import { ITestCollectionStorageService } from '../common/types'; import { TestFileCodeLensProvider } from './testFiles'; @@ -7,11 +6,10 @@ import { TestFileCodeLensProvider } from './testFiles'; export function activateCodeLenses( onDidChange: vscode.EventEmitter, symbolProvider: vscode.DocumentSymbolProvider, - testCollectionStorage: ITestCollectionStorageService, - serviceContainer: IServiceContainer + testCollectionStorage: ITestCollectionStorageService ): vscode.Disposable { const disposables: vscode.Disposable[] = []; - const codeLensProvider = new TestFileCodeLensProvider(onDidChange, symbolProvider, testCollectionStorage, serviceContainer); + const codeLensProvider = new TestFileCodeLensProvider(onDidChange, symbolProvider, testCollectionStorage); disposables.push(vscode.languages.registerCodeLensProvider(PYTHON, codeLensProvider)); return { diff --git a/src/client/testing/codeLenses/testFiles.ts b/src/client/testing/codeLenses/testFiles.ts index 19cf9a5c1783..140d1bddb702 100644 --- a/src/client/testing/codeLenses/testFiles.ts +++ b/src/client/testing/codeLenses/testFiles.ts @@ -2,10 +2,7 @@ // tslint:disable:no-object-literal-type-assertion -import { CancellationToken, CancellationTokenSource, CodeLens, CodeLensProvider, DocumentSymbolProvider, Event, EventEmitter, Position, Range, SymbolInformation, SymbolKind, TextDocument, Uri } from 'vscode'; -import { IWorkspaceService } from '../../../client/common/application/types'; -import { IFileSystem } from '../../../client/common/platform/types'; -import { IServiceContainer } from '../../../client/ioc/types'; +import { CancellationToken, CancellationTokenSource, CodeLens, CodeLensProvider, DocumentSymbolProvider, Event, EventEmitter, Position, Range, SymbolInformation, SymbolKind, TextDocument, Uri, workspace } from 'vscode'; import * as constants from '../../common/constants'; import { CommandSource } from '../common/constants'; import { ITestCollectionStorageService, TestFile, TestFunction, TestStatus, TestsToRun, TestSuite } from '../common/types'; @@ -16,15 +13,10 @@ type FunctionsAndSuites = { }; export class TestFileCodeLensProvider implements CodeLensProvider { - private workspaceService: IWorkspaceService; - private fileSystem: IFileSystem; // tslint:disable-next-line:variable-name constructor(private _onDidChange: EventEmitter, private symbolProvider: DocumentSymbolProvider, - private testCollectionStorage: ITestCollectionStorageService, - serviceContainer: IServiceContainer) { - this.workspaceService = serviceContainer.get(IWorkspaceService); - this.fileSystem = serviceContainer.get(IFileSystem); + private testCollectionStorage: ITestCollectionStorageService) { } get onDidChangeCodeLenses(): Event { @@ -32,7 +24,7 @@ export class TestFileCodeLensProvider implements CodeLensProvider { } public async provideCodeLenses(document: TextDocument, token: CancellationToken) { - const wkspace = this.workspaceService.getWorkspaceFolder(document.uri); + const wkspace = workspace.getWorkspaceFolder(document.uri); if (!wkspace) { return []; } @@ -60,20 +52,16 @@ export class TestFileCodeLensProvider implements CodeLensProvider { return Promise.resolve(codeLens); } - public getTestFileWhichNeedsCodeLens(document: TextDocument): TestFile | undefined { - const wkspace = this.workspaceService.getWorkspaceFolder(document.uri); + private async getCodeLenses(document: TextDocument, token: CancellationToken, symbolProvider: DocumentSymbolProvider) { + const wkspace = workspace.getWorkspaceFolder(document.uri); if (!wkspace) { - return; + return []; } const tests = this.testCollectionStorage.getTests(wkspace.uri); if (!tests) { - return; + return []; } - return tests.testFiles.find(item => this.fileSystem.arePathsSame(item.fullPath, document.uri.fsPath)); - } - - private async getCodeLenses(document: TextDocument, token: CancellationToken, symbolProvider: DocumentSymbolProvider) { - const file = this.getTestFileWhichNeedsCodeLens(document); + const file = tests.testFiles.find(item => item.fullPath === document.uri.fsPath); if (!file) { return []; } diff --git a/src/client/testing/common/services/discoveredTestParser.ts b/src/client/testing/common/services/discoveredTestParser.ts index 7e51904ee8b4..ed123270b12e 100644 --- a/src/client/testing/common/services/discoveredTestParser.ts +++ b/src/client/testing/common/services/discoveredTestParser.ts @@ -8,7 +8,6 @@ import * as path from 'path'; import { Uri } from 'vscode'; import { IWorkspaceService } from '../../../common/application/types'; import { traceError } from '../../../common/logger'; -import { IFileSystem } from '../../../common/platform/types'; import { TestDataItem } from '../../types'; import { getParentFile, getParentSuite, getTestType } from '../testUtils'; import { FlattenedTestFunction, FlattenedTestSuite, SubtestParent, TestFile, TestFolder, TestFunction, Tests, TestSuite, TestType } from '../types'; @@ -16,10 +15,7 @@ import { DiscoveredTests, ITestDiscoveredTestParser, TestContainer, TestItem } f @injectable() export class TestDiscoveredTestParser implements ITestDiscoveredTestParser { - constructor( - @inject(IWorkspaceService) private readonly workspaceService: IWorkspaceService, - @inject(IFileSystem) private readonly fileSystem: IFileSystem - ) { } + constructor(@inject(IWorkspaceService) private readonly workspaceService: IWorkspaceService) { } public parse(resource: Uri, discoveredTests: DiscoveredTests[]): Tests { const tests: Tests = { rootTestFolders: [], @@ -38,14 +34,8 @@ export class TestDiscoveredTestParser implements ITestDiscoveredTestParser { // If the root is the workspace folder, then ignore that. for (const data of discoveredTests) { - // For now we only check the current workspace. - const root = this.findRoot(data.root, [workspace.uri.fsPath]); - if (!root) { - // For now we only support tests from the workspace. - continue; - } const rootFolder = { - name: root, folders: [], time: 0, + name: data.root, folders: [], time: 0, testFiles: [], resource: resource, nameToRun: data.rootid }; tests.rootTestFolders.push(rootFolder); @@ -68,7 +58,7 @@ export class TestDiscoveredTestParser implements ITestDiscoveredTestParser { * @param {Tests} tests * @memberof TestsDiscovery */ - public buildChildren(rootFolder: TestFolder, parent: TestDataItem, discoveredTests: DiscoveredTests, tests: Tests) { + protected buildChildren(rootFolder: TestFolder, parent: TestDataItem, discoveredTests: DiscoveredTests, tests: Tests) { const parentType = getTestType(parent); switch (parentType) { case TestType.testFolder: { @@ -203,17 +193,6 @@ export class TestDiscoveredTestParser implements ITestDiscoveredTestParser { parent.functions.push(...functions); tests.testFunctions.push(...functions.map(func => createFlattenedParameterizedFunction(tests, func, parent))); } - - /** - * Returns the vscode recognized file paths which matches the pytest data test root - */ - private findRoot(raw: string, roots: string[]): string | undefined { - for (const root of roots) { - if (this.fileSystem.arePathsSame(raw, root)) { - return root; - } - } - } } function createTestFolder(root: TestFolder, item: TestContainer): TestFolder { diff --git a/src/client/testing/main.ts b/src/client/testing/main.ts index b9b697391b80..fc71ecaa22a1 100644 --- a/src/client/testing/main.ts +++ b/src/client/testing/main.ts @@ -324,7 +324,7 @@ export class UnitTestManagementService implements ITestManagementService, Dispos } }); this.disposableRegistry.push(handler); - this.disposableRegistry.push(activateCodeLenses(event, symbolProvider, testCollectionStorage, this.serviceContainer)); + this.disposableRegistry.push(activateCodeLenses(event, symbolProvider, testCollectionStorage)); } @captureTelemetry(EventName.UNITTEST_CONFIGURE, undefined, false) diff --git a/src/test/testing/codeLenses/testFiles.unit.test.ts b/src/test/testing/codeLenses/testFiles.unit.test.ts deleted file mode 100644 index ce262c9d3d4b..000000000000 --- a/src/test/testing/codeLenses/testFiles.unit.test.ts +++ /dev/null @@ -1,158 +0,0 @@ -// Copyright (c) Microsoft Corporation. All rights reserved. -// Licensed under the MIT License. - -'use strict'; - -// tslint:disable:no-any - -import { assert, expect } from 'chai'; -import { mock } from 'ts-mockito'; -import * as typemoq from 'typemoq'; -import { DocumentSymbolProvider, EventEmitter, Uri } from 'vscode'; -import { IWorkspaceService } from '../../../client/common/application/types'; -import { IFileSystem } from '../../../client/common/platform/types'; -import { IServiceContainer } from '../../../client/ioc/types'; -import { LanguageServerSymbolProvider } from '../../../client/providers/symbolProvider'; -import { TestFileCodeLensProvider } from '../../../client/testing/codeLenses/testFiles'; -import { ITestCollectionStorageService } from '../../../client/testing/common/types'; - -// tslint:disable-next-line: max-func-body-length -suite('Code lenses - Test files', () => { - let testCollectionStorage: typemoq.IMock; - let workspaceService: typemoq.IMock; - let fileSystem: typemoq.IMock; - let serviceContainer: typemoq.IMock; - let symbolProvider: DocumentSymbolProvider; - let onDidChange: EventEmitter; - let codeLensProvider: TestFileCodeLensProvider; - setup(() => { - workspaceService = typemoq.Mock.ofType(); - fileSystem = typemoq.Mock.ofType(); - testCollectionStorage = typemoq.Mock.ofType(); - serviceContainer = typemoq.Mock.ofType(); - symbolProvider = mock(LanguageServerSymbolProvider); - onDidChange = new EventEmitter(); - serviceContainer - .setup(c => c.get(typemoq.It.isValue(IWorkspaceService))) - .returns(() => workspaceService.object); - serviceContainer - .setup(c => c.get(typemoq.It.isValue(IFileSystem))) - .returns(() => fileSystem.object); - codeLensProvider = new TestFileCodeLensProvider(onDidChange, symbolProvider, testCollectionStorage.object, serviceContainer.object); - }); - - teardown(() => { - onDidChange.dispose(); - }); - - test('Function getTestFileWhichNeedsCodeLens() returns `undefined` if there are no workspace corresponding to document', async () => { - const document = { - uri: Uri.file('path/to/document') - }; - workspaceService - .setup(w => w.getWorkspaceFolder(document.uri)) - .returns(() => undefined) - .verifiable(typemoq.Times.once()); - testCollectionStorage - .setup(w => w.getTests(typemoq.It.isAny())) - .returns(() => undefined) - .verifiable(typemoq.Times.never()); - const files = codeLensProvider.getTestFileWhichNeedsCodeLens(document as any); - expect(files).to.equal(undefined, 'No files should be returned'); - workspaceService.verifyAll(); - testCollectionStorage.verifyAll(); - }); - - test('Function getTestFileWhichNeedsCodeLens() returns `undefined` if test storage is empty', async () => { - const document = { - uri: Uri.file('path/to/document') - }; - const workspaceUri = Uri.file('path/to/workspace'); - const workspace = { uri: workspaceUri }; - workspaceService - .setup(w => w.getWorkspaceFolder(document.uri)) - .returns(() => workspace as any) - .verifiable(typemoq.Times.once()); - testCollectionStorage - .setup(w => w.getTests(workspaceUri)) - .returns(() => undefined) - .verifiable(typemoq.Times.once()); - const files = codeLensProvider.getTestFileWhichNeedsCodeLens(document as any); - expect(files).to.equal(undefined, 'No files should be returned'); - workspaceService.verifyAll(); - testCollectionStorage.verifyAll(); - }); - - test('Function getTestFileWhichNeedsCodeLens() returns `undefined` if tests returned from storage does not contain document', async () => { - const document = { - uri: Uri.file('path/to/document5') - }; - const workspaceUri = Uri.file('path/to/workspace'); - const workspace = { uri: workspaceUri }; - const tests = { - testFiles: [ - { - fullPath: 'path/to/document1' - }, - { - fullPath: 'path/to/document2' - } - ] - }; - workspaceService - .setup(w => w.getWorkspaceFolder(document.uri)) - .returns(() => workspace as any) - .verifiable(typemoq.Times.once()); - testCollectionStorage - .setup(w => w.getTests(workspaceUri)) - .returns(() => tests as any) - .verifiable(typemoq.Times.once()); - fileSystem - .setup(f => f.arePathsSame('path/to/document1', 'path/to/document5')) - .returns(() => false); - fileSystem - .setup(f => f.arePathsSame('path/to/document2', 'path/to/document5')) - .returns(() => false); - const files = codeLensProvider.getTestFileWhichNeedsCodeLens(document as any); - expect(files).to.equal(undefined, 'No files should be returned'); - workspaceService.verifyAll(); - testCollectionStorage.verifyAll(); - }); - - test('Function getTestFileWhichNeedsCodeLens() returns test file if tests returned from storage contains document', async () => { - const document = { - uri: Uri.file('path/to/document2') - }; - const workspaceUri = Uri.file('path/to/workspace'); - const workspace = { uri: workspaceUri }; - const testFile2 = { - fullPath: 'path/to/document2' - }; - const tests = { - testFiles: [ - { - fullPath: 'path/to/document1' - }, - testFile2 - ] - }; - workspaceService - .setup(w => w.getWorkspaceFolder(document.uri)) - .returns(() => workspace as any) - .verifiable(typemoq.Times.once()); - testCollectionStorage - .setup(w => w.getTests(workspaceUri)) - .returns(() => tests as any) - .verifiable(typemoq.Times.once()); - fileSystem - .setup(f => f.arePathsSame('path/to/document1', 'path/to/document2')) - .returns(() => false); - fileSystem - .setup(f => f.arePathsSame('path/to/document2', 'path/to/document2')) - .returns(() => true); - const files = codeLensProvider.getTestFileWhichNeedsCodeLens(document as any); - assert.deepEqual(files, testFile2 as any); - workspaceService.verifyAll(); - testCollectionStorage.verifyAll(); - }); -}); diff --git a/src/test/testing/common/services/discoveredTestParser.unit.test.ts b/src/test/testing/common/services/discoveredTestParser.unit.test.ts deleted file mode 100644 index 867461ee0a96..000000000000 --- a/src/test/testing/common/services/discoveredTestParser.unit.test.ts +++ /dev/null @@ -1,144 +0,0 @@ -// Copyright (c) Microsoft Corporation. All rights reserved. -// Licensed under the MIT License. - -'use strict'; - -import * as assert from 'assert'; -import * as sinon from 'sinon'; -import * as typemoq from 'typemoq'; -import { Uri } from 'vscode'; -import { IWorkspaceService } from '../../../../client/common/application/types'; -import { IFileSystem } from '../../../../client/common/platform/types'; -import { TestDiscoveredTestParser } from '../../../../client/testing/common/services/discoveredTestParser'; -import { Tests } from '../../../../client/testing/common/types'; - -// tslint:disable:no-any max-func-body-length -suite('Services - Discovered test parser', () => { - let workspaceService: typemoq.IMock; - let fileSystem: typemoq.IMock; - let parser: TestDiscoveredTestParser; - setup(() => { - workspaceService = typemoq.Mock.ofType(); - fileSystem = typemoq.Mock.ofType(); - }); - - teardown(() => { - sinon.restore(); - }); - - test('Parse returns empty tests if resource does not belong to workspace', () => { - // That is, getWorkspaceFolder() returns undefined. - const expectedTests: Tests = { - rootTestFolders: [], - summary: { errors: 0, failures: 0, passed: 0, skipped: 0 }, - testFiles: [], - testFolders: [], - testFunctions: [], - testSuites: [] - }; - const discoveredTests = [{ - root: 'path/to/testDataRoot' - }]; - const buildChildren = sinon.stub(TestDiscoveredTestParser.prototype, 'buildChildren'); - buildChildren.callsFake(() => undefined); - workspaceService - .setup(w => w.getWorkspaceFolder(typemoq.It.isAny())) - .returns(() => undefined) - .verifiable(typemoq.Times.once()); - fileSystem - .setup(f => f.arePathsSame('path/to/testDataRoot', 'path/to/workspace')) - .returns(() => false) - .verifiable(typemoq.Times.never()); - parser = new TestDiscoveredTestParser(workspaceService.object, fileSystem.object); - const result = parser.parse(Uri.file('path/to/resource'), discoveredTests as any); - assert.ok(buildChildren.notCalled); - assert.deepEqual(expectedTests, result); - workspaceService.verifyAll(); - fileSystem.verifyAll(); - }); - - test('Parse returns empty tests if data root does not matches with workspace root', () => { - const expectedTests: Tests = { - rootTestFolders: [], - summary: { errors: 0, failures: 0, passed: 0, skipped: 0 }, - testFiles: [], - testFolders: [], - testFunctions: [], - testSuites: [] - }; - const discoveredTests = [{ - root: 'path/to/testDataRoot' - }]; - const workspaceUri = Uri.file('path/to/workspace'); - const workspace = { uri: workspaceUri }; - const buildChildren = sinon.stub(TestDiscoveredTestParser.prototype, 'buildChildren'); - buildChildren.callsFake(() => undefined); - workspaceService - .setup(w => w.getWorkspaceFolder(typemoq.It.isAny())) - .returns(() => workspace as any) - .verifiable(typemoq.Times.once()); - fileSystem - .setup(f => f.arePathsSame('path/to/testDataRoot', 'path/to/workspace')) - .returns(() => false) - .verifiable(typemoq.Times.atLeastOnce()); - parser = new TestDiscoveredTestParser(workspaceService.object, fileSystem.object); - const result = parser.parse(workspaceUri, discoveredTests as any); - assert.ok(buildChildren.notCalled); - assert.deepEqual(expectedTests, result); - fileSystem.verifyAll(); - }); - - test('Parse returns expected tests if some of data roots matches with workspace root', () => { - const discoveredTests = [ - { - root: 'path/to/testDataRoot1', - rootid: 'rootId1' - }, - { - root: 'path/to/testDataRoot2', - rootid: 'rootId2' - } - ]; - const workspaceUri = Uri.file('path/to/workspace'); - const workspace = { uri: workspaceUri }; - const expectedTests: Tests = { - rootTestFolders: [ - { - name: workspace.uri.fsPath, folders: [], time: 0, - testFiles: [], resource: workspaceUri, nameToRun: 'rootId1' - } - ], - summary: { errors: 0, failures: 0, passed: 0, skipped: 0 }, - testFiles: [], - testFolders: [ - { - name: workspace.uri.fsPath, folders: [], time: 0, - testFiles: [], resource: workspaceUri, nameToRun: 'rootId1' - } - ], - testFunctions: [], - testSuites: [] - }; - const buildChildren = sinon.stub(TestDiscoveredTestParser.prototype, 'buildChildren'); - buildChildren.callsFake(() => undefined); - workspaceService - .setup(w => w.getWorkspaceFolder(typemoq.It.isAny())) - .returns(() => workspace as any) - .verifiable(typemoq.Times.once()); - - // Only test data root 1 matches with path to workspace - fileSystem - .setup(f => f.arePathsSame('path/to/testDataRoot1', 'path/to/workspace')) - .returns(() => true) - .verifiable(typemoq.Times.atLeastOnce()); - fileSystem - .setup(f => f.arePathsSame('path/to/testDataRoot2', 'path/to/workspace')) - .returns(() => false) - .verifiable(typemoq.Times.atLeastOnce()); - parser = new TestDiscoveredTestParser(workspaceService.object, fileSystem.object); - const result = parser.parse(workspaceUri, discoveredTests as any); - assert.ok(buildChildren.calledOnce); - assert.deepEqual(expectedTests, result); - fileSystem.verifyAll(); - }); -}); diff --git a/src/test/testing/pytest/pytest.testMessageService.test.ts b/src/test/testing/pytest/pytest.testMessageService.test.ts index b63f217d67cf..69be5d7d624d 100644 --- a/src/test/testing/pytest/pytest.testMessageService.test.ts +++ b/src/test/testing/pytest/pytest.testMessageService.test.ts @@ -12,7 +12,6 @@ import * as vscode from 'vscode'; import { IWorkspaceService } from '../../../client/common/application/types'; import { EXTENSION_ROOT_DIR } from '../../../client/common/constants'; import { ProductNames } from '../../../client/common/installer/productNames'; -import { IFileSystem } from '../../../client/common/platform/types'; import { Product } from '../../../client/common/types'; import { ICondaService, IInterpreterService } from '../../../client/interpreter/contracts'; import { InterpreterService } from '../../../client/interpreter/interpreterService'; @@ -137,8 +136,7 @@ suite('Unit Tests - PyTest - TestMessageService', () => { }; // Setup the parser. const workspaceService = ioc.serviceContainer.get(IWorkspaceService); - const fileSystem = ioc.serviceContainer.get(IFileSystem); - const parser = new TestDiscoveredTestParser(workspaceService, fileSystem); + const parser = new TestDiscoveredTestParser(workspaceService); const discoveryOutput = fs.readFileSync(path.join(PYTEST_RESULTS_PATH, scenario.discoveryOutput), 'utf8').replace(/\/Users\/donjayamanne\/.vscode-insiders\/extensions\/pythonVSCode\/src\/test\/pythonFiles\/testFiles/g, path.dirname(UNITTEST_TEST_FILES_PATH)).replace(/\\/g, '/'); const discoveredTest: DiscoveredTests[] = JSON.parse(discoveryOutput); options.workspaceFolder = vscode.Uri.file(discoveredTest[0].root);