add option for Pkg.build to allow_reresolve=false (#3329)

Author: IanButterworth

CHANGELOG.md

@@ -2,6 +2,7 @@ Pkg v1.13 Release Notes
 =======================
 
 - Project.toml environments now support a `readonly` field to mark environments as read-only, preventing modifications. ([#4284])
+- `Pkg.build` now supports an `allow_reresolve` keyword argument to control whether the build process can re-resolve package versions, similar to the existing option for `Pkg.test`. ([#3329])
 - Packages are now automatically added to `[sources]` when they are added by url or devved.
 
 Pkg v1.12 Release Notes

src/API.jl

@@ -1118,7 +1118,7 @@ function gc(ctx::Context=Context(); collect_delay::Period=Day(7), verbose=false,
     return
 end
 
-function build(ctx::Context, pkgs::Vector{PackageSpec}; verbose=false, kwargs...)
+function build(ctx::Context, pkgs::Vector{PackageSpec}; verbose=false, allow_reresolve::Bool=true, kwargs...)
     Context!(ctx; kwargs...)
 
     if isempty(pkgs)
@@ -1133,7 +1133,7 @@ function build(ctx::Context, pkgs::Vector{PackageSpec}; verbose=false, kwargs...
     project_resolve!(ctx.env, pkgs)
     manifest_resolve!(ctx.env.manifest, pkgs)
     ensure_resolved(ctx, ctx.env.manifest, pkgs)
-    Operations.build(ctx, Set{UUID}(pkg.uuid for pkg in pkgs), verbose)
+    Operations.build(ctx, Set{UUID}(pkg.uuid for pkg in pkgs), verbose; allow_reresolve)
 end
 
 function get_or_make_pkgspec(pkgspecs::Vector{PackageSpec}, ctx::Context, uuid)

src/Operations.jl

@@ -1312,12 +1312,12 @@ function any_package_not_installed(manifest::Manifest)
     return false
 end
 
-function build(ctx::Context, uuids::Set{UUID}, verbose::Bool)
+function build(ctx::Context, uuids::Set{UUID}, verbose::Bool; allow_reresolve::Bool=true)
     if any_package_not_installed(ctx.env.manifest) || !isfile(ctx.env.manifest_file)
         Pkg.instantiate(ctx, allow_build = false, allow_autoprecomp = false)
     end
     all_uuids = get_deps(ctx.env, uuids)
-    build_versions(ctx, all_uuids; verbose)
+    build_versions(ctx, all_uuids; verbose, allow_reresolve)
 end
 
 function dependency_order_uuids(env::EnvCache, uuids::Vector{UUID})::Dict{UUID,Int}
@@ -1377,7 +1377,7 @@ pkg_scratchpath() = joinpath(depots1(), "scratchspaces", PkgUUID)
 
 builddir(source_path::String) = joinpath(source_path, "deps")
 buildfile(source_path::String) = joinpath(builddir(source_path), "build.jl")
-function build_versions(ctx::Context, uuids::Set{UUID}; verbose=false)
+function build_versions(ctx::Context, uuids::Set{UUID}; verbose=false, allow_reresolve::Bool=true)
     # collect builds for UUIDs with `deps/build.jl` files
     builds = Tuple{UUID,String,String,VersionNumber}[]
     for uuid in uuids
@@ -1459,7 +1459,7 @@ function build_versions(ctx::Context, uuids::Set{UUID}; verbose=false)
         fancyprint && show_progress(ctx.io, bar)
 
         let log_file=log_file
-            sandbox(ctx, pkg, builddir(source_path), build_project_override; preferences=build_project_preferences) do
+            sandbox(ctx, pkg, builddir(source_path), build_project_override; preferences=build_project_preferences, allow_reresolve) do
                 flush(ctx.io)
                 ok = open(log_file, "w") do log
                     std = verbose ? ctx.io : log

src/Pkg.jl

@@ -366,14 +366,22 @@ const gc = API.gc
     Pkg.build(pkg::Union{String, Vector{String}}; verbose = false, io::IO=stderr)
     Pkg.build(pkgs::Union{PackageSpec, Vector{PackageSpec}}; verbose = false, io::IO=stderr)
 
+**Keyword arguments:**
+  - `verbose::Bool=false`: print the build output to `stdout`/`stderr` instead of redirecting to the `build.log` file.
+  - `allow_reresolve::Bool=true`: allow Pkg to reresolve the package versions in the build environment
+
+!!! compat "Julia 1.13"
+    `allow_reresolve` requires at least Julia 1.13.
+
 Run the build script in `deps/build.jl` for `pkg` and all of its dependencies in
 depth-first recursive order.
 If no argument is given to `build`, the current project is built, which thus needs
 to be a package.
 This function is called automatically on any package that gets installed
 for the first time.
-`verbose = true` prints the build output to `stdout`/`stderr` instead of
-redirecting to the `build.log` file.
+
+The build takes place in a new process matching the current process with default of `startup-file=no`.
+If using the startup file (`~/.julia/config/startup.jl`) is desired, start julia with an explicit `--startup-file=yes`.
 """
 const build = API.build
 

test/api.jl

@@ -313,4 +313,33 @@ end
     end end
 end
 
+@testset "allow_reresolve parameter" begin
+    isolate(loaded_depot=false) do; mktempdir() do tempdir
+        Pkg.Registry.add(url = "https://github.com/JuliaRegistries/Test")
+        # AllowReresolveTest has Example v0.5.1 which is yanked in the test registry.
+        test_dir = joinpath(tempdir, "AllowReresolveTest")
+
+        # Test that we can build and test with allow_reresolve=true
+        copy_test_package(tempdir, "AllowReresolveTest")
+        Pkg.activate(joinpath(tempdir, "AllowReresolveTest"))
+        @test Pkg.build(; allow_reresolve=true) == nothing
+
+        rm(test_dir, force=true, recursive=true)
+        copy_test_package(tempdir, "AllowReresolveTest")
+        Pkg.activate(joinpath(tempdir, "AllowReresolveTest"))
+        @test Pkg.test(; allow_reresolve=true) == nothing
+
+        # Test that allow_reresolve=false fails with the broken manifest
+        rm(test_dir, force=true, recursive=true)
+        copy_test_package(tempdir, "AllowReresolveTest")
+        Pkg.activate(joinpath(tempdir, "AllowReresolveTest"))
+        @test_throws Pkg.Resolve.ResolverError Pkg.build(; allow_reresolve=false)
+
+        rm(test_dir, force=true, recursive=true)
+        copy_test_package(tempdir, "AllowReresolveTest")
+        Pkg.activate(joinpath(tempdir, "AllowReresolveTest"))
+        @test_throws Pkg.Resolve.ResolverError Pkg.test(; allow_reresolve=false)
+    end end
+end
+
 end # module APITests

test/test_packages/.gitignore

@@ -1 +1,2 @@
 Manifest.toml
+!AllowReresolveTest/Manifest.toml

test/test_packages/AllowReresolveTest/Manifest.toml

@@ -0,0 +1,62 @@
+# This file is machine-generated - editing it directly is not advised
+
+julia_version = "1.13.0-DEV"
+manifest_format = "2.0"
+project_hash = "a100b4eee2a8dd47230a6724ae4de850bddbb7a5"
+
+[[deps.AllowReresolveTest]]
+deps = ["Example"]
+path = "."
+uuid = "12345678-1234-1234-1234-123456789abc"
+version = "0.1.0"
+
+[[deps.Base64]]
+uuid = "2a0f44e3-6c83-55bd-87e4-b1978d98bd5f"
+version = "1.11.0"
+
+[[deps.Example]]
+deps = ["Test"]
+git-tree-sha1 = "8eb7b4d4ca487caade9ba3e85932e28ce6d6e1f8"
+uuid = "7876af07-990d-54b4-ab0e-23690620f79a"
+version = "0.5.1"
+
+[[deps.InteractiveUtils]]
+deps = ["Markdown"]
+uuid = "b77e0a4c-d291-57a0-90e8-8db25a27a240"
+version = "1.11.0"
+
+[[deps.JuliaSyntaxHighlighting]]
+deps = ["StyledStrings"]
+uuid = "ac6e5ff7-fb65-4e79-a425-ec3bc9c03011"
+version = "1.12.0"
+
+[[deps.Logging]]
+uuid = "56ddb016-857b-54e1-b83d-db4d58db5568"
+version = "1.11.0"
+
+[[deps.Markdown]]
+deps = ["Base64", "JuliaSyntaxHighlighting", "StyledStrings"]
+uuid = "d6f4376e-aef5-505a-96c1-9c027394607a"
+version = "1.11.0"
+
+[[deps.Random]]
+deps = ["SHA"]
+uuid = "9a3f8284-a2c9-5f02-9a11-845980a1fd5c"
+version = "1.11.0"
+
+[[deps.SHA]]
+uuid = "ea8e919c-243c-51af-8825-aaa63cd721ce"
+version = "0.7.0"
+
+[[deps.Serialization]]
+uuid = "9e88b42a-f829-5b0c-bbe9-9e923198166b"
+version = "1.11.0"
+
+[[deps.StyledStrings]]
+uuid = "f489334b-da3d-4c2e-b8f0-e476e12c162b"
+version = "1.11.0"
+
+[[deps.Test]]
+deps = ["InteractiveUtils", "Logging", "Random", "Serialization"]
+uuid = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
+version = "1.11.0"

test/test_packages/AllowReresolveTest/Project.toml

@@ -0,0 +1,16 @@
+name = "AllowReresolveTest"
+uuid = "12345678-1234-1234-1234-123456789abc"
+version = "0.1.0"
+
+[deps]
+Example = "7876af07-990d-54b4-ab0e-23690620f79a"
+
+[compat]
+Example = "0.5"
+
+[extras]
+Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
+
+[targets]
+test = ["Test"]
+build = ["Test"]

test/test_packages/AllowReresolveTest/deps/build.jl

@@ -0,0 +1,3 @@
+# Build script for AllowReresolveTest
+using Test
+println("Build completed successfully!")

test/test_packages/AllowReresolveTest/src/AllowReresolveTest.jl

@@ -0,0 +1,7 @@
+module AllowReresolveTest
+
+import Example
+
+greet() = "Hello from AllowReresolveTest using Example!"
+
+end