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

dmlemeshko · 2024-08-26T11:01:32Z

Summary

Follow-up to #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

…ests

dmlemeshko · 2024-08-26T11:03:05Z

test/api_integration/apis/data_views/scripted_fields_crud/get_scripted_field/errors.ts

-    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);
-    });
-


Complete duplicate of

kibana/test/api_integration/apis/data_views/scripted_fields_crud/get_scripted_field/errors.ts

Lines 51 to 57 in 2bed553

it('returns 404 error on non-existing scripted field', async () => {

const response1 = await supertest.get(

`/api/index_patterns/index_pattern/${indexPattern.id}/scripted_field/sf`

);

expect(response1.status).to.be(404);

});

in the same file

dmlemeshko · 2024-08-26T11:08:22Z

x-pack/test/alerting_api_integration/common/retry.ts

@@ -45,15 +45,15 @@ import type { ToolingLog } from '@kbn/tooling-log';
 * @returns The response from the test
 */
 export const retry = async <T>({
-  test,
+  testFn,


test is reserved by Mocha, renaming for convenience.

dmlemeshko · 2024-08-26T11:09:28Z

x-pack/test/api_integration/apis/management/index_management/mapping.ts

@@ -28,8 +28,6 @@ export default function ({ getService }: FtrProviderContext) {
      },
    };

-    after(async () => await deleteAllIndices());


duplicate hook:

kibana/x-pack/test/api_integration/apis/management/index_management/mapping.ts

Lines 41 to 48 in 3b98c57

after(async () => {

try {

await deleteAllIndices();

} catch (err) {

log.debug('[Cleanup error] Error deleting index');

throw err;

}

});

dmlemeshko · 2024-08-26T11:12:41Z

x-pack/test/api_integration/apis/metrics_ui/sources.ts

+    after(async () => {
+      await esArchiver.unload('x-pack/test/functional/es_archives/infra/metrics_and_logs');
+      await kibanaServer.savedObjects.cleanStandardList();
+    });


error Unexpected use of duplicate Mocha before hook mocha/no-sibling-hooks

Duplicating hooks is not recommended because it can lead to confusion about the order of execution and potential issues in test maintenance.

dmlemeshko · 2024-08-26T11:13:49Z

x-pack/test/fleet_api_integration/apis/download_sources/crud.ts

@@ -133,7 +130,7 @@ export default function (providerContext: FtrProviderContext) {
        expect(downloadSource.host).to.eql('https://test.co:403');
      });

