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 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[]
13
14package io.openliberty.guides.config;
15
16// tag::email[]
17public class Email {
18  private String name;
19  private String domain;
20
21  public Email(String value) {
22    String[] components = value.split("@");
23    if (components.length == 2) {
24      name = components[0];
25      domain = components[1];
26    }
27  }
28
29  public String getEmailName() {
30    return name;
31  }
32
33  public String getEmailDomain() {
34    return domain;
35  }
36
37  public String toString() {
38    return name + "@" + domain;
39  }
40}
41// end::email[]

 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 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 io.openliberty.guides.config;
14
15import org.eclipse.microprofile.config.spi.Converter;
16import io.openliberty.guides.config.Email;
17
18// tag::customConfig[]
19public class CustomEmailConverter implements Converter<Email> {
20
21  @Override
22  public Email convert(String value) {
23    return new Email(value);
24  }
25
26}
27// 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 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[]
13// tag::config-class[]
14package io.openliberty.guides.inventory;
15
16import jakarta.enterprise.context.RequestScoped;
17import jakarta.inject.Inject;
18import jakarta.inject.Provider;
19import org.eclipse.microprofile.config.inject.ConfigProperty;
20import io.openliberty.guides.config.Email;
21
22@RequestScoped
23public class InventoryConfig {
24
25  // tag::port-number[]
26  // tag::inject-port-number[]
27  @Inject
28  // end::inject-port-number[]
29  // tag::guides-port-number[]
30  @ConfigProperty(name = "io_openliberty_guides_port_number")
31  // end::guides-port-number[]
32  private int portNumber;
33
34  // end::port-number[]
35  // tag::build-in-converter[]
36  // tag::inject-inMaintenance[]
37  // tag::inject[]
38  @Inject
39  // end::inject[]
40  // tag::configPropety[]
41  @ConfigProperty(name = "io_openliberty_guides_inventory_inMaintenance")
42  // end::configPropety[]
43  // end::inject-inMaintenance[]
44  private Provider<Boolean> inMaintenance;
45
46  // end::build-in-converter[]
47  // tag::custom-converter[]
48  @Inject
49  @ConfigProperty(name = "io_openliberty_guides_email")
50  private Provider<Email> email;
51  // end::custom-converter[]
52
53  // tag::getPortNumber[]
54  public int getPortNumber() {
55    return portNumber;
56  }
57  // end::getPortNumber[]
58
59  // tag::isInMaintenance[]
60  public boolean isInMaintenance() {
61    // tag::inMaintenanceGet[]
62    return inMaintenance.get();
63    // end::inMaintenanceGet[]
64  }
65  // end::isInMaintenance[]
66
67  // tag::getEmail[]
68  public Email getEmail() {
69    return email.get();
70  }
71  // end::getEmail[]
72}
73// 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 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[]
13// tag::config-methods[]
14package io.openliberty.guides.inventory;
15
16import java.util.Properties;
17
18// CDI
19import jakarta.enterprise.context.RequestScoped;
20import jakarta.inject.Inject;
21import jakarta.ws.rs.GET;
22import jakarta.ws.rs.Path;
23import jakarta.ws.rs.PathParam;
24import jakarta.ws.rs.Produces;
25import jakarta.ws.rs.core.MediaType;
26import jakarta.ws.rs.core.Response;
27
28
29
30@RequestScoped
31@Path("systems")
32public class InventoryResource {
33
34  @Inject
35  InventoryManager manager;
36
37  // tag::config-injection[]
38  @Inject
39  InventoryConfig inventoryConfig;
40  // end::config-injection[]
41
42  @GET
43  @Path("{hostname}")
44  @Produces(MediaType.APPLICATION_JSON)
45  public Response getPropertiesForHost(@PathParam("hostname") String hostname) {
46
47    if (!inventoryConfig.isInMaintenance()) {
48      // tag::config-port[]
49      Properties props = manager.get(hostname, inventoryConfig.getPortNumber());
50      // end::config-port[]
51      if (props == null) {
52        return Response.status(Response.Status.NOT_FOUND)
53                       .entity("{ \"error\" : \"Unknown hostname or the system service "
54                       + "may not be running on " + hostname + "\" }")
55                       .build();
56      }
57
58      // Add to inventory
59      manager.add(hostname, props);
60      return Response.ok(props).build();
61    } else {
62      // tag::email[]
63      return Response.status(Response.Status.SERVICE_UNAVAILABLE)
64                     .entity("{ \"error\" : \"Service is currently in maintenance. "
65                     + "Contact: " + inventoryConfig.getEmail().toString() + "\" }")
66                     .build();
67      // end::email[]
68    }
69  }
70
71  @GET
72  @Produces(MediaType.APPLICATION_JSON)
73  public Response listContents() {
74    // tag::isInMaintenance[]
75    if (!inventoryConfig.isInMaintenance()) {
76    // end::isInMaintenance[]
77      return Response.ok(manager.list()).build();
78    } else {
79      // tag::email[]
80      return Response.status(Response.Status.SERVICE_UNAVAILABLE)
81                     .entity("{ \"error\" : \"Service is currently in maintenance. "
82                     + "Contact: " + inventoryConfig.getEmail().toString() + "\" }")
83                     .build();
84      // end::getEmail[]
85    }
86  }
87
88}
89
90// end::config-methods[]

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