Skip to content

Commit

Permalink
Merge pull request #89 from JuliaTesting/mm/use-test-env
Browse files Browse the repository at this point in the history 
Use TestEnv
  • Loading branch information
@mmiller-max
mmiller-max authored Oct 18, 2024
2 parents 5cb90bc + 13e6f78 commit 81ad054
Show file tree
Hide file tree
Showing 5 changed files with 19 additions and 215 deletions.
1 change: 0 additions & 1 deletion .github/workflows/ci.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@ jobs:
fail-fast: false
matrix:
version:
- '1.0'
- '1.6'
- '1'
- 'nightly'
Expand Down
6 changes: 4 additions & 2 deletions Project.toml
View file
Original file line number Diff line number Diff line change
@@ -1,17 +1,19 @@
name = "TestReports"
uuid = "dcd651b4-b50a-5b6b-8f22-87e9f253a252"
version = "1.1.1"
version = "1.1.2"

[deps]
Dates = "ade2ca70-3891-5945-98fb-dc099432e06a"
EzXML = "8f5d6c58-4d21-5cfd-889c-e3ad7ee6a615"
Pkg = "44cfe95a-1eb2-52ea-b672-e2afdf69b78f"
Printf = "de0858da-6303-5e67-8744-51eddeeeb8d7"
Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
TestEnv = "1e6cf692-eddd-4d53-88a5-2d735e33781b"

[compat]
EzXML = "1"
julia = "1"
julia = "1.6"
TestEnv = "1"

[extras]
ReferenceTests = "324d217c-45ce-50fc-942e-d289b448e8cf"
Expand Down
22 changes: 1 addition & 21 deletions src/TestReports.jl
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,33 +5,13 @@ using EzXML
using Pkg
using Printf
using Test

using Pkg: PackageSpec
using Pkg.Types: Context, ensure_resolved, is_project_uuid
using Pkg.Operations: manifest_info, manifest_resolve!, project_deps_resolve!,
project_rel_path, project_resolve!
using TestEnv

using Test: AbstractTestSet, DefaultTestSet, Result, Pass, Fail, Error, Broken,
get_testset, get_testset_depth, scrub_backtrace

import Test: finish, record

# Version specific imports
@static if VERSION >= v"1.4.0"
using Pkg.Operations: gen_target_project
else
using Pkg.Operations: with_dependencies_loadable_at_toplevel
end
@static if VERSION >= v"1.2.0"
using Pkg.Operations: sandbox, source_path
@static if VERSION < v"1.7.0"
using Pkg.Operations: update_package_test!
end
else
using Pkg.Operations: find_installed
using Pkg.Types: SHA1
end

export ReportingTestSet, any_problems, report, record_test_property, record_testset_property

const TESTREPORTS_VERSION = let # Copied from Documenter.jl
Expand Down
182 changes: 14 additions & 168 deletions src/runner.jl
View file
Original file line number Diff line number Diff line change
Expand Up @@ -191,126 +191,6 @@ function gen_command(runner_code, julia_args, coverage)
return cmd
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)
@static if v"1.4.0" <= VERSION < v"1.7.0"
var = ctx
else
var = ctx.env
end
@static if VERSION >= v"1.7.0"
manifest_var = ctx.env.manifest
else
manifest_var = var
end
project_resolve!(var, [pkgspec])
project_deps_resolve!(var, [pkgspec])
manifest_resolve!(manifest_var, [pkgspec])
try
@static if VERSION >= v"1.8.0"
ensure_resolved(ctx, manifest_var, [pkgspec])
else
ensure_resolved(manifest_var, [pkgspec])
end
catch err
err isa MethodError && rethrow()
return false
end
return true
end

