[8.6] [DOCS] Automate connector-listing.png (#143605) (#145659)

# Backport This will backport the following commits from `main` to `8.6`: - [[DOCS] Automate connector-listing.png (#143605)](#143605)  ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport)  Co-authored-by: Lisa Cawley <[email protected]>
elastic · Nov 18, 2022 · a8164ed · a8164ed
1 parent 38c967b
commit a8164ed
Show file tree

Hide file tree

Showing 19 changed files with 207 additions and 83 deletions.
diff --git a/docs/management/action-types.asciidoc b/docs/management/action-types.asciidoc
@@ -91,6 +91,7 @@ Rules use connectors to route actions to different destinations like log files,
 
 [role="screenshot"]
 image::images/connector-listing.png[Example connector listing in the {rules-ui} UI]
+// NOTE: This is an autogenerated screenshot. Do not edit it directly.
 
 [float]
 === Required permissions

diff --git a/docs/management/connectors/images/connector-listing.png b/docs/management/connectors/images/connector-listing.png
diff --git a/x-pack/test/functional/config.base.js b/x-pack/test/functional/config.base.js
@@ -169,6 +169,9 @@ export default async function ({ readConfigFile }) {
       observability: {
         pathname: '/app/observability',
       },
+      connectors: {
+        pathname: '/app/management/insightsAndAlerting/triggersActionsConnectors/',
+      },
     },
 
     // choose where screenshots should be saved

diff --git a/x-pack/test/functional/services/actions/api.ts b/x-pack/test/functional/services/actions/api.ts
@@ -0,0 +1,46 @@
+/*
+ * 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; you may not use this file except in compliance with the Elastic License
+ * 2.0.
+ */
+
+import { FtrProviderContext } from '../../ftr_provider_context';
+
+export function ActionsAPIServiceProvider({ getService }: FtrProviderContext) {
+  const kbnSupertest = getService('supertest');
+
+  return {
+    async createConnector({
+      name,
+      config,
+      secrets,
+      connectorTypeId,
+    }: {
+      name: string;
+      config: Record<string, unknown>;
+      secrets: Record<string, unknown>;
+      connectorTypeId: string;
+    }) {
+      const { body: createdAction } = await kbnSupertest
+        .post(`/api/actions/connector`)
+        .set('kbn-xsrf', 'foo')
+        .send({
+          name,
+          config,
+          secrets,
+          connector_type_id: connectorTypeId,
+        })
+        .expect(200);
+
+      return createdAction;
+    },
+
+    async deleteConnector(id: string) {
+      return kbnSupertest
+        .delete(`/api/actions/connector/${id}`)
+        .set('kbn-xsrf', 'foo')
+        .expect(204, '');
+    },
+  };
+}
diff --git a/x-pack/test/functional/services/actions/index.ts b/x-pack/test/functional/services/actions/index.ts
@@ -9,11 +9,13 @@ import { FtrProviderContext } from '../../ftr_provider_context';
 import { ActionsCommonServiceProvider } from './common';
 import { ActionsOpsgenieServiceProvider } from './opsgenie';
 import { ActionsTinesServiceProvider } from './tines';
+import { ActionsAPIServiceProvider } from './api';
 
 export function ActionsServiceProvider(context: FtrProviderContext) {
   const common = ActionsCommonServiceProvider(context);
 
   return {
+    api: ActionsAPIServiceProvider(context),
     common: ActionsCommonServiceProvider(context),
     opsgenie: ActionsOpsgenieServiceProvider(context, common),
     tines: ActionsTinesServiceProvider(context, common),

diff --git a/x-pack/test/functional/services/index.ts b/x-pack/test/functional/services/index.ts
@@ -73,6 +73,7 @@ import { CasesServiceProvider } from './cases';
 import { ActionsServiceProvider } from './actions';
 import { RulesServiceProvider } from './rules';
 import { AiopsProvider } from './aiops';
+import { SampleDataServiceProvider } from './sample_data';
 
 // define the name and providers for services that should be
 // available to your tests. If you don't specify anything here
@@ -136,4 +137,5 @@ export const services = {
   rules: RulesServiceProvider,
   cases: CasesServiceProvider,
   aiops: AiopsProvider,
+  sampleData: SampleDataServiceProvider,
 };
diff --git a/x-pack/test/functional/services/ml/test_resources.ts b/x-pack/test/functional/services/ml/test_resources.ts
@@ -630,39 +630,5 @@ export function MachineLearningTestResourcesProvider(
     async clearAdvancedSettingProperty(propertyName: string) {
       await kibanaServer.uiSettings.unset(propertyName);
     },
-
-    async installKibanaSampleData(sampleDataId: 'ecommerce' | 'flights' | 'logs') {
-      log.debug(`Installing Kibana sample data '${sampleDataId}'`);
-
-      const { body, status } = await supertest
-        .post(`/api/sample_data/${sampleDataId}`)
-        .set(COMMON_REQUEST_HEADERS);
-      mlApi.assertResponseStatusCode(200, status, body);
-
-      log.debug(` > Installed`);
-    },
-
-    async removeKibanaSampleData(sampleDataId: 'ecommerce' | 'flights' | 'logs') {
-      log.debug(`Removing Kibana sample data '${sampleDataId}'`);
-
-      const { body, status } = await supertest
-        .delete(`/api/sample_data/${sampleDataId}`)
-        .set(COMMON_REQUEST_HEADERS);
-      mlApi.assertResponseStatusCode(204, status, body);
-
-      log.debug(` > Removed`);
-    },
-
-    async installAllKibanaSampleData() {
-      await this.installKibanaSampleData('ecommerce');
-      await this.installKibanaSampleData('flights');
-      await this.installKibanaSampleData('logs');
-    },
-
-    async removeAllKibanaSampleData() {
-      await this.removeKibanaSampleData('ecommerce');
-      await this.removeKibanaSampleData('flights');
-      await this.removeKibanaSampleData('logs');
-    },
   };
 }
diff --git a/x-pack/test/functional/services/sample_data/index.ts b/x-pack/test/functional/services/sample_data/index.ts
@@ -0,0 +1,15 @@
+/*
+ * 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; you may not use this file except in compliance with the Elastic License
+ * 2.0.
+ */
+
+import { FtrProviderContext } from '../../ftr_provider_context';
+import { SampleDataTestResourcesServiceProvider } from './test_resources';
+
+export function SampleDataServiceProvider(context: FtrProviderContext) {
+  return {
+    testResources: SampleDataTestResourcesServiceProvider(context),
+  };
+}
diff --git a/x-pack/test/functional/services/sample_data/test_resources.ts b/x-pack/test/functional/services/sample_data/test_resources.ts
@@ -0,0 +1,37 @@
+/*
+ * 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; you may not use this file except in compliance with the Elastic License
+ * 2.0.
+ */
+
+import { FtrProviderContext } from '../../ftr_provider_context';
+
+export function SampleDataTestResourcesServiceProvider({ getService }: FtrProviderContext) {
+  const supertest = getService('supertest');
+
+  return {
+    async installKibanaSampleData(sampleDataId: 'ecommerce' | 'flights' | 'logs') {
+      await supertest.post(`/api/sample_data/${sampleDataId}`).set('kbn-xsrf', 'true').expect(200);
+    },
+
+    async removeKibanaSampleData(sampleDataId: 'ecommerce' | 'flights' | 'logs') {
+      await supertest
+        .delete(`/api/sample_data/${sampleDataId}`)
+        .set('kbn-xsrf', 'true')
+        .expect(204);
+    },
+
+    async installAllKibanaSampleData() {
+      await this.installKibanaSampleData('ecommerce');
+      await this.installKibanaSampleData('flights');
+      await this.installKibanaSampleData('logs');
+    },
+
+    async removeAllKibanaSampleData() {
+      await this.removeKibanaSampleData('ecommerce');
+      await this.removeKibanaSampleData('flights');
+      await this.removeKibanaSampleData('logs');
+    },
+  };
+}
diff --git a/x-pack/test/functional_with_es_ssl/apps/triggers_actions_ui/connectors/general.ts b/x-pack/test/functional_with_es_ssl/apps/triggers_actions_ui/connectors/general.ts
@@ -77,7 +77,7 @@ export default ({ getPageObjects, getPageObject, getService }: FtrProviderContex
       const updatedConnectorName = `${connectorName}updated`;
       const createdAction = await createSlackConnector({
         name: connectorName,
-        supertest,
+        getService,
       });
       objectRemover.add(createdAction.id, 'action', 'actions');
       await browser.refresh();
@@ -176,7 +176,7 @@ export default ({ getPageObjects, getPageObject, getService }: FtrProviderContex
       const connectorName = generateUniqueKey();
       const createdAction = await createSlackConnector({
         name: connectorName,
-        supertest,
+        getService,
       });
       objectRemover.add(createdAction.id, 'action', 'actions');
       await browser.refresh();
@@ -205,10 +205,10 @@ export default ({ getPageObjects, getPageObject, getService }: FtrProviderContex
 
     it('should delete a connector', async () => {
       const connectorName = generateUniqueKey();
-      await createSlackConnector({ name: connectorName, supertest });
+      await createSlackConnector({ name: connectorName, getService });
       const createdAction = await createSlackConnector({
         name: generateUniqueKey(),
-        supertest,
+        getService,
       });
       objectRemover.add(createdAction.id, 'action', 'actions');
       await browser.refresh();
@@ -234,10 +234,10 @@ export default ({ getPageObjects, getPageObject, getService }: FtrProviderContex
 
     it('should bulk delete connectors', async () => {
       const connectorName = generateUniqueKey();
-      await createSlackConnector({ name: connectorName, supertest });
+      await createSlackConnector({ name: connectorName, getService });
       const createdAction = await createSlackConnector({
         name: generateUniqueKey(),
-        supertest,
+        getService,
       });
       objectRemover.add(createdAction.id, 'action', 'actions');
       await browser.refresh();

diff --git a/x-pack/test/functional_with_es_ssl/apps/triggers_actions_ui/connectors/opsgenie.ts b/x-pack/test/functional_with_es_ssl/apps/triggers_actions_ui/connectors/opsgenie.ts
@@ -9,7 +9,7 @@ import expect from '@kbn/expect';
 import { FtrProviderContext } from '../../../ftr_provider_context';
 import { ObjectRemover } from '../../../lib/object_remover';
 import { generateUniqueKey } from '../../../lib/get_test_data';
-import { createConnector, createSlackConnectorAndObjectRemover, getConnectorByName } from './utils';
+import { createSlackConnectorAndObjectRemover, getConnectorByName } from './utils';
 
 export default ({ getPageObjects, getService }: FtrProviderContext) => {
   const testSubjects = getService('testSubjects');
@@ -366,12 +366,11 @@ export default ({ getPageObjects, getService }: FtrProviderContext) => {
     };
 
     const createOpsgenieConnector = async (name: string) => {
-      return createConnector({
+      return actions.api.createConnector({
         name,
         config: { apiUrl: 'https//test.com' },
         secrets: { apiKey: '1234' },
         connectorTypeId: '.opsgenie',
-        supertest,
       });
     };
   });

diff --git a/x-pack/test/functional_with_es_ssl/apps/triggers_actions_ui/connectors/tines.ts b/x-pack/test/functional_with_es_ssl/apps/triggers_actions_ui/connectors/tines.ts
@@ -9,7 +9,7 @@ import expect from '@kbn/expect';
 import { FtrProviderContext } from '../../../ftr_provider_context';
 import { ObjectRemover } from '../../../lib/object_remover';
 import { generateUniqueKey } from '../../../lib/get_test_data';
-import { createConnector, getConnectorByName } from './utils';
+import { getConnectorByName } from './utils';
 import {
   tinesAgentWebhook,
   tinesStory1,
@@ -267,12 +267,11 @@ export default ({ getPageObjects, getService }: FtrProviderContext) => {
     });
 
     const createTinesConnector = async (name: string) => {
-      return createConnector({
+      return actions.api.createConnector({
         name,
         config: { url: simulatorUrl },
         secrets: { email: '[email protected]', token: 'apiToken' },
         connectorTypeId: '.tines',
-        supertest,
       });
     };
   });

diff --git a/x-pack/test/functional_with_es_ssl/apps/triggers_actions_ui/connectors/utils.ts b/x-pack/test/functional_with_es_ssl/apps/triggers_actions_ui/connectors/utils.ts
@@ -23,7 +23,7 @@ export const createSlackConnectorAndObjectRemover = async ({
   const testData = getTestActionData();
   const createdAction = await createSlackConnector({
     name: testData.name,
-    supertest,
+    getService,
   });
   objectRemover.add(createdAction.id, 'action', 'actions');
 
@@ -32,17 +32,17 @@ export const createSlackConnectorAndObjectRemover = async ({
 
 export const createSlackConnector = async ({
   name,
-  supertest,
+  getService,
 }: {
   name: string;
-  supertest: SuperTest.SuperTest<SuperTest.Test>;
+  getService: FtrProviderContext['getService'];
 }) => {
-  const connector = await createConnector({
+  const actions = getService('actions');
+  const connector = await actions.api.createConnector({
     name,
     config: {},
     secrets: { webhookUrl: 'https://test.com' },
     connectorTypeId: '.slack',
-    supertest,
   });
 
   return connector;
@@ -59,30 +59,3 @@ export const getConnectorByName = async (
   const i = findIndex(body, (c: any) => c.name === name);
   return body[i];
 };
-
-export const createConnector = async ({
-  name,
-  config,
-  secrets,
-  connectorTypeId,
-  supertest,
-}: {
-  name: string;
-  config: Record<string, unknown>;
-  secrets: Record<string, unknown>;
-  connectorTypeId: string;
-  supertest: SuperTest.SuperTest<SuperTest.Test>;
-}) => {
-  const { body: createdAction } = await supertest
-    .post(`/api/actions/connector`)
-    .set('kbn-xsrf', 'foo')
-    .send({
-      name,
-      config,
-      secrets,
-      connector_type_id: connectorTypeId,
-    })
-    .expect(200);
-
-  return createdAction;
-};
diff --git a/x-pack/test/screenshot_creation/apps/ml_docs/index.ts b/x-pack/test/screenshot_creation/apps/ml_docs/index.ts
@@ -14,21 +14,22 @@ export const LOGS_INDEX_PATTERN = 'kibana_sample_data_logs';
 export default function ({ getPageObject, getService, loadTestFile }: FtrProviderContext) {
   const browser = getService('browser');
   const ml = getService('ml');
+  const sampleData = getService('sampleData');
   const securityPage = getPageObject('security');
 
   describe('machine learning docs', function () {
     this.tags(['ml']);
 
     before(async () => {
-      await ml.testResources.installAllKibanaSampleData();
+      await sampleData.testResources.installAllKibanaSampleData();
       await ml.testResources.setKibanaTimeZoneToUTC();
       await ml.testResources.disableKibanaAnnouncements();
       await browser.setWindowSize(1920, 1080);
     });
 
     after(async () => {
       await securityPage.forceLogout();
-      await ml.testResources.removeAllKibanaSampleData();
+      await sampleData.testResources.removeAllKibanaSampleData();
       await ml.testResources.resetKibanaTimeZone();
       await ml.testResources.resetKibanaAnnouncements();
     });

diff --git a/x-pack/test/screenshot_creation/apps/response_ops_docs/index.ts b/x-pack/test/screenshot_creation/apps/response_ops_docs/index.ts
@@ -15,13 +15,14 @@ export const LOGS_INDEX_PATTERN = 'kibana_sample_data_logs';
 export default function ({ getPageObject, getService, loadTestFile }: FtrProviderContext) {
   const browser = getService('browser');
   const ml = getService('ml');
+  const sampleData = getService('sampleData');
   const securityPage = getPageObject('security');
 
   describe('response ops docs', function () {
     this.tags(['responseOps']);
 
     before(async () => {
-      await ml.testResources.installAllKibanaSampleData();
+      await sampleData.testResources.installAllKibanaSampleData();
       await ml.testResources.setKibanaTimeZoneToUTC();
       await ml.testResources.disableKibanaAnnouncements();
       await browser.setWindowSize(1920, 1080);
@@ -33,11 +34,12 @@ export default function ({ getPageObject, getService, loadTestFile }: FtrProvide
 
     after(async () => {
       await securityPage.forceLogout();
-      await ml.testResources.removeAllKibanaSampleData();
+      await sampleData.testResources.removeAllKibanaSampleData();
       await ml.testResources.resetKibanaTimeZone();
       await ml.testResources.resetKibanaAnnouncements();
     });
 
+    loadTestFile(require.resolve('./stack_alerting'));
     loadTestFile(require.resolve('./stack_cases'));
     loadTestFile(require.resolve('./observability_cases'));
   });