cli2 5.0.0rc14__tar.gz → 5.0.2__tar.gz

{cli2-5.0.0rc14/cli2.egg-info → cli2-5.0.2}/PKG-INFO

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

{cli2-5.0.0rc14 → cli2-5.0.2}/cli2/__init__.py

@@ -30,3 +30,16 @@ def which(cmd):
     path = Path(os.getenv('HOME')) / '.local/bin' / cmd
     if path.exists():
         return str(path)
+
+
+def mutable(obj):
+    types = (
+        int,
+        float,
+        str,
+        tuple,
+        frozenset,
+        bool,
+        bytes,
+    )
+    return not isinstance(obj, types)

{cli2-5.0.0rc14 → cli2-5.0.2}/cli2/mask.py

@@ -32,8 +32,9 @@ class Mask:
     Because:
 
     - ``1337p4ssw0rD`` was given as a value to mask
-    - ``xx`` was the value of a key named ``password`` which was given as a key
-      to mask
+    - ``password``'s value because ``password`` was given as a key to match
+    - the Mask object learned the value of the ``password`` key, and masked it
+      in ``text``
 
     .. py:attribute:: keys
 
@@ -109,8 +110,10 @@ class Mask:
                     data[key] = self._mask(value)
         elif isinstance(data, list):
             return [self._mask(item) for item in data]
+        elif isinstance(data, set):
+            return {self._mask(item) for item in data}
         elif isinstance(data, str):
-            for value in self.values:
+            for value in sorted(self.values, key=len, reverse=True):
                 data = data.replace(str(value), '***MASKED***')
         return data
 

{cli2-5.0.0rc14 → cli2-5.0.2/cli2.egg-info}/PKG-INFO

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

{cli2-5.0.0rc14 → cli2-5.0.2}/setup.py

