Skip to content

Commit

Permalink
Typescriptifying Find
Browse files Browse the repository at this point in the history
  • Loading branch information
@kobelb
kobelb committed Sep 7, 2018
1 parent f707e03 commit f53f2ab
Show file tree
Hide file tree
Showing 4 changed files with 179 additions and 113 deletions.
124 changes: 74 additions & 50 deletions ...ation/common/suites/saved_objects/find.js → ...ation/common/suites/saved_objects/find.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,106 +4,130 @@
* you may not use this file except in compliance with the Elastic License.
*/
import expect from 'expect.js';
import { getIdPrefix, getUrlPrefix } from '../../../common/lib/space_test_utils';
import { DEFAULT_SPACE_ID } from '../../../../../plugins/spaces/common/constants';
import { getIdPrefix, getUrlPrefix } from '../../../common/lib/space_test_utils';
import { DescribeFn, TestDefinitionAuthentication } from '../../../common/lib/types';

interface FindTest {
statusCode: number;
description: string;
response: (resp: any) => void;
}

interface FindTests {
normal: FindTest;
unknownType: FindTest;
pageBeyondTotal: FindTest;
unknownSearchField: FindTest;
noType: FindTest;
}

interface FindTestDefinition {
auth?: TestDefinitionAuthentication;
spaceId?: string;
tests: FindTests;
}

