Support domainHomeSourceType in generated WDT files (#233)

* convert VerrazzanoModels to resourceTemplates to make more generic and support VZ and WKO targets from WDT

* remove resourceTemplate/verrazzanoModels from rebase, and prevent resource file update on dryRun

Author: ddsharpe

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

@@ -11,7 +11,6 @@
 import java.nio.file.Path;
 import java.nio.file.Paths;
 import java.util.ArrayList;
-import java.util.Collections;
 import java.util.List;
 import java.util.Properties;
 import java.util.regex.Matcher;
@@ -34,7 +33,6 @@
 import com.oracle.weblogic.imagetool.util.DockerBuildCommand;
 import com.oracle.weblogic.imagetool.util.DockerfileOptions;
 import com.oracle.weblogic.imagetool.util.Utils;
-import com.oracle.weblogic.imagetool.util.VerrazzanoModel;
 import picocli.CommandLine.Option;
 import picocli.CommandLine.Unmatched;
 
@@ -48,9 +46,6 @@ public abstract class CommonOptions {
     private String tempDirectory = null;
     private String nonProxyHosts = null;
 
-    private List<Object> resolveOptions = null;
-    private List<Path> resolveFiles = null;
-
     abstract String getInstallerVersion();
 
     private void handleChown() {
@@ -182,23 +177,6 @@ void init(String buildId) throws Exception {
         logger.exiting();
     }
 
-    List<Path> gatherFiles() {
-        if (resolveFiles == null) {
-            resolveFiles = new ArrayList<>();
-        }
-        if (verrazzanoModel != null) {
-            resolveFiles.add(verrazzanoModel);
-        }
-        return resolveFiles;
-    }
-
-    List<Object> resolveOptions() {
-        if (resolveFiles != null && !resolveFiles.isEmpty()) {
-            resolveOptions = Collections.singletonList(new VerrazzanoModel(imageTag, dockerfileOptions.domain_home()));
-        }
-        return resolveOptions;
-    }
-
     /**
      * Returns true if any patches should be applied.
      * A PSU is considered a patch.
@@ -566,12 +544,6 @@ String getPassword() {
     )
     private boolean skipOpatchUpdate = false;
 
-    @Option(
-        names = {"--vzModel"},
-        description = "For verrazzano, resolve parameters in the verrazzano model with information from the image tool."
-    )
-    Path verrazzanoModel;
-
     @Option(
         names = {"--packageManager"},
         description = "Set the Linux package manager to use for installing OS packages. Default: ${DEFAULT-VALUE}"

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

@@ -95,10 +95,10 @@ public CommandResponse call() throws Exception {
             String dockerfile = Utils.writeDockerfile(tmpDir + File.separator + "Dockerfile",
                 "Create_Image.mustache", dockerfileOptions, dryRun);
 
-            // resolve parameters in the list of mustache templates returned by gatherFiles()
-            Utils.writeResolvedFiles(gatherFiles(), resolveOptions());
-
             runDockerCommand(dockerfile, cmdBuilder);
+            if (!dryRun) {
+                wdtOptions.handleResourceTemplates(imageTag);
+            }
         } catch (Exception ex) {
             logger.fine("**ERROR**", ex);
             return new CommandResponse(-1, ex.getMessage());

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

@@ -163,10 +163,10 @@ public CommandResponse call() throws Exception {
             String dockerfile = Utils.writeDockerfile(tmpDir + File.separator + "Dockerfile",
                 "Update_Image.mustache", dockerfileOptions, dryRun);
 
-            // resolve parameters in the list of mustache templates returned by gatherFiles()
-            Utils.writeResolvedFiles(gatherFiles(), resolveOptions());
-
             runDockerCommand(dockerfile, cmdBuilder);
+            if (!dryRun) {
+                wdtOptions.handleResourceTemplates(imageTag);
+            }
         } catch (Exception ex) {
             return new CommandResponse(-1, ex.getMessage());
         } finally {

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

@@ -17,6 +17,8 @@
 import com.oracle.weblogic.imagetool.logging.LoggingFactory;
 import com.oracle.weblogic.imagetool.util.DockerBuildCommand;
 import com.oracle.weblogic.imagetool.util.DockerfileOptions;
+import com.oracle.weblogic.imagetool.util.DomainHomeSourceType;
+import com.oracle.weblogic.imagetool.util.ResourceTemplateOptions;
 import com.oracle.weblogic.imagetool.util.Utils;
 import picocli.CommandLine.Option;
 
@@ -115,6 +117,28 @@ private List<String> addWdtFilesAsList(Path fileArg, String type, String tmpDir)
         return fileList;
     }
 
+    /**
+     * Resolve variables in the provided list of resource template files.
+     * See --resourceTemplates.  For example, WDT -target vz is used to generate a custom resource.
+     * In the generated file(s), WDT will not know what the image name is and will leave a placeholder.
+     * This function provides the values for variables that are known during image build.
+     */
+    public void handleResourceTemplates(String imageName) throws IOException {
+        DomainHomeSourceType domainType = DomainHomeSourceType.PV;
+        if (modelOnly()) {
+            domainType = DomainHomeSourceType.MODEL;
+        } else if (isUsingWdt()) {
+            domainType = DomainHomeSourceType.IMAGE;
+        }
+
+        ResourceTemplateOptions options = new ResourceTemplateOptions()
+            .domainHome(wdtDomainHome)
+            .imageName(imageName)
+            .domainHomeSourceType(domainType);
+
+        // resolve parameters in the list of mustache templates returned by gatherFiles()
+        Utils.writeResolvedFiles(resourceTemplates, options);
+    }
 
     @Option(
         names = {"--wdtModel"},
@@ -213,4 +237,11 @@ private List<String> addWdtFilesAsList(Path fileArg, String type, String tmpDir)
         description = "path to file the passphrase to decrypt the WDT model"
     )
     private Path encryptionKeyFile;
+
+    @Option(
+        names = {"--resourceTemplates"},
+        split = ",",
+        description = "Resolve variables in the resource template(s) with information from the image tool build."
+    )
+    List<Path> resourceTemplates;
 }

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

@@ -0,0 +1,25 @@
+// Copyright (c) 2020, Oracle Corporation and/or its affiliates.
+// Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl.
+
+package com.oracle.weblogic.imagetool.util;
+
+public enum DomainHomeSourceType {
+    MODEL("FromModel"),
+    IMAGE("Image"),
+    PV("PersistentVolume");
+
+    private String value;
+
+    /**
+     * Create an Enum value for the domain home source type.
+     * @param value value the value to use for substitution in the mustache template.
+     */
+    DomainHomeSourceType(String value) {
+        this.value = value;
+    }
+
+    @Override
+    public String toString() {
+        return value;
+    }
+}

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

@@ -0,0 +1,77 @@
+// Copyright (c) 2020, Oracle Corporation and/or its affiliates.
+// Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl.
+
+package com.oracle.weblogic.imagetool.util;
+
+/**
+ * Provide backing bean for Mustache templates provided in --resourceTemplates.
+ */
+public class ResourceTemplateOptions {
+    private String imageName;
+    private String domainHome;
+    private DomainHomeSourceType domainHomeSourceType = DomainHomeSourceType.PV;
+
+
+    /**
+     * Return the image name value passed in the image --tag argument.
+     *
+     * @return image tag name
+     */
+    public String imageName() {
+        return imageName;
+    }
+
+    /**
+     * Set the image name value.
+     *
+     * @param value image name from --tag argument.
+     * @return builder/this
+     */
+    public ResourceTemplateOptions imageName(String value) {
+        imageName = value;
+        return this;
+    }
+
+    /**
+     * Return the domain home passed in the --wdtDomainHome argument or the default if not provided.
+     *
+     * @return domain home value
+     */
+    public String domainHome() {
+        return domainHome;
+    }
+
+    /**
+     * Set the domain home.
+     *
+     * @param value the domain home from the --wdtDomainHome argument
+     * @return builder/this
+     */
+    public ResourceTemplateOptions domainHome(String value) {
+        domainHome = value;
+        return this;
+    }
+
+    /**
+     * Return the domain home type based on WDT inputs provided.
+     * If --wdtModelOnly, then type is FromModel.
+     * If not model only but --wdtModel is provided, then Image.
+     * Else, PersistentVolume (domain in PV).
+     *
+     * @return domain home source type
+     */
+    public String domainHomeSourceType() {
+        return domainHomeSourceType.toString();
+    }
+
+    /**
+     * Set the domain home source type (FromModel, Image, or PersistentVolume).
+     *
+     * @param value FromModel, Image, or PersistentVolume
+     * @return builder/this
+     */
+    public ResourceTemplateOptions domainHomeSourceType(DomainHomeSourceType value) {
+        domainHomeSourceType = value;
+        return this;
+    }
+}

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

@@ -219,7 +219,7 @@ public static String writeDockerfile(String destPath, String template, Dockerfil
      * @param options list of option files to resolve the mustache parameters
      * @throws IOException if a file in the fileNames is invalid
      */
-    public static void writeResolvedFiles(List<Path> paths, List<Object> options)
+    public static void writeResolvedFiles(List<Path> paths, ResourceTemplateOptions options)
         throws IOException {
         if (paths != null) {
             for (Path path : paths) {

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

@@ -71,7 +71,7 @@ IMG-0069=[[yellow: {0} - there are no recommended patches for version {1}]]
 IMG-0070=Failed to find latest patches for {0}, version {1}
 IMG-0071=WDT Operation is set to UPDATE, but the DOMAIN_HOME environment variable was not defined in the base image, {0}.  Did you mean to use "--wdtOperation CREATE" to create a new domain?
 IMG-0072=ORACLE_HOME environment variable is not defined in the base image: {0}
-IMG-0073=Invalid file {0} listed for Verrazzano model
+IMG-0073=Invalid file {0} listed for --resourceTemplates
 IMG-0074=OPatch will not be updated, fromImage has version {0}, available version is {1}
 IMG-0075=Added patch entry [[cyan: {0}]]={1}
 IMG-0076=Cache key {0} already exists, remove it first

imagetool/src/main/resources/ImageTool.properties

@@ -21,13 +21,11 @@
 import com.oracle.weblogic.imagetool.logging.LoggingFacade;
 import com.oracle.weblogic.imagetool.logging.LoggingFactory;
 import com.oracle.weblogic.imagetool.util.DockerfileOptions;
-import com.oracle.weblogic.imagetool.util.Utils;
 import org.junit.jupiter.api.Tag;
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.io.TempDir;
 
 import static org.junit.jupiter.api.Assertions.assertEquals;
-import static org.junit.jupiter.api.Assertions.assertTrue;
 import static org.junit.jupiter.api.Assertions.fail;
 
 @Tag("unit")
@@ -135,41 +133,47 @@ void handleAdditionalBuildCommands(@TempDir File buildDir) throws Exception {
      */
     @Test
     void testResolveOptions() throws Exception {
-        CreateImage createImage = new CreateImage();
+        final String IMG_NAME = "mydomain:latest";
+        final String DOMAIN_HOME = "/u01/domains/xxxx";
+        final String DOMAIN_SOURCE = "PersistentVolume";
 
-        // accessing private fields normally set by the command line
-        Field optionsField = CommonOptions.class.getDeclaredField("dockerfileOptions");
-        optionsField.setAccessible(true);
-        DockerfileOptions dockerfile = new DockerfileOptions("testbuildid");
-        optionsField.set(createImage, dockerfile);
+        WdtOptions wdtOptions = new WdtOptions();
 
-        Field imageTagField = CommonOptions.class.getDeclaredField("imageTag");
-        imageTagField.setAccessible(true);
-        imageTagField.set(createImage, "mydomain:latest");
-
-        Field resolveFilesField = CommonOptions.class.getDeclaredField("resolveFiles");
-        resolveFilesField.setAccessible(true);
+        // accessing private fields normally set by the command line
+        Field resourceTemplatesField = WdtOptions.class.getDeclaredField("resourceTemplates");
+        resourceTemplatesField.setAccessible(true);
         List<Path> resolveFiles =
             Arrays.asList(new File("target/test-classes/templates/resolver.yml").toPath(),
             new File("target/test-classes/templates/verrazzano.yml").toPath());
-        resolveFilesField.set(createImage, resolveFiles);
+        resourceTemplatesField.set(wdtOptions, resolveFiles);
+
+        Field imageTagField = WdtOptions.class.getDeclaredField("wdtDomainHome");
+        imageTagField.setAccessible(true);
+        imageTagField.set(wdtOptions, DOMAIN_HOME);
 
-        Utils.writeResolvedFiles(resolveFiles, createImage.resolveOptions());
+        wdtOptions.handleResourceTemplates(IMG_NAME);
 
         List<String> linesRead =
             Files.readAllLines(new File("target/test-classes/templates/resolver.yml").toPath());
-        assertEquals(2, linesRead.size(), "Number of lines read from the file was unexpected");
+        assertEquals(3, linesRead.size(), "Number of lines read from the file was unexpected");
         for (String line : linesRead) {
-            line = line.trim();
-            if (line.startsWith("domainHome")) {
-                assertTrue(line.endsWith("/u01/domains/base_domain"), "Invalid domain home value " + line);
-            } else if (line.startsWith("image")) {
-                assertTrue(line.endsWith("mydomain:latest"),
-                    "Invalid tag name " + line);
-            } else {
-                fail("Unexpected line read " + line);
+            String[] linePart = line.split(" ");
+            if (linePart.length != 2) {
+                fail("Resolving template file, resolver.yml, failed to resolve line: " + line);
+            }
+            switch (linePart[0]) {
+                case "domainHome:":
+                    assertEquals(DOMAIN_HOME, linePart[1], "Invalid domain home value: " + line);
+                    break;
+                case "image:":
+                    assertEquals(IMG_NAME, linePart[1], "Invalid image name value: " + line);
+                    break;
+                case "domainHomeSourceType:":
+                    assertEquals(DOMAIN_SOURCE, linePart[1], "Invalid domain home source type: " + line);
+                    break;
+                default:
+                    fail("Unexpected line in resolver.yml: " + line);
             }
-
         }
     }
 }