[Scout] Migrate Data Views API tests from FTR - Part5 by fake-haris · Pull Request #264088 · elastic/kibana

fake-haris · 2026-04-17T13:41:11Z

Summary

Final pass of the data_views plugin FTR → Scout migration. Migrates the remaining serverless
x-pack/platform/test/serverless/api_integration/test_suites/data_views/* suites to Scout API
tests colocated with the plugin at
src/platform/plugins/shared/data_views/test/scout/api/tests/, and removes the migrated FTR
sources + loadTestFile wiring.

Part of the ongoing FTR → Scout migration effort.
Continues the work from earlier parts (crud_*, default_data_view, runtime_fields_{create,get_errors}, etc.).

What moved

Each migrated FTR suite is ported to two Scout specs — one targeting the data view API
(api/data_views/*, under tests/data_views/) and a parallel one targeting the legacy index
pattern API (api/index_patterns/*, under tests/index_patterns/) — mirroring how the FTR
suites iterated over both config variants. Routes that are only available on api/data_views/*
(swap_references, _existing_indices, _fields_for_wildcard) are ported once.

New Scout API specs under src/platform/plugins/shared/data_views/test/scout/api/tests/:

data_views/fields_api_update_{errors,main}.spec.ts + index_patterns/fields_api_update_{errors,main}.spec.ts
data_views/runtime_fields_{delete_errors,delete_main,get_main,put_errors,put_main,update_errors,update_main}.spec.ts + matching index_patterns/runtime_fields_*.spec.ts
data_views/swap_references_{errors,main,limit}.spec.ts (the FTR nested limit affected saved objects describe is split into its own spec per Scout's one-suite-per-file guideline)
data_views/has_user_data_view.spec.ts + index_patterns/has_user_index_pattern.spec.ts
data_views/integration.spec.ts + index_patterns/integration.spec.ts
existing_indices_route/{params,response}.spec.ts
fields_for_wildcard_route/{conflicts,filter,params,response}.spec.ts (use the viewer role since the route is read-only)

Jest unit test (colocated with library code, replaces the FTR es_errors/errors.js integration test):

src/platform/plugins/shared/data_views/server/fetcher/lib/errors.test.ts

Small additions to test/scout/api/fixtures/constants.ts: ES_ARCHIVE_CONFLICTS,
KBN_ARCHIVE_SAVED_OBJECTS_{BASIC,RELATIONSHIPS}, HAS_USER_DATA_VIEW_PATH,
HAS_USER_INDEX_PATTERN_PATH, EXISTING_INDICES_PATH, FIELDS_ROUTE_PATH,
RESOLVE_INDEX_PATH, SWAP_REFERENCES_{PATH,PREVIEW_PATH}.

What was removed

From x-pack/platform/test/serverless/api_integration/test_suites/data_views/:

data_views_crud/, existing_indices_route/, fields_api/, fields_for_wildcard_route/,
has_user_index_pattern/, integration/, runtime_fields_crud/, swap_references/
constants.ts (only consumed by the deleted specs)
Top-level index.ts updated — now only loads ./es_errors (kept, see note below).

The three parent configs (configs/{search,security,observability}/config.group1.ts) still
require.resolve('.../test_suites/data_views'), and the trimmed index.ts keeps that working.

Notes / follow-ups

es_errors is the last serverless FTR suite remaining under data_views. The new
errors.test.ts covers the same helpers as Jest; a follow-up can carry over the
indexNotFoundError / docNotFoundError integration-level checks (which guard against
unexpected ES error shape changes) into Scout and then drop es_errors/ and the
loadTestFile('./es_errors') entry entirely. Left in place in this PR to keep the change
scoped.
The platform (non-serverless) FTR suite at
src/platform/test/api_integration/apis/data_views/ is untouched in this PR.

…apis-part-5

macroscopeapp · 2026-04-17T13:43:24Z

Catch flakiness early (recommended)

Recommended before merge: run the flaky test runner against this PR to catch flakiness early.

Trigger a run with the Flaky Test Runner UI or post this comment on the PR:

/flaky scoutConfig:src/platform/plugins/shared/data_views/test/scout/api/playwright.config.ts:30 ftrConfig:x-pack/platform/test/serverless/api_integration/configs/observability/config.group1.ts:30 ftrConfig:x-pack/platform/test/serverless/api_integration/configs/search/config.group1.ts:30 ftrConfig:x-pack/platform/test/serverless/api_integration/configs/security/config.group1.ts:30

This check is experimental. Share your feedback in the #appex-qa channel.

^{Posted via Macroscope — Flaky Test Runner nudge}

macroscopeapp · 2026-04-17T13:45:30Z

+      await apiClient.post(`${DATA_VIEW_PATH}/${sharedDataViewId}/fields`, {
+        headers: { ...COMMON_HEADERS, ...adminApiCredentials.apiKeyHeader },
+        responseType: 'json',
+        body: { fields: { foo: { customLabel: 'baz' } } },
+      });
+
+      const getResponse = await apiClient.get(`${DATA_VIEW_PATH}/${sharedDataViewId}`, {
+        headers: { ...COMMON_HEADERS, ...adminApiCredentials.apiKeyHeader },
+        responseType: 'json',
+      });
+
+      expect(getResponse).toHaveStatusCode(200);
+      expect(getResponse.body[SERVICE_KEY].fields.foo.customLabel).toBe('baz');
+    });


🟢 Low data_views/fields_api_update_main.spec.ts:212

The test at line 212 does not verify the status code of the POST response, unlike every other test in the file. If the POST fails silently (e.g., 400 or 500), the subsequent GET assertion on fields.foo.customLabel would fail with an unclear message instead of reporting the actual API error. Consider adding expect(updateResponse).toHaveStatusCode(200) after the POST request.

await apiClient.post(`${DATA_VIEW_PATH}/${sharedDataViewId}/fields`, { headers: { ...COMMON_HEADERS, ...adminApiCredentials.apiKeyHeader }, responseType: 'json', body: { fields: { foo: { customLabel: 'baz' } } }, - }); + }); + + expect(updateResponse).toHaveStatusCode(200); const getResponse = await apiClient.get(`${DATA_VIEW_PATH}/${sharedDataViewId}`, {

🤖 Copy this AI Prompt to have your agent fix this:

In file src/platform/plugins/shared/data_views/test/scout/api/tests/data_views/fields_api_update_main.spec.ts around lines 212-225: The test at line 212 does not verify the status code of the POST response, unlike every other test in the file. If the POST fails silently (e.g., 400 or 500), the subsequent GET assertion on `fields.foo.customLabel` would fail with an unclear message instead of reporting the actual API error. Consider adding `expect(updateResponse).toHaveStatusCode(200)` after the POST request. Evidence trail: src/platform/plugins/shared/data_views/test/scout/api/tests/data_views/fields_api_update_main.spec.ts lines 211-225 (test without status check), lines 69-70, 95-96, 125, 152, 172, 201, 244, 266, 305 (all other tests with status checks)

macroscopeapp · 2026-04-17T13:45:30Z

+      });
+
+      expect(getResponse).toHaveStatusCode(200);
+      expect(getResponse.body[SERVICE_KEY].fields.foo.customLabel).toBe('baz');


🟢 Low data_views/fields_api_update_main.spec.ts:224

The test at line 224 accesses getResponse.body[SERVICE_KEY].fields.foo.customLabel instead of fieldAttrs.foo.customLabel. This mismatches the API response structure and the pattern used in all other tests (lines 175, 181, 202, 208, 244, 250), causing the assertion to check the wrong property.

🤖 Copy this AI Prompt to have your agent fix this:

In file src/platform/plugins/shared/data_views/test/scout/api/tests/data_views/fields_api_update_main.spec.ts around line 224: The test at line 224 accesses `getResponse.body[SERVICE_KEY].fields.foo.customLabel` instead of `fieldAttrs.foo.customLabel`. This mismatches the API response structure and the pattern used in all other tests (lines 175, 181, 202, 208, 244, 250), causing the assertion to check the wrong property. Evidence trail: src/platform/plugins/shared/data_views/test/scout/api/tests/data_views/fields_api_update_main.spec.ts lines 165-260 at REVIEWED_COMMIT. Line 224 shows `expect(getResponse.body[SERVICE_KEY].fields.foo.customLabel).toBe('baz');` while lines 175, 181, ~202, ~208, ~244, ~250 all use the pattern `fieldAttrs.foo.customLabel` for the same type of data.

…apis-part-5

elasticmachine · 2026-04-20T08:37:18Z

Pinging @elastic/appex-qa (Team:QA)

macroscopeapp

Scout Test Review

Overall, this is a well-executed migration — the new Scout tests follow key best practices: every suite has deploymentAgnostic tags, constants are centralized, cleanup consistently uses afterEach/afterAll hooks with the createdIds pattern, esArchiver.loadIfNeeded() is used for idempotent setup, assertions validate both status codes and response bodies, and apiClient vs apiServices are used for the right purposes. apiTest.step is also nicely used in runtime_fields_update_main.spec.ts.

I have a handful of findings below grouped by severity.

^{Posted via Macroscope — Scout Test Review}

macroscopeapp · 2026-04-20T08:44:50Z

 export const SERVICE_KEY_LEGACY = 'index_pattern';
 export const SERVICE_KEY = 'data_view';
+export const HAS_USER_DATA_VIEW_PATH = 'api/data_views/has_user_data_view';
+export const HAS_USER_INDEX_PATTERN_PATH = 'api/index_patterns/has_user_index_pattern';


🔵 Minor — Use constants for shared test values / Dead code

HAS_USER_INDEX_PATTERN_PATH, FIELDS_ROUTE_PATH, and RESOLVE_INDEX_PATH are exported here but never imported by any test file. If they're placeholders for future work, consider adding a // TODO comment. Otherwise, removing them keeps the constants file tidy and avoids confusion about what's covered.

^{Posted via Macroscope — Scout Test Review}

davismcphee

Thanks for working on this, the code changes look good overall! I left a few comments (and looks like a couple of the bot's might make sense too), but the only main blocker imo is the dropped index_patterns coverage.

davismcphee · 2026-04-20T21:17:48Z

+    // Remaining FTR coverage. The rest of this suite has been migrated to Scout under
+    // `src/platform/plugins/shared/data_views/test/scout/api/tests/`.


These tests are pretty weird, and I agree should largely be unit tests. The only ones that actually need to be integration tests are the ones referencing indexNotFoundError and docNotFoundError. They guard against unexpected ES error changes that our detection mechanisms are sensitive to, which has happened before unfortunately (and was missed by unit tests).

I'd be ok carrying only those ones over to Scout and leaving the remainder as unit tests, but also ok if that's left as a followup.

…part-5

macroscopeapp

Scout Test Review

Good progress since last review — the fields_for_wildcard_route tests now correctly use viewer credentials, and the integration test comparison was strengthened with omit/toStrictEqual. 👍

Found 2 issues in newly added files (2 major). These mirror patterns already flagged on equivalent data_views/ files in the prior run — those prior findings still apply too. See inline comments for details.

^{Posted via Macroscope — Scout Test Review}

macroscopeapp · 2026-04-21T10:40:13Z

Scout Test Review

All issues resolved ✅

^{Share feedback in the #appex-qa channel.}

^{Posted via Macroscope — Scout Test Review}

macroscopeapp

Scout Test Review — 2 findings on newly added index_patterns/ files.

^{Posted via Macroscope — Scout Test Review}

elasticmachine · 2026-04-21T16:59:59Z

💚 Build Succeeded

Buildkite Build
Commit: 4fdf739

Metrics [docs]

✅ unchanged

History

💔 Build #431436 failed d9ed7f1
💔 Build #431243 failed 2b5a1c8
💛 Build #430331 was flaky eb57e93

cc @fake-haris

davismcphee

Thank you kindly! Data Discovery changes LGTM 👍

kibanamachine · 2026-04-22T07:10:03Z

Starting backport for target branches: 8.19, 9.2, 9.3, 9.4

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

kibanamachine · 2026-04-22T07:19:10Z

💔 Some backports could not be created

Status	Branch	Result
❌	8.19	Backport failed because of merge conflicts
❌	9.2	Backport failed because of merge conflicts
✅	9.3
✅	9.4

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

Manual backport

To create the backport manually run:

node scripts/backport --pr 264088

Questions ?

Please refer to the Backport tool documentation

fake-haris · 2026-04-22T08:08:18Z

💚 All backports created successfully

Status	Branch	Result
✅	9.2
✅	8.19

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

Questions ?

Please refer to the Backport tool documentation

…#264905) # Backport This will backport the following commits from `main` to `9.4`: - [[Scout] Migrate Data Views API tests from FTR - Part5 (#264088)](#264088)  ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sorenlouv/backport)  Co-authored-by: Charis Kalpakis <39087493+fake-haris@users.noreply.github.com>

…#264904) # Backport This will backport the following commits from `main` to `9.3`: - [[Scout] Migrate Data Views API tests from FTR - Part5 (#264088)](#264088)  ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sorenlouv/backport)  Co-authored-by: Charis Kalpakis <39087493+fake-haris@users.noreply.github.com>

…sationChanges23 * commit '9a7b717c662d1c904052bc59f0e5a81daab87c7f': (145 commits) Upgrade EUI to v114.2.0 (elastic#264550) [Entity Analytics] Add missing OpenAPI descriptions and examples to p… (elastic#264778) [Entity Resolution] Clarify CSV upload result for already-linked entities (elastic#264689) [AI Infra] Fix failing GenAI Settings Scout tests (elastic#260496) [Agent Builder] [Bug Bash] OAuth connector settings mention fields that are not there (elastic#264756) [performance] process-wide cache for advanced settings lookup (elastic#262618) [CI] Update limits.yml for securitySolution (elastic#264946) [SLO] Fix APM embeddable ids (elastic#264750) [EDR Workflows] Unify artifacts empty state buttons (elastic#264389) [Alert Triage workflow] Adds security.buildAlertEntityGraph and security.renderAlertNarrative… (elastic#259159) [SigEvents] Add KI feature identification endpoints and refactor task to use shared service (elastic#263528) [Scout] Migrate Data Views API tests from FTR - Part5 (elastic#264088) [Cases] Apply shared extended_fields path util server side (elastic#264706) [Lens as code] Fix metric trendline (elastic#264777) [api-docs] 2026-04-22 Daily api_docs build (elastic#264882) [Scout] Update test config manifests (elastic#264575) [workflows_management] Lazy-load Zod connector schemas to cut idle memory (elastic#264283) [ES|QL] Fix ES|QL columns reset race during active fetch (elastic#263947) [Content List] Column layout props, sticky actions, and title click handlers (elastic#264203) [Lens as code] Validate `id` in route for new vis types (elastic#264480) ...

#264936) # Backport This will backport the following commits from `main` to `8.19`: - [[Scout] Migrate Data Views API tests from FTR - Part5 (#264088)](#264088)  ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sorenlouv/backport)

…#264934) # Backport This will backport the following commits from `main` to `9.2`: - [[Scout] Migrate Data Views API tests from FTR - Part5 (#264088)](#264088)  ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sorenlouv/backport)

fake-haris added 2 commits April 17, 2026 15:59

moved remaining ftr tests to scout

a3a9c97

Merge remote-tracking branch 'upstream/main' into migrate-data-views-…

89a6e62

…apis-part-5

fake-haris self-assigned this Apr 17, 2026

fake-haris added Team:QA Platform QA t// release_note:skip Skip the PR/issue when compiling release notes backport:all-open Backport to all branches that could still receive a release labels Apr 17, 2026

macroscopeapp Bot reviewed Apr 17, 2026

View reviewed changes

Merge remote-tracking branch 'upstream/main' into migrate-data-views-…

eb57e93

…apis-part-5

fake-haris marked this pull request as ready for review April 20, 2026 08:37

fake-haris requested a review from a team as a code owner April 20, 2026 08:37

macroscopeapp Bot reviewed Apr 20, 2026

View reviewed changes

davismcphee reviewed Apr 20, 2026

View reviewed changes

fake-haris added 2 commits April 21, 2026 13:33

changes based on pr comment

736f9b2

Merge remote-tracking branch 'upstream' into migrate-data-views-apis-…

2b5a1c8

…part-5

macroscopeapp Bot reviewed Apr 21, 2026

View reviewed changes

Comment thread ...plugins/shared/data_views/test/scout/api/tests/index_patterns/has_user_index_pattern.spec.ts

Comment thread src/platform/plugins/shared/data_views/test/scout/api/tests/index_patterns/integration.spec.ts

macroscopeapp Bot reviewed Apr 21, 2026

View reviewed changes

Comment thread ...plugins/shared/data_views/test/scout/api/tests/index_patterns/has_user_index_pattern.spec.ts Outdated

Comment thread src/platform/plugins/shared/data_views/test/scout/api/tests/index_patterns/integration.spec.ts

changes based on AI comments

d9ed7f1

fake-haris requested a review from davismcphee April 21, 2026 14:28

revert user to admin for filter and response

4fdf739

davismcphee approved these changes Apr 21, 2026

View reviewed changes

fake-haris merged commit af013db into elastic:main Apr 22, 2026
20 checks passed

kibanamachine added the v9.5.0 label Apr 22, 2026

This was referenced Apr 22, 2026

[9.3] [Scout] Migrate Data Views API tests from FTR - Part5 (#264088) #264904

Merged

[9.4] [Scout] Migrate Data Views API tests from FTR - Part5 (#264088) #264905

Merged

This was referenced Apr 22, 2026

[9.2] [Scout] Migrate Data Views API tests from FTR - Part5 (#264088) #264934

Merged

[8.19] [Scout] Migrate Data Views API tests from FTR - Part5 (#264088) #264936

Merged

kibanamachine added the v9.4.0 label Apr 22, 2026

kibanamachine added the v9.3.4 label Apr 22, 2026

kibanamachine added v8.19.15 v9.2.9 labels Apr 22, 2026

SoniaSanzV pushed a commit to SoniaSanzV/kibana that referenced this pull request Apr 27, 2026

[Scout] Migrate Data Views API tests from FTR - Part5 (elastic#264088)

d1c049d

		// Remaining FTR coverage. The rest of this suite has been migrated to Scout under
		// `src/platform/plugins/shared/data_views/test/scout/api/tests/`.

Conversation

fake-haris commented Apr 17, 2026 • edited by kibanamachine Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

What moved

What was removed

Notes / follow-ups

Uh oh!

macroscopeapp Bot commented Apr 17, 2026

Catch flakiness early (recommended)

Uh oh!

macroscopeapp Bot Apr 17, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

macroscopeapp Bot Apr 17, 2026

Choose a reason for hiding this comment

Uh oh!

elasticmachine commented Apr 20, 2026

Uh oh!

macroscopeapp Bot left a comment

Choose a reason for hiding this comment

Scout Test Review

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

macroscopeapp Bot Apr 20, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

davismcphee left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

davismcphee Apr 20, 2026

Choose a reason for hiding this comment

Uh oh!

macroscopeapp Bot left a comment

Choose a reason for hiding this comment

Scout Test Review

Uh oh!

Uh oh!

Uh oh!

macroscopeapp Bot commented Apr 21, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Scout Test Review

Uh oh!

macroscopeapp Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

elasticmachine commented Apr 21, 2026

💚 Build Succeeded

Metrics [docs]

History

Uh oh!

davismcphee left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

kibanamachine commented Apr 22, 2026

Uh oh!

kibanamachine commented Apr 22, 2026

💔 Some backports could not be created

Manual backport

Questions ?

Uh oh!

fake-haris commented Apr 22, 2026

💚 All backports created successfully

Questions ?

Uh oh!

Reviewers

Assignees

Labels

Projects

fake-haris commented Apr 17, 2026 •

edited by kibanamachine

Loading

macroscopeapp Bot commented Apr 21, 2026 •

edited

Loading