Containerizing microservices

duration 20 minutes

Prerequisites:

Learn how to containerize and run your microservices with Open Liberty using Docker.

What you’ll learn

You can easily deploy your microservices in different environments in a lightweight and portable manner by using containers. From development to production and across your DevOps environments, you can deploy your microservices consistently and efficiently with containers. You can run a container from a container image. Each container image is a package of what you need to run your microservice or application, from the code to its dependencies and configuration.

You’ll learn how to build container images and run containers using Docker for your microservices. You’ll learn about the Open Liberty container images and how to use them for your containerized applications. You’ll construct Dockerfile files, create Docker images by using the docker build command, and run the image as Docker containers by using docker run command.

The two microservices that you’ll be working with are called system and inventory. The system microservice returns the JVM system properties of the running container. The inventory microservice adds the properties from the system microservice to the inventory. This guide demonstrates how both microservices can run and communicate with each other in different Docker containers.

Additional prerequisites

Before you begin, Docker needs to be installed. For installation instructions, refer to the official Docker documentation. You will build and run the microservices in Docker containers.

Make sure to start your Docker daemon before you proceed.

Getting started

The fastest way to work through this guide is to clone the Git repository and use the projects that are provided inside:

git clone https://github.com/openliberty/guide-containerize.git
cd guide-containerize

The start directory contains the starting project that you will build upon.

The finish directory contains the finished project that you will build.

Before you begin, make sure you have all the necessary prerequisites.

Packaging your microservices

Navigate to the start directory to begin.

You can find the starting Java project in the start directory. This project is a multi-module Maven project that is made up of the system and inventory microservices. Each microservice is located in its own corresponding directory, system and inventory.

To try out the microservices by using Maven, run the following Maven goal to build the system microservice and run it inside Open Liberty:

mvn -pl system liberty:run

Open another command-line session and run the following Maven goal to build the inventory microservice and run it inside Open Liberty:

mvn -pl inventory liberty:run

After you see the following message in both command-line sessions, both of your services are ready:

The defaultServer server is ready to run a smarter planet.

To access the inventory service, which displays the current contents of the inventory, see http://localhost:9081/inventory/systems.

To access the system service, which shows the system properties of the running JVM, see http://localhost:9080/system/properties.

You can add the system properties of your localhost to the inventory service at http://localhost:9081/inventory/systems/localhost.

After you are finished checking out the microservices, stop the Open Liberty servers by pressing CTRL+C in the command-line sessions where you ran the servers. Alternatively, you can run the liberty:stop goal in another command-line session:

mvn -pl system liberty:stop
mvn -pl inventory liberty:stop

To package your microservices, run the Maven package goal to build the application .war files from the start directory so that the .war files are in the system/target and inventory/target directories.

mvn package

To learn more about RESTful web services and how to build them, see Creating a RESTful web service for details about how to build the system service. The inventory service is built in a similar way.

Building your Docker images

A Docker image is a binary file. It is made up of multiple layers and is used to run code in a Docker container. Images are built from instructions in Dockerfiles to create a containerized version of the application.

A Dockerfile is a collection of instructions for building a Docker image that can then be run as a container. As each instruction is run in a Dockerfile, a new Docker layer is created. These layers, which are known as intermediate images, are created when a change is made to your Docker image.

Every Dockerfile begins with a parent or base image over which various commands are run. For example, you can start your image from scratch and run commands that download and install a Java runtime, or you can start from an image that already contains a Java installation.

Learn more about Docker on the official Docker page.

Creating your Dockerfiles

You will be creating two Docker images to run the inventory service and system service. The first step is to create Dockerfiles for both services.

In this guide, you’re using an official image from the IBM Container Registry (ICR), icr.io/appcafe/open-liberty:full-java11-openj9-ubi, as your parent image. This image is tagged with the word full, meaning it includes all Liberty features. full images are recommended for development only because they significantly expand the image size with features that are not required by the application.

