Pip: Make the operating system configurable

By default, the python-inspector resolves the dependencies for a linux
installation. Add a configuration option to configure which operating
system should be used.

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

Author: mnonnenmacher

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

@@ -40,6 +40,7 @@ import org.ossreviewtoolkit.model.ProjectAnalyzerResult
 import org.ossreviewtoolkit.model.Scope
 import org.ossreviewtoolkit.model.VcsInfo
 import org.ossreviewtoolkit.model.config.AnalyzerConfiguration
+import org.ossreviewtoolkit.model.config.PackageManagerConfiguration
 import org.ossreviewtoolkit.model.config.RepositoryConfiguration
 import org.ossreviewtoolkit.utils.common.CommandLineTool
 import org.ossreviewtoolkit.utils.common.Os
@@ -115,10 +116,18 @@ object PythonVersion : CommandLineTool, Logging {
         }
 }
 
+private const val OPTION_OPERATING_SYSTEM = "operatingSystem"
+private const val OPTION_OPERATING_SYSTEM_DEFAULT = "linux"
+private val OPERATING_SYSTEMS = listOf("linux", "mac", "windows")
+
 /**
  * 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/)
  * and [setup.py vs. requirements.txt](https://caremad.io/posts/2013/07/setup-vs-requirement/).
+ *
+ * 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".
  */
 @Suppress("TooManyFunctions")
 class Pip(
@@ -141,6 +150,13 @@ class Pip(
         ) = Pip(managerName, analysisRoot, analyzerConfig, repoConfig)
     }
 
+    private val operatingSystemOption = (getOptions()[OPTION_OPERATING_SYSTEM] ?: OPTION_OPERATING_SYSTEM_DEFAULT)
+        .also { os ->
+            require(os.isEmpty() || os in OPERATING_SYSTEMS) {
+                "The 'operatingSystem' option must be one of ${OPERATING_SYSTEMS.joinToString { "'$it'" }}."
+            }
+        }
+
     override fun command(workingDir: File?) = "pip"
 
     override fun transformVersion(output: String) = output.removePrefix("pip ").substringBefore(' ')
@@ -284,15 +300,17 @@ class Pip(
         }
 
         logger.info {
-            "Resolving dependencies for '${definitionFile.absolutePath}' with Python version '$pythonVersion'."
+            "Resolving dependencies for '${definitionFile.absolutePath}' with Python version '$pythonVersion' and " +
+                    "operating system '$operatingSystemOption'."
         }
 
         val pythonInspectorResult = runCatching {
             try {
                 PythonInspector.run(
                     workingDir = workingDir,
                     definitionFile = definitionFile,
-                    pythonVersion = pythonVersion.replace(".", "")
+                    pythonVersion = pythonVersion.replace(".", ""),
+                    operatingSystem = operatingSystemOption
                 )
             } finally {
                 workingDir.resolve(".cache").safeDeleteRecursively(force = true)

analyzer/src/main/kotlin/managers/utils/PythonInspector.kt

@@ -54,13 +54,17 @@ internal object PythonInspector : CommandLineTool {
         workingDir: File,
         definitionFile: File,
         pythonVersion: String = "38",
+        operatingSystem: String = "linux"
     ): PythonInspectorResult {
         val outputFile = createOrtTempFile(prefix = "python-inspector", suffix = ".json")
 
         val commandLineOptions = buildList {
             add("--python-version")
             add(pythonVersion)
 
+            add("--operating-system")
+            add(operatingSystem)
+
             add("--json-pdt")
             add(outputFile.absolutePath)