cli:configmanager: rename _copy_tree() to copy_tree()

Author: slyon

netplan_cli/cli/commands/try_command.py

@@ -139,7 +139,7 @@ def revert(self):  # pragma: nocover (requires user input)
         tempdir = tempfile.mkdtemp()
         confdir = os.path.join(tempdir, 'etc', 'netplan')
         os.makedirs(confdir)
-        self.config_manager._copy_tree('/etc/netplan', confdir, dirs_exist_ok=True)
+        self.config_manager.copy_tree('/etc/netplan', confdir, dirs_exist_ok=True)
         # restore previous state
         self.config_manager.revert()
         NetplanApply().command_apply(run_generate=False, sync=True, exit_on_error=False, state_dir=tempdir)

netplan_cli/configmanager.py

@@ -104,14 +104,14 @@ def add(self, config_dict):
 
     def backup(self, backup_config_dir=True):
         if backup_config_dir:
-            self._copy_tree(os.path.join(self.prefix, "etc/netplan"),
-                            os.path.join(self.temp_etc, "netplan"))
-        self._copy_tree(os.path.join(self.prefix, "run/NetworkManager/system-connections"),
-                        os.path.join(self.temp_run, "NetworkManager", "system-connections"),
-                        missing_ok=True)
-        self._copy_tree(os.path.join(self.prefix, "run/systemd/network"),
-                        os.path.join(self.temp_run, "systemd", "network"),
-                        missing_ok=True)
+            self.copy_tree(os.path.join(self.prefix, "etc/netplan"),
+                           os.path.join(self.temp_etc, "netplan"))
+        self.copy_tree(os.path.join(self.prefix, "run/NetworkManager/system-connections"),
+                       os.path.join(self.temp_run, "NetworkManager", "system-connections"),
+                       missing_ok=True)
+        self.copy_tree(os.path.join(self.prefix, "run/systemd/network"),
+                       os.path.join(self.temp_run, "systemd", "network"),
+                       missing_ok=True)
 
     def revert(self):
         try:
@@ -122,12 +122,12 @@ def revert(self):
             temp_networkd_path = "{}/systemd/network".format(self.temp_run)
             if os.path.exists(temp_nm_path):
                 shutil.rmtree(os.path.join(self.prefix, "run/NetworkManager/system-connections"))
-                self._copy_tree(temp_nm_path,
-                                os.path.join(self.prefix, "run/NetworkManager/system-connections"))
+                self.copy_tree(temp_nm_path,
+                               os.path.join(self.prefix, "run/NetworkManager/system-connections"))
             if os.path.exists(temp_networkd_path):
                 shutil.rmtree(os.path.join(self.prefix, "run/systemd/network"))
-                self._copy_tree(temp_networkd_path,
-                                os.path.join(self.prefix, "run/systemd/network"))
+                self.copy_tree(temp_networkd_path,
+                               os.path.join(self.prefix, "run/systemd/network"))
         except Exception as e:  # pragma: nocover (only relevant to filesystem failures)
             # If we reach here, we're in big trouble. We may have wiped out
             # file NM or networkd are using, and we most likely removed the
@@ -152,7 +152,7 @@ def __del__(self):
     def _copy_file(self, src, dst):
         shutil.copy(src, dst)
 
-    def _copy_tree(self, src, dst, missing_ok=False, **kwargs):
+    def copy_tree(self, src, dst, missing_ok=False, **kwargs):
         try:
             shutil.copytree(src, dst, copy_function=copy_with_ownership, **kwargs)
         except FileNotFoundError:

tests/test_configmanager.py

@@ -332,12 +332,12 @@ def test_cleanup_and_destruction(self):
         del self.configmanager
         self.assertFalse(os.path.exists(backup_dir))
 
-    def test__copy_tree(self):
-        self.configmanager._copy_tree(os.path.join(self.workdir.name, "etc"),
-                                      os.path.join(self.workdir.name, "etc2"))
+    def test_copy_tree(self):
+        self.configmanager.copy_tree(os.path.join(self.workdir.name, "etc"),
+                                     os.path.join(self.workdir.name, "etc2"))
         self.assertTrue(os.path.exists(os.path.join(self.workdir.name, "etc2/netplan/test.yaml")))
 
-    def test__copy_tree_missing_source(self):
+    def test_copy_tree_missing_source(self):
         with self.assertRaises(FileNotFoundError):
-            self.configmanager._copy_tree(os.path.join(self.workdir.name, "nonexistent"),
-                                          os.path.join(self.workdir.name, "nonexistent2"), missing_ok=False)
+            self.configmanager.copy_tree(os.path.join(self.workdir.name, "nonexistent"),
+                                         os.path.join(self.workdir.name, "nonexistent2"), missing_ok=False)