[9.2] [console] Move api test to scout / playwright (#241561) (#242202)

# Backport

This will backport the following commits from `main` to `9.2`:
- [[console] Move api test to scout / playwright
(#241561)](#241561)

<!--- Backport version: 10.1.0 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sorenlouv/backport)

<!--BACKPORT [{"author":{"name":"Matthew
Kime","email":"[email protected]"},"sourceCommit":{"committedDate":"2025-11-05T11:33:45Z","message":"[console]
Move api test to scout / playwright (#241561)\n\n## Summary\n\nMove
console api integration test over to scout / playwright. Keeping\ntest
as unchanged as possible to learn about using scout /
playwright.\n\nPart of
https://github.com/elastic/kibana/issues/241708\n\n---------\n\nCo-authored-by:
kibanamachine
<[email protected]>\nCo-authored-by:
Dzmitry Lemechko
<[email protected]>","sha":"496455cd33d3e799b47da77b808fef3ec9bbbfac","branchLabelMapping":{"^v9.3.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["Feature:Console","Team:Kibana
Management","release_note:skip","backport
missing","backport:all-open","v9.3.0"],"title":"[console] Move api test
to scout /
playwright","number":241561,"url":"https://github.com/elastic/kibana/pull/241561","mergeCommit":{"message":"[console]
Move api test to scout / playwright (#241561)\n\n## Summary\n\nMove
console api integration test over to scout / playwright. Keeping\ntest
as unchanged as possible to learn about using scout /
playwright.\n\nPart of
https://github.com/elastic/kibana/issues/241708\n\n---------\n\nCo-authored-by:
kibanamachine
<[email protected]>\nCo-authored-by:
Dzmitry Lemechko
<[email protected]>","sha":"496455cd33d3e799b47da77b808fef3ec9bbbfac"}},"sourceBranch":"main","suggestedTargetBranches":[],"targetPullRequestStates":[{"branch":"main","label":"v9.3.0","branchLabelMappingKey":"^v9.3.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/241561","number":241561,"mergeCommit":{"message":"[console]
Move api test to scout / playwright (#241561)\n\n## Summary\n\nMove
console api integration test over to scout / playwright. Keeping\ntest
as unchanged as possible to learn about using scout /
playwright.\n\nPart of
https://github.com/elastic/kibana/issues/241708\n\n---------\n\nCo-authored-by:
kibanamachine
<[email protected]>\nCo-authored-by:
Dzmitry Lemechko
<[email protected]>","sha":"496455cd33d3e799b47da77b808fef3ec9bbbfac"}},{"url":"https://github.com/elastic/kibana/pull/242199","number":242199,"branch":"9.1","state":"OPEN"},{"url":"https://github.com/elastic/kibana/pull/242200","number":242200,"branch":"9.0","state":"OPEN"},{"url":"https://github.com/elastic/kibana/pull/242201","number":242201,"branch":"8.19","state":"OPEN"}]}]
BACKPORT-->

Author: mattkime

.buildkite/scout_ci_config.yml

@@ -2,6 +2,7 @@
 plugins:
   enabled:
     - apm
+    - console
     - discover_enhanced
     - maps
     - observability

src/platform/plugins/shared/console/test/scout/api/fixtures/constants.ts

@@ -0,0 +1,14 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the "Elastic License
+ * 2.0", the "GNU Affero General Public License v3.0 only", and the "Server Side
+ * Public License v 1"; you may not use this file except in compliance with, at
+ * your election, the "Elastic License 2.0", the "GNU Affero General Public
+ * License v3.0 only", or the "Server Side Public License, v 1".
+ */
+
+export const COMMON_HEADERS = {
+  'kbn-xsrf': 'some-xsrf-token',
+  'x-elastic-internal-origin': 'kibana',
+  'Content-Type': 'application/json;charset=UTF-8',
+};

src/platform/plugins/shared/console/test/scout/api/playwright.config.ts

@@ -0,0 +1,14 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the "Elastic License
+ * 2.0", the "GNU Affero General Public License v3.0 only", and the "Server Side
+ * Public License v 1"; you may not use this file except in compliance with, at
+ * your election, the "Elastic License 2.0", the "GNU Affero General Public
+ * License v3.0 only", or the "Server Side Public License, v 1".
+ */
+
+import { createPlaywrightConfig } from '@kbn/scout';
+
+export default createPlaywrightConfig({
+  testDir: './tests',
+});

src/platform/plugins/shared/console/test/scout/api/tests/spec_definitions.spec.ts

@@ -0,0 +1,40 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the "Elastic License
+ * 2.0", the "GNU Affero General Public License v3.0 only", and the "Server Side
+ * Public License v 1"; you may not use this file except in compliance with, at
+ * your election, the "Elastic License 2.0", the "GNU Affero General Public
+ * License v3.0 only", or the "Server Side Public License, v 1".
+ */
+
+import type { RoleApiCredentials } from '@kbn/scout';
+import { apiTest, expect } from '@kbn/scout';
+import { COMMON_HEADERS } from '../fixtures/constants';
+
+apiTest.describe(
+  'GET /api/console/api_server',
+  { tag: ['@ess', '@svlSecurity', '@svlOblt', '@svlSearch'] },
+  () => {
+    let adminApiCredentials: RoleApiCredentials;
+    apiTest.beforeAll(async ({ requestAuth }) => {
+      adminApiCredentials = await requestAuth.getApiKey('viewer');
+    });
+    apiTest('returns autocomplete definitions', async ({ apiClient }) => {
+      const { body, statusCode } = await apiClient.get('api/console/api_server', {
+        headers: {
+          ...COMMON_HEADERS,
+          ...adminApiCredentials.apiKeyHeader,
+        },
+        responseType: 'json',
+      });
+      expect(statusCode).toBe(200);
+      expect(body).toHaveProperty('es');
+      const {
+        es: { name, globals, endpoints },
+      } = body;
+      expect(name).toBe('es');
+      expect(Object.keys(globals).length).toBeGreaterThan(0);
+      expect(Object.keys(endpoints).length).toBeGreaterThan(0);
+    });
+  }
+);

src/platform/plugins/shared/console/tsconfig.json

@@ -3,8 +3,9 @@
   "compilerOptions": {
     "outDir": "target/types",
   },
-  "include": ["common/**/*", "public/**/*", "server/**/*"],
+  "include": ["common/**/*", "public/**/*", "server/**/*", "test/**/*"],
   "kbn_references": [
+    "@kbn/scout",
     "@kbn/core",
     "@kbn/dev-tools-plugin",
     "@kbn/es-ui-shared-plugin",

x-pack/platform/test/api_integration_deployment_agnostic/apis/console/index.ts

@@ -12,7 +12,6 @@ export default function ({ loadTestFile }: DeploymentAgnosticFtrProviderContext)
 
     // load new oblt and platform deployment-agnostic test here
     // Note: if your tests runtime is over 5 minutes, create a new index and config file
-    loadTestFile(require.resolve('../../apis/console'));
     loadTestFile(require.resolve('../../apis/core'));
     loadTestFile(require.resolve('../../apis/management'));
     loadTestFile(require.resolve('../../apis/painless_lab'));

x-pack/platform/test/api_integration_deployment_agnostic/apis/console/spec_definitions.ts

@@ -11,7 +11,6 @@ export default function ({ loadTestFile }: DeploymentAgnosticFtrProviderContext)
     this.tags(['esGate']);
 
     // load new search and platform deployment-agnostic test here
-    loadTestFile(require.resolve('../../apis/console'));
     loadTestFile(require.resolve('../../apis/core'));
     loadTestFile(require.resolve('../../apis/management'));
     loadTestFile(require.resolve('../../apis/saved_objects_management'));

x-pack/platform/test/api_integration_deployment_agnostic/configs/serverless/oblt.index.ts

@@ -11,7 +11,6 @@ export default function ({ loadTestFile }: DeploymentAgnosticFtrProviderContext)
     this.tags(['esGate']);
 
     // load new security and platform deployment-agnostic test here
-    loadTestFile(require.resolve('../../apis/console'));
     loadTestFile(require.resolve('../../apis/core'));
     loadTestFile(require.resolve('../../apis/management'));
     loadTestFile(require.resolve('../../apis/painless_lab'));