Merge pull request #17331 from yonasberhe23/allow_skip_214

[backport 2.14.2] Automation: Add env flag to allow skip

Author: yonasberhe23

cypress/base-config.ts

@@ -110,23 +110,25 @@ const baseConfig = defineConfig({
         'pkg/rancher-components/src/components/**/*.{vue,ts,js}',
       ]
     },
-    api:                 apiUrl,
+    api:                      apiUrl,
     username,
-    password:            process.env.CATTLE_BOOTSTRAP_PASSWORD || process.env.TEST_PASSWORD,
-    bootstrapPassword:   process.env.CATTLE_BOOTSTRAP_PASSWORD,
-    grepTags:            process.env.GREP_TAGS,
-    VAI_ENABLED:         process.env.VAI_ENABLED,
+    password:                 process.env.CATTLE_BOOTSTRAP_PASSWORD || process.env.TEST_PASSWORD,
+    bootstrapPassword:        process.env.CATTLE_BOOTSTRAP_PASSWORD,
+    grepTags:                 process.env.GREP_TAGS,
+    VAI_ENABLED:              process.env.VAI_ENABLED,
     // the below env vars are only available to tests that run in Jenkins
-    awsAccessKey:        process.env.AWS_ACCESS_KEY_ID,
-    awsSecretKey:        process.env.AWS_SECRET_ACCESS_KEY,
-    azureSubscriptionId: process.env.AZURE_AKS_SUBSCRIPTION_ID,
-    azureClientId:       process.env.AZURE_CLIENT_ID,
-    azureClientSecret:   process.env.AZURE_CLIENT_SECRET,
-    customNodeIp:        process.env.CUSTOM_NODE_IP,
-    customNodeKey:       process.env.CUSTOM_NODE_KEY,
-    accessibility:       !!process.env.TEST_A11Y, // Are we running accessibility tests?
-    a11yFolder:          path.join('.', 'cypress', 'accessibility'),
-    gkeServiceAccount:   process.env.GKE_SERVICE_ACCOUNT,
+    awsAccessKey:             process.env.AWS_ACCESS_KEY_ID,
+    awsSecretKey:             process.env.AWS_SECRET_ACCESS_KEY,
+    azureSubscriptionId:      process.env.AZURE_AKS_SUBSCRIPTION_ID,
+    azureClientId:            process.env.AZURE_CLIENT_ID,
+    azureClientSecret:        process.env.AZURE_CLIENT_SECRET,
+    customNodeIp:             process.env.CUSTOM_NODE_IP,
+    customNodeKey:            process.env.CUSTOM_NODE_KEY,
+    accessibility:            !!process.env.TEST_A11Y, // Are we running accessibility tests?
+    a11yFolder:               path.join('.', 'cypress', 'accessibility'),
+    gkeServiceAccount:        process.env.GKE_SERVICE_ACCOUNT,
+    // Set to 'true' to allow skipping when a chart is filtered from the UI catalog.
+    allowFilteredCatalogSkip: process.env.CYPRESS_ALLOW_FILTERED_CATALOG_SKIP,
   },
   reporter:        'cypress-mochawesome-reporter',
   reporterOptions: {

cypress/e2e/tests/pages/charts/chart-install-wizard.spec.ts

@@ -125,8 +125,8 @@ describe('Charts Wizard', { testIsolation: 'off', tags: ['@charts', '@adminUser'
       const chartApp = 'rancher-backup';
       const chartCrd = 'rancher-backup-crd';
 
-      cy.createRancherResource('v1', `catalog.cattle.io.apps/${ chartNamespace }/${ chartApp }?action=uninstall`, '{}');
-      cy.createRancherResource('v1', `catalog.cattle.io.apps/${ chartNamespace }/${ chartCrd }?action=uninstall`, '{}');
+      cy.createRancherResource('v1', `catalog.cattle.io.apps/${ chartNamespace }/${ chartApp }?action=uninstall`, '{}', false);
+      cy.createRancherResource('v1', `catalog.cattle.io.apps/${ chartNamespace }/${ chartCrd }?action=uninstall`, '{}', false);
       cy.updateNamespaceFilter('local', 'none', '{"local":["all://user"]}');
     });
   });

cypress/e2e/tests/pages/charts/compliance.spec.ts

@@ -100,8 +100,8 @@ describe('Charts', { testIsolation: 'off', tags: ['@charts', '@adminUser'] }, ()
         const chartApp = 'rancher-compliance';
         const chartCrd = 'rancher-compliance-crd';
 
-        cy.createRancherResource('v1', `catalog.cattle.io.apps/${ chartNamespace }/${ chartApp }?action=uninstall`, '{}');
-        cy.createRancherResource('v1', `catalog.cattle.io.apps/${ chartNamespace }/${ chartCrd }?action=uninstall`, '{}');
+        cy.createRancherResource('v1', `catalog.cattle.io.apps/${ chartNamespace }/${ chartApp }?action=uninstall`, '{}', false);
+        cy.createRancherResource('v1', `catalog.cattle.io.apps/${ chartNamespace }/${ chartCrd }?action=uninstall`, '{}', false);
         cy.updateNamespaceFilter('local', 'none', '{"local":["all://user"]}');
       });
     });

cypress/support/commands/rancher-api-commands.ts

@@ -1591,9 +1591,10 @@ Cypress.Commands.add('checkChartPresence', (repoName: string, chartKey: string)
 });
 
 /**
- * Runs the given callback only when the chart is available in the filtered catalog index.
- * Skips the test when the chart exists in the catalog but is filtered out intentionally (e.g. based on k8s or Rancher annotations).
- * Throws when the chart is missing from the unfiltered index (publishing/sync issue).
+ * Runs `callback` when `chartKey` is present in the filtered catalog index (the list the Charts UI uses).
+ * Throws error if the chart is missing from the unfiltered index — that points to catalog publish or sync, not compatibility filtering.
+ * If the chart is in the unfiltered index but not the filtered index, skips when Cypress env `allowFilteredCatalogSkip`
+ * is enabled; otherwise throws error.
  */
 export function runTestWhenChartAvailable(
   repo: string,
@@ -1607,9 +1608,13 @@ export function runTestWhenChartAvailable(
     }
 
     if (!inFiltered) {
-      cy.log(`Skipping: chart '${ chartKey }' is intentionally hidden from the filtered catalog index`);
+      if (String(Cypress.env('allowFilteredCatalogSkip')).toLowerCase() === 'true') {
+        cy.log(`Skipping: chart '${ chartKey }' is intentionally hidden from the filtered catalog index`);
 
-      return mochaContext.skip();
+        return mochaContext.skip();
+      }
+
+      throw new Error(`Failing: chart '${ chartKey }' is not in the filtered catalog index, so it does not appear in the Charts/Tools UI for this environment.`);
     }
 
     callback();