[@kbn/dashboard-plugin] Migrate Dashboard's CRUD API tests from FTR to Scout by steliosmavro · Pull Request #251163 · elastic/kibana

steliosmavro · 2026-01-31T08:18:32Z

Summary

Migrates the Dashboard plugin's CRUD API integration tests from FTR to the Scout framework. All 19 test cases have been successfully migrated with full coverage parity, using least-privileged roles (viewer for read operations, editor for write operations) and the new expect import from @kbn/scout/api.

Migrated tests for: create, get, update, delete, and search dashboard endpoints
Added OAS schema validation test (enabled server.oas.enabled=true in Scout base config)
Used appropriate roles: viewer for GET/search tests, editor for POST/PUT/DELETE tests
Organized test fixtures in dedicated fixtures/ directory with shared constants and archives
Removed FTR tests from src/platform/test/api_integration/apis/dashboards/
Added dashboard to .buildkite/scout_ci_config.yml
Updated .github/CODEOWNERS to remove old FTR test path
All 19 tests passing with ESLint and TypeScript checks clean

…cout reference

…n't exist in serverless

The OAS endpoint (/api/oas) is only enabled in stateful config (server.oas.enabled=true), not serverless. Test returns 404 on serverless deployments.

dmlemeshko · 2026-02-02T08:21:24Z

+      // Enable OpenAPI specification endpoint for schema validation tests
+      '--server.oas.enabled=true',


We need to check if the tests are working against ECH, and if not - move this argument to custom servers config and run only in local CI env. @steliosmavro could you create 9.4-snapshot deployment and run the new tests?

dmlemeshko · 2026-02-02T08:39:43Z

+    expect(response).toHaveStatusCode(400);
+    expect(response.body.statusCode).toBe(400);


isn't it a duplicated check?

I tried keeping it the same as it was to be secure, but I think you are right - we shouldn't check body.statusCode again if we've already checked response.

Unless @elastic/kibana-presentation has a good reason for this, I’ll proceed updating this and the other occurrences of the same pattern. 👍

dmlemeshko · 2026-02-02T08:39:59Z

+    expect(response).toHaveStatusCode(400);
+    expect(response.body.statusCode).toBe(400);


isn't it a duplicated check?

dmlemeshko · 2026-02-02T08:42:50Z

