Porting tests from archived repository of OpenPAYGO-Token

openpaygo/token_decode.py

@@ -134,6 +134,7 @@ def get_activation_value_count_and_type_from_token(
 
  @classmethod
  def _count_is_valid(cls, count, last_count, value, type, used_counts):
+
  if value == OpenPAYGOTokenShared.COUNTER_SYNC_VALUE:
  if count > (last_count - cls.MAX_TOKEN_JUMP):
  return True

test/README.md

@@ -0,0 +1,8 @@
+# OpenPAYGO-Token Test
+
+To run the test, first, create and activate a virtual environment. Then install the module and run the test:
+
+```bash
+uv run python test/simple_scenario_test.py 
+uv run python test/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)

test/helpers.py

@@ -0,0 +1,98 @@
+import codecs
+
+import openpaygo
+from openpaygo.token_shared import TokenType
+
+SET_TIME = TokenType.SET_TIME
+ADD_TIME = TokenType.ADD_TIME
+DISABLE_VALUE = 998
+
+START_RED = "\033[91m"
+END_RED = "\033[0m"
+
+
+def generate_from_device_data(
+ device_data, token_type, value_raw=None, value_days=None, token_count=None
+):
+ assert (value_days is not None) or (value_raw is not None)
+ if value_raw is None:
+ value_raw = value_days * device_data["time_divider"]
+ device_data["token_count"], token = (
+ openpaygo.token_encode.OpenPAYGOTokenEncoder.generate_standard_token(
+ starting_code=device_data["starting_code"],
+ key=codecs.decode(device_data["key"], "hex"),
+ value=value_raw,
+ count=token_count or device_data["token_count"],
+ restricted_digit_set=device_data["restricted_digit_set"],
+ mode=token_type,
+ )
+ )
+ token = str(token).rjust(9, "0")
+ token = " ".join([token[i : i + 3] for i in range(0, len(token), 3)])
+ return device_data, token
+
+
+def test_how_many_days(
+ test_name, token, value_days=None, value_raw=None, device_data=None, description=""
+):
+ if value_days is None:
+ if value_raw is not None:
+ value_days = value_raw / device_data["time_divider"]
+ else:
+ value_days = "infinite"
+ print(
+ test_name
+ + ","
+ + token
+ + ","
+ + str(value_days)
+ + " days active"
+ + ',"'
+ + description
+ + '"'
+ )
+
+
+def test_accepted(test_name, token, expected, description=""):
+ expected_string = "Token Accepted" if expected else "Token Refused"
+ print(test_name + "," + token + "," + expected_string + ',"' + description + '"')
+
+
+def test_how_many_days_validator(
+ device_simulator,
+ test_name,
+ token,
+ value_days=None,
+ value_raw=None,
+ device_data=None,
+ description="",
+ accepted_but_used=False,
+):
+ if value_days is None:
+ if value_raw is not None:
+ value_days = value_raw / device_data["time_divider"]
+ else:
+ value_days = "infinite"
+ result = device_simulator.enter_token(token.replace(" ", ""), show_result=False)
+ if result == 1 or (accepted_but_used and result == -2):
+ if device_simulator.get_days_remaining() == value_days:
+ print(test_name + ": Passed")
+ return
+ print(START_RED + test_name + ": Failed" + END_RED)
+
+
+def test_accepted_validator(
+ device_simulator, test_name, token, expected, description=""
+):
+ if (
+ device_simulator.enter_token(token.replace(" ", ""), show_result=False)
+ == expected
+ ):
+ print(test_name + ": Passed")
+ return
+ else:
+ print(START_RED + test_name + ": Failed" + END_RED)
+
+
+def test_name(test_base_name, test_number):
+ return test_base_name + chr(test_number + 64)

openpaygo/token_decode.py

@@ -134,6 +134,7 @@ def get_activation_value_count_and_type_from_token(
 
  @classmethod
  def _count_is_valid(cls, count, last_count, value, type, used_counts):
+
  if value == OpenPAYGOTokenShared.COUNTER_SYNC_VALUE:
  if count > (last_count - cls.MAX_TOKEN_JUMP):
  return True

test/README.md

@@ -0,0 +1,8 @@
+# OpenPAYGO-Token Test
+
+To run the test, first, create and activate a virtual environment. Then install the module and run the test:
+
+```bash
+uv run python test/simple_scenario_test.py 
+uv run python test/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)

