open-consul/ui/packages/consul-ui/tests/helpers/yadda-annotations.js
John Cowen c24c70af46
ui: Dev/Test environment configurable metrics (#9345)
In order to test certain setups for our metrics visualizations we need to be able to setup several different `ui_config` settings during development/testing. Generally in the UI, we use the Web Inspector to set various cookie values to configure the UI how we need to see it whilst developing, so this PR:

1. Routes `ui_config` through a dev time only `CONSUL_UI_CONFIG` env variable so we can change it via cookies vars.
2. Adds `CONSUL_METRICS_PROXY_ENABLE`, `CONSUL_METRICS_PROVIDER` and `CONSUL_SERVICE_DASHBOARD_URL` so it's easy to set/unset these only values during development.
3. Adds an acceptance testing step so we can setup `ui_config` to whatever we want during testing.
4. Adds an async 'repository-like' method to the `UiConfig` Service so it feels like a repository - incase we ever need to get this via an HTTP API+blocking query.
5. Vaguely unrelated: we allow cookie values to be set via the location.hash whilst in development only e.g. `/ui/services#CONSUL_METRICS_PROXY_ENABLE=1` so we can link to different setups if we ever need to.

All values added here are empty/falsey by default, so in order to see how it was previously you'll need to set the appropriate cookies values, but you can now also easily preview/test the the metrics viz in different/disabled states (with differing `ui_config`)
2020-12-15 15:34:54 +00:00

132 lines
4 KiB
JavaScript

import { skip, test } from 'qunit';
import { setupApplicationTest } from 'ember-qunit';
import Yadda from 'yadda';
import { env } from '../../env';
import api from './api';
import utils from './page';
import dictionary from '../dictionary';
const getDictionary = dictionary(utils);
const staticClassList = [...document.documentElement.classList];
const getCookies = () => {
return Object.fromEntries(document.cookie.split(';').map(item => item.split('=')));
};
const getResetCookies = function() {
const start = getCookies();
return () => {
const startKeys = Object.keys(start);
const endKeys = Object.keys(getCookies());
const diff = endKeys.filter(key => !startKeys.includes(key));
diff.forEach(item => {
document.cookie = `${item}= ; expires=${new Date(0)}`;
});
};
};
let resetCookies;
const reset = function() {
resetCookies();
window.localStorage.clear();
api.server.reset();
const list = document.documentElement.classList;
while (list.length > 0) {
list.remove(list.item(0));
}
staticClassList.forEach(function(item) {
list.add(item);
});
};
const startup = function() {
resetCookies = getResetCookies();
api.server.setCookie('CONSUL_LATENCY', 0);
};
const runTest = function(context, libraries, steps, scenarioContext) {
return new Promise((resolve, reject) => {
Yadda.Yadda(libraries, context).yadda(steps, scenarioContext, function next(err, result) {
if (err) {
reject(err);
}
resolve(result);
});
});
};
const checkAnnotations = function(annotations, isScenario) {
annotations = {
namespaceable: env('CONSUL_NSPACES_ENABLED'),
...annotations,
};
if (annotations.ignore) {
return function(test) {
skip(`${test.title}`, function(assert) {});
};
}
if (isScenario) {
if (env('CONSUL_NSPACES_ENABLED')) {
if (!annotations.notnamespaceable) {
return function(scenario, feature, yadda, yaddaAnnotations, library) {
const stepDefinitions = library.default;
['', 'default', 'team-1', undefined].forEach(function(item) {
test(`Scenario: ${
scenario.title
} with the ${item === '' ? 'empty' : typeof item === 'undefined' ? 'undefined' : item} namespace set`, function(assert) {
const scenarioContext = {
ctx: {
nspace: item,
},
};
const libraries = stepDefinitions({
assert: assert,
utils: utils,
library: Yadda.localisation.English.library(getDictionary(annotations, item)),
});
return runTest(this, libraries, scenario.steps, scenarioContext);
});
});
};
} else {
return function() {};
}
} else {
if (!annotations.onlynamespaceable) {
return function(scenario, feature, yadda, yaddaAnnotations, library) {
const stepDefinitions = library.default;
test(`Scenario: ${scenario.title}`, function(assert) {
const scenarioContext = {
ctx: {},
};
const libraries = stepDefinitions({
assert: assert,
utils: utils,
library: Yadda.localisation.English.library(getDictionary(annotations)),
});
return runTest(this, libraries, scenario.steps, scenarioContext);
});
};
} else {
return function() {};
}
}
}
};
export const setupFeature = function(featureAnnotations) {
return setupApplicationTest;
};
export const setupScenario = function(featureAnnotations, scenarioAnnotations) {
return function(model) {
model.beforeEach(function() {
startup();
});
model.afterEach(function() {
reset();
});
};
};
export const runFeature = function(annotations) {
return checkAnnotations(annotations);
};
export const runScenario = function(featureAnnotations, scenarioAnnotations) {
return checkAnnotations({ ...featureAnnotations, ...scenarioAnnotations }, true);
};