@rockcarver/frodo-lib 0.17.2-0 → 0.17.2

package/esm/api/AuthenticateApi.test.mjs

@@ -1,39 +1,81 @@
-import axios from 'axios';
-import MockAdapter from 'axios-mock-adapter';
+/**
+ * To record and update snapshots, you must perform 3 steps in order:
+ *
+ * 1. Record API responses & update ESM snapshots
+ *
+ *    To record and update ESM snapshots, you must call the test:record_noauth
+ *    script and override all the connection state variables supplied to the
+ *    getTokens() function by the test to connect to the env to record from:
+ *
+ *        FRODO_DEBUG=1 \
+ *        FRODO_HOST=https://openam-volker-dev.forgeblocks.com/am \
+ *        FRODO_REALM=alpha \
+ *        FRODO_USERNAME=vscheuber@gmail.com \
+ *        FRODO_PASSWORD='S3cr3!S@uc3' \
+ *        FRODO_AUTHENTICATION_SERVICE=PasswordGrant \
+ *        npm run test:record_noauth AuthenticateApi
+ *
+ * 2. Update CJS snapshots
+ *
+ *    After recording, the ESM snapshots will already be updated as that happens
+ *    in one go, but you musty manually update the CJS snapshots by running:
+ *
+ *        FRODO_DEBUG=1 npm run test:update AuthenticateApi
+ *
+ * 3. Test your changes
+ *
+ *    If 1 and 2 didn't produce any errors, you are ready to run the tests in
+ *    replay mode and make sure they all succeed as well:
+ *
+ *        npm run test AuthenticateApi
+ *
+ * Note: FRODO_DEBUG=1 is optional and enables debug logging for some output
+ * in case things don't function as expected
+ */
 import { AuthenticateRaw, state } from '../index';
-import * as global from '../storage/StaticStorage';
-import { getTreeStepResponse, mockStep } from '../test/mocks/ForgeRockApiMockEngine';
-const mock = new MockAdapter(axios);
-state.setHost('https://openam-frodo-dev.forgeblocks.com/am');
-state.setUsername('volker.scheuber@forgerock.com');
-state.setPassword('Sup3rS3cr3t!');
-state.setRealm('alpha');
-state.setCookieName('cookieName');
-state.setCookieValue('cookieValue');
-state.setDeploymentType(global.CLOUD_DEPLOYMENT_TYPE_KEY);
-describe.only('AuthenticateApi - step()', () => {
-  test('step() 0: Method is implemented', async () => {
-    expect(AuthenticateRaw.step).toBeDefined();
-  });
-  test('step() 1: Initial step - get callbacks', async () => {
-    mockStep(mock);
-    const config = {
-      headers: {
-        'X-OpenAM-Username': state.getUsername(),
-        'X-OpenAM-Password': state.getPassword()
-      }
-    };
-    const response = await AuthenticateRaw.step({}, config);
-    expect(response.authId).toBeTruthy();
-    expect(response.callbacks).toBeTruthy();
-  });
-  test('step() 2: Final step - get session', async () => {
-    const body = getTreeStepResponse(undefined, undefined);
-    mockStep(mock);
-    const response = await AuthenticateRaw.step(body);
-    expect(response.authId).toBeFalsy();
-    expect(response.callbacks).toBeFalsy();
-    expect(response.tokenId).toBeTruthy();
+import { autoSetupPolly, defaultMatchRequestsBy } from '../utils/AutoSetupPolly';
+
+// need to modify the default matching rules to allow the mocking to work for an authentication flow.
+const matchConfig = defaultMatchRequestsBy();
+matchConfig.body = false; // oauth flows are tricky because of the PKCE challenge, which is different for each request
+matchConfig.order = true; // since we instruct Polly not to match the body, we need to enable ordering of the requests
+
+autoSetupPolly(matchConfig);
+describe('AuthenticateApi', () => {
+  describe('step()', () => {
+    test('0: Method is implemented', async () => {
+      expect(AuthenticateRaw.step).toBeDefined();
+    });
+    test("1: Single step login journey 'PasswordGrant'", async () => {
+      state.setHost(process.env.FRODO_HOST || 'https://openam-frodo-dev.forgeblocks.com/am');
+      state.setRealm(process.env.FRODO_REALM || 'alpha');
+      state.setUsername(process.env.FRODO_USERNAME || 'mockUser');
+      state.setPassword(process.env.FRODO_PASSWORD || 'mockPassword');
+      state.setAuthenticationService(process.env.FRODO_AUTHENTICATION_SERVICE || 'PasswordGrant');
+      const config = {
+        headers: {
+          'X-OpenAM-Username': state.getUsername(),
+          'X-OpenAM-Password': state.getPassword()
+        }
+      };
+      const response1 = await AuthenticateRaw.step({}, config, state.getRealm());
+      expect(response1).toMatchSnapshot();
+    });
+    test("2: Two step login journey 'PasswordGrant'", async () => {
+      state.setHost(process.env.FRODO_HOST || 'https://openam-frodo-dev.forgeblocks.com/am');
+      state.setRealm(process.env.FRODO_REALM || 'alpha');
+      state.setUsername(process.env.FRODO_USERNAME || 'mockUser');
+      state.setPassword(process.env.FRODO_PASSWORD || 'mockPassword');
+      state.setAuthenticationService(process.env.FRODO_AUTHENTICATION_SERVICE || 'PasswordGrant');
+      const response1 = await AuthenticateRaw.step({}, {}, state.getRealm());
+      expect(response1).toMatchSnapshot();
+      const body = AuthenticateRaw.fillCallbacks(response1, {
+        IDToken1: state.getUsername(),
+        IDToken2: state.getPassword()
+      });
+      const response2 = await AuthenticateRaw.step(body, {}, state.getRealm());
+      expect(response2).toMatchSnapshot();
+    });
   });
 });
 //# sourceMappingURL=AuthenticateApi.test.js.map