CI: add downstream Plots test (#201)

Author: t-bltg

test/Project.toml

@@ -1,11 +1,17 @@
 [deps]
 Aqua = "4c88cf16-eb10-579e-8560-4a9242c79595"
+Downloads = "f43a241f-c20a-4ad4-852c-f6b1247861c6"
 JET = "c3a54625-cd67-489e-a8e7-0a5a0ff4e31b"
+JSON = "682c06a0-de6a-54ab-a142-c8b1cf79cde6"
+Pkg = "44cfe95a-1eb2-52ea-b672-e2afdf69b78f"
 Preferences = "21216c6a-2e73-6563-6e65-726566657250"
 Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
 
 [compat]
 Aqua = "0.8"
+Downloads = "1"
 JET = "0.9 - 0.10"
+JSON = "1"
+Pkg = "1"
 Preferences = "1"
 Test = "1"

test/downstream.jl

@@ -0,0 +1,79 @@
+using Downloads, JSON, Test
+
+function available_channels()
+    juliaup = "https://julialang-s3.julialang.org/juliaup"
+    for i ∈ 1:6
+        buf = PipeBuffer()
+        Downloads.download("$juliaup/DBVERSION", buf)
+        dbversion = VersionNumber(readline(buf))
+        dbversion.major == 1 || continue
+        buf = PipeBuffer()
+        Downloads.download(
+            "$juliaup/versiondb/versiondb-$dbversion-x86_64-unknown-linux-gnu.json",
+            buf,
+        )
+        json = JSON.parse(buf)
+        haskey(json, "AvailableChannels") || continue
+        return json["AvailableChannels"]
+        sleep(10i)
+    end
+    return
+end
+
+"""
+julia> is_latest(:lts)
+julia> is_latest(:release)
+"""
+function is_latest(variant)
+    channels = available_channels()
+    ver = let var::String = (
+        release = "release",
+        rel = "release",
+        lts = "lts",
+        release_candidate = "rc",
+        alpha = "alpha",
+        beta = "beta",
+        rc = "rc",
+    )[variant]
+        VersionNumber(split(channels[var]["Version"], '+') |> first)
+    end
+    dev = occursin("DEV", string(VERSION))  # or length(VERSION.prerelease) < 2
+    return !dev && (
+        VersionNumber(ver.major, ver.minor, 0, ("",)) ≤ VERSION < VersionNumber(ver.major, ver.minor + 1)
+    )
+end
+
+(is_ci() && Sys.islinux() && is_latest(:release)) && @testset "downstream" begin
+    tmpd = mktempdir()
+    Plots_jl = joinpath(tmpd, "Plots.jl")
+    @test Cmd(`$(Base.julia_cmd()) $(joinpath(@__DIR__, "downstream_dev.jl")) $tmpd`) |> run |> success
+    script = tempname()
+    write(
+        script,
+        """
+        using Pkg
+
+        Pkg.activate(joinpath("$Plots_jl", "PlotsBase"))
+        Pkg.develop(path="$(joinpath(@__DIR__, ".."))")
+
+        import Gaston  # trigger `PlotsBase` extension
+        Pkg.status(["Gaston", "PlotsBase"])
+
+        # test basic plots creation and bitmap or vector exports
+        using PlotsBase, Test
+
+        prefix = tempname()
+        @time for i ∈ 1:length(PlotsBase._examples)
+            i ∈ PlotsBase._backend_skips[:gaston] && continue  # skip unsupported examples
+            PlotsBase._examples[i].imports ≡ nothing || continue  # skip examples requiring optional test deps
+            pl = PlotsBase.test_examples(:gaston, i; disp = false)
+            for ext in (".png", ".pdf")  # TODO: maybe more ?
+                fn = string(prefix, i, ext)
+                PlotsBase.savefig(pl, fn)
+                @test filesize(fn) > 1_000
+            end
+        end
+        """
+    )
+    @test Cmd(`$(Base.julia_cmd()) --project=@. $script`; dir = Plots_jl) |> run |> success
+end

test/downstream_dev.jl

@@ -0,0 +1,63 @@
+using Pkg
+
+LibGit2 = Pkg.GitTools.LibGit2
+TOML = Pkg.TOML
+
+failsafe_clone_checkout(path, url, pkg = nothing; stable = true) = begin
+    local repo
+    for i in 1:6
+        try
+            repo = Pkg.GitTools.ensure_clone(stdout, path, url)
+            break
+        catch err
+            @warn err
+            sleep(20i)
+        end
+    end
+
+    name, _ = splitext(basename(url))
+    registries = joinpath(first(DEPOT_PATH), "registries")
+    general = joinpath(registries, "General")
+    versions = joinpath(general, name[1:1], name, "Versions.toml")
+    if !isfile(versions)
+        mkpath(general)
+        run(setenv(`tar xf $general.tar.gz`; dir = general))
+    end
+    @assert isfile(versions)
+
+    if stable
+        v_stable = maximum(VersionNumber.(keys(TOML.parse(read(versions, String)))))
+        obj = LibGit2.GitObject(repo, "v$v_stable")
+        hash = if isa(obj, LibGit2.GitTag)
+            LibGit2.target(obj)
+        else
+            LibGit2.GitHash(obj)
+        end |> string
+        LibGit2.checkout!(repo, hash)
+    end
+
+    toml = if pkg ≢ nothing && (fn = joinpath(path, pkg, "Project.toml")) |> isfile  # monorepo layout
+        fn
+    elseif (fn = joinpath(path, "Project.toml")) |> isfile  # single package toplevel
+        fn
+    end
+    @assert isfile(toml) "$toml does not exist, bailing out !"
+    toml
+end
+
+fake_supported_version!(toml) = begin
+    # fake the supported Gaston version for testing (for `Pkg.develop`)
+    Gaston_version = Pkg.Types.read_package(normpath(@__DIR__, "..", "Project.toml")).version
+    parsed_toml = TOML.parse(read(toml, String))
+    parsed_toml["compat"]["Gaston"] = string(Gaston_version)
+    open(toml, "w") do io
+        TOML.print(io, parsed_toml)
+    end
+    nothing
+end
+
+dn = joinpath(ARGS[1], "Plots.jl")
+toml = failsafe_clone_checkout(dn, "https://github.com/JuliaPlots/Plots.jl", "PlotsBase"; stable = false)
+docs = joinpath(dn, "docs")
+isdir(docs) && rm(docs; recursive=true)  # ERROR: LoadError: empty intersection between Gaston@2.0.1 and project compatibility ∅
+fake_supported_version!(toml)

test/runtests.jl

@@ -10,6 +10,9 @@ gh = Gaston.gethandles
 reset = Gaston.reset
 null() = Gaston.config.output = :null
 
+is_pkgeval() = Base.get_bool_env("JULIA_PKGEVAL", false)
+is_ci() = Base.get_bool_env("CI", false)
+
 @testset "Gnuplot version" begin
     @test Gaston.GNUPLOT_VERSION[] ≥ v"6"
 end
@@ -25,8 +28,8 @@ end
 end
 
 @testset "AQUA" begin
-    #Aqua.test_all(Gaston)
-    #Aqua.test_ambiguities(Gaston) # disabled -- fails with ambiguities from StatsBase
+    # Aqua.test_all(Gaston)
+    # Aqua.test_ambiguities(Gaston) # disabled -- fails with ambiguities from StatsBase
     Aqua.test_unbound_args(Gaston)
     Aqua.test_undefined_exports(Gaston)
     Aqua.test_project_extras(Gaston)
@@ -94,9 +97,9 @@ end
         f4 = Figure()
         @test f4.handle == 1
         closeall()
-        p1 = plot(1:10, handle = :a);
-        p2 = plot(1:10, handle = :b);
-        p3 = plot(1:10, handle = :c);
+        p1 = plot(1:10, handle = :a)
+        p2 = plot(1:10, handle = :b)
+        p3 = plot(1:10, handle = :c)
         @test begin
             closefigure(:b)
             gh()
@@ -725,11 +728,12 @@ end
     if Gaston.state.enabled
         @test Gaston.gp_exec("set grid") == ""
         null()
-        t = Gaston.terminals();
+        t = Gaston.terminals()
         @test isnothing(t)
     end
 end
 
 closeall()
 
 include("preferences.jl")
+include("downstream.jl")