Skip to content

refactor: Use environments to install Conan #10127

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
+104 −30
Open

refactor: Use environments to install Conan #10127

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
bfb8a2c
refactor(docker): Use environments to install Conan
heliocastro Apr 4, 2025
321ae2a
fix(conan): Adapt the Conan package manager to use the virtual enviro…
nnobelis Apr 10, 2025
6f90359
fix(conan)!: Use a Conan profile named `ort-default` instead of the d…
nnobelis Apr 10, 2025
76b591b
refactor(conan): Remove dummy profile settings
heliocastro Apr 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions plugins/package-managers/conan/src/main/kotlin/Conan.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -222,6 +222,8 @@ class Conan(
config.lockfileName?.let { hasLockfile(workingDir.resolve(it).path) } == true
}

handler.createConanProfileIfNeeded()
Copy link
Member

@sschuberth sschuberth Jun 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Commit message: s/-detect/--detect/


val handlerResults = handler.process(definitionFile, config.lockfileName)

val result = with(handlerResults) {
Expand Down
10 changes: 9 additions & 1 deletion plugins/package-managers/conan/src/main/kotlin/ConanV1Handler.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,12 @@ import org.ossreviewtoolkit.utils.ort.createOrtTempDir
internal class ConanV1Handler(private val conan: Conan) : ConanVersionHandler {
override fun getConanHome(): File = Os.userHomeDirectory.resolve(".conan")

override fun createConanProfileIfNeeded() {
if (!getConanHome().resolve("profiles/ort-default").isFile) {
conan.command.run("profile", "new", "ort-default", "--detect").requireSuccess()
Copy link
Member

@sschuberth sschuberth Jun 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The "ort-default" should only be added to the script in this commit which makes use of it.

}
}

override fun getConanStoragePath(): File = getConanHome().resolve("data")

override fun process(definitionFile: File, lockfileName: String?): HandlerResults {
Expand All @@ -64,7 +70,9 @@ internal class ConanV1Handler(private val conan: Conan) : ConanVersionHandler {
definitionFile.name,
"--json",
jsonFile.absolutePath,
*DUMMY_COMPILER_SETTINGS
*DUMMY_COMPILER_SETTINGS,
"--profile",
"ort-default"
).requireSuccess()
}

Expand Down
15 changes: 10 additions & 5 deletions plugins/package-managers/conan/src/main/kotlin/ConanV2Handler.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,16 +48,17 @@ import org.ossreviewtoolkit.utils.ort.createOrtTempDir
internal class ConanV2Handler(private val conan: Conan) : ConanVersionHandler {
override fun getConanHome(): File = Os.userHomeDirectory.resolve(".conan2")

override fun createConanProfileIfNeeded() {
if (!getConanHome().resolve("profiles/ort-default").isFile) {
conan.command.run("profile", "detect", "--name", "ort-default").requireSuccess()
}
}

override fun getConanStoragePath(): File = getConanHome().resolve("p")

override fun process(definitionFile: File, lockfileName: String?): HandlerResults {
val workingDir = definitionFile.parentFile

// Create a default build profile.
if (!getConanHome().resolve("profiles/default").isFile) {
conan.command.run(workingDir, "profile", "detect")
}

val jsonFile = createOrtTempDir().resolve("info.json")
if (lockfileName != null) {
conan.verifyLockfileBelongsToProject(workingDir, lockfileName)
Expand All @@ -71,6 +72,8 @@ internal class ConanV2Handler(private val conan: Conan) : ConanVersionHandler {
lockfileName,
"--out-file",
jsonFile.absolutePath,
"--profile:all",
"ort-default",
*DUMMY_COMPILER_SETTINGS,
definitionFile.name
).requireSuccess()
Expand All @@ -83,6 +86,8 @@ internal class ConanV2Handler(private val conan: Conan) : ConanVersionHandler {
"json",
"--out-file",
jsonFile.absolutePath,
"--profile:all",
"ort-default",
*DUMMY_COMPILER_SETTINGS,
definitionFile.name
).requireSuccess()
Expand Down
5 changes: 5 additions & 0 deletions plugins/package-managers/conan/src/main/kotlin/ConanVersionHandler.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,11 @@ internal interface ConanVersionHandler {
*/
fun getConanHome(): File

/**
* Create a default ORT Conan profile if it does not exist yet. This profile will contain the complication flags.
*/
fun createConanProfileIfNeeded()

/**
* Get the Conan storage path, i.e. the location where Conan caches downloaded packages.
*/
Expand Down