+    expect(response).toHaveStatusCode(404);
+    expect(response.body).toStrictEqual({
+      statusCode: 404,
+      error: 'Not Found',
+      message: 'A dashboard with ID non-existent-dashboard was not found.',


I think we can drop one of status code checks?

dmlemeshko · 2026-02-02T08:44:15Z

+    expect(response.body.dashboards[0].id).toBe('test-dashboard-00');
+    expect(response.body.dashboards).toHaveLength(20);


we probably want to change order of check to validate dashboards .length before unwrapping the first item

Nice catch, I'll update accordingly!

dmlemeshko · 2026-02-02T08:45:14Z

+    expect(response).toHaveStatusCode(404);
+    expect(response.body).toStrictEqual({
+      statusCode: 404,


identical check, one to drop?

dmlemeshko · 2026-02-02T08:45:30Z

+    expect(response).toHaveStatusCode(400);
+    expect(response.body.statusCode).toBe(400);


same here, one to drop?

dmlemeshko · 2026-02-02T08:45:41Z

+    expect(response).toHaveStatusCode(400);
+    expect(response.body.statusCode).toBe(400);


here as well

csr · 2026-02-02T10:14:57Z

+  apiTest.beforeAll(async ({ kbnClient, requestAuth }) => {
+    viewerCredentials = await requestAuth.getApiKey('viewer');
+    await kbnClient.importExport.load(KBN_ARCHIVES.BASIC);
+    await kbnClient.importExport.load(KBN_ARCHIVES.TAGS);
+  });
+
+  apiTest.afterAll(async ({ kbnClient }) => {
+    await kbnClient.savedObjects.cleanStandardList();
+  });


I don't think ingesting the Kibana archives is useful for the purposes of this test, is it?

We can remove kbnClient.importExport.load and kbnClient.savedObjects.cleanStandardList() calls (as there will be nothing to clean up):

Suggested change

apiTest.beforeAll(async ({ kbnClient, requestAuth }) => {

viewerCredentials = await requestAuth.getApiKey('viewer');

await kbnClient.importExport.load(KBN_ARCHIVES.BASIC);

await kbnClient.importExport.load(KBN_ARCHIVES.TAGS);

});

apiTest.afterAll(async ({ kbnClient }) => {

await kbnClient.savedObjects.cleanStandardList();

});

apiTest.beforeAll(async ({ kbnClient, requestAuth }) => {

viewerCredentials = await requestAuth.getApiKey('viewer');

});

ThomThomson

Changes LGTM! Seems like a direct port mostly. Looked through the code and made sure all the tests made it through the conversion. Thank you for tackling this!

kibanamachine · 2026-02-07T17:26:31Z

Starting backport for target branches: 8.19, 9.2, 9.3

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

kibanamachine · 2026-02-07T17:35:10Z

💔 All backports failed

Status	Branch	Result
❌	8.19	Backport failed because of merge conflicts
❌	9.2	Backport failed because of merge conflicts
❌	9.3	Backport failed because of merge conflicts You might need to backport the following PRs to 9.3: - [FTR to Scout] Migrate `x-pack` dashboard `group2` tests (#249233) - [scout] discover tests with custom server configs (#251297)

Manual backport

To create the backport manually run:

node scripts/backport --pr 251163

Questions ?

Please refer to the Backport tool documentation

…o Scout (elastic#251163) ## Summary Migrates the Dashboard plugin's CRUD API integration tests from FTR to the Scout framework. All 19 test cases have been successfully migrated with full coverage parity, using least-privileged roles (`viewer` for read operations, `editor` for write operations) and the new `expect` import from `@kbn/scout/api`. - Migrated tests for: create, get, update, delete, and search dashboard endpoints - Added OAS schema validation test (enabled `server.oas.enabled=true` in Scout base config) - Used appropriate roles: `viewer` for GET/search tests, `editor` for POST/PUT/DELETE tests - Organized test fixtures in dedicated `fixtures/` directory with shared constants and archives - Removed FTR tests from `src/platform/test/api_integration/apis/dashboards/` - Added `dashboard` to `.buildkite/scout_ci_config.yml` - Updated `.github/CODEOWNERS` to remove old FTR test path - All 19 tests passing with ESLint and TypeScript checks clean --------- Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com> (cherry picked from commit 17fdeed) # Conflicts: # .buildkite/scout_ci_config.yml # src/platform/plugins/shared/dashboard/moon.yml # src/platform/plugins/shared/dashboard/tsconfig.json

…o Scout (elastic#251163) ## Summary Migrates the Dashboard plugin's CRUD API integration tests from FTR to the Scout framework. All 19 test cases have been successfully migrated with full coverage parity, using least-privileged roles (`viewer` for read operations, `editor` for write operations) and the new `expect` import from `@kbn/scout/api`. - Migrated tests for: create, get, update, delete, and search dashboard endpoints - Added OAS schema validation test (enabled `server.oas.enabled=true` in Scout base config) - Used appropriate roles: `viewer` for GET/search tests, `editor` for POST/PUT/DELETE tests - Organized test fixtures in dedicated `fixtures/` directory with shared constants and archives - Removed FTR tests from `src/platform/test/api_integration/apis/dashboards/` - Added `dashboard` to `.buildkite/scout_ci_config.yml` - Updated `.github/CODEOWNERS` to remove old FTR test path - All 19 tests passing with ESLint and TypeScript checks clean --------- Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com> (cherry picked from commit 17fdeed) # Conflicts: # .buildkite/scout_ci_config.yml # src/platform/plugins/shared/dashboard/moon.yml # src/platform/plugins/shared/dashboard/test/scout/api/fixtures/index.ts # src/platform/plugins/shared/dashboard/test/scout_oas_schema/api/fixtures/schema_snapshot.json # src/platform/plugins/shared/dashboard/tsconfig.json # src/platform/test/api_integration/apis/dashboards/create_dashboard/index.ts # src/platform/test/api_integration/apis/dashboards/create_dashboard/main.ts # src/platform/test/api_integration/apis/dashboards/create_dashboard/validation.ts # src/platform/test/api_integration/apis/dashboards/delete_dashboard/main.ts # src/platform/test/api_integration/apis/dashboards/get_dashboard/main.ts # src/platform/test/api_integration/apis/dashboards/list_dashboards/index.ts # src/platform/test/api_integration/apis/dashboards/list_dashboards/main.ts # src/platform/test/api_integration/apis/dashboards/update_dashboard/main.ts # src/platform/test/api_integration/apis/dashboards/update_dashboard/validation.ts

…o Scout (elastic#251163) ## Summary Migrates the Dashboard plugin's CRUD API integration tests from FTR to the Scout framework. All 19 test cases have been successfully migrated with full coverage parity, using least-privileged roles (`viewer` for read operations, `editor` for write operations) and the new `expect` import from `@kbn/scout/api`. - Migrated tests for: create, get, update, delete, and search dashboard endpoints - Added OAS schema validation test (enabled `server.oas.enabled=true` in Scout base config) - Used appropriate roles: `viewer` for GET/search tests, `editor` for POST/PUT/DELETE tests - Organized test fixtures in dedicated `fixtures/` directory with shared constants and archives - Removed FTR tests from `src/platform/test/api_integration/apis/dashboards/` - Added `dashboard` to `.buildkite/scout_ci_config.yml` - Updated `.github/CODEOWNERS` to remove old FTR test path - All 19 tests passing with ESLint and TypeScript checks clean --------- Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com> (cherry picked from commit 17fdeed) # Conflicts: # .buildkite/scout_ci_config.yml # .github/CODEOWNERS # src/platform/plugins/shared/dashboard/moon.yml # src/platform/plugins/shared/dashboard/test/scout/api/fixtures/index.ts # src/platform/plugins/shared/dashboard/test/scout_oas_schema/api/fixtures/schema_snapshot.json # src/platform/plugins/shared/dashboard/tsconfig.json # src/platform/test/api_integration/apis/dashboards/create_dashboard/index.ts # src/platform/test/api_integration/apis/dashboards/create_dashboard/main.ts # src/platform/test/api_integration/apis/dashboards/create_dashboard/validation.ts # src/platform/test/api_integration/apis/dashboards/delete_dashboard/index.ts # src/platform/test/api_integration/apis/dashboards/delete_dashboard/main.ts # src/platform/test/api_integration/apis/dashboards/get_dashboard/index.ts # src/platform/test/api_integration/apis/dashboards/get_dashboard/main.ts # src/platform/test/api_integration/apis/dashboards/list_dashboards/index.ts # src/platform/test/api_integration/apis/dashboards/list_dashboards/main.ts # src/platform/test/api_integration/apis/dashboards/update_dashboard/index.ts # src/platform/test/api_integration/apis/dashboards/update_dashboard/main.ts # src/platform/test/api_integration/apis/dashboards/update_dashboard/validation.ts

steliosmavro · 2026-02-07T19:44:09Z

💚 All backports created successfully

Status	Branch	Result
✅	9.3
✅	9.2
✅	8.19

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

Questions ?

Please refer to the Backport tool documentation

…m FTR to Scout (#251163) (#252206) # Backport This will backport the following commits from `main` to `8.19`: - [[@kbn/dashboard-plugin] Migrate Dashboard's CRUD API tests from FTR to Scout (#251163)](#251163)  ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sorenlouv/backport)

… FTR to Scout (#251163) (#252205) # Backport This will backport the following commits from `main` to `9.2`: - [[@kbn/dashboard-plugin] Migrate Dashboard's CRUD API tests from FTR to Scout (#251163)](#251163)  ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sorenlouv/backport)

… FTR to Scout (#251163) (#252203) # Backport This will backport the following commits from `main` to `9.3`: - [[@kbn/dashboard-plugin] Migrate Dashboard's CRUD API tests from FTR to Scout (#251163)](#251163)  ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sorenlouv/backport)

…nd deployment agnostic tags (#253413) We introduced the `requestAuth.getApiKeyForPrivilegedUser()` API-key based authentication method via #252095. We now update some of the test suites introduced via #251163 to use the new method. We update the tags so that these tests are marked to run in more testing environments, not just stateful.

…nd deployment agnostic tags (elastic#253413) We introduced the `requestAuth.getApiKeyForPrivilegedUser()` API-key based authentication method via elastic#252095. We now update some of the test suites introduced via elastic#251163 to use the new method. We update the tags so that these tests are marked to run in more testing environments, not just stateful. (cherry picked from commit 6636fb6)

…nd deployment agnostic tags (elastic#253413) We introduced the `requestAuth.getApiKeyForPrivilegedUser()` API-key based authentication method via elastic#252095. We now update some of the test suites introduced via elastic#251163 to use the new method. We update the tags so that these tests are marked to run in more testing environments, not just stateful. (cherry picked from commit 6636fb6) # Conflicts: # src/platform/plugins/shared/dashboard/test/scout/api/tests/update_dashboard.spec.ts

…nd deployment agnostic tags (elastic#253413) We introduced the `requestAuth.getApiKeyForPrivilegedUser()` API-key based authentication method via elastic#252095. We now update some of the test suites introduced via elastic#251163 to use the new method. We update the tags so that these tests are marked to run in more testing environments, not just stateful.

## Summary Closes #250439. Blocked by #251163 This removes `spaces` from the create request body which is already passed in as part of the URL and removes the nesting under the `data` property in the request body. This also moves the optional `id` from the create request body to a URL param, e.g. `/api/dashboards/{id}`. Examples: Create request: ``` POST /api/dashboards { "title": "my empty dashboard" "description": "this is my description" // other dashboard attributes } ``` ``` POST /api/dashboards/{id} { "title": "my empty dashboard" "description": "this is my description" // other dashboard attributes } ``` Update request: ``` PUT /api/dashboards/:id { "title": "my updated dashboard" "description": "this is my updated description" // other dashboard attributes } ``` Create in a non-default space request: ``` POST /s/my-space/api/dashboards/id? { "title": "my empty dashboard" "description": "this is my description" // other dashboard attributes } ``` Update in a non-default space request: ``` PUT /s/my-space/api/dashboards/:id { "title": "my updated dashboard" "description": "this is my updated description" // other dashboard attributes } ``` ### Checklist Check the PR satisfies following conditions. Reviewers should verify this PR satisfies this list as well. - [ ] Any text added follows [EUI's writing guidelines](https://elastic.github.io/eui/#/guidelines/writing), uses sentence case text and includes [i18n support](https://github.com/elastic/kibana/blob/main/src/platform/packages/shared/kbn-i18n/README.md) - [ ] [Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html) was added for features that require explanation or tutorials - [ ] [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 - [ ] If a plugin configuration key changed, check if it needs to be allowlisted in the cloud and added to the [docker list](https://github.com/elastic/kibana/blob/main/src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker) - [ ] This was checked for breaking HTTP API changes, and any breaking changes have been approved by the breaking-change committee. The `release_note:breaking` label should be applied in these situations. - [ ] [Flaky Test Runner](https://ci-stats.kibana.dev/trigger_flaky_test_runner/1) was used on any tests changed - [ ] The PR description includes the appropriate Release Notes section, and the correct `release_note:*` label is applied per the [guidelines](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process) - [ ] Review the [backport guidelines](https://docs.google.com/document/d/1VyN5k91e5OVumlc0Gb9RPa3h1ewuPE705nRtioPiTvY/edit?usp=sharing) and apply applicable `backport:*` labels. ### Identify risks Does this PR introduce any risks? For example, consider risks like hard to test bugs, performance regression, potential of data loss. Describe the risk, its severity, and mitigation for each identified risk. Invite stakeholders and evaluate how to proceed before merging. - [ ] [See some risk examples](https://github.com/elastic/kibana/blob/main/RISK_MATRIX.mdx) - [ ] ...

steliosmavro added 2 commits January 30, 2026 14:33

Boilerplate from scaffolding command

aac9d14

Migrate Dashboard's FTR CRUD API tests to Scout

446d774

steliosmavro requested a review from dmlemeshko January 31, 2026 08:18

steliosmavro self-assigned this Jan 31, 2026

steliosmavro added the release_note:skip Skip the PR/issue when compiling release notes label Jan 31, 2026

steliosmavro requested a review from a team as a code owner January 31, 2026 08:18

steliosmavro added the backport:all-open Backport to all branches that could still receive a release label Jan 31, 2026

steliosmavro requested a review from a team as a code owner January 31, 2026 08:18

steliosmavro added the test:scout label Jan 31, 2026

steliosmavro changed the title ~~Scout migration dashboard crud api~~ [@kbn/dashboard-plugin] Migrate Dashboard's CRUD API tests from FTR to Scout Jan 31, 2026

steliosmavro and others added 8 commits January 31, 2026 11:17

Remove FTR tests and update CI configuration

2866bbc

Update TypeScript configuration to include Scout test files and add S…

715e4ed

…cout reference

Changes from node scripts/regenerate_moon_projects.js --update

9e1e6fa

Update tsconfig to include JSON files in Scout test directory

b980b2c

Changes from node scripts/regenerate_moon_projects.js --update

9bc29ec

Use ESS_ONLY tag for tests using editor role because editor role does…

a5b0886

…n't exist in serverless

Tag schema test as ESS_ONLY

cc3a93d

The OAS endpoint (/api/oas) is only enabled in stateful config (server.oas.enabled=true), not serverless. Test returns 404 on serverless deployments.

Merge branch 'main' into scout-migration-dashboard-crud-api

23fa3d7

csr self-requested a review February 2, 2026 08:19

dmlemeshko reviewed Feb 2, 2026

View reviewed changes

Comment thread src/platform/plugins/shared/dashboard/test/scout_oas_schema/api/tests/schema.spec.ts

dmlemeshko reviewed Feb 2, 2026

View reviewed changes

Enable OAS endpoint in Scout serverless config

cd15d5a

csr reviewed Feb 2, 2026

View reviewed changes

csr mentioned this pull request Feb 6, 2026

[Scout] Add convenience API key methods for common roles in requestAuth #252095

Merged

ThomThomson self-requested a review February 6, 2026 16:57

ThomThomson approved these changes Feb 6, 2026

View reviewed changes

steliosmavro merged commit 17fdeed into elastic:main Feb 7, 2026
16 checks passed

kibanamachine added the v9.4.0 label Feb 7, 2026

steliosmavro mentioned this pull request Feb 7, 2026

[9.3] [@kbn/dashboard-plugin] Migrate Dashboard's CRUD API tests from FTR to Scout (#251163) #252203

Merged

steliosmavro mentioned this pull request Feb 7, 2026

[9.2] [@kbn/dashboard-plugin] Migrate Dashboard's CRUD API tests from FTR to Scout (#251163) #252205

Merged

steliosmavro mentioned this pull request Feb 7, 2026

[8.19] [@kbn/dashboard-plugin] Migrate Dashboard's CRUD API tests from FTR to Scout (#251163) #252206

Merged

kibanamachine added v8.19.12 v9.2.6 labels Feb 9, 2026

kibanamachine added the v9.3.0 label Feb 9, 2026

csr mentioned this pull request Feb 17, 2026

[Dashboard] Update Scout API tests to use non-admin privileged role and deployment agnostic tags #253413

Merged

yiannisnikolopoulos mentioned this pull request Feb 18, 2026

[Synthetics] Embeddable schema registration #251445

Merged

2 tasks

		// Enable OpenAPI specification endpoint for schema validation tests
		'--server.oas.enabled=true',

		expect(response).toHaveStatusCode(400);
		expect(response.body.statusCode).toBe(400);

		expect(response.body.dashboards[0].id).toBe('test-dashboard-00');
		expect(response.body.dashboards).toHaveLength(20);

Conversation

steliosmavro commented Jan 31, 2026 • edited by kibanamachine Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

csr Feb 2, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ThomThomson left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

kibanamachine commented Feb 7, 2026

Uh oh!

kibanamachine commented Feb 7, 2026

💔 All backports failed

Manual backport

Questions ?

Uh oh!

steliosmavro commented Feb 7, 2026

💚 All backports created successfully

Questions ?

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

steliosmavro commented Jan 31, 2026 •

edited by kibanamachine

Loading

csr Feb 2, 2026 •

edited

Loading