Create the ftrSoApis FTR plugin (elastic#149188)

## Summary Fix elastic#148412 More and more SO types will not be accessible from the HTTP APIs (either `hidden:true` or `hiddenFromHTTPApis: true`). However, the FTR SO client (`KbnClientSavedObjects`) still needs to be able to access and manipulate all SO types. This PR introduces a `ftrSoApis` plugin that is loaded for all FTR suites. This plugin exposes SO APIs that are used by the FTR client instead of the public SO HTTP APIs. These APIs are configured to know about all types, even hidden ones. Co-authored-by: kibanamachine <[email protected]>
kqualters-elastic · Feb 6, 2023 · fe2bf9a · fe2bf9a
1 parent d9644fc
commit fe2bf9a
Show file tree

Hide file tree

Showing 36 changed files with 1,657 additions and 12 deletions.
diff --git a/.buildkite/ftr_configs.yml b/.buildkite/ftr_configs.yml
@@ -159,6 +159,7 @@ enabled:
   - x-pack/test/examples/config.ts
   - x-pack/test/fleet_api_integration/config.ts
   - x-pack/test/fleet_functional/config.ts
+  - x-pack/test/ftr_apis/security_and_spaces/config.ts
   - x-pack/test/functional_basic/config.ts
   - x-pack/test/functional_cors/config.ts
   - x-pack/test/functional_embedded/config.ts

diff --git a/docs/developer/plugin-list.asciidoc b/docs/developer/plugin-list.asciidoc
@@ -184,6 +184,10 @@ for use in their own application.
 |Minimal interface for admins to manage files in Kibana.
 
 
+|{kib-repo}blob/{branch}/src/plugins/ftr_apis/README.md[ftrApis]
+|This plugin exposes a set of APIs used internally during functional tests by the FTR.
+
+
 |{kib-repo}blob/{branch}/src/plugins/guided_onboarding/README.md[guidedOnboarding]
 |This plugin contains the code for the Guided Onboarding project. Guided onboarding consists of guides for Solutions (Enterprise Search, Observability, Security) that can be completed as a checklist of steps. The guides help users to ingest their data and to navigate to the correct Solutions pages.
 

diff --git a/packages/kbn-test/src/kbn_client/kbn_client_saved_objects.ts b/packages/kbn-test/src/kbn_client/kbn_client_saved_objects.ts
@@ -7,7 +7,6 @@
  */
 
 import { inspect } from 'util';
-
 import * as Rx from 'rxjs';
 import { mergeMap } from 'rxjs/operators';
 import { isAxiosResponseError } from '@kbn/dev-utils';
@@ -90,6 +89,11 @@ async function concurrently<T>(maxConcurrency: number, arr: T[], fn: (item: T) =
   }
 }
 
