-
Notifications
You must be signed in to change notification settings - Fork 8.3k
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.
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
[Security Solution] Refactor prebuilt rule customization test plans, part 2 #211472
[Security Solution] Refactor prebuilt rule customization test plans, part 2 #211472
Conversation
fba6999
to
f9f417e
Compare
Pinging @elastic/security-detections-response (Team:Detections and Resp) |
Pinging @elastic/security-solution (Team: SecuritySolution) |
Pinging @elastic/security-detection-rule-management (Team:Detection Rule Management) |
💚 Build Succeeded
cc @banderror |
f9f417e
to
a63fd92
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM @banderror, much more readable without needing as much initial context. Just left a few minor comments
...ecurity_solution/docs/testing/test_plans/detection_response/prebuilt_rules/prebuilt_rules.md
Outdated
Show resolved
Hide resolved
...ion/docs/testing/test_plans/detection_response/prebuilt_rules/prebuilt_rule_customization.md
Show resolved
Hide resolved
…or prebuilt rules
a63fd92
to
fe9d450
Compare
Starting backport for target branches: 8.18, 8.x, 9.0 |
…part 2 (elastic#211472) **Epic:** elastic#174168 **Partially addresses:** elastic#202068, elastic#202078, elastic#202079 **Follow-up to:** elastic#211300 ## Summary We're cleaning up and refactoring our existing test plans for prebuilt rule customization, upgrade, and export/import workflows. Specifically, this PR: - Creates an "entrypoint" file that should help navigate all the test plans for prebuilt rules. - Creates a file for keeping common information about prebuilt rules that can be shared between the test plans. - Extracts duplicated terminology to the file with common information. - Extracts duplicated assumptions to the file with common information. - Extracts duplicated non-functional requirements to the file with common information. - Adds user stories to each test plan. - Updates links to tickets in every test plan. No "functional" changes have been made to any test plans, such as adding, removing, or updating any scenarios. This refactoring prepares the test plans for being "functionally" changed and improved in follow-up PRs. For example, we're going to cover the logic described in elastic#210358 and address any other gaps in coverage. ## Review tip It might be easier to review this PR commit-by-commit as each of them contains logically cohesive changes. (cherry picked from commit 786df79)
…part 2 (elastic#211472) **Epic:** elastic#174168 **Partially addresses:** elastic#202068, elastic#202078, elastic#202079 **Follow-up to:** elastic#211300 ## Summary We're cleaning up and refactoring our existing test plans for prebuilt rule customization, upgrade, and export/import workflows. Specifically, this PR: - Creates an "entrypoint" file that should help navigate all the test plans for prebuilt rules. - Creates a file for keeping common information about prebuilt rules that can be shared between the test plans. - Extracts duplicated terminology to the file with common information. - Extracts duplicated assumptions to the file with common information. - Extracts duplicated non-functional requirements to the file with common information. - Adds user stories to each test plan. - Updates links to tickets in every test plan. No "functional" changes have been made to any test plans, such as adding, removing, or updating any scenarios. This refactoring prepares the test plans for being "functionally" changed and improved in follow-up PRs. For example, we're going to cover the logic described in elastic#210358 and address any other gaps in coverage. ## Review tip It might be easier to review this PR commit-by-commit as each of them contains logically cohesive changes. (cherry picked from commit 786df79)
…part 2 (elastic#211472) **Epic:** elastic#174168 **Partially addresses:** elastic#202068, elastic#202078, elastic#202079 **Follow-up to:** elastic#211300 ## Summary We're cleaning up and refactoring our existing test plans for prebuilt rule customization, upgrade, and export/import workflows. Specifically, this PR: - Creates an "entrypoint" file that should help navigate all the test plans for prebuilt rules. - Creates a file for keeping common information about prebuilt rules that can be shared between the test plans. - Extracts duplicated terminology to the file with common information. - Extracts duplicated assumptions to the file with common information. - Extracts duplicated non-functional requirements to the file with common information. - Adds user stories to each test plan. - Updates links to tickets in every test plan. No "functional" changes have been made to any test plans, such as adding, removing, or updating any scenarios. This refactoring prepares the test plans for being "functionally" changed and improved in follow-up PRs. For example, we're going to cover the logic described in elastic#210358 and address any other gaps in coverage. ## Review tip It might be easier to review this PR commit-by-commit as each of them contains logically cohesive changes. (cherry picked from commit 786df79)
💚 All backports created successfully
Note: Successful backport PRs will be merged automatically after passing CI. Questions ?Please refer to the Backport tool documentation |
…plans, part 2 (#211472) (#211649) # Backport This will backport the following commits from `main` to `8.18`: - [[Security Solution] Refactor prebuilt rule customization test plans, part 2 (#211472)](#211472) <!--- Backport version: 9.6.6 --> ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sorenlouv/backport) <!--BACKPORT [{"author":{"name":"Georgii Gorbachev","email":"georgii.gorbachev@elastic.co"},"sourceCommit":{"committedDate":"2025-02-18T20:34:15Z","message":"[Security Solution] Refactor prebuilt rule customization test plans, part 2 (#211472)\n\n**Epic:** https://github.com/elastic/kibana/issues/174168\r\n**Partially addresses:**\r\nhttps://github.com//issues/202068,\r\nhttps://github.com//issues/202078,\r\nhttps://github.com//issues/202079\r\n**Follow-up to:** https://github.com/elastic/kibana/pull/211300\r\n\r\n## Summary\r\n\r\nWe're cleaning up and refactoring our existing test plans for prebuilt\r\nrule customization, upgrade, and export/import workflows.\r\n\r\nSpecifically, this PR:\r\n\r\n- Creates an \"entrypoint\" file that should help navigate all the test\r\nplans for prebuilt rules.\r\n- Creates a file for keeping common information about prebuilt rules\r\nthat can be shared between the test plans.\r\n- Extracts duplicated terminology to the file with common information.\r\n- Extracts duplicated assumptions to the file with common information.\r\n- Extracts duplicated non-functional requirements to the file with\r\ncommon information.\r\n- Adds user stories to each test plan.\r\n- Updates links to tickets in every test plan.\r\n\r\nNo \"functional\" changes have been made to any test plans, such as\r\nadding, removing, or updating any scenarios.\r\n\r\nThis refactoring prepares the test plans for being \"functionally\"\r\nchanged and improved in follow-up PRs. For example, we're going to cover\r\nthe logic described in https://github.com/elastic/kibana/issues/210358\r\nand address any other gaps in coverage.\r\n\r\n## Review tip\r\n\r\nIt might be easier to review this PR commit-by-commit as each of them\r\ncontains logically cohesive changes.","sha":"786df79f37642b8ddf214e086a3375204ec63a3b","branchLabelMapping":{"^v9.1.0$":"main","^v8.19.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","test-plan","v9.0.0","Team:Detections and Resp","Team: SecuritySolution","Team:Detection Rule Management","Feature:Prebuilt Detection Rules","backport:version","v8.18.0","v9.1.0","v8.19.0"],"title":"[Security Solution] Refactor prebuilt rule customization test plans, part 2","number":211472,"url":"https://github.com/elastic/kibana/pull/211472","mergeCommit":{"message":"[Security Solution] Refactor prebuilt rule customization test plans, part 2 (#211472)\n\n**Epic:** https://github.com/elastic/kibana/issues/174168\r\n**Partially addresses:**\r\nhttps://github.com//issues/202068,\r\nhttps://github.com//issues/202078,\r\nhttps://github.com//issues/202079\r\n**Follow-up to:** https://github.com/elastic/kibana/pull/211300\r\n\r\n## Summary\r\n\r\nWe're cleaning up and refactoring our existing test plans for prebuilt\r\nrule customization, upgrade, and export/import workflows.\r\n\r\nSpecifically, this PR:\r\n\r\n- Creates an \"entrypoint\" file that should help navigate all the test\r\nplans for prebuilt rules.\r\n- Creates a file for keeping common information about prebuilt rules\r\nthat can be shared between the test plans.\r\n- Extracts duplicated terminology to the file with common information.\r\n- Extracts duplicated assumptions to the file with common information.\r\n- Extracts duplicated non-functional requirements to the file with\r\ncommon information.\r\n- Adds user stories to each test plan.\r\n- Updates links to tickets in every test plan.\r\n\r\nNo \"functional\" changes have been made to any test plans, such as\r\nadding, removing, or updating any scenarios.\r\n\r\nThis refactoring prepares the test plans for being \"functionally\"\r\nchanged and improved in follow-up PRs. For example, we're going to cover\r\nthe logic described in https://github.com/elastic/kibana/issues/210358\r\nand address any other gaps in coverage.\r\n\r\n## Review tip\r\n\r\nIt might be easier to review this PR commit-by-commit as each of them\r\ncontains logically cohesive changes.","sha":"786df79f37642b8ddf214e086a3375204ec63a3b"}},"sourceBranch":"main","suggestedTargetBranches":["9.0","8.18","8.x"],"targetPullRequestStates":[{"branch":"9.0","label":"v9.0.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.18","label":"v8.18.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"main","label":"v9.1.0","branchLabelMappingKey":"^v9.1.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/211472","number":211472,"mergeCommit":{"message":"[Security Solution] Refactor prebuilt rule customization test plans, part 2 (#211472)\n\n**Epic:** https://github.com/elastic/kibana/issues/174168\r\n**Partially addresses:**\r\nhttps://github.com//issues/202068,\r\nhttps://github.com//issues/202078,\r\nhttps://github.com//issues/202079\r\n**Follow-up to:** https://github.com/elastic/kibana/pull/211300\r\n\r\n## Summary\r\n\r\nWe're cleaning up and refactoring our existing test plans for prebuilt\r\nrule customization, upgrade, and export/import workflows.\r\n\r\nSpecifically, this PR:\r\n\r\n- Creates an \"entrypoint\" file that should help navigate all the test\r\nplans for prebuilt rules.\r\n- Creates a file for keeping common information about prebuilt rules\r\nthat can be shared between the test plans.\r\n- Extracts duplicated terminology to the file with common information.\r\n- Extracts duplicated assumptions to the file with common information.\r\n- Extracts duplicated non-functional requirements to the file with\r\ncommon information.\r\n- Adds user stories to each test plan.\r\n- Updates links to tickets in every test plan.\r\n\r\nNo \"functional\" changes have been made to any test plans, such as\r\nadding, removing, or updating any scenarios.\r\n\r\nThis refactoring prepares the test plans for being \"functionally\"\r\nchanged and improved in follow-up PRs. For example, we're going to cover\r\nthe logic described in https://github.com/elastic/kibana/issues/210358\r\nand address any other gaps in coverage.\r\n\r\n## Review tip\r\n\r\nIt might be easier to review this PR commit-by-commit as each of them\r\ncontains logically cohesive changes.","sha":"786df79f37642b8ddf214e086a3375204ec63a3b"}},{"branch":"8.x","label":"v8.19.0","branchLabelMappingKey":"^v8.19.0$","isSourceBranch":false,"state":"NOT_CREATED"}]}] BACKPORT--> Co-authored-by: Georgii Gorbachev <georgii.gorbachev@elastic.co>
…lans, part 2 (#211472) (#211651) # Backport This will backport the following commits from `main` to `9.0`: - [[Security Solution] Refactor prebuilt rule customization test plans, part 2 (#211472)](#211472) <!--- Backport version: 9.6.6 --> ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sorenlouv/backport) <!--BACKPORT [{"author":{"name":"Georgii Gorbachev","email":"georgii.gorbachev@elastic.co"},"sourceCommit":{"committedDate":"2025-02-18T20:34:15Z","message":"[Security Solution] Refactor prebuilt rule customization test plans, part 2 (#211472)\n\n**Epic:** https://github.com/elastic/kibana/issues/174168\r\n**Partially addresses:**\r\nhttps://github.com//issues/202068,\r\nhttps://github.com//issues/202078,\r\nhttps://github.com//issues/202079\r\n**Follow-up to:** https://github.com/elastic/kibana/pull/211300\r\n\r\n## Summary\r\n\r\nWe're cleaning up and refactoring our existing test plans for prebuilt\r\nrule customization, upgrade, and export/import workflows.\r\n\r\nSpecifically, this PR:\r\n\r\n- Creates an \"entrypoint\" file that should help navigate all the test\r\nplans for prebuilt rules.\r\n- Creates a file for keeping common information about prebuilt rules\r\nthat can be shared between the test plans.\r\n- Extracts duplicated terminology to the file with common information.\r\n- Extracts duplicated assumptions to the file with common information.\r\n- Extracts duplicated non-functional requirements to the file with\r\ncommon information.\r\n- Adds user stories to each test plan.\r\n- Updates links to tickets in every test plan.\r\n\r\nNo \"functional\" changes have been made to any test plans, such as\r\nadding, removing, or updating any scenarios.\r\n\r\nThis refactoring prepares the test plans for being \"functionally\"\r\nchanged and improved in follow-up PRs. For example, we're going to cover\r\nthe logic described in https://github.com/elastic/kibana/issues/210358\r\nand address any other gaps in coverage.\r\n\r\n## Review tip\r\n\r\nIt might be easier to review this PR commit-by-commit as each of them\r\ncontains logically cohesive changes.","sha":"786df79f37642b8ddf214e086a3375204ec63a3b","branchLabelMapping":{"^v9.1.0$":"main","^v8.19.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","test-plan","v9.0.0","Team:Detections and Resp","Team: SecuritySolution","Team:Detection Rule Management","Feature:Prebuilt Detection Rules","backport:version","v8.18.0","v9.1.0","v8.19.0"],"title":"[Security Solution] Refactor prebuilt rule customization test plans, part 2","number":211472,"url":"https://github.com/elastic/kibana/pull/211472","mergeCommit":{"message":"[Security Solution] Refactor prebuilt rule customization test plans, part 2 (#211472)\n\n**Epic:** https://github.com/elastic/kibana/issues/174168\r\n**Partially addresses:**\r\nhttps://github.com//issues/202068,\r\nhttps://github.com//issues/202078,\r\nhttps://github.com//issues/202079\r\n**Follow-up to:** https://github.com/elastic/kibana/pull/211300\r\n\r\n## Summary\r\n\r\nWe're cleaning up and refactoring our existing test plans for prebuilt\r\nrule customization, upgrade, and export/import workflows.\r\n\r\nSpecifically, this PR:\r\n\r\n- Creates an \"entrypoint\" file that should help navigate all the test\r\nplans for prebuilt rules.\r\n- Creates a file for keeping common information about prebuilt rules\r\nthat can be shared between the test plans.\r\n- Extracts duplicated terminology to the file with common information.\r\n- Extracts duplicated assumptions to the file with common information.\r\n- Extracts duplicated non-functional requirements to the file with\r\ncommon information.\r\n- Adds user stories to each test plan.\r\n- Updates links to tickets in every test plan.\r\n\r\nNo \"functional\" changes have been made to any test plans, such as\r\nadding, removing, or updating any scenarios.\r\n\r\nThis refactoring prepares the test plans for being \"functionally\"\r\nchanged and improved in follow-up PRs. For example, we're going to cover\r\nthe logic described in https://github.com/elastic/kibana/issues/210358\r\nand address any other gaps in coverage.\r\n\r\n## Review tip\r\n\r\nIt might be easier to review this PR commit-by-commit as each of them\r\ncontains logically cohesive changes.","sha":"786df79f37642b8ddf214e086a3375204ec63a3b"}},"sourceBranch":"main","suggestedTargetBranches":["9.0","8.18","8.x"],"targetPullRequestStates":[{"branch":"9.0","label":"v9.0.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.18","label":"v8.18.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"main","label":"v9.1.0","branchLabelMappingKey":"^v9.1.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/211472","number":211472,"mergeCommit":{"message":"[Security Solution] Refactor prebuilt rule customization test plans, part 2 (#211472)\n\n**Epic:** https://github.com/elastic/kibana/issues/174168\r\n**Partially addresses:**\r\nhttps://github.com//issues/202068,\r\nhttps://github.com//issues/202078,\r\nhttps://github.com//issues/202079\r\n**Follow-up to:** https://github.com/elastic/kibana/pull/211300\r\n\r\n## Summary\r\n\r\nWe're cleaning up and refactoring our existing test plans for prebuilt\r\nrule customization, upgrade, and export/import workflows.\r\n\r\nSpecifically, this PR:\r\n\r\n- Creates an \"entrypoint\" file that should help navigate all the test\r\nplans for prebuilt rules.\r\n- Creates a file for keeping common information about prebuilt rules\r\nthat can be shared between the test plans.\r\n- Extracts duplicated terminology to the file with common information.\r\n- Extracts duplicated assumptions to the file with common information.\r\n- Extracts duplicated non-functional requirements to the file with\r\ncommon information.\r\n- Adds user stories to each test plan.\r\n- Updates links to tickets in every test plan.\r\n\r\nNo \"functional\" changes have been made to any test plans, such as\r\nadding, removing, or updating any scenarios.\r\n\r\nThis refactoring prepares the test plans for being \"functionally\"\r\nchanged and improved in follow-up PRs. For example, we're going to cover\r\nthe logic described in https://github.com/elastic/kibana/issues/210358\r\nand address any other gaps in coverage.\r\n\r\n## Review tip\r\n\r\nIt might be easier to review this PR commit-by-commit as each of them\r\ncontains logically cohesive changes.","sha":"786df79f37642b8ddf214e086a3375204ec63a3b"}},{"branch":"8.x","label":"v8.19.0","branchLabelMappingKey":"^v8.19.0$","isSourceBranch":false,"state":"NOT_CREATED"}]}] BACKPORT--> Co-authored-by: Georgii Gorbachev <georgii.gorbachev@elastic.co>
…lans, part 2 (#211472) (#211650) # Backport This will backport the following commits from `main` to `8.x`: - [[Security Solution] Refactor prebuilt rule customization test plans, part 2 (#211472)](#211472) <!--- Backport version: 9.6.6 --> ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sorenlouv/backport) <!--BACKPORT [{"author":{"name":"Georgii Gorbachev","email":"georgii.gorbachev@elastic.co"},"sourceCommit":{"committedDate":"2025-02-18T20:34:15Z","message":"[Security Solution] Refactor prebuilt rule customization test plans, part 2 (#211472)\n\n**Epic:** https://github.com/elastic/kibana/issues/174168\r\n**Partially addresses:**\r\nhttps://github.com//issues/202068,\r\nhttps://github.com//issues/202078,\r\nhttps://github.com//issues/202079\r\n**Follow-up to:** https://github.com/elastic/kibana/pull/211300\r\n\r\n## Summary\r\n\r\nWe're cleaning up and refactoring our existing test plans for prebuilt\r\nrule customization, upgrade, and export/import workflows.\r\n\r\nSpecifically, this PR:\r\n\r\n- Creates an \"entrypoint\" file that should help navigate all the test\r\nplans for prebuilt rules.\r\n- Creates a file for keeping common information about prebuilt rules\r\nthat can be shared between the test plans.\r\n- Extracts duplicated terminology to the file with common information.\r\n- Extracts duplicated assumptions to the file with common information.\r\n- Extracts duplicated non-functional requirements to the file with\r\ncommon information.\r\n- Adds user stories to each test plan.\r\n- Updates links to tickets in every test plan.\r\n\r\nNo \"functional\" changes have been made to any test plans, such as\r\nadding, removing, or updating any scenarios.\r\n\r\nThis refactoring prepares the test plans for being \"functionally\"\r\nchanged and improved in follow-up PRs. For example, we're going to cover\r\nthe logic described in https://github.com/elastic/kibana/issues/210358\r\nand address any other gaps in coverage.\r\n\r\n## Review tip\r\n\r\nIt might be easier to review this PR commit-by-commit as each of them\r\ncontains logically cohesive changes.","sha":"786df79f37642b8ddf214e086a3375204ec63a3b","branchLabelMapping":{"^v9.1.0$":"main","^v8.19.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","test-plan","v9.0.0","Team:Detections and Resp","Team: SecuritySolution","Team:Detection Rule Management","Feature:Prebuilt Detection Rules","backport:version","v8.18.0","v9.1.0","v8.19.0"],"title":"[Security Solution] Refactor prebuilt rule customization test plans, part 2","number":211472,"url":"https://github.com/elastic/kibana/pull/211472","mergeCommit":{"message":"[Security Solution] Refactor prebuilt rule customization test plans, part 2 (#211472)\n\n**Epic:** https://github.com/elastic/kibana/issues/174168\r\n**Partially addresses:**\r\nhttps://github.com//issues/202068,\r\nhttps://github.com//issues/202078,\r\nhttps://github.com//issues/202079\r\n**Follow-up to:** https://github.com/elastic/kibana/pull/211300\r\n\r\n## Summary\r\n\r\nWe're cleaning up and refactoring our existing test plans for prebuilt\r\nrule customization, upgrade, and export/import workflows.\r\n\r\nSpecifically, this PR:\r\n\r\n- Creates an \"entrypoint\" file that should help navigate all the test\r\nplans for prebuilt rules.\r\n- Creates a file for keeping common information about prebuilt rules\r\nthat can be shared between the test plans.\r\n- Extracts duplicated terminology to the file with common information.\r\n- Extracts duplicated assumptions to the file with common information.\r\n- Extracts duplicated non-functional requirements to the file with\r\ncommon information.\r\n- Adds user stories to each test plan.\r\n- Updates links to tickets in every test plan.\r\n\r\nNo \"functional\" changes have been made to any test plans, such as\r\nadding, removing, or updating any scenarios.\r\n\r\nThis refactoring prepares the test plans for being \"functionally\"\r\nchanged and improved in follow-up PRs. For example, we're going to cover\r\nthe logic described in https://github.com/elastic/kibana/issues/210358\r\nand address any other gaps in coverage.\r\n\r\n## Review tip\r\n\r\nIt might be easier to review this PR commit-by-commit as each of them\r\ncontains logically cohesive changes.","sha":"786df79f37642b8ddf214e086a3375204ec63a3b"}},"sourceBranch":"main","suggestedTargetBranches":["9.0","8.18","8.x"],"targetPullRequestStates":[{"branch":"9.0","label":"v9.0.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.18","label":"v8.18.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"main","label":"v9.1.0","branchLabelMappingKey":"^v9.1.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/211472","number":211472,"mergeCommit":{"message":"[Security Solution] Refactor prebuilt rule customization test plans, part 2 (#211472)\n\n**Epic:** https://github.com/elastic/kibana/issues/174168\r\n**Partially addresses:**\r\nhttps://github.com//issues/202068,\r\nhttps://github.com//issues/202078,\r\nhttps://github.com//issues/202079\r\n**Follow-up to:** https://github.com/elastic/kibana/pull/211300\r\n\r\n## Summary\r\n\r\nWe're cleaning up and refactoring our existing test plans for prebuilt\r\nrule customization, upgrade, and export/import workflows.\r\n\r\nSpecifically, this PR:\r\n\r\n- Creates an \"entrypoint\" file that should help navigate all the test\r\nplans for prebuilt rules.\r\n- Creates a file for keeping common information about prebuilt rules\r\nthat can be shared between the test plans.\r\n- Extracts duplicated terminology to the file with common information.\r\n- Extracts duplicated assumptions to the file with common information.\r\n- Extracts duplicated non-functional requirements to the file with\r\ncommon information.\r\n- Adds user stories to each test plan.\r\n- Updates links to tickets in every test plan.\r\n\r\nNo \"functional\" changes have been made to any test plans, such as\r\nadding, removing, or updating any scenarios.\r\n\r\nThis refactoring prepares the test plans for being \"functionally\"\r\nchanged and improved in follow-up PRs. For example, we're going to cover\r\nthe logic described in https://github.com/elastic/kibana/issues/210358\r\nand address any other gaps in coverage.\r\n\r\n## Review tip\r\n\r\nIt might be easier to review this PR commit-by-commit as each of them\r\ncontains logically cohesive changes.","sha":"786df79f37642b8ddf214e086a3375204ec63a3b"}},{"branch":"8.x","label":"v8.19.0","branchLabelMappingKey":"^v8.19.0$","isSourceBranch":false,"state":"NOT_CREATED"}]}] BACKPORT--> Co-authored-by: Georgii Gorbachev <georgii.gorbachev@elastic.co>
…part 3 (#212420) **Epic:** #174168 **Partially addresses:** #202068, #202078, #202079 **Follow-up to:** #211472 ## Summary We're cleaning up and refactoring our existing test plans for prebuilt rule customization, upgrade, and export/import workflows. Specifically, this PR: - Updates the common structure of test plans: - Adds a tip to each test plan's header to help with navigating all our test plans for prebuilt rules. - Introduces a new `Requirements` section to each one and consolidates assumptions, technical requirements and product requirements under it. - Each `Product requirements` section now contains relevant user stories and other product details. In the document flow this is kept close to the `Scenarios` section. - Updates the test plan template according to the updated structure. - Moves the documentation about customizable and non-customizable rule fields to the common info document. - Restores the lost changes from commit bde4612. No "functional" changes have been made to any test plans, such as adding, removing, or updating any scenarios. The only functional-like changes were made to the user stories when creating/updating the product requirements sections. This PR wraps up the refactoring efforts aimed to prepare the test plans for being "functionally" changed and improved in follow-up PRs. In the following PRs, we're going to cover the logic described in #210358, address any gaps in the coverage, and improve the scenarios structure and wording. ## Review tip It might be easier to review this PR commit-by-commit as each of them contains logically cohesive changes.
…part 3 (elastic#212420) **Epic:** elastic#174168 **Partially addresses:** elastic#202068, elastic#202078, elastic#202079 **Follow-up to:** elastic#211472 ## Summary We're cleaning up and refactoring our existing test plans for prebuilt rule customization, upgrade, and export/import workflows. Specifically, this PR: - Updates the common structure of test plans: - Adds a tip to each test plan's header to help with navigating all our test plans for prebuilt rules. - Introduces a new `Requirements` section to each one and consolidates assumptions, technical requirements and product requirements under it. - Each `Product requirements` section now contains relevant user stories and other product details. In the document flow this is kept close to the `Scenarios` section. - Updates the test plan template according to the updated structure. - Moves the documentation about customizable and non-customizable rule fields to the common info document. - Restores the lost changes from commit elastic@bde4612. No "functional" changes have been made to any test plans, such as adding, removing, or updating any scenarios. The only functional-like changes were made to the user stories when creating/updating the product requirements sections. This PR wraps up the refactoring efforts aimed to prepare the test plans for being "functionally" changed and improved in follow-up PRs. In the following PRs, we're going to cover the logic described in elastic#210358, address any gaps in the coverage, and improve the scenarios structure and wording. ## Review tip It might be easier to review this PR commit-by-commit as each of them contains logically cohesive changes. (cherry picked from commit c961659)
…part 3 (elastic#212420) **Epic:** elastic#174168 **Partially addresses:** elastic#202068, elastic#202078, elastic#202079 **Follow-up to:** elastic#211472 ## Summary We're cleaning up and refactoring our existing test plans for prebuilt rule customization, upgrade, and export/import workflows. Specifically, this PR: - Updates the common structure of test plans: - Adds a tip to each test plan's header to help with navigating all our test plans for prebuilt rules. - Introduces a new `Requirements` section to each one and consolidates assumptions, technical requirements and product requirements under it. - Each `Product requirements` section now contains relevant user stories and other product details. In the document flow this is kept close to the `Scenarios` section. - Updates the test plan template according to the updated structure. - Moves the documentation about customizable and non-customizable rule fields to the common info document. - Restores the lost changes from commit elastic@bde4612. No "functional" changes have been made to any test plans, such as adding, removing, or updating any scenarios. The only functional-like changes were made to the user stories when creating/updating the product requirements sections. This PR wraps up the refactoring efforts aimed to prepare the test plans for being "functionally" changed and improved in follow-up PRs. In the following PRs, we're going to cover the logic described in elastic#210358, address any gaps in the coverage, and improve the scenarios structure and wording. ## Review tip It might be easier to review this PR commit-by-commit as each of them contains logically cohesive changes. (cherry picked from commit c961659)
…part 3 (elastic#212420) **Epic:** elastic#174168 **Partially addresses:** elastic#202068, elastic#202078, elastic#202079 **Follow-up to:** elastic#211472 ## Summary We're cleaning up and refactoring our existing test plans for prebuilt rule customization, upgrade, and export/import workflows. Specifically, this PR: - Updates the common structure of test plans: - Adds a tip to each test plan's header to help with navigating all our test plans for prebuilt rules. - Introduces a new `Requirements` section to each one and consolidates assumptions, technical requirements and product requirements under it. - Each `Product requirements` section now contains relevant user stories and other product details. In the document flow this is kept close to the `Scenarios` section. - Updates the test plan template according to the updated structure. - Moves the documentation about customizable and non-customizable rule fields to the common info document. - Restores the lost changes from commit elastic@bde4612. No "functional" changes have been made to any test plans, such as adding, removing, or updating any scenarios. The only functional-like changes were made to the user stories when creating/updating the product requirements sections. This PR wraps up the refactoring efforts aimed to prepare the test plans for being "functionally" changed and improved in follow-up PRs. In the following PRs, we're going to cover the logic described in elastic#210358, address any gaps in the coverage, and improve the scenarios structure and wording. ## Review tip It might be easier to review this PR commit-by-commit as each of them contains logically cohesive changes. (cherry picked from commit c961659)
…part 3 (elastic#212420) **Epic:** elastic#174168 **Partially addresses:** elastic#202068, elastic#202078, elastic#202079 **Follow-up to:** elastic#211472 ## Summary We're cleaning up and refactoring our existing test plans for prebuilt rule customization, upgrade, and export/import workflows. Specifically, this PR: - Updates the common structure of test plans: - Adds a tip to each test plan's header to help with navigating all our test plans for prebuilt rules. - Introduces a new `Requirements` section to each one and consolidates assumptions, technical requirements and product requirements under it. - Each `Product requirements` section now contains relevant user stories and other product details. In the document flow this is kept close to the `Scenarios` section. - Updates the test plan template according to the updated structure. - Moves the documentation about customizable and non-customizable rule fields to the common info document. - Restores the lost changes from commit elastic@bde4612. No "functional" changes have been made to any test plans, such as adding, removing, or updating any scenarios. The only functional-like changes were made to the user stories when creating/updating the product requirements sections. This PR wraps up the refactoring efforts aimed to prepare the test plans for being "functionally" changed and improved in follow-up PRs. In the following PRs, we're going to cover the logic described in elastic#210358, address any gaps in the coverage, and improve the scenarios structure and wording. ## Review tip It might be easier to review this PR commit-by-commit as each of them contains logically cohesive changes.
Epic: #174168
Partially addresses: #202068, #202078, #202079
Follow-up to: #211300
Summary
We're cleaning up and refactoring our existing test plans for prebuilt rule customization, upgrade, and export/import workflows.
Specifically, this PR:
No "functional" changes have been made to any test plans, such as adding, removing, or updating any scenarios.
This refactoring prepares the test plans for being "functionally" changed and improved in follow-up PRs. For example, we're going to cover the logic described in #210358 and address any other gaps in coverage.
Review tip
It might be easier to review this PR commit-by-commit as each of them contains logically cohesive changes.