Mock out project deps for more trustworthy coverage

And simplify module mocking.

Author: simonbuchan

src/CognitoUser.authenticateUser.test.js

@@ -183,10 +183,50 @@ function hexToBase64(hex) {
   return sjcl.codec.base64.fromBits(sjcl.codec.hex.toBits(hex));
 }
 
+class MockResultBase {
+  constructor(...params) {
+    this.params = params;
+  }
+}
+
+class MockCognitoTokenBase extends MockResultBase {}
+class MockCognitoAccessToken extends MockCognitoTokenBase {
+  getJwtToken() {
+    return this.params[0].AccessToken;
+  }
+}
+class MockCognitoIdToken extends MockCognitoTokenBase {
+  getJwtToken() {
+    return this.params[0].IdToken;
+  }
+}
+class MockCognitoRefreshToken extends MockCognitoTokenBase {
+  getToken() {
+    return this.params[0].RefreshToken;
+  }
+}
+class MockCognitoUserSession extends MockResultBase {
+  getAccessToken() {
+    return this.params[0].AccessToken;
+  }
+
+  getIdToken() {
+    return this.params[0].IdToken;
+  }
+
+  getRefreshToken() {
+    return this.params[0].RefreshToken;
+  }
+}
+
 function createUser({ pool = new MockUserPool() } = {}, ...requestConfigs) {
   pool.client = new MockClient(...requestConfigs); // eslint-disable-line no-param-reassign
   const CognitoUser = requireDefaultWithModuleMocks('./CognitoUser', {
     './AuthenticationHelper': MockAuthenticationHelper,
+    './CognitoAccessToken': MockCognitoAccessToken,
+    './CognitoIdToken': MockCognitoIdToken,
+    './CognitoRefreshToken': MockCognitoRefreshToken,
+    './CognitoUserSession': MockCognitoUserSession,
     './DateHelper': MockDateHelper,
   });
   return new CognitoUser({ Username: constructorUsername, Pool: pool });

src/CognitoUser.test.js

@@ -56,16 +56,18 @@ class MockSession {
   }
 }
 
-function createUser({ pool = new MockUserPool(), session } = {}, ...requestConfigs) {
+function createUser({ pool = new MockUserPool(), session, mocks } = {}, ...requestConfigs) {
   pool.client = new MockClient(...requestConfigs); // eslint-disable-line no-param-reassign
-  const CognitoUser = requireDefaultWithModuleMocks('./CognitoUser', {
-    // Nothing yet
-  });
+  const CognitoUser = requireDefaultWithModuleMocks('./CognitoUser', mocks);
   const user = new CognitoUser({ Username, Pool: pool });
   user.signInUserSession = session;
   return user;
 }
 
+function createSignedInUserWithMocks(mocks, ...requests) {
+  return createUser({ session: new MockSession(), mocks }, ...requests);
+}
+
 function createSignedInUser(...requests) {
   return createUser({ session: new MockSession() }, ...requests);
 }
@@ -249,15 +251,26 @@ test.cb(updateAttributesMacro, false);
 test.cb(updateAttributesMacro, true);
 
 function getUserAttributesMacro(t, succeeds) {
+  class MockCognitoUserAttribute {
+    constructor(...params) {
+      this.params = params;
+    }
+  }
+
   const expectedError = createExpectedErrorFromSuccess(succeeds);
   const responseResult = succeeds ? { UserAttributes: attributes } : null;
-  const user = createSignedInUser([expectedError, responseResult]);
+
+  const user = createSignedInUserWithMocks(
+    {
+      './CognitoUserAttribute': MockCognitoUserAttribute,
+    },
+    [expectedError, responseResult]);
 
   user.getUserAttributes((err, result) => {
     t.is(err, expectedError);
     if (succeeds) {
-      // Only check for Name, Value properties, don't assert the results are CognitoUserAttributes.
-      t.deepEqual(result.map(({ Name, Value }) => ({ Name, Value })), attributes);
+      t.true(Array.isArray(result) && result.every(i => i instanceof MockCognitoUserAttribute));
+      t.deepEqual(result.map(i => i.params[0]), attributes);
     } else {
       t.falsy(result);
     }

src/_helpers.test.js

@@ -2,7 +2,7 @@
 
 import test from 'ava';
 import { stub } from 'sinon';
-import mockRequire from 'mock-require';
+import mockRequire, { reRequire } from 'mock-require';
 
 export class MockClient {
   constructor(...requestConfigs) {
@@ -80,42 +80,29 @@ test.afterEach.always(t => {
   delete global.window;
 });
 
-function shouldMock(path) {
-  return path.startsWith(__dirname) && !path.endsWith('.test.js');
-}
+const defaultMocks = {
+  'aws-sdk/clients/cognitoidentityserviceprovider': MockClient,
+  './AuthenticationDetails': null,
+  './AuthenticationHelper': null,
+  './CognitoAccessToken': null,
+  './CognitoIdToken': null,
+  './CognitoRefreshToken': null,
+  './CognitoUser': null,
+  './CognitoUserAttribute': null,
+  './CognitoUserPool': null,
+  './CognitoUserSession': null,
+  './DateHelper': null,
+};
 
 function requireWithModuleMocks(request, moduleMocks = {}) {
-  const unmockedCache = Object.create(null);
-
-  // Remove require.cache entries that may be using the unmocked modules
-  Object.keys(require.cache).forEach(path => {
-    if (shouldMock(path)) {
-      delete require.cache[path];
-    }
-  });
-
-  // Always mock AWS SDK
-  mockRequire('aws-sdk/clients/cognitoidentityserviceprovider', MockClient);
-
-  // Mock other modules
-  Object.keys(moduleMocks).forEach(name => {
-    mockRequire(name, moduleMocks[name]);
-  });
-
-  const mockedModule = require(request);
-
-  // Restore require.cache to previous state
-  Object.keys(require.cache).forEach(path => {
-    if (shouldMock(path)) {
-      if (Object.prototype.hasOwnProperty.call(unmockedCache, path)) {
-        require.cache[path] = unmockedCache[path];
-      } else {
-        delete require.cache[path];
-      }
+  const allModuleMocks = Object.assign({}, defaultMocks, moduleMocks);
+  Object.keys(allModuleMocks).forEach(mockRequest => {
+    if (mockRequest !== request) {
+      mockRequire(mockRequest, allModuleMocks[mockRequest]);
     }
   });
 
-  return mockedModule;
+  return reRequire(request);
 }
 
 export function requireDefaultWithModuleMocks(request, moduleMocks) {