[FTR] Refactor test/common/services

Resolves: elastic#188541

docs/developer/contributing/development-functional-tests.asciidoc

@@ -203,7 +203,7 @@ Tests should run at the positive security boundary condition, meaning that they
 
 The functional UI tests now default to logging in with a user named `test_user` and the roles of this user can be changed dynamically without logging in and out.  
 
-In order to achieve this a new service was introduced called `createTestUserService` (see `test/common/services/security/test_user.ts`). The purpose of this test user service is to create roles defined in the test config files and setRoles() or restoreDefaults().
+In order to achieve this a new service was introduced called `createTestUserService` (see `packages/kbn-ftr-common-functional-ui-services/services/security/test_user.ts`). The purpose of this test user service is to create roles defined in the test config files and setRoles() or restoreDefaults().
 
 An example of how to set the role like how its defined below:
 
@@ -366,22 +366,22 @@ await testSubjects.click(‘containerButton’);
 ** `find.allByCssSelector()`
 
 **retry:**:::
-// * Source: {kibana-blob}test/common/services/retry/retry.ts[test/common/services/retry/retry.ts]
+// * Source: {kibana-blob}packages/kbn-ftr-common-functional-services/services/retry/retry.ts[packages/kbn-ftr-common-functional-services/services/retry/retry.ts]
 * Helpers for retrying operations
 * Popular methods:
 ** `retry.try(fn, onFailureBlock)` - Execute `fn` in a loop until it succeeds or the default timeout elapses. The optional `onFailureBlock` is executed before each retry attempt.
 ** `retry.tryForTime(ms, fn, onFailureBlock)` - Execute `fn` in a loop until it succeeds or `ms` milliseconds elapses. The optional `onFailureBlock` is executed before each retry attempt.
 
 **kibanaServer:**:::
-// * Source: {kibana-blob}test/common/services/kibana_server/kibana_server.js[test/common/services/kibana_server/kibana_server.js]
+// * Source: {kibana-blob}packages/kbn-ftr-common-functional-services/services/kibana_server/kibana_server.ts[packages/kbn-ftr-common-functional-services/services/kibana_server/kibana_server.ts]
 * Helpers for interacting with {kib}'s server
 * Commonly used methods:
 ** `kibanaServer.uiSettings.update()`
 ** `kibanaServer.version.get()`
 ** `kibanaServer.status.getOverallState()`
 
 **esArchiver:**:::
-// * Source: {kibana-blob}test/common/services/es_archiver.ts[test/common/services/es_archiver.ts]
+// * Source: {kibana-blob}packages/kbn-ftr-common-functional-services/services/es_archiver.ts[packages/kbn-ftr-common-functional-services/services/es_archiver.ts]
 * Load/unload archives created with the `esArchiver`
 * Popular methods:
 ** `esArchiver.load(path)`
