From 3d89b8c367555f46d62e25063f8d4af910de169f Mon Sep 17 00:00:00 2001
From: torressa <23246013+torressa@users.noreply.github.com>
Date: Wed, 18 Sep 2024 10:31:55 +0100
Subject: [PATCH] Add tests for solcheck CLI

---
 src/gurobi_modelanalyzer/solcheck.py |   3 +-
 tests/test_solcheck.py               | 120 +++++++++++++++++++++++++++
 2 files changed, 122 insertions(+), 1 deletion(-)

diff --git a/src/gurobi_modelanalyzer/solcheck.py b/src/gurobi_modelanalyzer/solcheck.py
index c716fd8..e379866 100644
--- a/src/gurobi_modelanalyzer/solcheck.py
+++ b/src/gurobi_modelanalyzer/solcheck.py
@@ -233,7 +233,6 @@ def optimize(self):
 def main_cli():
     import argparse
     import gurobipy as gp
-    import questionary as qy
 
     parser = argparse.ArgumentParser(
         prog="gurobi_solcheck", description="Check if a solution is feasible"
@@ -266,6 +265,8 @@ def main_cli():
     if args.model:
         mfn = args.model
     else:
+        import questionary as qy
+
         print("Entering interactive mode")
         mfn = qy.path(
             "Select a model file",
diff --git a/tests/test_solcheck.py b/tests/test_solcheck.py
index 509ede6..eead011 100644
--- a/tests/test_solcheck.py
+++ b/tests/test_solcheck.py
@@ -1,5 +1,8 @@
 import io
+import os
 import pathlib
+import hashlib
+import subprocess
 import contextlib
 from unittest import TestCase
 
@@ -7,6 +10,7 @@
 from gurobi_modelanalyzer import SolCheck
 
 here = pathlib.Path(__file__).parent
+cwd = pathlib.Path(os.getcwd())
 
 
 class TestSolCheck(TestCase):
@@ -77,3 +81,119 @@ def test_infeasible_solution(self):
                 abs_sum_violations += abs(c._Violation)
 
         self.assertEqual(abs_sum_violations, 1.5)
+
+
+class TestSolCheckCLI(TestCase):
+    def setUp(self):
+        self.afirofix_md5 = "f265f0c9554f2b480092757a83e47207"
+
+    def tearDown(self):
+        output_files = [
+            cwd.joinpath("afirofix.sol"),
+            cwd.joinpath("misc07fix.vio"),
+            cwd.joinpath("misc07fix.sol"),
+            cwd.joinpath("misc07fix.ilp"),
+        ]
+        for file in output_files:
+            if file.exists():
+                os.remove(file)
+
+    def test_suboptimal_solution(self):
+        afirofix_file = cwd.joinpath("afirofix.sol")
+        self.assertFalse(afirofix_file.exists())
+        cmd = (
+            f"gurobi_solcheck --model {str(here / 'dataset' / 'afiro.mps')} "
+            + f"--sol {str(here / 'dataset' / 'afiro.sol')} --result afirofix"
+        )
+        result = subprocess.getoutput(cmd)
+        self.assertIn(
+            "Solution is feasible for feasibility tolerance of 1e-06",
+            result,
+        )
+        self.assertIn("Difference: -5.0613", result)
+        self.assertTrue(afirofix_file.exists())
+
+        md5_ret = None
+        with open(afirofix_file, "rb") as f:
+            d = f.read()
+            md5_ret = hashlib.md5(d).hexdigest()
+
+        self.assertEqual(self.afirofix_md5, md5_ret)
+
+    def test_infeasible_solution(self):
+        misc07fix_vio_file = cwd.joinpath("misc07fix.vio")
+        self.assertFalse(misc07fix_vio_file.exists())
+        cmd = (
+            f"gurobi_solcheck --model {str(here / 'dataset' / 'misc07.mps')} "
+            + f"--sol {str(here / 'dataset' / 'misc07.sol')} --result misc07fix"
+        )
+        result = subprocess.getoutput(cmd)
+        self.assertTrue(misc07fix_vio_file.exists())
+
+        # Check log for expected output
+        self.assertIn(
+            "Model is infeasible",
+            result,
+        )
+        self.assertIn(
+            "Solution is infeasible for feasibility tolerance of 1e-06",
+            result,
+        )
+        self.assertIn(
+            "Relaxing to find smallest violation from fixed solution",
+            result,
+        )
+        self.assertIn(
+            "Fixed values are 1.5 from a feasible solution",
+            result,
+        )
+
+    def test_infeasible_solution_infmethodV(self):
+        misc07fix_sol_file = cwd.joinpath("misc07fix.sol")
+        self.assertFalse(misc07fix_sol_file.exists())
+        cmd = (
+            f"gurobi_solcheck --model {str(here / 'dataset' / 'misc07.mps')} "
+            + f"--sol {str(here / 'dataset' / 'misc07.sol')} --result misc07fix "
+            + "--infmethod V "
+        )
+        result = subprocess.getoutput(cmd)
+        self.assertTrue(misc07fix_sol_file.exists())
+
+        # Check log for expected output
+        self.assertIn(
+            "Model is infeasible",
+            result,
+        )
+        self.assertIn(
+            "Relaxing to find smallest violation from fixed solution",
+            result,
+        )
+        self.assertIn(
+            "Fixed values are 409.5 from a feasible solution",
+            result,
+        )
+
+    def test_infeasible_solution_infmethodI(self):
+        misc07fix_ilp_file = cwd.joinpath("misc07fix.ilp")
+        self.assertFalse(misc07fix_ilp_file.exists())
+        cmd = (
+            f"gurobi_solcheck --model {str(here / 'dataset' / 'misc07.mps')} "
+            + f"--sol {str(here / 'dataset' / 'misc07.sol')} --result misc07fix "
+            + "--infmethod I "
+        )
+        result = subprocess.getoutput(cmd)
+        self.assertTrue(misc07fix_ilp_file.exists())
+
+        # Check log for expected output
+        self.assertIn(
+            "Model is infeasible",
+            result,
+        )
+        self.assertIn(
+            "Solution is infeasible for feasibility tolerance of 1e-06",
+            result,
+        )
+        self.assertIn(
+            "Computing Irreducible Inconsistent Subsystem (IIS)",
+            result,
+        )