"""
gettestfilepath(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 gettestfilepath(ctx::Context, pkgspec::Pkg.Types.PackageSpec)
@static if VERSION >= v"1.7.0"
if is_project_uuid(ctx.env, pkgspec.uuid)
pkgspec.path = dirname(ctx.env.project_file)
pkgspec.version = ctx.env.pkg.version
else !Pkg.Operations.is_stdlib(pkgspec.uuid)
entry = manifest_info(ctx.env.manifest, pkgspec.uuid)
pkgspec.version = entry.version
pkgspec.tree_hash = entry.tree_hash
pkgspec.repo = entry.repo
pkgspec.path = entry.path
pkgspec.pinned = entry.pinned
if isnothing(pkgspec.path)
pkgspec.path = source_path(ctx.env.project_file, pkgspec, ctx.julia_version)
end
end
pkgfilepath = source_path(ctx.env.project_file, pkgspec, ctx.julia_version)
elseif VERSION >= v"1.4.0"
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)
elseif VERSION >= v"1.2.0"
pkgspec.special_action = Pkg.Types.PKGSPEC_TESTED
if is_project_uuid(ctx.env, pkgspec.uuid)
pkgspec.path = dirname(ctx.env.project_file)
pkgspec.version = ctx.env.pkg.version
else
update_package_test!(pkgspec, manifest_info(ctx.env, pkgspec.uuid))
pkgspec.path = joinpath(project_rel_path(ctx, source_path(pkgspec)))
end
pkgfilepath = project_rel_path(ctx, source_path(pkgspec))
elseif VERSION >= v"1.1.0"
pkgspec.special_action = Pkg.Types.PKGSPEC_TESTED
if is_project_uuid(ctx.env, pkgspec.uuid)
pkgspec.version = ctx.env.pkg.version
pkgfilepath = dirname(ctx.env.project_file)
else
entry = manifest_info(ctx.env, pkg.uuid)
if entry.repo.tree_sha !== nothing
pkgfilepath = find_installed(pkgspec.name, pkgspec.uuid, entry.repo.tree_sha)
elseif entry.path !== nothing
pkgfilepath = project_rel_path(ctx, entry.path)
elseif pkgspec.uuid in keys(ctx.stdlibs)
pkgfilepath = Pkg.Types.stdlib_path(pkgspec.name)
else
throw(PkgTestError("Could not find either `git-tree-sha1` or `path` for package $(pkgspec.name)"))
end
end
else
pkgspec.special_action = Pkg.Types.PKGSPEC_TESTED
if is_project_uuid(ctx.env, pkgspec.uuid)
pkgspec.version = ctx.env.pkg.version
pkgfilepath = dirname(ctx.env.project_file)
else
info = manifest_info(ctx.env, pkgspec.uuid)
if haskey(info, "git-tree-sha1")
pkgfilepath = find_installed(pkgspec.name, pkgspec.uuid, SHA1(info["git-tree-sha1"]))
elseif haskey(info, "path")
pkgfilepath = project_rel_path(ctx, info["path"])
elseif pkgspec.uuid in keys(ctx.stdlibs)
pkgfilepath = Pkg.Types.stdlib_path(pkgspec.name)
else
throw(PkgTestError("Could not find either `git-tree-sha1` or `path` for package $(pkgspec.name)"))
end
end
pkgspec.path = pkgfilepath
end
testfilepath = joinpath(pkgfilepath, "test", "runtests.jl")
return testfilepath
end

test_project_filepath(testfilepath) = joinpath(dirname(testfilepath), "Project.toml")
has_test_project_file(testfilepath) = isfile(test_project_filepath(testfilepath))

Expand Down Expand Up @@ -375,60 +255,26 @@ function test!(pkg::AbstractString,
# Copied from Pkg.test approach
julia_args = Cmd(julia_args)
test_args = Cmd(test_args)
pkgspec = deepcopy(PackageSpec(pkg))
ctx = Context()

if !isinstalled!(ctx, pkgspec)
push!(nopkgs, pkgspec.name)
return
end
Pkg.instantiate(ctx)
testfilepath = gettestfilepath(ctx, pkgspec)

ctx, pkgspec = try
TestEnv.ctx_and_pkgspec(pkg) # TODO: Don't use TestEnv internals
catch err
if err isa TestEnv.TestEnvError
push!(nopkgs, pkg)
return
else
rethrow()
end
end
testfilepath = joinpath(TestEnv.get_test_dir(ctx, pkgspec), "runtests.jl")
check_testreports_compatability(ctx, pkgspec, testfilepath)

if !isfile(testfilepath)
push!(notests, pkg)
else
runner_code = gen_runner_code(testfilepath, logfilename, test_args)
cmd = gen_command(runner_code, julia_args, coverage)
test_folder_has_project_file = has_test_project_file(testfilepath)

if VERSION >= v"1.4" || (VERSION >= v"1.2" && test_folder_has_project_file)
# Operations.sandbox() has different arguments between versions
test_project_override = if VERSION >= v"1.4" && !test_folder_has_project_file
if VERSION >= v"1.8"
gen_target_project(ctx, pkgspec, pkgspec.path::String, "test")
elseif VERSION >= v"1.7"
gen_target_project(ctx.env, ctx.registries, pkgspec, pkgspec.path, "test")
else
gen_target_project(ctx, pkgspec, pkgspec.path, "test")
end
else
nothing
end

sandbox_args = if VERSION >= v"1.11-"
(ctx, pkgspec, joinpath(pkgspec.path, "test"), test_project_override)
elseif VERSION >= v"1.4"
(ctx, pkgspec, pkgspec.path, joinpath(pkgspec.path, "test"), test_project_override)
else
(ctx, pkgspec, pkgspec.path, joinpath(pkgspec.path, "test"))
end

sandbox(sandbox_args...) do
flush(stdout)
runtests!(errs, pkg, cmd, logfilename)
end
else
with_dependencies_loadable_at_toplevel(ctx, pkgspec; might_need_to_resolve=true) do localctx
Pkg.activate(localctx.env.project_file)
try
runtests!(errs, pkg, cmd, logfilename)
finally
Pkg.activate(ctx.env.project_file)
end
end
TestEnv.activate(pkg) do
runtests!(errs, pkg, cmd, logfilename)
end
end
end
Expand Down Expand Up @@ -456,7 +302,7 @@ If `logfilename` is supplied, it must match the type (and length, if a vector) o
The tests are run in the same way as `Pkg.test`.
"""
function test(; kwargs...)
ctx = Context()
ctx = Pkg.Types.Context()
# This error mirrors the message generated by Pkg.test in similar situations
ctx.env.pkg === nothing && throw(PkgTestError("trying to test an unnamed project"))
test(ctx.env.pkg.name; kwargs...)
Expand Down
23 changes: 0 additions & 23 deletions test/runnerinternals.jl
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,29 +2,6 @@ using Pkg
using Test
using TestReports

