[Data Usage] setup integration tests #197112

neptunian · 2024-10-21T18:01:01Z

Summary

Adds serverless api integration tests and basic functional smoke test for data usage plugin

Both are skipped in mki until xpack.dataUsage.enabled is enabled by default in serverless

`GET /internal/api/data_usage/data_streams`

`POST /internal/api/data_usage/metrics`

skipped in MKI because we'll need to make sure real credentials are being used via the xpack.dataUsage.autoops*
we start a mock server at localhost:9000 and set that the config (xpack.dataUsage.autoops.api.url=http://localhost:9000') along with fake credentials for the other xpack.dataUsage.autoops* values. If we're not in MKI these values will be used and the mock server will respond to the request at http://localhost:9000. If we are in MKI, the real values and credentials should be set, otherwise it will fail as these kibana config values in the tests are not passed into the MKI environment.

neptunian · 2024-10-21T18:12:12Z

x-pack/plugins/data_usage/server/services/autoops_api.ts

@@ -134,8 +135,10 @@ export class AutoOpsAPIService {
      }
    );

+    const validatedResponse = UsageMetricsAutoOpsResponseSchema.body().validate(response.data);


I think we should validate the autoops response at runtime. The error will be caught further up.

neptunian · 2024-10-23T17:51:08Z

x-pack/test_serverless/api_integration/test_suites/search/config.ts

