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

Update DELETE to use template id included in pattern resource instead of relying on a naming convention

Browse source
This commit is contained in:
Matthew Bargar 2015-12-11 18:26:03 -05:00
parent 0397a2f659
commit 6b28312e69
8 changed files with 54 additions and 81 deletions
Download patch file Download diff file Expand all files Collapse all files

31
src/plugins/kibana/server/lib/__tests__/convert_pattern_and_template_name.js
View file

@ -1,31 +0,0 @@
const {templateToPattern, patternToTemplate} = require('../convert_pattern_and_template_name');
const expect = require('expect.js');
describe('convertPatternAndTemplateName', function () {
describe('templateToPattern', function () {
it('should convert an index template\'s name to its matching index pattern\'s title', function () {
expect(templateToPattern('kibana-logstash-*')).to.be('logstash-*');
});
it('should throw an error if the template name isn\'t a valid kibana namespaced name', function () {
expect(templateToPattern).withArgs('logstash-*').to.throwException('not a valid kibana namespaced template name');
expect(templateToPattern).withArgs('').to.throwException(/not a valid kibana namespaced template name/);
});
});
describe('patternToTemplate', function () {
it('should convert an index pattern\'s title to its matching index template\'s name', function () {
expect(patternToTemplate('logstash-*')).to.be('kibana-logstash-*');
});
it('should throw an error if the pattern is empty', function () {
expect(patternToTemplate).withArgs('').to.throwException(/pattern must not be empty/);
});
});
});

22
src/plugins/kibana/server/lib/convert_pattern_and_template_name.js
View file

@ -1,22 +0,0 @@
// To avoid index template naming collisions the index pattern creation API
// namespaces template names by prepending 'kibana-' to the matching pattern's title.
// e.g. a pattern with title `logstash-*` will have a matching template named `kibana-logstash-*`.
// This module provides utility functions for easily converting between template and pattern names.
module.exports = {
templateToPattern: (templateName) => {
if (templateName.indexOf('kibana-') === -1) {
throw new Error('not a valid kibana namespaced template name');
}
return templateName.slice(templateName.indexOf('-') + 1);
},
patternToTemplate: (patternName) => {
if (patternName === '') {
throw new Error('pattern must not be empty');
}
return `kibana-${patternName.toLowerCase()}`;
}
};

53
src/plugins/kibana/server/routes/api/index_patterns/register_delete.js
View file

@ -1,33 +1,52 @@
const Promise = require('bluebird');
const _ = require('lodash');
const handleESError = require('../../../lib/handle_es_error');
const {templateToPattern, patternToTemplate} = require('../../../lib/convert_pattern_and_template_name');
const getIndexPattern = require('./get_index_pattern');
module.exports = function registerDelete(server) {
server.route({
path: '/api/kibana/index_patterns/{id}',
method: 'DELETE',
handler: function (req, reply) {
const callWithRequest = server.plugins.elasticsearch.callWithRequest;
const boundCallWithRequest = _.partial(server.plugins.elasticsearch.callWithRequest, req);
const shouldIncludeTemplate = req.query.include === 'template';
const patternId = req.params.id;
const deletePatternParams = {
index: '.kibana',
type: 'index-pattern',
id: req.params.id
id: patternId
};
Promise.all([
callWithRequest(req, 'delete', deletePatternParams),
callWithRequest(req, 'indices.deleteTemplate', {name: patternToTemplate(req.params.id)})
.catch((error) => {
if (!error.status || error.status !== 404) {
throw error;
}
let result;
if (shouldIncludeTemplate) {
result = getIndexPattern(patternId, boundCallWithRequest)
.then((patternResource) => {
return boundCallWithRequest(
'indices.deleteTemplate',
{name: _.get(patternResource, 'data.relationships.template.data.id')}
)
.catch((error) => {
if (!error.status || error.status !== 404) {
throw error;
}
});
})
])
.then(function (pattern) {
reply('success');
}, function (error) {
reply(handleESError(error));
});
.then(() => {
return boundCallWithRequest('delete', deletePatternParams);
});
}
else {
result = boundCallWithRequest('delete', deletePatternParams);
}
result.then(
function () {
reply('success');
},
function (error) {
reply(handleESError(error));
}
);
}
});
};

1
src/plugins/kibana/server/routes/api/index_patterns/register_post.js
View file

@ -1,6 +1,5 @@
const Boom = require('boom');
const _ = require('lodash');
const {templateToPattern, patternToTemplate} = require('../../../lib/convert_pattern_and_template_name');
const indexPatternSchema = require('../../../lib/schemas/resources/index_pattern_schema');
const handleESError = require('../../../lib/handle_es_error');
const addMappingInfoToPatternFields = require('../../../lib/add_mapping_info_to_pattern_fields');

13
test/unit/api/index_patterns/_del.js
View file

@ -10,17 +10,20 @@ define(function (require) {
bdd.describe('DELETE index_patterns', function deleteIndexPatterns() {
bdd.beforeEach(function () {
return scenarioManager.reload('emptyKibana').then(function () {
return request.post('/kibana/index_patterns').send(createTestData().indexPatternWithTemplate);
return scenarioManager.reload('emptyKibana')
.then(function () {
return request.post('/kibana/index_patterns')
.send(createTestData().indexPatternWithTemplate)
.expect(201);
});
});
bdd.afterEach(function () {
return request.del('/kibana/index_patterns/logstash-*');
return request.del('/kibana/index_patterns/logstash-*?include=template');
});
bdd.it('should return 200 for successful deletion of pattern and template', function () {
return request.del('/kibana/index_patterns/logstash-*')
return request.del('/kibana/index_patterns/logstash-*?include=template')
.expect(200)
.then(function () {
return request.get('/kibana/index_patterns/logstash-*').expect(404);
@ -34,7 +37,7 @@ define(function (require) {
});
bdd.it('should return 404 for a non-existent id', function () {
return request.del('/kibana/index_patterns/doesnotexist')
return request.del('/kibana/index_patterns/doesnotexist?include=template')
.expect(404);
});

6
test/unit/api/index_patterns/_get.js
View file

@ -46,9 +46,9 @@ define(function (require) {
bdd.after(function () {
return Promise.all([
request.del('/kibana/index_patterns/logstash-*'),
request.del('/kibana/index_patterns/foo'),
request.del('/kibana/index_patterns/bar*')
request.del('/kibana/index_patterns/logstash-*?include=template'),
request.del('/kibana/index_patterns/foo?include=template'),
request.del('/kibana/index_patterns/bar*?include=template')
]);
});

7
test/unit/api/index_patterns/_post.js
View file

@ -12,7 +12,7 @@ define(function (require) {
});
bdd.afterEach(function () {
return request.del('/kibana/index_patterns/logstash-*');
return request.del('/kibana/index_patterns/logstash-*?include=template');
});
bdd.it('should return 400 for an invalid payload', function invalidPayload() {
@ -74,6 +74,11 @@ define(function (require) {
return request.post('/kibana/index_patterns')
.send(createTestData().indexPatternWithTemplate)
.expect(409);
})
.then(function () {
return scenarioManager.client.indices.deleteTemplate({
name: 'kibana-logstash-*'
});
});
});

2
test/unit/api/index_patterns/_put.js
View file

@ -15,7 +15,7 @@ define(function (require) {
});
bdd.afterEach(function () {
return request.del('/kibana/index_patterns/logstash-*');
return request.del('/kibana/index_patterns/logstash-*?include=template');
});
bdd.it('should return 200 for a successful update', function () {