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.

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 1 #211300

Conversation

banderror
Copy link
Contributor

@banderror banderror commented Feb 14, 2025

Epic: #174168
Partially addresses: #202068, #202078, #202079

Summary

We're cleaning up and refactoring our existing test plans for prebuilt rule customization, upgrade, and export/import workflows.

Specifically, in this PR we're consistently:

  • Changing the file names and test plan titles.
  • Adding or expanding test plan summaries.
  • Regenerating tables of contents using the Markdown All in One VS Code extension.

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.

@banderror banderror added release_note:skip Skip the PR/issue when compiling release notes test-plan v9.0.0 Team:Detections and Resp Security Detection Response Team Team: SecuritySolution Security Solutions Team working on SIEM, Endpoint, Timeline, Resolver, etc. Team:Detection Rule Management Security Detection Rule Management Team Feature:Prebuilt Detection Rules Security Solution Prebuilt Detection Rules area backport:version Backport to applied version labels v8.18.0 v9.1.0 v8.19.0 labels Feb 14, 2025
@banderror banderror requested a review from maximpn February 14, 2025 17:58
@banderror banderror self-assigned this Feb 14, 2025
@banderror banderror requested a review from a team as a code owner February 14, 2025 17:58
@elasticmachine
Copy link
Contributor

Pinging @elastic/security-detections-response (Team:Detections and Resp)

@elasticmachine
Copy link
Contributor

Pinging @elastic/security-solution (Team: SecuritySolution)

@elasticmachine
Copy link
Contributor

Pinging @elastic/security-detection-rule-management (Team:Detection Rule Management)

Copy link
Contributor

@dplumlee dplumlee left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Formatting updates LGTM, much more standardized

@banderror banderror enabled auto-merge (squash) February 14, 2025 18:21
@banderror banderror merged commit 9600de4 into elastic:main Feb 14, 2025
32 checks passed
@kibanamachine
Copy link
Contributor

Starting backport for target branches: 8.18, 8.x, 9.0

https://github.com/elastic/kibana/actions/runs/13335083797

