@apolitical/testing 0.0.4 → 1.0.0-beta.0

package/CHANGELOG.md

@@ -5,6 +5,12 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.0.0] - 2022-01-19
+### Changed
+- Updated Dependencies
+- Upgraded Node.js version
+- Revamped GitLab pipelines
+
 ## [0.0.4] - 2021-09-03
 ### Changed
 - Pass in cookies to a new request helper

package/README.md

@@ -1,6 +1,17 @@
 # Apolitical Testing
 
 Node.js module to encapsulate Jest testing helpers (backend)
+
+## Requirements
+
+Requires the following to run:
+
+- [node.js][node] 16.13.2+
+- [yarn][yarn]
+
+[node]: https://nodejs.org/en/download/
+[yarn]: https://classic.yarnpkg.com/en/docs/install
+
 ## Installation
 
 Install with `yarn`:
@@ -29,4 +40,10 @@ Then, you can use your express app to generate supertests agents:
 const agents = instance.generateAgents(app);
 ```
 
-The agents are `loggedIn`, `loggedOut`, `loggedInAdmin` and `loggedInMyself`. The `loggedInMyself` agent can also be updated with custome token payload with the use of the `assignTokenToMyself` function.
+The agents are:
+- `loggedIn`
+- `loggedOut`
+- `loggedInAdmin`
+- `loggedInMyself`
+
+The `loggedInMyself` agent can also be updated with custome token payload with the use of the `assignTokenToMyself` function.

package/package.json

@@ -1,19 +1,13 @@
 {
   "name": "@apolitical/testing",
-  "version": "0.0.4",
+  "version": "1.0.0-beta.0",
   "description": "Node.js module to encapsulate Jest testing helpers (backend)",
   "author": "Apolitical Group Limited <engineering@apolitical.co>",
-  "contributors": [
-    "Anouska Hopkins <anouska.hopkins@apolitical.co>",
-    "Antonio Cordasco <antonio.cordasco@apolitical.co>",
-    "Dorothy Yau <dorothy.yau@apolitical.co>",
-    "Laura Hanna-White <laura.hanna-white@apolitical.co>",
-    "Fatimat Gbajabiamila <fatimat.gbajabiamila@apolitical.co>",
-    "Renzo Rozza <renzo.rozza@apolitical.co>",
-    "Rihards Jukna <rihards.jukna@apolitical.co>"
-  ],
   "license": "MIT",
-  "main": "index.js",
+  "main": "src/index.js",
+  "files": [
+    "src"
+  ],
   "scripts": {
     "test": "jest --bail --runInBand",
     "integration-test": "jest --bail --runInBand",
@@ -30,19 +24,20 @@
     "Node Modules"
   ],
   "dependencies": {
-    "awilix": "5.0.1",
-    "jsrsasign": "10.4.0",
-    "supertest": "6.1.6"
+    "awilix": "6.0.0",
+    "jsrsasign": "10.5.1",
+    "supertest": "6.2.2"
   },
   "devDependencies": {
-    "@apolitical/eslint-config": "0.0.1",
-    "audit-ci": "4.1.0",
-    "husky": "7.0.2",
-    "jest": "27.1.0",
-    "lint-staged": "11.1.2"
+    "@apolitical/eslint-config": "1.0.0-beta.0",
+    "audit-ci": "5.1.2",
+    "husky": "7.0.4",
+    "jest": "27.4.7",
+    "jest-junit": "13.0.0",
+    "lint-staged": "12.2.0"
   },
   "engines": {
-    "node": ">=12.20.1"
+    "node": ">=16.13.2"
   },
   "eslintConfig": {
     "extends": "@apolitical/eslint-config/base.config"
@@ -67,7 +62,12 @@
     "testEnvironment": "node",
     "testTimeout": 60000,
     "maxConcurrency": 1,
-    "maxWorkers": 1
+    "maxWorkers": 1,
+    "reporters": [
+      "default",
+      "jest-junit"
+    ],
+    "testResultsProcessor": "jest-junit"
   },
   "lint-staged": {
     "*.js": "eslint --cache --fix --ignore-path .gitignore",

package/{index.js → src/index.js}

@@ -1,6 +1,6 @@
 'use strict';
 
-const { resolve } = require('./src/container');
+const { resolve } = require('./container');
 
 const requestHelper = resolve('requestHelper');
 const stubHelper = resolve('stubHelper');

package/.gitlab-ci.yml

@@ -1,22 +0,0 @@
-# External jobs
-include:
-  - project: 'apolitical/templates/gitlab-pipelines'
-    ref: master
-    file: 'Node-Testing.gitlab-ci.yml'
-
-stages:
-  - cache
-  - test
-  - publish
-
-publish-module:
-  stage: publish
-  image: node:12.20.1-alpine3.11
-  extends: 
-    - .use-cache
-  only:
-    - tags
-    - /^v\d+\.\d+\.\d+$/  
-  script:
-    - echo '//registry.npmjs.org/:_authToken=${NPM_TOKEN}' > ~/.npmrc
-    - yarn publish --access=public

package/.husky/pre-commit

@@ -1,6 +0,0 @@
-#!/bin/sh
-. "$(dirname "$0")/_/husky.sh"
-
-yarn lint-format
-
-yarn test

package/test/__snapshots__/request.spec.js.snap

@@ -1,42 +0,0 @@
-// Jest Snapshot v1, https://goo.gl/fbAQLP
-
-exports[`Request Helper Generate Agents should encode logged in and logged in admin tokens 1`] = `
-Array [
-  Array [
-    "HS256",
-    Object {
-      "alg": "HS256",
-      "typ": "JWT",
-    },
-    Object {
-      "admin": true,
-      "email": "apolitical.testing@email.com",
-      "exp": 2592000,
-      "iss": "apolitical-testing",
-      "name": "Apolitical Testing",
-      "role": "public-servant",
-      "slug": "apolitical-testing",
-      "sub": "login",
-    },
-    "some-session-secret",
-  ],
-  Array [
-    "HS256",
-    Object {
-      "alg": "HS256",
-      "typ": "JWT",
-    },
-    Object {
-      "admin": true,
-      "email": "apolitical.testing@email.com",
-      "exp": 2592000,
-      "iss": "apolitical-testing",
-      "name": "Apolitical Testing",
-      "role": "administrator",
-      "slug": "apolitical-testing",
-      "sub": "login",
-    },
-    "some-session-secret",
-  ],
-]
-`;

package/test/container.js

@@ -1,31 +0,0 @@
-'use strict';
-
-// External Modules
-const { createContainer, asValue, asFunction } = require('awilix');
-// Configuration
-const config = require('../src/config');
-// Helpers
-const jwtHelper = require('../src/helpers/jwt.helper');
-const requestHelper = require('../src/helpers/request.helper');
-// Stubs
-const { stubs: jsrsasignStubs, jsrsasign } = require('./stubs/jsrsasign.stub');
-const { stubs: supertestStubs, supertest } = require('./stubs/supertest.stub');
-
-const container = createContainer();
-container.register({
-  // External Modules
-  jsrsasign: asValue(jsrsasign),
-  supertest: asValue(supertest),
-  // Configuration
-  config: asValue(config),
-  // Helpers
-  jwtHelper: asFunction(jwtHelper).singleton(),
-  requestHelper: asFunction(requestHelper).singleton(),
-  // Stubs
-  stubs: asValue({
-    ...jsrsasignStubs,
-    ...supertestStubs,
-  }),
-});
-
-module.exports = container;

package/test/request.spec.js

@@ -1,77 +0,0 @@
-'use strict';
-
-const { resolve } = require('./container');
-// Helpers
-const requestHelper = resolve('requestHelper');
-// Stubs
-const { agent, set, sign } = resolve('stubs');
-
-describe('Request Helper', () => {
-  const sessionSecret = 'some-session-secret';
-
-  describe('General', () => {
-    test('should be exposed as function', () => {
-      expect(typeof requestHelper).toBe('function');
-    });
-
-    test('should throw an error when no session secret is defined', () => {
-      expect(() => {
-        requestHelper();
-      }).toThrow('Cannot create request helper without session secret');
-    });
-
-    test('should return genearte agents function', () => {
-      const instance = requestHelper({ sessionSecret });
-      expect(typeof instance.generateAgents).toBe('function');
-    });
-  });
-
-  describe('Generate Agents', () => {
-    const app = {};
-    let instance = null;
-
-    beforeEach(() => {
-      // Mock agent
-      agent.mockReturnValue({ set });
-
-      // Fixed expiration
-      Date.now = jest.fn();
-      Date.now.mockReturnValue(0);
-
-      // Create request instance
-      instance = requestHelper({ sessionSecret });
-    });
-
-    test('should encode logged in and logged in admin tokens', () => {
-      instance.generateAgents(app);
-      expect(sign).toHaveBeenCalledTimes(2);
-      expect(set).toHaveBeenCalledTimes(2);
-      expect(sign.mock.calls).toMatchSnapshot();
-    });
-
-    test('should create agents', () => {
-      instance.generateAgents(app);
-      expect(agent).toHaveBeenCalledTimes(4);
-    });
-
-    test('should expose agents', () => {
-      const { loggedIn, loggedOut, loggedInAdmin, loggedInMyself } = instance.generateAgents(app);
-      expect(typeof loggedIn).not.toBeUndefined();
-      expect(typeof loggedOut).not.toBeUndefined();
-      expect(typeof loggedInAdmin).not.toBeUndefined();
-      expect(typeof loggedInMyself).not.toBeUndefined();
-    });
-
-    test('should expose assign token to myself functions', () => {
-      const { assignTokenToMyself, assignTokenToMyselfWithCookies } = instance.generateAgents(app);
-      expect(typeof assignTokenToMyself).toBe('function');
-      expect(typeof assignTokenToMyselfWithCookies).toBe('function');
-    });
-
-    test('should throw an error when no express app is defined', () => {
-      expect(() => {
-        instance.generateAgents();
-      }).toThrow('Cannot generate agents without express app');
-    });
-  });
-});

package/test/stubs/jsrsasign.stub.js

@@ -1,7 +0,0 @@
-'use strict';
-
-const sign = jest.fn();
-
-const stubs = { sign };
-
-module.exports = { stubs, jsrsasign: { jws: { JWS: { sign } } } };

package/test/stubs/supertest.stub.js

@@ -1,8 +0,0 @@
-'use strict';
-
-const agent = jest.fn();
-const set = jest.fn();
-
-const stubs = { agent, set };
-
-module.exports = { stubs, supertest: { agent } };