Introduce PpmsConnection.last_served_from_cache attribute

Author: ehrenfeu

CHANGELOG.md

@@ -4,7 +4,12 @@
 
 NOTE: potentially breaking changes are flagged with a 🧨 symbol.
 
-## 3.1.1
+## 3.2.0
+
+### Added
+
+- `pyppms.booking.PpmsBooking.last_served_from_cache` has been added to indicate
+  if the last request was served from the cache or on-line.
 
 ### Changed
 

src/pyppms/ppms.py

@@ -40,6 +40,8 @@ class PpmsConnection:
     cache_users_only : bool
         Flag indicating that only PPMS user details will be stored in the
         on-disk cache, nothing else.
+    last_served_from_cache
+        Indicates if the last request was served from the cache or on-line.
     users : dict
         A dict with usernames as keys, mapping to the related
         :py:class:`pyppms.user.PpmsUser` object, serves as a cache during the object's
@@ -108,6 +110,8 @@ def __init__(self, url, api_key, timeout=10, cache="", cache_users_only=False):
         }
         self.cache_path = cache
         self.cache_users_only = cache_users_only
+        self.last_served_from_cache = False
+        """Indicates if the last request was served from the cache or on-line."""
 
         # run in cache-only mode (e.g. for testing or off-line usage) if no API
         # key has been specified, skip authentication then:
@@ -208,18 +212,18 @@ def request(self, action, parameters={}, skip_cache=False):
         # log.debug("Request parameters: {}", parameters)
 
         response = None
-        read_from_cache = False
         try:
             if skip_cache:  # pragma: no cover
                 raise LookupError("Skipping the cache has been requested")
             response = self.__intercept_read(req_data)
-            read_from_cache = True
+            self.last_served_from_cache = True
         except LookupError as err:
             log.trace(f"Doing an on-line request: {err}")
             response = requests.post(self.url, data=req_data, timeout=self.timeout)
+            self.last_served_from_cache = False
 
         # store the response if it hasn't been read from the cache before:
-        if not read_from_cache:  # pragma: no cover
+        if not self.last_served_from_cache:  # pragma: no cover
             self.__intercept_store(req_data, response)
 
         # NOTE: the HTTP status code returned is always `200` even if

tests/test_ppms.py

@@ -271,19 +271,19 @@ def test_get_user__skip_cache(caplog, ppms_connection, ppms_user):
     assert os.path.exists(cached) is False
 
     ppms_connection.get_user(ppms_user.username)
-    assert "Doing an on-line request: No cache hit for" in caplog.text
+    assert ppms_connection.last_served_from_cache is False
     assert "Read intercepted response text from" not in caplog.text
 
     assert os.path.exists(cached) is True
 
     caplog.clear()
     ppms_connection.get_user(ppms_user.username)
-    assert "Doing an on-line request: No cache hit for" not in caplog.text
+    assert ppms_connection.last_served_from_cache is True
     assert "Read intercepted response text from" in caplog.text
 
     caplog.clear()
     ppms_connection.get_user(ppms_user.username, skip_cache=True)
-    assert "Doing an on-line request: Skipping the cache" in caplog.text
+    assert ppms_connection.last_served_from_cache is False
     assert "Read intercepted response text from" not in caplog.text
 
     # make sure to clean up the test-specific cache again:
@@ -409,12 +409,10 @@ def test_update_systems(ppms_connection, caplog):
     """Test the get_systems() method."""
     caplog.set_level(logging.DEBUG)
     switch_cache_mocks(ppms_connection, "update_systems__broken_id")
-    systems = ppms_connection.get_systems()
-
+    assert len(ppms_connection.systems) == 0
+    ppms_connection.get_systems()
     # results should contain exaclty one system:
-    assert len(systems) == 1
-    assert "Updated 1 bookable systems from PPMS" in caplog.text
-    assert "1 systems failed parsing" in caplog.text
+    assert len(ppms_connection.systems) == 1
 
 
 def test_get_systems_matching(ppms_connection, system_details_raw):
@@ -819,9 +817,11 @@ def test_flush_cache__keep_users__request_new(ppms_connection, caplog, tmp_path)
 
     log.info(f"Requesting details from PUMAPI for cached user [{old_user_name}]")
     ppms_connection.get_user(old_user_name)
-    assert "No cache hit" not in caplog.text  # served from the cache
+    assert ppms_connection.last_served_from_cache is True
+    # assert "No cache hit" not in caplog.text  # served from the cache
 
     log.info(f"Requesting details from PUMAPI for 'new' user [{new_user_name}]")
     ppms_connection.get_user(new_user_name)
-    assert "No cache hit" in caplog.text  # requires an on-line request
+    assert ppms_connection.last_served_from_cache is False
+    # assert "No cache hit" in caplog.text  # requires an on-line request
     assert os.path.exists(new_user_cache)