Upgrade the /evocar_magx to use the created schedule. and added tests

Author: cmdelatorre

README.md

@@ -30,6 +30,8 @@ pip install -e .
 
 y estas listo para trabajar.
 
+`pip install freezegun` para correr los tests.
+
 ### Python 3.12
 
 `pip install setuptools`
@@ -62,9 +64,8 @@ En este momento ya se puede hablar con el bot. ¿Qué le digo?
 
 * `/su <password>` para reclamar permisos de admin, reemplazando `<password>` por la contraseña que hayamos
 elegido en la envvar `PYCAMP_BOT_MASTER_KEY`
-* `/agregar_pycamp <pycamp_name>` para crear un pycamp en la deb
+* `/empezar_pycamp <pycamp_name>` inicia el flujo de creación de un pycamp. Lo carga en la db, pide fecha de inicio y duración. Lo deja activo.
 * `/activar_pycamp <pycamp_name>` activa un pycamp
-* `/empezar_pycamp` setea la fecha de inicio del pycamp activo
 * `/empezar_carga_proyectos` habilita la carga de los proyectos. En este punto los pycampistas pueden cargar sus proyectos,
 enviandole al bot el comando `/cargar_proyecto`
 * `/terminar_carga_proyectos` termina carga proyectos
@@ -76,8 +77,20 @@ Para generar el schedule:
 * `/cronogramear` te va a preguntar cuantos dias queres cronogramear y cuantos slots por dia tenes y hacer el cronograma.
 * `/cambiar_slot` toma un nombre de proyecto y un slot; y te cambia ese proyecto a ese slot.
 
+Para agendar los magos:
+
+1. Todos los candidatos tienen que haberse registrado con `/ser_magx`
+2. Tiene que estar creado el schedule de presentaciones de proyectos (`/cronogramear`)
+
+* `/agendar_magos` Asigna un mago por hora durante todo el PyCamp.
+    * De 9 a 13 y de 14 a 19.
+    * El primer día arranca después del almuerzo (14hs).
+    * El último día termina al almuerzo (13hs).
+
 ### Flujo pycampista
 
 * `/cargar_proyecto` carga un proyecto (si está habilitada la carga)
 * `/votar` envia opciones para votar (si está habilitada la votacion)
 * `/ver_cronograma` te muestra el cronograma!
+* `/ser_magx` te registra como mago.
+* `/evocar_magx` llama al mago de turno para pedirle ayuda.

src/pycamp_bot/commands/manage_pycamp.py

@@ -169,10 +169,6 @@ async def cancel(update, context):
 )
 
 
-
-
-
-
 @active_needed
 @admin_needed
 async def end_pycamp(update, context):
@@ -183,6 +179,7 @@ async def end_pycamp(update, context):
         date = datetime.datetime.now()
 
     is_active, pycamp = get_active_pycamp()
+    pycamp.active = False
     pycamp.end = date
     pycamp.save()
 

src/pycamp_bot/commands/wizard.py

@@ -109,20 +109,31 @@ async def become_wizard(update, context):
 
     await context.bot.send_message(
         chat_id=update.message.chat_id,
-        text="Felicidades! Eres el Magx de turno"
+        text="¡Felicidades! Has sido registrado como magx."
     )
 
 
 async def summon_wizard(update, context):
-    username = update.message.from_user.username
-    wizard_list = list(Pycampista.select().where(Pycampista.wizard==True))
-    if len(wizard_list) == 0:
+    _, pycamp = get_active_pycamp()
+    wizard = pycamp.get_current_wizard()
+    if wizard is None:
         await context.bot.send_message(
             chat_id=update.message.chat_id,
-            text="No hay ningunx magx todavia"
+            text="No hay ningunx magx agendado a esta hora :-("
+        )
+        return
+
+    username = update.message.from_user.username
+    if username == wizard.username:
+        await context.bot.send_message(
+            chat_id=wizard.chat_id,
+            text="🧙"
+        )
+        await context.bot.send_message(
+            chat_id=wizard.chat_id,
+            text="Checkeá tu cabeza: si no ténes el sombrero de magx ¡deberías!\n(soltá la compu)"
         )
     else:
-        wizard = random.choice(wizard_list)
         await context.bot.send_message(
             chat_id=wizard.chat_id,
             text="PING PING PING MAGX! @{} te necesesita!".format(username)
@@ -133,23 +144,30 @@ async def summon_wizard(update, context):
         )
 
 
-@admin_needed
-async def schedule_wizards(update, context):
-    _, pycamp = get_active_pycamp()
-    logger.info(pycamp)
-
+def persist_wizards_schedule_in_db(pycamp):
+    """
+    Aux function to generate the wizards schedule and persist WizardAtPycamp instances in the DB.
+    
+    """
     schedule = define_wizards_schedule(pycamp)
 
     for slot, wizard in schedule.items():
         start, end = slot
         WizardAtPycamp.create(
             pycamp=pycamp,
             wizard=wizard,
-            slot_ini=start,
-            slot_end=end
+            init=start,
+            end=end
         )
         logger.debug("From {} to {} the wizard is {}".format(start, end, wizard.username))
 
