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

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