polendina 0.2.0 → 1.1.1

package/.github/workflows/test-and-release.yml

@@ -0,0 +1,58 @@
+name: Test & Maybe Release
+on: [push, pull_request]
+jobs:
+  test:
+    strategy:
+      fail-fast: false
+      matrix:
+        node: [14.x, 16.x]
+        os: [macos-latest, ubuntu-latest, windows-latest]
+    runs-on: ${{ matrix.os }}
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v2.3.4
+      - name: Use Node.js ${{ matrix.node }}
+        uses: actions/setup-node@v2.4.0
+        with:
+          node-version: ${{ matrix.node }}
+      - name: Install Dependencies
+        run: |
+          npm install --no-progress
+      - name: Run tests
+        run: |
+          npm config set script-shell bash
+          npm test
+  release:
+    name: Release
+    needs: test
+    runs-on: ubuntu-latest
+    if: github.event_name == 'push' && github.ref == 'refs/heads/master'
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2.3.4
+        with:
+          fetch-depth: 0
+      - name: Setup Node.js
+        uses: actions/setup-node@v2.4.0
+        with:
+          node-version: 14
+      - name: Install dependencies
+        run: |
+          npm install --no-progress --no-package-lock --no-save
+      - name: Install plugins
+        run: |
+          npm install \
+            @semantic-release/commit-analyzer \
+            conventional-changelog-conventionalcommits \
+            @semantic-release/release-notes-generator \
+            @semantic-release/npm \
+            @semantic-release/github \
+            @semantic-release/git \
+            @semantic-release/changelog \
+            --no-progress --no-package-lock --no-save
+      - name: Release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+        run: npx semantic-release
+

package/CHANGELOG.md

