Software Architecture y Behavioral Tests

Objetivo

El objetivo de este ejercicio es practicar el uso de arquitectura hexagonal.

Desarrollo

En esta práctica trabajarás con una base de código construida con Java 11, Spring Boot 2.9 y Docker/Docker Compose.

Para empezar la infraestructura ejecuta el siguiente comando:

docker compose up -d

Esto crea la base de datos de SQLServer que vamos a utilizar para poder realizar las operaciones. Hay que asegurar que el schema my_business_federation y my_business_federation_test existen, para ello dentro del contenedor hay que ejecutar el siguiente comando:

$ docker exec sqlserver_my_federation /opt/mssql-tools/bin/sqlcmd -S localhost -U sa -P PasswordO1. -d master -i create-database.sql

Para ejecutar las pruebas necesitas ejecutar el siguiente comando:

$ ./mvnw test

Para ejecutar las pruebas contenidas en una única clase de pruebas, utiliza un comando como el siguiente:

$ ./mvnw -Dtest=MyClassTest test

Para iniciar la aplicación utiliza el comando

$  ./mvnw spring-boot:run

Para correr las migraciones de flyway puedes ejecutar

$  ./mvnw flyway:migrate -Dflyway.configFiles=src/main/resources/flyway.conf

Configuración de los git hooks para formatear el código

Antes de empezar a realizar commits que contenga tu solución tienes que configurar un módulo de git que te ayudará a formatear tu código.

./mvnw git-code-format:install-hooks

Forma de trabajo

Recomendamos ampliamente utilizar el editor IntelliJ para realizar el desarrollo de la práctica. También agrega el plugin de IntelliJ SonarLint.

Entrega

Deja todo el código con tu solución en la rama main, pues por omisión es esta rama la que compara Github Classroom contra la versión inicial del código mediante el Pull Request llamado Feedback, el cual nosotros vamos a revisar para evaluar tu entrega.

Para verificar que tu código cumple con la especificación, en tu Pull Request debes de pasar las dos validaciones que hace Github Actions sobre el código, una de ellas verifica que pasas las pruebas automatizadas, y la otra que hayas formateado tu código con el plugin de maven.

Además, no olvides enviar el enlace hacia el Pull Request que contiene tu solución por medio del formulario.

Actividades

Federación de Usuario

Descripción

Vamos a trabajar con un pequeño proyecto de spring boot que administra la federación de usuario de un negocio. Cada usuario tiene al menos 3 datos asociados "username", "password" e "email". Además, opcionalmente le podemos asignar roles.

Requerimientos

La idea es reorganizar el código de este proyecto de tal manera que represente una arquitectura hexagonal o de N-capas válida, que siga los principios SOLID de diseño orientado a objetos y que contenga al menos una de pruebas de integración escrita con cucumber.

No es necesario que hagas refactor de todo el código, con que refactorices el código de /api/auth/signup o de /api/auth/signin es suficiente.

Es suficiente con que escribas un integration test con cucumber para /api/auth/signin. Ya proveemos dos ejemplos de integration tests para /api/auth/signup, uno escrito solo con código de java y el otro con Lenguaje de Gherkin que ejecutar cucumber, ambos integration tests son equivalentes.