if VERSION < v"1.2.0"
@testset "gettestfilepath - V1.0.5" begin
# Stdlibs are not tested by other functions for V1.0.5
stdlibname = "Dates"
ctx = Pkg.Types.Context()
pkg = Pkg.PackageSpec(stdlibname)
TestReports.isinstalled!(ctx, pkg)
delete!(ctx.env.manifest[stdlibname][1], "path") # Remove path to force stdlib check
testfilepath = joinpath(abspath(joinpath(dirname(Base.find_package(stdlibname)), "..")), "test", "runtests.jl")
@test TestReports.gettestfilepath(ctx, pkg) == testfilepath

# PkgTestError when PkgSpec has missing info when finding path - V1.0.5 only
pkgname = "PassingTests"
Pkg.develop(Pkg.PackageSpec(path=joinpath(@__DIR__, "test_packages", pkgname)))
ctx = Pkg.Types.Context()
pkg = Pkg.PackageSpec(pkgname)
TestReports.isinstalled!(ctx, pkg)
delete!(ctx.env.manifest["PassingTests"][1], "path")
@test_throws TestReports.PkgTestError TestReports.gettestfilepath(ctx, pkg)
Pkg.rm(Pkg.PackageSpec(path=joinpath(@__DIR__, "test_packages", pkgname)))
end
end

@testset "showerror" begin
@test_throws TestReports.PkgTestError throw(TestReports.PkgTestError("Test"))
@test sprint(showerror, TestReports.PkgTestError("Error text"), "") == "Error text"
Expand Down

2 comments on commit 81ad054

@mmiller-max
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@JuliaRegistrator register

@JuliaRegistrator
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Registration pull request created: JuliaRegistries/General/117568

Tip: Release Notes

Did you know you can add release notes too? Just add markdown formatted text underneath the comment after the text
"Release notes:" and it will be added to the registry PR, and if TagBot is installed it will also be added to the
release that TagBot creates. i.e.

@JuliaRegistrator register

Release notes:

## Breaking changes

- blah

To add them here just re-invoke and the PR will be updated.

Tagging

After the above pull request is merged, it is recommended that a tag is created on this repository for the registered package version.

This will be done automatically if the Julia TagBot GitHub Action is installed, or can be done manually through the github interface, or via:

git tag -a v1.1.2 -m "<description of version>" 81ad0543d044bfdafce36cb20b67fd48946b1ce1
git push origin v1.1.2

Please sign in to comment.