Merge pull request #57 from ianwalter/v2-dev

v2 dev

Author: Ian Walter

.github/main.workflow

@@ -0,0 +1,16 @@
+name: CI
+on: push
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    container:
+      image: node:12.10-slim
+    steps:
+      - name: Checkout
+        uses: actions/checkout@master
+      - name: Install
+        run: yarn
+      - name: Lint
+        run: yarn lint
+      - name: Test
+        run: yarn test

.github/workflows/ci.yml

@@ -1,7 +1,9 @@
 # @ianwalter/test-server
-> Easily create a minimal [Koa][koaUrl] server for testing
+> Easily create a minimal [Koa][koaUrl] or [Express][expressUrl] server for
+> testing
 
 [![npm page][npmImage]][npmUrl]
+[![CI][ciImage]][ciUrl]
 
 ## About
 
@@ -17,12 +19,13 @@ yarn add @ianwalter/test-server --dev
 
 ```js
 const { test } = require('@ianwalter/bff')
-const createTestServer = require('@ianwalter/test-server')
+const { createKoaServer } = require('@ianwalter/test-server')
+const { requester } = require('@ianwalter/requester')
 
-test('got', ({ expect }) => {
-  const server = await createTestServer()
+test('requester', ({ expect }) => {
+  const server = await createKoaServer()
   server.use(ctx => (ctx.body = 'Hello World!'))
-  const response = await got(server.url)
+  const response = await requester.get(server.url)
   expect(response.body).toBe('Hello World!')
   await server.close()
 })
@@ -36,8 +39,11 @@ Apache 2.0 with Commons Clause - See [LICENSE][licenseUrl]
 
 Created by [Ian Walter](https://iankwalter.com)
 
+[koaUrl]: https://github.com/koajs/koa
+[expressUrl]: https://expressjs.com/
 [npmImage]: https://img.shields.io/npm/v/@ianwalter/test-server.svg
 [npmUrl]: https://www.npmjs.com/package/@ianwalter/test-server
-[koaUrl]: https://github.com/koajs/koa
+[ciImage]: https://github.com/ianwalter/test-server/workflows/CI/badge.svg
+[ciUrl]: https://github.com/ianwalter/test-server/actions
 [ctsUrl]: https://github.com/lukechilds/create-test-server
 [licenseUrl]: https://github.com/ianwalter/test-server/blob/master/LICENSE

README.md

@@ -0,0 +1,53 @@
+const http = require('http')
+const express = require('express')
+const bodyParser = require('body-parser')
+const { print } = require('@ianwalter/print')
+const enableDestroy = require('server-destroy')
+
+const defaultOptions = { cors: false }
+
+module.exports = function createExpressServer (options = defaultOptions) {
+  // Create the Exoress app instance.
+  const app = express()
+
+  // Tell Express to parse requests with text content-type bodies.
+  app.use(bodyParser.text())
+
+  // Tell Express to parse requests with application/json content-type bodies.
+  app.use(bodyParser.json())
+
+  // Add error-handling middleware.
+  app.use(function errorHandlingMiddleware (err, req, res, next) {
+    print.error(err)
+    res.status(err.statusCode || err.status || 500)
+  })
+
+  // Create the server that will listen and execute the Koa app on all requests
+  // it receives.
+  const server = http.createServer(app)
+
+  // Add a destroy method to the server instance.
+  // https://github.com/nodejs/node/issues/2642
+  enableDestroy(server)
+
+  // Add a close method to the Koa app to allow the caller / receiver of the Koa
+  // app to close the server when done with it.
+  app.close = function close () {
+    return new Promise(resolve => server.destroy(resolve))
+  }
+
+  // Return the Koa app instance when the server has started listening.
+  return new Promise((resolve, reject) => {
+    server.listen(process.env.TEST_SERVER_PORT, err => {
+      if (err) {
+        reject(err)
+      } else {
+        // Add the server's port and URL to the app so it's easily accessible.
+        app.port = server.address().port
+        app.url = `http://localhost:${app.port}`
+
+        resolve(app)
+      }
+    })
+  })
+}

express.js

