1
0
mirror of https://github.com/Unleash/unleash.git synced 2024-12-28 00:06:53 +01:00
unleash.unleash/lib/routes/admin-api/feature.test.js
2021-01-29 09:53:27 +01:00

583 lines
16 KiB
JavaScript

'use strict';
const test = require('ava');
const supertest = require('supertest');
const { EventEmitter } = require('events');
const store = require('../../../test/fixtures/store');
const { createServices } = require('../../services');
const permissions = require('../../../test/fixtures/permissions');
const getLogger = require('../../../test/fixtures/no-logger');
const getApp = require('../../app');
const {
UPDATE_FEATURE,
CREATE_FEATURE,
DELETE_FEATURE,
} = require('../../permissions');
const eventBus = new EventEmitter();
function getSetup() {
const base = `/random${Math.round(Math.random() * 1000)}`;
const stores = store.createStores();
const perms = permissions();
const config = {
baseUriPath: base,
stores,
eventBus,
extendedPermissions: true,
preRouterHook: perms.hook,
getLogger,
};
const services = createServices(stores, config);
const app = getApp(config, services);
return {
base,
perms,
featureToggleStore: stores.featureToggleStore,
eventStore: stores.eventStore,
request: supertest(app),
};
}
test('should get empty getFeatures via admin', t => {
t.plan(1);
const { request, base } = getSetup();
return request
.get(`${base}/api/admin/features`)
.expect('Content-Type', /json/)
.expect(200)
.expect(res => {
t.true(res.body.features.length === 0);
});
});
test('should get one getFeature', t => {
t.plan(1);
const { request, featureToggleStore, base } = getSetup();
featureToggleStore.createFeature({
name: 'test_',
strategies: [{ name: 'default_' }],
});
return request
.get(`${base}/api/admin/features`)
.expect('Content-Type', /json/)
.expect(200)
.expect(res => {
t.true(res.body.features.length === 1);
});
});
test('should add version numbers for /features', t => {
t.plan(1);
const { request, featureToggleStore, base } = getSetup();
featureToggleStore.createFeature({
name: 'test2',
strategies: [{ name: 'default' }],
});
return request
.get(`${base}/api/admin/features`)
.expect('Content-Type', /json/)
.expect(200)
.expect(res => {
t.true(res.body.version === 1);
});
});
test('should require at least one strategy when creating a feature toggle', t => {
t.plan(0);
const { request, base, perms } = getSetup();
perms.withPermissions(CREATE_FEATURE);
return request
.post(`${base}/api/admin/features`)
.send({ name: 'sample.missing.strategy' })
.set('Content-Type', 'application/json')
.expect(400);
});
test('should be allowed to use new toggle name', t => {
t.plan(0);
const { request, base, perms } = getSetup();
perms.withPermissions(CREATE_FEATURE);
return request
.post(`${base}/api/admin/features/validate`)
.send({ name: 'new.name' })
.set('Content-Type', 'application/json')
.expect(200);
});
test('should be allowed to have variants="null"', t => {
t.plan(0);
const { request, base, perms } = getSetup();
perms.withPermissions(CREATE_FEATURE);
return request
.post(`${base}/api/admin/features`)
.send({
name: 'new.name.null',
enabled: false,
strategies: [{ name: 'default' }],
variants: null,
})
.set('Content-Type', 'application/json')
.expect(201);
});
test('should not be allowed to reuse active toggle name', t => {
t.plan(1);
const { request, featureToggleStore, base } = getSetup();
featureToggleStore.createFeature({
name: 'ts',
strategies: [{ name: 'default' }],
});
return request
.post(`${base}/api/admin/features/validate`)
.send({ name: 'ts' })
.set('Content-Type', 'application/json')
.expect(409)
.expect(res => {
t.is(
res.body.details[0].message,
'A toggle with that name already exists',
);
});
});
test('should not be allowed to reuse archived toggle name', t => {
t.plan(1);
const { request, featureToggleStore, base } = getSetup();
featureToggleStore.addArchivedFeature({
name: 'ts.archived',
strategies: [{ name: 'default' }],
});
return request
.post(`${base}/api/admin/features/validate`)
.send({ name: 'ts.archived' })
.set('Content-Type', 'application/json')
.expect(409)
.expect(res => {
t.is(
res.body.details[0].message,
'An archived toggle with that name already exists',
);
});
});
test('should require at least one strategy when updating a feature toggle', t => {
t.plan(0);
const { request, featureToggleStore, base, perms } = getSetup();
perms.withPermissions(UPDATE_FEATURE);
featureToggleStore.createFeature({
name: 'ts',
strategies: [{ name: 'default' }],
});
return request
.put(`${base}/api/admin/features/ts`)
.send({ name: 'ts' })
.set('Content-Type', 'application/json')
.expect(400);
});
test('valid feature names should pass validation', t => {
t.plan(0);
const { request, base, perms } = getSetup();
perms.withPermissions(CREATE_FEATURE);
const validNames = [
'com.example',
'com.exampleFeature',
'com.example-company.feature',
'com.example-company.exampleFeature',
'123',
'com.example-company.someFeature.123',
];
return Promise.all(
validNames.map(name =>
request
.post(`${base}/api/admin/features`)
.send({
name,
enabled: false,
strategies: [{ name: 'default' }],
})
.set('Content-Type', 'application/json')
.expect(201),
),
);
});
test('invalid feature names should not pass validation', t => {
t.plan(0);
const { request, base, perms } = getSetup();
perms.withPermissions(CREATE_FEATURE);
const invalidNames = [
'some example',
'some$example',
'me&me',
' ',
'o2%ae',
];
return Promise.all(
invalidNames.map(name =>
request
.post(`${base}/api/admin/features`)
.send({
name,
enabled: false,
strategies: [{ name: 'default' }],
})
.set('Content-Type', 'application/json')
.expect(400),
),
);
});
// Make sure current UI works. Should align on joi errors in future.
test('invalid feature names should have error msg', t => {
t.plan(1);
const { request, base, perms } = getSetup();
perms.withPermissions(CREATE_FEATURE);
const name = 'ØÆ`';
return request
.post(`${base}/api/admin/features`)
.send({
name,
enabled: false,
strategies: [{ name: 'default' }],
})
.set('Content-Type', 'application/json')
.expect(400)
.expect(res => {
t.true(
res.body.details[0].message === '"name" must be URL friendly',
);
});
});
test('should not allow variants with same name when creating feature flag', t => {
t.plan(0);
const { request, base, perms } = getSetup();
perms.withPermissions(CREATE_FEATURE);
return request
.post(`${base}/api/admin/features`)
.send({
name: 't.variant',
enabled: true,
strategies: [{ name: 'default' }],
variants: [
{ name: 'variant1', weight: 50 },
{ name: 'variant1', weight: 50 },
],
})
.set('Content-Type', 'application/json')
.expect(400);
});
test('should not allow variants with same name when updating feature flag', t => {
t.plan(0);
const { request, featureToggleStore, base, perms } = getSetup();
perms.withPermissions(UPDATE_FEATURE);
featureToggleStore.createFeature({
name: 'ts',
strategies: [{ name: 'default' }],
});
return request
.put(`${base}/api/admin/features/ts`)
.send({
name: 'ts',
strategies: [{ name: 'default' }],
variants: [{ name: 'variant1' }, { name: 'variant1' }],
})
.set('Content-Type', 'application/json')
.expect(400);
});
test('should toggle on', t => {
t.plan(1);
const { request, featureToggleStore, base, perms } = getSetup();
perms.withPermissions(UPDATE_FEATURE);
featureToggleStore.createFeature({
name: 'toggle.disabled',
enabled: false,
strategies: [{ name: 'default' }],
});
return request
.post(`${base}/api/admin/features/toggle.disabled/toggle/on`)
.expect('Content-Type', /json/)
.expect(200)
.expect(res => {
t.true(res.body.enabled === true);
});
});
test('should toggle off', t => {
t.plan(1);
const { request, featureToggleStore, base, perms } = getSetup();
perms.withPermissions(UPDATE_FEATURE);
featureToggleStore.createFeature({
name: 'toggle.enabled',
enabled: true,
strategies: [{ name: 'default' }],
});
return request
.post(`${base}/api/admin/features/toggle.enabled/toggle/off`)
.expect('Content-Type', /json/)
.expect(200)
.expect(res => {
t.true(res.body.enabled === false);
});
});
test('should toggle', t => {
t.plan(1);
const { request, featureToggleStore, base, perms } = getSetup();
perms.withPermissions(UPDATE_FEATURE);
featureToggleStore.createFeature({
name: 'toggle.disabled',
enabled: false,
strategies: [{ name: 'default' }],
});
return request
.post(`${base}/api/admin/features/toggle.disabled/toggle`)
.expect('Content-Type', /json/)
.expect(200)
.expect(res => {
t.true(res.body.enabled === true);
});
});
test('should be able to add tag for feature', t => {
t.plan(0);
const { request, featureToggleStore, base, perms } = getSetup();
perms.withPermissions(UPDATE_FEATURE);
featureToggleStore.createFeature({
name: 'toggle.disabled',
enabled: false,
strategies: [{ name: 'default' }],
});
return request
.post(`${base}/api/admin/features/toggle.disabled/tags`)
.send({
value: 'TeamRed',
type: 'simple',
})
.set('Content-Type', 'application/json')
.expect(201);
});
test('should be able to get tags for feature', t => {
t.plan(1);
const { request, featureToggleStore, base, perms } = getSetup();
perms.withPermissions(UPDATE_FEATURE);
featureToggleStore.createFeature({
name: 'toggle.disabled',
enabled: false,
strategies: [{ name: 'default' }],
});
featureToggleStore.tagFeature('toggle.disabled', {
value: 'TeamGreen',
type: 'simple',
});
return request
.get(`${base}/api/admin/features/toggle.disabled/tags`)
.expect('Content-Type', /json/)
.expect(200)
.expect(res => {
t.is(res.body.tags.length, 1);
});
});
test('Invalid tag for feature should be rejected', t => {
t.plan(1);
const { request, featureToggleStore, base, perms } = getSetup();
perms.withPermissions(UPDATE_FEATURE);
featureToggleStore.createFeature({
name: 'toggle.disabled',
enabled: false,
strategies: [{ name: 'default' }],
});
return request
.post(`${base}/api/admin/features/toggle.disabled/tags`)
.send({
type: 'not url safe',
value: 'some crazy value',
})
.set('Content-Type', 'application/json')
.expect(400)
.expect(res => {
t.is(res.body.details[0].message, '"type" must be URL friendly');
});
});
test('Should be able to filter on tag', t => {
t.plan(2);
const { request, featureToggleStore, base, perms } = getSetup();
perms.withPermissions(UPDATE_FEATURE);
featureToggleStore.createFeature({
name: 'toggle.tagged',
enabled: false,
strategies: [{ name: 'default' }],
});
featureToggleStore.createFeature({
name: 'toggle.untagged',
enabled: false,
strategies: [{ name: 'default' }],
});
featureToggleStore.tagFeature('toggle.tagged', {
type: 'simple',
value: 'mytag',
});
return request
.get(`${base}/api/admin/features?tag=simple:mytag`)
.expect(200)
.expect('Content-Type', /json/)
.expect(res => {
t.is(res.body.features.length, 1);
t.is(res.body.features[0].name, 'toggle.tagged');
});
});
test('Should be able to filter on name prefix', t => {
t.plan(3);
const { request, featureToggleStore, base, perms } = getSetup();
perms.withPermissions(UPDATE_FEATURE);
featureToggleStore.createFeature({
name: 'a_team.toggle',
enabled: false,
strategies: [{ name: 'default' }],
});
featureToggleStore.createFeature({
name: 'a_tag.toggle',
enabled: false,
strategies: [{ name: 'default' }],
});
featureToggleStore.createFeature({
name: 'b_tag.toggle',
enabled: false,
strategies: [{ name: 'default' }],
});
return request
.get(`${base}/api/admin/features?namePrefix=a_`)
.expect(200)
.expect('Content-Type', /json/)
.expect(res => {
t.is(res.body.features.length, 2);
t.is(res.body.features[0].name, 'a_team.toggle');
t.is(res.body.features[1].name, 'a_tag.toggle');
});
});
test('Should be able to filter on project', t => {
t.plan(3);
const { request, featureToggleStore, base, perms } = getSetup();
perms.withPermissions(UPDATE_FEATURE);
featureToggleStore.createFeature({
name: 'a_team.toggle',
enabled: false,
strategies: [{ name: 'default' }],
project: 'projecta',
});
featureToggleStore.createFeature({
name: 'a_tag.toggle',
enabled: false,
strategies: [{ name: 'default' }],
project: 'projecta',
});
featureToggleStore.createFeature({
name: 'b_tag.toggle',
enabled: false,
strategies: [{ name: 'default' }],
project: 'projectb',
});
return request
.get(`${base}/api/admin/features?project=projecta`)
.expect(200)
.expect('Content-Type', /json/)
.expect(res => {
t.is(res.body.features.length, 2);
t.is(res.body.features[0].name, 'a_team.toggle');
t.is(res.body.features[1].name, 'a_tag.toggle');
});
});
test('Tags should be included in archive events', async t => {
const { request, eventStore, featureToggleStore, base, perms } = getSetup();
perms.withPermissions(UPDATE_FEATURE, DELETE_FEATURE);
featureToggleStore.createFeature({
name: 'a_team.toggle',
enabled: false,
strategies: [{ name: 'default' }],
project: 'projecta',
});
featureToggleStore.tagFeature('a_team.toggle', {
type: 'simple',
value: 'tag',
});
await request
.delete(`${base}/api/admin/features/a_team.toggle`)
.expect(200);
const events = await eventStore.getEvents();
t.is(events[0].type, 'feature-archived');
t.is(events[0].tags[0].type, 'simple');
t.is(events[0].tags[0].value, 'tag');
});
test('Tags should be included in updated events', async t => {
const { request, eventStore, featureToggleStore, base, perms } = getSetup();
perms.withPermissions(UPDATE_FEATURE, DELETE_FEATURE);
featureToggleStore.createFeature({
name: 'a_team.toggle',
enabled: false,
strategies: [{ name: 'default' }],
project: 'projecta',
});
featureToggleStore.tagFeature('a_team.toggle', {
type: 'simple',
value: 'tag',
});
await request
.put(`${base}/api/admin/features/a_team.toggle`)
.send({
name: 'a_team.toggle',
enabled: false,
strategies: [{ name: 'default' }],
project: 'projectb',
})
.expect(200);
const events = await eventStore.getEvents();
t.is(events[0].type, 'feature-updated');
t.is(events[0].tags[0].type, 'simple');
t.is(events[0].tags[0].value, 'tag');
});