playwright/test/fixtures.spec.js

/**
 * 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');

/**
 * @type {TestSuite}
 */
module.exports.describe = function({testRunner, expect, product, playwright, playwrightPath, defaultBrowserOptions, WIN, FFOX, CHROMIUM, WEBKIT}) {
  const {describe, xdescribe, fdescribe} = testRunner;
  const {it, fit, xit, dit} = testRunner;
  const {beforeAll, beforeEach, afterAll, afterEach} = testRunner;

  async function testSignal(action) {
    const options = Object.assign({}, defaultBrowserOptions, {
      // Disable DUMPIO to cleanly read stdout.
      dumpio: false,
      handleSIGINT: true,
      handleSIGTERM: true,
      handleSIGHUP: true,
    });
    const res = spawn('node', [path.join(__dirname, 'fixtures', 'closeme.js'), playwrightPath, product, JSON.stringify(options)]);
    let wsEndPointCallback;
    const wsEndPointPromise = new Promise(x => wsEndPointCallback = x);
    let output = '';
    let browserExitCode = 'none';
    let browserSignal = 'none';
    let browserPid;
    res.stdout.on('data', data => {
      output += data;
      // Uncomment to debug these tests.
      // console.log(data.toString());
      let match = output.match(/browserWS:(.+):browserWS/);
      if (match)
        wsEndPointCallback(match[1]);
      match = output.match(/browserClose:([^:]+):([^:]+):browserClose/);
      if (match) {
        browserExitCode = match[1];
        browserSignal = match[2];
      }
      match = output.match(/browserPid:([^:]+):browserPid/);
      if (match)
        browserPid = +match[1];
    });
    res.on('error', (...args) => console.log("ERROR", ...args));
    const browser = await playwright.connect({ wsEndpoint: await wsEndPointPromise });
    const promises = [
      new Promise(resolve => browser.once('disconnected', resolve)),
      new Promise(resolve => res.on('exit', resolve)),
    ];
    action(res, browserPid);
    const [, exitCode] = await Promise.all(promises);
    return { exitCode, browserSignal, browserExitCode, output };
  }

  describe('Fixtures', function() {
    it('should dump browser process stderr', async({server}) => {
      let dumpioData = '';
      const res = spawn('node', [path.join(__dirname, 'fixtures', 'dumpio.js'), playwrightPath, product, 'usewebsocket']);
      res.stderr.on('data', data => dumpioData += data.toString('utf8'));
      await new Promise(resolve => res.on('close', resolve));
      expect(dumpioData).toContain('message from dumpio');
    });
    it('should dump browser process stderr', async({server}) => {
      let dumpioData = '';
      const res = spawn('node', [path.join(__dirname, 'fixtures', 'dumpio.js'), playwrightPath, product]);
      res.stderr.on('data', data => dumpioData += data.toString('utf8'));
      await new Promise(resolve => res.on('close', resolve));
      expect(dumpioData).toContain('message from dumpio');
    });
    it('should close the browser when the node process closes', async () => {
      const result = await testSignal(child => {
        if (WIN)
          execSync(`taskkill /pid ${child.pid} /T /F`);
        else
          process.kill(child.pid);
      });
      expect(result.exitCode).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.
    });
    if (!WIN) {
      // Cannot reliably send signals on Windows.
      it('should report browser close signal', async () => {
        const result = await testSignal((child, browserPid) => {
          process.kill(browserPid);
          process.kill(child.pid, 'SIGINT');
        });
        expect(result.exitCode).toBe(130);
        expect(result.browserExitCode).toBe('null');
        expect(result.browserSignal).toBe('SIGTERM');
      });
      it('should report browser close signal 2', async () => {
        const result = await testSignal((child, browserPid) => {
          process.kill(browserPid, 'SIGKILL');
          process.kill(child.pid, 'SIGINT');
        });
        expect(result.exitCode).toBe(130);
        expect(result.browserExitCode).toBe('null');
        expect(result.browserSignal).toBe('SIGKILL');
      });
      it('should close the browser on SIGINT', async () => {
        const result = await testSignal(child => process.kill(child.pid, 'SIGINT'));
        expect(result.exitCode).toBe(130);
        expect(result.browserExitCode).toBe('0');
        expect(result.browserSignal).toBe('null');
      });
      it('should close the browser on SIGTERM', async () => {
        const result = await testSignal(child => process.kill(child.pid, 'SIGTERM'));
        expect(result.exitCode).toBe(0);
        expect(result.browserExitCode).toBe('0');
        expect(result.browserSignal).toBe('null');
      });
      it('should close the browser on SIGHUP', async () => {
        const result = await testSignal(child => process.kill(child.pid, 'SIGHUP'));
        expect(result.exitCode).toBe(0);
        expect(result.browserExitCode).toBe('0');
        expect(result.browserSignal).toBe('null');
      });
      it('should kill the browser on double SIGINT', async () => {
        const result = await testSignal(child => {
          process.kill(child.pid, 'SIGINT');
          process.kill(child.pid, 'SIGINT');
        });
        expect(result.exitCode).toBe(130);
        // TODO: ideally, we would expect the SIGKILL on the browser from
        // force kill, but that's racy with sending two signals.
      });
      it('should kill the browser on SIGINT + SIGTERM', async () => {
        const result = await testSignal(child => {
          process.kill(child.pid, 'SIGINT');
          process.kill(child.pid, 'SIGTERM');
        });
        expect(result.exitCode).toBe(130);
        // TODO: ideally, we would expect the SIGKILL on the browser from
        // force kill, but that's racy with sending two signals.
      });
      it('should kill the browser on SIGTERM + SIGINT', async () => {
        const result = await testSignal(child => {
          process.kill(child.pid, 'SIGTERM');
          process.kill(child.pid, 'SIGINT');
        });
        expect(result.exitCode).toBe(130);
        // TODO: ideally, we would expect the SIGKILL on the browser from
        // force kill, but that's racy with sending two signals.
      });
    }
  });
};