@theia/cli 1.53.0-next.5 → 1.53.0-next.55

package/src/run-test.ts

@@ -1,87 +1,87 @@
-// *****************************************************************************
-// Copyright (C) 2020 TypeFox and others.
-//
-// This program and the accompanying materials are made available under the
-// terms of the Eclipse Public License v. 2.0 which is available at
-// http://www.eclipse.org/legal/epl-2.0.
-//
-// This Source Code may also be made available under the following Secondary
-// Licenses when the conditions for such availability set forth in the Eclipse
-// Public License v. 2.0 are satisfied: GNU General Public License, version 2
-// with the GNU Classpath Exception which is available at
-// https://www.gnu.org/software/classpath/license.html.
-//
-// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
-// *****************************************************************************
-
-/* eslint-disable @typescript-eslint/no-explicit-any */
-
-import * as net from 'net';
-import * as puppeteer from 'puppeteer-core';
-import newTestPage, { TestFileOptions } from './test-page';
-
-export interface TestOptions {
-    start: () => Promise<net.AddressInfo>
-    launch?: puppeteer.PuppeteerLaunchOptions
-    files?: Partial<TestFileOptions>
-    coverage?: boolean
-}
-
-export default async function runTest(options: TestOptions): Promise<void> {
-    const { start, launch } = options;
-    const exit = !(launch && launch.devtools);
-
-    const testPage = await newTestPage({
-        files: options.files,
-        matchAppUrl: () => true, // all urls are application urls
-        newPage: async () => {
-            const browser = await puppeteer.launch(launch);
-            // re-use empty tab
-            const [tab] = await browser.pages();
-            return tab;
-        },
-        onWillRun: async () => {
-            const promises = [];
-            if (options.coverage) {
-                promises.push(testPage.coverage.startJSCoverage());
-                promises.push(testPage.coverage.startCSSCoverage());
-            }
-            // When launching in non-headless mode (with a UI and dev-tools open), make sure
-            // the app has focus, to avoid failures of tests that query the UI's state.
-            if (launch && launch.devtools) {
-                promises.push(testPage.waitForSelector('#theia-app-shell.p-Widget.theia-ApplicationShell')
-                    .then(e => {
-                        // eslint-disable-next-line no-null/no-null
-                        if (e !== null) {
-                            e.click();
-                        }
-                    }));
-            }
-
-            // Clear application's local storage to avoid reusing previous state
-            promises.push(testPage.evaluate(() => localStorage.clear()));
-            await Promise.all(promises);
-        },
-        onDidRun: async failures => {
-            if (options.coverage) {
-                console.log('collecting test coverage...');
-                const [jsCoverage, cssCoverage] = await Promise.all([
-                    testPage.coverage.stopJSCoverage(),
-                    testPage.coverage.stopCSSCoverage(),
-                ]);
-                require('puppeteer-to-istanbul').write([...jsCoverage, ...cssCoverage]);
-            }
-            if (exit) {
-                // allow a bit of time to finish printing-out test results
-                await new Promise(resolve => setTimeout(resolve, 1000));
-                await testPage.close();
-                process.exit(failures > 0 ? 1 : 0);
-            }
-        }
-    });
-    const { address, port } = await start();
-    const url = net.isIPv6(address)
-        ? `http://[${address}]:${port}`
-        : `http://${address}:${port}`;
-    await testPage.goto(url);
-}
+// *****************************************************************************
+// Copyright (C) 2020 TypeFox and others.
+//
+// This program and the accompanying materials are made available under the
+// terms of the Eclipse Public License v. 2.0 which is available at
+// http://www.eclipse.org/legal/epl-2.0.
+//
+// This Source Code may also be made available under the following Secondary
+// Licenses when the conditions for such availability set forth in the Eclipse
+// Public License v. 2.0 are satisfied: GNU General Public License, version 2
+// with the GNU Classpath Exception which is available at
+// https://www.gnu.org/software/classpath/license.html.
+//
+// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
+// *****************************************************************************
+
+/* eslint-disable @typescript-eslint/no-explicit-any */
+
+import * as net from 'net';
+import * as puppeteer from 'puppeteer-core';
+import newTestPage, { TestFileOptions } from './test-page';
+
+export interface TestOptions {
+    start: () => Promise<net.AddressInfo>
+    launch?: puppeteer.PuppeteerLaunchOptions
+    files?: Partial<TestFileOptions>
+    coverage?: boolean
+}
+
+export default async function runTest(options: TestOptions): Promise<void> {
+    const { start, launch } = options;
+    const exit = !(launch && launch.devtools);
+
+    const testPage = await newTestPage({
+        files: options.files,
+        matchAppUrl: () => true, // all urls are application urls
+        newPage: async () => {
+            const browser = await puppeteer.launch(launch);
+            // re-use empty tab
+            const [tab] = await browser.pages();
+            return tab;
+        },
+        onWillRun: async () => {
+            const promises = [];
+            if (options.coverage) {
+                promises.push(testPage.coverage.startJSCoverage());
+                promises.push(testPage.coverage.startCSSCoverage());
+            }
+            // When launching in non-headless mode (with a UI and dev-tools open), make sure
+            // the app has focus, to avoid failures of tests that query the UI's state.
+            if (launch && launch.devtools) {
+                promises.push(testPage.waitForSelector('#theia-app-shell.p-Widget.theia-ApplicationShell')
+                    .then(e => {
+                        // eslint-disable-next-line no-null/no-null
+                        if (e !== null) {
+                            e.click();
+                        }
+                    }));
+            }
+
+            // Clear application's local storage to avoid reusing previous state
+            promises.push(testPage.evaluate(() => localStorage.clear()));
+            await Promise.all(promises);
+        },
+        onDidRun: async failures => {
+            if (options.coverage) {
+                console.log('collecting test coverage...');
+                const [jsCoverage, cssCoverage] = await Promise.all([
+                    testPage.coverage.stopJSCoverage(),
+                    testPage.coverage.stopCSSCoverage(),
+                ]);
+                require('puppeteer-to-istanbul').write([...jsCoverage, ...cssCoverage]);
+            }
+            if (exit) {
+                // allow a bit of time to finish printing-out test results
+                await new Promise(resolve => setTimeout(resolve, 1000));
+                await testPage.close();
+                process.exit(failures > 0 ? 1 : 0);
+            }
+        }
+    });
+    const { address, port } = await start();
+    const url = net.isIPv6(address)
+        ? `http://[${address}]:${port}`
+        : `http://${address}:${port}`;
+    await testPage.goto(url);
+}

