El famoso negocio de Ollivander ha crecido.
Como la demanda de productos mágicos no para de crecer, la expansión del negocio es inevitable para sobrevivir a Amazon.
Ollivander había contratado a Dobbie -a través del programa de FP Dual DAW de Hogwarts colegio concertado- para que le hiciese una app que gestionase el inventario, pero tras los tristes aoontecimientos en los que se vió -desgraciadamente- envuelto el pobrecico elfo, no tiene a nadie que pueda modificar el código para incluir nuevos productos.
Ollivander ha contratado los servicios de la consultora en la que trabajas para que adecúe la aplicación a las nuevas necesidades del inventario, por lo que te envían "a cliente" -a la tienda- a lidiar con él y, lo que es peor, con el código spagheti que manufacturó Dobby en sus momentos de langidez infinita.
Por si no fuera suficiente, tu compañero de empresa al que enviaron a cliente antes que a ti, a acaba de irse de España porque en el extranjero le pagan por trabajar, y ha dejado tiritando el código de los casos test que intentó añadir en un día de desesperación absoluta.
-
Refactoriza el código de la lógica para que sea fácil de entender, barato de modificar y no cambie el comportamiento observable del código existente.
-
El código existente pasa los casos test. Asegúrate de que el tuyo también, sin modificarlos.
-
Haz un evolutivo del sistema para que sea posible añadir al inventario un nuevo tipo de item llamado "Conjured". Los “Conjured” items degradan su calidad el doble de rápido que un item normal. Añade esta lógica al sistema así como los casos test que necesites.
WARNING No alteres la clase Item o las propiedades de Items porque el colegio profesional de goblings no cree en la propiedad compartida del código y suele enviar inquisidores por la tienda de vez en cuando para chequear no dos sino tres, digo tres cosas sino cuatro, no cuatro sino cinco cosas, oh f*ck! que han de respetar su certificación de gobbling inside.
-
Crea una base de datos SQL que permita realizar CRUD sobre el inventario.
-
El inventario inicial es el que especifica el primer caso test, el existente en el "día 0". Recuerda realizar un esquema que permita ampliarlo con el nuevo tipo de ítem "Conjured":
name, sellIn, quality
+5 Dexterity Vest, 10, 20
Aged Brie, 2, 0
Elixir of the Mongoose, 5, 7
Sulfuras, Hand of Ragnaros, 0, 80
Sulfuras, Hand of Ragnaros, -1, 80
Backstage passes to a TAFKAL80ETC concert, 15, 20
Backstage passes to a TAFKAL80ETC concert, 10, 49
Backstage passes to a TAFKAL80ETC concert, 5, 49
Conjured Mana Cake, 3, 6
Como quieres modernizar un poco el sistema de gestión de la tienda de Ollivander, decides desarrollar una app web que permita visualizar el estado del inventario, actualizar la calidad de los items y realizar operaciones básicas CRUD.
Esto supone tres capas en tu aplicación.
-
Capa de presentación y frontend.
- Utilizando HTML, CSS y JS construye un pequeño sitio web para la intranet, con una interfaz de usuario/a que permita a Ollivander realizar las operaciones de la lógica.
-
Capa de lógica y backend
- En el back encapsularás la lógica del negocio que has programado. Utilizarás un microframework llamado Flask para:
- Atender y responder las peticiones que lleguen a través de un navegador web con las consulas de a la base de datos.
- Construir una API REST que con al menos dos end points: un recurso devuelve el inventario y el otro la actualización del inventario. Si implementas el resto de operaciones CRUD, tendrás que añadir los end points correspondientes.
- En el back encapsularás la lógica del negocio que has programado. Utilizarás un microframework llamado Flask para:
-
Acceso a datos (backend)
- Mediante Flask, escribe el código necesario de la capa de acceso a datos, que conecte las peticiones web con la base de datos, para realizar las operaciones de la lógica. Recuerda que la lógica de la aplicación ha de ser agnóstica respecto a la base de datos utilizada.
-
Base de datos: reutiliza tus conocimientos de Mongo Atlas del primer trimestre, o aprovecha para implementar una base de datos relacional con MySQL.
-
Pensando en introducir un flujo de trabajo de Integración Continua y Entrega Continua (CI /CD) prepararás un contenedor Docker de desarrollo y pruebas y otro contenedor docker para despliegue. De momento, con Python es suficiente tox.
Para poder ejecutar la aplicación correctamente, es necesario tener instalado las siguientes herramientas/aplicaciones:
Necesitaremos tener Docker instalado y en funcionamiento, dado que será donde tengamos nuestro contenedor ejecutando la aplicación.
Para este proyecto utilizó la base de datos de MySQL, por lo tanto, para poder usar la base de datos es necesario tener instalado y configurado MySQL.
También para poder visualizar mejor el proyecto utilizo HeidiSQL y Xampp dado que me permiten interactuar mejor con la base de datos.
Una vez tengas instalado y configurado todos los requisitos, tendremos que seguir estos pasos para poder hacer uso de nuestra aplicación:
Primero de todo tenemos que tener nuestro entorno preparado con sus respectivas carpetas y archivos, para ello tendremos que hacer lo siguiente:
- Crear un directorio/carpeta
mkdir .\ollivanders_shop
cd ollivanders_shop
- Clonar repositorio
git clone https://github.com/Adrianlm17/ollivanders-Flask.git
- Entorno virtual
python -m venv venv
- Activar entorno
.\venv\Scripts\activate
- Instalar Requirements.txt
pip install -r requirements.txt
-
Una vez tenemos el entorno preparado vamos a preparar nuestra base de datos, para ello haremos uso de MySQL (o HeidiSQL), nos tendremos que registrar y acceder a una consulta.
-
Una vez tenemos la consulta preparada, ejecutaremos el script que se proporciona "ollivanders-database.sql" y lo ejecutaremos.
Por ultimo pero no menos importante, es necesario tener un contenedor donde se ecjutara nuestra aplicación, en este repositorio se proporciona un archivo llamado "Dockerfile" que nos permitira crear una imagen de Docker y posteriormente crear el contenedor necesario.
- Imagen Docker
docker build -t ollivanders-shop .
- Contenedor Docker
docker run --name=ollivanders_shop -p 5000:5000 -d ollivanders-shop:latest
Para poder hacer uso de nuestra aplicación, tendremos que seguir los siguientes pasos:
- Asegurate de estar en lar tura adecuada:
.\ollivanders-Flask>
- Ejecuta el comando de arrancado:
flask --debug run
- Si nos dirigimos a la ruta que nos indica en consola (http://127.0.0.1:5000), nos mostrara nuestra aplicación creada!
Pytest es una biblioteca de pruebas de Python que se utiliza para escribir y ejecutar pruebas unitarias y de integración de forma eficiente. Para poder hacer uso de dicha biblioteca, ejecuta el siguiente comando:
pytest
Coverage es una herramienta para medir la cobertura de código de los programas Python. Monitoriza tu programa, anotando qué partes del código han sido ejecutadas, y luego analiza el código fuente para identificar el código que podría haber sido ejecutado pero no lo fue. La medición de la cobertura se utiliza normalmente para medir la eficacia de las pruebas.
Para poder ejecutar Coverage, escribe los siguientes comandos:
coverage run --source ./ -m pytest
coverage report
Black es una herramienta de formateo de código en Python sin concesiones. Al usarlo, aceptas ceder el control sobre las minucias del formateo manual. A cambio, Black te da velocidad, determinismo y libertad de pycodestyle fastidiándote con el formateo. Ahorrará tiempo y energía mental para asuntos más importantes.
Para poder hacer uso de dicha herramienta, ejecuta el siguiente comando:
black .
Bandit es una herramienta de análisis de seguridad para Python que se utiliza para identificar posibles vulnerabilidades en el código fuente. Bandit realiza un análisis estático del código Python para buscar vulnerabilidades conocidas, como la inyección de SQL, la ejecución de comandos en el sistema, el uso de funciones peligrosas de pickle, entre otras.
Para poder visualizar el resultado de Bandit, ejecuta el siguiente comando en terminal:
bandit app.py
