playwright/test/playwright.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 fs = require('fs');
const path = require('path');
const rm = require('rimraf').sync;
const readline = require('readline');
const {TestServer} = require('../utils/testserver/');
const {Environment} = require('../utils/testrunner/Test');

const serverEnvironment = new Environment('TestServer');
serverEnvironment.beforeAll(async state => {
  const assetsPath = path.join(__dirname, 'assets');
  const cachedPath = path.join(__dirname, 'assets', 'cached');

  const port = 8907 + state.parallelIndex * 3;
  state.server = await TestServer.create(assetsPath, port);
  state.server.enableHTTPCache(cachedPath);
  state.server.PORT = port;
  state.server.PREFIX = `http://localhost:${port}`;
  state.server.CROSS_PROCESS_PREFIX = `http://127.0.0.1:${port}`;
  state.server.EMPTY_PAGE = `http://localhost:${port}/empty.html`;

  const httpsPort = port + 1;
  state.httpsServer = await TestServer.createHTTPS(assetsPath, httpsPort);
  state.httpsServer.enableHTTPCache(cachedPath);
  state.httpsServer.PORT = httpsPort;
  state.httpsServer.PREFIX = `https://localhost:${httpsPort}`;
  state.httpsServer.CROSS_PROCESS_PREFIX = `https://127.0.0.1:${httpsPort}`;
  state.httpsServer.EMPTY_PAGE = `https://localhost:${httpsPort}/empty.html`;

  const sourcePort = port + 2;
  state.sourceServer = await TestServer.create(path.join(__dirname, '..'), sourcePort);
  state.sourceServer.PORT = sourcePort;
  state.sourceServer.PREFIX = `http://localhost:${sourcePort}`;
});
serverEnvironment.afterAll(async({server, sourceServer, httpsServer}) => {
  await Promise.all([
    server.stop(),
    httpsServer.stop(),
    sourceServer.stop(),
  ]);
});
serverEnvironment.beforeEach(async({server, httpsServer}) => {
  server.reset();
  httpsServer.reset();
});

const goldenEnvironment = new Environment('Golden');
goldenEnvironment.beforeAll(async ({browserType}) => {
  const { OUTPUT_DIR, GOLDEN_DIR } = require('./utils').testOptions(browserType);
  if (fs.existsSync(OUTPUT_DIR))
    rm(OUTPUT_DIR);
  fs.mkdirSync(OUTPUT_DIR, { recursive: true });
  expect.setupGolden(GOLDEN_DIR, OUTPUT_DIR);
});

/**
 * @type {TestSuite}
 */