+
+@admin_needed
+async def schedule_wizards(update, context):
+    _, pycamp = get_active_pycamp()
+
+    persist_wizards_schedule_in_db(pycamp)
+
     # Mandar mensajes a los magos con su agenda propia
     msg = "Lista la agenda de magos."
     await context.bot.send_message(

src/pycamp_bot/models.py

@@ -1,6 +1,8 @@
-from datetime import datetime, timedelta
 import peewee as pw
 
+from datetime import datetime, timedelta
+from random import choice
+
 
 DEFAULT_SLOT_PERIOD = 60  # Minutos
 
@@ -87,6 +89,22 @@ def set_as_only_active(self):
     def get_wizards(self):
         return Pycampista.select().where(Pycampista.wizard == 1)
 
+    def get_current_wizard(self):
+        """Return the Pycampista instance that's the currently scheduled wizard."""
+        now = datetime.now()
+        current_wizards = WizardAtPycamp.select().where(  
+            (WizardAtPycamp.pycamp == self) & 
+            (WizardAtPycamp.init <= now) &
+            (WizardAtPycamp.end > now) 
+        )
+
+        wizard = None  # Default if n_wiz == 0
+        if current_wizards.count() >= 1:
+            # Ready for an improbable future where we'll have many concurrent wizards ;-)
+            wizard = choice(current_wizards).wizard
+        
+        return wizard
+
 
 class PycampistaAtPycamp(BaseModel):
     '''
@@ -104,8 +122,8 @@ class WizardAtPycamp(BaseModel):
     '''
     pycamp = pw.ForeignKeyField(Pycamp)
     wizard = pw.ForeignKeyField(Pycampista)
-    slot_ini = pw.DateTimeField()
-    slot_end = pw.DateTimeField()
+    init = pw.DateTimeField()
+    end = pw.DateTimeField()
 
 
 class Slot(BaseModel):

test/conftest.py

@@ -3,7 +3,7 @@
 from peewee import SqliteDatabase
 from telegram import Bot
 
-from pycamp_bot.models import Pycampista, Slot, Pycamp
+from pycamp_bot.models import Pycampista, Slot, Pycamp, WizardAtPycamp
 
 
 
@@ -13,7 +13,7 @@
 # use an in-memory SQLite for tests.
 test_db = SqliteDatabase(':memory:')
 
-MODELS = [Pycampista, Slot, Pycamp]
+MODELS = [Pycampista, Slot, Pycamp, WizardAtPycamp]
 
 
 # Bind the given models to the db for the duration of wrapped block.

test/test_pycamp_model.py

@@ -0,0 +1,76 @@
+from datetime import datetime
+from freezegun import freeze_time
+from pycamp_bot.models import Pycamp, Pycampista, WizardAtPycamp
+from pycamp_bot.commands import wizard
+from test.conftest import use_test_database, test_db, MODELS
+
+
+# ---------------------------
+# Module Level Setup/TearDown
+# ---------------------------
+def setup_module(module):
+    test_db.bind(MODELS, bind_refs=False, bind_backrefs=False)
+    test_db.connect()
+
+def teardown_module(module):
+    # Not strictly necessary since SQLite in-memory databases only live
+    # for the duration of the connection, and in the next step we close
+    # the connection...but a good practice all the same.
+    test_db.drop_tables(MODELS)
+
+    # Close connection to db.
+    test_db.close()
+    # If we wanted, we could re-bind the models to their original
+    # database here. But for tests this is probably not necessary.
+
+
+class TestPycampGetCurrentWizard:
+
+    def init_pycamp(self):
+        self.pycamp = Pycamp.create(
+            headquarters="Narnia",
+            init=datetime(2024, 6, 20),
+            end=datetime(2024, 6, 24),
+        )
+
+    @use_test_database
+    @freeze_time("2024-06-21 11:30:00")
+    def test_returns_correct_wizard_within_its_turno(self):
+        """Integration test using persist_wizards_schedule_in_db."""
+        p = Pycamp.create(
+            headquarters="Narnia",
+            init=datetime(2024,6,20),
+            end=datetime(2024,6,23),
+        )
+        pycamper = Pycampista.create(username="pepe", wizard=True)
+        wizard.persist_wizards_schedule_in_db(p)
+
+        assert p.get_current_wizard() == pycamper
+            
+    @use_test_database
+    def test_no_scheduled_wizard_then_return_none(self):
+        p = Pycamp.create(
+            headquarters="Narnia"
+        )
+        # Wizard exists, but no time scheduled.
+        pycamper = Pycampista.create(username="pepe", wizard=True)
+        assert WizardAtPycamp.select().count() == 0
+
+        assert p.get_current_wizard() is None
+
+    @use_test_database
+    @freeze_time("2024-06-20 10:30:00")
+    def test_many_scheduled_wizard_then_return_one_of_them(self):
+        p = Pycamp.create(
+            headquarters="Narnia"
+        )
+        # Wizard exists, scheduled in the same time slot.
+        gandalf = Pycampista.create(username="gandalf", wizard=True)
+        merlin = Pycampista.create(username="merlin", wizard=True)
+        ini = datetime(2024,6,20,10,0,0)
+        end = datetime(2024,6,20,11,0,0)
+        WizardAtPycamp.create(pycamp=p, wizard=gandalf, init=ini, end=end)
+        WizardAtPycamp.create(pycamp=p, wizard=merlin, init=ini, end=end)
+
+        w = p.get_current_wizard()
+        assert w == gandalf or w == merlin