robojerk/codeql-action

Rename FeatureFlag -> Feature

Browse source
This commit is contained in:
Andrew Eisenberg 2022-10-06 12:31:08 -07:00
parent b16314e16c
commit 6de05e4b24
24 changed files with 116 additions and 124 deletions
Download patch file Download diff file Expand all files Collapse all files

38
lib/feature-flags.test.js generated
View file

@ -31,7 +31,7 @@ for (const variant of ALL_FEATURE_FLAGS_DISABLED_VARIANTS) {
await (0, util_1.withTmpDir)(async (tmpDir) => {
const loggedMessages = [];
const featureFlags = setUpTests(tmpDir, (0, testing_utils_1.getRecordingLogger)(loggedMessages), variant.gitHubVersion);
for (const flag of Object.values(feature_flags_1.FeatureFlag)) {
for (const flag of Object.values(feature_flags_1.Feature)) {
t.assert((await featureFlags.getValue(flag, includeCodeQlIfRequired(flag))) ===
false);
}
@ -46,7 +46,7 @@ for (const variant of ALL_FEATURE_FLAGS_DISABLED_VARIANTS) {
const loggedMessages = [];
const featureFlags = setUpTests(tmpDir, (0, testing_utils_1.getRecordingLogger)(loggedMessages));
(0, testing_utils_1.mockFeatureFlagApiEndpoint)(403, {});
for (const flag of Object.values(feature_flags_1.FeatureFlag)) {
for (const flag of Object.values(feature_flags_1.Feature)) {
t.assert((await featureFlags.getValue(flag, includeCodeQlIfRequired(flag))) ===
false);
}
@ -58,7 +58,7 @@ for (const variant of ALL_FEATURE_FLAGS_DISABLED_VARIANTS) {
const loggedMessages = [];
const featureFlags = setUpTests(tmpDir, (0, testing_utils_1.getRecordingLogger)(loggedMessages));
(0, testing_utils_1.mockFeatureFlagApiEndpoint)(200, {});
for (const flag of Object.values(feature_flags_1.FeatureFlag)) {
for (const flag of Object.values(feature_flags_1.Feature)) {
t.assert((await featureFlags.getValue(flag, includeCodeQlIfRequired(flag))) ===
false);
}
@ -69,24 +69,24 @@ for (const variant of ALL_FEATURE_FLAGS_DISABLED_VARIANTS) {
await (0, util_1.withTmpDir)(async (tmpDir) => {
const featureFlags = setUpTests(tmpDir);
(0, testing_utils_1.mockFeatureFlagApiEndpoint)(500, {});
await t.throwsAsync(async () => featureFlags.getValue(feature_flags_1.FeatureFlag.MlPoweredQueriesEnabled, includeCodeQlIfRequired(feature_flags_1.FeatureFlag.MlPoweredQueriesEnabled)), {
await t.throwsAsync(async () => featureFlags.getValue(feature_flags_1.Feature.MlPoweredQueriesEnabled, includeCodeQlIfRequired(feature_flags_1.Feature.MlPoweredQueriesEnabled)), {
message: "Encountered an error while trying to load feature flags: Error: some error message",
});
});
});
for (const featureFlag of Object.keys(feature_flags_1.featureFlagConfig)) {
for (const featureFlag of Object.keys(feature_flags_1.featureConfig)) {
(0, ava_1.default)(`Only feature flag '${featureFlag}' is enabled if enabled in the API response. Other flags disabled`, async (t) => {
await (0, util_1.withTmpDir)(async (tmpDir) => {
const featureFlags = setUpTests(tmpDir);
// set all feature flags to false except the one we're testing
const expectedFeatureFlags = {};
for (const f of Object.keys(feature_flags_1.featureFlagConfig)) {
for (const f of Object.keys(feature_flags_1.featureConfig)) {
expectedFeatureFlags[f] = f === featureFlag;
}
(0, testing_utils_1.mockFeatureFlagApiEndpoint)(200, expectedFeatureFlags);
// retrieve the values of the actual feature flags
const actualFeatureFlags = {};
for (const f of Object.keys(feature_flags_1.featureFlagConfig)) {
for (const f of Object.keys(feature_flags_1.featureConfig)) {
actualFeatureFlags[f] = await featureFlags.getValue(f, includeCodeQlIfRequired(f));
}
// Alls flags should be false except the one we're testing
@ -101,7 +101,7 @@ for (const featureFlag of Object.keys(feature_flags_1.featureFlagConfig)) {
// feature flag should be disabled initially
t.assert(!(await featureFlags.getValue(featureFlag, includeCodeQlIfRequired(featureFlag))));
// set env var to true and check that the feature flag is now enabled
process.env[feature_flags_1.featureFlagConfig[featureFlag].envVar] = "true";
process.env[feature_flags_1.featureConfig[featureFlag].envVar] = "true";
t.assert(await featureFlags.getValue(featureFlag, includeCodeQlIfRequired(featureFlag)));
});
});
@ -113,11 +113,11 @@ for (const featureFlag of Object.keys(feature_flags_1.featureFlagConfig)) {
// feature flag should be enabled initially
t.assert(await featureFlags.getValue(featureFlag, includeCodeQlIfRequired(featureFlag)));
// set env var to false and check that the feature flag is now disabled
process.env[feature_flags_1.featureFlagConfig[featureFlag].envVar] = "false";
process.env[feature_flags_1.featureConfig[featureFlag].envVar] = "false";
t.assert(!(await featureFlags.getValue(featureFlag, includeCodeQlIfRequired(featureFlag))));
});
});
if (feature_flags_1.featureFlagConfig[featureFlag].minimumVersion !== undefined) {
if (feature_flags_1.featureConfig[featureFlag].minimumVersion !== undefined) {
(0, ava_1.default)(`Getting Feature Flag '${featureFlag} should throw if no codeql is provided`, async (t) => {
await (0, util_1.withTmpDir)(async (tmpDir) => {
const featureFlags = setUpTests(tmpDir);
@ -129,8 +129,8 @@ for (const featureFlag of Object.keys(feature_flags_1.featureFlagConfig)) {
});
});
}
if (feature_flags_1.featureFlagConfig[featureFlag].minimumVersion !== undefined) {
(0, ava_1.default)(`Feature flag '${featureFlag}' is disabled if the minimum CLI version is below ${feature_flags_1.featureFlagConfig[featureFlag].minimumVersion}`, async (t) => {
if (feature_flags_1.featureConfig[featureFlag].minimumVersion !== undefined) {
(0, ava_1.default)(`Feature flag '${featureFlag}' is disabled if the minimum CLI version is below ${feature_flags_1.featureConfig[featureFlag].minimumVersion}`, async (t) => {
await (0, util_1.withTmpDir)(async (tmpDir) => {
const featureFlags = setUpTests(tmpDir);
const expectedFeatureFlags = initializeFeatures(true);
@ -140,29 +140,29 @@ for (const featureFlag of Object.keys(feature_flags_1.featureFlagConfig)) {
t.assert(!(await featureFlags.getValue(featureFlag, codeql)));
// even setting the env var to true should not enable the feature flag if
// the minimum CLI version is not met
process.env[feature_flags_1.featureFlagConfig[featureFlag].envVar] = "true";
process.env[feature_flags_1.featureConfig[featureFlag].envVar] = "true";
t.assert(!(await featureFlags.getValue(featureFlag, codeql)));
// feature flag should be enabled when a new CLI version is set
// and env var is not set
process.env[feature_flags_1.featureFlagConfig[featureFlag].envVar] = "";
codeql = (0, testing_utils_1.mockCodeQLVersion)(feature_flags_1.featureFlagConfig[featureFlag].minimumVersion);
process.env[feature_flags_1.featureConfig[featureFlag].envVar] = "";
codeql = (0, testing_utils_1.mockCodeQLVersion)(feature_flags_1.featureConfig[featureFlag].minimumVersion);
t.assert(await featureFlags.getValue(featureFlag, codeql));
// set env var to false and check that the feature flag is now disabled
process.env[feature_flags_1.featureFlagConfig[featureFlag].envVar] = "false";
process.env[feature_flags_1.featureConfig[featureFlag].envVar] = "false";
t.assert(!(await featureFlags.getValue(featureFlag, codeql)));
});
});
}
}
function assertAllFeaturesUndefinedInApi(t, loggedMessages) {
for (const featureFlag of Object.keys(feature_flags_1.featureFlagConfig)) {
for (const featureFlag of Object.keys(feature_flags_1.featureConfig)) {
t.assert(loggedMessages.find((v) => v.type === "debug" &&
v.message.includes(featureFlag) &&
v.message.includes("considering it disabled")) !== undefined);
}
}
function initializeFeatures(initialValue) {
return Object.keys(feature_flags_1.featureFlagConfig).reduce((features, key) => {
return Object.keys(feature_flags_1.featureConfig).reduce((features, key) => {
features[key] = initialValue;
return features;
}, {});
@ -172,7 +172,7 @@ function setUpTests(tmpDir, logger = (0, logging_1.getRunnerLogger)(true), gitHu
return new feature_flags_1.GitHubFeatureFlags(gitHubVersion, testApiDetails, testRepositoryNwo, logger);
}
function includeCodeQlIfRequired(featureFlag) {
return feature_flags_1.featureFlagConfig[featureFlag].minimumVersion !== undefined
return feature_flags_1.featureConfig[featureFlag].minimumVersion !== undefined
? (0, testing_utils_1.mockCodeQLVersion)("9.9.9")
: undefined;
}