Skip to content

Latest commit

 

History

History
246 lines (198 loc) · 17.9 KB

step-3-local-development-experience.md

File metadata and controls

246 lines (198 loc) · 17.9 KB
Raw

Step 3: Local development experience with Microcks

Our application uses Kafka and external dependencies.

At first, if you run the application from your terminal without integrating Microcks, you would see the following traces:

./mvnw clean quarkus:dev -Dquarkus.microcks.devservices.enabled=false

[INFO] Scanning for projects...
[INFO] 
[INFO] -----------------------< org.acme:order-service >-----------------------
[INFO] Building order-service 0.0.1-SNAPSHOT
[INFO]   from pom.xml
[INFO] --------------------------------[ jar ]---------------------------------
[INFO] 
[INFO] --- clean:3.2.0:clean (default-clean) @ order-service ---
[INFO] Deleting /Users/edeandre/workspaces/IntelliJ/microcks-quarkus-demo/target
[INFO] 
[INFO] --- quarkus:3.7.3:dev (default-cli) @ order-service ---
[INFO] Invoking resources:3.3.1:resources (default-resources) @ order-service
[INFO] Copying 5 resources from src/main/resources to target/classes
[INFO] Invoking quarkus:3.7.3:generate-code (default) @ order-service
[INFO] Invoking compiler:3.12.1:compile (default-compile) @ order-service
[INFO] Recompiling the module because of changed source code.
[INFO] Compiling 14 source files with javac [debug release 17] to target/classes
[INFO] Invoking resources:3.3.1:testResources (default-testResources) @ order-service
[INFO] Copying 5 resources from src/test/resources to target/test-classes
[INFO] Invoking quarkus:3.7.3:generate-code-tests (default) @ order-service
[INFO] Invoking compiler:3.12.1:testCompile (default-testCompile) @ order-service
[INFO] Recompiling the module because of changed dependency.
[INFO] Compiling 6 source files with javac [debug release 17] to target/test-classes
Listening for transport dt_socket at address: 5005
10:54:00,209 INFO  [io.git.mic.qua.dep.DevServicesMicrocksProcessor] (build-14) Not starting devservices for Microcks as it has been disabled in the config
10:54:00,294 INFO  [io.qua.sma.dep.processor] (build-56) Generating Jackson deserializer for type org.acme.order.service.model.OrderEvent
10:54:00,296 INFO  [io.qua.sma.dep.processor] (build-56) Generating Jackson serializer for type org.acme.order.service.model.OrderEvent
10:54:01,948 INFO  [io.qua.kaf.cli.dep.DevServicesKafkaProcessor] (build-13) Dev Services for Kafka started. Other Quarkus applications in dev mode will find the broker automatically. For Quarkus applications in production mode, you can connect to this by starting your application with -Dkafka.bootstrap.servers=OUTSIDE://localhost:55011
Microcks DevServices has been initialized
__  ____  __  _____   ___  __ ____  ______ 
 --/ __ \/ / / / _ | / _ \/ //_/ / / / __/ 
 -/ /_/ / /_/ / __ |/ , _/ ,< / /_/ /\ \   
--\___\_\____/_/ |_/_/|_/_/|_|\____/___/   
10:54:02,538 INFO  [io.sma.rea.mes.kafka] (Quarkus Main Thread) SRMSG18229: Configured topics for channel 'orders-reviewed': [OrderEventsAPI-0.1.0-orders-reviewed]
10:54:02,543 INFO  [io.sma.rea.mes.kafka] (Quarkus Main Thread) SRMSG18214: Key deserializer omitted, using String as default
10:54:02,695 INFO  [io.sma.rea.mes.kafka] (smallrye-kafka-producer-thread-0) SRMSG18258: Kafka producer kafka-producer-orders-created, connected to Kafka brokers 'OUTSIDE://localhost:55011', is configured to write records to 'orders-created'
10:54:02,715 INFO  [io.sma.rea.mes.kafka] (smallrye-kafka-consumer-thread-0) SRMSG18257: Kafka consumer kafka-consumer-orders-reviewed, connected to Kafka brokers 'OUTSIDE://localhost:55011', belongs to the 'order-service' consumer group and is configured to poll records from [OrderEventsAPI-0.1.0-orders-reviewed]
10:54:02,766 INFO  [io.quarkus] (Quarkus Main Thread) order-service 0.0.1-SNAPSHOT on JVM (powered by Quarkus 3.7.3) started in 3.244s. Listening on: http://localhost:8080
10:54:02,766 INFO  [io.quarkus] (Quarkus Main Thread) Profile dev activated. Live Coding activated.
10:54:02,766 INFO  [io.quarkus] (Quarkus Main Thread) Installed features: [cdi, kafka-client, microcks, rest-client-reactive, rest-client-reactive-jackson, resteasy-reactive, resteasy-reactive-jackson, smallrye-context-propagation, smallrye-reactive-messaging, smallrye-reactive-messaging-kafka, vertx]

