Add fixture to tear down configs and make sure project init folders are not written.

Author: JoeZiminski

tests/test_utils.py

@@ -108,7 +108,9 @@ def delete_all_folders_in_project_path(project, local_or_central):
     """"""
     folder = f"{local_or_central}_path"
 
-    if folder == "central_path" and project.cfg[folder] is None:
+    if project.cfg is None or (
+        folder == "central_path" and project.cfg[folder] is None
+    ):
         return
 
     ds_logger.close_log_filehandler()

tests/tests_regression/test_backwards_compatibility.py

@@ -1,29 +1,40 @@
+import os
 import shutil
 from pathlib import Path
 
 import pytest
+import test_utils
 
 from datashuttle import DataShuttle
 
+TEST_PROJECT_NAME = "test_project"
+
 
 class TestBackwardsCompatibility:
 
     @pytest.fixture(scope="function")
     def project(self):
-        """ """
-        project = DataShuttle("test_project")
+        """
+        Delete the project configs if they exist,
+        and tear down after the test has run.
+        """
+        test_utils.delete_project_if_it_exists(TEST_PROJECT_NAME)
+
+        project = DataShuttle(TEST_PROJECT_NAME)
 
         yield project
 
-    def test_v0_6_0(self):
+        test_utils.delete_project_if_it_exists(TEST_PROJECT_NAME)
+
+    def test_v0_6_0(self, project, tmp_path):
         """
         v0.6.0 is the first version with narrow datatypes, and the checkboxes was refactored to
         be a {"on": bool, "displayed": bool} dict rather than a bool indicating whether the checkbox is on.
         However, this version is missing narrow datatypes added later (e.g. "motion").
         In the test file, all 'displayed' are turned off except f2pe.
         """
         reloaded_ver_configs, reloaded_ver_persistent_settings = (
-            self.load_and_check_old_version_yamls("v0.6.0")
+            self.load_and_check_old_version_yamls(project, tmp_path, "v0.6.0")
         )
 
         assert reloaded_ver_configs["local_path"] == Path("old_ver")
@@ -43,13 +54,13 @@ def test_v0_6_0(self):
         for key in transfer_checkboxes.keys():
             assert transfer_checkboxes[key]["displayed"] is (key == "f2pe")
 
-    def test_v0_5_3(self):
+    def test_v0_5_3(self, project, tmp_path):
         """
         This version did not have narrow datatypes, and the persistent checkbox setting was only a
         bool. Therefore, the "displayed" uses the canonical defaults (because they don't exist in the file yet).
         """
         reloaded_ver_configs, reloaded_ver_persistent_settings = (
-            self.load_and_check_old_version_yamls("v0.5.3")
+            self.load_and_check_old_version_yamls(project, tmp_path, "v0.5.3")
         )
 
         assert reloaded_ver_configs["local_path"] == Path("old_ver")
@@ -70,14 +81,18 @@ def test_v0_5_3(self):
         assert transfer_checkboxes["motion"]["displayed"] is False
         assert transfer_checkboxes["f2pe"]["displayed"] is False
 
-    def load_and_check_old_version_yamls(self, datashuttle_version):
+    def load_and_check_old_version_yamls(
+        self, project, tmp_path, datashuttle_version
+    ):
         """
         Load an old config file in the current datashuttle version,
         and check that the new-version ('canonical') configs
         and persistent settings match the structure of the
         files loaded from the old datashuttle version.
         """
-        project = DataShuttle("test_project")
+        # Switch dir so folders created in `DataShuttle` init do
+        # not pollute the users test drive.
+        os.chdir(tmp_path)
 
         # Set up paths and clear any existing config files for this project
         old_version_path = (
@@ -92,7 +107,7 @@ def load_and_check_old_version_yamls(self, datashuttle_version):
 
         # In the current version of datashuttle, get the settings. These are
         # thus correct for the most recent datashuttle version.
-        project = DataShuttle("test_project")
+        project = DataShuttle(TEST_PROJECT_NAME)
         project.make_config_file("cur_ver", "cur_ver", "local_filesystem")
 
         current_ver_configs = project.get_configs()
@@ -105,7 +120,7 @@ def load_and_check_old_version_yamls(self, datashuttle_version):
         shutil.copy(old_version_path / "config.yaml", config_path)
         shutil.copy(old_version_path / "persistent_settings.yaml", config_path)
 
-        project = DataShuttle("test_project")
+        project = DataShuttle(TEST_PROJECT_NAME)
 
         reloaded_ver_configs = project.get_configs()
         reloaded_ver_persistent_settings = project._load_persistent_settings()