Move to a modern testing infrastructure

Use Jest as test framework, and restructured ESLint config files so it applies to each directory separately.

Author: ishitatsuyuki

.eslintrc-node.js renamed to .eslintrc.js

@@ -19,6 +19,8 @@ module.exports = {
     "camelcase": "off",
     "no-var": "error",
     "prefer-const": "error",
+    "array-bracket-spacing": ["error", "always", {"objectsInArrays": false}],
+    "object-curly-spacing": ["error", "always"],
 
     // Override some eslint base rules because we're using node.
     "no-console": "off",

lib/__mocks__/db.js

@@ -0,0 +1,15 @@
+let store = {};
+
+exports.get = function (key, defaultValue) {
+  if (!store[key]) {
+    store[key] = defaultValue || {};
+  }
+
+  return store[key];
+};
+
+exports.save = () => {};
+
+exports.__setData = (newStore) => {
+  store = Object.assign({}, newStore);
+};

lib/blog.js

@@ -94,7 +94,7 @@ exports.synchronize = async function () {
   blog.topics = await Promise.all(topicsPromises);
   const now = Date.now();
   metrics.set(blog, 'updated', now);
-  metrics.push(blog, 'pull-time', [now, now - time]);
+  metrics.push(blog, 'pull-time', [ now, now - time ]);
   db.save();
   return { count: topics.length };
 };

lib/proxy-heuristics.js

@@ -26,7 +26,7 @@ exports.handleProxyUrls = function (request, response, next) {
   // Look for a container ID and port in `request.url`.
   let match = exports.proxyUrlPrefix.exec(request.url);
   if (match) {
-    [url, containerId, port, path] = match;
+    [ url, containerId, port, path ] = match;
 
     // We want the proxied `path` to always begin with a '/'.
     // However `path` is empty in URLs like '/abc123/8080?p=1', so we redirect
@@ -52,7 +52,7 @@ exports.handleProxyUrls = function (request, response, next) {
     const referer = nodeurl.parse(request.headers.referer);
     match = exports.proxyUrlPrefix.exec(referer.pathname);
     if (match) {
-      [url, containerId, port, path] = match;
+      [ url, containerId, port, path ] = match;
     }
   }
 

lib/sessions.js

@@ -7,7 +7,7 @@ const db = require('./db');
 const log = require('./log');
 
 const login = new EmailLogin({
-  db: './tokens/',
+  db: db.get('tokens', './tokens/'),
   mailer: db.get('mailer')
 });
 const useSecureCookies = !db.get('security').forceInsecure;

package.json

@@ -18,14 +18,14 @@
   "scripts": {
     "app": "SCRIPT=app npm start",
     "join": "SCRIPT=join npm start",
-    "lint": "eslint -c .eslintrc-node.js *.js api/ lib/ && eslint -c .eslintrc-browser.js static/",
-    "lint-fix": "eslint -c .eslintrc-node.js *.js api/ lib/ --fix && eslint -c .eslintrc-browser.js static/ --fix",
+    "lint": "eslint *.js api/ lib/ test/ static/",
+    "lint-fix": "eslint *.js api/ lib/ test/ static/ --fix",
     "rebase": "git pull -q --rebase origin master && git submodule -q update --rebase && npm update",
     "prestart": "npm stop && touch janitor.log janitor.pid && chmod 600 janitor.log janitor.pid",
     "start": "if [ -z \"$SCRIPT\" ] ; then printf \"Run which Janitor script? [join/app]:\" && read SCRIPT ; fi ; node \"$SCRIPT\" >> janitor.log 2>&1 & printf \"$!\\n\" > janitor.pid",
     "poststart": "printf \"[$(date -uIs)] Background process started (PID $(cat janitor.pid), LOGS $(pwd)/janitor.log).\\n\"",
     "stop": "if [ -e janitor.pid -a -n \"$(ps h $(cat janitor.pid))\" ] ; then kill $(cat janitor.pid) && printf \"[$(date -uIs)] Background process stopped (PID $(cat janitor.pid)).\\n\" ; fi ; rm -f janitor.pid",
-    "test": "cd tests && node tests.js",
+    "test": "jest",
     "prewatch": "touch janitor.log && chmod 600 janitor.log",
     "watch": "watch-run --initial --pattern 'app.js,package.json,api/**,lib/**,templates/**' --stop-on-error npm run app & tail -f janitor.log -n 0"
   },
@@ -52,6 +52,7 @@
     "eslint-plugin-node": "^6.0.0",
     "eslint-plugin-promise": "^3.5.0",
     "eslint-plugin-standard": "^3.0.1",
+    "jest": "^22.4.3",
     "watch-run": "^1.2.5"
   },
   "engines": {

.eslintrc-browser.js renamed to static/.eslintrc.js

@@ -0,0 +1,8 @@
+module.exports = {
+  "env": {
+    "jest": true
+  },
+  "extends": [
+    "../.eslintrc.js"
+  ]
+};

test/.eslintrc.js

@@ -0,0 +1,134 @@
+// Copyright © 2017 Jan Keromnes. All rights reserved.
+// The following code is covered by the AGPL-3.0 license.
+
+'use strict';
+
+const { Camp } = require('camp');
+const selfapi = require('selfapi');
+const stream = require('stream');
+const { promisify } = require('util');
+
+describe('Janitor API self-tests', () => {
+  jest.mock('../lib/boot');
+  jest.mock('../lib/db');
+  jest.mock('../lib/docker');
+
+  const db = require('../lib/db');
+  db.__setData({
+    // Tell our fake Janitor app that it runs on the fake host "example.com"
+    hostname: 'example.com',
+    // Disable sending any emails (for invites or signing in)
+    mailer: {
+      block: true
+    },
+    security: {
+      // Disable Let's Encrypt HTTPS certificate generation and verification
+      forceHttp: true,
+      // Disable any security policies that could get in the way of testing
+      forceInsecure: true
+    },
+    tokens: 'test/tokens'
+  });
+
+  const boot = require('../lib/boot');
+  boot.ensureDockerTlsCertificates.mockResolvedValue();
+
+  const docker = require('../lib/docker');
+  const hosts = require('../lib/hosts');
+  const machines = require('../lib/machines');
+  const users = require('../lib/users');
+
+  // Fake several Docker methods for testing.
+  // TODO Maybe use a real Docker Remote API server (or a full mock) for more
+  // realistic tests?
+  docker.pullImage.mockImplementation((parameters) => {
+    const readable = new stream.Readable();
+    readable.push('ok');
+    readable.push(null); // End the stream.
+    return Promise.resolve(readable);
+  });
+  docker.inspectImage.mockResolvedValue({ Created: 1500000000000 });
+  docker.tagImage.mockResolvedValue();
+  docker.runContainer.mockResolvedValue({ container: { id: 'abcdef0123456789' }, logs: '' });
+  docker.copyIntoContainer.mockResolvedValue();
+  docker.execInContainer.mockResolvedValue();
+  docker.listChangedFilesInContainer.mockResolvedValue([
+    { Path: '/tmp', Kind: 0 },
+    { Path: '/tmp/test', Kind: 1 }
+  ]);
+  docker.version.mockResolvedValue({ Version: '17.06.0-ce' });
+
+  const api = require('../api/');
+
+  const app = new Camp({
+    documentRoot: 'static'
+  });
+
+  beforeAll(async () => {
+    function registerTestUser () {
+      // Grant administrative privileges to the fake email "[email protected]".
+      db.get('admins')['[email protected]'] = true;
+      // Create the user "[email protected]" by "sending" them an invite email.
+      return promisify(users.sendInviteEmail)('[email protected]');
+    }
+
+    function createTestHost () {
+      return promisify(hosts.create)('example.com', {});
+    }
+
+    function createTestProject () {
+      machines.setProject({
+        'id': 'test-project',
+        '/name': 'Test Project',
+        '/docker/host': 'example.com',
+        '/docker/image': 'image:latest',
+      });
+    }
+
+    function createTestContainer () {
+      const user = db.get('users')['[email protected]'];
+      // Create a new user machine for the project "test-project".
+      return machines.spawn(user, 'test-project');
+    }
+
+    await Promise.all([
+      registerTestUser(),
+      createTestHost(),
+      createTestProject(),
+    ]);
+    await createTestContainer();
+
+    // Authenticate test requests with a server middleware.
+    const sessions = require('../lib/sessions');
+    app.handle((request, response, next) => {
+      sessions.get(request, (error, session, token) => {
+        if (error || !session || !session.id) {
+          console.error('[fail] session:', session, error);
+          response.statusCode = 500; // Internal Server Error
+          response.end();
+          return;
+        }
+        request.session = session;
+        if (!('client_secret' in request.query)) {
+          request.user = db.get('users')['[email protected]'];
+        }
+        next();
+      });
+    });
+
+    // Mount the Janitor API.
+    selfapi(app, '/api', api);
+
+    await promisify(app.listen).call(app, 0, '127.0.0.1');
+  });
+
+  afterAll(() => {
+    return promisify(app.close).call(app);
+  });
+
+  it('follows API examples', async () => {
+    const { passed, failed } = await promisify(api.test).call(api, `http://127.0.0.1:${app.address().port}`);
+    console.info(`${passed.length} passed, ${failed.length} failed`);
+    expect(failed).toHaveLength(0);
+  });
+});