Integration tests restructure (#205)

* restructure integration tests

* reverte groupID default change from oracle:root

* handle very bad message from Oracle Container Registry when image is not found

* remove integration test base class

* removed guava dependency, no longer used

Author: ddsharpe

.mvn/maven.config-template

@@ -1 +1 @@
--Dtest.dependency.dir=/some/folder/with/installers
+-Dtest.staging.dir=/some/folder/with/installers

Jenkinsfile

@@ -58,7 +58,10 @@ pipeline {
             }
             steps {
                 withCredentials([[$class: 'UsernamePasswordMultiBinding', credentialsId: 'otn-cred', passwordVariable: 'ORACLE_SUPPORT_PASSWORD', usernameVariable: 'ORACLE_SUPPORT_USERNAME']]) {
-                    sh 'mvn verify -Dtest.staging.dir=${STAGING_DIR} -Dtest.groups=gate'
+                    sh '''
+                        cd tests
+                        mvn clean verify -Dtest.staging.dir=${STAGING_DIR} -Dtest.groups=gate
+                    '''
                 }
             }
             post {
@@ -76,7 +79,10 @@ pipeline {
             }
             steps {
                 withCredentials([[$class: 'UsernamePasswordMultiBinding', credentialsId: 'otn-cred', passwordVariable: 'ORACLE_SUPPORT_PASSWORD', usernameVariable: 'ORACLE_SUPPORT_USERNAME']]) {
-                    sh 'mvn verify -Dtest.staging.dir=${STAGING_DIR} -Dtest.groups=gate,nightly'
+                    sh '''
+                        cd tests
+                        mvn clean verify -Dtest.staging.dir=${STAGING_DIR} -Dtest.groups=gate,nightly
+                    '''
                 }
             }
             post {

README.md

@@ -41,6 +41,54 @@ The Image Tool provides three functions within the main script:
 
 Use the [Quick Start](site/quickstart.md) guide to create a Linux based WebLogic Docker image.
 
+## Building From Source
+
+The Image Tool installer is available for download on the [Releases](releases) page.  If you want
+to build the installer from source instead of downloading it, follow these instructions:
+- Download and install JDK 8u261+
+- Download and install Maven 3.6.3+
+- Clone this repository to your local environment using one of the options under `Code` near the top of this page.
+- From inside the top-level directory of the cloned project, `weblogic-image-tool`, using Maven, execute one or 
+more of these phases:
+    - `validate` - Validate the project is correct and all necessary information is available.
+    - `compile`  - Compile the source code.
+    - `test`     - Test the compiled source code using the JUnit5 framework.
+    - `package`  - Create the installer ZIP file, `imagetool.zip`.
+    - `verify`   - Run integration tests using the JUnit5 framework (Pre-requisite: Docker installed).
+    - `clean`    - Restore the source by removing any items created by `package` or another phase of the build.
+    
+**Note:** Maven executes build phases sequentially, `validate`, `compile`, `test`, `package`, `verify`, such that 
+running `verify` will run all of these phases from `validate` through `package` before executing `verify`.
+
+Because the `package` phase comes before the `verify` phase, it is not necessary to run the integration tests to create 
+the Image Tool installer.  If you are making changes and want to validate those changes in your environment, you will 
+need to do some additional setup before running the `verify` phase because several of the integration tests require 
+access to the Oracle Technology Network.  To run the integration tests in the 
+`verify` phase, you must specify three environment variables, `ORACLE_SUPPORT_USERNAME`, `ORACLE_SUPPORT_PASSWORD`, 
+and `STAGING_DIR`.  The first two, Oracle Support user name and password, are used to connect to Oracle OTN for patches.
+The third, `STAGING_DIR`, should be a local folder where WebLogic Server installers, JDK installers, and pre-downloaded 
+patches can be found.  The files required in the `STAGING_DIR` depend on which tests that you want to run.  
+
+Example: Run a set of integration tests (available groups are `cache`, `gate`, and `nightly`:
+```shell script
+mvn verify -Dtest.groups=cache
+```
+
+Example: Run a single integration test:
+```shell script
+mvn verify -Dtest.groups=gate,nightly -Dit.test=ITImagetool#createWlsImg
+```
+
+Integration Test groups:
+- `cache` - Tests that build and manipulate the Image Tool cache.
+- `gate`  - A basic set of integration tests that are used to validate merge requests, including building several 
+Docker image (~20 minutes)
+- `nightly` - The full set of integration tests building various Docker images including JRF and WLS 
+installations (~2 hours)
+
+**Note:** In order to run an integration test that builds an image like `createWlsImg`, you must run the `cache` 
+group first in order to populate the cache with the WLS and JDK installers.
+
 ## Samples
 
 * [Create an image with full Internet access](site/create-image-with-internet.md)

imagetool/pom.xml

@@ -43,11 +43,6 @@
             <artifactId>junit-jupiter-engine</artifactId>
             <scope>test</scope>
         </dependency>
-        <dependency>
-            <groupId>com.google.guava</groupId>
-            <artifactId>guava</artifactId>
-            <scope>test</scope>
-        </dependency>
         <dependency>
             <groupId>com.github.spullara.mustache.java</groupId>
             <artifactId>compiler</artifactId>

imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonOptions.java

@@ -487,7 +487,7 @@ String getPassword() {
         names = {"--chown"},
         split = ":",
         description = "userid:groupid for JDK/Middleware installs and patches. Default: ${DEFAULT-VALUE}.",
-        defaultValue = "oracle:root"
+        defaultValue = "oracle:oracle"
     )
     private String[] osUserAndGroup;
 

imagetool/src/main/java/com/oracle/weblogic/imagetool/util/Utils.java

@@ -422,8 +422,11 @@ public static boolean isEmptyString(String s) {
     public static Properties getBaseImageProperties(String dockerImage, String tmpDir)
         throws IOException, InterruptedException {
 
+        logger.entering(dockerImage, tmpDir);
         List<String> imageEnvCmd = Utils.getDockerRunCmd(tmpDir, dockerImage, "test-env.sh");
-        return Utils.runDockerCommand(imageEnvCmd);
+        Properties result = Utils.runDockerCommand(imageEnvCmd);
+        logger.exiting(result);
+        return result;
     }
 
     /**
@@ -726,7 +729,11 @@ public static String getMessage(@PropertyKey(resourceBundle = "ImageTool") Strin
         if (bundle.containsKey(key)) {
             message = bundle.getString(key);
         }
-        return MessageFormat.format(message, params);
+        if (params == null || params.length == 0) {
+            return message;
+        } else {
+            return MessageFormat.format(message, params);
+        }
     }
 
     /**

tests/pom.xml

@@ -19,7 +19,6 @@
     <properties>
         <sonar.coverage.jacoco.xmlReportPaths>${basedir}/../${aggregate.report.dir}</sonar.coverage.jacoco.xmlReportPaths>
         <skipITs>false</skipITs>
-        <test.staging.dir>MUST BE SET TO DIRECTORY WITH PATCHES AND INSTALLERS</test.staging.dir>
     </properties>
 
     <dependencies>
@@ -33,11 +32,6 @@
             <artifactId>junit-jupiter-engine</artifactId>
             <scope>test</scope>
         </dependency>
-        <dependency>
-            <groupId>com.google.guava</groupId>
-            <artifactId>guava</artifactId>
-            <scope>test</scope>
-        </dependency>
     </dependencies>
 
     <build>
@@ -65,7 +59,7 @@
                                 </requireEnvironmentVariable>
                                 <requireProperty>
                                     <property>test.staging.dir</property>
-                                    <message>For integration tests, you must set the test.staging.dir System property to point to the directory where the installers are staged. Or, set STAGING_DIR environment variable.</message>
+                                    <message>For integration tests, you must define the test.staging.dir System property to point to the directory where the installers are staged. Or, set STAGING_DIR environment variable.</message>
                                 </requireProperty>
                             </rules>
                         </configuration>
@@ -126,9 +120,9 @@
                 <artifactId>jacoco-maven-plugin</artifactId>
                 <executions>
                     <execution>
-                        <id>prepare-agent</id>
+                        <id>prepare-agent-it</id>
                         <goals>
-                            <goal>prepare-agent-integration</goal>
+                            <goal>prepare-agent</goal>
                         </goals>
                     </execution>
                     <execution>