Revize 76bdccc4

re #9421 Added unit tests for resend_cached_payload() and send_data(); moved api_client.py into usb_detector package

client/src/api_client.py

@@ -1 @@
-import json
-import requests
-import logging
-from time import sleep
-from diskcache import Deque
-from requests import HTTPError, ConnectionError
-from requests.exceptions import InvalidSchema
-
-_uri = None
-_cache = None
-_config = None
-
-
-def api_client_set_config(config):
-    global _config, _cache, _uri
-    _config = config
-    _cache = _init_cache()
-    _uri = config.server_url + ":" + config.server_port + config.server_endpoint
-
-
-def _init_cache():
-    return Deque(directory=_config.cache_dir)
-
-
-def send_data(payload: dict):
-    if _uri is None:
-        logging.warning(f"sending payload = {payload} failed because uri is set to None")
-        _cache_failed_payload(payload)
-        return
-    try:
-        logging.info(f"sending payload = {payload} to {_uri}")
-        response = requests.post(url=_uri, data=json.dumps(payload))
-        logging.info(f"response text: {response.text}")
-    except (ConnectionError, InvalidSchema):
-        logging.warning(f"sending payload = {payload} to {_uri} failed")
-        _cache_failed_payload(payload)
-    except HTTPError as error:
-        logging.error(f"HTTP Error ({_uri}) payload = {payload}, {error}")
-        _cache_failed_payload(payload)
-
-
-def _cache_failed_payload(payload: dict):
-    if len(_cache) >= _config.cache_max_entries:
-        oldest_payload = _cache.pop()
-        logging.warning(f"cache is full - discarding payload = {oldest_payload}")
-
-    logging.info(f"adding payload = {payload} into cache")
-    _cache.append(payload)
-
-
-def _resend_cached_payloads():
-    retries = min(_config.max_retries, len(_cache))
-    logging.info(f"emptying the cache ({retries} records)")
-    for _ in range(0, retries):
-        payload = _cache.pop()
-        send_data(payload)
-
-
-def api_client_run():
-    while True:
-        _resend_cached_payloads()
-        sleep(_config.cache_retry_period_seconds)

client/src/main.py

@@ -9 +9 @@
 from config_manager import Config
 from usb_detector.detector import register_listener, usb_detector_run, usb_detector_set_config
 from usb_detector.event_listener import usb_connected_callback, usb_disconnected_callback
-from client.src.api_client import api_client_run, api_client_set_config
+from usb_detector.api_client import api_client_run, api_client_set_config
 
 
 def init_logging(app_config: Config):

client/src/usb_detector/api_client.py

@@ +1 @@
+import json
+import requests
+import logging
+from time import sleep
+from diskcache import Deque
+from requests import HTTPError, ConnectionError
+from requests.exceptions import InvalidSchema
+
+_uri = None
+_cache = None
+_config = None
+
+
+def api_client_set_config(config):
+    global _config, _cache, _uri
+    _config = config
+    _cache = _init_cache()
+    _uri = config.server_url + ":" + config.server_port + config.server_endpoint
+
+
+def _init_cache():
+    return Deque(directory=_config.cache_dir)
+
+
+def send_data(payload: dict):
+    if _uri is None:
+        logging.warning(f"sending payload = {payload} failed because uri is set to None")
+        _cache_failed_payload(payload)
+        return
+    try:
+        logging.info(f"sending payload = {payload} to {_uri}")
+        response = requests.post(url=_uri, data=json.dumps(payload))
+        logging.info(f"response text: {response.text}")
+    except (ConnectionError, InvalidSchema):
+        logging.warning(f"sending payload = {payload} to {_uri} failed")
+        _cache_failed_payload(payload)
+    except HTTPError as error:
+        logging.error(f"HTTP Error ({_uri}) payload = {payload}, {error}")
+        _cache_failed_payload(payload)
+
+
+def _cache_failed_payload(payload: dict):
+    if len(_cache) >= _config.cache_max_entries:
+        oldest_payload = _cache.pop()
+        logging.warning(f"cache is full - discarding payload = {oldest_payload}")
+
+    logging.info(f"adding payload = {payload} into cache")
+    _cache.append(payload)
+
+
+def _resend_cached_payloads():
+    retries = min(_config.max_retries, len(_cache))
+    logging.info(f"emptying the cache ({retries} records)")
+    for _ in range(0, retries):
+        payload = _cache.pop()
+        send_data(payload)
+
+
+def api_client_run():
+    while True:
+        _resend_cached_payloads()
+        sleep(_config.cache_retry_period_seconds)

client/src/usb_detector/event_listener.py

@@ -3 +3 @@
 import getpass
 from datetime import datetime
 
-from ..api_client import send_data
+from .api_client import send_data
 
 
 def _get_metadata() -> dict:

client/tests/api_client/test_api_client_set_config.py

@@ -1 @@
-import client.src.api_client
+from client.src.usb_detector import api_client
 
 from unittest import mock
 
 
[e-mail]('client.src.api_client._init_cache')
[e-mail]('client.src.usb_detector.api_client._init_cache')
 def test_api_client_set_config_1(_init_cache_mock):
     class Config:
         def __init__(self):
@@ -12 +12 @@
             self.server_endpoint = "/api/v1/usb-logs"
 
     config = Config()
