Adding health reports to microservices

  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::testClass[]
 14package it.io.openliberty.guides.inventory;
 15
 16import static org.junit.jupiter.api.Assertions.assertEquals;
 17import static org.junit.jupiter.api.Assertions.assertTrue;
 18
 19import jakarta.json.JsonArray;
 20import jakarta.json.JsonObject;
 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.AfterEach;
 27import org.junit.jupiter.api.BeforeAll;
 28import org.junit.jupiter.api.BeforeEach;
 29import org.junit.jupiter.api.MethodOrderer.OrderAnnotation;
 30import org.junit.jupiter.api.Order;
 31import org.junit.jupiter.api.Test;
 32import org.junit.jupiter.api.TestMethodOrder;
 33
 34@TestMethodOrder(OrderAnnotation.class)
 35public class InventoryEndpointIT {
 36
 37  private static String port;
 38  private static String baseUrl;
 39
 40  private Client client;
 41
 42  private final String SYSTEM_PROPERTIES = "system/properties";
 43  private final String INVENTORY_SYSTEMS = "inventory/systems";
 44
 45  @BeforeAll
 46  public static void oneTimeSetup() {
 47    port = System.getProperty("default.http.port");
 48    baseUrl = "http://localhost:" + port + "/";
 49  }
 50
 51  @BeforeEach
 52  public void setup() {
 53    client = ClientBuilder.newClient();
 54  }
 55
 56  @AfterEach
 57  public void teardown() {
 58    client.close();
 59  }
 60
 61  // tag::tests[]
 62  @Test
 63  @Order(1)
 64  // tag::testHostRegistration[]
 65  public void testHostRegistration() {
 66    this.visitLocalhost();
 67
 68    Response response = this.getResponse(baseUrl + INVENTORY_SYSTEMS);
 69    this.assertResponse(baseUrl, response);
 70
 71    JsonObject obj = response.readEntity(JsonObject.class);
 72
 73    JsonArray systems = obj.getJsonArray("systems");
 74
 75    boolean localhostExists = false;
 76    for (int n = 0; n < systems.size(); n++) {
 77      localhostExists = systems.getJsonObject(n).get("hostname").toString()
 78          .contains("localhost");
 79      if (localhostExists) {
 80        break;
 81      }
 82    }
 83    assertTrue(localhostExists, "A host was registered, but it was not localhost");
 84
 85    response.close();
 86  }
 87  // end::testHostRegistration[]
 88
 89  @Test
 90  @Order(2)
 91  // tag::testSystemPropertiesMatch[]
 92  public void testSystemPropertiesMatch() {
 93    Response invResponse = this.getResponse(baseUrl + INVENTORY_SYSTEMS);
 94    Response sysResponse = this.getResponse(baseUrl + SYSTEM_PROPERTIES);
 95
 96    this.assertResponse(baseUrl, invResponse);
 97    this.assertResponse(baseUrl, sysResponse);
 98
 99    JsonObject jsonFromInventory = (JsonObject) invResponse.readEntity(JsonObject.class)
100                                                           .getJsonArray("systems")
101                                                           .getJsonObject(0)
102                                                           .get("properties");
103
104    JsonObject jsonFromSystem = sysResponse.readEntity(JsonObject.class);
105
106    String osNameFromInventory = jsonFromInventory.getString("os.name");
107    String osNameFromSystem = jsonFromSystem.getString("os.name");
108    this.assertProperty("os.name", "localhost", osNameFromSystem,
109                        osNameFromInventory);
110
111    String userNameFromInventory = jsonFromInventory.getString("user.name");
112    String userNameFromSystem = jsonFromSystem.getString("user.name");
113    this.assertProperty("user.name", "localhost", userNameFromSystem,
114                        userNameFromInventory);
115
116    invResponse.close();
117    sysResponse.close();
118  }
119  // end::testSystemPropertiesMatch[]
120
121  @Test
122  @Order(3)
123  // tag::testUnknownHost[]
124  public void testUnknownHost() {
125    Response response = this.getResponse(baseUrl + INVENTORY_SYSTEMS);
126    this.assertResponse(baseUrl, response);
127
128    Response badResponse = client.target(baseUrl + INVENTORY_SYSTEMS + "/"
129        + "badhostname").request(MediaType.APPLICATION_JSON).get();
130
131    String obj = badResponse.readEntity(String.class);
132
133    boolean isError = obj.contains("error");
134    assertTrue(isError,
135        "badhostname is not a valid host but it didn't raise an error");
136
137    response.close();
138    badResponse.close();
139  }
140
141  // end::testUnknownHost[]
142  // end::tests[]
143  // tag::helpers[]
144  // tag::javadoc[]
145  /**
146   * <p>
147   * Returns response information from the specified URL.
148   * </p>
149   *
150   * @param url
151   *          - target URL.
152   * @return Response object with the response from the specified URL.
153   */
154  // end::javadoc[]
155  private Response getResponse(String url) {
156    return client.target(url).request().get();
157  }
158
159  // tag::javadoc[]
160  /**
161   * <p>
162   * Asserts that the given URL has the correct response code of 200.
163   * </p>
164   *
165   * @param url
166   *          - target URL.
167   * @param response
168   *          - response received from the target URL.
169   */
170  // end::javadoc[]
171  private void assertResponse(String url, Response response) {
172    assertEquals(200, response.getStatus(), "Incorrect response code from " + url);
173  }
174
175  // tag::javadoc[]
176  /**
177   * Asserts that the specified JVM system property is equivalent in both the
178   * system and inventory services.
179   *
180   * @param propertyName
181   *          - name of the system property to check.
182   * @param hostname
183   *          - name of JVM's host.
184   * @param expected
185   *          - expected name.
186   * @param actual
187   *          - actual name.
188   */
189  // end::javadoc[]
190  private void assertProperty(String propertyName, String hostname,
191      String expected, String actual) {
192    assertEquals(expected, actual, "JVM system property [" + propertyName + "] "
193        + "in the system service does not match the one stored in "
194        + "the inventory service for " + hostname);
195  }
196
197  // tag::javadoc[]
198  /**
199   * Makes a simple GET request to inventory/localhost.
200   */
201  // end::javadoc[]
202  private void visitLocalhost() {
203    Response response = this.getResponse(baseUrl + SYSTEM_PROPERTIES);
204    this.assertResponse(baseUrl, response);
205    response.close();
206
207    Response targetResponse = client.target(baseUrl + INVENTORY_SYSTEMS
208        + "/localhost").request().get();
209    targetResponse.close();
210  }
211  // end::helpers[]
212}
213// end::testClass[]

 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[]
13package it.io.openliberty.guides.system;
14
15import static org.junit.jupiter.api.Assertions.assertEquals;
16
17import jakarta.json.JsonObject;
18import jakarta.ws.rs.client.Client;
19import jakarta.ws.rs.client.ClientBuilder;
20import jakarta.ws.rs.client.WebTarget;
21import jakarta.ws.rs.core.Response;
22
23import org.junit.jupiter.api.Test;
24
25public class SystemEndpointIT {
26
27  @Test
28  public void testGetProperties() {
29    String port = System.getProperty("default.http.port");
30    String url = "http://localhost:" + port + "/";
31
32    Client client = ClientBuilder.newClient();
33
34    WebTarget target = client.target(url + "system/properties");
35    Response response = target.request().get();
36
37    assertEquals(200, response.getStatus(), "Incorrect response code from " + url);
38
39    JsonObject obj = response.readEntity(JsonObject.class);
40
41    assertEquals(System.getProperty("os.name"), obj.getString("os.name"),
42        "The system property for the local and remote JVM should match");
43
44    response.close();
45    client.close();
46  }
47}