@@ -393,7 +393,7 @@ Full list of services that are used in functional tests can be found here: {kiba
 
 **Low-level utilities:**:::
 * es
-// ** Source: {kibana-blob}test/common/services/es.ts[test/common/services/es.ts]
+// ** Source: {kibana-blob}packages/kbn-ftr-common-functional-services/services/es.ts[packages/kbn-ftr-common-functional-services/services/es.ts]
 ** {es} client
 ** Higher level options: `kibanaServer.uiSettings` or `esArchiver`
 * remote

packages/kbn-ftr-common-functional-services/index.ts

@@ -10,6 +10,7 @@ import { ProvidedType } from '@kbn/test';
 export { services as commonFunctionalServices } from './services/all';
 
 import { KibanaServerProvider } from './services/kibana_server';
+export { KibanaServerProvider } from './services/kibana_server';
 export type KibanaServer = ProvidedType<typeof KibanaServerProvider>;
 
 export { RetryService } from './services/retry';
@@ -18,6 +19,7 @@ import { EsArchiverProvider } from './services/es_archiver';
 export type EsArchiver = ProvidedType<typeof EsArchiverProvider>;
 
 import { EsProvider } from './services/es';
+export { EsProvider } from './services/es';
 export type Es = ProvidedType<typeof EsProvider>;
 
 import { SupertestWithoutAuthProvider } from './services/supertest_without_auth';
@@ -29,3 +31,6 @@ import { SamlAuthProvider } from './services/saml_auth/saml_auth_provider';
 export type SamlAuthProviderType = ProvidedType<typeof SamlAuthProvider>;
 
 export type { FtrProviderContext } from './services/ftr_provider_context';
+export { runSavedObjInfoSvc } from './services/saved_object_info';
+
+export type { BsearchService, SendOptions } from './services/bsearch';

packages/kbn-ftr-common-functional-services/services/all.ts

@@ -10,6 +10,13 @@ import { EsArchiverProvider } from './es_archiver';
 import { EsProvider } from './es';
 import { KibanaServerProvider } from './kibana_server';
 import { RetryService } from './retry';
+import { BsearchService } from './bsearch';
+import { ConsoleProvider } from './console';
+import { DeploymentService } from './deployment';
+import { EsDeleteAllIndicesProvider } from './es_delete_all_indices';
+import { IndexPatternsService } from './index_patterns';
+import { SavedObjectInfoService } from './saved_object_info';
+import { RandomnessService } from './randomness';
 import { SupertestWithoutAuthProvider } from './supertest_without_auth';
 import { SamlAuthProvider } from './saml_auth';
 
@@ -18,6 +25,13 @@ export const services = {
   kibanaServer: KibanaServerProvider,
   esArchiver: EsArchiverProvider,
   retry: RetryService,
+  bsearch: BsearchService,
+  console: ConsoleProvider,
+  deployment: DeploymentService,
+  esDeleteAllIndices: EsDeleteAllIndicesProvider,
+  indexPatterns: IndexPatternsService,
+  savedObjectInfo: SavedObjectInfoService,
+  randomness: RandomnessService,
   supertestWithoutAuth: SupertestWithoutAuthProvider,
   samlAuth: SamlAuthProvider,
 };

test/common/services/bsearch.ts → packages/kbn-ftr-common-functional-services/services/bsearch.ts

@@ -12,7 +12,7 @@ import type SuperTest from 'supertest';
 import type { IEsSearchResponse } from '@kbn/search-types';
 import { ELASTIC_HTTP_VERSION_HEADER } from '@kbn/core-http-common';
 import { BFETCH_ROUTE_VERSION_LATEST } from '@kbn/bfetch-plugin/common';
-import { FtrService } from '../ftr_provider_context';
+import { FtrService } from './ftr_provider_context';
 
 /**
  * Function copied from here:
@@ -62,6 +62,7 @@ export interface SendOptions {
  * });
  * expect(response).eql({ ... your value ... });
  */
+
 export class BsearchService extends FtrService {
   private readonly retry = this.ctx.getService('retry');
 

test/api_integration/apis/console/helpers.ts → packages/kbn-ftr-common-functional-services/services/console.ts

@@ -6,9 +6,9 @@
  * Side Public License, v 1.
  */
 
-import type { FtrProviderContext } from '../../ftr_provider_context';
+import type { FtrProviderContext } from './ftr_provider_context';
 
-export function helpers(getService: FtrProviderContext['getService']) {
+export function ConsoleProvider({ getService }: FtrProviderContext) {
   const client = getService('es');
 
   const createIndex = async (indexName: string) => {

test/common/services/deployment.ts → packages/kbn-ftr-common-functional-services/services/deployment.ts

@@ -11,7 +11,7 @@ import { Agent } from 'https';
 import fetch from 'node-fetch';
 import { getUrl } from '@kbn/test';
 
-import { FtrService } from '../ftr_provider_context';
+import { FtrService } from './ftr_provider_context';
 
 export class DeploymentService extends FtrService {
   private readonly config = this.ctx.getService('config');

test/common/services/es_delete_all_indices.ts → packages/kbn-ftr-common-functional-services/services/es_delete_all_indices.ts

@@ -6,7 +6,7 @@
  * Side Public License, v 1.
  */
 
-import { FtrProviderContext } from '../ftr_provider_context';
+import { FtrProviderContext } from './ftr_provider_context';
 
 export function EsDeleteAllIndicesProvider({ getService }: FtrProviderContext) {
   const log = getService('log');

test/common/services/index_patterns.ts → packages/kbn-ftr-common-functional-services/services/index_patterns.ts

@@ -6,10 +6,14 @@
  * Side Public License, v 1.
  */
 
-import { ELASTIC_HTTP_VERSION_HEADER } from '@kbn/core-http-common';
-import { INITIAL_REST_VERSION } from '@kbn/data-views-plugin/server/constants';
-import { DataViewSpec } from '@kbn/data-plugin/common';
-import { FtrService } from '../ftr_provider_context';
+import type { DataViewSpec } from '@kbn/data-plugin/common';
+import { FtrService } from './ftr_provider_context';
+
+// The fallowing two constant values live in
+// '@kbn/data-views-plugin/server/constants' and
+// '@kbn/core-http-common' respectively.
+const INITIAL_REST_VERSION = '2023-10-31' as const;
+const ELASTIC_HTTP_VERSION_HEADER = 'elastic-api-version' as const;
 
 export class IndexPatternsService extends FtrService {
   private readonly kibanaServer = this.ctx.getService('kibanaServer');

test/common/services/randomness.ts → packages/kbn-ftr-common-functional-services/services/randomness.ts

@@ -9,7 +9,7 @@
 import Chance from 'chance';
 import { ToolingLog } from '@kbn/tooling-log';
 
-import { FtrService } from '../ftr_provider_context';
+import { FtrService } from './ftr_provider_context';
 
 let __CACHED_SEED__: number | undefined;
 function getSeed(log: ToolingLog) {

test/common/services/saved_object_info/saved_object_info.ts → packages/kbn-ftr-common-functional-services/services/saved_object_info/saved_object_info.ts

@@ -13,7 +13,7 @@ import { flow, pipe } from 'fp-ts/function';
 import * as TE from 'fp-ts/lib/TaskEither';
 import * as T from 'fp-ts/lib/Task';
 import { ToolingLog } from '@kbn/tooling-log';
-import { FtrService } from '../../ftr_provider_context';
+import { FtrService } from '../ftr_provider_context';
 import { print } from './utils';
 
 const pluck =

packages/kbn-ftr-common-functional-services/tsconfig.json

@@ -16,8 +16,14 @@
     "@kbn/es-archiver",
     "@kbn/test",
     "@kbn/expect",
+    "@kbn/search-types",
+    "@kbn/core-http-common",
+    "@kbn/bfetch-plugin",
+    "@kbn/data-plugin",
+    "@kbn/dev-cli-runner",
+    "@kbn/dev-cli-errors",
     "@kbn/repo-info",
-    "@kbn/es",
+    "@kbn/es"
   ],
   "exclude": [
     "target/**/*",

packages/kbn-ftr-common-functional-ui-services/index.ts

@@ -22,3 +22,4 @@ export {
 } from './services/remote/network_profiles';
 export type { TimeoutOpt } from './types';
 export { TestSubjects } from './services/test_subjects';
+export { SecurityService } from './services/security';

packages/kbn-ftr-common-functional-ui-services/services/all.ts

@@ -12,6 +12,7 @@ import { FindProvider } from './find';
 import { TestSubjects } from './test_subjects';
 import { BrowserProvider } from './browser';
 import { ToastsService } from './toasts';
+import { SecurityServiceProvider } from './security';
 
 export const services = {
   retryOnStale: RetryOnStaleProvider,
@@ -20,4 +21,5 @@ export const services = {
   testSubjects: TestSubjects,
   browser: BrowserProvider,
   toasts: ToastsService,
+  security: SecurityServiceProvider,
 };

packages/kbn-ftr-common-functional-ui-services/services/ftr_provider_context.ts

@@ -7,12 +7,18 @@
  */
 
 import { GenericFtrProviderContext, GenericFtrService } from '@kbn/test';
-import { RetryService } from '@kbn/ftr-common-functional-services';
+import {
+  RetryService,
+  EsProvider,
+  KibanaServerProvider,
+} from '@kbn/ftr-common-functional-services';
 import { services as commonFunctionalUiServices } from './all';
 
 const services = {
   ...commonFunctionalUiServices,
   retry: RetryService,
+  es: EsProvider,
+  kibanaServer: KibanaServerProvider,
 };
 
 export type FtrProviderContext = GenericFtrProviderContext<typeof services, {}>;

test/common/services/security/index.ts → packages/kbn-ftr-common-functional-ui-services/services/security/index.ts

@@ -6,4 +6,4 @@
  * Side Public License, v 1.
  */
 
-export { SecurityServiceProvider } from './security';
+export { SecurityService, SecurityServiceProvider } from './security';

test/common/services/security/security.ts → packages/kbn-ftr-common-functional-ui-services/services/security/security.ts

@@ -9,7 +9,7 @@
 import { Role } from './role';
 import { User } from './user';
 import { RoleMappings } from './role_mappings';
-import { FtrProviderContext } from '../../ftr_provider_context';
+import { FtrProviderContext } from '../ftr_provider_context';
 import { createTestUserService, TestUserSupertestProvider, TestUser } from './test_user';
 import { createSystemIndicesUser } from './system_indices_user';
 

test/common/services/security/system_indices_user.ts → packages/kbn-ftr-common-functional-ui-services/services/security/system_indices_user.ts

@@ -13,7 +13,7 @@ import {
   createEsClientForFtrConfig,
   createRemoteEsClientForFtrConfig,
 } from '@kbn/test';
-import { FtrProviderContext } from '../../ftr_provider_context';
+import { FtrProviderContext } from '../ftr_provider_context';
 
 const SYSTEM_INDICES_SUPERUSER_ROLE = 'system_indices_superuser';
 

test/common/services/security/test_user.ts → packages/kbn-ftr-common-functional-ui-services/services/security/test_user.ts

@@ -9,10 +9,11 @@
 import { format as formatUrl } from 'url';
 import supertest from 'supertest';
 
-import { type Browser, TestSubjects } from '@kbn/ftr-common-functional-ui-services';
+import type { Browser } from '../browser';
+import type { TestSubjects } from '../test_subjects';
 import { Role } from './role';
 import { User } from './user';
-import { FtrService, FtrProviderContext } from '../../ftr_provider_context';
+import { FtrService, FtrProviderContext } from '../ftr_provider_context';
 
 const TEST_USER_NAME = 'test_user';
 const TEST_USER_PASSWORD = 'changeme';

scripts/saved_objs_info.js

@@ -7,4 +7,4 @@
  */
 
 require('../src/setup_node_env');
-require('@kbn/test-suites-src/common/services/saved_object_info').runSavedObjInfoSvc();
+require('@kbn/ftr-common-functional-services').runSavedObjInfoSvc();

test/analytics/services/index.ts

@@ -7,14 +7,17 @@
  */
 
 import { GenericFtrProviderContext } from '@kbn/test';
-import { services as commonServices } from '../../common/services';
+import { commonFunctionalServices } from '@kbn/ftr-common-functional-services';
+import { commonFunctionalUIServices } from '@kbn/ftr-common-functional-ui-services';
+
 import { services as functionalServices } from '../../functional/services';
 import { pageObjects } from '../../functional/page_objects';
 
 import { KibanaEBTServerProvider, KibanaEBTUIProvider } from './kibana_ebt';
 
 export const services = {
-  ...commonServices,
+  ...commonFunctionalServices,
+  ...commonFunctionalUIServices,
   ...functionalServices,
   kibana_ebt_server: KibanaEBTServerProvider,
   kibana_ebt_ui: KibanaEBTUIProvider,

test/api_integration/apis/console/autocomplete_entities.ts

@@ -8,25 +8,11 @@
 
 import expect from '@kbn/expect';
 import type { FtrProviderContext } from '../../ftr_provider_context';
-import { helpers } from './helpers';
 
 export default ({ getService }: FtrProviderContext) => {
-  const {
-    createIndex,
-    createAlias,
-    createLegacyTemplate,
-    createIndexTemplate,
-    createComponentTemplate,
-    createDataStream,
-    deleteIndex,
-    deleteAlias,
-    deleteLegacyTemplate,
-    deleteIndexTemplate,
-    deleteComponentTemplate,
-    deleteDataStream,
-  } = helpers(getService);
-
+  const console = getService('console');
   const supertest = getService('supertest');
+
   const sendRequest = (query: object) =>
     supertest.get('/api/console/autocomplete_entities').query(query);
 
@@ -40,22 +26,26 @@ export default ({ getService }: FtrProviderContext) => {
 
     before(async () => {
       // Setup indices, aliases, templates, and data streams
-      await createIndex(indexName);
-      await createAlias(indexName, aliasName);
-      await createComponentTemplate(componentTemplateName);
-      await createIndexTemplate(indexTemplateName, [dataStreamName], [componentTemplateName]);
-      await createDataStream(dataStreamName);
-      await createLegacyTemplate(legacyTemplateName);
+      await console.createIndex(indexName);
+      await console.createAlias(indexName, aliasName);
+      await console.createComponentTemplate(componentTemplateName);
+      await console.createIndexTemplate(
+        indexTemplateName,
+        [dataStreamName],
+        [componentTemplateName]
+      );
+      await console.createDataStream(dataStreamName);
+      await console.createLegacyTemplate(legacyTemplateName);
     });
 
     after(async () => {
       // Cleanup indices, aliases, templates, and data streams
-      await deleteAlias(indexName, aliasName);
-      await deleteIndex(indexName);
-      await deleteDataStream(dataStreamName);
-      await deleteIndexTemplate(indexTemplateName);
-      await deleteComponentTemplate(componentTemplateName);
-      await deleteLegacyTemplate(legacyTemplateName);
+      await console.deleteAlias(indexName, aliasName);
+      await console.deleteIndex(indexName);
+      await console.deleteDataStream(dataStreamName);
+      await console.deleteIndexTemplate(indexTemplateName);
+      await console.deleteComponentTemplate(componentTemplateName);
+      await console.deleteLegacyTemplate(legacyTemplateName);
     });
 
     it('should not succeed if no settings are provided in query params', async () => {

test/api_integration/services/index.ts

@@ -6,12 +6,13 @@
  * Side Public License, v 1.
  */
 
-import { services as commonServices } from '../../common/services';
-
+import { commonFunctionalServices } from '@kbn/ftr-common-functional-services';
+import { commonFunctionalUIServices } from '@kbn/ftr-common-functional-ui-services';
 import { KibanaSupertestProvider, ElasticsearchSupertestProvider } from './supertest';
 
 export const services = {
-  ...commonServices,
+  ...commonFunctionalServices,
+  ...commonFunctionalUIServices,
   supertest: KibanaSupertestProvider,
   esSupertest: ElasticsearchSupertestProvider,
 };

test/common/config.js

@@ -9,7 +9,6 @@
 import path from 'path';
 import { format as formatUrl } from 'url';
 import { esTestConfig, kbnTestConfig, kibanaServerTestUser } from '@kbn/test';
-import { services } from './services';
 
 export default function () {
   const servers = {
@@ -85,6 +84,5 @@ export default function () {
         })}`,
       ],
     },
-    services,
   };
 }