@@ -44,7 +44,7 @@ from setuptools import setup
 
 setup(
     name='cli2',
-    version='5.0.0rc14',
+    version='5.0.2',
     setup_requires='setupmeta',
     packages=['cli2'],
     install_requires=[

{cli2-5.0.0rc14 → cli2-5.0.2}/tests/test_ansible.py

@@ -9,17 +9,15 @@ import yaml
 import cansible
 
 
-class ActionModule(cansible.ActionBase):
-    mask_keys = ['a']
-
-    async def run_async(self):
-        self.result['x'] = dict(a='a', b='b', c='c', d='foo a rrr')
-
-
 @pytest.mark.asyncio
 async def test_mask(monkeypatch):
-    printer = mock.Mock()
-    monkeypatch.setattr(ActionModule, 'print', printer)
+    class ActionModule(cansible.ActionBase):
+        masked_keys = ['a']
+        print = mock.Mock()
+
+        async def run_async(self):
+            self.result['x'] = dict(a='a', b='b', c='c', d='foo a rrr')
+
     module = await ActionModule.run_test_async(facts=dict(mask_keys=['b']))
     # result is untouched
     assert module.result == {'x':
@@ -27,7 +25,19 @@ async def test_mask(monkeypatch):
     }
     # output has proper masking
     expected = "\x1b[94mx\x1b[39;49;00m:\x1b[37m\x1b[39;49;00m\n\x1b[37m    \x1b[39;49;00m\x1b[94ma\x1b[39;49;00m:\x1b[37m \x1b[39;49;00m\x1b[33m'\x1b[39;49;00m\x1b[33m***MASKED***\x1b[39;49;00m\x1b[33m'\x1b[39;49;00m\x1b[37m\x1b[39;49;00m\n\x1b[37m    \x1b[39;49;00m\x1b[94mb\x1b[39;49;00m:\x1b[37m \x1b[39;49;00m\x1b[33m'\x1b[39;49;00m\x1b[33m***MASKED***\x1b[39;49;00m\x1b[33m'\x1b[39;49;00m\x1b[37m\x1b[39;49;00m\n\x1b[37m    \x1b[39;49;00m\x1b[94mc\x1b[39;49;00m:\x1b[37m \x1b[39;49;00mc\x1b[37m\x1b[39;49;00m\n\x1b[37m    \x1b[39;49;00m\x1b[94md\x1b[39;49;00m:\x1b[37m \x1b[39;49;00mfoo ***MASKED*** rrr\x1b[37m\x1b[39;49;00m\n"  # noqa
-    printer.assert_called_once_with(expected)
+    module.print.assert_called_once_with(expected, mask=False)
+
+
+def test_subprocess_remote(playbook):
+    playbook.task_add(
+        'yourlabs.test.password_get',
+        no_log=True,
+    )
+    result = playbook()
+    expected = "foo:***MASKED***:bar\n\nansible_facts:\n\n    mask_values:\n\n    - \'***MASKED***\'\n\nsecret: \'***MASKED***\'\n\nstdout: foo:***MASKED***:bar"  # noqa
+    assert expected in result['stdout']
+
+
 
 
 @pytest.mark.asyncio
@@ -120,6 +130,41 @@ async def test_diff(monkeypatch):
     _print.assert_called_once_with(expected)
 
 
+@pytest.mark.asyncio
+async def test_fact_set():
+    class Action(cansible.ActionBase):
+        foo = cansible.Option(fact='foo')
+
+        async def run_async(self):
+            self.foo = 'bar'
+            assert self.foo == 'bar'
+
+    action = await Action.run_test_async(facts=dict(foo='bar'))
+    assert 'ansible_facts' not in action.result
+
+    action = await Action.run_test_async()
+    assert action.result['ansible_facts'] == dict(foo='bar')
+
+
+@pytest.mark.asyncio
+async def test_fact_set_mutable():
+    class Action(cansible.ActionBase):
+        async def run_async(self):
+            assert self.mask_values is self.mask.values
+            self.mask_values.add('foo')
+
+    action = await Action.run_test_async()
+    assert 'mask_values' in action.facts_values
+    assert action.result['ansible_facts'] == dict(mask_values=['foo'])
+
+    action = await Action.run_test_async(facts=dict(mask_values=['foo']))
+    assert 'ansible_facts' not in action.result
+
+    action = await Action.run_test_async(facts=dict(mask_values=['bar']))
+    result = action.result['ansible_facts']['mask_values']
+    assert sorted(result) == ['bar', 'foo']
+
+
 def test_playbook_render(playbook):
     assert playbook.name == 'test_playbook_render'
     playbook.task_add(
@@ -166,3 +211,12 @@ def test_playbook_exec(playbook):
     result = playbook()
     assert result['changed'] == 0
     assert result['ok'] == 2
+
+
+def test_masking_ansible_story(playbook):
+    with open('tests/test_ansible_masking.yml', 'r') as f:
+        data = yaml.safe_load(f.read())
+    playbook.tasks += data[0]['tasks']
+    result = playbook()
+    expected = "hello ***MASKED*** ***MASKED*** bye\n\nansible_facts:\n\n    mask_values:\n\n    - \'***MASKED***\'\n\n    - \'***MASKED***\'\n\ncmd: echo hello ***MASKED*** ***MASKED*** bye\n\nstdout: hello ***MASKED*** ***MASKED*** bye"  # noqa
+    assert expected in result['stdout']

{cli2-5.0.0rc14 → cli2-5.0.2}/tests/test_ansible_variables.py

@@ -13,27 +13,34 @@ def test_story():
     assert variables['variables_vault.yml'] == dict(bar='foo')
 
 
-def test_exceptions():
+def test_unresolvable_path_error():
     variables = cansible.Variables()
-    with pytest.raises(Exception) as exc:
+    with pytest.raises(cansible.UnresolvablePathError) 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',)
 
+def test_path_not_found_error():
+    variables = cansible.Variables()
+    with pytest.raises(cansible.PathNotFoundError) as exc:
+        variables['/nonexistent.yml']
+    assert exc.value.args == ('/nonexistent.yml does not exist',)
+
+
+def test_vault_password_required_error():
     variables = cansible.Variables(root_path=os.path.dirname(__file__))
-    with pytest.raises(Exception) as exc:
+    with pytest.raises(cansible.VaultPasswordFileRequiredError) as exc:
         variables['variables_vault.yml']
     assert exc.value.args == ('Vault password required in pass_path',)
 
+
+def test_vault_password_file_not_found_error():
     variables = cansible.Variables(
         root_path=os.path.dirname(__file__),
         pass_path='/does/not/exist',
     )
-    with pytest.raises(Exception) as exc:
+    with pytest.raises(cansible.VaultPasswordFileNotFoundError) as exc:
         variables['variables_vault.yml']
     assert exc.value.args == ('/does/not/exist does not exist',)

{cli2-5.0.0rc14 → cli2-5.0.2}/tests/test_client.py

@@ -99,6 +99,10 @@ async def test_client_cli_override(client_class, httpx_mock):
         async def find(cls, foo):
             return cls.url_list
 
+    @Client.cli.cmd
+    def test():
+        pass
+
     class TestModel2(Client.Model):
         @classmethod
         @cli2.cmd

{cli2-5.0.0rc14 → cli2-5.0.2}/tests/test_mask.py

@@ -23,3 +23,8 @@ def test_mask():
 
     assert mask
     assert not cli2.Mask()
+
+
+def test_mask_longest():
+    mask = cli2.Mask(values=['val', 'val2'])
+    assert mask('val2 val') == '***MASKED*** ***MASKED***'