--
Tests paused
Press [e] to edit command line args (currently ''), [r] to resume testing, [o] Toggle test output, [:] for the terminal, [h] for more options>

You can see that Dev Services for Kafka are started automatically because we included a Kafka client into our project dependencies. However, there's no such default Dev Services when using the Rest client to call our external Pastry API provider!

Just issue a simple API request using CURL or Postman or any of your favourite HTTP Client tools.

curl -v -X POST localhost:8080/api/orders -H 'Content-type: application/json' \
    -d '{"customerId": "lbroudoux", "productQuantities": [{"productName": "Eclair Cafe", "quantity": 1}], "totalPrice": 4.1}'

You should get a response similar to the following:

< HTTP/1.1 500 Internal Server Error
< content-length: 0
< 
* Connection #0 to host localhost left intact

and on the terminal where application is running, something like this:

ERROR [org.acm.ord.api.OrderResource] (executor-thread-1) Unexpected runtime exception: Error injecting org.acme.order.client.PastryAPIClient org.acme.order.service.OrderService.pastryRepository: java.lang.RuntimeException: Error injecting org.acme.order.client.PastryAPIClient org.acme.order.service.OrderService.pastryRepository
Caused by: java.lang.IllegalArgumentException: Unable to determine the proper baseUrl/baseUri. Consider registering using @RegisterRestClient(baseUri="someuri"), @RegisterRestClient(configKey="orkey"), or by adding 'quarkus.rest-client.pastries.url' or 'quarkus.rest-client.pastries.uri' to your Quarkus configuration

To run this application locally, we need Microcks Dev Services 🪄 to have our Pastry API mocked!

In order to see what's needed to run this, you may check the pom.xml and application.properties files.

Review pom.xml and application.properties

First, the quarkus-microcks dependency must be added to your project dependencies like illustrated below:

pom.xml:

<dependency>
  <groupId>io.github.microcks.quarkus</groupId>
  <artifactId>quarkus-microcks</artifactId>
  <version>${quarkus-microcks.version}</version>
  <scope>provided</scope>
</dependency>

The dependency scope can be set to provided as this dependency will only be used during development mode or unit tests. You don't need to package them into your application.

In order to wire the application to Microcks, we also need to update the application.properties file so that we specify to Microcks provided endpoints for both the Pastry API REST endpoint and the Kafka topic for receiving reviewed orders:

quarkus.rest-client.pastries.url=${quarkus.microcks.default.http}/rest/API+Pastries/0.0.1

mp.messaging.incoming.orders-reviewed.topic=OrderEventsAPI-0.1.0-orders-reviewed

Note

You'll notice that we use ${quarkus.microcks.default.http} expression to specify the dynamically assigned Microcks HTTP endpoint.

Application startup with Microcks DevServices

Now that we've got everything configured, we can start again the application. In the traces below, we only kept the significant parts related to Microcks DevServices usage:

./mvnw clean quarkus:dev 

[INFO] Scanning for projects...
[INFO] 
[INFO] -----------------------< org.acme:order-service >-----------------------
[INFO] Building order-service 0.0.1-SNAPSHOT
[INFO]   from pom.xml
[INFO] --------------------------------[ jar ]---------------------------------
[INFO] 
[INFO] --- clean:3.2.0:clean (default-clean) @ order-service ---
[INFO] Deleting /Users/edeandre/workspaces/IntelliJ/microcks-quarkus-demo/target
[INFO] 
[INFO] --- quarkus:3.7.3:dev (default-cli) @ order-service ---
[INFO] Invoking resources:3.3.1:resources (default-resources) @ order-service
[INFO] Copying 5 resources from src/main/resources to target/classes
[INFO] Invoking quarkus:3.7.3:generate-code (default) @ order-service
[INFO] Invoking compiler:3.12.1:compile (default-compile) @ order-service
[INFO] Recompiling the module because of changed source code.
[INFO] Compiling 14 source files with javac [debug release 17] to target/classes
[INFO] Invoking resources:3.3.1:testResources (default-testResources) @ order-service
[INFO] Copying 5 resources from src/test/resources to target/test-classes
[INFO] Invoking quarkus:3.7.3:generate-code-tests (default) @ order-service
[INFO] Invoking compiler:3.12.1:testCompile (default-testCompile) @ order-service
[INFO] Recompiling the module because of changed dependency.
[INFO] Compiling 6 source files with javac [debug release 17] to target/test-classes
Listening for transport dt_socket at address: 5005
11:04:03,995 INFO  [io.qua.sma.dep.processor] (build-41) Generating Jackson deserializer for type org.acme.order.service.model.OrderEvent
11:04:04,001 INFO  [io.qua.sma.dep.processor] (build-41) Generating Jackson serializer for type org.acme.order.service.model.OrderEvent
11:04:05,391 INFO  [io.qua.kaf.cli.dep.DevServicesKafkaProcessor] (build-62) Dev Services for Kafka started. Other Quarkus applications in dev mode will find the broker automatically. For Quarkus applications in production mode, you can connect to this by starting your application with -Dkafka.bootstrap.servers=PLAINTEXT://kafka-1sltj:29092,OUTSIDE://localhost:55014



