diff --git a/README.md b/README.md index ccc33de..053e0c3 100644 --- a/README.md +++ b/README.md @@ -2,75 +2,60 @@ # Desafio Java Concrete -Desafio técnico para evaluar el conocimiento de los aspirantes a unirse al equipo de **Backend**. - -## Contenido -- [El Desafio](#el-desafio) - - [Escenario](#escenario) - - [APIs](#apis) - - [Features](#features) - - [Puntos a Considerar](#puntos-a-considerar) -- [¿Qué nos Gustaría Ver?](#qué-nos-gustaría-ver) - - [Deseables](#deseables) - - [Stack/Pool de Tecnologías](#stackpool-de-tecnologías) -- [Forma de Entrega](#forma-de-entrega) -- [Importante](#importante) - -## El Desafio - -### Escenario -Recientemente te has unido a un equipo que esta desarrollando una aplicación mobile para una gran compañía de e-commerce. -Esta aplicación esta dirigida a dispositivos de **bajo rendimiento** hasta dispositivos con **gran poder de procesamiento**. -El cliente ya cuenta con un backend establecido que contiene todas las reglas e información de negocio, pero algunos sistemas dependen de **tecnologías legadas** que pueden ser **inestables**. -**Tu** eres responsable de construir la **API** que integrará con estos servicios y proveerá todas las informaciones que Mobile necesita. -Para las próximas iteraciones, el equipo va a trabajar en la **Pantalla de Início** y tu debes construir todo(s) los **endpoint(s)** que se requieran para integrar con los servicios y proveer la información para la pantalla. +## Categories & Coupons API -### APIs -Necesitarás consumir los siguientes servicios: -- **Categorias**: [https://cs-hsa-api-categories-rest.herokuapp.com/docs](https://cs-hsa-api-categories-rest.herokuapp.com/docs) -- **Cupones**: [https://cs-hsa-api-coupons-rest.herokuapp.com/docs](https://cs-hsa-api-coupons-rest.herokuapp.com/docs) +Este proyecto es una API de Spring Boot para manejar categorías y cupones. Utiliza Spring Boot 3 con Gradle, integración con clientes Feign para servicios externos, manejo de errores con Spring Retry, y documentación de API con Swagger. -### Features -El equipo Mobile necesita construir una pantalla de inicio que debe mostrar: - -- Carrusel con **Top 5** categorias. -- Carrusel con cupones que no han expirado. -- Tabla (Grid) con las categorias **restantes**. -- Mobile **no** necesita de todas las imagenes del modelo de subcategorías, solamente la **imagen más pequeña**. Tu podrías tener que filtrar la respuesta, si tu quieres. - -### Puntos a Considerar -- La API de Cupones es **inestable** y a veces demora en responder. ¿Qué podemos hacer para que este problema no se replique en otras capas? ¿Habrá algún patrón que nos ayude? -- La API de Categorias responde un modelo complejo de manejar. ¿Qué podríamos hacer para simplificar este modelo y que las integraciones con su aplicación sean más sencillas? - -## ¿Qué nos Gustaría Ver? -Eres libre para implementar la solución de la forma que consideres mejor, -pero debes considerar el escenario, objetivo, implicaciones de performance y stack/pool de tecnología propuesta abajo. -- Nos enfocamos mucho en la **calidad** de nuestros proyectos y nos gustaría ver alguna estrategia aplicada. Puedes usar, por ejemplo, **Pruebas Unitárias**. -- No queremos que la experiencia de usuario se vea afectada por el rendimiento de los servicios; -- **Usted tiene 1 semana para completar el desafio**. Si necesitas mas tiempo, no hay problema, puede hablar con nosotros y veremos que podemos hacer :) -- Documentación de como configurar y ejecutar el proyecto. Puede sobrescribir el **README.md** para eso. - -### Deseables -- Podría ser bueno una documentación de API. Sugerencia: [Swagger](https://swagger.io/). -- Ejecutando con [Docker](https://www.docker.com/). - -### Stack/Pool de Tecnologías -- **Java 8** o **superiores**. -- Cualquier Framework Web. Sugerencia: [Spring Boot](https://spring.io/projects/spring-boot). -- Cualquier API Client. Sugerencia: [Feign](https://github.com/OpenFeign/feign). -- De preferencia [Gradle](https://gradle.org/) como sistema de compilación. -- Tu eres libre para escoger librerias y frameworks de pruebas que mas te guste. Nuestra sugerencia es: [JUnit](https://junit.org/junit5/), [Mockito](https://site.mockito.org/). +## Comenzando ---- +Instrucciones para obtener una copia del proyecto funcionando en tu máquina local para desarrollo y pruebas. + +### Prerrequisitos + +- JDK 17 +- Gradle + +### Instalación + +Clona el repositorio y navega al directorio del proyecto: + +```bash +git clone https://github.com/BorisRand/java-recruiting-hsa.git +cd .\java-recruiting-hsa\bff-categories-coupons\ +``` + +### Configuración + +Configura las propiedades necesarias en `src/main/resources/application.properties`. -## Forma de Entrega -Siga los siguientes pasos para implementar y enviar este desafío: -- Haga un **Fork** a este repositorio. Puedes mirar esta guía para mayores informaciones: [Como hacer fork de un repositorio](https://help.github.com/en/articles/fork-a-repo). -- Implemente el desafío. -- Después de completar el desafío, realice un **Pull Request** a este repositorio, utilizando la interface de **Github**. [Creando un Pull Request](https://help.github.com/en/articles/creating-a-pull-request-from-a-fork). -- Si es posible, deja tu repositorio publico para hacer la revisión de código más sencilla. +### Swagger API Docs +La documentación de la API está disponible en Swagger UI, que se puede acceder en: -## Importante -**No** intente hacer un PUSH directo a ESTE repositorio! +```bash +http://localhost:8080/swagger-ui/index.html +``` + +### Spring Retry +El proyecto utiliza Spring Retry para manejar reintentos en las llamadas a servicios externos de manera eficiente. + +## Construido con + +- [Spring Boot](https://spring.io/projects/spring-boot) - El framework web utilizado. +- [Spring Cloud OpenFeign](https://spring.io/projects/spring-cloud-openfeign) - Cliente Feign para llamadas a servicios externos. +- [SpringDoc OpenAPI](https://springdoc.org/) - Para la documentación Swagger. +- [Spring Retry](https://docs.spring.io/spring-batch/docs/current/reference/html/retry.html) - Para el manejo de reintentos. + +## IDE utilizado + +- IntelliJ IDEA 2022.3.2 (Ultimate Edition) + +## Autores + +- **Boris Molina Igor** - Desarrollador - [BorisRand](https://github.com/BorisRand) + +### APIs +Necesitarás consumir los siguientes servicios: +- **Categorias**: [https://cs-hsa-api-categories-rest.herokuapp.com/docs](https://cs-hsa-api-categories-rest.herokuapp.com/docs) +- **Cupones**: [https://cs-hsa-api-coupons-rest.herokuapp.com/docs](https://cs-hsa-api-coupons-rest.herokuapp.com/docs) --- diff --git a/bff-categories-coupons/.gitignore b/bff-categories-coupons/.gitignore new file mode 100644 index 0000000..c2065bc --- /dev/null +++ b/bff-categories-coupons/.gitignore @@ -0,0 +1,37 @@ +HELP.md +.gradle +build/ +!gradle/wrapper/gradle-wrapper.jar +!**/src/main/**/build/ +!**/src/test/**/build/ + +### STS ### +.apt_generated +.classpath +.factorypath +.project +.settings +.springBeans +.sts4-cache +bin/ +!**/src/main/**/bin/ +!**/src/test/**/bin/ + +### IntelliJ IDEA ### +.idea +*.iws +*.iml +*.ipr +out/ +!**/src/main/**/out/ +!**/src/test/**/out/ + +### NetBeans ### +/nbproject/private/ +/nbbuild/ +/dist/ +/nbdist/ +/.nb-gradle/ + +### VS Code ### +.vscode/ diff --git a/bff-categories-coupons/build.gradle b/bff-categories-coupons/build.gradle new file mode 100644 index 0000000..0d9bd08 --- /dev/null +++ b/bff-categories-coupons/build.gradle @@ -0,0 +1,60 @@ +plugins { + id 'java' + id 'org.springframework.boot' version '3.1.6' + id 'io.spring.dependency-management' version '1.1.4' +} + +group = 'cl.accenture' +version = '0.0.1-SNAPSHOT' + +java { + sourceCompatibility = '17' +} + +configurations { + compileOnly { + extendsFrom annotationProcessor + } +} + +repositories { + mavenCentral() +} + +ext { + set('springCloudVersion', "2022.0.4") +} + +dependencies { + implementation 'org.springframework.boot:spring-boot-starter-web' + + implementation 'org.springframework.cloud:spring-cloud-starter-openfeign' + implementation 'org.springdoc:springdoc-openapi-starter-webmvc-ui:2.3.0' + + implementation 'org.springframework.retry:spring-retry:2.0.3' + implementation 'org.springframework:spring-aspects:6.0.11' + + implementation 'io.projectreactor:reactor-core' + + compileOnly 'org.projectlombok:lombok' + annotationProcessor 'org.projectlombok:lombok' + + testImplementation 'org.springframework.boot:spring-boot-starter-test' + testImplementation 'org.junit.jupiter:junit-jupiter-api:5.7.0' + testImplementation 'org.junit.jupiter:junit-jupiter-engine:5.7.0' + testRuntimeOnly 'org.junit.jupiter:junit-jupiter-engine:5.7.0' +} + +dependencyManagement { + imports { + mavenBom "org.springframework.cloud:spring-cloud-dependencies:${springCloudVersion}" + } +} + +tasks.named('bootBuildImage') { + builder = 'paketobuildpacks/builder-jammy-base:latest' +} + +tasks.named('test') { + useJUnitPlatform() +} diff --git a/bff-categories-coupons/gradle/wrapper/gradle-wrapper.jar b/bff-categories-coupons/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 0000000..d64cd49 Binary files /dev/null and b/bff-categories-coupons/gradle/wrapper/gradle-wrapper.jar differ diff --git a/bff-categories-coupons/gradle/wrapper/gradle-wrapper.properties b/bff-categories-coupons/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 0000000..1af9e09 --- /dev/null +++ b/bff-categories-coupons/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,7 @@ +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-8.5-bin.zip +networkTimeout=10000 +validateDistributionUrl=true +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists diff --git a/bff-categories-coupons/gradlew b/bff-categories-coupons/gradlew new file mode 100644 index 0000000..1aa94a4 --- /dev/null +++ b/bff-categories-coupons/gradlew @@ -0,0 +1,249 @@ +#!/bin/sh + +# +# Copyright © 2015-2021 the original authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +############################################################################## +# +# Gradle start up script for POSIX generated by Gradle. +# +# Important for running: +# +# (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is +# noncompliant, but you have some other compliant shell such as ksh or +# bash, then to run this script, type that shell name before the whole +# command line, like: +# +# ksh Gradle +# +# Busybox and similar reduced shells will NOT work, because this script +# requires all of these POSIX shell features: +# * functions; +# * expansions «$var», «${var}», «${var:-default}», «${var+SET}», +# «${var#prefix}», «${var%suffix}», and «$( cmd )»; +# * compound commands having a testable exit status, especially «case»; +# * various built-in commands including «command», «set», and «ulimit». +# +# Important for patching: +# +# (2) This script targets any POSIX shell, so it avoids extensions provided +# by Bash, Ksh, etc; in particular arrays are avoided. +# +# The "traditional" practice of packing multiple parameters into a +# space-separated string is a well documented source of bugs and security +# problems, so this is (mostly) avoided, by progressively accumulating +# options in "$@", and eventually passing that to Java. +# +# Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS, +# and GRADLE_OPTS) rely on word-splitting, this is performed explicitly; +# see the in-line comments for details. +# +# There are tweaks for specific operating systems such as AIX, CygWin, +# Darwin, MinGW, and NonStop. +# +# (3) This script is generated from the Groovy template +# https://github.com/gradle/gradle/blob/HEAD/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt +# within the Gradle project. +# +# You can find Gradle at https://github.com/gradle/gradle/. +# +############################################################################## + +# Attempt to set APP_HOME + +# Resolve links: $0 may be a link +app_path=$0 + +# Need this for daisy-chained symlinks. +while + APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path + [ -h "$app_path" ] +do + ls=$( ls -ld "$app_path" ) + link=${ls#*' -> '} + case $link in #( + /*) app_path=$link ;; #( + *) app_path=$APP_HOME$link ;; + esac +done + +# This is normally unused +# shellcheck disable=SC2034 +APP_BASE_NAME=${0##*/} +# Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036) +APP_HOME=$( cd "${APP_HOME:-./}" > /dev/null && pwd -P ) || exit + +# Use the maximum available, or set MAX_FD != -1 to use that value. +MAX_FD=maximum + +warn () { + echo "$*" +} >&2 + +die () { + echo + echo "$*" + echo + exit 1 +} >&2 + +# OS specific support (must be 'true' or 'false'). +cygwin=false +msys=false +darwin=false +nonstop=false +case "$( uname )" in #( + CYGWIN* ) cygwin=true ;; #( + Darwin* ) darwin=true ;; #( + MSYS* | MINGW* ) msys=true ;; #( + NONSTOP* ) nonstop=true ;; +esac + +CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar + + +# Determine the Java command to use to start the JVM. +if [ -n "$JAVA_HOME" ] ; then + if [ -x "$JAVA_HOME/jre/sh/java" ] ; then + # IBM's JDK on AIX uses strange locations for the executables + JAVACMD=$JAVA_HOME/jre/sh/java + else + JAVACMD=$JAVA_HOME/bin/java + fi + if [ ! -x "$JAVACMD" ] ; then + die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +else + JAVACMD=java + if ! command -v java >/dev/null 2>&1 + then + die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +fi + +# Increase the maximum file descriptors if we can. +if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then + case $MAX_FD in #( + max*) + # In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked. + # shellcheck disable=SC2039,SC3045 + MAX_FD=$( ulimit -H -n ) || + warn "Could not query maximum file descriptor limit" + esac + case $MAX_FD in #( + '' | soft) :;; #( + *) + # In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked. + # shellcheck disable=SC2039,SC3045 + ulimit -n "$MAX_FD" || + warn "Could not set maximum file descriptor limit to $MAX_FD" + esac +fi + +# Collect all arguments for the java command, stacking in reverse order: +# * args from the command line +# * the main class name +# * -classpath +# * -D...appname settings +# * --module-path (only if needed) +# * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables. + +# For Cygwin or MSYS, switch paths to Windows format before running java +if "$cygwin" || "$msys" ; then + APP_HOME=$( cygpath --path --mixed "$APP_HOME" ) + CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" ) + + JAVACMD=$( cygpath --unix "$JAVACMD" ) + + # Now convert the arguments - kludge to limit ourselves to /bin/sh + for arg do + if + case $arg in #( + -*) false ;; # don't mess with options #( + /?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath + [ -e "$t" ] ;; #( + *) false ;; + esac + then + arg=$( cygpath --path --ignore --mixed "$arg" ) + fi + # Roll the args list around exactly as many times as the number of + # args, so each arg winds up back in the position where it started, but + # possibly modified. + # + # NB: a `for` loop captures its iteration list before it begins, so + # changing the positional parameters here affects neither the number of + # iterations, nor the values presented in `arg`. + shift # remove old arg + set -- "$@" "$arg" # push replacement arg + done +fi + + +# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' + +# Collect all arguments for the java command: +# * DEFAULT_JVM_OPTS, JAVA_OPTS, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments, +# and any embedded shellness will be escaped. +# * For example: A user cannot expect ${Hostname} to be expanded, as it is an environment variable and will be +# treated as '${Hostname}' itself on the command line. + +set -- \ + "-Dorg.gradle.appname=$APP_BASE_NAME" \ + -classpath "$CLASSPATH" \ + org.gradle.wrapper.GradleWrapperMain \ + "$@" + +# Stop when "xargs" is not available. +if ! command -v xargs >/dev/null 2>&1 +then + die "xargs is not available" +fi + +# Use "xargs" to parse quoted args. +# +# With -n1 it outputs one arg per line, with the quotes and backslashes removed. +# +# In Bash we could simply go: +# +# readarray ARGS < <( xargs -n1 <<<"$var" ) && +# set -- "${ARGS[@]}" "$@" +# +# but POSIX shell has neither arrays nor command substitution, so instead we +# post-process each arg (as a line of input to sed) to backslash-escape any +# character that might be a shell metacharacter, then use eval to reverse +# that process (while maintaining the separation between arguments), and wrap +# the whole thing up as a single "set" statement. +# +# This will of course break if any of these variables contains a newline or +# an unmatched quote. +# + +eval "set -- $( + printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" | + xargs -n1 | + sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' | + tr '\n' ' ' + )" '"$@"' + +exec "$JAVACMD" "$@" diff --git a/bff-categories-coupons/gradlew.bat b/bff-categories-coupons/gradlew.bat new file mode 100644 index 0000000..93e3f59 --- /dev/null +++ b/bff-categories-coupons/gradlew.bat @@ -0,0 +1,92 @@ +@rem +@rem Copyright 2015 the original author or authors. +@rem +@rem Licensed under the Apache License, Version 2.0 (the "License"); +@rem you may not use this file except in compliance with the License. +@rem You may obtain a copy of the License at +@rem +@rem https://www.apache.org/licenses/LICENSE-2.0 +@rem +@rem Unless required by applicable law or agreed to in writing, software +@rem distributed under the License is distributed on an "AS IS" BASIS, +@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +@rem See the License for the specific language governing permissions and +@rem limitations under the License. +@rem + +@if "%DEBUG%"=="" @echo off +@rem ########################################################################## +@rem +@rem Gradle startup script for Windows +@rem +@rem ########################################################################## + +@rem Set local scope for the variables with windows NT shell +if "%OS%"=="Windows_NT" setlocal + +set DIRNAME=%~dp0 +if "%DIRNAME%"=="" set DIRNAME=. +@rem This is normally unused +set APP_BASE_NAME=%~n0 +set APP_HOME=%DIRNAME% + +@rem Resolve any "." and ".." in APP_HOME to make it shorter. +for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi + +@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" + +@rem Find java.exe +if defined JAVA_HOME goto findJavaFromJavaHome + +set JAVA_EXE=java.exe +%JAVA_EXE% -version >NUL 2>&1 +if %ERRORLEVEL% equ 0 goto execute + +echo. +echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:findJavaFromJavaHome +set JAVA_HOME=%JAVA_HOME:"=% +set JAVA_EXE=%JAVA_HOME%/bin/java.exe + +if exist "%JAVA_EXE%" goto execute + +echo. +echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:execute +@rem Setup the command line + +set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar + + +@rem Execute Gradle +"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %* + +:end +@rem End local scope for the variables with windows NT shell +if %ERRORLEVEL% equ 0 goto mainEnd + +:fail +rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of +rem the _cmd.exe /c_ return code! +set EXIT_CODE=%ERRORLEVEL% +if %EXIT_CODE% equ 0 set EXIT_CODE=1 +if not ""=="%GRADLE_EXIT_CONSOLE%" exit %EXIT_CODE% +exit /b %EXIT_CODE% + +:mainEnd +if "%OS%"=="Windows_NT" endlocal + +:omega diff --git a/bff-categories-coupons/settings.gradle b/bff-categories-coupons/settings.gradle new file mode 100644 index 0000000..276c9c6 --- /dev/null +++ b/bff-categories-coupons/settings.gradle @@ -0,0 +1 @@ +rootProject.name = 'bff-categories-coupons' diff --git a/bff-categories-coupons/src/main/java/cl/accenture/bff/categoriescoupons/CategoriesCouponsApplication.java b/bff-categories-coupons/src/main/java/cl/accenture/bff/categoriescoupons/CategoriesCouponsApplication.java new file mode 100644 index 0000000..db97a9c --- /dev/null +++ b/bff-categories-coupons/src/main/java/cl/accenture/bff/categoriescoupons/CategoriesCouponsApplication.java @@ -0,0 +1,22 @@ +package cl.accenture.bff.categoriescoupons; + +import org.springframework.boot.SpringApplication; +import org.springframework.boot.autoconfigure.SpringBootApplication; +import org.springframework.cloud.openfeign.EnableFeignClients; +import org.springframework.context.annotation.PropertySource; +import org.springframework.retry.annotation.EnableRetry; + +/* + * Copyright (c) 2023 Boris Molina + */ +@EnableFeignClients +@EnableRetry +@PropertySource("classpath:retryConfig.properties") +@SpringBootApplication +public class CategoriesCouponsApplication { + + public static void main(String[] args) { + SpringApplication.run(CategoriesCouponsApplication.class, args); + } + +} diff --git a/bff-categories-coupons/src/main/java/cl/accenture/bff/categoriescoupons/client/CategoriesClient.java b/bff-categories-coupons/src/main/java/cl/accenture/bff/categoriescoupons/client/CategoriesClient.java new file mode 100644 index 0000000..7675e75 --- /dev/null +++ b/bff-categories-coupons/src/main/java/cl/accenture/bff/categoriescoupons/client/CategoriesClient.java @@ -0,0 +1,18 @@ +package cl.accenture.bff.categoriescoupons.client; + +import cl.accenture.bff.categoriescoupons.config.FeignConfig; +import cl.accenture.bff.categoriescoupons.dto.Category; +import org.springframework.cloud.openfeign.FeignClient; +import org.springframework.web.bind.annotation.GetMapping; + +/* + * Copyright (c) 2023 Boris Molina + */ +@FeignClient(name = "categoriesClient", url = "${external.services.categories.url}", + configuration = FeignConfig.class) +public interface CategoriesClient { + + @GetMapping("/categories") + Category getCategories(); + +} diff --git a/bff-categories-coupons/src/main/java/cl/accenture/bff/categoriescoupons/client/CouponsClient.java b/bff-categories-coupons/src/main/java/cl/accenture/bff/categoriescoupons/client/CouponsClient.java new file mode 100644 index 0000000..321f39c --- /dev/null +++ b/bff-categories-coupons/src/main/java/cl/accenture/bff/categoriescoupons/client/CouponsClient.java @@ -0,0 +1,19 @@ +package cl.accenture.bff.categoriescoupons.client; + +import cl.accenture.bff.categoriescoupons.config.FeignConfig; +import cl.accenture.bff.categoriescoupons.dto.Coupon; +import org.springframework.cloud.openfeign.FeignClient; +import org.springframework.web.bind.annotation.GetMapping; + +import java.util.List; + +/* + * Copyright (c) 2023 Boris Molina + */ +@FeignClient(name = "couponsClient", url = "${external.services.coupons.url}", configuration = FeignConfig.class) +public interface CouponsClient { + + @GetMapping("/coupons") + List getCoupons(); + +} diff --git a/bff-categories-coupons/src/main/java/cl/accenture/bff/categoriescoupons/config/FeignConfig.java b/bff-categories-coupons/src/main/java/cl/accenture/bff/categoriescoupons/config/FeignConfig.java new file mode 100644 index 0000000..261016b --- /dev/null +++ b/bff-categories-coupons/src/main/java/cl/accenture/bff/categoriescoupons/config/FeignConfig.java @@ -0,0 +1,16 @@ +package cl.accenture.bff.categoriescoupons.config; + +import feign.Logger; +import org.springframework.context.annotation.Bean; + +/* + * Copyright (c) 2023 Boris Molina + */ +public class FeignConfig { + + @Bean + Logger.Level feignLoggerLevel() { + return Logger.Level.FULL; + } + +} diff --git a/bff-categories-coupons/src/main/java/cl/accenture/bff/categoriescoupons/controller/CategoriesController.java b/bff-categories-coupons/src/main/java/cl/accenture/bff/categoriescoupons/controller/CategoriesController.java new file mode 100644 index 0000000..34fdfa4 --- /dev/null +++ b/bff-categories-coupons/src/main/java/cl/accenture/bff/categoriescoupons/controller/CategoriesController.java @@ -0,0 +1,59 @@ +package cl.accenture.bff.categoriescoupons.controller; + +import cl.accenture.bff.categoriescoupons.dto.Category; +import cl.accenture.bff.categoriescoupons.service.CategoriesService; +import io.swagger.v3.oas.annotations.Operation; +import io.swagger.v3.oas.annotations.media.Content; +import io.swagger.v3.oas.annotations.responses.ApiResponse; +import org.springframework.http.HttpStatus; +import org.springframework.http.ResponseEntity; +import org.springframework.web.bind.annotation.GetMapping; +import org.springframework.web.bind.annotation.RequestMapping; +import org.springframework.web.bind.annotation.RestController; + +import java.util.List; + +/* + * Copyright (c) 2023 Boris Molina + */ +@RestController +@RequestMapping("/api/categories") +public class CategoriesController { + + private final CategoriesService categoriesService; + + public CategoriesController(CategoriesService categoriesService) { + this.categoriesService = categoriesService; + } + + @GetMapping + @Operation(summary = "Obtiene las categorías", + description = "Retorna las categorías", + responses = { + @ApiResponse( + description = "Categorías obtenidas con éxito", + responseCode = "200", content = @Content), + @ApiResponse( + description = "Error interno del servidor", + responseCode = "500", content = @Content) + }) + public ResponseEntity getCategories() { + return ResponseEntity.status(HttpStatus.OK).body(categoriesService.getCategories()); + } + + @GetMapping("/top5") + @Operation(summary = "Obtiene las TOP 5 categorías", + description = "Retorna el TOP 5 categorías", + responses = { + @ApiResponse( + description = "TOP 5 categorías obtenidas con éxito", + responseCode = "200", content = @Content), + @ApiResponse( + description = "Error interno del servidor", + responseCode = "500", content = @Content) + }) + public ResponseEntity> getTop5Categories() { + return ResponseEntity.status(HttpStatus.OK).body(categoriesService.getTop5Categories()); + } + +} diff --git a/bff-categories-coupons/src/main/java/cl/accenture/bff/categoriescoupons/controller/CouponsController.java b/bff-categories-coupons/src/main/java/cl/accenture/bff/categoriescoupons/controller/CouponsController.java new file mode 100644 index 0000000..f48ec29 --- /dev/null +++ b/bff-categories-coupons/src/main/java/cl/accenture/bff/categoriescoupons/controller/CouponsController.java @@ -0,0 +1,59 @@ +package cl.accenture.bff.categoriescoupons.controller; + +import cl.accenture.bff.categoriescoupons.dto.Coupon; +import cl.accenture.bff.categoriescoupons.service.CouponsService; +import io.swagger.v3.oas.annotations.Operation; +import io.swagger.v3.oas.annotations.media.Content; +import io.swagger.v3.oas.annotations.responses.ApiResponse; +import org.springframework.http.HttpStatus; +import org.springframework.http.ResponseEntity; +import org.springframework.web.bind.annotation.GetMapping; +import org.springframework.web.bind.annotation.RequestMapping; +import org.springframework.web.bind.annotation.RestController; + +import java.util.List; + +/* + * Copyright (c) 2023 Boris Molina + */ +@RestController +@RequestMapping("/api/coupons") +public class CouponsController { + + private final CouponsService couponsService; + + public CouponsController(CouponsService couponsService) { + this.couponsService = couponsService; + } + + @GetMapping("/all") + @Operation(summary = "Obtiene una lista de cupones", + description = "Retorna una lista de cupones", + responses = { + @ApiResponse( + description = "Lista de cupones obtenida con éxito", + responseCode = "200", content = @Content), + @ApiResponse( + description = "Error interno del servidor", + responseCode = "500", content = @Content) + }) + public ResponseEntity> getAllCoupons() { + return ResponseEntity.status(HttpStatus.OK).body(couponsService.getAllCoupons()); + } + + @GetMapping("/valid-coupons") + @Operation(summary = "Obtiene una lista de cupones vigentes", + description = "Retorna una lista de cupones vigentes", + responses = { + @ApiResponse( + description = "Lista de cupones vigentes obtenida con éxito", + responseCode = "200", content = @Content), + @ApiResponse( + description = "Error interno del servidor", + responseCode = "500", content = @Content) + }) + public ResponseEntity> getValidCoupons() { + return ResponseEntity.status(HttpStatus.OK).body(couponsService.getValidCoupons()); + } + +} diff --git a/bff-categories-coupons/src/main/java/cl/accenture/bff/categoriescoupons/dto/Category.java b/bff-categories-coupons/src/main/java/cl/accenture/bff/categoriescoupons/dto/Category.java new file mode 100644 index 0000000..b64c836 --- /dev/null +++ b/bff-categories-coupons/src/main/java/cl/accenture/bff/categoriescoupons/dto/Category.java @@ -0,0 +1,31 @@ +package cl.accenture.bff.categoriescoupons.dto; + +import com.fasterxml.jackson.annotation.JsonIgnore; +import lombok.AllArgsConstructor; +import lombok.Builder; +import lombok.Data; +import lombok.NoArgsConstructor; + +import java.util.List; + +/* + * Copyright (c) 2023 Boris Molina + */ +@Data +@NoArgsConstructor +@AllArgsConstructor +@Builder +public class Category { + + private String id; + private String name; + private int relevance; + private String iconImageUrl; + @JsonIgnore + private String largeImageUrl; + @JsonIgnore + private String mediumImageUrl; + private String smallImageUrl; + private List subcategories; + +} diff --git a/bff-categories-coupons/src/main/java/cl/accenture/bff/categoriescoupons/dto/Coupon.java b/bff-categories-coupons/src/main/java/cl/accenture/bff/categoriescoupons/dto/Coupon.java new file mode 100644 index 0000000..0443e44 --- /dev/null +++ b/bff-categories-coupons/src/main/java/cl/accenture/bff/categoriescoupons/dto/Coupon.java @@ -0,0 +1,25 @@ +package cl.accenture.bff.categoriescoupons.dto; + +import lombok.AllArgsConstructor; +import lombok.Builder; +import lombok.Data; +import lombok.NoArgsConstructor; + +import java.time.LocalDate; + +/* + * Copyright (c) 2023 Boris Molina + */ +@Data +@NoArgsConstructor +@AllArgsConstructor +@Builder +public class Coupon { + + private String id; + private String description; + private String seller; + private String image; + private LocalDate expiresAt; + +} diff --git a/bff-categories-coupons/src/main/java/cl/accenture/bff/categoriescoupons/dto/ErrorResponse.java b/bff-categories-coupons/src/main/java/cl/accenture/bff/categoriescoupons/dto/ErrorResponse.java new file mode 100644 index 0000000..b67e899 --- /dev/null +++ b/bff-categories-coupons/src/main/java/cl/accenture/bff/categoriescoupons/dto/ErrorResponse.java @@ -0,0 +1,32 @@ +package cl.accenture.bff.categoriescoupons.dto; + +import com.fasterxml.jackson.annotation.JsonFormat; +import com.fasterxml.jackson.annotation.JsonProperty; +import lombok.AllArgsConstructor; +import lombok.Builder; +import lombok.Data; +import lombok.NoArgsConstructor; + +import java.util.Date; + +/* + * Copyright (c) 2023 Boris Molina + */ +@Data +@NoArgsConstructor +@AllArgsConstructor +@Builder +public class ErrorResponse { + + @JsonFormat(shape = JsonFormat.Shape.STRING, pattern = "dd-MM-yyyy hh:mm:ss") + private Date timestamp; + @JsonProperty(value = "code") + private int code; + @JsonProperty(value = "status") + private String status; + @JsonProperty(value = "message") + private String message; + @JsonProperty(value = "details") + private String details; + +} diff --git a/bff-categories-coupons/src/main/java/cl/accenture/bff/categoriescoupons/exception/GlobalExceptionHandler.java b/bff-categories-coupons/src/main/java/cl/accenture/bff/categoriescoupons/exception/GlobalExceptionHandler.java new file mode 100644 index 0000000..a89ffe5 --- /dev/null +++ b/bff-categories-coupons/src/main/java/cl/accenture/bff/categoriescoupons/exception/GlobalExceptionHandler.java @@ -0,0 +1,32 @@ +package cl.accenture.bff.categoriescoupons.exception; + +import cl.accenture.bff.categoriescoupons.dto.ErrorResponse; +import feign.FeignException; +import org.springframework.http.HttpStatus; +import org.springframework.http.ResponseEntity; +import org.springframework.web.bind.annotation.ExceptionHandler; +import org.springframework.web.bind.annotation.RestControllerAdvice; +import org.springframework.web.context.request.WebRequest; + +import java.util.Date; + +/* + * Copyright (c) 2023 Boris Molina + */ +@RestControllerAdvice +public class GlobalExceptionHandler { + + @ExceptionHandler(FeignException.class) + public ResponseEntity handleFeignException(FeignException e, WebRequest request) { + return new ResponseEntity<>( + ErrorResponse.builder() + .timestamp(new Date()) + .code(HttpStatus.INTERNAL_SERVER_ERROR.value()) + .status(HttpStatus.INTERNAL_SERVER_ERROR.name()) + .message(e.getMessage()) + .details(request.getDescription(false)) + .build(), + HttpStatus.INTERNAL_SERVER_ERROR); + } + +} diff --git a/bff-categories-coupons/src/main/java/cl/accenture/bff/categoriescoupons/service/CategoriesService.java b/bff-categories-coupons/src/main/java/cl/accenture/bff/categoriescoupons/service/CategoriesService.java new file mode 100644 index 0000000..bc5c17c --- /dev/null +++ b/bff-categories-coupons/src/main/java/cl/accenture/bff/categoriescoupons/service/CategoriesService.java @@ -0,0 +1,48 @@ +package cl.accenture.bff.categoriescoupons.service; + +import cl.accenture.bff.categoriescoupons.client.CategoriesClient; +import cl.accenture.bff.categoriescoupons.dto.Category; +import org.springframework.retry.annotation.Backoff; +import org.springframework.retry.annotation.Retryable; +import org.springframework.stereotype.Service; + +import java.util.Collections; +import java.util.List; +import java.util.stream.Collectors; + +/* + * Copyright (c) 2023 Boris Molina + */ +@Service +public class CategoriesService { + + private final CategoriesClient categoriesClient; + + public CategoriesService(CategoriesClient categoriesClient) { + this.categoriesClient = categoriesClient; + } + + @Retryable(maxAttemptsExpression = "${retry.maxAttempts}", + backoff = @Backoff(delayExpression = "${retry.maxDelay}")) + public Category getCategories() { + return categoriesClient.getCategories(); + } + + @Retryable(maxAttemptsExpression = "${retry.maxAttempts}", + backoff = @Backoff(delayExpression = "${retry.maxDelay}")) + public List getTop5Categories() { + Category rootCategory = categoriesClient.getCategories(); + return getFirstFiveSubcategories(rootCategory); + } + + public List getFirstFiveSubcategories(Category category) { + if (category.getSubcategories() == null || category.getSubcategories().isEmpty()) { + return Collections.emptyList(); + } + return category.getSubcategories().stream() + .flatMap(subcat -> subcat.getSubcategories().stream()) + .limit(5) + .collect(Collectors.toList()); + } + +} diff --git a/bff-categories-coupons/src/main/java/cl/accenture/bff/categoriescoupons/service/CouponsService.java b/bff-categories-coupons/src/main/java/cl/accenture/bff/categoriescoupons/service/CouponsService.java new file mode 100644 index 0000000..3c109c8 --- /dev/null +++ b/bff-categories-coupons/src/main/java/cl/accenture/bff/categoriescoupons/service/CouponsService.java @@ -0,0 +1,43 @@ +package cl.accenture.bff.categoriescoupons.service; + +import cl.accenture.bff.categoriescoupons.client.CouponsClient; +import cl.accenture.bff.categoriescoupons.dto.Coupon; +import org.springframework.retry.annotation.Backoff; +import org.springframework.retry.annotation.Retryable; +import org.springframework.stereotype.Service; + +import java.time.LocalDate; +import java.util.List; +import java.util.stream.Collectors; + +/* + * Copyright (c) 2023 Boris Molina + */ +@Service +public class CouponsService { + + private final CouponsClient couponsClient; + + public CouponsService(CouponsClient couponsClient) { + this.couponsClient = couponsClient; + } + + @Retryable(maxAttemptsExpression = "${retry.maxAttempts}", + backoff = @Backoff(delayExpression = "${retry.maxDelay}")) + public List getAllCoupons() { + return couponsClient.getCoupons(); + } + + @Retryable(maxAttemptsExpression = "${retry.maxAttempts}", + backoff = @Backoff(delayExpression = "${retry.maxDelay}")) + public List getValidCoupons() { + return couponsClient.getCoupons().stream() + .filter(coupon -> isValidCoupon(coupon.getExpiresAt())) + .collect(Collectors.toList()); + } + + private boolean isValidCoupon(LocalDate expiresAt) { + return !expiresAt.isBefore(LocalDate.now()); + } + +} diff --git a/bff-categories-coupons/src/main/resources/application.properties b/bff-categories-coupons/src/main/resources/application.properties new file mode 100644 index 0000000..eadcc6c --- /dev/null +++ b/bff-categories-coupons/src/main/resources/application.properties @@ -0,0 +1,7 @@ +external.services.categories.url=https://cs-hsa-api-categories-rest.herokuapp.com +external.services.coupons.url=https://cs-hsa-api-coupons-rest.herokuapp.com + +spring.cloud.openfeign.client.config.default.readTimeout=1000 +spring.cloud.openfeign.client.config.default.connect-timeout=1000 + +server.port=8080 diff --git a/bff-categories-coupons/src/main/resources/retryConfig.properties b/bff-categories-coupons/src/main/resources/retryConfig.properties new file mode 100644 index 0000000..58e9111 --- /dev/null +++ b/bff-categories-coupons/src/main/resources/retryConfig.properties @@ -0,0 +1,2 @@ +retry.maxAttempts=5 +retry.maxDelay=1000 diff --git a/bff-categories-coupons/src/test/java/cl/accenture/bff/categoriescoupons/CategoriesCouponsApplicationTest.java b/bff-categories-coupons/src/test/java/cl/accenture/bff/categoriescoupons/CategoriesCouponsApplicationTest.java new file mode 100644 index 0000000..103d3d9 --- /dev/null +++ b/bff-categories-coupons/src/test/java/cl/accenture/bff/categoriescoupons/CategoriesCouponsApplicationTest.java @@ -0,0 +1,21 @@ +package cl.accenture.bff.categoriescoupons; + +import org.junit.jupiter.api.Test; +import org.springframework.boot.test.context.SpringBootTest; + +/* + * Copyright (c) 2023 Boris Molina + */ +@SpringBootTest +public class CategoriesCouponsApplicationTest { + + @Test + void contextLoads() { + } + + @Test + void main() { + CategoriesCouponsApplication.main(new String[]{}); + } + +} diff --git a/bff-categories-coupons/src/test/java/cl/accenture/bff/categoriescoupons/controller/CategoriesControllerTest.java b/bff-categories-coupons/src/test/java/cl/accenture/bff/categoriescoupons/controller/CategoriesControllerTest.java new file mode 100644 index 0000000..417886f --- /dev/null +++ b/bff-categories-coupons/src/test/java/cl/accenture/bff/categoriescoupons/controller/CategoriesControllerTest.java @@ -0,0 +1,50 @@ +package cl.accenture.bff.categoriescoupons.controller; + +import cl.accenture.bff.categoriescoupons.dto.Category; +import cl.accenture.bff.categoriescoupons.service.CategoriesService; +import org.junit.jupiter.api.Assertions; +import org.junit.jupiter.api.Test; +import org.junit.jupiter.api.extension.ExtendWith; +import org.mockito.InjectMocks; +import org.mockito.Mock; +import org.mockito.junit.jupiter.MockitoExtension; +import org.springframework.http.ResponseEntity; + +import java.util.Collections; +import java.util.List; + +import static org.mockito.Mockito.when; + +/* + * Copyright (c) 2023 Boris Molina + */ +@ExtendWith(MockitoExtension.class) +public class CategoriesControllerTest { + + @Mock + private CategoriesService categoriesService; + + @InjectMocks + private CategoriesController categoriesController; + + @Test + public void testGetCategories() { + when(categoriesService.getCategories()) + .thenReturn(Category.builder().build()); + + final ResponseEntity result = categoriesController.getCategories(); + + Assertions.assertNotNull(result); + } + + @Test + public void testTop5GetCategories() { + when(categoriesService.getTop5Categories()) + .thenReturn(Collections.singletonList(Category.builder().build())); + + final ResponseEntity> result = categoriesController.getTop5Categories(); + + Assertions.assertNotNull(result); + } + +} diff --git a/bff-categories-coupons/src/test/java/cl/accenture/bff/categoriescoupons/controller/CouponsControllerTest.java b/bff-categories-coupons/src/test/java/cl/accenture/bff/categoriescoupons/controller/CouponsControllerTest.java new file mode 100644 index 0000000..422ba12 --- /dev/null +++ b/bff-categories-coupons/src/test/java/cl/accenture/bff/categoriescoupons/controller/CouponsControllerTest.java @@ -0,0 +1,50 @@ +package cl.accenture.bff.categoriescoupons.controller; + +import cl.accenture.bff.categoriescoupons.dto.Coupon; +import cl.accenture.bff.categoriescoupons.service.CouponsService; +import org.junit.jupiter.api.Assertions; +import org.junit.jupiter.api.Test; +import org.junit.jupiter.api.extension.ExtendWith; +import org.mockito.InjectMocks; +import org.mockito.Mock; +import org.mockito.junit.jupiter.MockitoExtension; +import org.springframework.http.ResponseEntity; + +import java.util.Collections; +import java.util.List; + +import static org.mockito.Mockito.when; + +/* + * Copyright (c) 2023 Boris Molina + */ +@ExtendWith(MockitoExtension.class) +public class CouponsControllerTest { + + @Mock + private CouponsService couponsService; + + @InjectMocks + private CouponsController couponsController; + + @Test + public void testGetAllCoupons() { + when(couponsService.getAllCoupons()) + .thenReturn(Collections.singletonList(Coupon.builder().build())); + + final ResponseEntity> result = couponsController.getAllCoupons(); + + Assertions.assertNotNull(result); + } + + @Test + public void testGetValidCoupons() { + when(couponsService.getValidCoupons()) + .thenReturn(Collections.singletonList(Coupon.builder().build())); + + final ResponseEntity> result = couponsController.getValidCoupons(); + + Assertions.assertNotNull(result); + } + +} diff --git a/bff-categories-coupons/src/test/java/cl/accenture/bff/categoriescoupons/dto/CategoryTest.java b/bff-categories-coupons/src/test/java/cl/accenture/bff/categoriescoupons/dto/CategoryTest.java new file mode 100644 index 0000000..3193a3d --- /dev/null +++ b/bff-categories-coupons/src/test/java/cl/accenture/bff/categoriescoupons/dto/CategoryTest.java @@ -0,0 +1,41 @@ +package cl.accenture.bff.categoriescoupons.dto; + +import org.junit.jupiter.api.Test; + +import java.util.List; + +import static org.assertj.core.api.Assertions.assertThat; + +/* + * Copyright (c) 2023 Boris Molina + */ +public class CategoryTest { + + @Test + public void testCategory() { + Category subcategory = new Category(); + Category category = Category.builder() + .id("123") + .name("Name") + .relevance(1) + .iconImageUrl("iconUrl") + .largeImageUrl("largeUrl") + .mediumImageUrl("mediumUrl") + .smallImageUrl("smallUrl") + .subcategories(List.of(subcategory)) + .build(); + + assertThat(category.getId()).isEqualTo("123"); + assertThat(category.getName()).isEqualTo("Name"); + assertThat(category.getRelevance()).isEqualTo(1); + assertThat(category.getIconImageUrl()).isEqualTo("iconUrl"); + assertThat(category.getLargeImageUrl()).isEqualTo("largeUrl"); + assertThat(category.getMediumImageUrl()).isEqualTo("mediumUrl"); + assertThat(category.getSmallImageUrl()).isEqualTo("smallUrl"); + List subcategories = category.getSubcategories(); + assertThat(subcategories).isNotEmpty(); + assertThat(subcategories).hasSize(1); + assertThat(subcategories.get(0)).isEqualTo(subcategory); + } + +} diff --git a/bff-categories-coupons/src/test/java/cl/accenture/bff/categoriescoupons/dto/CouponTest.java b/bff-categories-coupons/src/test/java/cl/accenture/bff/categoriescoupons/dto/CouponTest.java new file mode 100644 index 0000000..c84e9de --- /dev/null +++ b/bff-categories-coupons/src/test/java/cl/accenture/bff/categoriescoupons/dto/CouponTest.java @@ -0,0 +1,44 @@ +package cl.accenture.bff.categoriescoupons.dto; + +import org.junit.jupiter.api.Test; + +import static java.time.LocalDate.EPOCH; +import static org.assertj.core.api.Assertions.assertThat; + +/* + * Copyright (c) 2023 Boris Molina + */ +public class CouponTest { + + @Test + public void testCoupon() { + Coupon subCoupon = new Coupon(); + Coupon coupon = Coupon.builder() + .id("123") + .description("20%") + .seller("seller") + .image("image_url") + .expiresAt(EPOCH) + .build(); + + assertThat(coupon.getId()).isEqualTo("123"); + assertThat(coupon.getDescription()).isEqualTo("20%"); + assertThat(coupon.getSeller()).isEqualTo("seller"); + assertThat(coupon.getImage()).isEqualTo("image_url"); + assertThat(coupon.getExpiresAt()).isEqualTo(EPOCH); + + Coupon anotherCoupon = Coupon.builder() + .id("123") + .description("20%") + .seller("seller") + .image("image_url") + .expiresAt(EPOCH) + .build(); + + assertThat(coupon).isEqualTo(anotherCoupon); + assertThat(coupon.hashCode()).isEqualTo(anotherCoupon.hashCode()); + assertThat(coupon.toString()).isNotNull(); + assertThat(subCoupon).isNotNull(); + } + +} diff --git a/bff-categories-coupons/src/test/java/cl/accenture/bff/categoriescoupons/dto/ErrorResponseTest.java b/bff-categories-coupons/src/test/java/cl/accenture/bff/categoriescoupons/dto/ErrorResponseTest.java new file mode 100644 index 0000000..2a438a7 --- /dev/null +++ b/bff-categories-coupons/src/test/java/cl/accenture/bff/categoriescoupons/dto/ErrorResponseTest.java @@ -0,0 +1,46 @@ +package cl.accenture.bff.categoriescoupons.dto; + +import org.junit.jupiter.api.Test; + +import java.util.Date; + +import static org.assertj.core.api.Assertions.assertThat; + +/* + * Copyright (c) 2023 Boris Molina + */ +public class ErrorResponseTest { + + @Test + public void testErrorResponse() { + Date date = new Date(); + ErrorResponse subErrorResponse = new ErrorResponse(); + ErrorResponse errorResponse = ErrorResponse.builder() + .timestamp(date) + .code(1) + .status("status") + .message("message") + .details("details") + .build(); + + assertThat(errorResponse.getTimestamp()).isEqualTo(date); + assertThat(errorResponse.getCode()).isEqualTo(1); + assertThat(errorResponse.getStatus()).isEqualTo("status"); + assertThat(errorResponse.getMessage()).isEqualTo("message"); + assertThat(errorResponse.getDetails()).isEqualTo("details"); + + ErrorResponse anotherErrorResponse = ErrorResponse.builder() + .timestamp(date) + .code(1) + .status("status") + .message("message") + .details("details") + .build(); + + assertThat(errorResponse).isEqualTo(anotherErrorResponse); + assertThat(errorResponse.hashCode()).isEqualTo(anotherErrorResponse.hashCode()); + assertThat(errorResponse.toString()).isNotNull(); + assertThat(subErrorResponse).isNotNull(); + } + +} diff --git a/bff-categories-coupons/src/test/java/cl/accenture/bff/categoriescoupons/exception/GlobalExceptionHandlerTest.java b/bff-categories-coupons/src/test/java/cl/accenture/bff/categoriescoupons/exception/GlobalExceptionHandlerTest.java new file mode 100644 index 0000000..ff85b50 --- /dev/null +++ b/bff-categories-coupons/src/test/java/cl/accenture/bff/categoriescoupons/exception/GlobalExceptionHandlerTest.java @@ -0,0 +1,67 @@ +package cl.accenture.bff.categoriescoupons.exception; + +import feign.FeignException; +import feign.Request; +import feign.Response; +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.Test; +import org.junit.jupiter.api.extension.ExtendWith; +import org.mockito.junit.jupiter.MockitoExtension; +import org.springframework.http.MediaType; +import org.springframework.test.web.servlet.MockMvc; +import org.springframework.test.web.servlet.setup.MockMvcBuilders; +import org.springframework.web.bind.annotation.GetMapping; +import org.springframework.web.bind.annotation.RestController; +import org.springframework.web.servlet.config.annotation.EnableWebMvc; + +import java.util.Collections; + +import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get; +import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.*; + +/* + * Copyright (c) 2023 Boris Molina + */ +@ExtendWith(MockitoExtension.class) +public class GlobalExceptionHandlerTest { + + private MockMvc mockMvc; + + @BeforeEach + public void setUp() { + mockMvc = MockMvcBuilders.standaloneSetup(new TestController()) + .setControllerAdvice(new GlobalExceptionHandler()) + .build(); + } + + @Test + public void testHandleFeignException() throws Exception { + mockMvc.perform(get("/test")) + .andExpect(status().isInternalServerError()) + .andExpect(content().contentType(MediaType.APPLICATION_JSON)) + .andExpect(jsonPath("$.message") + .value("[500 Feign error occurred] during [GET] to [] [Test Feign Exception]: []")) + .andExpect(jsonPath("$.details") + .value("uri=/test")); + } + + @EnableWebMvc + @RestController + public static class TestController { + @GetMapping("/test") + public void test() { + throw FeignException.errorStatus("Test Feign Exception", + Response.builder() + .status(500) + .reason("Feign error occurred") + .request(Request.create(Request.HttpMethod.GET, + "", + Collections.emptyMap(), + null, + null, + null)) + .build()); + } + } + +} diff --git a/bff-categories-coupons/src/test/java/cl/accenture/bff/categoriescoupons/service/CategoriesServiceTest.java b/bff-categories-coupons/src/test/java/cl/accenture/bff/categoriescoupons/service/CategoriesServiceTest.java new file mode 100644 index 0000000..8d37911 --- /dev/null +++ b/bff-categories-coupons/src/test/java/cl/accenture/bff/categoriescoupons/service/CategoriesServiceTest.java @@ -0,0 +1,77 @@ +package cl.accenture.bff.categoriescoupons.service; + +import cl.accenture.bff.categoriescoupons.client.CategoriesClient; +import cl.accenture.bff.categoriescoupons.dto.Category; +import org.junit.jupiter.api.Assertions; +import org.junit.jupiter.api.Test; +import org.junit.jupiter.api.extension.ExtendWith; +import org.mockito.InjectMocks; +import org.mockito.Mock; +import org.mockito.junit.jupiter.MockitoExtension; + +import java.util.Collections; +import java.util.List; + +import static org.mockito.Mockito.when; + +/* + * Copyright (c) 2023 Boris Molina + */ +@ExtendWith(MockitoExtension.class) +public class CategoriesServiceTest { + + @Mock + private CategoriesClient categoriesClient; + + @InjectMocks + private CategoriesService categoriesService; + + @Test + public void testGetCategories() { + when(categoriesClient.getCategories()) + .thenReturn(Category.builder().build()); + + final Category result = categoriesService.getCategories(); + + Assertions.assertNotNull(result); + } + + @Test + public void testGetTop5CategoriesIsEmpty() { + when(categoriesClient.getCategories()) + .thenReturn(Category.builder().build()); + + final List result = categoriesService.getTop5Categories(); + + Assertions.assertNotNull(result); + } + + @Test + public void testGetTop5Categories() { + when(categoriesClient.getCategories()) + .thenReturn(buildCategory()); + + final List result = categoriesService.getTop5Categories(); + + Assertions.assertNotNull(result); + } + + private Category buildCategory() { + return Category.builder() + .subcategories( + Collections.singletonList( + Category.builder() + .subcategories( + Collections.singletonList( + Category.builder() + .id("1") + .build() + ) + ) + .build() + ) + ) + .build(); + } + +} diff --git a/bff-categories-coupons/src/test/java/cl/accenture/bff/categoriescoupons/service/CouponsServiceTest.java b/bff-categories-coupons/src/test/java/cl/accenture/bff/categoriescoupons/service/CouponsServiceTest.java new file mode 100644 index 0000000..6a3ec64 --- /dev/null +++ b/bff-categories-coupons/src/test/java/cl/accenture/bff/categoriescoupons/service/CouponsServiceTest.java @@ -0,0 +1,56 @@ +package cl.accenture.bff.categoriescoupons.service; + +import cl.accenture.bff.categoriescoupons.client.CouponsClient; +import cl.accenture.bff.categoriescoupons.dto.Coupon; +import org.junit.jupiter.api.Assertions; +import org.junit.jupiter.api.Test; +import org.junit.jupiter.api.extension.ExtendWith; +import org.mockito.InjectMocks; +import org.mockito.Mock; +import org.mockito.junit.jupiter.MockitoExtension; + +import java.util.Collections; +import java.util.List; + +import static java.time.LocalDate.EPOCH; +import static org.mockito.Mockito.when; + +/* + * Copyright (c) 2023 Boris Molina + */ +@ExtendWith(MockitoExtension.class) +public class CouponsServiceTest { + + @Mock + private CouponsClient couponsClient; + + @InjectMocks + private CouponsService couponsService; + + @Test + public void testGetAllCoupons() { + when(couponsClient.getCoupons()) + .thenReturn(Collections.singletonList(Coupon.builder().build())); + + final List result = couponsService.getAllCoupons(); + + Assertions.assertNotNull(result); + } + + @Test + public void testGetValidCoupons() { + when(couponsClient.getCoupons()) + .thenReturn(Collections.singletonList(buildCoupon())); + + final List result = couponsService.getValidCoupons(); + + Assertions.assertNotNull(result); + } + + private Coupon buildCoupon() { + return Coupon.builder() + .expiresAt(EPOCH) + .build(); + } + +}