github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-24 01:38:56 -04:00
Code Issues Projects Releases Packages Wiki Activity

Functional tests for execution context (#110299)

Browse source 
* remove unnecessary ts-ignore

* add context propagation to x-opaque-id header tests

* run tests on CI

* simplify logging. the action purpose follows from the context name

* extend tests with the assertion against execution_context from the Kibana logs

* split JSON log records only

* apply suggestions proposed by Spencer
This commit is contained in:
Mikhail Shustov 2021-09-03 12:48:32 +03:00 • committed by GitHub
parent c42391ed3a
commit 641cef7ca6
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
9 changed files with 463 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

1
scripts/functional_tests.js
View file

@ -20,6 +20,7 @@ const onlyNotInCoverageTests = [
require.resolve('../test/api_integration/config.js'),
require.resolve('../test/interpreter_functional/config.ts'),
require.resolve('../test/examples/config.js'),
require.resolve('../test/functional_execution_context/config.ts'),
];
require('../src/setup_node_env');

4
src/core/server/execution_context/execution_context_service.test.ts
View file

@ -109,7 +109,7 @@ describe('ExecutionContextService', () => {
expect(loggingSystemMock.collect(core.logger).debug).toMatchInlineSnapshot(`
Array [
Array [
"set the execution context: {\\"type\\":\\"type-a\\",\\"name\\":\\"name-a\\",\\"id\\":\\"id-a\\",\\"description\\":\\"description-a\\"}",
"{\\"type\\":\\"type-a\\",\\"name\\":\\"name-a\\",\\"id\\":\\"id-a\\",\\"description\\":\\"description-a\\"}",
],
]
`);
@ -351,7 +351,7 @@ describe('ExecutionContextService', () => {
expect(loggingSystemMock.collect(core.logger).debug).toMatchInlineSnapshot(`
Array [
Array [
"stored the execution context: {\\"type\\":\\"type-a\\",\\"name\\":\\"name-a\\",\\"id\\":\\"id-a\\",\\"description\\":\\"description-a\\"}",
"{\\"type\\":\\"type-a\\",\\"name\\":\\"name-a\\",\\"id\\":\\"id-a\\",\\"description\\":\\"description-a\\"}",
],
]
`);

4
src/core/server/execution_context/execution_context_service.ts
View file

@ -124,7 +124,7 @@ export class ExecutionContextService
// we have to use enterWith since Hapi lifecycle model is built on event emitters.
// therefore if we wrapped request handler in asyncLocalStorage.run(), we would lose context in other lifecycles.
this.contextStore.enterWith(contextContainer);
this.log.debug(`set the execution context: ${JSON.stringify(contextContainer)}`);
this.log.debug(JSON.stringify(contextContainer));
}
private withContext<R>(
@ -136,7 +136,7 @@ export class ExecutionContextService
}
const parent = this.contextStore.getStore();
const contextContainer = new ExecutionContextContainer(context, parent);
this.log.debug(`stored the execution context: ${JSON.stringify(contextContainer)}`);
this.log.debug(JSON.stringify(contextContainer));
return this.contextStore.run(contextContainer, fn);
}

2
test/common/services/es_archiver.ts
View file

@ -8,8 +8,6 @@
import { EsArchiver } from '@kbn/es-archiver';
import { FtrProviderContext } from '../ftr_provider_context';
// @ts-ignore not TS yet
import * as KibanaServer from './kibana_server';
export function EsArchiverProvider({ getService }: FtrProviderContext): EsArchiver {

43
test/functional_execution_context/config.ts Normal file
View file

@ -0,0 +1,43 @@
/*
* 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 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 or the Server
* Side Public License, v 1.
*/
import { FtrConfigProviderContext } from '@kbn/test';
import Path from 'path';
export default async function ({ readConfigFile }: FtrConfigProviderContext) {
const functionalConfig = await readConfigFile(require.resolve('../functional/config'));
return {
...functionalConfig.getAll(),
rootTags: ['skipCloud'],
testFiles: [require.resolve('./tests/')],
junit: {
reportName: 'Execution Context Functional Tests',
},
kbnTestServer: {
...functionalConfig.get('kbnTestServer'),
serverArgs: [
...functionalConfig.get('kbnTestServer.serverArgs'),
'--execution_context.enabled=true',
'--logging.appenders.file.type=file',
`--logging.appenders.file.fileName=${Path.resolve(__dirname, './kibana.log')}`,
'--logging.appenders.file.layout.type=json',
'--logging.loggers[0].name=elasticsearch.query',
'--logging.loggers[0].level=all',
// eslint-disable-next-line prettier/prettier
'--logging.loggers[0].appenders=[\"file\"]',
'--logging.loggers[1].name=execution_context',
'--logging.loggers[1].level=debug',
// eslint-disable-next-line prettier/prettier
'--logging.loggers[1].appenders=[\"file\"]',
],
},
};
}

14
test/functional_execution_context/ftr_provider_context.ts Normal file
View file

@ -0,0 +1,14 @@
/*
* 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 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 or the Server
* Side Public License, v 1.
*/
import { GenericFtrProviderContext } from '@kbn/test';
import { pageObjects } from '../functional/page_objects';
import { services } from './services';
export type FtrProviderContext = GenericFtrProviderContext<typeof services, typeof pageObjects>;
export { pageObjects };

11
test/functional_execution_context/services.ts Normal file
View file

@ -0,0 +1,11 @@
/*
* 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 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 or the Server
* Side Public License, v 1.
*/
import { services as functionalServices } from '../functional/services';
export const services = functionalServices;

374
test/functional_execution_context/tests/execution_context.ts Normal file
View file

@ -0,0 +1,374 @@
/*
* 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 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 or the Server
* Side Public License, v 1.
*/
import type { Ecs, KibanaExecutionContext } from 'kibana/server';
import Fs from 'fs/promises';
import Path from 'path';
import { isEqual } from 'lodash';
import type { FtrProviderContext } from '../ftr_provider_context';
const logFilePath = Path.resolve(__dirname, '../kibana.log');
// to avoid splitting log record containing \n symbol
const endOfLine = /(?<=})\s*\n/;
export default function ({ getService, getPageObjects }: FtrProviderContext) {
const PageObjects = getPageObjects(['common', 'dashboard', 'header', 'home']);
const retry = getService('retry');
async function assertLogContains(
description: string,
predicate: (record: Ecs) => boolean
): Promise<void> {
// logs are written to disk asynchronously. I sacrificed performance to reduce flakiness.
await retry.waitFor(description, async () => {
const logsStr = await Fs.readFile(logFilePath, 'utf-8');
const normalizedRecords = logsStr
.split(endOfLine)
.filter(Boolean)
.map((s) => JSON.parse(s));
return normalizedRecords.some(predicate);
});
}
function isExecutionContextLog(
record: string | undefined,
executionContext: KibanaExecutionContext
) {
if (!record) return false;
try {
const object = JSON.parse(record);
return isEqual(object, executionContext);
} catch (e) {
return false;
}
}
describe('Execution context service', () => {
before(async () => {
await PageObjects.common.navigateToUrl('home', '/tutorial_directory/sampleData', {
useActualUrl: true,
});
await PageObjects.home.addSampleDataSet('flights');
await PageObjects.header.waitUntilLoadingHasFinished();
});
after(async () => {
await PageObjects.common.navigateToUrl('home', '/tutorial_directory/sampleData', {
useActualUrl: true,
});
await PageObjects.header.waitUntilLoadingHasFinished();
await PageObjects.home.removeSampleDataSet('flights');
});
describe('discover app', () => {
before(async () => {
await PageObjects.common.navigateToApp('discover');
await PageObjects.header.waitUntilLoadingHasFinished();
});
it('propagates context for Discover', async () => {
await assertLogContains(
'execution context propagates to Elasticsearch via "x-opaque-id" header',
(record) => Boolean(record.http?.request?.id?.includes('kibana:application:discover'))
);
await assertLogContains('execution context propagates to Kibana logs', (record) =>
isExecutionContextLog(record?.message, {
description: 'fetch documents',
id: '',
name: 'discover',
type: 'application',
// discovery doesn't have an URL since one of from the example dataset is not saved separately
url: '/app/discover',
})
);
await assertLogContains('execution context propagates to Kibana logs', (record) =>
isExecutionContextLog(record?.message, {
description: 'fetch chart data and total hits',
id: '',
name: 'discover',
type: 'application',
url: '/app/discover',
})
);
});
});
describe('dashboard app', () => {
before(async () => {
await PageObjects.common.navigateToApp('dashboard');
await PageObjects.dashboard.loadSavedDashboard('[Flights] Global Flight Dashboard');
await PageObjects.dashboard.waitForRenderComplete();
await PageObjects.header.waitUntilLoadingHasFinished();
});
describe('propagates context for Lens visualizations', () => {
it('lnsXY', async () => {
await assertLogContains(
'execution context propagates to Elasticsearch via "x-opaque-id" header',
(record) =>
Boolean(
record.http?.request?.id?.includes(
'kibana:application:dashboard:7adfa750-4c81-11e8-b3d7-01146121b73d;lens:lnsXY:086ac2e9-dd16-4b45-92b8-1e43ff7e3f65'
)
)
);
await assertLogContains('execution context propagates to Kibana logs', (record) =>
isExecutionContextLog(record?.message, {
parent: {
type: 'application',
name: 'dashboard',
id: '7adfa750-4c81-11e8-b3d7-01146121b73d',
description: '[Flights] Global Flight Dashboard',
url: '/view/7adfa750-4c81-11e8-b3d7-01146121b73d',
},
type: 'lens',
name: 'lnsXY',
id: '086ac2e9-dd16-4b45-92b8-1e43ff7e3f65',
description: '[Flights] Flight count',
url: '/app/lens#/edit_by_value',
})
);
});
it('lnsMetric', async () => {
await assertLogContains(
'execution context propagates to Elasticsearch via "x-opaque-id" header',
(record) =>
Boolean(
record.http?.request?.id?.includes(
'kibana:application:dashboard:7adfa750-4c81-11e8-b3d7-01146121b73d;lens:lnsMetric:b766e3b8-4544-46ed-99e6-9ecc4847e2a2'
)
)
);
await assertLogContains('execution context propagates to Kibana logs', (record) =>
isExecutionContextLog(record?.message, {
parent: {
type: 'application',
name: 'dashboard',
id: '7adfa750-4c81-11e8-b3d7-01146121b73d',
description: '[Flights] Global Flight Dashboard',
url: '/view/7adfa750-4c81-11e8-b3d7-01146121b73d',
},
type: 'lens',
name: 'lnsMetric',
id: '2e33ade5-96e5-40b4-b460-493e5d4fa834',
description: '',
url: '/app/lens#/edit_by_value',
})
);
});
it('lnsDatatable', async () => {
await assertLogContains(
'execution context propagates to Elasticsearch via "x-opaque-id" header',
(record) =>
Boolean(
record.http?.request?.id?.includes(
'kibana:application:dashboard:7adfa750-4c81-11e8-b3d7-01146121b73d;lens:lnsDatatable:fb86b32f-fb7a-45cf-9511-f366fef51bbd'
)
)
);
await assertLogContains('execution context propagates to Kibana logs', (record) =>
isExecutionContextLog(record?.message, {
parent: {
type: 'application',
name: 'dashboard',
id: '7adfa750-4c81-11e8-b3d7-01146121b73d',
description: '[Flights] Global Flight Dashboard',
url: '/view/7adfa750-4c81-11e8-b3d7-01146121b73d',
},
type: 'lens',
name: 'lnsDatatable',
id: 'fb86b32f-fb7a-45cf-9511-f366fef51bbd',
description: 'Cities by delay, cancellation',
url: '/app/lens#/edit_by_value',
})
);
});
it('lnsPie', async () => {
await assertLogContains(
'execution context propagates to Elasticsearch via "x-opaque-id" header',
(record) =>
Boolean(
record.http?.request?.id?.includes(
'kibana:application:dashboard:7adfa750-4c81-11e8-b3d7-01146121b73d;lens:lnsPie:5d53db36-2d5a-4adc-af7b-cec4c1a294e0'
)
)
);
await assertLogContains('execution context propagates to Kibana logs', (record) =>
isExecutionContextLog(record?.message, {
parent: {
type: 'application',
name: 'dashboard',
id: '7adfa750-4c81-11e8-b3d7-01146121b73d',
description: '[Flights] Global Flight Dashboard',
url: '/view/7adfa750-4c81-11e8-b3d7-01146121b73d',
},
type: 'lens',
name: 'lnsPie',
id: '5d53db36-2d5a-4adc-af7b-cec4c1a294e0',
description: '[Flights] Delay Type',
url: '/app/lens#/edit_by_value',
})
);
});
});
it('propagates context for built-in Discover', async () => {
await assertLogContains(
'execution context propagates to Elasticsearch via "x-opaque-id" header',
(record) =>
Boolean(
record.http?.request?.id?.includes(
'application:dashboard:7adfa750-4c81-11e8-b3d7-01146121b73d;search:discover:571aaf70-4c88-11e8-b3d7-01146121b73d'
)
)
);
await assertLogContains('execution context propagates to Kibana logs', (record) =>
isExecutionContextLog(record?.message, {
parent: {
type: 'application',
name: 'dashboard',
id: '7adfa750-4c81-11e8-b3d7-01146121b73d',
description: '[Flights] Global Flight Dashboard',
url: '/view/7adfa750-4c81-11e8-b3d7-01146121b73d',
},
type: 'search',
name: 'discover',
id: '571aaf70-4c88-11e8-b3d7-01146121b73d',
description: '[Flights] Flight Log',
url: '/app/discover#/view/571aaf70-4c88-11e8-b3d7-01146121b73d',
})
);
});
it('propagates context for TSVB visualizations', async () => {
await assertLogContains(
'execution context propagates to Elasticsearch via "x-opaque-id" header',
(record) =>
Boolean(
record.http?.request?.id?.includes(
'kibana:application:dashboard:7adfa750-4c81-11e8-b3d7-01146121b73d;visualization:TSVB:bcb63b50-4c89-11e8-b3d7-01146121b73d'
)
)
);
await assertLogContains('execution context propagates to Kibana logs', (record) =>
isExecutionContextLog(record?.message, {
parent: {
type: 'application',
name: 'dashboard',
id: '7adfa750-4c81-11e8-b3d7-01146121b73d',
description: '[Flights] Global Flight Dashboard',
url: '/view/7adfa750-4c81-11e8-b3d7-01146121b73d',
},
type: 'visualization',
name: 'TSVB',
id: 'bcb63b50-4c89-11e8-b3d7-01146121b73d',
description: '[Flights] Delays & Cancellations',
url: '/app/visualize#/edit/bcb63b50-4c89-11e8-b3d7-01146121b73d',
})
);
});
it('propagates context for Vega visualizations', async () => {
await assertLogContains(
'execution context propagates to Elasticsearch via "x-opaque-id" header',
(record) =>
Boolean(
record.http?.request?.id?.includes(
'kibana:application:dashboard:7adfa750-4c81-11e8-b3d7-01146121b73d;visualization:Vega:ed78a660-53a0-11e8-acbd-0be0ad9d822b'
)
)
);
await assertLogContains('execution context propagates to Kibana logs', (record) =>
isExecutionContextLog(record?.message, {
parent: {
type: 'application',
name: 'dashboard',
id: '7adfa750-4c81-11e8-b3d7-01146121b73d',
description: '[Flights] Global Flight Dashboard',
url: '/view/7adfa750-4c81-11e8-b3d7-01146121b73d',
},
type: 'visualization',
name: 'Vega',
id: 'ed78a660-53a0-11e8-acbd-0be0ad9d822b',
description: '[Flights] Airport Connections (Hover Over Airport)',
url: '/app/visualize#/edit/ed78a660-53a0-11e8-acbd-0be0ad9d822b',
})
);
});
it('propagates context for Tag Cloud visualization', async () => {
await assertLogContains(
'execution context propagates to Elasticsearch via "x-opaque-id" header',
(record) =>
Boolean(
record.http?.request?.id?.includes(
'kibana:application:dashboard:7adfa750-4c81-11e8-b3d7-01146121b73d;visualization:Tag cloud:293b5a30-4c8f-11e8-b3d7-01146121b73d'
)
)
);
await assertLogContains('execution context propagates to Kibana logs', (record) =>
isExecutionContextLog(record?.message, {
parent: {
type: 'application',
name: 'dashboard',
id: '7adfa750-4c81-11e8-b3d7-01146121b73d',
description: '[Flights] Global Flight Dashboard',
url: '/view/7adfa750-4c81-11e8-b3d7-01146121b73d',
},
type: 'visualization',
name: 'Tag cloud',
id: '293b5a30-4c8f-11e8-b3d7-01146121b73d',
description: '[Flights] Destination Weather',
url: '/app/visualize#/edit/293b5a30-4c8f-11e8-b3d7-01146121b73d',
})
);
});
it('propagates context for Vertical bar visualization', async () => {
await assertLogContains(
'execution context propagates to Elasticsearch via "x-opaque-id" header',
(record) =>
Boolean(
record.http?.request?.id?.includes(
'kibana:application:dashboard:7adfa750-4c81-11e8-b3d7-01146121b73d;visualization:Vertical bar:9886b410-4c8b-11e8-b3d7-01146121b73d'
)
)
);
await assertLogContains('execution context propagates to Kibana logs', (record) =>
isExecutionContextLog(record?.message, {
parent: {
type: 'application',
name: 'dashboard',
id: '7adfa750-4c81-11e8-b3d7-01146121b73d',
description: '[Flights] Global Flight Dashboard',
url: '/view/7adfa750-4c81-11e8-b3d7-01146121b73d',
},
type: 'visualization',
name: 'Vertical bar',
id: '9886b410-4c8b-11e8-b3d7-01146121b73d',
description: '[Flights] Delay Buckets',
url: '/app/visualize#/edit/9886b410-4c8b-11e8-b3d7-01146121b73d',
})
);
});
});
});
}

16
test/functional_execution_context/tests/index.ts Normal file
View file

@ -0,0 +1,16 @@
/*
* 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 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 or the Server
* Side Public License, v 1.
*/
import { FtrProviderContext } from '../ftr_provider_context';
export default function ({ loadTestFile }: FtrProviderContext) {
describe('Execution context', function () {
this.tags('ciGroup1');
loadTestFile(require.resolve('./execution_context'));
});
}