{"type":"doc","content":[{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"toc","parameters":{"macroParams":{"minLevel":{"value":"1"},"maxLevel":{"value":"6"},"outline":{"value":"false"},"type":{"value":"flat"},"printable":{"value":"false"}},"macroMetadata":{"macroId":{"value":"db7bb0d0-ea73-4e91-8ca5-a59545c3f36d"},"schemaVersion":{"value":"1"},"title":"Table of Contents"}},"localId":"82d30438-069c-4e30-8933-8b99d9859ac0"}},{"type":"heading","attrs":{"level":2},"content":[{"text":"Introducción","type":"text"}]},{"type":"paragraph","content":[{"text":"gRPC es un framework de procedimiento remoto de alto rendimiento desarrollado por Google. Utiliza el protocolo HTTP/2 para la comunicación entre los servidores y los clientes, y permite la comunicación entre los servicios de diferentes lenguajes de programación.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Configuración del entorno","type":"text"}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"paragraph","content":[{"text":"En el archivo ","type":"text"},{"text":"build.gradle","type":"text","marks":[{"type":"code"}]},{"text":" se añadieron las dependencias necesarias de gRPC","type":"text"}]}]},{"type":"codeBlock","content":[{"text":" testImplementation 'io.grpc:grpc-testing:1.41.0'\n testImplementation group: 'com.google.protobuf', name: 'protobuf-java', version:'3.23.2'\n implementation 'io.grpc:grpc-stub:1.53.0'\n implementation 'io.grpc:grpc-api:1.53.0'\n implementation 'io.grpc:protoc-gen-grpc-java:1.53.0'\n implementation 'io.grpc:grpc-core:1.53.0'\n implementation 'io.grpc:grpc-netty-shaded:1.53.0'\n implementation 'com.google.api.grpc:proto-google-common-protos:2.14.1'\n implementation 'javax.annotation:javax.annotation-api:1.3.2'\n implementation 'io.grpc:grpc-protobuf:1.55.1'","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Archivos .proto","type":"text"}]},{"type":"paragraph","content":[{"text":"En gRPC, los servicios y los mensajes que se envían entre el cliente y el servidor se definen en archivos ","type":"text"},{"text":".proto","type":"text","marks":[{"type":"code"}]},{"text":", que utilizan el lenguaje de definición de interfaz (IDL) de Protocol Buffers. Aquí es donde se definen las operaciones que el servicio puede realizar y los tipos de datos que se envían y reciben. Esencialmente, es la especificación de la API de gRPC.","type":"text"}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"paragraph","content":[{"text":"Agregar los archivos ","type":"text"},{"text":".proto","type":"text","marks":[{"type":"code"}]},{"text":" necesarios para las pruebas de servicios en ","type":"text"},{"text":"src/main/proto/servicename","type":"text","marks":[{"type":"code"}]}]}]},{"type":"paragraph","content":[{"text":"ejemplo:","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"center"},"content":[{"type":"media","attrs":{"width":1223,"id":"848f34b6-ee70-4959-855f-bfa33501c5a8","collection":"contentId-2484961314","type":"file","height":290}}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Stubs","type":"text"}]},{"type":"paragraph","content":[{"text":"Un \"stub\" se refiere al cliente de un servicio gRPC que se conecta a un servidor. Es esencialmente código generado a partir del archivo ","type":"text"},{"text":".proto","type":"text","marks":[{"type":"code"}]},{"text":" que un cliente puede usar para invocar ","type":"text"},{"text":"métodos ","type":"text","marks":[{"type":"strong"}]},{"text":"de un servicio remoto. Toma un mensaje de protocolo, serializa el mensaje en el formato correcto, envía la solicitud a través de la red, y luego espera y deserializa las respuestas para enviarlas de vuelta al código de llamada.","type":"text"}]},{"type":"panel","attrs":{"panelType":"note"},"content":[{"type":"paragraph","content":[{"text":"El enfoque más común para realizar pruebas en Java con gRPC es utilizar un stub generado automáticamente. Esto permite enfocarse en probar la lógica específica del cliente sin preocuparse por la complejidad de la comunicación subyacente.","type":"text"}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Generar los stubs (archivos Java) a partir del archivo .proto: ","type":"text"},{"type":"hardBreak"}]},{"type":"paragraph","content":[{"text":"Gradle posee un plugin que permite generar los archivos Java, los cuales incluyen el código para los servicios y mensajes a partir de los archivos ","type":"text"},{"text":".proto","type":"text","marks":[{"type":"code"}]},{"text":", utilizando el compilador de Protocol Buffers (protobuf-protoc).","type":"text"}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"paragraph","content":[{"text":"Se cuenta con el plugin de protobuf en el archivo ","type":"text"},{"text":"build.gradle","type":"text","marks":[{"type":"code"}]},{"text":":","type":"text"}]}]},{"type":"codeBlock","content":[{"text":"apply \nplugin\n'com.google.protobuf'","type":"text"}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"paragraph","content":[{"text":"También, se incluye la siguiente configuración para el plugin:","type":"text"}]}]},{"type":"codeBlock","content":[{"text":"protobuf {\n protoc {\n artifact = 'com.google.protobuf:protoc:3.23.2'\n }\n plugins{\n grpc{\n artifact = 'io.grpc:protoc-gen-grpc-java:1.53.0'\n }\n }\n generateProtoTasks {\n all()*.plugins {\n grpc{\n }\n }\n }\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Para que el plugin compile los archivos ","type":"text"},{"text":".proto","type":"text","marks":[{"type":"code"}]},{"text":" se ejecuta el comando ","type":"text"},{"text":"gradle build","type":"text","marks":[{"type":"code"}]},{"text":" y se generan los archivos Java necesarios.","type":"text"}]},{"type":"paragraph","content":[{"text":"Los stubs serán generados automáticamente en el directorio ","type":"text"},{"text":"build/generated/source/proto/main/grpc","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]},{"type":"panel","attrs":{"panelType":"warning"},"content":[{"type":"paragraph","content":[{"text":"Si se desea no utilizar un stub y probar la comunicación con un servidor gRPC , se tendría que implementar manualmente toda la lógica de comunicación, serialización, deserialización y manejo de la comunicación de red, lo que puede ser bastante complejo y propenso a errores.","type":"text"}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Tipos de Stubs en gRPC","type":"text"}]},{"type":"layoutSection","content":[{"type":"layoutColumn","attrs":{"width":33.33},"content":[{"type":"paragraph","content":[{"text":"Blocking (síncrono)","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph"},{"type":"paragraph"},{"type":"paragraph"},{"type":"paragraph"}]},{"type":"layoutColumn","attrs":{"width":66.66},"content":[{"type":"paragraph","content":[{"text":"Realiza llamadas síncronas. Esto significa que cuando se hace una llamada a un método en el stub, la ejecución de ese hilo se bloquea hasta que se recibe la respuesta del servidor. Este comportamiento es útil en situaciones en las que se necesita esperar la respuesta del servidor antes de continuar con la ejecución del programa, como cuando se está realizando una operación de consulta o actualización de datos.","type":"text"}]}]}]},{"type":"layoutSection","content":[{"type":"layoutColumn","attrs":{"width":33.33},"content":[{"type":"paragraph","content":[{"text":"Non-blocking (Future stub)","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"layoutColumn","attrs":{"width":66.66},"content":[{"type":"paragraph","content":[{"text":"Las llamadas son no bloqueantes, lo que significa que la llamada devuelve inmediatamente un ","type":"text"},{"text":"Future","type":"text","marks":[{"type":"code"}]},{"text":" que el cliente puede usar para obtener la respuesta cuando esté disponible.","type":"text"}]}]}]},{"type":"layoutSection","content":[{"type":"layoutColumn","attrs":{"width":33.33},"content":[{"type":"paragraph","content":[{"text":"Async (asíncrono)","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"layoutColumn","attrs":{"width":66.66},"content":[{"type":"paragraph","content":[{"text":"Las llamadas son asincrónicas. El cliente debe pasar un ","type":"text"},{"text":"StreamObserver","type":"text","marks":[{"type":"code"}]},{"text":" a la llamada que será llamado cuando la respuesta esté disponible.","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"Después de generar el código del cliente y del servidor, se implementan los stubs en los script de prueba. ","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Creación del tipo de Stub ","type":"text"}]},{"type":"paragraph","content":[{"text":"En gRPC en necesario especificar el tipo de stub (cliente) que que se requiere usar para hacer una petición. El tipo de stub que se elija, determina cómo se maneja la petición.","type":"text"}]},{"type":"paragraph","content":[{"text":"Para seleccionar el tipo de stub, se deben usar los métodos correspondientes de la clase generada automáticamente a partir del ","type":"text"},{"text":".proto","type":"text","marks":[{"type":"code"}]},{"text":". ","type":"text"}]},{"type":"paragraph","content":[{"text":"Por ejemplo, si el servicio se llama ","type":"text"},{"text":"AccountAggregationService","type":"text","marks":[{"type":"code"}]},{"text":", gRPC generará una clase ","type":"text"},{"text":"AccountAggregationServiceGrpc","type":"text","marks":[{"type":"code"}]},{"text":" que contiene métodos: ","type":"text"},{"text":"newBlockingStub","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"newFutureStub","type":"text","marks":[{"type":"code"}]},{"text":", y ","type":"text"},{"text":"newStub","type":"text","marks":[{"type":"code"}]},{"text":" que se pueden usar para crear los distintos tipos de stubs.","type":"text"}]},{"type":"paragraph","content":[{"text":"A continuación se especifica como se crea un stub de gRPC bloqueante para la interfaz ","type":"text"},{"text":"AccountAggregationService","type":"text","marks":[{"type":"code"}]},{"text":". Esto es esencialmente un cliente que se usará para hacer llamadas al servicio.","type":"text"}]},{"type":"codeBlock","content":[{"text":"AccountAggregationServiceGrpc.AccountAggregationServiceBlockingStub = AccountAggregationServiceGrpc.newBlockingStub();","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Implementación de Clases Base","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"ServiceBase.java","type":"text"}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"paragraph","content":[{"text":"Se optó por crear una clase principal con una estructura abstracta que maneje la apertura y cierre de canales, la infraestructura necesaria para construir y utilizar \"stubs\" gRPC, y la configuración de la URL del servidor que todos los tests de servicios gRPC requieren. Las subclases derivadas de ","type":"text"},{"text":"ServiceBase ","type":"text","marks":[{"type":"code"}]},{"text":"deberán proporcionar la implementación específica de la construcción del stub.","type":"text"}]}]},{"type":"paragraph","content":[{"text":"ServiceBase.java es una clase abstracta genérica que proporciona la estructura y herramientas para configurar una conexión al servicio y comunicarse con él utilizando la librería de gRPC para la creación de canales y stubs. ","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Al iniciar una prueba, la clase se conecta a un servicio usando una dirección URL (","type":"text"},{"text":"url","type":"text","marks":[{"type":"code"}]},{"text":").","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Una vez establecida la conexión, crea un \"stub\" o punto de conexión para comunicarse con el servicio.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Al finalizar una prueba, cierra la conexión.","type":"text"}]}]}]},{"type":"rule"},{"type":"codeBlock","content":[{"text":"public abstract class ServiceBase> extends TestBase","type":"text"}]},{"type":"paragraph","content":[{"type":"emoji","attrs":{"id":"1f6e0","text":"🛠️","shortName":":tools:"}},{"text":" La razón principal para hacer la clase abstracta es que contiene un método abstracto (","type":"text"},{"text":"buildStub","type":"text","marks":[{"type":"code"}]},{"text":") que las clases hijas deben implementar obligatoriamente.","type":"text"}]},{"type":"paragraph","content":[{"type":"emoji","attrs":{"id":"1f517","text":"🔗","shortName":":link:"}},{"text":" ","type":"text"},{"text":"T","type":"text","marks":[{"type":"code"}]},{"text":" es un tipo genérico. La clase está diseñada para trabajar con cualquier tipo ","type":"text"},{"text":"T","type":"text","marks":[{"type":"code"}]},{"text":" que extienda (o sea un subtipo de) ","type":"text"},{"text":"AbstractStub","type":"text","marks":[{"type":"code"}]},{"text":". ","type":"text"}]},{"type":"paragraph"},{"type":"codeBlock","content":[{"text":"protected abstract T buildStub(ManagedChannel channel);","type":"text"}]},{"type":"paragraph","content":[{"text":"buildStub","type":"text","marks":[{"type":"code"}]},{"text":"tiene el propósito de construir (o inicializar) un \"stub\". Es abstracto, no tiene una implementación en esta clase ya que las clases que hereden de esta deben proporcionarla.","type":"text"}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"paragraph","content":[{"text":"Cada servicio en gRPC puede tener su propio stub. Esta función será implementada por las subclases para construir el stub dependiendo del servicio que se esté probando.","type":"text"}]}]},{"type":"paragraph","content":[{"text":"Al ser ","type":"text"},{"text":"T","type":"text","marks":[{"type":"code"}]},{"text":" es un tipo que extiende de ","type":"text"},{"text":"AbstractStub","type":"text","marks":[{"type":"code"}]},{"text":". El método ","type":"text"},{"text":"buildStub","type":"text","marks":[{"type":"code"}]},{"text":" devolverá un objeto de tipo ","type":"text"},{"text":"T","type":"text","marks":[{"type":"code"}]},{"text":", que será una especie de ","type":"text"},{"text":"AbstractStub","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]},{"type":"paragraph","content":[{"text":"(ManagedChannel channel)","type":"text","marks":[{"type":"code"}]},{"text":": El método recibirá un parámetro llamado ","type":"text"},{"text":"channel","type":"text","marks":[{"type":"code"}]},{"text":" de tipo ","type":"text"},{"text":"ManagedChannel","type":"text","marks":[{"type":"code"}]},{"text":" El cual representa una conexión a un servidor gRPC.","type":"text"}]},{"type":"paragraph"},{"type":"codeBlock","attrs":{"language":"java"},"content":[{"text":"@Before\n public void setup() {\n channel = ManagedChannelBuilder.forTarget(url)\n .usePlaintext()\n .intercept(new LoggingClientInterceptor(url))\n .build();\n blockingStub = buildStub(channel);\n }\n@After\npublic void tearDown() throws Exception {\n if (channel != null) {\n channel.shutdownNow().awaitTermination(5, TimeUnit.SECONDS);\n }\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Estos métodos se utilizan para configurar y limpiar recursos antes y después de cada prueba individual.","type":"text"}]},{"type":"paragraph","content":[{"type":"emoji","attrs":{"id":"1f680","text":"🚀","shortName":":rocket:"}},{"text":" ","type":"text"},{"text":"setup()","type":"text","marks":[{"type":"code"}]},{"text":":","type":"text"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Crea un canal gRPC para comunicarse con un servicio remoto a la url que será proporcionada por la clase que herede de ","type":"text"},{"text":"ServiceBase","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Añade un interceptor de registro. (Para imprimir en el log: Calling URL, Calling method, Sending message y Received response)","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Construye un \"stub\" bloqueante utilizando el canal recién creado.","type":"text"}]}]}]},{"type":"paragraph","content":[{"type":"emoji","attrs":{"id":"1f9f9","text":"🧹","shortName":":broom:"}},{"text":" ","type":"text"},{"text":"tearDown()","type":"text","marks":[{"type":"code"}]},{"text":":","type":"text"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Verifica si el canal existe.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Si existe, cierra el canal inmediatamente y espera hasta 5 segundos para que se cierre completamente.","type":"text"}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"AccountAggregationServiceBase.java","type":"text"}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"paragraph","content":[{"text":"Esta clase proporciona la implementación concreta para el método ","type":"text"},{"text":"buildStub","type":"text","marks":[{"type":"code"}]},{"text":" que está declarado en ","type":"text"},{"text":"ServiceBase","type":"text","marks":[{"type":"code"}]},{"text":". Esta implementación crea y devuelve una nueva instancia de un stub bloqueante para ","type":"text"},{"text":"AccountAggregationServiceGrpc","type":"text","marks":[{"type":"code"}]},{"text":" usando el canal gRPC proporcionado.","type":"text"}]}]},{"type":"rule"},{"type":"codeBlock","content":[{"text":"public abstract class AccountAggregationServiceBase extends MirrorStrategyServiceBase {","type":"text"}]},{"type":"paragraph","content":[{"text":"Esta clase es específico está parametrizada con ","type":"text"},{"text":"AccountAggregationServiceGrpc.AccountAggregationServiceBlockingStub","type":"text","marks":[{"type":"code"}]},{"text":" para el tipo genérico ","type":"text"},{"text":"T","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]},{"type":"paragraph","content":[{"text":"Es decir, ","type":"text"},{"text":"MirrorStrategyServiceBase","type":"text","marks":[{"type":"code"}]},{"text":" trabaja específicamente con el \"stub bloqueante\" del servicio ","type":"text"},{"text":"AccountAggregationServiceGrpc","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]},{"type":"panel","attrs":{"panelType":"note"},"content":[{"type":"paragraph","content":[{"text":"Recordemos que ","type":"text"},{"text":"AccountAggregationServiceGrpc","type":"text","marks":[{"type":"code"}]},{"text":" es la clase generada automáticamente al compilarse un archivo ","type":"text"},{"text":".proto","type":"text","marks":[{"type":"code"}]},{"text":". Y ","type":"text"},{"text":"AccountAggregationServiceBlockingStub","type":"text","marks":[{"type":"code"}]},{"text":" es un tipo de stub de una clase interna generadas dentro de ","type":"text"},{"text":"AccountAggregationServiceGrpc","type":"text","marks":[{"type":"code"}]},{"text":". ","type":"text"}]},{"type":"paragraph","content":[{"text":"Por cada servicio a probar es necesario tener estas clases generadas para poderlas ocupar en la creación del tipo de stub.","type":"text"}]}]},{"type":"rule"},{"type":"codeBlock","content":[{"text":"public AccountAggregationServiceBase() {\n setUrl(baseMirrorStrategyADDRESS);\n }","type":"text"}]},{"type":"paragraph","content":[{"text":"Cuando se crea una instancia de esta clase, automáticamente se establece su URL al valor de ","type":"text"},{"text":"baseMirrorStrategyADDRESS","type":"text","marks":[{"type":"code"}]},{"text":" usando el método ","type":"text"},{"text":"setUrl","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"El valor de baseMirrorStrategyADDRESS se obtiene de la clase de configuración cuyo origen es el config.properties. Esta implementación es igual a la del proyecto de API REST.","type":"text"}]},{"type":"codeBlock","content":[{"text":"public abstract class TestConfig extends Runner {\n\n@BeforeClass\npublic static void setUp() throws IOException {\n if (globalSetup) {\n ...\n baseMirrorStrategyADDRESS = configProperties.getProperty(PropertiesHandler.paths().get(\"baseMirrorStrategyADDRESS\"));\n }\n}\n/**\n * End up execution after test class is being executed.\n */\n@AfterClass\n...\n}","type":"text"}]}]}]}]},{"type":"rule"},{"type":"codeBlock","content":[{"text":"@Override\n protected AccountAggregationServiceGrpc.AccountAggregationServiceBlockingStub buildStub(ManagedChannel channel) {\n return AccountAggregationServiceGrpc.newBlockingStub(channel);\n }","type":"text"}]},{"type":"paragraph","content":[{"text":"El tag ","type":"text"},{"text":"@Override","type":"text","marks":[{"type":"code"}]},{"text":" indica que ese método está sobrescribiendo al método de la clase en ","type":"text"},{"text":"ServiceBase","type":"text","marks":[{"type":"code"}]},{"text":". Aquí ya se está proporcionando una implementación específica del método ","type":"text"},{"text":"buildStub","type":"text","marks":[{"type":"code"}]},{"text":", recibe el canal creado para posteriormente crear un objeto stub bloqueante con el canal obtenido y lo devuelve de tipo ","type":"text"},{"text":"AccountAggregationServiceGrpc.AccountAggregationServiceBlockingStub","type":"text","marks":[{"type":"code"}]},{"text":" esto ya permitirá hacer las llamadas a procedimientos remotos en el ","type":"text"},{"text":"@Before","type":"text","marks":[{"type":"code"}]},{"text":" de la clase ","type":"text"},{"text":"ServiceBase","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Construcción Test Cases","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"ServiceDetailsPositiveTests.java","type":"text"}]},{"type":"paragraph","content":[{"text":"Esta clase es un ejemplo de una clase de prueba para un servicio es especifico y hereda de ","type":"text"},{"text":"MirrorStrategyServiceBase","type":"text","marks":[{"type":"code"}]},{"text":". ","type":"text"}]},{"type":"paragraph"},{"type":"codeBlock","content":[{"text":"@Test\n@Title\n(\"GRPC - Consult account details\")","type":"text"}]},{"type":"paragraph","content":[{"text":"En esencia, esta clase está estructurada de la misma forma que en los test del proyecto de REST.","type":"text"}]},{"type":"paragraph","content":[{"text":"Contiene las notaciones de método de prueba y de la descripción del caso (","type":"text"},{"text":"@Tesy","type":"text","marks":[{"type":"code"}]},{"text":" y ","type":"text"},{"text":"@Title","type":"text","marks":[{"type":"code"}]},{"text":")","type":"text"}]},{"type":"rule"},{"type":"paragraph","content":[{"text":"Construcción de la solicitud","type":"text","marks":[{"type":"strong"}]},{"text":":","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Se crea un objeto request de tipo ","type":"text"},{"text":"AccountDetailsRequestDTO","type":"text","marks":[{"type":"code"}]},{"text":" (generado por el compilador de Protocol Buffers-","type":"text"},{"text":"protoc","type":"text","marks":[{"type":"code"}]},{"text":").","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Después se usa el método ","type":"text"},{"text":"newBuilder()","type":"text","marks":[{"type":"code"}]},{"text":" para iniciar la construcción del mensaje.","type":"text"}]}]}]},{"type":"panel","attrs":{"panelType":"note"},"content":[{"type":"paragraph","content":[{"text":"Como lo veíamos anteriormente gRPC, utiliza Protocol Buffers (protobuf) como su mecanismo de serialización. Uno de los métodos que se generan a partir del ","type":"text"},{"text":".proto","type":"text","marks":[{"type":"code"}]},{"text":" es ","type":"text"},{"text":"newBuilder()","type":"text","marks":[{"type":"code"}]},{"text":". Este método permite construir una instancia del mensaje paso a paso (Indicando las propiedades y valores del mensaje) y devuelve una instancia del builder asociado a ese objeto.","type":"text"}]}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"La función ","type":"text"},{"text":"setAccountNumber()","type":"text","marks":[{"type":"code"}]},{"text":" establece el número de cuenta obtenido de dataProperties","type":"text"}]}]}]},{"type":"panel","attrs":{"panelType":"note"},"content":[{"type":"paragraph","content":[{"text":"Este es otro método generado automáticamente por ","type":"text"},{"text":"protoc","type":"text","marks":[{"type":"code"}]},{"text":" basado en la definición del mensaje en el archivo ","type":"text"},{"text":".proto","type":"text","marks":[{"type":"code"}]},{"text":". En este caso, indica que hay que mandar un campo llamado ","type":"text"},{"text":"accountNumber","type":"text","marks":[{"type":"code"}]},{"text":" en el mensaje de ","type":"text"},{"text":"AccountDetailsRequestDTO","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Finalmente, ","type":"text"},{"text":"build()","type":"text","marks":[{"type":"code"}]},{"text":" completa y devuelve una instancia completamente construida del mensaje.","type":"text"}]}]}]},{"type":"codeBlock","content":[{"text":" @Test\n @Title(\"GRPC - Consult account details\")\n public void getAccountDetailsTest() {\n AccountDetailsRequestDTO request = AccountDetailsRequestDTO\n .newBuilder()\n .setAccountNumber(dataProperties.getProperty(PropertiesConsts.MIRROR_STRATEGY_AUTOMATION_USER_1_ACCOUNT_NUMBER))\n .build();\n perform.performGRPCRequest(request, req -> blockingStub.getAccountDetails(req));\n validate.statusCodeIs(Status.Code.OK);\n validate.againstJsonSchema(JsonSchema.ACCOUNTS_DETAILS);\n validate.jsonNodeMatchesValue(Property.ACCOUNT_DATA_ACCOUNT_NUMBER, dataProperties.getProperty(PropertiesConsts.MIRROR_STRATEGY_AUTOMATION_USER_1_ACCOUNT_NUMBER));\n }","type":"text"}]},{"type":"paragraph","content":[{"text":"Envío de la solicitud GRPC","type":"text","marks":[{"type":"strong"}]},{"text":":","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Se realiza la solicitud GRPC usando el método ","type":"text"},{"text":"performGRPCRequest","type":"text","marks":[{"type":"code"}]},{"text":" de la clase ","type":"text"},{"text":"Perform","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Se le pasa la solicitud que se creó en el paso anterior.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Se utiliza una lambda ","type":"text"},{"text":"req -> blockingStub.getAccountDetails(req)","type":"text","marks":[{"type":"code"}]},{"text":" para especificar cómo debe realizarse la solicitud. Esto indica que hay una instancia de ","type":"text"},{"text":"blockingStub","type":"text","marks":[{"type":"code"}]},{"text":" que tiene un método ","type":"text"},{"text":"getAccountDetails","type":"text","marks":[{"type":"code"}]},{"text":" para realizar la acción deseada.","type":"text"}]}]}]},{"type":"panel","attrs":{"panelType":"note"},"content":[{"type":"paragraph","content":[{"text":"En este caso la expresión lambda se ocupa ya que en la clase Perform tenemos definido un método de interface funcional.","type":"text"}]},{"type":"paragraph","content":[{"text":"Al invocar ","type":"text"},{"text":"Perform.performGRPCRequest","type":"text","marks":[{"type":"code"}]},{"text":", se le pasan dos argumentos:","type":"text"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"El objeto ","type":"text"},{"text":"request","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Una expresión lambda: ","type":"text"},{"text":"req -> blockingStub.getAccountDetails(req)","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"Dentro de la definición del método ","type":"text"},{"text":"Perform.performGRPCRequest","type":"text","marks":[{"type":"code"}]},{"text":", la función tomará el primer argumento (","type":"text"},{"text":"request","type":"text","marks":[{"type":"code"}]},{"text":") y en algún punto, invocará la expresión lambda pasándole este argumento. En ese momento, ","type":"text"},{"text":"req","type":"text","marks":[{"type":"code"}]},{"text":" tomará el valor de ","type":"text"},{"text":"request","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]},{"type":"paragraph","content":[{"text":"Validación","type":"text","marks":[{"type":"strong"}]},{"text":":","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Se valida el estado de la respuesta utilizando el método ","type":"text"},{"text":"statusCodeIs","type":"text","marks":[{"type":"code"}]},{"text":" de la clase ","type":"text"},{"text":"Validate","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Se comprueba si el último código de estado (obtenido a través de ","type":"text"},{"text":"Perform.latestStatusCode","type":"text","marks":[{"type":"code"}]},{"text":") es \"OK\", lo que indica una respuesta exitosa.","type":"text"}]}]}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"paragraph","content":[{"text":"Al igual que en el proyecto de rest se definen los objetos de perform y validate en la clase ","type":"text"},{"text":"TestBase.java","type":"text","marks":[{"type":"code"}]}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"codeBlock","content":[{"text":"public abstract class TestBase extends TestConfig {\n\n @Steps\n protected static Perform perform;\n @Steps\n protected static Validate validate;\n}","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Envío del mensaje","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Perform.java","type":"text"}]},{"type":"paragraph","content":[{"text":"Esta clase define una forma estructurada de realizar llamadas a GRPC y manejar errores de manera uniforme.","type":"text"}]},{"type":"codeBlock","content":[{"text":" @FunctionalInterface\n public interface GRPCCall {\n Message execute(S request) throws StatusRuntimeException;\n }","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"@FunctionalInterface","type":"text","marks":[{"type":"code"}]},{"text":" es una anotación que indica que la interfaz tiene un método abstracto y puede servir como tipo objetivo para una expresión ","type":"text"},{"text":"lambda","type":"text","marks":[{"type":"em"}]},{"text":".","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"GRPCCall","type":"text","marks":[{"type":"code"}]},{"text":" es la interfaz funcional que define un método ","type":"text"},{"text":"execute","type":"text","marks":[{"type":"code"}]},{"text":", que toma un argumento S (la solicitud) y devuelve un objeto de tipo ","type":"text"},{"text":"Message","type":"text","marks":[{"type":"code"}]}]}]}]},{"type":"rule"},{"type":"codeBlock","content":[{"text":"public void performGRPCRequest(S request, GRPCCall call) {\n try {\n response = protobufToJson(call.execute(request));\n latestStatusCode = Status.Code.OK;\n } catch (StatusRuntimeException e) {\n ErrorInfo errorInfo = null;\n final com.google.rpc.Status status = StatusProto.fromThrowable(e);\n\n try {\n for (Any any : Objects.requireNonNull(status).getDetailsList()) {\n if (!any.is(ErrorInfo.class)) {\n continue;\n }\n errorInfo = any.unpack(ErrorInfo.class);\n }\n } catch (InvalidProtocolBufferException invalidProtocolBufferException) {\n logger.error(\"performGRPCRequest :: An error occurred while reading the properties.\");\n }\n\n JSONObject dataError = new JSONObject();\n\n if (errorInfo != null) {\n for (Map.Entry entry : errorInfo.getMetadataMap().entrySet()) {\n try {\n JSONObject fieldValue = new JSONObject(entry.getValue());\n dataError.put(entry.getKey(), fieldValue);\n } catch (JSONException jsonException) {\n try {\n JSONArray jsonArray = new JSONArray(entry.getValue());\n dataError.put(entry.getKey(), jsonArray);\n } catch (JSONException e2) {\n dataError.put(entry.getKey(), entry.getValue());\n }\n }\n }\n }\n\n response = dataError.toString(4);\n logger.error(\"Error: {}\", response);\n latestStatusCode = e.getStatus().getCode();\n }\n }","type":"text"}]},{"type":"paragraph","content":[{"text":"Este es el método principal que se usa en la clase de los tests. Su propósito principal es ejecutar una llamada gRPC usando la función (","type":"text"},{"text":"call","type":"text","marks":[{"type":"code"}]},{"text":") con la solicitud dada (","type":"text"},{"text":"request","type":"text","marks":[{"type":"code"}]},{"text":"), convierte la respuesta Protobuf a JSON y la guarda en ","type":"text"},{"text":"response","type":"text","marks":[{"type":"code"}]},{"text":", actualiza","type":"text"},{"text":"latestStatusCode","type":"text","marks":[{"type":"code"}]},{"text":" a \"OK\". ","type":"text"}]},{"type":"paragraph","content":[{"text":"Si se produce una excepción ","type":"text"},{"text":"StatusRuntimeException","type":"text","marks":[{"type":"code"}]},{"text":", el método extrae la información detallada del error usando ","type":"text"},{"text":"StatusProto.fromThrowable()","type":"text","marks":[{"type":"code"}]},{"text":" y ","type":"text"},{"text":"ErrorInfo","type":"text","marks":[{"type":"code"}]},{"text":". Luego, crea un objeto JSON (","type":"text"},{"text":"dataError","type":"text","marks":[{"type":"code"}]},{"text":") que contiene los metadatos de error y lo guarda en ","type":"text"},{"text":"response","type":"text","marks":[{"type":"code"}]},{"text":", además de registrar el error, actualiza ","type":"text"},{"text":"latestStatusCode","type":"text","marks":[{"type":"code"}]},{"text":" con el código de estado del error.","type":"text"}]},{"type":"panel","attrs":{"panelType":"note"},"content":[{"type":"paragraph","content":[{"text":"A través del método ","type":"text"},{"text":"protobufToJson","type":"text","marks":[{"type":"code"}]},{"text":" se hace una conversión del mensaje de la respuesta a un formato json que nos permite validar elementos de la respuesta como el json schema, o el valor de alguno de sus nodos.","type":"text"}]}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"paragraph","content":[{"text":"response","type":"text","marks":[{"type":"code"}]},{"text":" y ","type":"text"},{"text":"latestStatusCode","type":"text","marks":[{"type":"code"}]},{"text":" están definidos en la clase de TestConfig para que posteriormente puedan ser usados por las clases que extienden de TestConfig como Validate.","type":"text"}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Validaciones de la respuesta","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Validate.java","type":"text"}]},{"type":"paragraph","content":[{"text":"Contiene un conjunto de métodos para realizar diferentes tipos de validaciones en respuestas, obtenidas a través de llamadas gRPC. ","type":"text"}]},{"type":"codeBlock","content":[{"text":"public abstract class Validate extends TestConfig {\n\n @Step(\"Status Code is {0}\")\n public void statusCodeIs(Status.Code expectedCode) {\n Assert.assertEquals(expectedCode, latestStatusCode);\n }\n\n @Step(\"Validate json node {0} matches text {1}\")\n public void jsonNodeMatchesValue(String jsonNode, String expectedText) {\n String actualValue = JsonPath.read(response, \"$.\" + jsonNode);\n Assert.assertEquals(expectedText, actualValue);\n }\n\n @Step(\"Validate json Schema file {0} is correct\")\n public void againstJsonSchema(String jsonSchema) {\n try (InputStream schemaStream = Files.newInputStream(new File(jsonSchemasPath + jsonSchema + \".json\").toPath())) {\n JSONObject rawSchema = new JSONObject(new JSONTokener(schemaStream));\n Schema schema = SchemaLoader.load(rawSchema);\n schema.validate(new JSONObject(response));\n } catch (Exception e) {\n logger.error(\"Failed to validate the response against the schema.\", e);\n throw new RuntimeException(\"Failed to validate the response against the schema due to: \" + e.getMessage(), e);\n }\n }\n\n @Step(\"Validate json node {0} contains text {1}\")\n public void jsonNodeContainsText(String jsonNode, String expectedText) {\n String actualValue = JsonPath.read(response, \"$.\" + jsonNode);\n Assert.assertTrue(actualValue.contains(expectedText));\n }\n}","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Ejecución y resultados de las pruebas:","type":"text"}]},{"type":"panel","attrs":{"panelType":"warning"},"content":[{"type":"paragraph","content":[{"text":"Antes de ejecutar pruebas gRPC, es indispensable que las clases necesarias sean generadas a partir de los archivos Protocol Buffers (","type":"text"},{"text":".proto","type":"text","marks":[{"type":"code"}]},{"text":"). ","type":"text"}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"@WithTag","type":"text"}]},{"type":"paragraph","content":[{"text":"El uso del tag ","type":"text"},{"text":"WithTag","type":"text","marks":[{"type":"code"}]},{"text":" es una forma de categorizar y filtrar pruebas específicas que queremos ejecutar. ","type":"text"}]},{"type":"paragraph","content":[{"text":"La opción ","type":"text"},{"text":"-Ptags","type":"text","marks":[{"type":"code"}]},{"text":" del comando Gradle permite que sólo se ejecuten pruebas que coincidan con las etiquetas especificadas.","type":"text"}]},{"type":"codeBlock","content":[{"text":"@WithTag(\"Mirror-Strategy-Account-Aggregation-Service\")\npublic abstract class AccountAggregationServiceBase extends MirrorStrategyServiceBase {","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Comando de ejecución","type":"text"}]},{"type":"paragraph","content":[{"text":"Para realizar una ejecución de los scripts se usa el comando Gradle. ","type":"text"}]},{"type":"paragraph","content":[{"text":"Si se requiere ejecutar pruebas específicas, se pueden utilizar la etiqueta antes mencionada.","type":"text"}]},{"type":"paragraph","content":[{"text":"./gradlew test -Ptags=etiqueta-relacionada-con-grpc","type":"text","marks":[{"type":"code"}]}]},{"type":"mediaSingle","attrs":{"layout":"center"},"content":[{"type":"media","attrs":{"width":1418,"id":"e8aa7333-44d5-4c85-9d78-76f03add3745","collection":"contentId-2484961314","type":"file","height":961}}]},{"type":"paragraph"}],"version":1}

Browser not supported