test/helpers.py

@@ -0,0 +1,98 @@
+import codecs
+
+import openpaygo
+from openpaygo.token_shared import TokenType
+
+SET_TIME = TokenType.SET_TIME
+ADD_TIME = TokenType.ADD_TIME
+DISABLE_VALUE = 998
+
+START_RED = "\033[91m"
+END_RED = "\033[0m"
+
+
+def generate_from_device_data(
+ device_data, token_type, value_raw=None, value_days=None, token_count=None
+):
+ assert (value_days is not None) or (value_raw is not None)
+ if value_raw is None:
+ value_raw = value_days * device_data["time_divider"]
+ device_data["token_count"], token = (
+ openpaygo.token_encode.OpenPAYGOTokenEncoder.generate_standard_token(
+ starting_code=device_data["starting_code"],
+ key=codecs.decode(device_data["key"], "hex"),
+ value=value_raw,
+ count=token_count or device_data["token_count"],
+ restricted_digit_set=device_data["restricted_digit_set"],
+ mode=token_type,
+ )
+ )
+ token = str(token).rjust(9, "0")
+ token = " ".join([token[i : i + 3] for i in range(0, len(token), 3)])
+ return device_data, token
+
+
+def test_how_many_days(
+ test_name, token, value_days=None, value_raw=None, device_data=None, description=""
+):
+ if value_days is None:
+ if value_raw is not None:
+ value_days = value_raw / device_data["time_divider"]
+ else:
+ value_days = "infinite"
+ print(
+ test_name
+ + ","
+ + token
+ + ","
+ + str(value_days)
+ + " days active"
+ + ',"'
+ + description
+ + '"'
+ )
+
+
+def test_accepted(test_name, token, expected, description=""):
+ expected_string = "Token Accepted" if expected else "Token Refused"
+ print(test_name + "," + token + "," + expected_string + ',"' + description + '"')
+
+
+def test_how_many_days_validator(
+ device_simulator,
+ test_name,
+ token,
+ value_days=None,
+ value_raw=None,
+ device_data=None,
+ description="",
+ accepted_but_used=False,
+):
+ if value_days is None:
+ if value_raw is not None:
+ value_days = value_raw / device_data["time_divider"]
+ else:
+ value_days = "infinite"
+ result = device_simulator.enter_token(token.replace(" ", ""), show_result=False)
+ if result == 1 or (accepted_but_used and result == -2):
+ if device_simulator.get_days_remaining() == value_days:
+ print(test_name + ": Passed")
+ return
+ print(START_RED + test_name + ": Failed" + END_RED)
+
+
+def test_accepted_validator(
+ device_simulator, test_name, token, expected, description=""
+):
+ if (
+ device_simulator.enter_token(token.replace(" ", ""), show_result=False)
+ == expected
+ ):
+ print(test_name + ": Passed")
+ return
+ else:
+ print(START_RED + test_name + ": Failed" + END_RED)
+
+
+def test_name(test_base_name, test_number):
+ return test_base_name + chr(test_number + 64)

openpaygo/token_decode.py

