github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-23 17:28:26 -04:00
Code Issues Projects Releases Packages Wiki Activity

[Management] Relationships API test coverage (#19737) (#20788)

Browse source 
* Added coverage around search and dashboard tests.

* Added tests to check for whether the resource is available. If not, return 404.

* Skipped two tests due to https://github.com/elastic/kibana/issues/19713. Added error handling for relationships API for when no result is found. Return 404.

* Applied patch file per PR.

* Applied Chris patch and tested locally. No failures.

* Removed ajv and utilised joi for schema validation.

* Fixed package.json.

* Copied package.json description from master.

* Reverted package.json and made proper edit.
This commit is contained in:
John Dorlus 2018-07-13 15:33:37 -04:00 • committed by GitHub
parent 082f7b6c4f
commit 38c44389cf
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
4 changed files with 203 additions and 105 deletions
Download patch file Download diff file Expand all files Collapse all files

2
src/core_plugins/kibana/server/lib/__tests__/relationships.js
View file

@ -77,6 +77,7 @@ describe('findRelationships', () => {
const size = 10;
const savedObjectsClient = {
get: () => {},
find: () => ({
saved_objects: [
{
@ -202,6 +203,7 @@ describe('findRelationships', () => {
const size = 10;
const savedObjectsClient = {
get: () => {},
find: options => {
if (options.type === 'visualization') {
return {

38
src/core_plugins/kibana/server/lib/management/saved_objects/relationships.js
View file

@ -25,29 +25,34 @@ async function findDashboardRelationships(id, size, savedObjectsClient) {
const panelsJSON = JSON.parse(dashboard.attributes.panelsJSON);
if (panelsJSON) {
const visualizationIds = panelsJSON.map(panel => panel.id);
const visualizationResponse = await savedObjectsClient.bulkGet(visualizationIds.slice(0, size).map(id => ({
id,
type: 'visualization',
})));
const visualizationResponse = await savedObjectsClient.bulkGet(
visualizationIds.slice(0, size).map(id => ({
id,
type: 'visualization',
}))
);
visualizations.push(...visualizationResponse.saved_objects.reduce((accum, object) => {
if (!object.error) {
accum.push({
id: object.id,
title: object.attributes.title,
});
}
return accum;
}, []));
visualizations.push(
...visualizationResponse.saved_objects.reduce((accum, object) => {
if (!object.error) {
accum.push({
id: object.id,
title: object.attributes.title,
});
}
return accum;
}, [])
);
}
return { visualizations };
}
async function findVisualizationRelationships(id, size, savedObjectsClient) {
await savedObjectsClient.get('visualization', id);
const allDashboardsResponse = await savedObjectsClient.find({
type: 'dashboard',
fields: ['title', 'panelsJSON']
fields: ['title', 'panelsJSON'],
});
const dashboards = [];
@ -71,7 +76,6 @@ async function findVisualizationRelationships(id, size, savedObjectsClient) {
break;
}
}
return { dashboards };
}
@ -92,7 +96,7 @@ async function findSavedSearchRelationships(id, size, savedObjectsClient) {
type: 'visualization',
searchFields: ['savedSearchId'],
search: id,
fields: ['title']
fields: ['title'],
});
const visualizations = allVisualizationsResponse.saved_objects.reduce((accum, object) => {
@ -109,6 +113,7 @@ async function findSavedSearchRelationships(id, size, savedObjectsClient) {
}
async function findIndexPatternRelationships(id, size, savedObjectsClient) {
await savedObjectsClient.get('index-pattern', id);
const [allVisualizationsResponse, savedSearchResponse] = await Promise.all([
savedObjectsClient.find({
type: 'visualization',
@ -159,7 +164,6 @@ async function findIndexPatternRelationships(id, size, savedObjectsClient) {
break;
}
}
return { visualizations, searches };
}

20
src/core_plugins/kibana/server/routes/api/management/saved_objects/relationships.js
View file

@ -20,6 +20,7 @@
import Boom from 'boom';
import Joi from 'joi';
import { findRelationships } from '../../../../lib/management/saved_objects/relationships';
import { isNotFoundError } from '../../../../../../../server/saved_objects/service/lib/errors';
export function registerRelationships(server) {
server.route({
@ -33,7 +34,7 @@ export function registerRelationships(server) {
}),
query: Joi.object().keys({
size: Joi.number(),
})
}),
},
},
@ -43,18 +44,15 @@ export function registerRelationships(server) {
const size = req.query.size || 10;
try {
const response = await findRelationships(
type,
id,
size,
req.getSavedObjectsClient(),
);
const response = await findRelationships(type, id, size, req.getSavedObjectsClient());
reply(response);
}
catch (err) {
} catch (err) {
if (isNotFoundError(err)) {
reply(Boom.boomify(new Error('Resource not found'), { statusCode: 404 }));
return;
}
reply(Boom.boomify(err, { statusCode: 500 }));
}
}
},
});
}

248
test/api_integration/apis/management/saved_objects/relationships.js
View file

@ -18,101 +18,195 @@
*/
import expect from 'expect.js';
const Joi = require('joi');
export default function ({ getService }) {
const supertest = getService('supertest');
const esArchiver = getService('esArchiver');
const GENERIC_RESPONSE_SCHEMA = Joi.array().items(
Joi.object().keys({
id: Joi.string()
.uuid()
.required(),
title: Joi.string()
.required()
.min(1),
})
);
describe('relationships', () => {
before(() => esArchiver.load('management/saved_objects'));
after(() => esArchiver.unload('management/saved_objects'));
it('should work for searches', async () => {
await supertest
.get(
`/api/kibana/management/saved_objects/relationships/search/960372e0-3224-11e8-a572-ffca06da1357`
)
.expect(200)
.then(resp => {
expect(resp.body).to.eql({
visualizations: [
{
id: 'a42c0580-3224-11e8-a572-ffca06da1357',
title: 'VisualizationFromSavedSearch',
},
],
indexPatterns: [
{
id: '8963ca30-3224-11e8-a572-ffca06da1357',
title: 'saved_objects*',
},
],
});
});
const SEARCH_RESPONSE_SCHEMA = Joi.object().keys({
visualizations: GENERIC_RESPONSE_SCHEMA,
indexPatterns: GENERIC_RESPONSE_SCHEMA,
});
it('should work for dashboards', async () => {
await supertest
.get(
`/api/kibana/management/saved_objects/relationships/dashboard/b70c7ae0-3224-11e8-a572-ffca06da1357`
)
.expect(200)
.then(resp => {
expect(resp.body).to.eql({
visualizations: [
{
id: 'add810b0-3224-11e8-a572-ffca06da1357',
title: 'Visualization',
},
{
id: 'a42c0580-3224-11e8-a572-ffca06da1357',
title: 'VisualizationFromSavedSearch',
},
],
describe('searches', async () => {
it('should validate search response schema', async () => {
await supertest
.get(`/api/kibana/management/saved_objects/relationships/search/960372e0-3224-11e8-a572-ffca06da1357`)
.expect(200)
.then(resp => {
const validationResult = Joi.validate(resp.body, SEARCH_RESPONSE_SCHEMA);
expect(validationResult.error).to.be(null);
});
});
});
it('should work for searches', async () => {
await supertest
.get(`/api/kibana/management/saved_objects/relationships/search/960372e0-3224-11e8-a572-ffca06da1357`)
.expect(200)
.then(resp => {
expect(resp.body).to.eql({
visualizations: [
{
id: 'a42c0580-3224-11e8-a572-ffca06da1357',
title: 'VisualizationFromSavedSearch',
},
],
indexPatterns: [
{
id: '8963ca30-3224-11e8-a572-ffca06da1357',
title: 'saved_objects*',
},
],
});
});
});
//TODO: https://github.com/elastic/kibana/issues/19713 causes this test to fail.
it.skip('should return 404 if search finds no results', async () => {
await supertest.get(`/api/kibana/management/saved_objects/relationships/search/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx`).expect(404);
});
});
it('should work for visualizations', async () => {
await supertest
.get(
`/api/kibana/management/saved_objects/relationships/visualization/a42c0580-3224-11e8-a572-ffca06da1357`
)
.expect(200)
.then(resp => {
expect(resp.body).to.eql({
dashboards: [
{
id: 'b70c7ae0-3224-11e8-a572-ffca06da1357',
title: 'Dashboard',
},
],
describe('dashboards', async () => {
const DASHBOARD_RESPONSE_SCHEMA = Joi.object().keys({
visualizations: GENERIC_RESPONSE_SCHEMA,
});
it('should validate dashboard response schema', async () => {
await supertest
.get(`/api/kibana/management/saved_objects/relationships/dashboard/b70c7ae0-3224-11e8-a572-ffca06da1357`)
.expect(200)
.then(resp => {
const validationResult = Joi.validate(resp.body, DASHBOARD_RESPONSE_SCHEMA);
expect(validationResult.error).to.be(null);
});
});
});
it('should work for dashboards', async () => {
await supertest
.get(`/api/kibana/management/saved_objects/relationships/dashboard/b70c7ae0-3224-11e8-a572-ffca06da1357`)
.expect(200)
.then(resp => {
expect(resp.body).to.eql({
visualizations: [
{
id: 'add810b0-3224-11e8-a572-ffca06da1357',
title: 'Visualization',
},
{
id: 'a42c0580-3224-11e8-a572-ffca06da1357',
title: 'VisualizationFromSavedSearch',
},
],
});
});
});
//TODO: https://github.com/elastic/kibana/issues/19713 causes this test to fail.
it.skip('should return 404 if dashboard finds no results', async () => {
await supertest
.get(`/api/kibana/management/saved_objects/relationships/dashboard/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx`)
.expect(404);
});
});
it('should work for index patterns', async () => {
await supertest
.get(
`/api/kibana/management/saved_objects/relationships/index-pattern/8963ca30-3224-11e8-a572-ffca06da1357`
)
.expect(200)
.then(resp => {
expect(resp.body).to.eql({
searches: [
{
id: '960372e0-3224-11e8-a572-ffca06da1357',
title: 'OneRecord',
},
],
visualizations: [
{
id: 'add810b0-3224-11e8-a572-ffca06da1357',
title: 'Visualization',
},
],
describe('visualizations', async () => {
const VISUALIZATIONS_RESPONSE_SCHEMA = Joi.object().keys({
dashboards: GENERIC_RESPONSE_SCHEMA,
});
it('should validate visualization response schema', async () => {
await supertest
.get(`/api/kibana/management/saved_objects/relationships/visualization/a42c0580-3224-11e8-a572-ffca06da1357`)
.expect(200)
.then(resp => {
const validationResult = Joi.validate(resp.body, VISUALIZATIONS_RESPONSE_SCHEMA);
expect(validationResult.error).to.be(null);
});
});
});
it('should work for visualizations', async () => {
await supertest
.get(`/api/kibana/management/saved_objects/relationships/visualization/a42c0580-3224-11e8-a572-ffca06da1357`)
.expect(200)
.then(resp => {
expect(resp.body).to.eql({
dashboards: [
{
id: 'b70c7ae0-3224-11e8-a572-ffca06da1357',
title: 'Dashboard',
},
],
});
});
});
it('should return 404 if visualizations finds no results', async () => {
await supertest
.get(`/api/kibana/management/saved_objects/relationships/visualization/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx`)
.expect(404);
});
});
describe('index patterns', async () => {
const INDEX_PATTERN_RESPONSE_SCHEMA = Joi.object().keys({
searches: GENERIC_RESPONSE_SCHEMA,
visualizations: GENERIC_RESPONSE_SCHEMA,
});
it('should validate visualization response schema', async () => {
await supertest
.get(`/api/kibana/management/saved_objects/relationships/index-pattern/8963ca30-3224-11e8-a572-ffca06da1357`)
.expect(200)
.then(resp => {
const validationResult = Joi.validate(resp.body, INDEX_PATTERN_RESPONSE_SCHEMA);
expect(validationResult.error).to.be(null);
});
});
it('should work for index patterns', async () => {
await supertest
.get(`/api/kibana/management/saved_objects/relationships/index-pattern/8963ca30-3224-11e8-a572-ffca06da1357`)
.expect(200)
.then(resp => {
expect(resp.body).to.eql({
searches: [
{
id: '960372e0-3224-11e8-a572-ffca06da1357',
title: 'OneRecord',
},
],
visualizations: [
{
id: 'add810b0-3224-11e8-a572-ffca06da1357',
title: 'Visualization',
},
],
});
});
});
it('should return 404 if index pattern finds no results', async () => {
await supertest
.get(`/api/kibana/management/saved_objects/relationships/index-pattern/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx`)
.expect(404);
});
});
});
}