To minimize your image footprint in production, you can use one of the kernel-slim images, such as icr.io/appcafe/open-liberty:kernel-slim-java11-openj9-ubi. This image installs the basic server. You can then add all the necessary features for your application with the usage pattern that is detailed in the Open Liberty container image documentation. To use the default image that comes with the Open Liberty runtime, define the FROM instruction as FROM icr.io/appcafe/open-liberty. You can find all official images on the Open Liberty container image repository.

Create the Dockerfile for the inventory service.
inventory/Dockerfile

inventory/Dockerfile

 1# tag::from[]
 2FROM icr.io/appcafe/open-liberty:full-java11-openj9-ubi
 3# end::from[]
 4
 5ARG VERSION=1.0
 6ARG REVISION=SNAPSHOT
 7
 8# tag::label[]
 9LABEL \
10  org.opencontainers.image.authors="Your Name" \
11  org.opencontainers.image.vendor="Open Liberty" \
12  org.opencontainers.image.url="local" \
13  org.opencontainers.image.source="https://github.com/OpenLiberty/guide-containerize" \
14  org.opencontainers.image.version="$VERSION" \
15  org.opencontainers.image.revision="$REVISION" \
16  vendor="Open Liberty" \
17  name="inventory" \
18  version="$VERSION-$REVISION" \
19  summary="The inventory microservice from the Containerizing microservices guide" \
20  description="This image contains the inventory microservice running with the Open Liberty runtime."
21# end::label[]
22
23# tag::copy-config[]
24# tag::config-userID[]
25COPY --chown=1001:0 \
26# end::config-userID[]
27    # tag::inventory-config[]
28    src/main/liberty/config \
29    # end::inventory-config[]
30    # tag::config[]
31    /config/
32    # end::config[]
33# end::copy-config[]
34
35# tag::copy-war[]
36# tag::war-userID[]
37COPY --chown=1001:0 \
38# end::war-userID[]
39    # tag::inventory-war[]
40    target/guide-containerize-inventory.war \
41    # end::inventory-war[]
42    # tag::config-apps[]
43    /config/apps
44    # end::config-apps[]
45# end::copy-war[]
46
47# tag::configure-sh[]
48RUN configure.sh
49# end::configure-sh[]

The FROM instruction initializes a new build stage, which indicates the parent image of the built image. If you don’t need a parent image, then you can use FROM scratch, which makes your image a base image.

It is also recommended to label your Docker images with the LABEL command, as the label information can help you manage your images. For more information, see Best practices for writing Dockerfiles.

The COPY instructions are structured as COPY [--chown=<user>:<group>] <source> <destination>. They copy local files into the specified destination within your Docker image. In this case, the inventory server configuration files that are located at src/main/liberty/config are copied to the /config/ destination directory. The inventory application WAR file inventory.war, which was created from running mvn package, is copied to the /config/apps destination directory.

The COPY instructions use the 1001 user ID and 0 group because the icr.io/appcafe/open-liberty:full-java11-openj9-ubi image runs by default with the USER 1001 (non-root) user for security purposes. Otherwise, the files and directories that are copied over are owned by the root user.

Place the RUN configure.sh command at the end to get a pre-warmed Docker image. It improves the startup time of running your Docker container.

The Dockerfile for the system service follows the same instructions as the inventory service, except that some labels are updated, and the system.war archive is copied into /config/apps.

Create the Dockerfile for the system service.
system/Dockerfile

system/Dockerfile

 1FROM icr.io/appcafe/open-liberty:full-java11-openj9-ubi
 2
 3ARG VERSION=1.0
 4ARG REVISION=SNAPSHOT
 5
 6LABEL \
 7  org.opencontainers.image.authors="Your Name" \
 8  org.opencontainers.image.vendor="Open Liberty" \
 9  org.opencontainers.image.url="local" \
10  org.opencontainers.image.source="https://github.com/OpenLiberty/guide-containerize" \
11  org.opencontainers.image.version="$VERSION" \
12  org.opencontainers.image.revision="$REVISION" \
13  vendor="Open Liberty" \
14# tag::name[]
15  name="system" \
16# end::name[]
17  version="$VERSION-$REVISION" \
18# tag::summary[]
19  summary="The system microservice from the Containerizing microservices guide" \
20  description="This image contains the system microservice running with the Open Liberty runtime."
21# end::summary[]
22
23COPY --chown=1001:0 src/main/liberty/config /config/
24
25# tag::copy-war[]
26COPY --chown=1001:0 target/guide-containerize-system.war /config/apps
27# end::copy-war[]
28
29RUN configure.sh