@@ -134,6 +134,7 @@ def get_activation_value_count_and_type_from_token(
 
  @classmethod
  def _count_is_valid(cls, count, last_count, value, type, used_counts):
+
  if value == OpenPAYGOTokenShared.COUNTER_SYNC_VALUE:
  if count > (last_count - cls.MAX_TOKEN_JUMP):
  return True

test/README.md

@@ -0,0 +1,8 @@
+# OpenPAYGO-Token Test
+
+To run the test, first, create and activate a virtual environment. Then install the module and run the test:
+
+```bash
+uv run python test/simple_scenario_test.py 
+uv run python test/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)

test/helpers.py

@@ -0,0 +1,98 @@
+import codecs
+
+import openpaygo
+from openpaygo.token_shared import TokenType
+
+SET_TIME = TokenType.SET_TIME
+ADD_TIME = TokenType.ADD_TIME
+DISABLE_VALUE = 998
+
+START_RED = "\033[91m"
+END_RED = "\033[0m"
+
+
+def generate_from_device_data(
+ device_data, token_type, value_raw=None, value_days=None, token_count=None
+):
+ assert (value_days is not None) or (value_raw is not None)
+ if value_raw is None:
+ value_raw = value_days * device_data["time_divider"]
+ device_data["token_count"], token = (
+ openpaygo.token_encode.OpenPAYGOTokenEncoder.generate_standard_token(
+ starting_code=device_data["starting_code"],
+ key=codecs.decode(device_data["key"], "hex"),
+ value=value_raw,
+ count=token_count or device_data["token_count"],
+ restricted_digit_set=device_data["restricted_digit_set"],
+ mode=token_type,
+ )
+ )
+ token = str(token).rjust(9, "0")
+ token = " ".join([token[i : i + 3] for i in range(0, len(token), 3)])
+ return device_data, token
+
+
+def test_how_many_days(
+ test_name, token, value_days=None, value_raw=None, device_data=None, description=""
+):
+ if value_days is None:
+ if value_raw is not None:
+ value_days = value_raw / device_data["time_divider"]
+ else:
+ value_days = "infinite"
+ print(
+ test_name
+ + ","
+ + token
+ + ","
+ + str(value_days)
+ + " days active"
+ + ',"'
+ + description
+ + '"'
+ )
+
+
+def test_accepted(test_name, token, expected, description=""):
+ expected_string = "Token Accepted" if expected else "Token Refused"
+ print(test_name + "," + token + "," + expected_string + ',"' + description + '"')
+
+
+def test_how_many_days_validator(
+ device_simulator,
+ test_name,
+ token,
+ value_days=None,
+ value_raw=None,
+ device_data=None,
+ description="",
+ accepted_but_used=False,
+):
+ if value_days is None:
+ if value_raw is not None:
+ value_days = value_raw / device_data["time_divider"]
+ else:
+ value_days = "infinite"
+ result = device_simulator.enter_token(token.replace(" ", ""), show_result=False)
+ if result == 1 or (accepted_but_used and result == -2):
+ if device_simulator.get_days_remaining() == value_days:
+ print(test_name + ": Passed")
+ return
+ print(START_RED + test_name + ": Failed" + END_RED)
+
+
+def test_accepted_validator(
+ device_simulator, test_name, token, expected, description=""
+):
+ if (
+ device_simulator.enter_token(token.replace(" ", ""), show_result=False)
+ == expected
+ ):
+ print(test_name + ": Passed")
+ return
+ else:
+ print(START_RED + test_name + ": Failed" + END_RED)
+
+
+def test_name(test_base_name, test_number):
+ return test_base_name + chr(test_number + 64)

openpaygo/token_decode.py

@@ -134,6 +134,7 @@ def get_activation_value_count_and_type_from_token(
 
  @classmethod
  def _count_is_valid(cls, count, last_count, value, type, used_counts):
+
  if value == OpenPAYGOTokenShared.COUNTER_SYNC_VALUE:
  if count > (last_count - cls.MAX_TOKEN_JUMP):
  return True

test/README.md

@@ -0,0 +1,8 @@
+# OpenPAYGO-Token Test
+
+To run the test, first, create and activate a virtual environment. Then install the module and run the test:
+
+```bash
+uv run python test/simple_scenario_test.py 
+uv run python test/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)

test/helpers.py

