fix: cloud tests for iox behavior (#6497)

* fix: cloud tests for iox behavior

* chore: add new cy methods to type declaration

* chore: resolve gh test behavior with iox orgs

Co-authored-by: wdoconnell <91283923+wdoconnell@users.noreply.github.com>

Author: wiedld

cypress/e2e/cloud/billing.test.ts

@@ -13,35 +13,28 @@ describe('Billing Page Free Users', () => {
     'Series Cardinality',
   ]
 
-  interface FreeTestSettings {
-    orgIsIOx: boolean
-  }
-
-  const setupFreeTest = (settings: FreeTestSettings) => {
-    cy.intercept('GET', '/api/v2/orgs', req => {
-      req.continue(res => {
-        if (settings.orgIsIOx) {
-          res.body.orgs[0].defaultStorageType = 'iox'
-        }
-      })
+  beforeEach(() => {
+    cy.flush().then(() => {
+      cy.signin()
     })
+  })
 
-    cy.flush().then(() => {
-      cy.signin().then(() => {
-        cy.get('@org').then(({id}: Organization) => {
-          cy.quartzProvision({
-            accountType: 'free',
-          }).then(() => {
-            cy.visit(`/orgs/${id}/billing`)
-            cy.getByTestID('billing-page--header').should('be.visible')
-          })
-        })
+  const setupFreeTest = () => {
+    cy.get('@org').then(({id}: Organization) => {
+      cy.quartzProvision({
+        accountType: 'free',
+      }).then(() => {
+        cy.visit(`/orgs/${id}/billing`)
+        cy.getByTestID('billing-page--header').should('be.visible')
       })
     })
   }
 
   it('should display the free billing page for free users', () => {
-    setupFreeTest({orgIsIOx: false})
+    cy.isIoxOrg().then(isIOx => {
+      cy.skipOn(isIOx)
+    })
+    setupFreeTest()
 
     cy.getByTestID('cloud-upgrade--button').should('be.visible')
     cy.getByTestID('title-header--name')
@@ -62,7 +55,10 @@ describe('Billing Page Free Users', () => {
   })
 
   it('should not display the cardinality limit in an iox org', () => {
-    setupFreeTest({orgIsIOx: true})
+    cy.isIoxOrg().then(isIOx => {
+      cy.skipOn(!isIOx)
+    })
+    setupFreeTest()
 
     const limitsWithoutCardinality = limitNames.slice(0, -1)
 

cypress/e2e/cloud/globalHeader.test.ts

@@ -1,7 +1,11 @@
 import {makeQuartzUseIDPEOrgID} from 'cypress/support/Utils'
+import {Organization} from 'src/client'
 
 describe('global header', () => {
   let idpeOrgID: string
+  let idpeOrg: Organization
+
+  const orgIsIOx = () => idpeOrg.defaultStorageType === 'iox'
 
   before(() => {
     cy.flush().then(() =>
@@ -14,6 +18,7 @@ describe('global header', () => {
           // Store the IDPE org ID so that it can be cloned when intercepting quartz.
           if (res.body.orgs) {
             idpeOrgID = res.body.orgs[0].id
+            idpeOrg = res.body.orgs[0]
           }
         })
       })
@@ -180,33 +185,21 @@ describe('global header', () => {
   })
 
   describe('cardinality alerts', () => {
-    interface TestParams {
-      orgIsIOx: boolean
-    }
-
-    const setupCardinalityTest = (params: TestParams) => {
+    const setupCardinalityTest = () => {
       cy.intercept('GET', 'api/v2private/orgs/**/limits/status', req => {
         req.continue(res => {
           res.body.cardinality.status = 'exceeded'
         })
       })
-
-      if (params.orgIsIOx) {
-        cy.intercept('GET', '/api/v2/orgs', req => {
-          req.continue(res => {
-            res.body.orgs[0].defaultStorageType = 'iox'
-          })
-        })
-      }
-
       makeQuartzUseIDPEOrgID(idpeOrgID, 'pay_as_you_go')
       // Alert will appear in global header on any page (like data explorer)
       // that has <LimitChecker />, which displays cardinality alerts.
       cy.visit(`/orgs/${idpeOrgID}/data-explorer`)
     }
 
     it('shows a cardinality limit alert for TSM orgs if cardinality limits are exceeded', () => {
-      setupCardinalityTest({orgIsIOx: false})
+      cy.skipOn(orgIsIOx())
+      setupCardinalityTest()
 
       cy.getByTestID('rate-alert--banner')
         .should('be.visible')
@@ -217,7 +210,8 @@ describe('global header', () => {
     })
 
     it('never shows a cardinality limit alert for IOx orgs', () => {
-      setupCardinalityTest({orgIsIOx: true})
+      cy.skipOn(!orgIsIOx())
+      setupCardinalityTest()
 
       cy.getByTestID('rate-alert--banner').should('not.exist')
       cy.contains('series cardinality').should('not.exist')

cypress/index.d.ts

@@ -1,6 +1,7 @@
 /* eslint @typescript-eslint/no-unused-vars: "off" */
 import 'jest'
 import 'cypress-plugin-tab'
+import {skipOn} from '@cypress/skip-test'
 
 import {
   signin,
@@ -12,6 +13,7 @@ import {
   createSource,
   deleteOrg,
   flush,
+  isIoxOrg,
   getByTestID,
   getByTestIDHead,
   getByInputName,
@@ -80,6 +82,8 @@ declare global {
       createOrg: typeof createOrg
       deleteOrg: typeof deleteOrg
       flush: typeof flush
+      isIoxOrg: typeof isIoxOrg
+      skipOn: typeof skipOn
       getByTestID: typeof getByTestID
       getByTestIDHead: typeof getByTestIDHead
       getByInputName: typeof getByInputName

cypress/support/commands.ts

@@ -226,7 +226,7 @@ export const wrapDefaultPassword = (): Cypress.Chainable => {
   return cy.wrap(password).as('defaultPassword')
 }
 
-export const isIoxOrg = (): Cypress.Chainable<Cypress.Response<any>> => {
+export const isIoxOrg = (): Cypress.Chainable<boolean> => {
   return cy.get('@org').then(({defaultStorageType}: Organization) => {
     return Boolean(
       defaultStorageType && defaultStorageType.toLowerCase() === 'iox'