Changeset 40944

Timestamp:

Oct 14, 2019, 4:59:32 PM (7 years ago)

Author:

fairlamb

Message:

Tidy up tests, and removed now unused files

Location:

branches/ipp-259_genericise_backups/tools/backups

Files:

• backup.py (modified) (1 diff)
• backup_test.py (modified) (1 diff)
• confluence_backup.config (deleted)
• confluence_backup.py (modified) (2 diffs)
• confluence_backup_test.py (modified) (5 diffs)
• fixture_test.py (deleted)
• full_atlassian_backup_test.py (deleted)
• jira_backup.config (deleted)
• jira_backup.py (modified) (2 diffs)
• jira_backup_test.py (modified) (2 diffs)
• testing/full_backup_config.config (deleted)

branches/ipp-259_genericise_backups/tools/backups/backup.py

@@ -29 +29 @@
 
         config = ConfigParser()
+        expected_class = configparser.ConfigParser
         if config_class_or_filepath is None:
-            raise errs.ConfigError(config_class_or_filepath, "Neither config settings or filepath of config given")
-        elif isinstance(config_class_or_filepath, configparser.ConfigParser):
+            raise errs.ValidationError("ValidationError: config settings or filepath to config must be given")
+        elif isinstance(config_class_or_filepath, expected_class):
             config = config_class_or_filepath
-        elif path.exists(config_class_or_filepath):
-            config.read(config_class_or_filepath)
+        elif not path.exists(config_class_or_filepath):
+            raise errs.ValidationError(f"ValidationError: Config filepath does not exist (or incorrect class given, expected: {expected_class})")
+        config.read(config_class_or_filepath)
 
         self.read_default_section(config)

branches/ipp-259_genericise_backups/tools/backups/backup_test.py

@@ -103 +103 @@
     def test_failure_if_no_defaults_provided(self):
         config = ConfigParser()
-        with pytest.raises(errs.ConfigError):
+        with pytest.raises(errs.ConfigError) as e_empty:
             Backup(config_file=config)
-
-        with pytest.raises(errs.ValidationError):
+        assert "is required but was not found in config" in str(e_empty)
+
+        with pytest.raises(errs.ValidationError) as e_none:
             Backup(config_file=None)
-
-        with pytest.raises(errs.ConfigError):
+        assert "ValidationError: Backup class must be given a config" in str(e_none)
+
+        with pytest.raises(errs.ValidationError) as e_nofile:
             Backup(config_file="/not/a/real/file.config")
+        assert "ValidationError: Config filepath does not exist" in str(e_nofile)
 
     def test_nothing_should_be_set_to_run_if_not_present(self, tmpdir):

branches/ipp-259_genericise_backups/tools/backups/confluence_backup.py

@@ -8 +8 @@
 from backups.backup import Backup
 
-DEFAULT_CONFIG_FILE = path.join(path.dirname(__file__), 'confluence_backup.config')
+EXPECTED_CONFIG_FILE = path.join(path.dirname(__file__), './confluence_backup.config')
 
 
 class ConfluenceBackup(Backup):
 
-    def __init__(self, config_file=DEFAULT_CONFIG_FILE):
+    def __init__(self, config_file=EXPECTED_CONFIG_FILE):
         self.load_config(config_file)
 
@@ -69 +69 @@
         nargs='?',
         help='specify the location of a config that matches the ConfigSchema',
-        default=DEFAULT_CONFIG_FILE)
+        default=EXPECTED_CONFIG_FILE)
 
     return parser.parse_args()

branches/ipp-259_genericise_backups/tools/backups/confluence_backup_test.py

@@ -12 +12 @@
 
 
-JIRA_TEST_CONFIG = os.path.join(os.path.dirname(__file__), './testing/confluence_test.config')
+CONF_TEST_CONFIG = os.path.join(os.path.dirname(__file__), './testing/confluence_test.config')
 
 
@@ -113 +113 @@
 
     def test_load_from_config_file(self):
-        jb = ConfluenceBackup(config_file=JIRA_TEST_CONFIG)
+        jb = ConfluenceBackup(config_file=CONF_TEST_CONFIG)
         self.assert_defaults(jb)
 