@@ -0,0 +1,98 @@
+import codecs
+
+import openpaygo
+from openpaygo.token_shared import TokenType
+
+SET_TIME = TokenType.SET_TIME
+ADD_TIME = TokenType.ADD_TIME
+DISABLE_VALUE = 998
+
+START_RED = "\033[91m"
+END_RED = "\033[0m"
+
+
+def generate_from_device_data(
+ device_data, token_type, value_raw=None, value_days=None, token_count=None
+):
+ assert (value_days is not None) or (value_raw is not None)
+ if value_raw is None:
+ value_raw = value_days * device_data["time_divider"]
+ device_data["token_count"], token = (
+ openpaygo.token_encode.OpenPAYGOTokenEncoder.generate_standard_token(
+ starting_code=device_data["starting_code"],
+ key=codecs.decode(device_data["key"], "hex"),
+ value=value_raw,
+ count=token_count or device_data["token_count"],
+ restricted_digit_set=device_data["restricted_digit_set"],
+ mode=token_type,
+ )
+ )
+ token = str(token).rjust(9, "0")
+ token = " ".join([token[i : i + 3] for i in range(0, len(token), 3)])
+ return device_data, token
+
+
+def test_how_many_days(
+ test_name, token, value_days=None, value_raw=None, device_data=None, description=""
+):
+ if value_days is None:
+ if value_raw is not None:
+ value_days = value_raw / device_data["time_divider"]
+ else:
+ value_days = "infinite"
+ print(
+ test_name
+ + ","
+ + token
+ + ","
+ + str(value_days)
+ + " days active"
+ + ',"'
+ + description
+ + '"'
+ )
+
+
+def test_accepted(test_name, token, expected, description=""):
+ expected_string = "Token Accepted" if expected else "Token Refused"
+ print(test_name + "," + token + "," + expected_string + ',"' + description + '"')
+
+
+def test_how_many_days_validator(
+ device_simulator,
+ test_name,
+ token,
+ value_days=None,
+ value_raw=None,
+ device_data=None,
+ description="",
+ accepted_but_used=False,
+):
+ if value_days is None:
+ if value_raw is not None:
+ value_days = value_raw / device_data["time_divider"]
+ else:
+ value_days = "infinite"
+ result = device_simulator.enter_token(token.replace(" ", ""), show_result=False)
+ if result == 1 or (accepted_but_used and result == -2):
+ if device_simulator.get_days_remaining() == value_days:
+ print(test_name + ": Passed")
+ return
+ print(START_RED + test_name + ": Failed" + END_RED)
+
+
+def test_accepted_validator(
+ device_simulator, test_name, token, expected, description=""
+):
+ if (
+ device_simulator.enter_token(token.replace(" ", ""), show_result=False)
+ == expected
+ ):
+ print(test_name + ": Passed")
+ return
+ else:
+ print(START_RED + test_name + ": Failed" + END_RED)
+
+
+def test_name(test_base_name, test_number):
+ return test_base_name + chr(test_number + 64)

openpaygo/token_decode.py

