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

Add FTR smoke tests for http version negotiation (#184006)

Browse source 
## Summary

Add some FTR smoke test for http version negotiation.

Note: version negotiation is already extensively covered with
integration tests, the purpose here is to have something more end to
end.
This commit is contained in:
Pierre Gayvallet 2024-05-28 19:04:11 +02:00 • committed by GitHub
parent ef7677341b
commit 8149486489
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
3 changed files with 172 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

56
test/plugin_functional/plugins/core_http/server/plugin.ts
View file

@ -31,6 +31,62 @@ export class CoreHttpPlugin implements Plugin {
return res.ok({ body: req.headers });
}
);
router.versioned
.get({
path: '/api/core_http/public_versioned_route',
access: 'public',
enableQueryVersion: false,
})
.addVersion({ version: '2023-10-31', validate: false }, (ctx, req, res) => {
return res.ok({
body: {
version: '2023-10-31',
},
});
});
router.versioned
.get({
path: '/api/core_http/internal_versioned_route',
access: 'internal',
enableQueryVersion: false,
})
.addVersion({ version: '1', validate: false }, (ctx, req, res) => {
return res.ok({
body: {
version: 1,
},
});
})
.addVersion({ version: '2', validate: false }, (ctx, req, res) => {
return res.ok({
body: {
version: 2,
},
});
});
router.versioned
.get({
path: '/api/core_http/versioned_route_with_query_version',
access: 'internal',
enableQueryVersion: true,
})
.addVersion({ version: '1', validate: false }, (ctx, req, res) => {
return res.ok({
body: {
version: 1,
},
});
})
.addVersion({ version: '2', validate: false }, (ctx, req, res) => {
return res.ok({
body: {
version: 2,
},
});
});
}
public start() {}

115
test/plugin_functional/test_suites/core_plugins/http_versioned.ts Normal file
View file

@ -0,0 +1,115 @@
/*
* 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 expect from '@kbn/expect';
import '@kbn/core-provider-plugin/types';
import { PluginFunctionalProviderContext } from '../../services';
export default function ({ getService }: PluginFunctionalProviderContext) {
const supertest = getService('supertest');
// routes defined in the `core_http` test plugin
describe('Route version negotiation', () => {
describe('internal route', () => {
it('serves requests with the handler corresponding to the specified version', async () => {
await supertest
.get('/api/core_http/internal_versioned_route')
.set('Elastic-Api-Version', '1')
.expect(200)
.then((response) => {
expect(response.body).to.eql({
version: 1,
});
});
await supertest
.get('/api/core_http/internal_versioned_route')
.set('Elastic-Api-Version', '2')
.expect(200)
.then((response) => {
expect(response.body).to.eql({
version: 2,
});
});
});
it('returns the version in response headers', async () => {
await supertest
.get('/api/core_http/internal_versioned_route')
.set('Elastic-Api-Version', '1')
.expect(200)
.then((response) => {
expect(response.headers['elastic-api-version']).to.eql('1');
});
await supertest
.get('/api/core_http/internal_versioned_route')
.set('Elastic-Api-Version', '2')
.expect(200)
.then((response) => {
expect(response.headers['elastic-api-version']).to.eql('2');
});
});
it('requires the version header to be set', async () => {
await supertest
.get('/api/core_http/internal_versioned_route')
.unset('Elastic-Api-Version')
.expect(400)
.then((response) => {
expect(response.body.message).to.match(/Please specify.+version/);
});
});
});
describe('public route', () => {
it('serves requests with the handler corresponding to the specified version', async () => {
await supertest
.get('/api/core_http/public_versioned_route')
.set('Elastic-Api-Version', '2023-10-31')
.expect(200)
.then((response) => {
expect(response.body).to.eql({
version: '2023-10-31',
});
});
});
it('returns the version in response headers', async () => {
await supertest
.get('/api/core_http/public_versioned_route')
.set('Elastic-Api-Version', '2023-10-31')
.expect(200)
.then((response) => {
expect(response.headers['elastic-api-version']).to.eql('2023-10-31');
});
});
});
describe('query version', () => {
it('does not allow passing the version in the query by default', async () => {
await supertest
.get('/api/core_http/internal_versioned_route')
.unset('Elastic-Api-Version')
.query({ apiVersion: '2' })
.expect(400);
});
it('allows passing the version in the query when enabled via enableQueryVersion', async () => {
await supertest
.get('/api/core_http/versioned_route_with_query_version')
.unset('Elastic-Api-Version')
.query({ apiVersion: '2' })
.expect(200)
.then((response) => {
expect(response.body).to.eql({
version: '2',
});
});
});
});
});
}

1
test/plugin_functional/test_suites/core_plugins/index.ts
View file

@ -24,6 +24,7 @@ export default function ({ loadTestFile }: PluginFunctionalProviderContext) {
loadTestFile(require.resolve('./chrome_help_menu_links'));
loadTestFile(require.resolve('./history_block'));
loadTestFile(require.resolve('./http'));
loadTestFile(require.resolve('./http_versioned'));
loadTestFile(require.resolve('./dynamic_contract_resolving'));
});
}