FTR: enable ESLint mocha rules for api integration tests (elastic#191267

) ## Summary Follow-up to elastic#190690 Most of API integration tests does not match the path pattern set in the original PR (thanks @pheyos for catching it) and where not updated. This PR updates `.eslintrc.js` with explicit patterns to lint api_integration tests. Hopefully it is final change, but I rely on code owners to double check it. Most of the changes are trivial adjustments: - duplicated before/after hooks `mocha/no-sibling-hooks` - duplicated test titles `mocha/no-identical-title` - async function in describe() `mocha/no-async-describe` --------- Co-authored-by: Ash <[email protected]>
tsullivan · Aug 30, 2024 · 8436f45 · 8436f45
1 parent 22d23ff
commit 8436f45
Show file tree

Hide file tree

Showing 164 changed files with 509 additions and 613 deletions.
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -1371,8 +1371,10 @@ module.exports = {
     },
     {
       files: [
-        'test/{accessibility,*functional*,*api_integration*}/apps/**/*.{js,ts}',
-        'x-pack/test/{accessibility,*functional*,*api_integration*}/apps/**/*.{js,ts}',
+        'test/{accessibility,*functional*}/apps/**/*.{js,ts}',
+        'test/*api_integration*/**/*.{js,ts}',
+        'x-pack/test/{accessibility,*functional*}/apps/**/*.{js,ts}',
+        'x-pack/test/*api_integration*/**/*.{js,ts}',
         'x-pack/test_serverless/{functional,api_integration}/test_suites/**/*.{js,ts}',
       ],
       extends: ['plugin:mocha/recommended'],

diff --git a/test/api_integration/apis/data_views/data_views_crud/create_data_view/main.ts b/test/api_integration/apis/data_views/data_views_crud/create_data_view/main.ts
@@ -224,7 +224,7 @@ export default function ({ getService }: FtrProviderContext) {
           expect(response.body[config.serviceKey].fieldFormats.foo.params).to.eql({});
         });
 
