feat(conan): Add a parameter to analyze projects with Conan 2

nnobelis · sschuberth · commit 7637e0fe49f7 · 2025-03-25T21:17:19.000+01:00
The parameter 'useConan2' of the Conan package manager makes the latter run
the 'conan2' command instead of the 'conan' one. It should be used in a
setup where ORT must be able to scan both Conan 1 and Conan 2 projects, for
instance a CI using the ORT Docker image for compliance check.
This commit makes the `ConanFunTest` successful again.

Signed-off-by: Nicolas Nobelis &lt;nicolas.nobelis@bosch.com&gt;
diff --git a/model/src/main/resources/reference.yml b/model/src/main/resources/reference.yml
@@ -117,11 +117,14 @@ ort:
           disableRegistryCertificateVerification: false
 
       Conan:
-        # Holds a name of the lockfile. Required if allowDynamicVersions = false.
-        # The lockfile should be located in the same directory as the conanfile.py or conanfile.txt.
         options:
+          # Holds a name of the lockfile. Required if allowDynamicVersions = false.
+          # The lockfile should be located in the same directory as the conanfile.py or conanfile.txt.
           lockfileName: "lockfile.lock"
 
+          # If true, the Conan package manager with call a command called "conan2" instead of "conan".
+          useConan2: true
+
   advisor:
     # A flag to control whether excluded scopes and paths should be skipped when giving the advice.
     skipExcluded: true
diff --git a/plugins/package-managers/conan/src/funTest/kotlin/ConanFunTest.kt b/plugins/package-managers/conan/src/funTest/kotlin/ConanFunTest.kt
@@ -30,9 +30,8 @@ import org.ossreviewtoolkit.utils.test.matchExpectedResult
 import org.ossreviewtoolkit.utils.test.patchActualResult
 
 /**
- * This test class performs tests with both Conan 1 and Conan 2.
- * TODO: In the current state, both Conan version 2 cannot be run at the same time, because the package manager only
- *  uses one "conan" command.
+ * This test class performs tests with both Conan 1 and Conan 2. For it to be successful, it needs both a "conan"
+ * command for Conan 1 and a "conan2" command for Conan 2 in the PATH environment variable (as in ORT Docker image).
  *
  * A word of caution about Conan 2 tests: If there is no lockfile, when Conan resolves the dependencies it read its
  * cache and relies on the package name, ignoring the version. This means, for instance, that if a test reported
@@ -79,7 +78,8 @@ class ConanFunTest : StringSpec({
         val definitionFile = getAssetFile("projects/synthetic/conan-txt/conanfile.txt")
         val expectedResultFile = getAssetFile("projects/synthetic/conan2-expected-output-txt.yml")
 
-        val result = ConanFactory.create().resolveSingleProject(definitionFile, allowDynamicVersions = true)
+        val result = ConanFactory.create(useConan2 = true)
+            .resolveSingleProject(definitionFile, allowDynamicVersions = true)
 
         patchActualResult(result.toYaml()) should matchExpectedResult(expectedResultFile, definitionFile)
     }
@@ -89,7 +89,8 @@ class ConanFunTest : StringSpec({
         val definitionFile = getAssetFile("projects/synthetic/conan-py/conanfile.py")
         val expectedResultFile = getAssetFile("projects/synthetic/conan2-expected-output-py.yml")
 
-        val result = ConanFactory.create().resolveSingleProject(definitionFile, allowDynamicVersions = true)
+        val result = ConanFactory.create(useConan2 = true)
+            .resolveSingleProject(definitionFile, allowDynamicVersions = true)
 
         patchActualResult(result.toYaml()) should matchExpectedResult(expectedResultFile, definitionFile)
     }
@@ -101,7 +102,7 @@ class ConanFunTest : StringSpec({
         val definitionFile = getAssetFile("projects/synthetic/conan-py-lockfile/conanfile.py")
         val expectedResultFile = getAssetFile("projects/synthetic/conan-expected-output-py-lockfile.yml")
 
-        val result = ConanFactory.create(lockfileName = "lockfile_conan2.lock")
+        val result = ConanFactory.create(lockfileName = "lockfile_conan2.lock", useConan2 = true)
             .resolveSingleProject(definitionFile)
 
         patchActualResult(result.toYaml()) should matchExpectedResult(expectedResultFile, definitionFile)
diff --git a/plugins/package-managers/conan/src/main/kotlin/Conan.kt b/plugins/package-managers/conan/src/main/kotlin/Conan.kt
@@ -52,6 +52,7 @@ import org.ossreviewtoolkit.model.VcsInfo
 import org.ossreviewtoolkit.model.config.AnalyzerConfiguration
 import org.ossreviewtoolkit.model.config.Excludes
 import org.ossreviewtoolkit.plugins.api.OrtPlugin
+import org.ossreviewtoolkit.plugins.api.OrtPluginOption
 import org.ossreviewtoolkit.plugins.api.PluginDescriptor
 import org.ossreviewtoolkit.utils.common.CommandLineTool
 import org.ossreviewtoolkit.utils.common.masked
@@ -65,8 +66,8 @@ import org.ossreviewtoolkit.utils.ort.requestPasswordAuthentication
 import org.semver4j.RangesList
 import org.semver4j.RangesListFactory
 
-internal object ConanCommand : CommandLineTool {
-    override fun command(workingDir: File?) = "conan"
+internal class ConanCommand(private val useConan2: Boolean = false) : CommandLineTool {
+    override fun command(workingDir: File?) = if (useConan2) "conan2" else "conan"
 
     override fun transformVersion(output: String) =
         // Conan could report version strings like:
@@ -84,7 +85,15 @@ data class ConanConfig(
      * The name of the lockfile, which is used for analysis if allowDynamicVersions is set to false. The lockfile should
      * be located in the analysis root. Currently only one lockfile is supported per Conan project.
      */
