[Security Solution] Create RulesManagementClient, initial implementation

[jpdjere]

Partially addresses: #180128

Summary

• Creates RulesManagementClient, which centralizes CRUD utilites for rules, at x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/crud/rules_management_client.ts
  • Move ML Auth validation from endpoints to the new client utils.
• Adds client to SecuritySolution API requests context.
• Deletes createRules, deletesRules,updateRules and patchRules utils and replaces them with new client methods.
• Testing:
  • Creates individual test files for each "public" method of the RulesManagementClient.
  • Creates importable mock of the client

To-Do:

• Replace readRules method for a new public method within the API (left out of this PR to keep scope and size manageable)

Flaky Test Runner

• FTR Exceptions - ESS 🟢
• FTR Exceptions - Serverless 🟢
• FTR - Prebuilt Rules - Bundled Prebuilt Rules Package - ESS and Serverless 🟢
• FTR - Prebuilt Rules - Large Prebuilt Rules Package - ESS and Serverless 🟢
• FTR - Prebuilt Rules - Management - ESS and Serverless 🟢
• FTR - Prebuilt Rules - Update Prebuilt Rules Package - ESS and Serverless 🟢
• FTR - Rules Management - Rule Bulk Actions - ESS and Serverless 🟢
• FTR - Rules Management - Rule Creation - Basic License Essentials Tier - ESS and Serverless 🟢
• FTR - Rules Management - Rule Creation - Trial License Complete Tier - ESS and Serverless 🟢
• FTR - Rules Management - Rule Deletion - Basic License Essentials Tier - ESS and Serverless (name is wrong in the FTR UI, but runs the correct tests) 🟢
• FTR - Rules Management - Rule Deletion - Trial License Complete Tier - ESS and Serverless 🟢
• FTR - Rules Management - Rule Import and Export - Basic License Essentials Tier - ESS and Serverless 🟢
• FTR - Rules Management - Rule Import and Export - Trial License Complete Tier - ESS and Serverless 🟢
• FTR - Rules Management - Rule Patch - Basic License Essentials Tier - ESS and Serverless 🟢
• FTR - Rules Management - Rule Patch - Trial License Complete Tier - ESS and Serverless 🟢
• FTR - Rules Management - Rule Update - Basic License Essentials Tier - ESS and Serverless 🟢
• FTR - Rules Management - Rule Update - Trial License Complete Tier - ESS and Serverless 🟢
• Cypress - Security Solution Rule Management - ESS and Serverless 🟢
• Cypress - Security Solution Rule Management - Prebuilt Rules - ESS and Serverless 🟢
• Cypress - Security Solution Detection Engine - Exceptions - ESS and Serverless 🟢

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

[jpdjere]

/ci

[jpdjere]

/ci

[jpdjere]

/ci

[jpdjere]

/ci

[jpdjere]

/ci

[jpdjere]

/ci

[jpdjere]

@e40pud I addressed the comments and did some refactoring.

I ran the flaky test runner on the Exceptions code that I touched, which is what your team owns.

Can you please take another look at the PR? Thanks!!

[kibanamachine]

Flaky Test Runner Stats

🟠 Some tests failed. - kibana-flaky-test-suite-runner#6099

[❌] Security Solution Rule Management - Cypress: 74/100 tests passed.
[✅] [Serverless] Security Solution Rule Management - Cypress: 100/100 tests passed.

see run history

[yctercero]

Super nit - gonna be that person that asks about naming 😄 Any thoughts on making it securitySolutionRulesManagementClient or securityRulesManagementClient - for new devs and anyone quickly digging through the code it might be confusing to see rulesClient and rulesManagementClient.

[e40pud]

LGTM! @yctercero has a valid point regarding two clients with similar names. Would be nice to consider how to solve that.

[kibana-ci]

💛 Build succeeded, but was flaky

• Buildkite Build
• Commit: 7a59519

Failed CI Steps

Metrics [docs]

Public APIs missing comments

Total count of every public API that lacks a comment. Target amount is 0. Run node scripts/build_api_docs --plugin [yourplugin] --stats comments for more detailed information.

id	before	after	diff
securitySolution	120	121	+1

Public APIs missing exports

Total count of every type that is part of your API that should be exported but is not. This will cause broken links in the API documentation system. Target amount is 0. Run node scripts/build_api_docs --plugin [yourplugin] --stats exports for more detailed information.

id	before	after	diff
securitySolution	36	37	+1

Unknown metric groups

API count

id	before	after	diff
securitySolution	190	191	+1

ESLint disabled in files

id	before	after	diff
securitySolution	82	81	-1

ESLint disabled line counts

id	before	after	diff
securitySolution	522	523	+1

History

• 💚 Build #212111 succeeded 2e1b219
• 💔 Build #212086 failed 89d24ff
• 💛 Build #212020 was flaky 366bc6d
• 💔 Build #212006 failed 13f247d
• 💔 Build #211958 failed fc7f6e5
• 💔 Build #211956 failed 27ed76b

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

cc @jpdjere

[banderror]

@yctercero @e40pud No worries, as everyone knows, naming is the hardest problem in programming 🙂 We will think about a better name and probably open a separate PR for renaming it. cc @nikitaindik

[xcrzx]

I've listed all remaining work in this follow-up ticket: #184364.