quarkusio/quarkus-workshops

Hosts Quarkus related workshops

Hosts Quarkus related workshops

• quarkus-workshop-super-heroes: workshop where you build several microservices interoperating through HTTP and Kafka. Instructions are available here.

Configuring a workshop

The entry page of the workshop accepts query parameters.

For example, https://quarkus.io/quarkus-workshops/super-heroes/index.html?native=false&ai=false&kubernetes=false&contract-testing=false&observability=false&extension=false&messaging=false&hideDefined=true will present a minimal workshop with no optional components, but allow people to select an operating system. The hideDefined=true locks and hides options which have been set in the url.

As another example, https://quarkus.io/quarkus-workshops/super-heroes/index.html?os=mac would preconfigure the operating system to MacOS, and show all options.

Continuous Build

Each push and pull requests is checked using GitHub Actions.

quarkus-workshops's Issues

Discuss how to address import ambiguity

In the REST module some imports are not obvious:

• HeroService

  • REQUIRED

• HeroResource

  • Logger
  • Response
  • PathParam

• HeroResourceTest

  • Random
  • CONTENT_TYPE
  • ACCEPT
  • HttpHeaders
  • assertEquals (method)
  • assertTrue (method)
  • assertNotNull (method)
  • get (method)
  • TypeRef

• HeroService (config):

  • ConfigProperty

• HeroREsource (OpenAPI):

  • Parameter
  • SchemaType

• HeroApplication:

  • Application (jax-rs one I think)

Cannot build angular UI due to super pom failure