module.exports.addPlaywrightTests = ({testRunner, products}) => {
  const dumpProtocolOnFailure = valueFromEnv('DEBUGP', false);
  const playwrightPath = require('./utils').projectRoot();
  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(serverEnvironment);  // Custom global environment.
  testRunner.collector().useEnvironment(playwrightEnvironment);

  for (const product of products) {
    const browserTypeEnvironment = new Environment('BrowserType');
    browserTypeEnvironment.beforeAll(async state => {
      state.browserType = state.playwright[product.toLowerCase()];
    });
    browserTypeEnvironment.afterAll(async state => {
      delete state.browserType;
    });

    const browserEnvironment = new Environment(product);
    browserEnvironment.beforeAll(async state => {
      const { defaultBrowserOptions } = require('./utils').testOptions(state.browserType);
      state.browser = await state.browserType.launch(defaultBrowserOptions);
      state.browserServer = state.browser._ownedServer;
      state._stdout = readline.createInterface({ input: state.browserServer.process().stdout });
      state._stderr = readline.createInterface({ input: state.browserServer.process().stderr });
    });
    browserEnvironment.afterAll(async state => {
      await state.browserServer.close();
      state.browser = null;
      state.browserServer = null;
      state._stdout.close();
      state._stderr.close();
    });
    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);
      if (dumpProtocolOnFailure)
        state.browser._debugProtocol.log = data => testRun.log(`\x1b[32m[pw:protocol]\x1b[0m ${data}`);
      state.tearDown = async () => {
        state._stdout.off('line', dumpout);
        state._stderr.off('line', dumperr);
        if (dumpProtocolOnFailure)
          delete state.browser._debugProtocol.log;
      };
    });
    browserEnvironment.afterEach(async (state, test) => {
      if (state.browser.contexts().length !== 0) {
        if (test.result === 'ok')
          console.warn(`\nWARNING: test "${test.fullName()}" (${test.location()}) did not close all created contexts!\n`);
        await Promise.all(state.browser.contexts().map(context => context.close()));
      }
      await state.tearDown();
    });

    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;
    });

    function loadTest(path) {
      require(path);
      delete require.cache[require.resolve(path)];
    }

    describe(product, () => {
      // In addition to state, expose these two on global so that describes can access them.
      global.playwright = playwright;
      global.browserType = playwright[product.toLowerCase()];

      testRunner.collector().useEnvironment(browserTypeEnvironment);
      testRunner.collector().useEnvironment(goldenEnvironment);  // Custom environment.

      describe('', function() {
        testRunner.collector().useEnvironment(browserEnvironment);

        describe('', function() {
          testRunner.collector().useEnvironment(pageEnvironment);

          // Page-level tests that are given a browser, a context and a page.
          // Each test is launched in a new browser context.
          loadTest('./accessibility.spec.js');
          loadTest('./autowaiting.spec.js');
          loadTest('./click.spec.js');
          loadTest('./cookies.spec.js');
          loadTest('./dialog.spec.js');
          loadTest('./download.spec.js');
          loadTest('./elementhandle.spec.js');
          loadTest('./emulation.spec.js');
          loadTest('./evaluation.spec.js');
          loadTest('./frame.spec.js');
          loadTest('./focus.spec.js');
          loadTest('./input.spec.js');
          loadTest('./jshandle.spec.js');
          loadTest('./keyboard.spec.js');
          loadTest('./mouse.spec.js');
          loadTest('./navigation.spec.js');
          loadTest('./network.spec.js');
          loadTest('./page.spec.js');
          loadTest('./queryselector.spec.js');
          loadTest('./screenshot.spec.js');
          loadTest('./waittask.spec.js');
          loadTest('./interception.spec.js');
          loadTest('./geolocation.spec.js');
          loadTest('./workers.spec.js');
          loadTest('./capabilities.spec.js');
          loadTest('./permissions.spec.js');

          describe.skip(product !== 'Chromium')('[Chromium]', () => {
            loadTest('./chromium/chromium.spec.js');
            loadTest('./chromium/coverage.spec.js');
            loadTest('./chromium/pdf.spec.js');
            loadTest('./chromium/session.spec.js');
          });
        });

        // Browser-level tests that are given a browser.
        describe('[Driver]', () => {
          loadTest('./browser.spec.js');
          loadTest('./browsercontext.spec.js');
          loadTest('./ignorehttpserrors.spec.js');
          loadTest('./popup.spec.js');
        });
      });

      // Top-level tests that launch Browser themselves.
      describe('[Driver]', () => {
        loadTest('./defaultbrowsercontext.spec.js');
        loadTest('./fixtures.spec.js');
        loadTest('./launcher.spec.js');
        loadTest('./headful.spec.js');
        loadTest('./multiclient.spec.js');
      });

      describe.skip(product !== 'Chromium')('[Chromium]', () => {
        loadTest('./chromium/launcher.spec.js');
        loadTest('./chromium/oopif.spec.js');
        loadTest('./chromium/tracing.spec.js');
      });

      loadTest('./apicoverage.spec.js');

      delete global.browserType;
      delete global.playwright;
    });
  }
};

function valueFromEnv(name, defaultValue) {
  if (!(name in process.env))
    return defaultValue;
  return JSON.parse(process.env[name]);
}