Tidy up imports

Mal Miller · mmiller-max · commit d4ebb3258eec · 2021-02-27T20:00:29.000+11:00
- Use "using" where possible
- Remove unused imports
- Remove unused test dep
- Removed import of Types to make it clear its from Pkg
diff --git a/Project.toml b/Project.toml
@@ -1,6 +1,6 @@
 name = "TestReports"
 uuid = "dcd651b4-b50a-5b6b-8f22-87e9f253a252"
-version = "0.5.3"
+version = "0.5.4"
 
 [deps]
 Dates = "ade2ca70-3891-5945-98fb-dc099432e06a"
@@ -14,10 +14,9 @@ EzXML = "1"
 julia = "1"
 
 [extras]
-LibGit2 = "76f85450-5226-5b5a-8eaa-529ad045b433"
 ReferenceTests = "324d217c-45ce-50fc-942e-d289b448e8cf"
 Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
 UUIDs = "cf7118a7-6976-5b1a-9a39-7adc72f591a4"
 
 [targets]
-test = ["Test", "ReferenceTests", "UUIDs", "LibGit2"]
+test = ["ReferenceTests", "Test", "UUIDs"]
diff --git a/src/TestReports.jl b/src/TestReports.jl
@@ -1,11 +1,33 @@
 module TestReports
 
-# package code goes here
-using Test
+using Dates
 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 Test: AbstractTestSet, DefaultTestSet, Result, Pass, Fail, Error, Broken,
+    get_testset, get_testset_depth, scrub_backtrace
+
+import Test: finish, record
 
-import Test: AbstractTestSet, DefaultTestSet, record, finish, get_testset_depth, get_testset
-import Test: Result, Fail, Broken, Pass, Error, scrub_backtrace
+# 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, update_package_test! 
+else
+    using Pkg.Operations: find_installed
+    using Pkg.Types: SHA1
+end
 
 export ReportingTestSet, any_problems, report, recordproperty
 
diff --git a/src/recordproperty.jl b/src/recordproperty.jl
@@ -1,5 +1,3 @@
-import Test: get_testset
-
 """
     recordproperty(name::String, value)
 
diff --git a/src/runner.jl b/src/runner.jl
@@ -1,21 +1,3 @@
-using Pkg
-import Pkg: PackageSpec, Types
-import Pkg.Types: Context, EnvCache, ensure_resolved, is_project_uuid
-import Pkg.Operations: project_resolve!, project_deps_resolve!, manifest_resolve!, manifest_info, project_rel_path
-
-# Version specific imports
-@static if VERSION >= v"1.4.0"
-    import Pkg.Operations: gen_target_project
-else
-    import Pkg.Operations: with_dependencies_loadable_at_toplevel
-end
-@static if VERSION >= v"1.2.0"
-    import Pkg.Operations: update_package_test!, source_path, sandbox
-else
-    import Pkg.Operations: find_installed
-    import Pkg.Types: SHA1
-end
-
 "Exit code for runner when tests fail"
 const TESTS_FAILED = 3
 
@@ -170,7 +152,7 @@ function gen_command(runner_code, julia_args, coverage)
 end
 
 """
-    isinstalled!(ctx::Union{Context, EnvCache}, pkgspec::Types.PackageSpec)
+    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
@@ -180,7 +162,7 @@ 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::Types.PackageSpec)
+function isinstalled!(ctx::Context, pkgspec::Pkg.Types.PackageSpec)
     @static if VERSION >= v"1.4.0"
         var = ctx
     else
