cli2 4.0.4__tar.gz → 4.0.5__tar.gz

{cli2-4.0.4/cli2.egg-info → cli2-4.0.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: cli2
-Version: 4.0.4
+Version: 4.0.5
 Summary: image:: https://yourlabs.io/oss/cli2/badges/master/pipeline.svg
 Home-page: https://yourlabs.io/oss/cli2
 Author: James Pic

{cli2-4.0.4 → cli2-4.0.5}/cli2/__init__.py

@@ -40,3 +40,15 @@ from .display import diff, diff_data, render, print, highlight
 from .lock import Lock
 from .log import configure, log, get_logger
 from .table import Table
+
+
+def which(cmd):
+    """ Wrapper around shutil.which, and also check for ~/.local/bin. """
+    import shutil
+    path = shutil.which(cmd)
+    if path:
+        return path
+
+    path = Path(os.getenv('HOME')) / '.local/bin' / cmd
+    if path.exists():
+        return str(path)

{cli2-4.0.4 → cli2-4.0.5}/cli2/ansible/__init__.py

@@ -6,3 +6,4 @@ from .action import (
     AnsibleOptionError,
     ActionBase,
 )
+from .variables import Variables

cli2-4.0.5/cli2/ansible/variables.py

@@ -0,0 +1,115 @@
+"""
+Ansible variables file reader with vault support
+
+Why not use the Ansible Python API? We don't have a lot to do here, and the CLI
+are less likely to be subject to changes.
+"""
+
+import cli2
+import functools
+import subprocess
+import yaml
+from pathlib import Path
+
+
+class Vault(yaml.YAMLObject):
+    yaml_tag = '!vault'
+
+    @classmethod
+    def from_yaml(cls, loader, node):
+        """
+        Convert a representation node to a Python object.
+        """
+        return subprocess.check_output(
+            f'echo \'{node.value}\''
+            f' | {cls.ansible_vault}'
+            f' decrypt --vault-password-file {cls.pass_path}',
+            shell=True,
+        ).decode().strip()
+
+
+class Variables(dict):
+    """
+    Ansible variables reader.
+
+    In general, it should be instanciated with :py:attr:`root_path` and
+    :py:attr:`pass_path` to fully function correctly.
+
+    Example:
+
+    .. code-block:: python
+
+        import cli2.ansible
+        variables = cli2.ansible.Variables(
+            root_path=Path(__file__).parent,
+            pass_path='~/.vault_password',
+        )
+        print(variables['playbooks/vars/example.yml'])
+
+    Every file read is cached in the variables object.
+
+    .. py:attribute:: root_path
+
+        Unless you feed this with only absolute path, you'll need a root_path
+        so that relative paths can be resolved. This should be your collection
+        root.
+
+    .. py:attribute:: pass_path
+
+        Unless you don't use ansible-vault, you'll need to give the pass to the
+        vault password here.
+    """
+    def __init__(self, root_path=None, pass_path=None):
+        self.root_path = Path(root_path) if root_path else None
+        self.pass_path = Path(pass_path) if pass_path else None
+
+    def __getitem__(self, key):
+        if key not in self:
+            self.read(key)
+        return super().__getitem__(key)
+
+    @functools.cached_property
+    def ansible_vault(self):
+        return cli2.which('ansible-vault')
+
+    def read(self, path):
+        """
+        Read an ansible YAML variable file.
+
+        :param path: Absolute path or path relative to :py:attr:`root_path`
+        """
+        key = path
+        path = Path(path)
+
+        if path.is_absolute():
+            path = path
+        elif self.root_path:
+            path = self.root_path / path
+        else:
+            raise Exception(f'{path} must be absolute if root_path not set')
+
+        if not path.exists():
+            raise Exception(f'{path} does not exist')
+
+        with path.open('r') as f:
+            content = f.read()
+
+        if content.strip().startswith('$ANSIBLE_VAULT'):
+            if not self.pass_path:
+                raise Exception('Vault password required in pass_path')
+            if not self.pass_path.exists():
+                raise Exception(f'{self.pass_path} does not exist')
+            args = [
+                self.ansible_vault,
+                'view',
+                '--vault-password-file',
+                str(self.pass_path),
+                str(path),
+            ]
+            content = subprocess.check_output(args)
+
+        # todo: find a thread safe way to use our YAMLObject
+        Vault.ansible_vault = self.ansible_vault
+        Vault.pass_path = self.pass_path
+        self[key] = yaml.load(content, Loader=yaml.FullLoader)
+        return self[key]

{cli2-4.0.4 → cli2-4.0.5/cli2.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: cli2
-Version: 4.0.4
+Version: 4.0.5
 Summary: image:: https://yourlabs.io/oss/cli2/badges/master/pipeline.svg
 Home-page: https://yourlabs.io/oss/cli2
 Author: James Pic

{cli2-4.0.4 → cli2-4.0.5}/cli2.egg-info/SOURCES.txt

@@ -27,6 +27,7 @@ cli2/ansible/__init__.py
 cli2/ansible/action.py
 cli2/ansible/playbook.py
 cli2/ansible/pytest.py
+cli2/ansible/variables.py
 cli2/examples/__init__.py
 cli2/examples/client.py
 cli2/examples/conf.py
@@ -37,6 +38,7 @@ cli2/examples/obj.py
 cli2/examples/obj2.py
 cli2/examples/test.py
 tests/test_ansible.py
+tests/test_ansible_variables.py
 tests/test_cli.py
 tests/test_client.py
 tests/test_command.py

{cli2-4.0.4 → cli2-4.0.5}/setup.py

@@ -3,7 +3,7 @@ from setuptools import setup
 
 setup(
     name='cli2',
-    version='4.0.4',
+    version='4.0.5',
     setup_requires='setupmeta',
     install_requires=[
         'docstring_parser',

cli2-4.0.5/tests/test_ansible_variables.py

@@ -0,0 +1,39 @@
+from cli2 import ansible
+import pytest
+import os
+
+
+def test_story():
+    variables = ansible.Variables(
+        root_path=os.path.dirname(__file__),
+        pass_path=os.path.dirname(__file__) + '/vault_pass',
+    )
+    variables.read('variables.yml')
+    assert variables['variables.yml'] == dict(foo='bar', vaulted='foobar')
+    assert variables['variables_vault.yml'] == dict(bar='foo')
+
+
+def test_exceptions():
+    variables = ansible.Variables()
+    with pytest.raises(Exception) as exc:
+        variables['variables.yml']
+    assert exc.value.args == (
+        'variables.yml must be absolute if root_path not set',
+    )
+
+    with pytest.raises(Exception) as exc:
+        variables['/variables_vault.yml']
+    assert exc.value.args == ('/variables_vault.yml does not exist',)
+
+    variables = ansible.Variables(root_path=os.path.dirname(__file__))
+    with pytest.raises(Exception) as exc:
+        variables['variables_vault.yml']
+    assert exc.value.args == ('Vault password required in pass_path',)
+
+    variables = ansible.Variables(
+        root_path=os.path.dirname(__file__),
+        pass_path='/does/not/exist',
+    )
+    with pytest.raises(Exception) as exc:
+        variables['variables_vault.yml']
+    assert exc.value.args == ('/does/not/exist does not exist',)