mirror of
https://github.com/elastic/kibana.git
synced 2025-04-27 03:08:29 -04:00
3a68f8b3ae
fix https://github.com/elastic/kibana/issues/192052 ## Summary Internal APIs will be [restricted](https://github.com/elastic/kibana/issues/163654) from public access as of 9.0.0. In non-serverless environments, this breaking change will result in a 400 error if an external request is made to an internal Kibana API (route `access` option as `"internal"` or `"public"`). This PR allows API owners of non-xpack plugins to run their `ftr` API integration tests against the restriction and adds examples of how to handle it. ### Checklist - [x] [Unit or functional tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html) were updated or added to match the most common scenarios Note to reviewers: The header needed to allow access to internal apis shouldn't change your test output, with or without the restriction enabled. ### How to test the changes work: #### Non x-pack: 1. Set `server.restrictInternalApis: true` in `test/common/config.js` 2. Ensure your tests pass #### x-pack: 1. Set `server.restrictInternalApis: true` in `x-pack/test/api_integration/apis/security/config.ts` 2. Ensure the spaces tests pass --------- Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>
493 lines
17 KiB
TypeScript
493 lines
17 KiB
TypeScript
/*
|
|
* 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", the "GNU Affero General Public License v3.0 only", 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", the "GNU Affero General Public
|
|
* License v3.0 only", or the "Server Side Public License, v 1".
|
|
*/
|
|
|
|
import expect from '@kbn/expect';
|
|
import { schema } from '@kbn/config-schema';
|
|
import { X_ELASTIC_INTERNAL_ORIGIN_REQUEST } from '@kbn/core-http-common';
|
|
import { FtrProviderContext } from '../../ftr_provider_context';
|
|
|
|
export default function ({ getService }: FtrProviderContext) {
|
|
const supertest = getService('supertest');
|
|
const kibanaServer = getService('kibanaServer');
|
|
|
|
const relationSchema = schema.object({
|
|
id: schema.string(),
|
|
type: schema.string(),
|
|
relationship: schema.oneOf([schema.literal('parent'), schema.literal('child')]),
|
|
meta: schema.object({
|
|
title: schema.string(),
|
|
icon: schema.string(),
|
|
editUrl: schema.maybe(schema.string()),
|
|
inAppUrl: schema.object({
|
|
path: schema.string(),
|
|
uiCapabilitiesPath: schema.string(),
|
|
}),
|
|
namespaceType: schema.string(),
|
|
hiddenType: schema.boolean(),
|
|
}),
|
|
});
|
|
const invalidRelationSchema = schema.object({
|
|
id: schema.string(),
|
|
type: schema.string(),
|
|
relationship: schema.oneOf([schema.literal('parent'), schema.literal('child')]),
|
|
error: schema.string(),
|
|
});
|
|
|
|
const responseSchema = schema.object({
|
|
relations: schema.arrayOf(relationSchema),
|
|
invalidRelations: schema.arrayOf(invalidRelationSchema),
|
|
});
|
|
|
|
describe('relationships', () => {
|
|
before(async () => {
|
|
await kibanaServer.importExport.load(
|
|
'test/api_integration/fixtures/kbn_archiver/management/saved_objects/relationships.json'
|
|
);
|
|
});
|
|
after(async () => {
|
|
await kibanaServer.importExport.unload(
|
|
'test/api_integration/fixtures/kbn_archiver/management/saved_objects/relationships.json'
|
|
);
|
|
});
|
|
|
|
const baseApiUrl = `/api/kibana/management/saved_objects/relationships`;
|
|
const defaultTypes = ['visualization', 'index-pattern', 'search', 'dashboard'];
|
|
|
|
const relationshipsUrl = (type: string, id: string, types: string[] = defaultTypes) => {
|
|
const typesQuery = types.map((t) => `savedObjectTypes=${t}`).join('&');
|
|
return `${baseApiUrl}/${type}/${id}?${typesQuery}`;
|
|
};
|
|
|
|
describe('searches', () => {
|
|
it('should validate search response schema', async () => {
|
|
const resp = await supertest
|
|
.get(relationshipsUrl('search', '960372e0-3224-11e8-a572-ffca06da1357'))
|
|
.set(X_ELASTIC_INTERNAL_ORIGIN_REQUEST, 'kibana')
|
|
.expect(200);
|
|
|
|
expect(() => {
|
|
responseSchema.validate(resp.body);
|
|
}).not.to.throwError();
|
|
});
|
|
|
|
it('should work for searches', async () => {
|
|
const resp = await supertest
|
|
.get(relationshipsUrl('search', '960372e0-3224-11e8-a572-ffca06da1357'))
|
|
.set(X_ELASTIC_INTERNAL_ORIGIN_REQUEST, 'kibana')
|
|
.expect(200);
|
|
|
|
expect(resp.body.relations).to.eql([
|
|
{
|
|
id: '8963ca30-3224-11e8-a572-ffca06da1357',
|
|
type: 'index-pattern',
|
|
relationship: 'child',
|
|
meta: {
|
|
title: 'saved_objects*',
|
|
icon: 'indexPatternApp',
|
|
editUrl: '/management/kibana/dataViews/dataView/8963ca30-3224-11e8-a572-ffca06da1357',
|
|
inAppUrl: {
|
|
path: '/app/management/kibana/dataViews/dataView/8963ca30-3224-11e8-a572-ffca06da1357',
|
|
uiCapabilitiesPath: 'management.kibana.indexPatterns',
|
|
},
|
|
namespaceType: 'multiple',
|
|
hiddenType: false,
|
|
},
|
|
},
|
|
{
|
|
id: 'a42c0580-3224-11e8-a572-ffca06da1357',
|
|
type: 'visualization',
|
|
relationship: 'parent',
|
|
meta: {
|
|
title: 'VisualizationFromSavedSearch',
|
|
icon: 'visualizeApp',
|
|
inAppUrl: {
|
|
path: '/app/visualize#/edit/a42c0580-3224-11e8-a572-ffca06da1357',
|
|
uiCapabilitiesPath: 'visualize.show',
|
|
},
|
|
namespaceType: 'multiple-isolated',
|
|
hiddenType: false,
|
|
},
|
|
},
|
|
]);
|
|
});
|
|
|
|
it('should filter based on savedObjectTypes', async () => {
|
|
const resp = await supertest
|
|
.get(
|
|
relationshipsUrl('search', '960372e0-3224-11e8-a572-ffca06da1357', ['visualization'])
|
|
)
|
|
.set(X_ELASTIC_INTERNAL_ORIGIN_REQUEST, 'kibana')
|
|
.expect(200);
|
|
|
|
expect(resp.body.relations).to.eql([
|
|
{
|
|
id: '8963ca30-3224-11e8-a572-ffca06da1357',
|
|
type: 'index-pattern',
|
|
meta: {
|
|
icon: 'indexPatternApp',
|
|
title: 'saved_objects*',
|
|
editUrl: '/management/kibana/dataViews/dataView/8963ca30-3224-11e8-a572-ffca06da1357',
|
|
inAppUrl: {
|
|
path: '/app/management/kibana/dataViews/dataView/8963ca30-3224-11e8-a572-ffca06da1357',
|
|
uiCapabilitiesPath: 'management.kibana.indexPatterns',
|
|
},
|
|
namespaceType: 'multiple',
|
|
hiddenType: false,
|
|
},
|
|
relationship: 'child',
|
|
},
|
|
{
|
|
id: 'a42c0580-3224-11e8-a572-ffca06da1357',
|
|
type: 'visualization',
|
|
meta: {
|
|
icon: 'visualizeApp',
|
|
title: 'VisualizationFromSavedSearch',
|
|
inAppUrl: {
|
|
path: '/app/visualize#/edit/a42c0580-3224-11e8-a572-ffca06da1357',
|
|
uiCapabilitiesPath: 'visualize.show',
|
|
},
|
|
namespaceType: 'multiple-isolated',
|
|
hiddenType: false,
|
|
},
|
|
relationship: 'parent',
|
|
},
|
|
]);
|
|
});
|
|
|
|
it('should return 404 if search finds no results', async () => {
|
|
await supertest
|
|
.get(relationshipsUrl('search', 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx'))
|
|
.set(X_ELASTIC_INTERNAL_ORIGIN_REQUEST, 'kibana')
|
|
.expect(404);
|
|
});
|
|
});
|
|
|
|
describe('dashboards', () => {
|
|
it('should validate dashboard response schema', async () => {
|
|
const resp = await supertest
|
|
.get(relationshipsUrl('dashboard', 'b70c7ae0-3224-11e8-a572-ffca06da1357'))
|
|
.set(X_ELASTIC_INTERNAL_ORIGIN_REQUEST, 'kibana')
|
|
.expect(200);
|
|
|
|
expect(() => {
|
|
responseSchema.validate(resp.body);
|
|
}).not.to.throwError();
|
|
});
|
|
|
|
it('should work for dashboards', async () => {
|
|
const resp = await supertest
|
|
.get(relationshipsUrl('dashboard', 'b70c7ae0-3224-11e8-a572-ffca06da1357'))
|
|
.set(X_ELASTIC_INTERNAL_ORIGIN_REQUEST, 'kibana')
|
|
.expect(200);
|
|
|
|
expect(resp.body.relations).to.eql([
|
|
{
|
|
id: 'add810b0-3224-11e8-a572-ffca06da1357',
|
|
type: 'visualization',
|
|
relationship: 'child',
|
|
meta: {
|
|
icon: 'visualizeApp',
|
|
title: 'Visualization',
|
|
inAppUrl: {
|
|
path: '/app/visualize#/edit/add810b0-3224-11e8-a572-ffca06da1357',
|
|
uiCapabilitiesPath: 'visualize.show',
|
|
},
|
|
namespaceType: 'multiple-isolated',
|
|
hiddenType: false,
|
|
},
|
|
},
|
|
{
|
|
id: 'a42c0580-3224-11e8-a572-ffca06da1357',
|
|
type: 'visualization',
|
|
relationship: 'child',
|
|
meta: {
|
|
icon: 'visualizeApp',
|
|
title: 'VisualizationFromSavedSearch',
|
|
inAppUrl: {
|
|
path: '/app/visualize#/edit/a42c0580-3224-11e8-a572-ffca06da1357',
|
|
uiCapabilitiesPath: 'visualize.show',
|
|
},
|
|
namespaceType: 'multiple-isolated',
|
|
hiddenType: false,
|
|
},
|
|
},
|
|
]);
|
|
});
|
|
|
|
it('should filter based on savedObjectTypes', async () => {
|
|
const resp = await supertest
|
|
.get(relationshipsUrl('dashboard', 'b70c7ae0-3224-11e8-a572-ffca06da1357', ['search']))
|
|
.set(X_ELASTIC_INTERNAL_ORIGIN_REQUEST, 'kibana')
|
|
.expect(200);
|
|
|
|
expect(resp.body.relations).to.eql([
|
|
{
|
|
id: 'add810b0-3224-11e8-a572-ffca06da1357',
|
|
type: 'visualization',
|
|
meta: {
|
|
icon: 'visualizeApp',
|
|
title: 'Visualization',
|
|
inAppUrl: {
|
|
path: '/app/visualize#/edit/add810b0-3224-11e8-a572-ffca06da1357',
|
|
uiCapabilitiesPath: 'visualize.show',
|
|
},
|
|
namespaceType: 'multiple-isolated',
|
|
hiddenType: false,
|
|
},
|
|
relationship: 'child',
|
|
},
|
|
{
|
|
id: 'a42c0580-3224-11e8-a572-ffca06da1357',
|
|
type: 'visualization',
|
|
meta: {
|
|
icon: 'visualizeApp',
|
|
title: 'VisualizationFromSavedSearch',
|
|
inAppUrl: {
|
|
path: '/app/visualize#/edit/a42c0580-3224-11e8-a572-ffca06da1357',
|
|
uiCapabilitiesPath: 'visualize.show',
|
|
},
|
|
namespaceType: 'multiple-isolated',
|
|
hiddenType: false,
|
|
},
|
|
relationship: 'child',
|
|
},
|
|
]);
|
|
});
|
|
|
|
it('should return 404 if dashboard finds no results', async () => {
|
|
await supertest
|
|
.get(relationshipsUrl('dashboard', 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx'))
|
|
.set(X_ELASTIC_INTERNAL_ORIGIN_REQUEST, 'kibana')
|
|
.expect(404);
|
|
});
|
|
});
|
|
|
|
describe('visualizations', () => {
|
|
it('should validate visualization response schema', async () => {
|
|
const resp = await supertest
|
|
.get(relationshipsUrl('visualization', 'a42c0580-3224-11e8-a572-ffca06da1357'))
|
|
.set(X_ELASTIC_INTERNAL_ORIGIN_REQUEST, 'kibana')
|
|
.expect(200);
|
|
|
|
expect(() => {
|
|
responseSchema.validate(resp.body);
|
|
}).not.to.throwError();
|
|
});
|
|
|
|
it('should work for visualizations', async () => {
|
|
const resp = await supertest
|
|
.get(relationshipsUrl('visualization', 'a42c0580-3224-11e8-a572-ffca06da1357'))
|
|
.set(X_ELASTIC_INTERNAL_ORIGIN_REQUEST, 'kibana')
|
|
.expect(200);
|
|
|
|
expect(resp.body.relations).to.eql([
|
|
{
|
|
id: '960372e0-3224-11e8-a572-ffca06da1357',
|
|
type: 'search',
|
|
relationship: 'child',
|
|
meta: {
|
|
icon: 'discoverApp',
|
|
title: 'OneRecord',
|
|
inAppUrl: {
|
|
path: '/app/discover#/view/960372e0-3224-11e8-a572-ffca06da1357',
|
|
uiCapabilitiesPath: 'discover.show',
|
|
},
|
|
namespaceType: 'multiple-isolated',
|
|
hiddenType: false,
|
|
},
|
|
},
|
|
{
|
|
id: 'b70c7ae0-3224-11e8-a572-ffca06da1357',
|
|
type: 'dashboard',
|
|
relationship: 'parent',
|
|
meta: {
|
|
icon: 'dashboardApp',
|
|
title: 'Dashboard',
|
|
inAppUrl: {
|
|
path: '/app/dashboards#/view/b70c7ae0-3224-11e8-a572-ffca06da1357',
|
|
uiCapabilitiesPath: 'dashboard.show',
|
|
},
|
|
namespaceType: 'multiple-isolated',
|
|
hiddenType: false,
|
|
},
|
|
},
|
|
]);
|
|
});
|
|
|
|
it('should filter based on savedObjectTypes', async () => {
|
|
const resp = await supertest
|
|
.get(
|
|
relationshipsUrl('visualization', 'a42c0580-3224-11e8-a572-ffca06da1357', ['search'])
|
|
)
|
|
.set(X_ELASTIC_INTERNAL_ORIGIN_REQUEST, 'kibana')
|
|
.expect(200);
|
|
|
|
expect(resp.body.relations).to.eql([
|
|
{
|
|
id: '960372e0-3224-11e8-a572-ffca06da1357',
|
|
type: 'search',
|
|
meta: {
|
|
icon: 'discoverApp',
|
|
title: 'OneRecord',
|
|
inAppUrl: {
|
|
path: '/app/discover#/view/960372e0-3224-11e8-a572-ffca06da1357',
|
|
uiCapabilitiesPath: 'discover.show',
|
|
},
|
|
namespaceType: 'multiple-isolated',
|
|
hiddenType: false,
|
|
},
|
|
relationship: 'child',
|
|
},
|
|
]);
|
|
});
|
|
|
|
it('should return 404 if visualizations finds no results', async () => {
|
|
await supertest
|
|
.get(relationshipsUrl('visualization', 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx'))
|
|
.set(X_ELASTIC_INTERNAL_ORIGIN_REQUEST, 'kibana')
|
|
.expect(404);
|
|
});
|
|
});
|
|
|
|
describe('index patterns', () => {
|
|
it('should validate index-pattern response schema', async () => {
|
|
const resp = await supertest
|
|
.get(relationshipsUrl('index-pattern', '8963ca30-3224-11e8-a572-ffca06da1357'))
|
|
.set(X_ELASTIC_INTERNAL_ORIGIN_REQUEST, 'kibana')
|
|
.expect(200);
|
|
|
|
expect(() => {
|
|
responseSchema.validate(resp.body);
|
|
}).not.to.throwError();
|
|
});
|
|
|
|
it('should work for index patterns', async () => {
|
|
const resp = await supertest
|
|
.get(relationshipsUrl('index-pattern', '8963ca30-3224-11e8-a572-ffca06da1357'))
|
|
.set(X_ELASTIC_INTERNAL_ORIGIN_REQUEST, 'kibana')
|
|
.expect(200);
|
|
|
|
expect(resp.body.relations).to.eql([
|
|
{
|
|
id: '960372e0-3224-11e8-a572-ffca06da1357',
|
|
type: 'search',
|
|
relationship: 'parent',
|
|
meta: {
|
|
icon: 'discoverApp',
|
|
title: 'OneRecord',
|
|
inAppUrl: {
|
|
path: '/app/discover#/view/960372e0-3224-11e8-a572-ffca06da1357',
|
|
uiCapabilitiesPath: 'discover.show',
|
|
},
|
|
namespaceType: 'multiple-isolated',
|
|
hiddenType: false,
|
|
},
|
|
},
|
|
{
|
|
id: 'add810b0-3224-11e8-a572-ffca06da1357',
|
|
type: 'visualization',
|
|
relationship: 'parent',
|
|
meta: {
|
|
icon: 'visualizeApp',
|
|
title: 'Visualization',
|
|
inAppUrl: {
|
|
path: '/app/visualize#/edit/add810b0-3224-11e8-a572-ffca06da1357',
|
|
uiCapabilitiesPath: 'visualize.show',
|
|
},
|
|
namespaceType: 'multiple-isolated',
|
|
hiddenType: false,
|
|
},
|
|
},
|
|
]);
|
|
});
|
|
|
|
it('should filter based on savedObjectTypes', async () => {
|
|
const resp = await supertest
|
|
.get(
|
|
relationshipsUrl('index-pattern', '8963ca30-3224-11e8-a572-ffca06da1357', ['search'])
|
|
)
|
|
.set(X_ELASTIC_INTERNAL_ORIGIN_REQUEST, 'kibana')
|
|
.expect(200);
|
|
|
|
expect(resp.body.relations).to.eql([
|
|
{
|
|
id: '960372e0-3224-11e8-a572-ffca06da1357',
|
|
type: 'search',
|
|
meta: {
|
|
icon: 'discoverApp',
|
|
title: 'OneRecord',
|
|
inAppUrl: {
|
|
path: '/app/discover#/view/960372e0-3224-11e8-a572-ffca06da1357',
|
|
uiCapabilitiesPath: 'discover.show',
|
|
},
|
|
namespaceType: 'multiple-isolated',
|
|
hiddenType: false,
|
|
},
|
|
relationship: 'parent',
|
|
},
|
|
]);
|
|
});
|
|
|
|
it('should return 404 if index pattern finds no results', async () => {
|
|
await supertest
|
|
.get(relationshipsUrl('index-pattern', 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx'))
|
|
.set(X_ELASTIC_INTERNAL_ORIGIN_REQUEST, 'kibana')
|
|
.expect(404);
|
|
});
|
|
});
|
|
|
|
describe('invalid references', () => {
|
|
it('should validate the response schema', async () => {
|
|
const resp = await supertest
|
|
.get(relationshipsUrl('dashboard', 'invalid-refs'))
|
|
.set(X_ELASTIC_INTERNAL_ORIGIN_REQUEST, 'kibana')
|
|
.expect(200);
|
|
|
|
expect(() => {
|
|
responseSchema.validate(resp.body);
|
|
}).not.to.throwError();
|
|
});
|
|
|
|
it('should return the invalid relations', async () => {
|
|
const resp = await supertest
|
|
.get(relationshipsUrl('dashboard', 'invalid-refs'))
|
|
.set(X_ELASTIC_INTERNAL_ORIGIN_REQUEST, 'kibana')
|
|
.expect(200);
|
|
|
|
expect(resp.body).to.eql({
|
|
invalidRelations: [
|
|
{
|
|
error: 'Saved object [visualization/invalid-vis] not found',
|
|
id: 'invalid-vis',
|
|
relationship: 'child',
|
|
type: 'visualization',
|
|
},
|
|
],
|
|
relations: [
|
|
{
|
|
id: 'add810b0-3224-11e8-a572-ffca06da1357',
|
|
meta: {
|
|
icon: 'visualizeApp',
|
|
inAppUrl: {
|
|
path: '/app/visualize#/edit/add810b0-3224-11e8-a572-ffca06da1357',
|
|
uiCapabilitiesPath: 'visualize.show',
|
|
},
|
|
namespaceType: 'multiple-isolated',
|
|
hiddenType: false,
|
|
title: 'Visualization',
|
|
},
|
|
relationship: 'child',
|
|
type: 'visualization',
|
|
},
|
|
],
|
|
});
|
|
});
|
|
});
|
|
});
|
|
}
|