@@ -0,0 +1,11 @@
+### [1.1.1](https://github.com/rvagg/polendina/compare/v1.1.0...v1.1.1) (2021-12-07)
+
+
+### Bug Fixes
+
+* no build step for release ([b91faf0](https://github.com/rvagg/polendina/commit/b91faf08395e6f8bc44b21d02d94c2136bcac942))
+
+
+### Trivial Changes
+
+* add auto-releases ([#17](https://github.com/rvagg/polendina/issues/17)) ([9e71246](https://github.com/rvagg/polendina/commit/9e71246667ba96d8253aa180271728b35e700b45))

package/README.md

@@ -19,9 +19,10 @@
   * [Tape](#tape)
   * [bare-sync](#bare-sync)
   * [bare-async](#bare-async)
-* [`polendina-node`: the minimal Node.js test runner](#polendina-node-the-minimal-nodejs-test-runner)
+* [TypeScript support (and other Webpack extensions)](#typescript-support-and-other-webpack-extensions)
+* [polendina-node: the minimal Node.js test runner](#polendina-node-the-minimal-nodejs-test-runner)
 * [Minimising Puppeteer's size](#minimising-puppeteers-size)
-  * [Global and `npx`](#global-and-npx)
+  * [Global and npx](#global-and-npx)
 * [License and Copyright](#license-and-copyright)
 
 ## What and why?
@@ -63,6 +64,7 @@ Even though polendina is intended for "non-UI" testing, your tests run in a stan
  * `--stats`: Write webpack-stats.json with bundle; written to the `output-dir` so will be removed if `--cleanup` is specified (default: "false")
  * `--cleanup`: Remove the `output-dir` after execution (default: "false")
  * `--timeout`: Number of seconds to wait before auto-failing the test suite (default: "30")
+ * `--webpack-config`: Supply a path to a webpack.config.js to merge into Polendina's Webpack config (use with caution)
  * `--mocha-reporter`: Specify the Mocha reporter if the test runner is Mocha (default: "spec")
 
 ## Examples
@@ -158,6 +160,34 @@ module.exports.testFail = async () => {
 }
 ```
 
+## TypeScript support (and other Webpack extensions)
+
+Among other things, the `--webpack-config` option can be used to enable TypeScript support by mixing in the [ts-loader](https://ghub.io/ts-loader) package:
+
+**webpack.config.ts.js**
+
+```js
+module.exports = {
+    module: {
+        rules: [
+            {
+                test: /\.tsx?$/,
+                use: 'ts-loader',
+                exclude: /node_modules/
+            }
+        ]
+    }
+    resolve: {
+        extensions: ['.tsx', '.ts', '.js']
+    }
+}
+```
+
+```sh
+$ polendina --cleanup test/*.spec.ts --webpack-config webpack.config.ts.js
+```
+
+
 ## `polendina-node`: the minimal Node.js test runner
 
 polendina's `bare-sync` and `bare-async` modes run plain Node.js modules in the browser without the need for a test runner. But if you want to run these types of files in Node.js you may find it difficult to scale when you have many modules.

package/lib/puppeteer.js

@@ -79,6 +79,9 @@ async function _run (outputDir, port, timeout, mode, runner, coverage, callback)
     maybeEnd()
   })
 
+  page.on('error', (error) => console.error(error))
+  page.on('pageerror', (error) => console.error(error))
+
   await page.exposeFunction('polendinaEnd', (errors) => {
     end(errors)
   })

package/lib/webpack.config.js

@@ -2,10 +2,10 @@ const path = require('path')
 const glob = require('glob')
 
 module.exports = function (env, options, runner) {
-  const bundleRun = path.resolve(options.outputDir, runner)
+  const bundleRun = path.normalize(path.resolve(options.outputDir, runner))
   const testFiles = options._.reduce((p, c) => {
     return p.concat(glob.sync(c, { absolute: true }))
-  }, [])
+  }, []).map(path.normalize)
 
   // our globs may be fruitless
   if (!testFiles.length) {
@@ -16,6 +16,7 @@ module.exports = function (env, options, runner) {
 
   return {
     mode: 'development',
+    context: process.cwd(),
     entry: testFiles,
     output: {
       path: path.resolve(process.cwd(), options.outputDir),
@@ -27,18 +28,23 @@ module.exports = function (env, options, runner) {
     },
     resolve: {
       modules: [
-        path.join(__dirname, '../node_modules'),
-        path.join(process.cwd(), 'node_modules')
+        path.join(process.cwd(), 'node_modules'),
+        path.join(__dirname, '../node_modules')
       ]
     },
     resolveLoader: {
       modules: [
-        path.join(__dirname, '../node_modules'),
-        path.join(process.cwd(), 'node_modules')
+        path.join(process.cwd(), 'node_modules'),
+        path.join(__dirname, '../node_modules')
       ]
     },
     node: {
-      fs: 'empty'
+      dgram: 'empty',
+      fs: 'empty',
+      net: 'empty',
+      tls: 'empty',
+      dns: 'empty',
+      child_process: 'empty'
     },
     module: {
       rules: [

package/lib/wrap-loader.js

@@ -19,10 +19,10 @@ loader.pitch = function pitch (remainingRequest) {
 
   // wrap the test in a function that is only called when we want it called
   return `
-    const registry = require(${JSON.stringify(`!!${path.resolve(argv.outputDir, 'test-registry.js')}`)})
-    registry.argv = JSON.parse('${JSON.stringify(argv)}')
+    const registry = require(${JSON.stringify(`!!${path.normalize(path.resolve(argv.outputDir, 'test-registry.js'))}`)})
+    registry.argv = JSON.parse(${JSON.stringify(JSON.stringify(argv))})
     registry.tests.push({
-      name: JSON.parse('${JSON.stringify(path.relative(process.cwd(), remainingRequest))}'),
+      name: JSON.parse('${JSON.stringify(path.normalize(path.relative(process.cwd(), remainingRequest)))}'),
       load: () => { return require(${JSON.stringify(`!!${remainingRequest}`)}) }
     })
   `

package/package.json

@@ -1,32 +1,30 @@
 {
   "name": "polendina",
-  "version": "0.2.0",
+  "version": "1.1.1",
   "description": "Non-UI browser testing for JavaScript libraries from the command-line",
   "main": "polendina.js",
   "dependencies": {
     "ansi-colors": "^4.1.1",
     "glob": "^7.1.6",
-    "puppeteer": "^2.0.0",
+    "puppeteer": "^5.2.1",
     "raw-loader": "^4.0.0",
+    "readable-stream": "^2.3.7",
     "rimraf": "^3.0.0",
     "st": "^2.0.0",
     "strip-ansi": "^6.0.0",
     "webpack": "^4.41.5",
+    "webpack-merge": "^4.2.2",
     "yargs": "^15.1.0"
   },
   "bin": {
     "polendina": "./polendina-cli.js",
     "polendina-node": "./polendina-node-cli.js"
   },
-  "devDependencies": {
-    "mocha": "^7.0.0",
-    "standard": "^14.3.1",
-    "tape": "^4.12.1"
-  },
   "scripts": {
-    "lint": "standard",
-    "test:install": "for f in $(cd test/fixtures/; ls); do (cd test/fixtures/$f && grep devDependencies package.json > /dev/null && npm i --no-audit --no-fund); done",
-    "test": "npm run lint && npm run test:install && mocha test/test-*.js"
+    "lint": "npx standard",
+    "test:install": "for f in $(cd test/fixtures/; ls); do (cd test/fixtures/$f && grep devDependencies package.json > /dev/null && npm i --no-audit --no-fund --no-package-lock) || true; done",
+    "test:run": "npx mocha test/test-*.js",
+    "test": "npm run lint && npm run test:install && npm run test:run"
   },
   "repository": {
     "type": "git",
@@ -43,5 +41,86 @@
     "test"
   ],
   "author": "Rod <rod@vagg.org> (http://r.va.gg/)",
-  "license": "Apache-2.0"
+  "license": "Apache-2.0",
+  "release": {
+    "branches": [
+      "master"
+    ],
+    "plugins": [
+      [
+        "@semantic-release/commit-analyzer",
+        {
+          "preset": "conventionalcommits",
+          "releaseRules": [
+            {
+              "breaking": true,
+              "release": "major"
+            },
+            {
+              "revert": true,
+              "release": "patch"
+            },
+            {
+              "type": "feat",
+              "release": "minor"
+            },
+            {
+              "type": "fix",
+              "release": "patch"
+            },
+            {
+              "type": "chore",
+              "release": "patch"
+            },
+            {
+              "type": "docs",
+              "release": "patch"
+            },
+            {
+              "type": "test",
+              "release": "patch"
+            },
+            {
+              "scope": "no-release",
+              "release": false
+            }
+          ]
+        }
+      ],
+      [
+        "@semantic-release/release-notes-generator",
+        {
+          "preset": "conventionalcommits",
+          "presetConfig": {
+            "types": [
+              {
+                "type": "feat",
+                "section": "Features"
+              },
+              {
+                "type": "fix",
+                "section": "Bug Fixes"
+              },
+              {
+                "type": "chore",
+                "section": "Trivial Changes"
+              },
+              {
+                "type": "docs",
+                "section": "Trivial Changes"
+              },
+              {
+                "type": "test",
+                "section": "Tests"
+              }
+            ]
+          }
+        }
+      ],
+      "@semantic-release/changelog",
+      "@semantic-release/npm",
+      "@semantic-release/github",
+      "@semantic-release/git"
+    ]
+  }
 }

package/polendina-cli.js

@@ -57,6 +57,11 @@ const argv = require('yargs')
     default: false,
     hidden: true
   })
+  .option('webpack-config', {
+    type: 'string',
+    describe: 'Supply a path to a webpack.config.js to merge into Polendina\'s Webpack config (use with caution)',
+    requiresArg: true
+  })
   .option('mocha-reporter', {
     type: 'string',
     describe: 'Specify the Mocha reporter',

package/polendina.js

@@ -5,6 +5,7 @@ const http = require('http')
 const st = require('st')
 const rimraf = promisify(require('rimraf'))
 const webpack = promisify(require('webpack'))
+const merge = require('webpack-merge')
 const puppeteer = require('./lib/puppeteer')
 
 class Polendina {
@@ -31,7 +32,12 @@ class Polendina {
   }
 
   async build () {
-    const webpackConfig = require('./lib/webpack.config')(process.env, this._options, this._runnerModule)
+    let webpackConfig = require('./lib/webpack.config')(process.env, this._options, this._runnerModule)
+
+    if (this._options.webpackConfig) {
+      const userConfig = require(path.join(process.cwd(), this._options.webpackConfig))
+      webpackConfig = merge.smart(webpackConfig, userConfig)
+    }
 
     await fs.mkdir(this.outputDir, { recursive: true })
     const copyFiles = ['index.html', 'test-registry.js', 'page-run.js', 'common-run.js', this._runnerModule]
@@ -83,7 +89,12 @@ class Polendina {
   }
 
   _executeMode (mode) {
-    const mount = st({ path: this.outputDir, index: 'index.html', url: '/' })
+    const mount = st({
+      path: this.outputDir,
+      index: 'index.html',
+      url: '/',
+      cache: false
+    })
     return new Promise((resolve, reject) => {
       const server = http.createServer((req, res) => {
         mount(req, res, () => {

package/resources/mocha-run.js

@@ -1,28 +1,29 @@
-/* globals mocha Mocha */
-
 // in-browser setup and runner for Mocha, at end of bundle
 
-require('mocha/mocha.js')
+const mochaExport = require('mocha/mocha.js')
 const { registry, executionQueue, log, setup } = require('./common-run')
 
 function runMocha () {
-  mocha.setup({ reporter: registry.argv.mochaReporter, ui: 'bdd' })
+  // mocha@8 exports what we want, mocha@7 sets a global
+  const mochaLocal = global.mocha ? global.mocha : mochaExport
+  global._mocha = mochaLocal
+  mochaLocal.setup({ reporter: registry.argv.mochaReporter, ui: 'bdd' })
   // mocha@7 deprecated useColors()
-  if (typeof mocha.color === 'function') {
-    mocha.color(true)
-  } else if (typeof mocha.useColors === 'function') {
-    mocha.useColors(true)
+  if (typeof mochaLocal.color === 'function') {
+    mochaLocal.color(true)
+  } else if (typeof mochaLocal.useColors === 'function') {
+    mochaLocal.useColors(true)
   }
 
   // the well-behaved reporters, like spec, are easy to intercept
-  Mocha.reporters.Base.consoleLog = log.info
+  mochaLocal.constructor.reporters.Base.consoleLog = log.info
 
   for (const mod of registry.tests) {
     mod.load()
   }
 
   let errors = 0
-  mocha
+  mochaLocal
     .run((_errors) => { errors = _errors })
     .on('end', (...args) => {
       executionQueue(() => global.polendinaEnd(errors))

package/test/fixtures/mocha8/index.js

@@ -0,0 +1 @@
+module.exports = 'polendina test'

package/test/fixtures/mocha8/package.json

@@ -0,0 +1,18 @@
+{
+  "name": "fixture-mocha8",
+  "version": "1.0.0",
+  "description": "test-fixture",
+  "main": "index.js",
+  "scripts": {
+    "test": "mocha test-*.js"
+  },
+  "author": "Rod <rod@vagg.org> (http://r.va.gg/)",
+  "license": "Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/rvagg/polendina.git"
+  },
+  "devDependencies": {
+    "mocha": "^8.0.0"
+  }
+}

package/test/fixtures/mocha8/test-1.js

@@ -0,0 +1,14 @@
+/* globals describe it */
+
+const fixture = require('./')
+const assert = require('assert')
+
+describe('test suite 1', () => {
+  it('test case 1', () => {
+    assert.strictEqual(fixture, 'polendina test')
+  })
+
+  it('test case 2', () => {
+    assert.ok(true, 'all good')
+  })
+})

package/test/fixtures/mocha8/test-2.js

@@ -0,0 +1,19 @@
+/* globals describe it WorkerGlobalScope ServiceWorkerGlobalScope */
+
+const assert = require('assert')
+
+describe('test suite 2 - worker', () => {
+  if (typeof ServiceWorkerGlobalScope !== 'undefined' && global instanceof ServiceWorkerGlobalScope) {
+    it('is in serviceworker', () => {
+      assert.strictEqual(typeof ServiceWorkerGlobalScope, 'function')
+    })
+  } else if (typeof WorkerGlobalScope !== 'undefined' && global instanceof WorkerGlobalScope) {
+    it('is in worker', () => {
+      assert.strictEqual(typeof WorkerGlobalScope, 'function')
+    })
+  } else {
+    it('is not in worker', () => {
+      assert.strictEqual(typeof WorkerGlobalScope, 'undefined')
+    })
+  }
+})

package/test/fixtures/mocha8/test-3.js

@@ -0,0 +1,14 @@
+/* globals describe it */
+
+const fixture = require('./')
+const assert = require('assert')
+
+describe('test suite 3', () => {
+  it('test case 1', () => {
+    assert.strictEqual(fixture, 'polendina test')
+  })
+
+  it('test case 2', () => {
+    assert.ok(true, 'all good')
+  })
+})

package/test/fixtures/tape/package.json

@@ -13,6 +13,6 @@
     "url": "https://github.com/rvagg/polendina.git"
   },
   "devDependencies": {
-    "tape": "^4.12.1"
+    "tape": "^5.0.1"
   }
 }

package/test/fixtures/tape-failure/package.json

@@ -13,6 +13,6 @@
     "url": "https://github.com/rvagg/polendina.git"
   },
   "devDependencies": {
-    "tape": "^4.12.1"
+    "tape": "^5.0.1"
   }
 }

package/test/fixtures/webpack-merge/index.js

@@ -0,0 +1 @@
+module.exports = 'bare test fixture'

package/test/fixtures/webpack-merge/package.json

@@ -0,0 +1,15 @@
+{
+  "name": "fixture-webpack-merge",
+  "version": "1.0.0",
+  "description": "test fixture",
+  "main": "index.js",
+  "scripts": {
+    "test": "node test.js"
+  },
+  "author": "Rod <rod@vagg.org> (http://r.va.gg/)",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/rvagg/polendina.git"
+  },
+  "license": "Apache-2.0"
+}

package/test/fixtures/webpack-merge/test.js

@@ -0,0 +1,7 @@
+const assert = require('assert')
+const qs = require('querystring')
+
+assert.strictEqual(typeof assert.ok, 'function')
+console.log('assert.ok() is a function')
+assert.strictEqual(typeof qs.parse, 'function')
+console.log('querystring.parse() is a function')

package/test/fixtures/webpack-merge/webpack.config.js

@@ -0,0 +1,5 @@
+module.exports = {
+  node: {
+    querystring: 'empty'
+  }
+}

package/test/test-tape.js

@@ -13,15 +13,15 @@ describe('basic tape', function () {
 TAP version 13
 # test suite 1
 # test case 1
-ok 1 should be equal
+ok 1 should be strictly equal
 # test case 2
 ok 2 all good
 # test suite 2 - worker
 # is WORKER
-ok 3 should be equal
+ok 3 should be strictly equal
 # test suite 3
 # test case 1
-ok 4 should be equal
+ok 4 should be strictly equal
 # test case 2
 ok 5 all good
 
@@ -80,7 +80,7 @@ describe('failing tape', function () {
 TAP version 13
 # test suite 1 - worker
 # is WORKER
-ok 1 should be equal
+ok 1 should be strictly equal
 # test suite 2 - failure
 # test case 1
 not ok 2 bork

package/test/test-webpack-merge.js

@@ -0,0 +1,36 @@
+/* globals describe it */
+
+const assert = require('assert')
+const path = require('path')
+const { runCli } = require('./common')
+
+const webpackMergeFixture = path.join(__dirname, 'fixtures/webpack-merge')
+
+describe('basic webpack-merge', function () {
+  this.timeout(20000)
+  it('should run plain', async () => {
+    const expected = `
+assert.ok() is a function
+querystring.parse() is a function
+  ✔ test.js
+`
+    const { stdout, code } = await runCli(webpackMergeFixture, '--runner=bare-sync')
+    assert.strictEqual(code, 0, 'exited with zero exit code')
+    assert.ok(stdout.includes(expected), 'stdout contains expected test output')
+    assert.ok(stdout.includes('Running bare-sync page tests with Puppeteer'), 'stdout contains expected output for running in page')
+  })
+
+  it('should fail with custom config', async () => {
+    const expectedStdout = `
+assert.ok() is a function
+  ✘ test.js
+`
+    const expectedStderr = '\'undefined\' === \'function\''
+
+    const { stdout, stderr, code } = await runCli(webpackMergeFixture, '--runner=bare-sync --webpack-config webpack.config.js')
+    assert.strictEqual(code, 1, 'exited with zero exit code')
+    assert.ok(stdout.includes(expectedStdout), 'stdout contains expected test output')
+    assert.ok(stderr.includes(expectedStderr), 'stderr contains expected test output')
+    assert.ok(stdout.includes('Running bare-sync page tests with Puppeteer'), 'stdout contains expected output for running in page')
+  })
+})

package/.github/workflows/main.yml

@@ -1,21 +0,0 @@
-name: CI
-
-on: [push, pull_request]
-
-jobs:
-  build:
-
-    runs-on: ubuntu-latest
-
-    steps:
-    - name: Checkout
-      uses: actions/checkout@v1
-      with:
-        fetch-depth: 1
-
-    - name: Install and test
-      uses: actions/setup-node@v1
-      with:
-        node-version: '12.x'
-    - run: npm install
-    - run: npm test