[SIEM] Updates cypress readme with documentation about the test data. #62747
Conversation
MadameSheema
added
Team:SIEM
v8.0.0
release_note:skip
|
Pinging @elastic/siem (Team:SIEM) |
|
@MadameSheema tangential to this PR, but: I think we need another pass on this README now that we've consolidated on the "run against es_archiver data" approach. While we now mention (in passing) that this is the "preferred" approach, we still dedicate a large section of the README to running tests against a local cluster without mentioning potential pitfalls there. For example, does it:
As I mentioned in a previous comment, I realize that workflow has a legitimate use case, but I think that use case (and the above) needs to be clarified in the documentation. Speaking from personal experience: at one point I ran the tests against my local indexes and it unexpectedly modified my data. I then had to rebuild said data in order to continue development, and I have not run tests in that manner since. |
| @@ -111,6 +111,112 @@ elasticsearch: | |||
| hosts: ['https://<server>:9200'] | |||
| ``` | |||
|
|
|||
| ## Running (Headless) Tests on the Command Line as a Jenkins execution (The preferred way) | |||
There was a problem hiding this comment.
Are "headless" and "as a jenkins execution" meaningful qualifiers for the audience of this document? In my mind I see two workflows that require documentation:
- Developers that want to run cypress tests locally, without waiting for CI (i.e. "executing cypress CI locally")
- Developers that are developing new tests, or debugging existing tests (i.e. "developing/debugging cypress tests")
For the first workflow, the only configuration that should be needed is "which test(s) to run." It would be nice to simplify the DX here and encapsulate this with a script that devs can run.
For the development/debugging workflow, there's a legitimate use case for stopping execution/modifying data/isolating tests, and my preference would be to organize this README from a workflow-centric perspective (but we can do that iteratively).
|
|
||
| Note that loading and unloading data takes a signifcant amount of time so try to minimize the use of it when possible. | ||
|
|
||
| ### Current sets of data |
There was a problem hiding this comment.
Does es_archiver have a term for this? "dataset" or "archive" or "data archive"? It would help legibility to have consistent terminology (and perhaps even a glossary if necessary).
There was a problem hiding this comment.
++ for settling on consistent terminology - from the help docs it looks like it's just archive.
There was a problem hiding this comment.
Thanks! I'll open another PR to rename it from es_archives to archive since we have to change some functions names as well :)
Co-Authored-By: Ryland Herrick <ryalnd@gmail.com>
…elastic#62747) * updates test data section * Update x-pack/legacy/plugins/siem/cypress/README.md Co-Authored-By: Ryland Herrick <ryalnd@gmail.com> Co-authored-by: Ryland Herrick <ryalnd@gmail.com>
…elastic#62747) * updates test data section * Update x-pack/legacy/plugins/siem/cypress/README.md Co-Authored-By: Ryland Herrick <ryalnd@gmail.com> Co-authored-by: Ryland Herrick <ryalnd@gmail.com>
MindyRS
added
the
Team: SecuritySolution
|
Pinging @elastic/security-solution (Team: SecuritySolution) |
Summary
Updates cypress readme with documentation about the test data needed for the cypress tests to run in jenkins mode.