Configuring microservices

 1// tag::copyright[]
 2/*******************************************************************************
 3 * Copyright (c) 2017, 2019 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 2.0
 6 * which accompanies this distribution, and is available at
 7 * http://www.eclipse.org/legal/epl-2.0/
 8 *
 9 * SPDX-License-Identifier: EPL-2.0
10 *******************************************************************************/
11// end::copyright[]
12
13package io.openliberty.guides.config;
14
15// tag::email[]
16public class Email {
17  private String name;
18  private String domain;
19
20  public Email(String value) {
21    String[] components = value.split("@");
22    if (components.length == 2) {
23      name = components[0];
24      domain = components[1];
25    }
26  }
27
28  public String getEmailName() {
29    return name;
30  }
31
32  public String getEmailDomain() {
33    return domain;
34  }
35
36  public String toString() {
37    return name + "@" + domain;
38  }
39}
40// end::email[]

 1// tag::copyright[]
 2/*******************************************************************************
 3 * Copyright (c) 2017, 2023 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 2.0
 6 * which accompanies this distribution, and is available at
 7 * http://www.eclipse.org/legal/epl-2.0/
 8 *
 9 * SPDX-License-Identifier: EPL-2.0
10 *******************************************************************************/
11// end::copyright[]
12package io.openliberty.guides.config;
13
14import org.eclipse.microprofile.config.spi.Converter;
15
16// tag::customConfig[]
17public class CustomEmailConverter implements Converter<Email> {
18
19  @Override
20  public Email convert(String value) {
21    return new Email(value);
22  }
23
24}
25// end::customConfig[]

 1// tag::copyright[]
 2/*******************************************************************************
 3 * Copyright (c) 2017, 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 2.0
 6 * which accompanies this distribution, and is available at
 7 * http://www.eclipse.org/legal/epl-2.0/
 8 *
 9 * SPDX-License-Identifier: EPL-2.0
10 *******************************************************************************/
11// end::copyright[]
12// tag::config-class[]
13package io.openliberty.guides.inventory;
14
15import jakarta.enterprise.context.RequestScoped;
16import jakarta.inject.Inject;
17import jakarta.inject.Provider;
18import org.eclipse.microprofile.config.inject.ConfigProperty;
19import io.openliberty.guides.config.Email;
20
21@RequestScoped
22public class InventoryConfig {
23
24  // tag::port-number[]
25  // tag::inject-port-number[]
26  @Inject
27  // end::inject-port-number[]
28  // tag::guides-port-number[]
29  @ConfigProperty(name = "io_openliberty_guides_port_number")
30  // end::guides-port-number[]
31  private int portNumber;
32
33  // end::port-number[]
34  // tag::build-in-converter[]
35  // tag::inject-inMaintenance[]
36  // tag::inject[]
37  @Inject
38  // end::inject[]
39  // tag::configPropety[]
40  @ConfigProperty(name = "io_openliberty_guides_inventory_inMaintenance")
41  // end::configPropety[]
42  // end::inject-inMaintenance[]
43  private Provider<Boolean> inMaintenance;
44
45  // end::build-in-converter[]
46  // tag::custom-converter[]
47  @Inject
48  @ConfigProperty(name = "io_openliberty_guides_email")
49  private Provider<Email> email;
50  // end::custom-converter[]
51
52  // tag::getPortNumber[]
53  public int getPortNumber() {
54    return portNumber;
55  }
56  // end::getPortNumber[]
57
58  // tag::isInMaintenance[]
59  public boolean isInMaintenance() {
60    // tag::inMaintenanceGet[]
61    return inMaintenance.get();
62    // end::inMaintenanceGet[]
63  }
64  // end::isInMaintenance[]
65
66  // tag::getEmail[]
67  public Email getEmail() {
68    return email.get();
69  }
70  // end::getEmail[]
71}
72// end::config-class[]

 1// tag::copyright[]
 2/*******************************************************************************
 3 * Copyright (c) 2017, 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 2.0
 6 * which accompanies this distribution, and is available at
 7 * http://www.eclipse.org/legal/epl-2.0/
 8 *
 9 * SPDX-License-Identifier: EPL-2.0
10 *******************************************************************************/
11// end::copyright[]
12// tag::config-methods[]
13package io.openliberty.guides.inventory;
14
15import java.util.Properties;
16
17// CDI
18import jakarta.enterprise.context.RequestScoped;
19import jakarta.inject.Inject;
20import jakarta.ws.rs.GET;
21import jakarta.ws.rs.Path;
22import jakarta.ws.rs.PathParam;
23import jakarta.ws.rs.Produces;
24import jakarta.ws.rs.core.MediaType;
25import jakarta.ws.rs.core.Response;
26
27
28
29@RequestScoped
30@Path("systems")
31public class InventoryResource {
32
33  @Inject
34  InventoryManager manager;
35
36  // tag::config-injection[]
37  @Inject
38  InventoryConfig inventoryConfig;
39  // end::config-injection[]
40
41  @GET
42  @Path("{hostname}")
43  @Produces(MediaType.APPLICATION_JSON)
44  public Response getPropertiesForHost(@PathParam("hostname") String hostname) {
45
46    if (!inventoryConfig.isInMaintenance()) {
47      // tag::config-port[]
48      Properties props = manager.get(hostname, inventoryConfig.getPortNumber());
49      // end::config-port[]
50      if (props == null) {
51        return Response.status(Response.Status.NOT_FOUND)
52                       .entity("{ \"error\" : \"Unknown hostname or the system service "
53                       + "may not be running on " + hostname + "\" }")
54                       .build();
55      }
56
57      // Add to inventory
58      manager.add(hostname, props);
59      return Response.ok(props).build();
60    } else {
61      // tag::email[]
62      return Response.status(Response.Status.SERVICE_UNAVAILABLE)
63                     .entity("{ \"error\" : \"Service is currently in maintenance. "
64                     + "Contact: " + inventoryConfig.getEmail().toString() + "\" }")
65                     .build();
66      // end::email[]
67    }
68  }
69
70  @GET
71  @Produces(MediaType.APPLICATION_JSON)
72  public Response listContents() {
73    // tag::isInMaintenance[]
74    if (!inventoryConfig.isInMaintenance()) {
75    // end::isInMaintenance[]
76      return Response.ok(manager.list()).build();
77    } else {
78      // tag::email[]
79      return Response.status(Response.Status.SERVICE_UNAVAILABLE)
80                     .entity("{ \"error\" : \"Service is currently in maintenance. "
81                     + "Contact: " + inventoryConfig.getEmail().toString() + "\" }")
82                     .build();
83      // end::getEmail[]
84    }
85  }
86
87}
88
89// end::config-methods[]

  1// tag::copyright[]
  2/*******************************************************************************
  3 * Copyright (c) 2017, 2024 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 2.0
  6 * which accompanies this distribution, and is available at
  7 * http://www.eclipse.org/legal/epl-2.0/
  8 *
  9 * SPDX-License-Identifier: EPL-2.0
 10 *******************************************************************************/
 11// end::copyright[]
 12// tag::test[]
 13package it.io.openliberty.guides.config;
 14
 15import static org.junit.jupiter.api.Assertions.assertEquals;
 16
 17import jakarta.ws.rs.client.Client;
 18import jakarta.ws.rs.client.ClientBuilder;
 19import jakarta.ws.rs.core.Response;
 20
 21import org.junit.jupiter.api.AfterEach;
 22import org.junit.jupiter.api.BeforeEach;
 23import org.junit.jupiter.api.MethodOrderer.OrderAnnotation;
 24import org.junit.jupiter.api.Order;
 25import org.junit.jupiter.api.Test;
 26import org.junit.jupiter.api.TestMethodOrder;
 27
 28@TestMethodOrder(OrderAnnotation.class)
 29public class ConfigurationIT {
 30
 31  private String port;
 32  private String baseUrl;
 33  private Client client;
 34
 35  private final String INVENTORY_HOSTS = "inventory/systems";
 36  private final String USER_DIR = System.getProperty("user.dir");
 37  private final String DEFAULT_CONFIG_FILE = USER_DIR
 38      + "/src/main/resources/META-INF/microprofile-config.properties";
 39  private final String CUSTOM_CONFIG_FILE = USER_DIR.split("target")[0]
 40      + "/resources/CustomConfigSource.json";
 41  private final String INV_MAINTENANCE_PROP = "io_openliberty_guides"
 42      + "_inventory_inMaintenance";
 43
 44  @BeforeEach
 45  // tag::setup[]
 46  public void setup() {
 47    port = System.getProperty("http.port");
 48    baseUrl = "http://localhost:" + port + "/";
 49    ConfigITUtil.setDefaultJsonFile(CUSTOM_CONFIG_FILE);
 50
 51    client = ClientBuilder.newClient();
 52  }
 53  // end::setup[]
 54
 55  @AfterEach
 56  public void teardown() {
 57    ConfigITUtil.setDefaultJsonFile(CUSTOM_CONFIG_FILE);
 58    client.close();
 59  }
 60
 61  @Test
 62  @Order(1)
 63  // tag::testInitialServiceStatus[]
 64  public void testInitialServiceStatus() {
 65    boolean status = Boolean.valueOf(ConfigITUtil.readPropertyValueInFile(
 66        INV_MAINTENANCE_PROP, DEFAULT_CONFIG_FILE));
 67    if (!status) {
 68      Response response = ConfigITUtil.getResponse(client, baseUrl + INVENTORY_HOSTS);
 69
 70      int expected = Response.Status.OK.getStatusCode();
 71      int actual = response.getStatus();
 72      assertEquals(expected, actual);
 73    } else {
 74      assertEquals(
 75         "{ \"error\" : \"Service is currently in maintenance."
 76         + "Contact: [email protected]\" }",
 77          ConfigITUtil.getStringFromURL(client, baseUrl + INVENTORY_HOSTS),
 78          "The Inventory Service should be in maintenance");
 79    }
 80  }
 81  // end::testInitialServiceStatus[]
 82
 83  @Test
 84  @Order(2)
 85  // tag::testPutServiceInMaintenance[]
 86  public void testPutServiceInMaintenance() {
 87    Response response = ConfigITUtil.getResponse(client, baseUrl + INVENTORY_HOSTS);
 88
 89    int expected = Response.Status.OK.getStatusCode();
 90    int actual = response.getStatus();
 91    assertEquals(expected, actual);
 92
 93    ConfigITUtil.switchInventoryMaintenance(CUSTOM_CONFIG_FILE, true);
 94
 95    String error = ConfigITUtil.getStringFromURL(client, baseUrl + INVENTORY_HOSTS);
 96
 97    assertEquals(
 98         "{ \"error\" : \"Service is currently in maintenance. "
 99         + "Contact: [email protected]\" }",
100        error, "The inventory service should be down in the end");
101  }
102  // end::testPutServiceInMaintenance[]
103
104  @Test
105  @Order(3)
106  // tag::testChangeEmail[]
107  public void testChangeEmail() {
108    ConfigITUtil.switchInventoryMaintenance(CUSTOM_CONFIG_FILE, true);
109
110    String error = ConfigITUtil.getStringFromURL(client, baseUrl + INVENTORY_HOSTS);
111
112    assertEquals(
113         "{ \"error\" : \"Service is currently in maintenance. "
114         + "Contact: [email protected]\" }",
115        error, "The email should be [email protected] in the beginning");
116
117    ConfigITUtil.changeEmail(CUSTOM_CONFIG_FILE, "[email protected]");
118
119    error = ConfigITUtil.getStringFromURL(client, baseUrl + INVENTORY_HOSTS);
120
121    assertEquals(
122         "{ \"error\" : \"Service is currently in maintenance. "
123         + "Contact: [email protected]\" }",
124        error, "The email should be [email protected] in the beginning");
125  }
126  // end::testChangeEmail[]
127
128}
129// end::test[]