@depup/supertest 7.2.2-depup.0

package/lib/test.js

@@ -0,0 +1,403 @@
+'use strict';
+
+/**
+ * Module dependencies.
+ */
+
+const { inspect } = require('util');
+const http = require('http');
+const { STATUS_CODES } = require('http');
+const { Server } = require('tls');
+const { deepStrictEqual } = require('assert');
+const { Request } = require('superagent');
+let http2;
+try {
+  http2 = require('http2'); // eslint-disable-line global-require
+} catch (_) {
+  // eslint-disable-line no-empty
+}
+
+/** @typedef {import('superagent').Response} Response */
+
+class Test extends Request {
+  /**
+   * Initialize a new `Test` with the given `app`,
+   * request `method` and `path`.
+   *
+   * @param {Server} app
+   * @param {String} method
+   * @param {String} path
+   * @api public
+   */
+  constructor (app, method, path, optHttp2) {
+    super(method.toUpperCase(), path);
+
+    if (typeof app === 'function') {
+      if (optHttp2) {
+        app = http2.createServer(app); // eslint-disable-line no-param-reassign
+      } else {
+        app = http.createServer(app); // eslint-disable-line no-param-reassign
+      }
+    }
+
+    this.redirects(0);
+    this.buffer();
+    this.app = app;
+    this._asserts = [];
+    this.url = typeof app === 'string'
+      ? app + path
+      : this.serverAddress(app, path);
+  }
+
+  /**
+   * Returns a URL, extracted from a server.
+   *
+   * @param {Server} app
+   * @param {String} path
+   * @returns {String} URL address
+   * @api private
+   */
+  serverAddress(app, path) {
+    const addr = app.address();
+
+    if (!addr) this._server = app.listen(0);
+    // } else {
+    //   this._server = app;
+    // }
+    const port = app.address().port;
+    const protocol = app instanceof Server ? 'https' : 'http';
+    return protocol + '://127.0.0.1:' + port + path;
+  }
+
+  /**
+   * Expectations:
+   *
+   *   .expect(200)
+   *   .expect(200, fn)
+   *   .expect(200, body)
+   *   .expect('Some body')
+   *   .expect('Some body', fn)
+   *   .expect(['json array body', { key: 'val' }])
+   *   .expect('Content-Type', 'application/json')
+   *   .expect('Content-Type', 'application/json', fn)
+   *   .expect(fn)
+   *   .expect([200, 404])
+   *
+   * @return {Test}
+   * @api public
+   */
+  expect(a, b, c) {
+    // callback
+    if (typeof a === 'function') {
+      this._asserts.push(wrapAssertFn(a));
+      return this;
+    }
+    if (typeof b === 'function') this.end(b);
+    if (typeof c === 'function') this.end(c);
+
+    // status
+    if (typeof a === 'number') {
+      this._asserts.push(wrapAssertFn(this._assertStatus.bind(this, a)));
+      // body
+      if (typeof b !== 'function' && arguments.length > 1) {
+        this._asserts.push(wrapAssertFn(this._assertBody.bind(this, b)));
+      }
+      return this;
+    }
+
+    // multiple statuses
+    if (Array.isArray(a) && a.length > 0 && a.every(val => typeof val === 'number')) {
+      this._asserts.push(wrapAssertFn(this._assertStatusArray.bind(this, a)));
+      return this;
+    }
+
+    // header field
+    if (typeof b === 'string' || typeof b === 'number' || b instanceof RegExp) {
+      this._asserts.push(wrapAssertFn(this._assertHeader.bind(this, { name: '' + a, value: b })));
+      return this;
+    }
+
+    // body
+    this._asserts.push(wrapAssertFn(this._assertBody.bind(this, a)));
+
+    return this;
+  }
+
+  /**
+   * Defer invoking superagent's `.end()` until
+   * the server is listening.
+   *
+   * @param {?Function} fn
+   * @api public
+   */
+  end(fn) {
+    const server = this._server;
+
+    super.end((err, res) => {
+      const localAssert = () => {
+        this.assert(err, res, fn);
+      };
+
+      if (server && server._handle) {
+        // Handle server closing with error handling for already closed servers
+        return server.close((closeError) => {
+          // Ignore ERR_SERVER_NOT_RUNNING errors as the server is already closed
+          if (closeError && closeError.code === 'ERR_SERVER_NOT_RUNNING') {
+            return localAssert();
+          }
+          // For other errors, pass them through
+          if (closeError) {
+            return localAssert();
+          }
+          localAssert();
+        });
+      }
+
+      localAssert();
+    });
+
+    return this;
+  }
+
+  /**
+   * Perform assertions and invoke `fn(err, res)`.
+   *
+   * @param {?Error} resError
+   * @param {Response} res
+   * @param {Function} fn
+   * @api private
+   */
+  assert(resError, res, fn) {
+    let errorObj;
+
+    // check for unexpected network errors or server not running/reachable errors
+    // when there is no response and superagent sends back a System Error
+    // do not check further for other asserts, if any, in such case
+    // https://nodejs.org/api/errors.html#errors_common_system_errors
+    const sysErrors = {
+      ECONNREFUSED: 'Connection refused',
+      ECONNRESET: 'Connection reset by peer',
+      EPIPE: 'Broken pipe',
+      ETIMEDOUT: 'Operation timed out'
+    };
+
+    if (!res && resError) {
+      if (resError instanceof Error && resError.syscall === 'connect'
+        && Object.getOwnPropertyNames(sysErrors).indexOf(resError.code) >= 0) {
+        errorObj = new Error(resError.code + ': ' + sysErrors[resError.code]);
+      } else {
+        errorObj = resError;
+      }
+    }
+
+    // asserts
+    for (let i = 0; i < this._asserts.length && !errorObj; i += 1) {
+      errorObj = this._assertFunction(this._asserts[i], res);
+    }
+
+    // set unexpected superagent error if no other error has occurred.
+    if (!errorObj && resError instanceof Error && (!res || resError.status !== res.status)) {
+      errorObj = resError;
+    }
+
+    if (fn) {
+      fn.call(this, errorObj || null, res);
+    }
+  }
+
+  /*
+    * Adds a set Authorization Bearer
+    *
+    * @param {Bearer} Bearer Token
+    * Shortcut for .set('Authorization', `Bearer ${token}`)
+    */
+
+  bearer(token) {
+    this.set('Authorization', `Bearer ${token}`);
+    return this;
+  }
+
+  /*
+    * Adds a set Authorization Bearer
+    *
+    * @param {Bearer} Bearer Token
+    * Shortcut for .set('Authorization', `Bearer ${token}`)
+    */
+
+  bearer(token) {
+    this.set('Authorization', `Bearer ${token}`);
+    return this;
+  }
+
+  /**
+   * Perform assertions on a response body and return an Error upon failure.
+   *
+   * @param {Mixed} body
+   * @param {Response} res
+   * @return {?Error}
+   * @api private
+   */// eslint-disable-next-line class-methods-use-this
+  _assertBody(body, res) {
+    const isRegexp = body instanceof RegExp;
+
+    // parsed
+    if (typeof body === 'object' && !isRegexp) {
+      try {
+        deepStrictEqual(body, res.body);
+      } catch (err) {
+        const a = inspect(body);
+        const b = inspect(res.body);
+        return error('expected ' + a + ' response body, got ' + b, body, res.body);
+      }
+    } else if (body !== res.text) {
+      // string
+      const a = inspect(body);
+      const b = inspect(res.text);
+
+      // regexp
+      if (isRegexp) {
+        if (!body.test(res.text)) {
+          return error('expected body ' + b + ' to match ' + body, body, res.body);
+        }
+      } else {
+        return error('expected ' + a + ' response body, got ' + b, body, res.body);
+      }
+    }
+  }
+
+  /**
+   * Perform assertions on a response header and return an Error upon failure.
+   *
+   * @param {Object} header
+   * @param {Response} res
+   * @return {?Error}
+   * @api private
+   */// eslint-disable-next-line class-methods-use-this
+  _assertHeader(header, res) {
+    const field = header.name;
+    const actual = res.header[field.toLowerCase()];
+    const fieldExpected = header.value;
+
+    if (typeof actual === 'undefined') return new Error('expected "' + field + '" header field');
+    // This check handles header values that may be a String or single element Array
+    if ((Array.isArray(actual) && actual.toString() === fieldExpected)
+      || fieldExpected === actual) {
+      return;
+    }
+    if (fieldExpected instanceof RegExp) {
+      if (!fieldExpected.test(actual)) {
+        return new Error('expected "' + field + '" matching '
+          + fieldExpected + ', got "' + actual + '"');
+      }
+    } else {
+      return new Error('expected "' + field + '" of "' + fieldExpected + '", got "' + actual + '"');
+    }
+  }
+
+  /**
+   * Perform assertions on the response status and return an Error upon failure.
+   *
+   * @param {Number} status
+   * @param {Response} res
+   * @return {?Error}
+   * @api private
+   */// eslint-disable-next-line class-methods-use-this
+  _assertStatus(status, res) {
+    if (res.status !== status) {
+      const a = STATUS_CODES[status];
+      const b = STATUS_CODES[res.status];
+      return new Error('expected ' + status + ' "' + a + '", got ' + res.status + ' "' + b + '"');
+    }
+  }
+
+  /**
+   * Perform assertions on the response status and return an Error upon failure.
+   *
+   * @param {Array<Number>} statusArray
+   * @param {Response} res
+   * @return {?Error}
+   * @api private
+   */// eslint-disable-next-line class-methods-use-this
+  _assertStatusArray(statusArray, res) {
+    if (!statusArray.includes(res.status)) {
+      const b = STATUS_CODES[res.status];
+      const expectedList = statusArray.join(', ');
+      return new Error(
+        'expected one of "' + expectedList + '", got ' + res.status + ' "' + b + '"'
+      );
+    }
+  }
+
+  /**
+   * Performs an assertion by calling a function and return an Error upon failure.
+   *
+   * @param {Function} fn
+   * @param {Response} res
+   * @return {?Error}
+   * @api private
+   */// eslint-disable-next-line class-methods-use-this
+  _assertFunction(fn, res) {
+    let err;
+    try {
+      err = fn(res);
+    } catch (e) {
+      err = e;
+    }
+    if (err instanceof Error) return err;
+  }
+}
+
+/**
+ * Wraps an assert function into another.
+ * The wrapper function edit the stack trace of any assertion error, prepending a more useful stack to it.
+ *
+ * @param {Function} assertFn
+ * @returns {Function} wrapped assert function
+ */
+
+function wrapAssertFn(assertFn) {
+  const savedStack = new Error().stack.split('\n').slice(3);
+
+  return function(res) {
+    let badStack;
+    let err;
+    try {
+      err = assertFn(res);
+    } catch (e) {
+      err = e;
+    }
+    if (err instanceof Error && err.stack) {
+      badStack = err.stack.replace(err.message, '').split('\n').slice(1);
+      err.stack = [err.toString()]
+        .concat(savedStack)
+        .concat('----')
+        .concat(badStack)
+        .join('\n');
+    }
+    return err;
+  };
+}
+
+/**
+ * Return an `Error` with `msg` and results properties.
+ *
+ * @param {String} msg
+ * @param {Mixed} expected
+ * @param {Mixed} actual
+ * @return {Error}
+ * @api private
+ */
+
+function error(msg, expected, actual) {
+  const err = new Error(msg);
+  err.expected = expected;
+  err.actual = actual;
+  err.showDiff = true;
+  return err;
+}
+
+/**
+ * Expose `Test`.
+ */
+
+module.exports = Test;

