Change default for --chown in UPDATE to the owner:group of the Oracle Home in the fromImage

Author: ddsharpe

documentation/1.11/content/userguide/tools/update-image.md

@@ -25,13 +25,13 @@ Update WebLogic Docker image with selected patches
 ```
 | Parameter | Definition | Default |
 | --- | --- | --- |
-| `--fromImage` | (Required) Container image to be updated. The `fromImage` option serves as a starting point for the new image to be created. |   |
+| `--fromImage` | (Required) Container image to be extended. The provided image MUST contain an Oracle Home with middleware installed. The `fromImage` option serves as a starting point for the new image to be created. |   |
 | `--tag` | (Required) Tag for the final build image. Example: `store/oracle/weblogic:12.2.1.3.0`  |   |
 | `--additionalBuildCommands` | Path to a file with additional build commands. For more details, see [Additional information](#--additionalbuildcommands). |
 | `--additionalBuildFiles` | Additional files that are required by your `additionalBuildCommands`.  A comma separated list of files that should be copied to the build context. See [Additional information](#--additionalbuildfiles). |
 | `--builder`, `-b` | Executable to process the Dockerfile. Use the full path of the executable if not on your path. | `docker`  |
 | `--buildNetwork` | Networking mode for the RUN instructions during the image build.  See `--network` for Docker `build`.  |   |
-| `--chown` | `userid:groupid` for JDK/Middleware installs and patches.  | `oracle:oracle` |
+| `--chown` | `userid:groupid` for middleware patches and other operations.  | Owner:Group of the Oracle Home |
 | `--dryRun` | Skip Docker build execution and print the Dockerfile to stdout.  |  |
 | `--httpProxyUrl` | Proxy for the HTTP protocol. Example: `http://myproxy:80` or `http:user:passwd@myproxy:8080`  |   |
 | `--httpsProxyUrl` | Proxy for the HTTPS protocol. Example: `https://myproxy:80` or `https:user:passwd@myproxy:8080`  |   |

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

@@ -46,7 +46,8 @@ public abstract class CommonOptions {
     private String buildId;
 
     private void handleChown() {
-        if (!isOptionSet("--chown")) {
+        if (!isChownSet()) {
+            // nothing to do, user did not specify --chown on the command line
             return;
         }
 
@@ -170,7 +171,7 @@ void initializeOptions() throws InvalidCredentialException, IOException, Invalid
         if (kubernetesTarget == KubernetesTarget.OPENSHIFT) {
             dockerfileOptions.setDomainGroupAsUser(true);
             // if the user did not set the OS user:group, make the default oracle:root, instead of oracle:oracle
-            if (!isOptionSet(osUserAndGroup)) {
+            if (!isChownSet()) {
                 dockerfileOptions.setGroupId("root");
             }
         }
@@ -240,6 +241,15 @@ public void cleanup() throws IOException, InterruptedException {
         Utils.removeIntermediateDockerImages(buildEngine, buildId());
     }
 
+    /**
+     * If the user provided a value to alter the default user:group, return true.
+     *
+     * @return true if the user provided a value to change user:group.
+     */
+    public boolean isChownSet() {
+        return isOptionSet("--chown");
+    }
+
     private boolean isOptionSet(String optionName) {
         CommandLine.ParseResult pr = spec.commandLine().getParseResult();
         return pr.hasMatchedOption(optionName);

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

@@ -77,8 +77,20 @@ public CommandResponse call() throws Exception {
 
             String baseImageUsr = baseImageProperties.getProperty("oracleHomeUser");
             String baseImageGrp = baseImageProperties.getProperty("oracleHomeGroup");
-            if (!dockerfileOptions.userid().equals(baseImageUsr) || !dockerfileOptions.groupid().equals(baseImageGrp)) {
-                return CommandResponse.error("IMG-0087", fromImage(), baseImageUsr, baseImageGrp);
+
+            if (isChownSet()) {
+                // --chown for UPDATE no longer makes sense if the value must always be what the fromImage is.
+                if (!dockerfileOptions.userid().equals(baseImageUsr)
+                    || !dockerfileOptions.groupid().equals(baseImageGrp)) {
+                    // if the user specified a --chown that did not match the fromImage(), error
+                    return CommandResponse.error("IMG-0087", fromImage(), baseImageUsr, baseImageGrp);
+                }
+            } else {
+                // if the user did not specify --chown, use the user:group for the Oracle Home found in the --fromImage
+                dockerfileOptions.setUserId(baseImageUsr);
+                dockerfileOptions.setGroupId(baseImageGrp);
+                logger.fine("--chown not set by user. Using values found in --fromImage {0} for --chown {1}:{2}",
+                    fromImage(), baseImageUsr, baseImageGrp);
             }
 
             List<InstalledPatch> installedPatches = Collections.emptyList();

imagetool/src/test/java/com/oracle/weblogic/imagetool/cli/menu/CommonOptionsTest.java

@@ -27,6 +27,8 @@
 import picocli.CommandLine;
 
 import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertFalse;
+import static org.junit.jupiter.api.Assertions.assertTrue;
 import static org.junit.jupiter.api.Assertions.fail;
 
 @Tag("unit")
@@ -202,4 +204,24 @@ void testResolveOptions() throws Exception {
             }
         }
     }
+
+    /**
+     * isChownSet() true if the user provided a user:group on the CLI.
+     */
+    @Test
+    void isChownSet() {
+        CreateImage createImage = new CreateImage();
+        new CommandLine(createImage).parseArgs("--tag", "x:1", "--chown", "oracle:root");
+        assertTrue(createImage.isChownSet());
+    }
+
+    /**
+     * isChownSet() returns false if the user did not provide a user:group on the CLI.
+     */
+    @Test
+    void isChownNotSet() {
+        CreateImage createImage = new CreateImage();
+        new CommandLine(createImage).parseArgs("--tag", "x:1");
+        assertFalse(createImage.isChownSet());
+    }
 }

imagetool/src/test/java/com/oracle/weblogic/imagetool/logging/FileFormatterTest.java

@@ -0,0 +1,17 @@
+// Copyright (c) 2022, Oracle 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.logging;
+
+import org.junit.jupiter.api.Test;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+
+
+class FileFormatterTest {
+
+    @Test
+    void format() {
+        assertEquals(true, true);
+    }
+}