export function findTestSuiteFactory(esArchiver: any, supertest: SuperTest<any>) {
const makeFindTest = (describeFn: DescribeFn) => (
description: string,
definition: FindTestDefinition
) => {
const { auth = {}, spaceId = DEFAULT_SPACE_ID, tests } = definition;

export function findTestSuiteFactory(esArchiver, supertest) {
const makeFindTest = (describeFn) => (description, {
auth = {
username: undefined,
password: undefined,
},
spaceId,
tests
}) => {
describeFn(description, () => {
before(() => esArchiver.load('saved_objects/spaces'));
after(() => esArchiver.unload('saved_objects/spaces'));

it(`should return ${tests.normal.statusCode} with ${tests.normal.description}`, async () => (
it(`should return ${tests.normal.statusCode} with ${tests.normal.description}`, async () =>
await supertest
.get(`${getUrlPrefix(spaceId)}/api/saved_objects/_find?type=visualization&fields=title`)
.auth(auth.username, auth.password)
.expect(tests.normal.statusCode)
.then(tests.normal.response)
));
.then(tests.normal.response));

describe('unknown type', () => {
it(`should return ${tests.unknownType.statusCode} with ${tests.unknownType.description}`, async () => (
it(`should return ${tests.unknownType.statusCode} with ${
tests.unknownType.description
}`, async () =>
await supertest
.get(`${getUrlPrefix(spaceId)}/api/saved_objects/_find?type=wigwags`)
.auth(auth.username, auth.password)
.expect(tests.unknownType.statusCode)
.then(tests.unknownType.response)
));
.then(tests.unknownType.response));
});

describe('page beyond total', () => {
it(`should return ${tests.pageBeyondTotal.statusCode} with ${tests.pageBeyondTotal.description}`, async () => (
it(`should return ${tests.pageBeyondTotal.statusCode} with ${
tests.pageBeyondTotal.description
}`, async () =>
await supertest
.get(`${getUrlPrefix(spaceId)}/api/saved_objects/_find?type=visualization&page=100&per_page=100`)
.get(
`${getUrlPrefix(
spaceId
)}/api/saved_objects/_find?type=visualization&page=100&per_page=100`
)
.auth(auth.username, auth.password)
.expect(tests.pageBeyondTotal.statusCode)
.then(tests.pageBeyondTotal.response)
));
.then(tests.pageBeyondTotal.response));
});

describe('unknown search field', () => {
it(`should return ${tests.unknownSearchField.statusCode} with ${tests.unknownSearchField.description}`, async () => (
it(`should return ${tests.unknownSearchField.statusCode} with ${
tests.unknownSearchField.description
}`, async () =>
await supertest
.get(`${getUrlPrefix(spaceId)}/api/saved_objects/_find?type=wigwags&search_fields=a`)
.auth(auth.username, auth.password)
.expect(tests.unknownSearchField.statusCode)
.then(tests.unknownSearchField.response)
));
.then(tests.unknownSearchField.response));
});

describe('no type', () => {
it(`should return ${tests.noType.statusCode} with ${tests.noType.description}`, async () => (
it(`should return ${tests.noType.statusCode} with ${tests.noType.description}`, async () =>
await supertest
.get(`${getUrlPrefix(spaceId)}/api/saved_objects/_find`)
.auth(auth.username, auth.password)
.expect(tests.noType.statusCode)
.then(tests.noType.response)
));
.then(tests.noType.response));
});
});
};

const findTest = makeFindTest(describe);
findTest.only = makeFindTest(describe.only);

const createExpectEmpty = (page, perPage, total) => (resp) => {
const createExpectEmpty = (page: number, perPage: number, total: number) => (resp: any) => {
expect(resp.body).to.eql({
page: page,
page,
per_page: perPage,
total: total,
saved_objects: []
total,
saved_objects: [],
});
};

const createExpectRbacForbidden = (type) => resp => {
const message = type ?
`Unable to find ${type}, missing action:saved_objects/${type}/find` :
`Not authorized to find saved_object`;
const createExpectRbacForbidden = (type: string) => (resp: any) => {
const message = type
? `Unable to find ${type}, missing action:saved_objects/${type}/find`
: `Not authorized to find saved_object`;

expect(resp.body).to.eql({
statusCode: 403,
error: 'Forbidden',
message
message,
});
};

const createExpectLegacyForbidden = (username) => resp => {
const createExpectLegacyForbidden = (username: string) => (resp: any) => {
expect(resp.body).to.eql({
statusCode: 403,
error: 'Forbidden',
// eslint-disable-next-line max-len
message: `action [indices:data/read/search] is unauthorized for user [${username}]: [security_exception] action [indices:data/read/search] is unauthorized for user [${username}]`
message: `action [indices:data/read/search] is unauthorized for user [${username}]: [security_exception] action [indices:data/read/search] is unauthorized for user [${username}]`,
});
};

const createExpectResults = (spaceId = DEFAULT_SPACE_ID) => (resp) => {
const createExpectResults = (spaceId = DEFAULT_SPACE_ID) => (resp: any) => {
expect(resp.body).to.eql({
page: 1,
per_page: 20,
Expand All @@ -114,43 +138,43 @@ export function findTestSuiteFactory(esArchiver, supertest) {
type: 'index-pattern',
updated_at: '2017-09-21T18:49:16.270Z',
version: 1,
attributes: resp.body.saved_objects[0].attributes
attributes: resp.body.saved_objects[0].attributes,
},
{
id: '7.0.0-alpha1',
type: 'config',
updated_at: '2017-09-21T18:49:16.302Z',
version: 1,
attributes: resp.body.saved_objects[1].attributes
attributes: resp.body.saved_objects[1].attributes,
},
{
id: `${getIdPrefix(spaceId)}dd7caf20-9efd-11e7-acb3-3dab96693fab`,
type: 'visualization',
updated_at: '2017-09-21T18:51:23.794Z',
version: 1,
attributes: resp.body.saved_objects[2].attributes
attributes: resp.body.saved_objects[2].attributes,
},
{
id: `${getIdPrefix(spaceId)}be3733a0-9efe-11e7-acb3-3dab96693fab`,
type: 'dashboard',
updated_at: '2017-09-21T18:57:40.826Z',
version: 1,
attributes: resp.body.saved_objects[3].attributes
attributes: resp.body.saved_objects[3].attributes,
},
{
id: `8121a00-8efd-21e7-1cb3-34ab966434445`,
type: 'globaltype',
updated_at: '2017-09-21T18:59:16.270Z',
version: 1,
attributes: {
'name': 'My favorite global object'
}
}
]
name: 'My favorite global object',
},
},
],
});
};

const createExpectVisualizationResults = (spaceId = DEFAULT_SPACE_ID) => (resp) => {
const createExpectVisualizationResults = (spaceId = DEFAULT_SPACE_ID) => (resp: any) => {
expect(resp.body).to.eql({
page: 1,
per_page: 20,
Expand All @@ -161,10 +185,10 @@ export function findTestSuiteFactory(esArchiver, supertest) {
id: `${getIdPrefix(spaceId)}dd7caf20-9efd-11e7-acb3-3dab96693fab`,
version: 1,
attributes: {
'title': 'Count of requests'
}
title: 'Count of requests',
},
},
]
],
});
};

Expand Down
52 changes: 26 additions & 26 deletions ...ity_and_spaces/apis/saved_objects/find.js → ...ity_and_spaces/apis/saved_objects/find.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,11 @@

import { AUTHENTICATION } from '../../../common/lib/authentication';
import { SPACES } from '../../../common/lib/spaces';
import { TestInvoker } from '../../../common/lib/types';
import { findTestSuiteFactory } from '../../../common/suites/saved_objects/find';

export default function ({ getService }) {
// tslint:disable:no-default-export
export default function({ getService }: TestInvoker) {
const supertest = getService('supertestWithoutAuth');
const esArchiver = getService('esArchiver');

Expand All @@ -22,22 +24,20 @@ export default function ({ getService }) {
findTest,
} = findTestSuiteFactory(esArchiver, supertest);

[{
spaceId: SPACES.DEFAULT.spaceId,
userWithAllAtSpace: AUTHENTICATION.KIBANA_RBAC_DEFAULT_SPACE_ALL_USER,
userWithReadAtSpace: AUTHENTICATION.KIBANA_RBAC_DEFAULT_SPACE_READ_USER,
userWithAllAtOtherSpace: AUTHENTICATION.KIBANA_RBAC_SPACE_1_ALL_USER,
}, {
spaceId: SPACES.SPACE_1.spaceId,
userWithAllAtSpace: AUTHENTICATION.KIBANA_RBAC_SPACE_1_ALL_USER,
userWithReadAtSpace: AUTHENTICATION.KIBANA_RBAC_SPACE_1_READ_USER,
userWithAllAtOtherSpace: AUTHENTICATION.KIBANA_RBAC_DEFAULT_SPACE_ALL_USER,
}].forEach(({
spaceId,
userWithAllAtSpace,
userWithReadAtSpace,
userWithAllAtOtherSpace
}) => {
[
{
spaceId: SPACES.DEFAULT.spaceId,
userWithAllAtSpace: AUTHENTICATION.KIBANA_RBAC_DEFAULT_SPACE_ALL_USER,
userWithReadAtSpace: AUTHENTICATION.KIBANA_RBAC_DEFAULT_SPACE_READ_USER,
userWithAllAtOtherSpace: AUTHENTICATION.KIBANA_RBAC_SPACE_1_ALL_USER,
},
{
spaceId: SPACES.SPACE_1.spaceId,
userWithAllAtSpace: AUTHENTICATION.KIBANA_RBAC_SPACE_1_ALL_USER,
userWithReadAtSpace: AUTHENTICATION.KIBANA_RBAC_SPACE_1_READ_USER,
userWithAllAtOtherSpace: AUTHENTICATION.KIBANA_RBAC_DEFAULT_SPACE_ALL_USER,
},
].forEach(({ spaceId, userWithAllAtSpace, userWithReadAtSpace, userWithAllAtOtherSpace }) => {
describe(`${spaceId} space`, () => {
findTest(AUTHENTICATION.NOT_A_KIBANA_USER.USERNAME, {
auth: {
Expand Down Expand Up @@ -70,8 +70,8 @@ export default function ({ getService }) {
description: `forbidded can't find any types`,
statusCode: 403,
response: createExpectLegacyForbidden(AUTHENTICATION.NOT_A_KIBANA_USER.USERNAME),
}
}
},
},
});

findTest(AUTHENTICATION.SUPERUSER.USERNAME, {
Expand Down Expand Up @@ -176,7 +176,7 @@ export default function ({ getService }) {
statusCode: 200,
response: createExpectResults(spaceId),
},
}
},
});

findTest(AUTHENTICATION.KIBANA_DUAL_PRIVILEGES_USER.USERNAME, {
Expand Down Expand Up @@ -246,7 +246,7 @@ export default function ({ getService }) {
statusCode: 200,
response: createExpectResults(spaceId),
},
}
},
});

findTest(AUTHENTICATION.KIBANA_RBAC_USER.USERNAME, {
Expand Down Expand Up @@ -316,7 +316,7 @@ export default function ({ getService }) {
statusCode: 200,
response: createExpectResults(spaceId),
},
}
},
});

findTest(userWithAllAtSpace.USERNAME, {
Expand Down Expand Up @@ -351,7 +351,7 @@ export default function ({ getService }) {
statusCode: 200,
response: createExpectResults(spaceId),
},
}
},
});

findTest(userWithReadAtSpace.USERNAME, {
Expand Down Expand Up @@ -386,7 +386,7 @@ export default function ({ getService }) {
statusCode: 200,
response: createExpectResults(spaceId),
},
}
},
});

findTest(userWithAllAtOtherSpace.USERNAME, {
Expand Down Expand Up @@ -420,8 +420,8 @@ export default function ({ getService }) {
description: `forbidded can't find any types`,
statusCode: 403,
response: createExpectRbacForbidden(),
}
}
},
},
});
});
});
Expand Down
Loading

0 comments on commit f53f2ab

Please sign in to comment.