Fully align code structure with other branchs

Author: oxinabox

src/TestEnv.jl

@@ -1,22 +1,15 @@
 module TestEnv
 using Pkg
 using Pkg: PackageSpec
-using Pkg.Types: Context, ensure_resolved, is_project_uuid, write_env
+using Pkg.Types: Context, ensure_resolved, is_project_uuid, write_env, is_stdlib
+using Pkg.Types: Types, projectfile_path, manifestfile_path
 using Pkg.Operations: manifest_info, manifest_resolve!, project_deps_resolve!
 using Pkg.Operations: project_rel_path, project_resolve!
-
-using Pkg.Types: Types, projectfile_path, manifestfile_path
-using Pkg.Operations: gen_target_project
-using Pkg.Operations: update_package_test!
-using Pkg.Types: is_stdlib
 using Pkg.Operations: sandbox, source_path, sandbox_preserve, abspath!
+using Pkg.Operations: gen_target_project, update_package_test!
 
-
-include("exceptions.jl")
-
-include("activate.jl")
-include("make_test_env.jl")
-include("sandbox.jl")
-include("test_dir.jl")
+include("common.jl")
+include("activate_do.jl")
+include("activate_set.jl")
 
 end

src/activate.jl

@@ -0,0 +1,19 @@
+"""
+    TestEnv.activate(f, [pkg])
+
+Activate the test enviroment of `pkg` (defaults to current enviroment), and run `f()`,
+then deactivate the enviroment.
+This is not useful for many people: Julia is not really designed to have the enviroment
+being changed while you are executing code.
+However, this *is* useful for anyone doing something like making a alternative to
+`Pkg.test()`.
+Indeed this is basically extracted from what `Pkg.test()` does.
+"""
+function activate(f, pkg::AbstractString=current_pkg_name())
+    ctx, pkgspec = ctx_and_pkgspec(pkg)
+    test_project_override = maybe_gen_project_override!(ctx, pkgspec)
+    return sandbox(ctx, pkgspec, pkgspec.path, joinpath(pkgspec.path, "test"), test_project_override) do
+        flush(stdout)
+        f()
+    end
+end

src/activate_do.jl

@@ -1,14 +1,14 @@
+"""
+    TestEnv.activate([pkg])
 
-# Originally from Pkg.Operations.sandbox
-function make_test_env(ctx::Context, target)
-    # This needs to be first as `gen_target_project` fixes `target.path` if it is nothing
-    sandbox_project_override = if !test_dir_has_project_file(ctx, target)
-        sandbox_project_override = gen_target_project(ctx, target, target.path, "test")
-    else
-        nothing
-    end
+Activate the test enviroment of `pkg` (defaults to current enviroment).
+"""
+function activate(pkg::AbstractString=current_pkg_name())
+    ctx, pkgspec = ctx_and_pkgspec(pkg)
+    # This needs to be first as `gen_target_project` fixes `pkgspec.path` if it is nothing
+    sandbox_project_override = maybe_gen_project_override!(ctx, pkgspec)
 
-    sandbox_path = joinpath(target.path, "test")
+    sandbox_path = joinpath(pkgspec.path, "test")
     sandbox_project = projectfile_path(sandbox_path)
 
     tmp = mktempdir()
@@ -25,7 +25,7 @@ function make_test_env(ctx::Context, target)
     # create merged manifest
     # - copy over active subgraph
     # - abspath! to maintain location of all deved nodes
-    working_manifest = abspath!(ctx, sandbox_preserve(ctx, target, tmp_project))
+    working_manifest = abspath!(ctx, sandbox_preserve(ctx, pkgspec, tmp_project))
 
     # - copy over fixed subgraphs from test subgraph
     # really only need to copy over "special" nodes
@@ -52,7 +52,7 @@ function make_test_env(ctx::Context, target)
     Base.ACTIVE_PROJECT[] = nothing
 
     temp_ctx = Context()
-    temp_ctx.env.project.deps[target.name] = target.uuid
+    temp_ctx.env.project.deps[pkgspec.name] = pkgspec.uuid
 
     try
         Pkg.resolve(temp_ctx; io=devnull)

src/make_test_env.jl src/activate_set.jl

@@ -0,0 +1,81 @@
+struct TestEnvError <: Exception
+    msg::AbstractString
+end
+
+function Base.showerror(io::IO, ex::TestEnvError, bt; backtrace=true)
+    printstyled(io, ex.msg, color=Base.error_color())
+end
+
+
+current_pkg_name() = Context().env.pkg.name
+
+"""
+   ctx, pkgspec = ctx_and_pkgspec(pkg::AbstractString)
+   
+For a given package name `pkg`, instantiate a `Context` for it, and return that `Context`,
+and it's `PackageSpec`.
+"""
+function ctx_and_pkgspec(pkg::AbstractString)
+    pkgspec = deepcopy(PackageSpec(pkg))
+    ctx = Context()
+    isinstalled!(ctx, pkgspec) || throw(TestEnvError("$pkg not installed 👻"))
+    Pkg.instantiate(ctx)
+    return ctx, pkgspec
+end
+
+
+"""
+    isinstalled!(ctx::Context, pkgspec::Pkg.Types.PackageSpec)
+
+Checks if the package is installed by using `ensure_resolved` from `Pkg/src/Types.jl`.
+This function fails if the package is not installed, but here we wrap it in a
+try-catch as we may want to test another package after the one that isn't installed.
+
+For Julia versions V1.4 and later, the first arguments of the Pkg functions used
+is of type `Pkg.Types.Context`. For earlier versions, they are of type
+`Pkg.Types.EnvCache`.
+"""
+function isinstalled!(ctx::Context, pkgspec::Pkg.Types.PackageSpec)
+    project_resolve!(ctx, [pkgspec])
+    project_deps_resolve!(ctx, [pkgspec])
+    manifest_resolve!(ctx, [pkgspec])
+
+    try
+        ensure_resolved(ctx, [pkgspec])
+    catch err
+        err isa MethodError && rethrow()
+        return false
+    end
+    return true
+end
+
+function test_dir_has_project_file(ctx, pkgspec)
+    return isfile(joinpath(get_test_dir(ctx, pkgspec), "Project.toml"))
+end
+
+"""
+    get_test_dir(ctx::Context, pkgspec::Pkg.Types.PackageSpec)
+
+Gets the testfile path of the package. Code for each Julia version mirrors that found 
+in `Pkg/src/Operations.jl`.
+"""
+function get_test_dir(ctx::Context, pkgspec::Pkg.Types.PackageSpec)
+    if is_project_uuid(ctx, pkgspec.uuid)
+        pkgspec.path = dirname(ctx.env.project_file)
+        pkgspec.version = ctx.env.pkg.version
+    else
+        update_package_test!(pkgspec, manifest_info(ctx, pkgspec.uuid))
+        pkgspec.path = project_rel_path(ctx, source_path(ctx, pkgspec))
+    end
+    pkgfilepath = source_path(ctx, pkgspec)
+    return joinpath(pkgfilepath, "test")
+end
+
+
+function maybe_gen_project_override!(ctx, pkgspec)
+    if !test_dir_has_project_file(ctx, pkgspec)
+        sandbox_project_override = gen_target_project(ctx, pkgspec, pkgspec.path, "test")
+    else
+        nothing
+    end
+end