-    val lockfileName: String?
+    val lockfileName: String?,
+
+    /**
+     * If true, the Conan package manager will call a command called "conan2" instead of "conan". This is required to
+     * be able to support both Conan major versions in a given environment e.g., the ORT Docker image or a local
+     * development environment.
+     */
+    @OrtPluginOption(defaultValue = "false")
+    val useConan2: Boolean
 )
 
 /**
@@ -113,10 +122,12 @@ class Conan(
         internal const val SCOPE_NAME_DEV_DEPENDENCIES = "build_requires"
     }
 
+    internal val command by lazy { ConanCommand(config.useConan2) }
+
     override val globsForDefinitionFiles = listOf("conanfile*.txt", "conanfile*.py")
 
     private val handler by lazy {
-        if (ConanCommand.getVersion().startsWith("1.")) {
+        if (command.getVersion().startsWith("1.")) {
             ConanV1Handler(this)
         } else {
             ConanV2Handler(this)
@@ -140,7 +151,7 @@ class Conan(
         analysisRoot: File,
         definitionFiles: List<File>,
         analyzerConfig: AnalyzerConfiguration
-    ) = ConanCommand.checkVersion()
+    ) = command.checkVersion()
 
     /**
      * Primary method for resolving dependencies from [definitionFile].
@@ -219,7 +230,7 @@ class Conan(
     private fun configureRemoteAuthentication(conanConfig: File?) {
         // Install configuration from a local directory if available.
         conanConfig?.let {
-            ConanCommand.run("config", "install", it.absolutePath).requireSuccess()
+            command.run("config", "install", it.absolutePath).requireSuccess()
         }
 
         val remotes = handler.listRemotes()
@@ -237,7 +248,7 @@ class Conan(
                 if (auth != null) {
                     // Configure Conan's authentication based on ORT's authentication for the remote.
                     runCatching {
-                        ConanCommand.run(
+                        command.run(
                             "user",
                             "-r", remoteName,
                             "-p", String(auth.password).masked(),
diff --git a/plugins/package-managers/conan/src/main/kotlin/ConanV1Handler.kt b/plugins/package-managers/conan/src/main/kotlin/ConanV1Handler.kt
@@ -51,14 +51,14 @@ internal class ConanV1Handler(private val conan: Conan) : ConanVersionHandler {
         val jsonFile = createOrtTempDir().resolve("info.json")
         if (lockfileName != null) {
             conan.verifyLockfileBelongsToProject(workingDir, lockfileName)
-            ConanCommand.run(
+            conan.command.run(
                 workingDir,
                 "info", definitionFile.name,
                 "-l", lockfileName,
                 "--json", jsonFile.absolutePath
             ).requireSuccess()
         } else {
-            ConanCommand.run(
+            conan.command.run(
                 workingDir,
                 "info",
                 definitionFile.name,
@@ -92,7 +92,7 @@ internal class ConanV1Handler(private val conan: Conan) : ConanVersionHandler {
 
     override fun listRemotes(): List<Pair<String, String>> {
         val remoteList = runCatching {
-            ConanCommand.run("remote", "list", "--raw").requireSuccess()
+            conan.command.run("remote", "list", "--raw").requireSuccess()
         }.getOrElse {
             logger.warn { "Failed to list remotes." }
             return emptyList()
@@ -116,7 +116,7 @@ internal class ConanV1Handler(private val conan: Conan) : ConanVersionHandler {
     }
 
     override fun runInspectCommand(workingDir: File, pkgName: String, jsonFile: File) {
-        ConanCommand.run(workingDir, "inspect", pkgName, "--json", jsonFile.absolutePath).requireSuccess()
+        conan.command.run(workingDir, "inspect", pkgName, "--json", jsonFile.absolutePath).requireSuccess()
     }
 
     /**
diff --git a/plugins/package-managers/conan/src/main/kotlin/ConanV2Handler.kt b/plugins/package-managers/conan/src/main/kotlin/ConanV2Handler.kt
@@ -53,13 +53,13 @@ internal class ConanV2Handler(private val conan: Conan) : ConanVersionHandler {
 
         // Create a default build profile.
         if (!getConanHome().resolve("profiles/default").isFile) {
-            ConanCommand.run(workingDir, "profile", "detect")
+            conan.command.run(workingDir, "profile", "detect")
         }
 
         val jsonFile = createOrtTempDir().resolve("info.json")
         if (lockfileName != null) {
             conan.verifyLockfileBelongsToProject(workingDir, lockfileName)
-            ConanCommand.run(
+            conan.command.run(
                 workingDir,
                 "graph",
                 "info",
@@ -73,7 +73,7 @@ internal class ConanV2Handler(private val conan: Conan) : ConanVersionHandler {
                 definitionFile.name
             ).requireSuccess()
         } else {
-            ConanCommand.run(
+            conan.command.run(
                 workingDir,
                 "graph",
                 "info",
@@ -111,7 +111,7 @@ internal class ConanV2Handler(private val conan: Conan) : ConanVersionHandler {
     override fun listRemotes(): List<Pair<String, String>> {
         val remoteList = runCatching {
             // List configured remotes in JSON format.
-            ConanCommand.run("remote", "list", "-f", "json").requireSuccess()
+            conan.command.run("remote", "list", "-f", "json").requireSuccess()
         }.getOrElse {
             logger.warn { "Failed to list remotes." }
             return emptyList()
@@ -134,15 +134,15 @@ internal class ConanV2Handler(private val conan: Conan) : ConanVersionHandler {
             pkgName
         } else {
             // For Conan 2, "conan inspect" need the path of the reference. See https://github.com/conan-io/conan/issues/12532.
-            ConanCommand.run(
+            conan.command.run(
                 workingDir,
                 "cache",
                 "path",
                 pkgName
             ).requireSuccess().stdout.trim()
         }
 
-        ConanCommand.run(
+        conan.command.run(
             workingDir,
             "inspect",
             path,