$ui-super-heroes>
$ mvn install
[INFO] Scanning for projects...
Downloading from central: https://repo.maven.apache.org/maven2/io/quarkus/workshop/super-heroes/super-parent-pom/1.0/super-parent-pom-1.0.pom
[ERROR] [ERROR] Some problems were encountered while processing the POMs:
[FATAL] Non-resolvable parent POM for io.quarkus.workshop.super-heroes:ui-super-heroes:01: Could not find artifact io.quarkus.workshop.super-heroes:sup
er-parent-pom:pom:1.0 in central (https://repo.maven.apache.org/maven2) and 'parent.relativePath' points at wrong local POM @ line 22, column 13
 @
[ERROR] The build could not read 1 project -> [Help 1]
[ERROR]
[ERROR]   The project io.quarkus.workshop.super-heroes:ui-super-heroes:01 (/Users/emmanuel/Code/quarkus/demos/workshop/quarkus-workshop-super-heroes/su
per-heroes/ui-super-heroes/pom.xml) has 1 error
[ERROR]     Non-resolvable parent POM for io.quarkus.workshop.super-heroes:ui-super-heroes:01: Could not find artifact io.quarkus.workshop.super-heroes
:super-parent-pom:pom:1.0 in central (https://repo.maven.apache.org/maven2) and 'parent.relativePath' points at wrong local POM @ line 22, column 13 ->
 [Help 2]
[ERROR]
[ERROR] To see the full stack trace of the errors, re-run Maven with the -e switch.
[ERROR] Re-run Maven using the -X switch to enable full debug logging.
[ERROR]
[ERROR] For more information about the errors and possible solutions, please read the following articles:
[ERROR] [Help 1] http://cwiki.apache.org/confluence/display/MAVEN/ProjectBuildingException
[ERROR] [Help 2] http://cwiki.apache.org/confluence/display/MAVEN/UnresolvableModelException

Validate Messaging section

Package the UI as a standalone blob

Validate fault tolerance section

Question: should we add all the necessary extensions in the bootstrap for the villain ms

Today it does include no explicit extension and thus the lab rat has to figure out the extension list for himself based on the techno we use (panache , postgresql etc). Should we make that problem non existent by pre populating the extensions as part of the project creation or an explicit add-extension list?

Offer a base version of the Villain code to download as zip

Villain is pretty much the same as Hero so people learn nothing (they just increase their muscle memory. Since the lab is huge, I recommend we offer as an option (likely preferred) to fetch a zip with the state of Villain the way we want it

Add an "call to action" icon

Every time that the user must "do" something, an icon should be added. This visual sign should be visible enough so the user can scroll and find them pretty quickly.

Add the power to the Angular UI

Heroes and Villains should have the power displayed on the UI. ATM there is only the name and level:

fight-list.component should be refreshed after a fight

One we hit the "FIGHT ! button in the fight.component, the fight-list.component should be refreshed so the list of fights displays the latest fight

Implement the banner extension

Hero test fail after adding OpenAPI

Since in the preceding section we added a lwvel multiplier on persist, the test suite fails as it expect power level of 42 and 42*3 is returned.

Should we ask user to set back level to 1 at the end of the config section?

Use a single postgresql instance

Because 3 is too much for my machine.

Document how to change the test port

Add an configure Kafka to the docker-compose file

Be sure that test use a test database

Add introduction demos

The workshop should start with an introduction about Quarkus and a few demos.

This task is about adding the demos to the repository. The demo could reuse the "hero" microservice.

The demos should cover:

• project creation
• live reload
• REST
• optionally Panache
• Native compilation

Validate Observability section

Remove completely the Angular UI section

Prometheus can't acces to localhost on Linux ubuntu

Pour pouvoir le faire communiquer avec le host, sur le service prometheus j'ai ajouté le mode réseau : Host.

ex:
monitoring:
image: "prom/prometheus"
container_name: "super-visor"
network_mode: host
ports:
- 9090:9090

tag::adocVolumePrometheus[]

    volumes:
      - ./monitoring/prometheus.yml:/etc/prometheus/prometheus.yml

end::adocVolumePrometheus[]

Reference to the docker compose infrastructure directory does not work

The guide (rest-transaction-orm) has this

Go to https://raw.githubusercontent.com/quarkusio/quarkus-workshops/master/quarkus-workshop-super-heroes/super-heroes/infrastructure and download the entire code into the infrastructure directory.

This link does not work, you cannot point to a directory in GitHub raw mode. we need an alternative.

Fix the CSS so the cards are next to each other

The Fight component has two cards (one hero, one villain) that should be next to each other and in between, the two buttons ("New Fighters" and "Fight"). Instead, they are one below the other

Add a section about the "tracks"

After a common section the workshop is divided into tracks:

• observability
• event-driven and reactive
• fault-tolerance
• Quarkus extension

An introduction section should describe these and associate them with colors. A small list of the take-away for each track should be also written.

Remove hard coded version reference to testcontainer dependencies in the parent pom

This means updating the rest-transaction guide accordingly too

Add Heros and Vilain data

Insert data through import.sql

• Heros data at https://github.com/quarkusio/quarkus-workshops/tree/master/quarkus-workshop-super-heroes/exercise-99-final/hero-api/src/main/resources

• Vilains data at https://github.com/quarkusio/quarkus-workshops/tree/master/quarkus-workshop-super-heroes/exercise-99-final/vilain-api/src/main/resources

Cannot run Hero native IT

The guide says:
To see the NativeHeroResourceIT run against the native executable, use ./mvnw verify -Pnative:

But I get

INFO] -------------------------------------------------------
[INFO]  T E S T S
[INFO] -------------------------------------------------------
[INFO] Running io.quarkus.workshop.superheroes.hero.NativeHeroResourceIT
[ERROR] Tests run: 1, Failures: 0, Errors: 1, Skipped: 0, Time elapsed: 0.003 s <<< FAILURE! - in io.quarkus.workshop.superheroes.hero.NativeHeroResourceIT
[ERROR] io.quarkus.workshop.superheroes.hero.NativeHeroResourceIT  Time elapsed: 0.002 s  <<< ERROR!
org.junit.jupiter.engine.execution.ConditionEvaluationException: Failed to evaluate condition [org.testcontainers.junit.jupiter.TestcontainersExtension]: Illegal state: required test class is not present in the current ExtensionContext
Caused by: org.junit.platform.commons.PreconditionViolationException: Illegal state: required test class is not present in the current ExtensionContext

[INFO]
[INFO] Results:
[INFO]
[ERROR] Errors:
[ERROR]   NativeHeroResourceIT » ConditionEvaluation Failed to evaluate condition [org.t...
[INFO]
[ERROR] Tests run: 1, Failures: 0, Errors: 1, Skipped: 0

Make sure you don't stop in infra before the end of the workshop clearer

Right now it's rather unclear

Once all the containers are up and running, you can shut them down with the commands:

docker-compose -f docker-compose.yaml down
docker-compose -f docker-compose.yaml rm

Add another Quarkus instance just for the UI

Add a note about the light background and the log

Creating an invalid item should fail

At the moment, creating an invalid Hero or Villain works and it shouldn't. To test this behavior we have the HeroResourceTest class with a few test cases. The method shouldNotAddInvalidItem creates an invalid hero with a null name and a level of zero, does an HTTP POST and excepts a 400 (but it gets a 201):

    @Test
    void shouldNotAddInvalidItem() {
        Hero hero = new Hero();
        hero.name = null;
        hero.otherName = DEFAULT_OTHER_NAME;
        hero.picture = DEFAULT_PICTURE;
        hero.powers = DEFAULT_POWERS;
        hero.level = 0;

        given()
            .body(hero)
            .header(CONTENT_TYPE, APPLICATION_JSON)
            .header(ACCEPT, APPLICATION_JSON)
            .when()
            .post("/api/heroes")
            .then()
            .statusCode(BAD_REQUEST.getStatusCode());
    }

If you look at the Hero entity it has a @NotNull on name and @Min(1) on level:

@Entity
public class Hero extends PanacheEntity {

    @NotNull
    @Size(min = 3, max = 50)
    public String name;
    public String otherName;
    @NotNull
    @Min(1)
    public int level;

The HeroResource REST Endpoint has a create method that validates and invalid Hero (same for the service):

    @POST
    public Response create(@Valid Hero hero, @Context UriInfo uriInfo) {
        hero = service.createHero(hero);
        UriBuilder builder = uriInfo.getAbsolutePathBuilder().path(Long.toString(hero.id));
        LOGGER.debug("New hero created with URI " + builder.build().toString());
        return Response.created(builder.build()).build();
    }

At the moment the shouldNotAddInvalidItem succeeds but it should fail.

Same for Villain

Improve profile section to show some usages

We can improve the profile section easily by adding some profile settings

• change the log level for prod
• change the power level multiplier for test
• discuss that it's also useful for database and point to the Quarkus doc

The first two would be code examples (part of application.properties).

Validate microservice section

Get rid of @RegisterForReflection on the entities for 0.25 version

Don't know how to mock external services

To get two random fighters, the FightService.getRandomFighters() invokes two external microservices: the HeroService and the VillainService:

@ApplicationScoped
@Transactional(SUPPORTS)
public class FightService {

    @Inject
    @RestClient
    HeroService heroService;

    @Inject
    @RestClient
    VillainService villainService;

    public Fighters getRandomFighters() {
        Hero hero = heroService.findRandomHero();
        Villain villain = villainService.findRandomVillain();
        Fighters fighters = new Fighters();
        fighters.setHero(hero);
        fighters.setVillain(villain);
        return fighters;
    }

These services are registered as REST client:

@Path("/api/villains")
@Produces(MediaType.APPLICATION_JSON)
@RegisterRestClient
public interface HeroService {

    @GET
    @Path("/random")
    Hero findRandomHero();
}

To test the getRandomFighters method we need to mock the HeroService and the VillainService. This is done as follow using the @Mock annotation:

@Mock
@ApplicationScoped
public class MockHeroService implements HeroService {

    @Override
    public Hero findRandomHero() {
        Hero hero = new Hero();
        hero.setName(DEFAULT_HERO_NAME);
        hero.setPicture(DEFAULT_HERO_PICTURE);
        hero.setPowers(DEFAULT_HERO_POWERS);
        hero.setLevel(DEFAULT_HERO_LEVEL);
        return hero;
    }
}

But when executing the tests, we get:

org.junit.jupiter.api.extension.TestInstantiationException: TestInstanceFactory [io.quarkus.test.junit.QuarkusTestExtension] failed to instantiate test class [io.quarkus.workshop.superheroes.fight.FightResourceTest]: io.quarkus.builder.BuildException: Build failure: Build failed due to errors
	[error]: Build step io.quarkus.arc.deployment.ArcProcessor#validate threw an exception: javax.enterprise.inject.spi.DeploymentException: Found 2 deployment problems: 
[1] Unsatisfied dependency for type io.quarkus.workshop.superheroes.fight.client.HeroService and qualifiers [@RestClient]
	- java member: io.quarkus.workshop.superheroes.fight.FightService#heroService
	- declared on CLASS bean [types=[java.lang.Object, io.quarkus.workshop.superheroes.fight.FightService], qualifiers=[@Default, @Any], target=io.quarkus.workshop.superheroes.fight.FightService]
[2] Unsatisfied dependency for type io.quarkus.workshop.superheroes.fight.client.VillainService and qualifiers [@RestClient]
	- java member: io.quarkus.workshop.superheroes.fight.FightService#villainService
	- declared on CLASS bean [types=[java.lang.Object, io.quarkus.workshop.superheroes.fight.FightService], qualifiers=[@Default, @Any], target=io.quarkus.workshop.superheroes.fight.FightService]

Validate Extension section

Implement statistic logic and UI

Add and document prometheus

Make the hero API fail once in a while to demonstrate fault-tolerance

Write the conclusion

Change the landing page banner colors to be distinctive

Document how to configure prometheus on linux

ip -a
Find docker0
copy ip

something like 172.something

Jumping "frontend" does not go to the right link

It goes to install instead of running.

Write cloud chapter

:-(

Get rid of RegisterForReflection

Looks like we need to add RegisterForReflection on Entities for Native Builds but this shouldn't be mandatory in the coming releases of Quarkus

Use MP FT in the fight service

Get rid of quarkus-resteasy for 0.24.0

quarkus-vertx-http should be enough for ui-super-heroes:

        <dependency>
            <groupId>io.quarkus</groupId>
            <artifactId>quarkus-vertx-http</artifactId>
        </dependency>

We should be able to get rid of:

        <dependency>
            <groupId>io.quarkus</groupId>
            <artifactId>quarkus-resteasy</artifactId>
        </dependency>

IT uses the wrong profile

IT runs un the default profile at the moment instead of the test profile. It's an issue in Quarkus.

Ensure the current projects works in native mode

Write a fault injector extension

To make #10 easy

From Maven property in "from java to native" section

It uses the wrong quarkus version property.