Skip to content

[Utilities] improve test coverage #2669

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Feb 28, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 19 additions & 25 deletions src/MathOptInterface.jl
Original file line number Diff line number Diff line change
Expand Up @@ -394,31 +394,25 @@ import PrecompileTools

PrecompileTools.@setup_workload begin
PrecompileTools.@compile_workload begin
let
optimizer =
() -> Utilities.MockOptimizer(
Utilities.UniversalFallback(Utilities.Model{Float64}()),
)
model = Utilities.CachingOptimizer(
Utilities.UniversalFallback(Utilities.Model{Float64}()),
instantiate(optimizer; with_bridge_type = Float64),
)
set(model, Silent(), true)
x = add_variables(model, 3)
add_constraint(model, x[1], ZeroOne())
add_constraint(model, x[2], Integer())
add_constraint(model, x[1], GreaterThan(0.0))
add_constraint(model, x[2], LessThan(0.0))
add_constraint(model, x[3], EqualTo(0.0))
f = 1.0 * x[1] + x[2] + x[3]
add_constraint(model, f, GreaterThan(0.0))
add_constraint(model, f, LessThan(0.0))
add_constraint(model, f, EqualTo(0.0))
y, _ = add_constrained_variables(model, Nonnegatives(2))
set(model, ObjectiveSense(), MAX_SENSE)
set(model, ObjectiveFunction{typeof(f)}(), f)
optimize!(model)
end
model = Utilities.CachingOptimizer(
Utilities.UniversalFallback(Utilities.Model{Float64}()),
instantiate(Utilities.MockOptimizer; with_bridge_type = Float64),
)
set(model, Silent(), true)
x = add_variables(model, 3)
add_constraint(model, x[1], ZeroOne())
add_constraint(model, x[2], Integer())
add_constraint(model, x[1], GreaterThan(0.0))
add_constraint(model, x[2], LessThan(0.0))
add_constraint(model, x[3], EqualTo(0.0))
f = 1.0 * x[1] + x[2] + x[3]
add_constraint(model, f, GreaterThan(0.0))
add_constraint(model, f, LessThan(0.0))
add_constraint(model, f, EqualTo(0.0))
y, _ = add_constrained_variables(model, Nonnegatives(2))
set(model, ObjectiveSense(), MAX_SENSE)
set(model, ObjectiveFunction{typeof(f)}(), f)
optimize!(model)
end
end

Expand Down
2 changes: 1 addition & 1 deletion src/Test/test_attribute.jl
Original file line number Diff line number Diff line change
Expand Up @@ -172,7 +172,7 @@ function test_attribute_TimeLimitSec(model::MOI.AbstractOptimizer, ::Config)
try
return MOI.get(model, MOI.TimeLimitSec())
catch err
@assert err isa MOI.GetAttributeNotAllowed(MOI.TimeLimitSec())
@assert err isa MOI.GetAttributeNotAllowed{MOI.TimeLimitSec}
end
return
end
Expand Down
3 changes: 2 additions & 1 deletion src/Utilities/cachingoptimizer.jl
Original file line number Diff line number Diff line change
Expand Up @@ -320,7 +320,8 @@ function MOI.optimize!(m::CachingOptimizer)
for attr in MOI.get(m, MOI.ListOfModelAttributesSet())
if attr isa MOI.AbstractCallback
attach_optimizer(m)
return MOI.optimize!(m)
MOI.optimize!(m)
return
end
end
indexmap, copied = MOI.optimize!(m.optimizer, m.model_cache)
Expand Down
5 changes: 5 additions & 0 deletions src/Utilities/mockoptimizer.jl
Original file line number Diff line number Diff line change
Expand Up @@ -131,6 +131,11 @@
)
end

function MockOptimizer(::Type{T} = Float64; kwargs...) where {T}

Check warning on line 134 in src/Utilities/mockoptimizer.jl

View check run for this annotation

Codecov / codecov/patch

src/Utilities/mockoptimizer.jl#L134

Added line #L134 was not covered by tests
inner = UniversalFallback(Utilities.Model{T}())
return MockOptimizer(inner, T; kwargs...)
end

