Allow storing compat strings in Dependency objects (#123)

Author: fingolfin

src/BinaryBuilderBase.jl

@@ -17,7 +17,7 @@ export AbstractSource, AbstractDependency, SetupSource, PatchSource,
     generate_compiler_wrappers!, preferred_runner, CompilerShard, UserNSRunner,
     DockerRunner, choose_shards, exeext, preferred_libgfortran_version,
     preferred_cxxstring_abi, gcc_version, available_gcc_builds, getversion,
-    getpkg, aatriplet,
+    getpkg, aatriplet, getcompat,
     nbits, proc_family, storage_dir, extract_kwargs, extract_fields,
     download_source, setup_workspace, setup_dependencies, update_registry,
     getname, cleanup_dependencies, compress_dir, prepare_for_deletion,

src/Dependencies.jl

@@ -57,13 +57,33 @@ is_runtime_dependency
 Define a binary dependency that is necessary to build the package and load the
 generated JLL package.  The argument can be either a string with the name of the
 JLL package or a `Pkg.PackageSpec`.
+
+The optional keyword argument `build_version` can be used to specify the version
+of the dependency to be installed when building it.
+
+The optional keyword argument `compat` can be used to specify a string for
+use in the `Project.toml` of the generated Julia package.
 """
 struct Dependency <: AbstractDependency
     pkg::PkgSpec
     build_version::Union{VersionNumber,Nothing}
-    Dependency(pkg::PkgSpec, build_version = nothing) = new(pkg, build_version)
+    compat::String  # semver string for use in Project.toml of the JLL
+    function Dependency(pkg::PkgSpec, build_version = nothing; compat::String = "")
+        if length(compat) > 0
+            spec = Pkg.Types.semver_spec(compat) # verify compat is valid
+            if build_version !== nothing && !(build_version in spec)
+                throw(ArgumentError("build_version and compat for $(pkg) are incompatible"))
+            end
+            if pkg.version != Pkg.Types.VersionSpec("*") && !(pkg.version in spec)
+                throw(ArgumentError("PackageSpec version and compat for $(pkg) are incompatible"))
+            end
+        end
+        new(pkg, build_version, compat)
+    end
+end
+function Dependency(dep::AbstractString, build_version = nothing; compat::String = "")
+    return Dependency(PackageSpec(; name = dep), build_version, compat = compat)
 end
-Dependency(dep::AbstractString, build_version = nothing) = Dependency(PackageSpec(; name = dep), build_version)
 is_host_dependency(::Dependency) = false
 is_build_dependency(::Dependency) = true
 is_runtime_dependency(::Dependency) = true
@@ -181,10 +201,15 @@ __version(v::Pkg.Types.VersionSpec) = v.ranges[1].lower
 version(d::AbstractDependency) = __version(getpkg(d).version)
 version(d::Dependency) = __version(d.pkg.version)
 
+
+getcompat(d::AbstractDependency) = ""
+getcompat(d::Dependency) = d.compat
+
 for (type, type_descr) in ((Dependency, "dependency"), (BuildDependency, "builddependency"), (HostBuildDependency, "hostdependency"))
     JSON.lower(d::type) = Dict("type" => type_descr,
                                "name" => d.pkg.name,
                                "uuid" => string_or_nothing(d.pkg.uuid),
+                               "compat" => getcompat(d),
                                "version-major" => major(version(d)),
                                "version-minor" => minor(version(d)),
                                "version-patch" => patch(version(d)))
@@ -196,19 +221,19 @@ end
 function dependencify(d::Dict)
     if d["type"] in ("dependency", "builddependency", "hostdependency")
         uuid = isnothing(d["uuid"]) ? d["uuid"] : UUID(d["uuid"])
+        compat = d["compat"]
         version = VersionNumber(d["version-major"], d["version-minor"], d["version-patch"])
         version = version == v"0" ? nothing : version
-        T = if d["type"] == "dependency"
-            Dependency
+        spec = PackageSpec(; name = d["name"], uuid = uuid, version = version)
+        if d["type"] == "dependency"
+            return Dependency(spec; compat = compat)
         elseif d["type"] == "builddependency"
-            BuildDependency
+            return BuildDependency(spec)
         elseif d["type"] == "hostdependency"
-            HostBuildDependency
+            return HostBuildDependency(spec)
         end
-        return T(PackageSpec(; name = d["name"], uuid = uuid, version = version))
-    else
-        error("Cannot convert to dependency")
     end
+    error("Cannot convert to dependency")
 end
 
 

test/dependencies.jl

@@ -26,12 +26,24 @@ end
     @test getname(dep) == name
     @test getname(PackageSpec(; name = name)) == name
     @test getpkg(dep) == PackageSpec(; name = name)
+    @test getcompat(dep) == ""
 
     build_version = v"1.2.3"
     dep_buildver = Dependency(PackageSpec(; name = name), build_version)
     @test Dependency(name, build_version) == dep_buildver
     @test getname(dep_buildver) == name
     @test getpkg(dep_buildver) == PackageSpec(; name = name, version = build_version)
+    @test getcompat(dep_buildver) == ""
+
+    # the same but with compat info
+    dep_buildver = Dependency(PackageSpec(; name = name), build_version, compat = "~1.2")
+    @test Dependency(name, build_version) == dep_buildver
+    @test getname(dep_buildver) == name
+    @test getpkg(dep_buildver) == PackageSpec(; name = name, version = build_version)
+    @test getcompat(dep_buildver) == "~1.2"
+
+    # if build_version and compat don't match, an error should be thrown
+    @test_throws ArgumentError Dependency(PackageSpec(; name = name), build_version, compat = "2.0")
 
     build_name = "Foo_headers_jll"
     build_dep = BuildDependency(PackageSpec(; name = build_name))
@@ -57,25 +69,25 @@ end
 
     @testset "JSON (de)serialization" begin
         jdep = JSON.lower(dep)
-        @test jdep == Dict("type" => "dependency", "name" => name, "uuid" => nothing, "version-major" => 0x0, "version-minor" => 0x0, "version-patch" => 0x0)
+        @test jdep == Dict("type" => "dependency", "name" => name, "uuid" => nothing, "compat" => "", "version-major" => 0x0, "version-minor" => 0x0, "version-patch" => 0x0)
         @test dependencify(jdep) == dep
 
         jdep_buildver = JSON.lower(dep_buildver)
-        @test jdep_buildver == Dict("type" => "dependency", "name" => name, "uuid" => nothing, "version-major" => 0x0, "version-minor" => 0x0, "version-patch" => 0x0)
+        @test jdep_buildver == Dict("type" => "dependency", "name" => name, "uuid" => nothing, "compat" => "~1.2", "version-major" => 0x0, "version-minor" => 0x0, "version-patch" => 0x0)
         # the build_version is currently not serialized, so the following test fails
         @test_broken dependencify(jdep_buildver) == dep_buildver
 
         jbuild_dep = JSON.lower(build_dep)
-        @test jbuild_dep == Dict("type" => "builddependency", "name" => build_name, "uuid" => nothing, "version-major" => 0x0, "version-minor" => 0x0, "version-patch" => 0x0)
+        @test jbuild_dep == Dict("type" => "builddependency", "name" => build_name, "uuid" => nothing, "compat" => "", "version-major" => 0x0, "version-minor" => 0x0, "version-patch" => 0x0)
         @test dependencify(jbuild_dep) == build_dep
 
         jhost_dep = JSON.lower(host_dep)
-        @test jhost_dep == Dict("type" => "hostdependency", "name" => host_name, "uuid" => nothing, "version-major" => 0x0, "version-minor" => 0x0, "version-patch" => 0x0)
+        @test jhost_dep == Dict("type" => "hostdependency", "name" => host_name, "uuid" => nothing, "compat" => "", "version-major" => 0x0, "version-minor" => 0x0, "version-patch" => 0x0)
         @test dependencify(jhost_dep) == host_dep
 
         full_dep = Dependency(PackageSpec(; name = "Baz_jll", uuid = "00000000-1111-2222-3333-444444444444", version = "3.1.4"))
         jfull_dep = JSON.lower(full_dep)
-        @test jfull_dep == Dict("type" => "dependency", "name" => "Baz_jll", "uuid" => "00000000-1111-2222-3333-444444444444", "version-major" => 0x3, "version-minor" => 0x1, "version-patch" => 0x4)
+        @test jfull_dep == Dict("type" => "dependency", "name" => "Baz_jll", "uuid" => "00000000-1111-2222-3333-444444444444", "compat" => "", "version-major" => 0x3, "version-minor" => 0x1, "version-patch" => 0x4)
         @test dependencify(jfull_dep) == full_dep
         @test_throws ErrorException dependencify(Dict("type" => "git"))
     end