Allow Breaking Configuration Inheritance #326

gitlabform/configuration/core.py

@@ -11,7 +11,8 @@
 from yamlpath.common import Parsers
 from yamlpath.wrappers import ConsolePrinter
 
-from gitlabform import EXIT_INVALID_INPUT
+from gitlabform import EXIT_INVALID_INPUT, EXIT_PROCESSING_ERROR
+from ruamel.yaml.comments import CommentedMap
 
 
 class ConfigurationCore(ABC):
@@ -162,13 +163,64 @@ def is_group_skipped(self, group) -> bool:
     def is_skipped(self, an_array: list, item: str) -> bool:
         pass
 
+    @staticmethod
+    def validate_break_inheritance_flag(config, **kwargs):
+        has_invalid_flag = False
+        level = None
+        for key, value in config.items():
+            if "inherit" == key:
+                if kwargs["parent"] == "empty" and (
+                    kwargs["level"] == "group"
+                    or kwargs["level"] == "project"
+                    or kwargs["level"] == "subgroup"
+                ):
+                    level = kwargs["level"]
+                    has_invalid_flag = True
+                elif kwargs["level"] == "common":
+                    level = "common"
+                    has_invalid_flag = True
+            if has_invalid_flag:
+                fatal(
+                    "The inheritance break flag cannot be placed at the {config_level} level\n"
+                    "because {config_level} level is the highest level in the configuration file.\n".format(
+                        config_level=level
+                    ),
+                    exit_code=EXIT_PROCESSING_ERROR,
+                )
+            elif type(value) is CommentedMap:
+                ConfigurationCore.validate_break_inheritance_flag(
+                    value, level=kwargs["level"], parent=kwargs["parent"]
+                )
+
     @staticmethod
     def merge_configs(more_general_config, more_specific_config) -> dict:
         """
         :return: merge more general config with more specific configs.
                  More specific config values take precedence over more general ones.
         """
-        return dict(merge({}, more_general_config, more_specific_config))
+
+        merged_dict = merge({}, more_general_config, more_specific_config)
+
+        def break_inheritance(specific_config, parent_key=""):
+            for key, value in specific_config.items():
+                if "inherit" == key:
+                    replace_config_sections(merged_dict, parent_key, specific_config)
+                    break
+                elif type(value) is CommentedMap:
+                    break_inheritance(value, key)
+
+        def replace_config_sections(merged_config, specific_key, specific_config):
+            for key, value in merged_config.items():
+                if specific_key == key:
+                    del specific_config["inherit"]
+                    merged_config[key] = specific_config
+                    break
+                elif type(value) is CommentedMap:
+                    replace_config_sections(value, specific_key, specific_config)
+
+        break_inheritance(more_specific_config)
+
+        return dict(merged_dict)
 
 
 class ConfigFileNotFoundException(Exception):

gitlabform/configuration/groups.py

@@ -38,6 +38,15 @@ def get_effective_config_for_group(self, group) -> dict:
         if not group_config and not common_config:
             return {}
 
+        if common_config:
+            self.validate_break_inheritance_flag(
+                common_config, level="common", parent=""
+            )
+        elif not common_config and group_config:
+            self.validate_break_inheritance_flag(
+                group_config, level="group", parent="empty"
+            )
+
         return self.merge_configs(common_config, group_config)
 
     def get_effective_subgroup_config(self, subgroup):
@@ -75,8 +84,19 @@ def get_effective_subgroup_config(self, subgroup):
                     next_level_subgroup,
                     to_str(next_level_subgroup_config),
                 )
+
+                if effective_config:
+                    self.validate_break_inheritance_flag(
+                        effective_config, level="group", parent=""
+                    )
+                elif not effective_config and next_level_subgroup_config:
+                    self.validate_break_inheritance_flag(
+                        next_level_subgroup_config, level="subgroup", parent="empty"
+                    )
+
                 effective_config = self.merge_configs(
-                    effective_config, next_level_subgroup_config
+                    effective_config,
+                    next_level_subgroup_config,
                 )
                 debug(
                     "Merged previous level config for '%s' with config for '%s': %s",

gitlabform/configuration/projects_and_groups.py

@@ -41,15 +41,35 @@ def get_effective_config_for_project(self, group_and_project) -> dict:
         debug("Effective group/subgroup config: %s", to_str(group_config))
 
         project_config = self.get_project_config(group_and_project)
-        debug("Project config: %s", to_str(project_config))
+        debug("\nProject config: %s", to_str(project_config))
 
-        common_and_group_config = self.merge_configs(common_config, group_config)
+        if common_config:
+            self.validate_break_inheritance_flag(
+                common_config, level="common", parent=""
+            )
+        elif not common_config and group_config:
+            self.validate_break_inheritance_flag(
+                group_config, level="group", parent="empty"
+            )
+
+        common_and_group_config = self.merge_configs(
+            common_config,
+            group_config,
+        )
         debug(
             "Effective config common+group/subgroup: %s",
             to_str(common_and_group_config),
         )
 
-        effective_config = self.merge_configs(common_and_group_config, project_config)
+        if not common_and_group_config and project_config:
+            self.validate_break_inheritance_flag(
+                project_config, level="project", parent="empty"
+            )
+
+        effective_config = self.merge_configs(
+            common_and_group_config,
+            project_config,
+        )
         debug(
             "Effective config common+group/subgroup+project: %s",
             to_str(effective_config),