Page Comparison

Introducción

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.

Configuración del entorno

    testImplementation 'io.grpc:grpc-testing:1.41.0'
    testImplementation group: 'com.google.protobuf', name: 'protobuf-java', version:'3.23.2'
    implementation 'io.grpc:grpc-stub:1.53.0'
    implementation 'io.grpc:grpc-api:1.53.0'
    implementation 'io.grpc:protoc-gen-grpc-java:1.53.0'
    implementation 'io.grpc:grpc-core:1.53.0'
    implementation 'io.grpc:grpc-netty-shaded:1.53.0'
    implementation 'com.google.api.grpc:proto-google-common-protos:2.14.1'
    implementation 'javax.annotation:javax.annotation-api:1.3.2'
    implementation 'io.grpc:grpc-protobuf:1.55.1'

Archivos .proto

En gRPC, los servicios y los mensajes que se envían entre el cliente y el servidor se definen en archivos .proto, 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.

ejemplo:

Image Added

Stubs

Un "stub" en gRPC es un término utilizado para referirse se refiere al cliente de un servicio gRPC que se conecta a un servidor. Es esencialmente una pieza de código generada generado a partir del archivo .proto que un cliente puede usar para invocar métodos 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.

Generar los stubs (archivos Java) a partir del archivo .proto:

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 .proto, utilizando el compilador de Protocol Buffers (protobuf-protoc).

apply 
plugin
'com.google.protobuf'

protobuf {
    protoc {
        artifact = 'com.google.protobuf:protoc:3.23.2'
    }
    plugins{
        grpc{
            artifact = 'io.grpc:protoc-gen-grpc-java:1.53.0'
        }
    }
    generateProtoTasks {
        all()*.plugins {
            grpc{
            }
        }
    }

}

Para que el plugin compile los archivos .proto se ejecuta el comando gradle build y se generen generan los archivos Java necesarios.

Los stubs serán generados automáticamente en el directorio build/generated/source/proto/main/grpc.

Tipos de Stubs en gRPC

Después de generar el código del cliente y del servidor, se implementan los stubs en los script de prueba.

Creación del tipo de Stub

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.

Para seleccionar el tipo de stub, se deben usar los métodos correspondientes de la clase generada automáticamente a partir del .proto.

Por ejemplo, si el servicio se llama AccountAggregationService, gRPC generará una clase AccountAggregationServiceGrpc que contiene métodos: newBlockingStub, newFutureStub, y newStub que se pueden usar para crear los distintos tipos de stubs.

A continuación se especifica como se crea un stub de gRPC bloqueante para la interfaz AccountAggregationService. Esto es esencialmente un cliente que se usará para hacer llamadas al servicio.

AccountAggregationServiceGrpc.AccountAggregationServiceBlockingStub = AccountAggregationServiceGrpc.newBlockingStub();

Implementación de Clases Base

ServiceBase.java

ServiceBase.java es una clase abstracta genérica que proporciona una la estructura básica para la creación de servicios y utiliza 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.

Esta clase administra un ManagedChannel y un AbstractStub (referenciado genéricamente como T). El ManagedChannel es el medio principal de comunicación entre el cliente y el servidor en gRPC, y el AbstractStub es una representación genérica de un servicio gRPC en el lado del cliente.

ServiceBase se ocupa de la creación y cierre del ManagedChannel, pero delega la creación del AbstractStub a las subclases a través del método abstracto buildStub. El método buildStub se llama después de que se ha creado el ManagedChannel, en el método setup, para que las subclases puedan utilizar el canal para construir su stub.

AccountAggregationServiceBase.java

AccountAggregationServiceBase es una subclase concreta de ServiceBase que proporciona una implementación específica del método buildStub. Esta clase representa un servicio de agregación de cuentas y utiliza el stub de bloqueo específico para este servicio, AccountAggregationServiceGrpc.AccountAggregationServiceBlockingStub.

Por lo tanto, AccountAggregationServiceBase se beneficia de la gestión del ManagedChannel proporcionada por ServiceBase, y solo necesita preocuparse por la creación del stub correcto para su servicio específico.

• Al iniciar una prueba, la clase se conecta a un servicio usando una dirección URL (url).

• Una vez establecida la conexión, crea un "stub" o punto de conexión para comunicarse con el servicio.

• Al finalizar una prueba, cierra la conexión.

public abstract class ServiceBase<T extends AbstractStub<T>> extends TestBase

🛠️ La razón principal para hacer la clase abstracta es que contiene un método abstracto (buildStub) que las clases hijas deben implementar obligatoriamente.

🔗 T es un tipo genérico. La clase está diseñada para trabajar con cualquier tipo T que extienda (o sea un subtipo de) AbstractStub<T>.

protected abstract T buildStub(ManagedChannel channel);

buildStubtiene 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.

Al ser T es un tipo que extiende de AbstractStub<T>. El método buildStub devolverá un objeto de tipo T, que será una especie de AbstractStub.

