Merge pull request #148 from OpenLiberty/qa

Merge qa to master: use default keystore (#131)

Author: gkwan-ibm

README.adoc

@@ -235,7 +235,7 @@ cd /home/project/guide-microprofile-metrics/start
 {: codeblock}
 endif::[]
 
-include::{common-includes}/devmode-start.adoc[]
+include::{common-includes}/devmode-lmp33-start.adoc[]
 
 The MicroProfile Metrics API is included in the MicroProfile dependency specified by your [hotspot file=0]`pom.xml` file.
 Look for the dependency with the [hotspot=microprofile file=0]`microprofile` artifact ID.
@@ -251,7 +251,8 @@ in your code to provide metrics from your microservices.
 The [hotspot=mpMetrics file=1]`mpMetrics` feature enables MicroProfile Metrics support in Open Liberty. Note that this
 feature requires SSL and the configuration has been provided for you.
 
-The [hotspot=quickStartSecurity file=1]`quickStartSecurity` and [hotspot=keyStore file=1]`keyStore` configuration elements provide basic security to secure the server. When you visit the `/metrics` endpoint, use the credentials defined in the server configuration to log in and view the data.
+The [hotspot=quickStartSecurity file=1]`quickStartSecurity` configuration element provides basic security to secure the server. 
+When you visit the `/metrics` endpoint, use the credentials defined in the server configuration to log in and view the data.
 
 // =================================================================================================
 // Adding the annotations
@@ -474,13 +475,19 @@ Tests run: 1, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 1.4 sec - in it.
 Running it.io.openliberty.guides.metrics.MetricsIT
 Tests run: 4, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 1.476 sec - in it.io.openliberty.guides.metrics.MetricsIT
 Running it.io.openliberty.guides.inventory.InventoryEndpointIT
+[WARNING ] Interceptor for {http://client.inventory.guides.openliberty.io/}SystemClient has thrown exception, unwinding now
+Could not send Message.
+[err] The specified host is unknown.
 Tests run: 3, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 0.264 sec - in it.io.openliberty.guides.inventory.InventoryEndpointIT
 
 Results :
 
 Tests run: 8, Failures: 0, Errors: 0, Skipped: 0
 ----
 
+The warning and error messages are expected and result from a request to a bad or an unknown hostname. 
+This request is made in the `testUnknownHost()` test from the `InventoryEndpointIT` integration test.
+
 To determine whether the tests detect a failure, go to the [hotspot file=0]`MetricsIT.java` file and change any of the assertions
 in the test methods. Then re-run the tests to see a test failure occur.
 

finish/pom.xml

@@ -86,7 +86,7 @@
       <plugin>
         <groupId>io.openliberty.tools</groupId>
         <artifactId>liberty-maven-plugin</artifactId>
-        <version>3.2.3</version>
+        <version>3.3.3</version>
       </plugin>
       <!-- Plugin to run functional tests -->
       <plugin>

finish/src/main/liberty/config/server.xml

@@ -17,9 +17,6 @@
   <!-- tag::quickStartSecurity[] -->
   <quickStartSecurity userName="admin" userPassword="adminpwd"/>
   <!-- end::quickStartSecurity[] -->
-  <!-- tag::keyStore[] -->
-  <keyStore id="defaultKeyStore" location="key.jks" type="jks" password="mpKeystore"/>
-  <!-- end::keyStore[] -->
   <httpEndpoint host="*" httpPort="${default.http.port}"
       httpsPort="${default.https.port}" id="defaultHttpEndpoint"/>
   <webApplication location="guide-microprofile-metrics.war" contextRoot="/"/>

finish/src/test/java/it/io/openliberty/guides/metrics/MetricsIT.java

@@ -1,6 +1,6 @@
 // tag::copyright[]
 /*******************************************************************************
- * Copyright (c) 2017, 2020 IBM Corporation and others.
+ * Copyright (c) 2017, 2021 IBM Corporation and others.
  * All rights reserved. This program and the accompanying materials
  * are made available under the terms of the Eclipse Public License v1.0
  * which accompanies this distribution, and is available at
@@ -13,17 +13,31 @@
 // tag::MetricsTest[]
 package it.io.openliberty.guides.metrics;
 
-import static org.junit.jupiter.api.Assertions.*;
-import java.io.*;
-import java.util.*;
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertTrue;
+import static org.junit.jupiter.api.Assertions.fail;
+
+import java.io.BufferedReader;
+import java.io.FileInputStream;
+import java.io.IOException;
+import java.io.InputStream;
+import java.io.InputStreamReader;
+import java.security.KeyStore;
+import java.util.ArrayList;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+import java.util.Properties;
+
 import javax.ws.rs.client.Client;
 import javax.ws.rs.client.ClientBuilder;
 import javax.ws.rs.core.MediaType;
 import javax.ws.rs.core.Response;
+
 import org.apache.cxf.jaxrs.provider.jsrjsonp.JsrJsonpProvider;
 import org.junit.jupiter.api.AfterEach;
-import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.BeforeAll;
+import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.MethodOrderer.OrderAnnotation;
 import org.junit.jupiter.api.Order;
 import org.junit.jupiter.api.Test;
@@ -33,10 +47,19 @@
 @TestMethodOrder(OrderAnnotation.class)
 // end::TestMethodOrder[]
 public class MetricsIT {
+
+  private static final String KEYSTORE_PATH = System.getProperty("user.dir")
+                              + "/target/liberty/wlp/usr/servers/"
+                              + "defaultServer/resources/security/key.p12";
+  private static final String SYSTEM_ENV_PATH =  System.getProperty("user.dir")
+                              + "/target/liberty/wlp/usr/servers/"
+                              + "defaultServer/server.env";
+
   private static String httpPort;
   private static String httpsPort;
   private static String baseHttpUrl;
   private static String baseHttpsUrl;
+  private static KeyStore keystore;
 
   private List<String> metrics;
   private Client client;
@@ -49,20 +72,29 @@ public class MetricsIT {
   @BeforeAll
   // end::BeforeAll[]
   // tag::oneTimeSetup[]
-  public static void oneTimeSetup() {
+  public static void oneTimeSetup() throws Exception {
     httpPort = System.getProperty("http.port");
     httpsPort = System.getProperty("https.port");
     baseHttpUrl = "http://localhost:" + httpPort + "/";
     baseHttpsUrl = "https://localhost:" + httpsPort + "/";
+    loadKeystore();
   }
   // end::oneTimeSetup[]
 
+  private static void loadKeystore() throws Exception {
+    Properties sysEnv = new Properties();
+    sysEnv.load(new FileInputStream(SYSTEM_ENV_PATH));
+    char[] password = sysEnv.getProperty("keystore_password").toCharArray();
+    keystore = KeyStore.getInstance("PKCS12");
+    keystore.load(new FileInputStream(KEYSTORE_PATH), password);
+  }
+
   // tag::BeforeEach[]
   @BeforeEach
   // end::BeforeEach[]
   // tag::setup[]
   public void setup() {
-    client = ClientBuilder.newClient();
+    client = ClientBuilder.newBuilder().trustStore(keystore).build();
     // tag::JsrJsonpProvider[]
     client.register(JsrJsonpProvider.class);
     // end::JsrJsonpProvider[]
@@ -130,7 +162,7 @@ public void testInventoryAccessCountMetric() {
   // tag::testInventorySizeGaugeMetric[]
   public void testInventorySizeGaugeMetric() {
     metrics = getMetrics();
-    Map<String, Integer> inventorySizeGauges = getIntMetrics(metrics, 
+    Map<String, Integer> inventorySizeGauges = getIntMetrics(metrics,
             "application_inventorySizeGauge");
     for (Integer value : inventorySizeGauges.values()) {
       assertTrue(1 <= value);
@@ -176,7 +208,7 @@ private List<String> getMetrics() {
                                          authorizationHeaderValue)
                                      .get();
 
-    BufferedReader br = new BufferedReader(new InputStreamReader((InputStream) 
+    BufferedReader br = new BufferedReader(new InputStreamReader((InputStream)
     metricsResponse.getEntity()));
     List<String> result = new ArrayList<String>();
     try {
@@ -201,7 +233,7 @@ private Response getResponse(String url) {
   private void assertResponse(String url, Response response) {
     assertEquals(200, response.getStatus(), "Incorrect response code from " + url);
   }
-  
+
   private Map<String, Integer> getIntMetrics(List<String> metrics, String metricName) {
     Map<String, Integer> output = new HashMap<String, Integer>();
     for (String metric : metrics) {

start/pom.xml

@@ -86,7 +86,7 @@
       <plugin>
         <groupId>io.openliberty.tools</groupId>
         <artifactId>liberty-maven-plugin</artifactId>
-        <version>3.2.3</version>
+        <version>3.3.3</version>
       </plugin>
       <!-- Plugin to run functional tests -->
       <plugin>