fix: report error on double config import

dotdrop/cfg_yaml.py

@@ -102,13 +102,14 @@ class CfgYaml:
     top_entries = [key_dotfiles, key_settings, key_profiles]
 
     def __init__(self, path, profile=None, addprofiles=None,
-                 reloading=False, debug=False):
+                 reloading=False, debug=False, imported_configs=None):
         """
         config parser
         @path: config file path
         @profile: the selected profile names
         @addprofiles: included profiles names (list)
         @reloading: true when reloading
+        @imported_configs: paths of config files that have been imported so far
         @debug: debug flag
         """
         self._path = os.path.abspath(path)
@@ -124,6 +125,8 @@ class CfgYaml:
         self._profilevarskeys = []
         # included profiles
         self._inc_profiles = addprofiles or []
+        # imported configs
+        self.imported_configs = imported_configs or []
 
         # init the dictionaries
         self.settings = {}
@@ -981,7 +984,8 @@ class CfgYaml:
             self._dbg('included profiles: {}'.format(self._inc_profiles))
         sub = CfgYaml(path, profile=self._profile,
                       addprofiles=self._inc_profiles,
-                      debug=self._debug)
+                      debug=self._debug,
+                      imported_configs=self.imported_configs)
 
         # settings are ignored from external file
         # except for filter_file and func_file
@@ -1003,6 +1007,9 @@ class CfgYaml:
         self.trans_w = self._merge_dict(self.trans_w, sub.trans_w)
         self._clear_profile_vars(sub.variables)
 
+        self.imported_configs.append(path)
+        self.imported_configs += sub.imported_configs
+
         if self._debug:
             self._debug_dict('add import_configs var', sub.variables)
         self._add_variables(sub.variables, prio=True)
@@ -1015,6 +1022,10 @@ class CfgYaml:
             return
         paths = self._resolve_paths(imp)
         for path in paths:
+            if path in self.imported_configs:
+                err = '{} imported more than once in {}'.format(path,
+                                                                self._path)
+                raise YamlException(err)
             self._import_config(path)
 
     def _import_sub(self, path, key, mandatory=False, patch_func=None):

tests-ng/double-config-import.sh

@@ -0,0 +1,111 @@
+#!/usr/bin/env bash
+# author: davla (https://github.com/davla)
+# Copyright (c) 2022, deadc0de6
+#
+# test error report on importing the same sub-config file more than once
+#
+
+# exit on first error
+set -e
+
+# all this crap to get current path
+rl="readlink -f"
+if ! ${rl} "${0}" >/dev/null 2>&1; then
+  rl="realpath"
+
+  if ! hash ${rl}; then
+    echo "\"${rl}\" not found !" && exit 1
+  fi
+fi
+cur=$(dirname "$(${rl} "${0}")")
+
+#hash dotdrop >/dev/null 2>&1
+#[ "$?" != "0" ] && echo "install dotdrop to run tests" && exit 1
+
+#echo "called with ${1}"
+
+# dotdrop path can be pass as argument
+ddpath="${cur}/../"
+[ "${1}" != "" ] && ddpath="${1}"
+[ ! -d ${ddpath} ] && echo "ddpath \"${ddpath}\" is not a directory" && exit 1
+
+export PYTHONPATH="${ddpath}:${PYTHONPATH}"
+bin="python3 -m dotdrop.dotdrop"
+hash coverage 2>/dev/null && bin="coverage run -a --source=dotdrop -m dotdrop.dotdrop" || true
+
+echo "dotdrop path: ${ddpath}"
+echo "pythonpath: ${PYTHONPATH}"
+
+# get the helpers
+source ${cur}/helpers
+
+echo -e "$(tput setaf 6)==> RUNNING $(basename $BASH_SOURCE) <==$(tput sgr0)"
+
+################################################################
+# this is the test
+################################################################
+
+# dotfile source path
+src="$(mktemp -d --suffix='-dotdrop-tests' || mktemp -d)"
+mkdir -p "${src}/dotfiles"
+clear_on_exit "${src}"
+
+# dotfile destination
+dst="$(mktemp -d --suffix='-dotdrop-tests' || mktemp -d)"
+clear_on_exit "${dst}"
+error_log="${dst}/error.log"
+
+# bottom-level
+bottom_level_cfg="${src}/bottom-level.yaml"
+cat > ${bottom_level_cfg} << _EOF
+config:
+  backup: true
+  create: true
+  dotpath: ${src}/dotfiles
+
+dotfiles: []
+profiles: []
+_EOF
+touch "${src}/dotfiles/bottom"
+
+# mid-level
+mid_level_cfg="${src}/mid-level.yaml"
+cat > ${mid_level_cfg} << _EOF
+config:
+  backup: true
+  create: true
+  dotpath: ${src}/dotfiles
+  import_configs:
+  - ${bottom_level_cfg}
+
+dotfiles: []
+
+profiles: []
+_EOF
+
+# top-level
+top_level_cfg="${src}/top-level.yaml"
+cat > ${top_level_cfg} << _EOF
+config:
+  backup: true
+  create: true
+  dotpath: ${src}/dotfiles
+  import_configs:
+  - ${mid_level_cfg}
+  - ${bottom_level_cfg}
+
+dotfiles: []
+
+profiles: []
+_EOF
+
+# install
+set +e
+cd ${ddpath} | ${bin} install -f -c ${top_level_cfg} -p top-level 2> "${error_log}"
+set -e
+
+# checks
+grep "${bottom_level_cfg} imported more than once in ${top_level_cfg}" "${error_log}" > /dev/null 2>&1
+
+echo "OK"
+exit 0