kibanamachine pushed a commit to kibanamachine/kibana that referenced this pull request Feb 14, 2025
…part 1 (elastic#211300)

**Epic:** elastic#174168
**Partially addresses:**
elastic#202068,
elastic#202078,
elastic#202079

## Summary

We're cleaning up and refactoring our existing test plans for prebuilt
rule customization, upgrade, and export/import workflows.

Specifically, in this PR we're consistently:

- Changing the file names and test plan titles.
- Adding or expanding test plan summaries.
- Regenerating tables of contents using the [Markdown All in
One](https://marketplace.visualstudio.com/items?itemName=yzhang.markdown-all-in-one)
VS Code extension.

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.

(cherry picked from commit 9600de4)
kibanamachine pushed a commit to kibanamachine/kibana that referenced this pull request Feb 14, 2025
…part 1 (elastic#211300)

**Epic:** elastic#174168
**Partially addresses:**
elastic#202068,
elastic#202078,
elastic#202079

## Summary

We're cleaning up and refactoring our existing test plans for prebuilt
rule customization, upgrade, and export/import workflows.

Specifically, in this PR we're consistently:

- Changing the file names and test plan titles.
- Adding or expanding test plan summaries.
- Regenerating tables of contents using the [Markdown All in
One](https://marketplace.visualstudio.com/items?itemName=yzhang.markdown-all-in-one)
VS Code extension.

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.

(cherry picked from commit 9600de4)
kibanamachine pushed a commit to kibanamachine/kibana that referenced this pull request Feb 14, 2025
…part 1 (elastic#211300)

**Epic:** elastic#174168
**Partially addresses:**
elastic#202068,
elastic#202078,
elastic#202079

## Summary

We're cleaning up and refactoring our existing test plans for prebuilt
rule customization, upgrade, and export/import workflows.

Specifically, in this PR we're consistently:

- Changing the file names and test plan titles.
- Adding or expanding test plan summaries.
- Regenerating tables of contents using the [Markdown All in
One](https://marketplace.visualstudio.com/items?itemName=yzhang.markdown-all-in-one)
VS Code extension.

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.

(cherry picked from commit 9600de4)
@kibanamachine
Copy link
Contributor

💚 All backports created successfully

Status Branch Result
8.18
8.x
9.0

Note: Successful backport PRs will be merged automatically after passing CI.

Questions ?

Please refer to the Backport tool documentation

kibanamachine added a commit that referenced this pull request Feb 14, 2025
…lans, part 1 (#211300) (#211307)

# Backport

This will backport the following commits from `main` to `8.x`:
- [[Security Solution] Refactor prebuilt rule customization test plans,
part 1 (#211300)](#211300)

<!--- Backport version: 9.4.3 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sqren/backport)

<!--BACKPORT [{"author":{"name":"Georgii
Gorbachev","email":"[email protected]"},"sourceCommit":{"committedDate":"2025-02-14T18:22:45Z","message":"[Security
Solution] Refactor prebuilt rule customization test plans, part 1
(#211300)\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\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, in this PR we're consistently:\r\n\r\n-
Changing the file names and test plan titles.\r\n- Adding or expanding
test plan summaries.\r\n- Regenerating tables of contents using the
[Markdown All
in\r\nOne](https://marketplace.visualstudio.com/items?itemName=yzhang.markdown-all-in-one)\r\nVS
Code extension.\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.","sha":"9600de4338edc123dbac7c2cb3403ede2f016752","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
1","number":211300,"url":"https://github.com/elastic/kibana/pull/211300","mergeCommit":{"message":"[Security
Solution] Refactor prebuilt rule customization test plans, part 1
(#211300)\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\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, in this PR we're consistently:\r\n\r\n-
Changing the file names and test plan titles.\r\n- Adding or expanding
test plan summaries.\r\n- Regenerating tables of contents using the
[Markdown All
in\r\nOne](https://marketplace.visualstudio.com/items?itemName=yzhang.markdown-all-in-one)\r\nVS
Code extension.\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.","sha":"9600de4338edc123dbac7c2cb3403ede2f016752"}},"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/211300","number":211300,"mergeCommit":{"message":"[Security
Solution] Refactor prebuilt rule customization test plans, part 1
(#211300)\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\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, in this PR we're consistently:\r\n\r\n-
Changing the file names and test plan titles.\r\n- Adding or expanding
test plan summaries.\r\n- Regenerating tables of contents using the
[Markdown All
in\r\nOne](https://marketplace.visualstudio.com/items?itemName=yzhang.markdown-all-in-one)\r\nVS
Code extension.\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.","sha":"9600de4338edc123dbac7c2cb3403ede2f016752"}},{"branch":"8.x","label":"v8.19.0","branchLabelMappingKey":"^v8.19.0$","isSourceBranch":false,"state":"NOT_CREATED"}]}]
BACKPORT-->

Co-authored-by: Georgii Gorbachev <[email protected]>
kibanamachine added a commit that referenced this pull request Feb 14, 2025
…lans, part 1 (#211300) (#211308)

# Backport

This will backport the following commits from `main` to `9.0`:
- [[Security Solution] Refactor prebuilt rule customization test plans,
part 1 (#211300)](#211300)

<!--- Backport version: 9.4.3 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sqren/backport)

<!--BACKPORT [{"author":{"name":"Georgii
Gorbachev","email":"[email protected]"},"sourceCommit":{"committedDate":"2025-02-14T18:22:45Z","message":"[Security
Solution] Refactor prebuilt rule customization test plans, part 1
(#211300)\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\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, in this PR we're consistently:\r\n\r\n-
Changing the file names and test plan titles.\r\n- Adding or expanding
test plan summaries.\r\n- Regenerating tables of contents using the
[Markdown All
in\r\nOne](https://marketplace.visualstudio.com/items?itemName=yzhang.markdown-all-in-one)\r\nVS
Code extension.\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.","sha":"9600de4338edc123dbac7c2cb3403ede2f016752","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
1","number":211300,"url":"https://github.com/elastic/kibana/pull/211300","mergeCommit":{"message":"[Security
Solution] Refactor prebuilt rule customization test plans, part 1
(#211300)\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\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, in this PR we're consistently:\r\n\r\n-
Changing the file names and test plan titles.\r\n- Adding or expanding
test plan summaries.\r\n- Regenerating tables of contents using the
[Markdown All
in\r\nOne](https://marketplace.visualstudio.com/items?itemName=yzhang.markdown-all-in-one)\r\nVS
Code extension.\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.","sha":"9600de4338edc123dbac7c2cb3403ede2f016752"}},"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/211300","number":211300,"mergeCommit":{"message":"[Security
Solution] Refactor prebuilt rule customization test plans, part 1
(#211300)\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\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, in this PR we're consistently:\r\n\r\n-
Changing the file names and test plan titles.\r\n- Adding or expanding
test plan summaries.\r\n- Regenerating tables of contents using the
[Markdown All
in\r\nOne](https://marketplace.visualstudio.com/items?itemName=yzhang.markdown-all-in-one)\r\nVS
Code extension.\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.","sha":"9600de4338edc123dbac7c2cb3403ede2f016752"}},{"branch":"8.x","label":"v8.19.0","branchLabelMappingKey":"^v8.19.0$","isSourceBranch":false,"state":"NOT_CREATED"}]}]
BACKPORT-->

Co-authored-by: Georgii Gorbachev <[email protected]>
kibanamachine added a commit that referenced this pull request Feb 14, 2025
…plans, part 1 (#211300) (#211306)

# Backport

This will backport the following commits from `main` to `8.18`:
- [[Security Solution] Refactor prebuilt rule customization test plans,
part 1 (#211300)](#211300)

<!--- Backport version: 9.4.3 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sqren/backport)

<!--BACKPORT [{"author":{"name":"Georgii
Gorbachev","email":"[email protected]"},"sourceCommit":{"committedDate":"2025-02-14T18:22:45Z","message":"[Security
Solution] Refactor prebuilt rule customization test plans, part 1
(#211300)\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\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, in this PR we're consistently:\r\n\r\n-
Changing the file names and test plan titles.\r\n- Adding or expanding
test plan summaries.\r\n- Regenerating tables of contents using the
[Markdown All
in\r\nOne](https://marketplace.visualstudio.com/items?itemName=yzhang.markdown-all-in-one)\r\nVS
Code extension.\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.","sha":"9600de4338edc123dbac7c2cb3403ede2f016752","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
1","number":211300,"url":"https://github.com/elastic/kibana/pull/211300","mergeCommit":{"message":"[Security
Solution] Refactor prebuilt rule customization test plans, part 1
(#211300)\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\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, in this PR we're consistently:\r\n\r\n-
Changing the file names and test plan titles.\r\n- Adding or expanding
test plan summaries.\r\n- Regenerating tables of contents using the
[Markdown All
in\r\nOne](https://marketplace.visualstudio.com/items?itemName=yzhang.markdown-all-in-one)\r\nVS
Code extension.\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.","sha":"9600de4338edc123dbac7c2cb3403ede2f016752"}},"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/211300","number":211300,"mergeCommit":{"message":"[Security
Solution] Refactor prebuilt rule customization test plans, part 1
(#211300)\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\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, in this PR we're consistently:\r\n\r\n-
Changing the file names and test plan titles.\r\n- Adding or expanding
test plan summaries.\r\n- Regenerating tables of contents using the
[Markdown All
in\r\nOne](https://marketplace.visualstudio.com/items?itemName=yzhang.markdown-all-in-one)\r\nVS
Code extension.\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.","sha":"9600de4338edc123dbac7c2cb3403ede2f016752"}},{"branch":"8.x","label":"v8.19.0","branchLabelMappingKey":"^v8.19.0$","isSourceBranch":false,"state":"NOT_CREATED"}]}]
BACKPORT-->

Co-authored-by: Georgii Gorbachev <[email protected]>
@banderror banderror deleted the refactor-prebuilt-rule-customization-test-plans-v1 branch February 14, 2025 19:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport:version Backport to applied version labels Feature:Prebuilt Detection Rules Security Solution Prebuilt Detection Rules area release_note:skip Skip the PR/issue when compiling release notes Team:Detection Rule Management Security Detection Rule Management Team Team:Detections and Resp Security Detection Response Team Team: SecuritySolution Security Solutions Team working on SIEM, Endpoint, Timeline, Resolver, etc. test-plan v8.18.0 v8.19.0 v9.0.0 v9.1.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants