Rename cnfvar module to cnfvar_old

The new API will replace it and we want to prevent users from being
confused about which to use.

diff --git a/src/arnied_wrapper.py b/src/arnied_wrapper.py
index 4d13c4c..e8ee70e 100644 (file)
--- a/src/arnied_wrapper.py
+++ b/src/arnied_wrapper.py
@@ -55,7 +55,7 @@ import logging
 log = logging.getLogger('pyi2ncommon.arnied_wrapper')
 
 from .cnfline import build_cnfvar
-from . import cnfvar
+from . import cnfvar_old
 from . import sysmisc
 
 
@@ -495,16 +495,16 @@ def get_cnfvar(varname=None, instance=None, data=None, timeout=30, vm=None):
         # the output of "get_cnf" (no json) which is latin1.
         if isinstance(raw, bytes):
             raw = raw.decode("utf-8")
-        cnf = cnfvar.read_cnf_json(raw)
+        cnf = cnfvar_old.read_cnf_json(raw)
     except TypeError as exn:
         log.info("error \"%s\" parsing result of \"%s\"", exn, cmd_line)
         return None
-    except cnfvar.InvalidCNF as exn:
+    except cnfvar_old.InvalidCNF as exn:
         log.info("error \"%s\" validating result of \"%s\"", exn, cmd_line)
         return None
 
     if data is not None:
-        return cnfvar.get_vars(cnf, data=data)
+        return cnfvar_old.get_vars(cnf, data=data)
 
     return cnf
 
@@ -680,9 +680,9 @@ def set_cnf_dynamic(cnf, config_file=None, kind="cnf", timeout=30, vm=None):
     fd = open(config_path, "wb")
     try:
         SET_CNF_METHODS = {
-            "raw": cnfvar.write_cnf_raw,
-            "json": cnfvar.write_cnf_json,
-            "cnf": cnfvar.write_cnf
+            "raw": cnfvar_old.write_cnf_raw,
+            "json": cnfvar_old.write_cnf_json,
+            "cnf": cnfvar_old.write_cnf
         }
         SET_CNF_METHODS[kind](cnf, out=fd)
     except KeyError:

diff --git a/src/cnfvar.py b/src/cnfvar_old.py
similarity index 100%
rename from src/cnfvar.py
rename to src/cnfvar_old.py

diff --git a/src/simple_cnf.py b/src/simple_cnf.py
index cdc4318..03a50f7 100644 (file)
--- a/src/simple_cnf.py
+++ b/src/simple_cnf.py
@@ -67,7 +67,7 @@ import logging
 log = logging.getLogger('pyi2ncommon.simple_cnf')
 
 from . import arnied_wrapper
-from . import cnfvar
+from . import cnfvar_old
 from . import sysmisc
 
 ###############################################################################
@@ -310,7 +310,7 @@ class SimpleCnf(object):
                 new_dict = child.get_single_dict()
                 new_dict['parent'] = number
                 new_children.append(new_dict)
-            cnfvar.renumber_vars({'cnf':new_children}, number)
+            cnfvar_old.renumber_vars({'cnf':new_children}, number)
             children = new_children
         elif number is None:
             number = self._find_new_number(self.__cnfvars)
@@ -364,12 +364,12 @@ class SimpleCnf(object):
 
     def append_file(self, cnf, replacements=None):
         """Append conf var data from file."""
