chore(tests): add types for tests (#915)

I enabled vscode autocomplete in our test files. Typechecking had too many errors to enable, but it caught some real bugs that I will fix in a follow up. This patch contains: * `test/types.d.ts` - d.ts file for our test runner. * `test/tsconfig.json` - typescript project for our tests. * JSDoc header in all specs to mark the describe as a TestSuite * Drive-by fix of a launcher test that was using `if` instead of `it` * Some drive-by fixes of unimpactful typos in tests.
microsoft · Feb 10, 2020 · c03e8b7 · c03e8b7
1 parent 9da0229
commit c03e8b7
Show file tree

Hide file tree

Showing 45 changed files with 246 additions and 6 deletions.
diff --git a/test/accessibility.spec.js b/test/accessibility.spec.js
@@ -15,6 +15,9 @@
  * limitations under the License.
  */
 
+/**
+ * @type {PageTestSuite}
+ */
 module.exports.describe = function({testRunner, expect, FFOX, CHROMIUM, WEBKIT, MAC}) {
   const {describe, xdescribe, fdescribe} = testRunner;
   const {it, fit, xit, dit} = testRunner;

diff --git a/test/browser.spec.js b/test/browser.spec.js
@@ -16,6 +16,9 @@
 
 const utils = require('./utils');
 
+/**
+ * @type {BrowserTestSuite}
+ */
 module.exports.describe = function({testRunner, expect, playwright, CHROMIUM, WEBKIT}) {
   const {describe, xdescribe, fdescribe} = testRunner;
   const {it, fit, xit, dit} = testRunner;

diff --git a/test/browsercontext.spec.js b/test/browsercontext.spec.js
@@ -17,6 +17,9 @@
 
 const utils = require('./utils');
 
+/**
+ * @type {BrowserTestSuite}
+ */
 module.exports.describe = function({testRunner, expect, playwright, CHROMIUM, WEBKIT}) {
   const {describe, xdescribe, fdescribe} = testRunner;
   const {it, fit, xit, dit} = testRunner;

diff --git a/test/capabilities.spec.js b/test/capabilities.spec.js
@@ -17,6 +17,9 @@
 const utils = require('./utils');
 const { waitEvent } = utils;
 
+/**
+ * @type {PageTestSuite}
+ */
 module.exports.describe = function({testRunner, expect, WIN, WEBKIT}) {
   const {describe, xdescribe, fdescribe} = testRunner;
   const {it, fit, xit, dit} = testRunner;

diff --git a/test/chromium/chromium.spec.js b/test/chromium/chromium.spec.js
@@ -16,6 +16,9 @@
 
 const { waitEvent } = require('../utils');
 
+/**
+ * @type {ChromiumTestSuite}
+ */
 module.exports.describe = function({testRunner, expect, playwright, FFOX, CHROMIUM, WEBKIT}) {
   const {describe, xdescribe, fdescribe} = testRunner;
   const {it, fit, xit, dit} = testRunner;

diff --git a/test/chromium/coverage.spec.js b/test/chromium/coverage.spec.js
@@ -14,6 +14,9 @@
  * limitations under the License.
  */
 
+/**
+ * @type {ChromiumTestSuite}
+ */
 module.exports.describe = function({testRunner, expect, FFOX, CHROMIUM, WEBKIT}) {
   const {describe, xdescribe, fdescribe} = testRunner;
   const {it, fit, xit, dit} = testRunner;

diff --git a/test/chromium/headful.spec.js b/test/chromium/headful.spec.js
@@ -24,6 +24,9 @@ const mkdtempAsync = util.promisify(fs.mkdtemp);
 
 const TMP_FOLDER = path.join(os.tmpdir(), 'pw_tmp_folder-');
 
+/**
+ * @type {TestSuite}
+ */
 module.exports.describe = function({testRunner, expect, playwright, defaultBrowserOptions, FFOX, CHROMIUM, WEBKIT, WIN}) {
   const {describe, xdescribe, fdescribe} = testRunner;
   const {it, fit, xit, dit} = testRunner;

diff --git a/test/chromium/launcher.spec.js b/test/chromium/launcher.spec.js
@@ -25,6 +25,9 @@ const statAsync = util.promisify(fs.stat);
 
 const TMP_FOLDER = path.join(os.tmpdir(), 'pw_tmp_folder-');
 
+/**
+ * @type {TestSuite}
+ */
 module.exports.describe = function({testRunner, expect, defaultBrowserOptions, playwright, WIN}) {
   const {describe, xdescribe, fdescribe} = testRunner;
   const {it, fit, xit, dit} = testRunner;

diff --git a/test/chromium/oopif.spec.js b/test/chromium/oopif.spec.js
@@ -14,6 +14,9 @@
  * limitations under the License.
  */
 
+/**
+ * @type {ChromiumTestSuite}
+ */
 module.exports.describe = function({testRunner, expect, defaultBrowserOptions, playwright, FFOX, CHROMIUM, WEBKIT}) {
   const {describe, xdescribe, fdescribe} = testRunner;
   const {it, fit, xit, dit} = testRunner;

diff --git a/test/chromium/pdf.spec.js b/test/chromium/pdf.spec.js
@@ -17,6 +17,9 @@
 const fs = require('fs');
 const path = require('path');
 
+/**
+ * @type {ChromiumTestSuite}
+ */
 module.exports.describe = function({testRunner, expect, headless, ASSETS_DIR}) {
   const {describe, xdescribe, fdescribe} = testRunner;
   const {it, fit, xit, dit} = testRunner;

diff --git a/test/chromium/session.spec.js b/test/chromium/session.spec.js
@@ -16,6 +16,9 @@
 
 const { waitEvent } = require('../utils');
 
+/**
+ * @type {ChromiumTestSuite}
+ */
 module.exports.describe = function({testRunner, expect, FFOX, CHROMIUM, WEBKIT}) {
   const {describe, xdescribe, fdescribe} = testRunner;
   const {it, fit, xit, dit} = testRunner;

diff --git a/test/chromium/tracing.spec.js b/test/chromium/tracing.spec.js
@@ -17,6 +17,9 @@
 const fs = require('fs');
 const path = require('path');
 
+/**
+ * @type {ChromiumTestSuite}
+ */
 module.exports.describe = function({testRunner, expect, defaultBrowserOptions, playwright, ASSETS_DIR}) {
   const {describe, xdescribe, fdescribe} = testRunner;
   const {it, fit, xit, dit} = testRunner;

diff --git a/test/click.spec.js b/test/click.spec.js
@@ -17,6 +17,9 @@
 
 const utils = require('./utils');
 
+/**
+ * @type {PageTestSuite}
+ */
 module.exports.describe = function({testRunner, expect, playwright, FFOX, CHROMIUM, WEBKIT}) {
   const {describe, xdescribe, fdescribe} = testRunner;
   const {it, fit, xit, dit} = testRunner;

diff --git a/test/cookies.spec.js b/test/cookies.spec.js
@@ -15,6 +15,9 @@
  * limitations under the License.
  */
 
+/**
+ * @type {PageTestSuite}
+ */
 module.exports.describe = function({testRunner, expect, playwright, defaultBrowserOptions, MAC, FFOX, CHROMIUM, WEBKIT}) {
   const {describe, xdescribe, fdescribe} = testRunner;
   const {it, fit, xit, dit} = testRunner;

diff --git a/test/defaultbrowsercontext.spec.js b/test/defaultbrowsercontext.spec.js
@@ -17,6 +17,9 @@
 
 const { makeUserDataDir, removeUserDataDir } = require('./utils');
 
+/**
+ * @type {PageTestSuite}
+ */
 module.exports.describe = function ({ testRunner, expect, defaultBrowserOptions, playwright }) {
   const {describe, xdescribe, fdescribe} = testRunner;
   const {it, fit, xit, dit} = testRunner;

diff --git a/test/dialog.spec.js b/test/dialog.spec.js
@@ -15,6 +15,9 @@
  * limitations under the License.
  */
 
+/**
+ * @type {PageTestSuite}
+ */
 module.exports.describe = function({testRunner, expect, FFOX, CHROMIUM, WEBKIT}) {
   const {describe, xdescribe, fdescribe} = testRunner;
   const {it, fit, xit, dit} = testRunner;

diff --git a/test/elementhandle.spec.js b/test/elementhandle.spec.js
@@ -17,6 +17,9 @@
 
 const utils = require('./utils');
 
+/**
+ * @type {PageTestSuite}
+ */
 module.exports.describe = function({testRunner, expect, FFOX, CHROMIUM, WEBKIT}) {
   const {describe, xdescribe, fdescribe} = testRunner;
   const {it, fit, xit, dit} = testRunner;

diff --git a/test/emulation.spec.js b/test/emulation.spec.js
@@ -15,6 +15,9 @@
  * limitations under the License.
  */
 
+/**
+ * @type {PageTestSuite}
+ */
 module.exports.describe = function({testRunner, expect, playwright, FFOX, CHROMIUM, WEBKIT}) {
   const {describe, xdescribe, fdescribe} = testRunner;
   const {it, fit, xit, dit} = testRunner;

diff --git a/test/evaluation.spec.js b/test/evaluation.spec.js
@@ -19,6 +19,9 @@ const utils = require('./utils');
 
 const bigint = typeof BigInt !== 'undefined';
 
+/**
+ * @type {PageTestSuite}
+ */
 module.exports.describe = function({testRunner, expect, FFOX, CHROMIUM, WEBKIT}) {
   const {describe, xdescribe, fdescribe} = testRunner;
   const {it, fit, xit, dit} = testRunner;

diff --git a/test/features/permissions.spec.js b/test/features/permissions.spec.js
@@ -18,6 +18,9 @@
 const fs = require('fs');
 const path = require('path');
 
+/**
+ * @type {PageTestSuite}
+ */
 module.exports.describe = function({testRunner, expect, WEBKIT}) {
   const {describe, xdescribe, fdescribe} = testRunner;
   const {it, fit, xit, dit} = testRunner;

diff --git a/test/fixtures.spec.js b/test/fixtures.spec.js
@@ -18,6 +18,9 @@
 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;

diff --git a/test/frame.spec.js b/test/frame.spec.js
@@ -17,6 +17,9 @@
 
 const utils = require('./utils');
 
+/**
+ * @type {PageTestSuite}
+ */
 module.exports.describe = function({testRunner, expect, FFOX, CHROMIUM, WEBKIT}) {
   const {describe, xdescribe, fdescribe} = testRunner;
   const {it, fit, xit, dit} = testRunner;

diff --git a/test/geolocation.spec.js b/test/geolocation.spec.js
@@ -15,6 +15,9 @@
  * limitations under the License.
  */
 
+/**
+ * @type {PageTestSuite}
+ */
 module.exports.describe = function ({ testRunner, expect, FFOX, WEBKIT }) {
   const {describe, xdescribe, fdescribe} = testRunner;
   const {it, fit, xit, dit} = testRunner;

diff --git a/test/headful.spec.js b/test/headful.spec.js
@@ -16,6 +16,9 @@
 
 const { makeUserDataDir, removeUserDataDir } = require('./utils');
 
+/**
+ * @type {TestSuite}
+ */
 module.exports.describe = function({testRunner, expect, playwright, defaultBrowserOptions, FFOX, CHROMIUM, WEBKIT, WIN}) {
   const {describe, xdescribe, fdescribe} = testRunner;
   const {it, fit, xit, dit} = testRunner;

diff --git a/test/ignorehttpserrors.spec.js b/test/ignorehttpserrors.spec.js
@@ -15,6 +15,9 @@
  * limitations under the License.
  */
 
+/**
+ * @type {BrowserTestSuite}
+ */
 module.exports.describe = function({testRunner, expect, defaultBrowserOptions, playwright, FFOX, CHROMIUM, WEBKIT}) {
   const {describe, xdescribe, fdescribe} = testRunner;
   const {it, fit, xit, dit} = testRunner;

diff --git a/test/input.spec.js b/test/input.spec.js
@@ -21,6 +21,9 @@ const formidable = require('formidable');
 
 const FILE_TO_UPLOAD = path.join(__dirname, '/assets/file-to-upload.txt');
 
+/**
+ * @type {PageTestSuite}
+ */
 module.exports.describe = function({testRunner, expect, playwright, FFOX, CHROMIUM, WEBKIT}) {
   const {describe, xdescribe, fdescribe} = testRunner;
   const {it, fit, xit, dit} = testRunner;

diff --git a/test/interception.spec.js b/test/interception.spec.js
@@ -20,6 +20,9 @@ const path = require('path');
 const { helper } = require('../lib/helper');
 const utils = require('./utils');
 
+/**
+ * @type {PageTestSuite}
+ */
 module.exports.describe = function({testRunner, expect, defaultBrowserOptions, playwright, FFOX, CHROMIUM, WEBKIT}) {
   const {describe, xdescribe, fdescribe} = testRunner;
   const {it, fit, xit, dit} = testRunner;

diff --git a/test/jshandle.spec.js b/test/jshandle.spec.js
@@ -15,6 +15,9 @@
  * limitations under the License.
  */
 
+/**
+ * @type {PageTestSuite}
+ */
 module.exports.describe = function({testRunner, expect, CHROMIUM, FFOX, WEBKIT}) {
   const {describe, xdescribe, fdescribe} = testRunner;
   const {it, fit, xit, dit} = testRunner;

diff --git a/test/keyboard.spec.js b/test/keyboard.spec.js
@@ -18,6 +18,9 @@
 const utils = require('./utils');
 const os = require('os');
 
+/**
+ * @type {PageTestSuite}
+ */
 module.exports.describe = function({testRunner, expect, FFOX, CHROMIUM, WEBKIT, MAC}) {
   const {describe, xdescribe, fdescribe} = testRunner;
   const {it, fit, xit, dit} = testRunner;

diff --git a/test/launcher.spec.js b/test/launcher.spec.js
@@ -20,6 +20,9 @@ const fs = require('fs');
 const utils = require('./utils');
 const { makeUserDataDir, removeUserDataDir } = require('./utils');
 
+/**
+ * @type {TestSuite}
+ */
 module.exports.describe = function({testRunner, expect, defaultBrowserOptions, playwright, playwrightPath, product, CHROMIUM, FFOX, WEBKIT, WIN}) {
   const {describe, xdescribe, fdescribe} = testRunner;
   const {it, fit, xit, dit} = testRunner;
@@ -42,7 +45,7 @@ module.exports.describe = function({testRunner, expect, defaultBrowserOptions, p
         await playwright.launch(options).catch(e => waitError = e);
         expect(waitError.message).toContain('Failed to launch');
       });
-      if('should have default URL when launching browser', async function() {
+      it('should have default URL when launching browser', async function() {
         const userDataDir = await makeUserDataDir();
         const browserContext = await playwright.launchPersistent(userDataDir, defaultBrowserOptions);
         const pages = (await browserContext.pages()).map(page => page.url());
@@ -172,7 +175,7 @@ module.exports.describe = function({testRunner, expect, defaultBrowserOptions, p
   });
 
   describe('Browser.close', function() {
-    it('should terminate network waiters', async({context, server}) => {
+    it('should terminate network waiters', async({server}) => {
       const browserServer = await playwright.launchServer({...defaultBrowserOptions });
       const remote = await playwright.connect({ wsEndpoint: browserServer.wsEndpoint() });
       const newPage = await remote.newPage();

diff --git a/test/mouse.spec.js b/test/mouse.spec.js
@@ -26,6 +26,9 @@ function dimensions() {
   };
 }
 
+/**
+ * @type {PageTestSuite}
+ */
 module.exports.describe = function({testRunner, expect, FFOX, CHROMIUM, WEBKIT, MAC}) {
   const {describe, xdescribe, fdescribe} = testRunner;
   const {it, fit, xit, dit} = testRunner;

diff --git a/test/multiclient.spec.js b/test/multiclient.spec.js
@@ -17,6 +17,9 @@
 
 const utils = require('./utils');
 
+/**
+ * @type {TestSuite}
+ */
 module.exports.describe = function({testRunner, expect, defaultBrowserOptions, playwright, FFOX, CHROMIUM, WEBKIT}) {
   const {describe, xdescribe, fdescribe} = testRunner;
   const {it, fit, xit, dit} = testRunner;

diff --git a/test/navigation.spec.js b/test/navigation.spec.js
@@ -18,6 +18,9 @@
 const utils = require('./utils');
 const { performance } = require('perf_hooks');
 
+/**
+ * @type {PageTestSuite}
+ */
 module.exports.describe = function({testRunner, expect, playwright, MAC, WIN, FFOX, CHROMIUM, WEBKIT}) {
   const {describe, xdescribe, fdescribe} = testRunner;
   const {it, fit, xit, dit} = testRunner;

diff --git a/test/network.spec.js b/test/network.spec.js
@@ -19,6 +19,9 @@ const fs = require('fs');
 const path = require('path');
 const utils = require('./utils');
 
+/**
+ * @type {PageTestSuite}
+ */
 module.exports.describe = function({testRunner, expect, MAC, WIN, FFOX, CHROMIUM, WEBKIT}) {
   const {describe, xdescribe, fdescribe} = testRunner;
   const {it, fit, xit, dit} = testRunner;

diff --git a/test/page.spec.js b/test/page.spec.js
@@ -19,6 +19,9 @@ const path = require('path');
 const utils = require('./utils');
 const {waitEvent} = utils;
 
+/**
+ * @type {PageTestSuite}
+ */
 module.exports.describe = function({testRunner, expect, headless, playwright, FFOX, CHROMIUM, WEBKIT}) {
   const {describe, xdescribe, fdescribe} = testRunner;
   const {it, fit, xit, dit} = testRunner;

diff --git a/test/playwright.spec.js b/test/playwright.spec.js
@@ -24,6 +24,9 @@ const {Matchers} = require('../utils/testrunner/');
 const YELLOW_COLOR = '\x1b[33m';
 const RESET_COLOR = '\x1b[0m';
 
+/**
+ * @type {TestSuite}
+ */
 module.exports.describe = ({testRunner, product, playwrightPath}) => {
   const {describe, xdescribe, fdescribe} = testRunner;
   const {it, fit, xit, dit} = testRunner;

diff --git a/test/queryselector.spec.js b/test/queryselector.spec.js
@@ -17,6 +17,9 @@
 
 const zsSelectorEngineSource = require('../lib/generated/zsSelectorEngineSource');
 
+/**
+ * @type {PageTestSuite}
+ */
 module.exports.describe = function({testRunner, expect, selectors, FFOX, CHROMIUM, WEBKIT}) {
   const {describe, xdescribe, fdescribe} = testRunner;
   const {it, fit, xit, dit} = testRunner;
@@ -236,7 +239,7 @@ module.exports.describe = function({testRunner, expect, selectors, FFOX, CHROMIU
       const element = await page.$$('//html/body/non-existing-element');
       expect(element).toEqual([]);
     });
-    it('should return multiple elements', async({page, sever}) => {
+    it('should return multiple elements', async({page, server}) => {
       await page.setContent('<div></div><div></div>');
       const elements = await page.$$('xpath=/html/body/div');
       expect(elements.length).toBe(2);