-        it('can specify optional fieldFormats attribute when creating an index pattern', async () => {
+        it('can specify optional fieldFormats attributes count and customLabel when creating an index pattern', async () => {
           const title = `foo-${Date.now()}-${Math.random()}*`;
           const response = await supertest.post(config.path).send({
             [config.serviceKey]: {

diff --git a/test/api_integration/apis/data_views/scripted_fields_crud/get_scripted_field/errors.ts b/test/api_integration/apis/data_views/scripted_fields_crud/get_scripted_field/errors.ts
@@ -68,13 +68,6 @@ export default function ({ getService }: FtrProviderContext) {
       );
     });
 
-    it('returns 404 error on non-existing scripted field', async () => {
-      const response1 = await supertest.get(
-        `/api/index_patterns/index_pattern/${indexPattern.id}/scripted_field/test`
-      );
-      expect(response1.status).to.be(404);
-    });
-
     it('returns error when attempting to fetch a field which is not a scripted field', async () => {
       const response2 = await supertest.get(
         `/api/index_patterns/index_pattern/${indexPattern.id}/scripted_field/foo`

diff --git a/x-pack/test/alerting_api_integration/common/retry.ts b/x-pack/test/alerting_api_integration/common/retry.ts
@@ -19,7 +19,7 @@ import type { ToolingLog } from '@kbn/tooling-log';
  * Example usage:
  * ```ts
   const fleetResponse = await retry<InstallPackageResponse>({
-    test: async () => {
+    testFn: async () => {
       const testResponse = await supertest
         .post(`/api/fleet/epm/packages/security_detection_engine`)
         .set('kbn-xsrf', 'xxxx')
@@ -45,15 +45,15 @@ import type { ToolingLog } from '@kbn/tooling-log';
  * @returns The response from the test
  */
 export const retry = async <T>({
-  test,
+  testFn,
   retryService,
   utilityName,
   retries = 3,
   timeout = 30000,
   retryDelay = 200,
   logger,
 }: {
-  test: () => Promise<T>;
+  testFn: () => Promise<T>;
   utilityName: string;
   retryService: RetryService;
   retries?: number;
@@ -77,7 +77,7 @@ export const retry = async <T>({
 
       retryAttempt = retryAttempt + 1;
 
-      return await test();
+      return await testFn();
     },
     undefined,
     retryDelay

diff --git a/x-pack/test/alerting_api_integration/observability/helpers/alerting_wait_for_helpers.ts b/x-pack/test/alerting_api_integration/observability/helpers/alerting_wait_for_helpers.ts
@@ -34,7 +34,7 @@ export async function waitForRuleStatus({
   logger: ToolingLog;
 }): Promise<Record<string, any>> {
   const ruleResponse = await retry<Record<string, any>>({
-    test: async () => {
+    testFn: async () => {
       const response = await supertest.get(`/api/alerting/rule/${id}`);
       const { execution_status: executionStatus } = response.body || {};
       const { status } = executionStatus || {};
@@ -74,7 +74,7 @@ export async function waitForDocumentInIndex<T>({
   retryDelay?: number;
 }): Promise<SearchResponse<T, Record<string, AggregationsAggregate>>> {
   return await retry<SearchResponse<T, Record<string, AggregationsAggregate>>>({
-    test: async () => {
+    testFn: async () => {
       const response = await esClient.search<T>({
         index: indexName,
         rest_total_hits_as_int: true,
@@ -112,7 +112,7 @@ export async function waitForAlertInIndex<T>({
   logger: ToolingLog;
 }): Promise<SearchResponse<T, Record<string, AggregationsAggregate>>> {
   return await retry<SearchResponse<T, Record<string, AggregationsAggregate>>>({
-    test: async () => {
+    testFn: async () => {
       const response = await esClient.search<T>({
         index: indexName,
         body: {

diff --git a/...erting_api_integration/security_and_spaces/group1/tests/alerting/bulk_untrack_by_query.ts b/...erting_api_integration/security_and_spaces/group1/tests/alerting/bulk_untrack_by_query.ts
@@ -36,7 +36,7 @@ export default function bulkUntrackByQueryTests({ getService }: FtrProviderConte
     });
 
     for (const scenario of UserAtSpaceScenarios) {
-      describe(scenario.id, async () => {
+      describe(scenario.id, () => {
         it('should bulk mark alerts as untracked by query', async () => {
           const { body: createdRule1 } = await supertest
             .post(`${getUrlPrefix(scenario.space.id)}/api/alerting/rule`)

diff --git a/x-pack/test/alerting_api_integration/security_and_spaces/group1/tests/index.ts b/x-pack/test/alerting_api_integration/security_and_spaces/group1/tests/index.ts
@@ -10,8 +10,6 @@ import { FtrProviderContext } from '../../../../common/ftr_provider_context';
 // eslint-disable-next-line import/no-default-export
 export default function alertingApiIntegrationTests({ loadTestFile }: FtrProviderContext) {
   describe('alerting api integration security and spaces enabled', function () {
-    describe('', function () {
-      loadTestFile(require.resolve('./alerting'));
-    });
+    loadTestFile(require.resolve('./alerting'));
   });
 }
diff --git a/...ting_api_integration/security_and_spaces/group2/tests/actions/connector_types/opsgenie.ts b/...ting_api_integration/security_and_spaces/group2/tests/actions/connector_types/opsgenie.ts
@@ -239,7 +239,7 @@ export default function opsgenieTest({ getService }: FtrProviderContext) {
           });
         });
 
-        describe('optional parameters', async () => {
+        describe('optional parameters', () => {
           describe('responders', () => {
             it('should fail to create an alert when the responders is an invalid type', async () => {
               const { body } = await supertest

diff --git a/x-pack/test/alerting_api_integration/security_and_spaces/group3/tests/alerting/clone.ts b/x-pack/test/alerting_api_integration/security_and_spaces/group3/tests/alerting/clone.ts
@@ -30,7 +30,7 @@ export default function createAlertTests({ getService }: FtrProviderContext) {
   const es = getService('es');
   const supertestWithoutAuth = getService('supertestWithoutAuth');
 
-  describe('clone', async () => {
+  describe('clone', () => {
     const objectRemover = new ObjectRemover(supertest);
     const space1 = Spaces[0].id;
     const space2 = Spaces[1].id;

diff --git a/...ck/test/alerting_api_integration/security_and_spaces/group3/tests/alerting/fields_rule.ts b/...ck/test/alerting_api_integration/security_and_spaces/group3/tests/alerting/fields_rule.ts
@@ -14,7 +14,7 @@ import { FtrProviderContext } from '../../../../common/ftr_provider_context';
 export default function getRuleFieldsTests({ getService }: FtrProviderContext) {
   const supertestWithoutAuth = getService('supertestWithoutAuth');
 
-  describe('fields rule', async () => {
+  describe('fields rule', () => {
     for (const scenario of UserAtSpaceScenarios) {
       const { user, space } = scenario;
       describe(scenario.id, () => {

diff --git a/...ting_api_integration/security_and_spaces/group3/tests/alerting/suggestions_value_alert.ts b/...ting_api_integration/security_and_spaces/group3/tests/alerting/suggestions_value_alert.ts
@@ -14,7 +14,7 @@ import { FtrProviderContext } from '../../../../common/ftr_provider_context';
 export default function createRuleSuggestionValuesTests({ getService }: FtrProviderContext) {
   const space1 = Spaces[0].id;
 
-  describe('alerts/suggestions/values', async () => {
+  describe('alerts/suggestions/values', () => {
     const esArchiver = getService('esArchiver');
     const supertest = getService('supertest');
 

diff --git a/...rting_api_integration/security_and_spaces/group3/tests/alerting/suggestions_value_rule.ts b/...rting_api_integration/security_and_spaces/group3/tests/alerting/suggestions_value_rule.ts
@@ -19,7 +19,7 @@ export default function createRuleSuggestionValuesTests({ getService }: FtrProvi
   const supertest = getService('supertest');
   const supertestWithoutAuth = getService('supertestWithoutAuth');
 
-  describe('rules/suggestions/values', async () => {
+  describe('rules/suggestions/values', () => {
     const objectRemover = new ObjectRemover(supertest);
     const space1 = Spaces[0].id;
     const space2 = Spaces[1].id;

diff --git a/...pi_integration/spaces_only/tests/alerting/group2/ml_rule_types/anomaly_detection/alert.ts b/...pi_integration/spaces_only/tests/alerting/group2/ml_rule_types/anomaly_detection/alert.ts
@@ -75,7 +75,7 @@ export default function alertTests({ getService }: FtrProviderContext) {
   const esTestIndexTool = new ESTestIndexTool(es, retry);
   const esTestIndexToolOutput = new ESTestIndexTool(es, retry, ES_TEST_OUTPUT_INDEX_NAME);
 
-  describe('alert', async () => {
+  describe('alert', () => {
     const objectRemover = new ObjectRemover(supertest);
     let actionId: string;
 

diff --git a/...tegration/spaces_only/tests/alerting/group2/transform_rule_types/transform_health/rule.ts b/...tegration/spaces_only/tests/alerting/group2/transform_rule_types/transform_health/rule.ts
@@ -78,7 +78,7 @@ export default function ruleTests({ getService }: FtrProviderContext) {
     `.internal.alerts-transform.health.alerts-default-000001`
   );
 
-  describe('rule', async () => {
+  describe('rule', () => {
     const objectRemover = new ObjectRemover(supertest);
     let connectorId: string;
     const transformId = 'test_transform_01';

diff --git a/...i_integration/spaces_only/tests/alerting/group3/builtin_alert_types/es_query/esql_only.ts b/...i_integration/spaces_only/tests/alerting/group3/builtin_alert_types/es_query/esql_only.ts
@@ -38,7 +38,7 @@ export default function ruleTests({ getService }: FtrProviderContext) {
     getAllAADDocs,
   } = getRuleServices(getService);
 
-  describe('rule', async () => {
+  describe('rule', () => {
     let endDate: string;
     let connectorId: string;
     const objectRemover = new ObjectRemover(supertest);

diff --git a/...egration/spaces_only/tests/alerting/group3/builtin_alert_types/es_query/query_dsl_only.ts b/...egration/spaces_only/tests/alerting/group3/builtin_alert_types/es_query/query_dsl_only.ts
@@ -33,7 +33,7 @@ export default function ruleTests({ getService }: FtrProviderContext) {
   const { es, esTestIndexTool, esTestIndexToolOutput, createEsDocumentsInGroups, waitForDocs } =
     getRuleServices(getService);
 
-  describe('rule', async () => {
+  describe('rule', () => {
     let endDate: string;
     let connectorId: string;
     const objectRemover = new ObjectRemover(supertest);

diff --git a/...ng_api_integration/spaces_only/tests/alerting/group3/builtin_alert_types/es_query/rule.ts b/...ng_api_integration/spaces_only/tests/alerting/group3/builtin_alert_types/es_query/rule.ts
@@ -50,7 +50,7 @@ export default function ruleTests({ getService }: FtrProviderContext) {
     { label: 'host.name', searchPath: 'host.name' },
   ];
 
-  describe('rule', async () => {
+  describe('rule', () => {
     let endDate: string;
     let connectorId: string;
     const objectRemover = new ObjectRemover(supertest);

diff --git a/...ntegration/spaces_only/tests/alerting/group3/builtin_alert_types/index_threshold/alert.ts b/...ntegration/spaces_only/tests/alerting/group3/builtin_alert_types/index_threshold/alert.ts
@@ -41,7 +41,7 @@ export default function ruleTests({ getService }: FtrProviderContext) {
     `.internal.alerts-${STACK_AAD_INDEX_NAME}.alerts-default-000001`
   );
 
-  describe('rule', async () => {
+  describe('rule', () => {
     let endDate: string;
     let connectorId: string;
     const objectRemover = new ObjectRemover(supertest);

diff --git a/...pi_integration/spaces_only/tests/alerting/group4/builtin_alert_types/long_running/rule.ts b/...pi_integration/spaces_only/tests/alerting/group4/builtin_alert_types/long_running/rule.ts
@@ -18,7 +18,7 @@ export default function ruleTests({ getService }: FtrProviderContext) {
   const supertest = getService('supertest');
   const retry = getService('retry');
 
-  describe('long running rule', async () => {
+  describe('long running rule', () => {
     const objectRemover = new ObjectRemover(supertest);
 
     afterEach(async () => {

diff --git a/x-pack/test/alerting_api_integration/spaces_only/tests/alerting/group4/migrations/8_2_0.ts b/x-pack/test/alerting_api_integration/spaces_only/tests/alerting/group4/migrations/8_2_0.ts
@@ -29,7 +29,7 @@ export default function createGetTests({ getService }: FtrProviderContext) {
       await esArchiver.unload('x-pack/test/functional/es_archives/alerting/8_2_0');
     });
 
-    describe('rule with null snoozeEndTime value', async () => {
+    describe('rule with null snoozeEndTime value', () => {
       it('has snoozeEndTime removed', async () => {
         const response = await es.get<{ alert: RawRule & { snoozeEndTime?: string } }>(
           {
@@ -60,7 +60,7 @@ export default function createGetTests({ getService }: FtrProviderContext) {
       });
     });
 
-    describe('rules with snoozeEndTime value', async () => {
+    describe('rules with snoozeEndTime value', () => {
       it('has snoozeEndTime migrated to snoozeSchedule', async () => {
         const response = await es.get<{ alert: RawRule & { snoozeEndTime?: string } }>(
           {

diff --git a/x-pack/test/api_integration/apis/management/index_management/create_index.ts b/x-pack/test/api_integration/apis/management/index_management/create_index.ts
@@ -13,7 +13,7 @@ export default function ({ getService }: FtrProviderContext) {
   const es = getService('es');
   const esDeleteAllIndices = getService('esDeleteAllIndices');
 
-  describe('create index', async () => {
+  describe('create index', () => {
     const testIndices = ['my-test-index-001', 'my-test-index-002'];
     before(async () => {
       await esDeleteAllIndices(testIndices);

diff --git a/x-pack/test/api_integration/apis/management/index_management/data_enrichers/ilm.ts b/x-pack/test/api_integration/apis/management/index_management/data_enrichers/ilm.ts
@@ -54,7 +54,7 @@ export default function ({ getService }: FtrProviderContext) {
   const testIndex = '.test_index';
   const testAlias = 'test_alias';
   const testIlmPolicy = 'test_policy';
-  describe('GET indices with data enrichers', async () => {
+  describe('GET indices with data enrichers', () => {
     before(async () => {
       await createIndex(testIndex);
       await createIlmPolicy('test_policy');

diff --git a/.../test/api_integration/apis/management/index_management/disabled_data_enrichers/indices.ts b/.../test/api_integration/apis/management/index_management/disabled_data_enrichers/indices.ts
@@ -19,7 +19,7 @@ export default function ({ getService }: FtrProviderContext) {
   };
 
   const testIndex = 'test_index';
-  describe('GET indices without data enrichers', async () => {
+  describe('GET indices without data enrichers', () => {
     before(async () => {
       await createIndex(testIndex);
     });

diff --git a/x-pack/test/api_integration/apis/management/index_management/index_details.ts b/x-pack/test/api_integration/apis/management/index_management/index_details.ts
@@ -19,7 +19,7 @@ export default function ({ getService }: FtrProviderContext) {
   };
 
   const testIndex = 'test_index';
-  describe('index details', async () => {
+  describe('index details', () => {
     before(async () => {
       await createIndex(testIndex);
     });

diff --git a/x-pack/test/api_integration/apis/management/index_management/mapping.ts b/x-pack/test/api_integration/apis/management/index_management/mapping.ts
@@ -28,8 +28,6 @@ export default function ({ getService }: FtrProviderContext) {
       },
     };
 
-    after(async () => await deleteAllIndices());
-
     before(async () => {
       log.debug('Creating index');
       try {

diff --git a/x-pack/test/api_integration/apis/maps/index.js b/x-pack/test/api_integration/apis/maps/index.js
@@ -26,7 +26,7 @@ export default function ({ loadTestFile, getService }) {
       );
     });
 
-    describe('', () => {
+    describe('apis', () => {
       loadTestFile(require.resolve('./maps_telemetry'));
       loadTestFile(require.resolve('./get_indexes_matching_pattern'));
       loadTestFile(require.resolve('./create_doc_source'));

diff --git a/x-pack/test/api_integration/apis/metrics_ui/sources.ts b/x-pack/test/api_integration/apis/metrics_ui/sources.ts
@@ -22,10 +22,14 @@ export default function ({ getService }: FtrProviderContext) {
   const kibanaServer = getService('kibanaServer');
 
   describe('sources', () => {
-    before(() => esArchiver.load('x-pack/test/functional/es_archives/infra/metrics_and_logs'));
-    after(() => esArchiver.unload('x-pack/test/functional/es_archives/infra/metrics_and_logs'));
-    before(() => kibanaServer.savedObjects.cleanStandardList());
-    after(() => kibanaServer.savedObjects.cleanStandardList());
+    before(async () => {
+      await esArchiver.load('x-pack/test/functional/es_archives/infra/metrics_and_logs');
+      await kibanaServer.savedObjects.cleanStandardList();
+    });
+    after(async () => {
+      await esArchiver.unload('x-pack/test/functional/es_archives/infra/metrics_and_logs');
+      await kibanaServer.savedObjects.cleanStandardList();
+    });
 
     const patchRequest = async (
       body: PartialMetricsSourceConfigurationProperties

diff --git a/x-pack/test/api_integration/apis/ml/data_frame_analytics/evaluate.ts b/x-pack/test/api_integration/apis/ml/data_frame_analytics/evaluate.ts
@@ -129,7 +129,7 @@ export default ({ getService }: FtrProviderContext) => {
     });
 
     testJobConfigs.forEach((testConfig) => {
-      describe(`EvaluateDataFrameAnalytics ${testConfig.jobType}`, async () => {
+      describe(`EvaluateDataFrameAnalytics ${testConfig.jobType}`, () => {
         it(`should evaluate ${testConfig.jobType} analytics job`, async () => {
           const { body, status } = await supertest
             .post(`/internal/ml/data_frame/_evaluate`)

diff --git a/x-pack/test/api_integration/apis/ml/data_frame_analytics/explain.ts b/x-pack/test/api_integration/apis/ml/data_frame_analytics/explain.ts
@@ -88,7 +88,7 @@ export default ({ getService }: FtrProviderContext) => {
     });
 
     testJobConfigs.forEach((testConfig) => {
-      describe(`ExplainDataFrameAnalytics ${testConfig.jobType}`, async () => {
+      describe(`ExplainDataFrameAnalytics ${testConfig.jobType}`, () => {
         it(`should explain ${testConfig.jobType} analytics job`, async () => {
           const { body, status } = await supertest
             .post(`/internal/ml/data_frame/analytics/_explain`)

diff --git a/x-pack/test/api_integration/apis/ml/jobs/jobs_exist_spaces.ts b/x-pack/test/api_integration/apis/ml/jobs/jobs_exist_spaces.ts
@@ -62,7 +62,7 @@ export default ({ getService }: FtrProviderContext) => {
       expect(body).to.eql({ [jobIdSpace1]: { exists: true, isGroup: false } });
     });
 
-    it('should find single job from same space', async () => {
+    it('should find single group from same space', async () => {
       const body = await runRequest(idSpace1, 200, [groupSpace1]);
       expect(body).to.eql({ [groupSpace1]: { exists: true, isGroup: true } });
     });

diff --git a/x-pack/test/api_integration/apis/osquery/packs.ts b/x-pack/test/api_integration/apis/osquery/packs.ts
@@ -61,9 +61,6 @@ export default function ({ getService }: FtrProviderContext) {
       await getService('esArchiver').unload(
         'x-pack/test/functional/es_archives/fleet/empty_fleet_server'
       );
-    });
-
-    after(async function () {
       await supertest
         .post(`/api/fleet/agent_policies/delete`)
         .set('kbn-xsrf', 'xxxx')

diff --git a/x-pack/test/api_integration/apis/uptime/rest/certs.ts b/x-pack/test/api_integration/apis/uptime/rest/certs.ts
@@ -23,7 +23,7 @@ export default function ({ getService }: FtrProviderContext) {
   const esArchiver = getService('esArchiver');
 
   describe('certs api', () => {
-    describe('empty index', async () => {
+    describe('empty index', () => {
       it('returns empty array for no data', async () => {
         const apiResponse = await supertest
           .post(`/internal/search/ese`)
@@ -41,7 +41,7 @@ export default function ({ getService }: FtrProviderContext) {
       });
     });
 
-    describe('when data is present', async () => {
+    describe('when data is present', () => {
       const now = moment();
       const cnva = now.add(6, 'months').toISOString();
       const cnvb = now.subtract(23, 'weeks').toISOString();