Building your Docker image

Now that your microservices are packaged and you have written your Dockerfiles, you will build your Docker images by using the docker build command.

Run the following command to download or update to the latest Open Liberty Docker image:

docker pull icr.io/appcafe/open-liberty:full-java11-openj9-ubi

Run the following commands to build container images for your application:

docker build -t system:1.0-SNAPSHOT system/.
docker build -t inventory:1.0-SNAPSHOT inventory/.

The -t flag in the docker build command allows the Docker image to be labeled (tagged) in the name[:tag] format. The tag for an image describes the specific image version. If the optional [:tag] tag is not specified, the latest tag is created by default.

To verify that the images are built, run the docker images command to list all local Docker images:

docker images

Or, run the docker images command with --filter option to list your images:

docker images -f "label=org.opencontainers.image.authors=Your Name"

Your inventory and system images appear in the list of all Docker images:

REPOSITORY    TAG             IMAGE ID        CREATED          SIZE
inventory     1.0-SNAPSHOT    08fef024e986    4 minutes ago    1GB
system        1.0-SNAPSHOT    1dff6d0b4f31    5 minutes ago    977MB

Running your microservices in Docker containers

Now that your two images are built, you will run your microservices in Docker containers:

docker run -d --name system -p 9080:9080 system:1.0-SNAPSHOT
docker run -d --name inventory -p 9081:9081 inventory:1.0-SNAPSHOT

The following table describes the flags in these commands:

Flag Description

-d

Runs the container in the background.

--name

Specifies a name for the container.

-p

Maps the host ports to the container ports. For example: -p <HOST_PORT>:<CONTAINER_PORT>

Next, run the docker ps command to verify that your containers are started:

docker ps

Make sure that your containers are running and show Up as their status:

CONTAINER ID    IMAGE                   COMMAND                  CREATED          STATUS          PORTS                                        NAMES
2b584282e0f5    inventory:1.0-SNAPSHOT  "/opt/ol/helpers/run…"   2 seconds ago    Up 1 second     9080/tcp, 9443/tcp, 0.0.0.0:9081->9081/tcp   inventory
99a98313705f    system:1.0-SNAPSHOT     "/opt/ol/helpers/run…"   3 seconds ago    Up 2 seconds    0.0.0.0:9080->9080/tcp, 9443/tcp             system

If a problem occurs and your containers exit prematurely, the containers don’t appear in the container list that the docker ps command displays. Instead, your containers appear with an Exited status when they run the docker ps -a command. Run the docker logs system and docker logs inventory commands to view the container logs for any potential problems. Run the docker stats system and docker stats inventory commands to display a live stream of usage statistics for your containers. You can also double-check that your Dockerfiles are correct. When you find the cause of the issues, remove the faulty containers with the docker rm system and docker rm inventory commands. Rebuild your images, and start the containers again.

To access the application, go to the http://localhost:9081/inventory/systems URL. An empty list is expected because no system properties are stored in the inventory yet.

Next, retrieve the system container’s IP address by running the following:

docker inspect -f "{{.NetworkSettings.IPAddress }}" system

The command returns the system container IP address:

172.17.0.2

In this case, the IP address for the system service is 172.17.0.2. Take note of this IP address to construct the URL to view the system properties.

Go to the http://localhost:9081/inventory/systems/[system-ip-address] URL by replacing [system-ip-address] with the IP address that you obtained earlier. You see a result in JSON format with the system properties of your local JVM. When you go to this URL, these system properties are automatically stored in the inventory. Go back to the http://localhost:9081/inventory/systems URL and you see a new entry for [system-ip-address].

Externalizing server configuration

inventory/server.xml

 1<server description="Sample Liberty server">
 2
 3  <featureManager>
 4    <feature>restfulWS-3.0</feature>
 5    <feature>jsonb-2.0</feature>
 6    <feature>jsonp-2.0</feature>
 7    <feature>cdi-3.0</feature>
 8    <feature>mpConfig-3.0</feature>
 9  </featureManager>
