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

[Advanced settings][Serverless] Add API integration tests (#172083)

Browse source 
## Summary

This PR adds serverless API integration tests for the uiSettings routes.
This commit is contained in:
Elena Stoeva 2023-11-29 09:45:08 +00:00 • committed by GitHub
parent f085621576
commit 4d8db5b309
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 190 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

1
x-pack/test_serverless/api_integration/test_suites/common/core/index.ts
View file

@ -14,5 +14,6 @@ export default function ({ loadTestFile }: FtrProviderContext) {
loadTestFile(require.resolve('./compression'));
loadTestFile(require.resolve('./translations'));
loadTestFile(require.resolve('./capabilities'));
loadTestFile(require.resolve('./ui_settings'));
});
}

189
x-pack/test_serverless/api_integration/test_suites/common/core/ui_settings.ts Normal file
View file

@ -0,0 +1,189 @@
/*
* 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 '../../../ftr_provider_context';
// To test setting validations we are using the existing 'defaultColumns' setting that is available in all serverless projects
// (See list of common serverless settings in /packages/serverless/settings/common/index.ts)
// The 'defaultColumns' setting is of type array of strings
const DEFAULT_COLUMNS_SETTING = 'defaultColumns';
// We will also create a test setting
const TEST_SETTING = 'testSetting';
export default function ({ getService }: FtrProviderContext) {
const supertest = getService('supertest');
const svlCommonApi = getService('svlCommonApi');
describe('ui settings service', () => {
before(async () => {
// Creating a test setting
await supertest
.post(`/internal/kibana/settings/${TEST_SETTING}`)
.set(svlCommonApi.getInternalRequestHeader())
.send({ value: 100 })
.expect(200);
});
// We don't test the public routes as they are not available in serverless
describe('internal routes', () => {
describe('get', () => {
it('returns list of settings', async () => {
const { body } = await supertest
.get('/internal/kibana/settings')
.set(svlCommonApi.getInternalRequestHeader())
.expect(200);
// The returned list of settings should contain the created test setting
expect(body).to.have.property('settings');
expect(body.settings).to.have.property(TEST_SETTING);
});
});
describe('set', () => {
it('validates value', async () => {
const { body } = await supertest
.post(`/internal/kibana/settings/${DEFAULT_COLUMNS_SETTING}`)
.set(svlCommonApi.getInternalRequestHeader())
.send({ value: 100 })
.expect(400);
expect(body).to.eql({
statusCode: 400,
error: 'Bad Request',
message:
'[validation [defaultColumns]]: expected value of type [array] but got [number]',
});
});
it('sets value of a setting', async () => {
await supertest
.post(`/internal/kibana/settings/${TEST_SETTING}`)
.set(svlCommonApi.getInternalRequestHeader())
.send({ value: 999 })
.expect(200);
// Verify that the setting has a new value
const { body } = await supertest
.get('/internal/kibana/settings')
.set(svlCommonApi.getInternalRequestHeader())
.expect(200);
// The returned list of settings should contain the created test setting
expect(body.settings[TEST_SETTING].userValue).to.equal(999);
});
});
describe('set many', () => {
it('validates value', async () => {
const { body } = await supertest
.post('/internal/kibana/settings')
.set(svlCommonApi.getInternalRequestHeader())
.send({ changes: { [TEST_SETTING]: 100, [DEFAULT_COLUMNS_SETTING]: 100 } })
.expect(400);
expect(body).to.eql({
statusCode: 400,
error: 'Bad Request',
message:
'[validation [defaultColumns]]: expected value of type [array] but got [number]',
});
});
it('sets values of settings', async () => {
await supertest
.post(`/internal/kibana/settings`)
.set(svlCommonApi.getInternalRequestHeader())
.send({ changes: { [TEST_SETTING]: 500 } })
.expect(200);
// Verify that the setting has a new value
const { body } = await supertest
.get('/internal/kibana/settings')
.set(svlCommonApi.getInternalRequestHeader())
.expect(200);
// The returned list of settings should contain the created test setting
expect(body.settings[TEST_SETTING].userValue).to.equal(500);
});
});
describe('validate', () => {
it('returns correct validation error message for invalid value', async () => {
const { body } = await supertest
.post(`/internal/kibana/settings/${DEFAULT_COLUMNS_SETTING}/validate`)
.set(svlCommonApi.getInternalRequestHeader())
.send({ value: 100 })
.expect(200);
expect(body).to.eql({
valid: false,
errorMessage: 'expected value of type [array] but got [number]',
});
});
it('returns no validation error message for valid value', async () => {
const { body } = await supertest
.post(`/internal/kibana/settings/${DEFAULT_COLUMNS_SETTING}/validate`)
.set(svlCommonApi.getInternalRequestHeader())
.send({ value: ['test'] })
.expect(200);
expect(body).to.eql({
valid: true,
});
});
it('returns a 404 for non-existing key', async () => {
const { body } = await supertest
.post(`/internal/kibana/settings/nonExisting/validate`)
.set(svlCommonApi.getInternalRequestHeader())
.send({ value: ['test'] })
.expect(404);
expect(body).to.eql({
statusCode: 404,
error: 'Not Found',
message: 'Setting with a key [nonExisting] does not exist.',
});
});
it('returns a 400 for a null value', async () => {
const { body } = await supertest
.post(`/internal/kibana/settings/${DEFAULT_COLUMNS_SETTING}/validate`)
.set(svlCommonApi.getInternalRequestHeader())
.send({ value: null })
.expect(400);
expect(body).to.eql({
statusCode: 400,
error: 'Bad Request',
message: 'No value was specified.',
});
});
});
describe('delete', () => {
it('deletes setting', async () => {
await supertest
.delete(`/internal/kibana/settings/${TEST_SETTING}`)
.set(svlCommonApi.getInternalRequestHeader())
.expect(200);
// Verify that the setting is not returned in the Get response anymore
const { body } = await supertest
.get('/internal/kibana/settings')
.set(svlCommonApi.getInternalRequestHeader())
.expect(200);
// The returned list of settings should contain the created test setting
expect(body.settings).to.not.have.property(TEST_SETTING);
});
});
});
});
}