Skip to content

Latest commit

 

History

History
100 lines (78 loc) · 3.42 KB

README.md

File metadata and controls

100 lines (78 loc) · 3.42 KB
Raw

Quarkus Mars Rover gRPC Service

This service returns a list of Mars Rover names over gRPC. The protobuf file used to define this request and response is as follows:

syntax = "proto3";

package rovers;

service MarsRoverGrpc  {
  rpc rovers (MarsRoverRequest) returns (MarsRoverResponse) {}
}

message MarsRoverRequest {}

message MarsRoverResponse {
  repeated MarsRover rovers = 1;
}

message MarsRover {
  int32 id = 1;
  string name = 2;
}

A list of rover names will be returned along with a corresponding index:

{
  "rovers": [
    {
      "name": "Spirit"
    },
    {
      "id": 1,
      "name": "Opportunity"
    },
    {
      "id": 2,
      "name": "Curiosity"
    },
    {
      "id": 3,
      "name": "Perseverance"
    },
    {
      "id": 4,
      "name": "Sojourner"
    }
  ]
}

It is designed to be consumed using the mars rover cli-grpc to output those names to the command line. These two applications combined show how gRPC services can be mocked using WireMock and the WireMock gRPC Extension

If you are new to mocking with WireMock, a good place to start is the Stubbing section of the documentation and then move onto the Request Matching and Response Templating sections. There are also lots of examples of gRPC mocking in the WireMock gRPC Demos Project

WireMock Cloud

WireMock Cloud is a managed, hosted version of WireMock, developed by the same team who wrote the open-source project. It's built on the same technology that powers open source WireMock and is 100% compatible with the WireMock API, with additional features that make it quick and easy to mock any API you depend on. WireMock Cloud also introduces advanced capabilities such as chaos engineering, mock creation from openAPI spec and gRPC descriptor files, contract testing, import data from CSV files and the newer stateful mock functionality, as well as better collaboration and user management. WireMock Cloud has a free forever plan so take a look and see how WireMock Cloud can fit into your SDLC.

Quarkus

This project uses Quarkus, the Supersonic Subatomic Java Framework.

If you want to learn more about Quarkus, please visit its website: https://quarkus.io/ .

Running the application in dev mode

You can run your application in dev mode that enables live coding using:

./gradlew quarkusDev

NOTE: Quarkus now ships with a Dev UI, which is available in dev mode only at http://localhost:8080/q/dev/.

Making Requests

You can find a collection of requests in the form of a JetBrains http file in the src/test folder. This will allow you to make gRPC requests and see the responses returned. An alternative to the http file is gpcurl:

grpcurl -plaintext localhost:9000 list
grpcurl -plaintext localhost:9000 rovers.MarsRoverGrpc/rovers