robojerk/codeql-action

More renaming

Browse source
This commit is contained in:
Andrew Eisenberg 2022-10-11 10:39:40 -07:00
parent 6c869f8b03
commit 701cea34ba
45 changed files with 356 additions and 358 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -30,9 +30,9 @@ for (const variant of ALL_FEATURE_FLAGS_DISABLED_VARIANTS) {
(0, ava_1.default)(`All feature flags are disabled if running against ${variant.description}`, async (t) => {
await (0, util_1.withTmpDir)(async (tmpDir) => {
const loggedMessages = [];
const featureFlags = setUpTests(tmpDir, (0, testing_utils_1.getRecordingLogger)(loggedMessages), variant.gitHubVersion);
const featureEnablement = setUpTests(tmpDir, (0, testing_utils_1.getRecordingLogger)(loggedMessages), variant.gitHubVersion);
for (const flag of Object.values(feature_flags_1.Feature)) {
t.false(await featureFlags.getValue(flag, includeCodeQlIfRequired(flag)));
t.false(await featureEnablement.getValue(flag, includeCodeQlIfRequired(flag)));
}
t.assert(loggedMessages.find((v) => v.type === "debug" &&
v.message ===
@ -43,11 +43,10 @@ for (const variant of ALL_FEATURE_FLAGS_DISABLED_VARIANTS) {
(0, ava_1.default)("API response missing", async (t) => {
await (0, util_1.withTmpDir)(async (tmpDir) => {
const loggedMessages = [];
const featureFlags = setUpTests(tmpDir, (0, testing_utils_1.getRecordingLogger)(loggedMessages));
const featureEnablement = setUpTests(tmpDir, (0, testing_utils_1.getRecordingLogger)(loggedMessages));
(0, testing_utils_1.mockFeatureFlagApiEndpoint)(403, {});
for (const flag of Object.values(feature_flags_1.Feature)) {
t.assert((await featureFlags.getValue(flag, includeCodeQlIfRequired(flag))) ===
false);
t.assert((await featureEnablement.getValue(flag, includeCodeQlIfRequired(flag))) === false);
}
assertAllFeaturesUndefinedInApi(t, loggedMessages);
});
@ -55,100 +54,99 @@ for (const variant of ALL_FEATURE_FLAGS_DISABLED_VARIANTS) {
(0, ava_1.default)("Feature flags are disabled if they're not returned in API response", async (t) => {
await (0, util_1.withTmpDir)(async (tmpDir) => {
const loggedMessages = [];
const featureFlags = setUpTests(tmpDir, (0, testing_utils_1.getRecordingLogger)(loggedMessages));
const featureEnablement = setUpTests(tmpDir, (0, testing_utils_1.getRecordingLogger)(loggedMessages));
(0, testing_utils_1.mockFeatureFlagApiEndpoint)(200, {});
for (const flag of Object.values(feature_flags_1.Feature)) {
t.assert((await featureFlags.getValue(flag, includeCodeQlIfRequired(flag))) ===
false);
t.assert((await featureEnablement.getValue(flag, includeCodeQlIfRequired(flag))) === false);
}
assertAllFeaturesUndefinedInApi(t, loggedMessages);
});
});
(0, ava_1.default)("Feature flags exception is propagated if the API request errors", async (t) => {
await (0, util_1.withTmpDir)(async (tmpDir) => {
const featureFlags = setUpTests(tmpDir);
const featureEnablement = setUpTests(tmpDir);
(0, testing_utils_1.mockFeatureFlagApiEndpoint)(500, {});
await t.throwsAsync(async () => featureFlags.getValue(feature_flags_1.Feature.MlPoweredQueriesEnabled, includeCodeQlIfRequired(feature_flags_1.Feature.MlPoweredQueriesEnabled)), {
await t.throwsAsync(async () => featureEnablement.getValue(feature_flags_1.Feature.MlPoweredQueriesEnabled, includeCodeQlIfRequired(feature_flags_1.Feature.MlPoweredQueriesEnabled)), {
message: "Encountered an error while trying to determine feature enablement: Error: some error message",
});
});
});
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) => {
for (const feature of Object.keys(feature_flags_1.featureConfig)) {
(0, ava_1.default)(`Only feature flag '${feature}' is enabled if enabled in the API response. Other flags disabled`, async (t) => {
await (0, util_1.withTmpDir)(async (tmpDir) => {
const featureFlags = setUpTests(tmpDir);
const featureEnablement = setUpTests(tmpDir);
// set all feature flags to false except the one we're testing
const expectedFeatureFlags = {};
const expectedFeatureEnablement = {};
for (const f of Object.keys(feature_flags_1.featureConfig)) {
expectedFeatureFlags[f] = f === featureFlag;
expectedFeatureEnablement[f] = f === feature;
}
(0, testing_utils_1.mockFeatureFlagApiEndpoint)(200, expectedFeatureFlags);
(0, testing_utils_1.mockFeatureFlagApiEndpoint)(200, expectedFeatureEnablement);
// retrieve the values of the actual feature flags
const actualFeatureFlags = {};
const actualFeatureEnablement = {};
for (const f of Object.keys(feature_flags_1.featureConfig)) {
actualFeatureFlags[f] = await featureFlags.getValue(f, includeCodeQlIfRequired(f));
actualFeatureEnablement[f] = await featureEnablement.getValue(f, includeCodeQlIfRequired(f));
}
// Alls flags should be false except the one we're testing
t.deepEqual(actualFeatureFlags, expectedFeatureFlags);
t.deepEqual(actualFeatureEnablement, expectedFeatureEnablement);
});
});
(0, ava_1.default)(`Only feature flag '${featureFlag}' is enabled if the associated environment variable is true. Others disabled.`, async (t) => {
(0, ava_1.default)(`Only feature flag '${feature}' is enabled if the associated environment variable is true. Others disabled.`, async (t) => {
await (0, util_1.withTmpDir)(async (tmpDir) => {
const featureFlags = setUpTests(tmpDir);
const expectedFeatureFlags = initializeFeatures(false);
(0, testing_utils_1.mockFeatureFlagApiEndpoint)(200, expectedFeatureFlags);
const featureEnablement = setUpTests(tmpDir);
const expectedFeatureEnablement = initializeFeatures(false);
(0, testing_utils_1.mockFeatureFlagApiEndpoint)(200, expectedFeatureEnablement);
// feature flag should be disabled initially
t.assert(!(await featureFlags.getValue(featureFlag, includeCodeQlIfRequired(featureFlag))));
t.assert(!(await featureEnablement.getValue(feature, includeCodeQlIfRequired(feature))));
// set env var to true and check that the feature flag is now enabled
process.env[feature_flags_1.featureConfig[featureFlag].envVar] = "true";
t.assert(await featureFlags.getValue(featureFlag, includeCodeQlIfRequired(featureFlag)));
process.env[feature_flags_1.featureConfig[feature].envVar] = "true";
t.assert(await featureEnablement.getValue(feature, includeCodeQlIfRequired(feature)));
});
});
(0, ava_1.default)(`Feature flag '${featureFlag}' is disabled if the associated environment variable is false, even if enabled in API`, async (t) => {
(0, ava_1.default)(`Feature flag '${feature}' is disabled if the associated environment variable is false, even if enabled in API`, async (t) => {
await (0, util_1.withTmpDir)(async (tmpDir) => {
const featureFlags = setUpTests(tmpDir);
const expectedFeatureFlags = initializeFeatures(true);
(0, testing_utils_1.mockFeatureFlagApiEndpoint)(200, expectedFeatureFlags);
const featureEnablement = setUpTests(tmpDir);
const expectedFeatureEnablement = initializeFeatures(true);
(0, testing_utils_1.mockFeatureFlagApiEndpoint)(200, expectedFeatureEnablement);
// feature flag should be enabled initially
t.assert(await featureFlags.getValue(featureFlag, includeCodeQlIfRequired(featureFlag)));
t.assert(await featureEnablement.getValue(feature, includeCodeQlIfRequired(feature)));
// set env var to false and check that the feature flag is now disabled
process.env[feature_flags_1.featureConfig[featureFlag].envVar] = "false";
t.assert(!(await featureFlags.getValue(featureFlag, includeCodeQlIfRequired(featureFlag))));
process.env[feature_flags_1.featureConfig[feature].envVar] = "false";
t.assert(!(await featureEnablement.getValue(feature, includeCodeQlIfRequired(feature))));
});
});
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) => {
if (feature_flags_1.featureConfig[feature].minimumVersion !== undefined) {
(0, ava_1.default)(`Getting Feature Flag '${feature} should throw if no codeql is provided`, async (t) => {
await (0, util_1.withTmpDir)(async (tmpDir) => {
const featureFlags = setUpTests(tmpDir);
const expectedFeatureFlags = initializeFeatures(true);
(0, testing_utils_1.mockFeatureFlagApiEndpoint)(200, expectedFeatureFlags);
await t.throwsAsync(async () => featureFlags.getValue(featureFlag), {
message: `Internal error: A minimum version is specified for feature ${featureFlag}, but no instance of CodeQL was provided.`,
const featureEnablement = setUpTests(tmpDir);
const expectedFeatureEnablement = initializeFeatures(true);
(0, testing_utils_1.mockFeatureFlagApiEndpoint)(200, expectedFeatureEnablement);
await t.throwsAsync(async () => featureEnablement.getValue(feature), {
message: `Internal error: A minimum version is specified for feature ${feature}, but no instance of CodeQL was provided.`,
});
});
});
}
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) => {
if (feature_flags_1.featureConfig[feature].minimumVersion !== undefined) {
(0, ava_1.default)(`Feature flag '${feature}' is disabled if the minimum CLI version is below ${feature_flags_1.featureConfig[feature].minimumVersion}`, async (t) => {
await (0, util_1.withTmpDir)(async (tmpDir) => {
const featureFlags = setUpTests(tmpDir);
const expectedFeatureFlags = initializeFeatures(true);
(0, testing_utils_1.mockFeatureFlagApiEndpoint)(200, expectedFeatureFlags);
const featureEnablement = setUpTests(tmpDir);
const expectedFeatureEnablement = initializeFeatures(true);
(0, testing_utils_1.mockFeatureFlagApiEndpoint)(200, expectedFeatureEnablement);
// feature flag should be disabled when an old CLI version is set
let codeql = (0, testing_utils_1.mockCodeQLVersion)("2.0.0");
t.assert(!(await featureFlags.getValue(featureFlag, codeql)));
t.assert(!(await featureEnablement.getValue(feature, 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.featureConfig[featureFlag].envVar] = "true";
t.assert(!(await featureFlags.getValue(featureFlag, codeql)));
process.env[feature_flags_1.featureConfig[feature].envVar] = "true";
t.assert(!(await featureEnablement.getValue(feature, codeql)));
// feature flag should be enabled when a new CLI version is set
// and env var is not set
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));
process.env[feature_flags_1.featureConfig[feature].envVar] = "";
codeql = (0, testing_utils_1.mockCodeQLVersion)(feature_flags_1.featureConfig[feature].minimumVersion);
t.assert(await featureEnablement.getValue(feature, codeql));
// set env var to false and check that the feature flag is now disabled
process.env[feature_flags_1.featureConfig[featureFlag].envVar] = "false";
t.assert(!(await featureFlags.getValue(featureFlag, codeql)));
process.env[feature_flags_1.featureConfig[feature].envVar] = "false";
t.assert(!(await featureEnablement.getValue(feature, codeql)));
});
});
}
@ -164,9 +162,9 @@ for (const featureFlag of Object.keys(feature_flags_1.featureConfig)) {
t.assert(Object.values(feature_flags_1.featureConfig).length > 0, "There should be at least one feature flag");
});
function assertAllFeaturesUndefinedInApi(t, loggedMessages) {
for (const featureFlag of Object.keys(feature_flags_1.featureConfig)) {
for (const feature of Object.keys(feature_flags_1.featureConfig)) {
t.assert(loggedMessages.find((v) => v.type === "debug" &&
v.message.includes(featureFlag) &&
v.message.includes(feature) &&
v.message.includes("considering it disabled")) !== undefined);
}
}