enable doc / example tests in CI (#820)

* run doc tests in CI

* add `assert False` to verify doc tests run in CI

* remove `assert False`

Author: frrad

.github/workflows/pythonpackage.yml

@@ -47,4 +47,6 @@ jobs:
           version: '9.2.1'
           command: "sudo apt install -qq ./SCIPOptSuite-9.2.1-Linux-ubuntu24.deb"
       - name: Test with pulptest
+        env:
+          PYTHONPATH: .
         run: uv run --all-extras pulp/tests/run_tests.py

pulp/tests/run_tests.py

@@ -4,35 +4,30 @@
 from pulp.tests import test_examples, test_gurobipy_env, test_pulp, test_sparse
 
 
-def pulpTestAll(test_docs=False):
+def pulpTestAll():
     all_solvers = pulp.listSolvers(onlyAvailable=False)
     available = pulp.listSolvers(onlyAvailable=True)
     print(f"Available solvers: {available}")
     print(f"Unavailable solvers: {set(all_solvers) - set(available)}")
     runner = unittest.TextTestRunner()
-    suite_all = get_test_suite(test_docs)
+    suite_all = get_test_suite()
     # we run all tests at the same time
     ret = runner.run(suite_all)
     if not ret.wasSuccessful():
         raise pulp.PulpError("Tests Failed")
 
 
-def get_test_suite(test_docs: bool = False) -> unittest.TestSuite:
+def get_test_suite() -> unittest.TestSuite:
     loader = unittest.TestLoader()
     suite_all = unittest.TestSuite()
 
+    suite_all.addTests(loader.loadTestsFromTestCase(test_examples.Examples_DocsTests))
     suite_all.addTests(loader.loadTestsFromModule(test_pulp))
     suite_all.addTests(loader.loadTestsFromModule(test_sparse))
     suite_all.addTests(loader.loadTestsFromModule(test_gurobipy_env))
 
-    # We add examples and docs tests
-    if test_docs:
-        suite_all.addTests(
-            loader.loadTestsFromTestCase(test_examples.Examples_DocsTests)
-        )
-
     return suite_all
 
 
 if __name__ == "__main__":
-    pulpTestAll(test_docs=False)
+    pulpTestAll()