Modify package.json to run ds tests with VSCNotebook (#12270)

Author: DonJayamanne

package.json

@@ -2997,7 +2997,8 @@
         "test:cover:report": "nyc --nycrc-path build/.nycrc  report --reporter=text --reporter=html --reporter=text-summary --reporter=cobertura",
         "testDebugger": "node ./out/test/testBootstrap.js ./out/test/debuggerTest.js",
         "testSingleWorkspace": "node ./out/test/testBootstrap.js ./out/test/standardTest.js",
-        "testDataScience": "cross-env CODE_TESTS_WORKSPACE=src/test/datascience VSC_PYTHON_CI_TEST_VSC_CHANNEL=insiders TEST_FILES_SUFFIX=ds.test node ./out/test/testBootstrap.js ./out/test/standardTest.js",
+        "pretestDataScience": "node ./out/test/datascience/dsTestSetup.js",
+        "testDataScience": "cross-env CODE_TESTS_WORKSPACE=src/test/datascience VSC_PYTHON_CI_TEST_VSC_CHANNEL=insiders TEST_FILES_SUFFIX=ds.test VSC_PYTHON_LOAD_EXPERIMENTS_FROM_FILE=true node ./out/test/testBootstrap.js ./out/test/standardTest.js",
         "testMultiWorkspace": "node ./out/test/testBootstrap.js ./out/test/multiRootTest.js",
         "testPerformance": "node ./out/test/testBootstrap.js ./out/test/performanceTest.js",
         "testSmoke": "node ./out/test/smokeTest.js",

src/client/common/experiments/manager.ts

@@ -131,6 +131,7 @@ export class ExperimentsManager implements IExperimentsManager {
         this.populateUserExperiments();
         for (const exp of this.userExperiments || []) {
             // We need to know whether an experiment influences the logs we observe in github issues, so log the experiment group
+            // tslint:disable-next-line: no-console
             this.output.appendLine(Experiments.inGroup().format(exp.name));
         }
         this.initializeInBackground().ignoreErrors();

src/test/datascience/.vscode/settings.json

@@ -13,6 +13,7 @@
     "python.formatting.provider": "yapf",
     "python.pythonPath": "python",
     "python.experiments.optInto": [
+        "LocalZMQKernel - experiment",
         "NativeNotebook - experiment"
     ],
     // Do not set this to "Microsoft", else it will result in LS being downloaded on CI

src/test/datascience/dsTestSetup.ts

@@ -0,0 +1,62 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+import * as fs from 'fs-extra';
+import * as path from 'path';
+import { EXTENSION_ROOT_DIR_FOR_TESTS } from '../constants';
+/**
+ * Modify package.json to ensure VSC Notebooks have been setup so tests can run.
+ * This is required because we modify package.json during runtime, hence we need to do the same thing for tests.
+ */
+
+const packageJsonFile = path.join(EXTENSION_ROOT_DIR_FOR_TESTS, 'package.json');
+const content = JSON.parse(fs.readFileSync(packageJsonFile).toString());
+
+// This code is temporary.
+if (
+    !content.enableProposedApi ||
+    !Array.isArray(content.contributes.notebookOutputRenderer) ||
+    !Array.isArray(content.contributes.notebookProvider)
+) {
+    content.enableProposedApi = true;
+    content.contributes.notebookOutputRenderer = [
+        {
+            viewType: 'jupyter-notebook-renderer',
+            displayName: 'Jupyter Notebook Renderer',
+            mimeTypes: [
+                'application/geo+json',
+                'application/vdom.v1+json',
+                'application/vnd.dataresource+json',
+                'application/vnd.plotly.v1+json',
+                'application/vnd.vega.v2+json',
+                'application/vnd.vega.v3+json',
+                'application/vnd.vega.v4+json',
+                'application/vnd.vega.v5+json',
+                'application/vnd.vegalite.v1+json',
+                'application/vnd.vegalite.v2+json',
+                'application/vnd.vegalite.v3+json',
+                'application/vnd.vegalite.v4+json',
+                'application/x-nteract-model-debug+json',
+                'image/gif',
+                'text/latex',
+                'text/vnd.plotly.v1+html'
+            ]
+        }
+    ];
+    content.contributes.notebookProvider = [
+        {
+            viewType: 'jupyter-notebook',
+            displayName: 'Jupyter Notebook',
+            selector: [
+                {
+                    filenamePattern: '*.ipynb'
+                }
+            ]
+        }
+    ];
+}
+
+// Update package.json to pick experiments from our custom settings.json file.
+content.contributes.configuration.properties['python.experiments.optInto'].scope = 'resource';
+
+fs.writeFileSync(packageJsonFile, JSON.stringify(content, undefined, 4));

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

@@ -30,14 +30,14 @@ const vscodeNotebookEnums = require('vscode') as typeof import('vscode-proposed'
 
 // tslint:disable: no-any no-invalid-this
 suite('DataScience - VSCode Notebook - (Execution)', function () {
-    this.timeout(15_000);
+    this.timeout(60_000);
 
     let api: IExtensionTestApi;
     let editorProvider: INotebookEditorProvider;
     const disposables: IDisposable[] = [];
     let vscodeNotebook: IVSCodeNotebook;
     suiteSetup(async function () {
-        this.timeout(15_000);
+        this.timeout(60_000);
         api = await initialize();
         if (!(await canRunTests())) {
             return this.skip();

src/test/datascience/notebook/helper.ts

@@ -135,6 +135,7 @@ export async function createTemporaryFile(options: {
 
 export async function createTemporaryNotebook(templateFile: string, disposables: IDisposable[]): Promise<string> {
     const extension = path.extname(templateFile);
+    fs.ensureDirSync(path.join(EXTENSION_ROOT_DIR_FOR_TESTS, 'tmp'));
     const tempFile = tmp.tmpNameSync({ postfix: extension, dir: path.join(EXTENSION_ROOT_DIR_FOR_TESTS, 'tmp') });
     await fs.copyFile(templateFile, tempFile);
     disposables.push({ dispose: () => swallowExceptions(() => fs.unlinkSync(tempFile)) });

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

@@ -36,7 +36,7 @@ const vscodeNotebookEnums = require('vscode') as typeof import('vscode-proposed'
  * This is done by stubbing out some methods.
  */
 suite('DataScience - VSCode Notebook - Restart/Interrupt/Cancel/Errors', function () {
-    this.timeout(15_000);
+    this.timeout(60_000);
 
     let api: IExtensionTestApi;
     let editorProvider: INotebookEditorProvider;
@@ -46,7 +46,7 @@ suite('DataScience - VSCode Notebook - Restart/Interrupt/Cancel/Errors', functio
     let vscodeNotebook: IVSCodeNotebook;
     const suiteDisposables: IDisposable[] = [];
     suiteSetup(async function () {
-        this.timeout(15_000);
+        this.timeout(60_000);
         api = await initialize();
         if (!(await canRunTests())) {
             return this.skip();

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

@@ -35,17 +35,15 @@ const vscodeNotebookEnums = require('vscode') as typeof import('vscode-proposed'
 
 // tslint:disable: no-any no-invalid-this
 suite('DataScience - VSCode Notebook - (Saving)', function () {
-    this.timeout(15_000);
-    this.retries(0);
+    this.timeout(60_000);
     const templateIPynb = path.join(EXTENSION_ROOT_DIR_FOR_TESTS, 'src', 'test', 'datascience', 'test.ipynb');
     let api: IExtensionTestApi;
     let testIPynb: Uri;
     let editorProvider: INotebookEditorProvider;
     const disposables: IDisposable[] = [];
     let vscodeNotebook: IVSCodeNotebook;
     suiteSetup(async function () {
-        this.timeout(15_000);
-        this.retries(0);
+        this.timeout(60_000);
         api = await initialize();
         if (!(await canRunTests())) {
             return this.skip();