package/package.json

@@ -0,0 +1,57 @@
+{
+  "name": "@depup/supertest",
+  "description": "SuperAgent driven library for testing HTTP servers",
+  "version": "7.2.2-depup.0",
+  "author": "TJ Holowaychuk",
+  "contributors": [],
+  "dependencies": {
+    "methods": "^1.1.2",
+    "superagent": "^10.3.0",
+    "cookie-signature": "^1.2.2"
+  },
+  "devDependencies": {
+    "@commitlint/cli": "17",
+    "@commitlint/config-conventional": "17",
+    "body-parser": "^1.20.3",
+    "cookie-parser": "^1.4.7",
+    "eslint": "^8.32.0",
+    "eslint-config-airbnb-base": "^15.0.0",
+    "eslint-plugin-import": "^2.27.5",
+    "express": "^4.18.3",
+    "mocha": "^10.2.0",
+    "nock": "^13.3.8",
+    "nyc": "^15.1.0",
+    "proxyquire": "^2.1.3",
+    "should": "^13.2.3",
+    "sinon": "20.0.0"
+  },
+  "engines": {
+    "node": ">=14.18.0"
+  },
+  "files": [
+    "index.js",
+    "lib"
+  ],
+  "keywords": [
+    "bdd",
+    "http",
+    "request",
+    "superagent",
+    "tdd",
+    "test",
+    "testing"
+  ],
+  "license": "MIT",
+  "main": "index.js",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/ladjs/supertest.git"
+  },
+  "scripts": {
+    "coverage": "nyc report --reporter=text-lcov > coverage.lcov",
+    "lint": "eslint lib/**/*.js test/**/*.js index.js",
+    "lint:fix": "eslint --fix lib/**/*.js test/**/*.js index.js",
+    "pretest": "npm run lint --if-present",
+    "test": "nyc --reporter=html --reporter=text mocha --exit --require should --reporter spec --check-leaks"
+  }
+}