cli2 5.0.3__tar.gz → 5.1.0__tar.gz

{cli2-5.0.3/cli2.egg-info → cli2-5.1.0}/PKG-INFO

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

{cli2-5.0.3 → cli2-5.1.0}/cli2/__init__.py

@@ -20,7 +20,7 @@ except ImportError:
     """ windows """
 else:
     from .lock import Lock
-from .log import configure, log
+from .log import configure, log, parse
 from .mask import Mask
 from .table import Table
 

{cli2-5.0.3 → cli2-5.1.0}/cli2/log.py

@@ -37,6 +37,16 @@ variables.
 
     Setting this to ``INFO``, ``DEBUG``, or any other log level is safe.
 
+.. envvar:: LOG_FILE
+
+    Path to log file to use, with a couple of special values:
+
+    - if ``LOG_FILE=auto``, then a path will be calculated in
+      ``~/.local/cli2/log``,
+    - if ``LOG_FILE=none``, then there will be no file logging.
+
+    Default: ``auto``
+
 .. envvar:: DEBUG
 
     Setting this will set :envvar:`LOG_LEVEL` to `DEBUG`, but also activate
@@ -54,6 +64,7 @@ import os
 import re
 import sys
 import structlog
+import yaml
 from pathlib import Path
 
 import cli2.display
@@ -70,8 +81,15 @@ class YAMLFormatter:
         return '\n' + value
 
 
-def configure():
+def configure(log_file=None):
+    """
+    Configure logging.
+
+    :param log_file: override for :envvar:`LOG_FILE`.
+    """
     LOG_LEVEL = os.getenv('LOG_LEVEL', 'WARNING').upper()
+    if log_file is None:
+        log_file = os.getenv('LOG_FILE', 'auto')
 
     if os.getenv('DEBUG'):
         LOG_LEVEL = 'DEBUG'
@@ -92,11 +110,21 @@ def configure():
         for arg in sys.argv
     ])[:155]
 
-    log_dir = Path(os.getenv("HOME")) / '.local/cli2/log'
-    log_dir.mkdir(parents=True, exist_ok=True)
-    ts = datetime.datetime.now().strftime('%Y-%m-%d-%H-%M-%S')
-    file_name = f'{sys.argv[0].split("/")[-1]}-{ts}-{cmd}.log'
-    file_path = log_dir / file_name
+    if log_file == 'auto':
+        log_dir = Path(os.getenv("HOME")) / '.local/cli2/log'
+        log_dir.mkdir(parents=True, exist_ok=True)
+        ts = datetime.datetime.now().strftime('%Y-%m-%d-%H-%M-%S')
+        file_name = f'{sys.argv[0].split("/")[-1]}-{ts}-{cmd}.log'
+        log_file = log_dir / file_name
+    elif log_file == 'none' or not log_file:
+        log_file = None
+    else:
+        log_file = Path(log_file)
+
+    handlers = ['default']
+    if log_file:
+        handlers.append('file')
+
     LOGGING = {
         'version': 1,
         'disable_existing_loggers': True,
@@ -156,16 +184,10 @@ def configure():
                 'class': 'logging.StreamHandler',
                 'formatter': 'colored',
             },
