Produce compat entries in Project.toml (#1023)

... using the optional meta data provided by users in BBB's Dependency type.

Author: fingolfin

Manifest.toml

@@ -28,7 +28,7 @@ uuid = "2a0f44e3-6c83-55bd-87e4-b1978d98bd5f"
 
 [[BinaryBuilderBase]]
 deps = ["CodecZlib", "Downloads", "InteractiveUtils", "JSON", "LibGit2", "Libdl", "Logging", "OutputCollectors", "Pkg", "Random", "SHA", "Scratch", "SimpleBufferStream", "TOML", "Tar", "UUIDs", "p7zip_jll", "pigz_jll"]
-git-tree-sha1 = "87236ea2e2cf83b4a5bbeb29bc76c94f4a3252d4"
+git-tree-sha1 = "c3ceefb6a48993dd35514fac7f00f8e7b7addb2b"
 repo-rev = "master"
 repo-url = "https://github.com/JuliaPackaging/BinaryBuilderBase.jl.git"
 uuid = "7f725544-6523-48cd-82d1-3fa08ff4056e"

src/AutoBuild.jl

@@ -133,6 +133,18 @@ function build_tarballs(ARGS, src_name, src_version, sources, script,
     sources = coerce_source.(sources)
     dependencies = coerce_dependency.(dependencies)
 
+    # Reject user supplied dependencies using a VersionSpec: these should
+    # either use compat, or build_version, or both (depending on what they are
+    # trying to achieve). We cannot check for this in the Dependency
+    # constructor, as there are several valid situations in which we *do* want
+    # to store versions here (e.g. after running the dependency through the
+    # package resolver).
+    for dep in dependencies
+        if dep isa Dependency && dep.pkg.version != Pkg.Types.VersionSpec("*")
+            error("Dependency $(dep.pkg.name) specifies a version, use build_version and/or compat instead")
+        end
+    end
+
     # Do not clobber caller's ARGS
     ARGS = deepcopy(ARGS)
 
@@ -1369,24 +1381,6 @@ const uuid_package = UUID("cfb74b52-ec16-5bb7-a574-95d9e393895e")
 # "_jll" to the name of the new package before computing its UUID.
 jll_uuid(name) = bb_specific_uuid5(uuid_package, "$(name)_jll")
 function build_project_dict(name, version, dependencies::Array{Dependency}, julia_compat::String=DEFAULT_JULIA_VERSION_SPEC; lazy_artifacts::Bool=false, kwargs...)
-    function has_compat_info(d::Dependency)
-        r = Pkg.Types.VersionRange()
-        return isa(d.pkg.version, VersionNumber) ||
-               length(d.pkg.version.ranges) != 1 ||
-               d.pkg.version.ranges[1] != r
-    end
-    function exactly_this_version(v::VersionNumber)
-        return string("=", VersionNumber(v.major, v.minor, v.patch))
-    end
-    function exactly_this_version(v::Pkg.Types.VersionSpec)
-        if length(v.ranges) == 1 &&
-           v.ranges[1].lower.n == 3 &&
-           v.ranges[1].lower == v.ranges[1].upper
-           return string("=", v)
-       end
-       return string(v)
-    end
-    exactly_this_version(v) = v
     Pkg.Types.semver_spec(julia_compat) # verify julia_compat is valid
     project = Dict(
         "name" => "$(name)_jll",
@@ -1401,8 +1395,9 @@ function build_project_dict(name, version, dependencies::Array{Dependency}, juli
     for dep in dependencies
         depname = getname(dep)
         project["deps"][depname] = string(jll_uuid(depname))
-        if has_compat_info(dep)
-            project["compat"][depname] = string(exactly_this_version(dep.pkg.version))
+        if dep isa Dependency && length(dep.compat) > 0
+            Pkg.Types.semver_spec(dep.compat) # verify dep.compat is valid
+            project["compat"][depname] = dep.compat
         end
     end
     # Always add Libdl, Pkg and Artifacts as dependencies

test/basic.jl

@@ -221,21 +221,21 @@ end
 
     # Ensure passing compat bounds works
     dependencies = [
-        Dependency(PackageSpec(name="libLLVM_jll", version=v"9")),
+        Dependency(PackageSpec(name="libLLVM_jll"), compat="=9.0.0"),
     ]
     dict = build_project_dict("Clang", v"9.0.1+2", dependencies)
     @test dict["compat"]["julia"] == "1.0"
     @test dict["compat"]["libLLVM_jll"] == "=9.0.0"
 
     dependencies = [
-        Dependency(PackageSpec(name="libLLVM_jll", version="8.3-10")),
+        Dependency(PackageSpec(name="libLLVM_jll"), compat="8.3 - 10"),
     ]
     dict = build_project_dict("Clang", v"9.0.1+2", dependencies)
     @test dict["compat"]["julia"] == "1.0"
-    @test dict["compat"]["libLLVM_jll"] == "8.3-10"
+    @test dict["compat"]["libLLVM_jll"] == "8.3 - 10"
 
     dependencies = [
-        Dependency(PackageSpec(name="libLLVM_jll", version="8.3.0-8.3")),
+        Dependency(PackageSpec(name="libLLVM_jll"), compat="8.3"),
     ]
     dict = build_project_dict("Clang", v"9.0.1+2", dependencies)
     @test dict["compat"]["libLLVM_jll"] == "8.3"

test/jll.jl

@@ -8,7 +8,7 @@ module TestJLL end
     @test jll_uuid("Zlib_jll") == UUID("83775a58-1f1d-513f-b197-d71354ab007a")
     @test jll_uuid("FFMPEG_jll") == UUID("b22a6f82-2f65-5046-a5b2-351ab43fb4e5")
 
-    project = build_project_dict("LibFoo", v"1.3.5", [Dependency("Zlib_jll"), Dependency(PackageSpec(name = "XZ_jll", version = v"2.4.6"))])
+    project = build_project_dict("LibFoo", v"1.3.5", [Dependency("Zlib_jll"), Dependency(PackageSpec(name = "XZ_jll"), compat = "=2.4.6")])
     @test project["deps"] == Dict("JLLWrappers" => "692b3bcd-3c85-4b1f-b108-f13ce0eb3210",
                                   "Artifacts"   => "56f22d72-fd6d-98f1-02f0-08ddc0907c33",
                                   "Pkg"         => "44cfe95a-1eb2-52ea-b672-e2afdf69b78f",