Merge pull request #78 from OpenLiberty/qa

Merge qa to master: Fixing conversion issue (#76)

Author: gkwan-ibm

README.adoc

@@ -1,4 +1,4 @@
-//  Copyright (c) 2019, 2020 IBM Corporation and others.
+//  Copyright (c) 2019, 2021 IBM Corporation and others.
 // Licensed under Creative Commons Attribution-NoDerivatives
 // 4.0 International (CC BY-ND 4.0)
 //   https://creativecommons.org/licenses/by-nd/4.0/
@@ -17,7 +17,7 @@
 :page-seo-title: Testing a MicroProfile or Jakarta EE application using MicroShed Testing with an Open Liberty docker container
 :page-seo-description: A tutorial on how to develop tests for a MicroProfile microservice or a Jakarta EE application by using Open Liberty development mode provided by the Liberty Maven plugin.
 :guide-author: Open Liberty
-:page-tags: ['MicroProfile', 'Java EE', 'Jakarta EE', 'Testing', 'Docker']
+:page-tags: ['MicroProfile', 'Jakarta EE', 'Docker']
 :page-related-guides: ['rest-intro', 'docker', 'rest-client-java']
 :page-permalink: /guides/{projectid}
 :repo-description: Visit the https://openliberty.io/guides/{projectid}.html[website] for the rendered version of the guide.
@@ -71,10 +71,23 @@ include::finish/src/test/java/io/openliberty/guides/testing/PersonServiceIT.java
 
 To try out the application, go to the `finish` directory and run the following Maven 
 goal to build the application and run the integration tests on an Open Liberty server in a container:
+
+// static guide instructions:
+ifndef::cloud-hosted[]
 [role='command']
 ```
 mvn verify
 ```
+endif::[]
+
+// cloud-hosted guide instructions:
+ifdef::cloud-hosted[]
+```
+cd /home/project/guide-microshed-testing/finish
+mvn verify
+```
+{: codeblock}
+endif::[]
 
 This command might take some time to run the first time because the dependencies and the Docker image for Open Liberty must download. If you 
 run the same command again, it will be faster.
@@ -87,6 +100,14 @@ an already running Open Liberty server. Run the following Maven goal to start Op
 mvn liberty:dev
 ```
 
+After you see the following message, your application server in dev mode is ready:
+
+[role="no_copy"]
+----
+************************************************************************
+*    Liberty is running in dev mode.
+----
+
 After the Open Liberty server starts and you see the `Press the Enter key to run tests on demand.` message, you can press the 
 `enter/return` key to run the integration tests. After the tests finish, you can press the `enter/return` key to run the tests again, or you 
 can make code changes to the application or tests. Development mode automatically
@@ -97,10 +118,22 @@ where you ran the server, or by typing `q` and then pressing the `enter/return`
 
 == Bootstrapping your application for testing
 
+// static guide instructions:
+ifndef::cloud-hosted[]
 Navigate to the `start` directory to begin.
+endif::[]
+
+// cloud-hosted guide instructions:
+ifdef::cloud-hosted[]
+To begin, run the following command to navigate to the **start** directory:
+```
+cd /home/project/guide-microprofile-metrics/start
+```
+{: codeblock}
+endif::[]
 
 [role=command]
-include::{common-includes}/devmode-start.adoc[]
+include::{common-includes}/devmode-lmp33-start.adoc[]
 
 Wait for the `Press the Enter key to run tests on demand.` message, and then press the `enter/return` key to run the tests. You see that one test runs:
 
@@ -160,35 +193,47 @@ include::hotspots/src/test/java/io/openliberty/guides/testing/PersonServiceIT.2.
 
 The [hotspot=withAppContextRoot file=1]`withAppContextRoot(String)` method indicates the base path of the application. The app context root is the portion of the URL after the hostname and port. In this case, the application is deployed at the `\http://localhost:9080/guide-microshed-testing` URL, so the app context root is [hotspot=withAppContextRoot file=1]`/guide-microshed-testing`.
 
-The [hotspot=withReadinessPath file=1]`withReadinessPath(String)` method indicates what path is polled by HTTP to determine application readiness. MicroShed Testing automatically starts the ApplicationContainer application and waits for it to be ready before the tests start running. In this case, you are using the default application readiness check at the http://localhost:9080/health/ready[http://localhost:9080/health/ready^] URL, which is enabled by the [hotspot=mpHealth file=2]`MicroProfile Health` feature in our server.xml configuration file. When the readiness URL returns `HTTP 200`, the application is considered ready and the tests begin running.
-
 server.xml
 [source, xml, linenums, role='code_column']
 ----
 include::finish/src/main/liberty/config/server.xml[]
 ----
 
-Save your changes to the `PersonServiceIT` class and press the `enter/return` key in your console window to rerun the tests. You still see only one test running, but the output is different. Notice that MicroShed Testing is using a `hollow` configuration mode. This configuration mode means that MicroShed Testing is reusing an existing application runtime for the test, not starting up a new application instance each time you initiate a test run.
+The [hotspot=withReadinessPath file=1]`withReadinessPath(String)` method indicates what path is polled by HTTP to determine application readiness. 
+MicroShed Testing automatically starts the ApplicationContainer application and waits for it to be ready before the tests start running. 
+In this case, you are using the default application readiness check at the http://localhost:9080/health/ready[http://localhost:9080/health/ready^] URL, which is enabled by the [hotspot=mpHealth file=2]`MicroProfile Health` feature in our server.xml configuration file. When the readiness URL returns `HTTP 200`, the application is considered ready and the tests begin running.
+
+Save your changes to the `PersonServiceIT` class and press the `enter/return` key in your console window to rerun the tests. 
+You still see only one test running, but the output is different. 
+Notice that MicroShed Testing is using a `hollow` configuration mode. 
+This configuration mode means that MicroShed Testing is reusing an existing application runtime for the test, 
+not starting up a new application instance each time you initiate a test run.
 
 == Talking to your application with a REST client
 
-With MicroShed Testing, applications are exercised in a black box fashion. Black box means the tests cannot access the application internals. Instead, the application is exercised from the outside, usually with HTTP requests. To simplify the HTTP interactions, inject a REST client into the tests.
+With MicroShed Testing, applications are exercised in a black box fashion. Black box means the tests cannot access the application internals. 
+Instead, the application is exercised from the outside, usually with HTTP requests. To simplify the HTTP interactions, inject a REST client into the tests.
 
 [role="code_command hotspot file=0", subs="quotes"]
 ----
 #Update the `PersonServiceIT` class.#
 `src/test/java/io/openliberty/guides/testing/PersonServiceIT.java`
 ----
 [role="edit_command_text"]
-Import the [hotspot=importInject file=0]`org.microshed.testing.jaxrs.RESTClient` annotation, create a [hotspot=personSvc file=0]`PersonService` REST client, and annotate the REST client with [hotspot=inject file=0]`@RESTClient`.
+Import the [hotspot=importInject file=0]`org.microshed.testing.jaxrs.RESTClient` annotation, 
+create a [hotspot=personSvc file=0]`PersonService` REST client, and annotate the REST client with [hotspot=inject file=0]`@RESTClient`.
 
 PersonServiceIT.java
 [source, java, linenums, role='code_column hide_tags=copyright,importAssertNotNull,importSharedContainerConfig,sharedContainerConfig,testCreatePerson']
 ----
 include::hotspots/src/test/java/io/openliberty/guides/testing/PersonServiceIT.2.java[]
 ----
 
-In this example, the [hotspot=personSvc file=0]`PersonService` injected type is the same [hotspot file=1]`io.openliberty.guides.testing.PersonService` class that is used in your application. However, the _instance_ that gets injected is a REST client proxy. So, if you call `personSvc.createPerson("Bob", 42)`, the REST client makes an HTTP POST request to the application that is running at http://localhost:9080/guide-microshed-testing/people[http://localhost:9080/guide-microshed-testing/people^], which triggers the corresponding Java method in the application.
+In this example, the [hotspot=personSvc file=0]`PersonService` injected type is the same 
+[hotspot file=1]`io.openliberty.guides.testing.PersonService` class that is used in your application. 
+However, the _instance_ that gets injected is a REST client proxy. 
+So, if you call `personSvc.createPerson("Bob", 42)`, the REST client makes an HTTP POST request to the application 
+that is running at `\http://localhost:9080/guide-microshed-testing/people`, which triggers the corresponding Java method in the application.
 
 PersonService.java
 [source, java, linenums, role='code_column hide_tags=copyright']
@@ -219,8 +264,8 @@ Save the changes. Then, press the `enter/return` key in your console window to r
 
 [role="no_copy"]
 ----
-INFO org.microshed.testing.jaxrs.RestClientBuilder  - Building rest client for class io.openliberty.guides.testing.PersonService with base path: http://localhost:9080/guide-microshed-testing/ and providers: [class org.microshed.testing.jaxrs.JsonBProvider]
-INFO org.microshed.testing.jaxrs.JsonBProvider  - Response from server: 1809686877352335426
+[INFO] Building rest client for class io.openliberty.guides.testing.PersonService with base path: http://localhost:9080/guide-microshed-testing/ and providers: [class org.microshed.testing.jaxrs.JsonBProvider]
+[INFO] Response from server: 1809686877352335426
 ----
 
 Next, add more tests.