En el presente repositorio se provee un ejemplo de cliente-servidor el cual corre en containers con la ayuda de docker-compose. El mismo es un ejemplo práctico brindado por la cátedra para que los alumnos tengan un esqueleto básico de cómo armar un proyecto de cero en donde todas las dependencias del mismo se encuentren encapsuladas en containers. El cliente (Golang) y el servidor (Python) fueron desarrollados en diferentes lenguajes simplemente para mostrar cómo dos lenguajes de programación pueden convivir en el mismo proyecto con la ayuda de containers.
Por otro lado, se presenta una guía de ejercicios que los alumnos deberán resolver teniendo en cuenta las consideraciones generales descriptas al pie de este archivo.
El repositorio cuenta con un Makefile que posee encapsulado diferentes comandos utilizados recurrentemente en el proyecto en forma de targets. Los targets se ejecutan mediante la invocación de:
- make <target>: Los target imprescindibles para iniciar y detener el sistema son docker-compose-up y docker-compose-down, siendo los restantes targets de utilidad para el proceso de debugging y troubleshooting.
Los targets disponibles son:
- docker-compose-up: Inicializa el ambiente de desarrollo (buildear docker images del servidor y cliente, inicializar la red a utilizar por docker, etc.) y arranca los containers de las aplicaciones que componen el proyecto.
- docker-compose-down: Realiza un
docker-compose stoppara detener los containers asociados al compose y luego realiza undocker-compose downpara destruir todos los recursos asociados al proyecto que fueron inicializados. Se recomienda ejecutar este comando al finalizar cada ejecución para evitar que el disco de la máquina host se llene. - docker-compose-logs: Permite ver los logs actuales del proyecto. Acompañar con
greppara lograr ver mensajes de una aplicación específica dentro del compose. - docker-image: Buildea las imágenes a ser utilizadas tanto en el servidor como en el cliente. Este target es utilizado por docker-compose-up, por lo cual se lo puede utilizar para testear nuevos cambios en las imágenes antes de arrancar el proyecto.
- build: Compila la aplicación cliente para ejecución en el host en lugar de en docker. La compilación de esta forma es mucho más rápida pero requiere tener el entorno de Golang instalado en la máquina host.
El servidor del presente ejemplo es un EchoServer: los mensajes recibidos por el cliente son devueltos inmediatamente. El servidor actual funciona de la siguiente forma:
- Servidor acepta una nueva conexión.
- Servidor recibe mensaje del cliente y procede a responder el mismo.
- Servidor desconecta al cliente.
- Servidor procede a recibir una conexión nuevamente.
El cliente del presente ejemplo se conecta reiteradas veces al servidor y envía mensajes de la siguiente forma.
- Cliente se conecta al servidor.
- Cliente genera mensaje incremental. recibe mensaje del cliente y procede a responder el mismo.
- Cliente envía mensaje al servidor y espera mensaje de respuesta. Servidor desconecta al cliente.
- Cliente verifica si aún debe enviar un mensaje y si es así, vuelve al paso 2.
Al ejecutar el comando make docker-compose-up para comenzar la ejecución del ejemplo y luego el comando make docker-compose-logs, se observan los siguientes logs:
client1 | 2024-08-21 22:11:15 INFO action: config | result: success | client_id: 1 | server_address: server:12345 | loop_amount: 5 | loop_period: 5s | log_level: DEBUG
client1 | 2024-08-21 22:11:15 INFO action: receive_message | result: success | client_id: 1 | msg: [CLIENT 1] Message N°1
server | 2024-08-21 22:11:14 DEBUG action: config | result: success | port: 12345 | listen_backlog: 5 | logging_level: DEBUG
server | 2024-08-21 22:11:14 INFO action: accept_connections | result: in_progress
server | 2024-08-21 22:11:15 INFO action: accept_connections | result: success | ip: 172.25.125.3
server | 2024-08-21 22:11:15 INFO action: receive_message | result: success | ip: 172.25.125.3 | msg: [CLIENT 1] Message N°1
server | 2024-08-21 22:11:15 INFO action: accept_connections | result: in_progress
server | 2024-08-21 22:11:20 INFO action: accept_connections | result: success | ip: 172.25.125.3
server | 2024-08-21 22:11:20 INFO action: receive_message | result: success | ip: 172.25.125.3 | msg: [CLIENT 1] Message N°2
server | 2024-08-21 22:11:20 INFO action: accept_connections | result: in_progress
client1 | 2024-08-21 22:11:20 INFO action: receive_message | result: success | client_id: 1 | msg: [CLIENT 1] Message N°2
server | 2024-08-21 22:11:25 INFO action: accept_connections | result: success | ip: 172.25.125.3
server | 2024-08-21 22:11:25 INFO action: receive_message | result: success | ip: 172.25.125.3 | msg: [CLIENT 1] Message N°3
client1 | 2024-08-21 22:11:25 INFO action: receive_message | result: success | client_id: 1 | msg: [CLIENT 1] Message N°3
server | 2024-08-21 22:11:25 INFO action: accept_connections | result: in_progress
server | 2024-08-21 22:11:30 INFO action: accept_connections | result: success | ip: 172.25.125.3
server | 2024-08-21 22:11:30 INFO action: receive_message | result: success | ip: 172.25.125.3 | msg: [CLIENT 1] Message N°4
server | 2024-08-21 22:11:30 INFO action: accept_connections | result: in_progress
client1 | 2024-08-21 22:11:30 INFO action: receive_message | result: success | client_id: 1 | msg: [CLIENT 1] Message N°4
server | 2024-08-21 22:11:35 INFO action: accept_connections | result: success | ip: 172.25.125.3
server | 2024-08-21 22:11:35 INFO action: receive_message | result: success | ip: 172.25.125.3 | msg: [CLIENT 1] Message N°5
client1 | 2024-08-21 22:11:35 INFO action: receive_message | result: success | client_id: 1 | msg: [CLIENT 1] Message N°5
server | 2024-08-21 22:11:35 INFO action: accept_connections | result: in_progress
client1 | 2024-08-21 22:11:40 INFO action: loop_finished | result: success | client_id: 1
client1 exited with code 0
En esta primera parte del trabajo práctico se plantean una serie de ejercicios que sirven para introducir las herramientas básicas de Docker que se utilizarán a lo largo de la materia. El entendimiento de las mismas será crucial para el desarrollo de los próximos TPs.
Además, definir un script de bash generar-compose.sh que permita crear una definición de DockerCompose con una cantidad configurable de clientes. El nombre de los containers deberá seguir el formato propuesto: client1, client2, client3, etc.
El script deberá ubicarse en la raíz del proyecto y recibirá por parámetro el nombre del archivo de salida y la cantidad de clientes esperados:
./generar-compose.sh docker-compose-dev.yaml 5
Considerar que en el contenido del script pueden invocar un subscript de Go o Python:
#!/bin/bash
echo "Nombre del archivo de salida: $1"
echo "Cantidad de clientes: $2"
python3 mi-generador.py $1 $2
Modificar el cliente y el servidor para lograr que realizar cambios en el archivo de configuración no requiera un nuevo build de las imágenes de Docker para que los mismos sean efectivos. La configuración a través del archivo correspondiente (config.ini y config.yaml, dependiendo de la aplicación) debe ser inyectada en el container y persistida afuera de la imagen (hint: docker volumes).
Crear un script de bash validar-echo-server.sh que permita verificar el correcto funcionamiento del servidor utilizando el comando netcat para interactuar con el mismo. Dado que el servidor es un EchoServer, se debe enviar un mensaje al servidor y esperar recibir el mismo mensaje enviado.
En caso de que la validación sea exitosa imprimir: action: test_echo_server | result: success, de lo contrario imprimir:action: test_echo_server | result: fail.
El script deberá ubicarse en la raíz del proyecto. Netcat no debe ser instalado en la máquina host y no se puede exponer puertos del servidor para realizar la comunicación (hint: docker network). `
Modificar servidor y cliente para que ambos sistemas terminen de forma graceful al recibir la signal SIGTERM. Terminar la aplicación de forma graceful implica que todos los file descriptors (entre los que se encuentran archivos, sockets, threads y procesos) deben cerrarse correctamente antes que el thread de la aplicación principal muera. Loguear mensajes en el cierre de cada recurso (hint: Verificar que hace el flag -t utilizado en el comando docker compose down).
Las secciones de repaso del trabajo práctico plantean un caso de uso denominado Lotería Nacional. Para la resolución de las mismas deberá utilizarse como base al código fuente provisto en la primera parte, con las modificaciones agregadas en el ejercicio 4.
Modificar la lógica de negocio tanto de los clientes como del servidor para nuestro nuevo caso de uso.
Emulará a una agencia de quiniela que participa del proyecto. Existen 5 agencias. Deberán recibir como variables de entorno los campos que representan la apuesta de una persona: nombre, apellido, DNI, nacimiento, numero apostado (en adelante 'número'). Ej.: NOMBRE=Santiago Lionel, APELLIDO=Lorca, DOCUMENTO=30904465, NACIMIENTO=1999-03-17 y NUMERO=7574 respectivamente.
Los campos deben enviarse al servidor para dejar registro de la apuesta. Al recibir la confirmación del servidor se debe imprimir por log: action: apuesta_enviada | result: success | dni: ${DNI} | numero: ${NUMERO}.
Emulará a la central de Lotería Nacional. Deberá recibir los campos de la cada apuesta desde los clientes y almacenar la información mediante la función store_bet(...) para control futuro de ganadores. La función store_bet(...) es provista por la cátedra y no podrá ser modificada por el alumno.
Al persistir se debe imprimir por log: action: apuesta_almacenada | result: success | dni: ${DNI} | numero: ${NUMERO}.
Se deberá implementar un módulo de comunicación entre el cliente y el servidor donde se maneje el envío y la recepción de los paquetes, el cual se espera que contemple:
- Definición de un protocolo para el envío de los mensajes.
- Serialización de los datos.
- Correcta separación de responsabilidades entre modelo de dominio y capa de comunicación.
- Correcto empleo de sockets, incluyendo manejo de errores y evitando los fenómenos conocidos como short read y short write.
Modificar los clientes para que envíen varias apuestas a la vez (modalidad conocida como procesamiento por chunks o batchs). La información de cada agencia será simulada por la ingesta de su archivo numerado correspondiente, provisto por la cátedra dentro de .data/datasets.zip.
Los batchs permiten que el cliente registre varias apuestas en una misma consulta, acortando tiempos de transmisión y procesamiento.
En el servidor, si todas las apuestas del batch fueron procesadas correctamente, imprimir por log: action: apuesta_recibida | result: success | cantidad: ${CANTIDAD_DE_APUESTAS}. En caso de detectar un error con alguna de las apuestas, debe responder con un código de error a elección e imprimir: action: apuesta_recibida | result: fail | cantidad: ${CANTIDAD_DE_APUESTAS}.
La cantidad máxima de apuestas dentro de cada batch debe ser configurable desde config.yaml. Respetar la clave batch: maxAmount, pero modificar el valor por defecto de modo tal que los paquetes no excedan los 8kB.
El servidor, por otro lado, deberá responder con éxito solamente si todas las apuestas del batch fueron procesadas correctamente.
Modificar los clientes para que notifiquen al servidor al finalizar con el envío de todas las apuestas y así proceder con el sorteo.
Inmediatamente después de la notificacion, los clientes consultarán la lista de ganadores del sorteo correspondientes a su agencia.
Una vez el cliente obtenga los resultados, deberá imprimir por log: action: consulta_ganadores | result: success | cant_ganadores: ${CANT}.
El servidor deberá esperar la notificación de las 5 agencias para considerar que se realizó el sorteo e imprimir por log: action: sorteo | result: success.
Luego de este evento, podrá verificar cada apuesta con las funciones load_bets(...) y has_won(...) y retornar los DNI de los ganadores de la agencia en cuestión. Antes del sorteo, no podrá responder consultas por la lista de ganadores.
Las funciones load_bets(...) y has_won(...) son provistas por la cátedra y no podrán ser modificadas por el alumno.
Modificar el servidor para que permita aceptar conexiones y procesar mensajes en paralelo. En este ejercicio es importante considerar los mecanismos de sincronización a utilizar para el correcto funcionamiento de la persistencia.
En caso de que el alumno implemente el servidor Python utilizando multithreading, deberán tenerse en cuenta las limitaciones propias del lenguaje.
Se espera que los alumnos realicen un fork del presente repositorio para el desarrollo de los ejercicios.El fork deberá contar con una sección de README que indique como ejecutar cada ejercicio.
La Parte 2 requiere una sección donde se explique el protocolo de comunicación implementado. La Parte 3 requiere una sección que expliquen los mecanismos de sincronización utilizados.
Cada ejercicio deberá resolverse en una rama independiente con nombres siguiendo el formato ej${Nro de ejercicio}. Se permite agregar commits en cualquier órden, así como crear una rama a partir de otra, pero al momento de la entrega deben existir 8 ramas llamadas: ej1, ej2, ..., ej7, ej8.
(hint: verificar listado de ramas y últimos commits con git ls-remote)
Puden obtener un listado del último commit de cada rama ejecutando git ls-remote.
Finalmente, se pide a los alumnos leer atentamente y tener en cuenta los criterios de corrección provistos en el campus.