Create helper isPythonDependencyInstallationDisabled

github · Jan 5, 2024 · 2e27b3c · 2e27b3c
1 parent afef25e
commit 2e27b3c
Show file tree

Hide file tree

Showing 9 changed files with 37 additions and 41 deletions.
diff --git a/lib/analyze.js b/lib/analyze.js
diff --git a/lib/analyze.js.map b/lib/analyze.js.map
diff --git a/lib/feature-flags.js b/lib/feature-flags.js
diff --git a/lib/feature-flags.js.map b/lib/feature-flags.js.map
diff --git a/lib/init-action.js b/lib/init-action.js
diff --git a/lib/init-action.js.map b/lib/init-action.js.map
diff --git a/src/analyze.ts b/src/analyze.ts
@@ -18,6 +18,7 @@ import {
   Feature,
   logCodeScanningConfigInCli,
   useCodeScanningConfigInCli,
+  isPythonDependencyInstallationDisabled,
 } from "./feature-flags";
 import { isScannedLanguage, Language } from "./languages";
 import { Logger } from "./logging";
@@ -104,16 +105,7 @@ async function setupPythonExtractor(
     return;
   }
 
-  if (
-    (await features.getValue(
-      Feature.DisablePythonDependencyInstallationEnabled,
-      codeql,
-    )) ||
-    (await features.getValue(
-      Feature.PythonDefaultIsToSkipDependencyInstallationEnabled,
-      codeql,
-    ))
-  ) {
+  if (await isPythonDependencyInstallationDisabled(codeql, features)) {
     logger.warning(
       "We recommend that you remove the CODEQL_PYTHON environment variable from your workflow. This environment variable was originally used to specify a Python executable that included the dependencies of your Python code, however Python analysis no longer uses these dependencies." +
         "\nIf you used CODEQL_PYTHON to force the version of Python to analyze as, please use CODEQL_EXTRACTOR_PYTHON_ANALYSIS_VERSION instead, such as 'CODEQL_EXTRACTOR_PYTHON_ANALYSIS_VERSION=2.7' or 'CODEQL_EXTRACTOR_PYTHON_ANALYSIS_VERSION=3.11'.",

diff --git a/src/feature-flags.ts b/src/feature-flags.ts
@@ -484,3 +484,19 @@ export async function logCodeScanningConfigInCli(
     );
   }
 }
+
+export async function isPythonDependencyInstallationDisabled(
+  codeql: CodeQL,
+  features: FeatureEnablement,
+): Promise<boolean> {
+  return (
+    (await features.getValue(
+      Feature.DisablePythonDependencyInstallationEnabled,
+      codeql,
+    )) ||
+    (await features.getValue(
+      Feature.PythonDefaultIsToSkipDependencyInstallationEnabled,
+      codeql,
+    ))
+  );
+}
diff --git a/src/init-action.ts b/src/init-action.ts
@@ -16,7 +16,11 @@ import { getGitHubVersion } from "./api-client";
 import { CodeQL } from "./codeql";
 import * as configUtils from "./config-utils";
 import { EnvVar } from "./environment";
-import { Feature, Features } from "./feature-flags";
+import {
+  Feature,
+  Features,
+  isPythonDependencyInstallationDisabled,
+} from "./feature-flags";
 import {
   checkInstallPython311,
   initCodeQL,
@@ -293,16 +297,7 @@ async function run() {
       config.languages.includes(Language.python) &&
       getRequiredInput("setup-python-dependencies") === "true"
     ) {
-      if (
-        (await features.getValue(
-          Feature.DisablePythonDependencyInstallationEnabled,
-          codeql,
-        )) ||
-        (await features.getValue(
-          Feature.PythonDefaultIsToSkipDependencyInstallationEnabled,
-          codeql,
-        ))
-      ) {
+      if (await isPythonDependencyInstallationDisabled(codeql, features)) {
         logger.info("Skipping python dependency installation");
       } else {
         try {
@@ -450,16 +445,7 @@ async function run() {
     }
 
     // Disable Python dependency extraction if feature flag set
-    if (
-      (await features.getValue(
-        Feature.DisablePythonDependencyInstallationEnabled,
-        codeql,
-      )) ||
-      (await features.getValue(
-        Feature.PythonDefaultIsToSkipDependencyInstallationEnabled,
-        codeql,
-      ))
-    ) {
+    if (await isPythonDependencyInstallationDisabled(codeql, features)) {
       core.exportVariable(
         "CODEQL_EXTRACTOR_PYTHON_DISABLE_LIBRARY_EXTRACTION",
         "true",