/** * Copyright 2017 Google Inc. All rights reserved. * Modifications copyright (c) Microsoft Corporation. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ const fs = require('fs'); const readline = require('readline'); const TestRunner = require('../utils/testrunner/'); const {Environment} = require('../utils/testrunner/Test'); function collect(browserNames) { let parallel = 1; if (process.env.PW_PARALLEL_TESTS) parallel = parseInt(process.env.PW_PARALLEL_TESTS.trim(), 10); const parallelArgIndex = process.argv.indexOf('-j'); if (parallelArgIndex !== -1) parallel = parseInt(process.argv[parallelArgIndex + 1], 10); require('events').defaultMaxListeners *= parallel; let timeout = process.env.CI ? 30 * 1000 : 10 * 1000; if (!isNaN(process.env.TIMEOUT)) timeout = parseInt(process.env.TIMEOUT * 1000, 10); const MAJOR_NODEJS_VERSION = parseInt(process.version.substring(1).split('.')[0], 10); if (MAJOR_NODEJS_VERSION >= 8 && require('inspector').url()) { console.log('Detected inspector - disabling timeout to be debugger-friendly'); timeout = 0; } const config = require('./test.config'); const testRunner = new TestRunner({ timeout, totalTimeout: process.env.CI ? 15 * 60 * 1000 : 0, parallel, breakOnFailure: process.argv.indexOf('--break-on-failure') !== -1, verbose: process.argv.includes('--verbose'), summary: !process.argv.includes('--verbose'), showSlowTests: process.env.CI ? 5 : 0, showMarkedAsFailingTests: 10, }); if (config.setupTestRunner) config.setupTestRunner(testRunner); for (const [key, value] of Object.entries(testRunner.api())) global[key] = value; // TODO: this should be a preinstalled playwright by default. const playwrightPath = config.playwrightPath; const playwright = require(playwrightPath); const playwrightEnvironment = new Environment('Playwright'); playwrightEnvironment.beforeAll(async state => { state.playwright = playwright; global.playwright = playwright; }); playwrightEnvironment.afterAll(async state => { delete state.playwright; delete global.playwright; }); testRunner.collector().useEnvironment(playwrightEnvironment); for (const e of config.globalEnvironments || []) testRunner.collector().useEnvironment(e); for (const browserName of browserNames) { const browserType = playwright[browserName]; const browserTypeEnvironment = new Environment('BrowserType'); browserTypeEnvironment.beforeAll(async state => { state.browserType = browserType; }); browserTypeEnvironment.afterAll(async state => { delete state.browserType; }); // TODO: maybe launch options per browser? const launchOptions = { ...(config.launchOptions || {}), handleSIGINT: false, }; if (launchOptions.executablePath) launchOptions.executablePath = launchOptions.executablePath[browserName]; if (launchOptions.executablePath) { const YELLOW_COLOR = '\x1b[33m'; const RESET_COLOR = '\x1b[0m'; console.warn(`${YELLOW_COLOR}WARN: running ${browserName} tests with ${launchOptions.executablePath}${RESET_COLOR}`); browserType._executablePath = launchOptions.executablePath; delete launchOptions.executablePath; } else { if (!fs.existsSync(browserType.executablePath())) throw new Error(`Browser is not downloaded. Run 'npm install' and try to re-run tests`); } const browserEnvironment = new Environment(browserName); browserEnvironment.beforeAll(async state => { state.browser = await state.browserType.launch(launchOptions); state._stdout = readline.createInterface({ input: state.browser._ownedServer.process().stdout }); state._stderr = readline.createInterface({ input: state.browser._ownedServer.process().stderr }); }); browserEnvironment.afterAll(async state => { await state.browser.close(); delete state.browser; state._stdout.close(); state._stderr.close(); delete state._stdout; delete state._stderr; }); browserEnvironment.beforeEach(async(state, testRun) => { const dumpout = data => testRun.log(`\x1b[33m[pw:stdio:out]\x1b[0m ${data}`); const dumperr = data => testRun.log(`\x1b[31m[pw:stdio:err]\x1b[0m ${data}`); state._stdout.on('line', dumpout); state._stderr.on('line', dumperr); // TODO: figure out debug options. if (config.dumpProtocolOnFailure) { state.browser._debugProtocol.log = data => testRun.log(`\x1b[32m[pw:protocol]\x1b[0m ${data}`); state.browser._debugProtocol.enabled = true; } state._browserTearDown = async (testRun) => { state._stdout.off('line', dumpout); state._stderr.off('line', dumperr); if (config.dumpProtocolOnFailure) { delete state.browser._debugProtocol.log; state.browser._debugProtocol.enabled = false; if (testRun.ok()) testRun.output().splice(0); } }; }); browserEnvironment.afterEach(async (state, testRun) => { await state._browserTearDown(testRun); delete state._browserTearDown; }); const pageEnvironment = new Environment('Page'); pageEnvironment.beforeEach(async state => { state.context = await state.browser.newContext(); state.page = await state.context.newPage(); }); pageEnvironment.afterEach(async state => { await state.context.close(); state.context = null; state.page = null; }); const suiteName = { 'chromium': 'Chromium', 'firefox': 'Firefox', 'webkit': 'WebKit' }[browserName]; describe(suiteName, () => { // In addition to state, expose these two on global so that describes can access them. global.playwright = playwright; global.browserType = browserType; testRunner.collector().useEnvironment(browserTypeEnvironment); for (const spec of config.specs || []) { const skip = spec.browsers && !spec.browsers.includes(browserName); (skip ? xdescribe : describe)(spec.title || '', () => { for (const e of spec.environments || ['page']) { if (e === 'browser') { testRunner.collector().useEnvironment(browserEnvironment); } else if (e === 'page') { testRunner.collector().useEnvironment(browserEnvironment); testRunner.collector().useEnvironment(pageEnvironment); } else { testRunner.collector().useEnvironment(e); } } for (const file of spec.files || []) { require(file); delete require.cache[require.resolve(file)]; } }); } delete global.browserType; delete global.playwright; }); } for (const [key, value] of Object.entries(testRunner.api())) { // expect is used when running tests, while the rest of api is not. if (key !== 'expect') delete global[key]; } const filterArgIndex = process.argv.indexOf('--filter'); if (filterArgIndex !== -1) { const filter = process.argv[filterArgIndex + 1]; testRunner.focusMatchingTests(new RegExp(filter, 'i')); } return testRunner; } module.exports = collect; if (require.main === module) { console.log('Testing on Node', process.version); const browserNames = ['chromium', 'firefox', 'webkit'].filter(name => { return process.env.BROWSER === name || process.env.BROWSER === 'all'; }); const testRunner = collect(browserNames); testRunner.run().then(() => { delete global.expect; }); }