@@ -198,12 +180,12 @@ function isinstalled!(ctx::Context, pkgspec::Types.PackageSpec)
 end
 
 """
-    gettestfilepath(ctx::Context, pkgspec::Types.PackageSpec)
+    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::Types.PackageSpec)
+function gettestfilepath(ctx::Context, pkgspec::Pkg.Types.PackageSpec)
     @static if VERSION >= v"1.4.0"
         if is_project_uuid(ctx, pkgspec.uuid)
             pkgspec.path = dirname(ctx.env.project_file)
@@ -235,7 +217,7 @@ function gettestfilepath(ctx::Context, pkgspec::Types.PackageSpec)
             elseif entry.path !== nothing
                 pkgfilepath =  project_rel_path(ctx, entry.path)
             elseif pkgspec.uuid in keys(ctx.stdlibs)
-                pkgfilepath = Types.stdlib_path(pkgspec.name)
+                pkgfilepath = Pkg.Types.stdlib_path(pkgspec.name)
             else
                 throw(PkgTestError("Could not find either `git-tree-sha1` or `path` for package $(pkgspec.name)"))
             end
@@ -252,7 +234,7 @@ function gettestfilepath(ctx::Context, pkgspec::Types.PackageSpec)
             elseif haskey(info, "path")
                 pkgfilepath =  project_rel_path(ctx, info["path"])
             elseif pkgspec.uuid in keys(ctx.stdlibs)
-                pkgfilepath = Types.stdlib_path(pkgspec.name)
+                pkgfilepath = Pkg.Types.stdlib_path(pkgspec.name)
             else
                 throw(PkgTestError("Could not find either `git-tree-sha1` or `path` for package $(pkgspec.name)"))
             end
diff --git a/src/testsets.jl b/src/testsets.jl
@@ -1,6 +1,3 @@
-using Dates
-import Test: Result
-
 ####################
 # Type Definitions #
 ####################
diff --git a/src/to_xml.jl b/src/to_xml.jl
@@ -1,5 +1,3 @@
-using Printf
-
 # Format is defined by
 # https://www.ibm.com/support/knowledgecenter/en/SSQ2R2_14.2.0/com.ibm.rsar.analysis.codereview.cobol.doc/topics/cac_useresults_junit.html
 # http://help.catchsoftware.com/display/ET/JUnit+Format
diff --git a/test/recordproperty.jl b/test/recordproperty.jl
@@ -1,6 +1,6 @@
 using EzXML
 using Test
-import Test: DefaultTestSet, AbstractTestSet, finish, record, get_testset_depth, get_testset, Error
+using Test: DefaultTestSet, AbstractTestSet, Error, get_testset, get_testset_depth 
 using ReferenceTests
 using TestReports
 
diff --git a/test/runtests.jl b/test/runtests.jl
@@ -1,5 +1,5 @@
-using TestReports
 using Test
+using TestReports
 
 # Include utils
 include("utils.jl")
diff --git a/test/test_packages/CustomTestSet/test/runtests.jl b/test/test_packages/CustomTestSet/test/runtests.jl
@@ -1,5 +1,7 @@
 using Test
-import Test: AbstractTestSet, record, finish, get_testset_depth, get_testset
+using Test: AbstractTestSet, get_testset_depth, get_testset
+
+import Test: finish, record
 
 mutable struct MyTestSet <: AbstractTestSet
     description::String
diff --git a/test/test_packages/NoDescriptionCustomTestSet/test/runtests.jl b/test/test_packages/NoDescriptionCustomTestSet/test/runtests.jl
@@ -1,5 +1,7 @@
 using Test
-import Test: AbstractTestSet, record, finish, get_testset_depth, get_testset
+using Test: AbstractTestSet, get_testset_depth, get_testset
+
+import Test: finish, record
 
 mutable struct NoDescriptionTestSet <: AbstractTestSet
     results::Vector
diff --git a/test/test_packages/NoResultsCustomTestSet/test/runtests.jl b/test/test_packages/NoResultsCustomTestSet/test/runtests.jl
@@ -1,5 +1,7 @@
 using Test
-import Test: AbstractTestSet, record, finish, get_testset_depth, get_testset
+using Test: AbstractTestSet, get_testset_depth, get_testset
+
+import Test: finish, record
 
 mutable struct NoResultsTestSet <: AbstractTestSet
     description::String
diff --git a/test/testsets.jl b/test/testsets.jl
@@ -1,6 +1,6 @@
 using Dates
 using Test
-import Test: AbstractTestSet, Result, Pass, Fail, Broken, Error
+using Test: AbstractTestSet, Result, Pass, Fail, Broken, Error
 using TestReports
 
 @testset "handle_top_level_results!" begin
diff --git a/test/utils.jl b/test/utils.jl
@@ -1,5 +1,9 @@
-using Dates, Pkg, Test, LibGit2
-import Test: finish, record, AbstractTestSet, get_testset_depth, get_testset, Result
+using Dates
+using Pkg
+using Test
+using Test: AbstractTestSet, Result, get_testset, get_testset_depth 
+
+import Test: finish, record
 
 # Strip the filenames from the string, so that the reference strings work on different computers
 strip_filepaths(str) = replace(str, r" at .*\d+$"m => "")

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,3 @@`
`1`		`-import Test: get_testset`
`2`		`-`
`3`	`1`	`"""`
`4`	`2`	`recordproperty(name::String, value)`
`5`	`3`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,3 @@`
`1`		`-using Printf`
`2`		`-`
`3`	`1`	`# Format is defined by`
`4`	`2`	`# https://www.ibm.com/support/knowledgecenter/en/SSQ2R2_14.2.0/com.ibm.rsar.analysis.codereview.cobol.doc/topics/cac_useresults_junit.html`
`5`	`3`	`# http://help.catchsoftware.com/display/ET/JUnit+Format`