-
Notifications
You must be signed in to change notification settings - Fork 2.5k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
fix #7028: API to create integration test pages
It enabled clients to control how the application is started and do any additional authentication if it is required. Signed-off-by: Anton Kosyakov <anton.kosyakov@typefox.io>
- Loading branch information
Showing
2 changed files
with
168 additions
and
109 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,137 @@ | ||
| /******************************************************************************** | ||
| * 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 WITH Classpath-exception-2.0 | ||
| ********************************************************************************/ | ||
|
|
||
| /* eslint-disable @typescript-eslint/no-explicit-any */ | ||
|
|
||
| import * as puppeteer from 'puppeteer'; | ||
| 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 | ||
| 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', | ||
| useColors: true | ||
| } as MochaSetupOptions); | ||
| }); | ||
|
|
||
| if (onWillRun) { | ||
| await onWillRun(); | ||
| } | ||
|
|
||
| const files = collectFiles(fileOptions); | ||
| 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; | ||
| } |