@@ -21,5 +22,22 @@ export default createTestConfig({
  kbnServerArgs: [
    // useful for testing (also enabled in MKI QA)
    '--coreApp.allowDynamicConfigOverrides=true',
+    '--xpack.dataUsage.enabled=true',


we need to enable this to run the tests in MKI. once we enable this in serverless only, we can remove this.

neptunian · 2024-10-23T19:19:21Z

x-pack/plugins/data_usage/common/rest_types/usage_metrics.ts

->;
+>['metrics'][MetricTypes][number];
+
+export type UsageMetricsAutoOpsResponseSchemaBody = Omit<


I changed this type because I was getting a type error when only sending a subset of metrics (using the type in mock server response), so this allows the subset instead of all. @ashokaditya Hope thats ok.

…fix'

YulNaumenko · 2024-10-23T22:52:36Z

x-pack/test_serverless/api_integration/test_suites/security/config.ts

@@ -25,5 +26,11 @@ export default createTestConfig({
    '--coreApp.allowDynamicConfigOverrides=true',
    `--xpack.securitySolutionServerless.cloudSecurityUsageReportingTaskInterval=5s`,
    `--xpack.securitySolutionServerless.usageApi.url=http://localhost:8081`,
+    '--xpack.dataUsage.enabled=true',


Suggested change

'--xpack.dataUsage.enabled=true',

'--xpack.dataUsage.autoops.enabled=true',

I added --xpack.dataUsage.autoops.enabled=true, though left --xpack.dataUsage.enabled=true in place so as not to enable the plugin.

YulNaumenko · 2024-10-23T23:00:29Z

x-pack/test_serverless/api_integration/test_suites/search/config.ts

@@ -21,5 +22,11 @@ export default createTestConfig({
  kbnServerArgs: [
    // useful for testing (also enabled in MKI QA)
    '--coreApp.allowDynamicConfigOverrides=true',
+    '--xpack.dataUsage.enabled=true',


Suggested change

'--xpack.dataUsage.enabled=true',

'--xpack.dataUsage.autoops.enabled=true',

I added --xpack.dataUsage.autoops.enabled=true, though left --xpack.dataUsage.enabled=true in place so as not to enable the plugin.

ashokaditya · 2024-10-23T12:58:30Z

x-pack/test_serverless/api_integration/test_suites/common/data_usage/tests/data_streams.ts

+import { DataStreamsResponseBodySchemaBody } from '@kbn/data-usage-plugin/common/rest_types';
+import { FtrProviderContext } from '../../../../ftr_provider_context';
+
+const API_PATH = '/internal/api/data_usage/data_streams';


You can import and use DATA_USAGE_METRICS_API_ROUTE instead.

import { DATA_USAGE_METRICS_API_ROUTE } from '@kbn/data-usage-plugin/common';

x-pack/test_serverless/api_integration/test_suites/common/data_usage/tests/metrics.ts

awahab07

obs-ux-logs changes LGTM.

Thought need to look at why it triggered the codeowners review for obs-ux-logs-team.

YulNaumenko

LGTM!

elasticmachine · 2024-11-06T17:57:08Z

💚 Build Succeeded

Buildkite Build
Commit: dc0f07b

Metrics [docs]

✅ unchanged

History

💔 Build #248633 failed 6240095
💛 Build #248491 was flaky bdd5f7b
💛 Build #248248 was flaky be9b1bb
💚 Build #245787 succeeded ab2c072
💔 Build #245772 failed 6c1828e

kibanamachine · 2024-11-06T18:21:08Z

Starting backport for target branches: 8.x

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

kibanamachine · 2024-11-06T18:28:28Z

💔 All backports failed

Status	Branch	Result
❌	8.x	Backport failed because of merge conflicts

Manual backport

To create the backport manually run:

node scripts/backport --pr 197112

Questions ?

Please refer to the Backport tool documentation

Adds serverless api integration tests and basic functional smoke test for data usage plugin Both are skipped in mki until `xpack.dataUsage.enabled` is enabled by default in serverless - skipped in MKI because we'll need to make sure real credentials are being used via the `xpack.dataUsage.autoops*` - we start a mock server at localhost:9000 and set that the config (`xpack.dataUsage.autoops.api.url=http://localhost:9000'`) along with fake credentials for the other `xpack.dataUsage.autoops*` values. If we're not in MKI these values will be used and the mock server will respond to the request at `http://localhost:9000`. If we are in MKI, the real values and credentials should be set, otherwise it will fail as these kibana config values in the tests are not passed into the MKI environment. --------- Co-authored-by: kibanamachine <[email protected]>

## Summary Adds serverless api integration tests and basic functional smoke test for data usage plugin Both are skipped in mki until `xpack.dataUsage.enabled` is enabled by default in serverless ### `GET /internal/api/data_usage/data_streams` ### `POST /internal/api/data_usage/metrics` - skipped in MKI because we'll need to make sure real credentials are being used via the `xpack.dataUsage.autoops*` - we start a mock server at localhost:9000 and set that the config (`xpack.dataUsage.autoops.api.url=http://localhost:9000'`) along with fake credentials for the other `xpack.dataUsage.autoops*` values. If we're not in MKI these values will be used and the mock server will respond to the request at `http://localhost:9000`. If we are in MKI, the real values and credentials should be set, otherwise it will fail as these kibana config values in the tests are not passed into the MKI environment. --------- Co-authored-by: kibanamachine <[email protected]>

kibanamachine · 2024-11-07T12:23:28Z

Starting backport for target branches: 8.x

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

kibanamachine · 2024-11-07T12:28:19Z

💔 All backports failed

Status	Branch	Result
❌	8.x	Backport failed because of merge conflicts

Manual backport

To create the backport manually run:

node scripts/backport --pr 197112

Questions ?

Please refer to the Backport tool documentation

## Summary Adds serverless api integration tests and basic functional smoke test for data usage plugin Both are skipped in mki until `xpack.dataUsage.enabled` is enabled by default in serverless ### `GET /internal/api/data_usage/data_streams` ### `POST /internal/api/data_usage/metrics` - skipped in MKI because we'll need to make sure real credentials are being used via the `xpack.dataUsage.autoops*` - we start a mock server at localhost:9000 and set that the config (`xpack.dataUsage.autoops.api.url=http://localhost:9000'`) along with fake credentials for the other `xpack.dataUsage.autoops*` values. If we're not in MKI these values will be used and the mock server will respond to the request at `http://localhost:9000`. If we are in MKI, the real values and credentials should be set, otherwise it will fail as these kibana config values in the tests are not passed into the MKI environment. --------- Co-authored-by: kibanamachine <[email protected]> (cherry picked from commit 4f9ab47) # Conflicts: # x-pack/test_serverless/api_integration/test_suites/security/config.ts # x-pack/test_serverless/functional/test_suites/search/config.ts # x-pack/test_serverless/tsconfig.json

ashokaditya · 2024-11-07T12:42:45Z

💚 All backports created successfully

Status	Branch	Result
✅	8.x

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

Questions ?

Please refer to the Backport tool documentation

> [!Warning] > The following files were updated as a result of merge conflicts that should be reviewed > - `/x-pack/test_serverless/api_integration/test_suites/security/config.ts` > - `/x-pack/test_serverless/functional/test_suites/search/config.ts` > - `/x-pack/test_serverless/tsconfig.json` # Backport This will backport the following commits from `main` to `8.x`: - [[Data Usage] setup integration tests (#197112)](#197112)  ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport)  --------- Signed-off-by: Ash <[email protected]> Co-authored-by: Sandra G <[email protected]> Co-authored-by: kibanamachine <[email protected]>

neptunian commented Oct 21, 2024

View reviewed changes

elastic deleted a comment from elasticmachine Oct 22, 2024

neptunian commented Oct 23, 2024

View reviewed changes

neptunian force-pushed the data-usage-serverless-api-integration-tests branch 2 times, most recently from 55c96a7 to c786ac9 Compare October 23, 2024 19:13

neptunian added backport:prev-minor Backport to (8.x) the previous minor version (i.e. one version back from main) release_note:skip Skip the PR/issue when compiling release notes labels Oct 23, 2024

neptunian commented Oct 23, 2024

View reviewed changes

neptunian marked this pull request as ready for review October 23, 2024 19:21

neptunian requested review from a team as code owners October 23, 2024 19:21

neptunian and others added 6 commits October 23, 2024 15:52

setup integration tests

92c80ce

fix error

d5fb8b0

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

ef8ee48

…fix'

add data_streams test

f57a79f

skip data_streams in mki

406db08

remove proxy in favor of mock server

dff67dc

neptunian requested review from a team as code owners October 23, 2024 20:01

neptunian force-pushed the data-usage-serverless-api-integration-tests branch from 41e2585 to dff67dc Compare October 23, 2024 20:05

neptunian removed request for a team October 23, 2024 20:06

use certs from dev_utils

1e1b2ad

YulNaumenko reviewed Oct 23, 2024

View reviewed changes

add missing config

265df11

ashokaditya reviewed Oct 24, 2024

View reviewed changes

neptunian requested a review from a team as a code owner November 4, 2024 19:29

remove codeowners entry

bdd5f7b

ashokaditya approved these changes Nov 5, 2024

View reviewed changes

efegurkan approved these changes Nov 5, 2024

View reviewed changes

neptunian added 2 commits November 5, 2024 13:56

cleanup mock data

7fcac6e

functional test configs and smoke test

693b6c1

neptunian requested a review from a team as a code owner November 5, 2024 20:09

neptunian added 2 commits November 5, 2024 15:11

skip in MKI

0ef4725

change to main

6240095

awahab07 approved these changes Nov 5, 2024

View reviewed changes

ashokaditya approved these changes Nov 5, 2024

View reviewed changes

YulNaumenko approved these changes Nov 6, 2024

View reviewed changes

fix search config

dc0f07b

neptunian merged commit 4f9ab47 into elastic:main Nov 6, 2024
22 checks passed

kibanamachine added the v9.0.0 label Nov 6, 2024

ashokaditya mentioned this pull request Nov 7, 2024

[Index Management][Serverless] Add new internal Kibana API to fetch the data usage #192965

Closed

ashokaditya added backport:version Backport to applied version labels v8.17.0 and removed backport:prev-minor Backport to (8.x) the previous minor version (i.e. one version back from main) labels Nov 7, 2024

ashokaditya mentioned this pull request Nov 7, 2024

[8.x] [Data Usage] setup integration tests (#197112) #199305

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Data Usage] setup integration tests #197112

[Data Usage] setup integration tests #197112

neptunian commented Oct 21, 2024 •

edited by kibanamachine

Loading

neptunian Oct 21, 2024 •

edited

Loading

neptunian Oct 23, 2024 •

edited

Loading

neptunian Oct 23, 2024 •

edited

Loading

YulNaumenko Oct 23, 2024

neptunian Oct 24, 2024

YulNaumenko Oct 23, 2024

neptunian Oct 24, 2024

ashokaditya Oct 23, 2024

awahab07 left a comment

YulNaumenko left a comment

elasticmachine commented Nov 6, 2024

kibanamachine commented Nov 6, 2024

kibanamachine commented Nov 6, 2024

kibanamachine commented Nov 7, 2024

kibanamachine commented Nov 7, 2024

ashokaditya commented Nov 7, 2024

	'--xpack.dataUsage.enabled=true',
	'--xpack.dataUsage.autoops.enabled=true',

[Data Usage] setup integration tests #197112

[Data Usage] setup integration tests #197112

Conversation

neptunian commented Oct 21, 2024 • edited by kibanamachine Loading

Summary

GET /internal/api/data_usage/data_streams

POST /internal/api/data_usage/metrics

neptunian Oct 21, 2024 • edited Loading

Choose a reason for hiding this comment

neptunian Oct 23, 2024 • edited Loading

Choose a reason for hiding this comment

neptunian Oct 23, 2024 • edited Loading

Choose a reason for hiding this comment

YulNaumenko Oct 23, 2024

Choose a reason for hiding this comment

neptunian Oct 24, 2024

Choose a reason for hiding this comment

YulNaumenko Oct 23, 2024

Choose a reason for hiding this comment

neptunian Oct 24, 2024

Choose a reason for hiding this comment

ashokaditya Oct 23, 2024

Choose a reason for hiding this comment

awahab07 left a comment

Choose a reason for hiding this comment

YulNaumenko left a comment

Choose a reason for hiding this comment

elasticmachine commented Nov 6, 2024

💚 Build Succeeded

Metrics [docs]

History

kibanamachine commented Nov 6, 2024

kibanamachine commented Nov 6, 2024

💔 All backports failed

Manual backport

Questions ?

kibanamachine commented Nov 7, 2024

kibanamachine commented Nov 7, 2024

💔 All backports failed

Manual backport

Questions ?

ashokaditya commented Nov 7, 2024

💚 All backports created successfully

Questions ?

neptunian commented Oct 21, 2024 •

edited by kibanamachine

Loading

`GET /internal/api/data_usage/data_streams`

`POST /internal/api/data_usage/metrics`

neptunian Oct 21, 2024 •

edited

Loading

neptunian Oct 23, 2024 •

edited

Loading

neptunian Oct 23, 2024 •

edited

Loading