10
11  <!-- tag::httpPort[] -->
12  <variable name="default.http.port" defaultValue="9081" />
13  <!-- end::httpPort[] -->
14  <variable name="default.https.port" defaultValue="9444" />
15
16  <!-- tag::httpEndpoint[] -->
17  <httpEndpoint httpPort="${default.http.port}" httpsPort="${default.https.port}"
18      id="defaultHttpEndpoint" host="*" />
19  <!-- end::httpEndpoint[] -->
20
21  <webApplication location="guide-containerize-inventory.war" contextRoot="/">
22
23  </webApplication>
24
25</server>

As mentioned at the beginning of this guide, one of the advantages of using containers is that they are portable and can be moved and deployed efficiently across all of your DevOps environments. Configuration often changes across different environments, and by externalizing your server configuration, you can simplify the development process.

Imagine a scenario where you are developing an Open Liberty application on port 9081 but to deploy it to production, it must be available on port 9091. To manage this scenario, you can keep two different versions of the server.xml file; one for production and one for development. However, trying to maintain two different versions of a file might lead to mistakes. A better solution would be to externalize the configuration of the port number and use the value of an environment variable that is stored in each environment.

In this example, you will use an environment variable to externally configure the HTTP port number of the inventory service.

In the inventory/server.xml file, the default.http.port variable is declared and is used in the httpEndpoint element to define the service endpoint. The default value of the default.http.port variable is 9081. However, this value is only used if no other value is specified. You can replace this value in the container by using the -e flag for the podman run command.

Run the following commands to stop and remove the inventory container and rerun it with the default.http.port environment variable set:

docker stop inventory
docker rm inventory
docker run -d --name inventory -e default.http.port=9091 -p 9091:9091 inventory:1.0-SNAPSHOT

The -e flag can be used to create and set the values of environment variables in a Docker container. In this case, you are setting the default.http.port environment variable to 9091 for the inventory container.

Now, when the service is starting up, Open Liberty finds the default.http.port environment variable and uses it to set the value of the default.http.port variable to be used in the HTTP endpoint.

The inventory service is now available on the new port number that you specified. You can see the contents of the inventory at the http://localhost:9091/inventory/systems URL. You can add your local system properties at http://localhost:9091/inventory/systems/[system-ip-address] by replacing [system-ip-address] with the IP address that you obtained in the previous section. The system service remains unchanged and is available at the http://localhost:9080/system/properties URL.

You can externalize the configuration of more than just the port numbers. To learn more about Open Liberty server configuration, check out the Server Configuration Overview docs.

Optimizing the image size

As mentioned previously, the parent image that is used in each Dockerfile contains the full tag, which includes all of the Liberty features. This parent image with the full tag is recommended for development, but while deploying to production it is recommended to use a parent image with the kernel-slim tag. The kernel-slim tag provides a bare minimum server with the ability to add the features required by the application.

Replace the Dockerfile for the inventory service.
inventory/Dockerfile

inventory/Dockerfile

 1# tag::kernel-slim[]
 2FROM icr.io/appcafe/open-liberty:kernel-slim-java11-openj9-ubi
 3# end::kernel-slim[]
 4
 5ARG VERSION=1.0
 6ARG REVISION=SNAPSHOT
 7
 8# tag::label[]
 9LABEL \
