Merge pull request #7 from focusate/feature-install-paths-ala

[ADD] maraplus: install_paths

.gitignore

@@ -24,3 +24,4 @@ var/
 *.egg-info/
 .installed.cfg
 *.egg
+.venv

README.rst

@@ -16,4 +16,7 @@ Wrapper for :code:`marabunta` package, that adds some extra features:
 * If environment variable key is specified in configuration options, it will be
   replaced by its value, if such environment variable exists. E.g. if
   :code:`MY_ENV=test`, :code:`$MY_ENV` would be replaced by :code:`test`.
-
+* Can specify ``install_paths`` so modules are collected from specified file instead
+  of needing to explicitly specify in marabunta main yaml file. Modules specified in
+  these files are added into ``install`` option. If module already exists in ``install``
+  option, it is not added multiple times.

maraplus/config.py

@@ -53,8 +53,8 @@ def from_parse_args(cls, args):
         """Override to create config with extra arguments."""
         if not (bool(args.db_password) ^ bool(args.db_password_file)):
             raise TypeError(
-                "--db-password and --db-password-file arguments are mutually" +
-                " exclusive"
+                "--db-password and --db-password-file arguments are mutually"
+                + " exclusive"
             )
         return cls(
             args.migration_file,

maraplus/parser.py

@@ -11,23 +11,71 @@
 
 ADDITIVE_STRAT = mergedeep.Strategy.ADDITIVE
 
+# TODO: Should use tuples here to make sure data is immutable.
 VERSION_LIST_PATHS = [
     ['operations', 'pre'],
     ['operations', 'post'],
     ['addons', 'install'],
     ['addons', 'upgrade'],
 ]
+KEY_INSTALL_PATHS = 'install_paths'
+# Possible places for install_path argument.
+VERSION_INSTALL_PATHS = [
+    ['addons', KEY_INSTALL_PATHS],
+    # Asterisk means, expand to all modes (keys in modes dict)
+    ['modes', '*', 'addons', KEY_INSTALL_PATHS],
+]
 
 DEL_OPT_RE = r'DEL->{(.*)}'
 ENV_OPT_RE = r'(\$([A-Z0-9]+(?:_[A-Z0-9]+)*))'
 
 
-# TODO: move this to footil.
-def _get_from_dict(data: dict, keys: list) -> any:
+def get_from_nested_dict(data: dict, keys: list) -> any:
     """Retrieve value from nested dict."""
     return functools.reduce(operator.getitem, keys, data)
 
 
+def pop_from_nested_dict(data: dict, keys: list):
+    """Pop element at the end of nested dict using keys list as a path."""
+    if len(keys) == 1:
+        return data.pop(keys[0])
+    key = keys[-1]
+    inner_dct = get_from_nested_dict(data, keys[:-1])
+    return inner_dct.pop(key)
+
+
+def unpack_keys_from_nested_dict(data: dict, keys_chain: list):
+    """Unpack keys lists when any key is asterisk.
+
+    Asterisk means, we have key chains for each key in place of asterisk
+
+    E.g.
+        - data={'a': {'b1': {'c': 1}, 'b2': {'c': 2}}}
+        - keys_chain=['a', '*', 'c]
+        Results in these key chains:
+        [
+            ['a', 'b1', 'c'],
+            ['a', 'b2', 'c'],
+        ]
+
+    """
+    unpacked = [[]]
+    for idx, key in enumerate(keys_chain):
+        if key == '*':
+            new_unpacked = []
+            for path_keys in unpacked:
+                prev_keys = path_keys[:idx]
+                asterisk_keys = get_from_nested_dict(data, prev_keys).keys()
+                new_unpacked.extend(
+                    prev_keys + [k] for k in asterisk_keys
+                )
+            unpacked = new_unpacked
+        else:
+            for keys in unpacked:
+                keys.append(key)
+    return unpacked
+
+
 def _find_data_by_key(datas: list, key: str, val: any) -> dict:
     for data in datas:
         if data[key] == val:
@@ -46,10 +94,54 @@ def _render_env_placeholders(opt):
 class YamlParser(parser_orig.YamlParser):
     """Parser that can additionally parse install addons option."""
 
+    def __init__(self, parsed):
+        self.postprocess_parsed(parsed)
+        super().__init__(parsed)
+
     @property
     def _version_list_paths(self):
         return VERSION_LIST_PATHS
 
+    def postprocess_parsed(self, parsed):
+        # Handle install_path arg.
+        self._parse_install_paths(parsed)
+
+    def _parse_install_paths(self, parsed):
+        versions = parsed['migration']['versions']
+        for version in versions:
+            unpacked_keys = []
+            for vpaths in VERSION_INSTALL_PATHS:
+                # It is expected that some paths might not be defined
+                # in parsed file.
+                try:
+                    unpacked_keys.extend(unpack_keys_from_nested_dict(version, vpaths))
+                except KeyError:
+                    continue
+            for keys in unpacked_keys:
+                try:
+                    paths = pop_from_nested_dict(version, keys)
+                except KeyError:
+                    continue
+                # Parent dict is expected to be addons dict.
+                addons_cfg = get_from_nested_dict(version, keys[:-1])
+                for path in paths:
+                    self._parse_install_path(addons_cfg, path)
+
+    def _parse_install_path(self, addons_cfg: dict, path: str):
+        with open(path, 'r') as f:
+            modules_dct = yaml.safe_load(f)
+            try:
+                modules = modules_dct['install']
+            except Exception as e:
+                raise ParseError(f"install_path file expects 'install' key. Error: {e}")
+            if not isinstance(modules, list):
+                raise ParseError("'install_paths' key must be a list")
+        addons_cfg.setdefault('install', [])
+        install = addons_cfg['install']
+        for module in modules:
+            if module not in install:
+                install.append(module)
+
     @classmethod
     def parser_from_buffer(cls, fp, *extra_fps):
         """Extend to merge extra yaml."""
@@ -103,12 +195,12 @@ def _merge_yaml(self, fps):
 
     def _merge_dict(self, keys, extras):
         try:
-            main_dict = _get_from_dict(self.parsed, keys)
+            main_dict = get_from_nested_dict(self.parsed, keys)
         except KeyError:
             return
         for extra in extras:
             try:
-                extra_dict = _get_from_dict(extra, keys)
+                extra_dict = get_from_nested_dict(extra, keys)
                 mergedeep.merge(main_dict, extra_dict, strategy=ADDITIVE_STRAT)
             except KeyError:
                 continue
@@ -143,7 +235,7 @@ def _update_options(self, update_method):
         def update_data(data):
             for keys_path in self._version_list_paths:
                 try:
-                    vals_list = _get_from_dict(data, keys_path)
+                    vals_list = get_from_nested_dict(data, keys_path)
                     update_method(data, keys_path, vals_list)
                 except KeyError:
                     continue

setup.cfg

@@ -1,2 +1,5 @@
 [bdist_wheel]
 universal=1
+[flake8]
+ignore = E203,W503
+max-line-length = 88

setup.py

@@ -23,7 +23,7 @@
     license='AGPLv3+',
     packages=find_packages(),
     install_requires=[
-        'marabunta>=0.10.6',
+        'marabunta>=0.12.0',
         'mergedeep>=1.3.4',
         'PyYAML>=6.0',
     ],

tests/conftest.py

@@ -0,0 +1,17 @@
+import pathlib
+import pytest
+
+
+@pytest.fixture(scope="package")
+def path_modules_one():
+    yield str(_get_path("modules_one.yml"))
+
+
+@pytest.fixture(scope="package")
+def path_modules_two():
+    yield str(_get_path("modules_two.yml"))
+
+
+def _get_path(*args) -> pathlib.Path:
+    p = pathlib.Path(__file__).parent / "data"
+    return p.joinpath(*args)

tests/data/modules_one.yml

@@ -0,0 +1,5 @@
+---
+install:
+  - crm
+  - sale
+  - mrp

tests/data/modules_two.yml

@@ -0,0 +1,5 @@
+---
+install:
+  - sale
+  - account
+  - stock