Merge pull request #1 from smooth-code/spawnd-expect-puppeteer

feat: add spawnd & expect-puppeteer
argos-ci · Mar 4, 2018 · e67b617 · e67b617
2 parents 19c1cbb + 7fbb273
commit e67b617
Show file tree

Hide file tree

Showing 43 changed files with 1,168 additions and 110 deletions.
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -8,9 +8,17 @@ module.exports = {
   },
   env: {
     node: true,
+    jest: true,
+    browser: true,
+  },
+  globals: {
+    page: true,
+    browser: true,
+    expectPage: true,
   },
   rules: {
     'class-methods-use-this': 'off',
+    'no-shadow': 'off',
     'no-param-reassign': 'off',
     'no-use-before-define': 'off',
     'import/prefer-default-export': 'off',

diff --git a/README.md b/README.md
@@ -7,7 +7,7 @@
 Run your tests using Jest & Puppeteer 🎪✨
 
 ```
-npm install jest-environment-puppeteer puppeteer
+npm install jest-puppeteer-preset puppeteer
 ```
 
 ## Usage
@@ -16,9 +16,7 @@ Update your Jest configuration:
 
 ```json
 {
-  "globalSetup": "jest-environment-puppeteer/setup",
-  "globalTeardown": "jest-environment-puppeteer/teardown",
-  "testEnvironment": "jest-environment-puppeteer"
+  "preset": "jest-puppeteer-preset"
 }
 ```
 
@@ -27,12 +25,11 @@ Use Puppeteer in your tests:
 ```js
 describe('Google', () => {
   beforeAll(async () => {
-    await mainPage.goto('https://google.com')
+    await page.goto('https://google.com')
   })
 
   it('should display "google" text on page', async () => {
-    const text = await mainPage.evaluate(() => document.body.textContent)
-    expect(text).toContain('google')
+    expectPage().toMatch('google')
   })
 })
 ```
@@ -41,7 +38,9 @@ describe('Google', () => {
 
 ### Writing tests using Puppeteer
 
-To write your integration tests using Puppeteer you can find all available methods in [Puppeteer documentation](https://github.com/GoogleChrome/puppeteer/blob/master/docs/api.md).
+Writing integration test can be done using [Puppeteer API]([Puppeteer documentation](https://github.com/GoogleChrome/puppeteer/blob/master/docs/api.md)) but it can be complicated and hard because API is not designed for testing.
+
+To make it simpler, an `expectPage()` is automatically installed and available, it provides a lot of convenient methods, all documented in [expect-puppeteer API](https://github.com/smooth-code/jest-puppeteer/tree/master/packages/expect-ppuppeteer).
 
 ### Configure Puppeteer
 
@@ -59,7 +58,7 @@ module.exports = {
 
 ### Configure ESLint
 
-Jest Environment Puppeteer exposes two new globals: `browser` and `page`. If you want to avoid errors, you can add them to your `.eslintrc.js`:
+Jest Puppeteer exposes two new globals: `browser`, `page` and `expectPage`. If you want to avoid errors, you can add them to your `.eslintrc.js`:
 
 ```js
 // .eslintrc.js
@@ -70,6 +69,7 @@ module.exports = {
   globals: {
     page: true,
     browser: true,
+    expectPage: true,
   },
 }
 ```

diff --git a/jest.config.js b/jest.config.js
@@ -1,5 +1,5 @@
 module.exports = {
-  globalSetup: './packages/jest-environment-puppeteer/setup',
-  globalTeardown: './packages/jest-environment-puppeteer/teardown',
-  testEnvironment: './packages/jest-environment-puppeteer',
+  preset: './jest-puppeteer-preset',
+  globalSetup: './jestConfig/globalSetup',
+  globalTeardown: './jestConfig/globalTeardown',
 }
diff --git a/jestConfig/.eslintrc.js b/jestConfig/.eslintrc.js
@@ -0,0 +1,5 @@
+module.exports = {
+  rules: {
+    'import/no-extraneous-dependencies': 'off',
+  },
+}
diff --git a/jestConfig/globalSetup.js b/jestConfig/globalSetup.js
@@ -0,0 +1,15 @@
+const waitPort = require('wait-port')
+const {
+  setup: setupPuppeteer,
+} = require('../packages/jest-environment-puppeteer')
+const spawnd = require('../packages/spawnd')
+
+module.exports = async function setup() {
+  await setupPuppeteer()
+  global.app = spawnd('node server.js', {
+    cwd: __dirname,
+    env: process.env,
+    shell: true,
+  })
+  await waitPort({ port: 4444, output: 'silent' })
+}
diff --git a/jestConfig/globalTeardown.js b/jestConfig/globalTeardown.js
@@ -0,0 +1,8 @@
+const {
+  teardown: teardownPuppeteer,
+} = require('../packages/jest-environment-puppeteer')
+
+module.exports = async function teardown() {
+  await teardownPuppeteer()
+  if (global.app) global.app.destroy()
+}
diff --git a/jestConfig/public/index.html b/jestConfig/public/index.html
@@ -0,0 +1,22 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8">
+    <title>Test App</title>
+  </head>
+  <body>
+    <header>This is home!</header>
+    <a href="/page2.html">Page 2</a>
+    <select name="my-select">
+      <option value="">Select an option</option>
+      <option value="opt1">Option 1</option>
+      <option value="opt2">Option 2</option>
+    </select>
+    <input type="file" />
+    <form>
+      <input name="firstName" />
+      <input name="lastName" />
+    </form>
+    <button id="dialog-btn" onclick="window.confirm('Bouh!')">Open dialog</button>
+  </body>
+</html>
diff --git a/jestConfig/public/page2.html b/jestConfig/public/page2.html
@@ -0,0 +1,11 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8">
+    <title>Test App</title>
+  </head>
+  <body>
+    <header>This is Page 2</header>
+    <a href="/">Home</a>
+  </body>
+</html>
diff --git a/jestConfig/server.js b/jestConfig/server.js
@@ -0,0 +1,8 @@
+const path = require('path')
+const express = require('express')
+
+const app = express()
+
+app.use(express.static(path.join(__dirname, 'public')))
+
+app.listen(4444)
diff --git a/package.json b/package.json
@@ -1,6 +1,8 @@
 {
   "private": true,
-  "workspaces": ["packages/*"],
+  "workspaces": [
+    "packages/*"
+  ],
   "scripts": {
     "build": "lerna run build",
     "ci": "yarn build && yarn lint && yarn test --ci",
@@ -18,6 +20,7 @@
     "eslint-config-airbnb-base": "^12.1.0",
     "eslint-config-prettier": "^2.9.0",
     "eslint-plugin-import": "^2.9.0",
+    "express": "^4.16.2",
     "jest": "^22.4.2",
     "lerna": "^2.9.0",
     "puppeteer": "^1.1.1",

diff --git a/packages/expect-puppeteer/.npmignore b/packages/expect-puppeteer/.npmignore
@@ -0,0 +1,2 @@
+/*
+!/lib/*.js
diff --git a/packages/expect-puppeteer/LICENSE b/packages/expect-puppeteer/LICENSE
@@ -0,0 +1,7 @@
+Copyright 2018 Smooth Code
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
diff --git a/packages/expect-puppeteer/README.md b/packages/expect-puppeteer/README.md
@@ -0,0 +1,138 @@
+# expect-puppeteer
+
+[![Build Status][build-badge]][build]
+[![version][version-badge]][package]
+[![MIT License][license-badge]][license]
+
+Assertion library for Puppeteer.
+
+```
+npm install expect-puppeteer
+```
+
+## Usage
+
+```js
+import expectPage from 'expect-puppeteer'
+;(async () => {
+  const browser = await puppeteer.launch()
+  const page = await browser.newPage()
+  await page.goto('https://google.com')
+  await expectPage(page).toMatch('google')
+  await browser.close()
+})()
+```
+
+## API
+
+##### Table of Contents
+
+<!-- toc -->
+
+* [expectPage(page).toClick](#expectpagepagetoclickselectoroptions)
+* [expectPage(page).toDisplayDialog](#expectpagepagetodisplaydialogblock)
+* [expectPage(page).toFill](#expectpagepagetofillselectorvalueoptions)
+* [expectPage(page).toFillForm](#expectpagepagetofillformselectorvaluesoptions)
+* [expectPage(page).toMatch](#expectpagepagetomatchtext)
+* [expectPage(page).toSelect](#expectpagepagetoselectselectorvalueortext)
+* [expectPage(page).toUploadFile](#expectpagepagetouploadfileselectorfilepath)
+
+### expectPage(page).toClick(selector[, options])
+
+* `selector` <[string]> A [selector] to click on
+* `options` <[Object]> Optional parameters
+  * text <[string]> A text to match
+
+```js
+await expectPage(page).toClick('button', { text: 'Home' })
+```
+
+### expectPage(page).toDisplayDialog(block)
+
+* `block` <[function]> A [function] that should trigger a dialog
+
+```js
+await expectPage(page).toDisplayDialog(async () => {
+  await expectPage(page).toClick('button', { text: 'Show dialog' })
+})
+```
+
+### expectPage(page).toFill(selector, value[, options])
+
+* `selector` <[string]> A [selector] to match field
+* `value` <[string]> Value to fill
+* `options` <[Object]> Optional parameters
+  * `timeout` <[number]> maximum time to wait for in milliseconds. Defaults to `500`.
+
+```js
+await expectPage(page).toFill('input[name="firstName"]', 'James')
+```
+
+### expectPage(page).toFillForm(selector, values[, options])
+
+* `selector` <[string]> A [selector] to match form
+* `values` <[Object]> Values to fill
+* `options` <[Object]> Optional parameters
+  * `timeout` <[number]> maximum time to wait for in milliseconds. Defaults to `500`.
+
+```js
+await expectPage(page).toFillForm('form[name="myForm"]', {
+  firstName: 'James',
+  lastName: 'Bond',
+})
+```
+
+### expectPage(page).toMatch(text)
+
+* `text` <[string]> A text to match in page
+* `options` <[Object]> Optional parameters
+  * `timeout` <[number]> maximum time to wait for in milliseconds. Defaults to `500`.
+
+```js
+await expectPage(page).toMatch('Lorem ipsum')
+```
+
+### expectPage(page).toSelect(selector, valueOrText)
+
+* `selector` <[string]> A [selector] to match select [element]
+* `valueOrText` <[string]> Value or text matching option
+
+```js
+await expectPage(page).toSelect('select[name="choices"]', 'Choice 1')
+```
+
+### expectPage(page).toUploadFile(selector, filePath)
+
+* `selector` <[string]> A [selector] to match input [element]
+* `filePath` <[string]> A file path
+
+```js
+import path from 'path'
+
+await expectPage(page).toUploadFile(
+  'input[type="file"]',
+  path.join(__dirname, 'file.txt'),
+)
+```
+
+## License
+
+MIT
+
+[build-badge]: https://img.shields.io/travis/smooth-code/jest-puppeteer.svg?style=flat-square
+[build]: https://travis-ci.org/smooth-code/jest-puppeteer
+[version-badge]: https://img.shields.io/npm/v/expect-puppeteer.svg?style=flat-square
+[package]: https://www.npmjs.com/package/expect-puppeteer
+[license-badge]: https://img.shields.io/npm/l/expect-puppeteer.svg?style=flat-square
+[license]: https://github.com/smooth-code/jest-puppeteer/blob/master/LICENSE
+[array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array 'Array'
+[boolean]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type 'Boolean'
+[function]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function 'Function'
+[number]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type 'Number'
+[object]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object 'Object'
+[promise]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise 'Promise'
+[string]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type 'String'
+[error]: https://nodejs.org/api/errors.html#errors_class_error 'Error'
+[element]: https://developer.mozilla.org/en-US/docs/Web/API/element 'Element'
+[map]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map 'Map'
+[selector]: https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Selectors 'selector'
diff --git a/packages/expect-puppeteer/__fixtures__/file.txt b/packages/expect-puppeteer/__fixtures__/file.txt
diff --git a/packages/expect-puppeteer/package.json b/packages/expect-puppeteer/package.json
@@ -0,0 +1,26 @@
+{
+  "name": "expect-puppeteer",
+  "description": "Assertion toolkit for Puppeteer.",
+  "version": "1.0.1",
+  "main": "lib/index.js",
+  "repository": "https://github.com/smooth-code/jest-puppeteer/tree/master/packages/puppeteer-expect",
+  "author": "Greg Bergé <[email protected]>",
+  "license": "MIT",
+  "keywords": [
+    "jest",
+    "puppeteer",
+    "jest-puppeteer",
+    "chromeless",
+    "chrome-headless",
+    "expect",
+    "assert",
+    "should",
+    "assertion"
+  ],
+  "scripts": {
+    "prebuild": "rm -rf lib/",
+    "build": "babel src -d lib --ignore \"*.test.js\"",
+    "dev": "yarn build --watch",
+    "prepublishOnly": "yarn build"
+  }
+}