Skip to content

Commit 6de7ce6

Browse files
redsun82redsun82
committed
C++: simplify CppDependencyInstallation interface
1 parent 1dc6288 commit 6de7ce6

7 files changed

+44
-75
lines changed

‎autobuild/action.yml

-11
Original file line numberDiff line numberDiff line change
@@ -12,17 +12,6 @@ inputs:
1212
working directory. If this input is not set, the autobuilder runs with
1313
$GITHUB_WORKSPACE as its working directory.
1414
required: false
15-
cpp-autoinstall-dependencies:
16-
description: >-
17-
Experimental input, the API may change in the future.
18-
Set to true to enable trying to automatically detect and install
19-
dependencies when running the C/C++ autobuilder, set to anything else
20-
to explicitly disable it. This only works when running on Ubuntu and
21-
is automatically disabled otherwise. If this input is not set the
22-
default is currently driven by the cpp_dependency_installation_enabled
23-
feature flag or the CODEQL_CPP_DEPENDENCY_INSTALLATION environment
24-
variable.
25-
required: false
2615
runs:
2716
using: 'node16'
2817
main: '../lib/autobuild-action.js'

‎lib/autobuild.js

+14-22
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎lib/autobuild.js.map

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎lib/feature-flags.js

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎lib/feature-flags.js.map

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎src/autobuild.ts

+26-38
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
import * as core from "@actions/core";
22

3-
import { getOptionalInput, getTemporaryDirectory } from "./actions-util";
3+
import { getTemporaryDirectory } from "./actions-util";
44
import { getGitHubVersion } from "./api-client";
55
import { CodeQL, getCodeQL } from "./codeql";
66
import * as configUtils from "./config-utils";
7-
import { Feature, Features } from "./feature-flags";
7+
import { Feature, featureConfig, Features } from "./feature-flags";
88
import { isTracedLanguage, Language } from "./languages";
99
import { Logger } from "./logging";
1010
import { parseRepositoryNwo } from "./repository";
11-
import { codeQlVersionAbove, getRequiredEnvParam } from "./util";
11+
import { getRequiredEnvParam } from "./util";
1212

1313
export async function determineAutobuildLanguages(
1414
config: configUtils.Config,
@@ -99,46 +99,34 @@ export async function determineAutobuildLanguages(
9999
}
100100

101101
async function setupCppAutobuild(codeql: CodeQL, logger: Logger) {
102-
const envVar = "CODEQL_EXTRACTOR_CPP_AUTOINSTALL_DEPENDENCIES";
103-
const actionInput = getOptionalInput("cpp-autoinstall-dependencies");
102+
const envVar = featureConfig[Feature.CppDependencyInstallation].envVar;
104103
const featureName = "C++ automatic installation of dependencies";
105-
if (actionInput === "true") {
106-
if (!(await codeQlVersionAbove(codeql, "2.15.0"))) {
107-
logger.warning(
108-
`${featureName} was explicitly requested but is only available starting from CodeQL version 2.15.0, disabling it`,
109-
);
104+
const gitHubVersion = await getGitHubVersion();
105+
const repositoryNwo = parseRepositoryNwo(
106+
getRequiredEnvParam("GITHUB_REPOSITORY"),
107+
);
108+
const features = new Features(
109+
gitHubVersion,
110+
repositoryNwo,
111+
getTemporaryDirectory(),
112+
logger,
113+
);
114+
if (await features.getValue(Feature.CppDependencyInstallation, codeql)) {
115+
// disable autoinstall on self-hosted runners unless explicitly requested
116+
if (
117+
process.env["RUNNER_ENVIRONMENT"] === "self-hosted" &&
118+
process.env[envVar] !== "true"
119+
) {
120+
logger.info(`Disabling ${featureName} as we are on a self-hosted runner`);
121+
logger.info(`This can be enabled by setting ${envVar}: true in the env`);
110122
core.exportVariable(envVar, "false");
111123
} else {
112-
logger.info(
113-
`${
114-
actionInput === "true" ? "Enabling" : "Disabling"
115-
} ${featureName} explicitly requested`,
116-
);
117-
core.exportVariable(envVar, actionInput);
118-
}
119-
} else if (process.env["RUNNER_ENVIRONMENT"] === "self-hosted") {
120-
logger.info(
121-
`Disabling ${featureName} which is the default for self-hosted runners`,
122-
);
123-
core.exportVariable(envVar, "false");
124-
} else {
125-
const gitHubVersion = await getGitHubVersion();
126-
const repositoryNwo = parseRepositoryNwo(
127-
getRequiredEnvParam("GITHUB_REPOSITORY"),
128-
);
129-
const features = new Features(
130-
gitHubVersion,
131-
repositoryNwo,
132-
getTemporaryDirectory(),
133-
logger,
134-
);
135-
if (await features.getValue(Feature.CppDependencyInstallation, codeql)) {
136-
logger.info(`Enabling ${featureName}`);
124+
logger.info(`Enabling ${featureName}`);
137125
core.exportVariable(envVar, "true");
138-
} else {
139-
logger.info(`Disabling ${featureName}`);
140-
core.exportVariable(envVar, "false");
141126
}
127+
} else {
128+
logger.info(`Disabling ${featureName}`);
129+
core.exportVariable(envVar, "false");
142130
}
143131
}
144132

‎src/feature-flags.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ export const featureConfig: Record<
7676
defaultValue: false,
7777
},
7878
[Feature.CppDependencyInstallation]: {
79-
envVar: "CODEQL_CPP_DEPENDENCY_INSTALLATION",
79+
envVar: "CODEQL_EXTRACTOR_CPP_AUTOINSTALL_DEPENDENCIES",
8080
minimumVersion: "2.15.0",
8181
defaultValue: false,
8282
},

0 commit comments

Comments
 (0)