[Data Usage] setup integration tests #197112

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

Summary

Adds serverless api integration tests for data usage plugin

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

`POST /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-22T11:09:25Z

/ci

neptunian · 2024-10-22T22:07:00Z

/ci

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';

ashokaditya · 2024-10-24T11:58:47Z

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

+          .set('elastic-api-version', '1')
+          .send(requestBody);
+        expect(res.statusCode).to.be(200);
+        // TODO: decide on how to generate data


I think we should have a function that takes in a date range and spits out some metrics for that range. Maybe a data point every hour?

I'm thinking to use synthtrace

pmuellr

ResponseOps changes (in x-pack/test_serverless/api_integration/test_suites/observability/config.ts) LGTM.

Side note: no idea why Response Ops is marked for these files, which is why we got pinged:

kibana/.github/CODEOWNERS

Lines 1488 to 1489 in c41178d

    
           /x-pack/test_serverless/api_integration/test_suites/observability/config.ts @elastic/response-ops 
        
           /x-pack/test_serverless/api_integration/test_suites/observability/index.ts @elastic/response-ops

Perhaps fix that in this PR as well?

…-fix'

elasticmachine · 2024-10-24T22:15:42Z

💚 Build Succeeded

Buildkite Build
Commit: ab2c072

Metrics [docs]

✅ unchanged

History

💔 Build #245772 failed 6c1828e
💔 Build #245761 failed 0c45a7a
💛 Build #245545 was flaky 265df11
💚 Build #245334 succeeded 1e1b2ad
💛 Build #244875 was flaky 13e32db
💚 Build #244594 succeeded 270ab57

pheyos

x-pack/test_serverless/api_integration/test_suites/observability/common_configs/config.group1.ts and x-pack/test_serverless/tsconfig.json changes LGTM

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

pmuellr approved these changes Oct 24, 2024

View reviewed changes

neptunian and others added 5 commits October 24, 2024 13:07

merge error

49ebd73

use existing route constant

78484af

add tests

0c45a7a

Merge branch 'main' into data-usage-serverless-api-integration-tests

6c1828e

[CI] Auto-commit changed files from 'node scripts/eslint --no-cache -…

ab2c072

…-fix'

pheyos approved these changes Oct 25, 2024

View reviewed changes

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

Loading

neptunian Oct 21, 2024 •

edited

Loading

neptunian commented Oct 22, 2024

neptunian commented Oct 22, 2024

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

ashokaditya Oct 24, 2024

neptunian Oct 24, 2024

pmuellr left a comment

elasticmachine commented Oct 24, 2024

pheyos left a comment

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

	/x-pack/test_serverless/api_integration/test_suites/observability/config.ts @elastic/response-ops
	/x-pack/test_serverless/api_integration/test_suites/observability/index.ts @elastic/response-ops

[Data Usage] setup integration tests #197112

Are you sure you want to change the base?

[Data Usage] setup integration tests #197112

Conversation

neptunian commented Oct 21, 2024 • edited Loading

Summary

POST /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 commented Oct 22, 2024

neptunian commented Oct 22, 2024

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

ashokaditya Oct 24, 2024

Choose a reason for hiding this comment

neptunian Oct 24, 2024

Choose a reason for hiding this comment

pmuellr left a comment

Choose a reason for hiding this comment

elasticmachine commented Oct 24, 2024

💚 Build Succeeded

Metrics [docs]

History

pheyos left a comment

Choose a reason for hiding this comment

neptunian commented Oct 21, 2024 •

edited

Loading

`POST /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