Java poc

Former-commit-id: 53787cec1f997eb342484ec37c736be6f5f2d1bb

Author: gosurya-oracle

README.md

@@ -33,6 +33,22 @@ applying selected patches.
 - Docker client and daemon on the build machine
   - Experimental features should be turned on to support docker build --squash option.
 
-## Initialization
-
-Build the project to
+## Setup
+
+- Build the project to generate artifacts imagebuilder-0.1-SNAPSHOT.jar and imagebuilder_completion.sh
+- The jar is an uber-jar containing all the required packages to run the tool.
+- If running an os with bash, Use the below commands to setup the tool with tab complete feature.
+   ```bash
+   #!/usr/bin/env bash
+   unalias imagebuilder 2> /dev/null
+   alias imagebuilder='java -cp "./imagebuilder-0.1-SNAPSHOT.jar" com.oracle.weblogicx.imagebuilder.cli.CLIDriver'
+   source ./imagebuilder_completion.sh
+   ```
+- On Windows, setup imagebuilder.cmd or imagebuilder.bat script
+    ```cmd
+    @ECHO OFF
+    java -cp "./imagebuilder-0.1-SNAPSHOT.jar" com.oracle.weblogicx.imagebuilder.cli.CLIDriver %*
+    ```
+- Then, execute "imagebuilder help" to get the help screen
+- The jar can be executed directly using command java -cp "./imagebuilder-0.1-SNAPSHOT.jar" com.oracle.weblogicx.imagebuilder.cli.CLIDriver help
+- Once familiar with the commands, you should be able to create and update WebLogic docker images

pom.xml

@@ -4,11 +4,12 @@
          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>oracle.weblogicx</groupId>
+    <groupId>com.oracle.weblogicx</groupId>
     <artifactId>imagebuilder</artifactId>
-    <version>1.0-SNAPSHOT</version>
+    <version>0.1-SNAPSHOT</version>
 
     <properties>
+        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
         <maven.compiler.source>1.8</maven.compiler.source>
         <maven.compiler.target>1.8</maven.compiler.target>
         <exec-maven-plugin.version>1.6.0</exec-maven-plugin.version>
@@ -61,7 +62,7 @@
                         <classpath/>
                         <argument>picocli.AutoComplete</argument>
                         <argument>--force</argument><!-- overwrite if exists -->
-                        <argument>--writeCommandScript</argument>
+                        <!--<argument>&#45;&#45;writeCommandScript</argument>-->
                         <argument>--completionScript</argument>
                         <argument>${project.build.directory}/imagebuilder_completion.sh</argument>
                         <argument>com.oracle.weblogicx.imagebuilder.cli.CLIDriver</argument>

site/cache.md

@@ -0,0 +1,61 @@
+# Cache
+
+The cache command is used to add / edit the required metadata for the tool. Cache helps the tool to identify where the 
+required installers (wls, fmw, jdk) are located and where to download the patches to. There are several subcommands to 
+aid the user.
+
+```
+Usage: imagebuilder cache [COMMAND]
+List and set cache options
+
+Commands:
+
+  listItems     List cache contents
+  addInstaller  Add cache entry for wls, fmw, jdk or wdt installer
+  addPatch      Add cache entry for wls|fmw patch or psu
+  getCacheDir   Prints the cache directory path
+  setCacheDir   Sets the cache directory where to download required artifacts
+  addEntry      Command to add a cache entry. Use caution
+  deleteEntry   Command to delete a cache entry
+  help          Displays help information about the specified command
+```
+
+## Usage scenarios
+
+- listItems: Display the contents of cache. Displays key value pairs of the installers, patches.
+    ```
+    imagebuilder cache listItems
+
+    Cache contents
+    jdk_8u202=/Users/xyz/Downloads/cache/server-jre-8u202-linux-x64.tar.gz
+    12345678_600000000012345=/Users/xyz/Downloads/cache/p12345678_122130_Generic.zip
+    87654321_600000000654321=/Users/xyz/Downloads/cache/p87654321_139400_Generic.zip
+    wls_12.2.1.3.0=/Users/xyz/Downloads/cache/fmw_12.2.1.3.0_wls_Disk1_1of1.zip
+    cache.dir=/Users/xyz/Downloads/cache
+    ```
+
+- addInstaller: Add installer to cache, ex: jdk
+    ```
+    imagebuilder cache addInstaller --type jdk --version 8u202 --path /path/to/local/jdk.tar.gz
+    ```
+
+- addPatch: Add patch to cache. This command verifies if the path points to a valid patch by querying Oracle support portal
+    ```
+    imagebuilder cache addPatch --type wls --version 12.2.1.3.0 --user [email protected] --passwordEnv MYVAR --patchId 12345678 --path /path/to/patch.zip
+    ```
+
+- getCacheDir and setCacheDir: Get/Set cache directory. Used to display or set the directory where patches will be downloaded to by the tool.
+    ```
+    imagebuilder cache getCacheDir
+    imagebuilder cache setCacheDir /path/to/dir
+    ```
+    
+- addEntry: Consider this as an expert mode where you can add key value pairs to cache without any validation.
+    ```
+    imagebuilder cache addEntry --key xyz_123 --value /path/to/file
+    ```
+
+- deleteEntry: Delete a entry from cache for a given key. _Note: This command does not delete files from disk._ 
+    ```
+    imagebuilder cache deleteEntry --key xyz_123
+    ```

