Add ExplicitImports.jl test (#1875)

* add ExplicitImports.jl tests * format * use Trixi.at-batch in at-threaded and skipt at-batch in stale explicit imports test --------- Co-authored-by: Michael Schlottke-Lakemper <[email protected]>
trixi-framework · Mar 21, 2024 · 18aaae9 · 18aaae9
1 parent 17ab101
commit 18aaae9
Show file tree

Hide file tree

Showing 5 changed files with 19 additions and 9 deletions.
diff --git a/Project.toml b/Project.toml
@@ -31,7 +31,6 @@ RecipesBase = "3cdcf5f2-1ef4-517c-9805-6587b60abb01"
 Reexport = "189a3867-3050-52da-a836-e630ba90ab69"
 Requires = "ae029012-a4dd-5104-9daa-d747884805df"
 SciMLBase = "0bca4576-84f4-4d90-8ffe-ffa030f20462"
-Setfield = "efcf1570-3423-57d1-acb7-fd33fddbac46"
 SimpleUnPack = "ce78b400-467f-4804-87d8-8f486da07d0a"
 SparseArrays = "2f01184e-e22b-5df5-ae63-d93ebab69eaf"
 StartUpDG = "472ebc20-7c99-4d4b-9470-8fde4e9faa0f"
@@ -84,7 +83,6 @@ RecipesBase = "1.1"
 Reexport = "1.0"
 Requires = "1.1"
 SciMLBase = "1.90, 2"
-Setfield = "1"
 SimpleUnPack = "1.1"
 SparseArrays = "1"
 StartUpDG = "0.17.7"

diff --git a/src/Trixi.jl b/src/Trixi.jl
@@ -22,7 +22,7 @@ using LinearAlgebra: LinearAlgebra, Diagonal, diag, dot, mul!, norm, cross, norm
                      UniformScaling, det
 using Printf: @printf, @sprintf, println
 using SparseArrays: AbstractSparseMatrix, AbstractSparseMatrixCSC, sparse, droptol!,
-                    rowvals, nzrange, nonzeros, spzeros
+                    rowvals, nzrange, nonzeros
 
 # import @reexport now to make it available for further imports/exports
 using Reexport: @reexport
@@ -32,10 +32,10 @@ using Reexport: @reexport
 using MPI: MPI
 
 using SciMLBase: CallbackSet, DiscreteCallback,
-                 ODEProblem, ODESolution, ODEFunction,
+                 ODEProblem, ODESolution,
                  SplitODEProblem
 import SciMLBase: get_du, get_tmp_cache, u_modified!,
-                  AbstractODEIntegrator, init, step!, check_error,
+                  init, step!, check_error,
                   get_proposed_dt, set_proposed_dt!,
                   terminate!, remake, add_tstop!, has_tstop, first_tstop
 
@@ -57,7 +57,6 @@ using Polyester: Polyester, @batch # You know, the cheapest threads you can find
 using OffsetArrays: OffsetArray, OffsetVector
 using P4est
 using T8code
-using Setfield: @set
 using RecipesBase: RecipesBase
 using Requires: @require
 using Static: Static, One, True, False
@@ -66,7 +65,7 @@ using StaticArrays: StaticArrays, MVector, MArray, SMatrix, @SMatrix
 using StrideArrays: PtrArray, StrideArray, StaticInt
 @reexport using StructArrays: StructArrays, StructArray
 using TimerOutputs: TimerOutputs, @notimeit, TimerOutput, print_timer, reset_timer!
-using Triangulate: Triangulate, TriangulateIO, triangulate
+using Triangulate: Triangulate, TriangulateIO
 export TriangulateIO # for type parameter in DGMultiMesh
 using TriplotBase: TriplotBase
 using TriplotRecipes: DGTriPseudocolor
@@ -84,9 +83,9 @@ const _PREFERENCE_LOG = @load_preference("log", "log_Trixi_NaN")
 
 # finite difference SBP operators
 using SummationByPartsOperators: AbstractDerivativeOperator,
-                                 AbstractNonperiodicDerivativeOperator, DerivativeOperator,
+                                 AbstractNonperiodicDerivativeOperator,
                                  AbstractPeriodicDerivativeOperator,
-                                 PeriodicDerivativeOperator, grid
+                                 grid
 import SummationByPartsOperators: integrate, semidiscretize,
                                   compute_coefficients, compute_coefficients!,
                                   left_boundary_weight, right_boundary_weight

diff --git a/src/auxiliary/auxiliary.jl b/src/auxiliary/auxiliary.jl
@@ -242,6 +242,8 @@ macro threaded(expr)
     # !!! danger "Heisenbug"
     #     Look at the comments for `wrap_array` when considering to change this macro.
 
+    # By using `Trixi.@batch` we allow users of Trixi.jl to use `@threaded` without having
+    # Polyester.jl in their namespace.
     return esc(quote
                    Trixi.@batch $(expr)
                end)

diff --git a/test/Project.toml b/test/Project.toml
@@ -2,6 +2,7 @@
 Aqua = "4c88cf16-eb10-579e-8560-4a9242c79595"
 CairoMakie = "13f3f980-e62b-5c42-98c6-ff1f3baf88f0"
 Downloads = "f43a241f-c20a-4ad4-852c-f6b1247861c6"
+ExplicitImports = "7d51a73a-1435-4ff3-83d9-f097790105c7"
 FFMPEG = "c87230d0-a227-11e9-1b43-d7ebe4e7570a"
 ForwardDiff = "f6369f11-7733-5829-9624-2563aa707210"
 LinearAlgebra = "37e2e46d-f89d-539d-b4ee-838fcccc9c8e"
@@ -16,6 +17,7 @@ Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
 Aqua = "0.8"
 CairoMakie = "0.10"
 Downloads = "1"
+ExplicitImports = "1.0.1"
 FFMPEG = "0.4"
 ForwardDiff = "0.10.24"
 LinearAlgebra = "1"

diff --git a/test/test_aqua.jl b/test/test_aqua.jl
@@ -1,6 +1,7 @@
 module TestAqua
 
 using Aqua
+using ExplicitImports: check_no_implicit_imports, check_no_stale_explicit_imports
 using Test
 using Trixi
 
@@ -13,6 +14,14 @@ include("test_trixi.jl")
                   # in src/solvers/dgmulti/sbp.jl
                   piracies = (treat_as_own = [Trixi.StartUpDG.RefElemData,
                                   Trixi.StartUpDG.MeshData],))
+    @test isnothing(check_no_implicit_imports(Trixi,
+                                              skip = (Core, Base, Trixi.P4est, Trixi.T8code,
+                                                      Trixi.EllipsisNotation)))
+    @test isnothing(check_no_stale_explicit_imports(Trixi,
+                                                    ignore = (:derivative_operator,
+                                                              :periodic_derivative_operator,
+                                                              :upwind_operators,
+                                                              Symbol("@batch"))))
 end
 
 end #module