Porting tests from archived repository of OpenPAYGO-Token

CONTRIBUTING.md

@@ -14,7 +14,8 @@ Most documentation is currently written in Markdown, making it easy to add, modi
 
 ## Issues
 
-Issues are created [here](https://github.com/EnAccess/OpenPAYGO-python/issues/new/choose)
+Create new issues in the
+[issue tracker](https://github.com/EnAccess/OpenPAYGO-python/issues/new/choose)
 
 ### How to Contribute to Issues
 

openpaygo/token_decode.py

@@ -134,6 +134,8 @@ def get_activation_value_count_and_type_from_token(
 
     @classmethod
     def _count_is_valid(cls, count, last_count, value, type, used_counts):
+        if used_counts is None:
+            used_counts = []
         if value == OpenPAYGOTokenShared.COUNTER_SYNC_VALUE:
             if count > (last_count - cls.MAX_TOKEN_JUMP):
                 return True
@@ -147,7 +149,7 @@ def _count_is_valid(cls, count, last_count, value, type, used_counts):
 
     @classmethod
     def update_used_counts(cls, past_used_counts, value, new_count, type):
-        if not past_used_counts:
+        if not past_used_counts: 
             return None
         highest_count = max(past_used_counts) if past_used_counts else 0
         if new_count > highest_count:

openpaygo/token_shared.py

@@ -61,14 +61,32 @@ def generate_starting_code(cls, key):
 
     @classmethod
     def load_secret_key_from_hex(cls, secret_key):
+        if isinstance(secret_key, (bytes, bytearray)):
+            secret_key_bytes = bytes(secret_key)
+            if len(secret_key_bytes) != 16:
+                raise ValueError(
+                    "The secret key provided is not correctly formatted, it should be "
+                    "16 "
+                    "bytes. "
+                )
+            return secret_key_bytes
+
         try:
-            return codecs.decode(secret_key, "hex")
+            decoded = codecs.decode(secret_key, "hex")
         except Exception:
             raise ValueError(
                 "The secret key provided is not correctly formatted, it should be 32 "
                 "hexadecimal characters. "
             )
 
+        if len(decoded) != 16:
+            raise ValueError(
+                "The secret key provided is not correctly formatted, it should be 32 "
+                "hexadecimal characters. "
+            )
+
+        return decoded
+
     @classmethod
     def _convert_to_29_5_bits(cls, source):
         mask = ((1 << (32 - 2 + 1)) - 1) << 2

test/README.md

@@ -0,0 +1,17 @@
+# OpenPAYGO-Token Test
+
+To run the test, first, create and activate a virtual environment. Then install the module and run the test:
+
+```bash
+cd tests
+python -m venv env
+source env/bin/activate
+python -m pip install -e ..
+python simple_scenario_test.py
+```
+
+You can do it for full test procedure as well:
+
+```bash
+python full_test_procedure.py
+```

test/full_test_procedure.py

@@ -0,0 +1,250 @@
+import codecs
+
+from helpers import (
+    ADD_TIME,
+    DISABLE_VALUE,
+    SET_TIME,
+    generate_from_device_data,
+    test_accepted_validator,
+    test_how_many_days_validator,
+    test_name,
+)
+
+from test.simulators.device_simulator import DeviceSimulator
+
+# This tests the device simulator against the full test procedure
+
+
+def run_core_token_tests(device_data, device_simulator):
+    test = "We enter an invalid token"
+    token_g1 = "123 456 789"
+    test_accepted_validator(device_simulator, "G1", token_g1, -1, description=test)
+
+    test = "We enter a valid token for setting one day"
+    device_data, token_g2 = generate_from_device_data(
+        device_data, token_type=SET_TIME, value_days=1
+    )
+    test_how_many_days_validator(device_simulator, "G2", token_g2, 1, description=test)
+
+    test = "We enter a valid token for adding one day"
+    device_data, token_g3 = generate_from_device_data(
+        device_data, token_type=ADD_TIME, value_days=1
+    )
+    test_how_many_days_validator(device_simulator, "G3", token_g3, 2, description=test)
+
+    test = (
+        "We enter the same Add Time token for 1 day, the days should not be "
+        "added and the device should signal that the token was already used"
+    )
+    test_how_many_days_validator(
+        device_simulator,
+        "G4A",
+        token_g3,
+        2,
+        description=test,
+        accepted_but_used=True,
+    )
+    test = (
+        "We enter the older Set Time token for 1 day, the days should not "
+        "change and the device should signal that the token was already used"
+    )
+    test_how_many_days_validator(
+        device_simulator,
+        "G4B",
+        token_g2,
+        2,
+        description=test,
+        accepted_but_used=True,
+    )
+
+    test = (
+        "We enter a valid token for setting 30 days and ensures it sets and does "
+        "not add to the existing"
+    )
+    device_data, token_g5 = generate_from_device_data(
+        device_data, token_type=SET_TIME, value_days=30
+    )
+    test_how_many_days_validator(device_simulator, "G5", token_g5, 30, description=test)
+
+    test = (
+        "We enter a valid token for setting 0 days and ensures the device is "
+        "inactive with the outputs disabled immediately"
+    )
+    device_data, token_g6 = generate_from_device_data(
+        device_data, token_type=SET_TIME, value_days=0
+    )
+    test_how_many_days_validator(device_simulator, "G6", token_g6, 0, description=test)
+
+    test = (
+        "We enter 3 consecutive Add Time tokens with the maximum amount of days and "
+        "ensure that they cumulate properly"
+    )
+    for i in range(1, 3 + 1):
+        device_data, token_g7 = generate_from_device_data(
+            device_data, token_type=ADD_TIME, value_raw=995
+        )
+        test_how_many_days_validator(
+            device_simulator,
+            test_name("G7", i),
+            token_g7,
+            value_raw=995 * i,
+            device_data=device_data,
+            description=test,
+        )
+        test = ""
+
+    test = (
+        "We enter 21 consecutive Set Time tokens for 1, 2, 3, … 21 days "
+        "each with a count 30 higher than the other. The validation of the "
+        "token should not take more than 5 seconds"
+    )
+    for i in range(1, 21 + 1):
+        device_data, token_g8 = generate_from_device_data(
+            device_data,
+            token_type=SET_TIME,
+            value_days=i,
+            token_count=device_data["token_count"] + 29,
+        )
+        test_how_many_days_validator(
+            device_simulator,
+            test_name("G8", i),
+            token_g8,
+            value_days=i,
+            device_data=device_data,
+            description=test,
+        )
+        test = ""
+
+    test = "We enter a PAYG Disable token into the device"
+    device_data, token_g9 = generate_from_device_data(
+        device_data, token_type=SET_TIME, value_raw=DISABLE_VALUE
+    )
+    test_how_many_days_validator(
+        device_simulator, "G9", token_g9, None, description=test
+    )
+
+    test = "We enter a Set Time token for 0 day, it should relock the device"
+    device_data, token_g10 = generate_from_device_data(
+        device_data, token_type=SET_TIME, value_days=0
+    )
+    test_how_many_days_validator(
+        device_simulator, "G10", token_g10, 0, description=test
+    )
+
+    test = (
+        "We enter a PAYG Disable token to relock the device, then enter a Add "
+        "Time token with 0 day, it should NOT relock the device (Optional)"
+    )
+    device_data, token_g11a = generate_from_device_data(
+        device_data, token_type=SET_TIME, value_raw=DISABLE_VALUE
+    )
+    test_how_many_days_validator(
+        device_simulator, "G11A", token_g11a, None, description=test
+    )
+    device_data, token_g11b = generate_from_device_data(
+        device_data, token_type=ADD_TIME, value_days=0
+    )
+    test_how_many_days_validator(device_simulator, "G11B", token_g11b, None)
+
+    test = (
+        "We deactivate the device with a Set Time of 0 days. We then wait "
+        "48 hours before entering a Add Time of 1 day and ensuring that the "
+        "days late are not considered in the activation time"
+    )
+    device_data, token_g12a = generate_from_device_data(
+        device_data, token_type=SET_TIME, value_days=0
+    )
+    test_how_many_days_validator(
+        device_simulator, "G12A", token_g12a, 0, description=test
+    )
+    device_data, token_g12b = generate_from_device_data(
+        device_data, token_type=ADD_TIME, value_days=1
+    )
+    test_how_many_days_validator(device_simulator, "G12B", token_g12b, 1)
+
+    return device_data
+
+
+def run_unordered_entry_tests(device_data, device_simulator):
+    test = (
+        "We generate 3 Add Time tokens, then enter the 3rd, then first, then "
+        "second and ensure the days are added properly"
+    )
+    device_data, token_u1a = generate_from_device_data(
+        device_data, token_type=SET_TIME, value_days=60
+    )
+    test_how_many_days_validator(
+        device_simulator, "U1A", token_u1a, 60, description=test
+    )
+    device_data, token_u1b = generate_from_device_data(
+        device_data, token_type=ADD_TIME, value_days=10
+    )
+    device_data, token_u1c = generate_from_device_data(
+        device_data, token_type=ADD_TIME, value_days=5
+    )
+    device_data, token_u1d = generate_from_device_data(
+        device_data, token_type=ADD_TIME, value_days=1
+    )
+    test_how_many_days_validator(device_simulator, "U1B", token_u1d, 61)
+    test_how_many_days_validator(device_simulator, "U1C", token_u1b, 71)
+    test_how_many_days_validator(device_simulator, "U1D", token_u1c, 76)
+
+    test = (
+        "We generate an Add Time, a Set Time and another Add Time token. We "
+        "enter the set time and ensure that the older Add Time does not work "
+        "but the newer does"
+    )
+    device_data, token_u2a = generate_from_device_data(
+        device_data, token_type=ADD_TIME, value_days=5
+    )
+    device_data, token_u2b = generate_from_device_data(
+        device_data, token_type=SET_TIME, value_days=10
+    )
+    device_data, token_u2c = generate_from_device_data(
+        device_data, token_type=ADD_TIME, value_days=3
+    )
+    test_how_many_days_validator(
+        device_simulator, "U2A", token_u2b, 10, description=test
+    )
+    test_how_many_days_validator(
+        device_simulator, "U2B", token_u2a, 10, accepted_but_used=True
+    )
+    test_how_many_days_validator(device_simulator, "U2C", token_u2c, 13)
+
+    test = (
+        "We generate an Add Time token and a Disable PAYG token, we enter the "
+        "Disable PAYG token and then the Add Time token should be refused"
+    )
+    device_data, token_u3a = generate_from_device_data(
+        device_data, token_type=ADD_TIME, value_days=1
+    )
+    device_data, token_u3b = generate_from_device_data(
+        device_data, token_type=ADD_TIME, value_raw=DISABLE_VALUE
+    )
+    test_how_many_days_validator(
+        device_simulator, "U3A", token_u3b, None, description=test
+    )
+    test_how_many_days_validator(
+        device_simulator, "U3B", token_u3a, None, accepted_but_used=True
+    )
+
+    return device_data
+
+
+if __name__ == "__main__":
+    device_data = {
+        "serial_number": "XXX",
+        "starting_code": 516959010,
+        "key": "bc41ec9530f6dac86b1a29ab82edc5fb",
+        "restricted_digit_set": False,
+        "time_divider": 1,
+        "token_count": 1,
+    }
+    device_simulator = DeviceSimulator(
+        device_data["starting_code"],
+        codecs.decode(device_data["key"], "hex"),
+        restricted_digit_set=device_data["restricted_digit_set"],
+        waiting_period_enabled=False,
+    )
+    device_data = run_core_token_tests(device_data, device_simulator)
+    device_data = run_unordered_entry_tests(device_data, device_simulator)