mirror of
https://github.com/elastic/kibana.git
synced 2025-06-28 19:13:14 -04:00
7df01e99c1
## Summary
### This PR introduces a new type of API integration tests in FTR:
deployment-agnostic
#### Test suite is considered deployment-agnostic when it fulfils the
following criteria:
**Functionality**: It tests Kibana APIs that are **logically identical
in both stateful and serverless environments** for the same SAML roles.
**Design**: The test design is **clean and does not require additional
logic** to execute in either stateful or serverless environments.
### How It Works
Most existing stateful tests use basic authentication for API testing.
In contrast, serverless tests use SAML authentication with
project-specific role mapping.
Since stateful deployments also support SAML, deployment-agnostic tests
**configure Elasticsearch and Kibana with SAML authentication in both
cases**. For roles, stateful deployments define 'viewer', 'editor', and
'admin' roles with serverless-alike privileges.
New `samlAuth` service has `AuthProvider` interface with 2 different
implementations: depending on environment context (serverless or
stateful) appropriate implementation is used. But it remains on service
level and hidden in test suite.
test example
```
export default function ({ getService }: DeploymentAgnosticFtrProviderContext) {
const samlAuth = getService('samlAuth');
const supertestWithoutAuth = getService('supertestWithoutAuth');
let roleAuthc: RoleCredentials;
let internalHeaders: InternalRequestHeader;
describe('GET /api/console/api_server', () => {
before(async () => {
roleAuthc = await samlAuth.createM2mApiKeyWithRoleScope('admin');
internalHeaders = samlAuth.getInternalRequestHeader();
});
after(async () => {
await samlAuth.invalidateM2mApiKeyWithRoleScope(roleAuthc);
});
it('returns autocomplete definitions', async () => {
const { body } = await supertestWithoutAuth
.get('/api/console/api_server')
.set(roleAuthc.apiKeyHeader)
.set(internalHeaders)
.set('kbn-xsrf', 'true')
.expect(200);
expect(body.es).to.be.ok();
const {
es: { name, globals, endpoints },
} = body;
expect(name).to.be.ok();
expect(Object.keys(globals).length).to.be.above(0);
expect(Object.keys(endpoints).length).to.be.above(0);
});
});
}
```
Please read
[readme](966822ac87/x-pack/test/api_integration/deployment_agnostic/README.md)
for more details and step-by-step guide. It should help migrating
existing serverless tests to deployment-agnostic, assuming requirements
are met.
### Examples
Deployment-agnostic tests:
```
x-pack/test/api_integration/deployment_agnostic/apis/console/spec_definitions.ts
x-pack/test/api_integration/deployment_agnostic/apis/core/compression.ts
x-pack/test/api_integration/deployment_agnostic/apis/painless_lab/painless_lab.ts
```
Configs to run it:
```
node scripts/functional_tests --config x-pack/test/api_integration/deployment_agnostic/oblt.serverless.config.ts
node scripts/functional_tests --config x-pack/test/api_integration/deployment_agnostic/search.serverless.config.ts
node scripts/functional_tests --config x-pack/test/api_integration/deployment_agnostic/security.serverless.config.ts
node scripts/functional_tests --config x-pack/test/api_integration/deployment_agnostic/stateful.config.ts
```
PR is a compact version of #188737 with reduced changes in existing
serverless tests.
---------
Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>
Co-authored-by: elena-shostak <165678770+elena-shostak@users.noreply.github.com>
Co-authored-by: Aleh Zasypkin <aleh.zasypkin@gmail.com>
52 lines
1.5 KiB
TypeScript
52 lines
1.5 KiB
TypeScript
/*
|
|
* 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 { FtrProviderContext } from '../../functional/ftr_provider_context';
|
|
|
|
const COMMON_REQUEST_HEADERS = {
|
|
'kbn-xsrf': 'some-xsrf-token',
|
|
};
|
|
|
|
const INTERNAL_REQUEST_HEADERS = {
|
|
...COMMON_REQUEST_HEADERS,
|
|
'x-elastic-internal-origin': 'kibana',
|
|
};
|
|
|
|
export type InternalRequestHeader = typeof INTERNAL_REQUEST_HEADERS;
|
|
|
|
export function SvlCommonApiServiceProvider({}: FtrProviderContext) {
|
|
return {
|
|
// call it from 'samlAuth' service when tests are migrated to deployment-agnostic
|
|
getCommonRequestHeader() {
|
|
return COMMON_REQUEST_HEADERS;
|
|
},
|
|
// call it from 'samlAuth' service when tests are migrated to deployment-agnostic
|
|
getInternalRequestHeader(): InternalRequestHeader {
|
|
return INTERNAL_REQUEST_HEADERS;
|
|
},
|
|
|
|
assertResponseStatusCode(expectedStatus: number, actualStatus: number, responseBody: object) {
|
|
expect(actualStatus).to.eql(
|
|
expectedStatus,
|
|
`Expected status code ${expectedStatus}, got ${actualStatus} with body '${JSON.stringify(
|
|
responseBody
|
|
)}'`
|
|
);
|
|
},
|
|
|
|
assertApiNotFound(body: unknown, status: number) {
|
|
expect(body).to.eql({
|
|
statusCode: 404,
|
|
error: 'Not Found',
|
|
message: 'Not Found',
|
|
});
|
|
expect(status).to.eql(404);
|
|
},
|
|
};
|
|
}
|