-            'file': {
-                'level': 'DEBUG',
-                'class': 'logging.handlers.WatchedFileHandler',
-                'formatter': 'plain',
-                'filename': str(file_path),
-            },
         },
         'loggers': {
             'cli2': {
-                'handlers': ['default', 'file'],
+                'handlers': handlers,
                 'level': 'DEBUG',
                 'propagate': True,
             }
@@ -175,12 +197,20 @@ def configure():
     if os.getenv('HTTP_DEBUG'):
         LOGGING['loggers'].update({
             key: {
-                'handlers': ['default', 'file'],
+                'handlers': handlers,
                 'level': 'DEBUG',
                 'propagate': True,
             } for key in ('httpx', 'httpcore')
         })
 
+    if log_file:
+        LOGGING['handlers']['file'] = {
+            'level': 'DEBUG',
+            'class': 'logging.handlers.WatchedFileHandler',
+            'formatter': 'plain',
+            'filename': str(log_file),
+        }
+
     logging.config.dictConfig(LOGGING)
 
     structlog.configure(
@@ -198,5 +228,39 @@ def configure():
     )
 
 
+def parse(data):
+    """
+    Parse log file data into a list of entries.
+
+    :param data: Contents of a log file.
+    """
+    yaml_lines = []
+    entries = []
+    for line in data.split('\n'):
+        if 'event=' in line:
+            data = {}
+            for token in line.strip().split():
+                if match := re.match('^(\\w+)=(.*)', token):
+                    key = match.group(1)
+                    data[key] = match.group(2)
+                else:
+                    data[key] += ' ' + token
+
+            if yaml_lines:
+                data['json'] = yaml.safe_load('\n'.join(yaml_lines))
+
+            if data['event'] == 'request':
+                entries.append(dict(request=data))
+            elif data['event'] == 'response':
+                entries[-1]['response'] = data
+            else:
+                entries.append(data)
+
+            yaml_lines = []
+        else:
+            yaml_lines.append(line)
+    return entries
+
+
 configure()
 log = structlog.get_logger('cli2')

{cli2-5.0.3 → cli2-5.1.0/cli2.egg-info}/PKG-INFO

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

{cli2-5.0.3 → cli2-5.1.0}/cli2.egg-info/SOURCES.txt

@@ -36,6 +36,7 @@ tests/test_ansible_variables.py
 tests/test_asyncio.py
 tests/test_cli.py
 tests/test_client.py
+tests/test_client_test.py
 tests/test_command.py
 tests/test_configuration.py
 tests/test_decorators.py
@@ -44,6 +45,7 @@ tests/test_entry_point.py
 tests/test_group.py
 tests/test_inject.py
 tests/test_lock.py
+tests/test_log.py
 tests/test_mask.py
 tests/test_node.py
 tests/test_restful.py

{cli2-5.0.3 → cli2-5.1.0}/setup.py

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

{cli2-5.0.3 → cli2-5.1.0}/tests/test_client.py

@@ -7,8 +7,10 @@ import mock
 import pytest
 
 
-async def _response(**kwargs):
-    return httpx.Response(**kwargs)
+def _response(**kwargs):
+    response = httpx.Response(**kwargs)
+    response.request = httpx.Request('POST', '/', json=[1])
+    return response
 
 
 class HandlerSentinel(chttpx.Handler):
@@ -17,7 +19,11 @@ class HandlerSentinel(chttpx.Handler):
         self.calls = []
 
     async def __call__(self, client, response, tries, log):
-        self.calls.append((client, response.status_code, tries))
+        self.calls.append((
+            client,
+            getattr(response, 'status_code', response),
+            tries,
+        ))
         return await super().__call__(client, response, tries, log)
 
 
@@ -191,6 +197,7 @@ async def test_error_remote(httpx_mock, client_class):
             return 'token'
 
     client = TokenClient()
+    client.handler.tries = 2
     httpx_mock.add_response(url='http://lol', json=[1])
 
     async def raises(*a, **k):
@@ -230,10 +237,11 @@ async def test_client_handler(httpx_mock, client_class):
     class Client(client_class):
         def client_factory(self):
             client = super().client_factory()
-            client.send = mock.Mock()
+            client.send = mock.AsyncMock()
             return client
 
     client = Client(handler=HandlerSentinel())
+    client.handler.tries = 3
 
     # test response retry
     client.client.send.side_effect = [
@@ -247,16 +255,33 @@ async def test_client_handler(httpx_mock, client_class):
         (client, 200, 1),
     ]
 
-    # test TransportError retry
-    client.client.send.side_effect = [
-        httpx.TransportError("foo"),
-        _response(status_code=200),
-    ]
+
+@pytest.mark.asyncio
+async def test_client_error_retry(httpx_mock, client_class):
+    class Client(client_class):
+        calls = 0
+
+        def client_factory(self):
+            self.calls += 1
+
+            client = super().client_factory()
+            client.send = mock.AsyncMock()
+
+            if self.calls == 1:
+                client.send.side_effect = httpx.TransportError('foo')
+            elif self.calls == 2:
+                client.send.return_value = _response(status_code=200)
+
+            return client
+
+    client = Client(handler=HandlerSentinel())
+    client.handler.tries = 3
+
+    response = await client.request('GET', '/')
     assert response.status_code == 200
-    assert client.handler.calls == [
-        (client, 500, 0),
-        (client, 200, 1),
-    ]
+    assert isinstance(client.handler.calls[0][1], httpx.TransportError)
+    assert client.handler.calls[1][1] == 200
+    assert len(client.handler.calls) == 2
 
 
 @pytest.mark.asyncio
@@ -265,13 +290,19 @@ async def test_handler(client_class):
     client = client_class()
     client.client_reset = mock.AsyncMock()
     client.token_reset = mock.AsyncMock()
-    handler = chttpx.Handler(accepts=[201], refuses=[218], retokens=[418])
+    handler = chttpx.Handler(
+        accepts=[201],
+        refuses=[218],
+        retokens=[418],
+        tries=3,
+    )
 
     response = httpx.Response(status_code=201)
     result = await handler(client, response, 0, log)
     assert result == response
 
     response = httpx.Response(status_code=200)
+    response.request = httpx.Request('POST', '/', json=[1])
     result = await handler(client, response, 0, log)
     log.info.assert_called_once_with(
         'retry', status_code=200, tries=0, sleep=.0
@@ -286,7 +317,7 @@ async def test_handler(client_class):
         'retry', status_code=200, tries=0, sleep=.0
     )
 
-    msg = 'Unacceptable response <Response [200 OK]> after 31 tries\n\x1b[0m\x1b[1mPOST /\x1b[0m\n-\x1b[37m \x1b[39;49;00m1\x1b[37m\x1b[39;49;00m\n\n\x1b[1mHTTP 200\x1b[0m\n-\x1b[37m \x1b[39;49;00m2\x1b[37m\x1b[39;49;00m\n'  # noqa
+    msg = 'Unacceptable response <Response [200 OK]> after 4 tries\n\x1b[0m\x1b[1mPOST /\x1b[0m\n-\x1b[37m \x1b[39;49;00m1\x1b[37m\x1b[39;49;00m\n\n\x1b[1mHTTP 200\x1b[0m\n-\x1b[37m \x1b[39;49;00m2\x1b[37m\x1b[39;49;00m\n'  # noqa
     assert str(exc.value) == msg
 
     response = httpx.Response(status_code=200)
@@ -294,7 +325,7 @@ async def test_handler(client_class):
     with pytest.raises(chttpx.RetriesExceededError) as exc:
         await handler(client, response, handler.tries + 1, log)
 
-    msg = 'Unacceptable response <Response [200 OK]> after 31 tries\n\x1b[0m\x1b[1mGET /\x1b[0m\n\x1b[1mHTTP 200\x1b[0m'  # noqa
+    msg = 'Unacceptable response <Response [200 OK]> after 4 tries\n\x1b[0m\x1b[1mGET /\x1b[0m\n\x1b[1mHTTP 200\x1b[0m'  # noqa
     assert str(exc.value) == msg
 
     response = httpx.Response(status_code=218)
@@ -335,9 +366,7 @@ async def test_handler(client_class):
     assert not client.token_reset.await_count
     log.warn.reset_mock()
     result = await handler(client, response, 0, log)
-    log.warn.assert_called_once_with(
-        'retoken', status_code=418, tries=0, sleep=.0
-    )
+    log.warn.assert_called_once_with('retoken')
     assert not result
     assert client.token_reset.await_count == 1
 
@@ -358,10 +387,11 @@ async def test_retry(httpx_mock, client_class):
 
         def client_factory(self):
             client = super().client_factory()
-            client.send = mock.Mock()
+            client.send = mock.AsyncMock()
             return client
 
     client = Client()
+    client.handler.tries = 3
 
     current_client = client.client
     client.client.send.side_effect = [
@@ -645,10 +675,11 @@ def test_descriptor(client_class):
     assert model.data['undeclared']['foo'] == 3
 
     model = Model()
-    assert model.foo == ''
+    assert model.foo is None
+    assert 'foo' not in model._data
     assert not model.changed_fields
     model.foo = 'bar'
-    assert model.changed_fields == dict(foo='')
+    assert model.changed_fields == dict(foo=None)
     model = Model(foo='bar')
     model.foo = 'foo'
     assert model.changed_fields == dict(foo='bar')
@@ -1246,3 +1277,54 @@ def test_client_command(client_class, httpx_mock):
     cmd = Client.cli['request']
     cmd()
     assert not Client.post_call_called
+
+
+def test_field_callback(client_class):
+    class TestModel(client_class.Model):
+        foo = chttpx.Field()
+        bar = chttpx.Field()
+        other = chttpx.Field()
+
+        @other.factory
+        def other_factory(self):
+            return 'nice'
+
+        @bar.factory(foo)
+        def bar_factory(self):
+            return f'bar{self.foo}'
+
+    model = client_class().TestModel(foo='test')
+    assert model.bar == 'bartest'
+    assert model.other == 'nice'
+
+    model = client_class().TestModel(foo='test')
+    assert model.data['bar'] == 'bartest'
+    assert model.data['other'] == 'nice'
+
+    model = client_class().TestModel()
+    assert model.data == dict(other='nice')
+
+    model = client_class().TestModel(bar='lol')
+    assert model.bar == 'lol'
+    assert model.data['bar'] == 'lol'
+
+
+def test_field_callback_recursion(client_class):
+    class TestModel(client_class.Model):
+        final = chttpx.Field()
+        req2 = chttpx.Field()
+        req1 = chttpx.Field()
+
+        @final.factory(req2)
+        def final_factory(self):
+            return f'{self.req2}val3'
+
+        @req2.factory(req1)
+        def req2_factory(self):
+            return f'{self.req1}val2'
+
+    model = client_class().TestModel(req1='lol')
+    assert model.data['final'] == 'lolval2val3'
+
+    model = client_class().TestModel(req1='lol')
+    assert model.final == 'lolval2val3'

cli2-5.1.0/tests/test_client_test.py

@@ -0,0 +1,17 @@
+import chttpx
+import cli2
+import pytest
+from chttpx.example import APIClient
+
+
+@pytest.mark.chttpx_mock
+def test_object_story():
+    test_name = 'test33312'
+    obj = APIClient.cli['object']['create'](f'name={test_name}')
+    assert obj.name == test_name
+
+    cli2.log.info('bogus')
+
+    with pytest.raises(chttpx.RefusedResponseError):
+        APIClient.cli['object']['create'](f'name={test_name}')
+    result = APIClient.cli['object']['delete'](f'{obj.id}')

cli2-5.1.0/tests/test_log.py

@@ -0,0 +1,80 @@
+import cli2
+
+
+def test_log_parse():
+    logs = '''
+
+name: tes2980898zzzyzy7
+ method=POST url=http://localhost:8000/objects/ event=request level=debug timestamp=2025-03-21 10:09:40
+
+data: {}
+id: 103
+name: tes2980898zzzyzy7
+ method=POST url=http://localhost:8000/objects/ status_code=201 event=response level=info timestamp=2025-03-21 10:09:40
+event=bogus level=info
+
+name: tes2980898zzzyzy7
+ method=POST url=http://localhost:8000/objects/ event=request level=debug timestamp=2025-03-21 10:09:40
+
+name:
+- object with this name already exists.
+ method=POST url=http://localhost:8000/objects/ status_code=400 event=response level=info timestamp=2025-03-21 10:09:40
+    '''
+
+    result = cli2.parse(logs)
+    assert result == [
+		{
+		  'request': {
+			  'event': 'request',
+			  'json': {
+				  'name': 'tes2980898zzzyzy7',
+			  },
+			  'level': 'debug',
+			  'method': 'POST',
+			  'timestamp': '2025-03-21 10:09:40',
+			  'url': 'http://localhost:8000/objects/',
+		  },
+		  'response': {
+			  'event': 'response',
+			  'json': {
+				  'data': {},
+				  'id': 103,
+				  'name': 'tes2980898zzzyzy7',
+			  },
+			  'level': 'info',
+			  'method': 'POST',
+			  'status_code': '201',
+			  'timestamp': '2025-03-21 10:09:40',
+			  'url': 'http://localhost:8000/objects/',
+		  },
+		},
+        {
+          'event': 'bogus',
+          'level': 'info',
+        },
+		{
+		  'request': {
+			  'event': 'request',
+			  'json': {
+				  'name': 'tes2980898zzzyzy7',
+			  },
+			  'level': 'debug',
+			  'method': 'POST',
+			  'timestamp': '2025-03-21 10:09:40',
+			  'url': 'http://localhost:8000/objects/',
+		  },
+		  'response': {
+			  'event': 'response',
+			  'json': {
+				  'name': [
+					  'object with this name already exists.',
+				  ],
+			  },
+			  'level': 'info',
+			  'method': 'POST',
+			  'status_code': '400',
+			  'timestamp': '2025-03-21 10:09:40',
+			  'url': 'http://localhost:8000/objects/',
+		  },
+		},
+  	]