10  org.opencontainers.image.authors="Your Name" \
11  org.opencontainers.image.vendor="Open Liberty" \
12  org.opencontainers.image.url="local" \
13  org.opencontainers.image.source="https://github.com/OpenLiberty/guide-containerize" \
14  org.opencontainers.image.version="$VERSION" \
15  org.opencontainers.image.revision="$REVISION" \
16  vendor="Open Liberty" \
17  name="inventory" \
18  version="$VERSION-$REVISION" \
19  summary="The inventory microservice from the Containerizing microservices guide" \
20  description="This image contains the inventory microservice running with the Open Liberty runtime."
21# end::label[]
22
23# tag::copy-config[]
24# tag::config-userID[]
25COPY --chown=1001:0 \
26# end::config-userID[]
27    # tag::inventory-config[]
28    src/main/liberty/config \
29    # end::inventory-config[]
30    # tag::config[]
31    /config/
32    # end::config[]
33# end::copy-config[]
34
35# tag::features[]
36RUN features.sh
37# end::features[]
38
39# tag::copy-war[]
40# tag::war-userID[]
41COPY --chown=1001:0 \
42# end::war-userID[]
43    # tag::inventory-war[]
44    target/guide-containerize-inventory.war \
45    # end::inventory-war[]
46    # tag::config-apps[]
47    /config/apps
48    # end::config-apps[]
49# end::copy-war[]
50
51# tag::configure-sh[]
52RUN configure.sh
53# end::configure-sh[]

Replace the parent image with icr.io/appcafe/open-liberty:kernel-slim-java11-openj9-ubi at the top of your Dockerfile. This image contains the kernel-slim tag that is recommended when deploying to production.

Place RUN features.sh command after the COPY command that copies the local /config/ directory into the Docker image. The features.sh script adds the Liberty features that your application is required to operate.

Ensure that you repeat these instructions for the system service.

Replace the Dockerfile for the system service.
system/Dockerfile

system/Dockerfile

 1# tag::kernel-slim[]
 2FROM icr.io/appcafe/open-liberty:kernel-slim-java11-openj9-ubi
 3# end::kernel-slim[]
 4
 5ARG VERSION=1.0
 6ARG REVISION=SNAPSHOT
 7
 8LABEL \
 9  org.opencontainers.image.authors="Your Name" \
10  org.opencontainers.image.vendor="Open Liberty" \
11  org.opencontainers.image.url="local" \
12  org.opencontainers.image.source="https://github.com/OpenLiberty/guide-containerize" \
13  org.opencontainers.image.version="$VERSION" \
14  org.opencontainers.image.revision="$REVISION" \
15  vendor="Open Liberty" \
16# tag::name[]
17  name="system" \
18# end::name[]
19  version="$VERSION-$REVISION" \
20# tag::summary[]
21  summary="The system microservice from the Containerizing microservices guide" \
22  description="This image contains the system microservice running with the Open Liberty runtime."
23# end::summary[]
24
25COPY --chown=1001:0 src/main/liberty/config /config/
26
27# tag::features[]
28RUN features.sh
29# end::features[]
30
31# tag::copy-war[]
32COPY --chown=1001:0 target/guide-containerize-system.war /config/apps
33# end::copy-war[]
34
35RUN configure.sh

Continue by running the following commands to stop and remove your current Docker containers that are using the full parent image:

docker stop inventory system
docker rm inventory system

Next, build your new Docker images with the kernel-slim parent image:

docker build -t system:1.0-SNAPSHOT system/.
docker build -t inventory:1.0-SNAPSHOT inventory/.

Verify that the images have been built by executing the following command to list all the local Docker images:

docker images

Notice that the images for the inventory and system services now have a reduced image size.

REPOSITORY      TAG             IMAGE ID        CREATED         SIZE
inventory       1.0-SNAPSHOT	d5a3d1b2c20e    4 minutes ago	682MB
system          1.0-SNAPSHOT	6346cf87eae0	5 minutes ago	694MB

After confirming that the images have been built, run the following commands to start the Docker containers:

docker run -d --name system -p 9080:9080 system:1.0-SNAPSHOT
docker run -d --name inventory -p 9081:9081 inventory:1.0-SNAPSHOT

Once your Docker containers are running, run the following command to see the list of required features installed by features.sh:

docker exec -it inventory /opt/ol/wlp/bin/productInfo featureInfo

Your list of Liberty features should be similar to the following:

jndi-1.0
servlet-5.0
cdi-3.0
concurrent-2.0
jsonb-2.0
jsonp-2.0
mpConfig-3.0
restfulWS-3.0
restfulWSClient-3.0

To ensure that your containers are working properly, try accessing the system service to show the system properties of the running JVM. See http://localhost:9080/system/properties

