Can an Okta User be Mocked?

[ej2brown]

We cannot use a real user for testing (as shown in the Cypress Okta Authentication docs) and are required to mock one.

Issue: @okta/okta-auth-js cannot be mocked when it's a dependency in another function

Our normal flow:

1. OktaAuth is generated on creation and exported
2. We call the API endpoint "Programmatic Login" to receive an auth code to then retrieve the tokens.

Mock e2e flow:

1. We intercepted the https calls, i.e. /api/v1/authn, using cy.intercept. The intercept sets mock tokens and redirects which works beautifully.
2. Unfortunately, the OktaAuth object cy.stubs won't seem to work on the OktaAuth object. This means that the object fields cannot be mocked/stub. For example, We call OktaAuth.isLoginRedirect() after the redirect.

 it("mock okta methods - isLoginRedirect", () => {
    cy.stub(OktaAuth, "isLoginRedirect", (...args) => {
      return true;
    });
    console.assert(OktaAuth.isLoginRedirect() === true);
  });

The stubbing of OktaAuth.isLoginRedirect() works when called in the cypress test file, but not when it's a dependency in another function - the mock always returns false when the stub is true.

There seem to be related discussions on mocking/stubbing functions within modules (similar to our issue) but I'm not 100% sure if they're related or if this is related to OktaAuth.

Investigation of Sinon’s

I also investigated Sinon, which cy.stub uses stub | Cypress Documentation. They outline how to mock a dependency How to stub a dependency of a module.

const sinon = require("sinon");
const OktaAuth = require("components/utils/OktaAuth/OktaAuth");
const OktaAuthLib = require("@okta/okta-auth-js");

describe("login page", () => {
  beforeEach(() => {
    sinon.stub(OktaAuthLib, "isLoginRedirect").returns(true);
    sinon.stub(OktaAuth, "isLoginRedirect").returns(true);
....

The error I get is isLoginRedirect is non-configurable and non-writable

My question is can OktaAuth be stubbed in order to mock an Okta user?

---

Specs:

  {
    "@cypress/webpack-preprocessor": "^5.17.1",
    "@okta/okta-auth-js": "~7.2.0",
    "@okta/okta-react": "~6.7.0",
    "@webpack-cli/serve": "~1.6.0",
    "react": "~18.2.0",
    "cypress": "^12.13.0",
    "webpack": "~5.74.0"
  }