Pip: Make the Python version configurable

Add a configuration option to set the Python version to be used for
resolving dependencies. The configured version is now always used and
the guessed version is ignored for resolving dependencies, this allows
further simplications in a later commit.

Signed-off-by: Martin Nonnenmacher <[email protected]>

Author: mnonnenmacher

analyzer/src/funTest/kotlin/managers/PipFunTest.kt

@@ -26,6 +26,7 @@ import java.io.File
 
 import org.ossreviewtoolkit.downloader.VersionControlSystem
 import org.ossreviewtoolkit.model.config.AnalyzerConfiguration
+import org.ossreviewtoolkit.model.config.PackageManagerConfiguration
 import org.ossreviewtoolkit.model.config.RepositoryConfiguration
 import org.ossreviewtoolkit.utils.common.Os
 import org.ossreviewtoolkit.utils.ort.normalizeVcsUrl
@@ -42,7 +43,7 @@ class PipFunTest : WordSpec({
         "resolve setup.py dependencies correctly for spdx-tools-python" {
             val definitionFile = projectsDir.resolve("external/spdx-tools-python/setup.py")
 
-            val result = createPip().resolveSingleProject(definitionFile)
+            val result = createPip(pythonVersion = "2.7").resolveSingleProject(definitionFile)
             val expectedResult = projectsDir.resolve("external/spdx-tools-python-expected-output.yml").readText()
 
             result.toYaml() shouldBe expectedResult
@@ -59,7 +60,7 @@ class PipFunTest : WordSpec({
                 path = vcsPath
             )
 
-            val result = createPip().resolveSingleProject(definitionFile)
+            val result = createPip(pythonVersion = "2.7").resolveSingleProject(definitionFile)
 
             result.toYaml() shouldBe expectedResult
         }
@@ -116,4 +117,14 @@ class PipFunTest : WordSpec({
     }
 })
 
-private fun createPip() = Pip("PIP", USER_DIR, AnalyzerConfiguration(), RepositoryConfiguration())
+private fun createPip(pythonVersion: String = "3.10") =
+    Pip("PIP", USER_DIR, createAnalyzerConfiguration(pythonVersion), RepositoryConfiguration())
+
+private fun createAnalyzerConfiguration(pythonVersion: String) =
+    AnalyzerConfiguration(
+        packageManagers = mapOf(
+            Pip.Factory().managerName to PackageManagerConfiguration(
+                options = mapOf("pythonVersion" to pythonVersion)
+            )
+        )
+    )

analyzer/src/main/kotlin/managers/Pip.kt

@@ -120,6 +120,10 @@ private const val OPTION_OPERATING_SYSTEM = "operatingSystem"
 private const val OPTION_OPERATING_SYSTEM_DEFAULT = "linux"
 private val OPERATING_SYSTEMS = listOf("linux", "mac", "windows")
 
+private const val OPTION_PYTHON_VERSION = "pythonVersion"
+private const val OPTION_PYTHON_VERSION_DEFAULT = "3.10"
+private val PYTHON_VERSIONS = listOf("2.7", "3.6", "3.7", "3.8", "3.9", "3.10")
+
 /**
  * The [PIP](https://pip.pypa.io/) package manager for Python. Also see
  * [install_requires vs requirements files](https://packaging.python.org/discussions/install-requires-vs-requirements/)
@@ -128,6 +132,7 @@ private val OPERATING_SYSTEMS = listOf("linux", "mac", "windows")
  * This package manager supports the following [options][PackageManagerConfiguration.options]:
  * - *operatingSystem*: The name of the operating system to resolve dependencies for. One of "linux", "mac", or
  *   "windows". Defaults to "linux".
+ * - *pythonVersion*: The Python version to resolve dependencies for. Defaults to "3.10".
  */
 @Suppress("TooManyFunctions")
 class Pip(
@@ -157,6 +162,13 @@ class Pip(
             }
         }
 
+    private val pythonVersionOption = (options[OPTION_PYTHON_VERSION] ?: OPTION_PYTHON_VERSION_DEFAULT)
+        .also { pythonVersion ->
+            require(pythonVersion in PYTHON_VERSIONS) {
+                "The 'pythonVersion' option must be one of ${PYTHON_VERSIONS.joinToString { "'$it'" }}."
+            }
+        }
+
     override fun command(workingDir: File?) = "pip"
 
     override fun transformVersion(output: String) = output.removePrefix("pip ").substringBefore(' ')
@@ -193,7 +205,7 @@ class Pip(
         val virtualEnvDir = setupVirtualEnv(workingDir, pythonMajorVersion)
 
         val project = getProjectBasics(definitionFile, virtualEnvDir)
-        val (packages, installDependencies) = getInstallDependencies(definitionFile, pythonMajorVersion)
+        val (packages, installDependencies) = getInstallDependencies(definitionFile)
 
         // TODO: Handle "extras" and "tests" dependencies.
         val scopes = sortedSetOf(
@@ -287,29 +299,20 @@ class Pip(
         )
     }
 
-    private fun getInstallDependencies(
-        definitionFile: File,
-        pythonMajorVersion: Int
-    ): Pair<SortedSet<Package>, SortedSet<PackageReference>> {
+    private fun getInstallDependencies(definitionFile: File): Pair<SortedSet<Package>, SortedSet<PackageReference>> {
         val workingDir = definitionFile.parentFile
 
-        val pythonVersion = when (pythonMajorVersion) {
-            2 -> "2.7" // 2.7 is the only 2.x version supported by python-inspector.
-            3 -> "3.10" // 3.10 is the version currently used in the ORT Docker image.
-            else -> throw IllegalArgumentException("Unsupported Python major version '$pythonMajorVersion'.")
-        }
-
         logger.info {
-            "Resolving dependencies for '${definitionFile.absolutePath}' with Python version '$pythonVersion' and " +
-                    "operating system '$operatingSystemOption'."
+            "Resolving dependencies for '${definitionFile.absolutePath}' with Python version '$pythonVersionOption' " +
+                    "and operating system '$operatingSystemOption'."
         }
 
         val pythonInspectorResult = runCatching {
             try {
                 PythonInspector.run(
                     workingDir = workingDir,
                     definitionFile = definitionFile,
-                    pythonVersion = pythonVersion.replace(".", ""),
+                    pythonVersion = pythonVersionOption.replace(".", ""),
                     operatingSystem = operatingSystemOption
                 )
             } finally {