feat(conan): Add configurable optional path of a Conan profile

Some Conan projects are not compatible with the default build parameters
passed by ORT. Additionally, some projects maintain an external profile
file to configure the build properties.
This commit adds an extra configuration parameter to the Conan package
manager to allow passing such profile files. This parameter should contain
a relative file path that will be resolved against the analysis root, i.e
"analysisRoot/profilePath".

Signed-off-by: Nicolas Nobelis <[email protected]>

Author: nnobelis

plugins/package-managers/conan/src/main/kotlin/Conan.kt

@@ -96,7 +96,13 @@ data class ConanConfig(
      * development environment.
      */
     @OrtPluginOption(defaultValue = "false")
-    val useConan2: Boolean
+    val useConan2: Boolean,
+
+    /**
+     * The path, relative to the root of the analysis, of a Conan profile to use during dependency resolution.
+     * If not specified, the default profile is used instead.
+     */
+    val conanProfilePath: String?
 )
 
 /**
@@ -215,7 +221,11 @@ class Conan(
                 config.lockfileName?.let { hasLockfile(workingDir.resolve(it).path) } == true
             }
 
-            val handlerResults = handler.process(definitionFile, config.lockfileName)
+            val resolvedProfilePath = config.conanProfilePath?.let { profilePath ->
+                analysisRoot / profilePath
+            }
+
+            val handlerResults = handler.process(definitionFile, config.lockfileName, resolvedProfilePath)
 
             val result = with(handlerResults) {
                 val scopes = setOfNotNull(dependenciesScope, devDependenciesScope, testDependenciesScope)

plugins/package-managers/conan/src/main/kotlin/ConanV1Handler.kt

@@ -47,29 +47,31 @@ internal class ConanV1Handler(private val conan: Conan) : ConanVersionHandler {
 
     override fun getConanStoragePath(): File = getConanHome().resolve("data")
 
-    override fun process(definitionFile: File, lockfileName: String?): HandlerResults {
+    override fun process(definitionFile: File, lockfileName: String?, conanProfile: File?): HandlerResults {
         val workingDir = definitionFile.parentFile
         val jsonFile = createOrtTempDir().resolve("info.json")
-        if (lockfileName != null) {
+
+        val extraArgs = when {
+            conanProfile != null -> arrayOf("-pr", conanProfile.toRelativeString(definitionFile.parentFile))
+
             // Note that none of profile, settings, options, env or conf 'host' can be used with a lockfile.
-            conan.verifyLockfileBelongsToProject(workingDir, lockfileName)
-            conan.command.run(
-                workingDir,
-                "info", definitionFile.name,
-                "-l", lockfileName,
-                "--json", jsonFile.absolutePath
-            ).requireSuccess()
-        } else {
-            conan.command.run(
-                workingDir,
-                "info",
-                definitionFile.name,
-                "--json",
-                jsonFile.absolutePath,
-                *DUMMY_COMPILER_SETTINGS
-            ).requireSuccess()
+            lockfileName != null -> {
+                conan.verifyLockfileBelongsToProject(workingDir, lockfileName)
+                arrayOf("-l", lockfileName)
+            }
+
+            else -> DUMMY_COMPILER_SETTINGS
         }
 
+        conan.command.run(
+            workingDir,
+            "info",
+            definitionFile.name,
+            "--json",
+            jsonFile.absolutePath,
+            *extraArgs
+        ).requireSuccess()
+
         val pkgInfos = parsePackageInfosV1(jsonFile).also { jsonFile.parentFile.safeDeleteRecursively() }
 
         val packageList = removeProjectPackage(pkgInfos, definitionFile.name)

plugins/package-managers/conan/src/main/kotlin/ConanV2Handler.kt

@@ -51,43 +51,42 @@ internal class ConanV2Handler(private val conan: Conan) : ConanVersionHandler {
 
     override fun getConanStoragePath(): File = getConanHome().resolve("p")
 
-    override fun process(definitionFile: File, lockfileName: String?): HandlerResults {
+    override fun process(definitionFile: File, lockfileName: String?, conanProfile: File?): HandlerResults {
         val workingDir = definitionFile.parentFile
 
         // Create a default build profile.
         if (!getConanHome().resolve("profiles/default").isFile) {
             conan.command.run(workingDir, "profile", "detect")
         }
 
+        val extraArgs = buildList {
+            if (conanProfile != null) {
+                add("-pr")
+                add(conanProfile.toRelativeString(definitionFile.parentFile))
+            } else {
+                addAll(DUMMY_COMPILER_SETTINGS)
+            }
+
+            if (lockfileName != null) {
+                conan.verifyLockfileBelongsToProject(workingDir, lockfileName)
+                add("-l")
+                add(lockfileName)
+            }
+        }.toTypedArray()
+
         val jsonFile = createOrtTempDir().resolve("info.json")
-        if (lockfileName != null) {
-            conan.verifyLockfileBelongsToProject(workingDir, lockfileName)
-            conan.command.run(
-                workingDir,
-                "graph",
-                "info",
-                "-f",
-                "json",
-                "-l",
-                lockfileName,
-                "--out-file",
-                jsonFile.absolutePath,
-                *DUMMY_COMPILER_SETTINGS,
-                definitionFile.name
-            ).requireSuccess()
-        } else {
-            conan.command.run(
-                workingDir,
-                "graph",
-                "info",
-                "-f",
-                "json",
-                "--out-file",
-                jsonFile.absolutePath,
-                *DUMMY_COMPILER_SETTINGS,
-                definitionFile.name
-            ).requireSuccess()
-        }
+
+        conan.command.run(
+            workingDir,
+            "graph",
+            "info",
+            "-f",
+            "json",
+            "--out-file",
+            jsonFile.absolutePath,
+            *extraArgs,
+            definitionFile.name
+        ).requireSuccess()
 
         val pkgInfosV2 = parsePackageInfosV2(jsonFile).also { jsonFile.parentFile.safeDeleteRecursively() }
 

plugins/package-managers/conan/src/main/kotlin/ConanVersionHandler.kt

@@ -42,10 +42,10 @@ internal interface ConanVersionHandler {
     fun getConanStoragePath(): File
 
     /**
-     * Resolve the dependencies defined in the [definitionFile] and given the lockfile [lockfileName], and return them
-     * as [HandlerResults].
+     * Resolve the dependencies defined in the [definitionFile], with optional [lockfileName] / [conanProfile], and
+     * return them as [HandlerResults].
      */
-    fun process(definitionFile: File, lockfileName: String?): HandlerResults
+    fun process(definitionFile: File, lockfileName: String?, conanProfile: File?): HandlerResults
 
     /**
      * Get the Conan data file for a package with the given [name] and [version] from the [conanStorageDir]. This file