--
11:04:09,825 INFO  [io.git.mic.qua.dep.DevServicesMicrocksProcessor] (build-38) The 'default' microcks container is ready on http://localhost:53309
11:04:09,827 INFO  [tc.qua.io/microcks/microcks-postman-runtime:latest] (build-7) Creating container for image: quay.io/microcks/microcks-postman-runtime:latest
11:04:09,892 INFO  [tc.qua.io/microcks/microcks-postman-runtime:latest] (build-7) Container quay.io/microcks/microcks-postman-runtime:latest is starting: d48404bba92e7f76443e15a092e8bfb33349e0e5643b49943d65d32a1e28c9bd
11:04:10,326 INFO  [tc.qua.io/microcks/microcks-postman-runtime:latest] (build-7) Container quay.io/microcks/microcks-postman-runtime:latest started in PT0.498652S
11:04:10,327 INFO  [tc.qua.io/microcks/microcks-uber-async-minion:latest] (build-7) Creating container for image: quay.io/microcks/microcks-uber-async-minion:latest
11:04:10,372 INFO  [tc.qua.io/microcks/microcks-uber-async-minion:latest] (build-7) Container quay.io/microcks/microcks-uber-async-minion:latest is starting: bab0670713355552a08eaf24b03b61f43222736e713c3b0e24e2779b179b7964
11:04:11,827 INFO  [tc.qua.io/microcks/microcks-uber-async-minion:latest] (build-7) Container quay.io/microcks/microcks-uber-async-minion:latest started in PT1.500188S
__  ____  __  _____   ___  __ ____  ______ 
 --/ __ \/ / / / _ | / _ \/ //_/ / / / __/ 
 -/ /_/ / /_/ / __ |/ , _/ ,< / /_/ /\ \   
--\___\_\____/_/ |_/_/|_/_/|_|\____/___/   
11:04:11,974 WARN  [io.qua.config] (Quarkus Main Thread) Unrecognized configuration key "quarkus.microcks.default.grpc.host" was provided; it will be ignored; verify that the dependency extension for this configuration is set or that you did not make a typo

11:04:11,974 WARN  [io.qua.config] (Quarkus Main Thread) Unrecognized configuration key "quarkus.microcks.default.grpc" was provided; it will be ignored; verify that the dependency extension for this configuration is set or that you did not make a typo
11:04:11,974 WARN  [io.qua.config] (Quarkus Main Thread) Unrecognized configuration key "quarkus.microcks.default.http" was provided; it will be ignored; verify that the dependency extension for this configuration is set or that you did not make a typo
11:04:11,975 WARN  [io.qua.config] (Quarkus Main Thread) Unrecognized configuration key "quarkus.microcks.default.http.host" was provided; it will be ignored; verify that the dependency extension for this configuration is set or that you did not make a typo
11:04:11,975 WARN  [io.qua.config] (Quarkus Main Thread) Unrecognized configuration key "quarkus.microcks.default.grpc.port" was provided; it will be ignored; verify that the dependency extension for this configuration is set or that you did not make a typo
11:04:11,975 WARN  [io.qua.config] (Quarkus Main Thread) Unrecognized configuration key "quarkus.microcks.default.http.port" was provided; it will be ignored; verify that the dependency extension for this configuration is set or that you did not make a typo
11:04:12,195 INFO  [io.sma.rea.mes.kafka] (Quarkus Main Thread) SRMSG18229: Configured topics for channel 'orders-reviewed': [OrderEventsAPI-0.1.0-orders-reviewed]
11:04:12,200 INFO  [io.sma.rea.mes.kafka] (Quarkus Main Thread) SRMSG18214: Key deserializer omitted, using String as default
11:04:12,416 WARN  [org.apa.kaf.cli.ClientUtils] (smallrye-kafka-consumer-thread-0) Couldn't resolve server PLAINTEXT://kafka-1sltj:29092 from bootstrap.servers as DNS resolution failed for kafka-1sltj
11:04:12,471 WARN  [org.apa.kaf.cli.ClientUtils] (smallrye-kafka-producer-thread-0) Couldn't resolve server PLAINTEXT://kafka-1sltj:29092 from bootstrap.servers as DNS resolution failed for kafka-1sltj
11:04:12,475 INFO  [io.sma.rea.mes.kafka] (smallrye-kafka-producer-thread-0) SRMSG18258: Kafka producer kafka-producer-orders-created, connected to Kafka brokers 'PLAINTEXT://kafka-1sltj:29092,OUTSIDE://localhost:55014', is configured to write records to 'orders-created'
11:04:12,494 INFO  [io.sma.rea.mes.kafka] (smallrye-kafka-consumer-thread-0) SRMSG18257: Kafka consumer kafka-consumer-orders-reviewed, connected to Kafka brokers 'PLAINTEXT://kafka-1sltj:29092,OUTSIDE://localhost:55014', belongs to the 'order-service' consumer group and is configured to poll records from [OrderEventsAPI-0.1.0-orders-reviewed]
Microcks DevServices has been initialized
11:04:12,541 INFO  [io.quarkus] (Quarkus Main Thread) order-service 0.0.1-SNAPSHOT on JVM (powered by Quarkus 3.7.3) started in 9.274s. Listening on: http://localhost:8080
11:04:12,542 INFO  [io.quarkus] (Quarkus Main Thread) Profile dev activated. Live Coding activated.
11:04:12,542 INFO  [io.quarkus] (Quarkus Main Thread) Installed features: [cdi, kafka-client, microcks, rest-client-reactive, rest-client-reactive-jackson, resteasy-reactive, resteasy-reactive-jackson, smallrye-context-propagation, smallrye-reactive-messaging, smallrye-reactive-messaging-kafka, vertx]
11:04:18,831 INFO  [io.sma.rea.mes.kafka] (vert.x-eventloop-thread-3) SRMSG18256: Initialize record store for topic-partition 'OrderEventsAPI-0.1.0-orders-reviewed-0' at position -1.
11:04:18,843 INFO  [org.acm.ord.ser.OrderEventListener] (vert.x-eventloop-thread-3) Receiving a reviewed order with id '123-456-789'
11:04:20,811 INFO  [org.acm.ord.ser.OrderEventListener] (vert.x-eventloop-thread-3) Receiving a reviewed order with id '123-456-789'
[...]

