test: add potential code quality tests (#250)

Author: oameye

Project.toml

@@ -18,23 +18,35 @@ Symbolics = "0c5d862f-8b57-4792-8d23-62f2024744c7"
 TermInterface = "8ea1fca8-c5ef-4a55-8b96-4e9afe9c9a3c"
 
 [compat]
+Aqua = "0.8"
+CheckConcreteStructs = "0.1"
 Combinatorics = "1"
+ExplicitImports = "1.12"
+JET = "0.9"
 LaTeXStrings = "1"
 Latexify = "0.13, 0.14, 0.15, 0.16"
-LinearAlgebra = "1.6"
+LinearAlgebra = "1.10"
 MacroTools = "0.5"
 ModelingToolkit = "9"
+OrdinaryDiffEq = "6"
+QuantumOptics = "1"
 QuantumOpticsBase = "0.4, 0.5"
+Random = "1.10"
 Reexport = "1"
 SciMLBase = "1, 2"
 SecondQuantizedAlgebra = "0.1"
+SteadyStateDiffEq = "2"
 SymbolicUtils = "3.6 - 3.24"
 Symbolics = "6"
 TermInterface = "2"
-julia = "1.6"
+Test = "1.10"
+julia = "1.10"
 
 [extras]
 Aqua = "4c88cf16-eb10-579e-8560-4a9242c79595"
+CheckConcreteStructs = "73c92db5-9da6-4938-911a-6443a7e94a58"
+ExplicitImports = "7d51a73a-1435-4ff3-83d9-f097790105c7"
+JET = "c3a54625-cd67-489e-a8e7-0a5a0ff4e31b"
 ModelingToolkit = "961ee093-0014-501f-94e3-6117800e7a78"
 OrdinaryDiffEq = "1dea7af3-3e70-54e6-95c3-0bf5283fa5ed"
 QuantumOptics = "6e0679c1-51ea-5a7c-ac74-d61b76210b0c"
@@ -43,4 +55,4 @@ SteadyStateDiffEq = "9672c7b4-1e72-59bd-8a11-6ac3964bc41f"
 Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
 
 [targets]
-test = ["OrdinaryDiffEq", "SteadyStateDiffEq", "ModelingToolkit", "QuantumOptics", "Random", "Test", "Aqua"]
+test = ["OrdinaryDiffEq", "SteadyStateDiffEq", "ModelingToolkit", "QuantumOptics", "Random", "Test", "Aqua", "ExplicitImports", "JET", "CheckConcreteStructs"]

test/runtests.jl

@@ -1,5 +1,5 @@
 names = [
-    "test_aqua.jl"
+    "test_code_quality.jl"
     "test_fock.jl"
     "test_nlevel.jl"
     "test_spin.jl"

test/test_aqua.jl

@@ -0,0 +1,47 @@
+using QuantumCumulants, Test
+
+@testset "best practices" begin
+    using Aqua
+
+    Aqua.test_ambiguities([QuantumCumulants]; broken = true)
+    Aqua.test_piracies(QuantumCumulants; broken = true)
+    Aqua.test_all(QuantumCumulants; ambiguities = false, piracies = false)
+end
+
+@testset "ExplicitImports" begin
+    using ExplicitImports
+    # @test check_no_implicit_imports(QuantumCumulants) == nothing
+    @test check_all_explicit_imports_via_owners(QuantumCumulants) == nothing
+    # @test check_all_explicit_imports_are_public(QuantumCumulants) == nothing
+    # @test check_no_stale_explicit_imports(QuantumCumulants) == nothing
+    # @test check_all_qualified_accesses_via_owners(QuantumCumulants) == nothing
+    # @test check_all_qualified_accesses_are_public(QuantumCumulants) == nothing
+    # @test check_no_self_qualified_accesses(QuantumCumulants) == nothing
+end
+
+if isempty(VERSION.prerelease)
+    @testset "Code linting" begin
+        using JET
+        # JET.test_package(SecondQuantizedAlgebra; target_defined_modules=true)
+        rep = report_package("QuantumCumulants")
+        @show rep
+        @test length(JET.get_reports(rep)) <= 306
+        @test_broken length(JET.get_reports(rep)) == 0
+    end
+end
+
+@testset "Concretely typed" begin
+    import QuantumCumulants as QC
+    using CheckConcreteStructs
+
+    all_concrete(QC.CorrelationFunction)
+    all_concrete(QC.Spectrum)
+
+    all_concrete(QC.MeanfieldEquations)
+    all_concrete(QC.IndexedMeanfieldEquations)
+    all_concrete(QC.EvaledMeanfieldEquations)
+    all_concrete(QC.ScaledMeanfieldEquations)
+
+    all_concrete(QC.IndexedMeanfieldNoiseEquations)
+    all_concrete(QC.MeanfieldNoiseEquations)
+end