Document test

Author: adamtheturtle

tests/test_exceptions.py

@@ -4,17 +4,15 @@
 
 import io
 import random
-from datetime import datetime, timedelta
 
 import pytest
-import pytz
+from freezegun import freeze_time
 from mock_vws import MockVWS
 from mock_vws.database import VuforiaDatabase
 from mock_vws.states import States
 from PIL import Image
 from requests import codes
 
-from freezegun import freeze_time
 from vws import VWS, CloudRecoService
 from vws.exceptions import (
     AuthenticationFailure,
@@ -224,10 +222,21 @@ def test_metadata_too_large(
 
 
 def test_request_time_too_skewed(vws_client: VWS) -> None:
-    vws_max_time_skew = timedelta(minutes=5)
-    leeway = timedelta(seconds=10)
+    """
+    A ``RequestTimeTooSkewed`` exception is raised when the request time is
+    more than five minutes different from the server time.
+    """
+    vws_max_time_skew = 60 * 5
+    leeway = 10
     time_difference_from_now = vws_max_time_skew + leeway
-    with freeze_time(auto_tick_seconds=time_difference_from_now.seconds):
+
+    # We use a custom tick because we expect the following:
+    #
+    # * At least one time check when creating the request
+    # * At least one time check when processing the request
+    #
+    # >= 1 ticks are acceptable.
+    with freeze_time(auto_tick_seconds=time_difference_from_now):
         with pytest.raises(RequestTimeTooSkewed):
             vws_client.get_target_record(target_id='a')