azuredatastudio/test/smoke/src/sql/areas/notebook/notebook.test.ts

/*---------------------------------------------------------------------------------------------
 *  Copyright (c) Microsoft Corporation. All rights reserved.
 *  Licensed under the Source EULA. See License.txt in the project root for license information.
 *--------------------------------------------------------------------------------------------*/

import { Application } from '../../../../../automation';
import * as minimist from 'minimist';
import { afterSuite, beforeSuite } from '../../../utils';
import * as assert from 'assert';

export function setup(opts: minimist.ParsedArgs) {
	describe('Notebook', () => {
		beforeSuite(opts);
		afterSuite(opts);

		it('can perform basic text cell functionality', async function () {
			const app = this.app as Application;
			await app.workbench.sqlNotebook.newUntitledNotebook();
			await app.workbench.sqlNotebook.addCellFromPlaceholder('Markdown');
			await app.workbench.sqlNotebook.waitForPlaceholderGone();

			await app.code.dispatchKeybinding('escape'); // first escape sets the cell in edit mode
			await app.code.dispatchKeybinding('escape'); // second escape unselects cell completely
			await app.workbench.sqlNotebook.waitForDoubleClickToEdit();
			await app.workbench.sqlNotebook.doubleClickTextCell();
			await app.workbench.sqlNotebook.waitForDoubleClickToEditGone();

			await app.workbench.sqlNotebook.textCellToolbar.changeTextCellView('Split View');
			const sampleText: string = 'Test text cells';
			await app.workbench.sqlNotebook.waitForTypeInEditor(sampleText);
			await app.workbench.sqlNotebook.selectAllTextInEditor();
			await app.workbench.sqlNotebook.textCellToolbar.boldSelectedText();
			await app.code.dispatchKeybinding('escape');
			await app.workbench.sqlNotebook.waitForTextCellPreviewContent(sampleText, 'p', 'strong');
		});

		it('can perform basic code cell functionality', async function () {
			const app = this.app as Application;
			await app.workbench.sqlNotebook.newUntitledNotebook();
			await app.workbench.sqlNotebook.notebookToolbar.waitForKernel('SQL');
			await app.workbench.sqlNotebook.addCellFromPlaceholder('Code');
			await app.workbench.sqlNotebook.waitForPlaceholderGone();

			const text1: string = 'SEL';
			await app.workbench.sqlNotebook.waitForTypeInEditor(text1);
			await app.code.dispatchKeybinding('ctrl+space bar');

			// check for completion suggestions
			await app.workbench.sqlNotebook.waitForSuggestionWidget();
			await app.workbench.sqlNotebook.waitForSuggestionResult('SELECT');
			await app.code.dispatchKeybinding('tab');

			const text2: string = ' * FROM employees';
			await app.workbench.sqlNotebook.waitForTypeInEditor(text2);

			await app.workbench.sqlNotebook.waitForColorization('1', 'mtk5'); // SELECT
			await app.workbench.sqlNotebook.waitForColorization('3', 'mtk13'); // *
			await app.workbench.sqlNotebook.waitForColorization('5', 'mtk5'); // FROM
			await app.workbench.sqlNotebook.waitForColorization('6', 'mtk1'); // employees
		});

		// Python Notebooks

		it('can open new notebook, configure Python, and execute one cell', async function () {
			this.timeout(600000); // set timeout to 10 minutes to ensure test does not timeout during python installation
			const app = this.app as Application;
			await app.workbench.sqlNotebook.newUntitledNotebook();
			await app.workbench.sqlNotebook.addCell('code');
			await app.workbench.sqlNotebook.waitForTypeInEditor('print("Hello world!")');
			await app.workbench.sqlNotebook.notebookToolbar.waitForKernel('SQL');

			await app.workbench.sqlNotebook.notebookToolbar.changeKernel('Python 3');
			await app.workbench.configurePythonDialog.waitForConfigurePythonDialog();
			await app.workbench.configurePythonDialog.waitForPageOneLoaded();
			await app.workbench.configurePythonDialog.next();
			await app.workbench.configurePythonDialog.waitForPageTwoLoaded();
			await app.workbench.configurePythonDialog.install();
			await app.workbench.sqlNotebook.notebookToolbar.waitForKernel('Python 3');

			await app.workbench.sqlNotebook.runActiveCell();
			await app.workbench.sqlNotebook.waitForActiveCellResults();
		});

		it('can open ipynb file, run all, and save notebook with outputs', async function () {
			const app = this.app as Application;
			await openAndRunNotebook(app, 'hello.ipynb');
		});

		it('can open ipynb file from path with spaces, run all, and save notebook with outputs', async function () {
			const app = this.app as Application;
			await openAndRunNotebook(app, 'helloWithSpaces.ipynb');
		});

		it('can open ipynb file from path with escaped spaces, run all, and save notebook with outputs', async function () {
			const app = this.app as Application;
			await openAndRunNotebook(app, 'helloWithEscapedSpaces.ipynb');
		});

		afterEach(async function () {
			const app = this.app as Application;
			// If the test failed, take a screenshot before closing the active editor.
			if (this.currentTest!.state === 'failed') {
				const name = this.currentTest!.fullTitle().replace(/[^a-z0-9\-]/ig, '_');
				await app.captureScreenshot(`${name} (screenshot before revertAndCloseActiveEditor action)`);
			}

			await app.workbench.quickaccess.runCommand('workbench.action.revertAndCloseActiveEditor');

			// Close any open wizards
			await app.code.dispatchKeybinding('escape');
		});

		describe('Notebook Toolbar Actions', async () => {

			it('Collapse and Expand Cell', async function () {
				const app = this.app as Application;
				await app.workbench.sqlNotebook.openFile('collapsed.ipynb');
				await app.workbench.sqlNotebook.waitForCollapseIconInCells();
				await app.workbench.sqlNotebook.notebookToolbar.waitForCollapseCellsNotebookIcon();
				await app.workbench.sqlNotebook.notebookToolbar.collapseCells();
				await app.workbench.sqlNotebook.waitForExpandIconInCells();
				await app.workbench.sqlNotebook.notebookToolbar.waitForExpandCellsNotebookIcon();
				await app.workbench.sqlNotebook.notebookToolbar.expandCells();
				await app.workbench.sqlNotebook.waitForCollapseIconInCells();
				await app.workbench.sqlNotebook.notebookToolbar.waitForCollapseCellsNotebookIcon();
			});

			it('can open untrusted notebook, trust, save, and reopen trusted notebook', async function () {
				const app = this.app as Application;
				await app.workbench.sqlNotebook.openFile('untrusted.ipynb');
				await app.workbench.sqlNotebook.notebookToolbar.waitForKernel('SQL');
				await app.workbench.sqlNotebook.notebookToolbar.waitForNotTrustedIcon();
				await app.workbench.sqlNotebook.waitForTrustedElementsGone();

				await app.workbench.sqlNotebook.notebookToolbar.trustNotebook();
				await app.workbench.sqlNotebook.notebookToolbar.waitForTrustedIcon();
				await app.workbench.sqlNotebook.waitForTrustedElements();

				await app.workbench.quickaccess.runCommand('workbench.action.files.save');
				await app.workbench.quickaccess.runCommand('workbench.action.closeActiveEditor');

				await app.workbench.sqlNotebook.openFile('untrusted.ipynb');
				await app.workbench.sqlNotebook.notebookToolbar.waitForTrustedIcon();
				await app.workbench.sqlNotebook.waitForTrustedElements();
			});
		});

		describe('markdown', function () {
			it('can create http link from markdown', async function () {
				const app = this.app as Application;
				const markdownString = '[Microsoft homepage](http://www.microsoft.com)';
				const linkSelector = '.notebook-cell.active .notebook-text a[href=\'http://www.microsoft.com\']';
				await verifyElementRendered(app, markdownString, linkSelector);
			});
			it('can create img from markdown', async function () {
				const app = this.app as Application;
				const markdownString = '![Churn-Index](https://www.ngdata.com/wp-content/uploads/2016/05/churn.jpg)';
				// Verify image with the correct src and alt attributes is created
				const imgSelector = '.notebook-cell.active .notebook-text img[src=\'https://www.ngdata.com/wp-content/uploads/2016/05/churn.jpg\'][alt=\'Churn-Index\']';
				await verifyElementRendered(app, markdownString, imgSelector);
			});
		});
	});
}

