Skip to content

Commit

Permalink
Serverless custom roles and multiple spaces tests (elastic#191729)
Browse files Browse the repository at this point in the history 
## Summary

Implements serverless tests for custom roles and multiple spaces as part
of the feature flag test configs. We have implemented them here because
the feature flags for custom roles and multiple space are not yet
enabled in production.

These tests are minimal because when custom roles and custom spaces are
eventually be enabled in production, the full stateful test suites
should be adapted to deployment agnostic tests if possible.

### API Integration Tests
-
x-pack/test_serverless/api_integration/test_suites/common/management/multiple_spaces_enabled.ts
-
x-pack/test_serverless/api_integration/test_suites/common/platform_security/roles_routes_feature_flag.ts

## Functional Tests
-
x-pack/test_serverless/functional/test_suites/common/platform_security/roles.ts
-
x-pack/test_serverless/functional/test_suites/common/spaces/multiple_spaces_enabled.ts

## Flaky Test Runners
- API Integration Feature Flag tests:
https://buildkite.com/elastic/kibana-flaky-test-suite-runner/builds/6866
- Functional Feature Flag tests:
https://buildkite.com/elastic/kibana-flaky-test-suite-runner/builds/6867

---------

Co-authored-by: kibanamachine <[email protected]>
  • Loading branch information
@jeramysoucy @kibanamachine
jeramysoucy and kibanamachine authored Sep 6, 2024
1 parent d8445cc commit 6bef580
Show file tree
Hide file tree
Showing 20 changed files with 1,387 additions and 159 deletions.
274 changes: 274 additions & 0 deletions .../test_serverless/api_integration/test_suites/common/management/multiple_spaces_enabled.ts
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,274 @@
/*
* 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 'expect';
import { asyncForEach } from '@kbn/std';
import { SupertestWithRoleScopeType } from '@kbn/test-suites-xpack/api_integration/deployment_agnostic/services';
import { FtrProviderContext } from '../../../ftr_provider_context';

// Notes:
// This suite is currently only called from the feature flags test configs, e.g.
// x-pack/test_serverless/api_integration/test_suites/search/config.feature_flags.ts
// Configuration toggle:
// kbnServerArgs: ['--xpack.spaces.maxSpaces=100'],
//
// Initial test coverage limited to CRUD operations and ensuring disabling features/toggling feature visibility is not possible.
// Full coverage of x-pack/test/api_integration/apis/spaces & x-pack/test/spaces_api_integration
// should be converted into a deployment agnostic suite when spaces are
// permanently enabled in serverless.
//
// The route access tests for the spaces APIs in ./spaces.ts should also get updated at that time.

export default function ({ getService }: FtrProviderContext) {
const svlCommonApi = getService('svlCommonApi');
const roleScopedSupertest = getService('roleScopedSupertest');
let supertestWithAdminScope: SupertestWithRoleScopeType;

async function createSpace(id: string) {
await supertestWithAdminScope
.post('/api/spaces/space')
.send({
id,
name: id,
disabledFeatures: [],
})
.expect(200);
}

async function deleteSpace(id: string) {
await supertestWithAdminScope.delete(`/api/spaces/space/${id}`).expect(204);
}

describe('spaces', function () {
before(async () => {
supertestWithAdminScope = await roleScopedSupertest.getSupertestWithRoleScope('admin', {
withInternalHeaders: true,
withCustomHeaders: { 'kbn-xsrf': 'true' },
});
});
after(async () => {
// delete any lingering spaces
const { body } = await supertestWithAdminScope.get('/api/spaces/space').send().expect(200);

const toDelete = (body as Array<{ id: string }>).filter((f) => f.id !== 'default');

await asyncForEach(toDelete, async (space) => {
await deleteSpace(space.id);
});
});

describe('Create (POST /api/spaces/space)', () => {
it('should allow us to create a space', async () => {
await supertestWithAdminScope
.post('/api/spaces/space')
.send({
id: 'custom_space_1',
name: 'custom_space_1',
disabledFeatures: [],
})
.expect(200);
});

it('should not allow us to create a space with disabled features', async () => {
await supertestWithAdminScope
.post('/api/spaces/space')
.send({
id: 'custom_space_2',
name: 'custom_space_2',
disabledFeatures: ['discover'],
})
.expect(400);
});
});

describe('Read (GET /api/spaces/space)', () => {
before(async () => {
await createSpace('space_to_get_1');
await createSpace('space_to_get_2');
await createSpace('space_to_get_3');
});

after(async () => {
await deleteSpace('space_to_get_1');
await deleteSpace('space_to_get_2');
await deleteSpace('space_to_get_3');
});

it('should allow us to get a space', async () => {
await supertestWithAdminScope.get('/api/spaces/space/space_to_get_1').send().expect(200, {
id: 'space_to_get_1',
name: 'space_to_get_1',
disabledFeatures: [],
});
});

it('should allow us to get all spaces', async () => {
const { body } = await supertestWithAdminScope.get('/api/spaces/space').send().expect(200);

expect(body).toEqual(
expect.arrayContaining([
{
_reserved: true,
color: '#00bfb3',
description: 'This is your default space!',
disabledFeatures: [],
id: 'default',
name: 'Default',
},
{ id: 'space_to_get_1', name: 'space_to_get_1', disabledFeatures: [] },
{ id: 'space_to_get_2', name: 'space_to_get_2', disabledFeatures: [] },
{ id: 'space_to_get_3', name: 'space_to_get_3', disabledFeatures: [] },
])
);
});
});

describe('Update (PUT /api/spaces/space)', () => {
before(async () => {
await createSpace('space_to_update');
});

after(async () => {
await deleteSpace('space_to_update');
});

it('should allow us to update a space', async () => {
await supertestWithAdminScope
.put('/api/spaces/space/space_to_update')
.send({
id: 'space_to_update',
name: 'some new name',
initials: 'SN',
disabledFeatures: [],
})
.expect(200);

await supertestWithAdminScope.get('/api/spaces/space/space_to_update').send().expect(200, {
id: 'space_to_update',
name: 'some new name',
initials: 'SN',
disabledFeatures: [],
});
});

it('should not allow us to update a space with disabled features', async () => {
await supertestWithAdminScope
.put('/api/spaces/space/space_to_update')
.send({
id: 'space_to_update',
name: 'some new name',
initials: 'SN',
disabledFeatures: ['discover'],
})
.expect(400);
});
});

describe('Delete (DELETE /api/spaces/space)', () => {
it('should allow us to delete a space', async () => {
await createSpace('space_to_delete');

await supertestWithAdminScope.delete(`/api/spaces/space/space_to_delete`).expect(204);
});
});

describe('Get active space (GET /internal/spaces/_active_space)', () => {
before(async () => {
await createSpace('foo-space');
});

after(async () => {
await deleteSpace('foo-space');
});

it('returns the default space', async () => {
const response = await supertestWithAdminScope
.get('/internal/spaces/_active_space')
.expect(200);

const { id, name, _reserved } = response.body;
expect({ id, name, _reserved }).toEqual({
id: 'default',
name: 'Default',
_reserved: true,
});
});

it('returns the default space when explicitly referenced', async () => {
const response = await supertestWithAdminScope
.get('/s/default/internal/spaces/_active_space')
.expect(200);

const { id, name, _reserved } = response.body;
expect({ id, name, _reserved }).toEqual({
id: 'default',
name: 'Default',
_reserved: true,
});
});

it('returns the foo space', async () => {
await supertestWithAdminScope
.get('/s/foo-space/internal/spaces/_active_space')
.expect(200, {
id: 'foo-space',
name: 'foo-space',
disabledFeatures: [],
});
});

it('returns 404 when the space is not found', async () => {
await supertestWithAdminScope
.get('/s/not-found-space/internal/spaces/_active_space')
.expect(404, {
statusCode: 404,
error: 'Not Found',
message: 'Saved object [space/not-found-space] not found',
});
});
});

// These tests just test access to API endpoints
// They will be included in deployment agnostic testing once spaces
// are enabled in production.
describe(`Access`, () => {
it('#copyToSpace', async () => {
const { body, status } = await supertestWithAdminScope.post(
'/api/spaces/_copy_saved_objects'
);
svlCommonApi.assertResponseStatusCode(400, status, body);
});
it('#resolveCopyToSpaceErrors', async () => {
const { body, status } = await supertestWithAdminScope.post(
'/api/spaces/_resolve_copy_saved_objects_errors'
);
svlCommonApi.assertResponseStatusCode(400, status, body);
});
it('#updateObjectsSpaces', async () => {
const { body, status } = await supertestWithAdminScope.post(
'/api/spaces/_update_objects_spaces'
);
svlCommonApi.assertResponseStatusCode(400, status, body);
});
it('#getShareableReferences', async () => {
const { body, status } = await supertestWithAdminScope
.post('/api/spaces/_get_shareable_references')
.send({
objects: [{ type: 'a', id: 'a' }],
});
svlCommonApi.assertResponseStatusCode(200, status, body);
});
it('#disableLegacyUrlAliases', async () => {
const { body, status } = await supertestWithAdminScope.post(
'/api/spaces/_disable_legacy_url_aliases'
);
// without a request body we would normally a 400 bad request if the endpoint was registered
svlCommonApi.assertApiNotFound(body, status);
});
});
});
}
8 changes: 4 additions & 4 deletions x-pack/test_serverless/api_integration/test_suites/common/platform_security/authorization.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -64,31 +64,31 @@ export default function ({ getService }: FtrProviderContext) {

it('create/update roleAuthc', async () => {
const { body, status } = await supertestWithoutAuth
.put('/api/security/roleAuthc/test')
.put('/api/security/role/test')
.set(svlCommonApi.getInternalRequestHeader())
.set(roleAuthc.apiKeyHeader);
svlCommonApi.assertApiNotFound(body, status);
});

it('get roleAuthc', async () => {
const { body, status } = await supertestWithoutAuth
.get('/api/security/roleAuthc/superuser')
.get('/api/security/role/superuser')
.set(svlCommonApi.getInternalRequestHeader())
.set(roleAuthc.apiKeyHeader);
svlCommonApi.assertApiNotFound(body, status);
});

it('get all roles', async () => {
const { body, status } = await supertestWithoutAuth
.get('/api/security/roleAuthc')
.get('/api/security/role')
.set(svlCommonApi.getInternalRequestHeader())
.set(roleAuthc.apiKeyHeader);
svlCommonApi.assertApiNotFound(body, status);
});

it('delete roleAuthc', async () => {
const { body, status } = await supertestWithoutAuth
.delete('/api/security/roleAuthc/superuser')
.delete('/api/security/role/superuser')
.set(svlCommonApi.getInternalRequestHeader())
.set(roleAuthc.apiKeyHeader);
svlCommonApi.assertApiNotFound(body, status);
Expand Down
2 changes: 0 additions & 2 deletions ...erverless/api_integration/test_suites/common/platform_security/encrypted_saved_objects.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -32,9 +32,7 @@ export default function ({ getService }: FtrProviderContext) {

({ body, status } = await supertestWithoutAuth
.post('/api/encrypted_saved_objects/_rotate_key')
// .set(internalReqHeader)
.set(roleAuthc.apiKeyHeader));
// svlCommonApi.assertApiNotFound(body, status);
// expect a rejection because we're not using the internal header
expect(body).toEqual({
statusCode: 400,
Expand Down
Loading

0 comments on commit 6bef580

Please sign in to comment.