Use SciMLTesting public API docs QA

Co-Authored-By: Chris Rackauckas <accounts@chrisrackauckas.com>

Author: ChrisRackauckas

Project.toml

@@ -72,7 +72,7 @@ SafeTestsets = "0.1"
 SciMLBase = "2.148.0, 3"
 SciMLLogging = "1.10.1, 2"
 SciMLSensitivity = "7.100.0"
-SciMLTesting = "1"
+SciMLTesting = "2.1"
 SparseArrays = "1.10"
 Symbolics = "7"
 TerminalLoggers = "0.1"

lib/OptimizationAuglag/test/qa/Project.toml

@@ -13,5 +13,5 @@ Aqua = "0.8"
 JET = "0.9, 0.10, 0.11"
 julia = "1.10"
 OptimizationAuglag = "2"
-SciMLTesting = "1.6"
+SciMLTesting = "2.1"
 Test = "1"

lib/OptimizationAuglag/test/qa/qa.jl

@@ -9,6 +9,8 @@ using Test
 #    OptimizationBase, the backend, or Base and are not (yet) declared public;
 #    the proper fix is upstream `public` declarations, not a local change.
 #  * the ignored stale imports are part of the intentionally re-surfaced API.
+include(normpath(joinpath(@__DIR__, "..", "..", "..", "..", "test", "qa", "public_api_docs.jl")))
+
 run_qa(
     OptimizationAuglag;
     explicit_imports = true,
@@ -21,5 +23,6 @@ run_qa(
         all_qualified_accesses_are_public = (; ignore = (:OptimizationState, :__solve, :_check_and_convert_maxiters, :allowscallback, :allowsfg, :isa_dataiterator, :requiresconsjac, :requiresgradient)),
         all_explicit_imports_are_public = (; ignore = (:OptimizationStats,)),
     ),
+    api_docs_kwargs = public_api_docs_kwargs(OptimizationAuglag),
     ei_broken = (:no_implicit_imports,),
 )

lib/OptimizationBBO/test/qa/Project.toml

@@ -13,5 +13,5 @@ Aqua = "0.8"
 JET = "0.9, 0.10, 0.11"
 julia = "1.10"
 OptimizationBBO = "0.4"
-SciMLTesting = "1.6"
+SciMLTesting = "2.1"
 Test = "1"

lib/OptimizationBBO/test/qa/qa.jl

@@ -8,12 +8,15 @@ using Test
 #  * the ignored *_are_public / *_via_owners names are owned by SciMLBase,
 #    OptimizationBase, the backend, or Base and are not (yet) declared public;
 #    the proper fix is upstream `public` declarations, not a local change.
+include(normpath(joinpath(@__DIR__, "..", "..", "..", "..", "test", "qa", "public_api_docs.jl")))
+
 run_qa(
     OptimizationBBO;
     explicit_imports = true,
     ei_kwargs = (;
         all_qualified_accesses_via_owners = (; ignore = (:OptimizationStats,)),
         all_qualified_accesses_are_public = (; ignore = (Symbol("@logmsg"), :LogLevel, :OptRunController, :OptimizationState, :OptimizationStats, :SingleObjectiveMethodNames, :__solve, :_check_and_convert_maxiters, :_check_and_convert_maxtime, :allowscallback, :deduce_retcode, :elapsed_time, :num_steps, :requiresbounds, :shutdown_optimizer!)),
     ),
+    api_docs_kwargs = public_api_docs_kwargs(OptimizationBBO),
     ei_broken = (:no_implicit_imports,),
 )

lib/OptimizationBase/test/qa/Project.toml

@@ -13,5 +13,5 @@ Aqua = "0.8"
 JET = "0.9, 0.10, 0.11"
 julia = "1.10"
 OptimizationBase = "5"
-SciMLTesting = "1.6"
+SciMLTesting = "2.1"
 Test = "1"

lib/OptimizationBase/test/qa/qa.jl

@@ -15,6 +15,8 @@ using Test
 # AbstractOptimizationCache. Those are our *own* interface functions, so mark
 # them as own for the piracy check rather than flagging the SciML types.
 SB = OptimizationBase.SciMLBase
+include(normpath(joinpath(@__DIR__, "..", "..", "..", "..", "test", "qa", "public_api_docs.jl")))
+
 run_qa(
     OptimizationBase;
     explicit_imports = true,
@@ -33,5 +35,6 @@ run_qa(
         all_qualified_accesses_are_public = (; ignore = (:AbstractOptimizationCache, :AbstractOptimizationFunction, :AbstractOptimizationSolution, :AbstractTracer, :ChainRulesOriginator, :IsInfinite, :IteratorSize, :MaxSense, :MinSense, :NoAD, :NonConcreteEltypeError, :SizeUnknown, :__init, :allowsconsjvp, :allowsconsvjp, :allowsfg, :allowsfgh, :requiresconshess, :requiresconsjac, :requiresgradient, :requireshessian, :requireslagh)),
         all_explicit_imports_are_public = (; ignore = (:KeywordArgError, :MaxSense, :MinSense, :ObjSense, :OptimizationStats, :__init, :__solve, :_concrete_solve_adjoint, :_concrete_solve_forward, :allowscallback, :extract_alg, :get_concrete_p, :get_concrete_u0, :get_root_indp, :get_updated_symbolic_problem, :has_kwargs, :promote_u0, :requiresbounds, :requiresconshess, :requiresconsjac, :requiresconstraints, :requiresgradient, :requireshessian, :wrap_sol)),
     ),
+    api_docs_kwargs = public_api_docs_kwargs(OptimizationBase),
     ei_broken = (:no_implicit_imports,),
 )

lib/OptimizationCMAEvolutionStrategy/test/qa/Project.toml

@@ -13,5 +13,5 @@ Aqua = "0.8"
 JET = "0.9, 0.10, 0.11"
 julia = "1.10"
 OptimizationCMAEvolutionStrategy = "0.3"
-SciMLTesting = "1.6"
+SciMLTesting = "2.1"
 Test = "1"

lib/OptimizationCMAEvolutionStrategy/test/qa/qa.jl

@@ -8,12 +8,15 @@ using Test
 #  * the ignored *_are_public / *_via_owners names are owned by SciMLBase,
 #    OptimizationBase, the backend, or Base and are not (yet) declared public;
 #    the proper fix is upstream `public` declarations, not a local change.
+include(normpath(joinpath(@__DIR__, "..", "..", "..", "..", "test", "qa", "public_api_docs.jl")))
+
 run_qa(
     OptimizationCMAEvolutionStrategy;
     explicit_imports = true,
     ei_kwargs = (;
         all_qualified_accesses_via_owners = (; ignore = (:OptimizationStats,)),
         all_qualified_accesses_are_public = (; ignore = (:BasicLogger, :OptimizationState, :OptimizationStats, :__solve, :_check_and_convert_maxiters, :_check_and_convert_maxtime, :allowscallback, :requiresconshess, :requiresconsjac, :requiresgradient, :requireshessian)),
     ),
+    api_docs_kwargs = public_api_docs_kwargs(OptimizationCMAEvolutionStrategy),
     ei_broken = (:no_implicit_imports,),
 )

lib/OptimizationEvolutionary/test/qa/Project.toml

@@ -13,5 +13,5 @@ Aqua = "0.8"
 JET = "0.9, 0.10, 0.11"
 julia = "1.10"
 OptimizationEvolutionary = "0.4"
-SciMLTesting = "1.6"
+SciMLTesting = "2.1"
 Test = "1"