Add setter, getter & reset utils for intercepted aliases

Author: asirvadAbrahamVarghese

cypress/e2e/ui/validate-intercept-api-command.cy.js

@@ -16,9 +16,9 @@ describe('Validate intercept command', () => {
       triggerFn: () => cy.selectAccordionItem([/^ManageIQ Region:/, /^Zone:/]),
     }).then(() => {
       // verifies that the alias is set and the request is intercepted & awaited
-      expect(Cypress.env('interceptedAliases')).to.have.property(
-        'treeSelectApi'
-      );
+      cy.getInterceptedApiAliases().then((interceptedAliasesObject) => {
+        expect(interceptedAliasesObject).to.have.property('treeSelectApi');
+      });
     });
   });
 
@@ -36,10 +36,12 @@ describe('Validate intercept command', () => {
       triggerFn: () => cy.selectAccordionItem([/^ManageIQ Region:/, /^Zone:/]),
     }).then(() => {
       // verifies that both the aliases are set and the request is intercepted & awaited
-      expect(Cypress.env('interceptedAliases')).to.include.all.keys(
-        'accordionSelectApi',
-        'treeSelectApi'
-      );
+      cy.getInterceptedApiAliases().then((interceptedAliasesObject) => {
+        expect(interceptedAliasesObject).to.include.all.keys(
+          'accordionSelectApi',
+          'treeSelectApi'
+        );
+      });
     });
   });
 
@@ -50,15 +52,19 @@ describe('Validate intercept command', () => {
       urlPattern: /\/ops\/accordion_select\?id=.*/,
       triggerFn: () => cy.accordion('Diagnostics'),
     }).then(() => {
-      expect(Object.keys(Cypress.env('interceptedAliases')).length).to.equal(1);
+      cy.getInterceptedApiAliases().then((interceptedAliasesObject) => {
+        expect(Object.keys(interceptedAliasesObject).length).to.equal(1);
+      });
     });
     // second first api with alias 'treeSelectApi'
     cy.interceptApi({
       alias: 'treeSelectApi',
       urlPattern: /\/ops\/tree_select\?id=.*&text=.*/,
       triggerFn: () => cy.selectAccordionItem([/^ManageIQ Region:/, /^Zone:/]),
     }).then(() => {
-      expect(Object.keys(Cypress.env('interceptedAliases')).length).to.equal(2);
+      cy.getInterceptedApiAliases().then((interceptedAliasesObject) => {
+        expect(Object.keys(interceptedAliasesObject).length).to.equal(2);
+      });
     });
     // third api with a duplicate alias as above 'accordionSelectApi'
     cy.interceptApi({
@@ -67,7 +73,9 @@ describe('Validate intercept command', () => {
       triggerFn: () => cy.accordion('Access Control'),
     }).then(() => {
       // assert that the alias is not overwritten
-      expect(Object.keys(Cypress.env('interceptedAliases')).length).to.equal(2);
+      cy.getInterceptedApiAliases().then((interceptedAliasesObject) => {
+        expect(Object.keys(interceptedAliasesObject).length).to.equal(2);
+      });
     });
   });
 });

cypress/support/commands/api_commands.js

@@ -1,5 +1,58 @@
 /* eslint-disable no-undef */
 
+/**
+ * Custom command to get the intercepted API aliases stored in Cypress environment variables.
+ * This command returns the object containing all registered API interception aliases.
+ * 
+ * @returns {Object} An object where keys are the alias names and values are typically the same alias names
+ * @example
+ * cy.getInterceptedApiAliases().then((aliases) => {
+ *   Check if a specific alias exists
+ *   expect(aliases).to.have.property('myApiAlias');
+ *
+ *   Get the number of registered aliases
+ *   const aliasCount = Object.keys(aliases).length;
+ * });
+ */
+Cypress.Commands.add('getInterceptedApiAliases', () =>
+  Cypress.env('interceptedAliases')
+);
+
+/**
+ * Custom command to set an intercepted API alias in the Cypress environment variables.
+ * This command adds an alias in the intercepted aliases tracking object.
+ *
+ * @param {string} aliasKey - The key/name of the alias to set
+ * @param {string} [aliasValue=aliasKey] - The value to store for the alias (defaults to the same as the key)
+ * @example
+ * Set a new alias
+ * cy.setInterceptedApiAlias('getUsersApi');
+ *
+ * Set an alias with a custom value
+ * cy.setInterceptedApiAlias('getUsersApi', 'customValue');
+ */
+Cypress.Commands.add(
+  'setInterceptedApiAlias',
+  (aliasKey, aliasValue = aliasKey) => {
+    cy.getInterceptedApiAliases().then((interceptedAliasesMap) => {
+      interceptedAliasesMap[aliasKey] = aliasValue;
+      Cypress.env('interceptedAliases', interceptedAliasesMap);
+    });
+  }
+);
+
+/**
+ * Custom command to reset all intercepted API aliases stored in Cypress environment variables.
+ * This command clears the tracking object by setting it to an empty object.
+ * Useful for cleaning up between tests or test suites.
+ * @example
+ * Reset all intercepted API aliases
+ * cy.resetInterceptedApiAliases();
+ */
+Cypress.Commands.add('resetInterceptedApiAliases', () =>
+  Cypress.env('interceptedAliases', {})
+);
+
 /**
  * Custom command to intercept API calls and wait for them to complete.
  * This command will:
@@ -34,24 +87,23 @@ Cypress.Commands.add(
     /* ======================================================= */
 
     // Check if this request is already registered
-    const isAlreadyRegistered = !!Cypress.env('interceptedAliases')[alias];
-
-    // Register the intercept if not already done
-    if (!isAlreadyRegistered) {
-      cy.intercept(method, urlPattern).as(alias);
+    cy.getInterceptedApiAliases().then((interceptedAliasesMap) => {
+      // Check if this request is already registered
+      const isAlreadyRegistered = !!interceptedAliasesMap[alias];
 
-      // Store the alias in the tracking object
-      const interceptedAliases = Cypress.env('interceptedAliases');
-      interceptedAliases[alias] = alias;
-      Cypress.env('interceptedAliases', interceptedAliases);
-    }
+      // Register the intercept if not already done
+      if (!isAlreadyRegistered) {
+        cy.intercept(method, urlPattern).as(alias);
+        cy.setInterceptedApiAlias(alias);
+      }
 
-    // Execute the function that triggers the API call
-    triggerFn();
+      // Execute the function that triggers the API call
+      triggerFn();
 
-    // Wait for the intercepted request to complete
-    cy.wait(`@${alias}`).then((interception) => {
-      onApiResponse(interception);
+      // Wait for the intercepted request to complete
+      cy.wait(`@${alias}`).then((interception) => {
+        onApiResponse(interception);
+      });
     });
   }
 );

cypress/support/e2e.js

@@ -79,5 +79,5 @@ beforeEach(() => {
   // cy.stub_notifications();
 
   // Reset the intercepted aliases tracking object
-  Cypress.env('interceptedAliases', {});
+  cy.resetInterceptedApiAliases();
 })