Activate the test env with TestEnv.jl (#115)

* add aqua badge in readme

* wrap aqua in testset to hide subtests

* merge test and main project files, use TestEnv to activate test env

Author: m-fila

Project.toml

@@ -24,9 +24,11 @@ JetVisualisation = "Makie"
 
 [compat]
 Accessors = "0.1.36"
+Aqua = "0.8"
 CodecZlib = "0.7.4"
 EDM4hep = "0.4.0"
 EnumX = "1.0.4"
+JSON = "0.21"
 Logging = "1.9"
 LoopVectorization = "0.12.170"
 LorentzVectorHEP = "0.1.6"
@@ -38,7 +40,9 @@ Test = "1.9"
 julia = "1.9"
 
 [extras]
+Aqua = "4c88cf16-eb10-579e-8560-4a9242c79595"
 Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
+JSON = "682c06a0-de6a-54ab-a142-c8b1cf79cde6"
 
 [targets]
-test = ["Test"]
+test = ["Aqua", "Test", "JSON"]

README.md

@@ -7,6 +7,7 @@
 [![DOI](https://zenodo.org/badge/507671522.svg)](https://zenodo.org/doi/10.5281/zenodo.12671414)
 [![](https://img.shields.io/badge/docs-stable-blue.svg)](https://juliahep.github.io/JetReconstruction.jl/stable)
 [![](https://img.shields.io/badge/docs-dev-blue.svg)](https://juliahep.github.io/JetReconstruction.jl/dev)
+[![Aqua QA](https://raw.githubusercontent.com/JuliaTesting/Aqua.jl/master/badge.svg)](https://github.com/JuliaTesting/Aqua.jl)
 
 ## This package implements sequential Jet Reconstruction (clustering)
 

test/Project.toml

@@ -2,14 +2,10 @@
 
 This directory contains the unit tests for the JetReconstruction package.
 
-As there are dependencies that are only used for tests, there is a specific
-`Project.toml` file for testing. However, **make sure that the
-`JetReconstruction` package is in develop mode**.
-
 To run all of the tests do:
 
 ```sh
-julia --project=test runtests.jl
+julia --project test/runtests.jl
 ```
 
 or
@@ -21,8 +17,8 @@ julia> ]
 ...
 ```
 
-Tests are factorised into individual files as `test-*.jl`. By use of `common.jl` all of these tests can be run standalone, e.g.,
+Tests are factorised into individual files as `test-*.jl`. By use of `common.jl` all of these tests can be run standalone, provided that `TestEnv.jl` is installed in the default environment, e.g.,
 
 ```sh
-julia --project=test test-pp-reconstruction.jl
+julia --project test/test-pp-reconstruction.jl
 ```

test/README.md

@@ -6,5 +6,9 @@
 # to avoid double-including the common file.
 
 if !@isdefined JETRECO_TEST_COMMON
+    if !isempty(PROGRAM_FILE)
+        import TestEnv
+        TestEnv.activate()
+    end
     include("_common.jl")
 end

test/common.jl

@@ -1,11 +1,5 @@
 #! /usr/bin/env julia
 
-using JetReconstruction
-using Test
-using JSON
-using LorentzVectorHEP
-using Logging
-
 include("common.jl")
 
 function main()

test/runtests.jl

@@ -3,4 +3,6 @@
 using Aqua
 
 include("common.jl")
-Aqua.test_all(JetReconstruction)
+@testset "Aqua.jl" begin
+    Aqua.test_all(JetReconstruction)
+end