package/src/test-page.ts

@@ -1,138 +1,138 @@
-// *****************************************************************************
-// Copyright (C) 2020 TypeFox and others.
-//
-// This program and the accompanying materials are made available under the
-// terms of the Eclipse Public License v. 2.0 which is available at
-// http://www.eclipse.org/legal/epl-2.0.
-//
-// This Source Code may also be made available under the following Secondary
-// Licenses when the conditions for such availability set forth in the Eclipse
-// Public License v. 2.0 are satisfied: GNU General Public License, version 2
-// with the GNU Classpath Exception which is available at
-// https://www.gnu.org/software/classpath/license.html.
-//
-// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
-// *****************************************************************************
-
-/* eslint-disable @typescript-eslint/no-explicit-any */
-
-import * as puppeteer from 'puppeteer-core';
-const collectFiles: (options: TestFileOptions) => string[] = require('mocha/lib/cli/collect-files');
-
-export interface TestFileOptions {
-    ignore: string[]
-    extension: string[]
-    file: string[]
-    recursive: boolean
-    sort: boolean
-    spec: string[]
-}
-
-export interface TestPageOptions {
-    files?: Partial<TestFileOptions>
-    newPage: () => Promise<puppeteer.Page>
-    matchAppUrl?: (url: string) => boolean
-    onWillRun?: () => Promise<void>
-    onDidRun?: (failures: number) => Promise<void>
-}
-
-export default async function newTestPage(options: TestPageOptions): Promise<puppeteer.Page> {
-    const { newPage, matchAppUrl, onWillRun, onDidRun } = options;
-
-    const fileOptions: TestFileOptions = {
-        ignore: options.files && options.files.ignore || [],
-        extension: options.files && options.files.extension || [],
-        file: options.files && options.files.file || [],
-        spec: options.files && options.files.spec || [],
-        recursive: options.files && options.files.recursive || false,
-        sort: options.files && options.files.sort || false
-    };
-
-    // quick check whether test files exist
-    const files = collectFiles(fileOptions);
-
-    const page = await newPage();
-    page.on('dialog', dialog => dialog.dismiss());
-    page.on('pageerror', console.error);
-
-    let theiaLoaded = false;
-    page.exposeFunction('fireDidUnloadTheia', () => theiaLoaded = false);
-    const preLoad = (frame: puppeteer.Frame) => {
-        const frameUrl = frame.url();
-        if (matchAppUrl && !matchAppUrl(frameUrl)) {
-            return;
-        }
-        if (theiaLoaded) {
-            return;
-        }
-        console.log('loading chai...');
-        theiaLoaded = true;
-        page.addScriptTag({ path: require.resolve('chai/chai.js') });
-        page.evaluate(() =>
-            window.addEventListener('beforeunload', () => (window as any)['fireDidUnloadTheia']())
-        );
-    };
-    page.on('frameattached', preLoad);
-    page.on('framenavigated', preLoad);
-
-    page.on('load', async () => {
-        if (matchAppUrl && !matchAppUrl(page.url())) {
-            return;
-        }
-        console.log('loading mocha...');
-        // replace console.log by theia logger for mocha
-        await page.waitForFunction(() => !!(window as any)['theia']?.['@theia/core/lib/common/logger']?.logger, {
-            timeout: 30 * 1000
-        });
-        await page.addScriptTag({ path: require.resolve('mocha/mocha.js') });
-        await page.waitForFunction(() => !!(window as any)['chai'] && !!(window as any)['mocha'] && !!(window as any)['theia'].container, { timeout: 30 * 1000 });
-
-        console.log('loading Theia...');
-        await page.evaluate(() => {
-            const { FrontendApplicationStateService } = (window as any)['theia']['@theia/core/lib/browser/frontend-application-state'];
-            const { PreferenceService } = (window as any)['theia']['@theia/core/lib/browser/preferences/preference-service'];
-            const { WorkspaceService } = (window as any)['theia']['@theia/workspace/lib/browser/workspace-service'];
-
-            const container = (window as any)['theia'].container;
-            const frontendApplicationState = container.get(FrontendApplicationStateService);
-            const preferenceService = container.get(PreferenceService);
-            const workspaceService = container.get(WorkspaceService);
-
-            return Promise.all([
-                frontendApplicationState.reachedState('ready'),
-                preferenceService.ready,
-                workspaceService.roots
-            ]);
-        });
-
-        console.log('loading test files...');
-        await page.evaluate(() => {
-            // replace require to load modules from theia namespace
-            (window as any)['require'] = (moduleName: string) => (window as any)['theia'][moduleName];
-            mocha.setup({
-                reporter: 'spec',
-                ui: 'bdd',
-                color: true,
-                retries: 0,
-                timeout: 10000
-            });
-        });
-
-        if (onWillRun) {
-            await onWillRun();
-        }
-
-        for (const file of files) {
-            await page.addScriptTag({ path: file });
-        }
-
-        console.log('running test files...');
-        const failures = await page.evaluate(() =>
-            new Promise<number>(resolve => mocha.run(resolve))
-        );
-        if (onDidRun) {
-            await onDidRun(failures);
-        }
-    });
-    return page;
-}
+// *****************************************************************************
+// Copyright (C) 2020 TypeFox and others.
+//
+// This program and the accompanying materials are made available under the
+// terms of the Eclipse Public License v. 2.0 which is available at
+// http://www.eclipse.org/legal/epl-2.0.
+//
+// This Source Code may also be made available under the following Secondary
+// Licenses when the conditions for such availability set forth in the Eclipse
+// Public License v. 2.0 are satisfied: GNU General Public License, version 2
+// with the GNU Classpath Exception which is available at
+// https://www.gnu.org/software/classpath/license.html.
+//
+// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
+// *****************************************************************************
+
+/* eslint-disable @typescript-eslint/no-explicit-any */
+
+import * as puppeteer from 'puppeteer-core';
+const collectFiles: (options: TestFileOptions) => string[] = require('mocha/lib/cli/collect-files');
+
+export interface TestFileOptions {
+    ignore: string[]
+    extension: string[]
+    file: string[]
+    recursive: boolean
+    sort: boolean
+    spec: string[]
+}
+
+export interface TestPageOptions {
+    files?: Partial<TestFileOptions>
+    newPage: () => Promise<puppeteer.Page>
+    matchAppUrl?: (url: string) => boolean
+    onWillRun?: () => Promise<void>
+    onDidRun?: (failures: number) => Promise<void>
+}
+
+export default async function newTestPage(options: TestPageOptions): Promise<puppeteer.Page> {
+    const { newPage, matchAppUrl, onWillRun, onDidRun } = options;
+
+    const fileOptions: TestFileOptions = {
+        ignore: options.files && options.files.ignore || [],
+        extension: options.files && options.files.extension || [],
+        file: options.files && options.files.file || [],
+        spec: options.files && options.files.spec || [],
+        recursive: options.files && options.files.recursive || false,
+        sort: options.files && options.files.sort || false
+    };
+
+    // quick check whether test files exist
+    const files = collectFiles(fileOptions);
+
+    const page = await newPage();
+    page.on('dialog', dialog => dialog.dismiss());
+    page.on('pageerror', console.error);
+
+    let theiaLoaded = false;
+    page.exposeFunction('fireDidUnloadTheia', () => theiaLoaded = false);
+    const preLoad = (frame: puppeteer.Frame) => {
+        const frameUrl = frame.url();
+        if (matchAppUrl && !matchAppUrl(frameUrl)) {
+            return;
+        }
+        if (theiaLoaded) {
+            return;
+        }
+        console.log('loading chai...');
+        theiaLoaded = true;
+        page.addScriptTag({ path: require.resolve('chai/chai.js') });
+        page.evaluate(() =>
+            window.addEventListener('beforeunload', () => (window as any)['fireDidUnloadTheia']())
+        );
+    };
+    page.on('frameattached', preLoad);
+    page.on('framenavigated', preLoad);
+
+    page.on('load', async () => {
+        if (matchAppUrl && !matchAppUrl(page.url())) {
+            return;
+        }
+        console.log('loading mocha...');
+        // replace console.log by theia logger for mocha
+        await page.waitForFunction(() => !!(window as any)['theia']?.['@theia/core/lib/common/logger']?.logger, {
+            timeout: 30 * 1000
+        });
+        await page.addScriptTag({ path: require.resolve('mocha/mocha.js') });
+        await page.waitForFunction(() => !!(window as any)['chai'] && !!(window as any)['mocha'] && !!(window as any)['theia'].container, { timeout: 30 * 1000 });
+
+        console.log('loading Theia...');
+        await page.evaluate(() => {
+            const { FrontendApplicationStateService } = (window as any)['theia']['@theia/core/lib/browser/frontend-application-state'];
+            const { PreferenceService } = (window as any)['theia']['@theia/core/lib/browser/preferences/preference-service'];
+            const { WorkspaceService } = (window as any)['theia']['@theia/workspace/lib/browser/workspace-service'];
+
+            const container = (window as any)['theia'].container;
+            const frontendApplicationState = container.get(FrontendApplicationStateService);
+            const preferenceService = container.get(PreferenceService);
+            const workspaceService = container.get(WorkspaceService);
+
+            return Promise.all([
+                frontendApplicationState.reachedState('ready'),
+                preferenceService.ready,
+                workspaceService.roots
+            ]);
+        });
+
+        console.log('loading test files...');
+        await page.evaluate(() => {
+            // replace require to load modules from theia namespace
+            (window as any)['require'] = (moduleName: string) => (window as any)['theia'][moduleName];
+            mocha.setup({
+                reporter: 'spec',
+                ui: 'bdd',
+                color: true,
+                retries: 0,
+                timeout: 10000
+            });
+        });
+
+        if (onWillRun) {
+            await onWillRun();
+        }
+
+        for (const file of files) {
+            await page.addScriptTag({ path: file });
+        }
+
+        console.log('running test files...');
+        const failures = await page.evaluate(() =>
+            new Promise<number>(resolve => mocha.run(resolve))
+        );
+        if (onDidRun) {
+            await onDidRun(failures);
+        }
+    });
+    return page;
+}