Se debe clonar el proyecto localmente con el comando:
git clone https://github.com/lalaro/LAB5AREP_CRUD.git
Y luego revisar las intrucciones a continuación para el manejo de soluciones del proyecto.
Se necesita de Maven (La versión más reciente), IntelliJ, Docker, Spring Boot Git bash y Java 21, la instalación debe realizarse desde las paginas oficiales de cada programa.
Para Maven debe irse a https://maven.apache.org/download.cgi, descargar la versión más nueva que allá de Maven (En este caso tenemos la versión 3.9.6) y agregarse en la carpeta de Program Files, luego se hace la respectiva configuración de variables de entorno según la ubicación que tenemos para el archivo de instalación, tanto de MAVEN_HOME y de Path. Luego revisamos que haya quedado bien configurado con el comando para Windows:
mvn - v
o
mvn -version
Para Java debe irse a https://www.oracle.com/java/technologies/downloads/?er=221886, descargar la versión 21 de Java y agregarse en la carpeta de Program Files, luego se hace la respectiva configuración de variables de entorno según la ubicación que tenemos para el archivo de instalación, tanto de JAVA_HOME y de Path. Luego revisamos que haya quedado bien configurado con el comando para Windows:
java -version
Si no tenemos la versión solicitada podemos hacer lo siguiente, para el caso de Windows:
Ir al Windows PowerShell y ejecutar como administrador los siguientes codigos:
[System.Environment]::SetEnvironmentVariable("JAVA_HOME", "C:\Program Files\Java\jdk-21", [System.EnvironmentVariableTarget]::Machine)
Revisar las rutas de la máquina
$env:JAVA_HOME = "C:\Program Files\Java\jdk-21"
$env:Path = "C:\Program Files\Java\jdk-21\bin;" + $env:Path
echo $env:JAVA_HOME
javac -version
java -version
Así se debe ver:
Un sistema CRUD funcional que permite a los usuarios administrar listados de propiedades implementados en AWS
Este proyecto implementa una aplicación CRUD (Crear, Leer, Actualizar, Borrar) para la gestión de propiedades, desplegada en la infraestructura de AWS. La base de datos, se instaló y configuró directamente en una instancia EC2 de AWS. La aplicación, desarrollada en Java con Spring Boot, se dockerizó para facilitar su despliegue y escalabilidad. La imagen Docker resultante se desplegó en otra instancia EC2, configurando los puertos y la conectividad necesarios para interactuar con la base de datos remota. La interfaz de usuario, construida con HTML, CSS y JavaScript, permite a los usuarios realizar operaciones CRUD a través de una API RESTful, comunicándose con el backend dockerizado.
Diseñé esta arquitectura para mi aplicación CRUD, asegurando la integración entre el frontend, el backend y la base de datos, utilizando AWS, Docker e instancias de EC2. El frontend, desarrollado con HTML, CSS y JavaScript, se ejecuta en un servidor local y envía solicitudes HTTP al backend, que implementé como una API REST contenedorizada con Docker y desplegada en AWS EC2 dentro del servicio DockerWebApp. Para la persistencia de datos, utilicé MySQL, también contenedorizado y alojado en otra instancia de EC2 bajo el servicio database-lalaro. La comunicación entre los componentes se realiza mediante solicitudes a la API (ec2-...compute-1.amazonaws.com:42000/api/properties), que responde con datos en JSON, permitiendo su visualización en la interfaz web. Esta infraestructura escalable y eficiente facilita el despliegue en la nube, asegurando una integración fluida y un mantenimiento optimizado.
Esta aplicación usa CorsConfig para permitir que el frontend acceda a la API. Sin esto, el navegador bloquearía las peticiones. Permite el acceso desde otros dominios.
El PropertyController recibe las peticiones HTTP de los clientes. Coordina las operaciones CRUD. Usa el servicio para procesar las peticiones y devuelve respuestas.
Esta aplicación usa Property para definir un inmueble. Dentro del CRUD, es el modelo de datos. Define qué información se guarda de cada inmueble.
El PropertyRepository conecta la app con la base de datos. Permite hacer operaciones CRUD en los inmuebles sin escribir SQL. Facilita guardar y obtener datos.
Esta aplicación usa PropertyService para la lógica de los inmuebles. Es la capa entre el controlador y el repositorio. Procesa datos y llama al repositorio para el CRUD.
El archivo index.html define la estructura de la interfaz de usuario, incluyendo formularios para agregar y actualizar propiedades, y áreas para mostrar la lista de propiedades. El archivo script.js contiene la lógica de JavaScript que interactúa con la API RESTful, enviando y recibiendo datos para realizar las operaciones CRUD y actualizando dinámicamente la interfaz de usuario. Finalmente, el archivo style.css proporciona estilos básicos para mejorar la presentación de la página web, asegurando que los elementos estén dispuestos de manera clara y legible para el usuario.
Configuración de la Base de datos que tenemos en AWS:
Este Dockerfile crea una imagen para ejecutar una aplicación Java, usando OpenJDK 21 como base. Copia las clases compiladas y las dependencias de la aplicación a un directorio dentro del contenedor, define el puerto de la aplicación como 6000, copia los archivos estáticos a una ruta dentro del contenedor y luego ejecuta la aplicación Java usando el classpath apropiado.
Este docker-compose.yml configura dos servicios: una aplicación web construida desde un Dockerfile local y una base de datos MongoDB. Define puertos y volúmenes para ambos contenedores, permitiendo que la aplicación web se comunique con la base de datos y que los datos de la base de datos persistan.
- Primero es necesario, crear una nueva instancia EC2 en AWS, para poder contener la BD.
-
Como segundo paso, es fundamental instalar la base de datos que se va a usar en nuestra instancia EC2.
Aclaración: Debido a problemas con la instalación de MySQL en la instancia, donde paquetes corruptos impedían la finalización, opté por MariaDB. Su compatibilidad casi total con MySQL simplifica la configuración y garantiza una funcionalidad similar.
- Luego, conectamos la bd a nuestro proyecto spring-boot y revisamos que funcione localmente.
Hay que tener en cuenta que DNS de IP4 pública, va cambiar cada que se inicialice la instancia:
- Verificamos en tiempo real que la BD se actualice cada vez que se cree, consulte, actualice o elimine algun dato.
- Como quinto paso dockerizamos el proyecto de Spring-boot del CRUD.
java -cp "target\classes;target\dependency\*" edu.escuelaing.app.DemoApplication
- Conectamos la imagen a la instancia EC2, que ya se había creado en el lab 4.
- Corremos nuestras dos instancias al tiempo database_lala y DockerWebApp.
- Verificamos que la bd traiga los datos correspondientes a nuestro despliegue de AWS.
Ejecución localmente:
Ejecución dockerizada:
Ejecución desplegada en AWS:
El video del despliegue funcionando: Video
Podemos Abrir en terminal el proyecto y ejecutar las pruebas desde el PowerShell, en el caso de Windows. Y ejecutamos el comando:
Cabe recalcalcar que se pueden generar Advertencias, porque ya no está conectada la base de datos.
mvn test
O de igual forma en el ID que deseemos.
Así se vera:
- testUpdateProperty_ReturnsUpdatedProperty
Qué prueba: Verifica que la actualización de una propiedad con ID 1 devuelva la propiedad actualizada con los nuevos datos. Por qué la prueba: Asegura que la API permite actualizar correctamente una propiedad existente y devuelve los valores modificados.
- testGetAllProperties
Qué prueba: Verifica que la API devuelve correctamente una lista con todas las propiedades almacenadas. Por qué la prueba: Asegura que el endpoint de consulta de propiedades funciona correctamente y devuelve el número esperado de elementos.
- testGetPropertyById_WhenFound
Qué prueba: Verifica que la API devuelva correctamente una propiedad cuando se consulta por su ID y que los valores sean los esperados. Por qué la prueba: Asegura que el servicio puede recuperar correctamente una propiedad específica a partir de su identificador único.
- testGetPropertyById_WhenNotExists
Qué prueba: Verifica que la API responde con un estado 404 Not Found cuando se consulta una propiedad inexistente por su ID. Por qué la prueba: Asegura que el sistema maneja correctamente los casos en los que se intenta acceder a un recurso que no existe.
- testCreateProperty
Qué prueba: Verifica que la API permite la creación de una nueva propiedad y devuelve la propiedad recién creada con los datos esperados. Por qué la prueba: Asegura que el endpoint de creación de propiedades funciona correctamente y que la API puede manejar solicitudes de inserción de nuevos registros.
- testUpdateProperty
Qué prueba: Verifica que la API actualiza una propiedad con ID 1 y devuelve los nuevos datos correctamente. Por qué la prueba: Asegura que la API maneja correctamente las solicitudes de actualización y devuelve la información modificada.
- testUpdateProperty_WhenNotExists
Qué prueba: Verifica que la API responde con un estado 404 Not Found cuando se intenta actualizar una propiedad que no existe. Por qué la prueba: Asegura que la API maneja correctamente las solicitudes de actualización sobre recursos inexistentes.
- testDeleteProperty
Qué prueba: Verifica que la API permite eliminar una propiedad con ID 1 y responde con el estado 204 No Content. Por qué la prueba: Asegura que la API maneja correctamente las solicitudes de eliminación y que el recurso desaparece del sistema después de la operación.
stas pruebas verifican que las operaciones de creación, lectura, actualización y eliminación (Create, Read, Update, Delete) se ejecuten correctamente, asegurando que la API maneje adecuadamente las solicitudes y respuestas. Se probaron casos exitosos, donde los datos se almacenan y recuperan correctamente, así como casos de error, como la consulta o modificación de propiedades inexistentes, garantizando una gestión robusta y fiable del sistema.
Podemos Abrir en terminal el proyecto y compilar y empaquetar el proyecto desde el PowerShell, en el caso de Windows. Y ejecutamos los comandos:
mvn clean install
mvn spring-boot:run
O de igual forma en el ID que deseemos.
Cabe recalcalcar que se pueden generar Advertencias, porque ya no está conectada la base de datos.
- Maven - Gestión de dependencias.
- Java - Versionamiento en Java.
- GitHub - Sistema de control de versiones distribuido.
- IntelliJ - Entorno de desarrollo integrado.
- AWS - Amazon Web Services / plataforma de servicios de nube.
- Docker - Tecnología en contenedores que permite crear y usar contenedores Linux.
- Spring Boot -Herramienta de código abierto para desarrollar aplicaciones web y microservicios en Java
Por favor, lee CONTRIBUTING.md para detalles sobre nuestro código de conducta y el proceso para enviarnos solicitudes de cambios (pull requests).
Usamos SemVer para el versionado.
- Laura Valentina Rodríguez Ortegón - Lab5 AREP - Repositorio
Este proyecto está licenciado bajo la Licencia MIT - consulta el archivo LICENSE.md para más detalles.
- Agradecimientos a la Escuela Colombiana de Ingeniería
- La documentación de Git Hub
- Al profesor Luis Daniel Benavides