Let's understand why we got those messages at startup:

  • First, you can see that the DevServicesKafkaProcessor output is a bit different... This time we have a PLAINTEXT://kafka-1sltj:29092 endpoint and this one will be used by Microcks DevServices.
  • Second, you can see that the DevServicesMicrocksProcessor is starting a Microcks container that will be available at http://localhost:53309.
  • Then, you can see that this processor is also starting a some other containers like microcks-postman-runtime and microcks-uber-async-minion. This is not always the case and depends on your project configuration. Those services have been started here because we have Postman Collection files in our resources and because we have a Kafka broker running.
  • Just after the Quarkus logo, you can see that Microcks DevServices as also contributed a bunch of quarkus.microcks.* properties
  • Finally, after the application has started, you'll see messages about Receiving a reviewed order with id... that means that Microcks has started producing mock messages and the application is processing them.

And that's it! 🎉 You don't need to download and install extra-things, or clone other repositories and figure out how to start your dependant services.

You can get a visual confirmation that everything is running by accessing the Quarkus Dev Console.

Open a browser to http://localhost:8080/q/dev-ui, and click the Microcks UI link on the Microcks extension tile. You'll get access to the running Microcks container and will be able to check the discovered and loaded APIs:

Qarkus Dev Console

Now, you can invoke the APIs using CURL or Postman or any of your favourite HTTP Client tools.

Create an order

curl -v -X POST localhost:8080/api/orders -H 'Content-type: application/json' \
    -d '{"customerId": "lbroudoux", "productQuantities": [{"productName": "Millefeuille", "quantity": 1}], "totalPrice": 5.1}'

You should get a response similar to the following:

< HTTP/1.1 201 
< Content-Type: application/json;charset=UTF-8
< content-length: 172
< 
* Connection #0 to host localhost left intact
{"id":"0ddb2ad0-a74d-4b1c-84bc-f272349ef091","status":"CREATED","customerId":"lbroudoux","productQuantities":[{"productName":"Millefeuille","quantity":1}],"totalPrice":5.1}%

Now test with something else, requesting for another Pastry:

curl -v -X POST localhost:8080/api/orders -H 'Content-type: application/json' \
    -d '{"customerId": "lbroudoux", "productQuantities": [{"productName": "Eclair Chocolat", "quantity": 1}], "totalPrice": 4.1}' -v

This time you get another "exception" response:

< HTTP/1.1 422 Unprocessable Entity
< Content-Type: application/json;charset=UTF-8
< content-length: 85
< 
* Connection #0 to host localhost left intact
{"productName":"Eclair Chocolat","details":"Pastry Eclair Chocolat is not available"}%

and this is because Microcks has created different simulations for the Pastry API 3rd party API based on API artifacts we loaded.

Check the apipastries-openapi.yaml and apipastries-postman-collection.json files to get details.

Next