@@ -1,69 +1,4 @@
-const http = require('http')
-const Koa = require('koa')
-const json = require('koa-json')
-const { print } = require('@ianwalter/print')
-const enableDestroy = require('server-destroy')
-const bodyParser = require('koa-bodyparser')
+const createKoaServer = require('./koa')
+const createExpressServer = require('./express')
 
-const defaultOptions = { cors: false }
-
-module.exports = function createTestServer (options = defaultOptions) {
-  // Create the Koa app instance.
-  const app = new Koa()
-
-  // Add the bodyparser middleware that can parse a request body into json, etc.
-  app.use(bodyParser({ enableTypes: ['json', 'form', 'text'] }))
-
-  // Add error-handling middleware.
-  app.use(async function errorHandlingMiddleware (ctx, next) {
-    try {
-      await next()
-    } catch (err) {
-      print.error(err)
-      ctx.status = err.statusCode || err.status || 500
-      ctx.app.emit('error', err, ctx)
-    }
-  })
-
-  // Use middleware that automatically pretty-prints JSON responses.
-  app.use(json())
-
-  // If CORS is disabled, add the Access-Control-Allow-Origin header that
-  // accepts all requests to the response.
-  if (!options.cors) {
-    app.use(async function disableCorsMiddleware (ctx, next) {
-      ctx.set('Access-Control-Allow-Origin', '*')
-      ctx.set('Access-Control-Allow-Headers', '*')
-      return next()
-    })
-  }
-
-  // Create the server that will listen and execute the Koa app on all requests
-  // it receives.
-  const server = http.createServer(app.callback())
-
-  // Add a destroy method to the server instance.
-  // https://github.com/nodejs/node/issues/2642
-  enableDestroy(server)
-
-  // Add a close method to the Koa app to allow the caller / receiver of the Koa
-  // app to close the server when done with it.
-  app.close = function close () {
-    return new Promise(resolve => server.destroy(resolve))
-  }
-
-  // Return the Koa app instance when the server has started listening.
-  return new Promise((resolve, reject) => {
-    server.listen(process.env.TEST_SERVER_PORT, err => {
-      if (err) {
-        reject(err)
-      } else {
-        // Add the server's port and URL to the app so it's easily accessible.
-        app.port = server.address().port
-        app.url = `http://localhost:${app.port}`
-
-        resolve(app)
-      }
-    })
-  })
-}
+module.exports = { createKoaServer, createExpressServer }

index.js

@@ -0,0 +1,69 @@
+const http = require('http')
+const Koa = require('koa')
+const json = require('koa-json')
+const { print } = require('@ianwalter/print')
+const enableDestroy = require('server-destroy')
+const bodyParser = require('koa-bodyparser')
+
+const defaultOptions = { cors: false }
+
+module.exports = function createKoaServer (options = defaultOptions) {
+  // Create the Koa app instance.
+  const app = new Koa()
+
+  // Add error-handling middleware.
+  app.use(async function errorHandlingMiddleware (ctx, next) {
+    try {
+      await next()
+    } catch (err) {
+      print.error(err)
+      ctx.status = err.statusCode || err.status || 500
+      ctx.app.emit('error', err, ctx)
+    }
+  })
+
+  // Add the bodyparser middleware that can parse a request body into json, etc.
+  app.use(bodyParser({ enableTypes: ['json', 'form', 'text'] }))
+
+  // Use middleware that automatically pretty-prints JSON responses.
+  app.use(json())
+
+  // If CORS is disabled, add the Access-Control-Allow-Origin header that
+  // accepts all requests to the response.
+  if (!options.cors) {
+    app.use(async function disableCorsMiddleware (ctx, next) {
+      ctx.set('Access-Control-Allow-Origin', '*')
+      ctx.set('Access-Control-Allow-Headers', '*')
+      return next()
+    })
+  }
+
+  // Create the server that will listen and execute the Koa app on all requests
+  // it receives.
+  const server = http.createServer(app.callback())
+
+  // Add a destroy method to the server instance.
+  // https://github.com/nodejs/node/issues/2642
+  enableDestroy(server)
+
+  // Add a close method to the Koa app to allow the caller / receiver of the Koa
+  // app to close the server when done with it.
+  app.close = function close () {
+    return new Promise(resolve => server.destroy(resolve))
+  }
+
+  // Return the Koa app instance when the server has started listening.
+  return new Promise((resolve, reject) => {
+    server.listen(process.env.TEST_SERVER_PORT, err => {
+      if (err) {
+        reject(err)
+      } else {
+        // Add the server's port and URL to the app so it's easily accessible.
+        app.port = server.address().port
+        app.url = `http://localhost:${app.port}`
+
+        resolve(app)
+      }
+    })
+  })
+}