+/**
+ * SO client for FTR.
+ *
+ * @remarks: Leverage the `ftrApis` plugin under the hood.
+ */
 export class KbnClientSavedObjects {
   constructor(private readonly log: ToolingLog, private readonly requester: KbnClientRequester) {}
 
@@ -117,8 +121,8 @@ export class KbnClientSavedObjects {
     const { data } = await this.requester.request<SavedObjectResponse<Attributes>>({
       description: 'get saved object',
       path: options.space
-        ? uriencode`/s/${options.space}/api/saved_objects/${options.type}/${options.id}`
-        : uriencode`/api/saved_objects/${options.type}/${options.id}`,
+        ? uriencode`/s/${options.space}/internal/ftr/kbn_client_so/${options.type}/${options.id}`
+        : uriencode`/internal/ftr/kbn_client_so/${options.type}/${options.id}`,
       method: 'GET',
     });
     return data;
@@ -133,8 +137,8 @@ export class KbnClientSavedObjects {
     const { data } = await this.requester.request<SavedObjectResponse<Attributes>>({
       description: 'update saved object',
       path: options.id
-        ? uriencode`/api/saved_objects/${options.type}/${options.id}`
-        : uriencode`/api/saved_objects/${options.type}`,
+        ? uriencode`/internal/ftr/kbn_client_so/${options.type}/${options.id}`
+        : uriencode`/internal/ftr/kbn_client_so/${options.type}`,
       query: {
         overwrite: options.overwrite,
       },
@@ -156,7 +160,7 @@ export class KbnClientSavedObjects {
 
     const { data } = await this.requester.request<SavedObjectResponse<Attributes>>({
       description: 'update saved object',
-      path: uriencode`/api/saved_objects/${options.type}/${options.id}`,
+      path: uriencode`/internal/ftr/kbn_client_so/${options.type}/${options.id}`,
       query: {
         overwrite: options.overwrite,
       },
@@ -179,8 +183,8 @@ export class KbnClientSavedObjects {
     const { data } = await this.requester.request({
       description: 'delete saved object',
       path: options.space
-        ? uriencode`/s/${options.space}/api/saved_objects/${options.type}/${options.id}`
-        : uriencode`/api/saved_objects/${options.type}/${options.id}`,
+        ? uriencode`/s/${options.space}/internal/ftr/kbn_client_so/${options.type}/${options.id}`
+        : uriencode`/internal/ftr/kbn_client_so/${options.type}/${options.id}`,
       method: 'DELETE',
     });
 
@@ -196,8 +200,8 @@ export class KbnClientSavedObjects {
       const resp = await this.requester.request<FindApiResponse>({
         method: 'GET',
         path: options.space
-          ? uriencode`/s/${options.space}/api/saved_objects/_find`
-          : '/api/saved_objects/_find',
+          ? uriencode`/s/${options.space}/internal/ftr/kbn_client_so/_find`
+          : `/internal/ftr/kbn_client_so/_find`,
         query: {
           per_page: 1000,
           type: options.types,
@@ -270,8 +274,8 @@ export class KbnClientSavedObjects {
         await this.requester.request({
           method: 'DELETE',
           path: options.space
-            ? uriencode`/s/${options.space}/api/saved_objects/${obj.type}/${obj.id}?force=true`
-            : uriencode`/api/saved_objects/${obj.type}/${obj.id}?force=true`,
+            ? uriencode`/s/${options.space}/internal/ftr/kbn_client_so/${obj.type}/${obj.id}`
+            : uriencode`/internal/ftr/kbn_client_so/${obj.type}/${obj.id}`,
         });
         deleted++;
       } catch (error) {

diff --git a/src/plugins/ftr_apis/README.md b/src/plugins/ftr_apis/README.md
@@ -0,0 +1,8 @@
+# ftrApis plugin
+
+This plugin exposes a set of APIs used internally during functional tests by the FTR.
+
+The APIs currently exposed are:
+1. APIs used by the `KbnClientSavedObjects` (SO service of the FTR)
+
+**Remark: these APIs shouldn't be called directly for any reason**  
diff --git a/src/plugins/ftr_apis/jest.config.js b/src/plugins/ftr_apis/jest.config.js
@@ -0,0 +1,16 @@
+/*
+ * 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 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 or the Server
+ * Side Public License, v 1.
+ */
+
+module.exports = {
+  preset: '@kbn/test',
+  rootDir: '../../..',
+  roots: ['<rootDir>/src/plugins/ftr_apis'],
+  coverageDirectory: '<rootDir>/target/kibana-coverage/jest/src/plugins/ftr_apis',
+  coverageReporters: ['text', 'html'],
+  collectCoverageFrom: ['<rootDir>/src/plugins/ftr_apis/{common,public,server}/**/*.{js,ts,tsx}'],
+};
diff --git a/src/plugins/ftr_apis/kibana.json b/src/plugins/ftr_apis/kibana.json
@@ -0,0 +1,11 @@
+{
+  "id": "ftrApis",
+  "owner": {
+    "name": "Core",
+    "githubTeam": "kibana-core"
+  },
+  "version": "kibana",
+  "configPath": ["ftr_apis"],
+  "server": true,
+  "ui": false
+}
diff --git a/src/plugins/ftr_apis/server/config.ts b/src/plugins/ftr_apis/server/config.ts
@@ -0,0 +1,20 @@
+/*
+ * 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 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 or the Server
+ * Side Public License, v 1.
+ */
+
+import { schema, type TypeOf } from '@kbn/config-schema';
+import type { PluginConfigDescriptor } from '@kbn/core/server';
+
+const configSchema = schema.object({
+  disableApis: schema.boolean({ defaultValue: false }),
+});
+
+export type ConfigType = TypeOf<typeof configSchema>;
+
+export const config: PluginConfigDescriptor<ConfigType> = {
+  schema: configSchema,
+};
diff --git a/src/plugins/ftr_apis/server/index.ts b/src/plugins/ftr_apis/server/index.ts
@@ -0,0 +1,16 @@
+/*
+ * 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 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 or the Server
+ * Side Public License, v 1.
+ */
+
+import type { PluginInitializerContext } from '@kbn/core/server';
+import { FtrApisPlugin } from './plugin';
+
+export function plugin(initializerContext: PluginInitializerContext) {
+  return new FtrApisPlugin(initializerContext);
+}
+
+export { config } from './config';
diff --git a/src/plugins/ftr_apis/server/plugin.ts b/src/plugins/ftr_apis/server/plugin.ts
@@ -0,0 +1,28 @@
+/*
+ * 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 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 or the Server
+ * Side Public License, v 1.
+ */
+
+import type { CoreSetup, Plugin, PluginInitializerContext } from '@kbn/core/server';
+import { registerRoutes } from './routes';
+import type { ConfigType } from './config';
+
+export class FtrApisPlugin implements Plugin {
+  private readonly config: ConfigType;
+
+  constructor(initializerContext: PluginInitializerContext) {
+    this.config = initializerContext.config.get<ConfigType>();
+  }
+
+  public setup({ http, savedObjects }: CoreSetup) {
+    const router = http.createRouter();
+    if (!this.config.disableApis) {
+      registerRoutes(router);
+    }
+  }
+
+  public start() {}
+}
diff --git a/src/plugins/ftr_apis/server/routes/index.ts b/src/plugins/ftr_apis/server/routes/index.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 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 or the Server
+ * Side Public License, v 1.
+ */
+
+import type { IRouter } from '@kbn/core/server';
+import { registerKbnClientSoRoutes } from './kbn_client_so';
+
+export const registerRoutes = (router: IRouter) => {
+  registerKbnClientSoRoutes(router);
+};
diff --git a/src/plugins/ftr_apis/server/routes/kbn_client_so/bulk_delete.ts b/src/plugins/ftr_apis/server/routes/kbn_client_so/bulk_delete.ts
@@ -0,0 +1,38 @@
+/*
+ * 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 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 or the Server
+ * Side Public License, v 1.
+ */
+
+import type { IRouter } from '@kbn/core/server';
+import { schema } from '@kbn/config-schema';
+import { KBN_CLIENT_API_PREFIX, listHiddenTypes, catchAndReturnBoomErrors } from './utils';
+
+export const registerBulkDeleteRoute = (router: IRouter) => {
+  router.post(
+    {
+      path: `${KBN_CLIENT_API_PREFIX}/_bulk_delete`,
+      options: {
+        tags: ['access:ftrApis'],
+      },
+      validate: {
+        body: schema.arrayOf(
+          schema.object({
+            type: schema.string(),
+            id: schema.string(),
+          })
+        ),
+      },
+    },
+    catchAndReturnBoomErrors(async (ctx, req, res) => {
+      const { savedObjects } = await ctx.core;
+      const hiddenTypes = listHiddenTypes(savedObjects.typeRegistry);
+      const soClient = savedObjects.getClient({ includedHiddenTypes: hiddenTypes });
+
+      const statuses = await soClient.bulkDelete(req.body, { force: true });
+      return res.ok({ body: statuses });
+    })
+  );
+};
diff --git a/src/plugins/ftr_apis/server/routes/kbn_client_so/create.ts b/src/plugins/ftr_apis/server/routes/kbn_client_so/create.ts
@@ -0,0 +1,62 @@
+/*
+ * 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 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 or the Server
+ * Side Public License, v 1.
+ */
+
+import type { IRouter } from '@kbn/core/server';
+import { schema } from '@kbn/config-schema';
+import { KBN_CLIENT_API_PREFIX, listHiddenTypes, catchAndReturnBoomErrors } from './utils';
+
+export const registerCreateRoute = (router: IRouter) => {
+  router.post(
+    {
+      path: `${KBN_CLIENT_API_PREFIX}/{type}/{id?}`,
+      options: {
+        tags: ['access:ftrApis'],
+      },
+      validate: {
+        params: schema.object({
+          type: schema.string(),
+          id: schema.maybe(schema.string()),
+        }),
+        query: schema.object({
+          overwrite: schema.boolean({ defaultValue: false }),
+        }),
+        body: schema.object({
+          attributes: schema.recordOf(schema.string(), schema.any()),
+          migrationVersion: schema.maybe(schema.recordOf(schema.string(), schema.string())),
+          references: schema.maybe(
+            schema.arrayOf(
+              schema.object({
+                name: schema.string(),
+                type: schema.string(),
+                id: schema.string(),
+              })
+            )
+          ),
+        }),
+      },
+    },
+    catchAndReturnBoomErrors(async (ctx, req, res) => {
+      const { type, id } = req.params;
+      const { overwrite } = req.query;
+      const { attributes, migrationVersion, references } = req.body;
+      const { savedObjects } = await ctx.core;
+
+      const hiddenTypes = listHiddenTypes(savedObjects.typeRegistry);
+      const soClient = savedObjects.getClient({ includedHiddenTypes: hiddenTypes });
+
+      const options = {
+        id,
+        overwrite,
+        migrationVersion,
+        references,
+      };
+      const result = await soClient.create(type, attributes, options);
+      return res.ok({ body: result });
+    })
+  );
+};
diff --git a/src/plugins/ftr_apis/server/routes/kbn_client_so/delete.ts b/src/plugins/ftr_apis/server/routes/kbn_client_so/delete.ts
@@ -0,0 +1,38 @@
+/*
+ * 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 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 or the Server
+ * Side Public License, v 1.
+ */
+
+import type { IRouter } from '@kbn/core/server';
+import { schema } from '@kbn/config-schema';
+import { KBN_CLIENT_API_PREFIX, listHiddenTypes, catchAndReturnBoomErrors } from './utils';
+
+export const registerDeleteRoute = (router: IRouter) => {
+  router.delete(
+    {
+      path: `${KBN_CLIENT_API_PREFIX}/{type}/{id}`,
+      options: {
+        tags: ['access:ftrApis'],
+      },
+      validate: {
+        params: schema.object({
+          type: schema.string(),
+          id: schema.string(),
+        }),
+      },
+    },
+    catchAndReturnBoomErrors(async (ctx, req, res) => {
+      const { type, id } = req.params;
+      const { savedObjects } = await ctx.core;
+
+      const hiddenTypes = listHiddenTypes(savedObjects.typeRegistry);
+      const soClient = savedObjects.getClient({ includedHiddenTypes: hiddenTypes });
+
+      const result = await soClient.delete(type, id, { force: true });
+      return res.ok({ body: result });
+    })
+  );
+};