add some tests

Author: jClugstor

lib/NonlinearSolveBase/src/solve.jl

@@ -45,11 +45,23 @@ problems.
     https://docs.sciml.ai/SciMLSensitivity/stable/
 """
 function solve(prob::AbstractNonlinearProblem, args...; sensealg = nothing,
-        u0 = nothing, p = nothing, wrap = Val(true), kwargs...)
+        u0 = nothing, p = nothing, wrap = Val(true), verbose = NonlinearVerbosity(), kwargs...)
     if sensealg === nothing && haskey(prob.kwargs, :sensealg)
         sensealg = prob.kwargs[:sensealg]
     end
 
+    if verbose isa Bool
+        # @warn "Using `true` or `false` for `verbose` is being deprecated. Please use a `NonlinearVerbosity` type to specify verbosity settings.
+        # For details see the verbosity section of the common solver options documentation page."
+        if verbose
+            verbose = NonlinearVerbosity()
+        else
+            verbose = NonlinearVerbosity(None())
+        end
+    elseif verbose isa AbstractVerbosityPreset
+        verbose = NonlinearVerbosity(verbose)
+    end
+
     if haskey(prob.kwargs, :alias_u0)
         @warn "The `alias_u0` keyword argument is deprecated. Please use a NonlinearAliasSpecifier, e.g. `alias = NonlinearAliasSpecifier(alias_u0 = true)`."
         alias_spec = NonlinearAliasSpecifier(alias_u0 = prob.kwargs[:alias_u0])
@@ -85,6 +97,7 @@ function solve(prob::AbstractNonlinearProblem, args...; sensealg = nothing,
             args...;
             alias_u0 = alias_u0,
             originator = SciMLBase.ChainRulesOriginator(),
+            verbose,
             kwargs...))
     else
         solve_up(prob,
@@ -94,6 +107,7 @@ function solve(prob::AbstractNonlinearProblem, args...; sensealg = nothing,
             args...;
             alias_u0 = alias_u0,
             originator = SciMLBase.ChainRulesOriginator(),
+            verbose,
             kwargs...)
     end
 end
@@ -165,15 +179,27 @@ end
 
 function init(
         prob::AbstractNonlinearProblem, args...; sensealg = nothing,
-        u0 = nothing, p = nothing, kwargs...)
+        u0 = nothing, p = nothing, verbose = NonlinearVerbosity(), kwargs...)
     if sensealg === nothing && has_kwargs(prob) && haskey(prob.kwargs, :sensealg)
         sensealg = prob.kwargs[:sensealg]
     end
 
+    if verbose isa Bool
+        # @warn "Using `true` or `false` for `verbose` is being deprecated. Please use a `NonlinearVerbosity` type to specify verbosity settings.
+        # For details see the verbosity section of the common solver options documentation page."
+        if verbose
+            verbose = NonlinearVerbosity()
+        else
+            verbose = NonlinearVerbosity(None())
+        end
+    elseif verbose isa AbstractVerbosityPreset
+        verbose = NonlinearVerbosity(verbose)
+    end
+
     u0 = u0 !== nothing ? u0 : prob.u0
     p = p !== nothing ? p : prob.p
 
-    init_up(prob, sensealg, u0, p, args...; kwargs...)
+    init_up(prob, sensealg, u0, p, args...; verbose, kwargs...)
 end
 
 function init_up(prob::AbstractNonlinearProblem,

test/verbosity_tests.jl

@@ -118,4 +118,83 @@
         prob, verbose = NonlinearVerbosity(threshold_state = SciMLLogging.InfoLevel()))
 
     @test cache.verbose.threshold_state == SciMLLogging.InfoLevel()
-end
+
+    f(u, p) = u .* u .- 2
+    prob = NonlinearProblem(f, [1.0, 1.0])
+
+    @testset "solve with Bool verbose" begin
+        # Test verbose = true works (default verbosity)
+        sol1 = solve(prob, verbose = true)
+        @test sol1.retcode == ReturnCode.Success
+
+        # Test verbose = false silences all output
+        @test_logs min_level=0 sol2=solve(prob, verbose = false)
+    end
+
+    @testset "solve with Preset verbose" begin
+        # Test verbose = SciMLLogging.Standard() works
+        sol1 = solve(prob, verbose = SciMLLogging.Standard())
+        @test sol1.retcode == ReturnCode.Success
+
+        # Test verbose = SciMLLogging.None() silences output
+        @test_logs min_level=0 sol2=solve(prob, verbose = SciMLLogging.None())
+
+        # Test verbose = SciMLLogging.Detailed() works
+        sol3 = solve(prob, verbose = SciMLLogging.Detailed())
+        @test sol3.retcode == ReturnCode.Success
+
+        # Test verbose = SciMLLogging.All() works
+        sol4 = solve(prob, verbose = SciMLLogging.All())
+        @test sol4.retcode == ReturnCode.Success
+
+        # Test verbose = SciMLLogging.Minimal() works
+        sol5 = solve(prob, verbose = SciMLLogging.Minimal())
+        @test sol5.retcode == ReturnCode.Success
+    end
+
+    @testset "init with Bool verbose" begin
+        # Test verbose = true converts to NonlinearVerbosity()
+        cache1 = init(prob, verbose = true)
+        @test cache1.verbose isa NonlinearVerbosity
+        @test cache1.verbose.threshold_state == SciMLLogging.WarnLevel()
+
+        # Test verbose = false converts to NonlinearVerbosity(None())
+        cache2 = init(prob, verbose = false)
+        @test cache2.verbose isa NonlinearVerbosity
+        @test cache2.verbose.threshold_state isa SciMLLogging.Silent
+        @test cache2.verbose.non_enclosing_interval isa SciMLLogging.Silent
+    end
+
+    @testset "init with Preset verbose" begin
+        # Test verbose = SciMLLogging.Standard() converts to NonlinearVerbosity(Standard())
+        cache1 = init(prob, verbose = SciMLLogging.Standard())
+        @test cache1.verbose isa NonlinearVerbosity
+        @test cache1.verbose.threshold_state == SciMLLogging.WarnLevel()
+
+        # Test verbose = SciMLLogging.None() converts to NonlinearVerbosity(None())
+        cache2 = init(prob, verbose = SciMLLogging.None())
+        @test cache2.verbose isa NonlinearVerbosity
+        @test cache2.verbose.threshold_state isa SciMLLogging.Silent
+
+        # Test verbose = SciMLLogging.Detailed()
+        cache3 = init(prob, verbose = SciMLLogging.Detailed())
+        @test cache3.verbose isa NonlinearVerbosity
+        @test cache3.verbose.linear_verbosity isa SciMLLogging.Detailed
+
+        # Test verbose = SciMLLogging.All()
+        cache4 = init(prob, verbose = SciMLLogging.All())
+        @test cache4.verbose isa NonlinearVerbosity
+        @test cache4.verbose.threshold_state == SciMLLogging.InfoLevel()
+
+        # Test verbose = SciMLLogging.Minimal()
+        cache5 = init(prob, verbose = SciMLLogging.Minimal())
+        @test cache5.verbose isa NonlinearVerbosity
+        @test cache5.verbose.alias_u0_immutable isa SciMLLogging.Silent
+    end
+
+    @testset "init then solve with converted verbose" begin
+        # Ensure the converted verbose works through the full solve pipeline
+        cache = init(prob, verbose = false)
+        @test_logs min_level=0 sol=solve!(cache)
+    end
+end