Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Fix failing Prospector unit tests and add more tests for linters #1837

Merged
merged 3 commits into from
Jun 4, 2018
Merged

Fix failing Prospector unit tests and add more tests for linters #1837

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f181853
Fix failing Prospector unit tests
DonJayamanne Jun 2, 2018
7584d48
Add more tests for relative prospector paths
DonJayamanne Jun 2, 2018
95b4c60
Udpated readme
DonJayamanne Jun 2, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions news/3 Code Health/1836.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Fix failing Prospector unit tests and add more tests for linters (with and without workspaces).
2 changes: 1 addition & 1 deletion src/test/common/moduleInstaller.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ const info: PythonInterpreter = {
sysVersion: ''
};

suite('Module Installerx', () => {
suite('Module Installer', () => {
[undefined, Uri.file(__filename)].forEach(resource => {
let ioc: UnitTestIocContainer;
let mockTerminalService: TypeMoq.IMock<ITerminalService>;
Expand Down
249 changes: 127 additions & 122 deletions src/test/linters/lint.args.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,13 @@

'use strict';

// tslint:disable:no-any
// tslint:disable:no-any max-func-body-length

import { expect } from 'chai';
import { Container } from 'inversify';
import * as path from 'path';
import * as TypeMoq from 'typemoq';
import { CancellationTokenSource, OutputChannel, TextDocument, Uri } from 'vscode';
import { CancellationTokenSource, OutputChannel, TextDocument, Uri, WorkspaceFolder } from 'vscode';
import { IDocumentManager, IWorkspaceService } from '../../client/common/application/types';
import '../../client/common/extensions';
import { IFileSystem, IPlatformService } from '../../client/common/platform/types';
Expand All @@ -29,127 +29,132 @@ import { Pylint } from '../../client/linters/pylint';
import { ILinterManager, ILintingEngine } from '../../client/linters/types';
import { initialize } from '../initialize';

// tslint:disable-next-line:max-func-body-length
suite('Linting - Arguments', () => {
let interpreterService: TypeMoq.IMock<IInterpreterService>;
let engine: TypeMoq.IMock<ILintingEngine>;
let configService: TypeMoq.IMock<IConfigurationService>;
let docManager: TypeMoq.IMock<IDocumentManager>;
let settings: TypeMoq.IMock<IPythonSettings>;
let lm: ILinterManager;
let serviceContainer: ServiceContainer;
let document: TypeMoq.IMock<TextDocument>;
let outputChannel: TypeMoq.IMock<OutputChannel>;
let workspaceService: TypeMoq.IMock<IWorkspaceService>;
const cancellationToken = new CancellationTokenSource().token;

suiteSetup(initialize);
setup(async () => {
const cont = new Container();
const serviceManager = new ServiceManager(cont);

serviceContainer = new ServiceContainer(cont);
outputChannel = TypeMoq.Mock.ofType<OutputChannel>();

const fs = TypeMoq.Mock.ofType<IFileSystem>();
fs.setup(x => x.fileExists(TypeMoq.It.isAny())).returns(() => new Promise<boolean>((resolve, reject) => resolve(true)));
fs.setup(x => x.arePathsSame(TypeMoq.It.isAnyString(), TypeMoq.It.isAnyString())).returns(() => true);
serviceManager.addSingletonInstance<IFileSystem>(IFileSystem, fs.object);

serviceManager.addSingletonInstance(IOutputChannel, outputChannel.object);

interpreterService = TypeMoq.Mock.ofType<IInterpreterService>();
serviceManager.addSingletonInstance<IInterpreterService>(IInterpreterService, interpreterService.object);

engine = TypeMoq.Mock.ofType<ILintingEngine>();
serviceManager.addSingletonInstance<ILintingEngine>(ILintingEngine, engine.object);

docManager = TypeMoq.Mock.ofType<IDocumentManager>();
serviceManager.addSingletonInstance<IDocumentManager>(IDocumentManager, docManager.object);

const lintSettings = TypeMoq.Mock.ofType<ILintingSettings>();
lintSettings.setup(x => x.enabled).returns(() => true);
lintSettings.setup(x => x.lintOnSave).returns(() => true);

settings = TypeMoq.Mock.ofType<IPythonSettings>();
settings.setup(x => x.linting).returns(() => lintSettings.object);

configService = TypeMoq.Mock.ofType<IConfigurationService>();
configService.setup(x => x.getSettings(TypeMoq.It.isAny())).returns(() => settings.object);
serviceManager.addSingletonInstance<IConfigurationService>(IConfigurationService, configService.object);

workspaceService = TypeMoq.Mock.ofType<IWorkspaceService>();
serviceManager.addSingletonInstance<IWorkspaceService>(IWorkspaceService, workspaceService.object);

const logger = TypeMoq.Mock.ofType<ILogger>();
serviceManager.addSingletonInstance<ILogger>(ILogger, logger.object);

const installer = TypeMoq.Mock.ofType<IInstaller>();
serviceManager.addSingletonInstance<IInstaller>(IInstaller, installer.object);

const platformService = TypeMoq.Mock.ofType<IPlatformService>();
serviceManager.addSingletonInstance<IPlatformService>(IPlatformService, platformService.object);

lm = new LinterManager(serviceContainer);
serviceManager.addSingletonInstance<ILinterManager>(ILinterManager, lm);
document = TypeMoq.Mock.ofType<TextDocument>();
});

async function testLinter(linter: BaseLinter, fileUri: Uri, expectedArgs: string[]) {
document.setup(d => d.uri).returns(() => fileUri);

let invoked = false;
(linter as any).run = (args, doc, token) => {
expect(args).to.deep.equal(expectedArgs);
invoked = true;
return Promise.resolve([]);
};
await linter.lint(document.object, cancellationToken);
expect(invoked).to.be.equal(true, 'method not invoked');
}
[Uri.file(path.join('users', 'development path to', 'one.py')), Uri.file(path.join('users', 'development', 'one.py'))].forEach(fileUri => {
test(`Flake8 (${fileUri.fsPath.indexOf(' ') > 0 ? 'with spaces' : 'without spaces'})`, async () => {
const linter = new Flake8(outputChannel.object, serviceContainer);
const expectedArgs = ['--format=%(row)d,%(col)d,%(code).1s,%(code)s:%(text)s', fileUri.fsPath];
await testLinter(linter, fileUri, expectedArgs);
});
test(`Pep8 (${fileUri.fsPath.indexOf(' ') > 0 ? 'with spaces' : 'without spaces'})`, async () => {
const linter = new Pep8(outputChannel.object, serviceContainer);
const expectedArgs = ['--format=%(row)d,%(col)d,%(code).1s,%(code)s:%(text)s', fileUri.fsPath];
await testLinter(linter, fileUri, expectedArgs);
});
test(`Prospector (${fileUri.fsPath.indexOf(' ') > 0 ? 'with spaces' : 'without spaces'})`, async () => {
const linter = new Prospector(outputChannel.object, serviceContainer);
const expectedArgs = ['--absolute-paths', '--output-format=json', fileUri.fsPath];
await testLinter(linter, fileUri, expectedArgs);
});
test(`Pylama (${fileUri.fsPath.indexOf(' ') > 0 ? 'with spaces' : 'without spaces'})`, async () => {
const linter = new PyLama(outputChannel.object, serviceContainer);
const expectedArgs = ['--format=parsable', fileUri.fsPath];
await testLinter(linter, fileUri, expectedArgs);
});
test(`MyPy (${fileUri.fsPath.indexOf(' ') > 0 ? 'with spaces' : 'without spaces'})`, async () => {
const linter = new MyPy(outputChannel.object, serviceContainer);
const expectedArgs = [fileUri.fsPath];
await testLinter(linter, fileUri, expectedArgs);
});
test(`Pydocstyle (${fileUri.fsPath.indexOf(' ') > 0 ? 'with spaces' : 'without spaces'})`, async () => {
const linter = new PyDocStyle(outputChannel.object, serviceContainer);
const expectedArgs = [fileUri.fsPath];
await testLinter(linter, fileUri, expectedArgs);
});
test(`Pylint (${fileUri.fsPath.indexOf(' ') > 0 ? 'with spaces' : 'without spaces'})`, async () => {
const linter = new Pylint(outputChannel.object, serviceContainer);
document.setup(d => d.uri).returns(() => fileUri);

let invoked = false;
(linter as any).run = (args, doc, token) => {
expect(args[args.length - 1]).to.equal(fileUri.fsPath);
invoked = true;
return Promise.resolve([]);
};
await linter.lint(document.object, cancellationToken);
expect(invoked).to.be.equal(true, 'method not invoked');
[undefined, path.join('users', 'dev_user')].forEach(workspaceUri => {
[Uri.file(path.join('users', 'dev_user', 'development path to', 'one.py')), Uri.file(path.join('users', 'dev_user', 'development', 'one.py'))].forEach(fileUri => {
suite(`File path ${fileUri.fsPath.indexOf(' ') > 0 ? 'with' : 'without'} spaces and ${workspaceUri ? 'without' : 'with'} a workspace`, () => {
let interpreterService: TypeMoq.IMock<IInterpreterService>;
let engine: TypeMoq.IMock<ILintingEngine>;
let configService: TypeMoq.IMock<IConfigurationService>;
let docManager: TypeMoq.IMock<IDocumentManager>;
let settings: TypeMoq.IMock<IPythonSettings>;
let lm: ILinterManager;
let serviceContainer: ServiceContainer;
let document: TypeMoq.IMock<TextDocument>;
let outputChannel: TypeMoq.IMock<OutputChannel>;
let workspaceService: TypeMoq.IMock<IWorkspaceService>;
const cancellationToken = new CancellationTokenSource().token;
suiteSetup(initialize);
setup(async () => {
const cont = new Container();
const serviceManager = new ServiceManager(cont);

serviceContainer = new ServiceContainer(cont);
outputChannel = TypeMoq.Mock.ofType<OutputChannel>();

const fs = TypeMoq.Mock.ofType<IFileSystem>();
fs.setup(x => x.fileExists(TypeMoq.It.isAny())).returns(() => new Promise<boolean>((resolve, reject) => resolve(true)));
fs.setup(x => x.arePathsSame(TypeMoq.It.isAnyString(), TypeMoq.It.isAnyString())).returns(() => true);
serviceManager.addSingletonInstance<IFileSystem>(IFileSystem, fs.object);

serviceManager.addSingletonInstance(IOutputChannel, outputChannel.object);

interpreterService = TypeMoq.Mock.ofType<IInterpreterService>();
serviceManager.addSingletonInstance<IInterpreterService>(IInterpreterService, interpreterService.object);

engine = TypeMoq.Mock.ofType<ILintingEngine>();
serviceManager.addSingletonInstance<ILintingEngine>(ILintingEngine, engine.object);

docManager = TypeMoq.Mock.ofType<IDocumentManager>();
serviceManager.addSingletonInstance<IDocumentManager>(IDocumentManager, docManager.object);

const lintSettings = TypeMoq.Mock.ofType<ILintingSettings>();
lintSettings.setup(x => x.enabled).returns(() => true);
lintSettings.setup(x => x.lintOnSave).returns(() => true);

settings = TypeMoq.Mock.ofType<IPythonSettings>();
settings.setup(x => x.linting).returns(() => lintSettings.object);

configService = TypeMoq.Mock.ofType<IConfigurationService>();
configService.setup(x => x.getSettings(TypeMoq.It.isAny())).returns(() => settings.object);
serviceManager.addSingletonInstance<IConfigurationService>(IConfigurationService, configService.object);

const workspaceFolder: WorkspaceFolder | undefined = workspaceUri ? { uri: Uri.file(workspaceUri), index: 0, name: '' } : undefined;
workspaceService = TypeMoq.Mock.ofType<IWorkspaceService>();
workspaceService.setup(w => w.getWorkspaceFolder(TypeMoq.It.isAny())).returns(() => workspaceFolder);
serviceManager.addSingletonInstance<IWorkspaceService>(IWorkspaceService, workspaceService.object);

const logger = TypeMoq.Mock.ofType<ILogger>();
serviceManager.addSingletonInstance<ILogger>(ILogger, logger.object);

const installer = TypeMoq.Mock.ofType<IInstaller>();
serviceManager.addSingletonInstance<IInstaller>(IInstaller, installer.object);

const platformService = TypeMoq.Mock.ofType<IPlatformService>();
serviceManager.addSingletonInstance<IPlatformService>(IPlatformService, platformService.object);

lm = new LinterManager(serviceContainer);
serviceManager.addSingletonInstance<ILinterManager>(ILinterManager, lm);
document = TypeMoq.Mock.ofType<TextDocument>();
});

async function testLinter(linter: BaseLinter, expectedArgs: string[]) {
document.setup(d => d.uri).returns(() => fileUri);

let invoked = false;
(linter as any).run = (args, doc, token) => {
expect(args).to.deep.equal(expectedArgs);
invoked = true;
return Promise.resolve([]);
};
await linter.lint(document.object, cancellationToken);
expect(invoked).to.be.equal(true, 'method not invoked');
}
test('Flake8', async () => {
const linter = new Flake8(outputChannel.object, serviceContainer);
const expectedArgs = ['--format=%(row)d,%(col)d,%(code).1s,%(code)s:%(text)s', fileUri.fsPath];
await testLinter(linter, expectedArgs);
});
test('Pep8', async () => {
const linter = new Pep8(outputChannel.object, serviceContainer);
const expectedArgs = ['--format=%(row)d,%(col)d,%(code).1s,%(code)s:%(text)s', fileUri.fsPath];
await testLinter(linter, expectedArgs);
});
test('Prospector', async () => {
const linter = new Prospector(outputChannel.object, serviceContainer);
const expectedPath = workspaceUri ? path.relative(workspaceUri, fileUri.fsPath) : path.basename(fileUri.fsPath);
const expectedArgs = ['--absolute-paths', '--output-format=json', expectedPath];
await testLinter(linter, expectedArgs);
});
test('Pylama', async () => {
const linter = new PyLama(outputChannel.object, serviceContainer);
const expectedArgs = ['--format=parsable', fileUri.fsPath];
await testLinter(linter, expectedArgs);
});
test('MyPy', async () => {
const linter = new MyPy(outputChannel.object, serviceContainer);
const expectedArgs = [fileUri.fsPath];
await testLinter(linter, expectedArgs);
});
test('Pydocstyle', async () => {
const linter = new PyDocStyle(outputChannel.object, serviceContainer);
const expectedArgs = [fileUri.fsPath];
await testLinter(linter, expectedArgs);
});
test('Pylint', async () => {
const linter = new Pylint(outputChannel.object, serviceContainer);
document.setup(d => d.uri).returns(() => fileUri);

let invoked = false;
(linter as any).run = (args, doc, token) => {
expect(args[args.length - 1]).to.equal(fileUri.fsPath);
invoked = true;
return Promise.resolve([]);
};
await linter.lint(document.object, cancellationToken);
expect(invoked).to.be.equal(true, 'method not invoked');
});
});
});
});
});