chore(testrunner): make most modifiers external (#1581)

Author: dgozman

test/playwright.spec.js

@@ -99,6 +99,16 @@ module.exports.describe = ({testRunner, product, playwrightPath}) => {
     ASSETS_DIR,
   };
 
+  function loadTests(modulePath) {
+    const module = require(modulePath);
+    if (typeof module.describe === 'function')
+      describe('', module.describe, testOptions);
+    if (typeof module.fdescribe === 'function')
+      fdescribe('', module.fdescribe, testOptions);
+    if (typeof module.xdescribe === 'function')
+      xdescribe('', module.xdescribe, testOptions);
+  }
+
   describe('', function() {
     beforeAll(async state => {
       state.browser = await browserType.launch(defaultBrowserOptions);
@@ -154,69 +164,69 @@ module.exports.describe = ({testRunner, product, playwrightPath}) => {
 
       // Page-level tests that are given a browser, a context and a page.
       // Each test is launched in a new browser context.
-      describe('[Accessibility]', () => testRunner.loadTests(require('./accessibility.spec.js'), testOptions));
+      describe('[Accessibility]', () => loadTests('./accessibility.spec.js'));
       describe('[Driver]', () => {
-        testRunner.loadTests(require('./autowaiting.spec.js'), testOptions);
-        testRunner.loadTests(require('./click.spec.js'), testOptions);
-        testRunner.loadTests(require('./cookies.spec.js'), testOptions);
-        testRunner.loadTests(require('./dialog.spec.js'), testOptions);
-        testRunner.loadTests(require('./elementhandle.spec.js'), testOptions);
-        testRunner.loadTests(require('./emulation.spec.js'), testOptions);
-        testRunner.loadTests(require('./evaluation.spec.js'), testOptions);
-        testRunner.loadTests(require('./frame.spec.js'), testOptions);
-        testRunner.loadTests(require('./focus.spec.js'), testOptions);
-        testRunner.loadTests(require('./input.spec.js'), testOptions);
-        testRunner.loadTests(require('./jshandle.spec.js'), testOptions);
-        testRunner.loadTests(require('./keyboard.spec.js'), testOptions);
-        testRunner.loadTests(require('./mouse.spec.js'), testOptions);
-        testRunner.loadTests(require('./navigation.spec.js'), testOptions);
-        testRunner.loadTests(require('./network.spec.js'), testOptions);
-        testRunner.loadTests(require('./page.spec.js'), testOptions);
-        testRunner.loadTests(require('./queryselector.spec.js'), testOptions);
-        testRunner.loadTests(require('./screenshot.spec.js'), testOptions);
-        testRunner.loadTests(require('./waittask.spec.js'), testOptions);
-        testRunner.loadTests(require('./interception.spec.js'), testOptions);
-        testRunner.loadTests(require('./geolocation.spec.js'), testOptions);
-        testRunner.loadTests(require('./workers.spec.js'), testOptions);
-        testRunner.loadTests(require('./capabilities.spec.js'), testOptions);
+        loadTests('./autowaiting.spec.js');
+        loadTests('./click.spec.js');
+        loadTests('./cookies.spec.js');
+        loadTests('./dialog.spec.js');
+        loadTests('./elementhandle.spec.js');
+        loadTests('./emulation.spec.js');
+        loadTests('./evaluation.spec.js');
+        loadTests('./frame.spec.js');
+        loadTests('./focus.spec.js');
+        loadTests('./input.spec.js');
+        loadTests('./jshandle.spec.js');
+        loadTests('./keyboard.spec.js');
+        loadTests('./mouse.spec.js');
+        loadTests('./navigation.spec.js');
+        loadTests('./network.spec.js');
+        loadTests('./page.spec.js');
+        loadTests('./queryselector.spec.js');
+        loadTests('./screenshot.spec.js');
+        loadTests('./waittask.spec.js');
+        loadTests('./interception.spec.js');
+        loadTests('./geolocation.spec.js');
+        loadTests('./workers.spec.js');
+        loadTests('./capabilities.spec.js');
       });
       describe('[Permissions]', () => {
-        testRunner.loadTests(require('./permissions.spec.js'), testOptions);
+        loadTests('./permissions.spec.js');
       });
 
       describe.skip(!CHROMIUM)('[Chromium]', () => {
-        testRunner.loadTests(require('./chromium/chromium.spec.js'), testOptions);
-        testRunner.loadTests(require('./chromium/coverage.spec.js'), testOptions);
-        testRunner.loadTests(require('./chromium/pdf.spec.js'), testOptions);
-        testRunner.loadTests(require('./chromium/session.spec.js'), testOptions);
+        loadTests('./chromium/chromium.spec.js');
+        loadTests('./chromium/coverage.spec.js');
+        loadTests('./chromium/pdf.spec.js');
+        loadTests('./chromium/session.spec.js');
       });
     });
 
     // Browser-level tests that are given a browser.
     describe('[Driver]', () => {
-      testRunner.loadTests(require('./browser.spec.js'), testOptions);
-      testRunner.loadTests(require('./browsercontext.spec.js'), testOptions);
-      testRunner.loadTests(require('./ignorehttpserrors.spec.js'), testOptions);
-      testRunner.loadTests(require('./popup.spec.js'), testOptions);
+      loadTests('./browser.spec.js');
+      loadTests('./browsercontext.spec.js');
+      loadTests('./ignorehttpserrors.spec.js');
+      loadTests('./popup.spec.js');
     });
   });
 
   // Top-level tests that launch Browser themselves.
   describe('[Driver]', () => {
-    testRunner.loadTests(require('./defaultbrowsercontext.spec.js'), testOptions);
-    testRunner.loadTests(require('./fixtures.spec.js'), testOptions);
-    testRunner.loadTests(require('./launcher.spec.js'), testOptions);
-    testRunner.loadTests(require('./headful.spec.js'), testOptions);
-    testRunner.loadTests(require('./multiclient.spec.js'), testOptions);
+    loadTests('./defaultbrowsercontext.spec.js');
+    loadTests('./fixtures.spec.js');
+    loadTests('./launcher.spec.js');
+    loadTests('./headful.spec.js');
+    loadTests('./multiclient.spec.js');
   });
 
   describe.skip(!CHROMIUM)('[Chromium]', () => {
-    testRunner.loadTests(require('./chromium/launcher.spec.js'), testOptions);
-    testRunner.loadTests(require('./chromium/oopif.spec.js'), testOptions);
-    testRunner.loadTests(require('./chromium/tracing.spec.js'), testOptions);
+    loadTests('./chromium/launcher.spec.js');
+    loadTests('./chromium/oopif.spec.js');
+    loadTests('./chromium/tracing.spec.js');
   });
 
   describe('[Driver]', () => {
-    testRunner.loadTests(require('./web.spec.js'), testOptions);
+    loadTests('./web.spec.js');
   });
 };

test/test.js

@@ -18,6 +18,7 @@ const path = require('path');
 const {TestServer} = require('../utils/testserver/');
 const {TestRunner, Reporter} = require('../utils/testrunner/');
 const utils = require('./utils');
+const inspector = require('inspector');
 
 let parallel = 1;
 if (process.env.PW_PARALLEL_TESTS)
@@ -30,11 +31,66 @@ 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 && inspector.url()) {
+  console.log('Detected inspector - disabling timeout to be debugger-friendly');
+  timeout = 0;
+}
+
 const testRunner = new TestRunner({
   timeout,
   parallel,
   breakOnFailure: process.argv.indexOf('--break-on-failure') !== -1,
+  installCommonHelpers: false
+});
+testRunner.testModifier('skip', (t, condition) => condition && t.setMode(t.Modes.Skip));
+testRunner.suiteModifier('skip', (s, condition) => condition && s.setMode(s.Modes.Skip));
+testRunner.testModifier('fail', (t, condition) => condition && t.setExpectation(t.Expectations.Fail));
+testRunner.suiteModifier('fail', (s, condition) => condition && s.setExpectation(s.Expectations.Fail));
+testRunner.testModifier('slow', (t, condition) => condition && t.setTimeout(t.timeout() * 3));
+testRunner.testModifier('repeat', (t, count) => t.setRepeat(count));
+testRunner.suiteModifier('repeat', (s, count) => s.setRepeat(count));
+testRunner.testAttribute('focus', t => t.setMode(t.Modes.Focus));
+testRunner.suiteAttribute('focus', s => s.setMode(s.Modes.Focus));
+testRunner.testAttribute('debug', t => {
+  t.setMode(t.Modes.Focus);
+  t.setTimeout(100000000);
+
+  let session;
+  t.before(async () => {
+    const util = require('util');
+    const fs = require('fs');
+    const url = require('url');
+    const readFileAsync = util.promisify(fs.readFile.bind(fs));
+    session = new inspector.Session();
+    session.connect();
+    const postAsync = util.promisify(session.post.bind(session));
+    await postAsync('Debugger.enable');
+    const setBreakpointCommands = [];
+    const N = t.body().toString().split('\n').length;
+    const location = t.location();
+    const lines = (await readFileAsync(location.filePath, 'utf8')).split('\n');
+    for (let line = 0; line < N; ++line) {
+      const lineNumber = line + location.lineNumber;
+      setBreakpointCommands.push(postAsync('Debugger.setBreakpointByUrl', {
+        url: url.pathToFileURL(location.filePath),
+        lineNumber,
+        condition: `console.log('${String(lineNumber + 1).padStart(6, ' ')} | ' + ${JSON.stringify(lines[lineNumber])})`,
+      }).catch(e => {}));
+    }
+    await Promise.all(setBreakpointCommands);
+  });
+
+  t.after(async () => {
+    session.disconnect();
+  });
 });
+testRunner.fdescribe = testRunner.describe.focus;
+testRunner.xdescribe = testRunner.describe.skip(true);
+testRunner.fit = testRunner.it.focus;
+testRunner.xit = testRunner.it.skip(true);
+testRunner.dit = testRunner.it.debug;
+
 const {describe, fdescribe, beforeAll, afterAll, beforeEach, afterEach} = testRunner;
 
 console.log('Testing on Node', process.version);
@@ -106,7 +162,7 @@ for (const browserConfig of BROWSER_CONFIGS) {
     continue;
   const product = browserConfig.name;
   describe(product, () => {
-    testRunner.loadTests(require('./playwright.spec.js'), {
+    testRunner.describe('', require('./playwright.spec.js').describe, {
       product,
       playwrightPath: utils.projectRoot(),
       testRunner,

test/types.d.ts

@@ -36,7 +36,7 @@ type TestRunner<STATE> = {
     fit: ItFunction<STATE>;
     dit: ItFunction<STATE>;
 
-    beforeAll, beforeEach, afterAll, afterEach, loadTests;
+    beforeAll, beforeEach, afterAll, afterEach;
 };
 
 interface TestSetup<STATE> {