site/create-image.md

@@ -7,7 +7,6 @@ are marked with asterisk (*). Password can be provided in one of the three ways.
 3) File containing the password
 
 ```
-Missing required options [--tag=TAG, --user=<support email>]
 Usage: imagebuilder create [OPTIONS]
 Build WebLogic docker image
       --docker=<dockerPath> path to docker executable. Default: docker
@@ -59,7 +58,7 @@ The commands below assume that all the required jdk, wls or fmw (WebLogic infras
     ```
     imagebuilder create --tag sample:wls --latestPSU --user [email protected] --password hello
     ```
-    
+
 - Create an image named sample:wdt with 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

site/update-image.md

@@ -0,0 +1,50 @@
+# Update Image
+
+The update command is used to apply patches to an existing WebLogic docker image. The required options for the command 
+are marked with asterisk (*). Password can be provided in one of the three ways.
+ 
+1) Plain Text
+2) Environment Variable
+3) File containing the password
+
+```
+Usage: imagebuilder update [OPTIONS]
+Update WebLogic docker image with selected patches
+      --docker=<dockerPath> path to docker executable. Default: docker
+*     --fromImage=<fromImage>
+                            Docker image to use as base image.
+      --httpProxyUrl=<httpProxyUrl>
+                            proxy for http protocol. Ex: http://myproxy:80 or http:
+                              //user:passwd@myproxy:8080
+      --httpsProxyUrl=<httpsProxyUrl>
+                            proxy for https protocol. Ex: http://myproxy:80 or http:
+                              //user:passwd@myproxy:8080
+      --latestPSU           Whether to apply patches from latest PSU.
+      --password=<password for support user id>
+                            Password for support userId
+      --passwordEnv=<environment variable>
+                            environment variable containing the support password
+      --passwordFile=<password file>
+                            path to file containing just the password
+      --patches=patchId[,patchId...]
+                            Comma separated patch Ids. Ex: p12345678,p87654321
+*     --tag=TAG             Tag for the final build image. Ex: store/oracle/weblogic:
+                              12.2.1.3.0
+*     --user=<support email>
+                            Oracle Support email id
+```
+
+## Usage scenarios
+
+**_Note: Use --passwordEnv or --passwordFile instead of --password_**
+
+- 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
+    ```
+
+- Update an image named sample:1.0 with selected patches applied.
+    ```
+    imagebuilder 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/java/com/oracle/weblogicx/imagebuilder/cli/cache/AddEntry.java

@@ -50,7 +50,7 @@ public CommandResponse call() {
     private String key;
 
     @Option(
-            names = {"--path"},
+            names = {"--value"},
             description = "Value for the cache entry",
             required = true
     )

src/main/java/com/oracle/weblogicx/imagebuilder/cli/cache/AddInstallerEntry.java

@@ -15,7 +15,7 @@
 
 @Command(
         name = "addInstaller",
-        description = "Add cache entry for wls|fmw or jdk installer",
+        description = "Add cache entry for wls, fmw, jdk or wdt installer",
         sortOptions = false
 )
 public class AddInstallerEntry extends CacheOperation {

src/main/java/com/oracle/weblogicx/imagebuilder/cli/cache/AddPatchEntry.java

@@ -14,14 +14,13 @@
 import picocli.CommandLine.Command;
 import picocli.CommandLine.Option;
 
-import java.io.BufferedReader;
 import java.io.FileInputStream;
-import java.io.FileReader;
 import java.io.IOException;
 import java.nio.file.Files;
 import java.nio.file.Path;
 
 import static com.oracle.weblogicx.imagebuilder.api.meta.CacheStore.CACHE_KEY_SEPARATOR;
+import static com.oracle.weblogicx.imagebuilder.util.Constants.PATCH_ID_REGEX;
 
 @Command(
         name = "addPatch",
@@ -46,9 +45,11 @@ public CommandResponse call() throws Exception {
                 && userId != null && !userId.isEmpty()
                 && password != null && !password.isEmpty()
                 && location != null && Files.exists(location) && Files.isRegularFile(location)) {
-            String patchNumber = this.patchId.toLowerCase();
-            if (patchNumber.startsWith("p") && patchNumber.length() > 1) {
-                patchNumber = patchNumber.substring(1);
+            String patchNumber;
+            if (patchId.matches(PATCH_ID_REGEX)) {
+                patchNumber = patchId.substring(1);
+            } else {
+                return new CommandResponse(-1, "Invalid patch id format: " + patchId);
             }
             SearchResult result = ARUUtil.getPatchDetail(type.toString(), version, patchNumber, userId, password);
             if (result.isSuccess()) {

src/main/java/com/oracle/weblogicx/imagebuilder/cli/menu/CreateImage.java

@@ -7,7 +7,6 @@
 import com.oracle.weblogicx.imagebuilder.api.model.InstallerType;
 import com.oracle.weblogicx.imagebuilder.api.model.WLSInstallerType;
 import com.oracle.weblogicx.imagebuilder.impl.InstallerFile;
-import com.oracle.weblogicx.imagebuilder.util.ARUUtil;
 import com.oracle.weblogicx.imagebuilder.util.Constants;
 import com.oracle.weblogicx.imagebuilder.util.HttpUtil;
 import com.oracle.weblogicx.imagebuilder.util.Utils;
@@ -56,14 +55,6 @@ public CommandResponse call() throws Exception {
 
         Instant startTime = Instant.now();
 
-//        System.out.println("hello");
-//        System.out.println("WLSInstallerType = \"" + installerType + "\"");
-//        System.out.println("InstallerVersion = \"" + installerVersion + "\"");
-//        System.out.println("latestPSU = \"" + latestPSU + "\"");
-//        System.out.println("patches = \"" + patches + "\"");
-//        System.out.println("fromImage = \"" + fromImage + "\"");
-//        System.out.println("userId = \"" + userId + "\"");
-
         FileHandler fileHandler = setupLogger(isCLIMode);
         Path tmpDir = null;
         Path tmpDir2 = null;
@@ -75,16 +66,6 @@ public CommandResponse call() throws Exception {
                 return result;
             }
 
-            /*
-            password = handlePasswordOptions();
-            handleProxyUrls();
-
-            // check user support credentials
-            if (!ARUUtil.checkCredentials(userId, password)) {
-                return new CommandResponse(-1, "user Oracle support credentials do not match");
-            }
-            */
-
             List<String> cmdBuilder = getInitialBuildCmd();
 
             // create a tmp directory for user.
@@ -146,7 +127,6 @@ public CommandResponse call() throws Exception {
             Utils.runDockerCommand(cmdBuilder, dockerLog);
 
         } catch (Exception ex) {
-            //ex.printStackTrace();
             return new CommandResponse(-1, ex.getMessage());
         } finally {
             Utils.deleteFilesRecursively(tmpDir);

src/main/java/com/oracle/weblogicx/imagebuilder/cli/menu/ImageOperation.java

@@ -31,6 +31,7 @@
 import static com.oracle.weblogicx.imagebuilder.util.Constants.BUILD_ARG;
 import static com.oracle.weblogicx.imagebuilder.util.Constants.HTTP;
 import static com.oracle.weblogicx.imagebuilder.util.Constants.HTTPS;
+import static com.oracle.weblogicx.imagebuilder.util.Constants.PATCH_ID_REGEX;
 
 public abstract class ImageOperation implements Callable<CommandResponse> {
 
@@ -90,8 +91,13 @@ List<String> handlePatchFiles(Path tmpDir, Path tmpPatchesDir) throws Exception
         }
         if (patches != null && !patches.isEmpty()) {
             for (String patchId : patches) {
-                patchLocations.add(new PatchFile(installerType.toString(), installerVersion, patchId, userId, password)
-                        .resolve(cacheStore));
+                if (patchId.matches(PATCH_ID_REGEX)) {
+                    patchId = patchId.substring(1);
+                    patchLocations.add(new PatchFile(installerType.toString(), installerVersion, patchId, userId,
+                            password).resolve(cacheStore));
+                } else {
+                    logger.severe("Ignoring invalid patch id format: " + patchId);
+                }
             }
         }
         for (String patchLocation : patchLocations) {