Configuring microservices

 13package io.openliberty.guides.config;
 14
 15import jakarta.json.stream.JsonParser;
 16import jakarta.json.stream.JsonParser.Event;
 17import jakarta.json.Json;
 18import java.math.BigDecimal;
 19import java.io.StringReader;
 20import java.util.HashMap;
 21import java.util.Map;
 22import java.util.Set;
 23
 24import java.io.BufferedReader;
 25import java.io.FileReader;
 26import org.eclipse.microprofile.config.spi.ConfigSource;
 27
 28/**
 29 * User-provided ConfigSources are dynamic.
 30 * The getProperties() method will be periodically invoked by the runtime
 31 * to retrieve up-to-date values. The frequency is controlled by
 32 * the microprofile.config.refresh.rate Java system property,
 33 * which is in milliseconds and can be customized.
 34 */
 35public class CustomConfigSource implements ConfigSource {
 36
 37  String fileLocation = System.getProperty("user.dir").split("target")[0]
 38      + "resources/CustomConfigSource.json";
 39
 40  @Override
 41  public int getOrdinal() {
 42    return Integer.parseInt(getProperties().get("config_ordinal"));
 43  }
 44
 45  @Override
 46  public Set<String> getPropertyNames() {
 47    return getProperties().keySet();
 48  }
 49
 50  @Override
 51  public String getValue(String key) {
 52    return getProperties().get(key);
 53  }
 54
 55  @Override
 56  public String getName() {
 57    return "Custom Config Source: file:" + this.fileLocation;
 58  }
 59
 61  public Map<String, String> getProperties() {
 62    Map<String, String> m = new HashMap<String, String>();
 63    String jsonData = this.readFile(this.fileLocation);
 64    JsonParser parser = Json.createParser(new StringReader(jsonData));
 65    String key = null;
 66    while (parser.hasNext()) {
 67      final Event event = parser.next();
 68      switch (event) {
 69      case KEY_NAME:
 70        key = parser.getString();
 71        break;
 72      case VALUE_STRING:
 73        String string = parser.getString();
 74        m.put(key, string);
 75        break;
 76      case VALUE_NUMBER:
 77        BigDecimal number = parser.getBigDecimal();
 78        m.put(key, number.toString());
 79        break;
 80      case VALUE_TRUE:
 81        m.put(key, "true");
 82        break;
 83      case VALUE_FALSE:
 84        m.put(key, "false");
 85        break;
 86      default:
 87        break;
 88      }
 89    }
 90    parser.close();
 91    return m;
 92  }
 94
 95  public String readFile(String fileName) {
 96    String result = "";
 97    try {
 98      BufferedReader br = new BufferedReader(new FileReader(fileName));
 99      StringBuilder sb = new StringBuilder();
100      String line = br.readLine();
101      while (line != null) {
102        sb.append(line);
103        line = br.readLine();
104      }
105      result = sb.toString();
106      br.close();
107    } catch (Exception e) {
108      e.printStackTrace();
109    }
110    return result;
111  }
112}
114

12
13package io.openliberty.guides.config;
14
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}
41

12package io.openliberty.guides.config;
13
14import org.eclipse.microprofile.config.spi.Converter;
15
17public class CustomEmailConverter implements Converter<Email> {
18
19  @Override
20  public Email convert(String value) {
21    return new Email(value);
22  }
23
24}
26

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
26  @Inject
29  @ConfigProperty(name = "io_openliberty_guides_port_number")
31  private int portNumber;
32
37  @Inject
40  @ConfigProperty(name = "io_openliberty_guides_inventory_inMaintenance")
43  private Provider<Boolean> inMaintenance;
44
47  @Inject
48  @ConfigProperty(name = "io_openliberty_guides_email")
49  private Provider<Email> email;
51
53  public int getPortNumber() {
54    return portNumber;
55  }
57
59  public boolean isInMaintenance() {
61    return inMaintenance.get();
63  }
65
67  public Email getEmail() {
68    return email.get();
69  }
71}
73

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
37  @Inject
38  InventoryConfig inventoryConfig;
40
41  @GET
42  @Path("{hostname}")
43  @Produces(MediaType.APPLICATION_JSON)
44  public Response getPropertiesForHost(@PathParam("hostname") String hostname) {
45
46    if (!inventoryConfig.isInMaintenance()) {
48      Properties props = manager.get(hostname, inventoryConfig.getPortNumber());
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 {
62      return Response.status(Response.Status.SERVICE_UNAVAILABLE)
63                     .entity("{ \"error\" : \"Service is currently in maintenance. "
64                     + "Contact: " + inventoryConfig.getEmail().toString() + "\" }")
65                     .build();
67    }
68  }
69
70  @GET
71  @Produces(MediaType.APPLICATION_JSON)
72  public Response listContents() {
74    if (!inventoryConfig.isInMaintenance()) {
76      return Response.ok(manager.list()).build();
77    } else {
79      return Response.status(Response.Status.SERVICE_UNAVAILABLE)
80                     .entity("{ \"error\" : \"Service is currently in maintenance. "
81                     + "Contact: " + inventoryConfig.getEmail().toString() + "\" }")
82                     .build();
84    }
85  }
86
87}
88
90

 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
 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  }
 54
 55  @AfterEach
 56  public void teardown() {
 57    ConfigITUtil.setDefaultJsonFile(CUSTOM_CONFIG_FILE);
 58    client.close();
 59  }
 60
 61  @Test
 62  @Order(1)
 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: admin@guides.openliberty.io\" }",
 77          ConfigITUtil.getStringFromURL(client, baseUrl + INVENTORY_HOSTS),
 78          "The Inventory Service should be in maintenance");
 79    }
 80  }
 82
 83  @Test
 84  @Order(2)
 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: admin@guides.openliberty.io\" }",
100        error, "The inventory service should be down in the end");
101  }
103
104  @Test
105  @Order(3)
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: admin@guides.openliberty.io\" }",
115        error, "The email should be admin@guides.openliberty.io in the beginning");
116
117    ConfigITUtil.changeEmail(CUSTOM_CONFIG_FILE, "service@guides.openliberty.io");
118
119    error = ConfigITUtil.getStringFromURL(client, baseUrl + INVENTORY_HOSTS);
120
121    assertEquals(
122         "{ \"error\" : \"Service is currently in maintenance. "
123         + "Contact: service@guides.openliberty.io\" }",
124        error, "The email should be service@guides.openliberty.io in the beginning");
125  }
127
128}
130