@@ -134,6 +134,7 @@ def get_activation_value_count_and_type_from_token(
 
  @classmethod
  def _count_is_valid(cls, count, last_count, value, type, used_counts):
+
  if value == OpenPAYGOTokenShared.COUNTER_SYNC_VALUE:
  if count > (last_count - cls.MAX_TOKEN_JUMP):
  return True

test/README.md

@@ -0,0 +1,8 @@
+# OpenPAYGO-Token Test
+
+To run the test, first, create and activate a virtual environment. Then install the module and run the test:
+
+```bash
+uv run python test/simple_scenario_test.py 
+uv run python test/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)

test/helpers.py

@@ -0,0 +1,98 @@
+import codecs
+
+import openpaygo
+from openpaygo.token_shared import TokenType
+
+SET_TIME = TokenType.SET_TIME
+ADD_TIME = TokenType.ADD_TIME
+DISABLE_VALUE = 998
+
+START_RED = "\033[91m"
+END_RED = "\033[0m"
+
+
+def generate_from_device_data(
+ device_data, token_type, value_raw=None, value_days=None, token_count=None
+):
+ assert (value_days is not None) or (value_raw is not None)
+ if value_raw is None:
+ value_raw = value_days * device_data["time_divider"]
+ device_data["token_count"], token = (
+ openpaygo.token_encode.OpenPAYGOTokenEncoder.generate_standard_token(
+ starting_code=device_data["starting_code"],
+ key=codecs.decode(device_data["key"], "hex"),
+ value=value_raw,
+ count=token_count or device_data["token_count"],
+ restricted_digit_set=device_data["restricted_digit_set"],
+ mode=token_type,
+ )
+ )
+ token = str(token).rjust(9, "0")
+ token = " ".join([token[i : i + 3] for i in range(0, len(token), 3)])
+ return device_data, token
+
+
+def test_how_many_days(
+ test_name, token, value_days=None, value_raw=None, device_data=None, description=""
+):
+ if value_days is None:
+ if value_raw is not None:
+ value_days = value_raw / device_data["time_divider"]
+ else:
+ value_days = "infinite"
+ print(
+ test_name
+ + ","
+ + token
+ + ","
+ + str(value_days)
+ + " days active"
+ + ',"'
+ + description
+ + '"'
+ )
+
+
+def test_accepted(test_name, token, expected, description=""):
+ expected_string = "Token Accepted" if expected else "Token Refused"
+ print(test_name + "," + token + "," + expected_string + ',"' + description + '"')
+
+
+def test_how_many_days_validator(
+ device_simulator,
+ test_name,
+ token,
+ value_days=None,
+ value_raw=None,
+ device_data=None,
+ description="",
+ accepted_but_used=False,
+):
+ if value_days is None:
+ if value_raw is not None:
+ value_days = value_raw / device_data["time_divider"]
+ else:
+ value_days = "infinite"
+ result = device_simulator.enter_token(token.replace(" ", ""), show_result=False)
+ if result == 1 or (accepted_but_used and result == -2):
+ if device_simulator.get_days_remaining() == value_days:
+ print(test_name + ": Passed")
+ return
+ print(START_RED + test_name + ": Failed" + END_RED)
+
+
+def test_accepted_validator(
+ device_simulator, test_name, token, expected, description=""
+):
+ if (
+ device_simulator.enter_token(token.replace(" ", ""), show_result=False)
+ == expected
+ ):
+ print(test_name + ": Passed")
+ return
+ else:
+ print(START_RED + test_name + ": Failed" + END_RED)
+
+
+def test_name(test_base_name, test_number):
+ return test_base_name + chr(test_number + 64)

openpaygo/token_decode.py

@@ -134,6 +134,7 @@ def get_activation_value_count_and_type_from_token(
 
  @classmethod
  def _count_is_valid(cls, count, last_count, value, type, used_counts):
+
  if value == OpenPAYGOTokenShared.COUNTER_SYNC_VALUE:
  if count > (last_count - cls.MAX_TOKEN_JUMP):
  return True

test/README.md

@@ -0,0 +1,8 @@
+# OpenPAYGO-Token Test
+
+To run the test, first, create and activate a virtual environment. Then install the module and run the test:
+
+```bash
+uv run python test/simple_scenario_test.py 
+uv run python test/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)

test/helpers.py

@@ -0,0 +1,98 @@
+import codecs
+
+import openpaygo
+from openpaygo.token_shared import TokenType
+
+SET_TIME = TokenType.SET_TIME
+ADD_TIME = TokenType.ADD_TIME
+DISABLE_VALUE = 998
+
+START_RED = "\033[91m"
+END_RED = "\033[0m"
+
+
+def generate_from_device_data(
+ device_data, token_type, value_raw=None, value_days=None, token_count=None
+):
+ assert (value_days is not None) or (value_raw is not None)
+ if value_raw is None:
+ value_raw = value_days * device_data["time_divider"]
+ device_data["token_count"], token = (
+ openpaygo.token_encode.OpenPAYGOTokenEncoder.generate_standard_token(
+ starting_code=device_data["starting_code"],
+ key=codecs.decode(device_data["key"], "hex"),
+ value=value_raw,
+ count=token_count or device_data["token_count"],
+ restricted_digit_set=device_data["restricted_digit_set"],
+ mode=token_type,
+ )
+ )
+ token = str(token).rjust(9, "0")
+ token = " ".join([token[i : i + 3] for i in range(0, len(token), 3)])
+ return device_data, token
+
+
+def test_how_many_days(
+ test_name, token, value_days=None, value_raw=None, device_data=None, description=""
+):
+ if value_days is None:
+ if value_raw is not None:
+ value_days = value_raw / device_data["time_divider"]
+ else:
+ value_days = "infinite"
+ print(
+ test_name
+ + ","
+ + token
+ + ","
+ + str(value_days)
+ + " days active"
+ + ',"'
+ + description
+ + '"'
+ )
+
+
+def test_accepted(test_name, token, expected, description=""):
+ expected_string = "Token Accepted" if expected else "Token Refused"
+ print(test_name + "," + token + "," + expected_string + ',"' + description + '"')
+
+
+def test_how_many_days_validator(
+ device_simulator,
+ test_name,
+ token,
+ value_days=None,
+ value_raw=None,
+ device_data=None,
+ description="",
+ accepted_but_used=False,
+):
+ if value_days is None:
+ if value_raw is not None:
+ value_days = value_raw / device_data["time_divider"]
+ else:
+ value_days = "infinite"
+ result = device_simulator.enter_token(token.replace(" ", ""), show_result=False)
+ if result == 1 or (accepted_but_used and result == -2):
+ if device_simulator.get_days_remaining() == value_days:
+ print(test_name + ": Passed")
+ return
+ print(START_RED + test_name + ": Failed" + END_RED)
+
+
+def test_accepted_validator(
+ device_simulator, test_name, token, expected, description=""
+):
+ if (
+ device_simulator.enter_token(token.replace(" ", ""), show_result=False)
+ == expected
+ ):
+ print(test_name + ": Passed")
+ return
+ else:
+ print(START_RED + test_name + ": Failed" + END_RED)
+
+
+def test_name(test_base_name, test_number):
+ return test_base_name + chr(test_number + 64)

