Skip to content

Commit

Permalink
Migrate service api tests
Browse files Browse the repository at this point in the history
  • Loading branch information
crespocarlos committed Nov 12, 2024
1 parent c4e97c6 commit d527ffe
Show file tree
Hide file tree
Showing 33 changed files with 1,635 additions and 1,634 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ import { apm, timerange } from '@kbn/apm-synthtrace-client';
import expect from '@kbn/expect';
import { omit } from 'lodash';
import { ApmSynthtraceEsClient } from '@kbn/apm-synthtrace';
import type { RoleCredentials, SupertestWithRoleScopeType } from '../../../../services';
import type { RoleCredentials } from '../../../../services';
import type { DeploymentAgnosticFtrProviderContext } from '../../../../ftr_provider_context';
import {
fetchServiceInventoryAlertCounts,
Expand All @@ -23,15 +23,13 @@ import {
} from './helpers/alerting_helper';

export default function ApiTest({ getService }: DeploymentAgnosticFtrProviderContext) {
const roleScopedSupertest = getService('roleScopedSupertest');
const apmApiClient = getService('apmApi');
const synthtrace = getService('synthtrace');
const alertingApi = getService('alertingApi');
const samlAuth = getService('samlAuth');

describe('error count threshold alert', () => {
let apmSynthtraceEsClient: ApmSynthtraceEsClient;
let supertestViewerWithCookieCredentials: SupertestWithRoleScopeType;
let roleAuthc: RoleCredentials;

const javaErrorMessage = 'a java error';
Expand All @@ -52,14 +50,6 @@ export default function ApiTest({ getService }: DeploymentAgnosticFtrProviderCon
};

before(async () => {
supertestViewerWithCookieCredentials = await roleScopedSupertest.getSupertestWithRoleScope(
'viewer',
{
withInternalHeaders: true,
useCookieHeader: true,
}
);

roleAuthc = await samlAuth.createM2mApiKeyWithRoleScope('admin');

const opbeansJava = apm
Expand Down Expand Up @@ -116,7 +106,6 @@ export default function ApiTest({ getService }: DeploymentAgnosticFtrProviderCon

after(async () => {
await apmSynthtraceEsClient.clean();
await supertestViewerWithCookieCredentials.destroy();
await samlAuth.invalidateM2mApiKeyWithRoleScope(roleAuthc);
});

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ import { apm, timerange } from '@kbn/apm-synthtrace-client';
import expect from '@kbn/expect';
import { omit } from 'lodash';
import type { ApmSynthtraceEsClient } from '@kbn/apm-synthtrace';
import type { RoleCredentials, SupertestWithRoleScopeType } from '../../../../services';
import type { RoleCredentials } from '../../../../services';
import type { DeploymentAgnosticFtrProviderContext } from '../../../../ftr_provider_context';
import {
fetchServiceInventoryAlertCounts,
Expand All @@ -24,7 +24,6 @@ import {
} from './helpers/alerting_helper';

export default function ApiTest({ getService }: DeploymentAgnosticFtrProviderContext) {
const roleScopedSupertest = getService('roleScopedSupertest');
const apmApiClient = getService('apmApi');
const synthtrace = getService('synthtrace');
const alertingApi = getService('alertingApi');
Expand All @@ -43,18 +42,9 @@ export default function ApiTest({ getService }: DeploymentAgnosticFtrProviderCon

describe('transaction duration alert', () => {
let apmSynthtraceEsClient: ApmSynthtraceEsClient;
let supertestViewerWithCookieCredentials: SupertestWithRoleScopeType;
let roleAuthc: RoleCredentials;

before(async () => {
supertestViewerWithCookieCredentials = await roleScopedSupertest.getSupertestWithRoleScope(
'viewer',
{
withInternalHeaders: true,
useCookieHeader: true,
}
);

roleAuthc = await samlAuth.createM2mApiKeyWithRoleScope('admin');

const opbeansJava = apm
Expand Down Expand Up @@ -86,7 +76,6 @@ export default function ApiTest({ getService }: DeploymentAgnosticFtrProviderCon

after(async () => {
await apmSynthtraceEsClient.clean();
await supertestViewerWithCookieCredentials.destroy();
await samlAuth.invalidateM2mApiKeyWithRoleScope(roleAuthc);
});

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ import { apm, timerange } from '@kbn/apm-synthtrace-client';
import expect from '@kbn/expect';
import { omit } from 'lodash';
import type { ApmSynthtraceEsClient } from '@kbn/apm-synthtrace';
import type { RoleCredentials, SupertestWithRoleScopeType } from '../../../../services';
import type { RoleCredentials } from '../../../../services';
import type { DeploymentAgnosticFtrProviderContext } from '../../../../ftr_provider_context';
import {
fetchServiceInventoryAlertCounts,
Expand All @@ -23,26 +23,16 @@ import {
} from './helpers/alerting_helper';

export default function ApiTest({ getService }: DeploymentAgnosticFtrProviderContext) {
const roleScopedSupertest = getService('roleScopedSupertest');
const apmApiClient = getService('apmApi');
const synthtrace = getService('synthtrace');
const alertingApi = getService('alertingApi');
const samlAuth = getService('samlAuth');

describe('transaction error rate alert', () => {
let apmSynthtraceEsClient: ApmSynthtraceEsClient;
let supertestViewerWithCookieCredentials: SupertestWithRoleScopeType;
let roleAuthc: RoleCredentials;

before(async () => {
supertestViewerWithCookieCredentials = await roleScopedSupertest.getSupertestWithRoleScope(
'viewer',
{
withInternalHeaders: true,
useCookieHeader: true,
}
);

roleAuthc = await samlAuth.createM2mApiKeyWithRoleScope('admin');

const opbeansJava = apm
Expand Down Expand Up @@ -84,7 +74,6 @@ export default function ApiTest({ getService }: DeploymentAgnosticFtrProviderCon

after(async () => {
await apmSynthtraceEsClient.clean();
await supertestViewerWithCookieCredentials.destroy();
await samlAuth.invalidateM2mApiKeyWithRoleScope(roleAuthc);
});

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,24 +7,20 @@

type ArchiveName =
| '8.0.0'
| 'apm_8.0.0'
| 'apm_mappings_only_8.0.0'
| 'infra_metrics_and_apm'
| 'metrics_8.0.0'
| 'ml_8.0.0'
| 'observability_overview'
| 'rum_8.0.0'
| 'rum_test_data';

export const ARCHIVER_ROUTES: { [key in ArchiveName]: string } = {
'8.0.0': 'x-pack/test/apm_api_integration/common/fixtures/es_archiver/8.0.0',
'apm_8.0.0': 'x-pack/test/apm_api_integration/common/fixtures/es_archiver/apm_8.0.0',
'apm_mappings_only_8.0.0':
'x-pack/test/apm_api_integration/common/fixtures/es_archiver/apm_mappings_only_8.0.0',
infra_metrics_and_apm:
'x-pack/test/apm_api_integration/common/fixtures/es_archiver/infra_metrics_and_apm',
'metrics_8.0.0': 'x-pack/test/apm_api_integration/common/fixtures/es_archiver/metrics_8.0.0',
'ml_8.0.0': 'x-pack/test/apm_api_integration/common/fixtures/es_archiver/ml_8.0.0',
observability_overview:
'x-pack/test/apm_api_integration/common/fixtures/es_archiver/observability_overview',
'rum_8.0.0': 'x-pack/test/apm_api_integration/common/fixtures/es_archiver/rum_8.0.0',
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,5 +21,6 @@ export default function apmApiIntegrationTests({
loadTestFile(require.resolve('./correlations'));
loadTestFile(require.resolve('./entities'));
loadTestFile(require.resolve('./cold_start'));
loadTestFile(require.resolve('./services'));
});
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
/*
* 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 expect from '@kbn/expect';
import { ApmDocumentType } from '@kbn/apm-plugin/common/document_type';
import { RollupInterval } from '@kbn/apm-plugin/common/rollup';
import type { DeploymentAgnosticFtrProviderContext } from '../../../../ftr_provider_context';

export default function ApiTest({ getService }: DeploymentAgnosticFtrProviderContext) {
const apmApiClient = getService('apmApi');

const start = '2021-10-01T00:00:00.000Z';
const end = '2021-10-01T01:00:00.000Z';

const serviceNames = ['opbeans-java', 'opbeans-go'];

describe('Services detailed statistics', () => {
describe('Services detailed statistics when data is not loaded', () => {
it('handles the empty state', async () => {
const response = await apmApiClient.readUser({
endpoint: `POST /internal/apm/services/detailed_statistics`,
params: {
query: {
start,
end,
environment: 'ENVIRONMENT_ALL',
kuery: '',
offset: '1d',
probability: 1,
documentType: ApmDocumentType.TransactionMetric,
rollupInterval: RollupInterval.OneMinute,
bucketSizeInSeconds: 60,
},
body: {
serviceNames: JSON.stringify(serviceNames),
},
},
});

expect(response.status).to.be(200);
expect(response.body.currentPeriod).to.be.empty();
expect(response.body.previousPeriod).to.be.empty();
});
});
});
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,172 @@
/*
* 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 expect from '@kbn/expect';
import { APIReturnType } from '@kbn/apm-plugin/public/services/rest/create_call_apm_api';

import { RoleCredentials } from '@kbn/ftr-common-functional-services';
import type { DeploymentAgnosticFtrProviderContext } from '../../../../ftr_provider_context';

export default function annotationApiTests({ getService }: DeploymentAgnosticFtrProviderContext) {
const apmApiClient = getService('apmApi');
const es = getService('es');
const samlAuth = getService('samlAuth');

const dates = [
new Date('2021-02-01T00:00:00.000Z'),
new Date('2021-02-01T01:00:00.000Z'),
new Date('2021-02-01T02:00:00.000Z'),
new Date('2021-02-01T03:00:00.000Z'),
];

const indexName = 'apm-8.0.0-transaction';

describe('Derived deployment annotations with a basic license', () => {
describe('when there are multiple service versions', () => {
let roleAuthc: RoleCredentials;
let response: APIReturnType<'GET /api/apm/services/{serviceName}/annotation/search 2023-10-31'>;

before(async () => {
roleAuthc = await samlAuth.createM2mApiKeyWithRoleScope('viewer');
const indexExists = await es.indices.exists({ index: indexName });
if (indexExists) {
await es.indices.delete({
index: indexName,
});
}

await es.indices.create({
index: indexName,
body: {
mappings: {
properties: {
service: {
properties: {
name: {
type: 'keyword',
},
version: {
type: 'keyword',
},
environment: {
type: 'keyword',
},
},
},
transaction: {
properties: {
type: {
type: 'keyword',
},
duration: {
type: 'long',
},
},
},
processor: {
properties: {
event: {
type: 'keyword',
},
},
},
},
},
},
});

const docs = dates.flatMap((date, index) => {
const baseAnnotation = {
transaction: {
type: 'request',
duration: 1000000,
},

service: {
name: 'opbeans-java',
environment: 'production',
version: index + 1,
},
processor: {
event: 'transaction',
},
};
return [
{
...baseAnnotation,
'@timestamp': date.toISOString(),
},
{
...baseAnnotation,
'@timestamp': new Date(date.getTime() + 30000),
},
{
...baseAnnotation,
'@timestamp': new Date(date.getTime() + 60000),
},
];
});

await es.bulk({
index: indexName,
body: docs.flatMap((doc) => [{ index: {} }, doc]),
refresh: true,
});

response = (
await apmApiClient.readUser({
endpoint: 'GET /api/apm/services/{serviceName}/annotation/search 2023-10-31',
params: {
path: {
serviceName: 'opbeans-java',
},
query: {
start: dates[1].toISOString(),
end: dates[2].toISOString(),
environment: 'production',
},
},
roleAuthc,
})
).body;
});

after(async () => {
await es.indices.delete({
index: indexName,
});
await samlAuth.invalidateM2mApiKeyWithRoleScope(roleAuthc);
});

it('annotations are displayed for the service versions in the given time range', async () => {
expect(response.annotations.length).to.be(2);
expect(response.annotations[0]['@timestamp']).to.be(dates[1].getTime());
expect(response.annotations[1]['@timestamp']).to.be(dates[2].getTime());

expectSnapshot(response.annotations[0]).toMatchInline(`
Object {
"@timestamp": 1612141200000,
"id": "2",
"text": "2",
"type": "version",
}
`);
});

it('annotations are not displayed for the service versions outside of the given time range', () => {
expect(
response.annotations.some((annotation) => {
return (
annotation['@timestamp'] !== dates[0].getTime() &&
annotation['@timestamp'] !== dates[2].getTime()
);
})
);
});
});
});
}
Loading

0 comments on commit d527ffe

Please sign in to comment.