Next, replace [system-ip-address] with the IP address that you obtained earlier and add your localhost system properties to the inventory service by visiting: http://localhost:9081/inventory/systems/[system-ip-address]

Then, verify the addition of your localhost system properties to your inventory service. See http://localhost:9081/inventory/systems

Testing the microservices

You can test your microservices manually by hitting the endpoints or with automated tests that check your running Docker containers.

Create the SystemEndpointIT class.
system/src/test/java/it/io/openliberty/guides/system/SystemEndpointIT.java

SystemEndpointIT.java

 1// tag::copyright[]
 2/*******************************************************************************
 3 * Copyright (c) 2018, 2022 IBM Corporation and others.
 4 * All rights reserved. This program and the accompanying materials
 5 * are made available under the terms of the Eclipse Public License v1.0
 6 * which accompanies this distribution, and is available at
 7 * http://www.eclipse.org/legal/epl-v10.html
 8 *
 9 * Contributors:
10 *     IBM Corporation - Initial implementation
11 *******************************************************************************/
12// end::copyright[]
13package it.io.openliberty.guides.system;
14
15import static org.junit.jupiter.api.Assertions.assertEquals;
16
17import javax.net.ssl.HostnameVerifier;
18import javax.net.ssl.SSLSession;
19import jakarta.ws.rs.client.Client;
20import jakarta.ws.rs.client.ClientBuilder;
21import jakarta.ws.rs.client.WebTarget;
22import jakarta.ws.rs.core.Response;
23
24import org.junit.jupiter.api.AfterEach;
25import org.junit.jupiter.api.BeforeAll;
26import org.junit.jupiter.api.BeforeEach;
27import org.junit.jupiter.api.Test;
28
29public class SystemEndpointIT {
30
31    private static String clusterUrl;
32
33    private Client client;
34
35    @BeforeAll
36    public static void oneTimeSetup() {
37        String nodePort = System.getProperty("system.http.port");
38        clusterUrl = "http://localhost:" + nodePort + "/system/properties/";
39    }
40
41    @BeforeEach
42    public void setup() {
43        client = ClientBuilder.newBuilder()
44                    .hostnameVerifier(new HostnameVerifier() {
45                        public boolean verify(String hostname, SSLSession session) {
46                            return true;
47                        }
48                    })
49                    .build();
50    }
51
52    @AfterEach
53    public void teardown() {
54        client.close();
55    }
56
57    // tag::testGetProperties[]
58    @Test
59    public void testGetProperties() {
60        Client client = ClientBuilder.newClient();
61
62        WebTarget target = client.target(clusterUrl);
63        Response response = target.request().get();
64
65        assertEquals(200, response.getStatus(),
66            "Incorrect response code from " + clusterUrl);
67        response.close();
68    }
69    // end::testGetProperties[]
70
71}

The testGetProperties() method checks for a 200 response code from the system service endpoint.

Create the InventoryEndpointIT class.
inventory/src/test/java/it/io/openliberty/guides/inventory/InventoryEndpointIT.java