openpaygo/token_decode.py

@@ -134,6 +134,7 @@ def get_activation_value_count_and_type_from_token(
 
  @classmethod
  def _count_is_valid(cls, count, last_count, value, type, used_counts):
+
  if value == OpenPAYGOTokenShared.COUNTER_SYNC_VALUE:
  if count > (last_count - cls.MAX_TOKEN_JUMP):
  return True

test/README.md

@@ -0,0 +1,8 @@
+# OpenPAYGO-Token Test
+
+To run the test, first, create and activate a virtual environment. Then install the module and run the test:
+
+```bash
+uv run python test/simple_scenario_test.py 
+uv run python test/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)

test/helpers.py

@@ -0,0 +1,98 @@
+import codecs
+
+import openpaygo
+from openpaygo.token_shared import TokenType
+
+SET_TIME = TokenType.SET_TIME
+ADD_TIME = TokenType.ADD_TIME
+DISABLE_VALUE = 998
+
+START_RED = "\033[91m"
+END_RED = "\033[0m"
+
+
+def generate_from_device_data(
+ device_data, token_type, value_raw=None, value_days=None, token_count=None
+):
+ assert (value_days is not None) or (value_raw is not None)
+ if value_raw is None:
+ value_raw = value_days * device_data["time_divider"]
+ device_data["token_count"], token = (
+ openpaygo.token_encode.OpenPAYGOTokenEncoder.generate_standard_token(
+ starting_code=device_data["starting_code"],
+ key=codecs.decode(device_data["key"], "hex"),
+ value=value_raw,
+ count=token_count or device_data["token_count"],
+ restricted_digit_set=device_data["restricted_digit_set"],
+ mode=token_type,
+ )
+ )
+ token = str(token).rjust(9, "0")
+ token = " ".join([token[i : i + 3] for i in range(0, len(token), 3)])
+ return device_data, token
+
+
+def test_how_many_days(
+ test_name, token, value_days=None, value_raw=None, device_data=None, description=""
+):
+ if value_days is None:
+ if value_raw is not None:
+ value_days = value_raw / device_data["time_divider"]
+ else:
+ value_days = "infinite"
+ print(
+ test_name
+ + ","
+ + token
+ + ","
+ + str(value_days)
+ + " days active"
+ + ',"'
+ + description
+ + '"'
+ )
+
+
+def test_accepted(test_name, token, expected, description=""):
+ expected_string = "Token Accepted" if expected else "Token Refused"
+ print(test_name + "," + token + "," + expected_string + ',"' + description + '"')
+
+
+def test_how_many_days_validator(
+ device_simulator,
+ test_name,
+ token,
+ value_days=None,
+ value_raw=None,
+ device_data=None,
+ description="",
+ accepted_but_used=False,
+):
+ if value_days is None:
+ if value_raw is not None:
+ value_days = value_raw / device_data["time_divider"]
+ else:
+ value_days = "infinite"
+ result = device_simulator.enter_token(token.replace(" ", ""), show_result=False)
+ if result == 1 or (accepted_but_used and result == -2):
+ if device_simulator.get_days_remaining() == value_days:
+ print(test_name + ": Passed")
+ return
+ print(START_RED + test_name + ": Failed" + END_RED)
+
+
+def test_accepted_validator(
+ device_simulator, test_name, token, expected, description=""
+):
+ if (
+ device_simulator.enter_token(token.replace(" ", ""), show_result=False)
+ == expected
+ ):
+ print(test_name + ": Passed")
+ return
+ else:
+ print(START_RED + test_name + ": Failed" + END_RED)
+
+
+def test_name(test_base_name, test_number):
+ return test_base_name + chr(test_number + 64)

openpaygo/token_decode.py

@@ -134,6 +134,7 @@ def get_activation_value_count_and_type_from_token(
 
  @classmethod
  def _count_is_valid(cls, count, last_count, value, type, used_counts):
+
  if value == OpenPAYGOTokenShared.COUNTER_SYNC_VALUE:
  if count > (last_count - cls.MAX_TOKEN_JUMP):
  return True

test/README.md

@@ -0,0 +1,8 @@
+# OpenPAYGO-Token Test
+
+To run the test, first, create and activate a virtual environment. Then install the module and run the test:
+
+```bash
+uv run python test/simple_scenario_test.py 
+uv run python test/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)

