Add tests for relocated_module()

Author: jsiirola

pyomo/common/tests/relo_mod.py

@@ -0,0 +1,14 @@
+#  ___________________________________________________________________________
+#
+#  Pyomo: Python Optimization Modeling Objects
+#  Copyright (c) 2008-2022
+#  National Technology and Engineering Solutions of Sandia, LLC
+#  Under the terms of Contract DE-NA0003525 with National Technology and
+#  Engineering Solutions of Sandia, LLC, the U.S. Government retains certain
+#  rights in this software.
+#  This software is distributed under the 3-clause BSD License.
+#  ___________________________________________________________________________
+
+from pyomo.common.deprecation import relocated_module
+
+relocated_module('pyomo.common.tests.relo_mod_new', version='1.2')

pyomo/common/tests/relo_mod_new.py

@@ -0,0 +1,14 @@
+#  ___________________________________________________________________________
+#
+#  Pyomo: Python Optimization Modeling Objects
+#  Copyright (c) 2008-2022
+#  National Technology and Engineering Solutions of Sandia, LLC
+#  Under the terms of Contract DE-NA0003525 with National Technology and
+#  Engineering Solutions of Sandia, LLC, the U.S. Government retains certain
+#  rights in this software.
+#  This software is distributed under the 3-clause BSD License.
+#  ___________________________________________________________________________
+
+RELO_ATTR = 42
+
+class ReloClass(object): pass

pyomo/common/tests/test_deprecated.py

@@ -425,6 +425,25 @@ def test_relocated_message(self):
             "DEPRECATED: the 'oldName' class has been moved to "
             "'pyomo.common.tests.test_deprecated.TestRelocated'")
 
+    def test_relocated_module(self):
+        with LoggingIntercept() as LOG:
+            # Can import attributes defined only in the new module
+            from pyomo.common.tests.relo_mod import ReloClass
+        self.assertRegex(
+            LOG.getvalue().replace('\n', ' '),
+            r"DEPRECATED: The 'pyomo\.common\.tests\.relo_mod' module has "
+            r"been moved to 'pyomo\.common\.tests\.relo_mod_new'. Please "
+            r"update your import. \(deprecated in 1\.2\) \(called from "
+            r".*/pyomo/common/tests/test_deprecated\.py")
+        with LoggingIntercept() as LOG:
+            # Second import: no warning
+            import pyomo.common.tests.relo_mod as relo
+        self.assertEqual(LOG.getvalue(), '')
+        import pyomo.common.tests.relo_mod_new as relo_new
+        self.assertIs(relo, relo_new)
+        self.assertEqual(relo.RELO_ATTR, 42)
+        self.assertIs(ReloClass, relo_new.ReloClass)
+
 
 class TestRenamedClass(unittest.TestCase):
     def test_renamed(self):