Adds new gatekeeper tests

test/teos/unit/test_gatekeeper.py

@@ -1,11 +1,14 @@
 import pytest
 
-from teos.gatekeeper import AuthenticationFailure, NotEnoughSlots
+from teos.users_dbm import UsersDBM
+from teos.block_processor import BlockProcessor
+from teos.gatekeeper import AuthenticationFailure, NotEnoughSlots, UserInfo
 
 from common.cryptographer import Cryptographer
 from common.exceptions import InvalidParameter
+from common.constants import ENCRYPTED_BLOB_MAX_SIZE_HEX
 
-from test.teos.unit.conftest import get_random_value_hex, generate_keypair, get_config
+from test.teos.unit.conftest import get_random_value_hex, generate_keypair, get_config, generate_dummy_appointment
 
 
 config = get_config()
@@ -13,11 +16,18 @@ config = get_config()
 
 def test_init(gatekeeper, run_bitcoind):
     assert isinstance(gatekeeper.default_slots, int) and gatekeeper.default_slots == config.get("DEFAULT_SLOTS")
+    assert isinstance(
+        gatekeeper.default_subscription_duration, int
+    ) and gatekeeper.default_subscription_duration == config.get("DEFAULT_SUBSCRIPTION_DURATION")
+    assert isinstance(gatekeeper.expiry_delta, int) and gatekeeper.expiry_delta == config.get("EXPIRY_DELTA")
+    assert isinstance(gatekeeper.block_processor, BlockProcessor)
+    assert isinstance(gatekeeper.user_db, UsersDBM)
     assert isinstance(gatekeeper.registered_users, dict) and len(gatekeeper.registered_users) == 0
 
 
 def test_add_update_user(gatekeeper):
     # add_update_user adds DEFAULT_SLOTS to a given user as long as the identifier is {02, 03}| 32-byte hex str
+    # it also add DEFAULT_SUBSCRIPTION_DURATION + current_block_height to the user
     user_pk = "02" + get_random_value_hex(32)
 
     for _ in range(10):
@@ -27,6 +37,11 @@ def test_add_update_user(gatekeeper):
         gatekeeper.add_update_user(user_pk)
 
         assert gatekeeper.registered_users.get(user_pk).available_slots == current_slots + config.get("DEFAULT_SLOTS")
+        assert gatekeeper.registered_users[
+            user_pk
+        ].subscription_expiry == gatekeeper.block_processor.get_block_count() + config.get(
+            "DEFAULT_SUBSCRIPTION_DURATION"
+        )
 
     # The same can be checked for multiple users
     for _ in range(10):
@@ -35,6 +50,11 @@ def test_add_update_user(gatekeeper):
 
         gatekeeper.add_update_user(user_pk)
         assert gatekeeper.registered_users.get(user_pk).available_slots == config.get("DEFAULT_SLOTS")
+        assert gatekeeper.registered_users[
+            user_pk
+        ].subscription_expiry == gatekeeper.block_processor.get_block_count() + config.get(
+            "DEFAULT_SUBSCRIPTION_DURATION"
+        )
 
 
 def test_add_update_user_wrong_pk(gatekeeper):
@@ -108,4 +128,63 @@ def test_identify_user_wrong(gatekeeper):
         gatekeeper.authenticate_user(message, signature.encode())
 
 
-# FIXME: MISSING TESTS
+def test_update_available_slots(gatekeeper):
+    # update_available_slots should decrease the slot count if a new appointment is added
+    # let's add a new user
+    sk, pk = generate_keypair()
+    compressed_pk = Cryptographer.get_compressed_pk(pk)
+    gatekeeper.add_update_user(compressed_pk)
+
+    # And now update the slots given an appointment
+    appointment, _ = generate_dummy_appointment()
+    gatekeeper.update_available_slots(compressed_pk, appointment.get_summary())
+
+    # This is a standard size appointment, so it should have reduced the slots by one
+    assert gatekeeper.registered_users[compressed_pk].available_slots == config.get("DEFAULT_SLOTS") - 1
+
+    # Updates can leave the count as it, decrease it, or increase it, depending on the appointment size (modulo
+    # ENCRYPTED_BLOB_MAX_SIZE_HEX)
+
+    # Appointments of the same size leave it as is
+    appointment_same_size, _ = generate_dummy_appointment()
+    remaining_slots = gatekeeper.update_available_slots(
+        compressed_pk, appointment.get_summary(), appointment_same_size.get_summary()
+    )
+    assert remaining_slots == config.get("DEFAULT_SLOTS") - 1
+
+    # Bigger appointments decrease it
+    appointment_x2_size = appointment_same_size
+    appointment_x2_size.encrypted_blob = "A" * (ENCRYPTED_BLOB_MAX_SIZE_HEX + 1)
+    remaining_slots = gatekeeper.update_available_slots(
+        compressed_pk, appointment_x2_size.get_summary(), appointment.get_summary()
+    )
+    assert remaining_slots == config.get("DEFAULT_SLOTS") - 2
+
+    # Smaller appointments increase it (using the same data but flipped)
+    remaining_slots = gatekeeper.update_available_slots(
+        compressed_pk, appointment.get_summary(), appointment_x2_size.get_summary()
+    )
+    assert remaining_slots == config.get("DEFAULT_SLOTS") - 1
+
+    # If the appointment needs more slots than there's free, it should fail
+    gatekeeper.registered_users[compressed_pk].available_slots = 1
+    with pytest.raises(NotEnoughSlots):
+        gatekeeper.update_available_slots(compressed_pk, appointment_x2_size.get_summary())
+
+
+def test_get_expired_appointments(gatekeeper):
+    # get_expired_appointments returns a list of appointment uuids expiring at a given block
+
+    appointment = {}
+    # Let's simulate adding some users with dummy expiry times
+    gatekeeper.registered_users = {}
+    for i in reversed(range(100)):
+        uuid = get_random_value_hex(16)
+        user_appointments = [get_random_value_hex(16)]
+        # Add a single appointment to the user
+        gatekeeper.registered_users[uuid] = UserInfo(100, i, user_appointments)
+        appointment[i] = user_appointments
+
+    # Now let's check that reversed
+    for i in range(100):
+        assert gatekeeper.get_expired_appointments(i + gatekeeper.expiry_delta) == appointment[i]