[Security Solution] Minimize the use of es_archiver on cypress tests #85019

MadameSheema · 2020-12-04T13:48:04Z

Summary

In this PR we are minimising the use of es_archiver creating the data we need when possible using our own APIs. Wit this refactor:

The execution of the tests is faster
Our tests are more reliable and less flaky
We need to maintain less data

x-pack/plugins/security_solution/cypress/integration/timelines_export.spec.ts

…_export.spec.ts Co-authored-by: Patryk Kopyciński <contact@patrykkopycinski.com>

patrykkopycinski · 2020-12-08T15:46:17Z

x-pack/plugins/security_solution/cypress/integration/timeline_templates_export.spec.ts

-        savedObjectId: timelineId,
-        templateTimelineId,
-      } = response!.body.data.persistTimeline.timeline;
+    const jsonTemplate = JSON.parse(JSON.stringify(template));


JSON.parse is opposite to JSON.stringify, so seems you don't need any of these as template is the same as JSON.parse(JSON.stringify(template))

patrykkopycinski · 2020-12-08T15:47:24Z

x-pack/plugins/security_solution/cypress/integration/alerts_detection_rules_export.spec.ts

    cy.intercept(
      'POST',
-      '/api/detection_engine/rules/_export?exclude_export_details=false&file_name=rules_export.ndjson'
+      '**api/detection_engine/rules/_export?exclude_export_details=false&file_name=rules_export.ndjson*'


no need for **

angorayc · 2020-12-08T17:48:31Z

x-pack/plugins/security_solution/cypress/objects/rule.ts

@@ -319,3 +320,9 @@ export const editedRule = {
  description: 'Edited Rule description',
  tags: [...existingRule.tags, 'edited'],
 };
+
+export const expectedExportedRule = (rule: string) => {
+  const jsonrule = JSON.parse(JSON.stringify(rule));


const jsonrule = rule; should be fine

angorayc · 2020-12-08T17:53:18Z

x-pack/plugins/security_solution/cypress/tasks/api_calls/timelines.ts

+    body: {
+      operationName: 'DeleteTimelineMutation',
+      variables: {
+        id: [`${timelineId}`],


seems timelineId is a string already, so we could just do [timelineId] here

MadameSheema · 2020-12-08T19:56:55Z

@elasticmachine merge upstream

kibanamachine · 2020-12-08T19:56:57Z

merge conflict between base and head

rylnd · 2020-12-09T00:23:30Z

@MadameSheema I'm getting test failures on usage of these new create* helpers:

As indicated by the error, I don't think we can return/await a promise as those helpers are currently expecting; if we need to pass information from the request to the test, we'll have to alias and retrieve the response.

rylnd · 2020-12-09T00:26:29Z

x-pack/plugins/security_solution/cypress/integration/alerts_detection_rules_custom.spec.ts

+
+  before(async () => {
+    const createdTimeline = await createTimeline(newRule.timeline);
+    rule = deepMerge(newRule, { timeline: { id: createdTimeline[0] } });


Nit: I don't think deepmerge is strictly necessary, here:

rule = { ...newRule, { timeline: { ...newRule.timeline, id: timelineId } } }

I would go that route for now and keep dependencies to a minimum.

rylnd · 2020-12-09T00:29:03Z

x-pack/plugins/security_solution/cypress/tasks/api_calls/timelines.ts

+  const timelineId = response.body.data.persistTimeline.timeline.savedObjectId;
+  const timelineBody = response.body.data.persistTimeline.timeline;
+
+  return [timelineId, timelineBody];


As per my comment about promises/errors, ideally these methods just return cy.request() and these custom types go away. However, in the case that they don't, I don't believe that timelineBody is a string here as the types indicate.

We also don't seem to be using timelineBody, so 🤷‍♂️

… into minimize-es-archiver

MadameSheema · 2020-12-09T10:34:41Z

@rylnd lots of thanks for taking a look to the code, with the latest changes the PR got really broke, I'm working to fix it ASAP

MadameSheema · 2020-12-09T10:42:35Z

@MadameSheema I'm getting test failures on usage of these new create* helpers:

As indicated by the error, I don't think we can return/await a promise as those helpers are currently expecting; if we need to pass information from the request to the test, we'll have to alias and retrieve the response.

@ryland with this library https://www.npmjs.com/package/cypress-promise we can pass variable to the tests in a better way than alias.

MadameSheema · 2020-12-09T15:26:34Z

@angorayc @patrykkopycinski @rylnd I tried to follow all your suggestions, can you please take a look to the PR again? Lots of thanks 😊

patrykkopycinski · 2020-12-09T15:50:00Z

x-pack/plugins/security_solution/cypress/integration/alerts_detection_exceptions.spec.ts

-          NUMBER_OF_AUDITBEAT_EXCEPTIONS_ALERTS
-        );
-      });
+    cy.get(NUMBER_OF_ALERTS).should('have.text', NUMBER_OF_AUDITBEAT_EXCEPTIONS_ALERTS);


MadameSheema · 2020-12-09T18:59:03Z

@elasticmachine merge upstream

patrykkopycinski

Thank you @MadameSheema 💪

… into minimize-es-archiver

kibanamachine · 2020-12-10T17:29:33Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request
Commit: ffc5cda

Metrics [docs]

Distributable file count

id	before	after	diff
`default`	47770	47769	-1

History

💔 Build #93503 failed 6bddf6d
💚 Build #93468 succeeded 7bfe997
💔 Build #93422 failed 06c4cb1
💚 Build #93225 succeeded a576b8a
💔 Build #93199 failed b5dc0b2

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

…lastic#85019) * minimizes the uses of es_archiver * refactor * fixes merge issue * fixes typecheck issue * Update x-pack/plugins/security_solution/cypress/integration/timelines_export.spec.ts Co-authored-by: Patryk Kopyciński <contact@patrykkopycinski.com> * final refactor * final touches * unskips skipped tests * removes async * fixes typo * removes unused lines * fixes failing test * fixes timelines failing tests * fixes merge issue Co-authored-by: Patryk Kopyciński <contact@patrykkopycinski.com> Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>

…85019) (#85612) * minimizes the uses of es_archiver * refactor * fixes merge issue * fixes typecheck issue * Update x-pack/plugins/security_solution/cypress/integration/timelines_export.spec.ts Co-authored-by: Patryk Kopyciński <contact@patrykkopycinski.com> * final refactor * final touches * unskips skipped tests * removes async * fixes typo * removes unused lines * fixes failing test * fixes timelines failing tests * fixes merge issue Co-authored-by: Patryk Kopyciński <contact@patrykkopycinski.com> Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com> Co-authored-by: Patryk Kopyciński <contact@patrykkopycinski.com> Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>

minimizes the uses of es_archiver

2eccf8a

MadameSheema force-pushed the minimize-es-archiver branch from ba61b7c to 2eccf8a Compare December 6, 2020 20:06

Merge branch 'master' into minimize-es-archiver

c650db6

MadameSheema changed the title ~~[Security Solution] Minimize es archiver~~ [Security Solution] Minimize the use of es_archiver on cypress tests Dec 7, 2020

MadameSheema self-assigned this Dec 7, 2020

MadameSheema added v7.11.0 v8.0.0 Team: SecuritySolution Security Solutions Team working on SIEM, Endpoint, Timeline, Resolver, etc. release_note:skip Skip the PR/issue when compiling release notes labels Dec 7, 2020

MadameSheema marked this pull request as ready for review December 7, 2020 11:34

MadameSheema requested review from a team as code owners December 7, 2020 11:34

MadameSheema requested review from IgorGuz2000 and achuguy December 7, 2020 11:34

MadameSheema added 5 commits December 8, 2020 09:11

Merge branch 'master' into minimize-es-archiver

b9689fd

refactor

4764ce6

Merge branch 'master' into minimize-es-archiver

50a382a

fixes merge issue

36714c3

fixes typecheck issue

765bd82

patrykkopycinski reviewed Dec 8, 2020

View reviewed changes

x-pack/plugins/security_solution/cypress/integration/timelines_export.spec.ts Outdated Show resolved Hide resolved

Update x-pack/plugins/security_solution/cypress/integration/timelines…

9f16b5c

…_export.spec.ts Co-authored-by: Patryk Kopyciński <contact@patrykkopycinski.com>

patrykkopycinski reviewed Dec 8, 2020

View reviewed changes

angorayc reviewed Dec 8, 2020

View reviewed changes

final refactor

4288b17

Merge branch 'master' into minimize-es-archiver

fd18b6b

rylnd reviewed Dec 9, 2020

View reviewed changes

MadameSheema added 2 commits December 9, 2020 10:54

Merge branch 'master' into minimize-es-archiver

2b217ec

Merge branch 'minimize-es-archiver' of github.com:MadameSheema/kibana…

1c2516e

… into minimize-es-archiver

MadameSheema added 2 commits December 9, 2020 16:03

final touches

9f86a29

unskips skipped tests

c6de6c7

removes async

a9875d6

patrykkopycinski reviewed Dec 9, 2020

View reviewed changes

MadameSheema added 3 commits December 9, 2020 16:53

fixes typo

8bd1336

removes unused lines

e67eaab

fixes failing test

b5dc0b2

Merge branch 'master' into minimize-es-archiver

a576b8a

patrykkopycinski approved these changes Dec 10, 2020

View reviewed changes

MadameSheema added 5 commits December 10, 2020 11:28

Merge branch 'master' into minimize-es-archiver

8c3e4bb

Merge branch 'minimize-es-archiver' of github.com:MadameSheema/kibana…

06c4cb1

… into minimize-es-archiver

fixes timelines failing tests

7bfe997

Merge branch 'master' into minimize-es-archiver

6bddf6d

fixes merge issue

ffc5cda

MadameSheema merged commit 1b5d43b into elastic:master Dec 10, 2020

MadameSheema deleted the minimize-es-archiver branch December 10, 2020 17:31

MadameSheema mentioned this pull request Dec 10, 2020

[7.x] [Security Solution] Minimize the use of es_archiver on cypress tests (#85019) #85612

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Security Solution] Minimize the use of es_archiver on cypress tests #85019

[Security Solution] Minimize the use of es_archiver on cypress tests #85019

MadameSheema commented Dec 4, 2020 •

edited

Loading

patrykkopycinski Dec 8, 2020

patrykkopycinski Dec 8, 2020

angorayc Dec 8, 2020

angorayc Dec 8, 2020

MadameSheema commented Dec 8, 2020

kibanamachine commented Dec 8, 2020

rylnd commented Dec 9, 2020

rylnd Dec 9, 2020

rylnd Dec 9, 2020 •

edited

Loading

rylnd Dec 9, 2020

MadameSheema commented Dec 9, 2020

MadameSheema commented Dec 9, 2020

MadameSheema commented Dec 9, 2020

patrykkopycinski Dec 9, 2020

MadameSheema commented Dec 9, 2020

patrykkopycinski left a comment

kibanamachine commented Dec 10, 2020

[Security Solution] Minimize the use of es_archiver on cypress tests #85019

[Security Solution] Minimize the use of es_archiver on cypress tests #85019

Conversation

MadameSheema commented Dec 4, 2020 • edited Loading

Summary

patrykkopycinski Dec 8, 2020

Choose a reason for hiding this comment

patrykkopycinski Dec 8, 2020

Choose a reason for hiding this comment

angorayc Dec 8, 2020

Choose a reason for hiding this comment

angorayc Dec 8, 2020

Choose a reason for hiding this comment

MadameSheema commented Dec 8, 2020

kibanamachine commented Dec 8, 2020

rylnd commented Dec 9, 2020

rylnd Dec 9, 2020

Choose a reason for hiding this comment

rylnd Dec 9, 2020 • edited Loading

Choose a reason for hiding this comment

rylnd Dec 9, 2020

Choose a reason for hiding this comment

MadameSheema commented Dec 9, 2020

MadameSheema commented Dec 9, 2020

MadameSheema commented Dec 9, 2020

patrykkopycinski Dec 9, 2020

Choose a reason for hiding this comment

MadameSheema commented Dec 9, 2020

patrykkopycinski left a comment

Choose a reason for hiding this comment

kibanamachine commented Dec 10, 2020

💚 Build Succeeded

Metrics [docs]

Distributable file count

History

MadameSheema commented Dec 4, 2020 •

edited

Loading

rylnd Dec 9, 2020 •

edited

Loading