Retry our ML API call in Cypress tests

This call was found to be sporadically failing in elastic#182183. This applies the same changes made in elastic#188155, but for Cypress tests instead of FTR.
rylnd · Jul 11, 2024 · f4d94d2 · f4d94d2
1 parent 48e2b57
commit f4d94d2
Show file tree

Hide file tree

Showing 3 changed files with 23 additions and 5 deletions.
diff --git a/...detection_response/detection_engine/rule_creation/machine_learning_rule_suppression.cy.ts b/...detection_response/detection_engine/rule_creation/machine_learning_rule_suppression.cy.ts
@@ -19,9 +19,9 @@ import {
   SUPPRESS_MISSING_FIELD,
 } from '../../../../screens/rule_details';
 import {
-  executeSetupModuleRequest,
   forceStartDatafeeds,
   forceStopAndCloseJob,
+  setupMlModulesWithRetry,
 } from '../../../../support/machine_learning';
 import {
   continueFromDefineStep,
@@ -94,7 +94,7 @@ describe(
       describe('when ML jobs have run', () => {
         before(() => {
           cy.task('esArchiverLoad', { archiveName: '../auditbeat/hosts', type: 'ftr' });
-          executeSetupModuleRequest({ moduleName: 'security_linux_v3' });
+          setupMlModulesWithRetry({ moduleName: 'security_linux_v3' });
           forceStartDatafeeds({ jobIds: [jobId] });
           cy.task('esArchiverLoad', { archiveName: 'anomalies', type: 'ftr' });
         });

diff --git a/...ess/cypress/e2e/detection_response/detection_engine/rule_edit/machine_learning_rule.cy.ts b/...ess/cypress/e2e/detection_response/detection_engine/rule_edit/machine_learning_rule.cy.ts
@@ -19,9 +19,9 @@ import {
   SUPPRESS_MISSING_FIELD,
 } from '../../../../screens/rule_details';
 import {
-  executeSetupModuleRequest,
   forceStartDatafeeds,
   forceStopAndCloseJob,
+  setupMlModulesWithRetry,
 } from '../../../../support/machine_learning';
 import { editFirstRule } from '../../../../tasks/alerts_detection_rules';
 import { deleteAlertsAndRules } from '../../../../tasks/api_calls/common';
@@ -71,7 +71,7 @@ describe(
       login();
       deleteAlertsAndRules();
       cy.task('esArchiverLoad', { archiveName: '../auditbeat/hosts', type: 'ftr' });
-      executeSetupModuleRequest({ moduleName: 'security_linux_v3' });
+      setupMlModulesWithRetry({ moduleName: 'security_linux_v3' });
       forceStartDatafeeds({ jobIds: [jobId] });
       cy.task('esArchiverLoad', { archiveName: 'anomalies', type: 'ftr' });
     });

diff --git a/x-pack/test/security_solution_cypress/cypress/support/machine_learning.ts b/x-pack/test/security_solution_cypress/cypress/support/machine_learning.ts
@@ -5,6 +5,7 @@
  * 2.0.
  */
 
+import { recurse } from 'cypress-recurse';
 import { ML_GROUP_ID } from '@kbn/security-solution-plugin/common/constants';
 import { rootRequest } from '../tasks/api_calls/common';
 
@@ -16,7 +17,7 @@ import { rootRequest } from '../tasks/api_calls/common';
  * @returns the response from the setup module request
  */
 export const executeSetupModuleRequest = ({ moduleName }: { moduleName: string }) =>
-  rootRequest({
+  rootRequest<{ jobs: Array<{ success: boolean; error?: { status: number } }> }>({
     headers: {
       'elastic-api-version': 1,
     },
@@ -33,6 +34,23 @@ export const executeSetupModuleRequest = ({ moduleName }: { moduleName: string }
     },
   });
 
+/**
+ *
+ * Calls {@link executeSetupModuleRequest} until all jobs in the module are
+ * successfully set up.
+ * @param moduleName the name of the ML module to set up
+ * @returns the response from the setup module request
+ */
+export const setupMlModulesWithRetry = ({ moduleName }: { moduleName: string }) =>
+  recurse(
+    () => executeSetupModuleRequest({ moduleName }),
+    (response) =>
+      response.body.jobs.every(
+        (job) => job.success || (job.error?.status && job.error.status < 500)
+      ),
+    { delay: 1000 }
+  );
+
 /**
  *
  * Calls the internal ML Jobs API to force start the datafeeds for the given job IDs. Necessary to get them in the "started" state for the purposes of the detection engine