[Cases] Case action: Integration tests #178277

cnasikas · 2024-03-08T08:51:46Z

Summary

In this PR I started adding integration tests for the case action. This process revealed a couple of bugs which I fixed. Specifically this PR:

Handles decorated errors thrown by the SO client
Skip executing if there are no alerts
Pass an unsecured (security is disabled) version of the SO client
Create one attachment with all alerts instead of one attachment per alert
Registers the required kibana privileges the case action needs to run
Add integration tests

Blocked by: #178307
Flaky test runner: https://buildkite.com/elastic/kibana-flaky-test-suite-runner/builds/5488

Checklist

Delete any items that are not applicable to this PR.

Unit or functional tests were updated or added to match the most common scenarios
Flaky Test Runner was used on any tests changed

For maintainers

This was checked for breaking API changes and was labeled appropriately

cnasikas · 2024-03-11T19:46:38Z

/ci

…te --fix'

…o ca_integration_tests

cnasikas · 2024-03-12T07:37:46Z

packages/kbn-check-mappings-update-cli/current_mappings.json

@@ -669,6 +669,34 @@
      }
    }
  },
+  "cases-oracle": {


The PR is going to be merged into a feature branch. There is no need for a thorough review at the moment.

elasticmachine · 2024-03-14T12:15:32Z

Pinging @elastic/response-ops (Team:ResponseOps)

elasticmachine · 2024-03-14T12:15:33Z

Pinging @elastic/response-ops-cases (Feature:Cases)

cnasikas · 2024-03-15T09:43:08Z

x-pack/plugins/cases/server/connectors/cases/cases_connector_executor.ts

-          rule: { id: rule.id, name: rule.name },
-          owner: theCase.owner,
-        })),
+        attachments: [


Instead of creating one attachment per alert, we create one attachment with all alerts included in the attachment. This will reduce the amount of SO created.

cnasikas · 2024-03-15T09:45:38Z

x-pack/plugins/cases/server/connectors/cases/index.ts

@@ -43,4 +53,14 @@ export const getCasesConnectorType = ({
   * TODO: Verify license
   */
  minimumLicenseRequired: 'platinum' as const,
+  isSystemActionType: true,
+  getKibanaPrivileges: ({ params } = { params: { subAction: 'run', subActionParams: {} } }) => {


Registers the required kibana privileges the case action needs to run.

cnasikas · 2024-03-15T09:47:36Z

/ci

cnasikas · 2024-03-16T12:55:32Z

/ci

js-jankisalvi

Awesome integration tests!! 😃 Great work 🎉

js-jankisalvi · 2024-03-19T13:23:12Z

x-pack/plugins/cases/server/connectors/cases/utils.ts

@@ -78,3 +78,7 @@ export const buildRequiredCustomFieldsForRequest = (
        })
    : [];
 };
+
+export const constructRequiredKibanaPrivileges = (owner: string): string[] => {
+  return [`cases:${owner}/createCase`, `cases:${owner}/updateCase`];


I guess for case action user doesn't need to have delete permission, right?

Good point. At the moment the case action does not do any delete operation but I will add it just to be safe in case we need it in the future.

js-jankisalvi · 2024-03-19T13:28:24Z

...st/cases_api_integration/security_and_spaces/tests/trial/connectors/cases/cases_connector.ts

+  const kibanaServer = getService('kibanaServer');
+
+  describe('Case connector', () => {
+    const connectorId = 'system-connector-.cases';


Shouldn't this be just .cases?

The actions framework generates the connector's ID automatically by pretending system-connector- to all system connectors.

kibana-ci · 2024-03-19T16:11:45Z

💔 Build Failed

Failed CI Steps

Test Failures

[job] [logs] Jest Tests #12 / getCasesConnectorType getKibanaPrivileges construct the kibana privileges correctly
[job] [logs] Jest Tests #12 / getCasesConnectorType getKibanaPrivileges construct the kibana privileges correctly
[job] [logs] FTR Configs #20 / serverless observability UI Dataset Quality Dataset quality summary updates the degraded count when degraded docs are ingested
[job] [logs] FTR Configs #20 / serverless observability UI Dataset Quality Dataset quality summary updates the poor count when degraded docs are ingested

Metrics [docs]

‼️ ERROR: no builds found for mergeBase sha [dbbeca4]

History

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

cc @cnasikas

## Summary Depends on: #166267, #170326, #169484, #173740, #173763, #178068, #178307, #178600, #180437 PRs: - #168370 - #169229 - #171754 - #172709 - #173012 - #175107 - #175452 - #175505 - #177033 - #178277 - #177139 - #179796 Fixes: #153837 ## Testing Run Kibana with `--run-examples` if you want to use the "Always firing" rule. Create a rule with a case action in observability and the stack. The security solution is not supported. You should not be able to assign a case action in a security solution rule. 1. Test the "Reopen closed cases" configuration. 2. Test the "Grouping by" configuration. Only one field is allowed. Not all fields are persisted in alerts. If you select a field not part of the alert the case action will create a case where the grouping value is set to `unknow`. 3. Test the "Time window" feature. You can comment out the validation to test for shorter times. 4. Verify that the case action is experimental. 5. Verify that based on the rule type the case is created in the correct solution. 6. Verify that you cannot create a rule with the case action on the basic license. 7. Verify that the execution of the case action fails if you do not have permission for cases. Pending work on the system actions framework level to not allow users to create rules with system actions where they do not have permission. 8. Stress test the case action by creating multiple rules. ### Checklist Delete any items that are not applicable to this PR. - [x] [Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html) was added for features that require explanation or tutorials - [x] [Unit or functional tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html) were updated or added to match the most common scenarios ### For maintainers - [x] This was checked for breaking API changes and was [labeled appropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process) ## Release notes Automatically create cases when an alert is triggered. --------- Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com> Co-authored-by: adcoelho <antonio.coelho@elastic.co> Co-authored-by: Janki Salvi <117571355+js-jankisalvi@users.noreply.github.com>

cnasikas added 5 commits March 8, 2024 10:45

Refactor so registration

f64b523

Use custom SO client to have access to hidden SOs

7d07c9e

Configure the case action as system action

1a1c9b7

Do not execute if there are no alerts

81fd651

Draft

095c2ec

cnasikas added release_note:skip Skip the PR/issue when compiling release notes Team:ResponseOps Label for the ResponseOps team (formerly the Cases and Alerting teams) Feature:Cases Cases feature v8.14.0 labels Mar 8, 2024

cnasikas self-assigned this Mar 8, 2024

cnasikas mentioned this pull request Mar 8, 2024

[Cases] Case action #168369

Merged

3 tasks

cnasikas added 13 commits March 8, 2024 14:55

Handle different type of errors returned by the SO client

746ac55

Fix types

32b633c

Merge branch 'fix_so_errors' into ca_integration_tests

acc29cf

Handle decorated errors

7a0a4e9

Fix bug with schema

6431727

Add integration tests

68fc281

Merge branch 'case_action' into ca_integration_tests

3d38566

Add more tests

1b6645e

Support Boom errors

0904ec5

Define cases required privileges

da51642

Disable security plugin in the saved object client

24b6842

Add RBAC tests

22a6f3c

Add validation tests

c017761

kibanamachine and others added 3 commits March 11, 2024 20:13

[CI] Auto-commit changed files from 'node scripts/check_mappings_upda…

3454bbc

…te --fix'

Fix tests

fc61f18

Merge branch 'ca_integration_tests' of github.com:cnasikas/kibana int…

ef73a01

…o ca_integration_tests

cnasikas commented Mar 12, 2024

View reviewed changes

Test complex workflows

f6a7cf7

cnasikas added 3 commits March 14, 2024 11:07

Merge branch 'case_action' into ca_integration_tests

4cc1427

Add all alerts to the same attachment

8f80dc0

Add more tests

3553ce9

cnasikas marked this pull request as ready for review March 14, 2024 12:15

cnasikas requested review from a team as code owners March 14, 2024 12:15

cnasikas commented Mar 15, 2024

View reviewed changes

Fix snapshots

ad2610e

pgayvallet approved these changes Mar 18, 2024

View reviewed changes

js-jankisalvi approved these changes Mar 19, 2024

View reviewed changes

PR feedback

014fbf5

cnasikas requested a review from a team as a code owner March 19, 2024 15:13

cnasikas merged commit 5918e24 into elastic:case_action Mar 19, 2024
4 of 5 checks passed

cnasikas deleted the ca_integration_tests branch March 19, 2024 15:13

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Cases] Case action: Integration tests #178277

[Cases] Case action: Integration tests #178277

cnasikas commented Mar 8, 2024 •

edited

Loading

cnasikas commented Mar 11, 2024

cnasikas Mar 12, 2024

elasticmachine commented Mar 14, 2024

elasticmachine commented Mar 14, 2024

cnasikas Mar 15, 2024

cnasikas Mar 15, 2024

cnasikas commented Mar 15, 2024

cnasikas commented Mar 16, 2024

js-jankisalvi left a comment

js-jankisalvi Mar 19, 2024

cnasikas Mar 19, 2024

js-jankisalvi Mar 19, 2024

cnasikas Mar 19, 2024

kibana-ci commented Mar 19, 2024 •

edited

Loading

[Cases] Case action: Integration tests #178277

[Cases] Case action: Integration tests #178277

Conversation

cnasikas commented Mar 8, 2024 • edited Loading

Summary

Checklist

For maintainers

cnasikas commented Mar 11, 2024

cnasikas Mar 12, 2024

Choose a reason for hiding this comment

elasticmachine commented Mar 14, 2024

elasticmachine commented Mar 14, 2024

cnasikas Mar 15, 2024

Choose a reason for hiding this comment

cnasikas Mar 15, 2024

Choose a reason for hiding this comment

cnasikas commented Mar 15, 2024

cnasikas commented Mar 16, 2024

js-jankisalvi left a comment

Choose a reason for hiding this comment

js-jankisalvi Mar 19, 2024

Choose a reason for hiding this comment

cnasikas Mar 19, 2024

Choose a reason for hiding this comment

js-jankisalvi Mar 19, 2024

Choose a reason for hiding this comment

cnasikas Mar 19, 2024

Choose a reason for hiding this comment

kibana-ci commented Mar 19, 2024 • edited Loading

💔 Build Failed

Failed CI Steps

Test Failures

Metrics [docs]

History

cnasikas commented Mar 8, 2024 •

edited

Loading

kibana-ci commented Mar 19, 2024 •

edited

Loading