test/helpers.py

@@ -0,0 +1,98 @@
+import codecs
+
+import openpaygo
+from openpaygo.token_shared import TokenType
+
+SET_TIME = TokenType.SET_TIME
+ADD_TIME = TokenType.ADD_TIME
+DISABLE_VALUE = 998
+
+START_RED = "\033[91m"
+END_RED = "\033[0m"
+
+
+def generate_from_device_data(
+ device_data, token_type, value_raw=None, value_days=None, token_count=None
+):
+ assert (value_days is not None) or (value_raw is not None)
+ if value_raw is None:
+ value_raw = value_days * device_data["time_divider"]
+ device_data["token_count"], token = (
+ openpaygo.token_encode.OpenPAYGOTokenEncoder.generate_standard_token(
+ starting_code=device_data["starting_code"],
+ key=codecs.decode(device_data["key"], "hex"),
+ value=value_raw,
+ count=token_count or device_data["token_count"],
+ restricted_digit_set=device_data["restricted_digit_set"],
+ mode=token_type,
+ )
+ )
+ token = str(token).rjust(9, "0")
+ token = " ".join([token[i : i + 3] for i in range(0, len(token), 3)])
+ return device_data, token
+
+
+def test_how_many_days(
+ test_name, token, value_days=None, value_raw=None, device_data=None, description=""
+):
+ if value_days is None:
+ if value_raw is not None:
+ value_days = value_raw / device_data["time_divider"]
+ else:
+ value_days = "infinite"
+ print(
+ test_name
+ + ","
+ + token
+ + ","
+ + str(value_days)
+ + " days active"
+ + ',"'
+ + description
+ + '"'
+ )
+
+
+def test_accepted(test_name, token, expected, description=""):
+ expected_string = "Token Accepted" if expected else "Token Refused"
+ print(test_name + "," + token + "," + expected_string + ',"' + description + '"')
+
+
+def test_how_many_days_validator(
+ device_simulator,
+ test_name,
+ token,
+ value_days=None,
+ value_raw=None,
+ device_data=None,
+ description="",
+ accepted_but_used=False,
+):
+ if value_days is None:
+ if value_raw is not None:
+ value_days = value_raw / device_data["time_divider"]
+ else:
+ value_days = "infinite"
+ result = device_simulator.enter_token(token.replace(" ", ""), show_result=False)
+ if result == 1 or (accepted_but_used and result == -2):
+ if device_simulator.get_days_remaining() == value_days:
+ print(test_name + ": Passed")
+ return
+ print(START_RED + test_name + ": Failed" + END_RED)
+
+
+def test_accepted_validator(
+ device_simulator, test_name, token, expected, description=""
+):
+ if (
+ device_simulator.enter_token(token.replace(" ", ""), show_result=False)
+ == expected
+ ):
+ print(test_name + ": Passed")
+ return
+ else:
+ print(START_RED + test_name + ": Failed" + END_RED)
+
+
+def test_name(test_base_name, test_number):
+ return test_base_name + chr(test_number + 64)