Added console logs for Book unit tests (#6876)

* added logs

* use uuid for random path name

extensions/notebook/package.json

@@ -373,6 +373,7 @@
 		"@types/node": "^11.9.3",
 		"@types/request": "^2.48.1",
 		"@types/temp-write": "^3.3.0",
+		"@types/uuid": "^3.4.5",
 		"assert": "^1.4.1",
 		"mocha": "^5.2.0",
 		"mocha-junit-reporter": "^1.17.0",

extensions/notebook/src/test/book/book.test.ts

@@ -0,0 +1,156 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the Source EULA. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+import * as vscode from 'vscode';
+import * as should from 'should';
+import * as TypeMoq from 'typemoq';
+import * as path from 'path';
+import * as fs from 'fs-extra';
+import * as rimraf from 'rimraf';
+import * as os from 'os';
+import * as uuid from 'uuid';
+import { BookTreeViewProvider } from '../../book/bookTreeView';
+import { BookTreeItem } from '../../book/bookTreeItem';
+
+export interface ExpectedBookItem {
+	title: string;
+	url?: string;
+	sections?: any[];
+	external?: boolean;
+	previousUri?: string | undefined;
+	nextUri?: string | undefined;
+}
+
+export function equalBookItems(book: BookTreeItem, expectedBook: ExpectedBookItem): void {
+	should(book.title).equal(expectedBook.title);
+	should(book.uri).equal(expectedBook.url);
+	if (expectedBook.previousUri || expectedBook.nextUri) {
+		let prevUri = book.previousUri ? book.previousUri.toLocaleLowerCase() : undefined;
+		should(prevUri).equal(expectedBook.previousUri);
+		let nextUri = book.nextUri ? book.nextUri.toLocaleLowerCase() : undefined;
+		should(nextUri).equal(expectedBook.nextUri);
+	}
+}
+
+describe('BookTreeViewProvider.getChildren', function (): void {
+	let rootFolderPath: string;
+	let expectedNotebook1: ExpectedBookItem;
+	let expectedNotebook2: ExpectedBookItem;
+	let expectedNotebook3: ExpectedBookItem;
+	let expectedMarkdown: ExpectedBookItem;
+	let expectedExternalLink: ExpectedBookItem;
+	let expectedBook: ExpectedBookItem;
+
+	let mockExtensionContext: TypeMoq.IMock<vscode.ExtensionContext>;
+	let bookTreeViewProvider: BookTreeViewProvider;
+	let book: BookTreeItem;
+	let notebook1: BookTreeItem;
+
+	this.beforeAll(async () => {
+		console.log('Generating random rootFolderPath...');
+		rootFolderPath = path.join(os.tmpdir(), `BookTestData_${uuid.v4()}`);
+		console.log('Random rootFolderPath generated.');
+		let dataFolderPath = path.join(rootFolderPath, '_data');
+		let contentFolderPath = path.join(rootFolderPath, 'content');
+		let configFile = path.join(rootFolderPath, '_config.yml');
+		let tableOfContentsFile = path.join(dataFolderPath, 'toc.yml');
+		let notebook1File = path.join(contentFolderPath, 'notebook1.ipynb');
+		let notebook2File = path.join(contentFolderPath, 'notebook2.ipynb');
+		let notebook3File = path.join(contentFolderPath, 'notebook3.ipynb');
+		let markdownFile = path.join(contentFolderPath, 'markdown.md');
+		expectedNotebook1 = {
+			title: 'Notebook1',
+			url: '/notebook1',
+			previousUri: undefined,
+			nextUri: notebook2File.toLocaleLowerCase()
+		};
+		expectedNotebook2 = {
+			title: 'Notebook2',
+			url: '/notebook2',
+			previousUri: notebook1File.toLocaleLowerCase(),
+			nextUri: notebook3File.toLocaleLowerCase()
+		};
+		expectedNotebook3 = {
+			title: 'Notebook3',
+			url: '/notebook3',
+			previousUri: notebook2File.toLocaleLowerCase(),
+			nextUri: undefined
+		};
+		expectedMarkdown = {
+			title: 'Markdown',
+			url: '/markdown'
+		};
+		expectedExternalLink = {
+			title: 'GitHub',
+			url: 'https://github.com/',
+			external: true
+		};
+		expectedBook = {
+			sections: [expectedNotebook1, expectedMarkdown, expectedExternalLink],
+			title: 'Test Book'
+		};
+		console.log('Creating temporary folders and files...');
+		await fs.mkdir(rootFolderPath);
+		await fs.mkdir(dataFolderPath);
+		await fs.mkdir(contentFolderPath);
+		await fs.writeFile(configFile, 'title: Test Book');
+		await fs.writeFile(tableOfContentsFile, '- title: Notebook1\n  url: /notebook1\n  sections:\n  - title: Notebook2\n    url: /notebook2\n  - title: Notebook3\n    url: /notebook3\n- title: Markdown\n  url: /markdown\n- title: GitHub\n  url: https://github.com/\n  external: true');
+		await fs.writeFile(notebook1File, '');
+		await fs.writeFile(notebook2File, '');
+		await fs.writeFile(notebook3File, '');
+		await fs.writeFile(markdownFile, '');
+		console.log('Temporary folders and files created.');
+		mockExtensionContext = TypeMoq.Mock.ofType<vscode.ExtensionContext>();
+		let folder: vscode.WorkspaceFolder = {
+			uri: vscode.Uri.file(rootFolderPath),
+			name: '',
+			index: 0
+		};
+		console.log('Creating BookTreeViewProvider...');
+		bookTreeViewProvider = new BookTreeViewProvider([folder], mockExtensionContext.object);
+		let tocRead = new Promise((resolve, reject) => bookTreeViewProvider.onReadAllTOCFiles(() => resolve()));
+		let errorCase = new Promise((resolve, reject) => setTimeout(() => resolve(), 5000));
+		await Promise.race([tocRead, errorCase.then(() => { throw new Error('Table of Contents were not ready in time'); })]);
+		console.log('BookTreeViewProvider successfully created.');
+	});
+
+	it('should return all book nodes when element is undefined', async function (): Promise<void> {
+		const children = await bookTreeViewProvider.getChildren();
+		should(children).be.Array();
+		should(children.length).equal(1);
+		book = children[0];
+		should(book.title).equal(expectedBook.title);
+	});
+
+	it('should return all page nodes when element is a book', async function (): Promise<void> {
+		const children = await bookTreeViewProvider.getChildren(book);
+		should(children).be.Array();
+		should(children.length).equal(3);
+		notebook1 = children[0];
+		const markdown = children[1];
+		const externalLink = children[2];
+		equalBookItems(notebook1, expectedNotebook1);
+		equalBookItems(markdown, expectedMarkdown);
+		equalBookItems(externalLink, expectedExternalLink);
+	});
+
+	it('should return all sections when element is a notebook', async function (): Promise<void> {
+		const children = await bookTreeViewProvider.getChildren(notebook1);
+		should(children).be.Array();
+		should(children.length).equal(2);
+		const notebook2 = children[0];
+		const notebook3 = children[1];
+		equalBookItems(notebook2, expectedNotebook2);
+		equalBookItems(notebook3, expectedNotebook3);
+	});
+
+	this.afterAll(async function () {
+		console.log('Removing temporary files...');
+		if (fs.existsSync(rootFolderPath)) {
+			rimraf.sync(rootFolderPath);
+		}
+		console.log('Successfully removed temporary files.');
+	});
+});

extensions/notebook/yarn.lock

@@ -196,6 +196,13 @@
   resolved "https://registry.yarnpkg.com/@types/tough-cookie/-/tough-cookie-2.3.5.tgz#9da44ed75571999b65c37b60c9b2b88db54c585d"
   integrity sha512-SCcK7mvGi3+ZNz833RRjFIxrn4gI1PPR3NtuIS+6vMkvmsGjosqTJwRt5bAEFLRz+wtJMWv8+uOnZf2hi2QXTg==
 
+"@types/uuid@^3.4.5":
+  version "3.4.5"
+  resolved "https://registry.yarnpkg.com/@types/uuid/-/uuid-3.4.5.tgz#d4dc10785b497a1474eae0ba7f0cb09c0ddfd6eb"
+  integrity sha512-MNL15wC3EKyw1VLF+RoVO4hJJdk9t/Hlv3rt1OL65Qvuadm4BYo6g9ZJQqoq7X8NBFSsQXgAujWciovh2lpVjA==
+  dependencies:
+    "@types/node" "*"
+
 ajv@^6.5.5:
   version "6.9.1"
   resolved "https://registry.yarnpkg.com/ajv/-/ajv-6.9.1.tgz#a4d3683d74abc5670e75f0b16520f70a20ea8dc1"