playwright/test/fixtures.spec.js

197 lines
7.4 KiB
JavaScript

/**
* Copyright 2019 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 path = require('path');
const {spawn, execSync} = require('child_process');
const {FFOX, CHROMIUM, WEBKIT, WIN, LINUX} = require('./utils').testOptions(browserType);
class Wrapper {
constructor(state, extraOptions) {
this._output = new Map();
this._outputCallback = new Map();
this._browserType = state.browserType;
const launchOptions = {...state.defaultBrowserOptions,
handleSIGINT: true,
handleSIGTERM: true,
handleSIGHUP: true,
executablePath: state.browserType.executablePath(),
logger: undefined,
};
const options = {
playwrightFile: path.join(state.playwrightPath, 'index'),
browserTypeName: state.browserType.name(),
launchOptions,
...extraOptions,
};
this._child = spawn('node', [path.join(__dirname, 'fixtures', 'closeme.js'), JSON.stringify(options)]);
this._child.on('error', (...args) => console.log("ERROR", ...args));
this._exitPromise = new Promise(resolve => this._child.on('exit', resolve));
let outputString = '';
this._child.stdout.on('data', data => {
outputString += data.toString();
// Uncomment to debug.
// console.log(data.toString());
let match;
while (match = outputString.match(/\(([^()]+)=>([^()]+)\)/)) {
const key = match[1];
const value = match[2];
this._addOutput(key, value);
outputString = outputString.substring(match.index + match[0].length);
}
});
}
_addOutput(key, value) {
this._output.set(key, value);
const cb = this._outputCallback.get(key);
this._outputCallback.delete(key);
if (cb)
cb();
}
async out(key) {
if (!this._output.has(key))
await new Promise(f => this._outputCallback.set(key, f));
return this._output.get(key);
}
async connect() {
const wsEndpoint = await this.out('wsEndpoint');
const browser = await this._browserType.connect({ wsEndpoint });
this._exitAndDisconnectPromise = Promise.all([
this._exitPromise,
new Promise(resolve => browser.once('disconnected', resolve)),
]).then(([exitCode]) => exitCode);
}
child() {
return this._child;
}
async childExitCode() {
return await this._exitAndDisconnectPromise;
}
}
async function setup(state, options = {}) {
const wrapper = new Wrapper(state, options);
await wrapper.connect();
return wrapper;
}
describe('Fixtures', function() {
it.slow()('should close the browser when the node process closes', async state => {
const wrapper = await setup(state);
if (WIN)
execSync(`taskkill /pid ${wrapper.child().pid} /T /F`);
else
process.kill(wrapper.child().pid);
expect(await wrapper.childExitCode()).toBe(WIN ? 1 : 0);
// We might not get browser exitCode in time when killing the parent node process,
// so we don't check it here.
});
describe.skip(WIN).skip(!HEADLESS)('signals', () => {
// Cannot reliably send signals on Windows.
it.slow()('should report browser close signal', async state => {
const wrapper = await setup(state);
const pid = await wrapper.out('pid');
process.kill(-pid, 'SIGTERM');
expect(await wrapper.out('exitCode')).toBe('null');
expect(await wrapper.out('signal')).toBe('SIGTERM');
process.kill(wrapper.child().pid);
await wrapper.childExitCode();
});
it.slow()('should report browser close signal 2', async state => {
const wrapper = await setup(state);
const pid = await wrapper.out('pid');
process.kill(-pid, 'SIGKILL');
expect(await wrapper.out('exitCode')).toBe('null');
expect(await wrapper.out('signal')).toBe('SIGKILL');
process.kill(wrapper.child().pid);
await wrapper.childExitCode();
});
it.slow()('should close the browser on SIGINT', async state => {
const wrapper = await setup(state);
process.kill(wrapper.child().pid, 'SIGINT');
expect(await wrapper.out('exitCode')).toBe('0');
expect(await wrapper.out('signal')).toBe('null');
expect(await wrapper.childExitCode()).toBe(130);
});
it.slow()('should close the browser on SIGTERM', async state => {
const wrapper = await setup(state);
process.kill(wrapper.child().pid, 'SIGTERM');
expect(await wrapper.out('exitCode')).toBe('0');
expect(await wrapper.out('signal')).toBe('null');
expect(await wrapper.childExitCode()).toBe(0);
});
it.slow()('should close the browser on SIGHUP', async state => {
const wrapper = await setup(state);
process.kill(wrapper.child().pid, 'SIGHUP');
expect(await wrapper.out('exitCode')).toBe('0');
expect(await wrapper.out('signal')).toBe('null');
expect(await wrapper.childExitCode()).toBe(0);
});
it.slow()('should kill the browser on double SIGINT', async state => {
const wrapper = await setup(state, { stallOnClose: true });
process.kill(wrapper.child().pid, 'SIGINT');
await wrapper.out('stalled');
process.kill(wrapper.child().pid, 'SIGINT');
expect(await wrapper.out('exitCode')).toBe('null');
expect(await wrapper.out('signal')).toBe('SIGKILL');
expect(await wrapper.childExitCode()).toBe(130);
});
it.slow()('should kill the browser on SIGINT + SIGTERM', async state => {
const wrapper = await setup(state, { stallOnClose: true });
process.kill(wrapper.child().pid, 'SIGINT');
await wrapper.out('stalled');
process.kill(wrapper.child().pid, 'SIGTERM');
expect(await wrapper.out('exitCode')).toBe('null');
expect(await wrapper.out('signal')).toBe('SIGKILL');
expect(await wrapper.childExitCode()).toBe(0);
});
it.slow()('should kill the browser on SIGTERM + SIGINT', async state => {
const wrapper = await setup(state, { stallOnClose: true });
process.kill(wrapper.child().pid, 'SIGTERM');
await wrapper.out('stalled');
process.kill(wrapper.child().pid, 'SIGINT');
expect(await wrapper.out('exitCode')).toBe('null');
expect(await wrapper.out('signal')).toBe('SIGKILL');
expect(await wrapper.childExitCode()).toBe(130);
});
});
});
describe('StackTrace', () => {
it('caller file path', async state => {
const stackTrace = require(path.join(state.playwrightPath, 'lib', 'utils', 'stackTrace'));
const callme = require('./fixtures/callback');
const filePath = callme(() => {
return stackTrace.getCallerFilePath(path.join(__dirname, 'fixtures') + path.sep);
});
expect(filePath).toBe(__filename);
});
it('api call', async state => {
const stackTrace = require(path.join(state.playwrightPath, 'lib', 'utils', 'stackTrace'));
const callme = require('./fixtures/callback');
const apiCall = callme(stackTrace.getCurrentApiCall.bind(stackTrace, path.join(__dirname, 'fixtures') + path.sep));
expect(apiCall).toBe('callme');
});
});