cli2 4.2.5__tar.gz → 4.2.7__tar.gz

{cli2-4.2.5/cli2.egg-info → cli2-4.2.7}/PKG-INFO

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

{cli2-4.2.5 → cli2-4.2.7}/cli2/ansible/action.py

@@ -9,6 +9,7 @@ import os
 import re
 import traceback
 
+from ansible.parsing.yaml.objects import AnsibleUnicode
 from ansible.plugins.action import ActionBase
 
 # colors:
@@ -126,7 +127,15 @@ class ActionBase(ActionBase):
 
         The client object generated by :py:meth:`client_factory` if you
         implement it.
+
+    .. py:attribute:: mask
+
+        List of result keys to mask, if set, this module will print the result
+        with masked values, so you can set no_log: True for the task and still
+        see most of the result.
     """
+    mask = None
+
     def get(self, arg_name=None, fact_name=None, default=UNSET_DEFAULT):
         if arg_name and arg_name in self._task.args:
             return self._task.args[arg_name]
@@ -165,6 +174,9 @@ class ActionBase(ActionBase):
         except Exception as exc:
             self.result['failed'] = True
 
+            if self.verbosity:
+                traceback.print_exc()
+
             if isinstance(exc, AnsibleError):
                 self.result['error'] = exc.message
             elif isinstance(exc, cli2.ResponseError):
@@ -179,12 +191,14 @@ class ActionBase(ActionBase):
                 key, value = self.client.request_log_data(exc.request)
                 if key:
                     self.result[f'request_{key}'] = value
-            elif self.verbosity:
-                traceback.print_exc()
 
             # for pytest to raise
             self.exc = exc
         finally:
+            if self.mask and self.verbosity:
+                print('\nResult:')
+                cli2.print(self.masked_result())
+
             if (
                 self._before_data != UNSET_DEFAULT
                 and self._after_data != UNSET_DEFAULT
@@ -208,6 +222,31 @@ class ActionBase(ActionBase):
                 else:
                     cli2.diff(diff)
 
+    def native(self, data):
+        def _native(data):
+            for key, value in data.items():
+                if isinstance(value, AnsibleUnicode):
+                    data[key] = str(value)
+                elif isinstance(value, dict):
+                    data[key] = _native(value)
+                elif isinstance(value, list):
+                    data[key] = [_native(item) for item in value]
+            return data
+        return _native(copy.deepcopy(data))
+
+    def masked_result(self):
+        def _mask(data):
+            if isinstance(data, dict):
+                for key, value in data.items():
+                    if key in self.mask:
+                        data[key] = '***MASKED***'
+                    else:
+                        data[key] = _mask(value)
+            elif isinstance(data, list):
+                return [_mask(item) for item in data]
+            return data
+        return _mask(self.native(self.result))
+
     async def run_async(self):
         """
         The method you are supposed to implement.
@@ -276,7 +315,7 @@ class ActionBase(ActionBase):
         :param data: Dictionnary of data
         :param label: Label to show in diff
         """
-        self._before_data = copy.deepcopy(data)
+        self._before_data = self.native(data)
         self._before_label = label
 
     def after_set(self, data, label='after'):
@@ -286,5 +325,5 @@ class ActionBase(ActionBase):
         :param data: Dictionnary of data
         :param label: Label to show in diff
         """
-        self._after_data = copy.deepcopy(data)
+        self._after_data = self.native(data)
         self._after_label = label

{cli2-4.2.5 → cli2-4.2.7/cli2.egg-info}/PKG-INFO

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

{cli2-4.2.5 → cli2-4.2.7}/setup.py

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

{cli2-4.2.5 → cli2-4.2.7}/tests/test_ansible.py

@@ -8,6 +8,25 @@ import yaml
 from cli2 import ansible
 
 
+class ActionModule(ansible.ActionBase):
+    mask = ['a']
+
+    async def run_async(self):
+        self.result['x'] = dict(a='a', b='b')
+
+
+@pytest.mark.asyncio
+async def test_mask(monkeypatch):
+    printer = mock.Mock()
+    from cli2.ansible import action
+    monkeypatch.setattr(action.cli2, 'print', printer)
+    module = await ActionModule.run_test_async()
+    assert module.result == dict(x=dict(a='a', b='b'))
+    printer.assert_called_once_with(
+        dict(x=dict(a='***MASKED***', b='b'))
+    )
+
+
 @pytest.mark.asyncio
 async def test_response_error(httpx_mock):
     class Client(cli2.Client):