"""
All user-facing indices are xor'd with this mask to produce unusual indices.
This is good at catching bugs in solvers which assume indices are ordered 1, 2,
Expand Down
3 changes: 1 addition & 2 deletions src/Utilities/universalfallback.jl
Original file line number Diff line number Diff line change
Expand Up @@ -783,8 +783,7 @@ function MOI.set(
ci::MOI.ConstraintIndex{F,S},
value,
) where {F,S}
if MOI.supports_constraint(uf.model, F, S) &&
MOI.supports(uf.model, attr, MOI.ConstraintIndex{F,S})
if _model_supports_attribute(uf.model, attr, MOI.ConstraintIndex{F,S})
MOI.set(uf.model, attr, ci, value)
else
_set(uf, attr, ci, value)
Expand Down
25 changes: 25 additions & 0 deletions test/Test/Test.jl
Original file line number Diff line number Diff line change
Expand Up @@ -246,6 +246,31 @@ function test_error_handler()
return
end

"Test a model that errors getting time limit unless it was previously set"
mutable struct ModelTimeLimitSecErrorIfNotSet <: MOI.AbstractOptimizer
time_limit::Union{Missing,Nothing,Float64}
end

MOI.supports(::ModelTimeLimitSecErrorIfNotSet, ::MOI.TimeLimitSec) = true

function MOI.get(model::ModelTimeLimitSecErrorIfNotSet, attr::MOI.TimeLimitSec)
if model.time_limit === missing
throw(MOI.GetAttributeNotAllowed(attr))
end
return model.time_limit::Union{Nothing,Float64}
end

function MOI.set(model::ModelTimeLimitSecErrorIfNotSet, ::MOI.TimeLimitSec, v)
model.time_limit = v
return
end

function test_attribute_TimeLimitSec()
model = ModelTimeLimitSecErrorIfNotSet(missing)
MOI.Test.test_attribute_TimeLimitSec(model, MOI.Test.Config())
return
end

end # module

TestTest.runtests()
62 changes: 62 additions & 0 deletions test/Utilities/cachingoptimizer.jl
Original file line number Diff line number Diff line change
Expand Up @@ -1403,6 +1403,68 @@ function test_pass_nonvariable_constraints()
return
end

function test_optimize_abstract_callback()
inner = MOI.Utilities.UniversalFallback(MOI.Utilities.Model{Float64}())
optimizer = MOI.Utilities.MockOptimizer(inner)
model = MOI.Utilities.CachingOptimizer(
MOI.Utilities.UniversalFallback(MOI.Utilities.Model{Float64}()),
optimizer,
)
x, _ = MOI.add_constrained_variable(model, MOI.Integer())
function callback_fn(cb_data)
_ = MOI.submit(model, MOI.HeuristicSolution(cb_data), [x], [1.0])
return
end
MOI.set(model, MOI.HeuristicCallback(), callback_fn)
MOI.optimize!(model)
@test model.state == MOI.Utilities.ATTACHED_OPTIMIZER
@test optimizer.optimize_called
return
end

struct ErrorOnSetAttributeModel <: MOI.ModelLike end

MOI.is_empty(::ErrorOnSetAttributeModel) = true

function MOI.copy_to(::ErrorOnSetAttributeModel, src::MOI.ModelLike)
return MOI.Utilities.identity_index_map(src)
end

function MOI.set(
::ErrorOnSetAttributeModel,
::MOI.ObjectiveSense,
::MOI.OptimizationSense,
)
return error("Something other than unsupported model attribute")
end

function MOI.set(
::ErrorOnSetAttributeModel,
::MOI.VariablePrimalStart,
::MOI.VariableIndex,
::Float64,
)
return error("Something other than unsupported variable attribute")
end

function test_rethrow_set_model_attribute()
model = MOI.Utilities.CachingOptimizer(
MOI.Utilities.UniversalFallback(MOI.Utilities.Model{Float64}()),
ErrorOnSetAttributeModel(),
)
x = MOI.add_variable(model)
MOI.Utilities.attach_optimizer(model)
@test_throws(
ErrorException("Something other than unsupported model attribute"),
MOI.set(model, MOI.ObjectiveSense(), MOI.MIN_SENSE),
)
@test_throws(
ErrorException("Something other than unsupported variable attribute"),
MOI.set(model, MOI.VariablePrimalStart(), x, 1.0),
)
return
end

end # module

TestCachingOptimizer.runtests()
22 changes: 22 additions & 0 deletions test/Utilities/mockoptimizer.jl
Original file line number Diff line number Diff line change
Expand Up @@ -285,6 +285,28 @@ function test_is_set_by_optimize_optimizer_attribute()
return
end

function test_empty_constructor()
mock = MOI.Utilities.MockOptimizer(Int; supports_names = false)
@test mock.supports_names == false
@test isa(
mock,
MOI.Utilities.MockOptimizer{
MOI.Utilities.UniversalFallback{MOI.Utilities.Model{Int}},
Int,
},
)
mock = MOI.Utilities.MockOptimizer()
@test mock.supports_names
@test isa(
mock,
MOI.Utilities.MockOptimizer{
MOI.Utilities.UniversalFallback{MOI.Utilities.Model{Float64}},
Float64,
},
)
return
end

end # module

TestMockOptimizer.runtests()
14 changes: 14 additions & 0 deletions test/Utilities/universalfallback.jl
Original file line number Diff line number Diff line change
Expand Up @@ -434,6 +434,8 @@ function test_throw_unsupported_variable_constraint()
MOI.UnsupportedConstraint{typeof(x),typeof(set)}(),
MOI.Utilities.throw_unsupported(model),
)
MOI.delete(model, c)
@test MOI.Utilities.throw_unsupported(model) === nothing
return
end

Expand All @@ -447,6 +449,8 @@ function test_throw_unsupported_affine_constraint()
MOI.UnsupportedConstraint{typeof(func),typeof(set)}(),
MOI.Utilities.throw_unsupported(model),
)
MOI.delete(model, c)
@test MOI.Utilities.throw_unsupported(model) === nothing
return
end

Expand Down Expand Up @@ -516,6 +520,16 @@ function test_delete_ci_attribute()
return
end

function test_set_inner_constraint_attribute()
inner = MOI.Utilities.UniversalFallback(MOI.Utilities.Model{Float64}())
model = MOI.Utilities.UniversalFallback(inner)
x = MOI.add_variable(model)
c = MOI.add_constraint(model, x, MOI.GreaterThan(1.0))
MOI.set(model, MOI.ConstraintPrimalStart(), c, 1.0)
@test MOI.get(model, MOI.ConstraintPrimalStart(), c) == 1.0
return
end

end # module

TestUniversalFallback.runtests()
Loading