(ManagedChannel channel): El método recibirá un parámetro llamado channel de tipo ManagedChannel El cual representa una conexión a un servidor gRPC.

@Before
    public void setup() {
        channel = ManagedChannelBuilder.forTarget(url)
                .usePlaintext()
                .intercept(new LoggingClientInterceptor(url))
                .build();
        blockingStub = buildStub(channel);
    }
@After
public void tearDown() throws Exception {
    if (channel != null) {
        channel.shutdownNow().awaitTermination(5, TimeUnit.SECONDS);
    }
}

Estos métodos se utilizan para configurar y limpiar recursos antes y después de cada prueba individual.

🚀 setup():

1. Crea un canal gRPC para comunicarse con un servicio remoto a la url que será proporcionada por la clase que herede de ServiceBase.

2. Añade un interceptor de registro. (Para imprimir en el log: Calling URL, Calling method, Sending message y Received response)

3. Construye un "stub" bloqueante utilizando el canal recién creado.

🧹 tearDown():

1. Verifica si el canal existe.

2. Si existe, cierra el canal inmediatamente y espera hasta 5 segundos para que se cierre completamente.

AccountAggregationServiceBase.java

public abstract class AccountAggregationServiceBase extends MirrorStrategyServiceBase<AccountAggregationServiceGrpc.AccountAggregationServiceBlockingStub> {

Esta clase es específico está parametrizada con AccountAggregationServiceGrpc.AccountAggregationServiceBlockingStub para el tipo genérico T.

Es decir, MirrorStrategyServiceBase trabaja específicamente con el "stub bloqueante" del servicio AccountAggregationServiceGrpc.

public AccountAggregationServiceBase() {
        setUrl(baseMirrorStrategyADDRESS);
    }

Cuando se crea una instancia de esta clase, automáticamente se establece su URL al valor de baseMirrorStrategyADDRESS usando el método setUrl.

@Override
    protected AccountAggregationServiceGrpc.AccountAggregationServiceBlockingStub buildStub(ManagedChannel channel) {
        return AccountAggregationServiceGrpc.newBlockingStub(channel);
    }

El tag @Override indica que ese método está sobrescribiendo al método de la clase en ServiceBase. Aquí ya se está proporcionando una implementación específica del método buildStub, recibe el canal creado para posteriormente crear un objeto stub bloqueante con el canal obtenido y lo devuelve de tipo AccountAggregationServiceGrpc.AccountAggregationServiceBlockingStub esto ya permitirá hacer las llamadas a procedimientos remotos en el @Before de la clase ServiceBase.

Construcción Test Cases

ServiceDetailsPositiveTests.java

Esta clase es un ejemplo de una clase de prueba para un servicio es especifico y hereda de MirrorStrategyServiceBase.

@Test
@Title
("GRPC - Consult account details")

En esencia, esta clase está estructurada de la misma forma que en los test del proyecto de REST.

Contiene las notaciones de método de prueba y de la descripción del caso (@Tesy y @Title)

Construcción de la solicitud:

• Se crea un objeto request de tipo AccountDetailsRequestDTO (generado por el compilador de Protocol Buffers-protoc).

• Después se usa el método newBuilder() para iniciar la construcción del mensaje.

• La función setAccountNumber() establece el número de cuenta obtenido de dataProperties

• Finalmente, build() completa y devuelve una instancia completamente construida del mensaje.

    @Test
    @Title("GRPC - Consult account details")
    public void getAccountDetailsTest() {
        AccountDetailsRequestDTO request = AccountDetailsRequestDTO
                .newBuilder()
                .setAccountNumber(dataProperties.getProperty(PropertiesConsts.MIRROR_STRATEGY_AUTOMATION_USER_1_ACCOUNT_NUMBER))
                .build();
        perform.performGRPCRequest(request, req -> blockingStub.getAccountDetails(req));
        validate.statusCodeIs(Status.Code.OK);
        validate.againstJsonSchema(JsonSchema.ACCOUNTS_DETAILS);
        validate.jsonNodeMatchesValue(Property.ACCOUNT_DATA_ACCOUNT_NUMBER, dataProperties.getProperty(PropertiesConsts.MIRROR_STRATEGY_AUTOMATION_USER_1_ACCOUNT_NUMBER));
    }

Envío de la solicitud GRPC:

• Se realiza la solicitud GRPC usando el método performGRPCRequest de la clase Perform.

• Se le pasa la solicitud que se creó en el paso anterior.

• Se utiliza una lambda req -> blockingStub.getAccountDetails(req) para especificar cómo debe realizarse la solicitud. Esto indica que hay una instancia de blockingStub que tiene un método getAccountDetails para realizar la acción deseada.

Validación:

• Se valida el estado de la respuesta utilizando el método statusCodeIs de la clase Validate.

• Se comprueba si el último código de estado (obtenido a través de Perform.latestStatusCode) es "OK", lo que indica una respuesta exitosa.

Envío del mensaje

Perform.java

Esta clase define una forma estructurada de realizar llamadas a GRPC y manejar errores de manera uniforme.