-      it('should allow to update an existing download source', async function () {
+      it('should allow to update is_default for existing download source', async function () {


error Test title is used multiple times in the same test suite mocha/no-identical-title

dmlemeshko · 2024-08-26T11:14:57Z

/ci

dmlemeshko · 2024-08-26T11:17:30Z

x-pack/test/fleet_api_integration/apis/outputs/crud.ts

-      it('should discard the shipper values when shipper is disabled', async function () {
-        await supertest
-          .post(`/api/fleet/outputs`)
-          .set('kbn-xsrf', 'xxxx')
-          .send({
-            name: 'default monitoring output 1',
-            type: 'elasticsearch',
-            hosts: ['https://test.fr'],
-            is_default_monitoring: true,
-            shipper: {
-              disk_queue_enabled: true,
-              disk_queue_path: 'path/to/disk/queue',
-              disk_queue_encryption_enabled: true,
-            },
-          })
-          .expect(200);
-        const {
-          body: { items: outputs },
-        } = await supertest.get(`/api/fleet/outputs`).expect(200);
-        const defaultOutputs = outputs.filter((o: any) => o.is_default_monitoring);
-        expect(defaultOutputs[0].shipper).to.equal(null);
-      });
-


Duplicate of

kibana/x-pack/test/fleet_api_integration/apis/outputs/crud.ts

Lines 1290 to 1311 in ffe6cf4

it('should discard the shipper values when shipper is disabled', async function () {

await supertest

.post(`/api/fleet/outputs`)

.set('kbn-xsrf', 'xxxx')

.send({

name: 'default monitoring output 1',

type: 'elasticsearch',

hosts: ['https://test.fr'],

is_default_monitoring: true,

shipper: {

disk_queue_enabled: true,

disk_queue_path: 'path/to/disk/queue',

disk_queue_encryption_enabled: true,

},

})

.expect(200);

const {

body: { items: outputs },

} = await supertest.get(`/api/fleet/outputs`).expect(200);

const defaultOutputs = outputs.filter((o: any) => o.is_default_monitoring);

expect(defaultOutputs[0].shipper).to.equal(null);

});

in the same file

dmlemeshko · 2024-08-26T11:21:09Z

x-pack/test/fleet_api_integration/apis/uninstall_token/get.ts

-        it('should return nothing if searched for managed policy name', async () => {
-          const response = await supertest
-            .get(uninstallTokensRouteService.getListPath())
-            .query({
-              search: generatedManagedPolicyArray[0].name,
-            })
-            .expect(200);
-
-          const body: GetUninstallTokensMetadataResponse = response.body;
-          expect(body.total).to.equal(0);
-          expect(body.page).to.equal(1);
-          expect(body.perPage).to.equal(20);
-          expect(body.items).to.eql([]);
-        });
-


Duplicate of

kibana/x-pack/test/fleet_api_integration/apis/uninstall_token/get.ts

Lines 476 to 489 in ffe6cf4

it('should return nothing if searched for managed policy name', async () => {

const response = await supertest

.get(uninstallTokensRouteService.getListPath())

.query({

search: generatedManagedPolicyArray[0].name,

})

.expect(200);

const body: GetUninstallTokensMetadataResponse = response.body;

expect(body.total).to.equal(0);

expect(body.page).to.equal(1);

expect(body.perPage).to.equal(20);

expect(body.items).to.eql([]);

});

in the same file

…crud.ts

dmlemeshko · 2024-08-26T14:23:40Z

/ci

dmlemeshko · 2024-08-26T16:10:39Z

/ci

dmlemeshko · 2024-08-26T18:27:51Z

/ci

## Summary This PR refactors the `setupFleetAndAgents` helper function into a `FleetAndAgents` FTR service, which is now initialized during the config file loading. Reason: The previous implementation of `setupFleetAndAgents` wrapped a Mocha `before` hook, which is considered an anti-pattern according to the Mocha ESLint rules that the Operations and QA teams have agreed to enable in the Kibana repo. It's best practice to avoid duplicating hooks, as this can lead to inconsistent test results and make debugging difficult. Ensuring a single before and after hook sequence guarantees that the associated logic runs in a predictable and sequential manner. This change also unblocks #191267, where we plan to enforce the same recommended Mocha ESLint rules that were previously enabled for UI tests in #190690. --------- Co-authored-by: kibanamachine <[email protected]>

…ests

dmlemeshko · 2024-08-28T08:36:53Z

/ci

…a into ftr/eslint-in-api-tests

elasticmachine · 2024-08-28T17:39:59Z

Pinging @elastic/obs-ux-infra_services-team (Team:obs-ux-infra_services)

elasticmachine · 2024-08-28T17:39:59Z

Pinging @elastic/fleet (Team:Fleet)

nreese

kibana-presentation changes LGTM
code review only

peteharverson

ML code changes LGTM

ashokaditya

Thanks for the changes. security_solution_api_integration/edr_workflows changes LGTM.

...ion_api_integration/test_suites/edr_workflows/artifacts/trial_license_complete_tier/index.ts

sabarasaba

kibana management changes lgtm

…workflows/artifacts/trial_license_complete_tier/index.ts Co-authored-by: Ash <[email protected]>

kpollich

Fleet changes

…ests

pheyos

LGTM

…ests

kibana-ci · 2024-08-30T16:07:31Z

💛 Build succeeded, but was flaky

Buildkite Build
Commit: 3faef29
Kibana Serverless Image: docker.elastic.co/kibana-ci/kibana-serverless:pr-191267-3faef29f35e1

Failed CI Steps

FTR Configs #56

Metrics [docs]

Unknown metric groups

ESLint disabled line counts

id	before	after	diff
`@kbn/test-suites-xpack`	709	719	+10

Total ESLint disabled count

id	before	after	diff
`@kbn/test-suites-xpack`	733	743	+10

History

💛 Build #231121 was flaky 835d737
💔 Build #231085 failed 40d8908
💔 Build #231067 failed c7889ab
💛 Build #230737 was flaky 4a06190
💔 Build #230694 failed 696e9e6

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

delanni · 2024-08-30T16:50:31Z

Admin-merging forgoing the missing few approvals

dmlemeshko added 3 commits August 26, 2024 11:48

add more test paths and fix errors in test/

6ee0020

fix errors in x-pack/test/

b806b14

Merge remote-tracking branch 'upstream/main' into ftr/eslint-in-api-t…

2bed553

…ests

dmlemeshko changed the title ~~Ftr/eslint in api tests~~ FTR: enable ESLint mocha rules for api integration tests Aug 26, 2024

dmlemeshko commented Aug 26, 2024

View reviewed changes

rename arg in retry service to testFn

3b98c57

dmlemeshko commented Aug 26, 2024

View reviewed changes

Merge branch 'main' into ftr/eslint-in-api-tests

ffe6cf4

dmlemeshko commented Aug 26, 2024

View reviewed changes

dmlemeshko added 2 commits August 26, 2024 16:17

git revert changes in x-pack/test/fleet_api_integration/apis/outputs/…

32066d3

…crud.ts

fix errors in x-pack/test/apm_api_integration

6e23c4c

fix errors

cfb1f0b

dmlemeshko mentioned this pull request Aug 27, 2024

[ftr] add fleetAndAgents service #191448

Merged

Merge remote-tracking branch 'upstream/main' into ftr/eslint-in-api-t…

3705654

…ests

dmlemeshko force-pushed the ftr/eslint-in-api-tests branch from 1946622 to 3705654 Compare August 28, 2024 08:32

Merge branch 'main' into ftr/eslint-in-api-tests

5096866

dmlemeshko added 3 commits August 28, 2024 18:36

add missing await

3ba8d41

Merge branch 'ftr/eslint-in-api-tests' of github.com:dmlemeshko/kiban…

01e0a6c

…a into ftr/eslint-in-api-tests

Merge branch 'main' into ftr/eslint-in-api-tests

4f802ed

dmlemeshko added the release_note:skip Skip the PR/issue when compiling release notes label Aug 28, 2024

botelastic bot added the Team:obs-ux-infra_services Observability Infrastructure & Services User Experience Team label Aug 28, 2024

pzl requested review from ashokaditya and removed request for pzl August 28, 2024 17:43

nreese approved these changes Aug 28, 2024

View reviewed changes

ymao1 approved these changes Aug 28, 2024

View reviewed changes

lukasolson approved these changes Aug 28, 2024

View reviewed changes

smith added the apm:review label Aug 28, 2024

SiddharthMantri approved these changes Aug 29, 2024

View reviewed changes

peteharverson approved these changes Aug 29, 2024

View reviewed changes

ashokaditya approved these changes Aug 29, 2024

View reviewed changes

...ion_api_integration/test_suites/edr_workflows/artifacts/trial_license_complete_tier/index.ts Outdated Show resolved Hide resolved

sabarasaba approved these changes Aug 29, 2024

View reviewed changes

dmlemeshko and others added 2 commits August 29, 2024 10:38

Update x-pack/test/security_solution_api_integration/test_suites/edr_…

3533eb2

…workflows/artifacts/trial_license_complete_tier/index.ts Co-authored-by: Ash <[email protected]>

Merge branch 'main' into ftr/eslint-in-api-tests

696e9e6

angorayc approved these changes Aug 29, 2024

View reviewed changes

dmlemeshko requested a review from pheyos August 29, 2024 09:03

nkhristinin approved these changes Aug 29, 2024

View reviewed changes

Merge branch 'main' into ftr/eslint-in-api-tests

4a06190

neptunian approved these changes Aug 29, 2024

View reviewed changes

kpollich approved these changes Aug 29, 2024

View reviewed changes

dmlemeshko added 4 commits August 30, 2024 11:49

Merge remote-tracking branch 'upstream/main' into ftr/eslint-in-api-t…

c7889ab

…ests

fix spaces FTR service

40d8908

call service in before hook

19510e2

Merge remote-tracking branch 'upstream/main' into ftr/eslint-in-api-t…

835d737

…ests

pheyos approved these changes Aug 30, 2024

View reviewed changes

Merge remote-tracking branch 'upstream/main' into ftr/eslint-in-api-t…

3faef29

…ests

delanni merged commit 8436f45 into elastic:main Aug 30, 2024
23 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

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

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

dmlemeshko commented Aug 26, 2024 •

edited

Loading

dmlemeshko Aug 26, 2024 •

edited

Loading

dmlemeshko Aug 26, 2024

dmlemeshko Aug 26, 2024

dmlemeshko Aug 26, 2024

dmlemeshko Aug 26, 2024

dmlemeshko commented Aug 26, 2024

dmlemeshko Aug 26, 2024

dmlemeshko Aug 26, 2024

dmlemeshko commented Aug 26, 2024

dmlemeshko commented Aug 26, 2024

dmlemeshko commented Aug 26, 2024

dmlemeshko commented Aug 28, 2024

elasticmachine commented Aug 28, 2024

elasticmachine commented Aug 28, 2024

nreese left a comment

peteharverson left a comment

ashokaditya left a comment

sabarasaba left a comment

kpollich left a comment

pheyos left a comment

kibana-ci commented Aug 30, 2024 •

edited

Loading

ESLint disabled line counts

Total ESLint disabled count

delanni commented Aug 30, 2024

	it('returns 404 error on non-existing scripted field', async () => {
	const response1 = await supertest.get(
	`/api/index_patterns/index_pattern/${indexPattern.id}/scripted_field/sf`
	);

	expect(response1.status).to.be(404);
	});

	after(async () => {
	try {
	await deleteAllIndices();
	} catch (err) {
	log.debug('[Cleanup error] Error deleting index');
	throw err;
	}
	});

	it('should discard the shipper values when shipper is disabled', async function () {
	await supertest
	.post(`/api/fleet/outputs`)
	.set('kbn-xsrf', 'xxxx')
	.send({
	name: 'default monitoring output 1',
	type: 'elasticsearch',
	hosts: ['https://test.fr'],
	is_default_monitoring: true,
	shipper: {
	disk_queue_enabled: true,
	disk_queue_path: 'path/to/disk/queue',
	disk_queue_encryption_enabled: true,
	},
	})
	.expect(200);
	const {
	body: { items: outputs },
	} = await supertest.get(`/api/fleet/outputs`).expect(200);
	const defaultOutputs = outputs.filter((o: any) => o.is_default_monitoring);
	expect(defaultOutputs[0].shipper).to.equal(null);
	});

	it('should return nothing if searched for managed policy name', async () => {
	const response = await supertest
	.get(uninstallTokensRouteService.getListPath())
	.query({
	search: generatedManagedPolicyArray[0].name,
	})
	.expect(200);

	const body: GetUninstallTokensMetadataResponse = response.body;
	expect(body.total).to.equal(0);
	expect(body.page).to.equal(1);
	expect(body.perPage).to.equal(20);
	expect(body.items).to.eql([]);
	});

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

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

Conversation

dmlemeshko commented Aug 26, 2024 • edited Loading

Summary

dmlemeshko Aug 26, 2024 • edited Loading

Choose a reason for hiding this comment

dmlemeshko Aug 26, 2024

Choose a reason for hiding this comment

dmlemeshko Aug 26, 2024

Choose a reason for hiding this comment

dmlemeshko Aug 26, 2024

Choose a reason for hiding this comment

dmlemeshko Aug 26, 2024

Choose a reason for hiding this comment

dmlemeshko commented Aug 26, 2024

dmlemeshko Aug 26, 2024

Choose a reason for hiding this comment

dmlemeshko Aug 26, 2024

Choose a reason for hiding this comment

dmlemeshko commented Aug 26, 2024

dmlemeshko commented Aug 26, 2024

dmlemeshko commented Aug 26, 2024

dmlemeshko commented Aug 28, 2024

elasticmachine commented Aug 28, 2024

elasticmachine commented Aug 28, 2024

nreese left a comment

Choose a reason for hiding this comment

peteharverson left a comment

Choose a reason for hiding this comment

ashokaditya left a comment

Choose a reason for hiding this comment

sabarasaba left a comment

Choose a reason for hiding this comment

kpollich left a comment

Choose a reason for hiding this comment

pheyos left a comment

Choose a reason for hiding this comment

kibana-ci commented Aug 30, 2024 • edited Loading

💛 Build succeeded, but was flaky

Failed CI Steps

Metrics [docs]

ESLint disabled line counts

Total ESLint disabled count

History

delanni commented Aug 30, 2024

dmlemeshko commented Aug 26, 2024 •

edited

Loading

dmlemeshko Aug 26, 2024 •

edited

Loading

kibana-ci commented Aug 30, 2024 •

edited

Loading