-    client.src.api_client.api_client_set_config(config)
+    api_client.api_client_set_config(config)
 
-    assert client.src.api_client._config is config
-    assert client.src.api_client._uri == "127.0.0.1:54444/api/v1/usb-logs"
+    assert api_client._config is config
+    assert api_client._uri == "127.0.0.1:54444/api/v1/usb-logs"

client/tests/api_client/test_cache_failed_payload.py

@@ -1 @@
-import client.src.api_client as api_client
+from client.src.usb_detector import api_client
 
 
 class CacheMock:

client/tests/api_client/test_resend_cached_payloads.py

@@ +1 @@
+from client.src.usb_detector import api_client
+
+from unittest import mock
+
+
+class CacheMock:
+
+    def __init__(self):
+        self._data = []
+
+    def pop(self):
+        return self._data.pop()
+
+    def append(self, payload):
+        self._data.append(payload)
+
+    def __len__(self):
+        return len(self._data)
+
+
+class ConfigMock:
+
+    def __init__(self):
+        self.cache_max_entries = 5
+        self.max_retries = 3
+
+
+payload_mock = {
+    "device": {
+        "vendor_id": 1,
+        "product_id": 2
+    }
+}
+
+
[e-mail]('client.src.usb_detector.api_client.send_data')
+def test_resend_cached_payloads_1(send_data_mock):
+    cache = CacheMock()
+    config = ConfigMock()
+
+    api_client._cache = cache
+    api_client._config = config
+
+    for _ in range(0, config.cache_max_entries + 1):
+        api_client._cache_failed_payload(payload_mock)
+
+    api_client._resend_cached_payloads()
+    send_data_mock.assert_called()
+    assert len(api_client._cache) == 2
+
+    api_client._resend_cached_payloads()
+    assert len(api_client._cache) == 0
+
+    api_client._resend_cached_payloads()
+    assert len(api_client._cache) == 0
+
+
[e-mail]('client.src.usb_detector.api_client.send_data')
+def test_resend_cached_payloads_2(send_data_mock):
+    cache = CacheMock()
+    config = ConfigMock()
+
+    api_client._cache = cache
+    api_client._config = config
+
+    api_client._resend_cached_payloads()
+    send_data_mock.assert_not_called()
+    assert len(api_client._cache) == 0
+
+
[e-mail]('client.src.usb_detector.api_client.send_data')
+def test_resend_cached_payloads_3(send_data_mock):
+    cache = CacheMock()
+    config = ConfigMock()
+
+    api_client._cache = cache
+    api_client._config = config
+
+    for _ in range(0, 2):
+        api_client._cache_failed_payload(payload_mock)
+
+    assert len(api_client._cache) == 2
+    api_client._resend_cached_payloads()
+    send_data_mock.assert_called()
+    assert len(api_client._cache) == 0
+

client/tests/api_client/test_send_data.py

@@ +1 @@
+from client.src.usb_detector import api_client
+
+import requests
+from unittest import mock
+
+
[e-mail]('client.src.usb_detector.api_client._cache_failed_payload')
+def test_send_data_1(_cache_failed_payload_mock):
+    payload_mock = {
+        "device": {
+            "vendor_id": 1,
+            "product_id": 2
+        }
+    }
+
+    api_client._uri = None
+    api_client.send_data(payload_mock)
+
+    args = _cache_failed_payload_mock.call_args.args
+    _cache_failed_payload_mock.assert_called()
+    assert args[0] == payload_mock
+
+
[e-mail]('client.src.usb_detector.api_client._cache_failed_payload')
+def test_send_data_2(_cache_failed_payload_mock):
+    payload_mock = {
+        "device": {
+            "vendor_id": 1,
+            "product_id": 2
+        }
+    }
+
+    api_client._uri = "127.0.0.1:54444/api/v1/usb-logs"
+    api_client.send_data(payload_mock)
+
+    args = _cache_failed_payload_mock.call_args.args
+    _cache_failed_payload_mock.assert_called()
+    assert args[0] == payload_mock
+
+
[e-mail]('client.src.usb_detector.api_client.requests.post')
[e-mail]('client.src.usb_detector.api_client._cache_failed_payload')
+def test_send_data_3(_cache_failed_payload_mock, post_mock):
+    payload_mock = {
+        "device": {
+            "vendor_id": 1,
+            "product_id": 2
+        }
+    }
+
+    api_client._uri = "127.0.0.1:54444/api/v1/usb-logs"
+    api_client.send_data(payload_mock)
+
+    _cache_failed_payload_mock.assert_not_called()
+
+
[e-mail]('client.src.usb_detector.api_client.requests.post')
[e-mail]('client.src.usb_detector.api_client._cache_failed_payload')
+def test_send_data_4(_cache_failed_payload_mock, post_mock):
+    payload_mock = {
+        "device": {
+            "vendor_id": 1,
+            "product_id": 2
+        }
+    }
+    post_mock.side_effect = requests.exceptions.HTTPError()
+
+    api_client._uri = "127.0.0.1:54444/api/v1/usb-logs"
+    api_client.send_data(payload_mock)
+
+    args = _cache_failed_payload_mock.call_args.args
+    _cache_failed_payload_mock.assert_called()
+    assert args[0] == payload_mock