InventoryEndpointIT.java

  1// tag::copyright[]
  2/*******************************************************************************
  3 * Copyright (c) 2018, 2022 IBM Corporation and others.
  4 * All rights reserved. This program and the accompanying materials
  5 * are made available under the terms of the Eclipse Public License v1.0
  6 * which accompanies this distribution, and is available at
  7 * http://www.eclipse.org/legal/epl-v10.html
  8 *
  9 * Contributors:
 10 *     IBM Corporation - Initial implementation
 11 *******************************************************************************/
 12// end::copyright[]
 13package it.io.openliberty.guides.inventory;
 14
 15import static org.junit.jupiter.api.Assertions.assertEquals;
 16import static org.junit.jupiter.api.Assertions.assertTrue;
 17
 18import jakarta.json.JsonObject;
 19import javax.net.ssl.HostnameVerifier;
 20import javax.net.ssl.SSLSession;
 21import jakarta.ws.rs.client.Client;
 22import jakarta.ws.rs.client.ClientBuilder;
 23import jakarta.ws.rs.core.MediaType;
 24import jakarta.ws.rs.core.Response;
 25
 26import org.junit.jupiter.api.AfterAll;
 27import org.junit.jupiter.api.BeforeAll;
 28import org.junit.jupiter.api.MethodOrderer.OrderAnnotation;
 29import org.junit.jupiter.api.Order;
 30import org.junit.jupiter.api.Test;
 31import org.junit.jupiter.api.TestMethodOrder;
 32
 33@TestMethodOrder(OrderAnnotation.class)
 34public class InventoryEndpointIT {
 35
 36    private static String invUrl;
 37    private static String sysUrl;
 38    private static String systemServiceIp;
 39
 40    private static Client client;
 41
 42    @BeforeAll
 43    public static void oneTimeSetup() {
 44
 45        String invServPort = System.getProperty("inventory.http.port");
 46        String sysServPort = System.getProperty("system.http.port");
 47
 48        // tag::systemServiceIp[]
 49        systemServiceIp = System.getProperty("system.ip");
 50        // end::systemServiceIp[]
 51
 52        invUrl = "http://localhost" + ":" + invServPort + "/inventory/systems/";
 53        sysUrl = "http://localhost" + ":" + sysServPort + "/system/properties/";
 54
 55        client = ClientBuilder.newBuilder().hostnameVerifier(new HostnameVerifier() {
 56            public boolean verify(String hostname, SSLSession session) {
 57                return true;
 58            }
 59        }).build();
 60
 61        client.target(invUrl + "reset").request().post(null);
 62    }
 63
 64    @AfterAll
 65    public static void teardown() {
 66        client.close();
 67    }
 68
 69    // tag::tests[]
 70    // tag::testEmptyInventory[]
 71    @Test
 72    @Order(1)
 73    public void testEmptyInventory() {
 74        Response response = this.getResponse(invUrl);
 75        this.assertResponse(invUrl, response);
 76
 77        JsonObject obj = response.readEntity(JsonObject.class);
 78
 79        int expected = 0;
 80        int actual = obj.getInt("total");
 81        assertEquals(expected, actual,
 82                    "The inventory should be empty on application start but it wasn't");
 83
 84        response.close();
 85    }
 86    // end::testEmptyInventory[]
 87
 88    // tag::testHostRegistration[]
 89    @Test
 90    @Order(2)
 91    public void testHostRegistration() {
 92        this.visitSystemService();
 93
 94        Response response = this.getResponse(invUrl);
 95        this.assertResponse(invUrl, response);
 96
 97        JsonObject obj = response.readEntity(JsonObject.class);
 98
 99        int expected = 1;
100        int actual = obj.getInt("total");
101        assertEquals(expected, actual,
102                        "The inventory should have one entry for " + systemServiceIp);
103
104        boolean serviceExists = obj.getJsonArray("systems").getJsonObject(0)
105                        .get("hostname").toString().contains(systemServiceIp);
106        assertTrue(serviceExists,
107                        "A host was registered, but it was not " + systemServiceIp);
108
109        response.close();
110    }
111    // end::testHostRegistration[]
112
113    // tag::testSystemPropertiesMatch[]
114    @Test
115    @Order(3)
116    public void testSystemPropertiesMatch() {
117        Response invResponse = this.getResponse(invUrl);
118        Response sysResponse = this.getResponse(sysUrl);
119
120        this.assertResponse(invUrl, invResponse);
121        this.assertResponse(sysUrl, sysResponse);
122
123        JsonObject jsonFromInventory = (JsonObject) invResponse
124                        .readEntity(JsonObject.class).getJsonArray("systems")
125                        .getJsonObject(0).get("properties");
126
127        JsonObject jsonFromSystem = sysResponse.readEntity(JsonObject.class);
128
129        String osNameFromInventory = jsonFromInventory.getString("os.name");
130        String osNameFromSystem = jsonFromSystem.getString("os.name");
131        this.assertProperty("os.name", systemServiceIp, osNameFromSystem,
132                        osNameFromInventory);
133
134        String userNameFromInventory = jsonFromInventory.getString("user.name");
135        String userNameFromSystem = jsonFromSystem.getString("user.name");
136        this.assertProperty("user.name", systemServiceIp, userNameFromSystem,
137                        userNameFromInventory);
138
139        invResponse.close();
140        sysResponse.close();
141    }
142    // end::testSystemPropertiesMatch[]
143
144    // tag::testUnknownHost[]
145    @Test
146    @Order(4)
147    public void testUnknownHost() {
148        Response response = this.getResponse(invUrl);
149        this.assertResponse(invUrl, response);
150
151        Response badResponse = client.target(invUrl + "badhostname")
152                        .request(MediaType.APPLICATION_JSON).get();
153
154        String obj = badResponse.readEntity(String.class);
155
156        boolean isError = obj.contains("error");
157        assertTrue(isError,
158                        "badhostname is not a valid host but it didn't raise an error");
159
160        response.close();
161        badResponse.close();
162    }
163    // end::testUnknownHost[]
164    // end::tests[]
165
166    // Returns response information from the specified URL.
167    private Response getResponse(String url) {
168        return client.target(url).request().get();
169    }
170
171
172    // Asserts that the given URL has the correct response code of 200.
173    private void assertResponse(String url, Response response) {
174        assertEquals(200, response.getStatus(), "Incorrect response code from " + url);
175    }
176
177    // Asserts that the specified JVM system property is equivalent in both the
178    // system and inventory services.
179    private void assertProperty(String propertyName, String hostname, String expected,
180                    String actual) {
181        assertEquals(expected, actual, "JVM system property [" + propertyName + "] "
182                        + "in the system service does not match the one stored in "
183                        + "the inventory service for " + hostname);
184    }
185
186    // Makes a simple GET request to inventory/localhost.
187    private void visitSystemService() {
188        Response response = this.getResponse(sysUrl);
189        this.assertResponse(sysUrl, response);
190        response.close();
191
192        Response targetResponse = client.target(invUrl + systemServiceIp).request()
193                        .get();
194
195        targetResponse.close();
196    }
197}

  • The testEmptyInventory() method checks that the inventory service has a total of 0 systems before anything is added to it.

  • The testHostRegistration() method checks that the system service was added to inventory properly.

  • The testSystemPropertiesMatch() checks that the system properties match what was added into the inventory service.

  • The testUnknownHost() method checks that an error is raised if an unknown host name is being added into the inventory service.

  • The systemServiceIp variable has the same value as the IP address that you retrieved in the previous section when you manually added the system service into the inventory service. This value of the IP address is passed in when you run the tests.

