Test for verification

Author: rchiodo

src/test/datascience/notebook/helper.ts

@@ -163,6 +163,9 @@ export async function shutdownAllNotebooks() {
 }
 
 let oldValueFor_alwaysTrustNotebooks: undefined | boolean;
+let oldLinterSettings:
+ | { enabled: boolean; pylintEnabled: boolean; lintOnSave: boolean; pylintUseMinimalCheckers: boolean }
+ | undefined;
 export async function closeNotebooksAndCleanUpAfterTests(disposables: IDisposable[] = []) {
  await closeActiveWindows();
  disposeAllDisposables(disposables);
@@ -174,6 +177,18 @@ export async function closeNotebooksAndCleanUpAfterTests(disposables: IDisposabl
  dsSettings.alwaysTrustNotebooks = oldValueFor_alwaysTrustNotebooks;
  oldValueFor_alwaysTrustNotebooks = undefined;
  }
+ if (oldLinterSettings !== undefined) {
+ const api = await initialize();
+ const configService = api.serviceContainer.get<IConfigurationService>(IConfigurationService);
+ await configService.updateSetting('linting.enabled', oldLinterSettings.enabled);
+ await configService.updateSetting('linting.pylintEnabled', oldLinterSettings.pylintEnabled);
+ await configService.updateSetting('linting.lintOnSave', oldLinterSettings.lintOnSave);
+ await configService.updateSetting(
+ 'linting.pylintUseMinimalCheckers',
+ oldLinterSettings.pylintUseMinimalCheckers
+ );
+ oldLinterSettings = undefined;
+ }
 
  sinon.restore();
 }
@@ -182,6 +197,23 @@ export async function closeNotebooks(disposables: IDisposable[] = []) {
  disposeAllDisposables(disposables);
 }
 
+export async function setLinterToPylint(useMinimal: boolean) {
+ const api = await initialize();
+ const configService = api.serviceContainer.get<IConfigurationService>(IConfigurationService);
+ const settings = configService.getSettings();
+ oldLinterSettings = {
+ enabled: settings.linting.enabled,
+ pylintEnabled: settings.linting.pylintEnabled,
+ pylintUseMinimalCheckers: settings.linting.pylintUseMinimalCheckers,
+ lintOnSave: settings.linting.lintOnSave
+ };
+
+ await configService.updateSetting('linting.enabled', true);
+ await configService.updateSetting('linting.pylintEnabled', true);
+ await configService.updateSetting('linting.lintOnSave', true);
+ await configService.updateSetting('linting.pylintUseMinimalCheckers', useMinimal);
+}
+
 export async function trustAllNotebooks() {
  const api = await initialize();
  const dsSettings = api.serviceContainer.get<IConfigurationService>(IConfigurationService).getSettings().datascience;

src/test/datascience/notebook/linter.ds.test.ts

@@ -0,0 +1,71 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+'use strict';
+
+// tslint:disable:no-require-imports no-var-requires
+import { assert } from 'chai';
+import * as path from 'path';
+import * as sinon from 'sinon';
+import * as vscode from 'vscode';
+import { ICommandManager, IVSCodeNotebook } from '../../../client/common/application/types';
+import { Commands } from '../../../client/common/constants';
+import { IDisposable } from '../../../client/common/types';
+import { INotebookEditorProvider } from '../../../client/datascience/types';
+import { IExtensionTestApi } from '../../common';
+import { EXTENSION_ROOT_DIR_FOR_TESTS, initialize } from '../../initialize';
+import {
+ canRunTests,
+ closeNotebooksAndCleanUpAfterTests,
+ createTemporaryNotebook,
+ setLinterToPylint,
+ trustAllNotebooks
+} from './helper';
+// tslint:disable-next-line: no-var-requires no-require-imports
+
+// tslint:disable: no-any no-invalid-this
+suite('DataScience - VSCode Notebook - (linting)', function () {
+ this.timeout(15_000);
+ const templateIPynb = path.join(
+ EXTENSION_ROOT_DIR_FOR_TESTS,
+ 'src',
+ 'test',
+ 'datascience',
+ 'notebook',
+ 'linterTest.ipynb'
+ );
+ let api: IExtensionTestApi;
+ const disposables: IDisposable[] = [];
+ suiteSetup(async function () {
+ this.timeout(15_000);
+ api = await initialize();
+ if (!(await canRunTests())) {
+ return this.skip();
+ }
+ });
+ setup(async () => {
+ await trustAllNotebooks();
+ sinon.restore();
+ });
+ teardown(async () => closeNotebooksAndCleanUpAfterTests(disposables));
+ suiteTeardown(closeNotebooksAndCleanUpAfterTests);
+
+ test('Linter runs on file', async () => {
+ await setLinterToPylint(false);
+ const editorProvider = api.serviceContainer.get<INotebookEditorProvider>(INotebookEditorProvider);
+ await editorProvider.open(vscode.Uri.file(templateIPynb));
+
+ const document = api.serviceContainer.get<IVSCodeNotebook>(IVSCodeNotebook).activeNotebookEditor!.document;
+
+ // Wait for the linter to run
+ await api.serviceContainer.get<ICommandManager>(ICommandManager).executeCommand(Commands.Run_Linter);
+
+ // Each cell should have its own list of linting errors
+ const cell1 = document.cells[0];
+ let diagnostics = vscode.languages.getDiagnostics(cell1.document.uri);
+ assert.equal(diagnostics.length, 4, 'No linting on first cell');
+ const cell2 = document.cells[1];
+ diagnostics = vscode.languages.getDiagnostics(cell2.document.uri);
+ assert.equal(diagnostics.length, 3, 'No linting on second cell');
+ });
+});

src/test/datascience/notebook/linterTest.ipynb

@@ -0,0 +1 @@
+{"cells":[{"cell_type":"code","execution_count":1,"metadata":{},"outputs":[{"data":{"text/plain":"1"},"execution_count":1,"metadata":{},"output_type":"execute_result"}],"source":["a=1"]},{"cell_type":"code","execution_count":null,"metadata":{},"outputs":[],"source":["b = 4\r\n","print(b)"]}],"metadata":{"file_extension":".py","kernelspec":{"display_name":"Python 3.8.5 64-bit ('storeEnv': venv)","name":"python_defaultSpec_1597181082069"},"language_info":{"codemirror_mode":{"name":"ipython","version":3},"name":"python","version":"3.8.5-final"},"mimetype":"text/x-python","name":"python","npconvert_exporter":"python","orig_nbformat":2,"pygments_lexer":"ipython3","version":3},"nbformat":4,"nbformat_minor":2}