Merge pull request #190 from gocept/fix-28/duplicate-attribs

Fail if an attribute is set both in environment and via secrets.

.gitignore

@@ -8,6 +8,7 @@
 .installed.cfg
 .pytest_cache
 .vagrant
+/.tox
 /bin
 /develop-eggs
 /doc/build

CHANGES.md

@@ -4,13 +4,17 @@
 2.3b2 (unreleased)
 ------------------
 
-- NetLoc objects are now comparable. (#88)
+- NetLoc objects are now comparable.
+  ([#88](https://github.com/flyingcircusio/batou/issues/88))
 
 - Render a better error message if gpg failed to decrypt a secrets file.
   ([#123](https://github.com/flyingcircusio/batou/issues/123))
 
-- Support `ls` syntax in mode attributes. (#61)
+- Support `ls` syntax in mode attributes.
+  ([#61](https://github.com/flyingcircusio/batou/issues/61))
 
+- Fail if an attribute is set both in environment and via secrets.
+  ([#28](https://github.com/flyingcircusio/batou/issues/28))
 - Raise exception when calling `batou secrets add` or `batou secrets remove`
   with an unknown environment name.
   ([#143](https://github.com/flyingcircusio/batou/issues/143))

examples/errors/components/component1/component.py

@@ -4,6 +4,7 @@
 class Component1(Component):
 
     do_what_is_needed = Attribute("literal", None)
+    my_attribute = None
 
 
 class Component2(Component):

examples/errors/environments/errors.cfg

@@ -6,6 +6,7 @@ localhost = component1, component2, component3, component4, missingcomponent, cy
 
 [component:component1]
 do_what_is_needed = false
+my_attribute = set in environment
 
 [component:component2]
 this_does_not_exist = True

examples/errors2/components/component1/component.py

@@ -4,6 +4,7 @@
 class Component1(Component):
 
     do_what_is_needed = Attribute("literal", None)
+    my_attribute = None
 
 
 class Component2(Component):

src/batou/__init__.py

@@ -349,6 +349,28 @@ def report(self):
         # TODO provide traceback in debug output
 
 
+class DuplicateOverride(ConfigurationError):
+    """An override for a component attribute was found both in the secrets and
+    in the environment configuration."""
+
+    sort_key = (0,)
+
+    def __init__(self, component, attribute):
+        self.component = component
+        self.attribute = attribute
+
+    def __str__(self):
+        return (f'A value {self.component}.{self.attribute} is defined both in'
+                ' environment and secrets.')
+
+    def report(self):
+        output.error(
+            "Attribute override found both in environment and secrets")
+        output.tabular("Component", self.component, red=True)
+        output.tabular("Attribute", self.attribute, red=True)
+        # TODO provide traceback in debug output
+
+
 class CycleErrorDetected(ConfigurationError):
     """We think we found a cycle in the component dependencies.
     """

src/batou/secrets/__init__.py

@@ -20,8 +20,9 @@
 
 """
 
-from batou import SuperfluousSecretsSection
 from .encryption import EncryptedConfigFile
+from batou import DuplicateOverride
+from batou import SuperfluousSecretsSection
 import os.path
 import glob
 
@@ -50,9 +51,13 @@ def add_secrets_to_environment(environment):
                 if component not in environment.components:
                     environment.exceptions.append(
                         SuperfluousSecretsSection(component))
-                o = environment.overrides.setdefault(component, {})
-                o.update(((k, o.value)
-                          for k, o in config_file.config.items(section_)))
+                overrides = environment.overrides.setdefault(component, {})
+                for k, v in config_file.config.items(section_):
+                    if k in overrides:
+                        environment.exceptions.append(
+                            DuplicateOverride(component, k))
+                    else:
+                        overrides[k] = v.value
 
         # additional_secrets
         prefix = "secrets/{}-".format(environment.name)

src/batou/tests/test_deploy.py

@@ -47,6 +47,10 @@ def test_main_with_errors(capsys):
 ERROR: Override section for unknown component found
  Component: nonexisting-component-section
 
+ERROR: Attribute override found both in environment and secrets
+ Component: component1
+ Attribute: my_attribute
+
 ERROR: Secrets section for unknown component found
  Component: another-nonexisting-component-section
 ======================= DEPLOYMENT FAILED (during load) ========================

src/batou/tests/test_endtoend.py

@@ -43,6 +43,10 @@ def test_example_errors_early():
 ERROR: Override section for unknown component found
  Component: nonexisting-component-section
 
+ERROR: Attribute override found both in environment and secrets
+ Component: component1
+ Attribute: my_attribute
+
 ERROR: Secrets section for unknown component found
  Component: another-nonexisting-component-section
 ======================= DEPLOYMENT FAILED (during load) ========================