Running the tests

Run the Maven package goal to compile the test classes. Run the Maven failsafe goal to test the services that are running in the Docker containers by replacing the [system-ip-address] with the IP address that you determined previously.

mvn package
mvn failsafe:integration-test -Dsystem.ip=[system-ip-address] -Dinventory.http.port=9081 -Dsystem.http.port=9080

If the tests pass, you see output similar to the following example:

-------------------------------------------------------
 T E S T S
-------------------------------------------------------
Running it.io.openliberty.guides.system.SystemEndpointIT
Tests run: 1, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 0.653 s - in it.io.openliberty.guides.system.SystemEndpointIT

Results:

Tests run: 1, Failures: 0, Errors: 0, Skipped: 0

-------------------------------------------------------
 T E S T S
-------------------------------------------------------
Running it.io.openliberty.guides.inventory.InventoryEndpointIT
Tests run: 4, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 0.935 s - in it.io.openliberty.guides.inventory.InventoryEndpointIT

Results:

Tests run: 4, Failures: 0, Errors: 0, Skipped: 0

When you are finished with the services, run the following commands to stop and remove your containers:

docker stop inventory system
docker rm inventory system

Great work! You’re done!

You have just built Docker images and run two microservices on Open Liberty in containers.

Guide Attribution

Containerizing microservices by Open Liberty is licensed under CC BY-ND 4.0

Copied to clipboard
Copy code block
Copy file contents

Prerequisites:

Nice work! Where to next?

What did you think of this guide?

Extreme Dislike Dislike Like Extreme Like

What could make this guide better?

Raise an issue to share feedback

Create a pull request to contribute to this guide

Need help?

Ask a question on Stack Overflow

Like Open Liberty? Star our repo on GitHub.

Star