@browserless/test 10.9.14 → 10.9.15

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (4) hide show
  1. package/package.json +3 -4
  2. package/src/create.js +64 -0
  3. package/src/index.js +1 -0
  4. package/src/suite.js +145 -0
package/package.json CHANGED
@@ -2,7 +2,7 @@
2
2
  "name": "@browserless/test",
3
3
  "description": "A test suite for browserless API",
4
4
  "homepage": "https://browserless.js.org",
5
- "version": "10.9.14",
5
+ "version": "10.9.15",
6
6
  "exports": {
7
7
  ".": "./src/index.js",
8
8
  "./create": "./src/create.js",
@@ -47,13 +47,12 @@
47
47
  "node": ">= 12"
48
48
  },
49
49
  "files": [
50
- "fixtures",
51
- "index.js"
50
+ "src"
52
51
  ],
53
52
  "scripts": {
54
53
  "coverage": "exit 0",
55
54
  "test": "exit 0"
56
55
  },
57
56
  "license": "MIT",
58
- "gitHead": "040050889a2b4d50fa83c5f095cf941632d172e3"
57
+ "gitHead": "b7e795fe720ee15519ecb14210fc4b11379e25ad"
59
58
  }
package/src/create.js ADDED
@@ -0,0 +1,64 @@
1
+ 'use strict'
2
+
3
+ const { default: listen } = require('async-listen')
4
+ const { onExit } = require('signal-exit')
5
+ const { createServer } = require('http')
6
+
7
+ const closeServer = server => require('util').promisify(server.close.bind(server))()
8
+
9
+ const runServer = async (t, handler) => {
10
+ const server = createServer(async (req, res) => {
11
+ try {
12
+ await handler({ req, res })
13
+ } catch (error) {
14
+ console.error(error)
15
+ res.statusCode = 500
16
+ res.end()
17
+ }
18
+ })
19
+
20
+ const url = await listen(server)
21
+ url.hostname = '127.0.0.1'
22
+
23
+ t.teardown(() => closeServer(server))
24
+ return url.toString()
25
+ }
26
+
27
+ module.exports = opts => {
28
+ let _browser
29
+
30
+ const createBrowser = () => {
31
+ const browser = require('browserless')(opts)
32
+ onExit(browser.close)
33
+ return browser
34
+ }
35
+
36
+ const getBrowser = () => _browser || (_browser = createBrowser())
37
+
38
+ const getInternalBrowser = () => getBrowser().browser()
39
+
40
+ const getBrowserWSEndpoint = () => getInternalBrowser().then(browser => browser.wsEndpoint())
41
+
42
+ const getBrowserContext = async (t, opts) => {
43
+ const browserless = await getBrowser().createContext(opts)
44
+ t.teardown(browserless.destroyContext)
45
+ return browserless
46
+ }
47
+
48
+ const getPage = async (t, opts) => {
49
+ const browserless = await getBrowserContext(t, opts)
50
+ const page = await browserless.page()
51
+ t.teardown(() => page.close())
52
+ return page
53
+ }
54
+
55
+ return {
56
+ createBrowser,
57
+ getBrowser,
58
+ getBrowserContext,
59
+ getBrowserWSEndpoint,
60
+ getInternalBrowser,
61
+ getPage,
62
+ runServer
63
+ }
64
+ }
package/src/index.js ADDED
@@ -0,0 +1 @@
1
+ module.exports = require('./create')({ timeout: 120000 })
package/src/suite.js ADDED
@@ -0,0 +1,145 @@
1
+ 'use strict'
2
+
3
+ const { imgDiff } = require('img-diff-js')
4
+ const { PDFParse } = require('pdf-parse')
5
+ const { onExit } = require('signal-exit')
6
+ const { copy } = require('fs-extra')
7
+ const temp = require('temperment')
8
+ const path = require('path')
9
+ const test = require('ava')
10
+ const fs = require('fs')
11
+
12
+ const { runServer } = require('.')
13
+
14
+ const isCI = !!process.env.CI
15
+
16
+ const PIXELS_DIFFERENCE = isCI ? 50000 : 0
17
+
18
+ const looksSame = async (actualFilename, expectedFilename) =>
19
+ imgDiff({
20
+ actualFilename,
21
+ expectedFilename
22
+ })
23
+
24
+ const imageComparison = async (t, expectedFilename, filename) => {
25
+ const actualFilename = path.resolve(process.cwd(), `test/snapshots/${filename}`)
26
+ if (!fs.existsSync(actualFilename)) {
27
+ await copy(expectedFilename, actualFilename)
28
+ return true
29
+ }
30
+ return looksSame(expectedFilename, actualFilename)
31
+ }
32
+
33
+ const getUrl = t =>
34
+ runServer(t, ({ res }) => {
35
+ res.setHeader('Content-Type', 'text/html')
36
+ return res.end(`<!DOCTYPE html>
37
+ <html lang="en">
38
+ <head>
39
+ <meta charset="UTF-8">
40
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
41
+ <title>Document</title>
42
+ </head>
43
+ <body>
44
+ <p>hello world</p>
45
+ </body>
46
+ </html>`)
47
+ })
48
+
49
+ module.exports = (browser, teardown = browser.close) => {
50
+ onExit(teardown)
51
+
52
+ test('.html', async t => {
53
+ const browserless = await browser.createContext()
54
+ t.teardown(browserless.destroyContext)
55
+ const url = await getUrl(t)
56
+ const html = await browserless.html(url, {
57
+ adblock: false
58
+ })
59
+ t.snapshot(html)
60
+ })
61
+
62
+ test('.text', async t => {
63
+ const browserless = await browser.createContext()
64
+ t.teardown(browserless.destroyContext)
65
+ const url = await getUrl(t)
66
+ const text = await browserless.text(url)
67
+
68
+ t.snapshot(text)
69
+ })
70
+
71
+ test('.screenshot (png)', async t => {
72
+ const filepath = temp.file({
73
+ extension: 'png'
74
+ })
75
+
76
+ const browserless = await browser.createContext()
77
+ t.teardown(browserless.destroyContext)
78
+ const url = await getUrl(t)
79
+ await browserless.screenshot(url, {
80
+ path: filepath
81
+ })
82
+
83
+ const { diffCount } = await imageComparison(t, filepath, 'example.png')
84
+
85
+ t.true(
86
+ diffCount <= PIXELS_DIFFERENCE,
87
+ `images are different by ${diffCount} differential pixels`
88
+ )
89
+ })
90
+
91
+ test('.screenshot (jpeg)', async t => {
92
+ const filepath = temp.file({
93
+ extension: 'jpeg'
94
+ })
95
+
96
+ const browserless = await browser.createContext()
97
+ t.teardown(browserless.destroyContext)
98
+ const url = await getUrl(t)
99
+ await browserless.screenshot(url, {
100
+ type: 'jpeg',
101
+ path: filepath
102
+ })
103
+
104
+ const { diffCount } = await imageComparison(t, filepath, 'example.jpeg')
105
+
106
+ t.true(
107
+ diffCount <= PIXELS_DIFFERENCE,
108
+ `images are different by ${diffCount} differential pixels`
109
+ )
110
+ })
111
+
112
+ test('.screenshot with device emulation', async t => {
113
+ const filepath = temp.file({
114
+ extension: 'png'
115
+ })
116
+
117
+ const browserless = await browser.createContext()
118
+ t.teardown(browserless.destroyContext)
119
+ const url = await getUrl(t)
120
+ await browserless.screenshot(url, {
121
+ device: 'iPhone 6',
122
+ path: filepath
123
+ })
124
+
125
+ const { diffCount } = await imageComparison(t, filepath, 'iphone.png')
126
+
127
+ t.true(
128
+ diffCount <= PIXELS_DIFFERENCE,
129
+ `images are different by ${diffCount} differential pixels`
130
+ )
131
+ })
132
+
133
+ test('.pdf', async t => {
134
+ const browserless = await browser.createContext()
135
+ t.teardown(browserless.destroyContext)
136
+ const url = await getUrl(t)
137
+ const buffer = await browserless.pdf(url)
138
+
139
+ const parser = new PDFParse({ data: buffer })
140
+ await parser.load()
141
+ const data = await parser.getText()
142
+
143
+ t.snapshot(data.text.trim())
144
+ })
145
+ }