-    def test_default_config_loads_with_no_args(self):
-        default_config = jbck_mod.DEFAULT_CONFIG_FILE
-        assert os.path.exists(default_config)
-        jb = ConfluenceBackup()
-        self.assert_defaults(jb)
+    def test_default_config_fails_to_load_if_the_file_does_not_exist(self):
+        default_config = jbck_mod.EXPECTED_CONFIG_FILE
+        assert not os.path.exists(default_config)
+
+        with pytest.raises(errs.ValidationError) as e:
+            ConfluenceBackup()
+        assert "ValidationError: Config filepath does not exist" in str(e)
 
     def test_default_arguments(self):
-        jb = ConfluenceBackup(config_file=JIRA_TEST_CONFIG)
+        jb = ConfluenceBackup(config_file=CONF_TEST_CONFIG)
         self.assert_defaults(jb)
 
@@ -166 +168 @@
 
     def test_nonexistant_config_file_raises_error(self):
-        with pytest.raises(errs.ConfigError):
+        with pytest.raises(errs.ValidationError) as e:
             ConfluenceBackup("not a real file path")
+        assert "ValidationError: Config filepath does not exist" in str(e)
 
     def test_main_loads_default_and_fails_due_to_missing_paths(self):
         with pytest.raises(errs.ValidationError) as e:
             jbck_mod.main()
-        assert "ValidationError: target path does not exist:" in str(e)
+        assert "ValidationError: Config filepath does not exist" in str(e)
 
 
@@ -180 +183 @@
 
     def test_get_confluence_backup_date_format(self):
-        jb = ConfluenceBackup(config_file=JIRA_TEST_CONFIG)
+        jb = ConfluenceBackup(config_file=CONF_TEST_CONFIG)
         today = datetime.date.today()
         expected_format = today.strftime("%Y_%m_%d")
@@ -190 +193 @@
 
     def test_copying_fails_if_paths_not_present(self):
-        jb = ConfluenceBackup(config_file=JIRA_TEST_CONFIG)
+        jb = ConfluenceBackup(config_file=CONF_TEST_CONFIG)
         # return_value = jb._copy_confluence_backup()
         with pytest.raises(ValidationError) as e:

branches/ipp-259_genericise_backups/tools/backups/jira_backup.py

@@ -8 +8 @@
 from backups.backup import Backup
 
-DEFAULT_CONFIG_FILE = path.join(path.dirname(__file__), 'jira_backup.config')
+EXPECTED_CONFIG_FILE = path.join(path.dirname(__file__), './jira_backup.config')
 
 
 class JiraBackup(Backup):
 
-    def __init__(self, config_file=DEFAULT_CONFIG_FILE):
+    def __init__(self, config_file=EXPECTED_CONFIG_FILE):
         self.load_config(config_file)
 
@@ -69 +69 @@
         nargs='?',
         help='specify the location of a config that matches the ConfigSchema',
-        default=DEFAULT_CONFIG_FILE)
+        default=EXPECTED_CONFIG_FILE)
 
     return parser.parse_args()

branches/ipp-259_genericise_backups/tools/backups/jira_backup_test.py

@@ -116 +116 @@
         self.assert_defaults(jb)
 
-    def test_default_config_loads_with_no_args(self):
-        default_config = jbck_mod.DEFAULT_CONFIG_FILE
-        assert os.path.exists(default_config)
-        jb = JiraBackup()
-        self.assert_defaults(jb)
+    def test_default_config_fails_to_load_if_the_file_does_not_exist(self):
+        default_config = jbck_mod.EXPECTED_CONFIG_FILE
+        assert not os.path.exists(default_config)
+
+        with pytest.raises(errs.ValidationError) as e:
+            JiraBackup()
+        assert "ValidationError: Config filepath does not exist" in str(e)
 
     def test_default_arguments(self):
@@ -166 +168 @@
 
     def test_nonexistant_config_file_raises_error(self):
-        with pytest.raises(errs.ConfigError):
+        with pytest.raises(errs.ValidationError) as e:
             JiraBackup("not a real file path")
+        assert "ValidationError: Config filepath does not exist" in str(e)
 
     def test_main_loads_default_and_fails_due_to_missing_paths(self):
         with pytest.raises(errs.ValidationError) as e:
             jbck_mod.main()
-        assert "ValidationError: target path does not exist:" in str(e)
+        assert "ValidationError: Config filepath does not exist" in str(e)