Validate config during upgrades if possible

Author: LinuxMercedes

assigner/config/__init__.py

@@ -3,7 +3,7 @@
 
 from collections import UserDict
 
-from assigner.config.versions import upgrade, validate, ValidationError
+from assigner.config.versions import upgrade, validate, ValidationError, VersionError
 
 
 class DuplicateUserError(Exception):
@@ -35,6 +35,10 @@ def __init__(self, filename):
             validate(self.data)
         except ValidationError as e:
             logging.warning("Your configuration is not valid: %s", e.message)
+        except VersionError as e:
+            logging.warning(e)
+            logging.warning("Is your installation of Assigner up to date?")
+            logging.warning("Attempting to continue anyway...")
 
     def __enter__(self):
         return self

assigner/config/versions.py

@@ -11,8 +11,22 @@ class ValidationError(jsonschema.ValidationError):
     pass
 
 
-def validate(config, version=(len(SCHEMAS) - 1)):
-    assert version < len(SCHEMAS)
+class VersionError(Exception):
+    pass
+
+
+class UpgradeError(Exception):
+    pass
+
+
+def validate(config, version=None):
+    if version is None:
+        version = get_version(config)
+
+    if version >= len(SCHEMAS):
+        raise VersionError(
+            "Configuration version %d is newer than latest known configuration version %d" % (version, len(SCHEMAS) - 1)
+        )
 
     try:
         jsonschema.validate(config, SCHEMAS[version])
@@ -35,16 +49,40 @@ def upgrade(config):
     latest = len(SCHEMAS) - 1
 
     if current > latest:
-        logger.warning("Configuration version %d is newer than latest known configuration version %d", current, latest)
-        logger.warning("Is your installation of Assigner up to date?")
-        logger.warning("Attempting to continue anyway...")
         return config
 
     if current != latest:
         logger.info("Migrating configuration from version %d to version %d.", current, latest)
 
+    # Determine whether we should look for upgrade-caused
+    # validation errors. If the initial config doesn't validate,
+    # we can't tell whether upgrading has made things worse, but
+    # we'll try anyway.
+    try:
+        validate(config, current)
+        is_valid = True
+    except ValidationError:
+        is_valid = False
+
     for version in range(current, latest):
         config = UPGRADES[version](config)
+
+        # Upgrade validation.
+        # Upgrades should be rare, so we can afford to be very particular about them.
         assert get_version(config) == version + 1
+        if is_valid:
+            try:
+                validate(config, version + 1)
+            except ValidationError as e:
+                # pylint: disable=bad-continuation
+                raise UpgradeError(
+"""
+Upgrading configuration from version %d to %d resulted in an invalid configuration:
+%s
+
+This is a bug. Please file an issue at https://github.com/redkyn/assigner/issues with your configuration.
+Your original configuration has been restored.
+""" % (version, version + 1, e.message)
+                )
 
     return config

assigner/tests/config_test.py

@@ -1,6 +1,6 @@
 from assigner.tests.utils import AssignerTestCase
 
-from assigner.config.versions import validate, get_version, upgrade, ValidationError
+from assigner.config.versions import validate, get_version, upgrade, ValidationError, VersionError
 from assigner.config.upgrades import UPGRADES
 from assigner.config.schemas import SCHEMAS
 
@@ -41,6 +41,7 @@
     },
 ]
 
+TOO_NEW_CONFIG = {"version": len(SCHEMAS)}
 
 class UpgradeTester(AssignerTestCase):
     def test_that_we_are_testing_all_schemas_and_upgrades(self):
@@ -86,3 +87,7 @@ def test_empty_config_upgrade(self):
         for config in EMPTY_CONFIGS:
             config = upgrade(config)
             self.assertEqual(config, EMPTY_CONFIGS[-1])
+
+    def test_too_new_config(self):
+        with self.assertRaises(VersionError):
+            validate(TOO_NEW_CONFIG)