ckaczor/azuredatastudio
1
0
Fork 0
mirror of https://github.com/ckaczor/azuredatastudio.git synced 2026-02-16 10:58:30 -05:00
Code Issues Packages Projects Releases Wiki Activity

Unit Tests for Books (#6676)

Browse Source 
* added test for sections and navigation

* update variable names

* latest from master

* add await for creating file methods

* wait for all toc.yml to be found

* add event to signal all toc.yml files read

* add workspae folder parameter back

* remove toc filter

* use onReadAllTOCFIles event

* added timeout logic for getting toc.yml files

* latest from master

* new method for comparing book items
This commit is contained in:
Lucy Zhang
2019-08-16 17:01:43 -07:00
committed by GitHub
parent 4c24ea0f7d
commit fb26126bcb
1 changed files with 113 additions and 67 deletions
Download Patch File Download Diff File Expand all files Collapse all files

180
extensions/notebook/src/test/book/book.test.ts
View File

@@ -12,91 +12,137 @@ import * as rimraf from 'rimraf';
import * as os from 'os'; import * as os from 'os';
import { BookTreeViewProvider } from '../../book/bookTreeView'; import { BookTreeViewProvider } from '../../book/bookTreeView';
import { BookTreeItem } from '../../book/bookTreeItem'; import { BookTreeItem } from '../../book/bookTreeItem';
import * as assert from 'assert';
const SEED = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789'; const SEED = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789';
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 { describe('BookTreeViewProvider.getChildren', function (): void {
let rootFolderPath: string; let rootFolderPath: string;
const expectedNotebook = { let expectedNotebook1: ExpectedBookItem;
title: 'Notebook', let expectedNotebook2: ExpectedBookItem;
url: '/notebook' let expectedNotebook3: ExpectedBookItem;
}; let expectedMarkdown: ExpectedBookItem;
const expectedMarkdown = { let expectedExternalLink: ExpectedBookItem;
title: 'Markdown', let expectedBook: ExpectedBookItem;
url: '/markdown'
};
const expectedExternalLink = {
title: 'GitHub',
url: 'https://github.com/',
external: true
};
const expectedBook = {
sections: [expectedNotebook, expectedMarkdown, expectedExternalLink],
title: 'Test Book'
};
let mockExtensionContext: TypeMoq.IMock<vscode.ExtensionContext>; let mockExtensionContext: TypeMoq.IMock<vscode.ExtensionContext>;
let bookTreeViewProvider: BookTreeViewProvider; let bookTreeViewProvider: BookTreeViewProvider;
let book: BookTreeItem; let book: BookTreeItem;
let notebook1: BookTreeItem;
this.beforeAll(async () => { this.beforeAll(async () => {
try { let testFolder = '';
let testFolder = ''; for (let i = 0; i < 8; i++) {
for (let i = 0; i < 8; i++) { testFolder += SEED.charAt(Math.floor(Math.random() * SEED.length));
testFolder += SEED.charAt(Math.floor(Math.random() * SEED.length));
}
rootFolderPath = path.join(os.tmpdir(), 'BookTestData_' + testFolder);
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 notebookFile = path.join(contentFolderPath, 'notebook.ipynb');
let markdownFile = path.join(contentFolderPath, 'markdown.md');
await fs.mkdir(rootFolderPath);
await fs.mkdir(dataFolderPath);
await fs.mkdir(contentFolderPath);
await fs.writeFile(configFile, 'title: Test Book');
await fs.writeFile(tableOfContentsFile, '- title: Notebook\n url: /notebook\n- title: Markdown\n url: /markdown\n- title: GitHub\n url: https://github.com/\n external: true');
await fs.writeFile(notebookFile, '');
await fs.writeFile(markdownFile, '');
mockExtensionContext = TypeMoq.Mock.ofType<vscode.ExtensionContext>();
let folder: vscode.WorkspaceFolder = {
uri: vscode.Uri.file(rootFolderPath),
name: '',
index: 0
};
bookTreeViewProvider = new BookTreeViewProvider([folder], mockExtensionContext.object);
} catch (e) {
assert.ok(false, e);
} }
rootFolderPath = path.join(os.tmpdir(), 'BookTestData_' + testFolder);
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'
};
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, '');
mockExtensionContext = TypeMoq.Mock.ofType<vscode.ExtensionContext>();
let folder: vscode.WorkspaceFolder = {
uri: vscode.Uri.file(rootFolderPath),
name: '',
index: 0
};
bookTreeViewProvider = new BookTreeViewProvider([folder], mockExtensionContext.object);
let tocRead = new Promise((resolve, reject) => bookTreeViewProvider.onReadAllTOCFiles(() => resolve()));
let errorCase = new Promise((resolve, reject) => setTimeout(() => resolve(), 150));
await Promise.race([tocRead, errorCase.then(() => { throw new Error('Table of Contents were not ready in time'); })]);
}); });
it('should return all book nodes when element is undefined', async function (): Promise<void> { it('should return all book nodes when element is undefined', async function (): Promise<void> {
bookTreeViewProvider.onReadAllTOCFiles(async () => { const children = await bookTreeViewProvider.getChildren();
const children = await bookTreeViewProvider.getChildren(); should(children).be.Array();
should(children).be.Array(); should(children.length).equal(1);
should(children.length).equal(1); book = children[0];
book = children[0]; should(book.title).equal(expectedBook.title);
should(book.title).equal(expectedBook.title);
});
}); });
it('should return all page nodes when element is a book', async function (): Promise<void> { it('should return all page nodes when element is a book', async function (): Promise<void> {
bookTreeViewProvider.onReadAllTOCFiles(async () => { const children = await bookTreeViewProvider.getChildren(book);
const children = await bookTreeViewProvider.getChildren(book); should(children).be.Array();
should(children).be.Array(); should(children.length).equal(3);
should(children.length).equal(3); notebook1 = children[0];
const notebook = children[0]; const markdown = children[1];
const markdown = children[1]; const externalLink = children[2];
const externalLink = children[2]; equalBookItems(notebook1, expectedNotebook1);
should(notebook.title).equal(expectedNotebook.title); equalBookItems(markdown, expectedMarkdown);
should(notebook.uri).equal(expectedNotebook.url); equalBookItems(externalLink, expectedExternalLink);
should(markdown.title).equal(expectedMarkdown.title); });
should(markdown.uri).equal(expectedMarkdown.url);
should(externalLink.title).equal(expectedExternalLink.title); it('should return all sections when element is a notebook', async function (): Promise<void> {
should(externalLink.uri).equal(expectedExternalLink.url); 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 () { this.afterAll(async function () {