-        return self.append_file_generic(cnfvar.read_cnf, cnf,
+        return self.append_file_generic(cnfvar_old.read_cnf, cnf,
                                         replacements=replacements)
 
     def append_file_json(self, cnf, replacements=None):
         """Append conf var data from json file."""
-        return self.append_file_generic(cnfvar.read_cnf_json, cnf,
+        return self.append_file_generic(cnfvar_old.read_cnf_json, cnf,
                                         replacements=replacements)
 
     def append_guest_vars(self, vm=None, varname=None, replacements=None):
@@ -417,7 +417,7 @@ class SimpleCnf(object):
             filename = arnied_wrapper.generate_config_path(dumped=True)
 
         with open(filename, 'w') as out:
-            cnfvar.output_json({"cnf": current}, out, renumber=True)
+            cnfvar_old.output_json({"cnf": current}, out, renumber=True)
 
         return filename
 
@@ -435,7 +435,7 @@ class SimpleCnf(object):
         current = self.__cnfvars
         if renumber:
             log.info("enforce consistent CNF_LINE numbering")
-            cnfvar.renumber_vars(current)
+            cnfvar_old.renumber_vars(current)
         log.info("inject configuration %s" % "into guest" if vm else "in place")
         arnied_wrapper.set_cnf_dynamic({"cnf": current},
                                        config_file=gen_tmpname(), vm=vm)
@@ -447,7 +447,7 @@ class SimpleCnf(object):
         :returns: config in json format
         :rtype: str
         """
-        return cnfvar.dump_json_string({"cnf": self.__cnfvars}, renumber=True)
+        return cnfvar_old.dump_json_string({"cnf": self.__cnfvars}, renumber=True)
 
     def pretty_print(self, print_func=None):
         """

diff --git a/test/test_cnfvar.py b/test/test_cnfvar_old.py
similarity index 91%
rename from test/test_cnfvar.py
rename to test/test_cnfvar_old.py
index f733700..8efe0a3 100755 (executable)
--- a/test/test_cnfvar.py
+++ b/test/test_cnfvar_old.py
@@ -24,7 +24,7 @@
 import os
 import unittest
 
-from src import cnfvar
+from src import cnfvar_old
 
 #
 #                                  test data
@@ -373,64 +373,64 @@ class CnfVarUnittest(unittest.TestCase):
 
     def test_print_cnf(self):
         with open(os.devnull, "w") as devnull:
-            cnfvar.print_cnf(demo_cnfvar, out=devnull)
+            cnfvar_old.print_cnf(demo_cnfvar, out=devnull)
 
     def test_parse_cnf_simple_str(self):
-        cnf = cnfvar.read_cnf(demo_cnf_group)
+        cnf = cnfvar_old.read_cnf(demo_cnf_group)
         with open(os.devnull, "w") as devnull:
-            cnfvar.print_cnf_json(cnf, out=devnull)
+            cnfvar_old.print_cnf_json(cnf, out=devnull)
 
     def test_parse_cnf_simple_bytes(self):
-        cnf = cnfvar.read_cnf(demo_cnf_group_bytes)
+        cnf = cnfvar_old.read_cnf(demo_cnf_group_bytes)
         with open(os.devnull, "w") as devnull:
-            cnfvar.print_cnf_json(cnf, out=devnull)
+            cnfvar_old.print_cnf_json(cnf, out=devnull)
 
     def test_parse_cnf_nested(self):
-        cnf = cnfvar.read_cnf(demo_cnf_filter)
+        cnf = cnfvar_old.read_cnf(demo_cnf_filter)
         with open(os.devnull, "w") as devnull:
-            cnfvar.print_cnf_json(cnf, out=devnull)
+            cnfvar_old.print_cnf_json(cnf, out=devnull)
 
     def test_parse_cnf_comments(self):
-        cnf = cnfvar.read_cnf(demo_cnf_comments)
+        cnf = cnfvar_old.read_cnf(demo_cnf_comments)
         with open(os.devnull, "w") as devnull:
-            cnfvar.print_cnf_json(cnf, out=devnull)
+            cnfvar_old.print_cnf_json(cnf, out=devnull)
 
     def test_print_cnf_garbage(self):
         try:
             with open(os.devnull, "w") as devnull:
-                cnfvar.print_cnf(demo_invalid_cnfvar, out=devnull)
-        except cnfvar.InvalidCNF:
+                cnfvar_old.print_cnf(demo_invalid_cnfvar, out=devnull)
+        except cnfvar_old.InvalidCNF:
             print ("Caught the duplicate line, bravo!")
 
     def test_read_json_str(self):
-        cnf = cnfvar.read_cnf_json(demo_jsoncnf)
+        cnf = cnfvar_old.read_cnf_json(demo_jsoncnf)
         with open(os.devnull, "w") as devnull:
-            cnfvar.print_cnf(cnf, out=devnull)
+            cnfvar_old.print_cnf(cnf, out=devnull)
 
     def test_read_json_bytes(self):
-        cnf = cnfvar.read_cnf_json(demo_jsoncnf_bytes)
+        cnf = cnfvar_old.read_cnf_json(demo_jsoncnf_bytes)
         with open(os.devnull, "w") as devnull:
-            cnfvar.print_cnf(cnf, out=devnull)
+            cnfvar_old.print_cnf(cnf, out=devnull)
 
     def test_read_json_nonascii(self):
-        cnf = cnfvar.read_cnf_json(demo_nonascii)
+        cnf = cnfvar_old.read_cnf_json(demo_nonascii)
         with open(os.devnull, "wb") as devnull:
-            cnfvar.print_cnf(cnf, out=devnull)
+            cnfvar_old.print_cnf(cnf, out=devnull)
 
     def test_read_json_latin1(self):
-        cnf = cnfvar.read_cnf_json(demo_latin1crap)
+        cnf = cnfvar_old.read_cnf_json(demo_latin1crap)
         with open(os.devnull, "wb") as devnull:
-            cnfvar.print_cnf(cnf, out=devnull)
+            cnfvar_old.print_cnf(cnf, out=devnull)
 
     def test_parse_cnf_quotes(self):
-        cnf = cnfvar.read_cnf(demo_cnf_escaped_quotes)
+        cnf = cnfvar_old.read_cnf(demo_cnf_escaped_quotes)
         with open(os.devnull, "w") as devnull:
-            cnfvar.print_cnf_json(cnf, out=devnull)
+            cnfvar_old.print_cnf_json(cnf, out=devnull)
 
     def test_parse_json_quotes(self):
-        cnf = cnfvar.read_cnf_json(demo_json_escaped_quotes)
+        cnf = cnfvar_old.read_cnf_json(demo_json_escaped_quotes)
         with open(os.devnull, "w") as devnull:
-            cnfvar.print_cnf_json(cnf, out=devnull)
+            cnfvar_old.print_cnf_json(cnf, out=devnull)
 
 
 class CnfVarUnittestVarnameCase(unittest.TestCase):
@@ -452,7 +452,7 @@ class CnfVarUnittestVarnameCase(unittest.TestCase):
             {"instance": 1, "varname": "hypothetical_child",
              "data": "1", "number": 5, "parent": 3, "comment": None}]}
         ]}
-        serialization = cnfvar.dump_json_string(cnf)
+        serialization = cnfvar_old.dump_json_string(cnf)
         self.assertIn('DIALOUT_MODE', serialization)
         self.assertIn('DIALOUT_DEFAULTPROVIDER_REF', serialization)
         self.assertIn('HYPOTHETICAL_CHILD', serialization)
@@ -462,7 +462,7 @@ class CnfVarUnittestVarnameCase(unittest.TestCase):
 
     def test_read_cnf_lowercase(self):
         """Test that after reading, varnames are lowercase."""
-        cnf = cnfvar.read_cnf_json(demo_jsoncnf.encode('latin1'))
+        cnf = cnfvar_old.read_cnf_json(demo_jsoncnf.encode('latin1'))
         for parentvar  in cnf['cnf']:
             self.assertEqual(parentvar['varname'],
                              parentvar['varname'].lower())