koa.js

@@ -1,7 +1,7 @@
 {
   "name": "@ianwalter/test-server",
   "version": "1.4.3",
-  "description": "Easily create a minimal [Koa][koaUrl] server for testing",
+  "description": "Easily create a minimal Koa or Express server for testing",
   "license": "SEE LICENSE IN LICENSE",
   "main": "index.js",
   "repository": {
@@ -15,22 +15,27 @@
     "koa",
     "testing",
     "unit",
-    "mock"
+    "mock",
+    "express"
   ],
   "author": "Ian Walter <public@iankwalter.com> (https://iankwalter.com)",
   "bugs": {
     "url": "https://github.com/ianwalter/test-server/issues"
   },
   "homepage": "https://github.com/ianwalter/test-server#readme",
   "files": [
-    "index.js"
+    "index.js",
+    "koa.js",
+    "express.js"
   ],
   "scripts": {
-    "lint": "eslint index.js tests",
+    "lint": "eslint .",
     "test": "bff"
   },
   "dependencies": {
     "@ianwalter/print": "^3.2.0",
+    "body-parser": "^1.19.0",
+    "express": "^4.17.1",
     "koa": "^2.8.1",
     "koa-bodyparser": "^4.2.1",
     "koa-json": "^2.0.2",
@@ -42,7 +47,7 @@
     "@ianwalter/puppeteer-helper": "^4.0.0",
     "@ianwalter/release": "^3.0.3",
     "@ianwalter/renovate-config": "^1.2.0",
-    "r2": "^2.0.1"
+    "@ianwalter/requester": "^1.2.0"
   },
   "eslintConfig": {
     "root": true,

package.json

@@ -0,0 +1,58 @@
+const { test } = require('@ianwalter/bff')
+const { requester } = require('@ianwalter/requester')
+const { createExpressServer } = require('..')
+
+test('Express server created', async ({ expect }) => {
+  const server = await createExpressServer()
+  expect(server.port).toBeGreaterThan(0)
+  expect(server.url).toBeTruthy()
+  await server.close()
+})
+
+test('Express request handler', async ({ expect }) => {
+  const server = await createExpressServer()
+  const msg = 'Nobody Lost, Nobody Found'
+  server.use((req, res) => res.send(msg))
+  const { body } = await requester.get(server.url)
+  expect(body).toBe(msg)
+  await server.close()
+})
+
+test('Express json response', async ({ expect }) => {
+  const server = await createExpressServer()
+  server.use((req, res) => res.json({ name: 'Out There On the Ice' }))
+  const { body } = await requester.get(server.url)
+  expect(body).toMatchSnapshot()
+  await server.close()
+})
+
+test('Express json request', async ({ expect }) => {
+  const server = await createExpressServer()
+  server.use((req, res) => res.json(req.body))
+  const body = { name: 'When Am I Gonna Lose You' }
+  const response = await requester.post(server.url, { body })
+  expect(response.body).toEqual(body)
+  await server.close()
+})
+
+test.skip('Express cors', async (t, page) => {
+  const server = await createExpressServer()
+  server.use(ctx => (ctx.body = 'Moments'))
+  const result = await page.evaluate(
+    url => window.fetch(url).then(response => response.text()),
+    server.url
+  )
+  t.is(result, 'Moments')
+})
+
+test('Express error', async ({ pass }) => {
+  const server = await createExpressServer()
+  server.use((req, res, next) => next(new Error('Test Error')))
+  try {
+    await requester.get(server.url)
+  } catch (err) {
+    pass()
+  } finally {
+    await server.close()
+  }
+})