Merge pull request #1 from oracle/refactor

refactor and rename artifact

Author: jshum2479

README.md

@@ -1,22 +1,22 @@
-# Oracle WebLogic Image Builder Tool
+# Oracle WebLogic Image Tool
 
 Containerization is taking over the software world. In this modern age of software development, Docker and Kubernetes
 have become the gold standard. To help customers stay at the forefront of this, Oracle has released the
 [WebLogic Server Kubernetes Operator](https://github.com/oracle/weblogic-kubernetes-operator). The operator helps
 customers move their workloads to the cloud via the Kubernetes (cloud neutral) route. Customers get to decide how
 to create the Docker images and apply patches to these images deployed by the Kubernetes operator. To help them
-with this effort, we have created the [WebLogic Image Builder Tool](https://github.com/oracle/weblogic-imagebuilder-tool).
+with this effort, we have created the [WebLogic Image Tool](https://github.com/oracle/weblogic-image-tool).
 
 ## Table of Contents
 
-- [Features](#features-of-the-imagebuilder-tool)
+- [Features](#features-of-the-oracle-weblogic-image-tool)
 - [Prerequisites](#prerequisites)
 - [Setup](#setup)
   - [Create Image](site/create-image.md)
   - [Update Image](site/update-image.md)
   - [Cache](site/cache.md)
 
-## Features of the Oracle WebLogic Image Builder Tool
+## Features of the Oracle WebLogic Image Tool
 
 The Image Builder Tool can create a WebLogic Docker image from any base image (for example, Oracle Linux, Ubuntu), install a given version of
 WebLogic (for example, 12.2.1.3.0), install a given JDK (for example, 8u202), apply selected patches, and create a domain with a given
@@ -29,21 +29,21 @@ applying selected patches).
 - Active Internet connection. The tool needs to communicate with Oracle support system.
 - Oracle support credentials. These are used to validate and download patches.
 - WebLogic and JDK installers from OTN / e-delivery. These should be available on local disk.
-- Docker client and daemon on the build machine. Experimental features should be turned on to support the `docker build --squash` option. Refer to [Docker squash](https://docs.docker.com/engine/reference/commandline/build/#squash-an-images-layers---squash-experimental)
+- Docker client and daemon on the build machine.
 - Bash version 4.0 or higher to enable `<tab>` command complete feature
 
 ## Setup
 
-- Build the project (`mvn clean package`) to generate artifacts `imagebuilder-0.1-SNAPSHOT.zip`.
+- Build the project (`mvn clean package`) to generate artifacts `imagetool-0.1-SNAPSHOT.zip`.
 - Unzip to a desired location. This action should create lib, bin directories and LICENSE.txt.
 - If running an OS with bash, run `cd your_unzipped_location/bin` and `source setup.sh`.
-- On Windows, set up with `imagebuilder.cmd` or the `imagebuilder.bat` script:
+- On Windows, set up with `imagetool.cmd` or the `imagetool.bat` script:
     ```cmd
     @ECHO OFF
-    java -cp "your_unzipped_folder/lib" com.oracle.weblogicx.imagebuilder.cli.CLIDriver %*
+    java -cp "your_unzipped_folder/lib" com.oracle.weblogic.imagetool.cli.CLIDriver %*
     ```
-- Then, execute `imagebuilder help` to get the help screen.
-- You can execute the JAR directly using the command `java -cp "your_unzipped_folder/lib" com.oracle.weblogicx.imagebuilder.cli.CLIDriver help`.
+- Then, execute `imagetool help` to get the help screen.
+- You can execute the JAR directly using the command `java -cp "your_unzipped_folder/lib" com.oracle.weblogic.imagetool.cli.CLIDriver help`.
 - After you are familiar with the commands, you will be able to create and update WebLogic Docker images.
 
 ## Copyright

pom.xml

@@ -4,8 +4,8 @@
          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
 
     <modelVersion>4.0.0</modelVersion>
-    <groupId>com.oracle.weblogicx</groupId>
-    <artifactId>imagebuilder</artifactId>
+    <groupId>com.oracle.weblogic.lifecycle</groupId>
+    <artifactId>imagetool</artifactId>
     <version>0.1-SNAPSHOT</version>
 
     <properties>
@@ -58,11 +58,6 @@
             </resource>
         </resources>
         <plugins>
-            <!--<plugin>-->
-                <!--<groupId>org.apache.maven.plugins</groupId>-->
-                <!--<artifactId>maven-resources-plugin</artifactId>-->
-                <!--<version>3.1.0</version>-->
-            <!--</plugin>-->
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-jar-plugin</artifactId>
@@ -101,8 +96,8 @@
                         <argument>picocli.AutoComplete</argument>
                         <argument>--force</argument><!-- overwrite if exists -->
                         <argument>--completionScript</argument>
-                        <argument>${project.build.directory}/imagebuilder_completion.sh</argument>
-                        <argument>com.oracle.weblogicx.imagebuilder.cli.CLIDriver</argument>
+                        <argument>${project.build.directory}/imagetool_completion.sh</argument>
+                        <argument>com.oracle.weblogic.imagetool.cli.CLIDriver</argument>
                     </arguments>
                 </configuration>
             </plugin>

site/cache.md

@@ -4,7 +4,7 @@ Use the `cache` command to add or edit the required metadata for the tool. Cache
 required installers (WLS, FMW, JDK) are located and where to download the patches. There are several subcommands:
 
 ```
-Usage: imagebuilder cache [COMMAND]
+Usage: imagetool cache [COMMAND]
 List and set cache options
 
 Commands:
@@ -23,7 +23,7 @@ Commands:
 
 - `listItems`: Display the contents of the cache. Displays key value pairs of the installers and patches.
     ```
-    imagebuilder cache listItems
+    imagetool cache listItems
 
     Cache contents
     jdk_8u202=/Users/xyz/Downloads/cache/server-jre-8u202-linux-x64.tar.gz
@@ -35,28 +35,28 @@ Commands:
 
 - `addInstaller`: Add an installer to the cache, for example, JDK.
     ```
-    imagebuilder cache addInstaller --type jdk --version 8u202 --path /path/to/local/jdk.tar.gz
+    imagetool cache addInstaller --type jdk --version 8u202 --path /path/to/local/jdk.tar.gz
     ```
 
 - `addPatch`: Add a patch to the cache. This command verifies if the path points to a valid patch by querying the Oracle support portal.
     ```
-    imagebuilder cache addPatch --type wls --version 12.2.1.3.0 --user [email protected] --passwordEnv MYVAR --patchId p12345678 --path /path/to/patch.zip
+    imagetool cache addPatch --type wls --version 12.2.1.3.0 --user [email protected] --passwordEnv MYVAR --patchId p12345678 --path /path/to/patch.zip
     ```
 
 - `getCacheDir` and `setCacheDir`: Get or set the cache directory. Used to display or set the directory where patches will be downloaded.
     ```
-    imagebuilder cache getCacheDir
-    imagebuilder cache setCacheDir /path/to/dir
+    imagetool cache getCacheDir
+    imagetool cache setCacheDir /path/to/dir
     ```
 
 - `addEntry`: Consider this an expert mode where you can add key value pairs to the cache without any validation.
     ```
-    imagebuilder cache addEntry --key xyz_123 --value /path/to/file
+    imagetool cache addEntry --key xyz_123 --value /path/to/file
     ```
 
 - `deleteEntry`: Delete an entry from the cache for a given key. **Note**: This command does not delete files from the disk.
     ```
-    imagebuilder cache deleteEntry --key xyz_123
+    imagetool cache deleteEntry --key xyz_123
     ```
 
 ## Copyright

site/create-image.md

@@ -8,7 +8,7 @@ are marked with an asterisk (*). You can provide the password in one of the thre
 * File containing the password
 
 ```
-Usage: imagebuilder create [OPTIONS]
+Usage: imagetool create [OPTIONS]
 Build WebLogic docker image
       --docker=<dockerPath> path to docker executable. Default: docker
       --fromImage=<fromImage>
@@ -57,18 +57,18 @@ The commands below assume that all the required JDK, WLS or FMW (WebLogic infras
 
 - Create an image named `sample:wls` with the WebLogic installer 12.2.1.3.0, server JDK 8u202, and latest PSU applied.
     ```
-    imagebuilder create --tag sample:wls --latestPSU --user [email protected] --password hello
+    imagetool create --tag sample:wls --latestPSU --user [email protected] --password hello
     ```
 
 - Create an image named `sample:wdt` with the same options as above and create a domain with [WebLogic Deploy Tooling](https://github.com/oracle/weblogic-deploy-tooling).
     ```
-    imagebuilder create --tag sample:wdt --latestPSU --user [email protected] --password hello --wdtModel /path/to/model.json --wdtVariables /path/to/variables.json --wdtVersion 0.16
+    imagetool create --tag sample:wdt --latestPSU --user [email protected] --password hello --wdtModel /path/to/model.json --wdtVariables /path/to/variables.json --wdtVersion 0.16
     ```
     If `wdtVersion` is not provided, the tool uses the latest release.
 
 - Create an image named `sample:patch` with the selected patches applied.
     ```
-    imagebuilder create --tag sample:patch --user [email protected] --password hello --patches 12345678,p87654321
+    imagetool create --tag sample:patch --user [email protected] --password hello --patches 12345678,p87654321
     ```
     The patch numbers may or may not start with '`p`'.
 
@@ -79,7 +79,7 @@ The commands below assume that all the required JDK, WLS or FMW (WebLogic infras
    - This implies that the tool could not find the JDK installer in its cache.
    - Use the [cache](cache.md) command to fix it:
     ```
-    imagebuilder cache addInstaller --type jdk --version 8u202 --path /local/path/to/jdk.gz
+    imagetool cache addInstaller --type jdk --version 8u202 --path /local/path/to/jdk.gz
     ```
 ## Copyright
 Copyright (c) 2019 Oracle and/or its affiliates. All rights reserved.

site/update-image.md

@@ -8,7 +8,7 @@ are marked with asterisk (*). The password can be provided in one of the three w
 * File containing the password
 
 ```
-Usage: imagebuilder update [OPTIONS]
+Usage: imagetool update [OPTIONS]
 Update WebLogic docker image with selected patches
       --docker=<dockerPath> path to docker executable. Default: docker
 *     --fromImage=<fromImage>
@@ -40,12 +40,12 @@ Update WebLogic docker image with selected patches
 
 - Update an image named `sample:1.0` by applying the latest PSU and tag it as `sample:1.1`:
     ```
-    imagebuilder update --fromImage sample:1.0 --tag sample:1.1 --latestPSU --user [email protected] --passwordEnv MYVAR
+    imagetool update --fromImage sample:1.0 --tag sample:1.1 --latestPSU --user [email protected] --passwordEnv MYVAR
     ```
 
 - Update an image named `sample:1.0` with the selected patches applied.
     ```
-    imagebuilder update --fromImage sample:1.0 --tag sample:1.1 --user [email protected] --password hello --patches 12345678,p87654321
+    imagetool update --fromImage sample:1.0 --tag sample:1.1 --user [email protected] --password hello --patches 12345678,p87654321
     ```
     The patch numbers may or may not start with '`p`'.
 

src/main/bin/setup.sh

@@ -44,9 +44,9 @@ cd $PREV_DIR
 echo $RESULT_PATH
 }
 
-unalias imagebuilder 2> /dev/null
+unalias imagetool 2> /dev/null
 script_dir=$( dirname "$( read_link "${BASH_SOURCE[0]}" )" )
-IMAGEBUILDER_HOME=`cd "${script_dir}/.." ; pwd`
-export IMAGEBUILDER_HOME
-alias imagebuilder="${JAVA_HOME}/bin/java -cp \"${IMAGEBUILDER_HOME}/lib/*\" com.oracle.weblogicx.imagebuilder.cli.CLIDriver"
-source ${IMAGEBUILDER_HOME}/lib/imagebuilder_completion.sh
+IMAGETOOL_HOME=`cd "${script_dir}/.." ; pwd`
+export IMAGETOOL_HOME
+alias imagetool="${JAVA_HOME}/bin/java -cp \"${IMAGETOOL_HOME}/lib/*\" com.oracle.weblogic.imagetool.cli.CLIDriver"
+source ${IMAGETOOL_HOME}/lib/imagetool_completion.sh

src/main/java/com/oracle/weblogicx/imagebuilder/api/FileResolver.java renamed to src/main/java/com/oracle/weblogic/imagetool/api/FileResolver.java

@@ -3,9 +3,9 @@
 * Licensed under the Universal Permissive License v 1.0 as shown at http://oss.oracle.com/licenses/upl. 
 */
 
-package com.oracle.weblogicx.imagebuilder.api;
+package com.oracle.weblogic.imagetool.api;
 
-import com.oracle.weblogicx.imagebuilder.api.meta.CacheStore;
+import com.oracle.weblogic.imagetool.api.meta.CacheStore;
 
 public interface FileResolver {
 

src/main/java/com/oracle/weblogicx/imagebuilder/api/meta/CacheStore.java renamed to src/main/java/com/oracle/weblogic/imagetool/api/meta/CacheStore.java

@@ -3,7 +3,7 @@
 * Licensed under the Universal Permissive License v 1.0 as shown at http://oss.oracle.com/licenses/upl. 
 */
 
-package com.oracle.weblogicx.imagebuilder.api.meta;
+package com.oracle.weblogic.imagetool.api.meta;
 
 import java.util.Map;
 

src/main/java/com/oracle/weblogicx/imagebuilder/api/model/AbstractFile.java renamed to src/main/java/com/oracle/weblogic/imagetool/api/model/AbstractFile.java

@@ -2,9 +2,9 @@
 *                                                             
 * Licensed under the Universal Permissive License v 1.0 as shown at http://oss.oracle.com/licenses/upl. 
 */
-package com.oracle.weblogicx.imagebuilder.api.model;
+package com.oracle.weblogic.imagetool.api.model;
 
-import com.oracle.weblogicx.imagebuilder.api.FileResolver;
+import com.oracle.weblogic.imagetool.api.FileResolver;
 
 import java.nio.file.Files;
 import java.nio.file.Paths;

src/main/java/com/oracle/weblogicx/imagebuilder/api/model/CachePolicy.java renamed to src/main/java/com/oracle/weblogic/imagetool/api/model/CachePolicy.java

@@ -3,7 +3,7 @@
 * Licensed under the Universal Permissive License v 1.0 as shown at http://oss.oracle.com/licenses/upl. 
 */
 
-package com.oracle.weblogicx.imagebuilder.api.model;
+package com.oracle.weblogic.imagetool.api.model;
 
 /**
  * first - Use cache entries and download artifacts if required