fix failing path tests for notebook (#9195)

IanMatthewHuff · web-flow · commit 4074633bcca5 · 2019-12-18T13:30:24.000-08:00
diff --git a/news/3 Code Health/9191.md b/news/3 Code Health/9191.md
@@ -0,0 +1 @@
+Fix working directory path verification for notebook tests.
diff --git a/src/test/datascience/mockJupyterManager.ts b/src/test/datascience/mockJupyterManager.ts
@@ -149,7 +149,7 @@ export class MockJupyterManager implements IJupyterSessionManager {
         this.addCell(`__file__ = '${Uri.file('bar.py').fsPath.replace(/\\/g, '\\\\')}'`);
         this.addCell(`__file__ = '${Uri.file('foo').fsPath.replace(/\\/g, '\\\\')}'`);
         this.addCell(`__file__ = '${Uri.file('test.py').fsPath.replace(/\\/g, '\\\\')}'`);
-        this.addCell('import os\nos.getcwd()', path.join(EXTENSION_ROOT_DIR));
+        this.addCell('import os\nos.getcwd()', `'${path.join(EXTENSION_ROOT_DIR)}'`);
     }
 
     public getConnInfo(): IConnection {
@@ -326,6 +326,10 @@ export class MockJupyterManager implements IJupyterSessionManager {
         return Promise.resolve([]);
     }
 
+    public changeWorkingDirectory(workingDir: string) {
+        this.addCell('import os\nos.getcwd()', path.join(workingDir));
+    }
+
     private addCellOutput(cell: ICell, result?: undefined | string | number | nbformat.IUnrecognizedOutput | nbformat.IExecuteResult | nbformat.IDisplayData | nbformat.IStream | nbformat.IError, mimeType?: string) {
         const massagedResult = this.massageCellResult(result, mimeType);
         const data: nbformat.ICodeCell = cell.data as nbformat.ICodeCell;
diff --git a/src/test/datascience/notebook.functional.test.ts b/src/test/datascience/notebook.functional.test.ts
@@ -128,11 +128,18 @@ suite('DataScience notebook tests', () => {
         }
     }
 
-    async function verifySimple(notebook: INotebook | undefined, code: string, expectedValue: any): Promise<void> {
+    async function verifySimple(notebook: INotebook | undefined, code: string, expectedValue: any, pathVerify = false): Promise<void> {
         const cells = await notebook!.execute(code, path.join(srcDirectory(), 'foo.py'), 2, uuid());
         assert.equal(cells.length, 1, `Wrong number of cells returned`);
         const data = extractDataOutput(cells[0]);
-        assert.equal(data, expectedValue, 'Cell value does not match');
+        if (pathVerify) {
+            // For a path comparison normalize output and add single quotes on expected value
+            const normalizedOutput = path.normalize(data).toUpperCase();
+            const normalizedTarget = `'${path.normalize(expectedValue).toUpperCase()}'`;
+            assert.equal(normalizedOutput, normalizedTarget, 'Cell path values does not match');
+        } else {
+            assert.equal(data, expectedValue, 'Cell value does not match');
+        }
     }
 
     async function verifyError(notebook: INotebook | undefined, code: string, errorString: string): Promise<void> {
@@ -224,14 +231,21 @@ suite('DataScience notebook tests', () => {
         });
     }
 
-    async function createNotebook(useDefaultConfig: boolean, expectFailure?: boolean, usingDarkTheme?: boolean, purpose?: string): Promise<INotebook | undefined> {
+    async function createNotebook(useDefaultConfig: boolean, expectFailure?: boolean, usingDarkTheme?: boolean, purpose?: string, workingDir?: string, launchingFile?: string): Promise<INotebook | undefined> {
         // Catch exceptions. Throw a specific assertion if the promise fails
         try {
-            const server = await jupyterExecution.connectToNotebookServer({ usingDarkTheme, useDefaultConfig, workingDir: ioc.getSettings().datascience.notebookFileRoot, purpose: purpose ? purpose : '1' });
+            const server = await jupyterExecution.connectToNotebookServer({ usingDarkTheme, useDefaultConfig, workingDir: workingDir ? workingDir : ioc.getSettings().datascience.notebookFileRoot, purpose: purpose ? purpose : '1' });
             if (expectFailure) {
                 assert.ok(false, `Expected server to not be created`);
             }
-            return server ? await server.createNotebook(Uri.parse(Identifiers.InteractiveWindowIdentity)) : undefined;
+            if (server) {
+                const notebook = await server.createNotebook(Uri.parse(Identifiers.InteractiveWindowIdentity));
+                // If specified set our launch file
+                if (launchingFile) {
+                    await notebook.setLaunchingFile(launchingFile);
+                }
+                return notebook;
+            }
         } catch (exc) {
             if (!expectFailure) {
                 assert.ok(false, `Expected server to be created, but got ${exc}`);
@@ -249,6 +263,12 @@ suite('DataScience notebook tests', () => {
         }
     }
 
+    function changeMockWorkingDirectory(workingDir: string) {
+        if (ioc.mockJupyter) {
+            ioc.mockJupyter.changeWorkingDirectory(workingDir);
+        }
+    }
+
     function addInterruptableMockData(code: string, resultGenerator: (c: CancellationToken) => Promise<{ result: string; haveMore: boolean }>) {
         if (ioc.mockJupyter) {
             ioc.mockJupyter.addContinuousOutputCell(code, resultGenerator);
@@ -531,9 +551,18 @@ suite('DataScience notebook tests', () => {
         }
     });
 
-    runTest('Verify path', async () => {
-        const notebook = await createNotebook(true);
-        await verifySimple(notebook, 'import os\nos.getcwd()', EXTENSION_ROOT_DIR);
+    runTest('Verify manual working directory', async () => {
+        // Instead of default, manually set a working directory
+        const notebook = await createNotebook(true, undefined, undefined, undefined, EXTENSION_ROOT_DIR);
+        await verifySimple(notebook, 'import os\nos.getcwd()', EXTENSION_ROOT_DIR, true);
+    });
+
+    // tslint:disable-next-line:no-invalid-template-strings
+    runTest('Verify ${fileDirname} working directory', async () => {
+        // Verify that the default ${fileDirname} setting sets the working directory to the file path
+        changeMockWorkingDirectory(`'${srcDirectory()}'`);
+        const notebook = await createNotebook(true, undefined, undefined, undefined, undefined, path.join(srcDirectory(), 'foo.py'));
+        await verifySimple(notebook, 'import os\nos.getcwd()', srcDirectory(), true);
     });
 
     runTest('Change Interpreter', async () => {

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+Fix working directory path verification for notebook tests.`