    @FunctionalInterface
    public interface GRPCCall<S> {
        Message execute(S request) throws StatusRuntimeException;
    }

• @FunctionalInterface es una anotación que indica que la interfaz tiene un método abstracto y puede servir como tipo objetivo para una expresión lambda.

• GRPCCall<S> es la interfaz funcional que define un método execute, que toma un argumento S (la solicitud) y devuelve un objeto de tipo Message

public <S> void performGRPCRequest(S request, GRPCCall<S> call) {
        try {
            response = protobufToJson(call.execute(request));
            latestStatusCode = Status.Code.OK;
        } catch (StatusRuntimeException e) {
            ErrorInfo errorInfo = null;
            final com.google.rpc.Status status = StatusProto.fromThrowable(e);

            try {
                for (Any any : Objects.requireNonNull(status).getDetailsList()) {
                    if (!any.is(ErrorInfo.class)) {
                        continue;
                    }
                    errorInfo = any.unpack(ErrorInfo.class);
                }
            } catch (InvalidProtocolBufferException invalidProtocolBufferException) {
                logger.error("performGRPCRequest :: An error occurred while reading the properties.");
            }

            JSONObject dataError = new JSONObject();

            if (errorInfo != null) {
                for (Map.Entry<String, String> entry : errorInfo.getMetadataMap().entrySet()) {
                    try {
                        JSONObject fieldValue = new JSONObject(entry.getValue());
                        dataError.put(entry.getKey(), fieldValue);
                    } catch (JSONException jsonException) {
                        try {
                            JSONArray jsonArray = new JSONArray(entry.getValue());
                            dataError.put(entry.getKey(), jsonArray);
                        } catch (JSONException e2) {
                            dataError.put(entry.getKey(), entry.getValue());
                        }
                    }
                }
            }

            response = dataError.toString(4);
            logger.error("Error: {}", response);
            latestStatusCode = e.getStatus().getCode();
        }
    }

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 (call) con la solicitud dada (request), convierte la respuesta Protobuf a JSON y la guarda en response, actualizalatestStatusCode a "OK".

Si se produce una excepción StatusRuntimeException, el método extrae la información detallada del error usando StatusProto.fromThrowable() y ErrorInfo. Luego, crea un objeto JSON (dataError) que contiene los metadatos de error y lo guarda en response, además de registrar el error, actualiza latestStatusCode con el código de estado del error.

Validaciones de la respuesta

Validate.java

Contiene un conjunto de métodos para realizar diferentes tipos de validaciones en respuestas, obtenidas a través de llamadas gRPC.

public abstract class Validate extends TestConfig {

    @Step("Status Code is {0}")
    public void statusCodeIs(Status.Code expectedCode) {
        Assert.assertEquals(expectedCode, latestStatusCode);
    }

    @Step("Validate json node {0} matches text {1}")
    public void jsonNodeMatchesValue(String jsonNode, String expectedText) {
        String actualValue = JsonPath.read(response, "$." + jsonNode);
        Assert.assertEquals(expectedText, actualValue);
    }

    @Step("Validate json Schema file {0} is correct")
    public void againstJsonSchema(String jsonSchema) {
        try (InputStream schemaStream = Files.newInputStream(new File(jsonSchemasPath + jsonSchema + ".json").toPath())) {
            JSONObject rawSchema = new JSONObject(new JSONTokener(schemaStream));
            Schema schema = SchemaLoader.load(rawSchema);
            schema.validate(new JSONObject(response));
        } catch (Exception e) {
            logger.error("Failed to validate the response against the schema.", e);
            throw new RuntimeException("Failed to validate the response against the schema due to: " + e.getMessage(), e);
        }
    }

    @Step("Validate json node {0} contains text {1}")
    public void jsonNodeContainsText(String jsonNode, String expectedText) {
        String actualValue = JsonPath.read(response, "$." + jsonNode);
        Assert.assertTrue(actualValue.contains(expectedText));
    }
}

Ejecución y resultados de las pruebas:

@WithTag

El uso del tag WithTag es una forma de categorizar y filtrar pruebas específicas que queremos ejecutar.

La opción -Ptags del comando Gradle permite que sólo se ejecuten pruebas que coincidan con las etiquetas especificadas.

@WithTag("Mirror-Strategy-Account-Aggregation-Service")
public abstract class AccountAggregationServiceBase extends MirrorStrategyServiceBase<AccountAggregationServiceGrpc.AccountAggregationServiceBlockingStub> {

Comando de ejecución

Para realizar una ejecución de los scripts se usa el comando Gradle.

Si se requiere ejecutar pruebas específicas, se pueden utilizar la etiqueta antes mencionada.

./gradlew test -Ptags=etiqueta-relacionada-con-grpc

Image Added