Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[8.15] [Detection Engine] Fix flake in ML Rule Cypress tests (#188164) #188483

Merged
merged 1 commit into from
Jul 16, 2024
Merged

[8.15] [Detection Engine] Fix flake in ML Rule Cypress tests (#188164) #188483

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions ...detection_response/detection_engine/rule_creation/machine_learning_rule_suppression.cy.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,9 @@ import {
SUPPRESS_MISSING_FIELD,
} from '../../../../screens/rule_details';
import {
executeSetupModuleRequest,
forceStartDatafeeds,
forceStopAndCloseJob,
setupMlModulesWithRetry,
} from '../../../../support/machine_learning';
import {
continueFromDefineStep,
Expand Down Expand Up @@ -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' });
});
Expand Down
4 changes: 2 additions & 2 deletions ...ess/cypress/e2e/detection_response/detection_engine/rule_edit/machine_learning_rule.cy.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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';
Expand Down Expand Up @@ -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' });
});
Expand Down
20 changes: 19 additions & 1 deletion x-pack/test/security_solution_cypress/cypress/support/machine_learning.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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';

Expand All @@ -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,
},
Expand All @@ -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
Expand Down