Template for the SSDD laboratory 2024-2025
To locally install the package, just run
pip install .
Or, if you want to modify it during your development,
pip install -e .
To run the template server, just install the package and run
remotetypes --Ice.Config=config/remotetypes.config
This template only allows to configure the server endpoint. To do so, you need to modify
the file config/remotetypes.config and change the existing line.
For example, if you want to make your server to listen always in the same TCP port, your file should look like
remotetypes.Endpoints=tcp -p 10000
If you want to run the tests and/or linters, you need to install the dependencies for them:
- To install test dependencies:
pip install .[tests] - To install linters dependencies:
pip install .[linters]
All the tests runners and linters are configured in the pyproject.toml.
This repository is already configured to run the following workflows:
- Ruff: checks the format, code style and docs style of the source code.
- Pylint: same as Ruff, but it evaluates the code. If the code is rated under a given threshold, it fails.
- MyPy: checks the types definitions and the usages, showing possible errors.
- Unit tests: uses
pytestto run unit tests. The code coverage is quite low. Fixing the tests, checking the test coverage and improving it will make a difference.
If you create your repository from this template, you will get all those CI for free.
The Slice file is provided inside the remotetypes directory. It is only loaded once when the remotetypes
package is loaded by Python. It makes your life much easier, as you don't need to load the Slice in every module
or submodule that you define.
The code loading the Slice is inside the __init__.py file.
Para lanzar y utilizar el proyecto se recomienda utilizar un entorno virtual usando el comando "python3 -m venv venv" para crearlo y usando el comando "source venv/bin/activate" para activarlo. El proyecto cuenta con un conjuto de documentos .py que son utilizados para el funcionamiento del servidor y un documento cliente.py que prueba el funcionamiento del mismo haciendo peticiendo de creación de los distintos tipos remotos y recorriendolos con los distintos iteradores implementados. El servidor al lanzarse y aceptar peticiones de creación de distintas distintas instancias de objetos crea archivos .json que se encuentran en la carpeta almacen si esta carpeta no existe el propio servidor la crea para almacenar los .json que se creen durante la ejecución. Para crear las instancias se les asigna una id, elegida por el cliente. Pueden existir una instancia de cada tipo remoto, pues al crear la instancia se concatena al nombre del objeto json una etiqueta _dict, _set y _list para diferenciar los tipos. Si un .json con uan combinación de tipo e id ya existía previamente en el servidor esté cargará la información del objeto creado previamente, en el caso de que el archivo este corrupto o no tenga el formato adecuado el servidor lo sobreescribirá para evitar errores de lectura y escritura
Al igual que con el anterior entregable se hará uso de entorno virtual. Este entregable cuenta con tres documentos docker-compose.yml que almacena la configuración de nuestro servidor docker que utilizaremos cuando lancemos el comando "docker-compose up -d" Un documento producer.py que será el encargado de lanzar los mensajes al servidor Y un documento clienteKafka.py que gestionará las respuestas que da el servidor a los mensajes enviados por el productor y las almacenará en un nuevo topic llamado responses La configuración del cliente se encuentra en el documento config.txt en caso de que este no se encuentre el cliente creaŕa uno con valores predeterminados Para lanzar nuestro cliente ejecutaremos el comando python3 clientekafka.py y para ejecutar nuestro productor ejecutaremos el comando python3 productor.py con los argumentos que queramos introducir al mensaje Las opciones son el servidor al que vamos a enviar el mensaje, el topic al que lo vammos a enviar, el id de la operación, el identificador del objeto igual que en la practica uno, el tipo de objeto sobre el que vamos a operar, la operación que queremos realizar y los argumentos entre '{}' separdos por , indicando primero el atributo y luego el valor separados por : ambos entre "". Ejemplo: " python3 producer.py localhost:9092 main_topic 2 test2 RDict getItem '{"key": "key1"}' "