Files
ortools-clone/ortools/math_opt/python/normalize_test.py
2024-04-12 17:17:40 +02:00

129 lines
4.8 KiB
Python

#!/usr/bin/env python3
# Copyright 2010-2024 Google LLC
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""Test normalize for mathopt protos."""
from google3.net.proto2.contrib.pyutil import compare
from absl.testing import absltest
from ortools.math_opt import model_parameters_pb2
from ortools.math_opt import model_pb2
from ortools.math_opt import model_update_pb2
from ortools.math_opt import parameters_pb2
from ortools.math_opt import result_pb2
from ortools.math_opt import sparse_containers_pb2
from ortools.math_opt.python import normalize
class MathOptProtoAssertionsTest(absltest.TestCase, compare.Proto2Assertions):
def test_removes_empty_message(self) -> None:
model_with_empty_vars = model_pb2.ModelProto()
model_with_empty_vars.variables.SetInParent()
with self.assertRaisesRegex(AssertionError, ".*variables.*"):
self.assertProto2Equal(model_with_empty_vars, model_pb2.ModelProto())
normalize.math_opt_normalize_proto(model_with_empty_vars)
self.assertProto2Equal(model_with_empty_vars, model_pb2.ModelProto())
def test_keeps_nonempty_message(self) -> None:
model_with_vars = model_pb2.ModelProto()
model_with_vars.variables.ids[:] = [1, 3]
expected = model_pb2.ModelProto()
expected.variables.ids[:] = [1, 3]
normalize.math_opt_normalize_proto(model_with_vars)
self.assertProto2Equal(model_with_vars, expected)
def test_keeps_optional_scalar_at_default_message(self) -> None:
objective = model_update_pb2.ObjectiveUpdatesProto(offset_update=0.0)
normalize.math_opt_normalize_proto(objective)
wrong = model_update_pb2.ObjectiveUpdatesProto()
with self.assertRaisesRegex(AssertionError, ".*offset_update.*"):
self.assertProto2Equal(objective, wrong)
expected = model_update_pb2.ObjectiveUpdatesProto(offset_update=0.0)
self.assertProto2Equal(objective, expected)
def test_recursive_cleanup(self) -> None:
update_rec_empty = model_update_pb2.ModelUpdateProto()
update_rec_empty.variable_updates.lower_bounds.SetInParent()
normalize.math_opt_normalize_proto(update_rec_empty)
self.assertProto2Equal(update_rec_empty, model_update_pb2.ModelUpdateProto())
def test_duration_no_cleanup(self) -> None:
params = parameters_pb2.SolveParametersProto()
params.time_limit.SetInParent()
with self.assertRaisesRegex(AssertionError, ".*time_limit.*"):
normalize.math_opt_normalize_proto(params)
self.assertProto2Equal(params, parameters_pb2.SolveParametersProto())
def test_repeated_scalar_no_cleanup(self) -> None:
vec = sparse_containers_pb2.SparseDoubleVectorProto()
vec.ids[:] = [0, 0]
normalize.math_opt_normalize_proto(vec)
expected = sparse_containers_pb2.SparseDoubleVectorProto()
expected.ids[:] = [0, 0]
self.assertProto2Equal(vec, expected)
def test_reaches_into_map(self) -> None:
model = model_pb2.ModelProto()
model.quadratic_constraints[2].linear_terms.SetInParent()
normalize.math_opt_normalize_proto(model)
expected = model_pb2.ModelProto()
expected.quadratic_constraints[2] # pylint: disable=pointless-statement
self.assertProto2Equal(model, expected)
def test_reaches_into_vector(self) -> None:
params = model_parameters_pb2.ModelSolveParametersProto()
params.solution_hints.add().variable_values.SetInParent()
normalize.math_opt_normalize_proto(params)
expected = model_parameters_pb2.ModelSolveParametersProto()
expected.solution_hints.add()
self.assertProto2Equal(params, expected)
def test_oneof_is_not_cleared(self) -> None:
result = result_pb2.SolveResultProto()
result.gscip_output.SetInParent()
normalize.math_opt_normalize_proto(result)
expected = result_pb2.SolveResultProto()
expected.gscip_output.SetInParent()
self.assertProto2Equal(result, expected)
def test_reaches_into_oneof(self) -> None:
result = result_pb2.SolveResultProto()
result.gscip_output.stats.SetInParent()
normalize.math_opt_normalize_proto(result)
expected = result_pb2.SolveResultProto()
expected.gscip_output.SetInParent()
self.assertProto2Equal(result, expected)
if __name__ == "__main__":
absltest.main()