/**
 * Verifies that the given markdown string is rendered into the expected HTML element in split view, rich text view
 * and the text cell outside of edit mode.
 * @param app The application
 * @param markdownString The markdown text to enter for the element to render
 * @param element The query selector for the element that is expected to be rendered
 */
async function verifyElementRendered(app: Application, markdownString: string, element: string): Promise<void> {
	await app.workbench.sqlNotebook.newUntitledNotebook();
	await app.workbench.sqlNotebook.addCell('markdown');
	await app.workbench.sqlNotebook.textCellToolbar.changeTextCellView('Split View');
	await app.workbench.sqlNotebook.waitForTypeInEditor(markdownString);
	// Verify link is shown in split view
	await app.code.waitForElement(element);
	await app.workbench.sqlNotebook.textCellToolbar.changeTextCellView('Rich Text View');
	// Verify link is shown in WYSIWYG view
	await app.code.waitForElement(element);
	// Verify link is shown outside of edit mode
	await app.code.dispatchKeybinding('escape');
	await app.code.waitForElement(element);
}

async function openAndRunNotebook(app: Application, filename: string): Promise<void> {
	await app.workbench.sqlNotebook.openFile(filename);
	await app.workbench.sqlNotebook.notebookToolbar.waitForKernel('Python 3');

	await app.workbench.sqlNotebook.notebookToolbar.clearResults();
	await app.workbench.sqlNotebook.waitForAllResultsGone();
	await app.workbench.sqlNotebook.runAllCells();
	await app.workbench.sqlNotebook.waitForAllResults();

	await app.workbench.quickaccess.runCommand('workbench.action.files.save');
	await app.workbench.quickaccess.runCommand('workbench.action.closeActiveEditor');

	await app.workbench.sqlNotebook.openFile(filename);
	await app.workbench.sqlNotebook.notebookToolbar.waitForKernel('Python 3');
	await app.workbench.sqlNotebook.waitForAllResults();
}