[8.19] [Scout] Migrate Data Views API tests from FTR - Part4 (#257709)

src/platform/plugins/shared/data_views/test/scout/api/tests/data_views/runtime_fields_create_errors.spec.ts

@@ -0,0 +1,56 @@
+/*
+ * 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 { apiTest, tags, type RoleApiCredentials } from '@kbn/scout';
+import { expect } from '@kbn/scout/api';
+import { COMMON_HEADERS, DATA_VIEW_PATH } from '../../fixtures/constants';
+
+apiTest.describe(
+  'POST api/data_views/data_view/{id}/runtime_field - create errors (data view api)',
+  { tag: tags.deploymentAgnostic },
+  () => {
+    let adminApiCredentials: RoleApiCredentials;
+    let createdIds: string[] = [];
+
+    apiTest.beforeAll(async ({ requestAuth }) => {
+      adminApiCredentials = await requestAuth.getApiKey('admin');
+    });
+
+    apiTest.afterEach(async ({ apiServices }) => {
+      for (const id of createdIds) {
+        await apiServices.dataViews.delete(id);
+      }
+      createdIds = [];
+    });
+
+    apiTest(
+      'returns an error when runtime field object is not provided',
+      async ({ apiClient, apiServices }) => {
+        const title = `foo-${Date.now()}-${Math.random()}*`;
+        const { data: dataView } = await apiServices.dataViews.create({ title });
+        createdIds.push(dataView.id);
+
+        const response = await apiClient.post(`${DATA_VIEW_PATH}/${dataView.id}/runtime_field`, {
+          headers: {
+            ...COMMON_HEADERS,
+            ...adminApiCredentials.apiKeyHeader,
+          },
+          responseType: 'json',
+          body: {},
+        });
+
+        expect(response).toHaveStatusCode(400);
+        expect(response.body.statusCode).toBe(400);
+        expect(response.body.message).toBe(
+          '[request body.name]: expected value of type [string] but got [undefined]'
+        );
+      }
+    );
+  }
+);

src/platform/plugins/shared/data_views/test/scout/api/tests/data_views/runtime_fields_create_main.spec.ts

@@ -0,0 +1,234 @@
+/*
+ * 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 { apiTest, tags, type RoleApiCredentials } from '@kbn/scout';
+import { expect } from '@kbn/scout/api';
+import { COMMON_HEADERS, ES_ARCHIVE_BASIC_INDEX, DATA_VIEW_PATH } from '../../fixtures/constants';
+
+apiTest.describe(
+  'POST api/data_views/data_view/{id}/runtime_field - create main (data view api)',
+  { tag: tags.deploymentAgnostic },
+  () => {
+    let adminApiCredentials: RoleApiCredentials;
+    let createdIds: string[] = [];
+
+    apiTest.beforeAll(async ({ esArchiver, requestAuth }) => {
+      adminApiCredentials = await requestAuth.getApiKey('admin');
+      await esArchiver.loadIfNeeded(ES_ARCHIVE_BASIC_INDEX);
+    });
+
+    apiTest.afterEach(async ({ apiServices }) => {
+      for (const id of createdIds) {
+        await apiServices.dataViews.delete(id);
+      }
+      createdIds = [];
+    });
+
+    apiTest('can create a new runtime field', async ({ apiClient, apiServices }) => {
+      const title = `basic_index-${Date.now()}-${Math.random()}*`;
+      const { data: dataView } = await apiServices.dataViews.create({
+        title,
+        override: true,
+      });
+      createdIds.push(dataView.id);
+
+      const response = await apiClient.post(`${DATA_VIEW_PATH}/${dataView.id}/runtime_field`, {
+        headers: {
+          ...COMMON_HEADERS,
+          ...adminApiCredentials.apiKeyHeader,
+        },
+        responseType: 'json',
+        body: {
+          name: 'runtimeBar',
+          runtimeField: {
+            type: 'long',
+            script: {
+              source: "emit(doc['field_name'].value)",
+            },
+          },
+        },
+      });
+
+      expect(response).toHaveStatusCode(200);
+      expect(response.body.data_view).toBeDefined();
+      expect(response.body.fields).toBeDefined();
+      expect(response.body.fields.length).toBeGreaterThan(0);
+
+      const field = response.body.fields[0];
+      expect(field.name).toBe('runtimeBar');
+      expect(field.runtimeField.type).toBe('long');
+      expect(field.runtimeField.script.source).toBe("emit(doc['field_name'].value)");
+      expect(field.scripted).toBe(false);
+    });
+
+    apiTest(
+      'newly created runtime field is available in the data view object',
+      async ({ apiClient, apiServices }) => {
+        const title = `basic_index-${Date.now()}-${Math.random()}`;
+        const { data: dataView } = await apiServices.dataViews.create({
+          title,
+          override: true,
+        });
+        createdIds.push(dataView.id);
+
+        const rtResponse = await apiClient.post(`${DATA_VIEW_PATH}/${dataView.id}/runtime_field`, {
+          headers: {
+            ...COMMON_HEADERS,
+            ...adminApiCredentials.apiKeyHeader,
+          },
+          responseType: 'json',
+          body: {
+            name: 'runtimeBar',
+            runtimeField: {
+              type: 'long',
+              script: {
+                source: "emit(doc['field_name'].value)",
+              },
+            },
+          },
+        });
+
+        expect(rtResponse).toHaveStatusCode(200);
+
+        const { data: retrievedDataView } = await apiServices.dataViews.get(dataView.id);
+        expect(retrievedDataView).toBeDefined();
+
+        const fields = retrievedDataView.fields;
+        expect(fields).toBeDefined();
+
+        const field = fields!.runtimeBar;
+        expect(field.name).toBe('runtimeBar');
+        expect(field.runtimeField.type).toBe('long');
+        expect(field.runtimeField.script.source).toBe("emit(doc['field_name'].value)");
+        expect(field.scripted).toBe(false);
+
+        const duplicateResponse = await apiClient.post(
+          `${DATA_VIEW_PATH}/${dataView.id}/runtime_field`,
+          {
+            headers: {
+              ...COMMON_HEADERS,
+              ...adminApiCredentials.apiKeyHeader,
+            },
+            responseType: 'json',
+            body: {
+              name: 'runtimeBar',
+              runtimeField: {
+                type: 'long',
+                script: {
+                  source: "emit(doc['field_name'].value)",
+                },
+              },
+            },
+          }
+        );
+
+        expect(duplicateResponse).toHaveStatusCode(400);
+      }
+    );
+
+    apiTest('prevents field name collisions', async ({ apiClient, apiServices }) => {
+      const title = `basic-${Date.now()}-${Math.random()}*`;
+      const { data: dataView } = await apiServices.dataViews.create({
+        title,
+        override: true,
+      });
+      createdIds.push(dataView.id);
+
+      const response1 = await apiClient.post(`${DATA_VIEW_PATH}/${dataView.id}/runtime_field`, {
+        headers: {
+          ...COMMON_HEADERS,
+          ...adminApiCredentials.apiKeyHeader,
+        },
+        responseType: 'json',
+        body: {
+          name: 'runtimeBar',
+          runtimeField: {
+            type: 'long',
+            script: {
+              source: "emit(doc['field_name'].value)",
+            },
+          },
+        },
+      });
+
+      expect(response1).toHaveStatusCode(200);
+
+      const response2 = await apiClient.post(`${DATA_VIEW_PATH}/${dataView.id}/runtime_field`, {
+        headers: {
+          ...COMMON_HEADERS,
+          ...adminApiCredentials.apiKeyHeader,
+        },
+        responseType: 'json',
+        body: {
+          name: 'runtimeBar',
+          runtimeField: {
+            type: 'long',
+            script: {
+              source: "emit(doc['field_name'].value)",
+            },
+          },
+        },
+      });
+
+      expect(response2).toHaveStatusCode(400);
+
+      const compositeResponse1 = await apiClient.post(
+        `${DATA_VIEW_PATH}/${dataView.id}/runtime_field`,
+        {
+          headers: {
+            ...COMMON_HEADERS,
+            ...adminApiCredentials.apiKeyHeader,
+          },
+          responseType: 'json',
+          body: {
+            name: 'runtimeComposite',
+            runtimeField: {
+              type: 'composite',
+              script: {
+                source: 'emit("a","a"); emit("b","b")',
+              },
+              fields: {
+                a: { type: 'keyword' },
+                b: { type: 'keyword' },
+              },
+            },
+          },
+        }
+      );
+
+      expect(compositeResponse1).toHaveStatusCode(200);
+
+      const compositeResponse2 = await apiClient.post(
+        `${DATA_VIEW_PATH}/${dataView.id}/runtime_field`,
+        {
+          headers: {
+            ...COMMON_HEADERS,
+            ...adminApiCredentials.apiKeyHeader,
+          },
+          responseType: 'json',
+          body: {
+            name: 'runtimeComposite',
+            runtimeField: {
+              type: 'composite',
+              script: {
+                source: 'emit("a","a"); emit("b","b")',
+              },
+              fields: {
+                a: { type: 'keyword' },
+                b: { type: 'keyword' },
+              },
+            },
+          },
+        }
+      );
+
+      expect(compositeResponse2).toHaveStatusCode(400);
+    });
+  }
+);

src/platform/plugins/shared/data_views/test/scout/api/tests/data_views/runtime_fields_get_errors.spec.ts

@@ -0,0 +1,85 @@
+/*
+ * 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 { apiTest, tags, type RoleApiCredentials } from '@kbn/scout';
+import { expect } from '@kbn/scout/api';
+import {
+  COMMON_HEADERS,
+  ES_ARCHIVE_BASIC_INDEX,
+  DATA_VIEW_PATH,
+  ID_OVER_MAX_LENGTH,
+} from '../../fixtures/constants';
+
+apiTest.describe(
+  'GET api/data_views/data_view/{id}/runtime_field/{name} - get errors (data view api)',
+  { tag: tags.deploymentAgnostic },
+  () => {
+    let viewerApiCredentials: RoleApiCredentials;
+    let dataViewId: string;
+
+    apiTest.beforeAll(async ({ esArchiver, requestAuth, apiServices }) => {
+      viewerApiCredentials = await requestAuth.getApiKeyForViewer();
+      await esArchiver.loadIfNeeded(ES_ARCHIVE_BASIC_INDEX);
+
+      const { data: dataView } = await apiServices.dataViews.create({
+        title: '*asic_index',
+      });
+      dataViewId = dataView.id;
+    });
+
+    apiTest.afterAll(async ({ apiServices }) => {
+      if (dataViewId) {
+        await apiServices.dataViews.delete(dataViewId);
+      }
+    });
+
+    apiTest('returns 404 error on non-existing data view', async ({ apiClient }) => {
+      const id = `xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx-${Date.now()}`;
+      const response = await apiClient.get(`${DATA_VIEW_PATH}/${id}/runtime_field/foo`, {
+        headers: {
+          ...COMMON_HEADERS,
+          ...viewerApiCredentials.apiKeyHeader,
+        },
+        responseType: 'json',
+      });
+
+      expect(response).toHaveStatusCode(404);
+    });
+
+    apiTest('returns 404 error on non-existing runtime field', async ({ apiClient }) => {
+      const response = await apiClient.get(`${DATA_VIEW_PATH}/${dataViewId}/runtime_field/sf`, {
+        headers: {
+          ...COMMON_HEADERS,
+          ...viewerApiCredentials.apiKeyHeader,
+        },
+        responseType: 'json',
+      });
+
+      expect(response).toHaveStatusCode(404);
+    });
+
+    apiTest('returns error when ID is too long', async ({ apiClient }) => {
+      const response = await apiClient.get(
+        `${DATA_VIEW_PATH}/${ID_OVER_MAX_LENGTH}/runtime_field/foo`,
+        {
+          headers: {
+            ...COMMON_HEADERS,
+            ...viewerApiCredentials.apiKeyHeader,
+          },
+          responseType: 'json',
+        }
+      );
+
+      expect(response).toHaveStatusCode(400);
+      expect(response.body.message).toBe(
+        '[request params.id]: value has length [1759] but it must have a maximum length of [1000].'
+      );
+    });
+  }
+);