Update Enketo mock in testing

Author: matthew-white

test/integration/api/forms/draft.js

@@ -96,8 +96,8 @@ describe('api: /projects/:id/forms (drafts)', () => {
               .then(({ body }) => {
                 body.enketoId.should.equal('::abcdefgh');
                 should.not.exist(body.enketoOnceId);
-                global.enketoReceivedUrl.startsWith(container.env.domain).should.equal(true);
-                global.enketoReceivedUrl.should.match(/\/v1\/test\/[a-z0-9$!]{64}\/projects\/1\/forms\/simple\/draft/i);
+                global.enketo.receivedUrl.startsWith(container.env.domain).should.equal(true);
+                global.enketo.receivedUrl.should.match(/\/v1\/test\/[a-z0-9$!]{64}\/projects\/1\/forms\/simple\/draft/i);
               })))));
 
       it('should manage draft/published enketo tokens separately', testService((service, container) =>
@@ -108,7 +108,7 @@ describe('api: /projects/:id/forms (drafts)', () => {
             .expect(200)
             .then(() => exhaust(container))
             .then(() => {
-              global.enketoToken = '::ijklmnop';
+              global.enketo.token = '::ijklmnop';
               return asAlice.post('/v1/projects/1/forms/simple2/draft')
                 .expect(200)
                 .then(() => exhaust(container))
@@ -814,7 +814,7 @@ describe('api: /projects/:id/forms (drafts)', () => {
             .expect(200)
             .then(() => exhaust(container))
             .then(() => {
-              global.enketoToken = '::ijklmnop';
+              global.enketo.token = '::ijklmnop';
               return asAlice.post('/v1/projects/1/forms/simple2/draft')
                 .expect(200)
                 .then(() => exhaust(container))

test/integration/api/forms/forms.js

@@ -768,7 +768,7 @@ describe('api: /projects/:id/forms (create, read, update)', () => {
             .expect(200)
             .then(() => exhaust(container))
             .then(() => {
-              global.enketoToken = '::ijklmnop';
+              global.enketo.token = '::ijklmnop';
               return asAlice.post('/v1/projects/1/forms/simple2/draft')
                 .expect(200)
                 .then(() => exhaust(container))

test/integration/api/submissions.js

@@ -1247,11 +1247,12 @@ describe('api: /forms/:id/submissions', () => {
           .then(() => asAlice.get('/v1/projects/1/forms/binaryType/submissions/both/edit')
             .expect(302))
           .then(() => {
-            global.enketoEditData.openRosaUrl.should.equal('http://localhost:8989/v1/projects/1');
-            global.enketoEditData.domain.should.equal('http://localhost:8989');
-            global.enketoEditData.logicalId.should.equal('both');
-            global.enketoEditData.attachments.length.should.equal(2);
-            global.enketoEditData.token.should.be.a.token();
+            const { editData } = global.enketo;
+            editData.openRosaUrl.should.equal('http://localhost:8989/v1/projects/1');
+            editData.domain.should.equal('http://localhost:8989');
+            editData.logicalId.should.equal('both');
+            editData.attachments.length.should.equal(2);
+            editData.token.should.be.a.token();
           }))));
   });
 

test/integration/other/transactions.js

@@ -52,7 +52,7 @@ describe('enketo worker transaction', () => {
     await Audits.log(null, 'form.update.publish', simple);
 
     let flush;
-    global.enketoWait = (f) => { flush = f; };
+    global.enketo.wait = (f) => { flush = f; };
     const workerTicket = exhaust(container);
     // eslint-disable-next-line no-await-in-loop
     while (flush == null) await sometime(50);

test/integration/setup.js

@@ -44,7 +44,8 @@ const bcrypt = require(appRoot + '/lib/util/crypto').password(_bcrypt);
 
 // set up our enketo mock.
 // eslint-disable-next-line import/no-dynamic-require
-const enketo = require(appRoot + '/test/util/enketo');
+const { reset: resetEnketo, ...enketo } = require(appRoot + '/test/util/enketo');
+beforeEach(resetEnketo);
 
 // set up odk analytics mock.
 // eslint-disable-next-line import/no-dynamic-require

test/util/enketo.js

@@ -1,33 +1,76 @@
+// This file exports an enketo mock for testing. A test can communicate with the
+// mock by getting or setting properties of global.enketo.
+
 const appRoot = require('app-root-path');
 const { call } = require('ramda');
-// eslint-disable-next-line import/no-dynamic-require
 const Problem = require(appRoot + '/lib/util/problem');
+const { without } = require(appRoot + '/lib/util/util');
+
+const defaults = {
+  // Properties that each test can set
+
+  // If `state` is set to 'error', the mock will pretend that Enketo has
+  // misbehaved and will return a rejected promise for the next call.
+  state: undefined,
+  // Controls the timing of the Enketo response.
+  wait: call,
+  // The enketoId for the create() or createOnceToken() method to return. By
+  // default, it is ::abcdefgh for create() and ::::abcdefgh for
+  // createOnceToken().
+  token: undefined,
+
+  // Properties that may be updated after the mock is called
+
+  // The total number of times that the mock has been called during the test
+  callCount: 0,
+  // The OpenRosa URL that was passed to the create() or createOnceToken()
+  // method
+  receivedUrl: undefined,
+  // An object with a property for each argument passed to the edit() method
+  editData: undefined
+};
 
-const _create = (prefix) => (openRosaUrl) => new Promise((resolve, reject) => {
-  const state = global.enketoPreviewTest;
-  global.enketoPreviewTest = null;
-  const token = global.enketoToken || `${prefix}abcdefgh`;
-  global.enketoToken = null;
-  global.enketoReceivedUrl = null;
-  const wait = global.enketoWait || call;
-  global.enketoWait = null;
-
-  wait(() => {
-    if (state === 'error') {
-      // pretend that Enketo has misbehaved
-      reject(Problem.internal.enketoUnexpectedResponse('wrong status code'));
-    } else {
-      global.enketoReceivedUrl = openRosaUrl;
-      resolve(token);
-    }
+let cancelToken = 0;
+
+const reset = () => {
+  if (global.enketo === undefined) global.enketo = {};
+  Object.assign(global.enketo, defaults);
+  cancelToken += 1;
+};
+
+// Mocks a request to Enketo.
+const request = (f) => {
+  global.enketo.callCount += 1;
+  const options = { ...global.enketo };
+  Object.assign(global.enketo, without(['callCount'], defaults));
+  return new Promise((resolve, reject) => {
+    const { wait } = options;
+    const tokenBeforeWait = cancelToken;
+    wait(() => {
+      if (cancelToken !== tokenBeforeWait)
+        reject(new Error('request was canceled'));
+      else if (options.state === 'error')
+        reject(Problem.internal.enketoUnexpectedResponse('wrong status code'));
+      else
+        resolve(f(options));
+    });
   });
-});
+};
 
-const edit = (openRosaUrl, domain, form, logicalId, submissionDef, attachments, token) => new Promise((resolve) => {
-  global.enketoEditTest = null;
-  global.enketoEditData = { openRosaUrl, domain, form, logicalId, submissionDef, attachments, token };
-  resolve('https://enketo/edit/url');
-});
+const _create = (prefix) => (openRosaUrl) =>
+  request(({ token = `${prefix}abcdefgh` }) => {
+    global.enketo.receivedUrl = openRosaUrl;
+    return token;
+  });
+
+const edit = (openRosaUrl, domain, form, logicalId, submissionDef, attachments, token) =>
+  request(() => {
+    global.enketo.editData = { openRosaUrl, domain, form, logicalId, submissionDef, attachments, token };
+    return 'https://enketo/edit/url';
+  });
 
-module.exports = { create: _create('::'), createOnceToken: _create('::::'), edit };
+module.exports = {
+  create: _create('::'), createOnceToken: _create('::::'), edit,
+  reset
+};