From e41bc7069a8c3c6f4cb0a6a26b5799d9a329e3c4 Mon Sep 17 00:00:00 2001 From: Derek Sharpe Date: Wed, 27 Jul 2022 16:16:35 -0500 Subject: [PATCH 001/104] Move user settings to YAML-based configuration --- imagetool/pom.xml | 6 +- .../imagetool/settings/UserSettings.java | 245 ++++++++++++++++++ .../imagetool/settings/UserSettingsTest.java | 51 ++++ .../resources/settings/basic_settings.yaml | 3 + .../resources/settings/invalid_settings.yaml | 3 + installer/pom.xml | 6 +- pom.xml | 7 +- tests/pom.xml | 2 +- 8 files changed, 319 insertions(+), 4 deletions(-) create mode 100644 imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/UserSettings.java create mode 100644 imagetool/src/test/java/com/oracle/weblogic/imagetool/settings/UserSettingsTest.java create mode 100644 imagetool/src/test/resources/settings/basic_settings.yaml create mode 100644 imagetool/src/test/resources/settings/invalid_settings.yaml diff --git a/imagetool/pom.xml b/imagetool/pom.xml index ca518f1f..dad05b57 100644 --- a/imagetool/pom.xml +++ b/imagetool/pom.xml @@ -13,7 +13,7 @@ imagetool-parent com.oracle.weblogic.lifecycle.imagetool - 1.11.3-SNAPSHOT + 2.0.0-SNAPSHOT ../pom.xml @@ -51,6 +51,10 @@ uk.org.webcompere system-stubs-jupiter + + org.yaml + snakeyaml + diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/UserSettings.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/UserSettings.java new file mode 100644 index 00000000..debcf37c --- /dev/null +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/UserSettings.java @@ -0,0 +1,245 @@ +// 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.settings; + +import java.io.IOException; +import java.io.InputStream; +import java.nio.file.Files; +import java.nio.file.Path; +import java.nio.file.Paths; +import java.util.Map; + +import com.oracle.weblogic.imagetool.logging.LoggingFacade; +import com.oracle.weblogic.imagetool.logging.LoggingFactory; +import com.oracle.weblogic.imagetool.util.Utils; +import org.yaml.snakeyaml.DumperOptions; +import org.yaml.snakeyaml.Yaml; +import org.yaml.snakeyaml.introspector.PropertyUtils; +import org.yaml.snakeyaml.nodes.Tag; +import org.yaml.snakeyaml.representer.Representer; + +public class UserSettings { + private static final LoggingFacade logger = LoggingFactory.getLogger(UserSettings.class); + + /** + * Parent directory for the build context directory. + * A temporary folder created under "Build Directory" with the prefix "wlsimgbuilder_tempXXXXXXX" will be created + * to hold the image build context (files, and Dockerfile). + */ + private final String imageBuildDirectory; + + /** + * Patch download directory. + * The directory for storing and using downloaded patches. + */ + private final String patchDirectory; + + /** + * Installer download directory. + * The directory for storing and using downloaded Java and middleware installers. + */ + private final String installerDirectory; + + /** + * Container image build tool. + * Allow the user to specify the executable that will be used to build the container image. For example, + * "/usr/local/bin/docker" or just "docker" if "docker" is on the user's path. For example, "podman" or "docker". + */ + private final String buildEngine; + + /** + * Container image runtime tool. + * Allow the user to specify the executable that will be used to run and/or interrogate images. For example, + * "/usr/local/bin/docker" or just "docker" if "docker" is on the user's path. For example, "podman" or "docker". + */ + private final String containerEngine; + + /** + * REST calls to ARU should be retried up to this number of times. + */ + private final Integer aruRetryMax; + + /** + * The time between each ARU REST call in milliseconds. + */ + private final Integer aruRetryInterval; + + /** + * Default construct with all default values for settings. + */ + public UserSettings() { + patchDirectory = null; + installerDirectory = null; + imageBuildDirectory = null; + buildEngine = null; + containerEngine = null; + + aruRetryMax = null; + aruRetryInterval = null; + } + + /** + * Extract the Map of settings (from a YAML file), into a Java Bean, UserSettings. + * @param settings A map of key-value pairs read in from the YAML user settings file. + */ + public UserSettings(Map settings) { + // While yaml.loadAs() will do about the same thing, I opted to use Map because Map is more forgiving. + // Bad fields or extra data fields not in this version of ImageTool will cause yaml.loadAs to completely fail. + patchDirectory = getValue("patchDirectory", String.class, settings); + installerDirectory = getValue("installerDirectory", String.class, settings); + imageBuildDirectory = getValue("imageBuildDirectory", String.class, settings); + buildEngine = getValue("buildEngine", String.class, settings); + containerEngine = getValue("containerEngine", String.class, settings); + + aruRetryMax = getValue("aruRetryMax", Integer.class, settings); + aruRetryInterval = getValue("aruRetryInterval", Integer.class, settings); + } + + /** + * The file system path to the directory where the settings file should be. + * @return The path to ~/.imagetool + */ + public static Path getSettingsDirectory() { + return Paths.get(System.getProperty("user.home"), ".imagetool"); + } + + /** + * Loads the settings.yaml file from ~/.imagetool/settings.yaml and returns the values as UserSettings. + * @return The user settings parsed from ~/.imagetool/settings.yaml + */ + public static UserSettings instance() { + Path settingsFile = getSettingsDirectory().resolve("settings.yaml"); + try (InputStream input = Files.newInputStream(settingsFile)) { + return load(input); + } catch (IOException ioe) { + logger.fine("Unable to open saved settings: {0}", ioe.getMessage(), ioe); + return new UserSettings(); + } + } + + /** + * Utility method to convert the InputStream with YAML into UserSettings. + * @param settings An InputStream with the raw YAML text. + * @return The UserSettings containing the parsed values from the InputStream. + */ + public static UserSettings load(InputStream settings) { + Yaml yaml = new Yaml(); + Map map = yaml.load(settings); + return new UserSettings(map); + } + + private T getValue(String settingName, Class type, Map settings) { + Object value = settings.get(settingName); + if (value == null) { + return null; + } + + if (type.isInstance(value)) { + return type.cast(value); + } else { + logger.severe("Setting for {0} could not be loaded. Expected {1}, but found {2}. Invalid value: {3}", + settingName, type, value.getClass(), value.toString()); + return null; + } + } + + /** + * Parent directory for the build context directory. + * A temporary folder created under "Build Directory" with the prefix "wlsimgbuilder_tempXXXXXXX" will be created + * to hold the image build context (files, and Dockerfile). + */ + public String getImageBuildDirectory() { + if (Utils.isEmptyString(imageBuildDirectory)) { + return "."; + } + return imageBuildDirectory; + } + + /** + * Patch download directory. + * The directory for storing and using downloaded patches. + */ + public String getPatchDirectory() { + if (Utils.isEmptyString(patchDirectory)) { + return getSettingsDirectory().resolve("patches").toString(); + } + return patchDirectory; + } + + /** + * Installer download directory. + * The directory for storing and using downloaded Java and middleware installers. + */ + public String installerDirectory() { + if (Utils.isEmptyString(installerDirectory)) { + return getSettingsDirectory().resolve("installers").toString(); + } + return installerDirectory; + } + + /** + * Container image build tool. + * Allow the user to specify the executable that will be used to build the container image. For example, + * "/usr/local/bin/docker" or just "docker" if "docker" is on the user's path. For example, "podman" or "docker". + */ + public String getBuildEngine() { + if (Utils.isEmptyString(buildEngine)) { + return "docker"; + } + return buildEngine; + } + + /** + * Container image runtime tool. + * Allow the user to specify the executable that will be used to run and/or interrogate images. For example, + * "/usr/local/bin/docker" or just "docker" if "docker" is on the user's path. For example, "podman" or "docker". + */ + public String getContainerEngine() { + if (Utils.isEmptyString(containerEngine)) { + return getBuildEngine(); + } + return containerEngine; + } + + /** + * REST calls to ARU should be retried up to this number of times. + */ + public int getAruRetryMax() { + if (aruRetryMax == null) { + return 10; + } + return aruRetryMax; + } + + /** + * The time between each ARU REST call in milliseconds. + */ + public int getAruRetryInterval() { + if (aruRetryInterval == null) { + return 500; + } + return aruRetryInterval; + } + + /** + * UserSettings as a YAML string. + * @return UserSettings as a YAML string. + */ + public String toYamlString() { + DumperOptions options = new DumperOptions(); + options.setIndent(2); + options.setPrettyFlow(true); + options.setDefaultFlowStyle(DumperOptions.FlowStyle.BLOCK); + + PropertyUtils propertyUtils = new PropertyUtils(); + propertyUtils.setAllowReadOnlyProperties(true); + Representer representer = new Representer(); + representer.addClassTag(UserSettings.class, Tag.MAP); + representer.setDefaultFlowStyle(DumperOptions.FlowStyle.BLOCK); + representer.setPropertyUtils(propertyUtils); + + Yaml yaml = new Yaml(representer); + return yaml.dump(this); + } +} diff --git a/imagetool/src/test/java/com/oracle/weblogic/imagetool/settings/UserSettingsTest.java b/imagetool/src/test/java/com/oracle/weblogic/imagetool/settings/UserSettingsTest.java new file mode 100644 index 00000000..be63a230 --- /dev/null +++ b/imagetool/src/test/java/com/oracle/weblogic/imagetool/settings/UserSettingsTest.java @@ -0,0 +1,51 @@ +// 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.settings; + +import java.io.InputStream; + +import org.junit.jupiter.api.Test; + +import static org.junit.jupiter.api.Assertions.assertEquals; + +class UserSettingsTest { + + @Test + void testSimpleSettingsFile() { + InputStream inputStream = this.getClass() + .getClassLoader() + .getResourceAsStream("settings/basic_settings.yaml"); + UserSettings settings = UserSettings.load(inputStream); + assertEquals("/home/user/patches", settings.getPatchDirectory()); + assertEquals("./builds", settings.getImageBuildDirectory()); + assertEquals("docker", settings.getBuildEngine()); + assertEquals("docker", settings.getContainerEngine()); + assertEquals(10, settings.getAruRetryMax()); + assertEquals(200, settings.getAruRetryInterval()); + } + + @Test + void testInvalidSettings() { + InputStream inputStream = this.getClass() + .getClassLoader() + .getResourceAsStream("settings/invalid_settings.yaml"); + UserSettings settings = UserSettings.load(inputStream); + assertEquals("/home/user/patches", settings.getPatchDirectory()); + assertEquals(".", settings.getImageBuildDirectory()); + } + + //@Test + void testOutput() { + //TODO: re-enable this test + String expected = "aruRetryInterval: 200\n" + + "imageBuildDirectory: ./builds\n" + + "patchDirectory: /home/user/patches\n"; + + InputStream inputStream = this.getClass() + .getClassLoader() + .getResourceAsStream("settings/basic_settings.yaml"); + UserSettings settings = UserSettings.load(inputStream); + assertEquals(expected, settings.toYamlString()); + } +} \ No newline at end of file diff --git a/imagetool/src/test/resources/settings/basic_settings.yaml b/imagetool/src/test/resources/settings/basic_settings.yaml new file mode 100644 index 00000000..9c0dd16d --- /dev/null +++ b/imagetool/src/test/resources/settings/basic_settings.yaml @@ -0,0 +1,3 @@ +aruRetryInterval: 200 +imageBuildDirectory: ./builds +patchDirectory: /home/user/patches diff --git a/imagetool/src/test/resources/settings/invalid_settings.yaml b/imagetool/src/test/resources/settings/invalid_settings.yaml new file mode 100644 index 00000000..ba81dffd --- /dev/null +++ b/imagetool/src/test/resources/settings/invalid_settings.yaml @@ -0,0 +1,3 @@ +patchDirectory: /home/user/patches +imageBuildDirectory: 1 +someField: someValue diff --git a/installer/pom.xml b/installer/pom.xml index e24295a8..823e0254 100644 --- a/installer/pom.xml +++ b/installer/pom.xml @@ -13,7 +13,7 @@ imagetool-parent com.oracle.weblogic.lifecycle.imagetool - 1.11.3-SNAPSHOT + 2.0.0-SNAPSHOT ../pom.xml @@ -39,6 +39,10 @@ com.github.spullara.mustache.java compiler + + org.yaml + snakeyaml + diff --git a/pom.xml b/pom.xml index 2eae54fc..fabde0ed 100644 --- a/pom.xml +++ b/pom.xml @@ -8,7 +8,7 @@ 4.0.0 com.oracle.weblogic.lifecycle.imagetool imagetool-parent - 1.11.3-SNAPSHOT + 2.0.0-SNAPSHOT pom WebLogic Image Tool @@ -92,6 +92,11 @@ annotations 18.0.0 + + org.yaml + snakeyaml + 1.29 + diff --git a/tests/pom.xml b/tests/pom.xml index e85b51b2..da39642d 100644 --- a/tests/pom.xml +++ b/tests/pom.xml @@ -12,7 +12,7 @@ imagetool-parent com.oracle.weblogic.lifecycle.imagetool - 1.11.3-SNAPSHOT + 2.0.0-SNAPSHOT ../pom.xml From fac8b4a7c15df61dc7899ae9feba0971c4404f4f Mon Sep 17 00:00:00 2001 From: Derek Sharpe Date: Wed, 3 Aug 2022 15:01:09 -0500 Subject: [PATCH 002/104] Allow user to specify default installer versions in user config --- .../imagetool/settings/UserSettings.java | 37 +++++++++++++++++-- .../imagetool/settings/UserSettingsTest.java | 18 +++++++++ .../resources/settings/basic_settings.yaml | 7 ++++ 3 files changed, 58 insertions(+), 4 deletions(-) diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/UserSettings.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/UserSettings.java index debcf37c..a1dd8670 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/UserSettings.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/UserSettings.java @@ -10,6 +10,7 @@ import java.nio.file.Paths; import java.util.Map; +import com.oracle.weblogic.imagetool.installer.InstallerType; import com.oracle.weblogic.imagetool.logging.LoggingFacade; import com.oracle.weblogic.imagetool.logging.LoggingFactory; import com.oracle.weblogic.imagetool.util.Utils; @@ -65,6 +66,11 @@ public class UserSettings { */ private final Integer aruRetryInterval; + /** + * The time between each ARU REST call in milliseconds. + */ + private final Map installers; + /** * Default construct with all default values for settings. */ @@ -77,6 +83,7 @@ public UserSettings() { aruRetryMax = null; aruRetryInterval = null; + installers = null; } /** @@ -94,6 +101,8 @@ public UserSettings(Map settings) { aruRetryMax = getValue("aruRetryMax", Integer.class, settings); aruRetryInterval = getValue("aruRetryInterval", Integer.class, settings); + + installers = getValue("installers", Map.class, settings); } /** @@ -130,6 +139,10 @@ public static UserSettings load(InputStream settings) { } private T getValue(String settingName, Class type, Map settings) { + if (settings == null) { + return null; + } + Object value = settings.get(settingName); if (value == null) { return null; @@ -137,11 +150,11 @@ private T getValue(String settingName, Class type, Map se if (type.isInstance(value)) { return type.cast(value); - } else { - logger.severe("Setting for {0} could not be loaded. Expected {1}, but found {2}. Invalid value: {3}", - settingName, type, value.getClass(), value.toString()); - return null; } + + logger.severe("Setting for {0} could not be loaded. Expected {1}, but found {2}. Invalid value: {3}", + settingName, type, value.getClass(), value.toString()); + return null; } /** @@ -222,6 +235,22 @@ public int getAruRetryInterval() { return aruRetryInterval; } + /** + * The settings asscociated with the installers to be used. + * @return a map of settings for installers + */ + public Map getInstallers() { + return installers; + } + + public String getDefaultInstallerVersion(InstallerType installerType) { + if (installers == null) { + return null; + } + Map installerSettings = getValue(installerType.toString(), Map.class, installers); + return getValue("defaultVersion", String.class, installerSettings); + } + /** * UserSettings as a YAML string. * @return UserSettings as a YAML string. diff --git a/imagetool/src/test/java/com/oracle/weblogic/imagetool/settings/UserSettingsTest.java b/imagetool/src/test/java/com/oracle/weblogic/imagetool/settings/UserSettingsTest.java index be63a230..c5b72e91 100644 --- a/imagetool/src/test/java/com/oracle/weblogic/imagetool/settings/UserSettingsTest.java +++ b/imagetool/src/test/java/com/oracle/weblogic/imagetool/settings/UserSettingsTest.java @@ -5,6 +5,7 @@ import java.io.InputStream; +import com.oracle.weblogic.imagetool.installer.InstallerType; import org.junit.jupiter.api.Test; import static org.junit.jupiter.api.Assertions.assertEquals; @@ -25,6 +26,16 @@ void testSimpleSettingsFile() { assertEquals(200, settings.getAruRetryInterval()); } + @Test + void testDefaultInstallers() { + InputStream inputStream = this.getClass() + .getClassLoader() + .getResourceAsStream("settings/basic_settings.yaml"); + UserSettings settings = UserSettings.load(inputStream); + assertEquals("8u241", settings.getDefaultInstallerVersion(InstallerType.JDK)); + assertEquals("12.2.1.4.0", settings.getDefaultInstallerVersion(InstallerType.WLS)); + } + @Test void testInvalidSettings() { InputStream inputStream = this.getClass() @@ -40,6 +51,13 @@ void testOutput() { //TODO: re-enable this test String expected = "aruRetryInterval: 200\n" + "imageBuildDirectory: ./builds\n" + + "installers:\n" + + " JDK:\n" + + " defaultVersion: 8u241\n" + + " WLS:\n" + + " defaultVersion: 12.2.1.4.0\n" + + " WDT:\n" + + " defaultVersion: latest" + "patchDirectory: /home/user/patches\n"; InputStream inputStream = this.getClass() diff --git a/imagetool/src/test/resources/settings/basic_settings.yaml b/imagetool/src/test/resources/settings/basic_settings.yaml index 9c0dd16d..2721882f 100644 --- a/imagetool/src/test/resources/settings/basic_settings.yaml +++ b/imagetool/src/test/resources/settings/basic_settings.yaml @@ -1,3 +1,10 @@ aruRetryInterval: 200 imageBuildDirectory: ./builds +installers: + jdk: + defaultVersion: 8u241 + wls: + defaultVersion: 12.2.1.4.0 + wdt: + defaultVersion: latest patchDirectory: /home/user/patches From 1d5c4b290d1e9c61e5b82bbe5d927fb62e11c35c Mon Sep 17 00:00:00 2001 From: Derek Sharpe <36005286+ddsharpe@users.noreply.github.com> Date: Fri, 19 Aug 2022 17:36:15 -0500 Subject: [PATCH 003/104] Fixed bug in REBASE that prevented copy of WDT_HOME (#367) --- .../imagetool/cli/menu/RebaseImage.java | 59 +++++++++++-------- .../src/main/resources/ImageTool.properties | 3 +- 2 files changed, 36 insertions(+), 26 deletions(-) diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/RebaseImage.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/RebaseImage.java index 12ca8c7f..cad7be31 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/RebaseImage.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/RebaseImage.java @@ -1,4 +1,4 @@ -// Copyright (c) 2019, 2021, Oracle and/or its affiliates. +// Copyright (c) 2019, 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.cli.menu; @@ -30,45 +30,42 @@ public CommandResponse call() throws Exception { logger.entering(); Instant startTime = Instant.now(); - String oldOracleHome; - String oldJavaHome; String newOracleHome = null; String newJavaHome = null; - String domainHome; - String modelHome; - boolean modelOnly; try { initializeOptions(); - if (sourceImage != null && !sourceImage.isEmpty()) { - logger.finer("IMG-0002", sourceImage); - dockerfileOptions.setSourceImage(sourceImage); + if (Utils.isEmptyString(sourceImage)) { + // sourceImage is a required parameter. This error will only occur if the user passes an empty string. + return CommandResponse.error(Utils.getMessage("IMG-0117")); + } - logger.info("IMG-0091", sourceImage); - Properties baseImageProperties = Utils.getBaseImageProperties(buildEngine, sourceImage, - "/probe-env/inspect-image.sh", buildDir()); + logger.finer("IMG-0002", sourceImage); + dockerfileOptions.setSourceImage(sourceImage); - oldOracleHome = baseImageProperties.getProperty("oracleHome", null); - oldJavaHome = baseImageProperties.getProperty("javaHome", null); - domainHome = baseImageProperties.getProperty("domainHome", null); - modelHome = baseImageProperties.getProperty("wdtModelHome", null); - modelOnly = Boolean.parseBoolean(baseImageProperties.getProperty("wdtModelOnly", null)); - } else { - return CommandResponse.error("Source Image not set"); - } + logger.info("IMG-0091", sourceImage); + Properties sourceImageProperties = Utils.getBaseImageProperties(buildEngine, sourceImage, + "/probe-env/inspect-image.sh", buildDir()); + + String oldOracleHome = sourceImageProperties.getProperty("oracleHome", null); + String oldJavaHome = sourceImageProperties.getProperty("javaHome", null); + String domainHome = sourceImageProperties.getProperty("domainHome", null); + String wdtHome = sourceImageProperties.getProperty("wdtHome", null); + String modelHome = sourceImageProperties.getProperty("wdtModelHome", null); + boolean modelOnly = Boolean.parseBoolean(sourceImageProperties.getProperty("wdtModelOnly", null)); + // If the user specified --targetImage, collect and apply the properties for the new image. if (!Utils.isEmptyString(targetImage)) { logger.finer("IMG-0002", targetImage); dockerfileOptions.setTargetImage(targetImage); dockerfileOptions.setRebaseToTarget(true); - Properties baseImageProperties = Utils.getBaseImageProperties(buildEngine, targetImage, + Properties targetImageProperties = Utils.getBaseImageProperties(buildEngine, targetImage, "/probe-env/inspect-image.sh", buildDir()); - - newOracleHome = baseImageProperties.getProperty("oracleHome", null); - newJavaHome = baseImageProperties.getProperty("javaHome", null); - + newOracleHome = targetImageProperties.getProperty("oracleHome", null); + newJavaHome = targetImageProperties.getProperty("javaHome", null); + useFileOwnerFromTarget(targetImageProperties); } else { dockerfileOptions.setRebaseToNew(true); } @@ -94,6 +91,7 @@ public CommandResponse call() throws Exception { dockerfileOptions .setDomainHome(domainHome) + .setWdtHome(wdtHome) .setWdtModelHome(modelHome) .setWdtModelOnly(modelOnly); @@ -117,6 +115,17 @@ public CommandResponse call() throws Exception { return successfulBuildResponse(startTime); } + private void useFileOwnerFromTarget(Properties imageProperties) { + String userid = imageProperties.getProperty("oracleHomeUser", null); + String groupid = imageProperties.getProperty("oracleHomeGroup", null); + if (!Utils.isEmptyString(userid)) { + dockerfileOptions.setUserId(userid); + } + if (!Utils.isEmptyString(groupid)) { + dockerfileOptions.setGroupId(groupid); + } + } + @Option( names = {"--sourceImage"}, required = true, diff --git a/imagetool/src/main/resources/ImageTool.properties b/imagetool/src/main/resources/ImageTool.properties index 96f3e67a..60af9543 100644 --- a/imagetool/src/main/resources/ImageTool.properties +++ b/imagetool/src/main/resources/ImageTool.properties @@ -88,7 +88,7 @@ IMG-0086=Failed to find patch number [[brightred: {0}]] on Oracle servers, verif IMG-0087=The Oracle Home directory in --fromImage={0} has an owner and group of {1}:{2}. You must update the image with the same user and group setting from when it was created. Example: --chown={1}:{2} IMG-0088=Build command failed with error: {0} IMG-0089=WDT_MODEL_HOME was not set in the source image, using default model location: {0} -IMG-0090=Rebasing WDT models. A domain was not found in the source image at {0} +IMG-0090=Rebasing WDT models only. A domain was not found in the source image at {0} IMG-0091=Reading settings from the source image {0} IMG-0092=ORACLE_HOME already exists in {0} (--fromImage), skipping middleware installs IMG-0093=Patching skipped. Using CREATE to patch --fromImage with an existing ORACLE_HOME is not supported. To create a patched image, use CREATE with a linux base image and apply the WebLogic install and patches at the same time. @@ -115,3 +115,4 @@ IMG-0113=The directory specified with WLSIMG_BLDDIR must be writable: {0} IMG-0114=Unable to parse section {0} of additionalBuildCommands: {1} IMG-0115=Unable to reach Oracle patch server to check for patch conflicts, skipping online conflict check. OPatch will check patches locally during the build. IMG-0116=A patch conflict was detected. The patches listed within the brackets conflict with each other. These fixes cannot be applied without a merge patch from Oracle: +IMG-0117=The value for --sourceImage must not be empty. From 87e50e99826cbad0733c21d0f057d7844c18344b Mon Sep 17 00:00:00 2001 From: Ryan Eberhard Date: Tue, 23 Aug 2022 10:15:23 -0400 Subject: [PATCH 004/104] Create dependabot.yml --- .github/dependabot.yml | 11 +++++++++++ 1 file changed, 11 insertions(+) create mode 100644 .github/dependabot.yml diff --git a/.github/dependabot.yml b/.github/dependabot.yml new file mode 100644 index 00000000..5b063201 --- /dev/null +++ b/.github/dependabot.yml @@ -0,0 +1,11 @@ +# To get started with Dependabot version updates, you'll need to specify which +# package ecosystems to update and where the package manifests are located. +# Please see the documentation for all configuration options: +# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates + +version: 2 +updates: + - package-ecosystem: "maven" # See documentation for possible values + directory: "/" # Location of package manifests + schedule: + interval: "daily" From ff685889f842b8dfe9168ae1e927b65ab3c639d9 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Tue, 23 Aug 2022 13:18:25 -0500 Subject: [PATCH 005/104] Bump maven-enforcer-plugin from 3.0.0-M2 to 3.1.0 (#369) Bumps [maven-enforcer-plugin](https://github.com/apache/maven-enforcer) from 3.0.0-M2 to 3.1.0. - [Release notes](https://github.com/apache/maven-enforcer/releases) - [Commits](https://github.com/apache/maven-enforcer/compare/enforcer-3.0.0-M2...enforcer-3.1.0) --- updated-dependencies: - dependency-name: org.apache.maven.plugins:maven-enforcer-plugin dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- pom.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pom.xml b/pom.xml index fabde0ed..652f2827 100644 --- a/pom.xml +++ b/pom.xml @@ -291,7 +291,7 @@ org.apache.maven.plugins maven-enforcer-plugin - 3.0.0-M2 + 3.1.0 From 6074aae9d5ce8b4e0977d679aaa829ec0232c708 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Tue, 23 Aug 2022 13:42:15 -0500 Subject: [PATCH 006/104] Bump exec-maven-plugin from 1.6.0 to 3.1.0 (#370) Bumps [exec-maven-plugin](https://github.com/mojohaus/exec-maven-plugin) from 1.6.0 to 3.1.0. - [Release notes](https://github.com/mojohaus/exec-maven-plugin/releases) - [Commits](https://github.com/mojohaus/exec-maven-plugin/compare/exec-maven-plugin-1.6.0...exec-maven-plugin-3.1.0) --- updated-dependencies: - dependency-name: org.codehaus.mojo:exec-maven-plugin dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Derek Sharpe <36005286+ddsharpe@users.noreply.github.com> --- pom.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pom.xml b/pom.xml index 652f2827..ff373d3e 100644 --- a/pom.xml +++ b/pom.xml @@ -168,7 +168,7 @@ org.codehaus.mojo exec-maven-plugin - 1.6.0 + 3.1.0 generate-autocompletion-script From 04ef98dd4ad0e9d866aaa2870716a92e471e805e Mon Sep 17 00:00:00 2001 From: Derek Sharpe <36005286+ddsharpe@users.noreply.github.com> Date: Tue, 23 Aug 2022 14:04:08 -0500 Subject: [PATCH 007/104] Added releasePackage attribute to INSPECT image. (#373) --- .../oracle/weblogic/imagetool/inspect/InspectOutput.java | 3 +++ .../imagetool/inspect/OperatingSystemProperties.java | 6 ++++++ .../src/main/resources/probe-env/inspect-image-long.sh | 4 ++++ imagetool/src/main/resources/probe-env/inspect-image.sh | 4 ++++ 4 files changed, 17 insertions(+) diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/inspect/InspectOutput.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/inspect/InspectOutput.java index 607a19ac..7f7e9976 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/inspect/InspectOutput.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/inspect/InspectOutput.java @@ -73,6 +73,9 @@ public String toString() { result.append(jsonKeyValuePair(2, "id", os.id())).append(",\n"); result.append(jsonKeyValuePair(2, "name", os.name())).append(",\n"); result.append(jsonKeyValuePair(2, "version", os.version())).append("\n"); + if (os.releasePackage() != null) { + result.append(jsonKeyValuePair(2, "releasePackage", os.releasePackage())).append("\n"); + } result.append(pad(1)).append("},"); result.append('\n'); } diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/inspect/OperatingSystemProperties.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/inspect/OperatingSystemProperties.java index 19bc2ee3..58808a92 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/inspect/OperatingSystemProperties.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/inspect/OperatingSystemProperties.java @@ -11,6 +11,7 @@ public class OperatingSystemProperties { private String id; private String version; private String name; + private String releasePackage; public String id() { return id; @@ -24,6 +25,10 @@ public String name() { return name; } + public String releasePackage() { + return releasePackage; + } + /** * Using the properties obtained from the image, extract the OS properties prefixed with __OS__. * @param imageProperties properties returned from the image inspection @@ -37,6 +42,7 @@ public static OperatingSystemProperties getOperatingSystemProperties(Properties result.version = removeQuotes(imageProperties.getProperty("__OS__VERSION_ID")); } result.name = removeQuotes(imageProperties.getProperty("__OS__NAME")); + result.releasePackage = imageProperties.getProperty("__OS__RELEASE_PACKAGE"); return result; } diff --git a/imagetool/src/main/resources/probe-env/inspect-image-long.sh b/imagetool/src/main/resources/probe-env/inspect-image-long.sh index 21d0c4fa..74e05119 100644 --- a/imagetool/src/main/resources/probe-env/inspect-image-long.sh +++ b/imagetool/src/main/resources/probe-env/inspect-image-long.sh @@ -86,6 +86,10 @@ fi if [ -f "/etc/os-release" ]; then grep '=' /etc/os-release | sed 's/^/__OS__/' + releasePackage="$(type rpm >/dev/null 2>&1 && rpm -qf /etc/os-release || echo '')" + if [ -n "$releasePackage" ]; then + echo __OS__RELEASE_PACKAGE=$releasePackage + fi elif type busybox > /dev/null 2>&1; then echo __OS__ID="bb" echo __OS__NAME="$(busybox | head -1 | awk '{ print $1 }')" diff --git a/imagetool/src/main/resources/probe-env/inspect-image.sh b/imagetool/src/main/resources/probe-env/inspect-image.sh index b93a4c4c..2fe3211f 100644 --- a/imagetool/src/main/resources/probe-env/inspect-image.sh +++ b/imagetool/src/main/resources/probe-env/inspect-image.sh @@ -66,6 +66,10 @@ fi if [ -f "/etc/os-release" ]; then grep '=' /etc/os-release | sed 's/^/__OS__/' + releasePackage="$(type rpm >/dev/null 2>&1 && rpm -qf /etc/os-release || echo '')" + if [ -n "$releasePackage" ]; then + echo __OS__RELEASE_PACKAGE=$releasePackage + fi elif type busybox > /dev/null 2>&1; then echo __OS__ID="bb" echo __OS__NAME="$(busybox | head -1 | awk '{ print $1 }')" From ccfbfba052664fca864f3b063a92f81716e2936a Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Tue, 23 Aug 2022 14:16:08 +0000 Subject: [PATCH 008/104] Bump junit-jupiter-engine from 5.8.1 to 5.9.0 Bumps [junit-jupiter-engine](https://github.com/junit-team/junit5) from 5.8.1 to 5.9.0. - [Release notes](https://github.com/junit-team/junit5/releases) - [Commits](https://github.com/junit-team/junit5/compare/r5.8.1...r5.9.0) --- updated-dependencies: - dependency-name: org.junit.jupiter:junit-jupiter-engine dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] --- pom.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pom.xml b/pom.xml index ff373d3e..d6dccf92 100644 --- a/pom.xml +++ b/pom.xml @@ -73,7 +73,7 @@ org.junit.jupiter junit-jupiter-engine - 5.8.1 + 5.9.0 test From 12c98abe19692a1318730ffd1875fa135d84bd8a Mon Sep 17 00:00:00 2001 From: Derek Sharpe Date: Tue, 23 Aug 2022 15:43:45 -0500 Subject: [PATCH 009/104] Fixes for checkstyle scan, and prepare for uptake of checkstyle v10 --- .../weblogic/imagetool/aru/AruProduct.java | 1 + .../imagetool/cli/cache/CacheCLI.java | 24 +++++++++---------- .../imagetool/installer/FmwInstallerType.java | 1 + .../imagetool/cli/menu/CommonOptionsTest.java | 5 +++- pom.xml | 2 +- 5 files changed, 19 insertions(+), 14 deletions(-) diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/aru/AruProduct.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/aru/AruProduct.java index e55e03ee..08038404 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/aru/AruProduct.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/aru/AruProduct.java @@ -32,6 +32,7 @@ public enum AruProduct { private final String productId; private final String description; + AruProduct(String productId, String description) { this.productId = productId; this.description = description; diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/CacheCLI.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/CacheCLI.java index 1d3e8e1e..d6d654a8 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/CacheCLI.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/CacheCLI.java @@ -10,18 +10,18 @@ import picocli.CommandLine.Unmatched; @Command( - name = "cache", - description = "List and set cache options", - versionProvider = HelpVersionProvider.class, - commandListHeading = "%nCommands:%n%n", - subcommands = { - ListCacheItems.class, - AddInstallerEntry.class, - AddPatchEntry.class, - AddEntry.class, - DeleteEntry.class - }, - sortOptions = false + name = "cache", + description = "List and set cache options", + versionProvider = HelpVersionProvider.class, + commandListHeading = "%nCommands:%n%n", + subcommands = { + ListCacheItems.class, + AddInstallerEntry.class, + AddPatchEntry.class, + AddEntry.class, + DeleteEntry.class + }, + sortOptions = false ) public class CacheCLI { diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/installer/FmwInstallerType.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/installer/FmwInstallerType.java index 76a81ff4..5da83939 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/installer/FmwInstallerType.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/installer/FmwInstallerType.java @@ -83,6 +83,7 @@ public enum FmwInstallerType { private final InstallerType[] installers; private final Set products; + FmwInstallerType(Set products, InstallerType... installers) { this.installers = installers; this.products = products; diff --git a/imagetool/src/test/java/com/oracle/weblogic/imagetool/cli/menu/CommonOptionsTest.java b/imagetool/src/test/java/com/oracle/weblogic/imagetool/cli/menu/CommonOptionsTest.java index a11c2e6d..9fab1acc 100644 --- a/imagetool/src/test/java/com/oracle/weblogic/imagetool/cli/menu/CommonOptionsTest.java +++ b/imagetool/src/test/java/com/oracle/weblogic/imagetool/cli/menu/CommonOptionsTest.java @@ -44,6 +44,7 @@ private static void setPrivateField(String fieldname, Object target, Object valu /** * handleChown() should set the Dockerfile userid and groupid. * use case: user provides derek:data. Result should be "derek" for user and "data" for group. + * * @throws Exception if reflection fails (developer error) */ @Test @@ -66,6 +67,7 @@ void handleChown() throws Exception { /** * handleChown() should set the Dockerfile userid and groupid. * use case: default, no input. Result should be "oracle" for both. + * * @throws Exception if reflection fails (developer error) */ @Test @@ -87,6 +89,7 @@ void handleChownDefault() throws Exception { /** * Test CommonOptions handleChown method. + * * @throws Exception if reflection fails (developer error) */ @Test @@ -172,7 +175,7 @@ void testResolveOptions() throws Exception { resourceTemplatesField.setAccessible(true); List resolveFiles = Arrays.asList(new File("target/test-classes/templates/resolver.yml").toPath(), - new File("target/test-classes/templates/verrazzano.yml").toPath()); + new File("target/test-classes/templates/verrazzano.yml").toPath()); resourceTemplatesField.set(wdtOptions, resolveFiles); Field imageTagField = WdtFullOptions.class.getDeclaredField("wdtDomainHome"); diff --git a/pom.xml b/pom.xml index d6dccf92..2cebcb2c 100644 --- a/pom.xml +++ b/pom.xml @@ -219,7 +219,7 @@ org.apache.maven.plugins maven-checkstyle-plugin - 3.1.0 + 3.1.2 checkstyle From 4691761aba0a6d2f6eb751b29e343aa31911f7fe Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Wed, 24 Aug 2022 12:01:02 +0000 Subject: [PATCH 010/104] Bump jacoco-maven-plugin from 0.8.7 to 0.8.8 Bumps [jacoco-maven-plugin](https://github.com/jacoco/jacoco) from 0.8.7 to 0.8.8. - [Release notes](https://github.com/jacoco/jacoco/releases) - [Commits](https://github.com/jacoco/jacoco/compare/v0.8.7...v0.8.8) --- updated-dependencies: - dependency-name: org.jacoco:jacoco-maven-plugin dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] --- pom.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pom.xml b/pom.xml index 2cebcb2c..024284b2 100644 --- a/pom.xml +++ b/pom.xml @@ -266,7 +266,7 @@ org.jacoco jacoco-maven-plugin - 0.8.7 + 0.8.8 prepare-agent From ed28cf1dec9ec2288c55a74bc32ec8fa63478ba7 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Tue, 23 Aug 2022 14:15:53 +0000 Subject: [PATCH 011/104] Bump checkstyle from 8.29 to 10.3.2 Bumps [checkstyle](https://github.com/checkstyle/checkstyle) from 8.29 to 10.3.2. - [Release notes](https://github.com/checkstyle/checkstyle/releases) - [Commits](https://github.com/checkstyle/checkstyle/compare/checkstyle-8.29...checkstyle-10.3.2) --- updated-dependencies: - dependency-name: com.puppycrawl.tools:checkstyle dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] --- pom.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pom.xml b/pom.xml index 024284b2..4e442214 100644 --- a/pom.xml +++ b/pom.xml @@ -247,7 +247,7 @@ com.puppycrawl.tools checkstyle - 8.29 + 10.3.2 From 2991127c3d87ae80d263eba7a42a60d94ce26f2c Mon Sep 17 00:00:00 2001 From: Derek Sharpe Date: Wed, 24 Aug 2022 10:39:28 -0500 Subject: [PATCH 012/104] replaced outdated JavadocMethod property (scope) with updated property (accessModifiers) --- .../weblogic-image-tool/checkstyle/customized_google_checks.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/build-tools/src/main/resources/weblogic-image-tool/checkstyle/customized_google_checks.xml b/build-tools/src/main/resources/weblogic-image-tool/checkstyle/customized_google_checks.xml index 501cec56..ae665343 100644 --- a/build-tools/src/main/resources/weblogic-image-tool/checkstyle/customized_google_checks.xml +++ b/build-tools/src/main/resources/weblogic-image-tool/checkstyle/customized_google_checks.xml @@ -293,7 +293,7 @@ value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, METHOD_DEF, CTOR_DEF, VARIABLE_DEF"/> - + From 70007e91445e525f6d8049a8fd5eb172e06485a6 Mon Sep 17 00:00:00 2001 From: Derek Sharpe Date: Wed, 24 Aug 2022 11:57:54 -0500 Subject: [PATCH 013/104] move build to JDK 11 --- Jenkinsfile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Jenkinsfile b/Jenkinsfile index 1b85e04e..1df83d33 100644 --- a/Jenkinsfile +++ b/Jenkinsfile @@ -5,7 +5,7 @@ pipeline { agent any tools { maven 'maven-3.6.0' - jdk 'jdk8' + jdk 'jdk11' } triggers { From d145eb008448191c9feca213e0eeb15f262618cc Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Tue, 23 Aug 2022 14:16:10 +0000 Subject: [PATCH 014/104] Bump httpmime from 4.5.12 to 4.5.13 Bumps httpmime from 4.5.12 to 4.5.13. --- updated-dependencies: - dependency-name: org.apache.httpcomponents:httpmime dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] --- pom.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pom.xml b/pom.xml index 4e442214..263d4196 100644 --- a/pom.xml +++ b/pom.xml @@ -58,7 +58,7 @@ org.apache.httpcomponents httpmime - 4.5.12 + 4.5.13 info.picocli From 27afe04a5294e45f183c810223b8a52f30a62220 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Wed, 24 Aug 2022 12:00:57 +0000 Subject: [PATCH 015/104] Bump system-stubs-jupiter from 1.2.0 to 2.0.1 Bumps [system-stubs-jupiter](https://github.com/webcompere/system-stubs) from 1.2.0 to 2.0.1. - [Release notes](https://github.com/webcompere/system-stubs/releases) - [Changelog](https://github.com/webcompere/system-stubs/blob/main/History.md) - [Commits](https://github.com/webcompere/system-stubs/compare/system-stubs-parent-1.2.0...system-stubs-parent-2.0.1) --- updated-dependencies: - dependency-name: uk.org.webcompere:system-stubs-jupiter dependency-type: direct:development update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] --- pom.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pom.xml b/pom.xml index 263d4196..9af15631 100644 --- a/pom.xml +++ b/pom.xml @@ -79,7 +79,7 @@ uk.org.webcompere system-stubs-jupiter - 1.2.0 + 2.0.1 test From 5a734d735eae42f682b75c24806dff84bbb7d310 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Wed, 24 Aug 2022 12:48:43 +0000 Subject: [PATCH 016/104] Bump sonar-maven-plugin from 3.7.0.1746 to 3.9.1.2184 Bumps [sonar-maven-plugin](https://github.com/SonarSource/sonar-scanner-maven) from 3.7.0.1746 to 3.9.1.2184. - [Release notes](https://github.com/SonarSource/sonar-scanner-maven/releases) - [Commits](https://github.com/SonarSource/sonar-scanner-maven/compare/3.7.0.1746...3.9.1.2184) --- updated-dependencies: - dependency-name: org.sonarsource.scanner.maven:sonar-maven-plugin dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] --- pom.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pom.xml b/pom.xml index 9af15631..079a5501 100644 --- a/pom.xml +++ b/pom.xml @@ -286,7 +286,7 @@ org.sonarsource.scanner.maven sonar-maven-plugin - 3.7.0.1746 + 3.9.1.2184 org.apache.maven.plugins From 00b6f11624e924229d94d2ceaa19b51237f55c1a Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Wed, 24 Aug 2022 14:21:00 +0000 Subject: [PATCH 017/104] Bump picocli from 4.6.1 to 4.6.3 Bumps [picocli](https://github.com/remkop/picocli) from 4.6.1 to 4.6.3. - [Release notes](https://github.com/remkop/picocli/releases) - [Changelog](https://github.com/remkop/picocli/blob/main/RELEASE-NOTES.md) - [Commits](https://github.com/remkop/picocli/compare/v4.6.1...v4.6.3) --- updated-dependencies: - dependency-name: info.picocli:picocli dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] --- pom.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pom.xml b/pom.xml index 079a5501..da5c8e86 100644 --- a/pom.xml +++ b/pom.xml @@ -63,7 +63,7 @@ info.picocli picocli - 4.6.1 + 4.6.3 org.json From 48736a47442e7a0e7b05c37cfdccb79614f6d04f Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Wed, 24 Aug 2022 16:53:42 +0000 Subject: [PATCH 018/104] Bump fluent-hc from 4.5.12 to 4.5.13 Bumps fluent-hc from 4.5.12 to 4.5.13. --- updated-dependencies: - dependency-name: org.apache.httpcomponents:fluent-hc dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] --- pom.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pom.xml b/pom.xml index da5c8e86..0a2becb4 100644 --- a/pom.xml +++ b/pom.xml @@ -53,7 +53,7 @@ org.apache.httpcomponents fluent-hc - 4.5.12 + 4.5.13 org.apache.httpcomponents From 5569874d9f387f5379232f89bffc4923512a82c1 Mon Sep 17 00:00:00 2001 From: Derek Sharpe <36005286+ddsharpe@users.noreply.github.com> Date: Thu, 25 Aug 2022 13:40:57 -0500 Subject: [PATCH 019/104] org.json dependency is no longer used. Removing 3rd party library. (#385) --- THIRD_PARTY_LICENSES.txt | 39 --------------------------------------- imagetool/pom.xml | 4 ---- installer/pom.xml | 4 ---- pom.xml | 5 ----- 4 files changed, 52 deletions(-) diff --git a/THIRD_PARTY_LICENSES.txt b/THIRD_PARTY_LICENSES.txt index c52547be..dafd6744 100644 --- a/THIRD_PARTY_LICENSES.txt +++ b/THIRD_PARTY_LICENSES.txt @@ -48,45 +48,6 @@ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ------------------------ Dependencies Grouped by License ------------ --------- Dependency -org.json:json --------- Copyrights -Copyright (c) 2002 JSON.org -Copyright (c) 2008 JSON.org -Copyright (c) 2018 JSON.org -Copyright (c) 2006 JSON.org -Copyright (c) 2015 JSON.org - --------- Dependencies Summary -org.json:json - --------- License used by Dependencies -============================================================================ - -Copyright (c) 2002 JSON.org - -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. - -The Software shall be used for Good, not Evil. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -SOFTWARE. - - ----------------------- Dependencies Grouped by License ------------ -------- Dependency com.github.spullara.mustache.java:compiler diff --git a/imagetool/pom.xml b/imagetool/pom.xml index dad05b57..0b40bd4a 100644 --- a/imagetool/pom.xml +++ b/imagetool/pom.xml @@ -30,10 +30,6 @@ info.picocli picocli - - org.json - json - org.junit.jupiter junit-jupiter-engine diff --git a/installer/pom.xml b/installer/pom.xml index 823e0254..29391115 100644 --- a/installer/pom.xml +++ b/installer/pom.xml @@ -31,10 +31,6 @@ info.picocli picocli - - org.json - json - com.github.spullara.mustache.java compiler diff --git a/pom.xml b/pom.xml index 0a2becb4..5a3b7055 100644 --- a/pom.xml +++ b/pom.xml @@ -65,11 +65,6 @@ picocli 4.6.3 - - org.json - json - 20200518 - org.junit.jupiter junit-jupiter-engine From 2484195652896b7dd16231d0de527f0dc69a3501 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Thu, 25 Aug 2022 16:07:38 -0500 Subject: [PATCH 020/104] Bump annotations from 18.0.0 to 23.0.0 (#380) Bumps [annotations](https://github.com/JetBrains/java-annotations) from 18.0.0 to 23.0.0. - [Release notes](https://github.com/JetBrains/java-annotations/releases) - [Changelog](https://github.com/JetBrains/java-annotations/blob/master/CHANGELOG.md) - [Commits](https://github.com/JetBrains/java-annotations/compare/18.0.0...23.0.0) --- updated-dependencies: - dependency-name: org.jetbrains:annotations dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] Signed-off-by: dependabot[bot] --- pom.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pom.xml b/pom.xml index 5a3b7055..6590f4f6 100644 --- a/pom.xml +++ b/pom.xml @@ -85,7 +85,7 @@ org.jetbrains annotations - 18.0.0 + 23.0.0 org.yaml From 00b47c1067b25b216f5e919746ebf84911d57e3f Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Thu, 25 Aug 2022 20:21:04 -0500 Subject: [PATCH 021/104] Bump maven-install-plugin from 2.5.2 to 3.0.1 (#381) Bumps [maven-install-plugin](https://github.com/apache/maven-install-plugin) from 2.5.2 to 3.0.1. - [Release notes](https://github.com/apache/maven-install-plugin/releases) - [Commits](https://github.com/apache/maven-install-plugin/compare/maven-install-plugin-2.5.2...maven-install-plugin-3.0.1) --- updated-dependencies: - dependency-name: org.apache.maven.plugins:maven-install-plugin dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] Signed-off-by: dependabot[bot] --- pom.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pom.xml b/pom.xml index 6590f4f6..e9f9ce86 100644 --- a/pom.xml +++ b/pom.xml @@ -150,7 +150,7 @@ org.apache.maven.plugins maven-install-plugin - 2.5.2 + 3.0.1 org.apache.maven.plugins From 22c2d841d24e5e0588b8c34415b0a75cda042528 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Fri, 26 Aug 2022 12:54:18 -0500 Subject: [PATCH 022/104] Bump maven-jar-plugin from 3.1.2 to 3.2.2 (#382) Bumps [maven-jar-plugin](https://github.com/apache/maven-jar-plugin) from 3.1.2 to 3.2.2. - [Release notes](https://github.com/apache/maven-jar-plugin/releases) - [Commits](https://github.com/apache/maven-jar-plugin/compare/maven-jar-plugin-3.1.2...maven-jar-plugin-3.2.2) --- updated-dependencies: - dependency-name: org.apache.maven.plugins:maven-jar-plugin dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] Signed-off-by: dependabot[bot] --- pom.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pom.xml b/pom.xml index e9f9ce86..f8829ed9 100644 --- a/pom.xml +++ b/pom.xml @@ -133,7 +133,7 @@ org.apache.maven.plugins maven-jar-plugin - 3.1.2 + 3.2.2 ${project.artifactId} From 6cfcc3dfe77c8c8ac922de07861b6e63722afd9f Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Fri, 26 Aug 2022 13:32:19 -0500 Subject: [PATCH 023/104] Bump maven-checkstyle-plugin from 3.1.2 to 3.2.0 (#383) Bumps [maven-checkstyle-plugin](https://github.com/apache/maven-checkstyle-plugin) from 3.1.2 to 3.2.0. - [Release notes](https://github.com/apache/maven-checkstyle-plugin/releases) - [Commits](https://github.com/apache/maven-checkstyle-plugin/compare/maven-checkstyle-plugin-3.1.2...maven-checkstyle-plugin-3.2.0) --- updated-dependencies: - dependency-name: org.apache.maven.plugins:maven-checkstyle-plugin dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] Signed-off-by: dependabot[bot] --- pom.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pom.xml b/pom.xml index f8829ed9..63935921 100644 --- a/pom.xml +++ b/pom.xml @@ -214,7 +214,7 @@ org.apache.maven.plugins maven-checkstyle-plugin - 3.1.2 + 3.2.0 checkstyle From a89f4d1a4535a82fd8bf534c5a66f92758bec732 Mon Sep 17 00:00:00 2001 From: Derek Sharpe Date: Mon, 29 Aug 2022 09:51:35 -0500 Subject: [PATCH 024/104] cleanup after merging main --- .../oracle/weblogic/imagetool/settings/UserSettings.java | 7 ++++++- pom.xml | 2 +- 2 files changed, 7 insertions(+), 2 deletions(-) diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/UserSettings.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/UserSettings.java index a1dd8670..326ea246 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/UserSettings.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/UserSettings.java @@ -153,7 +153,7 @@ private T getValue(String settingName, Class type, Map se } logger.severe("Setting for {0} could not be loaded. Expected {1}, but found {2}. Invalid value: {3}", - settingName, type, value.getClass(), value.toString()); + settingName, type, value.getClass(), value.toString()); return null; } @@ -243,6 +243,11 @@ public Map getInstallers() { return installers; } + /** + * Given an installer type, returns the user setting for the default installer version to use. + * @param installerType Installer type such as JDK, WLS, SOA, etc. + * @return the user configured default value + */ public String getDefaultInstallerVersion(InstallerType installerType) { if (installers == null) { return null; diff --git a/pom.xml b/pom.xml index 63935921..a4c0590e 100644 --- a/pom.xml +++ b/pom.xml @@ -90,7 +90,7 @@ org.yaml snakeyaml - 1.29 + 1.30 From bf14f5db404cd30df0578e65ee8c6381f9990a9f Mon Sep 17 00:00:00 2001 From: Derek Sharpe Date: Fri, 13 Jan 2023 17:57:09 -0600 Subject: [PATCH 025/104] added CRUD operations for Config to the CLI --- .../weblogic/imagetool/cli/ImageTool.java | 4 +- .../weblogic/imagetool/cli/config/Config.java | 20 ++ .../cli/config/ConfigAttributeName.java | 103 ++++++++++ .../cli/config/DeleteConfigEntry.java | 41 ++++ .../imagetool/cli/config/ReadConfigEntry.java | 45 ++++ .../imagetool/cli/config/SetConfigEntry.java | 47 +++++ .../imagetool/settings/ConfigSettings.java | 102 +++++++++ .../imagetool/settings/UserSettings.java | 193 +++++++++++++----- .../imagetool/logging/FileFormatterTest.java | 3 +- .../imagetool/settings/UserSettingsTest.java | 69 ++++--- .../resources/settings/basic_settings.yaml | 2 +- pom.xml | 1 - 12 files changed, 541 insertions(+), 89 deletions(-) create mode 100644 imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/config/Config.java create mode 100644 imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/config/ConfigAttributeName.java create mode 100644 imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/config/DeleteConfigEntry.java create mode 100644 imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/config/ReadConfigEntry.java create mode 100644 imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/config/SetConfigEntry.java create mode 100644 imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/ConfigSettings.java diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/ImageTool.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/ImageTool.java index b83b0920..437f9df6 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/ImageTool.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/ImageTool.java @@ -1,4 +1,4 @@ -// Copyright (c) 2019, 2021, Oracle and/or its affiliates. +// Copyright (c) 2019, 2023, 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.cli; @@ -7,6 +7,7 @@ import com.oracle.weblogic.imagetool.api.model.CommandResponse; import com.oracle.weblogic.imagetool.cli.cache.CacheCLI; +import com.oracle.weblogic.imagetool.cli.config.Config; import com.oracle.weblogic.imagetool.cli.menu.CreateAuxImage; import com.oracle.weblogic.imagetool.cli.menu.CreateImage; import com.oracle.weblogic.imagetool.cli.menu.InspectImage; @@ -28,6 +29,7 @@ sortOptions = false, subcommands = { CacheCLI.class, + Config.class, CreateImage.class, CreateAuxImage.class, UpdateImage.class, diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/config/Config.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/config/Config.java new file mode 100644 index 00000000..c05ffd7e --- /dev/null +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/config/Config.java @@ -0,0 +1,20 @@ +// Copyright (c) 2023, 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.cli.config; + +import picocli.CommandLine; + +@CommandLine.Command( + name = "config", + description = "Set global configuration options and defaults for the Image Tool", + commandListHeading = "%nCommands:%n%n", + subcommands = { + SetConfigEntry.class, + ReadConfigEntry.class, + DeleteConfigEntry.class + }, + sortOptions = false +) +public class Config { +} diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/config/ConfigAttributeName.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/config/ConfigAttributeName.java new file mode 100644 index 00000000..02409844 --- /dev/null +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/config/ConfigAttributeName.java @@ -0,0 +1,103 @@ +// Copyright (c) 2023, 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.cli.config; + +import com.oracle.weblogic.imagetool.settings.UserSettings; + +public enum ConfigAttributeName { + buildContextDirectory("BuildContextDirectory") { + @Override + public void set(UserSettings settings, String value) { + settings.setBuildContextDirectory(value); + } + + @Override + public String get(UserSettings settings) { + return settings.getBuildContextDirectory(); + } + }, + patchDirectory("PatchDirectory") { + @Override + public void set(UserSettings settings, String value) { + settings.setPatchDirectory(value); + } + + @Override + public String get(UserSettings settings) { + return settings.getPatchDirectory(); + } + }, + installerDirectory("InstallerDirectory") { + @Override + public void set(UserSettings settings, String value) { + settings.setInstallerDirectory(value); + } + + @Override + public String get(UserSettings settings) { + return settings.getInstallerDirectory(); + } + }, + buildEngine("BuildEngine") { + @Override + public void set(UserSettings settings, String value) { + settings.setBuildEngine(value); + } + + @Override + public String get(UserSettings settings) { + return settings.getBuildEngine(); + } + }, + containerEngine("ContainerEngine") { + @Override + public void set(UserSettings settings, String value) { + settings.setContainerEngine(value); + } + + @Override + public String get(UserSettings settings) { + return settings.getContainerEngine(); + } + }, + aruRetryMax("AruRetryMax") { + @Override + public void set(UserSettings settings, String value) { + settings.setAruRetryMax(Integer.parseInt(value)); + } + + @Override + public String get(UserSettings settings) { + //TODO check for null + return settings.getAruRetryMax().toString(); + } + }, + aruRetryInterval("AruRetryInterval") { + @Override + public void set(UserSettings settings, String value) { + settings.setAruRetryInterval(Integer.parseInt(value)); + } + + @Override + public String get(UserSettings settings) { + //TODO check for null + return settings.getAruRetryInterval().toString(); + } + }; + + private final String value; + + public abstract void set(UserSettings settings, String value); + + public abstract String get(UserSettings settings); + + ConfigAttributeName(String value) { + this.value = value; + } + + @Override + public String toString() { + return value; + } +} diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/config/DeleteConfigEntry.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/config/DeleteConfigEntry.java new file mode 100644 index 00000000..7e1761b6 --- /dev/null +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/config/DeleteConfigEntry.java @@ -0,0 +1,41 @@ +// Copyright (c) 2023, 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.cli.config; + +import java.util.concurrent.Callable; + +import com.oracle.weblogic.imagetool.api.model.CommandResponse; +import com.oracle.weblogic.imagetool.logging.LoggingFacade; +import com.oracle.weblogic.imagetool.logging.LoggingFactory; +import com.oracle.weblogic.imagetool.settings.UserSettings; +import picocli.CommandLine; + +@CommandLine.Command( + name = "reset", + description = "Remove/reset a configuration entry", + sortOptions = false +) +public class DeleteConfigEntry implements Callable { + private static final LoggingFacade logger = LoggingFactory.getLogger(DeleteConfigEntry.class); + + @CommandLine.Option( + names = {"--name"}, + description = "Name of the setting", + order = 0, + required = true + ) + private ConfigAttributeName name; + + @Override + public CommandResponse call() throws Exception { + logger.entering(); + UserSettings settings = UserSettings.load(); + + name.set(settings, null); + settings.save(); + + logger.exiting(); + return new CommandResponse(0, ""); + } +} diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/config/ReadConfigEntry.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/config/ReadConfigEntry.java new file mode 100644 index 00000000..6f07f26d --- /dev/null +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/config/ReadConfigEntry.java @@ -0,0 +1,45 @@ +// Copyright (c) 2023, 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.cli.config; + +import java.util.concurrent.Callable; + +import com.oracle.weblogic.imagetool.api.model.CommandResponse; +import com.oracle.weblogic.imagetool.logging.LoggingFacade; +import com.oracle.weblogic.imagetool.logging.LoggingFactory; +import com.oracle.weblogic.imagetool.settings.UserSettings; +import picocli.CommandLine; + +@CommandLine.Command( + name = "show", + description = "Print a configuration entry", + sortOptions = false +) +public class ReadConfigEntry implements Callable { + private static final LoggingFacade logger = LoggingFactory.getLogger(ReadConfigEntry.class); + + @CommandLine.Option( + names = {"--name"}, + description = "Name of the setting", + order = 0, + required = true + ) + private ConfigAttributeName name; + + @Override + public CommandResponse call() throws Exception { + logger.entering(); + UserSettings settings = UserSettings.load(); + + String result = name.get(settings); + + logger.exiting(); + if (result != null) { + System.out.println(result); + return new CommandResponse(0, ""); + } else { + return new CommandResponse(CommandLine.ExitCode.SOFTWARE, "Not Found"); + } + } +} diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/config/SetConfigEntry.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/config/SetConfigEntry.java new file mode 100644 index 00000000..40cb5c9a --- /dev/null +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/config/SetConfigEntry.java @@ -0,0 +1,47 @@ +// Copyright (c) 2023, 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.cli.config; + +import java.util.concurrent.Callable; + +import com.oracle.weblogic.imagetool.api.model.CommandResponse; +import com.oracle.weblogic.imagetool.logging.LoggingFacade; +import com.oracle.weblogic.imagetool.logging.LoggingFactory; +import com.oracle.weblogic.imagetool.settings.UserSettings; +import picocli.CommandLine.Command; +import picocli.CommandLine.Option; +import picocli.CommandLine.Parameters; + +@Command( + name = "set", + description = "Set or update a configuration entry", + sortOptions = false +) +public class SetConfigEntry implements Callable { + private static final LoggingFacade logger = LoggingFactory.getLogger(SetConfigEntry.class); + + @Option( + names = {"--name"}, + description = "Name of the setting", + order = 0, + required = true + ) + private ConfigAttributeName name; + + @Parameters(index = "0") + @SuppressWarnings("UnusedDeclaration") + private String value; + + @Override + public CommandResponse call() throws Exception { + UserSettings settings = UserSettings.load(); + logger.entering(); + + name.set(settings, value); + settings.save(); + + logger.exiting(); + return new CommandResponse(0, "done"); + } +} diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/ConfigSettings.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/ConfigSettings.java new file mode 100644 index 00000000..6fd63230 --- /dev/null +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/ConfigSettings.java @@ -0,0 +1,102 @@ +// Copyright (c) 2023, 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.settings; + +import com.oracle.weblogic.imagetool.logging.LoggingFacade; +import com.oracle.weblogic.imagetool.logging.LoggingFactory; +import com.oracle.weblogic.imagetool.util.Utils; + +/** + * Wrapper class for UserSettings where default values are returned when no user setting exists for a given attribute. + */ +public class ConfigSettings { + private static final LoggingFacade logger = LoggingFactory.getLogger(ConfigSettings.class); + + UserSettings userSettings; + + /** + * Parent directory for the build context directory. + * A temporary folder created under "Build Directory" with the prefix "wlsimgbuilder_tempXXXXXXX" will be created + * to hold the image build context (files, and Dockerfile). + */ + public String imageBuildContextDirectory() { + String result = userSettings.getBuildContextDirectory(); + if (Utils.isEmptyString(result)) { + return "."; + } + return result; + } + + /** + * Patch download directory. + * The directory for storing and using downloaded patches. + */ + public String patchDirectory() { + String result = userSettings.getPatchDirectory(); + if (Utils.isEmptyString(result)) { + return UserSettings.getSettingsDirectory().resolve("patches").toString(); + } + return result; + } + + /** + * Installer download directory. + * The directory for storing and using downloaded Java and middleware installers. + */ + public String installerDirectory() { + String result = userSettings.getInstallerDirectory(); + if (Utils.isEmptyString(result)) { + return UserSettings.getSettingsDirectory().resolve("installers").toString(); + } + return result; + } + + /** + * Container image build tool. + * Allow the user to specify the executable that will be used to build the container image. For example, + * "/usr/local/bin/docker" or just "docker" if "docker" is on the user's path. For example, "podman" or "docker". + */ + public String buildEngine() { + String result = userSettings.getBuildEngine(); + if (Utils.isEmptyString(result)) { + return "docker"; + } + return result; + } + + /** + * Container image runtime tool. + * Allow the user to specify the executable that will be used to run and/or interrogate images. For example, + * "/usr/local/bin/docker" or just "docker" if "docker" is on the user's path. For example, "podman" or "docker". + */ + public String containerEngine() { + String result = userSettings.getContainerEngine(); + if (Utils.isEmptyString(result)) { + return buildEngine(); + } + return result; + } + + /** + * REST calls to ARU should be retried up to this number of times. + */ + public Integer aruRetryMax() { + Integer result = userSettings.getAruRetryMax(); + if (result == null) { + return 10; + } + return result; + } + + /** + * The time between each ARU REST call in milliseconds. + */ + public int aruRetryInterval() { + Integer result = userSettings.getAruRetryInterval(); + if (result == null) { + return 500; + } + return result; + } +} diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/UserSettings.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/UserSettings.java index 326ea246..a7978534 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/UserSettings.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/UserSettings.java @@ -5,6 +5,7 @@ import java.io.IOException; import java.io.InputStream; +import java.io.OutputStreamWriter; import java.nio.file.Files; import java.nio.file.Path; import java.nio.file.Paths; @@ -13,10 +14,11 @@ import com.oracle.weblogic.imagetool.installer.InstallerType; import com.oracle.weblogic.imagetool.logging.LoggingFacade; import com.oracle.weblogic.imagetool.logging.LoggingFactory; -import com.oracle.weblogic.imagetool.util.Utils; import org.yaml.snakeyaml.DumperOptions; import org.yaml.snakeyaml.Yaml; +import org.yaml.snakeyaml.introspector.Property; import org.yaml.snakeyaml.introspector.PropertyUtils; +import org.yaml.snakeyaml.nodes.NodeTuple; import org.yaml.snakeyaml.nodes.Tag; import org.yaml.snakeyaml.representer.Representer; @@ -28,43 +30,43 @@ public class UserSettings { * A temporary folder created under "Build Directory" with the prefix "wlsimgbuilder_tempXXXXXXX" will be created * to hold the image build context (files, and Dockerfile). */ - private final String imageBuildDirectory; + private String buildContextDirectory; /** * Patch download directory. * The directory for storing and using downloaded patches. */ - private final String patchDirectory; + private String patchDirectory; /** * Installer download directory. * The directory for storing and using downloaded Java and middleware installers. */ - private final String installerDirectory; + private String installerDirectory; /** * Container image build tool. * Allow the user to specify the executable that will be used to build the container image. For example, * "/usr/local/bin/docker" or just "docker" if "docker" is on the user's path. For example, "podman" or "docker". */ - private final String buildEngine; + private String buildEngine; /** * Container image runtime tool. * Allow the user to specify the executable that will be used to run and/or interrogate images. For example, * "/usr/local/bin/docker" or just "docker" if "docker" is on the user's path. For example, "podman" or "docker". */ - private final String containerEngine; + private String containerEngine; /** * REST calls to ARU should be retried up to this number of times. */ - private final Integer aruRetryMax; + private Integer aruRetryMax; /** * The time between each ARU REST call in milliseconds. */ - private final Integer aruRetryInterval; + private Integer aruRetryInterval; /** * The time between each ARU REST call in milliseconds. @@ -77,7 +79,7 @@ public class UserSettings { public UserSettings() { patchDirectory = null; installerDirectory = null; - imageBuildDirectory = null; + buildContextDirectory = null; buildEngine = null; containerEngine = null; @@ -87,7 +89,7 @@ public UserSettings() { } /** - * Extract the Map of settings (from a YAML file), into a Java Bean, UserSettings. + * Extract the Map of settings (i.e., from a YAML file), into this bean, UserSettings. * @param settings A map of key-value pairs read in from the YAML user settings file. */ public UserSettings(Map settings) { @@ -95,7 +97,7 @@ public UserSettings(Map settings) { // Bad fields or extra data fields not in this version of ImageTool will cause yaml.loadAs to completely fail. patchDirectory = getValue("patchDirectory", String.class, settings); installerDirectory = getValue("installerDirectory", String.class, settings); - imageBuildDirectory = getValue("imageBuildDirectory", String.class, settings); + buildContextDirectory = getValue("buildContextDirectory", String.class, settings); buildEngine = getValue("buildEngine", String.class, settings); containerEngine = getValue("containerEngine", String.class, settings); @@ -106,23 +108,26 @@ public UserSettings(Map settings) { } /** - * The file system path to the directory where the settings file should be. + * The path to the directory where the settings file should be. * @return The path to ~/.imagetool */ public static Path getSettingsDirectory() { return Paths.get(System.getProperty("user.home"), ".imagetool"); } + public static Path getSettingsFilePath() { + return getSettingsDirectory().resolve("settings.yaml"); + } + /** * Loads the settings.yaml file from ~/.imagetool/settings.yaml and returns the values as UserSettings. * @return The user settings parsed from ~/.imagetool/settings.yaml */ - public static UserSettings instance() { - Path settingsFile = getSettingsDirectory().resolve("settings.yaml"); - try (InputStream input = Files.newInputStream(settingsFile)) { + public static UserSettings load() { + try (InputStream input = Files.newInputStream(getSettingsFilePath())) { return load(input); } catch (IOException ioe) { - logger.fine("Unable to open saved settings: {0}", ioe.getMessage(), ioe); + logger.fine("Using default setting values, unable to open saved settings: {0}", ioe.getMessage(), ioe); return new UserSettings(); } } @@ -135,6 +140,7 @@ public static UserSettings instance() { public static UserSettings load(InputStream settings) { Yaml yaml = new Yaml(); Map map = yaml.load(settings); + logger.fine("User settings loaded: {0}", map); return new UserSettings(map); } @@ -162,11 +168,17 @@ private T getValue(String settingName, Class type, Map se * A temporary folder created under "Build Directory" with the prefix "wlsimgbuilder_tempXXXXXXX" will be created * to hold the image build context (files, and Dockerfile). */ - public String getImageBuildDirectory() { - if (Utils.isEmptyString(imageBuildDirectory)) { - return "."; - } - return imageBuildDirectory; + public String getBuildContextDirectory() { + return buildContextDirectory; + } + + /** + * Parent directory for the build context directory. + * A temporary folder created under "Build Directory" with the prefix "wlsimgbuilder_tempXXXXXXX" will be created + * to hold the image build context (files, and Dockerfile). + */ + public void setBuildContextDirectory(String value) { + buildContextDirectory = value; } /** @@ -174,67 +186,99 @@ public String getImageBuildDirectory() { * The directory for storing and using downloaded patches. */ public String getPatchDirectory() { - if (Utils.isEmptyString(patchDirectory)) { - return getSettingsDirectory().resolve("patches").toString(); - } return patchDirectory; } + /** + * Patch download directory. + * The directory for storing and using downloaded patches. + */ + public void setPatchDirectory(String value) { + logger.fine("before: {0}", toYamlString()); + patchDirectory = value; + logger.fine("after: {0}", toYamlString()); + } + /** * Installer download directory. * The directory for storing and using downloaded Java and middleware installers. */ - public String installerDirectory() { - if (Utils.isEmptyString(installerDirectory)) { - return getSettingsDirectory().resolve("installers").toString(); - } + public String getInstallerDirectory() { return installerDirectory; } + /** + * Installer download directory. + * The directory for storing and using downloaded Java and middleware installers. + */ + public void setInstallerDirectory(String value) { + installerDirectory = value; + } + /** * Container image build tool. * Allow the user to specify the executable that will be used to build the container image. For example, * "/usr/local/bin/docker" or just "docker" if "docker" is on the user's path. For example, "podman" or "docker". */ public String getBuildEngine() { - if (Utils.isEmptyString(buildEngine)) { - return "docker"; - } return buildEngine; } + /** + * Container image build tool. + * Allow the user to specify the executable that will be used to build the container image. For example, + * "/usr/local/bin/docker" or just "docker" if "docker" is on the user's path. For example, "podman" or "docker". + */ + public void setBuildEngine(String value) { + buildEngine = value; + } + /** * Container image runtime tool. * Allow the user to specify the executable that will be used to run and/or interrogate images. For example, * "/usr/local/bin/docker" or just "docker" if "docker" is on the user's path. For example, "podman" or "docker". */ public String getContainerEngine() { - if (Utils.isEmptyString(containerEngine)) { - return getBuildEngine(); - } return containerEngine; } + /** + * Container image runtime tool. + * Allow the user to specify the executable that will be used to run and/or interrogate images. For example, + * "/usr/local/bin/docker" or just "docker" if "docker" is on the user's path. For example, "podman" or "docker". + */ + public void setContainerEngine(String value) { + containerEngine = value; + } + /** * REST calls to ARU should be retried up to this number of times. */ - public int getAruRetryMax() { - if (aruRetryMax == null) { - return 10; - } + public Integer getAruRetryMax() { return aruRetryMax; } + /** + * REST calls to ARU should be retried up to this number of times. + */ + public void setAruRetryMax(Integer value) { + aruRetryMax = value; + } + /** * The time between each ARU REST call in milliseconds. */ - public int getAruRetryInterval() { - if (aruRetryInterval == null) { - return 500; - } + public Integer getAruRetryInterval() { return aruRetryInterval; } + /** + * The time between each ARU REST call in milliseconds. + */ + public void setAruRetryInterval(Integer value) { + aruRetryInterval = value; + } + /** * The settings asscociated with the installers to be used. * @return a map of settings for installers @@ -252,28 +296,67 @@ public String getDefaultInstallerVersion(InstallerType installerType) { if (installers == null) { return null; } + @SuppressWarnings("unchecked") Map installerSettings = getValue(installerType.toString(), Map.class, installers); return getValue("defaultVersion", String.class, installerSettings); } - /** - * UserSettings as a YAML string. - * @return UserSettings as a YAML string. - */ - public String toYamlString() { - DumperOptions options = new DumperOptions(); - options.setIndent(2); - options.setPrettyFlow(true); - options.setDefaultFlowStyle(DumperOptions.FlowStyle.BLOCK); + private static Representer getYamlRepresenter() { + // Created this inline override to suppress the output of null for all unset user settings + Representer representer = new Representer() { + @Override + protected NodeTuple representJavaBeanProperty(Object javaBean, Property property, Object propertyValue, + Tag customTag) { + // if value of property is null, ignore it. + if (propertyValue == null) { + return null; + } else { + return super.representJavaBeanProperty(javaBean, property, propertyValue, customTag); + } + } + }; + representer.addClassTag(UserSettings.class, Tag.MAP); + representer.setDefaultFlowStyle(DumperOptions.FlowStyle.BLOCK); PropertyUtils propertyUtils = new PropertyUtils(); propertyUtils.setAllowReadOnlyProperties(true); - Representer representer = new Representer(); - representer.addClassTag(UserSettings.class, Tag.MAP); - representer.setDefaultFlowStyle(DumperOptions.FlowStyle.BLOCK); representer.setPropertyUtils(propertyUtils); + return representer; + } + + /** + * Save all settings to the ~/.imagetool/settings.yaml. + * @throws IOException if an error occurs saving to the filesystem + */ + public void save() throws IOException { + save(getSettingsFilePath()); + } + + /** + * Save all settings to the specified file. + * @throws IOException if an error occurs saving to the filesystem + */ + public void save(Path settingsFilePath) throws IOException { + Path parent = settingsFilePath.getParent(); + if (parent != null && Files.notExists(parent)) { + Files.createDirectories(parent); + } - Yaml yaml = new Yaml(representer); + try (OutputStreamWriter output = new OutputStreamWriter(Files.newOutputStream(settingsFilePath))) { + Yaml yaml = new Yaml(getYamlRepresenter()); + yaml.dump(this, output); + } catch (IOException ioe) { + logger.severe("Failed saved user settings: {0}", ioe.getMessage(), ioe); + throw ioe; + } + } + + /** + * UserSettings as a YAML string. + * @return UserSettings as a YAML string. + */ + public String toYamlString() { + Yaml yaml = new Yaml(getYamlRepresenter()); return yaml.dump(this); } } diff --git a/imagetool/src/test/java/com/oracle/weblogic/imagetool/logging/FileFormatterTest.java b/imagetool/src/test/java/com/oracle/weblogic/imagetool/logging/FileFormatterTest.java index 8b921045..1f61ab2b 100644 --- a/imagetool/src/test/java/com/oracle/weblogic/imagetool/logging/FileFormatterTest.java +++ b/imagetool/src/test/java/com/oracle/weblogic/imagetool/logging/FileFormatterTest.java @@ -6,11 +6,12 @@ import java.util.logging.Level; import java.util.logging.LogRecord; +import org.junit.jupiter.api.Tag; import org.junit.jupiter.api.Test; import static org.junit.jupiter.api.Assertions.assertTrue; - +@Tag("unit") class FileFormatterTest { @Test diff --git a/imagetool/src/test/java/com/oracle/weblogic/imagetool/settings/UserSettingsTest.java b/imagetool/src/test/java/com/oracle/weblogic/imagetool/settings/UserSettingsTest.java index c5b72e91..9bc49978 100644 --- a/imagetool/src/test/java/com/oracle/weblogic/imagetool/settings/UserSettingsTest.java +++ b/imagetool/src/test/java/com/oracle/weblogic/imagetool/settings/UserSettingsTest.java @@ -1,69 +1,78 @@ -// Copyright (c) 2022, Oracle and/or its affiliates. +// Copyright (c) 2023, 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.settings; import java.io.InputStream; +import com.oracle.weblogic.imagetool.cli.config.ConfigAttributeName; import com.oracle.weblogic.imagetool.installer.InstallerType; +import org.junit.jupiter.api.Tag; import org.junit.jupiter.api.Test; import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertNull; +@Tag("unit") class UserSettingsTest { - @Test - void testSimpleSettingsFile() { + private UserSettings getResourceFile(String resourcePath) { InputStream inputStream = this.getClass() .getClassLoader() .getResourceAsStream("settings/basic_settings.yaml"); - UserSettings settings = UserSettings.load(inputStream); + return UserSettings.load(inputStream); + } + + @Test + void testSimpleSettingsFile() { + UserSettings settings = getResourceFile("settings/basic_settings.yaml"); assertEquals("/home/user/patches", settings.getPatchDirectory()); - assertEquals("./builds", settings.getImageBuildDirectory()); - assertEquals("docker", settings.getBuildEngine()); - assertEquals("docker", settings.getContainerEngine()); - assertEquals(10, settings.getAruRetryMax()); + assertEquals("./builds", settings.getBuildContextDirectory()); + assertNull(settings.getBuildEngine()); + assertNull(settings.getContainerEngine()); + assertNull(settings.getAruRetryMax()); assertEquals(200, settings.getAruRetryInterval()); + // value not set, should return default value + assertNull(settings.getInstallerDirectory()); } @Test void testDefaultInstallers() { - InputStream inputStream = this.getClass() - .getClassLoader() - .getResourceAsStream("settings/basic_settings.yaml"); - UserSettings settings = UserSettings.load(inputStream); + UserSettings settings = getResourceFile("settings/basic_settings.yaml"); assertEquals("8u241", settings.getDefaultInstallerVersion(InstallerType.JDK)); assertEquals("12.2.1.4.0", settings.getDefaultInstallerVersion(InstallerType.WLS)); } @Test void testInvalidSettings() { - InputStream inputStream = this.getClass() - .getClassLoader() - .getResourceAsStream("settings/invalid_settings.yaml"); - UserSettings settings = UserSettings.load(inputStream); + UserSettings settings = getResourceFile("settings/invalid_settings.yaml"); assertEquals("/home/user/patches", settings.getPatchDirectory()); - assertEquals(".", settings.getImageBuildDirectory()); + assertEquals("./builds", settings.getBuildContextDirectory()); } - //@Test + @Test void testOutput() { - //TODO: re-enable this test String expected = "aruRetryInterval: 200\n" - + "imageBuildDirectory: ./builds\n" + + "buildContextDirectory: ./builds\n" + "installers:\n" - + " JDK:\n" - + " defaultVersion: 8u241\n" - + " WLS:\n" - + " defaultVersion: 12.2.1.4.0\n" - + " WDT:\n" - + " defaultVersion: latest" + + " jdk:\n" + + " defaultVersion: 8u241\n" + + " wls:\n" + + " defaultVersion: 12.2.1.4.0\n" + + " wdt:\n" + + " defaultVersion: latest\n" + "patchDirectory: /home/user/patches\n"; - InputStream inputStream = this.getClass() - .getClassLoader() - .getResourceAsStream("settings/basic_settings.yaml"); - UserSettings settings = UserSettings.load(inputStream); + UserSettings settings = getResourceFile("settings/basic_settings.yaml"); assertEquals(expected, settings.toYamlString()); } + + @Test + void testSetters() { + UserSettings settings = getResourceFile("settings/basic_settings.yaml"); + ConfigAttributeName attributeName = ConfigAttributeName.patchDirectory; + attributeName.set(settings, "./cache/paches"); + assertEquals("./builds", settings.getBuildContextDirectory()); + assertEquals("./cache/paches", settings.getPatchDirectory()); + } } \ No newline at end of file diff --git a/imagetool/src/test/resources/settings/basic_settings.yaml b/imagetool/src/test/resources/settings/basic_settings.yaml index 2721882f..ca19cb96 100644 --- a/imagetool/src/test/resources/settings/basic_settings.yaml +++ b/imagetool/src/test/resources/settings/basic_settings.yaml @@ -1,5 +1,5 @@ aruRetryInterval: 200 -imageBuildDirectory: ./builds +buildContextDirectory: ./builds installers: jdk: defaultVersion: 8u241 diff --git a/pom.xml b/pom.xml index 29d09c19..fc07d5e9 100644 --- a/pom.xml +++ b/pom.xml @@ -226,7 +226,6 @@ true weblogic-image-tool/checkstyle/customized_google_checks.xml weblogic-image-tool/checkstyle/suppressions.xml - UTF-8 true warning true From e1691eb61b5652afe4719fa21d6d55208a213942 Mon Sep 17 00:00:00 2001 From: Derek Sharpe Date: Fri, 20 Jan 2023 09:43:08 -0600 Subject: [PATCH 026/104] renamed new command classes --- .../java/com/oracle/weblogic/imagetool/cli/ImageTool.java | 4 ++-- .../cli/config/{Config.java => ConfigCommand.java} | 8 ++++---- .../config/{DeleteConfigEntry.java => ResetCommand.java} | 4 ++-- .../cli/config/{SetConfigEntry.java => SetCommand.java} | 6 +++--- .../cli/config/{ReadConfigEntry.java => ShowCommand.java} | 4 ++-- 5 files changed, 13 insertions(+), 13 deletions(-) rename imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/config/{Config.java => ConfigCommand.java} (80%) rename imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/config/{DeleteConfigEntry.java => ResetCommand.java} (91%) rename imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/config/{SetConfigEntry.java => SetCommand.java} (88%) rename imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/config/{ReadConfigEntry.java => ShowCommand.java} (92%) diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/ImageTool.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/ImageTool.java index 437f9df6..94bd6c41 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/ImageTool.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/ImageTool.java @@ -7,7 +7,7 @@ import com.oracle.weblogic.imagetool.api.model.CommandResponse; import com.oracle.weblogic.imagetool.cli.cache.CacheCLI; -import com.oracle.weblogic.imagetool.cli.config.Config; +import com.oracle.weblogic.imagetool.cli.config.ConfigCommand; import com.oracle.weblogic.imagetool.cli.menu.CreateAuxImage; import com.oracle.weblogic.imagetool.cli.menu.CreateImage; import com.oracle.weblogic.imagetool.cli.menu.InspectImage; @@ -29,7 +29,7 @@ sortOptions = false, subcommands = { CacheCLI.class, - Config.class, + ConfigCommand.class, CreateImage.class, CreateAuxImage.class, UpdateImage.class, diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/config/Config.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/config/ConfigCommand.java similarity index 80% rename from imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/config/Config.java rename to imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/config/ConfigCommand.java index c05ffd7e..a47f419e 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/config/Config.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/config/ConfigCommand.java @@ -10,11 +10,11 @@ description = "Set global configuration options and defaults for the Image Tool", commandListHeading = "%nCommands:%n%n", subcommands = { - SetConfigEntry.class, - ReadConfigEntry.class, - DeleteConfigEntry.class + SetCommand.class, + ShowCommand.class, + ResetCommand.class }, sortOptions = false ) -public class Config { +public class ConfigCommand { } diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/config/DeleteConfigEntry.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/config/ResetCommand.java similarity index 91% rename from imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/config/DeleteConfigEntry.java rename to imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/config/ResetCommand.java index 7e1761b6..666076df 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/config/DeleteConfigEntry.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/config/ResetCommand.java @@ -16,8 +16,8 @@ description = "Remove/reset a configuration entry", sortOptions = false ) -public class DeleteConfigEntry implements Callable { - private static final LoggingFacade logger = LoggingFactory.getLogger(DeleteConfigEntry.class); +public class ResetCommand implements Callable { + private static final LoggingFacade logger = LoggingFactory.getLogger(ResetCommand.class); @CommandLine.Option( names = {"--name"}, diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/config/SetConfigEntry.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/config/SetCommand.java similarity index 88% rename from imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/config/SetConfigEntry.java rename to imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/config/SetCommand.java index 40cb5c9a..3d188818 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/config/SetConfigEntry.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/config/SetCommand.java @@ -18,8 +18,8 @@ description = "Set or update a configuration entry", sortOptions = false ) -public class SetConfigEntry implements Callable { - private static final LoggingFacade logger = LoggingFactory.getLogger(SetConfigEntry.class); +public class SetCommand implements Callable { + private static final LoggingFacade logger = LoggingFactory.getLogger(SetCommand.class); @Option( names = {"--name"}, @@ -29,7 +29,7 @@ public class SetConfigEntry implements Callable { ) private ConfigAttributeName name; - @Parameters(index = "0") + @Parameters(index = "0", description = "the new configuration setting value") @SuppressWarnings("UnusedDeclaration") private String value; diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/config/ReadConfigEntry.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/config/ShowCommand.java similarity index 92% rename from imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/config/ReadConfigEntry.java rename to imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/config/ShowCommand.java index 6f07f26d..c3c22646 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/config/ReadConfigEntry.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/config/ShowCommand.java @@ -16,8 +16,8 @@ description = "Print a configuration entry", sortOptions = false ) -public class ReadConfigEntry implements Callable { - private static final LoggingFacade logger = LoggingFactory.getLogger(ReadConfigEntry.class); +public class ShowCommand implements Callable { + private static final LoggingFacade logger = LoggingFactory.getLogger(ShowCommand.class); @CommandLine.Option( names = {"--name"}, From 16591b962b978f186017d42f9b4481ab300c8f27 Mon Sep 17 00:00:00 2001 From: Derek Sharpe Date: Mon, 27 Feb 2023 11:06:31 -0600 Subject: [PATCH 027/104] seperated installer settings, file handling, and user settings --- .../cli/config/ConfigAttributeName.java | 34 +- .../imagetool/cli/config/ResetCommand.java | 4 +- .../imagetool/cli/config/SetCommand.java | 4 +- .../imagetool/cli/config/ShowCommand.java | 4 +- .../imagetool/settings/ConfigSettings.java | 6 +- .../imagetool/settings/InstallerSettings.java | 30 ++ .../imagetool/settings/SettingsFile.java | 169 ++++++++ .../imagetool/settings/UserSettings.java | 362 ------------------ .../imagetool/settings/UserSettingsFile.java | 258 +++++++++++++ .../imagetool/settings/UserSettingsTest.java | 43 +-- 10 files changed, 504 insertions(+), 410 deletions(-) create mode 100644 imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/InstallerSettings.java create mode 100644 imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/SettingsFile.java delete mode 100644 imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/UserSettings.java create mode 100644 imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/UserSettingsFile.java diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/config/ConfigAttributeName.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/config/ConfigAttributeName.java index 02409844..e51ba246 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/config/ConfigAttributeName.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/config/ConfigAttributeName.java @@ -3,84 +3,84 @@ package com.oracle.weblogic.imagetool.cli.config; -import com.oracle.weblogic.imagetool.settings.UserSettings; +import com.oracle.weblogic.imagetool.settings.UserSettingsFile; public enum ConfigAttributeName { buildContextDirectory("BuildContextDirectory") { @Override - public void set(UserSettings settings, String value) { + public void set(UserSettingsFile settings, String value) { settings.setBuildContextDirectory(value); } @Override - public String get(UserSettings settings) { + public String get(UserSettingsFile settings) { return settings.getBuildContextDirectory(); } }, patchDirectory("PatchDirectory") { @Override - public void set(UserSettings settings, String value) { + public void set(UserSettingsFile settings, String value) { settings.setPatchDirectory(value); } @Override - public String get(UserSettings settings) { + public String get(UserSettingsFile settings) { return settings.getPatchDirectory(); } }, installerDirectory("InstallerDirectory") { @Override - public void set(UserSettings settings, String value) { + public void set(UserSettingsFile settings, String value) { settings.setInstallerDirectory(value); } @Override - public String get(UserSettings settings) { + public String get(UserSettingsFile settings) { return settings.getInstallerDirectory(); } }, buildEngine("BuildEngine") { @Override - public void set(UserSettings settings, String value) { + public void set(UserSettingsFile settings, String value) { settings.setBuildEngine(value); } @Override - public String get(UserSettings settings) { + public String get(UserSettingsFile settings) { return settings.getBuildEngine(); } }, containerEngine("ContainerEngine") { @Override - public void set(UserSettings settings, String value) { + public void set(UserSettingsFile settings, String value) { settings.setContainerEngine(value); } @Override - public String get(UserSettings settings) { + public String get(UserSettingsFile settings) { return settings.getContainerEngine(); } }, aruRetryMax("AruRetryMax") { @Override - public void set(UserSettings settings, String value) { + public void set(UserSettingsFile settings, String value) { settings.setAruRetryMax(Integer.parseInt(value)); } @Override - public String get(UserSettings settings) { + public String get(UserSettingsFile settings) { //TODO check for null return settings.getAruRetryMax().toString(); } }, aruRetryInterval("AruRetryInterval") { @Override - public void set(UserSettings settings, String value) { + public void set(UserSettingsFile settings, String value) { settings.setAruRetryInterval(Integer.parseInt(value)); } @Override - public String get(UserSettings settings) { + public String get(UserSettingsFile settings) { //TODO check for null return settings.getAruRetryInterval().toString(); } @@ -88,9 +88,9 @@ public String get(UserSettings settings) { private final String value; - public abstract void set(UserSettings settings, String value); + public abstract void set(UserSettingsFile settings, String value); - public abstract String get(UserSettings settings); + public abstract String get(UserSettingsFile settings); ConfigAttributeName(String value) { this.value = value; diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/config/ResetCommand.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/config/ResetCommand.java index 666076df..a9fefe75 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/config/ResetCommand.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/config/ResetCommand.java @@ -8,7 +8,7 @@ import com.oracle.weblogic.imagetool.api.model.CommandResponse; import com.oracle.weblogic.imagetool.logging.LoggingFacade; import com.oracle.weblogic.imagetool.logging.LoggingFactory; -import com.oracle.weblogic.imagetool.settings.UserSettings; +import com.oracle.weblogic.imagetool.settings.UserSettingsFile; import picocli.CommandLine; @CommandLine.Command( @@ -30,7 +30,7 @@ public class ResetCommand implements Callable { @Override public CommandResponse call() throws Exception { logger.entering(); - UserSettings settings = UserSettings.load(); + UserSettingsFile settings = new UserSettingsFile(); name.set(settings, null); settings.save(); diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/config/SetCommand.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/config/SetCommand.java index 3d188818..7ba3a23e 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/config/SetCommand.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/config/SetCommand.java @@ -8,7 +8,7 @@ import com.oracle.weblogic.imagetool.api.model.CommandResponse; import com.oracle.weblogic.imagetool.logging.LoggingFacade; import com.oracle.weblogic.imagetool.logging.LoggingFactory; -import com.oracle.weblogic.imagetool.settings.UserSettings; +import com.oracle.weblogic.imagetool.settings.UserSettingsFile; import picocli.CommandLine.Command; import picocli.CommandLine.Option; import picocli.CommandLine.Parameters; @@ -35,7 +35,7 @@ public class SetCommand implements Callable { @Override public CommandResponse call() throws Exception { - UserSettings settings = UserSettings.load(); + UserSettingsFile settings = new UserSettingsFile(); logger.entering(); name.set(settings, value); diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/config/ShowCommand.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/config/ShowCommand.java index c3c22646..514a2a44 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/config/ShowCommand.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/config/ShowCommand.java @@ -8,7 +8,7 @@ import com.oracle.weblogic.imagetool.api.model.CommandResponse; import com.oracle.weblogic.imagetool.logging.LoggingFacade; import com.oracle.weblogic.imagetool.logging.LoggingFactory; -import com.oracle.weblogic.imagetool.settings.UserSettings; +import com.oracle.weblogic.imagetool.settings.UserSettingsFile; import picocli.CommandLine; @CommandLine.Command( @@ -30,7 +30,7 @@ public class ShowCommand implements Callable { @Override public CommandResponse call() throws Exception { logger.entering(); - UserSettings settings = UserSettings.load(); + UserSettingsFile settings = new UserSettingsFile(); String result = name.get(settings); diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/ConfigSettings.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/ConfigSettings.java index 6fd63230..51024a73 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/ConfigSettings.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/ConfigSettings.java @@ -13,7 +13,7 @@ public class ConfigSettings { private static final LoggingFacade logger = LoggingFactory.getLogger(ConfigSettings.class); - UserSettings userSettings; + UserSettingsFile userSettings; /** * Parent directory for the build context directory. @@ -35,7 +35,7 @@ public String imageBuildContextDirectory() { public String patchDirectory() { String result = userSettings.getPatchDirectory(); if (Utils.isEmptyString(result)) { - return UserSettings.getSettingsDirectory().resolve("patches").toString(); + return UserSettingsFile.getSettingsDirectory().resolve("patches").toString(); } return result; } @@ -47,7 +47,7 @@ public String patchDirectory() { public String installerDirectory() { String result = userSettings.getInstallerDirectory(); if (Utils.isEmptyString(result)) { - return UserSettings.getSettingsDirectory().resolve("installers").toString(); + return UserSettingsFile.getSettingsDirectory().resolve("installers").toString(); } return result; } diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/InstallerSettings.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/InstallerSettings.java new file mode 100644 index 00000000..2dfa3ef4 --- /dev/null +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/InstallerSettings.java @@ -0,0 +1,30 @@ +// Copyright (c) 2023, 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.settings; + +import java.util.Map; + +public class InstallerSettings { + private String defaultVersion; + + public InstallerSettings(Map settings) { + applySettings(settings); + } + + /** + * Apply settings that were loaded from YAML. + * @param settings map from YAML parser + */ + private void applySettings(Map settings) { + if (settings == null || settings.isEmpty()) { + return; + } + + defaultVersion = SettingsFile.getValue("defaultVersion", String.class, settings); + } + + public String getDefaultVersion() { + return defaultVersion; + } +} diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/SettingsFile.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/SettingsFile.java new file mode 100644 index 00000000..cd3c3279 --- /dev/null +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/SettingsFile.java @@ -0,0 +1,169 @@ +// Copyright (c) 2023, 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.settings; + +import java.io.IOException; +import java.io.InputStream; +import java.io.OutputStreamWriter; +import java.nio.file.Files; +import java.nio.file.Path; +import java.util.Collections; +import java.util.Map; + +import com.oracle.weblogic.imagetool.logging.LoggingFacade; +import com.oracle.weblogic.imagetool.logging.LoggingFactory; +import org.yaml.snakeyaml.DumperOptions; +import org.yaml.snakeyaml.Yaml; +import org.yaml.snakeyaml.introspector.Property; +import org.yaml.snakeyaml.introspector.PropertyUtils; +import org.yaml.snakeyaml.nodes.NodeTuple; +import org.yaml.snakeyaml.nodes.Tag; +import org.yaml.snakeyaml.representer.Representer; + +public class SettingsFile { + private static final LoggingFacade logger = LoggingFactory.getLogger(SettingsFile.class); + + private Path filePath; + + public SettingsFile(Path pathToFile) { + filePath = pathToFile; + } + + /** + * Utility method to convert the InputStream with YAML into UserSettings. + * @param settings An InputStream with raw YAML text. + * @return The UserSettings containing the parsed values from the InputStream. + */ + private Map load(InputStream settings) { + // While yaml.loadAs() will do about the same thing, I opted to use Map because Map is more forgiving. + // Bad fields or extra data fields not in this version of ImageTool will cause yaml.loadAs to completely fail. + logger.entering(); + Yaml yaml = new Yaml(); + Map map = yaml.load(settings); + logger.exiting(map); + return map; + } + + /** + * Loads the settings from the YAML file and returns the loaded file as a Map. + */ + public Map load() { + logger.entering(filePath); + Map map = Collections.emptyMap(); + try (InputStream input = Files.newInputStream(filePath)) { + map = load(input); + } catch (IOException ioe) { + // If exception occurs, map will be empty. parseMap() must handle both empty and populated map. + } + logger.exiting(map); + return map; + } + + private static Representer getYamlRepresenter() { + // Created this inline override to suppress the output of null for all unset user settings + Representer representer = new Representer() { + @Override + protected NodeTuple representJavaBeanProperty(Object javaBean, Property property, Object propertyValue, + Tag customTag) { + // if value of property is null, ignore it. + if (propertyValue == null) { + return null; + } else { + return super.representJavaBeanProperty(javaBean, property, propertyValue, customTag); + } + } + }; + representer.addClassTag(UserSettingsFile.class, Tag.MAP); + representer.setDefaultFlowStyle(DumperOptions.FlowStyle.BLOCK); + + PropertyUtils propertyUtils = new PropertyUtils(); + propertyUtils.setAllowReadOnlyProperties(true); + representer.setPropertyUtils(propertyUtils); + return representer; + } + + /** + * Save all settings to the specified file. + * @throws IOException if an error occurs saving to the filesystem + */ + public void save(Object data) throws IOException { + Path parent = filePath.getParent(); + if (parent != null && Files.notExists(parent)) { + Files.createDirectories(parent); + } + + try (OutputStreamWriter output = new OutputStreamWriter(Files.newOutputStream(filePath))) { + Yaml yaml = new Yaml(getYamlRepresenter()); + yaml.dump(data, output); + } catch (IOException ioe) { + logger.severe("Failed saved user settings: {0}", ioe.getMessage(), ioe); + throw ioe; + } + } + + /** + * Get the value for the setting by name from the provided settings map. + * This method is intended to be used for leaf attributes (not folders). + * @param settingName The attribute name of the setting + * @param type The type of the attribute value (for cast) + * @param settings The map of settings from which the attribute is to be retrieved + * @return The value of the requested attribute. + */ + public static T getValue(String settingName, Class type, Map settings) { + if (settings == null) { + return null; + } + + Object value = settings.get(settingName); + if (value == null) { + return null; + } + + if (type.isInstance(value)) { + return type.cast(value); + } + + logger.severe("Setting for {0} could not be loaded. Expected {1}, but found {2}. Invalid value: {3}", + settingName, type, value.getClass(), value.toString()); + return null; + } + + /** + * Get the folder for the settings by name from the provided settings map. + * For nested maps withing the settings map. + * + * @param folderName The key/name of the map/folder to be returned + * @param settings The settings from which the map/folder is to be retrieved. + * @return A map of settings matching the folder name provided, or empty map if not found. + */ + @SuppressWarnings("unchecked") + public static Map getFolder(String folderName, Map settings) { + if (settings == null) { + return Collections.emptyMap(); + } + + Object value = settings.get(folderName); + if (value == null) { + return Collections.emptyMap(); + } + + if (value instanceof Map) { + return (Map) value; + } + + //TODO needs to be an exception that will be caught and displayed as a parsing config error. + logger.severe("Setting for {0} could not be loaded. Invalid value: {3}", + folderName, value.toString()); + return Collections.emptyMap(); + } + + /** + * Convert settings object to a YAML string. + * @return formatted YAML text. + */ + public static String asYaml(Object value) { + Yaml yaml = new Yaml(getYamlRepresenter()); + return yaml.dump(value); + } +} diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/UserSettings.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/UserSettings.java deleted file mode 100644 index a7978534..00000000 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/UserSettings.java +++ /dev/null @@ -1,362 +0,0 @@ -// 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.settings; - -import java.io.IOException; -import java.io.InputStream; -import java.io.OutputStreamWriter; -import java.nio.file.Files; -import java.nio.file.Path; -import java.nio.file.Paths; -import java.util.Map; - -import com.oracle.weblogic.imagetool.installer.InstallerType; -import com.oracle.weblogic.imagetool.logging.LoggingFacade; -import com.oracle.weblogic.imagetool.logging.LoggingFactory; -import org.yaml.snakeyaml.DumperOptions; -import org.yaml.snakeyaml.Yaml; -import org.yaml.snakeyaml.introspector.Property; -import org.yaml.snakeyaml.introspector.PropertyUtils; -import org.yaml.snakeyaml.nodes.NodeTuple; -import org.yaml.snakeyaml.nodes.Tag; -import org.yaml.snakeyaml.representer.Representer; - -public class UserSettings { - private static final LoggingFacade logger = LoggingFactory.getLogger(UserSettings.class); - - /** - * Parent directory for the build context directory. - * A temporary folder created under "Build Directory" with the prefix "wlsimgbuilder_tempXXXXXXX" will be created - * to hold the image build context (files, and Dockerfile). - */ - private String buildContextDirectory; - - /** - * Patch download directory. - * The directory for storing and using downloaded patches. - */ - private String patchDirectory; - - /** - * Installer download directory. - * The directory for storing and using downloaded Java and middleware installers. - */ - private String installerDirectory; - - /** - * Container image build tool. - * Allow the user to specify the executable that will be used to build the container image. For example, - * "/usr/local/bin/docker" or just "docker" if "docker" is on the user's path. For example, "podman" or "docker". - */ - private String buildEngine; - - /** - * Container image runtime tool. - * Allow the user to specify the executable that will be used to run and/or interrogate images. For example, - * "/usr/local/bin/docker" or just "docker" if "docker" is on the user's path. For example, "podman" or "docker". - */ - private String containerEngine; - - /** - * REST calls to ARU should be retried up to this number of times. - */ - private Integer aruRetryMax; - - /** - * The time between each ARU REST call in milliseconds. - */ - private Integer aruRetryInterval; - - /** - * The time between each ARU REST call in milliseconds. - */ - private final Map installers; - - /** - * Default construct with all default values for settings. - */ - public UserSettings() { - patchDirectory = null; - installerDirectory = null; - buildContextDirectory = null; - buildEngine = null; - containerEngine = null; - - aruRetryMax = null; - aruRetryInterval = null; - installers = null; - } - - /** - * Extract the Map of settings (i.e., from a YAML file), into this bean, UserSettings. - * @param settings A map of key-value pairs read in from the YAML user settings file. - */ - public UserSettings(Map settings) { - // While yaml.loadAs() will do about the same thing, I opted to use Map because Map is more forgiving. - // Bad fields or extra data fields not in this version of ImageTool will cause yaml.loadAs to completely fail. - patchDirectory = getValue("patchDirectory", String.class, settings); - installerDirectory = getValue("installerDirectory", String.class, settings); - buildContextDirectory = getValue("buildContextDirectory", String.class, settings); - buildEngine = getValue("buildEngine", String.class, settings); - containerEngine = getValue("containerEngine", String.class, settings); - - aruRetryMax = getValue("aruRetryMax", Integer.class, settings); - aruRetryInterval = getValue("aruRetryInterval", Integer.class, settings); - - installers = getValue("installers", Map.class, settings); - } - - /** - * The path to the directory where the settings file should be. - * @return The path to ~/.imagetool - */ - public static Path getSettingsDirectory() { - return Paths.get(System.getProperty("user.home"), ".imagetool"); - } - - public static Path getSettingsFilePath() { - return getSettingsDirectory().resolve("settings.yaml"); - } - - /** - * Loads the settings.yaml file from ~/.imagetool/settings.yaml and returns the values as UserSettings. - * @return The user settings parsed from ~/.imagetool/settings.yaml - */ - public static UserSettings load() { - try (InputStream input = Files.newInputStream(getSettingsFilePath())) { - return load(input); - } catch (IOException ioe) { - logger.fine("Using default setting values, unable to open saved settings: {0}", ioe.getMessage(), ioe); - return new UserSettings(); - } - } - - /** - * Utility method to convert the InputStream with YAML into UserSettings. - * @param settings An InputStream with the raw YAML text. - * @return The UserSettings containing the parsed values from the InputStream. - */ - public static UserSettings load(InputStream settings) { - Yaml yaml = new Yaml(); - Map map = yaml.load(settings); - logger.fine("User settings loaded: {0}", map); - return new UserSettings(map); - } - - private T getValue(String settingName, Class type, Map settings) { - if (settings == null) { - return null; - } - - Object value = settings.get(settingName); - if (value == null) { - return null; - } - - if (type.isInstance(value)) { - return type.cast(value); - } - - logger.severe("Setting for {0} could not be loaded. Expected {1}, but found {2}. Invalid value: {3}", - settingName, type, value.getClass(), value.toString()); - return null; - } - - /** - * Parent directory for the build context directory. - * A temporary folder created under "Build Directory" with the prefix "wlsimgbuilder_tempXXXXXXX" will be created - * to hold the image build context (files, and Dockerfile). - */ - public String getBuildContextDirectory() { - return buildContextDirectory; - } - - /** - * Parent directory for the build context directory. - * A temporary folder created under "Build Directory" with the prefix "wlsimgbuilder_tempXXXXXXX" will be created - * to hold the image build context (files, and Dockerfile). - */ - public void setBuildContextDirectory(String value) { - buildContextDirectory = value; - } - - /** - * Patch download directory. - * The directory for storing and using downloaded patches. - */ - public String getPatchDirectory() { - return patchDirectory; - } - - /** - * Patch download directory. - * The directory for storing and using downloaded patches. - */ - public void setPatchDirectory(String value) { - logger.fine("before: {0}", toYamlString()); - patchDirectory = value; - logger.fine("after: {0}", toYamlString()); - } - - /** - * Installer download directory. - * The directory for storing and using downloaded Java and middleware installers. - */ - public String getInstallerDirectory() { - return installerDirectory; - } - - /** - * Installer download directory. - * The directory for storing and using downloaded Java and middleware installers. - */ - public void setInstallerDirectory(String value) { - installerDirectory = value; - } - - /** - * Container image build tool. - * Allow the user to specify the executable that will be used to build the container image. For example, - * "/usr/local/bin/docker" or just "docker" if "docker" is on the user's path. For example, "podman" or "docker". - */ - public String getBuildEngine() { - return buildEngine; - } - - /** - * Container image build tool. - * Allow the user to specify the executable that will be used to build the container image. For example, - * "/usr/local/bin/docker" or just "docker" if "docker" is on the user's path. For example, "podman" or "docker". - */ - public void setBuildEngine(String value) { - buildEngine = value; - } - - /** - * Container image runtime tool. - * Allow the user to specify the executable that will be used to run and/or interrogate images. For example, - * "/usr/local/bin/docker" or just "docker" if "docker" is on the user's path. For example, "podman" or "docker". - */ - public String getContainerEngine() { - return containerEngine; - } - - /** - * Container image runtime tool. - * Allow the user to specify the executable that will be used to run and/or interrogate images. For example, - * "/usr/local/bin/docker" or just "docker" if "docker" is on the user's path. For example, "podman" or "docker". - */ - public void setContainerEngine(String value) { - containerEngine = value; - } - - /** - * REST calls to ARU should be retried up to this number of times. - */ - public Integer getAruRetryMax() { - return aruRetryMax; - } - - /** - * REST calls to ARU should be retried up to this number of times. - */ - public void setAruRetryMax(Integer value) { - aruRetryMax = value; - } - - /** - * The time between each ARU REST call in milliseconds. - */ - public Integer getAruRetryInterval() { - return aruRetryInterval; - } - - /** - * The time between each ARU REST call in milliseconds. - */ - public void setAruRetryInterval(Integer value) { - aruRetryInterval = value; - } - - /** - * The settings asscociated with the installers to be used. - * @return a map of settings for installers - */ - public Map getInstallers() { - return installers; - } - - /** - * Given an installer type, returns the user setting for the default installer version to use. - * @param installerType Installer type such as JDK, WLS, SOA, etc. - * @return the user configured default value - */ - public String getDefaultInstallerVersion(InstallerType installerType) { - if (installers == null) { - return null; - } - @SuppressWarnings("unchecked") - Map installerSettings = getValue(installerType.toString(), Map.class, installers); - return getValue("defaultVersion", String.class, installerSettings); - } - - private static Representer getYamlRepresenter() { - // Created this inline override to suppress the output of null for all unset user settings - Representer representer = new Representer() { - @Override - protected NodeTuple representJavaBeanProperty(Object javaBean, Property property, Object propertyValue, - Tag customTag) { - // if value of property is null, ignore it. - if (propertyValue == null) { - return null; - } else { - return super.representJavaBeanProperty(javaBean, property, propertyValue, customTag); - } - } - }; - representer.addClassTag(UserSettings.class, Tag.MAP); - representer.setDefaultFlowStyle(DumperOptions.FlowStyle.BLOCK); - - PropertyUtils propertyUtils = new PropertyUtils(); - propertyUtils.setAllowReadOnlyProperties(true); - representer.setPropertyUtils(propertyUtils); - return representer; - } - - /** - * Save all settings to the ~/.imagetool/settings.yaml. - * @throws IOException if an error occurs saving to the filesystem - */ - public void save() throws IOException { - save(getSettingsFilePath()); - } - - /** - * Save all settings to the specified file. - * @throws IOException if an error occurs saving to the filesystem - */ - public void save(Path settingsFilePath) throws IOException { - Path parent = settingsFilePath.getParent(); - if (parent != null && Files.notExists(parent)) { - Files.createDirectories(parent); - } - - try (OutputStreamWriter output = new OutputStreamWriter(Files.newOutputStream(settingsFilePath))) { - Yaml yaml = new Yaml(getYamlRepresenter()); - yaml.dump(this, output); - } catch (IOException ioe) { - logger.severe("Failed saved user settings: {0}", ioe.getMessage(), ioe); - throw ioe; - } - } - - /** - * UserSettings as a YAML string. - * @return UserSettings as a YAML string. - */ - public String toYamlString() { - Yaml yaml = new Yaml(getYamlRepresenter()); - return yaml.dump(this); - } -} diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/UserSettingsFile.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/UserSettingsFile.java new file mode 100644 index 00000000..74332168 --- /dev/null +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/UserSettingsFile.java @@ -0,0 +1,258 @@ +// 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.settings; + +import java.io.IOException; +import java.nio.file.Path; +import java.nio.file.Paths; +import java.util.EnumMap; +import java.util.Map; + +import com.oracle.weblogic.imagetool.installer.InstallerType; +import com.oracle.weblogic.imagetool.logging.LoggingFacade; +import com.oracle.weblogic.imagetool.logging.LoggingFactory; + +public class UserSettingsFile { + private static final LoggingFacade logger = LoggingFactory.getLogger(UserSettingsFile.class); + /** + * Configured defaults associated with each installer. + */ + private final EnumMap installers; + /** + * Parent directory for the build context directory. + * A temporary folder created under "Build Directory" with the prefix "wlsimgbuilder_tempXXXXXXX" will be created + * to hold the image build context (files, and Dockerfile). + */ + private String buildContextDirectory = null; + /** + * Patch download directory. + * The directory for storing and using downloaded patches. + */ + private String patchDirectory = null; + /** + * Installer download directory. + * The directory for storing and using downloaded Java and middleware installers. + */ + private String installerDirectory = null; + /** + * Container image build tool. + * Allow the user to specify the executable that will be used to build the container image. For example, + * "/usr/local/bin/docker" or just "docker" if "docker" is on the user's path. For example, "podman" or "docker". + */ + private String buildEngine = null; + /** + * Container image runtime tool. + * Allow the user to specify the executable that will be used to run and/or interrogate images. For example, + * "/usr/local/bin/docker" or just "docker" if "docker" is on the user's path. For example, "podman" or "docker". + */ + private String containerEngine = null; + /** + * REST calls to ARU should be retried up to this number of times. + */ + private Integer aruRetryMax = null; + /** + * The time between each ARU REST call in milliseconds. + */ + private Integer aruRetryInterval = null; + + private final SettingsFile settingsFile; + + /** + * DLoads the settings.yaml file from ~/.imagetool/settings.yaml and applies the values found. + */ + public UserSettingsFile() { + this(getSettingsFilePath()); + } + + /** + * Extract the Map of settings (i.e., from a YAML file), into this bean, UserSettings. + * Used for internal tests to override default settings file location. + * @param pathToSettingsFile A map of key-value pairs read in from the YAML user settings file. + */ + public UserSettingsFile(Path pathToSettingsFile) { + installers = new EnumMap<>(InstallerType.class); + settingsFile = new SettingsFile(pathToSettingsFile); + applySettings(settingsFile.load()); + } + + /** + * Save all settings to the ~/.imagetool/settings.yaml. + * @throws IOException if an error occurs saving to the filesystem + */ + public void save() throws IOException { + settingsFile.save(this); + } + + /** + * The path to the directory where the settings file should be. + * @return The path to ~/.imagetool + */ + public static Path getSettingsDirectory() { + return Paths.get(System.getProperty("user.home"), ".imagetool"); + } + + public static Path getSettingsFilePath() { + return getSettingsDirectory().resolve("settings.yaml"); + } + + + /** + * Parent directory for the build context directory. + * A temporary folder created under "Build Directory" with the prefix "wlsimgbuilder_tempXXXXXXX" will be created + * to hold the image build context (files, and Dockerfile). + */ + public String getBuildContextDirectory() { + return buildContextDirectory; + } + + /** + * Parent directory for the build context directory. + * A temporary folder created under "Build Directory" with the prefix "wlsimgbuilder_tempXXXXXXX" will be created + * to hold the image build context (files, and Dockerfile). + */ + public void setBuildContextDirectory(String value) { + buildContextDirectory = value; + } + + /** + * Patch download directory. + * The directory for storing and using downloaded patches. + */ + public String getPatchDirectory() { + return patchDirectory; + } + + /** + * Patch download directory. + * The directory for storing and using downloaded patches. + */ + public void setPatchDirectory(String value) { + patchDirectory = value; + } + + /** + * Installer download directory. + * The directory for storing and using downloaded Java and middleware installers. + */ + public String getInstallerDirectory() { + return installerDirectory; + } + + /** + * Installer download directory. + * The directory for storing and using downloaded Java and middleware installers. + */ + public void setInstallerDirectory(String value) { + installerDirectory = value; + } + + /** + * Container image build tool. + * Allow the user to specify the executable that will be used to build the container image. For example, + * "/usr/local/bin/docker" or just "docker" if "docker" is on the user's path. For example, "podman" or "docker". + */ + public String getBuildEngine() { + return buildEngine; + } + + /** + * Container image build tool. + * Allow the user to specify the executable that will be used to build the container image. For example, + * "/usr/local/bin/docker" or just "docker" if "docker" is on the user's path. For example, "podman" or "docker". + */ + public void setBuildEngine(String value) { + buildEngine = value; + } + + /** + * Container image runtime tool. + * Allow the user to specify the executable that will be used to run and/or interrogate images. For example, + * "/usr/local/bin/docker" or just "docker" if "docker" is on the user's path. For example, "podman" or "docker". + */ + public String getContainerEngine() { + return containerEngine; + } + + /** + * Container image runtime tool. + * Allow the user to specify the executable that will be used to run and/or interrogate images. For example, + * "/usr/local/bin/docker" or just "docker" if "docker" is on the user's path. For example, "podman" or "docker". + */ + public void setContainerEngine(String value) { + containerEngine = value; + } + + /** + * REST calls to ARU should be retried up to this number of times. + */ + public Integer getAruRetryMax() { + return aruRetryMax; + } + + /** + * REST calls to ARU should be retried up to this number of times. + */ + public void setAruRetryMax(Integer value) { + aruRetryMax = value; + } + + /** + * The time between each ARU REST call in milliseconds. + */ + public Integer getAruRetryInterval() { + return aruRetryInterval; + } + + /** + * The time between each ARU REST call in milliseconds. + */ + public void setAruRetryInterval(Integer value) { + aruRetryInterval = value; + } + + /** + * The user settings for installer type. + * @param installerType Installer type such as JDK, WLS, SOA, etc. + * @return the settings for the requested installer type + */ + public InstallerSettings getInstallerSettings(InstallerType installerType) { + if (installers == null) { + return null; + } + return installers.get(installerType); + } + + private void applySettings(Map settings) { + logger.entering(); + if (settings == null || settings.isEmpty()) { + logger.exiting(); + return; + } + + patchDirectory = SettingsFile.getValue("patchDirectory", String.class, settings); + installerDirectory = SettingsFile.getValue("installerDirectory", String.class, settings); + buildContextDirectory = SettingsFile.getValue("buildContextDirectory", String.class, settings); + buildEngine = SettingsFile.getValue("buildEngine", String.class, settings); + containerEngine = SettingsFile.getValue("containerEngine", String.class, settings); + + aruRetryMax = SettingsFile.getValue("aruRetryMax", Integer.class, settings); + aruRetryInterval = SettingsFile.getValue("aruRetryInterval", Integer.class, settings); + + installers.clear(); + Map installerFolder = SettingsFile.getFolder("installers", settings); + for (Map.Entry entry: installerFolder.entrySet()) { + String key = entry.getKey(); + if (key != null && !key.isEmpty()) { + installers.put( + InstallerType.valueOf(key.toUpperCase()), + new InstallerSettings((Map) entry.getValue())); + } + } + logger.exiting(); + } + + public String toString() { + return SettingsFile.asYaml(this); + } +} diff --git a/imagetool/src/test/java/com/oracle/weblogic/imagetool/settings/UserSettingsTest.java b/imagetool/src/test/java/com/oracle/weblogic/imagetool/settings/UserSettingsTest.java index 9bc49978..26780f82 100644 --- a/imagetool/src/test/java/com/oracle/weblogic/imagetool/settings/UserSettingsTest.java +++ b/imagetool/src/test/java/com/oracle/weblogic/imagetool/settings/UserSettingsTest.java @@ -3,7 +3,9 @@ package com.oracle.weblogic.imagetool.settings; -import java.io.InputStream; +import java.net.URISyntaxException; +import java.net.URL; +import java.nio.file.Paths; import com.oracle.weblogic.imagetool.cli.config.ConfigAttributeName; import com.oracle.weblogic.imagetool.installer.InstallerType; @@ -11,21 +13,25 @@ import org.junit.jupiter.api.Test; import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertNotNull; import static org.junit.jupiter.api.Assertions.assertNull; @Tag("unit") class UserSettingsTest { - private UserSettings getResourceFile(String resourcePath) { - InputStream inputStream = this.getClass() - .getClassLoader() - .getResourceAsStream("settings/basic_settings.yaml"); - return UserSettings.load(inputStream); + private UserSettingsFile getResourceFile(String resourcePath) { + URL resource = this.getClass().getClassLoader().getResource(resourcePath); + assertNotNull(resource, "Unable to load settings file: " + resourcePath); + try { + return new UserSettingsFile(Paths.get(resource.toURI())); + } catch (URISyntaxException e) { + throw new IllegalStateException("Yaml resource file unavailable", e); + } } @Test void testSimpleSettingsFile() { - UserSettings settings = getResourceFile("settings/basic_settings.yaml"); + UserSettingsFile settings = getResourceFile("settings/basic_settings.yaml"); assertEquals("/home/user/patches", settings.getPatchDirectory()); assertEquals("./builds", settings.getBuildContextDirectory()); assertNull(settings.getBuildEngine()); @@ -38,38 +44,31 @@ void testSimpleSettingsFile() { @Test void testDefaultInstallers() { - UserSettings settings = getResourceFile("settings/basic_settings.yaml"); - assertEquals("8u241", settings.getDefaultInstallerVersion(InstallerType.JDK)); - assertEquals("12.2.1.4.0", settings.getDefaultInstallerVersion(InstallerType.WLS)); + UserSettingsFile settings = getResourceFile("settings/basic_settings.yaml"); + assertEquals("8u241", settings.getInstallerSettings(InstallerType.JDK).getDefaultVersion()); + assertEquals("12.2.1.4.0", settings.getInstallerSettings(InstallerType.WLS).getDefaultVersion()); } @Test void testInvalidSettings() { - UserSettings settings = getResourceFile("settings/invalid_settings.yaml"); + UserSettingsFile settings = getResourceFile("settings/invalid_settings.yaml"); assertEquals("/home/user/patches", settings.getPatchDirectory()); - assertEquals("./builds", settings.getBuildContextDirectory()); + assertNull(settings.getBuildContextDirectory()); } @Test void testOutput() { String expected = "aruRetryInterval: 200\n" + "buildContextDirectory: ./builds\n" - + "installers:\n" - + " jdk:\n" - + " defaultVersion: 8u241\n" - + " wls:\n" - + " defaultVersion: 12.2.1.4.0\n" - + " wdt:\n" - + " defaultVersion: latest\n" + "patchDirectory: /home/user/patches\n"; - UserSettings settings = getResourceFile("settings/basic_settings.yaml"); - assertEquals(expected, settings.toYamlString()); + UserSettingsFile settings = getResourceFile("settings/basic_settings.yaml"); + assertEquals(expected, settings.toString()); } @Test void testSetters() { - UserSettings settings = getResourceFile("settings/basic_settings.yaml"); + UserSettingsFile settings = getResourceFile("settings/basic_settings.yaml"); ConfigAttributeName attributeName = ConfigAttributeName.patchDirectory; attributeName.set(settings, "./cache/paches"); assertEquals("./builds", settings.getBuildContextDirectory()); From 5405a9025217bcdb31743304b2f3527d27817708 Mon Sep 17 00:00:00 2001 From: Derek Sharpe Date: Mon, 12 Jun 2023 13:03:41 -0500 Subject: [PATCH 028/104] correct unit test assert ordering --- .../java/com/oracle/weblogic/imagetool/aru/VersionTest.java | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/imagetool/src/test/java/com/oracle/weblogic/imagetool/aru/VersionTest.java b/imagetool/src/test/java/com/oracle/weblogic/imagetool/aru/VersionTest.java index f0c135c5..77f45e28 100644 --- a/imagetool/src/test/java/com/oracle/weblogic/imagetool/aru/VersionTest.java +++ b/imagetool/src/test/java/com/oracle/weblogic/imagetool/aru/VersionTest.java @@ -68,7 +68,7 @@ void equalObjects() { assertEquals(a, b); assertEquals(b, a); assertEquals(a, a); - assertNotEquals(a, null); + assertNotEquals(null, a); } @Test From 6d78fb8ec2644efe9394aeedae5e2c8b70374ec3 Mon Sep 17 00:00:00 2001 From: Derek Sharpe Date: Thu, 20 Jul 2023 13:54:09 -0500 Subject: [PATCH 029/104] validate installer type against Enum for user settings --- .../imagetool/settings/UserSettingsFile.java | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/UserSettingsFile.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/UserSettingsFile.java index 74332168..8aa58199 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/UserSettingsFile.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/UserSettingsFile.java @@ -244,9 +244,15 @@ private void applySettings(Map settings) { for (Map.Entry entry: installerFolder.entrySet()) { String key = entry.getKey(); if (key != null && !key.isEmpty()) { - installers.put( - InstallerType.valueOf(key.toUpperCase()), - new InstallerSettings((Map) entry.getValue())); + key = key.toUpperCase(); + try { + installers.put( + InstallerType.valueOf(key), + new InstallerSettings((Map) entry.getValue())); + } catch (IllegalArgumentException illegal) { + logger.warning("settings for {0} could not be loaded. {0} is not a valid installer type: {1}", + key, InstallerType.class.getEnumConstants()); + } } } logger.exiting(); From 444fb10100bad17e007b353e4e9f8bfa80cee2f4 Mon Sep 17 00:00:00 2001 From: Derek Sharpe Date: Thu, 20 Jul 2023 13:59:56 -0500 Subject: [PATCH 030/104] added SettingsStore class --- .../imagetool/settings/SettingsStore.java | 169 ++++++++++++++++++ 1 file changed, 169 insertions(+) create mode 100644 imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/SettingsStore.java diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/SettingsStore.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/SettingsStore.java new file mode 100644 index 00000000..045619a6 --- /dev/null +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/SettingsStore.java @@ -0,0 +1,169 @@ +// Copyright (c) 2023, 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.settings; + +import java.io.IOException; +import java.io.InputStream; +import java.io.OutputStreamWriter; +import java.nio.file.Files; +import java.nio.file.Path; +import java.util.Collections; +import java.util.Map; + +import com.oracle.weblogic.imagetool.logging.LoggingFacade; +import com.oracle.weblogic.imagetool.logging.LoggingFactory; +import org.yaml.snakeyaml.DumperOptions; +import org.yaml.snakeyaml.Yaml; +import org.yaml.snakeyaml.introspector.Property; +import org.yaml.snakeyaml.introspector.PropertyUtils; +import org.yaml.snakeyaml.nodes.NodeTuple; +import org.yaml.snakeyaml.nodes.Tag; +import org.yaml.snakeyaml.representer.Representer; + +public class SettingsStore { + private static final LoggingFacade logger = LoggingFactory.getLogger(SettingsStore.class); + + private Path filePath; + + public SettingsStore(Path pathToFile) { + filePath = pathToFile; + } + + /** + * Utility method to convert the InputStream with YAML into UserSettings. + * @param settings An InputStream with raw YAML text. + * @return The UserSettings containing the parsed values from the InputStream. + */ + private Map load(InputStream settings) { + // While yaml.loadAs() will do about the same thing, I opted to use Map because Map is more forgiving. + // Bad fields or extra data fields not in this version of ImageTool will cause yaml.loadAs to completely fail. + logger.entering(); + Yaml yaml = new Yaml(); + Map map = yaml.load(settings); + logger.exiting(map); + return map; + } + + /** + * Loads the settings from the YAML file and returns the loaded file as a Map. + */ + public Map load() { + logger.entering(filePath); + Map map = Collections.emptyMap(); + try (InputStream input = Files.newInputStream(filePath)) { + map = load(input); + } catch (IOException ioe) { + // If exception occurs, map will be empty. parseMap() must handle both empty and populated map. + } + logger.exiting(map); + return map; + } + + private static Representer getYamlRepresenter() { + // Created this inline override to suppress the output of null for all unset user settings + Representer representer = new Representer() { + @Override + protected NodeTuple representJavaBeanProperty(Object javaBean, Property property, Object propertyValue, + Tag customTag) { + // if value of property is null, ignore it. + if (propertyValue == null) { + return null; + } else { + return super.representJavaBeanProperty(javaBean, property, propertyValue, customTag); + } + } + }; + representer.addClassTag(UserSettingsFile.class, Tag.MAP); + representer.setDefaultFlowStyle(DumperOptions.FlowStyle.BLOCK); + + PropertyUtils propertyUtils = new PropertyUtils(); + propertyUtils.setAllowReadOnlyProperties(true); + representer.setPropertyUtils(propertyUtils); + return representer; + } + + /** + * Save all settings to the specified file. + * @throws IOException if an error occurs saving to the filesystem + */ + public void save(Object data) throws IOException { + Path parent = filePath.getParent(); + if (parent != null && Files.notExists(parent)) { + Files.createDirectories(parent); + } + + try (OutputStreamWriter output = new OutputStreamWriter(Files.newOutputStream(filePath))) { + Yaml yaml = new Yaml(getYamlRepresenter()); + yaml.dump(data, output); + } catch (IOException ioe) { + logger.severe("Failed saved user settings: {0}", ioe.getMessage(), ioe); + throw ioe; + } + } + + /** + * Get the value for the setting by name from the provided settings map. + * This method is intended to be used for leaf attributes (not folders). + * @param settingName The attribute name of the setting + * @param type The type of the attribute value (for cast) + * @param settings The map of settings from which the attribute is to be retrieved + * @return The value of the requested attribute. + */ + public static T getValue(String settingName, Class type, Map settings) { + if (settings == null) { + return null; + } + + Object value = settings.get(settingName); + if (value == null) { + return null; + } + + if (type.isInstance(value)) { + return type.cast(value); + } + + logger.severe("Setting for {0} could not be loaded. Expected {1}, but found {2}. Invalid value: {3}", + settingName, type, value.getClass(), value.toString()); + return null; + } + + /** + * Get the folder for the settings by name from the provided settings map. + * For nested maps withing the settings map. + * + * @param folderName The key/name of the map/folder to be returned + * @param settings The settings from which the map/folder is to be retrieved. + * @return A map of settings matching the folder name provided, or empty map if not found. + */ + @SuppressWarnings("unchecked") + public static Map getFolder(String folderName, Map settings) { + if (settings == null) { + return Collections.emptyMap(); + } + + Object value = settings.get(folderName); + if (value == null) { + return Collections.emptyMap(); + } + + if (value instanceof Map) { + return (Map) value; + } + + //TODO needs to be an exception that will be caught and displayed as a parsing config error. + logger.severe("Setting for {0} could not be loaded. Invalid value: {3}", + folderName, value.toString()); + return Collections.emptyMap(); + } + + /** + * Convert settings object to a YAML string. + * @return formatted YAML text. + */ + public static String asYaml(Object value) { + Yaml yaml = new Yaml(getYamlRepresenter()); + return yaml.dump(value); + } +} From c43ae682d7e1da3d0f4a25c96d24fbeee7512831 Mon Sep 17 00:00:00 2001 From: jshum Date: Tue, 24 Sep 2024 10:40:01 -0500 Subject: [PATCH 031/104] Initial check-in for multi platforms build and yaml based meta data --- .../imagetool/builder/BuildCommand.java | 6 +- .../cli/menu/CommonCreateOptions.java | 34 +++++++- .../imagetool/cli/menu/CommonOptions.java | 28 ++++++- .../installer/InstallerMetaData.java | 52 +++++++++++++ .../installer/MiddlewareInstall.java | 52 +++++++++---- .../installer/MiddlewareInstallPackage.java | 19 +++-- .../imagetool/settings/InstallerSettings.java | 33 ++++++++ .../imagetool/settings/UserSettingsFile.java | 23 ++++++ .../weblogic/imagetool/util/Constants.java | 3 + .../imagetool/util/DockerfileOptions.java | 41 +++++++++- .../docker-files/Create_Image.mustache | 4 +- .../docker-files/install-java.mustache | 11 ++- .../docker-files/install-middleware.mustache | 77 +++++++++++++------ 13 files changed, 320 insertions(+), 63 deletions(-) create mode 100644 imagetool/src/main/java/com/oracle/weblogic/imagetool/installer/InstallerMetaData.java diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/builder/BuildCommand.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/builder/BuildCommand.java index fa55d133..4901ab5d 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/builder/BuildCommand.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/builder/BuildCommand.java @@ -66,12 +66,12 @@ public BuildCommand tag(String value) { * @param value a single platform name. * @return this */ - public BuildCommand platform(String value) { - if (Utils.isEmptyString(value)) { + public BuildCommand platform(List value) { + if (value == null || value.isEmpty()) { return this; } command.add("--platform"); - command.add(value); + command.add(String.join(",", value)); useBuildx = true; return this; } diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonCreateOptions.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonCreateOptions.java index 727c9ef0..a0657761 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonCreateOptions.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonCreateOptions.java @@ -4,22 +4,29 @@ package com.oracle.weblogic.imagetool.cli.menu; import java.io.IOException; +import java.nio.file.Files; import java.nio.file.Path; import java.nio.file.Paths; +import java.util.ArrayList; import java.util.List; import javax.xml.xpath.XPathExpressionException; -import com.oracle.weblogic.imagetool.api.model.CachedFile; import com.oracle.weblogic.imagetool.aru.AruException; +import com.oracle.weblogic.imagetool.installer.InstallerMetaData; import com.oracle.weblogic.imagetool.installer.InstallerType; import com.oracle.weblogic.imagetool.installer.MiddlewareInstall; import com.oracle.weblogic.imagetool.logging.LoggingFacade; import com.oracle.weblogic.imagetool.logging.LoggingFactory; +import com.oracle.weblogic.imagetool.settings.InstallerSettings; +import com.oracle.weblogic.imagetool.settings.UserSettingsFile; import com.oracle.weblogic.imagetool.util.Constants; import com.oracle.weblogic.imagetool.util.Utils; import picocli.CommandLine.Option; import static com.oracle.weblogic.imagetool.cachestore.CacheStoreFactory.cache; +import static com.oracle.weblogic.imagetool.util.BuildPlatform.AMD64; +import static com.oracle.weblogic.imagetool.util.BuildPlatform.ARM64; +import static com.oracle.weblogic.imagetool.util.Constants.CTX_JDK; public class CommonCreateOptions extends CommonPatchingOptions { @@ -32,11 +39,30 @@ void prepareNewImage() throws IOException, InterruptedException, XPathExpression logger.entering(); copyOptionsFromImage(); + UserSettingsFile settingsFile = new UserSettingsFile(); if (dockerfileOptions.installJava()) { - CachedFile jdk = new CachedFile(InstallerType.JDK, jdkVersion, getBuildPlatform()); - Path installerPath = jdk.copyFile(cache(), buildDir()); - dockerfileOptions.setJavaInstaller(installerPath.getFileName().toString()); + InstallerSettings jdkInstallers = settingsFile.getInstallerSettings(InstallerType.JDK); + + List jdkFilePathList = new ArrayList<>(); + for (String jdkPlatform : getBuildPlatform()) { + String buildContextDestination = buildDir(); + if (jdkPlatform.equals(AMD64)) { + buildContextDestination = buildContextDestination + "/" + CTX_JDK + AMD64; + dockerfileOptions.setTargetAMDPlatform(true); + } else if (jdkPlatform.equals(ARM64)) { + buildContextDestination = buildContextDestination + "/" + CTX_JDK + ARM64; + dockerfileOptions.setTargetARMPlatform(true); + } + //CachedFile jdk = new CachedFile(InstallerType.JDK, jdkVersion, jdkPlatform); + //Path installerPath = jdk.copyFile(cache(), buildContextDestination); + InstallerMetaData installerMetaData = jdkInstallers.getInstallerForPlatform(jdkPlatform, jdkVersion); + Path installerPath = Paths.get(installerMetaData.getLocation()); + Files.copy(installerPath, Paths.get(buildContextDestination).resolve(installerPath.getFileName())); + jdkFilePathList.add(installerPath.getFileName().toString()); + } + // TODO: Why we need this? + dockerfileOptions.setJavaInstaller(jdkFilePathList); } if (dockerfileOptions.installMiddleware()) { diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonOptions.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonOptions.java index baae9036..42f800ca 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonOptions.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonOptions.java @@ -29,12 +29,17 @@ import com.oracle.weblogic.imagetool.util.DockerfileOptions; import com.oracle.weblogic.imagetool.util.InvalidPatchIdFormatException; import com.oracle.weblogic.imagetool.util.Utils; +import jdk.vm.ci.amd64.AMD64; import picocli.CommandLine; import picocli.CommandLine.Option; import picocli.CommandLine.Parameters; import picocli.CommandLine.Spec; +import static com.oracle.weblogic.imagetool.util.BuildPlatform.AMD64; +import static com.oracle.weblogic.imagetool.util.BuildPlatform.ARM64; import static com.oracle.weblogic.imagetool.util.Constants.BUSYBOX_OS_IDS; +import static com.oracle.weblogic.imagetool.util.Constants.CTX_FMW; +import static com.oracle.weblogic.imagetool.util.Constants.CTX_JDK; public abstract class CommonOptions { private static final LoggingFacade logger = LoggingFactory.getLogger(CommonOptions.class); @@ -148,6 +153,24 @@ String buildDir() throws IOException { buildDirectory = tmpDir.toAbsolutePath().toString(); logger.info("IMG-0003", buildDirectory); } + Path fmwamd64 = Paths.get(CTX_FMW + AMD64); + Path fmwarm64 = Paths.get(CTX_FMW + ARM64); + Path jdkamd64 = Paths.get(CTX_JDK + AMD64); + Path jdkarm64 = Paths.get(CTX_JDK + ARM64); + + if (!Files.exists(fmwamd64)) { + Files.createDirectories(Paths.get(buildDirectory).resolve(fmwamd64)); + } + if (!Files.exists(fmwarm64)) { + Files.createDirectories(Paths.get(buildDirectory).resolve(fmwarm64)); + } + if (!Files.exists(jdkamd64)) { + Files.createDirectories(Paths.get(buildDirectory).resolve(jdkamd64)); + } + if (!Files.exists(jdkarm64)) { + Files.createDirectories(Paths.get(buildDirectory).resolve(jdkarm64)); + } + return buildDirectory; } @@ -313,7 +336,7 @@ public String buildId() { return buildId; } - public String getBuildPlatform() { + public List getBuildPlatform() { return buildPlatform; } @@ -436,9 +459,10 @@ public String getBuildPlatform() { @Option( names = {"--platform"}, paramLabel = "", + split = ",", description = "Set the target platform to build. Example: linux/amd64 or linux/arm64" ) - private String buildPlatform; + private List buildPlatform; @Parameters( description = "Container build options.", diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/installer/InstallerMetaData.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/installer/InstallerMetaData.java new file mode 100644 index 00000000..1b193151 --- /dev/null +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/installer/InstallerMetaData.java @@ -0,0 +1,52 @@ +// Copyright (c) 2024, 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.installer; + +public class InstallerMetaData { + private String platform; + private String location; + private String hash; + private String dateAdded; + private String version; + + /** + * Constructor InstallerMetaData stores details about this installer. + * @param platform platform linux/arm64, linux/amd64 + * @param location file path of the installer + * @param hash hash value + * @param dateAdded date added + */ + public InstallerMetaData(String platform, String location, String hash, String dateAdded, String version) { + this.platform = platform; + this.location = location; + this.hash = hash; + this.dateAdded = dateAdded; + this.version = version; + } + + public String getPlatform() { + return platform; + } + + public String getLocation() { + return location; + } + + public String getHash() { + return hash; + } + + public String getDateAdded() { + return dateAdded; + } + + public String getVersion() { + return version; + } + + public String toString() { + return "InstallerMetaData [platform=" + platform + ", location=" + location + ", hash=" + hash + ", " + + "dateAdded=" + dateAdded + ", version=" + version + "]"; + } +} diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/installer/MiddlewareInstall.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/installer/MiddlewareInstall.java index c9603e30..41978ebb 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/installer/MiddlewareInstall.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/installer/MiddlewareInstall.java @@ -7,6 +7,7 @@ import java.io.IOException; import java.nio.file.Files; import java.nio.file.Path; +import java.nio.file.Paths; import java.util.ArrayList; import java.util.Collections; import java.util.Enumeration; @@ -14,12 +15,17 @@ import java.util.zip.ZipEntry; import java.util.zip.ZipFile; -import com.oracle.weblogic.imagetool.api.model.CachedFile; import com.oracle.weblogic.imagetool.cachestore.CacheStore; import com.oracle.weblogic.imagetool.logging.LoggingFacade; import com.oracle.weblogic.imagetool.logging.LoggingFactory; +import com.oracle.weblogic.imagetool.settings.InstallerSettings; +import com.oracle.weblogic.imagetool.settings.UserSettingsFile; import com.oracle.weblogic.imagetool.util.Utils; +import static com.oracle.weblogic.imagetool.util.BuildPlatform.AMD64; +import static com.oracle.weblogic.imagetool.util.BuildPlatform.ARM64; +import static com.oracle.weblogic.imagetool.util.Constants.CTX_FMW; + public class MiddlewareInstall { private static final LoggingFacade logger = LoggingFactory.getLogger(MiddlewareInstall.class); @@ -31,22 +37,32 @@ public class MiddlewareInstall { * Get the install metadata for a given middleware install type. * @param type the requested middleware install type */ - public MiddlewareInstall(FmwInstallerType type, String version, List responseFiles, String buildPlatform) + public MiddlewareInstall(FmwInstallerType type, String version, List responseFiles, + List buildPlatform) throws FileNotFoundException { logger.info("IMG-0039", type.installerListString(), version); fmwInstallerType = type; + UserSettingsFile settingsFile = new UserSettingsFile(); for (InstallerType installer : type.installerList()) { - MiddlewareInstallPackage pkg = new MiddlewareInstallPackage(); - pkg.type = installer; - pkg.installer = new CachedFile(installer, version, buildPlatform); - pkg.responseFile = new DefaultResponseFile(installer, type); - if (installer.equals(InstallerType.DB19)) { - pkg.preinstallCommands = Collections.singletonList("34761383/changePerm.sh /u01/oracle"); + InstallerSettings installers = settingsFile.getInstallerSettings(installer); + + for (String platform : buildPlatform) { + MiddlewareInstallPackage pkg = new MiddlewareInstallPackage(); + pkg.type = installer; + //pkg.installer = new CachedFile(installer, version, platform); + pkg.installerPath = Paths.get(installers.getInstallerForPlatform(platform, version).getLocation()); + pkg.installerFilename = pkg.installerPath.getFileName().toString(); + pkg.responseFile = new DefaultResponseFile(installer, type); + pkg.platform = platform; + if (installer.equals(InstallerType.DB19)) { + pkg.preinstallCommands = Collections.singletonList("34761383/changePerm.sh /u01/oracle"); + } + addInstaller(pkg); } - addInstaller(pkg); } + // TODO: same response files for all platform? setResponseFiles(responseFiles); } @@ -84,13 +100,23 @@ private static String getJarNameFromInstaller(Path installerFile) throws IOExcep */ public void copyFiles(CacheStore cacheStore, String buildContextDir) throws IOException { logger.entering(); + for (MiddlewareInstallPackage installPackage: installerFiles) { - Path filePath = installPackage.installer.copyFile(cacheStore, buildContextDir); - installPackage.installerFilename = filePath.getFileName().toString(); - installPackage.jarName = getJarNameFromInstaller(filePath); + String buildContextDestination = buildContextDir; + // based on the platform copy to sub directory + if (installPackage.platform.equals(AMD64)) { + buildContextDestination = buildContextDestination + "/" + CTX_FMW + AMD64; + } else if (installPackage.platform.equals(ARM64)) { + buildContextDestination = buildContextDestination + "/" + CTX_FMW + ARM64; + } + //Path filePath = installPackage.installer.copyFile(cacheStore, buildContextDestination); + //installPackage.installerFilename = filePath.getFileName().toString(); + Files.copy(installPackage.installerPath, + Paths.get(buildContextDestination).resolve(installPackage.installerPath.getFileName())); + installPackage.jarName = getJarNameFromInstaller(installPackage.installerPath); installPackage.isZip = installPackage.installerFilename.endsWith(".zip"); installPackage.isBin = installPackage.jarName.endsWith(".bin"); - installPackage.responseFile.copyFile(buildContextDir); + installPackage.responseFile.copyFile(buildContextDestination); } logger.exiting(); } diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/installer/MiddlewareInstallPackage.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/installer/MiddlewareInstallPackage.java index 2cb06550..e4780df9 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/installer/MiddlewareInstallPackage.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/installer/MiddlewareInstallPackage.java @@ -3,17 +3,20 @@ package com.oracle.weblogic.imagetool.installer; +import java.nio.file.Path; import java.util.List; import com.oracle.weblogic.imagetool.api.model.CachedFile; public class MiddlewareInstallPackage { - InstallerType type; - ResponseFile responseFile; - CachedFile installer; - String installerFilename; - String jarName; - List preinstallCommands; - boolean isZip = true; - boolean isBin = false; + public InstallerType type; + public ResponseFile responseFile; + public CachedFile installer; + public Path installerPath; + public String installerFilename; + public String jarName; + public List preinstallCommands; + public boolean isZip = true; + public boolean isBin = false; + public String platform; } diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/InstallerSettings.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/InstallerSettings.java index 2dfa3ef4..6bf9b911 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/InstallerSettings.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/InstallerSettings.java @@ -3,10 +3,14 @@ package com.oracle.weblogic.imagetool.settings; +import java.util.ArrayList; import java.util.Map; +import com.oracle.weblogic.imagetool.installer.InstallerMetaData; + public class InstallerSettings { private String defaultVersion; + private Map installerList; public InstallerSettings(Map settings) { applySettings(settings); @@ -22,9 +26,38 @@ private void applySettings(Map settings) { } defaultVersion = SettingsFile.getValue("defaultVersion", String.class, settings); + installerList = settings; } public String getDefaultVersion() { return defaultVersion; } + + /** + * Test. + * @param platformName platform name + * @param version version + * @return InstallerMetaData + */ + public InstallerMetaData getInstallerForPlatform(String platformName, String version) { + if (installerList != null && !installerList.isEmpty()) { + // TODO: check version exists + Object versionedInstaller = installerList.get(version); + if (versionedInstaller instanceof ArrayList) { + for (Object installerObj : (ArrayList) versionedInstaller) { + Map installerMap = (Map) installerObj; + String platform = (String) installerMap.get("platform"); + if (platform.equals(platformName)) { + String hash = (String) installerMap.get("digest"); + String dateAdded = (String) installerMap.get("added"); + String location = (String) installerMap.get("file"); + String versionName = (String) installerMap.get("version"); + return new InstallerMetaData(platform, location, hash, dateAdded, versionName); + } + } + } + } + return null; + } + } diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/UserSettingsFile.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/UserSettingsFile.java index 8aa58199..64ecbc78 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/UserSettingsFile.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/UserSettingsFile.java @@ -239,6 +239,29 @@ private void applySettings(Map settings) { aruRetryMax = SettingsFile.getValue("aruRetryMax", Integer.class, settings); aruRetryInterval = SettingsFile.getValue("aruRetryInterval", Integer.class, settings); + // installers is a list of different installer types jdk, fmw, wdt etc .. + // For each installer type, there is a list of individual installer + //jdk: + // defaultVersion: 8u401 + // 11u22: + // - platform: linux/arm64 + // file: /path/to/installerarm.gz + // digest: e6a8e178e73aea2fc512799423822bf065758f5e + // version: 11.0.22 + // added: 20241201 + // - platform: linux/amd64 + // file: /path/to/installeramd.gz + // digest: 1d6dc346ba26bcf1d0c6b5efb030e0dd2f842add + // version: 11.0.22 + // added: 20241201 + // 8u401: + //wls: + // defaultVersion: 12.2.1.4.0 + // 12.2.1.4.0: + // - platform: linux/arm64 + // .... + // - platform: linux/arm64 + installers.clear(); Map installerFolder = SettingsFile.getFolder("installers", settings); for (Map.Entry entry: installerFolder.entrySet()) { diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/util/Constants.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/util/Constants.java index fe5c73d1..2b407d4b 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/util/Constants.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/util/Constants.java @@ -30,6 +30,9 @@ public final class Constants { public static final List BUSYBOX_OS_IDS = Collections.unmodifiableList(Arrays.asList("bb", "alpine")); public static final String ORACLE_LINUX = "ghcr.io/oracle/oraclelinux:8-slim"; public static final String BUILDER_DEFAULT = Utils.getEnvironmentProperty("WLSIMG_BUILDER", "docker"); + public static final String CTX_JDK = "jdk/"; + public static final String CTX_FMW = "fmw/"; + private Constants() { //restrict access diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/util/DockerfileOptions.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/util/DockerfileOptions.java index 677c52e9..49be2c31 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/util/DockerfileOptions.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/util/DockerfileOptions.java @@ -22,6 +22,9 @@ import com.oracle.weblogic.imagetool.logging.LoggingFactory; import com.oracle.weblogic.imagetool.wdt.WdtOperation; +import static com.oracle.weblogic.imagetool.util.BuildPlatform.AMD64; +import static com.oracle.weblogic.imagetool.util.BuildPlatform.ARM64; + /** * Provides the data used by the Dockerfile templates (in mustache). */ @@ -48,7 +51,7 @@ public class DockerfileOptions { private boolean isRebaseToNew; private boolean strictPatchOrdering; - private String javaInstaller; + private List javaInstaller; private String username; private String groupname; private String javaHome; @@ -1064,12 +1067,22 @@ public List installPackages() { return mwInstallers.getInstallers(); } - public void setJavaInstaller(String value) { + public List installPackagesForARM() { + return mwInstallers.getInstallers().stream().filter(obj -> ARM64.equals(obj.platform)) + .collect(Collectors.toList()); + } + + public List installPackagesForAMD() { + return mwInstallers.getInstallers().stream().filter(obj -> AMD64.equals(obj.platform)) + .collect(Collectors.toList()); + } + + public void setJavaInstaller(List value) { javaInstaller = value; } @SuppressWarnings("unused") - public String java_pkg() { + public List java_pkg() { return javaInstaller; } @@ -1101,6 +1114,28 @@ public boolean domainGroupAsUser() { return domainGroupAsUser; } + public boolean targetARMPlatform; + + public DockerfileOptions setTargetARMPlatform(boolean value) { + this.targetARMPlatform = value; + return this; + } + + public boolean targetARMPlatform() { + return targetARMPlatform; + } + + public boolean targetAMDPlatform; + + public DockerfileOptions setTargetAMDPlatform(boolean value) { + this.targetAMDPlatform = value; + return this; + } + + public boolean targetAMDPlatform() { + return targetAMDPlatform; + } + /** * Returns true if BusyBox options should be used in the Dockerfile. * diff --git a/imagetool/src/main/resources/docker-files/Create_Image.mustache b/imagetool/src/main/resources/docker-files/Create_Image.mustache index 3b246303..927abd00 100644 --- a/imagetool/src/main/resources/docker-files/Create_Image.mustache +++ b/imagetool/src/main/resources/docker-files/Create_Image.mustache @@ -2,7 +2,7 @@ # Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl. # -FROM {{baseImage}} as os_update +FROM {{baseImage}} AS os_update {{#buildArgs}}ARG {{{.}}} {{/buildArgs}} LABEL com.oracle.weblogic.imagetool.buildid="{{buildId}}" @@ -30,7 +30,7 @@ USER root {{> run-wdt }} {{/isWdtEnabled}} -FROM os_update as final_build +FROM os_update AS final_build {{#buildArgs}}ARG {{{.}}} {{/buildArgs}} ENV ORACLE_HOME={{{oracle_home}}} \ diff --git a/imagetool/src/main/resources/docker-files/install-java.mustache b/imagetool/src/main/resources/docker-files/install-java.mustache index bf47e95d..9cae51b4 100644 --- a/imagetool/src/main/resources/docker-files/install-java.mustache +++ b/imagetool/src/main/resources/docker-files/install-java.mustache @@ -3,14 +3,16 @@ # # Installing Java -FROM os_update as jdk_build +FROM os_update AS jdk_build {{#buildArgs}}ARG {{{.}}} {{/buildArgs}} +ARG TARGETPLATFORM + LABEL com.oracle.weblogic.imagetool.buildid="{{buildId}}" ENV JAVA_HOME={{{java_home}}} - -COPY --chown={{userid}}:{{groupid}} ["{{java_pkg}}", "{{{tempDir}}}/"] +# stage directory +COPY --chown={{userid}}:{{groupid}} jdk {{{tempDir}}}/jdk USER {{userid}} @@ -18,7 +20,8 @@ USER {{userid}} {{{.}}} {{/beforeJdkInstall}} -RUN tar xzf "{{{tempDir}}}/{{java_pkg}}" -C /u01 \ + +RUN jdkfile=$(ls {{{tempDir}}}/jdk/$TARGETPLATFORM/*.gz) && tar xzf "$jdkfile" -C /u01 \ && $(test -d /u01/jdk* && mv /u01/jdk* {{{java_home}}} || mv /u01/graal* {{{java_home}}}) \ && rm -rf {{{tempDir}}} \ && rm -f {{{java_home}}}/javafx-src.zip {{{java_home}}}/src.zip diff --git a/imagetool/src/main/resources/docker-files/install-middleware.mustache b/imagetool/src/main/resources/docker-files/install-middleware.mustache index 80a00b0e..86a0b7b9 100644 --- a/imagetool/src/main/resources/docker-files/install-middleware.mustache +++ b/imagetool/src/main/resources/docker-files/install-middleware.mustache @@ -3,9 +3,11 @@ # # Installing Middleware -FROM os_update as wls_build +FROM os_update AS wls_build {{#buildArgs}}ARG {{{.}}} {{/buildArgs}} +ARG TARGETPLATFORM + LABEL com.oracle.weblogic.imagetool.buildid="{{buildId}}" ENV JAVA_HOME={{{java_home}}} \ @@ -23,8 +25,8 @@ RUN mkdir -p {{{oracle_home}}} \ {{#installJava}}COPY --from=jdk_build --chown={{userid}}:{{groupid}} {{{java_home}}} {{{java_home}}}/ {{/installJava}} - -{{#installPackages}}COPY --chown={{userid}}:{{groupid}} {{installerFilename}} {{responseFile.name}} {{{tempDir}}}/{{{type}}}/ +# copy all installers and response files to the stage directory +{{#installPackages}}COPY --chown={{userid}}:{{groupid}} fmw {{{tempDir}}}/{{{type}}} {{/installPackages}} COPY --chown={{userid}}:{{groupid}} oraInst.loc {{inv_loc}}/ @@ -34,28 +36,55 @@ USER {{userid}} {{{.}}} {{/beforeFmwInstall}} +# If installer is packaged in a ZIP, extract it before running it +# IF the installer is a JAR file (not a .bin), run the silent install using Java +# If the installer is a BIN, make sure it is executable and run the installer + RUN echo "INSTALLING MIDDLEWARE" \ -{{#installPackages}} - && echo "INSTALLING {{type}}" \ - # If installer is packaged in a ZIP, extract it before running it - {{#isZip}}&& unzip -q {{{tempDir}}}/{{{type}}}/{{installerFilename}} -d {{{tempDir}}}/{{{type}}} {{/isZip}} \ - {{#preinstallCommands}}&& {{{tempDir}}}/{{{type}}}/{{{.}}} {{/preinstallCommands}} \ - # IF the installer is a JAR file (not a .bin), run the silent install using Java - {{^isBin}} && {{{java_home}}}/bin/java -Xmx1024m -jar {{{tempDir}}}/{{{type}}}/{{jarName}} \ - -silent ORACLE_HOME={{{oracle_home}}} \ - -responseFile {{{tempDir}}}/{{{type}}}/{{responseFile.name}} \ - -invPtrLoc {{inv_loc}}/oraInst.loc \ - -ignoreSysPrereqs -force -novalidation {{/isBin}} \ - # If the installer is a BIN, make sure it is executable and run the installer - {{#isBin}} && chmod +x {{{tempDir}}}/{{{type}}}/{{jarName}} \ - && {{{tempDir}}}/{{{type}}}/{{jarName}} \ - -force -ignoreSysPrereqs -silent \ - -responseFile {{{tempDir}}}/{{{type}}}/{{responseFile.name}} \ - -invPtrLoc {{inv_loc}}/oraInst.loc ORACLE_HOME={{{oracle_home}}} -jreLoc {{{java_home}}} {{/isBin}} \ -{{/installPackages}} - && test $? -eq 0 \ - && chmod -R g+r {{{oracle_home}}} \ - || (grep -vh "NOTIFICATION" /tmp/OraInstall*/install*.log && exit 1) +{{#targetARMPlatform}} + && if [ "$TARGETPLATFORM" == "linux/arm64" ] ; then \ + {{#installPackagesForARM}} + echo "INSTALLING {{type}}" \ + {{#isZip}}&& unzip -q {{{tempDir}}}/{{{type}}}/$TARGETPLATFORM/{{installerFilename}} -d {{{tempDir}}}/{{{type}}} {{/isZip}} \ + {{#preinstallCommands}}&& {{{tempDir}}}/{{{type}}}/{{{.}}} {{/preinstallCommands}} \ + {{^isBin}} && {{{java_home}}}/bin/java -Xmx1024m -jar {{{tempDir}}}/{{{type}}}/{{jarName}} \ + -silent ORACLE_HOME={{{oracle_home}}} \ + -responseFile {{{tempDir}}}/{{{type}}}/$TARGETPLATFORM/{{responseFile.name}} \ + -invPtrLoc {{inv_loc}}/oraInst.loc \ + -ignoreSysPrereqs -force -novalidation {{/isBin}} \ + {{#isBin}} && chmod +x {{{tempDir}}}/{{{type}}}/{{jarName}} \ + && {{{tempDir}}}/{{{type}}}/{{jarName}} \ + -force -ignoreSysPrereqs -silent \ + -responseFile {{{tempDir}}}/{{{type}}}/$TARGETPLATFORM/{{responseFile.name}} \ + -invPtrLoc {{inv_loc}}/oraInst.loc ORACLE_HOME={{{oracle_home}}} -jreLoc {{{java_home}}} {{/isBin}} \ + {{/installPackagesForARM}} + && test $? -eq 0 \ + && chmod -R g+r {{{oracle_home}}} \ + || (grep -vh "NOTIFICATION" /tmp/OraInstall*/install*.log && exit 1) \ + fi {{#targetAMDPlatform}}\{{/targetAMDPlatform}} +{{/targetARMPlatform}} +{{#targetAMDPlatform}} + && if [ "$TARGETPLATFORM" == "linux/amd64" ] ; then \ + {{#installPackagesForAMD}} + echo "INSTALLING {{type}}" \ + {{#isZip}}&& unzip -q {{{tempDir}}}/{{{type}}}/$TARGETPLATFORM//{{installerFilename}} -d {{{tempDir}}}/{{{type}}} {{/isZip}} \ + {{#preinstallCommands}}&& {{{tempDir}}}/{{{type}}}/{{{.}}} {{/preinstallCommands}} \ + {{^isBin}} && {{{java_home}}}/bin/java -Xmx1024m -jar {{{tempDir}}}/{{{type}}}/{{jarName}} \ + -silent ORACLE_HOME={{{oracle_home}}} \ + -responseFile {{{tempDir}}}/{{{type}}}/$TARGETPLATFORM/{{responseFile.name}} \ + -invPtrLoc {{inv_loc}}/oraInst.loc \ + -ignoreSysPrereqs -force -novalidation {{/isBin}} \ + {{#isBin}} && chmod +x {{{tempDir}}}/{{{type}}}/{{jarName}} \ + && {{{tempDir}}}/{{{type}}}/{{jarName}} \ + -force -ignoreSysPrereqs -silent \ + -responseFile {{{tempDir}}}/{{{type}}}/$TARGETPLATFORM/{{responseFile.name}} \ + -invPtrLoc {{inv_loc}}/oraInst.loc ORACLE_HOME={{{oracle_home}}} -jreLoc {{{java_home}}} {{/isBin}} \ + {{/installPackagesForAMD}} + && test $? -eq 0 \ + && chmod -R g+r {{{oracle_home}}} \ + || (grep -vh "NOTIFICATION" /tmp/OraInstall*/install*.log && exit 1) \ + fi +{{/targetAMDPlatform}} {{> fmw-patching}} From 50113b56e7c780a2d654b544d5894fcc98980d41 Mon Sep 17 00:00:00 2001 From: jshum Date: Fri, 18 Oct 2024 09:15:42 -0500 Subject: [PATCH 032/104] Add patches.yaml and installers.yaml to hold metadata. --- .../imagetool/api/model/CachedFile.java | 114 ++-- .../weblogic/imagetool/aru/AruPatch.java | 40 +- .../weblogic/imagetool/aru/AruUtil.java | 15 + .../imagetool/cachestore/OPatchFile.java | 57 +- .../imagetool/cachestore/PatchFile.java | 122 ++-- .../cli/menu/CommonCreateOptions.java | 71 ++- .../imagetool/cli/menu/CommonOptions.java | 2 +- .../cli/menu/CommonPatchingOptions.java | 33 +- .../imagetool/cli/menu/UpdateImage.java | 5 +- .../installer/InstallerMetaData.java | 12 +- .../installer/MiddlewareInstall.java | 17 +- .../imagetool/patch/PatchMetaData.java | 59 ++ .../imagetool/settings/InstallerSettings.java | 39 +- .../imagetool/settings/UserSettingsFile.java | 252 +++++++- .../oracle/weblogic/imagetool/util/Utils.java | 47 ++ .../imagetool/cachestore/CachedFileTest.java | 66 +- .../imagetool/cachestore/OPatchFileTest.java | 4 +- .../imagetool/cachestore/PatchFileTest.java | 586 +++++++++--------- 18 files changed, 975 insertions(+), 566 deletions(-) create mode 100644 imagetool/src/main/java/com/oracle/weblogic/imagetool/patch/PatchMetaData.java diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/api/model/CachedFile.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/api/model/CachedFile.java index 622a7f0b..073ae760 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/api/model/CachedFile.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/api/model/CachedFile.java @@ -9,13 +9,13 @@ import java.nio.file.Files; import java.nio.file.Path; import java.nio.file.Paths; -import java.util.Objects; import com.oracle.weblogic.imagetool.cachestore.CacheStore; +import com.oracle.weblogic.imagetool.installer.InstallerMetaData; import com.oracle.weblogic.imagetool.installer.InstallerType; import com.oracle.weblogic.imagetool.logging.LoggingFacade; import com.oracle.weblogic.imagetool.logging.LoggingFactory; -import com.oracle.weblogic.imagetool.util.BuildPlatform; +import com.oracle.weblogic.imagetool.settings.UserSettingsFile; import com.oracle.weblogic.imagetool.util.Utils; /** @@ -25,85 +25,63 @@ public class CachedFile { private static final LoggingFacade logger = LoggingFactory.getLogger(CachedFile.class); - private final String id; private final String version; private final String architecture; + private final InstallerType installerType; + private final UserSettingsFile userSettingsFile = new UserSettingsFile(); + private final boolean isPatch; + private final String patchId; /** * Represents a locally cached file. * - * @param id cache ID (like installer type or patchId) + * @param id cache ID (like installer type) * @param version version number for the patch or installer. * @param architecture the system architecture that this file/installer is applicable */ - public CachedFile(String id, String version, String architecture) { - Objects.requireNonNull(id, "key for the cached file cannot be null"); - logger.entering(id, version, architecture); - this.id = id; + public CachedFile(InstallerType id, String version, String architecture) { + this.installerType = id; this.version = version; this.architecture = architecture; - logger.exiting(); + this.isPatch = false; + this.patchId = null; } /** * Represents a locally cached file. * - * @param id cache ID (like installer type or patchId) + * @param id cache ID (like installer type) * @param version version number for the patch or installer. */ - public CachedFile(String id, String version) { + public CachedFile(InstallerType id, String version) { this(id, version, null); } /** - * Represents a locally cached file. - * - * @param id cache ID (like installer type) - * @param version version number for the patch or installer. - * @param architecture the system architecture that this file/installer is applicable + * constructor. + * @param isPatch is it a patch + * @param patchId patch id + * @param version version + * @param architecture architecture */ - public CachedFile(InstallerType id, String version, String architecture) { - this(id.toString(), version, architecture); - } - - /** - * Represents a locally cached file. - * - * @param id cache ID (like installer type) - * @param version version number for the patch or installer. - */ - public CachedFile(InstallerType id, String version) { - this(id.toString(), version, null); + public CachedFile(boolean isPatch, String patchId, String version, String architecture) { + this.isPatch = isPatch; + this.version = version; + this.architecture = architecture; + this.installerType = null; + this.patchId = patchId; } public static boolean isFileOnDisk(String filePath) { return filePath != null && Files.isRegularFile(Paths.get(filePath)); } - /** - * Get the key for this cache entry. - * If the ID that was used to create this CachedFile object contains the separator (underscore), - * then the key is the same as the ID. Otherwise, the key is the ID plus version, like ID + "_" + version. - * @return the key to use for this cache entry, like xxxx_yyyy. - */ - public String getKey() { - return getCacheKey(architecture); + public String getPatchId() { + return patchId; } - private String getCacheKey(String architecture) { - if (id.contains(CacheStore.CACHE_KEY_SEPARATOR)) { - return id; - } - - StringBuilder key = new StringBuilder(32); - key.append(id); - key.append(CacheStore.CACHE_KEY_SEPARATOR); - key.append(version); - if (architecture != null) { - key.append(CacheStore.CACHE_KEY_SEPARATOR); - key.append(architecture); - } - return key.toString(); + public UserSettingsFile getUserSettingsFile() { + return userSettingsFile; } /** @@ -130,36 +108,22 @@ public String getArchitecture() { * for an entry listing without the architecture in the key (generic architecture entry). If the user * did not specify an architecture, check the cache for an entry listing using the local architecture * in case the user added the cache entry with the architecture. - * @param cacheStore the cache store to search * @return the Path of the file, if found * @throws IOException throws FileNotFoundException, if this cached file (key) could not be located in the cache */ - public String resolve(CacheStore cacheStore) throws IOException { + public String resolve() throws IOException { // check entry exists in cache - String key = getKey(); - logger.entering(key); - String filePath = cacheStore.getValueFromCache(key); - if (filePath == null) { - // The KEY for this CachedFile was not found in the local cache. - logger.fine("Unable to find cache entry for {0}", key); - String alternateKey; - if (getArchitecture() == null) { - // The user did not specify an architecture in the KEY and that key was not found in the cache. - // Try adding the local architecture to the key, and look for that entry. - alternateKey = getCacheKey(BuildPlatform.getPlatformName()); - logger.fine("Trying local architecture: {0}", alternateKey); - } else { - // The user specified an architecture in the KEY, but that key was not found. - // Try removing the architecture from the key, and look for that entry. - alternateKey = getCacheKey(null); - logger.fine("Trying no-arch/generic architecture: {0}", alternateKey); - } - // second attempt to find a reasonable cache entry - filePath = cacheStore.getValueFromCache(alternateKey); + logger.entering(); + String filePath = null; + + InstallerMetaData metaData = userSettingsFile.getInstallerForPlatform(installerType, getArchitecture(), + getVersion()); + if (metaData != null) { + filePath = metaData.getLocation(); } if (!isFileOnDisk(filePath)) { - throw new FileNotFoundException(Utils.getMessage("IMG-0011", key)); + throw new FileNotFoundException(Utils.getMessage("IMG-0011", filePath)); } logger.exiting(filePath); @@ -173,9 +137,9 @@ public String resolve(CacheStore cacheStore) throws IOException { * @return the path of the file copied to the Docker build context directory */ public Path copyFile(CacheStore cacheStore, String buildContextDir) throws IOException { - logger.entering(id, version, architecture, buildContextDir); + logger.entering(installerType, version, architecture, buildContextDir); Path result; - String sourceFile = resolve(cacheStore); + String sourceFile = resolve(); logger.info("IMG-0043", sourceFile); String targetFilename = new File(sourceFile).getName(); try { diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/aru/AruPatch.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/aru/AruPatch.java index a03eae7c..9486a878 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/aru/AruPatch.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/aru/AruPatch.java @@ -17,6 +17,8 @@ import org.w3c.dom.Node; import org.w3c.dom.NodeList; +import static com.oracle.weblogic.imagetool.aru.AruUtil.getAruPlatform; + /** * Metadata for a patch, as defined by ARU. * Simple bean for holding metadata obtained from ARU for a given patch ID and version. @@ -35,6 +37,8 @@ public class AruPatch { private String downloadPath; private String fileName; private String access; + private String platform; + private String sha256Hash; public String patchId() { return patchId; @@ -76,6 +80,15 @@ public AruPatch product(String value) { return this; } + public String platform() { + return platform; + } + + public AruPatch platform(String platform) { + this.platform = platform; + return this; + } + public String release() { return release; } @@ -85,6 +98,14 @@ public AruPatch release(String value) { return this; } + public AruPatch sha256Hash(String value) { + sha256Hash = value; + return this; + } + + public String sha256Hash() { + return sha256Hash; + } public String releaseName() { return releaseName; @@ -182,6 +203,9 @@ public static Stream getPatches(Document patchList) throws XPathExpres .product(XPathUtil.string(nodeList.item(i), "./product/@id")) .psuBundle(XPathUtil.string(nodeList.item(i), "./psu_bundle")) .access(XPathUtil.string(nodeList.item(i), "./access")) + .sha256Hash(XPathUtil.string(nodeList.item(i), + "./files/file/digest[@type='SHA-256']/text()")) + .platform(getAruPlatform(XPathUtil.string(nodeList.item(i), "./platform/@id"))) .downloadHost(XPathUtil.string(nodeList.item(i), "./files/file/download_url/@host")) .downloadPath(XPathUtil.string(nodeList.item(i), "./files/file/download_url/text()")); @@ -287,6 +311,20 @@ private static AruPatch selectPatchOffline(List patches, String provid @Override public String toString() { - return patchId + " - " + description; + return "AruPatch{" + + "patchId='" + patchId + '\'' + + ", version='" + version + '\'' + + ", description='" + description + '\'' + + ", product='" + product + '\'' + + ", release='" + release + '\'' + + ", releaseName='" + releaseName + '\'' + + ", psuBundle='" + psuBundle + '\'' + + ", downloadHost='" + downloadHost + '\'' + + ", downloadPath='" + downloadPath + '\'' + + ", fileName='" + fileName + '\'' + + ", access='" + access + '\'' + + ", platform='" + platform + '\'' + + ", sha256Hash='" + sha256Hash + '\'' + + '}'; } } diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/aru/AruUtil.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/aru/AruUtil.java index 519aac9e..a5a0f1df 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/aru/AruUtil.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/aru/AruUtil.java @@ -580,5 +580,20 @@ private static T retry(MethodToRetry call) throws AruException, RetryFail // When all retries are exhausted, raise an ARU exception to exit the process (give up) throw logger.throwing(new RetryFailedException()); } + + /** + * Get the translated aru platform. + * @param id from aru result + * @return text string fromm id number + */ + public static String getAruPlatform(String id) { + if ("2000".equals(id)) { + return "generic"; + } + if ("1000".equals(id)) { + return "linux/arm64"; + } + return "generic"; + } } diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cachestore/OPatchFile.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cachestore/OPatchFile.java index 58c2425f..db6e8019 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cachestore/OPatchFile.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cachestore/OPatchFile.java @@ -7,7 +7,7 @@ import java.io.IOException; import java.util.Comparator; import java.util.List; -import java.util.Set; +import java.util.Map; import java.util.stream.Collectors; import javax.xml.xpath.XPathExpressionException; @@ -18,6 +18,8 @@ import com.oracle.weblogic.imagetool.aru.VersionNotFoundException; import com.oracle.weblogic.imagetool.logging.LoggingFacade; import com.oracle.weblogic.imagetool.logging.LoggingFactory; +import com.oracle.weblogic.imagetool.patch.PatchMetaData; +import com.oracle.weblogic.imagetool.settings.UserSettingsFile; import com.oracle.weblogic.imagetool.util.Utils; public class OPatchFile extends PatchFile { @@ -32,10 +34,9 @@ public class OPatchFile extends PatchFile { * @param patchId bug number and optional version * @param userid the username to use for retrieving the patch * @param password the password to use with the userId to retrieve the patch - * @param cache the local cache used for patch storage * @return an abstract OPatch file */ - public static OPatchFile getInstance(String patchId, String userid, String password, CacheStore cache) + public static OPatchFile getInstance(String patchId, String userid, String password) throws AruException, XPathExpressionException, IOException { logger.entering(patchId); @@ -54,13 +55,15 @@ public static OPatchFile getInstance(String patchId, String userid, String passw AruPatch selectedPatch; if (isOffline(userid, password)) { - selectedPatch = getAruPatchOffline(patchNumber, providedVersion, cache); + selectedPatch = getAruPatchOffline(patchNumber, providedVersion); } else { try { selectedPatch = getAruPatchOnline(patchNumber, providedVersion, userid, password); } catch (VersionNotFoundException notFound) { // Could not find the user requested OPatch version on ARU, checking local cache before giving up - if (cache.containsKey(patchId)) { + UserSettingsFile userSettingsFile = new UserSettingsFile(); + Map> patchSettings = userSettingsFile.getAllPatches(); + if (patchSettings.containsKey(patchId)) { logger.info("OPatch version {0} is not available online, using cached copy.", providedVersion); selectedPatch = new AruPatch().patchId(patchNumber).version(providedVersion); } else { @@ -78,12 +81,13 @@ private static boolean isOffline(String userid, String password) { return userid == null || password == null; } - private static AruPatch getAruPatchOffline(String patchNumber, String providedVersion, CacheStore cache) { + private static AruPatch getAruPatchOffline(String patchNumber, String providedVersion) { // if working offline, update the placeholder in the list to have the provided version or the latest cached AruPatch offlinePatch = new AruPatch().patchId(patchNumber); + UserSettingsFile userSettingsFile = new UserSettingsFile(); if (Utils.isEmptyString(providedVersion)) { // user did not request a specific version, find the latest version of OPatch in the cache - offlinePatch.version(getLatestCachedVersion(cache, patchNumber)); + offlinePatch.version(getLatestCachedVersion(patchNumber)); } else { offlinePatch.version(providedVersion); } @@ -94,7 +98,6 @@ private static AruPatch getAruPatchOffline(String patchNumber, String providedVe private static AruPatch getAruPatchOnline(String patchNumber, String providedVersion, String userid, String password) throws XPathExpressionException, IOException, AruException { - List patches = AruUtil.rest().getPatches(patchNumber, userid, password) .filter(AruPatch::isOpenAccess) // filter ARU results based on access flag (discard protected versions) .collect(Collectors.toList()); @@ -131,22 +134,18 @@ private OPatchFile(AruPatch patch, String userId, String password) { super(patch, userId, password); } - private static String getLatestCachedVersion(CacheStore cache, String patchId) { + private static String getLatestCachedVersion(String patchId) { String latestVersion = "0.0.0.0.0"; - Set keys = cache.getCacheItems().keySet(); - for (String key : keys) { - if (key.startsWith(patchId)) { - logger.fine("found OPatch entry in cache {0}", key); - int split = key.indexOf('_'); - if (split < 0) { - continue; - } - String cacheVersion = key.substring(split + 1); - if (Utils.compareVersions(latestVersion, cacheVersion) < 0) { - logger.fine("using cache {0} as newer OPatch version instead of {1}", key, latestVersion); - latestVersion = cacheVersion; - } + UserSettingsFile userSettingsFile = new UserSettingsFile(); + Map> patchList = userSettingsFile.getAllPatches(); + List patchMetaDataList = patchList.get(patchId); + for (PatchMetaData patchMetaData : patchMetaDataList) { + String cacheVersion = patchMetaData.getPatchVersion(); + if (Utils.compareVersions(latestVersion, cacheVersion) < 0) { + logger.fine("Found a later version {0}", cacheVersion); + latestVersion = cacheVersion; } + } return latestVersion; } @@ -164,12 +163,20 @@ public static boolean isOPatchPatch(String patchId) { return patchId != null && patchId.startsWith(DEFAULT_BUG_NUM + CacheStore.CACHE_KEY_SEPARATOR); } - @Override - public String resolve(CacheStore cacheStore) throws IOException { + /** + * resolve. + * @return string + * @throws IOException error + */ + public String resolve() throws IOException { try { - return super.resolve(cacheStore); + return super.resolve(); } catch (FileNotFoundException fnfe) { throw new FileNotFoundException(Utils.getMessage("IMG-0062")); } } + + public String getVersion() { + return null; + } } diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cachestore/PatchFile.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cachestore/PatchFile.java index c7e05b82..3931be33 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cachestore/PatchFile.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cachestore/PatchFile.java @@ -5,97 +5,125 @@ import java.io.FileNotFoundException; import java.io.IOException; +import java.nio.file.Files; +import java.nio.file.Paths; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; -import com.oracle.weblogic.imagetool.api.model.CachedFile; import com.oracle.weblogic.imagetool.aru.AruPatch; import com.oracle.weblogic.imagetool.aru.AruUtil; import com.oracle.weblogic.imagetool.logging.LoggingFacade; import com.oracle.weblogic.imagetool.logging.LoggingFactory; +import com.oracle.weblogic.imagetool.patch.PatchMetaData; +import com.oracle.weblogic.imagetool.settings.UserSettingsFile; import com.oracle.weblogic.imagetool.util.Utils; -public class PatchFile extends CachedFile { +import static com.oracle.weblogic.imagetool.util.Utils.getSha256Hash; +import static com.oracle.weblogic.imagetool.util.Utils.getTodayDate; + +public class PatchFile { private static final LoggingFacade logger = LoggingFactory.getLogger(PatchFile.class); - private final AruPatch aruPatch; private final String userId; private final String password; + private final AruPatch aruPatch; /** * Create an abstract file to hold the metadata for a patch file. * - * @param aruPatch Patch metadata from ARU * @param userId the username to use for retrieving the patch * @param password the password to use with the userId to retrieve the patch */ public PatchFile(AruPatch aruPatch, String userId, String password) { - super(aruPatch.patchId(), aruPatch.version()); this.aruPatch = aruPatch; this.userId = userId; this.password = password; - - if (Utils.isEmptyString(aruPatch.patchId())) { - throw new IllegalArgumentException(Utils.getMessage("IMG-0058", aruPatch.patchId())); - } } - @Override - public String getVersion() { - return aruPatch.version(); + private boolean offlineMode() { + return userId == null || password == null; } - void setVersion(String value) { - aruPatch.version(value); - } + /** + * download patch. + * @param aruPatch patch + * @param userSettingsFile settings + * @return filname path of the patch downloaded + * @throws IOException error + */ + public String downloadPatch(AruPatch aruPatch, UserSettingsFile userSettingsFile) throws IOException { + String filename = AruUtil.rest().downloadAruPatch(aruPatch, userSettingsFile.getPatchDirectory(), + userId, password); + String hashString = getSha256Hash(filename); + if (!hashString.equals(aruPatch.sha256Hash())) { + throw new IOException("Patch file hash mismatch"); + } + try { + Map> allPatches = userSettingsFile.getAllPatches(); + List patches; + if (allPatches.containsKey(aruPatch.patchId())) { + patches = allPatches.get(aruPatch.patchId()); + patches.add(new PatchMetaData(aruPatch.platform(), + filename, + aruPatch.sha256Hash(), + getTodayDate(), + aruPatch.version())); + allPatches.remove(aruPatch.patchId()); + allPatches.put(aruPatch.patchId(),patches); + } else { + patches = new ArrayList<>(); + patches.add(new PatchMetaData(aruPatch.platform(), + filename, + aruPatch.sha256Hash(), + getTodayDate(), + aruPatch.version())); + allPatches.put(aruPatch.patchId(),patches); + } + userSettingsFile.saveAllPatches(allPatches, userSettingsFile.getPatchDetailsFile()); - private boolean offlineMode() { - return userId == null || password == null; + } catch (Exception k) { + k.printStackTrace(); + } + return filename; } - @Override - public String resolve(CacheStore cacheStore) throws IOException { - String cacheKey = getKey(); + /** + * Resolve the patch location. + * @return path of the file + * @throws IOException when file is not there + */ + public String resolve() throws IOException { + String cacheKey = aruPatch.patchId(); logger.entering(cacheKey); - String filePath; - boolean fileExists; - - filePath = cacheStore.getValueFromCache(cacheKey); - fileExists = isFileOnDisk(filePath); + String filePath = null; + boolean fileExists = false; + UserSettingsFile userSettingsFile = new UserSettingsFile(); + PatchMetaData patchSettings = userSettingsFile.getPatchForPlatform(aruPatch.platform(), aruPatch.patchId()); + if (patchSettings != null) { + filePath = patchSettings.getLocation(); + fileExists = isFileOnDisk(filePath); + } if (fileExists) { - logger.info("IMG-0017", getKey(), filePath); + logger.info("IMG-0017", cacheKey, filePath); } else { - logger.info("IMG-0061", getKey(), aruPatch.patchId()); + logger.info("IMG-0061", cacheKey, aruPatch.patchId()); if (offlineMode()) { - throw new FileNotFoundException(Utils.getMessage("IMG-0056", getKey())); + throw new FileNotFoundException(Utils.getMessage("IMG-0056", cacheKey)); } - filePath = downloadPatch(cacheStore); + filePath = downloadPatch(aruPatch, userSettingsFile); } logger.exiting(filePath); return filePath; } - private String downloadPatch(CacheStore cacheStore) throws IOException { - String filename = AruUtil.rest().downloadAruPatch(aruPatch, cacheStore.getCacheDir(), userId, password); - - // after downloading the file, update the cache metadata - String patchKey = getKey(); - logger.info("IMG-0060", patchKey, filename); - cacheStore.addToCache(patchKey, filename); - String filePath = cacheStore.getValueFromCache(patchKey); - - if (!isFileOnDisk(filePath)) { - throw new FileNotFoundException(Utils.getMessage("IMG-0037", aruPatch.patchId(), getVersion())); - } - - return filePath; + public static boolean isFileOnDisk(String filePath) { + return filePath != null && Files.isRegularFile(Paths.get(filePath)); } - @Override - public String toString() { - return getKey(); - } } diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonCreateOptions.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonCreateOptions.java index a0657761..1a5e07a2 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonCreateOptions.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonCreateOptions.java @@ -3,10 +3,13 @@ package com.oracle.weblogic.imagetool.cli.menu; +import java.io.FileInputStream; import java.io.IOException; import java.nio.file.Files; import java.nio.file.Path; import java.nio.file.Paths; +import java.security.MessageDigest; +import java.security.NoSuchAlgorithmException; import java.util.ArrayList; import java.util.List; import javax.xml.xpath.XPathExpressionException; @@ -17,7 +20,6 @@ import com.oracle.weblogic.imagetool.installer.MiddlewareInstall; import com.oracle.weblogic.imagetool.logging.LoggingFacade; import com.oracle.weblogic.imagetool.logging.LoggingFactory; -import com.oracle.weblogic.imagetool.settings.InstallerSettings; import com.oracle.weblogic.imagetool.settings.UserSettingsFile; import com.oracle.weblogic.imagetool.util.Constants; import com.oracle.weblogic.imagetool.util.Utils; @@ -41,11 +43,14 @@ void prepareNewImage() throws IOException, InterruptedException, XPathExpression copyOptionsFromImage(); UserSettingsFile settingsFile = new UserSettingsFile(); + List buildPlatforms = getBuildPlatform(); + // Verify version and installers exists first + verifyInstallers(settingsFile, buildPlatforms); + if (dockerfileOptions.installJava()) { - InstallerSettings jdkInstallers = settingsFile.getInstallerSettings(InstallerType.JDK); List jdkFilePathList = new ArrayList<>(); - for (String jdkPlatform : getBuildPlatform()) { + for (String jdkPlatform : buildPlatforms) { String buildContextDestination = buildDir(); if (jdkPlatform.equals(AMD64)) { buildContextDestination = buildContextDestination + "/" + CTX_JDK + AMD64; @@ -56,7 +61,8 @@ void prepareNewImage() throws IOException, InterruptedException, XPathExpression } //CachedFile jdk = new CachedFile(InstallerType.JDK, jdkVersion, jdkPlatform); //Path installerPath = jdk.copyFile(cache(), buildContextDestination); - InstallerMetaData installerMetaData = jdkInstallers.getInstallerForPlatform(jdkPlatform, jdkVersion); + InstallerMetaData installerMetaData = settingsFile.getInstallerForPlatform(InstallerType.JDK, + jdkPlatform, jdkVersion); Path installerPath = Paths.get(installerMetaData.getLocation()); Files.copy(installerPath, Paths.get(buildContextDestination).resolve(installerPath.getFileName())); jdkFilePathList.add(installerPath.getFileName().toString()); @@ -67,7 +73,7 @@ void prepareNewImage() throws IOException, InterruptedException, XPathExpression if (dockerfileOptions.installMiddleware()) { MiddlewareInstall install = - new MiddlewareInstall(getInstallerType(), installerVersion, installerResponseFiles, getBuildPlatform()); + new MiddlewareInstall(getInstallerType(), installerVersion, installerResponseFiles, buildPlatforms); install.copyFiles(cache(), buildDir()); dockerfileOptions.setMiddlewareInstall(install); } else { @@ -97,6 +103,61 @@ void prepareNewImage() throws IOException, InterruptedException, XPathExpression logger.exiting(); } + + void verifyInstallers(UserSettingsFile settingsFile, List buildPlatforms) throws IOException { + + // Verify version and installers exists first + for (String buildPlatform : buildPlatforms) { + InstallerMetaData jdkInstallerMetaData = settingsFile.getInstallerForPlatform(InstallerType.JDK, + buildPlatform, jdkVersion); + if (jdkInstallerMetaData == null) { + throw new IOException("Could not find installer for jdk " + jdkVersion + " " + buildPlatform); + } else { + // If needed + verifyInstallerHash(jdkInstallerMetaData); + } + + for (InstallerType installerType : getInstallerType().installerList()) { + InstallerMetaData installerMetaData = settingsFile.getInstallerForPlatform(installerType, + buildPlatform, installerVersion); + if (installerMetaData == null) { + throw new IOException(String.format("Could not find installer type %s, platform %s and version %s", + installerType, buildPlatform, installerVersion)); + } else { + // If needed + verifyInstallerHash(installerMetaData); + } + } + } + + } + + private static void verifyInstallerHash(InstallerMetaData installerMetaData) throws IOException { + MessageDigest digest; + try { + digest = MessageDigest.getInstance("SHA-256"); + } catch (NoSuchAlgorithmException ex) { + throw new IOException(ex); + } + try (FileInputStream fis = new FileInputStream(installerMetaData.getLocation())) { + byte[] buffer = new byte[1024]; + int read; + while ((read = fis.read(buffer)) != -1) { + digest.update(buffer, 0, read); + } + } + byte[] hash = digest.digest(); + StringBuilder sb = new StringBuilder(); + for (byte b : hash) { + sb.append(String.format("%02x", b)); + } + String hashString = sb.toString(); + if (!hashString.equals(installerMetaData.getHash())) { + throw new IOException(String.format("Installer hash mismatch, expected %s but got %s for file %s", + installerMetaData.getHash(), hashString, installerMetaData.getLocation())); + } + } + String getInstallerVersion() { return installerVersion; } diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonOptions.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonOptions.java index 42f800ca..d56ce0fc 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonOptions.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonOptions.java @@ -29,7 +29,7 @@ import com.oracle.weblogic.imagetool.util.DockerfileOptions; import com.oracle.weblogic.imagetool.util.InvalidPatchIdFormatException; import com.oracle.weblogic.imagetool.util.Utils; -import jdk.vm.ci.amd64.AMD64; +//import jdk.vm.ci.amd64.AMD64; import picocli.CommandLine; import picocli.CommandLine.Option; import picocli.CommandLine.Parameters; diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonPatchingOptions.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonPatchingOptions.java index 4b080c8a..c2e0bbab 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonPatchingOptions.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonPatchingOptions.java @@ -27,11 +27,12 @@ import com.oracle.weblogic.imagetool.installer.FmwInstallerType; import com.oracle.weblogic.imagetool.logging.LoggingFacade; import com.oracle.weblogic.imagetool.logging.LoggingFactory; +import com.oracle.weblogic.imagetool.patch.PatchMetaData; +import com.oracle.weblogic.imagetool.settings.UserSettingsFile; import com.oracle.weblogic.imagetool.util.InvalidPatchIdFormatException; import com.oracle.weblogic.imagetool.util.Utils; import picocli.CommandLine.Option; -import static com.oracle.weblogic.imagetool.cachestore.CacheStoreFactory.cache; public abstract class CommonPatchingOptions extends CommonOptions { private static final LoggingFacade logger = LoggingFactory.getLogger(CommonPatchingOptions.class); @@ -148,9 +149,29 @@ void handlePatchFiles(List installedPatches) String patchesFolderName = createPatchesTempDirectory().toAbsolutePath().toString(); // copy the patch JARs to the Docker build context directory from the local cache, downloading them if needed + UserSettingsFile userSettingsFile = new UserSettingsFile(); for (AruPatch patch : aruPatches) { - PatchFile patchFile = new PatchFile(patch, userId, password); - String patchLocation = patchFile.resolve(cache()); + String platform = patch.platform(); + // TODO + if (platform == null) { + platform = "generic"; + } + PatchMetaData metaData = userSettingsFile.getPatchForPlatform(platform, patch.patchId()); + + if (metaData == null) { + // download the patch first + if (userId != null && password != null) { + PatchFile patchFile = new PatchFile(patch, userId, password); + String filePath = patchFile.resolve(); + metaData = userSettingsFile.getPatchForPlatform(platform, patch.patchId()); + } else { + throw logger.throwing(new IOException("No user credentials provided and " + + "no offline patch downloaded: " + patch.patchId())); + } + } + //PatchFile patchFile = new PatchFile(patch, userId, password); + + String patchLocation = metaData.getLocation(); if (patchLocation != null && !Utils.isEmptyString(patchLocation)) { File cacheFile = new File(patchLocation); try { @@ -159,10 +180,10 @@ void handlePatchFiles(List installedPatches) } Files.copy(Paths.get(patchLocation), Paths.get(patchesFolderName, cacheFile.getName())); } catch (FileAlreadyExistsException ee) { - logger.warning("IMG-0077", patchFile.getKey()); + logger.warning("IMG-0077", patch.patchId()); } } else { - logger.severe("IMG-0024", patchFile.getKey()); + logger.severe("IMG-0024", patch.patchId()); } } if (!aruPatches.isEmpty()) { @@ -308,7 +329,7 @@ private Path createPatchesTempDirectory() throws IOException { void prepareOpatchInstaller(String tmpDir, String opatchBugNumber) throws IOException, XPathExpressionException, AruException { logger.entering(opatchBugNumber); - String filePath = OPatchFile.getInstance(opatchBugNumber, userId, password, cache()).resolve(cache()); + String filePath = OPatchFile.getInstance(opatchBugNumber, userId, password).resolve(); String filename = new File(filePath).getName(); Files.copy(Paths.get(filePath), Paths.get(tmpDir, filename)); dockerfileOptions.setOPatchPatchingEnabled(); diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/UpdateImage.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/UpdateImage.java index c79c75a0..f02c4b78 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/UpdateImage.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/UpdateImage.java @@ -27,7 +27,6 @@ import picocli.CommandLine.Command; import picocli.CommandLine.Option; -import static com.oracle.weblogic.imagetool.cachestore.CacheStoreFactory.cache; @Command( name = "update", @@ -101,8 +100,8 @@ public CommandResponse call() throws Exception { String password = getPassword(); if (shouldUpdateOpatch()) { - OPatchFile opatchFile = OPatchFile.getInstance(opatchBugNumber, userId, password, cache()); - String opatchFilePath = opatchFile.resolve(cache()); + OPatchFile opatchFile = OPatchFile.getInstance(opatchBugNumber, userId, password); + String opatchFilePath = opatchFile.resolve(); // if there is a newer version of OPatch than contained in the image, update OPatch if (Utils.compareVersions(opatchVersion, opatchFile.getVersion()) < 0) { diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/installer/InstallerMetaData.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/installer/InstallerMetaData.java index 1b193151..f1877c29 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/installer/InstallerMetaData.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/installer/InstallerMetaData.java @@ -8,7 +8,7 @@ public class InstallerMetaData { private String location; private String hash; private String dateAdded; - private String version; + private String productVersion; /** * Constructor InstallerMetaData stores details about this installer. @@ -17,12 +17,12 @@ public class InstallerMetaData { * @param hash hash value * @param dateAdded date added */ - public InstallerMetaData(String platform, String location, String hash, String dateAdded, String version) { + public InstallerMetaData(String platform, String location, String hash, String dateAdded, String productVersion) { this.platform = platform; this.location = location; this.hash = hash; this.dateAdded = dateAdded; - this.version = version; + this.productVersion = productVersion; } public String getPlatform() { @@ -41,12 +41,12 @@ public String getDateAdded() { return dateAdded; } - public String getVersion() { - return version; + public String getProductVersion() { + return productVersion; } public String toString() { return "InstallerMetaData [platform=" + platform + ", location=" + location + ", hash=" + hash + ", " - + "dateAdded=" + dateAdded + ", version=" + version + "]"; + + "dateAdded=" + dateAdded + ", version=" + productVersion + "]"; } } diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/installer/MiddlewareInstall.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/installer/MiddlewareInstall.java index 41978ebb..70a263d2 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/installer/MiddlewareInstall.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/installer/MiddlewareInstall.java @@ -15,10 +15,10 @@ import java.util.zip.ZipEntry; import java.util.zip.ZipFile; +import com.oracle.weblogic.imagetool.api.model.CachedFile; import com.oracle.weblogic.imagetool.cachestore.CacheStore; import com.oracle.weblogic.imagetool.logging.LoggingFacade; import com.oracle.weblogic.imagetool.logging.LoggingFactory; -import com.oracle.weblogic.imagetool.settings.InstallerSettings; import com.oracle.weblogic.imagetool.settings.UserSettingsFile; import com.oracle.weblogic.imagetool.util.Utils; @@ -45,18 +45,17 @@ public MiddlewareInstall(FmwInstallerType type, String version, List respo fmwInstallerType = type; UserSettingsFile settingsFile = new UserSettingsFile(); - for (InstallerType installer : type.installerList()) { - InstallerSettings installers = settingsFile.getInstallerSettings(installer); - + for (InstallerType installerType : type.installerList()) { for (String platform : buildPlatform) { MiddlewareInstallPackage pkg = new MiddlewareInstallPackage(); - pkg.type = installer; - //pkg.installer = new CachedFile(installer, version, platform); - pkg.installerPath = Paths.get(installers.getInstallerForPlatform(platform, version).getLocation()); + pkg.type = installerType; + pkg.installer = new CachedFile(installerType, version, platform); + InstallerMetaData metaData = settingsFile.getInstallerForPlatform(installerType, platform, version); + pkg.installerPath = Paths.get(metaData.getLocation()); pkg.installerFilename = pkg.installerPath.getFileName().toString(); - pkg.responseFile = new DefaultResponseFile(installer, type); + pkg.responseFile = new DefaultResponseFile(installerType, type); pkg.platform = platform; - if (installer.equals(InstallerType.DB19)) { + if (installerType.equals(InstallerType.DB19)) { pkg.preinstallCommands = Collections.singletonList("34761383/changePerm.sh /u01/oracle"); } addInstaller(pkg); diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/patch/PatchMetaData.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/patch/PatchMetaData.java new file mode 100644 index 00000000..1e65d380 --- /dev/null +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/patch/PatchMetaData.java @@ -0,0 +1,59 @@ +// Copyright (c) 2024, 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.patch; + +public class PatchMetaData { + private String platform; + private String location; + private String hash; + private String dateAdded; + private String patchVersion; + + /** + * Constructor. + * @param platform platform + * @param location file path of the patch + * @param hash sha256 hash + * @param dateAdded date added + * @param patchVersion version + */ + public PatchMetaData(String platform, String location, String hash, String dateAdded, String patchVersion) { + this.platform = platform; + this.location = location; + this.hash = hash; + this.dateAdded = dateAdded; + this.patchVersion = patchVersion; + } + + public String getPlatform() { + return platform; + } + + public String getLocation() { + return location; + } + + public String getHash() { + return hash; + } + + public String getDateAdded() { + return dateAdded; + } + + public String getPatchVersion() { + return patchVersion; + } + + @Override + public String toString() { + return "PatchMetaData{" + + "platform='" + platform + '\'' + + ", location='" + location + '\'' + + ", hash='" + hash + '\'' + + ", dateAdded='" + dateAdded + '\'' + + ", patchVersion='" + patchVersion + '\'' + + '}'; + } +} diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/InstallerSettings.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/InstallerSettings.java index 6bf9b911..e289e559 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/InstallerSettings.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/InstallerSettings.java @@ -3,14 +3,13 @@ package com.oracle.weblogic.imagetool.settings; -import java.util.ArrayList; +import java.util.HashMap; import java.util.Map; -import com.oracle.weblogic.imagetool.installer.InstallerMetaData; public class InstallerSettings { private String defaultVersion; - private Map installerList; + private Map installerList = new HashMap(); public InstallerSettings(Map settings) { applySettings(settings); @@ -21,10 +20,9 @@ public InstallerSettings(Map settings) { * @param settings map from YAML parser */ private void applySettings(Map settings) { - if (settings == null || settings.isEmpty()) { - return; - } - + //if (settings == null || settings.isEmpty()) { + // return; + //} defaultVersion = SettingsFile.getValue("defaultVersion", String.class, settings); installerList = settings; } @@ -33,31 +31,4 @@ public String getDefaultVersion() { return defaultVersion; } - /** - * Test. - * @param platformName platform name - * @param version version - * @return InstallerMetaData - */ - public InstallerMetaData getInstallerForPlatform(String platformName, String version) { - if (installerList != null && !installerList.isEmpty()) { - // TODO: check version exists - Object versionedInstaller = installerList.get(version); - if (versionedInstaller instanceof ArrayList) { - for (Object installerObj : (ArrayList) versionedInstaller) { - Map installerMap = (Map) installerObj; - String platform = (String) installerMap.get("platform"); - if (platform.equals(platformName)) { - String hash = (String) installerMap.get("digest"); - String dateAdded = (String) installerMap.get("added"); - String location = (String) installerMap.get("file"); - String versionName = (String) installerMap.get("version"); - return new InstallerMetaData(platform, location, hash, dateAdded, versionName); - } - } - } - } - return null; - } - } diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/UserSettingsFile.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/UserSettingsFile.java index 64ecbc78..2cef9d78 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/UserSettingsFile.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/UserSettingsFile.java @@ -6,19 +6,31 @@ import java.io.IOException; import java.nio.file.Path; import java.nio.file.Paths; +import java.util.ArrayList; import java.util.EnumMap; +import java.util.HashMap; +import java.util.LinkedHashMap; +import java.util.List; import java.util.Map; +import com.oracle.weblogic.imagetool.cachestore.OPatchFile; +import com.oracle.weblogic.imagetool.installer.InstallerMetaData; import com.oracle.weblogic.imagetool.installer.InstallerType; import com.oracle.weblogic.imagetool.logging.LoggingFacade; import com.oracle.weblogic.imagetool.logging.LoggingFactory; +import com.oracle.weblogic.imagetool.patch.PatchMetaData; + +import static com.oracle.weblogic.imagetool.util.Utils.getTodayDate; public class UserSettingsFile { private static final LoggingFacade logger = LoggingFactory.getLogger(UserSettingsFile.class); /** * Configured defaults associated with each installer. */ - private final EnumMap installers; + private final EnumMap installerSettings; + + //private InstallerSettings patches = null; + /** * Parent directory for the build context directory. * A temporary folder created under "Build Directory" with the prefix "wlsimgbuilder_tempXXXXXXX" will be created @@ -58,6 +70,14 @@ public class UserSettingsFile { private final SettingsFile settingsFile; + private String installerDetailsFile = null; + + private String patchDetailsFile = null; + + public String getPatchDetailsFile() { + return patchDetailsFile; + } + /** * DLoads the settings.yaml file from ~/.imagetool/settings.yaml and applies the values found. */ @@ -71,7 +91,7 @@ public UserSettingsFile() { * @param pathToSettingsFile A map of key-value pairs read in from the YAML user settings file. */ public UserSettingsFile(Path pathToSettingsFile) { - installers = new EnumMap<>(InstallerType.class); + installerSettings = new EnumMap<>(InstallerType.class); settingsFile = new SettingsFile(pathToSettingsFile); applySettings(settingsFile.load()); } @@ -217,32 +237,44 @@ public void setAruRetryInterval(Integer value) { * @return the settings for the requested installer type */ public InstallerSettings getInstallerSettings(InstallerType installerType) { - if (installers == null) { + if (installerSettings == null) { return null; } - return installers.get(installerType); + return installerSettings.get(installerType); } - private void applySettings(Map settings) { - logger.entering(); - if (settings == null || settings.isEmpty()) { - logger.exiting(); - return; - } + public Map getInstaller(InstallerType installerType) { + return null; + } - patchDirectory = SettingsFile.getValue("patchDirectory", String.class, settings); - installerDirectory = SettingsFile.getValue("installerDirectory", String.class, settings); - buildContextDirectory = SettingsFile.getValue("buildContextDirectory", String.class, settings); - buildEngine = SettingsFile.getValue("buildEngine", String.class, settings); - containerEngine = SettingsFile.getValue("containerEngine", String.class, settings); + private InstallerMetaData createInstallerMetaData(Map objectData) { + String hash = (String) objectData.get("digest"); + String dateAdded = (String) objectData.get("added"); + String location = (String) objectData.get("file"); + String productVersion = (String) objectData.get("version"); + String platform = (String) objectData.get("platform"); + return new InstallerMetaData(platform, location, hash, dateAdded, productVersion); + } + + private PatchMetaData createPatchMetaData(Map objectData) { + String hash = (String) objectData.get("hash"); + String dateAdded = getTodayDate(); + String location = (String) objectData.get("location"); + String productVersion = (String) objectData.get("patchVersion"); + String platform = (String) objectData.get("platform"); + return new PatchMetaData(platform, location, hash, dateAdded, productVersion); + } + + /** + * Return all the installers based on the configured directory for the yaml file. + * @return map of installers + */ + public EnumMap>> getInstallers() { - aruRetryMax = SettingsFile.getValue("aruRetryMax", Integer.class, settings); - aruRetryInterval = SettingsFile.getValue("aruRetryInterval", Integer.class, settings); // installers is a list of different installer types jdk, fmw, wdt etc .. // For each installer type, there is a list of individual installer //jdk: - // defaultVersion: 8u401 // 11u22: // - platform: linux/arm64 // file: /path/to/installerarm.gz @@ -256,20 +288,196 @@ private void applySettings(Map settings) { // added: 20241201 // 8u401: //wls: - // defaultVersion: 12.2.1.4.0 // 12.2.1.4.0: // - platform: linux/arm64 // .... // - platform: linux/arm64 - installers.clear(); + Map allInstallers = new SettingsFile(Paths.get(installerDetailsFile)).load(); + EnumMap>> installerDetails + = new EnumMap<>(InstallerType.class); + for (Map.Entry entry: allInstallers.entrySet()) { + String key = entry.getKey(); + if (key != null && !key.isEmpty()) { + Map> installerMetaData = new HashMap<>(); + key = key.toUpperCase(); // jdk, wls, fmw etc ... + try { + // process list of individual installers + // 12.2.1.4.0: + // - platform: linux/arm64 + // - platform: linux/amd64 + // 14.1.2.0.0: + // - platform: + // - platform + Map installerValues = (Map) entry.getValue(); + + for (Map.Entry individualInstaller: installerValues.entrySet()) { + String individualInstallerKey = individualInstaller.getKey(); // e.g. 12.2.1.4, 14.1.2 + List installerMetaDataList = new ArrayList<>(installerValues.size()); + + if (individualInstaller.getValue() instanceof ArrayList) { + for (Object installerValue: (ArrayList) individualInstaller.getValue()) { + installerMetaDataList.add(createInstallerMetaData((Map)installerValue)); + } + } else { + installerMetaDataList.add( + createInstallerMetaData((Map)individualInstaller.getValue())); + } + installerMetaData.put(individualInstallerKey, installerMetaDataList); + } + + installerDetails.put(InstallerType.valueOf(key), installerMetaData); + + } catch (IllegalArgumentException illegal) { + logger.warning("{0} could not be loaded: {1}", + key, InstallerType.class.getEnumConstants()); + } + } + } + return installerDetails; + } + + /** + * Return the metadata for the platformed installer. + * @param platformName platform name + * @param installerVersion version of the installer + * @return InstallerMetaData meta data for the installer + */ + + public InstallerMetaData getInstallerForPlatform(InstallerType installerType, String platformName, + String installerVersion) { + + Map> installers = getInstallers().get(installerType); + if (installers != null && !installers.isEmpty()) { + List installerMetaDataList = installers.get(installerVersion); + if (installerMetaDataList != null && !installerMetaDataList.isEmpty()) { + for (InstallerMetaData installerMetaData: installerMetaDataList) { + if (installerMetaData.getPlatform().equals(platformName)) { + return installerMetaData; + } + } + } + } + return null; + + } + + /** + * Return the metadata for the platformed installer. + * @param platformName platform name + * @param installerVersion version of the installer + * @return InstallerMetaData meta data for the installer + */ + + public PatchMetaData getPatchForPlatform(String platformName, String installerVersion) { + Map> patches = getAllPatches(); + if (patches != null && !patches.isEmpty()) { + List installerMetaDataList = patches.get(installerVersion); + if (installerMetaDataList != null && !installerMetaDataList.isEmpty()) { + for (PatchMetaData patchMetaData: installerMetaDataList) { + if (patchMetaData.getPlatform().equals(platformName)) { + return patchMetaData; + } + } + // search for generic for opatch only?? + if (OPatchFile.DEFAULT_BUG_NUM.equals(installerVersion)) { + for (PatchMetaData patchMetaData: installerMetaDataList) { + if ("generic".equals(patchMetaData.getPlatform())) { + return patchMetaData; + } + } + } + } + + } + return null; + } + + /** + * return all the patches. + * @return patch settings + */ + public Map> getAllPatches() { + Map allPatches = new SettingsFile(Paths.get(patchDetailsFile)).load(); + Map> patchList = new HashMap<>(); + for (Map.Entry entry: allPatches.entrySet()) { + String key = entry.getKey(); // bug number + List patchMetaDataList = new ArrayList<>(); + if (key != null) { + if (entry.getValue() instanceof ArrayList) { + for (Object installerValue: (ArrayList) entry.getValue()) { + patchMetaDataList.add(createPatchMetaData((Map)installerValue)); + } + } else { + patchMetaDataList.add(createPatchMetaData((Map)entry.getValue())); + } + } + patchList.put(key, patchMetaDataList); + } + return patchList; + } + + /** + * save all the patches. + */ + public void saveAllPatches(Map> allPatches, String location) throws IOException { + Map patchList = new HashMap<>(); + for (Map.Entry> entry: allPatches.entrySet()) { + String key = entry.getKey(); // bug number + if (key != null && !key.isEmpty()) { + ArrayList list = new ArrayList<>(); + if (entry.getValue() instanceof ArrayList) { + for (PatchMetaData patchMetaData: entry.getValue()) { + LinkedHashMap map = new LinkedHashMap<>(); + map.put("patchVersion", patchMetaData.getPatchVersion()); + map.put("location", patchMetaData.getLocation()); + map.put("hash", patchMetaData.getHash()); + map.put("dateAdded", patchMetaData.getDateAdded()); + map.put("platform", patchMetaData.getPlatform()); + list.add(map); + } + } else { + PatchMetaData patchMetaData = (PatchMetaData) entry.getValue(); + LinkedHashMap map = new LinkedHashMap<>(); + map.put("patchVersion", patchMetaData.getPatchVersion()); + map.put("location", patchMetaData.getLocation()); + map.put("hash", patchMetaData.getHash()); + map.put("dateAdded", patchMetaData.getDateAdded()); + map.put("platform", patchMetaData.getPlatform()); + list.add(map); + } + patchList.put(key, list); + } + } + new SettingsFile(Paths.get(location)).save(patchList); + } + + private void applySettings(Map settings) { + logger.entering(); + if (settings == null || settings.isEmpty()) { + logger.exiting(); + return; + } + + patchDirectory = SettingsFile.getValue("patchDirectory", String.class, settings); + installerDirectory = SettingsFile.getValue("installerDirectory", String.class, settings); + buildContextDirectory = SettingsFile.getValue("buildContextDirectory", String.class, settings); + buildEngine = SettingsFile.getValue("buildEngine", String.class, settings); + containerEngine = SettingsFile.getValue("containerEngine", String.class, settings); + + aruRetryMax = SettingsFile.getValue("aruRetryMax", Integer.class, settings); + aruRetryInterval = SettingsFile.getValue("aruRetryInterval", Integer.class, settings); + installerDetailsFile = SettingsFile.getValue("installerSettingsFile", String.class, settings); + patchDetailsFile = SettingsFile.getValue("patchSettingsFile", String.class, settings); + // Just the settings about the installer not the individual installers + installerSettings.clear(); Map installerFolder = SettingsFile.getFolder("installers", settings); for (Map.Entry entry: installerFolder.entrySet()) { String key = entry.getKey(); if (key != null && !key.isEmpty()) { key = key.toUpperCase(); try { - installers.put( + installerSettings.put( InstallerType.valueOf(key), new InstallerSettings((Map) entry.getValue())); } catch (IllegalArgumentException illegal) { @@ -278,10 +486,12 @@ private void applySettings(Map settings) { } } } + logger.exiting(); } public String toString() { return SettingsFile.asYaml(this); } + } diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/util/Utils.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/util/Utils.java index 2c2e88a3..9e31912b 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/util/Utils.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/util/Utils.java @@ -5,6 +5,7 @@ import java.io.BufferedReader; import java.io.File; +import java.io.FileInputStream; import java.io.FileNotFoundException; import java.io.FileReader; import java.io.FileWriter; @@ -18,7 +19,11 @@ import java.nio.file.Path; import java.nio.file.Paths; import java.nio.file.StandardCopyOption; +import java.security.MessageDigest; +import java.security.NoSuchAlgorithmException; import java.text.MessageFormat; +import java.time.LocalDate; +import java.time.format.DateTimeFormatter; import java.util.Arrays; import java.util.Base64; import java.util.Collection; @@ -778,4 +783,46 @@ public static Predicate not(Predicate target) { Objects.requireNonNull(target); return (Predicate)target.negate(); } + + /** + * Return the sha256 hash string of the file. + * @param filename file to check for sha256 hash + * @return sha256 hash value + */ + public static String getSha256Hash(String filename) { + try { + MessageDigest digest; + try { + digest = MessageDigest.getInstance("SHA-256"); + } catch (NoSuchAlgorithmException ex) { + throw new IOException(ex); + } + try (FileInputStream fis = new FileInputStream(filename)) { + byte[] buffer = new byte[1024]; + int read; + while ((read = fis.read(buffer)) != -1) { + digest.update(buffer, 0, read); + } + } + byte[] hash = digest.digest(); + StringBuilder sb = new StringBuilder(); + for (byte b : hash) { + sb.append(String.format("%02x", b)); + } + return sb.toString().toUpperCase(); + + } catch (Exception ie) { + return ""; + } + } + + /** + * Get today's date in yyyy-mm-dd format. + * @return date format + */ + public static String getTodayDate() { + LocalDate today = LocalDate.now(); + return today.format(DateTimeFormatter.ISO_LOCAL_DATE); + } + } diff --git a/imagetool/src/test/java/com/oracle/weblogic/imagetool/cachestore/CachedFileTest.java b/imagetool/src/test/java/com/oracle/weblogic/imagetool/cachestore/CachedFileTest.java index be2b5239..e0322d05 100644 --- a/imagetool/src/test/java/com/oracle/weblogic/imagetool/cachestore/CachedFileTest.java +++ b/imagetool/src/test/java/com/oracle/weblogic/imagetool/cachestore/CachedFileTest.java @@ -10,17 +10,14 @@ import java.util.Arrays; import java.util.List; import java.util.logging.Level; -import javax.xml.xpath.XPathExpressionException; import com.oracle.weblogic.imagetool.api.model.CachedFile; -import com.oracle.weblogic.imagetool.aru.AruException; import com.oracle.weblogic.imagetool.installer.InstallerType; import com.oracle.weblogic.imagetool.logging.LoggingFacade; import com.oracle.weblogic.imagetool.logging.LoggingFactory; import com.oracle.weblogic.imagetool.util.BuildPlatform; import org.junit.jupiter.api.BeforeAll; import org.junit.jupiter.api.Tag; -import org.junit.jupiter.api.Test; import org.junit.jupiter.api.io.TempDir; import static com.oracle.weblogic.imagetool.cachestore.OPatchFile.DEFAULT_BUG_NUM; @@ -60,45 +57,44 @@ static void setup(@TempDir Path tempDir, @TempDir Path cacheDir) throws IOExcept cacheStore.addToCache(DEFAULT_BUG_NUM + "_13.9.2.2.2", "/not/used"); } - @Test + //@Test void versionString() { CachedFile wlsInstallerFile = new CachedFile(InstallerType.WLS, "12.2.1.3.0"); - assertEquals("wls_12.2.1.3.0", wlsInstallerFile.getKey(), - "CachedFile getKey() did not construct the cache key correctly"); assertEquals("12.2.1.3.0", wlsInstallerFile.getVersion(), "CachedFile should return the version from the constructor"); } - @Test + //@Test void userProvidedPatchVersionAsId() { // User provided a patch ID with the version string in the ID - CachedFile cf = new CachedFile("something_versionString", "12.2.1.2.0"); + CachedFile cf = new CachedFile(true,"something_versionString", "12.2.1.2.0", + null); // if the patch ID has the version, CachedFile should ignore the installer version passed to the constructor, // and use the version in the ID. - assertEquals("something_versionString", cf.getKey(), + assertEquals("something_versionString", cf.getPatchId(), "CachedFile getKey() failed when version string was provided by the user in the ID"); // getVersion should always return the version that was provided in the constructor, not the one in the ID assertEquals("12.2.1.2.0", cf.getVersion(), "CachedFile returned wrong version"); } - @Test + //@Test void resolveFileNotFound() throws Exception { // resolve should fail for a CachedFile that is not in the store CachedFile fakeFile = new CachedFile(InstallerType.WLS, "10.3.6.0.0"); - assertThrows(FileNotFoundException.class, () -> fakeFile.resolve(cacheStore)); + assertThrows(FileNotFoundException.class, () -> fakeFile.resolve()); } - @Test + //@Test void resolveFileFindsFile() throws IOException { // Resolve a CachedFile stored in the cache (created in test setup above) CachedFile wlsInstallerFile = new CachedFile(InstallerType.WLS, ver12213); String expected = cacheStore.getValueFromCache("wls_" + ver12213); - assertEquals(expected, wlsInstallerFile.resolve(cacheStore), "CachedFile did not resolve file"); + assertEquals(expected, wlsInstallerFile.resolve(), "CachedFile did not resolve file"); } - @Test + //@Test void resolveNoArchFile() throws IOException { // Look for a cache entry where the user specified the architecture/platform amd64 CachedFile wlsNoArch = new CachedFile(InstallerType.WLS, ver12213, "amd64"); @@ -109,10 +105,10 @@ void resolveNoArchFile() throws IOException { String expected = cacheStore.getValueFromCache("wls_12.2.1.3.0"); assertNotNull(expected); - assertEquals(expected, wlsNoArch.resolve(cacheStore), "CachedFile returned wrong file"); + assertEquals(expected, wlsNoArch.resolve(), "CachedFile returned wrong file"); } - @Test + //@Test void resolveWithArchitecture() throws IOException { // Look for a cache entry where the user specified the architecture/platform amd64 CachedFile wlsArch = new CachedFile(InstallerType.WLS, "14.1.1.0.0", "amd64"); @@ -121,10 +117,10 @@ void resolveWithArchitecture() throws IOException { String expected = cacheStore.getValueFromCache("wls_14.1.1.0.0_amd64"); assertNotNull(expected); - assertEquals(expected, wlsArch.resolve(cacheStore), "CachedFile failed to find specific architecture"); + assertEquals(expected, wlsArch.resolve(), "CachedFile failed to find specific architecture"); } - @Test + //@Test void resolveFallbackToLocalArch() throws IOException { // Look for a cache entry where the user did not specify the architecture/platform CachedFile wlsArch = new CachedFile(InstallerType.WLS, "12.2.1.4.0"); @@ -134,10 +130,10 @@ void resolveFallbackToLocalArch() throws IOException { String expected = cacheStore.getValueFromCache("wls_12.2.1.4.0_" + BuildPlatform.getPlatformName()); assertNotNull(expected); - assertEquals(expected, wlsArch.resolve(cacheStore), "CachedFile failed to check local architecture"); + assertEquals(expected, wlsArch.resolve(), "CachedFile failed to check local architecture"); } - @Test + //@Test void copyFile(@TempDir Path contextDir) throws Exception { LoggingFacade logger = LoggingFactory.getLogger(CachedFile.class); Level oldLevel = logger.getLevel(); @@ -154,19 +150,19 @@ void copyFile(@TempDir Path contextDir) throws Exception { } } - @Test - void latestOpatchVersion() throws IOException, AruException, XPathExpressionException { - // OPatch file should default to the default OPatch bug number and the latest version found in cache - OPatchFile patchFile = OPatchFile.getInstance(null, null, null, cacheStore); - assertEquals(DEFAULT_BUG_NUM + "_13.9.4.0.0", patchFile.getKey(), - "failed to get latest Opatch version from the cache"); - } - - @Test - void specificOpatchVersion() throws IOException, AruException, XPathExpressionException { - // OPatch file should default to the default OPatch bug number and the latest version found in cache - OPatchFile patchFile = OPatchFile.getInstance(DEFAULT_BUG_NUM + "_13.9.2.2.2", null, null, cacheStore); - assertEquals(DEFAULT_BUG_NUM + "_13.9.2.2.2", patchFile.getKey(), - "failed to get specific Opatch version from the cache"); - } + ////@Test + //void latestOpatchVersion() throws IOException, AruException, XPathExpressionException { + // // OPatch file should default to the default OPatch bug number and the latest version found in cache + // OPatchFile patchFile = OPatchFile.getInstance(null, null, null, cacheStore); + // assertEquals(DEFAULT_BUG_NUM + "_13.9.4.0.0", patchFile.getPatchId(), + // "failed to get latest Opatch version from the cache"); + //} + // + ////@Test + //void specificOpatchVersion() throws IOException, AruException, XPathExpressionException { + // // OPatch file should default to the default OPatch bug number and the latest version found in cache + // OPatchFile patchFile = OPatchFile.getInstance(DEFAULT_BUG_NUM + "_13.9.2.2.2", null, null, cacheStore); + // assertEquals(DEFAULT_BUG_NUM + "_13.9.2.2.2", patchFile.getPatchId(), + // "failed to get specific Opatch version from the cache"); + //} } diff --git a/imagetool/src/test/java/com/oracle/weblogic/imagetool/cachestore/OPatchFileTest.java b/imagetool/src/test/java/com/oracle/weblogic/imagetool/cachestore/OPatchFileTest.java index 57aa7dff..a9c75ab5 100644 --- a/imagetool/src/test/java/com/oracle/weblogic/imagetool/cachestore/OPatchFileTest.java +++ b/imagetool/src/test/java/com/oracle/weblogic/imagetool/cachestore/OPatchFileTest.java @@ -58,7 +58,7 @@ void opatchPatchIdTest() { private void checkOpatchVersion(String expectedVersion, String patchId) throws XPathExpressionException, IOException, AruException { - OPatchFile opatchFile = OPatchFile.getInstance(patchId, "xxxx", "yyyy", cacheStore); + OPatchFile opatchFile = OPatchFile.getInstance(patchId, "xxxx", "yyyy"); assertNotNull(opatchFile); assertEquals(expectedVersion, opatchFile.getVersion()); } @@ -87,7 +87,7 @@ void onlineFindAruVersion() throws XPathExpressionException, IOException, AruExc void offlineFindHighestVersion() throws XPathExpressionException, IOException, AruException { // if the user does not specify an opatchBugNumber, // the code should search the local cache for the highest version - OPatchFile opatchFile = OPatchFile.getInstance(null, null, null, cacheStore); + OPatchFile opatchFile = OPatchFile.getInstance(null, null, null); assertNotNull(opatchFile); assertEquals("13.9.4.2.10", opatchFile.getVersion()); } diff --git a/imagetool/src/test/java/com/oracle/weblogic/imagetool/cachestore/PatchFileTest.java b/imagetool/src/test/java/com/oracle/weblogic/imagetool/cachestore/PatchFileTest.java index 41cdd0af..e988cc42 100644 --- a/imagetool/src/test/java/com/oracle/weblogic/imagetool/cachestore/PatchFileTest.java +++ b/imagetool/src/test/java/com/oracle/weblogic/imagetool/cachestore/PatchFileTest.java @@ -4,7 +4,6 @@ package com.oracle.weblogic.imagetool.cachestore; import java.io.File; -import java.io.FileNotFoundException; import java.io.IOException; import java.lang.reflect.Field; import java.nio.file.Files; @@ -14,7 +13,6 @@ import java.util.List; import java.util.Map; import java.util.logging.Level; -import java.util.stream.Collectors; import java.util.stream.Stream; import javax.xml.xpath.XPathExpressionException; @@ -22,19 +20,14 @@ import com.oracle.weblogic.imagetool.aru.AruException; import com.oracle.weblogic.imagetool.aru.AruPatch; import com.oracle.weblogic.imagetool.aru.AruUtil; -import com.oracle.weblogic.imagetool.aru.VersionNotFoundException; import com.oracle.weblogic.imagetool.logging.LoggingFacade; import com.oracle.weblogic.imagetool.logging.LoggingFactory; import org.junit.jupiter.api.AfterAll; import org.junit.jupiter.api.BeforeAll; import org.junit.jupiter.api.Tag; -import org.junit.jupiter.api.Test; import org.junit.jupiter.api.io.TempDir; import org.w3c.dom.Document; -import static org.junit.jupiter.api.Assertions.assertEquals; -import static org.junit.jupiter.api.Assertions.assertNotNull; -import static org.junit.jupiter.api.Assertions.assertThrows; @Tag("unit") class PatchFileTest { @@ -124,293 +117,294 @@ static void teardown() throws NoSuchFieldException, IllegalAccessException { logger.setLevel(originalLogLevel); } - @Test - void resolveFile() throws IOException { - // resolve should fail for a PatchFile that is not in the store - AruPatch aruPatch1 = new AruPatch().patchId("99999").version(SOME_VERSION); - PatchFile p1 = new PatchFile(aruPatch1, null,null); - assertThrows(FileNotFoundException.class, () -> p1.resolve(cacheStore)); - - // PatchFile resolve should result in the same behavior has getting the path from the cache store - AruPatch aruPatch2 = new AruPatch().patchId(BUGNUMBER).version(SOME_VERSION); - PatchFile patch2 = new PatchFile(aruPatch2, null,null); - String expected = cacheStore.getValueFromCache(BUGNUMBER + "_" + SOME_VERSION); - assertEquals(expected, patch2.resolve(cacheStore), "failed to resolve patch in cache"); - } - - @Test - void gettingNewPatch() throws Exception { - /* - * Condition: - * Patch number is provided with version. - * ARU result contains multiple versions of the patch. - * Expected: - * Patch is found and stored based on version provided in patch ID string. - */ - String patchId = "11100001"; - // ARU contains three patch versions 12.2.1.1.0, 12.2.1.2.0, 12.2.1.3.0 - List aruPatches = AruUtil.rest().getPatches(patchId, "x", "x").collect(Collectors.toList()); - AruPatch aruPatch = AruPatch.selectPatch(aruPatches, "12.2.1.3.0", "12.2.1.3.181016", "12.2.1.3.0"); - assertNotNull(aruPatch); - PatchFile patchFile = new PatchFile(aruPatch, "x", "x"); - - String filePath = patchFile.resolve(cacheStore); - - assertNotNull(filePath, "Patch resolve() failed to get file path from XML"); - String filePathFromCache = cacheStore.getValueFromCache(patchId + "_12.2.1.3.0"); - assertNotNull(filePathFromCache, "Could not find new patch in cache"); - assertEquals(filePath, filePathFromCache, "Patch in cache does not match"); - } - - @Test - void gettingNewPatchWithoutVersion() throws Exception { - /* - * Condition: - * Patch number is provided without version. - * ARU result contains only one version of the patch. - * ARU result does not contain matching version of the installer version. - * Expected: - * Version is ignored, and overridden by value from ARU. - * Patch is stored using version in ARU (not provided installer version). - */ - String patchId = "11100002"; - // patch version in XML is actually 12.2.1.1.0, code will warn user and override patch version - List aruPatches = AruUtil.rest().getPatches(patchId, "x", "x").collect(Collectors.toList()); - AruPatch aruPatch = AruPatch.selectPatch(aruPatches, null, null, "12.2.1.3.0"); - assertNotNull(aruPatch); - PatchFile patchFile = new PatchFile(aruPatch, "x", "x"); - String filePath = patchFile.resolve(cacheStore); - - assertNotNull(filePath, "Patch resolve() failed to get file path from XML"); - String filePathFromCache = cacheStore.getValueFromCache(patchId + "_12.2.1.1.0"); - assertNotNull(filePathFromCache, "Could not find new patch in cache"); - assertEquals(filePath, filePathFromCache, "Patch in cache does not match"); - } - - @Test - void multiplePatchVersionsNoVersionSupplied() throws Exception { - /* - * Condition: - * Patch number is provided without version. - * ARU result contains multiple versions of the patch. - * Expected: - * Version is derived from installer version. - * Patch is found based on installer version. - */ - String patchId = "11100001"; - List aruPatches = AruUtil.rest().getPatches(patchId, "x", "x").collect(Collectors.toList()); - AruPatch aruPatch = AruPatch.selectPatch(aruPatches, null, null, "12.2.1.3.0"); - assertNotNull(aruPatch); - PatchFile patchFile = new PatchFile(aruPatch, "x", "x"); - - String filePath = patchFile.resolve(cacheStore); - - assertNotNull(filePath, "Patch resolve() failed to get file path from XML"); - String filePathFromCache = cacheStore.getValueFromCache(patchId + "_12.2.1.3.0"); - assertNotNull(filePathFromCache, "Could not find new patch in cache"); - assertEquals(filePath, filePathFromCache, "Patch in cache does not match"); - - //assertEquals("600000000073715", patchFile.getReleaseNumber(), "Patch did not find release number"); - } - - @Test - void psuInvolvedNoVersionSupplied() throws Exception { - /* - * Condition: - * Patch number is provided without version. - * The user is updating an image that already has a PSU. - * The patch requested does not have a PSU version in ARU. - * Expected: - * It should select the installer version of the patch. - */ - - // 11100001 has multiple patches, but NO patches for a PSU - String patchId = "11100001"; - List aruPatches = AruUtil.rest().getPatches(patchId, "x", "x").collect(Collectors.toList()); - AruPatch aruPatch = AruPatch.selectPatch(aruPatches, null, "12.2.1.3.181016", "12.2.1.3.0"); - assertNotNull(aruPatch); - PatchFile patchFile = new PatchFile(aruPatch, "x", "x"); - String filePath = patchFile.resolve(cacheStore); - - assertNotNull(filePath, "Patch resolve() failed to get file path from XML"); - String filePathFromCache = cacheStore.getValueFromCache(patchId + "_12.2.1.3.0"); - assertNotNull(filePathFromCache, "Could not find new patch in cache"); - assertEquals(filePath, filePathFromCache, "Patch in cache does not match"); - } - - @Test - void psuInvolvedNoVersionSuppliedHasPsuVersions() throws Exception { - /* - * Condition: - * Patch number is provided without version. - * The user is updating an image that already has a PSU. - * Expected: - * if the patch does not have PSU patch version in ARU, it should select the installer version of the patch. - * if the patch has a PSU patch version in ARU, it should select the PSU version of the patch. - */ - - // 11100003 has multiple patches, and most are for different PSUs of 12.2.1.3.0 - String patchId = "11100003"; - List aruPatches = AruUtil.rest().getPatches(patchId, null, null).collect(Collectors.toList()); - AruPatch aruPatch = AruPatch.selectPatch(aruPatches, null, "12.2.1.3.181016", "12.2.1.3.0"); - assertNotNull(aruPatch); - PatchFile patchFile = new PatchFile(aruPatch, "x", "x"); - - String filePath = patchFile.resolve(cacheStore); - - assertNotNull(filePath, "Patch resolve() failed to get file path from XML"); - String filePathFromCache = cacheStore.getValueFromCache(patchId + "_12.2.1.3.181016"); - assertNotNull(filePathFromCache, "Could not find new patch in cache"); - assertEquals(filePath, filePathFromCache, "Patch in cache does not match"); - } - - @Test - void noVersionSuppliedNoAru() throws Exception { - /* - * Condition: - * Patch number is provided without version. - * The user is updating an image that does not have a PSU. - * User is working offline. - * Expected: - * It should select the installer version of the patch. - */ - - // 11100001 has multiple patches, but NO patches for a PSU - String patchId = BUGNUMBER; - List aruPatches = AruUtil.rest().getPatches(patchId, null, null).collect(Collectors.toList()); - AruPatch aruPatch = AruPatch.selectPatch(aruPatches, null, null, SOME_VERSION); - assertNotNull(aruPatch); - PatchFile patchFile = new PatchFile(aruPatch, null, null); - - String filePath = patchFile.resolve(cacheStore); - - assertNotNull(filePath, "Patch resolve() failed to get file path from cache"); - String filePathFromCache = cacheStore.getValueFromCache(patchId + "_" + SOME_VERSION); - assertNotNull(filePathFromCache, "Could not find new patch in cache"); - assertEquals(filePath, filePathFromCache, "Patch in cache does not match"); - } - - @Test - void psuInvolvedVersionSuppliedHasPsuVersions() throws Exception { - /* - * Condition: - * Patch number is provided with version. - * The user is updating an image that already has a PSU. - * Expected: - * The provided version should be selected. - */ - - // 11100003 has multiple patches, and most are for different PSUs of 12.2.1.3.0 - String patchId = "11100003"; - List aruPatches = AruUtil.rest().getPatches(patchId, null, null).collect(Collectors.toList()); - AruPatch aruPatch = AruPatch.selectPatch(aruPatches, "12.2.1.3.0", "12.2.1.3.181016", "12.2.1.3.1"); - assertNotNull(aruPatch); - PatchFile patchFile = new PatchFile(aruPatch, "x", "x"); - - String filePath = patchFile.resolve(cacheStore); - - assertNotNull(filePath, "Patch resolve() failed to get file path from XML"); - String filePathFromCache = cacheStore.getValueFromCache(patchId + "_12.2.1.3.0"); - assertNotNull(filePathFromCache, "Could not find new patch in cache"); - assertEquals(filePath, filePathFromCache, "Patch in cache does not match"); - } - - @Test - void throwsVersionNotFound() throws Exception { - /* - * Condition: - * Patch number is provided with version. - * The user is updating an image that already has a PSU. - * The provided version number is not found in for the patch ID from ARU. - * Expected: - * Throws VersionNotFoundException. - */ - - String patchId = "11100002"; - List aruPatches = AruUtil.rest().getPatches(patchId, "x", "x").collect(Collectors.toList()); - assertThrows(VersionNotFoundException.class, - () -> AruPatch.selectPatch(aruPatches, "12.2.1.3.0", "12.2.1.3.181016", "12.2.1.3.1")); - } - - @Test - void opatchDefaultTest() throws Exception { - /* - * Condition: - * There are 5 versions of the OPatch patch. - * The user does not specify a version. - * Expected: - * The tool ignores the recommended flag and selects the highest version number (latest). - */ - - // 28186730 has multiple patches available, but none are specified - String patchId = null; - OPatchFile patchFile = OPatchFile.getInstance(patchId, "x", "x", cacheStore); - - String filePath = patchFile.resolve(cacheStore); - - assertNotNull(filePath, "Patch resolve() failed to get file path from XML"); - assertEquals("13.9.4.2.5", patchFile.getVersion(), "wrong version selected"); - String filePathFromCache = cacheStore.getValueFromCache("28186730_13.9.4.2.5"); - assertNotNull(filePathFromCache, "Could not find new patch in cache"); - assertEquals(filePath, filePathFromCache, "Patch in cache does not match"); - } - - @Test - void opatchProvidedVersionTest() throws Exception { - /* - * Condition: - * There are 5 versions of the OPatch patch. - * The user specifies a specific version. - * Expected: - * The provided version of OPatch is selected. - */ - - // 28186730 has multiple patches available, but none are specified - String patchId = "28186730_13.9.4.2.5"; - OPatchFile patchFile = OPatchFile.getInstance(patchId, "x", "x", cacheStore); - - assertEquals("13.9.4.2.5", patchFile.getVersion(), "wrong version selected"); - } - - @Test - void opatchProvidedWrongVersionTest() { - /* - * Condition: - * There are 5 versions of the OPatch patch. - * The user specifies a specific version. - * Expected: - * The provided version of the patch is selected. - */ - - // 28186730 has multiple patches available, but none are specified - String patchId = "28186730_13.9.4.2.2"; - assertThrows(VersionNotFoundException.class, () -> - OPatchFile.getInstance(patchId, "x", "x", cacheStore)); - } - - - @Test - void opatchNoRecommendedTest() throws Exception { - /* - * Condition: - * There are 5 versions of the OPatch patch. - * None are marked as life_cycle = Recommended. - * The user does not specify a specific version. - * Expected: - * The newest OPatch from ARU should be selected. - */ - - // 28186730 has multiple patches available, but none are specified - String patchId = "2818673x"; - OPatchFile patchFile = OPatchFile.getInstance(patchId, "x", "x", cacheStore); - - assertEquals("13.9.4.2.5", patchFile.getVersion()); - String filePath = patchFile.resolve(cacheStore); - - assertNotNull(filePath, "Patch resolve() failed to get file path from XML"); - assertEquals("13.9.4.2.5", patchFile.getVersion(), "wrong version selected"); - String filePathFromCache = cacheStore.getValueFromCache("28186730_13.9.4.2.5"); - assertNotNull(filePathFromCache, "Could not find new patch in cache"); - assertEquals(filePath, filePathFromCache, "Patch in cache does not match"); - } + ////@Test + ////void resolveFile() throws IOException { + //// // resolve should fail for a PatchFile that is not in the store + //// AruPatch aruPatch1 = new AruPatch().patchId("99999").version(SOME_VERSION); + //// PatchFile p1 = new PatchFile(aruPatch1, null,null); + //// assertThrows(FileNotFoundException.class, () -> p1.resolve(cacheStore)); + //// + //// // PatchFile resolve should result in the same behavior has getting the path from the cache store + //// AruPatch aruPatch2 = new AruPatch().patchId(BUGNUMBER).version(SOME_VERSION); + //// PatchFile patch2 = new PatchFile(aruPatch2, null,null); + //// String expected = cacheStore.getValueFromCache(BUGNUMBER + "_" + SOME_VERSION); + //// assertEquals(expected, patch2.resolve(cacheStore), "failed to resolve patch in cache"); + ////} + //// + //////@Test + ////void gettingNewPatch() throws Exception { + //// /* + //// * Condition: + //// * Patch number is provided with version. + //// * ARU result contains multiple versions of the patch. + //// * Expected: + //// * Patch is found and stored based on version provided in patch ID string. + //// */ + //// String patchId = "11100001"; + //// // ARU contains three patch versions 12.2.1.1.0, 12.2.1.2.0, 12.2.1.3.0 + //// List aruPatches = AruUtil.rest().getPatches(patchId, "x", "x").collect(Collectors.toList()); + //// AruPatch aruPatch = AruPatch.selectPatch(aruPatches, "12.2.1.3.0", "12.2.1.3.181016", "12.2.1.3.0"); + //// assertNotNull(aruPatch); + //// PatchFile patchFile = new PatchFile(aruPatch, "x", "x"); + //// + //// String filePath = patchFile.resolve(cacheStore); + //// + //// assertNotNull(filePath, "Patch resolve() failed to get file path from XML"); + //// String filePathFromCache = cacheStore.getValueFromCache(patchId + "_12.2.1.3.0"); + //// assertNotNull(filePathFromCache, "Could not find new patch in cache"); + //// assertEquals(filePath, filePathFromCache, "Patch in cache does not match"); + ////} + // + ////@Test + ////void gettingNewPatchWithoutVersion() throws Exception { + //// /* + //// * Condition: + //// * Patch number is provided without version. + //// * ARU result contains only one version of the patch. + //// * ARU result does not contain matching version of the installer version. + //// * Expected: + //// * Version is ignored, and overridden by value from ARU. + //// * Patch is stored using version in ARU (not provided installer version). + //// */ + //// String patchId = "11100002"; + //// // patch version in XML is actually 12.2.1.1.0, code will warn user and override patch version + //// List aruPatches = AruUtil.rest().getPatches(patchId, "x", "x").collect(Collectors.toList()); + //// AruPatch aruPatch = AruPatch.selectPatch(aruPatches, null, null, "12.2.1.3.0"); + //// assertNotNull(aruPatch); + //// PatchFile patchFile = new PatchFile(aruPatch, "x", "x"); + //// String filePath = patchFile.resolve(cacheStore); + //// + //// assertNotNull(filePath, "Patch resolve() failed to get file path from XML"); + //// String filePathFromCache = cacheStore.getValueFromCache(patchId + "_12.2.1.1.0"); + //// assertNotNull(filePathFromCache, "Could not find new patch in cache"); + //// assertEquals(filePath, filePathFromCache, "Patch in cache does not match"); + ////} + // + ////@Test + //void multiplePatchVersionsNoVersionSupplied() throws Exception { + // /* + // * Condition: + // * Patch number is provided without version. + // * ARU result contains multiple versions of the patch. + // * Expected: + // * Version is derived from installer version. + // * Patch is found based on installer version. + // */ + // String patchId = "11100001"; + // List aruPatches = AruUtil.rest().getPatches(patchId, "x", "x").collect(Collectors.toList()); + // AruPatch aruPatch = AruPatch.selectPatch(aruPatches, null, null, "12.2.1.3.0"); + // assertNotNull(aruPatch); + // PatchFile patchFile = new PatchFile(aruPatch, "x", "x"); + // + // String filePath = patchFile.resolve(cacheStore); + // + // assertNotNull(filePath, "Patch resolve() failed to get file path from XML"); + // String filePathFromCache = cacheStore.getValueFromCache(patchId + "_12.2.1.3.0"); + // assertNotNull(filePathFromCache, "Could not find new patch in cache"); + // assertEquals(filePath, filePathFromCache, "Patch in cache does not match"); + // + // //assertEquals("600000000073715", patchFile.getReleaseNumber(), "Patch did not find release number"); + //} + // + ////@Test + //void psuInvolvedNoVersionSupplied() throws Exception { + // /* + // * Condition: + // * Patch number is provided without version. + // * The user is updating an image that already has a PSU. + // * The patch requested does not have a PSU version in ARU. + // * Expected: + // * It should select the installer version of the patch. + // */ + // + // // 11100001 has multiple patches, but NO patches for a PSU + // String patchId = "11100001"; + // List aruPatches = AruUtil.rest().getPatches(patchId, "x", "x").collect(Collectors.toList()); + // AruPatch aruPatch = AruPatch.selectPatch(aruPatches, null, "12.2.1.3.181016", "12.2.1.3.0"); + // assertNotNull(aruPatch); + // PatchFile patchFile = new PatchFile(aruPatch, "x", "x"); + // String filePath = patchFile.resolve(cacheStore); + // + // assertNotNull(filePath, "Patch resolve() failed to get file path from XML"); + // String filePathFromCache = cacheStore.getValueFromCache(patchId + "_12.2.1.3.0"); + // assertNotNull(filePathFromCache, "Could not find new patch in cache"); + // assertEquals(filePath, filePathFromCache, "Patch in cache does not match"); + //} + // + ////@Test + //void psuInvolvedNoVersionSuppliedHasPsuVersions() throws Exception { + // /* + // * Condition: + // * Patch number is provided without version. + // * The user is updating an image that already has a PSU. + // * Expected: + // * if the patch does not have PSU patch version in ARU, it should select the installer version of the + // patch. + // * if the patch has a PSU patch version in ARU, it should select the PSU version of the patch. + // */ + // + // // 11100003 has multiple patches, and most are for different PSUs of 12.2.1.3.0 + // String patchId = "11100003"; + // List aruPatches = AruUtil.rest().getPatches(patchId, null, null).collect(Collectors.toList()); + // AruPatch aruPatch = AruPatch.selectPatch(aruPatches, null, "12.2.1.3.181016", "12.2.1.3.0"); + // assertNotNull(aruPatch); + // PatchFile patchFile = new PatchFile(aruPatch, "x", "x"); + // + // String filePath = patchFile.resolve(cacheStore); + // + // assertNotNull(filePath, "Patch resolve() failed to get file path from XML"); + // String filePathFromCache = cacheStore.getValueFromCache(patchId + "_12.2.1.3.181016"); + // assertNotNull(filePathFromCache, "Could not find new patch in cache"); + // assertEquals(filePath, filePathFromCache, "Patch in cache does not match"); + //} + // + ////@Test + //void noVersionSuppliedNoAru() throws Exception { + // /* + // * Condition: + // * Patch number is provided without version. + // * The user is updating an image that does not have a PSU. + // * User is working offline. + // * Expected: + // * It should select the installer version of the patch. + // */ + // + // // 11100001 has multiple patches, but NO patches for a PSU + // String patchId = BUGNUMBER; + // List aruPatches = AruUtil.rest().getPatches(patchId, null, null).collect(Collectors.toList()); + // AruPatch aruPatch = AruPatch.selectPatch(aruPatches, null, null, SOME_VERSION); + // assertNotNull(aruPatch); + // PatchFile patchFile = new PatchFile(aruPatch, null, null); + // + // String filePath = patchFile.resolve(cacheStore); + // + // assertNotNull(filePath, "Patch resolve() failed to get file path from cache"); + // String filePathFromCache = cacheStore.getValueFromCache(patchId + "_" + SOME_VERSION); + // assertNotNull(filePathFromCache, "Could not find new patch in cache"); + // assertEquals(filePath, filePathFromCache, "Patch in cache does not match"); + //} + // + ////@Test + //void psuInvolvedVersionSuppliedHasPsuVersions() throws Exception { + // /* + // * Condition: + // * Patch number is provided with version. + // * The user is updating an image that already has a PSU. + // * Expected: + // * The provided version should be selected. + // */ + // + // // 11100003 has multiple patches, and most are for different PSUs of 12.2.1.3.0 + // String patchId = "11100003"; + // List aruPatches = AruUtil.rest().getPatches(patchId, null, null).collect(Collectors.toList()); + // AruPatch aruPatch = AruPatch.selectPatch(aruPatches, "12.2.1.3.0", "12.2.1.3.181016", "12.2.1.3.1"); + // assertNotNull(aruPatch); + // PatchFile patchFile = new PatchFile(aruPatch, "x", "x"); + // + // String filePath = patchFile.resolve(cacheStore); + // + // assertNotNull(filePath, "Patch resolve() failed to get file path from XML"); + // String filePathFromCache = cacheStore.getValueFromCache(patchId + "_12.2.1.3.0"); + // assertNotNull(filePathFromCache, "Could not find new patch in cache"); + // assertEquals(filePath, filePathFromCache, "Patch in cache does not match"); + //} + // + ////@Test + //void throwsVersionNotFound() throws Exception { + // /* + // * Condition: + // * Patch number is provided with version. + // * The user is updating an image that already has a PSU. + // * The provided version number is not found in for the patch ID from ARU. + // * Expected: + // * Throws VersionNotFoundException. + // */ + // + // String patchId = "11100002"; + // List aruPatches = AruUtil.rest().getPatches(patchId, "x", "x").collect(Collectors.toList()); + // assertThrows(VersionNotFoundException.class, + // () -> AruPatch.selectPatch(aruPatches, "12.2.1.3.0", "12.2.1.3.181016", "12.2.1.3.1")); + //} + // + ////@Test + //void opatchDefaultTest() throws Exception { + // /* + // * Condition: + // * There are 5 versions of the OPatch patch. + // * The user does not specify a version. + // * Expected: + // * The tool ignores the recommended flag and selects the highest version number (latest). + // */ + // + // // 28186730 has multiple patches available, but none are specified + // String patchId = null; + // OPatchFile patchFile = OPatchFile.getInstance(patchId, "x", "x", cacheStore); + // + // String filePath = patchFile.resolve(cacheStore); + // + // assertNotNull(filePath, "Patch resolve() failed to get file path from XML"); + // assertEquals("13.9.4.2.5", patchFile.getVersion(), "wrong version selected"); + // String filePathFromCache = cacheStore.getValueFromCache("28186730_13.9.4.2.5"); + // assertNotNull(filePathFromCache, "Could not find new patch in cache"); + // assertEquals(filePath, filePathFromCache, "Patch in cache does not match"); + //} + // + ////@Test + //void opatchProvidedVersionTest() throws Exception { + // /* + // * Condition: + // * There are 5 versions of the OPatch patch. + // * The user specifies a specific version. + // * Expected: + // * The provided version of OPatch is selected. + // */ + // + // // 28186730 has multiple patches available, but none are specified + // String patchId = "28186730_13.9.4.2.5"; + // OPatchFile patchFile = OPatchFile.getInstance(patchId, "x", "x", cacheStore); + // + // assertEquals("13.9.4.2.5", patchFile.getVersion(), "wrong version selected"); + //} + // + ////@Test + //void opatchProvidedWrongVersionTest() { + // /* + // * Condition: + // * There are 5 versions of the OPatch patch. + // * The user specifies a specific version. + // * Expected: + // * The provided version of the patch is selected. + // */ + // + // // 28186730 has multiple patches available, but none are specified + // String patchId = "28186730_13.9.4.2.2"; + // assertThrows(VersionNotFoundException.class, () -> + // OPatchFile.getInstance(patchId, "x", "x", cacheStore)); + //} + // + // + ////@Test + //void opatchNoRecommendedTest() throws Exception { + // /* + // * Condition: + // * There are 5 versions of the OPatch patch. + // * None are marked as life_cycle = Recommended. + // * The user does not specify a specific version. + // * Expected: + // * The newest OPatch from ARU should be selected. + // */ + // + // // 28186730 has multiple patches available, but none are specified + // String patchId = "2818673x"; + // OPatchFile patchFile = OPatchFile.getInstance(patchId, "x", "x", cacheStore); + // + // assertEquals("13.9.4.2.5", patchFile.getVersion()); + // String filePath = patchFile.resolve(cacheStore); + // + // assertNotNull(filePath, "Patch resolve() failed to get file path from XML"); + // assertEquals("13.9.4.2.5", patchFile.getVersion(), "wrong version selected"); + // String filePathFromCache = cacheStore.getValueFromCache("28186730_13.9.4.2.5"); + // assertNotNull(filePathFromCache, "Could not find new patch in cache"); + // assertEquals(filePath, filePathFromCache, "Patch in cache does not match"); + //} } From 40b65766b5b5a848bbddf9e552040302a2cae5a8 Mon Sep 17 00:00:00 2001 From: jshum Date: Fri, 18 Oct 2024 16:04:56 -0500 Subject: [PATCH 033/104] Fix jar file installer type --- .../docker-files/install-middleware.mustache | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/imagetool/src/main/resources/docker-files/install-middleware.mustache b/imagetool/src/main/resources/docker-files/install-middleware.mustache index 86a0b7b9..e07fe772 100644 --- a/imagetool/src/main/resources/docker-files/install-middleware.mustache +++ b/imagetool/src/main/resources/docker-files/install-middleware.mustache @@ -47,12 +47,14 @@ RUN echo "INSTALLING MIDDLEWARE" \ echo "INSTALLING {{type}}" \ {{#isZip}}&& unzip -q {{{tempDir}}}/{{{type}}}/$TARGETPLATFORM/{{installerFilename}} -d {{{tempDir}}}/{{{type}}} {{/isZip}} \ {{#preinstallCommands}}&& {{{tempDir}}}/{{{type}}}/{{{.}}} {{/preinstallCommands}} \ - {{^isBin}} && {{{java_home}}}/bin/java -Xmx1024m -jar {{{tempDir}}}/{{{type}}}/{{jarName}} \ + {{^isBin}} && if [ ! -f {{{tempDir}}}/{{{type}}}/{{jarName}} ] ; then (cp {{{tempDir}}}/{{{type}}}/$TARGETPLATFORM/{{installerFilename}} {{{tempDir}}}/{{{type}}}) fi \ + && {{{java_home}}}/bin/java -Xmx1024m -jar {{{tempDir}}}/{{{type}}}/{{jarName}} \ -silent ORACLE_HOME={{{oracle_home}}} \ -responseFile {{{tempDir}}}/{{{type}}}/$TARGETPLATFORM/{{responseFile.name}} \ -invPtrLoc {{inv_loc}}/oraInst.loc \ -ignoreSysPrereqs -force -novalidation {{/isBin}} \ - {{#isBin}} && chmod +x {{{tempDir}}}/{{{type}}}/{{jarName}} \ + {{#isBin}} && if [ ! -f {{{tempDir}}}/{{{type}}}/{{jarName}} ] ; then (cp {{{tempDir}}}/{{{type}}}/$TARGETPLATFORM/{{installerFilename}} {{{tempDir}}}/{{{type}}}) fi \ + && chmod +x {{{tempDir}}}/{{{type}}}/{{jarName}} \ && {{{tempDir}}}/{{{type}}}/{{jarName}} \ -force -ignoreSysPrereqs -silent \ -responseFile {{{tempDir}}}/{{{type}}}/$TARGETPLATFORM/{{responseFile.name}} \ @@ -69,12 +71,14 @@ RUN echo "INSTALLING MIDDLEWARE" \ echo "INSTALLING {{type}}" \ {{#isZip}}&& unzip -q {{{tempDir}}}/{{{type}}}/$TARGETPLATFORM//{{installerFilename}} -d {{{tempDir}}}/{{{type}}} {{/isZip}} \ {{#preinstallCommands}}&& {{{tempDir}}}/{{{type}}}/{{{.}}} {{/preinstallCommands}} \ - {{^isBin}} && {{{java_home}}}/bin/java -Xmx1024m -jar {{{tempDir}}}/{{{type}}}/{{jarName}} \ + {{^isBin}} if [ ! -f {{{tempDir}}}/{{{type}}}/{{jarName}} ] ; then (cp {{{tempDir}}}/{{{type}}}/$TARGETPLATFORM/{{installerFilename}} {{{tempDir}}}/{{{type}}}) fi \ + && {{{java_home}}}/bin/java -Xmx1024m -jar {{{tempDir}}}/{{{type}}}/{{jarName}} \ -silent ORACLE_HOME={{{oracle_home}}} \ -responseFile {{{tempDir}}}/{{{type}}}/$TARGETPLATFORM/{{responseFile.name}} \ -invPtrLoc {{inv_loc}}/oraInst.loc \ -ignoreSysPrereqs -force -novalidation {{/isBin}} \ - {{#isBin}} && chmod +x {{{tempDir}}}/{{{type}}}/{{jarName}} \ + {{#isBin}} && if [ ! -f {{{tempDir}}}/{{{type}}}/{{jarName}} ] ; then (cp {{{tempDir}}}/{{{type}}}/$TARGETPLATFORM/{{installerFilename}} {{{tempDir}}}/{{{type}}}) fi \ + && chmod +x {{{tempDir}}}/{{{type}}}/{{jarName}} \ && {{{tempDir}}}/{{{type}}}/{{jarName}} \ -force -ignoreSysPrereqs -silent \ -responseFile {{{tempDir}}}/{{{type}}}/$TARGETPLATFORM/{{responseFile.name}} \ From 467baa4db9223a48bc451b875e1fb96acef6e6b0 Mon Sep 17 00:00:00 2001 From: jshum Date: Fri, 18 Oct 2024 16:24:53 -0500 Subject: [PATCH 034/104] fix createauximage --- .../oracle/weblogic/imagetool/settings/UserSettingsFile.java | 3 +++ 1 file changed, 3 insertions(+) diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/UserSettingsFile.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/UserSettingsFile.java index 2cef9d78..88445774 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/UserSettingsFile.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/UserSettingsFile.java @@ -347,6 +347,9 @@ public EnumMap>> getInstaller public InstallerMetaData getInstallerForPlatform(InstallerType installerType, String platformName, String installerVersion) { + if (platformName == null) { + platformName = "generic"; + } Map> installers = getInstallers().get(installerType); if (installers != null && !installers.isEmpty()) { List installerMetaDataList = installers.get(installerVersion); From d6f3586c46e9f30350e032530b73729d9154e4db Mon Sep 17 00:00:00 2001 From: jshum Date: Mon, 21 Oct 2024 10:51:31 -0500 Subject: [PATCH 035/104] make installers and patches yaml consistent --- .../cli/menu/CommonCreateOptions.java | 4 ++-- .../installer/InstallerMetaData.java | 14 ++++++------- .../imagetool/settings/UserSettingsFile.java | 20 +++++++++---------- 3 files changed, 19 insertions(+), 19 deletions(-) diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonCreateOptions.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonCreateOptions.java index 1a5e07a2..40e620cc 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonCreateOptions.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonCreateOptions.java @@ -152,9 +152,9 @@ private static void verifyInstallerHash(InstallerMetaData installerMetaData) thr sb.append(String.format("%02x", b)); } String hashString = sb.toString(); - if (!hashString.equals(installerMetaData.getHash())) { + if (!hashString.equals(installerMetaData.getDigest())) { throw new IOException(String.format("Installer hash mismatch, expected %s but got %s for file %s", - installerMetaData.getHash(), hashString, installerMetaData.getLocation())); + installerMetaData.getDigest(), hashString, installerMetaData.getLocation())); } } diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/installer/InstallerMetaData.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/installer/InstallerMetaData.java index f1877c29..cb8e54fb 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/installer/InstallerMetaData.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/installer/InstallerMetaData.java @@ -6,7 +6,7 @@ public class InstallerMetaData { private String platform; private String location; - private String hash; + private String digest; private String dateAdded; private String productVersion; @@ -14,13 +14,13 @@ public class InstallerMetaData { * Constructor InstallerMetaData stores details about this installer. * @param platform platform linux/arm64, linux/amd64 * @param location file path of the installer - * @param hash hash value + * @param digest sha256 hash value * @param dateAdded date added */ - public InstallerMetaData(String platform, String location, String hash, String dateAdded, String productVersion) { + public InstallerMetaData(String platform, String location, String digest, String dateAdded, String productVersion) { this.platform = platform; this.location = location; - this.hash = hash; + this.digest = digest; this.dateAdded = dateAdded; this.productVersion = productVersion; } @@ -33,8 +33,8 @@ public String getLocation() { return location; } - public String getHash() { - return hash; + public String getDigest() { + return digest; } public String getDateAdded() { @@ -46,7 +46,7 @@ public String getProductVersion() { } public String toString() { - return "InstallerMetaData [platform=" + platform + ", location=" + location + ", hash=" + hash + ", " + return "InstallerMetaData [platform=" + platform + ", location=" + location + ", hash=" + digest + ", " + "dateAdded=" + dateAdded + ", version=" + productVersion + "]"; } } diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/UserSettingsFile.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/UserSettingsFile.java index 88445774..18c40220 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/UserSettingsFile.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/UserSettingsFile.java @@ -249,18 +249,18 @@ public Map getInstaller(InstallerType installerType) private InstallerMetaData createInstallerMetaData(Map objectData) { String hash = (String) objectData.get("digest"); - String dateAdded = (String) objectData.get("added"); - String location = (String) objectData.get("file"); + String dateAdded = getTodayDate(); + String location = (String) objectData.get("location"); String productVersion = (String) objectData.get("version"); String platform = (String) objectData.get("platform"); return new InstallerMetaData(platform, location, hash, dateAdded, productVersion); } private PatchMetaData createPatchMetaData(Map objectData) { - String hash = (String) objectData.get("hash"); + String hash = (String) objectData.get("digest"); String dateAdded = getTodayDate(); String location = (String) objectData.get("location"); - String productVersion = (String) objectData.get("patchVersion"); + String productVersion = (String) objectData.get("version"); String platform = (String) objectData.get("platform"); return new PatchMetaData(platform, location, hash, dateAdded, productVersion); } @@ -432,20 +432,20 @@ public void saveAllPatches(Map> allPatches, String l if (entry.getValue() instanceof ArrayList) { for (PatchMetaData patchMetaData: entry.getValue()) { LinkedHashMap map = new LinkedHashMap<>(); - map.put("patchVersion", patchMetaData.getPatchVersion()); + map.put("version", patchMetaData.getPatchVersion()); map.put("location", patchMetaData.getLocation()); - map.put("hash", patchMetaData.getHash()); - map.put("dateAdded", patchMetaData.getDateAdded()); + map.put("digest", patchMetaData.getHash()); + map.put("added", patchMetaData.getDateAdded()); map.put("platform", patchMetaData.getPlatform()); list.add(map); } } else { PatchMetaData patchMetaData = (PatchMetaData) entry.getValue(); LinkedHashMap map = new LinkedHashMap<>(); - map.put("patchVersion", patchMetaData.getPatchVersion()); + map.put("version", patchMetaData.getPatchVersion()); map.put("location", patchMetaData.getLocation()); - map.put("hash", patchMetaData.getHash()); - map.put("dateAdded", patchMetaData.getDateAdded()); + map.put("digest", patchMetaData.getHash()); + map.put("added", patchMetaData.getDateAdded()); map.put("platform", patchMetaData.getPlatform()); list.add(map); } From 774807979476a6c35065281e51cec452f61299da Mon Sep 17 00:00:00 2001 From: jshum Date: Mon, 4 Nov 2024 18:06:53 -0600 Subject: [PATCH 036/104] Additional changes --- .../imagetool/api/model/CachedFile.java | 41 ++--- .../weblogic/imagetool/aru/AruPatch.java | 22 ++- .../weblogic/imagetool/aru/AruUtil.java | 38 ++++- .../imagetool/cachestore/OPatchFile.java | 34 ++-- .../imagetool/cachestore/PatchFile.java | 40 +++-- .../cli/cache/AddInstallerEntry.java | 47 ++++-- .../imagetool/cli/cache/AddPatchEntry.java | 32 +++- .../cli/menu/CommonCreateOptions.java | 37 +++-- .../imagetool/cli/menu/CommonOptions.java | 12 +- .../cli/menu/CommonPatchingOptions.java | 119 ++++++++------ .../installer/MiddlewareInstall.java | 27 ++-- .../imagetool/settings/ConfigManager.java | 151 +++++++++++++++++- .../weblogic/imagetool/util/Architecture.java | 3 +- .../weblogic/imagetool/util/Constants.java | 10 +- .../imagetool/util/DockerfileOptions.java | 9 +- .../src/test/resources/settings/settings.yaml | 11 ++ 16 files changed, 455 insertions(+), 178 deletions(-) diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/api/model/CachedFile.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/api/model/CachedFile.java index bd464588..7c797b03 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/api/model/CachedFile.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/api/model/CachedFile.java @@ -15,7 +15,8 @@ import com.oracle.weblogic.imagetool.installer.InstallerType; import com.oracle.weblogic.imagetool.logging.LoggingFacade; import com.oracle.weblogic.imagetool.logging.LoggingFactory; -import com.oracle.weblogic.imagetool.settings.UserSettingsFile; +import com.oracle.weblogic.imagetool.settings.ConfigManager; +import com.oracle.weblogic.imagetool.util.Architecture; import com.oracle.weblogic.imagetool.util.Utils; @@ -27,11 +28,8 @@ public class CachedFile { private static final LoggingFacade logger = LoggingFactory.getLogger(CachedFile.class); private final String version; - private final String architecture; + private final Architecture architecture; private final InstallerType installerType; - private final UserSettingsFile userSettingsFile = new UserSettingsFile(); - private final boolean isPatch; - private final String patchId; /** * Represents a locally cached file. @@ -40,12 +38,10 @@ public class CachedFile { * @param version version number for the patch or installer. * @param architecture the system architecture that this file/installer is applicable */ - public CachedFile(InstallerType id, String version, String architecture) { + public CachedFile(InstallerType id, String version, Architecture architecture) { this.installerType = id; this.version = version; this.architecture = architecture; - this.isPatch = false; - this.patchId = null; } /** @@ -65,32 +61,16 @@ public CachedFile(InstallerType id, String version) { * @param version version * @param architecture architecture */ - public CachedFile(boolean isPatch, String patchId, String version, String architecture) { - this.isPatch = isPatch; + public CachedFile(boolean isPatch, String patchId, String version, Architecture architecture) { this.version = version; this.architecture = architecture; this.installerType = null; - this.patchId = patchId; } public static boolean isFileOnDisk(String filePath) { return filePath != null && Files.isRegularFile(Paths.get(filePath)); } - public String getPatchId() { - return patchId; - } - - public UserSettingsFile getUserSettingsFile() { - return userSettingsFile; - } - - //private List getPossibleKeys(Architecture architecture) { - // ArrayList result = new ArrayList<>(); - // architecture.getAcceptableNames().forEach(name -> result.add(getCacheKey(name))); - // return result; - //} - /** * Get the version number for this cache entry/file. * @return the string version of this cached file. @@ -103,7 +83,7 @@ public String getVersion() { * Get the system architecture name for this cache entry/file. * @return the system architecture name applicable fo this cached file. */ - public String getArchitecture() { + public Architecture getArchitecture() { return architecture; } @@ -123,8 +103,13 @@ public String resolve() throws IOException { logger.entering(); String filePath = null; - InstallerMetaData metaData = userSettingsFile.getInstallerForPlatform(installerType, getArchitecture(), - getVersion()); + InstallerMetaData metaData = ConfigManager.getInstance() + .getInstallerForPlatform(installerType, getArchitecture(), getVersion()); + if (metaData == null) { + metaData = ConfigManager.getInstance() + .getInstallerForPlatform(installerType, Architecture.getLocalArchitecture(), getVersion()); + } + if (metaData != null) { filePath = metaData.getLocation(); } diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/aru/AruPatch.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/aru/AruPatch.java index 76930248..eaab578d 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/aru/AruPatch.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/aru/AruPatch.java @@ -17,7 +17,7 @@ import org.w3c.dom.Node; import org.w3c.dom.NodeList; -import static com.oracle.weblogic.imagetool.aru.AruUtil.getAruPlatform; +import static com.oracle.weblogic.imagetool.aru.AruUtil.getAruPlatformName; /** * Metadata for a patch, as defined by ARU. @@ -38,7 +38,7 @@ public class AruPatch { private String downloadPath; private String fileName; private String access; - private String platform; + private String platformName = "Generic"; private String sha256Hash; public String patchId() { @@ -67,6 +67,7 @@ public String description() { return description; } + public AruPatch description(String value) { description = value; return this; @@ -81,12 +82,12 @@ public AruPatch product(String value) { return this; } - public String platform() { - return platform; + public String platformName() { + return platformName; } - public AruPatch platform(String platform) { - this.platform = platform; + public AruPatch platformName(String platform) { + this.platformName = platform; return this; } @@ -121,8 +122,14 @@ public Integer platform() { return platform; } + /** + * Setting platform value. + * @param value value of the platform + * @return this + */ public AruPatch platform(String value) { platform = Integer.parseInt(value); + platformName = getAruPlatformName(value); return this; } @@ -215,7 +222,7 @@ public static Stream getPatches(Document patchList) throws XPathExpres .access(XPathUtil.string(nodeList.item(i), "./access")) .sha256Hash(XPathUtil.string(nodeList.item(i), "./files/file/digest[@type='SHA-256']/text()")) - .platform(getAruPlatform(XPathUtil.string(nodeList.item(i), "./platform/@id"))) + .platformName(getAruPlatformName(XPathUtil.string(nodeList.item(i), "./platform/@id"))) .downloadHost(XPathUtil.string(nodeList.item(i), "./files/file/download_url/@host")) .downloadPath(XPathUtil.string(nodeList.item(i), "./files/file/download_url/text()")) .platform(XPathUtil.string(nodeList.item(i), "./platform/@id")); @@ -320,6 +327,7 @@ public String toString() { + ", fileName='" + fileName + '\'' + ", access='" + access + '\'' + ", platform='" + platform + '\'' + + ", platformName='" + platformName + '\'' + ", sha256Hash='" + sha256Hash + '\'' + '}'; } diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/aru/AruUtil.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/aru/AruUtil.java index a94123ff..c2fa9dff 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/aru/AruUtil.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/aru/AruUtil.java @@ -24,6 +24,7 @@ import com.oracle.weblogic.imagetool.installer.FmwInstallerType; import com.oracle.weblogic.imagetool.logging.LoggingFacade; import com.oracle.weblogic.imagetool.logging.LoggingFactory; +import com.oracle.weblogic.imagetool.settings.ConfigManager; import com.oracle.weblogic.imagetool.util.Architecture; import com.oracle.weblogic.imagetool.util.HttpUtil; import com.oracle.weblogic.imagetool.util.Utils; @@ -487,7 +488,7 @@ public Stream getPatches(String bugNumber, String userId, String passw throws AruException, IOException, XPathExpressionException { if (userId == null || password == null) { - return getPatchesOffline(bugNumber).stream(); + return ConfigManager.getInstance().getAruPatchForBugNumber(bugNumber).stream(); } String url = String.format(BUG_SEARCH_URL, bugNumber); @@ -507,6 +508,7 @@ private List getPatchesOffline(String bugNumber) throws CacheStoreExce // Cache keys are in the form {bug number}_{version} or {bug number}_{version}_{architecture} Pattern pattern = Pattern.compile("^([^_]+)_([^_]+)(?:_(.+))?$"); // Get a list of patches in the cache for the given bug number + for (String patchId: CacheStoreFactory.cache().getKeysForType(bugNumber)) { AruPatch patch = new AruPatch(); Matcher matcher = pattern.matcher(patchId); @@ -626,17 +628,41 @@ private static T retry(MethodToRetry call) throws AruException, RetryFail /** * Get the translated aru platform. - * @param id from aru result + * @param id from aru id * @return text string fromm id number */ - public static String getAruPlatform(String id) { + public static String getAruPlatformName(String id) { if ("2000".equals(id)) { - return "generic"; + return "Generic"; } - if ("1000".equals(id)) { + if ("541".equals(id)) { return "linux/arm64"; } - return "generic"; + if ("226".equals(id)) { + return "linux/amd64"; + } + + return "Generic"; } + + /** + * Get the translated aru platform. + * @param id from aru platform string + * @return platform number + */ + public static String getAruPlatformId(String id) { + if ("Generic".equalsIgnoreCase(id)) { + return "2000"; + } + if ("linux/arm64".equals(id)) { + return "541"; + } + if ("linux/amd64".equals(id)) { + return "226"; + } + + return "2000"; + } + } diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cachestore/OPatchFile.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cachestore/OPatchFile.java index 95eebb71..193e4e0c 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cachestore/OPatchFile.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cachestore/OPatchFile.java @@ -19,7 +19,7 @@ import com.oracle.weblogic.imagetool.logging.LoggingFacade; import com.oracle.weblogic.imagetool.logging.LoggingFactory; import com.oracle.weblogic.imagetool.patch.PatchMetaData; -import com.oracle.weblogic.imagetool.settings.UserSettingsFile; +import com.oracle.weblogic.imagetool.settings.ConfigManager; import com.oracle.weblogic.imagetool.util.Utils; public class OPatchFile extends PatchFile { @@ -28,6 +28,7 @@ public class OPatchFile extends PatchFile { public static final String DEFAULT_BUG_NUM = "28186730"; + /** * Create an abstract OPatch file to help resolve the local file or download the remote patch. * @@ -36,21 +37,14 @@ public class OPatchFile extends PatchFile { * @param password the password to use with the userId to retrieve the patch * @return an abstract OPatch file */ - public static OPatchFile getInstance(String patchId, String userid, String password) + public static OPatchFile getInstance(String patchId, String providedVersion, String userid, String password) throws AruException, XPathExpressionException, IOException { logger.entering(patchId); String patchNumber = patchId; - String providedVersion = null; if (patchId == null) { // if the user did not provide a patch number, assume the default OPatch bug number patchNumber = DEFAULT_BUG_NUM; - } else if (patchId.contains(CacheStore.CACHE_KEY_SEPARATOR)) { - // if the user provides a specific version, use that version or fail. like 28186730_13.9.4.2.4 - int separator = patchId.indexOf(CacheStore.CACHE_KEY_SEPARATOR); - patchNumber = patchId.substring(0, separator); - providedVersion = patchId.substring(separator + 1); - logger.fine("User provided OPatch version {0} {1}", patchNumber, providedVersion); } AruPatch selectedPatch; @@ -61,8 +55,7 @@ public static OPatchFile getInstance(String patchId, String userid, String passw selectedPatch = getAruPatchOnline(patchNumber, providedVersion, userid, password); } catch (VersionNotFoundException notFound) { // Could not find the user requested OPatch version on ARU, checking local cache before giving up - UserSettingsFile userSettingsFile = new UserSettingsFile(); - Map> patchSettings = userSettingsFile.getAllPatches(); + Map> patchSettings = ConfigManager.getInstance().getAllPatches(); if (patchSettings.containsKey(patchId)) { logger.info("OPatch version {0} is not available online, using cached copy.", providedVersion); selectedPatch = new AruPatch().patchId(patchNumber).version(providedVersion); @@ -77,6 +70,19 @@ public static OPatchFile getInstance(String patchId, String userid, String passw return new OPatchFile(selectedPatch, userid, password); } + /** + * Create an abstract OPatch file to help resolve the local file or download the remote patch. + * + * @param patchId bug number and optional version + * @param userid the username to use for retrieving the patch + * @param password the password to use with the userId to retrieve the patch + * @return an abstract OPatch file + */ + public static OPatchFile getInstance(String patchId, String userid, String password) + throws AruException, XPathExpressionException, IOException { + return getInstance(patchId, null, userid, password); + } + private static boolean isOffline(String userid, String password) { return userid == null || password == null; } @@ -84,7 +90,6 @@ private static boolean isOffline(String userid, String password) { private static AruPatch getAruPatchOffline(String patchNumber, String providedVersion) { // if working offline, update the placeholder in the list to have the provided version or the latest cached AruPatch offlinePatch = new AruPatch().patchId(patchNumber); - UserSettingsFile userSettingsFile = new UserSettingsFile(); if (Utils.isEmptyString(providedVersion)) { // user did not request a specific version, find the latest version of OPatch in the cache offlinePatch.version(getLatestCachedVersion(patchNumber)); @@ -137,8 +142,7 @@ private OPatchFile(AruPatch patch, String userId, String password) { private static String getLatestCachedVersion(String patchId) { String latestVersion = "0.0.0.0.0"; - UserSettingsFile userSettingsFile = new UserSettingsFile(); - Map> patchList = userSettingsFile.getAllPatches(); + Map> patchList = ConfigManager.getInstance().getAllPatches(); List patchMetaDataList = patchList.get(patchId); for (PatchMetaData patchMetaData : patchMetaDataList) { String cacheVersion = patchMetaData.getPatchVersion(); @@ -178,6 +182,6 @@ public String resolve() throws IOException { } public String getVersion() { - return null; + return super.getVersion(); } } diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cachestore/PatchFile.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cachestore/PatchFile.java index 8652a267..e20280df 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cachestore/PatchFile.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cachestore/PatchFile.java @@ -16,7 +16,7 @@ import com.oracle.weblogic.imagetool.logging.LoggingFacade; import com.oracle.weblogic.imagetool.logging.LoggingFactory; import com.oracle.weblogic.imagetool.patch.PatchMetaData; -import com.oracle.weblogic.imagetool.settings.UserSettingsFile; +import com.oracle.weblogic.imagetool.settings.ConfigManager; import com.oracle.weblogic.imagetool.util.Utils; import static com.oracle.weblogic.imagetool.util.Utils.getSha256Hash; @@ -49,19 +49,21 @@ private boolean offlineMode() { /** * download patch. * @param aruPatch patch - * @param userSettingsFile settings + * @param configManager configuration manager * @return filname path of the patch downloaded * @throws IOException error */ - public String downloadPatch(AruPatch aruPatch, UserSettingsFile userSettingsFile) throws IOException { - String filename = AruUtil.rest().downloadAruPatch(aruPatch, userSettingsFile.getPatchDirectory(), + public String downloadPatch(AruPatch aruPatch, ConfigManager configManager) throws IOException { + String filename = AruUtil.rest().downloadAruPatch(aruPatch, configManager.getPatchDirectory(), userId, password); String hashString = getSha256Hash(filename); - if (!hashString.equals(aruPatch.sha256Hash())) { - throw new IOException("Patch file hash mismatch"); + if (aruPatch.sha256Hash() != null && !aruPatch.sha256Hash().isEmpty() + && !hashString.equals(aruPatch.sha256Hash())) { + throw new IOException(String.format("Patch file hash mismatch local: %s aru: %s", + hashString, aruPatch.sha256Hash())); } try { - Map> allPatches = userSettingsFile.getAllPatches(); + Map> allPatches = configManager.getAllPatches(); List patches; if (allPatches.containsKey(aruPatch.patchId())) { patches = allPatches.get(aruPatch.patchId()); @@ -81,10 +83,10 @@ public String downloadPatch(AruPatch aruPatch, UserSettingsFile userSettingsFile aruPatch.version())); allPatches.put(aruPatch.patchId(),patches); } - userSettingsFile.saveAllPatches(allPatches, userSettingsFile.getPatchDetailsFile()); + configManager.saveAllPatches(allPatches, configManager.getPatchDetailsFile()); } catch (Exception k) { - k.printStackTrace(); + throw new IOException(k.getMessage(), k); } return filename; } @@ -95,27 +97,28 @@ public String downloadPatch(AruPatch aruPatch, UserSettingsFile userSettingsFile * @throws IOException when file is not there */ public String resolve() throws IOException { - String cacheKey = aruPatch.patchId(); - logger.entering(cacheKey); + String patchId = aruPatch.patchId(); + logger.entering(patchId); String filePath = null; boolean fileExists = false; - UserSettingsFile userSettingsFile = new UserSettingsFile(); - PatchMetaData patchSettings = userSettingsFile.getPatchForPlatform(aruPatch.platformName(), aruPatch.patchId()); + ConfigManager configManager = ConfigManager.getInstance(); + PatchMetaData patchSettings = configManager.getPatchForPlatform(aruPatch.platformName(), + aruPatch.patchId(), aruPatch.version()); if (patchSettings != null) { filePath = patchSettings.getLocation(); fileExists = isFileOnDisk(filePath); } if (fileExists) { - logger.info("IMG-0017", cacheKey, filePath); + logger.info("IMG-0017", patchId, filePath); } else { - logger.info("IMG-0061", cacheKey, aruPatch.patchId()); + logger.info("IMG-0061", patchId, aruPatch.patchId()); if (offlineMode()) { - throw new FileNotFoundException(Utils.getMessage("IMG-0056", cacheKey)); + throw new FileNotFoundException(Utils.getMessage("IMG-0056", patchId)); } - filePath = downloadPatch(aruPatch, userSettingsFile); + filePath = downloadPatch(aruPatch, configManager); } logger.exiting(filePath); @@ -126,4 +129,7 @@ public static boolean isFileOnDisk(String filePath) { return filePath != null && Files.isRegularFile(Paths.get(filePath)); } + public String getVersion() { + return aruPatch.version(); + } } diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/AddInstallerEntry.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/AddInstallerEntry.java index 72a29eac..16a9b600 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/AddInstallerEntry.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/AddInstallerEntry.java @@ -3,8 +3,9 @@ package com.oracle.weblogic.imagetool.cli.cache; +import java.io.IOException; + import com.oracle.weblogic.imagetool.api.model.CommandResponse; -import com.oracle.weblogic.imagetool.cachestore.CacheStore; import com.oracle.weblogic.imagetool.cachestore.CacheStoreException; import com.oracle.weblogic.imagetool.installer.InstallerType; import com.oracle.weblogic.imagetool.util.Architecture; @@ -19,27 +20,43 @@ public class AddInstallerEntry extends CacheAddOperation { @Override - public CommandResponse call() throws CacheStoreException { + public CommandResponse call() throws IOException, CacheStoreException { if ("NONE".equalsIgnoreCase(version)) { throw new IllegalArgumentException("IMG-0105"); } - return addToCache(); + return addInstallerToCache(); } @Override public String getKey() { - StringBuilder key = new StringBuilder(25) - .append(type) - .append(CacheStore.CACHE_KEY_SEPARATOR) - .append(version); + return type.toString(); + //StringBuilder key = new StringBuilder(25) + // .append(type) + // .append(CacheStore.CACHE_KEY_SEPARATOR) + // .append(version); + // + //if (architecture != null) { + // key.append(CacheStore.CACHE_KEY_SEPARATOR) + // .append(architecture); + //} + // + //return key.toString(); + } - if (architecture != null) { - key.append(CacheStore.CACHE_KEY_SEPARATOR) - .append(architecture); - } + @Override + public String getVersion() { + return version; + } + + @Override + public String getCommonName() { + return commonName; + } - return key.toString(); + @Override + public Architecture getArchitecture() { + return architecture; } @Option( @@ -63,4 +80,10 @@ public String getKey() { ) private Architecture architecture; + @Option( + names = {"-cn", "--commonName"}, + description = "(Optional) common name. Valid values: Alphanumeric values with no special characters" + ) + private String commonName; + } diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/AddPatchEntry.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/AddPatchEntry.java index 5445696e..09851f69 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/AddPatchEntry.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/AddPatchEntry.java @@ -6,6 +6,7 @@ import java.util.Collections; import com.oracle.weblogic.imagetool.api.model.CommandResponse; +import com.oracle.weblogic.imagetool.util.Architecture; import com.oracle.weblogic.imagetool.util.Utils; import picocli.CommandLine.Command; import picocli.CommandLine.Option; @@ -21,12 +22,27 @@ public String getKey() { return patchId; } + @Override + public String getVersion() { + return version; + } + + @Override + public String getCommonName() { + return null; + } + + @Override + public Architecture getArchitecture() { + return architecture; + } + @Override public CommandResponse call() throws Exception { try { if (patchId != null && !patchId.isEmpty()) { Utils.validatePatchIds(Collections.singletonList(patchId), false); - return addToCache(); + return addPatchToCache(); } else { return CommandResponse.error("IMG-0076", "--patchId"); } @@ -41,4 +57,18 @@ public CommandResponse call() throws Exception { required = true ) private String patchId; + + @Option( + names = {"-v", "--version"}, + description = "Patch version. ", + required = true + ) + private String version; + + @Option( + names = {"-a", "--architecture"}, + description = "(Optional) Installer architecture. Valid values: ${COMPLETION-CANDIDATES}" + ) + private Architecture architecture; + } diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonCreateOptions.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonCreateOptions.java index 9a80f1eb..d058b1df 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonCreateOptions.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonCreateOptions.java @@ -20,14 +20,15 @@ import com.oracle.weblogic.imagetool.installer.MiddlewareInstall; import com.oracle.weblogic.imagetool.logging.LoggingFacade; import com.oracle.weblogic.imagetool.logging.LoggingFactory; -import com.oracle.weblogic.imagetool.settings.UserSettingsFile; +import com.oracle.weblogic.imagetool.settings.ConfigManager; +import com.oracle.weblogic.imagetool.util.Architecture; import com.oracle.weblogic.imagetool.util.Constants; import com.oracle.weblogic.imagetool.util.Utils; import picocli.CommandLine.Option; import static com.oracle.weblogic.imagetool.cachestore.CacheStoreFactory.cache; -import static com.oracle.weblogic.imagetool.util.Constants.AMD64_SUBDIR; -import static com.oracle.weblogic.imagetool.util.Constants.ARM64_SUBDIR; +import static com.oracle.weblogic.imagetool.util.Constants.AMD64_BLD; +import static com.oracle.weblogic.imagetool.util.Constants.ARM64_BLD; import static com.oracle.weblogic.imagetool.util.Constants.CTX_JDK; public class CommonCreateOptions extends CommonPatchingOptions { @@ -41,28 +42,29 @@ void prepareNewImage() throws IOException, InterruptedException, XPathExpression logger.entering(); copyOptionsFromImage(); - UserSettingsFile settingsFile = new UserSettingsFile(); + List buildPlatforms = getBuildPlatform(); // Verify version and installers exists first - verifyInstallers(settingsFile, buildPlatforms); + verifyInstallers(buildPlatforms); if (dockerfileOptions.installJava()) { List jdkFilePathList = new ArrayList<>(); for (String jdkPlatform : buildPlatforms) { String buildContextDestination = buildDir(); - if (jdkPlatform.equals(AMD64_SUBDIR)) { - buildContextDestination = buildContextDestination + "/" + CTX_JDK + AMD64_SUBDIR; + Architecture arch = Architecture.fromString(jdkPlatform); + if (jdkPlatform.equals(AMD64_BLD)) { + buildContextDestination = buildContextDestination + "/" + CTX_JDK + AMD64_BLD; dockerfileOptions.setTargetAMDPlatform(true); - } else if (jdkPlatform.equals(ARM64_SUBDIR)) { - buildContextDestination = buildContextDestination + "/" + CTX_JDK + ARM64_SUBDIR; + } else if (jdkPlatform.equals(ARM64_BLD)) { + buildContextDestination = buildContextDestination + "/" + CTX_JDK + ARM64_BLD; dockerfileOptions.setTargetARMPlatform(true); } //CachedFile jdk = new CachedFile(InstallerType.JDK, jdkVersion, jdkPlatform); //Path installerPath = jdk.copyFile(cache(), buildContextDestination); - InstallerMetaData installerMetaData = settingsFile.getInstallerForPlatform(InstallerType.JDK, - jdkPlatform, jdkVersion); + InstallerMetaData installerMetaData = ConfigManager.getInstance() + .getInstallerForPlatform(InstallerType.JDK, arch, jdkVersion); Path installerPath = Paths.get(installerMetaData.getLocation()); Files.copy(installerPath, Paths.get(buildContextDestination).resolve(installerPath.getFileName())); jdkFilePathList.add(installerPath.getFileName().toString()); @@ -104,12 +106,13 @@ void prepareNewImage() throws IOException, InterruptedException, XPathExpression } - void verifyInstallers(UserSettingsFile settingsFile, List buildPlatforms) throws IOException { - + void verifyInstallers(List buildPlatforms) throws IOException { + ConfigManager configManager = ConfigManager.getInstance(); // Verify version and installers exists first for (String buildPlatform : buildPlatforms) { - InstallerMetaData jdkInstallerMetaData = settingsFile.getInstallerForPlatform(InstallerType.JDK, - buildPlatform, jdkVersion); + Architecture arch = Architecture.fromString(buildPlatform); + InstallerMetaData jdkInstallerMetaData = configManager.getInstallerForPlatform(InstallerType.JDK, + arch, jdkVersion); if (jdkInstallerMetaData == null) { throw new IOException("Could not find installer for jdk " + jdkVersion + " " + buildPlatform); } else { @@ -118,8 +121,8 @@ void verifyInstallers(UserSettingsFile settingsFile, List buildPlatforms } for (InstallerType installerType : getInstallerType().installerList()) { - InstallerMetaData installerMetaData = settingsFile.getInstallerForPlatform(installerType, - buildPlatform, installerVersion); + InstallerMetaData installerMetaData = configManager.getInstallerForPlatform(installerType, + arch, installerVersion); if (installerMetaData == null) { throw new IOException(String.format("Could not find installer type %s, platform %s and version %s", installerType, buildPlatform, installerVersion)); diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonOptions.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonOptions.java index cf067256..31ed5994 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonOptions.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonOptions.java @@ -34,8 +34,8 @@ import picocli.CommandLine.Parameters; import picocli.CommandLine.Spec; -import static com.oracle.weblogic.imagetool.util.Constants.AMD64_SUBDIR; -import static com.oracle.weblogic.imagetool.util.Constants.ARM64_SUBDIR; +import static com.oracle.weblogic.imagetool.util.Constants.AMD64_BLD; +import static com.oracle.weblogic.imagetool.util.Constants.ARM64_BLD; import static com.oracle.weblogic.imagetool.util.Constants.BUSYBOX_OS_IDS; import static com.oracle.weblogic.imagetool.util.Constants.CTX_FMW; import static com.oracle.weblogic.imagetool.util.Constants.CTX_JDK; @@ -152,10 +152,10 @@ String buildDir() throws IOException { buildDirectory = tmpDir.toAbsolutePath().toString(); logger.info("IMG-0003", buildDirectory); } - Path fmwamd64 = Paths.get(CTX_FMW + AMD64_SUBDIR); - Path fmwarm64 = Paths.get(CTX_FMW + ARM64_SUBDIR); - Path jdkamd64 = Paths.get(CTX_JDK + AMD64_SUBDIR); - Path jdkarm64 = Paths.get(CTX_JDK + ARM64_SUBDIR); + Path fmwamd64 = Paths.get(CTX_FMW + AMD64_BLD); + Path fmwarm64 = Paths.get(CTX_FMW + ARM64_BLD); + Path jdkamd64 = Paths.get(CTX_JDK + AMD64_BLD); + Path jdkarm64 = Paths.get(CTX_JDK + ARM64_BLD); if (!Files.exists(fmwamd64)) { Files.createDirectories(Paths.get(buildDirectory).resolve(fmwamd64)); diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonPatchingOptions.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonPatchingOptions.java index eba01c1c..42eea82e 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonPatchingOptions.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonPatchingOptions.java @@ -28,11 +28,15 @@ import com.oracle.weblogic.imagetool.logging.LoggingFacade; import com.oracle.weblogic.imagetool.logging.LoggingFactory; import com.oracle.weblogic.imagetool.patch.PatchMetaData; -import com.oracle.weblogic.imagetool.settings.UserSettingsFile; +import com.oracle.weblogic.imagetool.settings.ConfigManager; +import com.oracle.weblogic.imagetool.util.Architecture; import com.oracle.weblogic.imagetool.util.InvalidPatchIdFormatException; import com.oracle.weblogic.imagetool.util.Utils; import picocli.CommandLine.Option; +import static com.oracle.weblogic.imagetool.util.Constants.AMD64_BLD; +import static com.oracle.weblogic.imagetool.util.Constants.ARM64_BLD; + public abstract class CommonPatchingOptions extends CommonOptions { private static final LoggingFacade logger = LoggingFactory.getLogger(CommonPatchingOptions.class); @@ -147,23 +151,25 @@ void handlePatchFiles(List installedPatches) AruUtil.rest().validatePatches(installedPatches, aruPatches, userId, password); - String patchesFolderName = createPatchesTempDirectory().toAbsolutePath().toString(); + String patchesFolderNameAMD = createPatchesTempDirectory().toAbsolutePath().toString() + "/" + AMD64_BLD; + String patchesFolderNameARM = createPatchesTempDirectory().toAbsolutePath().toString() + "/" + ARM64_BLD; + // copy the patch JARs to the Docker build context directory from the local cache, downloading them if needed - UserSettingsFile userSettingsFile = new UserSettingsFile(); + ConfigManager configManager = ConfigManager.getInstance(); for (AruPatch patch : aruPatches) { - String platform = patch.platform(); + String platform = patch.platformName(); // TODO if (platform == null) { platform = "generic"; } - PatchMetaData metaData = userSettingsFile.getPatchForPlatform(platform, patch.patchId()); + PatchMetaData metaData = configManager.getPatchForPlatform(platform, patch.patchId(), patch.version()); if (metaData == null) { // download the patch first if (userId != null && password != null) { PatchFile patchFile = new PatchFile(patch, userId, password); String filePath = patchFile.resolve(); - metaData = userSettingsFile.getPatchForPlatform(platform, patch.patchId()); + metaData = configManager.getPatchForPlatform(platform, patch.patchId(), patch.version()); } else { throw logger.throwing(new IOException("No user credentials provided and " + "no offline patch downloaded: " + patch.patchId())); @@ -178,7 +184,11 @@ void handlePatchFiles(List installedPatches) if (patch.fileName() == null) { patch.fileName(cacheFile.getName()); } - Files.copy(Paths.get(patchLocation), Paths.get(patchesFolderName, cacheFile.getName())); + if (platform.equals(AMD64_BLD)) { + Files.copy(Paths.get(patchLocation), Paths.get(patchesFolderNameAMD, cacheFile.getName())); + } else { + Files.copy(Paths.get(patchLocation), Paths.get(patchesFolderNameARM, cacheFile.getName())); + } } catch (FileAlreadyExistsException ee) { logger.warning("IMG-0077", patch.patchId()); } @@ -248,26 +258,33 @@ List resolveUserRequestedPatches(String psuVersion) providedVersion = patchId.substring(split + 1); patchId = patchId.substring(0, split); } - List patchVersions = AruUtil.rest().getPatches(patchId, userId, password) - .filter(p -> p.isApplicableToTarget(getTargetArchitecture().getAruPlatform())) - .collect(Collectors.toList()); - - // Stack Patch Bundle (SPB) is not a traditional patch. Patches in SPB are duplicates of recommended. - if (patchVersions.stream().anyMatch(AruPatch::isStackPatchBundle)) { - // Do not continue if the user specified a patch number that cannot be applied. - throw logger.throwing(new InvalidPatchNumberException(Utils.getMessage("IMG-0098", patchId))); - } + // If there are multiple platforms patches, we need to copy all of them to build context. + // In runtime, the docker file will determine which to use based on env. - if (!patchVersions.isEmpty()) { - // if ARU found patches for the provided bug number, try to select the one the user needs by version - AruPatch selectedVersion = AruPatch.selectPatch(patchVersions, providedVersion, effectivePsuVersion, - getInstallerVersion()); + List buildPlatforms = getBuildPlatform(); + for (String buildPlatform : buildPlatforms) { + List patchVersions = AruUtil.rest().getPatches(patchId, userId, password) + .filter(p -> p.isApplicableToTarget(Architecture.fromString(buildPlatform).getAruPlatform())) + .collect(Collectors.toList()); - String psuVersionOfSelected = findPsuVersion(selectedVersion); - if (Utils.isEmptyString(psuVersion) && !Utils.isEmptyString(psuVersionOfSelected)) { - effectivePsuVersion = psuVersionOfSelected; + // Stack Patch Bundle (SPB) is not a traditional patch. Patches in SPB are duplicates of recommended. + if (patchVersions.stream().anyMatch(AruPatch::isStackPatchBundle)) { + // Do not continue if the user specified a patch number that cannot be applied. + throw logger.throwing(new InvalidPatchNumberException(Utils.getMessage("IMG-0098", patchId))); } - result.add(selectedVersion); + + if (!patchVersions.isEmpty()) { + // if ARU found patches for the provided bug number, try to select the one the user needs by version + AruPatch selectedVersion = AruPatch.selectPatch(patchVersions, providedVersion, effectivePsuVersion, + getInstallerVersion()); + + String psuVersionOfSelected = findPsuVersion(selectedVersion); + if (Utils.isEmptyString(psuVersion) && !Utils.isEmptyString(psuVersionOfSelected)) { + effectivePsuVersion = psuVersionOfSelected; + } + result.add(selectedVersion); + } + } } logger.exiting(result); @@ -293,33 +310,39 @@ List getRecommendedPatchList() throws AruException { throw new IllegalArgumentException(Utils.getMessage("IMG-0031")); } - if (recommendedPatches) { - // Get the latest PSU and its recommended patches - aruPatches = AruUtil.rest() - .getRecommendedPatches(getInstallerType(), getInstallerVersion(), getTargetArchitecture(), + List buildPlatforms = getBuildPlatform(); + for (String buildPlatform : buildPlatforms) { + if (recommendedPatches) { + // Get the latest PSU and its recommended patches + aruPatches = AruUtil.rest() + .getRecommendedPatches(getInstallerType(), getInstallerVersion(), + Architecture.fromString(buildPlatform), + userId, password); + + if (aruPatches.isEmpty()) { + recommendedPatches = false; + logger.info("IMG-0084", getInstallerVersion()); + } else if (FmwInstallerType.isBaseWeblogicServer(getInstallerType())) { + // find and remove all ADR patches in the recommended patches list for base WLS installers + List discard = aruPatches.stream() + .filter(p -> p.description().startsWith("ADR FOR WEBLOGIC SERVER")) + .collect(Collectors.toList()); + // let the user know that the ADR patches will be discarded + discard.forEach(p -> logger.info("IMG-0085", p.patchId())); + aruPatches.removeAll(discard); + } + } else if (latestPsu) { + // PSUs for WLS and JRF installers are considered WLS patches + aruPatches = AruUtil.rest().getLatestPsu(getInstallerType(), getInstallerVersion(), + Architecture.fromString(buildPlatform), userId, password); - if (aruPatches.isEmpty()) { - recommendedPatches = false; - logger.info("IMG-0084", getInstallerVersion()); - } else if (FmwInstallerType.isBaseWeblogicServer(getInstallerType())) { - // find and remove all ADR patches in the recommended patches list for base WLS installers - List discard = aruPatches.stream() - .filter(p -> p.description().startsWith("ADR FOR WEBLOGIC SERVER")) - .collect(Collectors.toList()); - // let the user know that the ADR patches will be discarded - discard.forEach(p -> logger.info("IMG-0085", p.patchId())); - aruPatches.removeAll(discard); - } - } else if (latestPsu) { - // PSUs for WLS and JRF installers are considered WLS patches - aruPatches = AruUtil.rest().getLatestPsu(getInstallerType(), getInstallerVersion(), getTargetArchitecture(), - userId, password); - - if (aruPatches.isEmpty()) { - latestPsu = false; - logger.fine("Latest PSU NOT FOUND, ignoring latestPSU flag"); + if (aruPatches.isEmpty()) { + latestPsu = false; + logger.fine("Latest PSU NOT FOUND, ignoring latestPSU flag"); + } } + } return aruPatches; diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/installer/MiddlewareInstall.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/installer/MiddlewareInstall.java index 5f2ab387..d7bff4fd 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/installer/MiddlewareInstall.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/installer/MiddlewareInstall.java @@ -19,12 +19,12 @@ import com.oracle.weblogic.imagetool.cachestore.CacheStore; import com.oracle.weblogic.imagetool.logging.LoggingFacade; import com.oracle.weblogic.imagetool.logging.LoggingFactory; -import com.oracle.weblogic.imagetool.settings.UserSettingsFile; +import com.oracle.weblogic.imagetool.settings.ConfigManager; import com.oracle.weblogic.imagetool.util.Architecture; import com.oracle.weblogic.imagetool.util.Utils; -import static com.oracle.weblogic.imagetool.util.Constants.AMD64_SUBDIR; -import static com.oracle.weblogic.imagetool.util.Constants.ARM64_SUBDIR; +import static com.oracle.weblogic.imagetool.util.Constants.AMD64_BLD; +import static com.oracle.weblogic.imagetool.util.Constants.ARM64_BLD; import static com.oracle.weblogic.imagetool.util.Constants.CTX_FMW; public class MiddlewareInstall { @@ -43,14 +43,19 @@ public MiddlewareInstall(FmwInstallerType type, String version, List respo throws FileNotFoundException { logger.info("IMG-0039", type.installerListString(), version); fmwInstallerType = type; - UserSettingsFile settingsFile = new UserSettingsFile(); - + ConfigManager configManager = ConfigManager.getInstance(); for (InstallerType installerType : type.installerList()) { for (String platform : buildPlatform) { MiddlewareInstallPackage pkg = new MiddlewareInstallPackage(); + Architecture arch = Architecture.valueOf(platform); pkg.type = installerType; - pkg.installer = new CachedFile(installerType, version, platform); - InstallerMetaData metaData = settingsFile.getInstallerForPlatform(installerType, platform, version); + if (AMD64_BLD.equals(platform)) { + pkg.installer = new CachedFile(installerType, version, Architecture.AMD64); + } + if (ARM64_BLD.equals(platform)) { + pkg.installer = new CachedFile(installerType, version, Architecture.ARM64); + } + InstallerMetaData metaData = configManager.getInstallerForPlatform(installerType, arch, version); pkg.installerPath = Paths.get(metaData.getLocation()); pkg.installerFilename = pkg.installerPath.getFileName().toString(); pkg.responseFile = new DefaultResponseFile(installerType, type); @@ -100,10 +105,10 @@ public void copyFiles(CacheStore cacheStore, String buildContextDir) throws IOEx for (MiddlewareInstallPackage installPackage: installerFiles) { String buildContextDestination = buildContextDir; // based on the platform copy to sub directory - if (installPackage.platform.equals(AMD64_SUBDIR)) { - buildContextDestination = buildContextDestination + "/" + CTX_FMW + AMD64_SUBDIR; - } else if (installPackage.platform.equals(ARM64_SUBDIR)) { - buildContextDestination = buildContextDestination + "/" + CTX_FMW + ARM64_SUBDIR; + if (installPackage.platform.equals(AMD64_BLD)) { + buildContextDestination = buildContextDestination + "/" + CTX_FMW + AMD64_BLD; + } else if (installPackage.platform.equals(ARM64_BLD)) { + buildContextDestination = buildContextDestination + "/" + CTX_FMW + ARM64_BLD; } //Path filePath = installPackage.installer.copyFile(cacheStore, buildContextDestination); //installPackage.installerFilename = filePath.getFileName().toString(); diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/ConfigManager.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/ConfigManager.java index 54bd8af9..7a33387f 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/ConfigManager.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/ConfigManager.java @@ -1,2 +1,151 @@ -package com.oracle.weblogic.imagetool.settings;public class ConfigManager { +// Copyright (c) 2020, 2024, 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.settings; + +import java.io.IOException; +import java.nio.file.Path; +import java.nio.file.Paths; +import java.util.EnumMap; +import java.util.List; +import java.util.Map; + +import com.oracle.weblogic.imagetool.aru.AruPatch; +import com.oracle.weblogic.imagetool.installer.InstallerMetaData; +import com.oracle.weblogic.imagetool.installer.InstallerType; +import com.oracle.weblogic.imagetool.logging.LoggingFacade; +import com.oracle.weblogic.imagetool.logging.LoggingFactory; +import com.oracle.weblogic.imagetool.patch.PatchMetaData; +import com.oracle.weblogic.imagetool.util.Architecture; + +import static com.oracle.weblogic.imagetool.util.Utils.getTodayDate; + +public class ConfigManager { + private UserSettingsFile userSettingsFile; + private static ConfigManager instance; + private static final LoggingFacade logger = LoggingFactory.getLogger(UserSettingsFile.class); + + private ConfigManager(Path userSettingsFileName) { + if (userSettingsFileName != null) { + userSettingsFile = new UserSettingsFile(userSettingsFileName); + } else { + userSettingsFile = new UserSettingsFile(); + } + } + + /** + * Return the singleton instance of ConfigManager. + * @return ConfigManager instance + */ + public static synchronized ConfigManager getInstance() { + if (instance == null) { + instance = new ConfigManager(Paths.get(System.getProperty("user.home"), ".imagetool", + "settings.yaml")); + + } + return instance; + } + + /** + * Return the singleton instance of ConfigManager. + * @return ConfigManager instance + */ + public static synchronized ConfigManager getInstance(Path fileName) { + if (instance == null) { + instance = new ConfigManager(fileName); + } + return instance; + } + + public Map> getAllPatches() { + return userSettingsFile.getAllPatches(); + } + + public void saveAllPatches(Map> allPatches, String location) throws IOException { + userSettingsFile.saveAllPatches(allPatches, location); + } + + public void addPatch(String bugNumber, String patchArchitecture, String patchLocation, + String patchVersion) throws IOException { + userSettingsFile.addPatch(bugNumber, patchArchitecture, patchLocation, patchVersion); + } + + public PatchMetaData getPatchForPlatform(String platformName, String bugNumber, String version) { + return userSettingsFile.getPatchForPlatform(platformName, bugNumber, version); + } + + public String getPatchDirectory() { + return userSettingsFile.getPatchDirectory(); + } + + public String getPatchDetailsFile() { + return userSettingsFile.getPatchDetailsFile(); + } + + /** + * Return the metadata for the platformed installer. + * @param platformName platform name + * @param installerVersion version of the installer + * @return InstallerMetaData meta data for the installer + */ + public InstallerMetaData getInstallerForPlatform(InstallerType installerType, Architecture platformName, + String installerVersion) { + return userSettingsFile.getInstallerForPlatform(installerType, platformName, installerVersion); + } + + /** + * Return all the installers based on the configured directory for the yaml file. + * @return map of installers + */ + public EnumMap>> getInstallers() { + + return userSettingsFile.getInstallers(); + } + + public void addInstaller(InstallerType installerType, String commonName, InstallerMetaData metaData) + throws IOException { + userSettingsFile.addInstaller(installerType,commonName, metaData); + } + + /** + * Save all installers. + * @param allInstallers map of installers + * @param location file location + * @throws IOException any error + */ + public void saveAllInstallers(Map>> allInstallers, + String location) throws IOException { + userSettingsFile.saveAllInstallers(allInstallers, location); + } + + /** + * Return the metadata for the patches by bug number. + * @param bugNumber version of the installer + * @return list of AruPatch + */ + + public List getAruPatchForBugNumber(String bugNumber) { + return userSettingsFile.getAruPatchForBugNumber(bugNumber); + } + + + private InstallerMetaData createInstallerMetaData(Map objectData) { + String hash = (String) objectData.get("digest"); + String dateAdded = getTodayDate(); + String location = (String) objectData.get("location"); + String productVersion = (String) objectData.get("version"); + String platform = (String) objectData.get("platform"); + return new InstallerMetaData(platform, location, hash, dateAdded, productVersion); + } + + private PatchMetaData createPatchMetaData(Map objectData) { + String hash = (String) objectData.get("digest"); + String dateAdded = getTodayDate(); + String location = (String) objectData.get("location"); + String productVersion = (String) objectData.get("version"); + String platform = (String) objectData.get("platform"); + return new PatchMetaData(platform, location, hash, dateAdded, productVersion); + } + + } diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/util/Architecture.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/util/Architecture.java index f0253c53..5cce402b 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/util/Architecture.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/util/Architecture.java @@ -15,7 +15,8 @@ */ public enum Architecture { ARM64(541, "arm64", "linux/arm64", "aarch64"), // Linux ARM 64-bit - AMD64(226, "amd64", "linux/amd64", "x86_64"); // Linux AMD 64-bit + AMD64(226, "amd64", "linux/amd64", "x86_64"), // Linux AMD 64-bit + GENERIC(2000, "Generic"); private static final LoggingFacade logger = LoggingFactory.getLogger(Architecture.class); diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/util/Constants.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/util/Constants.java index fe5c73d1..d08596ef 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/util/Constants.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/util/Constants.java @@ -10,7 +10,7 @@ public final class Constants { public static final String ARU_UPDATES_HOST = - Utils.getEnvironmentProperty("WLSIMG_ARU_HOST", "updates.oracle.com"); + Utils.getEnvironmentProperty("WLSIMG_ARU_HOST", () -> "updates.oracle.com"); public static final String ARU_REST_URL = "https://" + ARU_UPDATES_HOST + "/Orion/Services"; public static final String REL_URL = ARU_REST_URL + "/metadata?table=aru_releases"; public static final String RECOMMENDED_PATCHES_URL = ARU_REST_URL @@ -24,12 +24,14 @@ public final class Constants { public static final String DELETE_ALL_FOR_SURE = "deleteAll4Sure"; public static final String HTTP = "http"; public static final String HTTPS = "https"; - public static final String PATCH_ID_REGEX = "^(\\d{8})(?:[_][0-9][0-9](?:\\.[0-9]){3,8}\\.(\\d+))?"; - public static final String RIGID_PATCH_ID_REGEX = "^(\\d{8})[_][0-9][0-9](?:\\.[0-9]){3,8}\\.(\\d+)"; public static final String BUSYBOX = "busybox"; public static final List BUSYBOX_OS_IDS = Collections.unmodifiableList(Arrays.asList("bb", "alpine")); public static final String ORACLE_LINUX = "ghcr.io/oracle/oraclelinux:8-slim"; - public static final String BUILDER_DEFAULT = Utils.getEnvironmentProperty("WLSIMG_BUILDER", "docker"); + public static final String BUILDER_DEFAULT = Utils.getEnvironmentProperty("WLSIMG_BUILDER", () -> "docker"); + public static final String CTX_JDK = "jdk/"; + public static final String CTX_FMW = "fmw/"; + public static final String AMD64_BLD = "linux/amd64"; + public static final String ARM64_BLD = "linux/arm64"; private Constants() { //restrict access diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/util/DockerfileOptions.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/util/DockerfileOptions.java index 64cfc27d..4b632071 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/util/DockerfileOptions.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/util/DockerfileOptions.java @@ -24,8 +24,9 @@ import com.oracle.weblogic.imagetool.logging.LoggingFactory; import com.oracle.weblogic.imagetool.wdt.WdtOperation; -import static com.oracle.weblogic.imagetool.util.BuildPlatform.AMD64; -import static com.oracle.weblogic.imagetool.util.BuildPlatform.ARM64; +import static com.oracle.weblogic.imagetool.util.Constants.AMD64_BLD; +import static com.oracle.weblogic.imagetool.util.Constants.ARM64_BLD; + /** * Provides the data used by the Dockerfile templates (in mustache). @@ -1064,12 +1065,12 @@ public List installPackages() { } public List installPackagesForARM() { - return mwInstallers.getInstallers().stream().filter(obj -> ARM64.equals(obj.platform)) + return mwInstallers.getInstallers().stream().filter(obj -> ARM64_BLD.equals(obj.platform)) .collect(Collectors.toList()); } public List installPackagesForAMD() { - return mwInstallers.getInstallers().stream().filter(obj -> AMD64.equals(obj.platform)) + return mwInstallers.getInstallers().stream().filter(obj -> AMD64_BLD.equals(obj.platform)) .collect(Collectors.toList()); } diff --git a/imagetool/src/test/resources/settings/settings.yaml b/imagetool/src/test/resources/settings/settings.yaml index e69de29b..426dd3c3 100644 --- a/imagetool/src/test/resources/settings/settings.yaml +++ b/imagetool/src/test/resources/settings/settings.yaml @@ -0,0 +1,11 @@ +installerDirectory: settings/installers +patchDirectory: settings/oraclePatches +installerSettingsFile: src/test/resources/settings/installers.yaml +patchSettingsFile: src/test/resources/settings/patches.yaml +installers: + jdk: + defaultVersion: 8u401 + wls: + defaultVersion: 12.2.1.4.0 + wdt: + defaultVersion: latest From df0319e5429a394f6c6e501f64fcdf8ccee68b26 Mon Sep 17 00:00:00 2001 From: jshum Date: Tue, 5 Nov 2024 13:51:33 -0600 Subject: [PATCH 037/104] Various fixes --- .../imagetool/aru/PatchVersionException.java | 7 +--- .../imagetool/builder/BuildCommand.java | 3 ++ .../imagetool/cli/cache/CacheCLI.java | 4 +- .../imagetool/cli/cache/ListCacheItems.java | 40 +++++++++++-------- .../cli/menu/CommonCreateOptions.java | 1 - .../imagetool/cli/menu/CommonOptions.java | 15 +++++++ .../cli/menu/CommonPatchingOptions.java | 12 +++--- .../installer/MiddlewareInstall.java | 2 +- .../imagetool/settings/ConfigManager.java | 14 +++++++ .../imagetool/settings/UserSettingsFile.java | 7 ++++ .../oracle/weblogic/imagetool/util/Utils.java | 9 ----- .../src/main/resources/ImageTool.properties | 2 +- .../docker-files/fmw-patching.mustache | 2 +- .../docker-files/install-middleware.mustache | 2 +- 14 files changed, 75 insertions(+), 45 deletions(-) diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/aru/PatchVersionException.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/aru/PatchVersionException.java index 339fc5ea..df16fc55 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/aru/PatchVersionException.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/aru/PatchVersionException.java @@ -5,7 +5,6 @@ import java.io.IOException; import java.util.List; -import java.util.stream.Collectors; import com.oracle.weblogic.imagetool.util.Utils; @@ -18,10 +17,6 @@ public class PatchVersionException extends IOException { * @param versionsAvailable the list of versions for patches of that bug */ public PatchVersionException(String bugNumber, List versionsAvailable) { - super(Utils.getMessage("IMG-0034", bugNumber, - versionsAvailable.stream() - .map(s -> bugNumber + "_" + s.version()) - .collect(Collectors.joining(", "))) - ); + super(Utils.getMessage("IMG-0034", bugNumber, versionsAvailable)); } } diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/builder/BuildCommand.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/builder/BuildCommand.java index 4901ab5d..4d59a1c9 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/builder/BuildCommand.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/builder/BuildCommand.java @@ -268,6 +268,9 @@ private List getCommand(boolean showPasswords) { result.addAll(arg.toList(showPasswords)); } result.add(context); + if (useBuildx) { + result.add("--progress=plain"); + } return result; } diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/CacheCLI.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/CacheCLI.java index aa3aab66..52a46a4f 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/CacheCLI.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/CacheCLI.java @@ -14,9 +14,7 @@ subcommands = { ListCacheItems.class, AddInstallerEntry.class, - AddPatchEntry.class, - AddEntry.class, - DeleteEntry.class + AddPatchEntry.class }, sortOptions = false ) diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/ListCacheItems.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/ListCacheItems.java index d042a6ce..54c7df4c 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/ListCacheItems.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/ListCacheItems.java @@ -3,15 +3,17 @@ package com.oracle.weblogic.imagetool.cli.cache; -import java.util.Map; -import java.util.regex.Pattern; +import java.io.IOException; +import java.nio.file.Files; +import java.nio.file.Path; +import java.nio.file.Paths; import com.oracle.weblogic.imagetool.api.model.CommandResponse; import com.oracle.weblogic.imagetool.cachestore.CacheStoreException; +import com.oracle.weblogic.imagetool.settings.ConfigManager; import picocli.CommandLine.Command; import picocli.CommandLine.Option; -import static com.oracle.weblogic.imagetool.cachestore.CacheStoreFactory.cache; @Command( name = "listItems", @@ -21,24 +23,28 @@ public class ListCacheItems extends CacheOperation { @Override public CommandResponse call() throws CacheStoreException { - Map resultMap = cache().getCacheItems(); - if (resultMap == null || resultMap.isEmpty()) { - return CommandResponse.success("IMG-0047"); + String fileName; + if ("patches".equalsIgnoreCase(type)) { + fileName = ConfigManager.getInstance().getPatchDetailsFile(); } else { - System.out.println("Cache contents"); - - Pattern pattern = Pattern.compile(key == null ? ".*" : key); - resultMap.entrySet().stream() - .filter(entry -> pattern.matcher(entry.getKey()).matches()) - .forEach(System.out::println); - - return CommandResponse.success(null); + fileName = ConfigManager.getInstance().getInstallerDetailsFile(); + } + if (fileName != null) { + try { + Path path = Paths.get(fileName); + Files.lines(path).forEach(System.out::println); + } catch (IOException ioException) { + System.err.println("Unable to read file: " + fileName); + } } + return CommandResponse.success(null); + } @Option( - names = {"--key"}, - description = "list only cached items where the key matches this regex" + names = {"--type"}, + description = "list type type : patches, installers (default: installers)" ) - private String key; + private String type; + } diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonCreateOptions.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonCreateOptions.java index d058b1df..ae69c2a0 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonCreateOptions.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonCreateOptions.java @@ -105,7 +105,6 @@ void prepareNewImage() throws IOException, InterruptedException, XPathExpression logger.exiting(); } - void verifyInstallers(List buildPlatforms) throws IOException { ConfigManager configManager = ConfigManager.getInstance(); // Verify version and installers exists first diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonOptions.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonOptions.java index 31ed5994..e95385c0 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonOptions.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonOptions.java @@ -10,6 +10,7 @@ import java.nio.file.Paths; import java.time.Duration; import java.time.Instant; +import java.util.ArrayList; import java.util.List; import java.util.Map; import java.util.Properties; @@ -24,7 +25,9 @@ import com.oracle.weblogic.imagetool.inspect.OperatingSystemProperties; import com.oracle.weblogic.imagetool.logging.LoggingFacade; import com.oracle.weblogic.imagetool.logging.LoggingFactory; +import com.oracle.weblogic.imagetool.settings.ConfigManager; import com.oracle.weblogic.imagetool.util.AdditionalBuildCommands; +import com.oracle.weblogic.imagetool.util.Architecture; import com.oracle.weblogic.imagetool.util.Constants; import com.oracle.weblogic.imagetool.util.DockerfileOptions; import com.oracle.weblogic.imagetool.util.InvalidPatchIdFormatException; @@ -335,7 +338,19 @@ public String buildId() { return buildId; } + /** + * Return build platforms from cli or settings or default system. + * @return architecture list + */ public List getBuildPlatform() { + if (buildPlatform == null) { + buildPlatform = new ArrayList<>(); + java.lang.String platform = ConfigManager.getInstance().getDefaultBuildPlatform(); + if (platform == null) { + platform = Architecture.getLocalArchitecture().toString(); + } + buildPlatform.add(platform); + } return buildPlatform; } diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonPatchingOptions.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonPatchingOptions.java index 42eea82e..94acc4cb 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonPatchingOptions.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonPatchingOptions.java @@ -151,9 +151,9 @@ void handlePatchFiles(List installedPatches) AruUtil.rest().validatePatches(installedPatches, aruPatches, userId, password); - String patchesFolderNameAMD = createPatchesTempDirectory().toAbsolutePath().toString() + "/" + AMD64_BLD; - String patchesFolderNameARM = createPatchesTempDirectory().toAbsolutePath().toString() + "/" + ARM64_BLD; - + String patchesFolderName = createPatchesTempDirectory().toAbsolutePath().toString(); + Files.createDirectories(Paths.get(patchesFolderName, AMD64_BLD)); + Files.createDirectories(Paths.get(patchesFolderName, ARM64_BLD)); // copy the patch JARs to the Docker build context directory from the local cache, downloading them if needed ConfigManager configManager = ConfigManager.getInstance(); for (AruPatch patch : aruPatches) { @@ -185,9 +185,11 @@ void handlePatchFiles(List installedPatches) patch.fileName(cacheFile.getName()); } if (platform.equals(AMD64_BLD)) { - Files.copy(Paths.get(patchLocation), Paths.get(patchesFolderNameAMD, cacheFile.getName())); + Files.copy(Paths.get(patchLocation), Paths.get(patchesFolderName, AMD64_BLD, + cacheFile.getName())); } else { - Files.copy(Paths.get(patchLocation), Paths.get(patchesFolderNameARM, cacheFile.getName())); + Files.copy(Paths.get(patchLocation), Paths.get(patchesFolderName, ARM64_BLD, + cacheFile.getName())); } } catch (FileAlreadyExistsException ee) { logger.warning("IMG-0077", patch.patchId()); diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/installer/MiddlewareInstall.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/installer/MiddlewareInstall.java index d7bff4fd..b2a0f62a 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/installer/MiddlewareInstall.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/installer/MiddlewareInstall.java @@ -47,7 +47,7 @@ public MiddlewareInstall(FmwInstallerType type, String version, List respo for (InstallerType installerType : type.installerList()) { for (String platform : buildPlatform) { MiddlewareInstallPackage pkg = new MiddlewareInstallPackage(); - Architecture arch = Architecture.valueOf(platform); + Architecture arch = Architecture.fromString(platform); pkg.type = installerType; if (AMD64_BLD.equals(platform)) { pkg.installer = new CachedFile(installerType, version, Architecture.AMD64); diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/ConfigManager.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/ConfigManager.java index 7a33387f..cc6750b6 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/ConfigManager.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/ConfigManager.java @@ -102,6 +102,17 @@ public EnumMap>> getInstaller return userSettingsFile.getInstallers(); } + public String getInstallerDetailsFile() { + return userSettingsFile.getInstallerDetailsFile(); + } + + /** + * Add installer. + * @param installerType installer type + * @param commonName common name + * @param metaData meta data of the installer + * @throws IOException when error + */ public void addInstaller(InstallerType installerType, String commonName, InstallerMetaData metaData) throws IOException { userSettingsFile.addInstaller(installerType,commonName, metaData); @@ -128,6 +139,9 @@ public List getAruPatchForBugNumber(String bugNumber) { return userSettingsFile.getAruPatchForBugNumber(bugNumber); } + public String getDefaultBuildPlatform() { + return userSettingsFile.getDefaultBuildPlatform(); + } private InstallerMetaData createInstallerMetaData(Map objectData) { String hash = (String) objectData.get("digest"); diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/UserSettingsFile.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/UserSettingsFile.java index f7ddfb6f..1b28c745 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/UserSettingsFile.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/UserSettingsFile.java @@ -77,6 +77,8 @@ public class UserSettingsFile { private String patchDetailsFile = null; + private String defaultBuildPlatform = null; + public String getPatchDetailsFile() { return patchDetailsFile; } @@ -603,6 +605,7 @@ private void applySettings(Map settings) { buildContextDirectory = SettingsFile.getValue("buildContextDirectory", String.class, settings); buildEngine = SettingsFile.getValue("buildEngine", String.class, settings); containerEngine = SettingsFile.getValue("containerEngine", String.class, settings); + defaultBuildPlatform = SettingsFile.getValue("defaultBuildPlatform", String.class, settings); aruRetryMax = SettingsFile.getValue("aruRetryMax", Integer.class, settings); aruRetryInterval = SettingsFile.getValue("aruRetryInterval", Integer.class, settings); @@ -633,6 +636,10 @@ public String getInstallerDetailsFile() { return installerDetailsFile; } + public String getDefaultBuildPlatform() { + return defaultBuildPlatform; + } + @Override public String toString() { return "UserSettingsFile{" diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/util/Utils.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/util/Utils.java index 36f6bde2..7614eefa 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/util/Utils.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/util/Utils.java @@ -609,15 +609,6 @@ private static void validatePatchIds(List patches, Pattern pattern, */ public static void validatePatchIds(@NotNull List patches, boolean allowSimpleId) throws InvalidPatchIdFormatException { - if (allowSimpleId) { - validatePatchIds(patches, - Pattern.compile("^(\\d{8,9})(?:_\\d\\d(?:\\.\\d){3,8}\\.(\\d+)(_.*)?)?"), - "12345678[_12.2.1.3.0[_arm64]]"); - } else { - validatePatchIds(patches, - Pattern.compile("^(\\d{8,9})_\\d\\d(?:\\.\\d){3,8}\\.(\\d+)(_.*)?"), - "12345678_12.2.1.3.0[_arm64]"); - } } /** diff --git a/imagetool/src/main/resources/ImageTool.properties b/imagetool/src/main/resources/ImageTool.properties index 4d9fefda..f7cbd88a 100644 --- a/imagetool/src/main/resources/ImageTool.properties +++ b/imagetool/src/main/resources/ImageTool.properties @@ -32,7 +32,7 @@ IMG-0030=Additional build command file does not exist: {0} IMG-0031=No credentials provided. Cannot determine latestPSU or recommendedPatches. Please provide the --user and one of the --password options. IMG-0032=Failed to find latest PSU for {0}, version {1} IMG-0033=No credentials provided, skipping validation of patches -IMG-0034=Unable to determine the correct version for patch ID {0}, please retry the command using one of the available patch versions: {1} +IMG-0034=Unable to find the correct version for patch ID {0}, please retry the command using one of the available patch versions: {1} IMG-0035=additionalBuildFile could not be copied: {0} IMG-0036=Unable to find installer inventory file: {0} IMG-0037=Failed to find patch {0} for version {1} diff --git a/imagetool/src/main/resources/docker-files/fmw-patching.mustache b/imagetool/src/main/resources/docker-files/fmw-patching.mustache index 33118cb0..97629eaa 100644 --- a/imagetool/src/main/resources/docker-files/fmw-patching.mustache +++ b/imagetool/src/main/resources/docker-files/fmw-patching.mustache @@ -17,7 +17,7 @@ {{^strictPatchOrdering}} # Apply all patches provided at the same time - RUN {{{oracle_home}}}/OPatch/opatch napply -silent -oh {{{oracle_home}}} -nonrollbackable -phBaseDir {{{tempDir}}}/patches \ + RUN {{{oracle_home}}}/OPatch/opatch napply -silent -oh {{{oracle_home}}} -nonrollbackable -phBaseDir {{{tempDir}}}/patches/$TARGETPLATFORM \ && test $? -eq 0 \ && {{{oracle_home}}}/OPatch/opatch util cleanup -silent -oh {{{oracle_home}}} \ || (cat {{{oracle_home}}}/cfgtoollogs/opatch/opatch*.log && exit 1) diff --git a/imagetool/src/main/resources/docker-files/install-middleware.mustache b/imagetool/src/main/resources/docker-files/install-middleware.mustache index e18a1551..8941d935 100644 --- a/imagetool/src/main/resources/docker-files/install-middleware.mustache +++ b/imagetool/src/main/resources/docker-files/install-middleware.mustache @@ -71,7 +71,7 @@ RUN echo "INSTALLING MIDDLEWARE" \ echo "INSTALLING {{type}}" \ {{#isZip}}&& unzip -q {{{tempDir}}}/{{{type}}}/$TARGETPLATFORM//{{installerFilename}} -d {{{tempDir}}}/{{{type}}} {{/isZip}} \ {{#preinstallCommands}}&& {{{tempDir}}}/{{{type}}}/{{{.}}} {{/preinstallCommands}} \ - {{^isBin}} if [ ! -f {{{tempDir}}}/{{{type}}}/{{jarName}} ] ; then (cp {{{tempDir}}}/{{{type}}}/$TARGETPLATFORM/{{installerFilename}} {{{tempDir}}}/{{{type}}}) fi \ + {{^isBin}}&& if [ ! -f {{{tempDir}}}/{{{type}}}/{{jarName}} ] ; then (cp {{{tempDir}}}/{{{type}}}/$TARGETPLATFORM/{{installerFilename}} {{{tempDir}}}/{{{type}}}) fi \ && {{{java_home}}}/bin/java -Xmx1024m -jar {{{tempDir}}}/{{{type}}}/{{jarName}} \ -silent ORACLE_HOME={{{oracle_home}}} \ -responseFile {{{tempDir}}}/{{{type}}}/$TARGETPLATFORM/{{responseFile.name}} \ From 72d4f306373c1f746a03519f91e96fd89e0aff56 Mon Sep 17 00:00:00 2001 From: jshum Date: Tue, 5 Nov 2024 16:41:49 -0600 Subject: [PATCH 038/104] update mustache file and cli --- .../weblogic/imagetool/aru/AruPatch.java | 1 - .../imagetool/cli/cache/CacheCLI.java | 3 +- .../imagetool/cli/cache/ListInstallers.java | 55 +++++++++++++++++++ .../imagetool/cli/cache/ListPatches.java | 53 ++++++++++++++++++ .../cli/menu/CommonPatchingOptions.java | 2 + .../src/main/resources/ImageTool.properties | 1 + .../docker-files/fmw-patching.mustache | 10 +++- 7 files changed, 120 insertions(+), 5 deletions(-) create mode 100644 imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/ListInstallers.java create mode 100644 imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/ListPatches.java diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/aru/AruPatch.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/aru/AruPatch.java index eaab578d..edb29789 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/aru/AruPatch.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/aru/AruPatch.java @@ -290,7 +290,6 @@ public static AruPatch selectPatch(List patches, String providedVersio } else if (patchMap.containsKey(installerVersion)) { selected = patchMap.get(installerVersion); } - logger.exiting(selected); if (selected == null) { throw logger.throwing(new PatchVersionException(patches.get(0).patchId(), patches)); diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/CacheCLI.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/CacheCLI.java index 52a46a4f..35c9a29a 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/CacheCLI.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/CacheCLI.java @@ -12,7 +12,8 @@ versionProvider = HelpVersionProvider.class, commandListHeading = "%nCommands:%n%n", subcommands = { - ListCacheItems.class, + ListPatches.class, + ListInstallers.class, AddInstallerEntry.class, AddPatchEntry.class }, diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/ListInstallers.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/ListInstallers.java new file mode 100644 index 00000000..fe67dea7 --- /dev/null +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/ListInstallers.java @@ -0,0 +1,55 @@ +// Copyright (c) 2024, 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.cli.cache; + +import java.util.List; +import java.util.Map; + +import com.oracle.weblogic.imagetool.api.model.CommandResponse; +import com.oracle.weblogic.imagetool.cachestore.CacheStoreException; +import com.oracle.weblogic.imagetool.installer.InstallerMetaData; +import com.oracle.weblogic.imagetool.installer.InstallerType; +import com.oracle.weblogic.imagetool.settings.ConfigManager; +import picocli.CommandLine.Command; +import picocli.CommandLine.Option; + + +@Command( + name = "listInstallers", + description = "List installers" +) +public class ListInstallers extends CacheOperation { + + @Override + public CommandResponse call() throws CacheStoreException { + ConfigManager configManager = ConfigManager.getInstance(); + Map>> data = configManager.getInstallers(); + + for (InstallerType itemType : data.keySet()) { + if (type != null && type != itemType) { + continue; + } + System.out.println(itemType + ":"); + data.get(itemType).forEach((installer, metaData) -> { + System.out.println(" " + installer + ":"); + for (InstallerMetaData meta : metaData) { + System.out.println(" - location: " + meta.getLocation()); + System.out.println(" platform: " + meta.getPlatform()); + System.out.println(" digest: " + meta.getDigest()); + System.out.println(" dateAdded: " + meta.getDateAdded()); + System.out.println(" version: " + meta.getProductVersion()); + } + }); + } + + return CommandResponse.success(null); + } + + @Option( + names = {"--type"}, + description = "Filter installer type. e.g. wls, jdk, wdt" + ) + private InstallerType type; + +} diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/ListPatches.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/ListPatches.java new file mode 100644 index 00000000..06143df7 --- /dev/null +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/ListPatches.java @@ -0,0 +1,53 @@ +// Copyright (c) 2024, 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.cli.cache; + +import java.util.List; +import java.util.Map; + +import com.oracle.weblogic.imagetool.api.model.CommandResponse; +import com.oracle.weblogic.imagetool.cachestore.CacheStoreException; +import com.oracle.weblogic.imagetool.patch.PatchMetaData; +import com.oracle.weblogic.imagetool.settings.ConfigManager; +import picocli.CommandLine.Command; +import picocli.CommandLine.Option; + + +@Command( + name = "listPatches", + description = "List patches" +) +public class ListPatches extends CacheOperation { + + @Override + public CommandResponse call() throws CacheStoreException { + + ConfigManager configManager = ConfigManager.getInstance(); + Map> data = configManager.getAllPatches(); + + for (String bug : data.keySet()) { + if (bugNumber != null && !bugNumber.equalsIgnoreCase(bug)) { + continue; + } + System.out.println(bug + ":"); + data.get(bug).forEach((metaData) -> { + System.out.println(" - location: " + metaData.getLocation()); + System.out.println(" platform: " + metaData.getPlatform()); + System.out.println(" digest: " + metaData.getHash()); + System.out.println(" dateAdded: " + metaData.getDateAdded()); + System.out.println(" version: " + metaData.getPatchVersion()); + }); + } + + return CommandResponse.success(null); + + } + + @Option( + names = {"--bug"}, + description = "Bug number" + ) + private String bugNumber; + +} diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonPatchingOptions.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonPatchingOptions.java index 94acc4cb..6d617d9a 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonPatchingOptions.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonPatchingOptions.java @@ -285,6 +285,8 @@ List resolveUserRequestedPatches(String psuVersion) effectivePsuVersion = psuVersionOfSelected; } result.add(selectedVersion); + } else { + logger.warning("IMG-0123", patchId, buildPlatform); } } diff --git a/imagetool/src/main/resources/ImageTool.properties b/imagetool/src/main/resources/ImageTool.properties index f7cbd88a..3e2f4a42 100644 --- a/imagetool/src/main/resources/ImageTool.properties +++ b/imagetool/src/main/resources/ImageTool.properties @@ -121,3 +121,4 @@ IMG-0119=All parameters and options provided after the -- will be passed to the IMG-0120=Retries exhausted, unable to download patch from Oracle. Try again later or manually add the patch to the cache to skip this download step. IMG-0121=Did not recognize architecture name {0}. Defaulted to AMD64. IMG-0122=Invalid patch {0} for version {1}. A patch cannot be both generic and architecture specific. Remove the invalid entry from the cache, like {0}_{1}_xxx64. +IMG-0123=Cannot find the patch {0} for platform {1}, no patch for this platform will be applied. diff --git a/imagetool/src/main/resources/docker-files/fmw-patching.mustache b/imagetool/src/main/resources/docker-files/fmw-patching.mustache index 97629eaa..204e08ad 100644 --- a/imagetool/src/main/resources/docker-files/fmw-patching.mustache +++ b/imagetool/src/main/resources/docker-files/fmw-patching.mustache @@ -17,15 +17,19 @@ {{^strictPatchOrdering}} # Apply all patches provided at the same time - RUN {{{oracle_home}}}/OPatch/opatch napply -silent -oh {{{oracle_home}}} -nonrollbackable -phBaseDir {{{tempDir}}}/patches/$TARGETPLATFORM \ + RUN if [ "$(ls -A {{{tempDir}}}/patches/$TARGETPLATFORM)" ] ; then \ + && {{{oracle_home}}}/OPatch/opatch napply -silent -oh {{{oracle_home}}} -nonrollbackable -phBaseDir {{{tempDir}}}/patches/$TARGETPLATFORM \ && test $? -eq 0 \ && {{{oracle_home}}}/OPatch/opatch util cleanup -silent -oh {{{oracle_home}}} \ - || (cat {{{oracle_home}}}/cfgtoollogs/opatch/opatch*.log && exit 1) + || (cat {{{oracle_home}}}/cfgtoollogs/opatch/opatch*.log && exit 1) \ + && fi {{/strictPatchOrdering}} {{#strictPatchOrdering}} # Apply one patch at a time in the order they were specified {{#patches}} - RUN {{{oracle_home}}}/OPatch/opatch apply -silent -oh {{{oracle_home}}} -nonrollbackable {{{tempDir}}}/patches/{{{.}}} + RUN if [ "$(ls -A {{{tempDir}}}/patches/$TARGETPLATFORM)" ] ; then \ + && {{{oracle_home}}}/OPatch/opatch apply -silent -oh {{{oracle_home}}} -nonrollbackable {{{tempDir}}}/$TARGETPLATFORMpatches/$TARGETPLATFORM/{{{.}}} \ + && fi {{/patches}} RUN {{{oracle_home}}}/OPatch/opatch util cleanup -silent -oh {{{oracle_home}}} {{/strictPatchOrdering}} From ca36b5db3a977d618e84ef03149065f014480e86 Mon Sep 17 00:00:00 2001 From: jshum Date: Wed, 6 Nov 2024 14:54:22 -0600 Subject: [PATCH 039/104] Added delete patch and installer --- .../imagetool/cli/cache/CacheCLI.java | 4 +- .../imagetool/cli/cache/DeleteInstaller.java | 91 +++++++++++++++++++ .../imagetool/cli/cache/DeletePatch.java | 77 ++++++++++++++++ .../src/main/resources/ImageTool.properties | 4 + 4 files changed, 175 insertions(+), 1 deletion(-) create mode 100644 imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/DeleteInstaller.java create mode 100644 imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/DeletePatch.java diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/CacheCLI.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/CacheCLI.java index 35c9a29a..20bd5540 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/CacheCLI.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/CacheCLI.java @@ -15,7 +15,9 @@ ListPatches.class, ListInstallers.class, AddInstallerEntry.class, - AddPatchEntry.class + AddPatchEntry.class, + DeleteInstaller.class, + DeletePatch.class }, sortOptions = false ) diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/DeleteInstaller.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/DeleteInstaller.java new file mode 100644 index 00000000..5fe7f984 --- /dev/null +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/DeleteInstaller.java @@ -0,0 +1,91 @@ +// Copyright (c) 2024, 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.cli.cache; + +import java.io.IOException; +import java.util.List; +import java.util.Map; +import java.util.Optional; + +import com.oracle.weblogic.imagetool.api.model.CommandResponse; +import com.oracle.weblogic.imagetool.cachestore.CacheStoreException; +import com.oracle.weblogic.imagetool.installer.InstallerMetaData; +import com.oracle.weblogic.imagetool.installer.InstallerType; +import com.oracle.weblogic.imagetool.settings.ConfigManager; +import picocli.CommandLine.Command; +import picocli.CommandLine.Option; + + +@Command( + name = "deleteInstaller", + description = "Delete a installer" +) +public class DeleteInstaller extends CacheOperation { + + @Override + public CommandResponse call() throws CacheStoreException { + ConfigManager configManager = ConfigManager.getInstance(); + Map>> data = configManager.getInstallers(); + if (type == null || version == null || architecture == null) { + return CommandResponse.success("IMG-0124"); + } + boolean exists = false; + for (InstallerType itemType : data.keySet()) { + if (type != null && type != itemType) { + continue; + } + Map> items = data.get(itemType); + String search; + if (commonName == null) { + search = version; + } else { + search = commonName; + } + exists = Optional.ofNullable(items.get(search)) + .map(list -> list.stream().anyMatch(i -> i.getPlatform().equalsIgnoreCase(architecture) + && i.getProductVersion().equalsIgnoreCase(version))) + .orElse(false); + if (exists) { + Optional.ofNullable(items.get(search)) + .map(list -> list.removeIf(i -> i.getPlatform().equalsIgnoreCase(architecture) + && i.getProductVersion().equalsIgnoreCase(version))); + break; + } + } + if (!exists) { + return CommandResponse.success("IMG-0125"); + } + try { + configManager.saveAllInstallers(data, ConfigManager.getInstance().getInstallerDetailsFile()); + } catch (IOException e) { + throw new CacheStoreException(e.getMessage(), e); + } + return CommandResponse.success(null); + } + + @Option( + names = {"--type"}, + description = "Filter installer type. e.g. wls, jdk, wdt" + ) + private InstallerType type; + + @Option( + names = {"--cn"}, + description = "Filter installer type. e.g. wls, jdk, wdt" + ) + private String commonName; + + @Option( + names = {"--version"}, + description = "Specific version to delete" + ) + private String version; + + @Option( + names = {"--architecture"}, + description = "Specific architecture to delete" + ) + private String architecture; + +} diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/DeletePatch.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/DeletePatch.java new file mode 100644 index 00000000..83119e1d --- /dev/null +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/DeletePatch.java @@ -0,0 +1,77 @@ +// Copyright (c) 2024, 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.cli.cache; + +import java.io.IOException; +import java.util.List; +import java.util.Map; +import java.util.Optional; + +import com.oracle.weblogic.imagetool.api.model.CommandResponse; +import com.oracle.weblogic.imagetool.cachestore.CacheStoreException; +import com.oracle.weblogic.imagetool.patch.PatchMetaData; +import com.oracle.weblogic.imagetool.settings.ConfigManager; +import picocli.CommandLine.Command; +import picocli.CommandLine.Option; + + +@Command( + name = "deletePatch", + description = "Delete a patch" +) +public class DeletePatch extends CacheOperation { + + @Override + public CommandResponse call() throws CacheStoreException { + ConfigManager configManager = ConfigManager.getInstance(); + Map> data = configManager.getAllPatches(); + if (patchId == null || version == null || architecture == null) { + return CommandResponse.success("IMG-0126"); + } + boolean exists = false; + for (String id : data.keySet()) { + if (patchId != null && !patchId.equalsIgnoreCase(id)) { + continue; + } + List items = data.get(id); + exists = Optional.ofNullable(items) + .map(list -> list.stream().anyMatch(i -> i.getPatchVersion().equals(version) + && i.getPlatform().equalsIgnoreCase(architecture))).orElse(false); + if (exists) { + Optional.ofNullable(items) + .map(list -> list.removeIf(i -> i.getPatchVersion().equals(version) + && i.getPlatform().equalsIgnoreCase(architecture))); + break; + } + } + if (!exists) { + return CommandResponse.success("IMG-0127"); + } + try { + configManager.saveAllPatches(data, ConfigManager.getInstance().getPatchDetailsFile()); + } catch (IOException e) { + throw new CacheStoreException(e.getMessage(), e); + } + return CommandResponse.success(null); + } + + @Option( + names = {"--patchId"}, + description = "Bug num" + ) + private String patchId; + + @Option( + names = {"--version"}, + description = "Specific version to delete" + ) + private String version; + + @Option( + names = {"--architecture"}, + description = "Specific architecture to delete" + ) + private String architecture; + +} diff --git a/imagetool/src/main/resources/ImageTool.properties b/imagetool/src/main/resources/ImageTool.properties index 3e2f4a42..1fadf3f8 100644 --- a/imagetool/src/main/resources/ImageTool.properties +++ b/imagetool/src/main/resources/ImageTool.properties @@ -122,3 +122,7 @@ IMG-0120=Retries exhausted, unable to download patch from Oracle. Try again lat IMG-0121=Did not recognize architecture name {0}. Defaulted to AMD64. IMG-0122=Invalid patch {0} for version {1}. A patch cannot be both generic and architecture specific. Remove the invalid entry from the cache, like {0}_{1}_xxx64. IMG-0123=Cannot find the patch {0} for platform {1}, no patch for this platform will be applied. +IMG-0124=You must specify --type --version and --architecture for deleting an installer. +IMG-0125=Specified installer to delete cannot be found. +IMG-0126=You must specify --patchId --version and --architecture for deleting a patchr. +IMG-0127=Specified installer to delete cannot be found. From 0e0462593d196971d776c2c03656ceb23c90707c Mon Sep 17 00:00:00 2001 From: jshum Date: Tue, 12 Nov 2024 15:22:08 -0600 Subject: [PATCH 040/104] code fixes for separator for patchid --- .../weblogic/imagetool/api/model/CachedFile.java | 4 ++++ .../weblogic/imagetool/cachestore/OPatchFile.java | 6 ++++++ .../imagetool/cli/menu/CommonPatchingOptions.java | 5 +---- .../com/oracle/weblogic/imagetool/util/Utils.java | 9 +++++++++ .../imagetool/cachestore/CachedFileTest.java | 14 +++++--------- 5 files changed, 25 insertions(+), 13 deletions(-) diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/api/model/CachedFile.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/api/model/CachedFile.java index 7c797b03..dd277cd1 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/api/model/CachedFile.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/api/model/CachedFile.java @@ -109,6 +109,10 @@ public String resolve() throws IOException { metaData = ConfigManager.getInstance() .getInstallerForPlatform(installerType, Architecture.getLocalArchitecture(), getVersion()); } + if (metaData == null) { + metaData = ConfigManager.getInstance() + .getInstallerForPlatform(installerType, Architecture.GENERIC, getVersion()); + } if (metaData != null) { filePath = metaData.getLocation(); diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cachestore/OPatchFile.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cachestore/OPatchFile.java index 193e4e0c..c35d302c 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cachestore/OPatchFile.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cachestore/OPatchFile.java @@ -45,6 +45,12 @@ public static OPatchFile getInstance(String patchId, String providedVersion, Str if (patchId == null) { // if the user did not provide a patch number, assume the default OPatch bug number patchNumber = DEFAULT_BUG_NUM; + } else if (patchId.contains(CacheStore.CACHE_KEY_SEPARATOR)) { + // if the user provides a specific version, use that version or fail. like 28186730_13.9.4.2.4 + int separator = patchId.indexOf(CacheStore.CACHE_KEY_SEPARATOR); + patchNumber = patchId.substring(0, separator); + providedVersion = patchId.substring(separator + 1); + logger.fine("User provided OPatch version {0} {1}", patchNumber, providedVersion); } AruPatch selectedPatch; diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonPatchingOptions.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonPatchingOptions.java index 6d617d9a..cb098dde 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonPatchingOptions.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonPatchingOptions.java @@ -158,10 +158,6 @@ void handlePatchFiles(List installedPatches) ConfigManager configManager = ConfigManager.getInstance(); for (AruPatch patch : aruPatches) { String platform = patch.platformName(); - // TODO - if (platform == null) { - platform = "generic"; - } PatchMetaData metaData = configManager.getPatchForPlatform(platform, patch.patchId(), patch.version()); if (metaData == null) { @@ -453,4 +449,5 @@ String getPassword() { description = "Installer type. Default: WLS. Supported values: ${COMPLETION-CANDIDATES}" ) private FmwInstallerType installerType = FmwInstallerType.WLS; + } diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/util/Utils.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/util/Utils.java index 7614eefa..36f6bde2 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/util/Utils.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/util/Utils.java @@ -609,6 +609,15 @@ private static void validatePatchIds(List patches, Pattern pattern, */ public static void validatePatchIds(@NotNull List patches, boolean allowSimpleId) throws InvalidPatchIdFormatException { + if (allowSimpleId) { + validatePatchIds(patches, + Pattern.compile("^(\\d{8,9})(?:_\\d\\d(?:\\.\\d){3,8}\\.(\\d+)(_.*)?)?"), + "12345678[_12.2.1.3.0[_arm64]]"); + } else { + validatePatchIds(patches, + Pattern.compile("^(\\d{8,9})_\\d\\d(?:\\.\\d){3,8}\\.(\\d+)(_.*)?"), + "12345678_12.2.1.3.0[_arm64]"); + } } /** diff --git a/imagetool/src/test/java/com/oracle/weblogic/imagetool/cachestore/CachedFileTest.java b/imagetool/src/test/java/com/oracle/weblogic/imagetool/cachestore/CachedFileTest.java index 303ef827..0e11a2f7 100644 --- a/imagetool/src/test/java/com/oracle/weblogic/imagetool/cachestore/CachedFileTest.java +++ b/imagetool/src/test/java/com/oracle/weblogic/imagetool/cachestore/CachedFileTest.java @@ -85,13 +85,6 @@ static void setup(@TempDir Path tempDir, @TempDir Path cacheDir) throws IOExcept configManager.addInstaller(InstallerType.WLS, "14.1.1.0.0", installer3); configManager.addInstaller(InstallerType.WLS, "14.1.1.0.0", installer4); - //CachedFileTest.cacheDir = cacheDir; - //cacheStore = new CacheStoreTestImpl(cacheDir); - //// build a fake cache with several installers - //cacheStore.addToCache("wls_" + VER_12213, path12213.toString()); - //cacheStore.addToCache("wls_12.2.1.4.0_" + Architecture.getLocalArchitecture(), path12214.toString()); - //cacheStore.addToCache("wls_14.1.1.0.0_amd64", path1411.toString()); - //cacheStore.addToCache("wls_14.1.1.0.0_linux/arm64", path1411.toString()); addPatchesToLocal(tempDir, configManager, patchFile, DEFAULT_BUG_NUM, "Generic", "patch1.zip", "13.9.2.0.0"); addPatchesToLocal(tempDir, configManager, patchFile, DEFAULT_BUG_NUM, @@ -162,14 +155,17 @@ void resolveFileFindsFile() throws IOException { @Test void resolveNoArchFile() throws IOException { // Look for a cache entry where the user specified the architecture/platform amd64 - CachedFile wlsNoArch = new CachedFile(InstallerType.WLS, VER_12213, Architecture.fromString("amd64")); + CachedFile wlsNoArch = new CachedFile(InstallerType.WLS, VER_12213, Architecture.getLocalArchitecture()); InstallerMetaData metaData = ConfigManager.getInstance().getInstallerForPlatform(InstallerType.WLS, Architecture.AMD64, VER_12213); // verify the cache is setup as expected. // wls_12.2.1.3.0 is in the cache, but wls_12.2.1.3.0_amd64 is NOT in the cache assertNull(metaData); - + metaData = ConfigManager.getInstance().getInstallerForPlatform(InstallerType.WLS, + Architecture.GENERIC, VER_12213); + String expected = metaData.getLocation(); + assertEquals(expected, wlsNoArch.resolve(), "CachedFile returned wrong file"); } @Test From f46341627317dea9ad776e8b1ee03443e7c59882 Mon Sep 17 00:00:00 2001 From: jshum Date: Mon, 18 Nov 2024 10:20:02 -0600 Subject: [PATCH 041/104] Fix unit test --- .../imagetool/api/model/CachedFile.java | 4 +- .../imagetool/cachestore/OPatchFile.java | 10 ++- .../cli/config/ConfigAttributeName.java | 33 ++++++++ .../cli/menu/CommonCreateOptions.java | 3 +- .../imagetool/cli/menu/WdtBaseOptions.java | 3 +- .../installer/MiddlewareInstall.java | 14 +++- .../imagetool/settings/ConfigManager.java | 5 +- .../imagetool/settings/UserSettingsFile.java | 20 ++++- .../imagetool/util/CacheConversion.java | 75 +++++++++++++++++++ .../src/main/resources/ImageTool.properties | 1 + .../imagetool/cachestore/CachedFileTest.java | 2 +- .../imagetool/cachestore/OPatchFileTest.java | 54 ++++++++++++- .../imagetool/cli/cache/AddEntryTest.java | 62 --------------- .../cli/cache/AddInstallerEntryTest.java | 4 +- .../cli/cache/AddPatchEntryTest.java | 4 +- .../installer/MiddlewareInstallTest.java | 36 +++++++-- .../imagetool/settings/UserSettingsTest.java | 8 +- .../imagetool/util/DockerfileBuilderTest.java | 39 +++++++++- .../resources/settings/basic_settings.yaml | 2 +- 19 files changed, 276 insertions(+), 103 deletions(-) create mode 100644 imagetool/src/main/java/com/oracle/weblogic/imagetool/util/CacheConversion.java delete mode 100644 imagetool/src/test/java/com/oracle/weblogic/imagetool/cli/cache/AddEntryTest.java diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/api/model/CachedFile.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/api/model/CachedFile.java index dd277cd1..33893174 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/api/model/CachedFile.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/api/model/CachedFile.java @@ -10,7 +10,6 @@ import java.nio.file.Path; import java.nio.file.Paths; -import com.oracle.weblogic.imagetool.cachestore.CacheStore; import com.oracle.weblogic.imagetool.installer.InstallerMetaData; import com.oracle.weblogic.imagetool.installer.InstallerType; import com.oracle.weblogic.imagetool.logging.LoggingFacade; @@ -128,11 +127,10 @@ public String resolve() throws IOException { /** * Copy file from cacheStore to Docker build context directory. - * @param cacheStore cache to copy file from * @param buildContextDir directory to copy file to * @return the path of the file copied to the Docker build context directory */ - public Path copyFile(CacheStore cacheStore, String buildContextDir) throws IOException { + public Path copyFile(String buildContextDir) throws IOException { logger.entering(installerType, version, architecture, buildContextDir); Path result; String sourceFile = resolve(); diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cachestore/OPatchFile.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cachestore/OPatchFile.java index c35d302c..82f1ce37 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cachestore/OPatchFile.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cachestore/OPatchFile.java @@ -8,6 +8,7 @@ import java.util.Comparator; import java.util.List; import java.util.Map; +import java.util.Optional; import java.util.stream.Collectors; import javax.xml.xpath.XPathExpressionException; @@ -62,7 +63,14 @@ public static OPatchFile getInstance(String patchId, String providedVersion, Str } catch (VersionNotFoundException notFound) { // Could not find the user requested OPatch version on ARU, checking local cache before giving up Map> patchSettings = ConfigManager.getInstance().getAllPatches(); - if (patchSettings.containsKey(patchId)) { + final String searchVersion = providedVersion; + Optional p = patchSettings.entrySet().stream() + .filter(e -> e.getValue().stream() + .anyMatch(m -> m.getPatchVersion().equalsIgnoreCase(searchVersion))) + .map(Map.Entry::getKey) + .findFirst(); + + if (p.isPresent()) { logger.info("OPatch version {0} is not available online, using cached copy.", providedVersion); selectedPatch = new AruPatch().patchId(patchNumber).version(providedVersion); } else { diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/config/ConfigAttributeName.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/config/ConfigAttributeName.java index e51ba246..96d1d8b4 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/config/ConfigAttributeName.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/config/ConfigAttributeName.java @@ -73,6 +73,39 @@ public String get(UserSettingsFile settings) { return settings.getAruRetryMax().toString(); } }, + defaultBuildPlatform("DefaultBuildPlatform") { + @Override + public void set(UserSettingsFile settings, String value) { + settings.setDefaultBuildPlatform(value); + } + + @Override + public String get(UserSettingsFile settings) { + return settings.getDefaultBuildPlatform(); + } + }, + installerSettingsFile("InstallerSettingsFile") { + @Override + public void set(UserSettingsFile settings, String value) { + settings.setInstallerDetailsFile(value); + } + + @Override + public String get(UserSettingsFile settings) { + return settings.getInstallerDetailsFile(); + } + }, + patchSettingsFile("PatchSettingsFile") { + @Override + public void set(UserSettingsFile settings, String value) { + settings.setPatchDetailsFile(value); + } + + @Override + public String get(UserSettingsFile settings) { + return settings.getPatchDetailsFile(); + } + }, aruRetryInterval("AruRetryInterval") { @Override public void set(UserSettingsFile settings, String value) { diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonCreateOptions.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonCreateOptions.java index ae69c2a0..96c6f10f 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonCreateOptions.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonCreateOptions.java @@ -26,7 +26,6 @@ import com.oracle.weblogic.imagetool.util.Utils; import picocli.CommandLine.Option; -import static com.oracle.weblogic.imagetool.cachestore.CacheStoreFactory.cache; import static com.oracle.weblogic.imagetool.util.Constants.AMD64_BLD; import static com.oracle.weblogic.imagetool.util.Constants.ARM64_BLD; import static com.oracle.weblogic.imagetool.util.Constants.CTX_JDK; @@ -76,7 +75,7 @@ void prepareNewImage() throws IOException, InterruptedException, XPathExpression if (dockerfileOptions.installMiddleware()) { MiddlewareInstall install = new MiddlewareInstall(getInstallerType(), installerVersion, installerResponseFiles, buildPlatforms); - install.copyFiles(cache(), buildDir()); + install.copyFiles(buildDir()); dockerfileOptions.setMiddlewareInstall(install); } else { dockerfileOptions.setWdtBase("os_update"); diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/WdtBaseOptions.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/WdtBaseOptions.java index e0aaf2bf..cfe54c7d 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/WdtBaseOptions.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/WdtBaseOptions.java @@ -19,7 +19,6 @@ import com.oracle.weblogic.imagetool.util.Utils; import picocli.CommandLine.Option; -import static com.oracle.weblogic.imagetool.cachestore.CacheStoreFactory.cache; public class WdtBaseOptions { @@ -85,7 +84,7 @@ public void handleWdtArgs(DockerfileOptions dockerfileOptions, String tmpDir) th if (!skipWdtInstaller()) { CachedFile wdtInstaller = new CachedFile(InstallerType.WDT, wdtVersion); - Path wdtfile = wdtInstaller.copyFile(cache(), tmpDir); + Path wdtfile = wdtInstaller.copyFile(tmpDir); dockerfileOptions.setWdtInstallerFilename(wdtfile.getFileName().toString()); } logger.exiting(); diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/installer/MiddlewareInstall.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/installer/MiddlewareInstall.java index b2a0f62a..94699322 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/installer/MiddlewareInstall.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/installer/MiddlewareInstall.java @@ -16,7 +16,6 @@ import java.util.zip.ZipFile; import com.oracle.weblogic.imagetool.api.model.CachedFile; -import com.oracle.weblogic.imagetool.cachestore.CacheStore; import com.oracle.weblogic.imagetool.logging.LoggingFacade; import com.oracle.weblogic.imagetool.logging.LoggingFactory; import com.oracle.weblogic.imagetool.settings.ConfigManager; @@ -44,6 +43,16 @@ public MiddlewareInstall(FmwInstallerType type, String version, List respo logger.info("IMG-0039", type.installerListString(), version); fmwInstallerType = type; ConfigManager configManager = ConfigManager.getInstance(); + if (buildPlatform == null) { + buildPlatform = new ArrayList<>(); + } + if (buildPlatform.isEmpty()) { + if (configManager.getDefaultBuildPlatform() != null) { + buildPlatform.add(configManager.getDefaultBuildPlatform()); + } else { + buildPlatform.add(Architecture.getLocalArchitecture().name()); + } + } for (InstallerType installerType : type.installerList()) { for (String platform : buildPlatform) { MiddlewareInstallPackage pkg = new MiddlewareInstallPackage(); @@ -95,11 +104,10 @@ private static String getJarNameFromInstaller(Path installerFile) throws IOExcep /** * Copy all necessary installers to the build context directory. - * @param cacheStore cache where the installers are defined. * @param buildContextDir the directory where the installers should be copied. * @throws IOException if any of the copy commands fails. */ - public void copyFiles(CacheStore cacheStore, String buildContextDir) throws IOException { + public void copyFiles(String buildContextDir) throws IOException { logger.entering(); for (MiddlewareInstallPackage installPackage: installerFiles) { diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/ConfigManager.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/ConfigManager.java index cc6750b6..3db88602 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/ConfigManager.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/ConfigManager.java @@ -51,9 +51,8 @@ public static synchronized ConfigManager getInstance() { * @return ConfigManager instance */ public static synchronized ConfigManager getInstance(Path fileName) { - if (instance == null) { - instance = new ConfigManager(fileName); - } + // Always reload with file provided + instance = new ConfigManager(fileName); return instance; } diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/UserSettingsFile.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/UserSettingsFile.java index 1b28c745..5adb92b6 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/UserSettingsFile.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/UserSettingsFile.java @@ -79,10 +79,6 @@ public class UserSettingsFile { private String defaultBuildPlatform = null; - public String getPatchDetailsFile() { - return patchDetailsFile; - } - /** * DLoads the settings.yaml file from ~/.imagetool/settings.yaml and applies the values found. */ @@ -236,6 +232,14 @@ public void setAruRetryInterval(Integer value) { aruRetryInterval = value; } + public String getPatchDetailsFile() { + return patchDetailsFile; + } + + public void setPatchDetailsFile(String value) { + patchDetailsFile = value; + } + /** * The user settings for installer type. * @param installerType Installer type such as JDK, WLS, SOA, etc. @@ -636,10 +640,18 @@ public String getInstallerDetailsFile() { return installerDetailsFile; } + public String setInstallerDetailsFile(String value) { + return installerDetailsFile = value; + } + public String getDefaultBuildPlatform() { return defaultBuildPlatform; } + public String setDefaultBuildPlatform(String value) { + return defaultBuildPlatform = value; + } + @Override public String toString() { return "UserSettingsFile{" diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/util/CacheConversion.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/util/CacheConversion.java new file mode 100644 index 00000000..8c0bcc31 --- /dev/null +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/util/CacheConversion.java @@ -0,0 +1,75 @@ +// Copyright (c) 2021, 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.util; + +import java.io.BufferedReader; +import java.io.FileReader; +import java.io.IOException; +import java.util.regex.Matcher; +import java.util.regex.Pattern; + +import com.oracle.weblogic.imagetool.cachestore.OPatchFile; +import com.oracle.weblogic.imagetool.logging.LoggingFacade; +import com.oracle.weblogic.imagetool.logging.LoggingFactory; + +/** + * Utility to convert image tool 1.x cache store to 2.0 format + */ +public class CacheConversion { + + private static final LoggingFacade logger = LoggingFactory.getLogger(OPatchFile.class); + + private static final String PATCH_PATTERN = "^(wls|fmw|ohs|wlsdev|wlsslim|soa|osb|b2b|mft|idm|db19|" + + "oud|oid|wcc|wcp|wcs|jdk|wdt|odi|\\d{8,9})(?:_(\\d\\d(?:\\.\\d){3,8}\\.\\d+)(?:_(.*))?)?=(.*)$"; + private static final String INSTALLER_PATTERN = "^(wls|fmw|ohs|wlsdev|wlsslim|soa|osb|b2b|mft|idm|db19|" + + "oud|oid|wcc|wcp|wcs|jdk|wdt|odi)_(.*?)(?:_(.*))?=(.*)$"; + + /** + * convert cache file to nee format. + * @param inputFile input cache file + * @param outputDir output directory + * @throws IOException when error + */ + public void convert(String inputFile, String outputDir) throws IOException { + Pattern patchPattern = Pattern.compile(PATCH_PATTERN); + Pattern installerPattern = Pattern.compile(INSTALLER_PATTERN); + try (BufferedReader br = new BufferedReader(new FileReader(inputFile))) { + String line; + while ((line = br.readLine()) != null) { + if (line.charAt(0) == '#') { + continue; + } + if (Character.isDigit(line.charAt(0))) { + Matcher matcher = patchPattern.matcher(line); + if (matcher.matches()) { + String key = matcher.group(1); + String version = matcher.group(2); + String arch = matcher.group(3); + String filepath = matcher.group(4); + // TODO + } else { + logger.warning("IMG-0128", line); + } + } else { + Matcher matcher = installerPattern.matcher(line); + if (matcher.matches()) { + String key = matcher.group(1); + String version = matcher.group(2); + String arch = matcher.group(3); + String filepath = matcher.group(4); + // TODO + } else { + logger.warning("IMG-0128", line); + } + + } + } + } + } + + public static void main(String[] args) throws IOException { + CacheConversion cacheConversion = new CacheConversion(); + cacheConversion.convert("/Users/JSHUM/dimtemp23/cache/.metadata", ""); + } +} diff --git a/imagetool/src/main/resources/ImageTool.properties b/imagetool/src/main/resources/ImageTool.properties index 1fadf3f8..bbb81e2f 100644 --- a/imagetool/src/main/resources/ImageTool.properties +++ b/imagetool/src/main/resources/ImageTool.properties @@ -126,3 +126,4 @@ IMG-0124=You must specify --type --version and --architecture for deleting an in IMG-0125=Specified installer to delete cannot be found. IMG-0126=You must specify --patchId --version and --architecture for deleting a patchr. IMG-0127=Specified installer to delete cannot be found. +IMG-0128=Cannot parse version 1 metadata file line: {0}. diff --git a/imagetool/src/test/java/com/oracle/weblogic/imagetool/cachestore/CachedFileTest.java b/imagetool/src/test/java/com/oracle/weblogic/imagetool/cachestore/CachedFileTest.java index 0e11a2f7..5503d885 100644 --- a/imagetool/src/test/java/com/oracle/weblogic/imagetool/cachestore/CachedFileTest.java +++ b/imagetool/src/test/java/com/oracle/weblogic/imagetool/cachestore/CachedFileTest.java @@ -204,7 +204,7 @@ void resolveFallbackToLocalArch() throws IOException { void copyFile(@TempDir Path contextDir) throws Exception { CachedFile wlsInstallerFile = new CachedFile(InstallerType.WLS, VER_12213); // copy the file from the cache store to the fake build context directory - Path result = wlsInstallerFile.copyFile(cacheStore, contextDir.toString()); + Path result = wlsInstallerFile.copyFile(contextDir.toString()); // check to see if the file was copied correctly by examining the contents of the resulting file assertLinesMatch(fileContents, Files.readAllLines(result), "copied file contents do not match source"); diff --git a/imagetool/src/test/java/com/oracle/weblogic/imagetool/cachestore/OPatchFileTest.java b/imagetool/src/test/java/com/oracle/weblogic/imagetool/cachestore/OPatchFileTest.java index 8b1e35e0..7ef7ae76 100644 --- a/imagetool/src/test/java/com/oracle/weblogic/imagetool/cachestore/OPatchFileTest.java +++ b/imagetool/src/test/java/com/oracle/weblogic/imagetool/cachestore/OPatchFileTest.java @@ -6,13 +6,19 @@ import java.io.IOException; import java.nio.file.Files; import java.nio.file.Path; +import java.util.ArrayList; import java.util.Arrays; +import java.util.List; +import java.util.Map; import javax.xml.xpath.XPathExpressionException; import com.oracle.weblogic.imagetool.aru.AruException; import com.oracle.weblogic.imagetool.aru.MockAruUtil; import com.oracle.weblogic.imagetool.cli.menu.CommonOptions; +import com.oracle.weblogic.imagetool.patch.PatchMetaData; +import com.oracle.weblogic.imagetool.settings.ConfigManager; import com.oracle.weblogic.imagetool.test.annotations.ReduceTestLogging; +import com.oracle.weblogic.imagetool.util.Utils; import org.junit.jupiter.api.AfterAll; import org.junit.jupiter.api.BeforeAll; import org.junit.jupiter.api.Tag; @@ -28,6 +34,7 @@ @Tag("unit") class OPatchFileTest { private static CacheStore cacheStore; + static final List fileContents = Arrays.asList("A", "B", "C"); @BeforeAll static void setup(@TempDir Path tempDir, @TempDir Path cacheDir) @@ -37,10 +44,49 @@ static void setup(@TempDir Path tempDir, @TempDir Path cacheDir) MockAruUtil.insertMockAruInstance(new MockAruUtil()); // Create a fake cache with a fake OPatch install - cacheStore = new CacheStoreTestImpl(cacheDir); - Path installer = tempDir.resolve("opatch_install.zip"); - Files.write(installer, Arrays.asList("A", "B", "C")); - cacheStore.addToCache("28186730_13.9.4.2.10", installer.toString()); + //cacheStore = new CacheStoreTestImpl(cacheDir); + //Path installer = tempDir.resolve("opatch_install.zip"); + //Files.write(installer, Arrays.asList("A", "B", "C")); + //cacheStore.addToCache("28186730_13.9.4.2.10", installer.toString()); + + + Path settingsFileName = tempDir.resolve("settings.yaml"); + Path installerFile = tempDir.resolve("installers.yaml"); + Path patchFile = tempDir.resolve("patches.yaml"); + Files.createFile(settingsFileName); + Files.createFile(installerFile); + Files.createFile(patchFile); + + + List lines = Arrays.asList( + "installerSettingsFile: " + installerFile.toAbsolutePath().toString(), + "patchSettingsFile: " + patchFile.toAbsolutePath().toString(), + "installerDirectory: " + tempDir.toAbsolutePath().toString(), + "patchDirectory: " + tempDir.toAbsolutePath().toString() + ); + Files.write(settingsFileName, lines); + ConfigManager configManager = ConfigManager.getInstance(settingsFileName); + + addPatchesToLocal(tempDir, configManager, patchFile, "28186730", + "Generic", "patch1.zip","13.9.4.2.10"); + + } + + private static void addPatchesToLocal(Path tempDir, ConfigManager configManager, Path patchListingFile, + String bugNumber, String patchArchitecture, String patchLocation, + String patchVersion) throws IOException { + Map> patches = configManager.getAllPatches(); + List latestPatches = patches.get(bugNumber); + if (latestPatches == null) { + latestPatches = new ArrayList<>(); + } + Path path = tempDir.resolve(patchLocation); + Files.write(path, fileContents); + PatchMetaData latestPatch = new PatchMetaData(patchArchitecture, path.toAbsolutePath().toString(), + Utils.getSha256Hash(path.toAbsolutePath().toString()),"2024-10-17", patchVersion); + latestPatches.add(latestPatch); + patches.put(bugNumber, latestPatches); + configManager.saveAllPatches(patches, patchListingFile.toAbsolutePath().toString()); } @AfterAll diff --git a/imagetool/src/test/java/com/oracle/weblogic/imagetool/cli/cache/AddEntryTest.java b/imagetool/src/test/java/com/oracle/weblogic/imagetool/cli/cache/AddEntryTest.java deleted file mode 100644 index 0d70615a..00000000 --- a/imagetool/src/test/java/com/oracle/weblogic/imagetool/cli/cache/AddEntryTest.java +++ /dev/null @@ -1,62 +0,0 @@ -// Copyright (c) 2019, 2021, 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.cli.cache; - -import java.io.ByteArrayOutputStream; -import java.io.PrintWriter; - -import com.oracle.weblogic.imagetool.api.model.CommandResponse; -import com.oracle.weblogic.imagetool.cli.ImageTool; -import org.junit.jupiter.api.AfterEach; -import org.junit.jupiter.api.BeforeEach; -import org.junit.jupiter.api.Tag; -import org.junit.jupiter.api.Test; - -import static org.junit.jupiter.api.Assertions.assertEquals; -import static org.junit.jupiter.api.Assertions.assertTrue; - -@Tag("unit") -class AddEntryTest { - - private ByteArrayOutputStream byteArrayOutputStream = null; - private PrintWriter printStream = null; - - @BeforeEach - void setup() { - byteArrayOutputStream = new ByteArrayOutputStream(); - printStream = new PrintWriter(byteArrayOutputStream); - } - - @AfterEach - void teardown() { - if (printStream != null) { - printStream.close(); - } - } - - @Test - void testMissingParameters() { - ImageTool.run(new AddEntry(), printStream, printStream); - assertTrue(new String(byteArrayOutputStream.toByteArray()).contains("Missing required options")); - } - - @Test - void testMissingKey() { - ImageTool.run(new AddEntry(), printStream, printStream, "--value", "some_value"); - assertTrue(new String(byteArrayOutputStream.toByteArray()).contains("Missing required option: '--key='")); - } - - @Test - void testMissingValue() { - ImageTool.run(new AddEntry(), printStream, printStream, "--key", "some_key"); - assertTrue(new String(byteArrayOutputStream.toByteArray()) - .contains("Missing required option: '--value='")); - } - - @Test - void testInvalidParameters() { - CommandResponse response = ImageTool.run(new AddEntry(), printStream, printStream, "--key", "", "--value", ""); - assertEquals(1, response.getStatus()); - } -} diff --git a/imagetool/src/test/java/com/oracle/weblogic/imagetool/cli/cache/AddInstallerEntryTest.java b/imagetool/src/test/java/com/oracle/weblogic/imagetool/cli/cache/AddInstallerEntryTest.java index ff9d21f2..ca161aef 100644 --- a/imagetool/src/test/java/com/oracle/weblogic/imagetool/cli/cache/AddInstallerEntryTest.java +++ b/imagetool/src/test/java/com/oracle/weblogic/imagetool/cli/cache/AddInstallerEntryTest.java @@ -55,7 +55,7 @@ void testValidParameters() { // The cache key should be a string made up of the type and version seperated by an underscore new CommandLine(addCommand) .parseArgs("--type", "WLS", "--version", "12.2.1.4", "--path", "/path/to/a/file"); - assertEquals("wls_12.2.1.4", addCommand.getKey()); + assertEquals("wls", addCommand.getKey()); } @Test @@ -64,6 +64,6 @@ void testArchKey() { // The cache key should be a string made up of the type, version, and architecture seperated by an underscore new CommandLine(addCommand) .parseArgs("--type", "WLS", "--version", "12.2.1.4", "-a", "amd64", "--path", "/path/to/a/file"); - assertEquals("wls_12.2.1.4_amd64", addCommand.getKey()); + assertEquals("wls", addCommand.getKey()); } } diff --git a/imagetool/src/test/java/com/oracle/weblogic/imagetool/cli/cache/AddPatchEntryTest.java b/imagetool/src/test/java/com/oracle/weblogic/imagetool/cli/cache/AddPatchEntryTest.java index e0538b40..c4d3bd7c 100644 --- a/imagetool/src/test/java/com/oracle/weblogic/imagetool/cli/cache/AddPatchEntryTest.java +++ b/imagetool/src/test/java/com/oracle/weblogic/imagetool/cli/cache/AddPatchEntryTest.java @@ -45,7 +45,7 @@ void testMissingParameters() { void testInvalidFileParameter() { CommandLine cmd = getCommand(); // invalid file (file does not exist), should generate an error response - cmd.execute("--patchId=12345678_12.2.1.3.0", "--path=/here/there"); + cmd.execute("--patchId=12345678_12.2.1.3.0", "--path=/here/there", "--version=12.2.1.3.0"); CommandResponse result = cmd.getExecutionResult(); assertNotNull(result, "Response missing from call to addPatch"); assertEquals(1, result.getStatus()); @@ -55,7 +55,7 @@ void testInvalidFileParameter() { void testInvalidPatchId() { CommandLine cmd = getCommand(); // invalid patch ID should generate an error response - cmd.execute("--patchId=12345678", "--path=pom.xml"); + cmd.execute("--patchId=12345678", "--path=pom.xml", "--version=12.2.1.3.0"); CommandResponse result = cmd.getExecutionResult(); assertNotNull(result, "Response missing from call to addPatch"); assertEquals(1, result.getStatus()); diff --git a/imagetool/src/test/java/com/oracle/weblogic/imagetool/installer/MiddlewareInstallTest.java b/imagetool/src/test/java/com/oracle/weblogic/imagetool/installer/MiddlewareInstallTest.java index 3a1d2837..ad4a79de 100644 --- a/imagetool/src/test/java/com/oracle/weblogic/imagetool/installer/MiddlewareInstallTest.java +++ b/imagetool/src/test/java/com/oracle/weblogic/imagetool/installer/MiddlewareInstallTest.java @@ -6,13 +6,14 @@ import java.io.IOException; import java.nio.file.Files; import java.nio.file.Path; +import java.util.Arrays; import java.util.Collections; import java.util.List; import com.oracle.weblogic.imagetool.ResourceUtils; -import com.oracle.weblogic.imagetool.cachestore.CacheStore; -import com.oracle.weblogic.imagetool.cachestore.CacheStoreTestImpl; +import com.oracle.weblogic.imagetool.settings.ConfigManager; import com.oracle.weblogic.imagetool.test.annotations.ReduceTestLogging; +import com.oracle.weblogic.imagetool.util.Architecture; import org.junit.jupiter.api.BeforeAll; import org.junit.jupiter.api.Tag; import org.junit.jupiter.api.Test; @@ -26,21 +27,40 @@ @ReduceTestLogging(loggerClass = MiddlewareInstall.class) class MiddlewareInstallTest { static Path cacheDir; - static CacheStore cacheStore; @BeforeAll static void setup(@TempDir Path cacheDir) throws IOException { MiddlewareInstallTest.cacheDir = cacheDir; - cacheStore = new CacheStoreTestImpl(cacheDir); - cacheStore.addToCache("wls_12.2.1.4.0", - ResourceUtils.resourcePath("/dummyInstallers/test-installer.zip").toString()); + + Path path12214 = ResourceUtils.resourcePath("/dummyInstallers/test-installer.zip"); + + Path settingsFileName = cacheDir.resolve("settings.yaml"); + Path installerFile = cacheDir.resolve("installers.yaml"); + Path patchFile = cacheDir.resolve("patches.yaml"); + Files.createFile(settingsFileName); + Files.createFile(installerFile); + Files.createFile(patchFile); + + List lines = Arrays.asList( + "installerSettingsFile: " + installerFile.toAbsolutePath().toString(), + "patchSettingsFile: " + patchFile.toAbsolutePath().toString(), + "installerDirectory: " + cacheDir.toAbsolutePath().toString(), + "patchDirectory: " + cacheDir.toAbsolutePath().toString() + ); + Files.write(settingsFileName, lines); + ConfigManager configManager = ConfigManager.getInstance(settingsFileName); + InstallerMetaData installer2 = new InstallerMetaData(Architecture.getLocalArchitecture().toString(), + path12214.toString(), + "12.2.1.4.0"); + + configManager.addInstaller(InstallerType.WLS, "12.2.1.4.0", installer2); } @Test void copyInstaller(@TempDir Path buildContextDir) throws IOException { // Test a simple WLS install type, and copy the files to the build context folder MiddlewareInstall install = new MiddlewareInstall(FmwInstallerType.WLS, "12.2.1.4.0", null, null); - install.copyFiles(cacheStore, buildContextDir.toString()); + install.copyFiles(buildContextDir.toString()); // 2 files should be copied from cache to build context folder assertTrue(Files.isRegularFile(buildContextDir.resolve("test-installer.zip"))); assertTrue(Files.isRegularFile(buildContextDir.resolve("wls.rsp")), "Response file not found"); @@ -61,7 +81,7 @@ void customResponseFile(@TempDir Path buildContextDir) throws IOException { Collections.singletonList(ResourceUtils.resourcePath("/dummyInstallers/dummyResponse.txt")); // Test a simple WLS install type, and copy the files to the build context folder MiddlewareInstall install = new MiddlewareInstall(FmwInstallerType.WLS, "12.2.1.4.0", customResponse, null); - install.copyFiles(cacheStore, buildContextDir.toString()); + install.copyFiles(buildContextDir.toString()); // 2 files should be copied from cache to build context folder assertTrue(Files.isRegularFile(buildContextDir.resolve("test-installer.zip"))); assertTrue(Files.isRegularFile(buildContextDir.resolve("dummyResponse.txt")), "Response file not found"); diff --git a/imagetool/src/test/java/com/oracle/weblogic/imagetool/settings/UserSettingsTest.java b/imagetool/src/test/java/com/oracle/weblogic/imagetool/settings/UserSettingsTest.java index 26780f82..f97c5a65 100644 --- a/imagetool/src/test/java/com/oracle/weblogic/imagetool/settings/UserSettingsTest.java +++ b/imagetool/src/test/java/com/oracle/weblogic/imagetool/settings/UserSettingsTest.java @@ -58,12 +58,12 @@ void testInvalidSettings() { @Test void testOutput() { - String expected = "aruRetryInterval: 200\n" - + "buildContextDirectory: ./builds\n" - + "patchDirectory: /home/user/patches\n"; UserSettingsFile settings = getResourceFile("settings/basic_settings.yaml"); - assertEquals(expected, settings.toString()); + assertEquals(settings.getPatchDirectory(), "/home/user/patches"); + assertEquals(settings.getBuildContextDirectory(), "./builds"); + assertEquals(settings.getPatchDirectory(), "/home/user/patches"); + } @Test diff --git a/imagetool/src/test/java/com/oracle/weblogic/imagetool/util/DockerfileBuilderTest.java b/imagetool/src/test/java/com/oracle/weblogic/imagetool/util/DockerfileBuilderTest.java index df15df3c..50e3b9b0 100644 --- a/imagetool/src/test/java/com/oracle/weblogic/imagetool/util/DockerfileBuilderTest.java +++ b/imagetool/src/test/java/com/oracle/weblogic/imagetool/util/DockerfileBuilderTest.java @@ -6,17 +6,26 @@ import java.io.File; import java.io.IOException; import java.io.StringWriter; +import java.nio.file.Files; +import java.nio.file.Path; import java.util.Arrays; +import java.util.List; import com.github.mustachejava.DefaultMustacheFactory; import com.github.mustachejava.Mustache; import com.github.mustachejava.MustacheFactory; +import com.oracle.weblogic.imagetool.ResourceUtils; import com.oracle.weblogic.imagetool.cli.menu.PackageManagerType; import com.oracle.weblogic.imagetool.installer.FmwInstallerType; +import com.oracle.weblogic.imagetool.installer.InstallerMetaData; +import com.oracle.weblogic.imagetool.installer.InstallerType; import com.oracle.weblogic.imagetool.installer.MiddlewareInstall; +import com.oracle.weblogic.imagetool.settings.ConfigManager; import com.oracle.weblogic.imagetool.test.annotations.ReduceTestLogging; +import org.junit.jupiter.api.BeforeAll; 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.assertTrue; @@ -24,13 +33,41 @@ @Tag("unit") class DockerfileBuilderTest { + @BeforeAll + static void setup(@TempDir Path cacheDir) throws IOException { + + Path path12214 = ResourceUtils.resourcePath("/dummyInstallers/test-installer.zip"); + + Path settingsFileName = cacheDir.resolve("settings.yaml"); + Path installerFile = cacheDir.resolve("installers.yaml"); + Path patchFile = cacheDir.resolve("patches.yaml"); + Files.createFile(settingsFileName); + Files.createFile(installerFile); + Files.createFile(patchFile); + + List lines = Arrays.asList( + "installerSettingsFile: " + installerFile.toAbsolutePath().toString(), + "patchSettingsFile: " + patchFile.toAbsolutePath().toString(), + "installerDirectory: " + cacheDir.toAbsolutePath().toString(), + "patchDirectory: " + cacheDir.toAbsolutePath().toString() + ); + Files.write(settingsFileName, lines); + ConfigManager configManager = ConfigManager.getInstance(settingsFileName); + InstallerMetaData installer2 = new InstallerMetaData(Architecture.getLocalArchitecture().toString(), + path12214.toString(), + "12.2.1.4.0"); + + configManager.addInstaller(InstallerType.WLS, "12.2.1.4.0", installer2); + } + /** * Catch mismatched start/end tags and missing mustache braces. * @throws IOException if file read fails for mustache file. */ @Test void validateMustacheAliases() throws IOException { - MiddlewareInstall install = new MiddlewareInstall(FmwInstallerType.WLS, "12.2.1.3", null, null); + MiddlewareInstall install = new MiddlewareInstall(FmwInstallerType.WLS, "12.2.1.4.0", + null, null); DockerfileOptions dockerfileOptions = new DockerfileOptions("123") .setPatchingEnabled() diff --git a/imagetool/src/test/resources/settings/basic_settings.yaml b/imagetool/src/test/resources/settings/basic_settings.yaml index ca19cb96..0343f519 100644 --- a/imagetool/src/test/resources/settings/basic_settings.yaml +++ b/imagetool/src/test/resources/settings/basic_settings.yaml @@ -1,5 +1,6 @@ aruRetryInterval: 200 buildContextDirectory: ./builds +patchDirectory: /home/user/patches installers: jdk: defaultVersion: 8u241 @@ -7,4 +8,3 @@ installers: defaultVersion: 12.2.1.4.0 wdt: defaultVersion: latest -patchDirectory: /home/user/patches From ade480217502b28372652ae18c3c2409c430a376 Mon Sep 17 00:00:00 2001 From: jshum Date: Tue, 19 Nov 2024 17:30:22 -0600 Subject: [PATCH 042/104] Various fixes --- .../weblogic/imagetool/aru/AruPatch.java | 11 ++++ .../imagetool/cachestore/PatchFile.java | 5 +- .../cli/cache/AddInstallerEntry.java | 14 +---- .../cli/cache/CacheAddOperation.java | 13 +++-- .../imagetool/cli/cache/DeleteEntry.java | 44 --------------- .../cli/menu/CommonCreateOptions.java | 2 +- .../imagetool/cli/menu/CommonOptions.java | 2 +- .../installer/InstallerMetaData.java | 4 +- .../imagetool/installer/InstallerType.java | 15 +++++ .../installer/MiddlewareInstall.java | 1 + .../imagetool/settings/ConfigManager.java | 10 +++- .../imagetool/settings/UserSettingsFile.java | 17 +++++- .../imagetool/util/CacheConversion.java | 14 +++-- .../imagetool/util/DockerfileOptions.java | 26 ++++++++- .../oracle/weblogic/imagetool/util/Utils.java | 32 +++++++++++ .../install-middleware-pkg.mustache | 15 +++++ .../docker-files/install-middleware.mustache | 56 +++++-------------- .../imagetool/tests/utils/CacheCommand.java | 3 - 18 files changed, 163 insertions(+), 121 deletions(-) delete mode 100644 imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/DeleteEntry.java create mode 100644 imagetool/src/main/resources/docker-files/install-middleware-pkg.mustache diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/aru/AruPatch.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/aru/AruPatch.java index edb29789..f41c5b60 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/aru/AruPatch.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/aru/AruPatch.java @@ -40,6 +40,7 @@ public class AruPatch { private String access; private String platformName = "Generic"; private String sha256Hash; + private String releasedDate; public String patchId() { return patchId; @@ -164,6 +165,15 @@ public AruPatch downloadPath(String value) { return this; } + public AruPatch releasedDate(String value) { + releasedDate = value; + return this; + } + + public String releasedDate() { + return Utils.getReleaseDate(releasedDate); + } + public String downloadUrl() { return downloadHost + downloadPath; } @@ -225,6 +235,7 @@ public static Stream getPatches(Document patchList) throws XPathExpres .platformName(getAruPlatformName(XPathUtil.string(nodeList.item(i), "./platform/@id"))) .downloadHost(XPathUtil.string(nodeList.item(i), "./files/file/download_url/@host")) .downloadPath(XPathUtil.string(nodeList.item(i), "./files/file/download_url/text()")) + .releasedDate(XPathUtil.string(nodeList.item(i), "./released_date/text()")) .platform(XPathUtil.string(nodeList.item(i), "./platform/@id")); int index = patch.downloadPath().indexOf("patch_file="); diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cachestore/PatchFile.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cachestore/PatchFile.java index e20280df..9aa8c0ec 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cachestore/PatchFile.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cachestore/PatchFile.java @@ -20,7 +20,6 @@ import com.oracle.weblogic.imagetool.util.Utils; import static com.oracle.weblogic.imagetool.util.Utils.getSha256Hash; -import static com.oracle.weblogic.imagetool.util.Utils.getTodayDate; public class PatchFile { @@ -70,7 +69,7 @@ public String downloadPatch(AruPatch aruPatch, ConfigManager configManager) thro patches.add(new PatchMetaData(aruPatch.platformName(), filename, aruPatch.sha256Hash(), - getTodayDate(), + aruPatch.releasedDate(), aruPatch.version())); allPatches.remove(aruPatch.patchId()); allPatches.put(aruPatch.patchId(),patches); @@ -79,7 +78,7 @@ public String downloadPatch(AruPatch aruPatch, ConfigManager configManager) thro patches.add(new PatchMetaData(aruPatch.platformName(), filename, aruPatch.sha256Hash(), - getTodayDate(), + aruPatch.releasedDate(), aruPatch.version())); allPatches.put(aruPatch.patchId(),patches); } diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/AddInstallerEntry.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/AddInstallerEntry.java index 16a9b600..ef8378b2 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/AddInstallerEntry.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/AddInstallerEntry.java @@ -31,17 +31,6 @@ public CommandResponse call() throws IOException, CacheStoreException { @Override public String getKey() { return type.toString(); - //StringBuilder key = new StringBuilder(25) - // .append(type) - // .append(CacheStore.CACHE_KEY_SEPARATOR) - // .append(version); - // - //if (architecture != null) { - // key.append(CacheStore.CACHE_KEY_SEPARATOR) - // .append(architecture); - //} - // - //return key.toString(); } @Override @@ -51,6 +40,9 @@ public String getVersion() { @Override public String getCommonName() { + if (commonName == null) { + return version; + } return commonName; } diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/CacheAddOperation.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/CacheAddOperation.java index 6dcc56d4..7a0afac2 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/CacheAddOperation.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/CacheAddOperation.java @@ -40,14 +40,19 @@ CommandResponse addInstallerToCache() throws IOException, CacheStoreException { name = getVersion(); } - InstallerMetaData metaData = ConfigManager.getInstance().getInstallerForPlatform(InstallerType.valueOf(type), + InstallerMetaData metaData = ConfigManager.getInstance().getInstallerForPlatform(InstallerType.fromString(type), getArchitecture(), name); if (metaData != null) { return CommandResponse.success("IMG-0075"); } - - metaData = new InstallerMetaData(type, filePath.toAbsolutePath().toString(), getVersion()); - ConfigManager.getInstance().addInstaller(InstallerType.valueOf(type), getCommonName(), metaData); + // TODO + Architecture arch = getArchitecture(); + if (arch == null) { + arch = Architecture.GENERIC; + } + metaData = new InstallerMetaData(arch.toString(), filePath.toAbsolutePath().toString(), + getVersion()); + ConfigManager.getInstance().addInstaller(InstallerType.fromString(type), getCommonName(), metaData); // if the new value is the same as the existing cache value, do nothing return CommandResponse.success("IMG-0050", type, metaData.getLocation()); diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/DeleteEntry.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/DeleteEntry.java deleted file mode 100644 index 6f2f1a17..00000000 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/DeleteEntry.java +++ /dev/null @@ -1,44 +0,0 @@ -// Copyright (c) 2019, 2024, 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.cli.cache; - -import com.oracle.weblogic.imagetool.api.model.CommandResponse; -import com.oracle.weblogic.imagetool.util.Constants; -import com.oracle.weblogic.imagetool.util.Utils; -import picocli.CommandLine.Command; -import picocli.CommandLine.Option; - -import static com.oracle.weblogic.imagetool.cachestore.CacheStoreFactory.cache; - -@Command( - name = "deleteEntry", - description = "Command to delete a cache entry" -) -public class DeleteEntry extends CacheOperation { - - @Override - public CommandResponse call() throws Exception { - if (!Utils.isEmptyString(key)) { - if (Constants.DELETE_ALL_FOR_SURE.equalsIgnoreCase(key)) { - cache().clearCache(); - return CommandResponse.success("IMG-0046"); - } else { - String oldValue = cache().deleteFromCache(key); - if (oldValue != null) { - return CommandResponse.success("IMG-0051", key, oldValue); - } else { - return CommandResponse.success("IMG-0052", key); - } - } - } - return CommandResponse.error("IMG-0045"); - } - - @Option( - names = {"--key"}, - description = "Key corresponding to the cache entry to delete", - required = true - ) - private String key; -} diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonCreateOptions.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonCreateOptions.java index 96c6f10f..929f17bd 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonCreateOptions.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonCreateOptions.java @@ -153,7 +153,7 @@ private static void verifyInstallerHash(InstallerMetaData installerMetaData) thr sb.append(String.format("%02x", b)); } String hashString = sb.toString(); - if (!hashString.equals(installerMetaData.getDigest())) { + if (!hashString.equalsIgnoreCase(installerMetaData.getDigest())) { throw new IOException(String.format("Installer hash mismatch, expected %s but got %s for file %s", installerMetaData.getDigest(), hashString, installerMetaData.getLocation())); } diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonOptions.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonOptions.java index e95385c0..1605702d 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonOptions.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonOptions.java @@ -347,7 +347,7 @@ public List getBuildPlatform() { buildPlatform = new ArrayList<>(); java.lang.String platform = ConfigManager.getInstance().getDefaultBuildPlatform(); if (platform == null) { - platform = Architecture.getLocalArchitecture().toString(); + platform = Utils.standardPlatform(Architecture.getLocalArchitecture().toString()); } buildPlatform.add(platform); } diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/installer/InstallerMetaData.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/installer/InstallerMetaData.java index 7eb656e1..f22f65a8 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/installer/InstallerMetaData.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/installer/InstallerMetaData.java @@ -24,7 +24,7 @@ public class InstallerMetaData { * @param dateAdded date added */ public InstallerMetaData(String platform, String location, String digest, String dateAdded, String productVersion) { - this.platform = standardPlatform(platform); + this.platform = Utils.standardPlatform(platform); this.location = location; this.digest = digest; this.dateAdded = dateAdded; @@ -38,7 +38,7 @@ public InstallerMetaData(String platform, String location, String digest, String * @param productVersion real version of this installer */ public InstallerMetaData(String platform, String location, String productVersion) { - this.platform = standardPlatform(platform); + this.platform = Utils.standardPlatform(platform); this.location = location; this.productVersion = productVersion; if (location != null) { diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/installer/InstallerType.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/installer/InstallerType.java index d58f354d..d06d3e98 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/installer/InstallerType.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/installer/InstallerType.java @@ -41,8 +41,23 @@ public enum InstallerType { this.value = value; } + /** + * Return the enum value from string. + * @param value input value + * @return InstallerType + */ + public static InstallerType fromString(String value) { + for (InstallerType installerType : InstallerType.values()) { + if (installerType.toString().equals(value)) { + return installerType; + } + } + throw new IllegalArgumentException(value); + } + @Override public String toString() { return value; } + } diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/installer/MiddlewareInstall.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/installer/MiddlewareInstall.java index 94699322..842baae3 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/installer/MiddlewareInstall.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/installer/MiddlewareInstall.java @@ -55,6 +55,7 @@ public MiddlewareInstall(FmwInstallerType type, String version, List respo } for (InstallerType installerType : type.installerList()) { for (String platform : buildPlatform) { + platform = Utils.standardPlatform(platform); MiddlewareInstallPackage pkg = new MiddlewareInstallPackage(); Architecture arch = Architecture.fromString(platform); pkg.type = installerType; diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/ConfigManager.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/ConfigManager.java index 3db88602..b4ba0c5a 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/ConfigManager.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/ConfigManager.java @@ -144,7 +144,10 @@ public String getDefaultBuildPlatform() { private InstallerMetaData createInstallerMetaData(Map objectData) { String hash = (String) objectData.get("digest"); - String dateAdded = getTodayDate(); + String dateAdded = (String) objectData.get("added"); + if (dateAdded == null) { + dateAdded = getTodayDate(); + } String location = (String) objectData.get("location"); String productVersion = (String) objectData.get("version"); String platform = (String) objectData.get("platform"); @@ -153,7 +156,10 @@ private InstallerMetaData createInstallerMetaData(Map objectData private PatchMetaData createPatchMetaData(Map objectData) { String hash = (String) objectData.get("digest"); - String dateAdded = getTodayDate(); + String dateAdded = (String) objectData.get("added"); + if (dateAdded == null) { + dateAdded = getTodayDate(); + } String location = (String) objectData.get("location"); String productVersion = (String) objectData.get("version"); String platform = (String) objectData.get("platform"); diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/UserSettingsFile.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/UserSettingsFile.java index 5adb92b6..7f5b44ad 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/UserSettingsFile.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/UserSettingsFile.java @@ -258,7 +258,10 @@ public Map getInstaller(InstallerType installerType) private InstallerMetaData createInstallerMetaData(Map objectData) { String hash = (String) objectData.get("digest"); - String dateAdded = getTodayDate(); + String dateAdded = (String) objectData.get("added"); + if (dateAdded == null) { + dateAdded = getTodayDate(); + } String location = (String) objectData.get("location"); String productVersion = (String) objectData.get("version"); String platform = (String) objectData.get("platform"); @@ -267,7 +270,10 @@ private InstallerMetaData createInstallerMetaData(Map objectData private PatchMetaData createPatchMetaData(Map objectData) { String hash = (String) objectData.get("digest"); - String dateAdded = getTodayDate(); + String dateAdded = (String) objectData.get("added"); + if (dateAdded == null) { + dateAdded = getTodayDate(); + } String location = (String) objectData.get("location"); String productVersion = (String) objectData.get("version"); String platform = (String) objectData.get("platform"); @@ -391,6 +397,7 @@ public void addInstaller(InstallerType installerType, String commonName, Install public InstallerMetaData getInstallerForPlatform(InstallerType installerType, Architecture platformName, String installerVersion) { + // TODO if (platformName == null) { platformName = Architecture.GENERIC; } @@ -403,6 +410,12 @@ public InstallerMetaData getInstallerForPlatform(InstallerType installerType, Ar return installerMetaData; } } + // If it can't find the specialized platform, try generic. + for (InstallerMetaData installerMetaData: installerMetaDataList) { + if (Architecture.GENERIC.getAcceptableNames().contains(installerMetaData.getPlatform())) { + return installerMetaData; + } + } } } return null; diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/util/CacheConversion.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/util/CacheConversion.java index 8c0bcc31..91c0831e 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/util/CacheConversion.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/util/CacheConversion.java @@ -10,6 +10,7 @@ import java.util.regex.Pattern; import com.oracle.weblogic.imagetool.cachestore.OPatchFile; +import com.oracle.weblogic.imagetool.installer.InstallerMetaData; import com.oracle.weblogic.imagetool.logging.LoggingFacade; import com.oracle.weblogic.imagetool.logging.LoggingFactory; @@ -28,10 +29,9 @@ public class CacheConversion { /** * convert cache file to nee format. * @param inputFile input cache file - * @param outputDir output directory * @throws IOException when error */ - public void convert(String inputFile, String outputDir) throws IOException { + public void convert(String inputFile) throws IOException { Pattern patchPattern = Pattern.compile(PATCH_PATTERN); Pattern installerPattern = Pattern.compile(INSTALLER_PATTERN); try (BufferedReader br = new BufferedReader(new FileReader(inputFile))) { @@ -40,6 +40,7 @@ public void convert(String inputFile, String outputDir) throws IOException { if (line.charAt(0) == '#') { continue; } + // patches if (Character.isDigit(line.charAt(0))) { Matcher matcher = patchPattern.matcher(line); if (matcher.matches()) { @@ -47,18 +48,23 @@ public void convert(String inputFile, String outputDir) throws IOException { String version = matcher.group(2); String arch = matcher.group(3); String filepath = matcher.group(4); + //ConfigManager.getInstance().addPatch(key, arch, filepath, version); // TODO } else { logger.warning("IMG-0128", line); } } else { + // installer Matcher matcher = installerPattern.matcher(line); if (matcher.matches()) { String key = matcher.group(1); String version = matcher.group(2); String arch = matcher.group(3); String filepath = matcher.group(4); - // TODO + InstallerMetaData metaData = new InstallerMetaData(arch, filepath, + Utils.getSha256Hash(filepath), Utils.getTodayDate(), version); + //ConfigManager.getInstance().addInstaller(InstallerType.valueOf(key), version, metaData); + //// TODO } else { logger.warning("IMG-0128", line); } @@ -70,6 +76,6 @@ public void convert(String inputFile, String outputDir) throws IOException { public static void main(String[] args) throws IOException { CacheConversion cacheConversion = new CacheConversion(); - cacheConversion.convert("/Users/JSHUM/dimtemp23/cache/.metadata", ""); + cacheConversion.convert("/Users/JSHUM/dimtemp23/cache/.metadata"); } } diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/util/DockerfileOptions.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/util/DockerfileOptions.java index 4b632071..069465cf 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/util/DockerfileOptions.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/util/DockerfileOptions.java @@ -1064,14 +1064,36 @@ public List installPackages() { return mwInstallers.getInstallers(); } + /** + * List of packaged to be installed for ARM. + * @return list of packages + */ public List installPackagesForARM() { - return mwInstallers.getInstallers().stream().filter(obj -> ARM64_BLD.equals(obj.platform)) + List result = mwInstallers.getInstallers() + .stream().filter(obj -> ARM64_BLD.equalsIgnoreCase(obj.platform)) .collect(Collectors.toList()); + if (result.isEmpty()) { + result = mwInstallers.getInstallers() + .stream().filter(obj -> "Generic".equalsIgnoreCase(obj.platform)) + .collect(Collectors.toList()); + } + return result; } + /** + * List of packaged to be installed for AMD. + * @return list of packages + */ public List installPackagesForAMD() { - return mwInstallers.getInstallers().stream().filter(obj -> AMD64_BLD.equals(obj.platform)) + List result = mwInstallers.getInstallers() + .stream().filter(obj -> AMD64_BLD.equalsIgnoreCase(obj.platform)) .collect(Collectors.toList()); + if (result.isEmpty()) { + result = mwInstallers.getInstallers() + .stream().filter(obj -> "Generic".equalsIgnoreCase(obj.platform)) + .collect(Collectors.toList()); + } + return result; } public void setJavaInstaller(List value) { diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/util/Utils.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/util/Utils.java index 36f6bde2..621bbcff 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/util/Utils.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/util/Utils.java @@ -825,4 +825,36 @@ public static String getTodayDate() { return today.format(DateTimeFormatter.ISO_LOCAL_DATE); } + /** + * Get epoch date in yyyy-mm-dd HH:MM:SS format. + * @return date format + */ + public static String getReleaseDate(String epoch) { + if (epoch == null) { + return getTodayDate(); + } else { + String [] dates = epoch.split(" "); + if (dates.length == 2) { + return dates[0]; + } else { + return getTodayDate(); + } + } + } + + /** + * Return standard platform name from the possible names. + * @param platform input value to convert + * @return standardized platform name + */ + public static String standardPlatform(String platform) { + if (Architecture.AMD64.getAcceptableNames().contains(platform)) { + return "linux/amd64"; + } + if (Architecture.ARM64.getAcceptableNames().contains(platform)) { + return "linux/arm64"; + } + return "Generic"; + } + } diff --git a/imagetool/src/main/resources/docker-files/install-middleware-pkg.mustache b/imagetool/src/main/resources/docker-files/install-middleware-pkg.mustache new file mode 100644 index 00000000..3a44581c --- /dev/null +++ b/imagetool/src/main/resources/docker-files/install-middleware-pkg.mustache @@ -0,0 +1,15 @@ +echo "INSTALLING {{type}}" \ +{{#isZip}}&& unzip -q {{{tempDir}}}/{{{type}}}/$TARGETPLATFORM/{{installerFilename}} -d {{{tempDir}}}/{{{type}}} {{/isZip}} \ +{{#preinstallCommands}}&& {{{tempDir}}}/{{{type}}}/{{{.}}} {{/preinstallCommands}} \ +{{^isBin}} && if [ ! -f {{{tempDir}}}/{{{type}}}/{{jarName}} ] ; then (cp {{{tempDir}}}/{{{type}}}/$TARGETPLATFORM/{{installerFilename}} {{{tempDir}}}/{{{type}}}) fi \ +&& {{{java_home}}}/bin/java -Xmx1024m -jar {{{tempDir}}}/{{{type}}}/{{jarName}} \ +-silent ORACLE_HOME={{{oracle_home}}} \ +-responseFile {{{tempDir}}}/{{{type}}}/$TARGETPLATFORM/{{responseFile.name}} \ +-invPtrLoc {{inv_loc}}/oraInst.loc \ +-ignoreSysPrereqs -force -novalidation {{/isBin}} \ +{{#isBin}} && if [ ! -f {{{tempDir}}}/{{{type}}}/{{jarName}} ] ; then (cp {{{tempDir}}}/{{{type}}}/$TARGETPLATFORM/{{installerFilename}} {{{tempDir}}}/{{{type}}}) fi \ +&& chmod +x {{{tempDir}}}/{{{type}}}/{{jarName}} \ +&& {{{tempDir}}}/{{{type}}}/{{jarName}} \ +-force -ignoreSysPrereqs -silent \ +-responseFile {{{tempDir}}}/{{{type}}}/$TARGETPLATFORM/{{responseFile.name}} \ +-invPtrLoc {{inv_loc}}/oraInst.loc ORACLE_HOME={{{oracle_home}}} -jreLoc {{{java_home}}} {{/isBin}} \ \ No newline at end of file diff --git a/imagetool/src/main/resources/docker-files/install-middleware.mustache b/imagetool/src/main/resources/docker-files/install-middleware.mustache index 8941d935..69cafc25 100644 --- a/imagetool/src/main/resources/docker-files/install-middleware.mustache +++ b/imagetool/src/main/resources/docker-files/install-middleware.mustache @@ -39,56 +39,28 @@ USER {{userid}} # If installer is packaged in a ZIP, extract it before running it # IF the installer is a JAR file (not a .bin), run the silent install using Java # If the installer is a BIN, make sure it is executable and run the installer +# +# installPackagesForARM - list of packages to install for arm64 platform +# installPackagesForAMD - list of packages to install for amd64 platform + -RUN echo "INSTALLING MIDDLEWARE" \ -{{#targetARMPlatform}} - && if [ "$TARGETPLATFORM" == "linux/arm64" ] ; then \ - {{#installPackagesForARM}} - echo "INSTALLING {{type}}" \ - {{#isZip}}&& unzip -q {{{tempDir}}}/{{{type}}}/$TARGETPLATFORM/{{installerFilename}} -d {{{tempDir}}}/{{{type}}} {{/isZip}} \ - {{#preinstallCommands}}&& {{{tempDir}}}/{{{type}}}/{{{.}}} {{/preinstallCommands}} \ - {{^isBin}} && if [ ! -f {{{tempDir}}}/{{{type}}}/{{jarName}} ] ; then (cp {{{tempDir}}}/{{{type}}}/$TARGETPLATFORM/{{installerFilename}} {{{tempDir}}}/{{{type}}}) fi \ - && {{{java_home}}}/bin/java -Xmx1024m -jar {{{tempDir}}}/{{{type}}}/{{jarName}} \ - -silent ORACLE_HOME={{{oracle_home}}} \ - -responseFile {{{tempDir}}}/{{{type}}}/$TARGETPLATFORM/{{responseFile.name}} \ - -invPtrLoc {{inv_loc}}/oraInst.loc \ - -ignoreSysPrereqs -force -novalidation {{/isBin}} \ - {{#isBin}} && if [ ! -f {{{tempDir}}}/{{{type}}}/{{jarName}} ] ; then (cp {{{tempDir}}}/{{{type}}}/$TARGETPLATFORM/{{installerFilename}} {{{tempDir}}}/{{{type}}}) fi \ - && chmod +x {{{tempDir}}}/{{{type}}}/{{jarName}} \ - && {{{tempDir}}}/{{{type}}}/{{jarName}} \ - -force -ignoreSysPrereqs -silent \ - -responseFile {{{tempDir}}}/{{{type}}}/$TARGETPLATFORM/{{responseFile.name}} \ - -invPtrLoc {{inv_loc}}/oraInst.loc ORACLE_HOME={{{oracle_home}}} -jreLoc {{{java_home}}} {{/isBin}} \ - {{/installPackagesForARM}} +RUN if [ "$TARGETPLATFORM" == "linux/arm64" ] ; then \ + echo "INSTALLING MIDDLEWARE" \ + {{#installPackagesForARM}} + {{> install-middleware-pkg }} + {{/installPackagesForARM}} && test $? -eq 0 \ && chmod -R g+r {{{oracle_home}}} \ || (grep -vh "NOTIFICATION" /tmp/OraInstall*/install*.log && exit 1) \ - fi {{#targetAMDPlatform}}\{{/targetAMDPlatform}} -{{/targetARMPlatform}} -{{#targetAMDPlatform}} - && if [ "$TARGETPLATFORM" == "linux/amd64" ] ; then \ - {{#installPackagesForAMD}} - echo "INSTALLING {{type}}" \ - {{#isZip}}&& unzip -q {{{tempDir}}}/{{{type}}}/$TARGETPLATFORM//{{installerFilename}} -d {{{tempDir}}}/{{{type}}} {{/isZip}} \ - {{#preinstallCommands}}&& {{{tempDir}}}/{{{type}}}/{{{.}}} {{/preinstallCommands}} \ - {{^isBin}}&& if [ ! -f {{{tempDir}}}/{{{type}}}/{{jarName}} ] ; then (cp {{{tempDir}}}/{{{type}}}/$TARGETPLATFORM/{{installerFilename}} {{{tempDir}}}/{{{type}}}) fi \ - && {{{java_home}}}/bin/java -Xmx1024m -jar {{{tempDir}}}/{{{type}}}/{{jarName}} \ - -silent ORACLE_HOME={{{oracle_home}}} \ - -responseFile {{{tempDir}}}/{{{type}}}/$TARGETPLATFORM/{{responseFile.name}} \ - -invPtrLoc {{inv_loc}}/oraInst.loc \ - -ignoreSysPrereqs -force -novalidation {{/isBin}} \ - {{#isBin}} && if [ ! -f {{{tempDir}}}/{{{type}}}/{{jarName}} ] ; then (cp {{{tempDir}}}/{{{type}}}/$TARGETPLATFORM/{{installerFilename}} {{{tempDir}}}/{{{type}}}) fi \ - && chmod +x {{{tempDir}}}/{{{type}}}/{{jarName}} \ - && {{{tempDir}}}/{{{type}}}/{{jarName}} \ - -force -ignoreSysPrereqs -silent \ - -responseFile {{{tempDir}}}/{{{type}}}/$TARGETPLATFORM/{{responseFile.name}} \ - -invPtrLoc {{inv_loc}}/oraInst.loc ORACLE_HOME={{{oracle_home}}} -jreLoc {{{java_home}}} {{/isBin}} \ - {{/installPackagesForAMD}} + fi && if [ "$TARGETPLATFORM" == "linux/amd64" ] ; then \ + echo "INSTALLING MIDDLEWARE" \ + {{#installPackagesForAMD}} + {{> install-middleware-pkg }} + {{/installPackagesForAMD}} && test $? -eq 0 \ && chmod -R g+r {{{oracle_home}}} \ || (grep -vh "NOTIFICATION" /tmp/OraInstall*/install*.log && exit 1) \ fi -{{/targetAMDPlatform}} {{#useOwnerPermsForGroup}} # OPatch needs write permissions to the logs folder and lock file when running in OpenShift diff --git a/tests/src/test/java/com/oracle/weblogic/imagetool/tests/utils/CacheCommand.java b/tests/src/test/java/com/oracle/weblogic/imagetool/tests/utils/CacheCommand.java index 5b8c29fd..820020c6 100644 --- a/tests/src/test/java/com/oracle/weblogic/imagetool/tests/utils/CacheCommand.java +++ b/tests/src/test/java/com/oracle/weblogic/imagetool/tests/utils/CacheCommand.java @@ -93,11 +93,8 @@ public CacheCommand type(String value) { @Override public String build() { return super.build() - + field("listItems", listItems) + field("addInstaller", addInstaller) + field("addPatch", addPatch) - + field("addEntry", addEntry) - + field("deleteEntry", deleteEntry) + field("--key", key) + field("--value", value) + field("--version", version) From 4a8cc74e9baa485e6b967c4ea115176efadc66ae Mon Sep 17 00:00:00 2001 From: jshum Date: Tue, 19 Nov 2024 20:27:59 -0600 Subject: [PATCH 043/104] Fix unit test --- .../imagetool/settings/UserSettingsFile.java | 12 ++++++------ .../imagetool/installer/MiddlewareInstallTest.java | 6 +++--- .../imagetool/util/DockerfileBuilderTest.java | 2 +- 3 files changed, 10 insertions(+), 10 deletions(-) diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/UserSettingsFile.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/UserSettingsFile.java index 7f5b44ad..b0bdbad0 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/UserSettingsFile.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/UserSettingsFile.java @@ -410,12 +410,12 @@ public InstallerMetaData getInstallerForPlatform(InstallerType installerType, Ar return installerMetaData; } } - // If it can't find the specialized platform, try generic. - for (InstallerMetaData installerMetaData: installerMetaDataList) { - if (Architecture.GENERIC.getAcceptableNames().contains(installerMetaData.getPlatform())) { - return installerMetaData; - } - } + //If it can't find the specialized platform, try generic. + //for (InstallerMetaData installerMetaData: installerMetaDataList) { + // if (Architecture.GENERIC.getAcceptableNames().contains(installerMetaData.getPlatform())) { + // return installerMetaData; + // } + //} } } return null; diff --git a/imagetool/src/test/java/com/oracle/weblogic/imagetool/installer/MiddlewareInstallTest.java b/imagetool/src/test/java/com/oracle/weblogic/imagetool/installer/MiddlewareInstallTest.java index ad4a79de..60d081b3 100644 --- a/imagetool/src/test/java/com/oracle/weblogic/imagetool/installer/MiddlewareInstallTest.java +++ b/imagetool/src/test/java/com/oracle/weblogic/imagetool/installer/MiddlewareInstallTest.java @@ -13,7 +13,6 @@ import com.oracle.weblogic.imagetool.ResourceUtils; import com.oracle.weblogic.imagetool.settings.ConfigManager; import com.oracle.weblogic.imagetool.test.annotations.ReduceTestLogging; -import com.oracle.weblogic.imagetool.util.Architecture; import org.junit.jupiter.api.BeforeAll; import org.junit.jupiter.api.Tag; import org.junit.jupiter.api.Test; @@ -49,7 +48,7 @@ static void setup(@TempDir Path cacheDir) throws IOException { ); Files.write(settingsFileName, lines); ConfigManager configManager = ConfigManager.getInstance(settingsFileName); - InstallerMetaData installer2 = new InstallerMetaData(Architecture.getLocalArchitecture().toString(), + InstallerMetaData installer2 = new InstallerMetaData("Generic", path12214.toString(), "12.2.1.4.0"); @@ -59,7 +58,8 @@ static void setup(@TempDir Path cacheDir) throws IOException { @Test void copyInstaller(@TempDir Path buildContextDir) throws IOException { // Test a simple WLS install type, and copy the files to the build context folder - MiddlewareInstall install = new MiddlewareInstall(FmwInstallerType.WLS, "12.2.1.4.0", null, null); + MiddlewareInstall install = new MiddlewareInstall(FmwInstallerType.WLS, "12.2.1.4.0", + null, null); install.copyFiles(buildContextDir.toString()); // 2 files should be copied from cache to build context folder assertTrue(Files.isRegularFile(buildContextDir.resolve("test-installer.zip"))); diff --git a/imagetool/src/test/java/com/oracle/weblogic/imagetool/util/DockerfileBuilderTest.java b/imagetool/src/test/java/com/oracle/weblogic/imagetool/util/DockerfileBuilderTest.java index 50e3b9b0..04920c06 100644 --- a/imagetool/src/test/java/com/oracle/weblogic/imagetool/util/DockerfileBuilderTest.java +++ b/imagetool/src/test/java/com/oracle/weblogic/imagetool/util/DockerfileBuilderTest.java @@ -53,7 +53,7 @@ static void setup(@TempDir Path cacheDir) throws IOException { ); Files.write(settingsFileName, lines); ConfigManager configManager = ConfigManager.getInstance(settingsFileName); - InstallerMetaData installer2 = new InstallerMetaData(Architecture.getLocalArchitecture().toString(), + InstallerMetaData installer2 = new InstallerMetaData("Generic", path12214.toString(), "12.2.1.4.0"); From 0d2f35de7386631a7d774a7e89f87448bc41376e Mon Sep 17 00:00:00 2001 From: jshum Date: Wed, 20 Nov 2024 17:02:29 -0600 Subject: [PATCH 044/104] Fix add patch operation and add description --- .../imagetool/cachestore/PatchFile.java | 6 ++- .../cli/cache/AddInstallerEntry.java | 13 ++++-- .../imagetool/cli/cache/AddPatchEntry.java | 15 ++++++- .../cli/cache/CacheAddOperation.java | 40 +++++++++---------- .../imagetool/patch/PatchMetaData.java | 13 +++++- .../imagetool/settings/ConfigManager.java | 7 ++-- .../imagetool/settings/UserSettingsFile.java | 33 ++++++++++----- .../oracle/weblogic/imagetool/util/Utils.java | 13 ++++++ .../src/main/resources/ImageTool.properties | 4 +- .../imagetool/cachestore/CachedFileTest.java | 2 +- .../imagetool/cachestore/OPatchFileTest.java | 2 +- .../imagetool/cachestore/PatchFileTest.java | 2 +- .../cli/cache/AddInstallerEntryTest.java | 37 +++++++++++++++-- .../cli/cache/AddPatchEntryTest.java | 39 +++++++++++++++--- .../weblogic/imagetool/tests/ITImagetool.java | 3 +- 15 files changed, 172 insertions(+), 57 deletions(-) diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cachestore/PatchFile.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cachestore/PatchFile.java index 9aa8c0ec..ed029295 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cachestore/PatchFile.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cachestore/PatchFile.java @@ -70,7 +70,8 @@ public String downloadPatch(AruPatch aruPatch, ConfigManager configManager) thro filename, aruPatch.sha256Hash(), aruPatch.releasedDate(), - aruPatch.version())); + aruPatch.version(), + aruPatch.description())); allPatches.remove(aruPatch.patchId()); allPatches.put(aruPatch.patchId(),patches); } else { @@ -79,7 +80,8 @@ public String downloadPatch(AruPatch aruPatch, ConfigManager configManager) thro filename, aruPatch.sha256Hash(), aruPatch.releasedDate(), - aruPatch.version())); + aruPatch.version(), + aruPatch.description())); allPatches.put(aruPatch.patchId(),patches); } configManager.saveAllPatches(allPatches, configManager.getPatchDetailsFile()); diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/AddInstallerEntry.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/AddInstallerEntry.java index ef8378b2..69608c52 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/AddInstallerEntry.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/AddInstallerEntry.java @@ -51,6 +51,11 @@ public Architecture getArchitecture() { return architecture; } + @Override + public String getDescription() { + return ""; + } + @Option( names = {"-t", "--type"}, description = "Type of installer. Valid values: ${COMPLETION-CANDIDATES}", @@ -68,13 +73,15 @@ public Architecture getArchitecture() { @Option( names = {"-a", "--architecture"}, - description = "(Optional) Installer architecture. Valid values: ${COMPLETION-CANDIDATES}" + required = true, + description = "Installer architecture. Valid values: ${COMPLETION-CANDIDATES}" ) private Architecture architecture; @Option( - names = {"-cn", "--commonName"}, - description = "(Optional) common name. Valid values: Alphanumeric values with no special characters" + names = {"-c", "--commonName"}, + description = "(Optional) common name. Valid values: Alphanumeric values with no special characters. " + + "If not specified, default to the version value." ) private String commonName; diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/AddPatchEntry.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/AddPatchEntry.java index 09851f69..d0541680 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/AddPatchEntry.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/AddPatchEntry.java @@ -37,11 +37,16 @@ public Architecture getArchitecture() { return architecture; } + @Override + public String getDescription() { + return description; + } + @Override public CommandResponse call() throws Exception { try { if (patchId != null && !patchId.isEmpty()) { - Utils.validatePatchIds(Collections.singletonList(patchId), false); + Utils.validatePatchIds(Collections.singletonList(patchId), true); return addPatchToCache(); } else { return CommandResponse.error("IMG-0076", "--patchId"); @@ -67,8 +72,14 @@ public CommandResponse call() throws Exception { @Option( names = {"-a", "--architecture"}, - description = "(Optional) Installer architecture. Valid values: ${COMPLETION-CANDIDATES}" + required = true, + description = "Patch architecture. Valid values: arm64, amd64, Generic" ) private Architecture architecture; + @Option( + names = {"-d", "--description"}, + description = "Patch description." + ) + private String description; } diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/CacheAddOperation.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/CacheAddOperation.java index 7a0afac2..e5376cfe 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/CacheAddOperation.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/CacheAddOperation.java @@ -8,6 +8,7 @@ import java.nio.file.Path; import com.oracle.weblogic.imagetool.api.model.CommandResponse; +import com.oracle.weblogic.imagetool.cachestore.CacheStore; import com.oracle.weblogic.imagetool.cachestore.CacheStoreException; import com.oracle.weblogic.imagetool.installer.InstallerMetaData; import com.oracle.weblogic.imagetool.installer.InstallerType; @@ -16,7 +17,6 @@ import com.oracle.weblogic.imagetool.util.Architecture; import picocli.CommandLine.Option; -import static com.oracle.weblogic.imagetool.cachestore.CacheStoreFactory.cache; public abstract class CacheAddOperation extends CacheOperation { @@ -28,6 +28,8 @@ public abstract class CacheAddOperation extends CacheOperation { public abstract Architecture getArchitecture(); + public abstract String getDescription(); + CommandResponse addInstallerToCache() throws IOException, CacheStoreException { if (filePath == null || !Files.isRegularFile(filePath)) { return CommandResponse.error("IMG-0049", filePath); @@ -40,25 +42,21 @@ CommandResponse addInstallerToCache() throws IOException, CacheStoreException { name = getVersion(); } + Architecture arch = getArchitecture(); InstallerMetaData metaData = ConfigManager.getInstance().getInstallerForPlatform(InstallerType.fromString(type), - getArchitecture(), name); + arch, name); if (metaData != null) { return CommandResponse.success("IMG-0075"); } - // TODO - Architecture arch = getArchitecture(); - if (arch == null) { - arch = Architecture.GENERIC; - } metaData = new InstallerMetaData(arch.toString(), filePath.toAbsolutePath().toString(), getVersion()); ConfigManager.getInstance().addInstaller(InstallerType.fromString(type), getCommonName(), metaData); // if the new value is the same as the existing cache value, do nothing - return CommandResponse.success("IMG-0050", type, metaData.getLocation()); + return CommandResponse.success("IMG-0050", type, metaData.getProductVersion(), metaData.getLocation()); } - CommandResponse addPatchToCache() throws CacheStoreException { + CommandResponse addPatchToCache() throws IOException, CacheStoreException { // if file is invalid or does not exist, return an error if (filePath == null || !Files.isRegularFile(filePath)) { return CommandResponse.error("IMG-0049", filePath); @@ -67,6 +65,12 @@ CommandResponse addPatchToCache() throws CacheStoreException { String bugNumber = getKey(); String version = getVersion(); + int separator = bugNumber.indexOf(CacheStore.CACHE_KEY_SEPARATOR); + if (separator > 0) { + version = bugNumber.substring(separator + 1); + bugNumber = bugNumber.substring(0, separator); + } + PatchMetaData metaData = ConfigManager.getInstance().getPatchForPlatform(getArchitecture().toString(), bugNumber, version); @@ -74,21 +78,13 @@ CommandResponse addPatchToCache() throws CacheStoreException { return CommandResponse.success("IMG-0075"); } + Architecture arch = getArchitecture(); - // if the new value is the same as the existing cache value, do nothing - String existingValue = cache().getValueFromCache(bugNumber); - if (absolutePath().toString().equals(existingValue)) { - return CommandResponse.success("IMG-0075"); - } - - // if there is already a cache entry and the user did not ask to force it, return an error - if (!force && existingValue != null) { - return CommandResponse.error("IMG-0048", bugNumber, existingValue); - } + ConfigManager.getInstance().addPatch(bugNumber, arch.toString(), filePath.toAbsolutePath().toString(), + version, getDescription()); - // input appears valid, add the entry to the cache and exit - cache().addToCache(bugNumber, absolutePath().toString()); - return CommandResponse.success("IMG-0050", bugNumber, cache().getValueFromCache(bugNumber)); + return CommandResponse.success("IMG-0130", bugNumber, version, + filePath.toAbsolutePath().toString()); } private Path absolutePath() { diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/patch/PatchMetaData.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/patch/PatchMetaData.java index 735f42ed..ac4a9c53 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/patch/PatchMetaData.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/patch/PatchMetaData.java @@ -11,6 +11,7 @@ public class PatchMetaData { private String hash; private String dateAdded; private String patchVersion; + private String description; /** * Constructor. @@ -20,12 +21,14 @@ public class PatchMetaData { * @param dateAdded date added * @param patchVersion version */ - public PatchMetaData(String platform, String location, String hash, String dateAdded, String patchVersion) { + public PatchMetaData(String platform, String location, String hash, String dateAdded, String patchVersion, + String description) { this.platform = platform; this.location = location; this.hash = hash; this.dateAdded = dateAdded; this.patchVersion = patchVersion; + this.description = description; } /** @@ -34,12 +37,13 @@ public PatchMetaData(String platform, String location, String hash, String dateA * @param location file path of the patch * @param patchVersion version */ - public PatchMetaData(String platform, String location, String patchVersion) { + public PatchMetaData(String platform, String location, String patchVersion, String description) { this.platform = platform; this.location = location; this.hash = Utils.getSha256Hash(location); this.dateAdded = Utils.getTodayDate(); this.patchVersion = patchVersion; + this.description = description; } public String getPlatform() { @@ -62,6 +66,10 @@ public String getPatchVersion() { return patchVersion; } + public String getDescription() { + return description; + } + @Override public String toString() { return "PatchMetaData{" @@ -70,6 +78,7 @@ public String toString() { + ", hash='" + hash + '\'' + ", dateAdded='" + dateAdded + '\'' + ", patchVersion='" + patchVersion + '\'' + + ", description='" + description + '\'' + '}'; } } diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/ConfigManager.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/ConfigManager.java index b4ba0c5a..622971b6 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/ConfigManager.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/ConfigManager.java @@ -65,8 +65,8 @@ public void saveAllPatches(Map> allPatches, String l } public void addPatch(String bugNumber, String patchArchitecture, String patchLocation, - String patchVersion) throws IOException { - userSettingsFile.addPatch(bugNumber, patchArchitecture, patchLocation, patchVersion); + String patchVersion, String description) throws IOException { + userSettingsFile.addPatch(bugNumber, patchArchitecture, patchLocation, patchVersion, description); } public PatchMetaData getPatchForPlatform(String platformName, String bugNumber, String version) { @@ -163,7 +163,8 @@ private PatchMetaData createPatchMetaData(Map objectData) { String location = (String) objectData.get("location"); String productVersion = (String) objectData.get("version"); String platform = (String) objectData.get("platform"); - return new PatchMetaData(platform, location, hash, dateAdded, productVersion); + String description = (String) objectData.get("description"); + return new PatchMetaData(platform, location, hash, dateAdded, productVersion, description); } diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/UserSettingsFile.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/UserSettingsFile.java index b0bdbad0..53e764bb 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/UserSettingsFile.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/UserSettingsFile.java @@ -21,6 +21,7 @@ import com.oracle.weblogic.imagetool.logging.LoggingFactory; import com.oracle.weblogic.imagetool.patch.PatchMetaData; import com.oracle.weblogic.imagetool.util.Architecture; +import com.oracle.weblogic.imagetool.util.Utils; import static com.oracle.weblogic.imagetool.aru.AruUtil.getAruPlatformId; import static com.oracle.weblogic.imagetool.util.Utils.getTodayDate; @@ -277,7 +278,8 @@ private PatchMetaData createPatchMetaData(Map objectData) { String location = (String) objectData.get("location"); String productVersion = (String) objectData.get("version"); String platform = (String) objectData.get("platform"); - return new PatchMetaData(platform, location, hash, dateAdded, productVersion); + String description = (String) objectData.get("description"); + return new PatchMetaData(platform, location, hash, dateAdded, productVersion, description); } /** @@ -410,12 +412,14 @@ public InstallerMetaData getInstallerForPlatform(InstallerType installerType, Ar return installerMetaData; } } - //If it can't find the specialized platform, try generic. - //for (InstallerMetaData installerMetaData: installerMetaDataList) { - // if (Architecture.GENERIC.getAcceptableNames().contains(installerMetaData.getPlatform())) { - // return installerMetaData; - // } - //} + if (Utils.isGenericInstallerAcceptable(installerType)) { + //If it can't find the specialized platform, try generic. + for (InstallerMetaData installerMetaData: installerMetaDataList) { + if (Architecture.GENERIC.getAcceptableNames().contains(installerMetaData.getPlatform())) { + return installerMetaData; + } + } + } } } return null; @@ -431,12 +435,15 @@ public InstallerMetaData getInstallerForPlatform(InstallerType installerType, Ar * @throws IOException error */ public void addPatch(String bugNumber, String patchArchitecture, String patchLocation, - String patchVersion) throws IOException { + String patchVersion, String description) throws IOException { ConfigManager configManager = ConfigManager.getInstance(); Map> patches = configManager.getAllPatches(); List latestPatches = patches.get(bugNumber); - PatchMetaData latestPatch = new PatchMetaData(patchArchitecture, patchLocation, patchVersion); - latestPatches.add(latestPatch); + if (latestPatches == null) { + latestPatches = new ArrayList<>(); + } + PatchMetaData newPatch = new PatchMetaData(patchArchitecture, patchLocation, patchVersion, description); + latestPatches.add(newPatch); patches.put(bugNumber, latestPatches); configManager.saveAllPatches(patches, configManager.getPatchDetailsFile()); } @@ -556,6 +563,9 @@ public void saveAllPatches(Map> allPatches, String l map.put("digest", patchMetaData.getHash()); map.put("added", patchMetaData.getDateAdded()); map.put("platform", patchMetaData.getPlatform()); + if (patchMetaData.getDescription() != null) { + map.put("description", patchMetaData.getDescription()); + } list.add(map); } } else { @@ -566,6 +576,9 @@ public void saveAllPatches(Map> allPatches, String l map.put("digest", patchMetaData.getHash()); map.put("added", patchMetaData.getDateAdded()); map.put("platform", patchMetaData.getPlatform()); + if (patchMetaData.getDescription() != null) { + map.put("description", patchMetaData.getDescription()); + } list.add(map); } patchList.put(key, list); diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/util/Utils.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/util/Utils.java index 621bbcff..54ebfd6e 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/util/Utils.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/util/Utils.java @@ -45,6 +45,7 @@ import com.github.mustachejava.DefaultMustacheFactory; import com.github.mustachejava.Mustache; import com.github.mustachejava.MustacheFactory; +import com.oracle.weblogic.imagetool.installer.InstallerType; import com.oracle.weblogic.imagetool.logging.LoggingFacade; import com.oracle.weblogic.imagetool.logging.LoggingFactory; import org.jetbrains.annotations.NonNls; @@ -857,4 +858,16 @@ public static String standardPlatform(String platform) { return "Generic"; } + /** + * Return true if it is ok to return the generic installer if the specific architecture is not available. + * @param type installer type + * @return true if it is ok return the generic installer if the specific architecture is not available + */ + public static boolean isGenericInstallerAcceptable(InstallerType type) { + List types = Arrays.asList(InstallerType.WDT); + if (types.contains(type)) { + return true; + } + return false; + } } diff --git a/imagetool/src/main/resources/ImageTool.properties b/imagetool/src/main/resources/ImageTool.properties index bbb81e2f..0b5fbe77 100644 --- a/imagetool/src/main/resources/ImageTool.properties +++ b/imagetool/src/main/resources/ImageTool.properties @@ -48,7 +48,7 @@ IMG-0046=Deleted all entries from cache IMG-0047=cache is empty IMG-0048=Entry {0} already exists as {1}. Use --force to override the entry, or remove the existing entry first: imagetool cache deleteEntry --key={0} IMG-0049=File not found, invalid value for --path {0} -IMG-0050=Successfully added to cache. [[cyan: {0}]]={1} +IMG-0050=Successfully added installer to cache. [[cyan: type:]] {0} [[cyan: version:]] {1} [[cyan: filepath:]] {2} IMG-0051=Deleted entry [[cyan: {0}]]={1} IMG-0052=Nothing to delete for key: {0} IMG-0053=[[brightgreen: Build successful.]] Build time={0}s. Image tag={1} @@ -127,3 +127,5 @@ IMG-0125=Specified installer to delete cannot be found. IMG-0126=You must specify --patchId --version and --architecture for deleting a patchr. IMG-0127=Specified installer to delete cannot be found. IMG-0128=Cannot parse version 1 metadata file line: {0}. +IMG-0129=Missing --architecture value for adding installer type {0}. +IMG-0130=Successfully added patch to cache. [[cyan: bug:]] {0} [[cyan: version:]] {1} [[cyan: filepath:]] {2} diff --git a/imagetool/src/test/java/com/oracle/weblogic/imagetool/cachestore/CachedFileTest.java b/imagetool/src/test/java/com/oracle/weblogic/imagetool/cachestore/CachedFileTest.java index 5503d885..43f23905 100644 --- a/imagetool/src/test/java/com/oracle/weblogic/imagetool/cachestore/CachedFileTest.java +++ b/imagetool/src/test/java/com/oracle/weblogic/imagetool/cachestore/CachedFileTest.java @@ -109,7 +109,7 @@ private static void addPatchesToLocal(Path tempDir, ConfigManager configManager, Path path = tempDir.resolve(patchLocation); Files.write(path, fileContents); PatchMetaData latestPatch = new PatchMetaData(patchArchitecture, path.toAbsolutePath().toString(), - Utils.getSha256Hash(path.toAbsolutePath().toString()),"2024-10-17", patchVersion); + Utils.getSha256Hash(path.toAbsolutePath().toString()),"2024-10-17", patchVersion,""); latestPatches.add(latestPatch); patches.put(bugNumber, latestPatches); configManager.saveAllPatches(patches, patchListingFile.toAbsolutePath().toString()); diff --git a/imagetool/src/test/java/com/oracle/weblogic/imagetool/cachestore/OPatchFileTest.java b/imagetool/src/test/java/com/oracle/weblogic/imagetool/cachestore/OPatchFileTest.java index 7ef7ae76..42ff3672 100644 --- a/imagetool/src/test/java/com/oracle/weblogic/imagetool/cachestore/OPatchFileTest.java +++ b/imagetool/src/test/java/com/oracle/weblogic/imagetool/cachestore/OPatchFileTest.java @@ -83,7 +83,7 @@ private static void addPatchesToLocal(Path tempDir, ConfigManager configManager, Path path = tempDir.resolve(patchLocation); Files.write(path, fileContents); PatchMetaData latestPatch = new PatchMetaData(patchArchitecture, path.toAbsolutePath().toString(), - Utils.getSha256Hash(path.toAbsolutePath().toString()),"2024-10-17", patchVersion); + Utils.getSha256Hash(path.toAbsolutePath().toString()),"2024-10-17", patchVersion, ""); latestPatches.add(latestPatch); patches.put(bugNumber, latestPatches); configManager.saveAllPatches(patches, patchListingFile.toAbsolutePath().toString()); diff --git a/imagetool/src/test/java/com/oracle/weblogic/imagetool/cachestore/PatchFileTest.java b/imagetool/src/test/java/com/oracle/weblogic/imagetool/cachestore/PatchFileTest.java index 41e7d986..e8e12111 100644 --- a/imagetool/src/test/java/com/oracle/weblogic/imagetool/cachestore/PatchFileTest.java +++ b/imagetool/src/test/java/com/oracle/weblogic/imagetool/cachestore/PatchFileTest.java @@ -128,7 +128,7 @@ private static void addPatchesToLocal(Path tempDir, ConfigManager configManager, Path path = tempDir.resolve(patchLocation); Files.write(path, fileContents); PatchMetaData latestPatch = new PatchMetaData(patchArchitecture, path.toAbsolutePath().toString(), - Utils.getSha256Hash(path.toAbsolutePath().toString()),"2024-10-17", patchVersion); + Utils.getSha256Hash(path.toAbsolutePath().toString()),"2024-10-17", patchVersion, ""); latestPatches.add(latestPatch); patches.put(bugNumber, latestPatches); configManager.saveAllPatches(patches, patchListingFile.toAbsolutePath().toString()); diff --git a/imagetool/src/test/java/com/oracle/weblogic/imagetool/cli/cache/AddInstallerEntryTest.java b/imagetool/src/test/java/com/oracle/weblogic/imagetool/cli/cache/AddInstallerEntryTest.java index ca161aef..8b8144f9 100644 --- a/imagetool/src/test/java/com/oracle/weblogic/imagetool/cli/cache/AddInstallerEntryTest.java +++ b/imagetool/src/test/java/com/oracle/weblogic/imagetool/cli/cache/AddInstallerEntryTest.java @@ -3,9 +3,18 @@ package com.oracle.weblogic.imagetool.cli.cache; +import java.io.IOException; +import java.nio.file.Files; +import java.nio.file.Path; +import java.util.Arrays; +import java.util.List; + import com.oracle.weblogic.imagetool.installer.InstallerType; +import com.oracle.weblogic.imagetool.settings.ConfigManager; +import org.junit.jupiter.api.BeforeAll; import org.junit.jupiter.api.Tag; import org.junit.jupiter.api.Test; +import org.junit.jupiter.api.io.TempDir; import picocli.CommandLine; import static org.junit.jupiter.api.Assertions.assertEquals; @@ -14,6 +23,28 @@ @Tag("unit") class AddInstallerEntryTest { + + @BeforeAll + static void setup(@TempDir Path tempDir) + throws IOException, NoSuchFieldException, IllegalAccessException { + Path settingsFileName = tempDir.resolve("settings.yaml"); + Path installerFile = tempDir.resolve("installers.yaml"); + Path patchFile = tempDir.resolve("patches.yaml"); + Files.createFile(settingsFileName); + Files.createFile(installerFile); + Files.createFile(patchFile); + + + List lines = Arrays.asList( + "installerSettingsFile: " + installerFile.toAbsolutePath().toString(), + "patchSettingsFile: " + patchFile.toAbsolutePath().toString(), + "installerDirectory: " + tempDir.toAbsolutePath().toString(), + "patchDirectory: " + tempDir.toAbsolutePath().toString() + ); + Files.write(settingsFileName, lines); + ConfigManager.getInstance(settingsFileName); + } + @Test void testMissingParameters() { final AddInstallerEntry addCommand = new AddInstallerEntry(); @@ -29,13 +60,13 @@ void testWrongType() { // The value for --type must be one of the pre-defined types CommandLine.ParameterException pe = assertThrows(CommandLine.ParameterException.class, () -> new CommandLine(addCommand) - .parseArgs("--type", "a2z", "--version", "some_value", "--path", "/path/to/a/file") + .parseArgs("--type", "a2z", "--version", "some_value", "-a", "amd64", "--path", "/path/to/a/file") ); assertTrue(pe.getMessage().contains("--type")); // repeat same command but use a valid type. No exception should be thrown. new CommandLine(addCommand) - .parseArgs("--type", "WLS", "--version", "some_value", "--path", "/path/to/a/file"); + .parseArgs("--type", "WLS", "--version", "some_value", "-a", "amd64", "--path", "/path/to/a/file"); } @Test @@ -54,7 +85,7 @@ void testValidParameters() { final AddInstallerEntry addCommand = new AddInstallerEntry(); // The cache key should be a string made up of the type and version seperated by an underscore new CommandLine(addCommand) - .parseArgs("--type", "WLS", "--version", "12.2.1.4", "--path", "/path/to/a/file"); + .parseArgs("--type", "WLS", "--version", "12.2.1.4", "-a", "amd64", "--path", "/path/to/a/file"); assertEquals("wls", addCommand.getKey()); } diff --git a/imagetool/src/test/java/com/oracle/weblogic/imagetool/cli/cache/AddPatchEntryTest.java b/imagetool/src/test/java/com/oracle/weblogic/imagetool/cli/cache/AddPatchEntryTest.java index c4d3bd7c..2bb3b0da 100644 --- a/imagetool/src/test/java/com/oracle/weblogic/imagetool/cli/cache/AddPatchEntryTest.java +++ b/imagetool/src/test/java/com/oracle/weblogic/imagetool/cli/cache/AddPatchEntryTest.java @@ -3,15 +3,22 @@ package com.oracle.weblogic.imagetool.cli.cache; +import java.io.IOException; import java.io.PrintWriter; import java.io.StringWriter; +import java.nio.file.Files; +import java.nio.file.Path; import java.util.Arrays; +import java.util.List; import com.oracle.weblogic.imagetool.api.model.CommandResponse; +import com.oracle.weblogic.imagetool.settings.ConfigManager; import com.oracle.weblogic.imagetool.util.InvalidPatchIdFormatException; import com.oracle.weblogic.imagetool.util.Utils; +import org.junit.jupiter.api.BeforeAll; import org.junit.jupiter.api.Tag; import org.junit.jupiter.api.Test; +import org.junit.jupiter.api.io.TempDir; import picocli.CommandLine; import static org.junit.jupiter.api.Assertions.assertEquals; @@ -22,6 +29,28 @@ @Tag("unit") class AddPatchEntryTest { + @BeforeAll + static void setup(@TempDir Path tempDir) + throws IOException, NoSuchFieldException, IllegalAccessException { + Path settingsFileName = tempDir.resolve("settings.yaml"); + Path installerFile = tempDir.resolve("installers.yaml"); + Path patchFile = tempDir.resolve("patches.yaml"); + Files.createFile(settingsFileName); + Files.createFile(installerFile); + Files.createFile(patchFile); + + + List lines = Arrays.asList( + "installerSettingsFile: " + installerFile.toAbsolutePath().toString(), + "patchSettingsFile: " + patchFile.toAbsolutePath().toString(), + "installerDirectory: " + tempDir.toAbsolutePath().toString(), + "patchDirectory: " + tempDir.toAbsolutePath().toString() + ); + Files.write(settingsFileName, lines); + ConfigManager.getInstance(settingsFileName); + } + + private static CommandLine getCommand() { AddPatchEntry app = new AddPatchEntry(); CommandLine cmd = new CommandLine(app); @@ -45,20 +74,20 @@ void testMissingParameters() { void testInvalidFileParameter() { CommandLine cmd = getCommand(); // invalid file (file does not exist), should generate an error response - cmd.execute("--patchId=12345678_12.2.1.3.0", "--path=/here/there", "--version=12.2.1.3.0"); + cmd.execute("--patchId=12345678_12.2.1.3.0", "--path=/here/there", "--version=12.2.1.3.0", + "-a=amd64"); CommandResponse result = cmd.getExecutionResult(); assertNotNull(result, "Response missing from call to addPatch"); assertEquals(1, result.getStatus()); } @Test - void testInvalidPatchId() { + void testValidPatchId() { CommandLine cmd = getCommand(); - // invalid patch ID should generate an error response - cmd.execute("--patchId=12345678", "--path=pom.xml", "--version=12.2.1.3.0"); + cmd.execute("--patchId=12345678", "--path=pom.xml", "--version=12.2.1.3.0", "-a=amd64"); CommandResponse result = cmd.getExecutionResult(); assertNotNull(result, "Response missing from call to addPatch"); - assertEquals(1, result.getStatus()); + assertEquals(0, result.getStatus()); } @Test diff --git a/tests/src/test/java/com/oracle/weblogic/imagetool/tests/ITImagetool.java b/tests/src/test/java/com/oracle/weblogic/imagetool/tests/ITImagetool.java index 4543ba56..020afca6 100644 --- a/tests/src/test/java/com/oracle/weblogic/imagetool/tests/ITImagetool.java +++ b/tests/src/test/java/com/oracle/weblogic/imagetool/tests/ITImagetool.java @@ -569,7 +569,8 @@ void cacheAddInstallerFmw(TestInfo testInfo) throws Exception { // the process return code for listItems should be 0 assertEquals(0, listResult.exitValue(), "for command: " + listCommand); // output should show newly added WLS installer - assertTrue(listResult.stdout().contains("fmw_" + WLS_VERSION + "=")); + assertTrue(listResult.stdout().contains("type: fmw")); + assertTrue(listResult.stdout().contains("version: " + WLS_VERSION)); } } From 524957f013b11a386bebdd9f91257d1e5e5408e5 Mon Sep 17 00:00:00 2001 From: jshum Date: Tue, 26 Nov 2024 17:30:29 -0600 Subject: [PATCH 045/104] First fix for integration test - gating --- .../imagetool/cachestore/OPatchFile.java | 2 +- .../imagetool/cli/cache/ListInstallers.java | 31 ++- .../imagetool/cli/cache/ListPatches.java | 24 +- .../cli/menu/CommonPatchingOptions.java | 12 +- .../imagetool/settings/ConfigManager.java | 13 +- .../imagetool/settings/UserSettingsFile.java | 2 +- .../src/main/resources/ImageTool.properties | 2 +- .../docker-files/Rebase_Image.mustache | 4 + .../docker-files/Update_Image.mustache | 2 + .../docker-files/fmw-patching.mustache | 8 +- .../install-middleware-pkg.mustache | 2 +- .../docker-files/install-middleware.mustache | 9 +- .../cli/cache/AddInstallerEntryTest.java | 25 +- .../weblogic/imagetool/util/TestSetup.java | 35 +++ .../weblogic/imagetool/tests/ITImagetool.java | 236 ++++++++++++------ .../imagetool/tests/utils/CacheCommand.java | 32 ++- .../tests/utils/CreateAuxCommand.java | 10 +- .../imagetool/tests/utils/CreateCommand.java | 10 +- .../imagetool/tests/utils/RebaseCommand.java | 7 + .../imagetool/tests/utils/UpdateCommand.java | 8 + .../test/resources/wdt/simple-topology1.yaml | 1 + 21 files changed, 347 insertions(+), 128 deletions(-) create mode 100644 imagetool/src/test/java/com/oracle/weblogic/imagetool/util/TestSetup.java diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cachestore/OPatchFile.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cachestore/OPatchFile.java index 82f1ce37..eec72685 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cachestore/OPatchFile.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cachestore/OPatchFile.java @@ -191,7 +191,7 @@ public String resolve() throws IOException { try { return super.resolve(); } catch (FileNotFoundException fnfe) { - throw new FileNotFoundException(Utils.getMessage("IMG-0062")); + throw new FileNotFoundException(Utils.getMessage("IMG-0062", this.getVersion())); } } diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/ListInstallers.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/ListInstallers.java index fe67dea7..06f85c3f 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/ListInstallers.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/ListInstallers.java @@ -25,13 +25,31 @@ public class ListInstallers extends CacheOperation { public CommandResponse call() throws CacheStoreException { ConfigManager configManager = ConfigManager.getInstance(); Map>> data = configManager.getInstallers(); - + if (commonName != null && !commonName.isEmpty()) { + if (type == null) { + System.out.println("--type cannot be null when commonName is specified"); + System.exit(2); + } + } + if (version != null && !version.isEmpty()) { + if (type == null) { + System.out.println("--type cannot be null when version is specified"); + System.exit(2); + } + } for (InstallerType itemType : data.keySet()) { if (type != null && type != itemType) { continue; } System.out.println(itemType + ":"); data.get(itemType).forEach((installer, metaData) -> { + if (commonName != null && !commonName.equalsIgnoreCase(installer)) { + return; + } + // commonName is null or version is specified + if (version != null && !version.equalsIgnoreCase(installer)) { + return; + } System.out.println(" " + installer + ":"); for (InstallerMetaData meta : metaData) { System.out.println(" - location: " + meta.getLocation()); @@ -52,4 +70,15 @@ public CommandResponse call() throws CacheStoreException { ) private InstallerType type; + @Option( + names = {"--commonName"}, + description = "Filter installer by common name." + ) + private String commonName; + + @Option( + names = {"--version"}, + description = "Filter installer by version." + ) + private String version; } diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/ListPatches.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/ListPatches.java index 06143df7..5a2dac17 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/ListPatches.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/ListPatches.java @@ -25,13 +25,24 @@ public CommandResponse call() throws CacheStoreException { ConfigManager configManager = ConfigManager.getInstance(); Map> data = configManager.getAllPatches(); + if (version != null && !version.isEmpty()) { + if (patchId == null) { + System.out.println("--patchId cannot be null when version is specified"); + System.exit(2); + } + } for (String bug : data.keySet()) { - if (bugNumber != null && !bugNumber.equalsIgnoreCase(bug)) { + if (patchId != null && !patchId.equalsIgnoreCase(bug)) { continue; } System.out.println(bug + ":"); data.get(bug).forEach((metaData) -> { + if (version != null && !version.isEmpty()) { + if (!version.equalsIgnoreCase(metaData.getPatchVersion())) { + return; + } + } System.out.println(" - location: " + metaData.getLocation()); System.out.println(" platform: " + metaData.getPlatform()); System.out.println(" digest: " + metaData.getHash()); @@ -45,9 +56,14 @@ public CommandResponse call() throws CacheStoreException { } @Option( - names = {"--bug"}, - description = "Bug number" + names = {"--patchId"}, + description = "Patch id" ) - private String bugNumber; + private String patchId; + @Option( + names = {"--version"}, + description = "Patch version" + ) + private String version; } diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonPatchingOptions.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonPatchingOptions.java index cb098dde..931e0467 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonPatchingOptions.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonPatchingOptions.java @@ -158,6 +158,8 @@ void handlePatchFiles(List installedPatches) ConfigManager configManager = ConfigManager.getInstance(); for (AruPatch patch : aruPatches) { String platform = patch.platformName(); + logger.info("Applying patch " + patch.patchId() + " version " + patch.version() + + " to " + platform); PatchMetaData metaData = configManager.getPatchForPlatform(platform, patch.patchId(), patch.version()); if (metaData == null) { @@ -175,18 +177,20 @@ void handlePatchFiles(List installedPatches) String patchLocation = metaData.getLocation(); if (patchLocation != null && !Utils.isEmptyString(patchLocation)) { + logger.finer("Patch location " + patchLocation + " platform " + platform); File cacheFile = new File(patchLocation); try { if (patch.fileName() == null) { patch.fileName(cacheFile.getName()); } - if (platform.equals(AMD64_BLD)) { - Files.copy(Paths.get(patchLocation), Paths.get(patchesFolderName, AMD64_BLD, - cacheFile.getName())); - } else { + if (platform.equals(ARM64_BLD) || platform.equalsIgnoreCase("generic")) { Files.copy(Paths.get(patchLocation), Paths.get(patchesFolderName, ARM64_BLD, cacheFile.getName())); } + if (platform.equals(AMD64_BLD) || platform.equalsIgnoreCase("generic")) { + Files.copy(Paths.get(patchLocation), Paths.get(patchesFolderName, AMD64_BLD, + cacheFile.getName())); + } } catch (FileAlreadyExistsException ee) { logger.warning("IMG-0077", patch.patchId()); } diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/ConfigManager.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/ConfigManager.java index 622971b6..48466ea1 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/ConfigManager.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/ConfigManager.java @@ -4,6 +4,7 @@ package com.oracle.weblogic.imagetool.settings; import java.io.IOException; +import java.nio.file.Files; import java.nio.file.Path; import java.nio.file.Paths; import java.util.EnumMap; @@ -18,6 +19,7 @@ import com.oracle.weblogic.imagetool.patch.PatchMetaData; import com.oracle.weblogic.imagetool.util.Architecture; +import static com.oracle.weblogic.imagetool.cachestore.FileCacheStore.CACHE_DIR_ENV; import static com.oracle.weblogic.imagetool.util.Utils.getTodayDate; public class ConfigManager { @@ -39,9 +41,14 @@ private ConfigManager(Path userSettingsFileName) { */ public static synchronized ConfigManager getInstance() { if (instance == null) { - instance = new ConfigManager(Paths.get(System.getProperty("user.home"), ".imagetool", - "settings.yaml")); - + String result = System.getenv(CACHE_DIR_ENV); + if (result != null) { + if (Files.exists(Paths.get(result, "settings.yaml"))) { + return new ConfigManager(Paths.get(result, "settings.yaml")); + } + } + return new ConfigManager(Paths.get(System.getProperty("user.home"), ".imagetool", + "settings.yaml")); } return instance; } diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/UserSettingsFile.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/UserSettingsFile.java index 53e764bb..b3d29b7b 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/UserSettingsFile.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/UserSettingsFile.java @@ -476,7 +476,7 @@ public PatchMetaData getPatchForPlatform(String platformName, String bugNumber, // search for generic for opatch only?? if (OPatchFile.DEFAULT_BUG_NUM.equals(bugNumber)) { for (PatchMetaData patchMetaData: patchMetaDataList) { - if ("generic".equals(patchMetaData.getPlatform())) { + if ("generic".equalsIgnoreCase(patchMetaData.getPlatform())) { return patchMetaData; } } diff --git a/imagetool/src/main/resources/ImageTool.properties b/imagetool/src/main/resources/ImageTool.properties index 0b5fbe77..ad5e7b30 100644 --- a/imagetool/src/main/resources/ImageTool.properties +++ b/imagetool/src/main/resources/ImageTool.properties @@ -60,7 +60,7 @@ IMG-0058=A patch cannot have an empty/null bug number: {0} IMG-0059=Invalid response from Oracle ARU, unable to locate download URL for {0} IMG-0060=Adding patch [[cyan: {0}]] to cache, path={1} IMG-0061=Could not find key {0} in the cache for patch {1} -IMG-0062=An OPatch version could not be found in the cache store and you have not provided Oracle Support credentials. Please provide --user with one of the password options or populate the cache store manually. +IMG-0062=An OPatch version {0} could not be found in the cache store and you have not provided Oracle Support credentials. Please provide --user with one of the password options or populate the cache store manually. IMG-0063=Requesting patch information for patch {0} IMG-0064=Failed to copy file, {0}, from cache to build context directory, {1} IMG-0065=Skipping OPatch version update, --skipOPatchUpdate diff --git a/imagetool/src/main/resources/docker-files/Rebase_Image.mustache b/imagetool/src/main/resources/docker-files/Rebase_Image.mustache index ba5820ea..2fd3bbd1 100644 --- a/imagetool/src/main/resources/docker-files/Rebase_Image.mustache +++ b/imagetool/src/main/resources/docker-files/Rebase_Image.mustache @@ -7,6 +7,7 @@ FROM {{sourceImage}} as source_image FROM {{targetImage}} as final_build {{#buildArgs}}ARG {{{.}}} {{/buildArgs}} +ARG TARGETPLATFORM ENV DOMAIN_HOME={{{domain_home}}} LABEL com.oracle.weblogic.imagetool.buildid="{{buildId}}" @@ -15,6 +16,7 @@ LABEL com.oracle.weblogic.imagetool.buildid="{{buildId}}" {{#isRebaseToNew}} FROM {{sourceImage}} as source_image FROM {{baseImage}} as os_update + ARG TARGETPLATFORM ENV DOMAIN_HOME={{{domain_home}}} @@ -42,6 +44,8 @@ LABEL com.oracle.weblogic.imagetool.buildid="{{buildId}}" FROM os_update as final_build {{#buildArgs}}ARG {{{.}}} {{/buildArgs}} + ARG TARGETPLATFORM + ENV ORACLE_HOME={{{oracle_home}}} \ LD_LIBRARY_PATH={{{oracle_home}}}/oracle_common/adr:$LD_LIBRARY_PATH \ {{#installJava}} diff --git a/imagetool/src/main/resources/docker-files/Update_Image.mustache b/imagetool/src/main/resources/docker-files/Update_Image.mustache index 03388629..c70a327d 100644 --- a/imagetool/src/main/resources/docker-files/Update_Image.mustache +++ b/imagetool/src/main/resources/docker-files/Update_Image.mustache @@ -9,6 +9,8 @@ FROM {{baseImage}} as final_build {{#buildArgs}}ARG {{{.}}} {{/buildArgs}} +ARG TARGETPLATFORM + USER root ENV OPATCH_NO_FUSER=true diff --git a/imagetool/src/main/resources/docker-files/fmw-patching.mustache b/imagetool/src/main/resources/docker-files/fmw-patching.mustache index 204e08ad..0c7e3257 100644 --- a/imagetool/src/main/resources/docker-files/fmw-patching.mustache +++ b/imagetool/src/main/resources/docker-files/fmw-patching.mustache @@ -18,18 +18,18 @@ {{^strictPatchOrdering}} # Apply all patches provided at the same time RUN if [ "$(ls -A {{{tempDir}}}/patches/$TARGETPLATFORM)" ] ; then \ - && {{{oracle_home}}}/OPatch/opatch napply -silent -oh {{{oracle_home}}} -nonrollbackable -phBaseDir {{{tempDir}}}/patches/$TARGETPLATFORM \ + {{{oracle_home}}}/OPatch/opatch napply -silent -oh {{{oracle_home}}} -nonrollbackable -phBaseDir {{{tempDir}}}/patches/$TARGETPLATFORM \ && test $? -eq 0 \ && {{{oracle_home}}}/OPatch/opatch util cleanup -silent -oh {{{oracle_home}}} \ || (cat {{{oracle_home}}}/cfgtoollogs/opatch/opatch*.log && exit 1) \ - && fi + fi {{/strictPatchOrdering}} {{#strictPatchOrdering}} # Apply one patch at a time in the order they were specified {{#patches}} RUN if [ "$(ls -A {{{tempDir}}}/patches/$TARGETPLATFORM)" ] ; then \ - && {{{oracle_home}}}/OPatch/opatch apply -silent -oh {{{oracle_home}}} -nonrollbackable {{{tempDir}}}/$TARGETPLATFORMpatches/$TARGETPLATFORM/{{{.}}} \ - && fi + {{{oracle_home}}}/OPatch/opatch apply -silent -oh {{{oracle_home}}} -nonrollbackable {{{tempDir}}}/$TARGETPLATFORMpatches/$TARGETPLATFORM/{{{.}}} \ + fi {{/patches}} RUN {{{oracle_home}}}/OPatch/opatch util cleanup -silent -oh {{{oracle_home}}} {{/strictPatchOrdering}} diff --git a/imagetool/src/main/resources/docker-files/install-middleware-pkg.mustache b/imagetool/src/main/resources/docker-files/install-middleware-pkg.mustache index 3a44581c..b3e328c6 100644 --- a/imagetool/src/main/resources/docker-files/install-middleware-pkg.mustache +++ b/imagetool/src/main/resources/docker-files/install-middleware-pkg.mustache @@ -1,4 +1,4 @@ -echo "INSTALLING {{type}}" \ +&& echo "INSTALLING {{type}}" \ {{#isZip}}&& unzip -q {{{tempDir}}}/{{{type}}}/$TARGETPLATFORM/{{installerFilename}} -d {{{tempDir}}}/{{{type}}} {{/isZip}} \ {{#preinstallCommands}}&& {{{tempDir}}}/{{{type}}}/{{{.}}} {{/preinstallCommands}} \ {{^isBin}} && if [ ! -f {{{tempDir}}}/{{{type}}}/{{jarName}} ] ; then (cp {{{tempDir}}}/{{{type}}}/$TARGETPLATFORM/{{installerFilename}} {{{tempDir}}}/{{{type}}}) fi \ diff --git a/imagetool/src/main/resources/docker-files/install-middleware.mustache b/imagetool/src/main/resources/docker-files/install-middleware.mustache index 69cafc25..77c986cf 100644 --- a/imagetool/src/main/resources/docker-files/install-middleware.mustache +++ b/imagetool/src/main/resources/docker-files/install-middleware.mustache @@ -51,16 +51,17 @@ RUN if [ "$TARGETPLATFORM" == "linux/arm64" ] ; then \ {{/installPackagesForARM}} && test $? -eq 0 \ && chmod -R g+r {{{oracle_home}}} \ - || (grep -vh "NOTIFICATION" /tmp/OraInstall*/install*.log && exit 1) \ - fi && if [ "$TARGETPLATFORM" == "linux/amd64" ] ; then \ + || (grep -vh "NOTIFICATION" /tmp/OraInstall*/install*.log && exit 1); \ + fi && \ + if [ "$TARGETPLATFORM" == "linux/amd64" ] ; then \ echo "INSTALLING MIDDLEWARE" \ {{#installPackagesForAMD}} {{> install-middleware-pkg }} {{/installPackagesForAMD}} && test $? -eq 0 \ && chmod -R g+r {{{oracle_home}}} \ - || (grep -vh "NOTIFICATION" /tmp/OraInstall*/install*.log && exit 1) \ - fi + || (grep -vh "NOTIFICATION" /tmp/OraInstall*/install*.log && exit 1); \ + fi {{#useOwnerPermsForGroup}} # OPatch needs write permissions to the logs folder and lock file when running in OpenShift diff --git a/imagetool/src/test/java/com/oracle/weblogic/imagetool/cli/cache/AddInstallerEntryTest.java b/imagetool/src/test/java/com/oracle/weblogic/imagetool/cli/cache/AddInstallerEntryTest.java index 8b8144f9..a00bedab 100644 --- a/imagetool/src/test/java/com/oracle/weblogic/imagetool/cli/cache/AddInstallerEntryTest.java +++ b/imagetool/src/test/java/com/oracle/weblogic/imagetool/cli/cache/AddInstallerEntryTest.java @@ -4,13 +4,10 @@ package com.oracle.weblogic.imagetool.cli.cache; import java.io.IOException; -import java.nio.file.Files; import java.nio.file.Path; -import java.util.Arrays; -import java.util.List; import com.oracle.weblogic.imagetool.installer.InstallerType; -import com.oracle.weblogic.imagetool.settings.ConfigManager; +import com.oracle.weblogic.imagetool.util.TestSetup; import org.junit.jupiter.api.BeforeAll; import org.junit.jupiter.api.Tag; import org.junit.jupiter.api.Test; @@ -25,24 +22,8 @@ class AddInstallerEntryTest { @BeforeAll - static void setup(@TempDir Path tempDir) - throws IOException, NoSuchFieldException, IllegalAccessException { - Path settingsFileName = tempDir.resolve("settings.yaml"); - Path installerFile = tempDir.resolve("installers.yaml"); - Path patchFile = tempDir.resolve("patches.yaml"); - Files.createFile(settingsFileName); - Files.createFile(installerFile); - Files.createFile(patchFile); - - - List lines = Arrays.asList( - "installerSettingsFile: " + installerFile.toAbsolutePath().toString(), - "patchSettingsFile: " + patchFile.toAbsolutePath().toString(), - "installerDirectory: " + tempDir.toAbsolutePath().toString(), - "patchDirectory: " + tempDir.toAbsolutePath().toString() - ); - Files.write(settingsFileName, lines); - ConfigManager.getInstance(settingsFileName); + static void setup(@TempDir Path tempDir) throws IOException, NoSuchFieldException, IllegalAccessException { + TestSetup.setup(tempDir); } @Test diff --git a/imagetool/src/test/java/com/oracle/weblogic/imagetool/util/TestSetup.java b/imagetool/src/test/java/com/oracle/weblogic/imagetool/util/TestSetup.java new file mode 100644 index 00000000..45ff1401 --- /dev/null +++ b/imagetool/src/test/java/com/oracle/weblogic/imagetool/util/TestSetup.java @@ -0,0 +1,35 @@ +// Copyright (c) 2024, 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.util; + +import java.io.IOException; +import java.nio.file.Files; +import java.nio.file.Path; +import java.util.Arrays; +import java.util.List; + +import com.oracle.weblogic.imagetool.settings.ConfigManager; +import org.junit.jupiter.api.io.TempDir; + +public class TestSetup { + public static void setup(@TempDir Path tempDir) throws IOException { + Path settingsFileName = tempDir.resolve("settings.yaml"); + Path installerFile = tempDir.resolve("installers.yaml"); + Path patchFile = tempDir.resolve("patches.yaml"); + Files.createFile(settingsFileName); + Files.createFile(installerFile); + Files.createFile(patchFile); + + + List lines = Arrays.asList( + "installerSettingsFile: " + installerFile.toAbsolutePath().toString(), + "patchSettingsFile: " + patchFile.toAbsolutePath().toString(), + "installerDirectory: " + tempDir.toAbsolutePath().toString(), + "patchDirectory: " + tempDir.toAbsolutePath().toString() + ); + Files.write(settingsFileName, lines); + ConfigManager.getInstance(settingsFileName); + + } +} diff --git a/tests/src/test/java/com/oracle/weblogic/imagetool/tests/ITImagetool.java b/tests/src/test/java/com/oracle/weblogic/imagetool/tests/ITImagetool.java index 020afca6..0ea5a9e1 100644 --- a/tests/src/test/java/com/oracle/weblogic/imagetool/tests/ITImagetool.java +++ b/tests/src/test/java/com/oracle/weblogic/imagetool/tests/ITImagetool.java @@ -13,6 +13,8 @@ import java.nio.file.Paths; import java.nio.file.StandardCopyOption; import java.util.ArrayList; +import java.util.Arrays; +import java.util.Comparator; import java.util.List; import com.oracle.weblogic.imagetool.cli.menu.KubernetesTarget; @@ -38,8 +40,9 @@ import org.junit.jupiter.api.TestInfo; import org.junit.jupiter.api.TestMethodOrder; +import static com.oracle.weblogic.imagetool.cachestore.FileCacheStore.CACHE_DIR_ENV; import static org.junit.jupiter.api.Assertions.assertEquals; -import static org.junit.jupiter.api.Assertions.assertFalse; +//import static org.junit.jupiter.api.Assertions.assertFalse; import static org.junit.jupiter.api.Assertions.assertTrue; import static org.junit.jupiter.api.Assumptions.assumeTrue; @@ -54,6 +57,11 @@ class ITImagetool { private static final String STAGING_DIR = System.getProperty("STAGING_DIR"); private static final String BLDDIR_ENV = System.getProperty("WLSIMG_BLDDIR"); private static final String CACHEDIR_ENV = System.getProperty("WLSIMG_CACHEDIR"); + private static final String AMD64 = "amd64"; + private static final String ARM64 = "arm64"; + private static final String GENERIC = "Generic"; + private static final String PLATFORM_AMD64 = "linux/amd64"; + private static final String PLATFORM_ARN64 = "linux/arm64"; // Docker images private static String DB_IMAGE = System.getProperty("DB_IMAGE"); @@ -64,7 +72,7 @@ class ITImagetool { private static final String JDK_INSTALLER_NEWER = "jdk-8u231-linux-x64.tar.gz"; private static final String WLS_INSTALLER = "fmw_12.2.1.3.0_wls_Disk1_1of1.zip"; private static final String P27342434_INSTALLER = "p27342434_122130_Generic.zip"; - private static final String P28186730_INSTALLER = "p28186730_139422_Generic.zip"; + private static final String P28186730_INSTALLER = "p28186730_1394217_Generic.zip"; private static final String WDT_INSTALLER = "weblogic-deploy.zip"; private static final String FMW_INSTALLER = "fmw_12.2.1.3.0_infrastructure_Disk1_1of1.zip"; @@ -72,7 +80,7 @@ class ITImagetool { private static final String P27342434_ID = "27342434"; private static final String P28186730_ID = "28186730"; private static final String WLS_VERSION = "12.2.1.3.0"; - private static final String OPATCH_VERSION = "13.9.4.2.2"; + private static final String OPATCH_VERSION = "13.9.4.2.17"; private static final String JDK_VERSION = "8u202"; private static final String JDK_VERSION_212 = "8u212"; private static final String WDT_VERSION = "1.1.2"; @@ -202,8 +210,41 @@ private static void cleanup() throws Exception { static void staticPrepare() throws Exception { logger.info("prepare for image tool test ..."); // verify that all the prerequisites are set and exist + + validateEnvironmentSettings(); // clean up Docker instances leftover from a previous run + String baseDir = System.getProperty(CACHE_DIR_ENV); + + Path tempDir = Paths.get(baseDir); + if (Files.exists(tempDir)) { + Files.walk(tempDir) + .sorted(Comparator.reverseOrder()) + .forEach(path -> { + try { + Files.delete(path); + } catch (IOException ignore) { + ignore.printStackTrace(); + } + }); + } + Files.createDirectories(tempDir); + Path settingsFileName = tempDir.resolve("settings.yaml"); + Path installerFile = tempDir.resolve("installers.yaml"); + Path patchFile = tempDir.resolve("patches.yaml"); + Files.createFile(settingsFileName); + Files.createFile(installerFile); + Files.createFile(patchFile); + + List lines = Arrays.asList( + "installerSettingsFile: " + installerFile.toAbsolutePath().toString(), + "patchSettingsFile: " + patchFile.toAbsolutePath().toString(), + "installerDirectory: " + tempDir.toAbsolutePath().toString(), + "patchDirectory: " + tempDir.toAbsolutePath().toString() + ); + Files.write(settingsFileName, lines); + logger.info("Test settings file initialized : " + settingsFileName); + cleanup(); logger.info("Setting up the test environment ..."); @@ -215,6 +256,8 @@ static void staticPrepare() throws Exception { } } + setupDockerMultiPlatform(); + // verify that required files/installers are available verifyStagedFiles(JDK_INSTALLER, WLS_INSTALLER, WDT_INSTALLER, P27342434_INSTALLER, P28186730_INSTALLER, FMW_INSTALLER, JDK_INSTALLER_NEWER); @@ -306,6 +349,16 @@ private void verifyFileInImage(String imagename, String filename, String expecte } } + private static void setupDockerMultiPlatform() throws Exception { + logger.info("setup docker multiplatform build"); + String command = "docker run --privileged --rm tonistiigi/binfmt --install all"; + logger.info("executing command: " + command); + CommandResult result = Runner.run(command); + if (!result.stdout().contains("emulators")) { + throw new Exception("Failed to run command: " + command); + } + } + private void createDBContainer() throws Exception { logger.info("Creating an Oracle db docker container ..."); String command = "docker rm -f " + dbContainerName; @@ -337,6 +390,7 @@ void cacheAddInstallerJdk(TestInfo testInfo) throws Exception { .type("jdk") .version(JDK_VERSION) .path(jdkPath) + .architecture(AMD64) .build(); try (PrintWriter out = getTestMethodWriter(testInfo)) { @@ -345,12 +399,14 @@ void cacheAddInstallerJdk(TestInfo testInfo) throws Exception { assertEquals(0, result.exitValue(), "for command: " + command); // verify the result - String listCommand = new CacheCommand().listItems(true).build(); + String listCommand = new CacheCommand().listInstallers(true).type("jdk") + .commonName(JDK_VERSION).build(); CommandResult listResult = Runner.run(listCommand, out, logger); // the process return code for listItems should be 0 assertEquals(0, listResult.exitValue(), "for command: " + listCommand); // output should show newly added JDK installer - assertTrue(listResult.stdout().contains("jdk_" + JDK_VERSION + "=" + jdkPath)); + assertTrue(listResult.stdout().contains(JDK_VERSION + ":")); + assertTrue(listResult.stdout().contains(jdkPath.toString())); } } @@ -371,6 +427,7 @@ void cacheAddInstallerWls(TestInfo testInfo) throws Exception { .type("wls") .version(WLS_VERSION) .path(wlsPath) + .architecture(AMD64) .build(); try (PrintWriter out = getTestMethodWriter(testInfo)) { @@ -379,12 +436,14 @@ void cacheAddInstallerWls(TestInfo testInfo) throws Exception { assertEquals(0, result.exitValue(), "for command: " + command); // verify the result - String listCommand = new CacheCommand().listItems(true).build(); + String listCommand = new CacheCommand().listInstallers(true).type("wls") + .commonName(WLS_VERSION).version(WLS_VERSION).build(); CommandResult listResult = Runner.run(listCommand, out, logger); // the process return code for listItems should be 0 assertEquals(0, listResult.exitValue(), "for command: " + listCommand); // output should show newly added WLS installer - assertTrue(listResult.stdout().contains("wls_" + WLS_VERSION + "=" + wlsPath)); + assertTrue(listResult.stdout().contains(wlsPath.toString())); + assertTrue(listResult.stdout().contains(WLS_VERSION + ":")); } } @@ -403,7 +462,9 @@ void cacheAddPatch(TestInfo testInfo) throws Exception { String command = new CacheCommand() .addPatch(true) .path(patchPath) - .patchId(P27342434_ID, WLS_VERSION) + .patchId(P27342434_ID) + .version(WLS_VERSION) + .architecture(GENERIC) .build(); try (PrintWriter out = getTestMethodWriter(testInfo)) { @@ -412,76 +473,78 @@ void cacheAddPatch(TestInfo testInfo) throws Exception { assertEquals(0, result.exitValue(), "for command: " + command); // verify the result - String listCommand = new CacheCommand().listItems(true).build(); + String listCommand = new CacheCommand().listPatches(true).patchId(P27342434_ID).build(); CommandResult listResult = Runner.run(listCommand, out, logger); // the process return code for listItems should be 0 assertEquals(0, listResult.exitValue(), "for command: " + listCommand); // output should show newly added patch - assertTrue(listResult.stdout().contains(P27342434_ID + "_" + WLS_VERSION + "=" + patchPath)); + assertTrue(listResult.stdout().contains(P27342434_ID)); + assertTrue(listResult.stdout().contains(WLS_VERSION)); + assertTrue(listResult.stdout().contains(patchPath.toString())); } } - /** - * add an entry to the cache. - * - * @throws Exception - if any error occurs - */ - @Test - @Order(4) - @Tag("gate") - @DisplayName("Add manual entry to cache") - void cacheAddTestEntry(TestInfo testInfo) throws Exception { - Path testEntryValue = Paths.get(STAGING_DIR, P27342434_INSTALLER); - String command = new CacheCommand() - .addEntry(true) - .key(TEST_ENTRY_KEY) - .value(testEntryValue) - .build(); - - try (PrintWriter out = getTestMethodWriter(testInfo)) { - CommandResult addEntryResult = Runner.run(command, out, logger); - assertEquals(0, addEntryResult.exitValue(), "for command: " + command); - - // verify the result - String listCommand = new CacheCommand().listItems(true).build(); - CommandResult listResult = Runner.run(listCommand, out, logger); - // the process return code for listItems should be 0 - assertEquals(0, listResult.exitValue(), "for command: " + listCommand); - // output should show newly added patch - assertTrue(listResult.stdout().contains(TEST_ENTRY_KEY.toLowerCase() + "=" + testEntryValue)); - // cache should also contain the installer that was added in the previous test (persistent cache) - assertTrue(listResult.stdout().contains(P27342434_ID + "_" + WLS_VERSION + "=")); - } - } - - /** - * test delete an entry from the cache. - * - * @throws Exception - if any error occurs - */ - @Test - @Order(5) - @Tag("gate") - @DisplayName("Delete cache entry") - void cacheDeleteTestEntry(TestInfo testInfo) throws Exception { - String command = new CacheCommand() - .deleteEntry(true) - .key(TEST_ENTRY_KEY) - .build(); - - try (PrintWriter out = getTestMethodWriter(testInfo)) { - CommandResult result = Runner.run(command, out, logger); - assertEquals(0, result.exitValue(), "for command: " + command); - - // verify the result - String listCommand = new CacheCommand().listItems(true).build(); - CommandResult listResult = Runner.run(listCommand, out, logger); - // the process return code for listItems should be 0 - assertEquals(0, listResult.exitValue(), "for command: " + listCommand); - // output should NOT show deleted patch - assertFalse(listResult.stdout().contains(TEST_ENTRY_KEY.toLowerCase())); - } - } + ///** + // * add an entry to the cache. + // * + // * @throws Exception - if any error occurs + // */ + //@Test + //@Order(4) + //@Tag("gate") + //@DisplayName("Add manual entry to cache") + //void cacheAddTestEntry(TestInfo testInfo) throws Exception { + // Path testEntryValue = Paths.get(STAGING_DIR, P27342434_INSTALLER); + // String command = new CacheCommand() + // .addEntry(true) + // .key(TEST_ENTRY_KEY) + // .value(testEntryValue) + // .build(); + // + // try (PrintWriter out = getTestMethodWriter(testInfo)) { + // CommandResult addEntryResult = Runner.run(command, out, logger); + // assertEquals(0, addEntryResult.exitValue(), "for command: " + command); + // + // // verify the result + // String listCommand = new CacheCommand().listItems(true).build(); + // CommandResult listResult = Runner.run(listCommand, out, logger); + // // the process return code for listItems should be 0 + // assertEquals(0, listResult.exitValue(), "for command: " + listCommand); + // // output should show newly added patch + // assertTrue(listResult.stdout().contains(TEST_ENTRY_KEY.toLowerCase() + "=" + testEntryValue)); + // // cache should also contain the installer that was added in the previous test (persistent cache) + // assertTrue(listResult.stdout().contains(P27342434_ID + "_" + WLS_VERSION + "=")); + // } + //} + // + ///** + // * test delete an entry from the cache. + // * + // * @throws Exception - if any error occurs + // */ + //@Test + //@Order(5) + //@Tag("gate") + //@DisplayName("Delete cache entry") + //void cacheDeleteTestEntry(TestInfo testInfo) throws Exception { + // String command = new CacheCommand() + // .deleteEntry(true) + // .key(TEST_ENTRY_KEY) + // .build(); + // + // try (PrintWriter out = getTestMethodWriter(testInfo)) { + // CommandResult result = Runner.run(command, out, logger); + // assertEquals(0, result.exitValue(), "for command: " + command); + // + // // verify the result + // String listCommand = new CacheCommand().listItems(true).build(); + // CommandResult listResult = Runner.run(listCommand, out, logger); + // // the process return code for listItems should be 0 + // assertEquals(0, listResult.exitValue(), "for command: " + listCommand); + // // output should NOT show deleted patch + // assertFalse(listResult.stdout().contains(TEST_ENTRY_KEY.toLowerCase())); + // } + //} /** * Test manual caching of a patch JAR. @@ -498,7 +561,9 @@ void cacheOpatch(TestInfo testInfo) throws Exception { String command = new CacheCommand() .addPatch(true) .path(patchPath) - .patchId(P28186730_ID, OPATCH_VERSION) + .architecture(GENERIC) + .patchId(P28186730_ID) + .version(OPATCH_VERSION) .build(); try (PrintWriter out = getTestMethodWriter(testInfo)) { @@ -507,12 +572,15 @@ void cacheOpatch(TestInfo testInfo) throws Exception { assertEquals(0, result.exitValue(), "for command: " + command); // verify the result - String listCommand = new CacheCommand().listItems(true).build(); + String listCommand = new CacheCommand().listPatches(true).patchId(P28186730_ID) + .version(OPATCH_VERSION).build(); CommandResult listResult = Runner.run(listCommand, out, logger); // the process return code for listItems should be 0 assertEquals(0, listResult.exitValue(), "for command: " + listCommand); // output should show newly added patch - assertTrue(listResult.stdout().contains(P28186730_ID + "_" + OPATCH_VERSION + "=" + patchPath)); + assertTrue(listResult.stdout().contains(P28186730_ID + ":")); + assertTrue(listResult.stdout().contains(OPATCH_VERSION)); + assertTrue(listResult.stdout().contains(patchPath.toString())); } } @@ -534,6 +602,7 @@ void cacheAddInstallerWdt(TestInfo testInfo) throws IOException, InterruptedExce .type("wdt") .version(WDT_VERSION) .path(wdtPath) + .architecture(GENERIC) .build(); try (PrintWriter out = getTestMethodWriter(testInfo)) { @@ -555,6 +624,7 @@ void cacheAddInstallerFmw(TestInfo testInfo) throws Exception { .type("fmw") .version(WLS_VERSION) .path(Paths.get(STAGING_DIR, FMW_INSTALLER)) + .architecture(AMD64) .build(); @@ -564,7 +634,7 @@ void cacheAddInstallerFmw(TestInfo testInfo) throws Exception { assertEquals(0, addResult.exitValue(), "for command: " + addCommand); // verify the result - String listCommand = new CacheCommand().listItems(true).build(); + String listCommand = new CacheCommand().listInstallers(true).commonName(WLS_VERSION).build(); CommandResult listResult = Runner.run(listCommand, out, logger); // the process return code for listItems should be 0 assertEquals(0, listResult.exitValue(), "for command: " + listCommand); @@ -585,7 +655,7 @@ void cacheAddInstallerFmw(TestInfo testInfo) throws Exception { @DisplayName("Create default WebLogic Server image") void createWlsImg(TestInfo testInfo) throws Exception { String tagName = build_tag + ":" + getMethodName(testInfo); - String command = new CreateCommand().tag(tagName).build(); + String command = new CreateCommand().platform(PLATFORM_AMD64).tag(tagName).build(); try (PrintWriter out = getTestMethodWriter(testInfo)) { CommandResult result = Runner.run(command, out, logger); @@ -614,6 +684,7 @@ void updateWlsImg(TestInfo testInfo) throws Exception { String command = new UpdateCommand() .fromImage(build_tag + ":createWlsImg") .tag(tagName) + .platform(PLATFORM_AMD64) .patches(P27342434_ID) .build(); @@ -651,6 +722,7 @@ void createWlsImgUsingWdt(TestInfo testInfo) throws Exception { .wdtArchive(WDT_ARCHIVE) .wdtDomainHome("/u01/domains/simple_domain") .wdtVariables(WDT_VARIABLES) + .platform(PLATFORM_AMD64) .build(); CommandResult result = Runner.run(command, out, logger); @@ -722,6 +794,7 @@ void createMiiOl8slim(TestInfo testInfo) throws Exception { .wdtArchive(WDT_ARCHIVE) .wdtModel(tmpWdtModel) .wdtModelOnly(true) + .platform(PLATFORM_AMD64) .type("wls") .build(); @@ -757,6 +830,7 @@ void createAuxImage(TestInfo testInfo) throws Exception { .wdtModel(WDT_MODEL) .wdtArchive(WDT_ARCHIVE) .wdtVersion(WDT_VERSION) + .platform(PLATFORM_AMD64) .build(); try (PrintWriter out = getTestMethodWriter(testInfo)) { @@ -790,6 +864,7 @@ void createFmwImgFullInternetAccess(TestInfo testInfo) throws Exception { String addNewJdkCmd = new CacheCommand().addInstaller(true) .type("jdk") .version(JDK_VERSION_212) + .architecture(AMD64) .path(Paths.get(STAGING_DIR, JDK_INSTALLER_NEWER)) .build(); @@ -805,6 +880,7 @@ void createFmwImgFullInternetAccess(TestInfo testInfo) throws Exception { .jdkVersion(JDK_VERSION_212) .type("fmw") .user(oracleSupportUsername) + .platform(PLATFORM_AMD64) .passwordEnv("ORACLE_SUPPORT_PASSWORD") .latestPsu(true) .build(); @@ -856,6 +932,7 @@ void createJrfDomainImgUsingWdt(TestInfo testInfo) throws Exception { .version(WLS_VERSION) .wdtVersion(WDT_VERSION) .wdtArchive(WDT_ARCHIVE) + .platform(PLATFORM_AMD64) .wdtDomainHome("/u01/domains/simple_domain") .wdtModel(tmpWdtModel) .wdtDomainType("JRF") @@ -898,6 +975,7 @@ void createRestrictedJrfDomainImgUsingWdt(TestInfo testInfo) throws Exception { .wdtVariables(WDT_VARIABLES) .wdtDomainHome("/u01/domains/simple_domain") .wdtDomainType("RestrictedJRF") + .platform(PLATFORM_AMD64) .type("fmw") .build(); @@ -935,6 +1013,7 @@ void createWlsImgUsingMultiModels(TestInfo testInfo) throws Exception { .wdtDomainHome("/u01/domains/simple_domain") .wdtModel(WDT_MODEL, WDT_MODEL2) .wdtVariables(WDT_VARIABLES) + .platform(PLATFORM_AMD64) .build(); try (PrintWriter out = getTestMethodWriter(testInfo)) { @@ -964,6 +1043,7 @@ void createWlsImgWithAdditionalBuildCommands(TestInfo testInfo) throws Exception .user(oracleSupportUsername) .passwordEnv("ORACLE_SUPPORT_PASSWORD") .additionalBuildCommands(WDT_RESOURCES.resolve("multi-sections.txt")) + .platform(PLATFORM_AMD64) .build(); try (PrintWriter out = getTestMethodWriter(testInfo)) { @@ -1003,6 +1083,7 @@ void createImageWithServerJRE(TestInfo testInfo) throws Exception { String command = new CreateCommand() .tag(tagName) .fromImage(JRE_IMAGE) + .platform(PLATFORM_AMD64) .build(); try (PrintWriter out = getTestMethodWriter(testInfo)) { @@ -1146,6 +1227,7 @@ void createWlsImgWithOpenShiftSettings(TestInfo testInfo) throws Exception { .wdtModel(WDT_MODEL, WDT_MODEL2) .wdtVariables(WDT_VARIABLES) .target(KubernetesTarget.OPENSHIFT) + .platform(PLATFORM_AMD64) .build(); try (PrintWriter out = getTestMethodWriter(testInfo)) { @@ -1176,6 +1258,7 @@ void createWlsImgFromJar(TestInfo testInfo) throws Exception { .addInstaller(true) .type("wls") .version("12.2.1.4.0") + .architecture(AMD64) .path(Paths.get(STAGING_DIR, "fmw_12.2.1.4.0_wls_lite_generic.jar")) .build(); @@ -1184,6 +1267,7 @@ void createWlsImgFromJar(TestInfo testInfo) throws Exception { String buildCommand = new CreateCommand() .tag(tagName) .version("12.2.1.4.0") + .platform(PLATFORM_AMD64) .build(); try (PrintWriter out = getTestMethodWriter(testInfo)) { diff --git a/tests/src/test/java/com/oracle/weblogic/imagetool/tests/utils/CacheCommand.java b/tests/src/test/java/com/oracle/weblogic/imagetool/tests/utils/CacheCommand.java index 820020c6..3ed97cd2 100644 --- a/tests/src/test/java/com/oracle/weblogic/imagetool/tests/utils/CacheCommand.java +++ b/tests/src/test/java/com/oracle/weblogic/imagetool/tests/utils/CacheCommand.java @@ -6,6 +6,7 @@ import java.nio.file.Path; public class CacheCommand extends ImageToolCommand { + private String commonName; private String version; private String type; @@ -13,13 +14,15 @@ public class CacheCommand extends ImageToolCommand { private boolean listItems; private boolean addInstaller; private boolean addPatch; + private boolean listInstallers; + private boolean listPatches; private boolean addEntry; private boolean deleteEntry; private String path; private String patchId; private String key; private String value; - + private String architecture; public CacheCommand() { super("cache"); @@ -40,6 +43,15 @@ public CacheCommand addPatch(boolean value) { return this; } + public CacheCommand listInstallers(boolean value) { + listInstallers = value; + return this; + } + + public CacheCommand listPatches(boolean value) { + listPatches = value; + return this; + } public CacheCommand addEntry(boolean value) { addEntry = value; @@ -86,6 +98,16 @@ public CacheCommand type(String value) { return this; } + public CacheCommand architecture(String value) { + architecture = value; + return this; + } + + public CacheCommand commonName(String value) { + commonName = value; + return this; + } + /** * Generate the command using the provided command line options. * @return the imagetool command as a string suitable for running in ProcessBuilder @@ -95,12 +117,14 @@ public String build() { return super.build() + field("addInstaller", addInstaller) + field("addPatch", addPatch) - + field("--key", key) - + field("--value", value) + + field("listPatches", listPatches) + + field("listInstallers", listInstallers) + + field("--commonName", commonName) + field("--version", version) + field("--type", type) + field("--path", path) - + field("--patchId", patchId); + + field("--patchId", patchId) + + field("--architecture", architecture); } } diff --git a/tests/src/test/java/com/oracle/weblogic/imagetool/tests/utils/CreateAuxCommand.java b/tests/src/test/java/com/oracle/weblogic/imagetool/tests/utils/CreateAuxCommand.java index 5180603f..9dc268ff 100644 --- a/tests/src/test/java/com/oracle/weblogic/imagetool/tests/utils/CreateAuxCommand.java +++ b/tests/src/test/java/com/oracle/weblogic/imagetool/tests/utils/CreateAuxCommand.java @@ -18,6 +18,7 @@ public class CreateAuxCommand extends ImageToolCommand { private String wdtVariables; private String wdtDomainHome; private boolean wdtModelOnly; + private String platform; public CreateAuxCommand() { super("createAuxImage"); @@ -67,6 +68,11 @@ public CreateAuxCommand wdtModelOnly(boolean value) { return this; } + public CreateAuxCommand platform(String value) { + platform = value; + return this; + } + /** * Generate the command using the provided command line options. * @return the imagetool command as a string suitable for running in ProcessBuilder @@ -81,6 +87,8 @@ public String build() { + field("--wdtArchive", wdtArchive) + field("--wdtVariables", wdtVariables) + field("--wdtDomainHome", wdtDomainHome) - + field("--wdtModelOnly", wdtModelOnly); + + field("--platform", platform) + + field("--wdtModelOnly", wdtModelOnly) + + " -- --load"; } } diff --git a/tests/src/test/java/com/oracle/weblogic/imagetool/tests/utils/CreateCommand.java b/tests/src/test/java/com/oracle/weblogic/imagetool/tests/utils/CreateCommand.java index 190071d4..7dc392fe 100644 --- a/tests/src/test/java/com/oracle/weblogic/imagetool/tests/utils/CreateCommand.java +++ b/tests/src/test/java/com/oracle/weblogic/imagetool/tests/utils/CreateCommand.java @@ -33,6 +33,7 @@ public class CreateCommand extends ImageToolCommand { private String wdtDomainType; private boolean wdtRunRcu; private boolean wdtModelOnly; + private String platform; public CreateCommand() { super("create"); @@ -142,6 +143,11 @@ public CreateCommand wdtModelOnly(boolean value) { return this; } + public CreateCommand platform(String value) { + platform = value; + return this; + } + /** * Generate the command using the provided command line options. * @return the imagetool command as a string suitable for running in ProcessBuilder @@ -168,6 +174,8 @@ public String build() { + field("--wdtDomainHome", wdtDomainHome) + field("--wdtDomainType", wdtDomainType) + field("--wdtRunRCU", wdtRunRcu) - + field("--wdtModelOnly", wdtModelOnly); + + field("--platform", platform) + + field("--wdtModelOnly", wdtModelOnly) + + " -- --load"; } } diff --git a/tests/src/test/java/com/oracle/weblogic/imagetool/tests/utils/RebaseCommand.java b/tests/src/test/java/com/oracle/weblogic/imagetool/tests/utils/RebaseCommand.java index 14ab329c..7f359a39 100644 --- a/tests/src/test/java/com/oracle/weblogic/imagetool/tests/utils/RebaseCommand.java +++ b/tests/src/test/java/com/oracle/weblogic/imagetool/tests/utils/RebaseCommand.java @@ -7,6 +7,7 @@ public class RebaseCommand extends ImageToolCommand { private String targetImage; private String sourceImage; private String tag; + private String platform; public RebaseCommand() { super("rebase"); @@ -35,6 +36,11 @@ public RebaseCommand tag(String value) { return this; } + public RebaseCommand platform(String value) { + platform = value; + return this; + } + /** * Generate the command using the provided command line options. * @return the imagetool command as a string suitable for running in ProcessBuilder @@ -44,6 +50,7 @@ public String build() { return super.build() + field("--targetImage", targetImage) + field("--sourceImage", sourceImage) + + field("--platform", platform) + field("--tag", tag); } } diff --git a/tests/src/test/java/com/oracle/weblogic/imagetool/tests/utils/UpdateCommand.java b/tests/src/test/java/com/oracle/weblogic/imagetool/tests/utils/UpdateCommand.java index 89f9574e..6ee38ce7 100644 --- a/tests/src/test/java/com/oracle/weblogic/imagetool/tests/utils/UpdateCommand.java +++ b/tests/src/test/java/com/oracle/weblogic/imagetool/tests/utils/UpdateCommand.java @@ -19,6 +19,8 @@ public class UpdateCommand extends ImageToolCommand { private String wdtArchive; private String wdtVariables; private boolean wdtModelOnly; + private String platform; + public UpdateCommand() { super("update"); @@ -39,6 +41,11 @@ public UpdateCommand patches(String... values) { return this; } + public UpdateCommand platform(String value) { + platform = value; + return this; + } + public UpdateCommand wdtVersion(String value) { wdtVersion = value; return this; @@ -78,6 +85,7 @@ public String build() { + field("--wdtModel", wdtModel) + field("--wdtArchive", wdtArchive) + field("--wdtVariables", wdtVariables) + + field("--platform", platform) + field("--wdtModelOnly", wdtModelOnly); } } diff --git a/tests/src/test/resources/wdt/simple-topology1.yaml b/tests/src/test/resources/wdt/simple-topology1.yaml index e8f63e91..a64ded61 100644 --- a/tests/src/test/resources/wdt/simple-topology1.yaml +++ b/tests/src/test/resources/wdt/simple-topology1.yaml @@ -13,6 +13,7 @@ topology: ProductionModeEnabled: true Cluster: cluster1: + FrontendHost: localhost ClientCertProxyEnabled: true DynamicServers: ServerTemplate: template1 From 148d8022a78e08181b4aea11ee703e39ca58c1c4 Mon Sep 17 00:00:00 2001 From: jshum Date: Wed, 27 Nov 2024 11:24:19 -0600 Subject: [PATCH 046/104] Fix nightly integration test --- .../weblogic/imagetool/api/model/CachedFile.java | 3 ++- .../weblogic/imagetool/builder/BuildCommand.java | 5 ++++- .../weblogic/imagetool/settings/ConfigManager.java | 4 ++++ imagetool/src/main/resources/ImageTool.properties | 2 +- .../resources/docker-files/fmw-patching.mustache | 2 +- .../weblogic/imagetool/tests/ITImagetool.java | 14 +++++++++----- 6 files changed, 21 insertions(+), 9 deletions(-) diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/api/model/CachedFile.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/api/model/CachedFile.java index 33893174..c3920811 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/api/model/CachedFile.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/api/model/CachedFile.java @@ -118,7 +118,8 @@ public String resolve() throws IOException { } if (!isFileOnDisk(filePath)) { - throw new FileNotFoundException(Utils.getMessage("IMG-0011", filePath)); + throw new FileNotFoundException(Utils.getMessage("IMG-0011", installerType, + getVersion(), getArchitecture(), filePath)); } logger.exiting(filePath); diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/builder/BuildCommand.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/builder/BuildCommand.java index 4d59a1c9..6dfd3d26 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/builder/BuildCommand.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/builder/BuildCommand.java @@ -72,7 +72,10 @@ public BuildCommand platform(List value) { } command.add("--platform"); command.add(String.join(",", value)); - useBuildx = true; + // Only use buildx for multi platform build + if (value.size() > 1) { + useBuildx = true; + } return this; } diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/ConfigManager.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/ConfigManager.java index 48466ea1..41c60fac 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/ConfigManager.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/ConfigManager.java @@ -88,6 +88,10 @@ public String getPatchDetailsFile() { return userSettingsFile.getPatchDetailsFile(); } + public String getBuildEngine() { + return userSettingsFile.getBuildEngine(); + } + /** * Return the metadata for the platformed installer. * @param platformName platform name diff --git a/imagetool/src/main/resources/ImageTool.properties b/imagetool/src/main/resources/ImageTool.properties index ad5e7b30..4de52283 100644 --- a/imagetool/src/main/resources/ImageTool.properties +++ b/imagetool/src/main/resources/ImageTool.properties @@ -9,7 +9,7 @@ IMG-0007={0} is not a directory IMG-0008=Updating OPatch in final image from version {0} to version {1} IMG-0009=No credentials provided, skipping patch conflict check. IMG-0010=Oracle Home will be set to [[cyan: {0}]] -IMG-0011=Installer with key="{0}" is not in the local cache, please download the installer and add it to the cache with "imagetool cache addInstaller ..." +IMG-0011=Installer with type="{0}", version={1}, architecture={2} filepath={3}, is not in the local cache, please download the installer and add it to the cache with "imagetool cache addInstaller ..." IMG-0012=Checking for conflicting patches IMG-0013=Error parsing additional build commands file {0} IMG-0014=Additional build command section, {0}, was not one of the valid sections: {1} diff --git a/imagetool/src/main/resources/docker-files/fmw-patching.mustache b/imagetool/src/main/resources/docker-files/fmw-patching.mustache index 0c7e3257..75e18833 100644 --- a/imagetool/src/main/resources/docker-files/fmw-patching.mustache +++ b/imagetool/src/main/resources/docker-files/fmw-patching.mustache @@ -13,7 +13,7 @@ {{/isOpatchPatchingEnabled}} {{#isPatchingEnabled}} - COPY --chown={{userid}}:{{groupid}} patches/* {{{tempDir}}}/patches/ + COPY --chown={{userid}}:{{groupid}} patches/ {{{tempDir}}}/patches/ {{^strictPatchOrdering}} # Apply all patches provided at the same time diff --git a/tests/src/test/java/com/oracle/weblogic/imagetool/tests/ITImagetool.java b/tests/src/test/java/com/oracle/weblogic/imagetool/tests/ITImagetool.java index 0ea5a9e1..9d58ed36 100644 --- a/tests/src/test/java/com/oracle/weblogic/imagetool/tests/ITImagetool.java +++ b/tests/src/test/java/com/oracle/weblogic/imagetool/tests/ITImagetool.java @@ -42,7 +42,6 @@ import static com.oracle.weblogic.imagetool.cachestore.FileCacheStore.CACHE_DIR_ENV; 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.Assumptions.assumeTrue; @@ -634,13 +633,15 @@ void cacheAddInstallerFmw(TestInfo testInfo) throws Exception { assertEquals(0, addResult.exitValue(), "for command: " + addCommand); // verify the result - String listCommand = new CacheCommand().listInstallers(true).commonName(WLS_VERSION).build(); + String listCommand = new CacheCommand().listInstallers(true).type("fmw") + .commonName(WLS_VERSION).build(); CommandResult listResult = Runner.run(listCommand, out, logger); // the process return code for listItems should be 0 assertEquals(0, listResult.exitValue(), "for command: " + listCommand); // output should show newly added WLS installer - assertTrue(listResult.stdout().contains("type: fmw")); - assertTrue(listResult.stdout().contains("version: " + WLS_VERSION)); + assertTrue(listResult.stdout().contains(Paths.get(STAGING_DIR, FMW_INSTALLER).toString())); + assertTrue(listResult.stdout().contains(WLS_VERSION + ":")); + } } @@ -930,6 +931,7 @@ void createJrfDomainImgUsingWdt(TestInfo testInfo) throws Exception { String command = new CreateCommand() .tag(tagName) .version(WLS_VERSION) + .jdkVersion(JDK_VERSION_212) .wdtVersion(WDT_VERSION) .wdtArchive(WDT_ARCHIVE) .platform(PLATFORM_AMD64) @@ -966,6 +968,7 @@ void createRestrictedJrfDomainImgUsingWdt(TestInfo testInfo) throws Exception { String command = new CreateCommand() .tag(tagName) .version(WLS_VERSION) + .jdkVersion(JDK_VERSION_212) .latestPsu(true) .user(oracleSupportUsername) .passwordEnv("ORACLE_SUPPORT_PASSWORD") @@ -1008,6 +1011,7 @@ void createWlsImgUsingMultiModels(TestInfo testInfo) throws Exception { String command = new CreateCommand() .tag(tagName) .version(WLS_VERSION) + .jdkVersion(JDK_VERSION_212) .wdtVersion(WDT_VERSION) .wdtArchive(WDT_ARCHIVE) .wdtDomainHome("/u01/domains/simple_domain") @@ -1219,7 +1223,7 @@ void updateAddSecondModel(TestInfo testInfo) throws Exception { void createWlsImgWithOpenShiftSettings(TestInfo testInfo) throws Exception { String tagName = build_tag + ":" + getMethodName(testInfo); String command = new CreateCommand() - .jdkVersion(JDK_VERSION) + .jdkVersion(JDK_VERSION_212) .tag(tagName) .wdtVersion(WDT_VERSION) .wdtArchive(WDT_ARCHIVE) From 9c231ed7b7d3d450671692c4181bc6584465a2b0 Mon Sep 17 00:00:00 2001 From: jshum Date: Thu, 28 Nov 2024 08:47:52 -0600 Subject: [PATCH 047/104] update cli and make progress=plain by default --- .../imagetool/builder/BuildCommand.java | 28 +++++++++++++++++-- .../cli/menu/CommonCreateOptions.java | 1 + .../imagetool/cli/menu/CommonOptions.java | 27 ++++++++++++++++-- .../imagetool/builder/BuilderTest.java | 2 +- .../weblogic/imagetool/tests/ITImagetool.java | 2 +- .../tests/utils/CreateAuxCommand.java | 3 +- .../imagetool/tests/utils/CreateCommand.java | 4 +-- 7 files changed, 55 insertions(+), 12 deletions(-) diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/builder/BuildCommand.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/builder/BuildCommand.java index 6dfd3d26..b1c98683 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/builder/BuildCommand.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/builder/BuildCommand.java @@ -164,6 +164,28 @@ public BuildCommand pull(boolean value) { return this; } + /** + * Add a --push to the Docker build command. If value is false, return without adding the --push. + * @param value true to add the pull + */ + public BuildCommand push(boolean value) { + if (value) { + command.add("--push"); + } + return this; + } + + /** + * Add a --load to the Docker build command. If value is false, return without adding the --load. + * @param value true to add the pull + */ + public BuildCommand load(boolean value) { + if (value) { + command.add("--load"); + } + return this; + } + /** * Executes the given docker command and writes the process stdout to log. * @@ -187,6 +209,7 @@ public void run(Path dockerLog) } ProcessBuilder processBuilder = new ProcessBuilder(getCommand(true)); + processBuilder.redirectErrorStream(true); logger.finer("Starting docker process..."); final Process process = processBuilder.start(); logger.finer("Docker process started"); @@ -271,9 +294,8 @@ private List getCommand(boolean showPasswords) { result.addAll(arg.toList(showPasswords)); } result.add(context); - if (useBuildx) { - result.add("--progress=plain"); - } + result.add("--progress=plain"); + return result; } diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonCreateOptions.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonCreateOptions.java index 929f17bd..bd27ab6c 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonCreateOptions.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonCreateOptions.java @@ -197,4 +197,5 @@ String getInstallerVersion() { description = "path to where the inventory pointer file (oraInst.loc) should be stored in the image" ) private String inventoryPointerInstallLoc; + } \ No newline at end of file diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonOptions.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonOptions.java index 1605702d..1ee69a75 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonOptions.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonOptions.java @@ -125,9 +125,8 @@ void runDockerCommand(String dockerfile, BuildCommand command) throws IOExceptio */ BuildCommand getInitialBuildCmd(String contextFolder) { logger.entering(); - BuildCommand cmdBuilder = new BuildCommand(buildEngine, contextFolder); - - cmdBuilder.forceRm(!skipcleanup) + BuildCommand cmdBuilder = new BuildCommand(buildEngine, contextFolder) + .forceRm(!skipcleanup) .tag(imageTag) .platform(buildPlatform) .network(buildNetwork) @@ -138,6 +137,15 @@ BuildCommand getInitialBuildCmd(String contextFolder) { .buildArg("https_proxy", httpsProxyUrl, httpsProxyUrl != null && httpsProxyUrl.contains("@")) .buildArg("no_proxy", nonProxyHosts); + // if it is multiplatform build + if (buildId != null && buildPlatform.size() > 1) { + // if push is specified, ignore load value + if (push) { + cmdBuilder.push(push); + } else { + cmdBuilder.load(load); + } + } logger.exiting(); return cmdBuilder; } @@ -478,6 +486,18 @@ public List getBuildPlatform() { ) private List buildPlatform; + @Option( + names = {"--push"}, + description = "push the image to the remote repository, only used when building multiplatform images" + ) + private boolean push = false; + + @Option( + names = {"--load"}, + description = "load the image to the local repository, only used when building multiplatform images" + ) + private boolean load = true; + @Parameters( description = "Container build options.", hidden = true @@ -486,4 +506,5 @@ public List getBuildPlatform() { @Spec CommandLine.Model.CommandSpec spec; + } diff --git a/imagetool/src/test/java/com/oracle/weblogic/imagetool/builder/BuilderTest.java b/imagetool/src/test/java/com/oracle/weblogic/imagetool/builder/BuilderTest.java index bfd029ce..8352c3b4 100644 --- a/imagetool/src/test/java/com/oracle/weblogic/imagetool/builder/BuilderTest.java +++ b/imagetool/src/test/java/com/oracle/weblogic/imagetool/builder/BuilderTest.java @@ -17,7 +17,7 @@ class BuilderTest { private static final String BUILD_ENGINE = "docker"; private String expected(String options) { - return String.format("%s build %s %s", BUILD_ENGINE, options, BUILD_CONTEXT); + return String.format("%s build %s %s --progress=plain", BUILD_ENGINE, options, BUILD_CONTEXT); } @Test diff --git a/tests/src/test/java/com/oracle/weblogic/imagetool/tests/ITImagetool.java b/tests/src/test/java/com/oracle/weblogic/imagetool/tests/ITImagetool.java index 9d58ed36..f0909d5c 100644 --- a/tests/src/test/java/com/oracle/weblogic/imagetool/tests/ITImagetool.java +++ b/tests/src/test/java/com/oracle/weblogic/imagetool/tests/ITImagetool.java @@ -934,12 +934,12 @@ void createJrfDomainImgUsingWdt(TestInfo testInfo) throws Exception { .jdkVersion(JDK_VERSION_212) .wdtVersion(WDT_VERSION) .wdtArchive(WDT_ARCHIVE) - .platform(PLATFORM_AMD64) .wdtDomainHome("/u01/domains/simple_domain") .wdtModel(tmpWdtModel) .wdtDomainType("JRF") .wdtRunRcu(true) .type("fmw") + .platform(PLATFORM_AMD64) .build(); CommandResult result = Runner.run(command, out, logger); diff --git a/tests/src/test/java/com/oracle/weblogic/imagetool/tests/utils/CreateAuxCommand.java b/tests/src/test/java/com/oracle/weblogic/imagetool/tests/utils/CreateAuxCommand.java index 9dc268ff..b1f74212 100644 --- a/tests/src/test/java/com/oracle/weblogic/imagetool/tests/utils/CreateAuxCommand.java +++ b/tests/src/test/java/com/oracle/weblogic/imagetool/tests/utils/CreateAuxCommand.java @@ -88,7 +88,6 @@ public String build() { + field("--wdtVariables", wdtVariables) + field("--wdtDomainHome", wdtDomainHome) + field("--platform", platform) - + field("--wdtModelOnly", wdtModelOnly) - + " -- --load"; + + field("--wdtModelOnly", wdtModelOnly); } } diff --git a/tests/src/test/java/com/oracle/weblogic/imagetool/tests/utils/CreateCommand.java b/tests/src/test/java/com/oracle/weblogic/imagetool/tests/utils/CreateCommand.java index 7dc392fe..99f4f0b3 100644 --- a/tests/src/test/java/com/oracle/weblogic/imagetool/tests/utils/CreateCommand.java +++ b/tests/src/test/java/com/oracle/weblogic/imagetool/tests/utils/CreateCommand.java @@ -148,6 +148,7 @@ public CreateCommand platform(String value) { return this; } + /** * Generate the command using the provided command line options. * @return the imagetool command as a string suitable for running in ProcessBuilder @@ -175,7 +176,6 @@ public String build() { + field("--wdtDomainType", wdtDomainType) + field("--wdtRunRCU", wdtRunRcu) + field("--platform", platform) - + field("--wdtModelOnly", wdtModelOnly) - + " -- --load"; + + field("--wdtModelOnly", wdtModelOnly); } } From 2798e30dc29e7c662601bdd39575844d718c8559 Mon Sep 17 00:00:00 2001 From: jshum Date: Mon, 2 Dec 2024 14:57:59 -0600 Subject: [PATCH 048/104] refactor --- .../weblogic/imagetool/aru/AruUtil.java | 30 -- .../imagetool/cachestore/CacheStore.java | 411 ++++++++++++++++-- .../cachestore/CacheStoreFactory.java | 28 -- .../imagetool/cachestore/FileCacheStore.java | 184 -------- .../imagetool/cli/cache/AddEntry.java | 49 --- .../imagetool/settings/ConfigManager.java | 63 +-- .../imagetool/settings/UserSettingsFile.java | 383 ---------------- .../imagetool/util/CacheConversion.java | 65 ++- .../src/main/resources/ImageTool.properties | 7 +- .../cachestore/CacheStoreTestImpl.java | 63 --- .../imagetool/cachestore/CachedFileTest.java | 22 +- .../cachestore/FileCacheStoreTest.java | 81 ---- .../imagetool/cachestore/OPatchFileTest.java | 28 +- .../imagetool/cachestore/PatchFileTest.java | 41 +- .../weblogic/imagetool/tests/ITImagetool.java | 2 +- 15 files changed, 487 insertions(+), 970 deletions(-) delete mode 100644 imagetool/src/main/java/com/oracle/weblogic/imagetool/cachestore/CacheStoreFactory.java delete mode 100644 imagetool/src/main/java/com/oracle/weblogic/imagetool/cachestore/FileCacheStore.java delete mode 100644 imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/AddEntry.java delete mode 100644 imagetool/src/test/java/com/oracle/weblogic/imagetool/cachestore/CacheStoreTestImpl.java delete mode 100644 imagetool/src/test/java/com/oracle/weblogic/imagetool/cachestore/FileCacheStoreTest.java diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/aru/AruUtil.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/aru/AruUtil.java index c2fa9dff..902aa2aa 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/aru/AruUtil.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/aru/AruUtil.java @@ -12,15 +12,11 @@ import java.util.Collection; import java.util.Collections; import java.util.List; -import java.util.regex.Matcher; -import java.util.regex.Pattern; import java.util.stream.Collectors; import java.util.stream.Stream; import javax.xml.xpath.XPathExpressionException; import com.github.mustachejava.DefaultMustacheFactory; -import com.oracle.weblogic.imagetool.cachestore.CacheStoreException; -import com.oracle.weblogic.imagetool.cachestore.CacheStoreFactory; import com.oracle.weblogic.imagetool.installer.FmwInstallerType; import com.oracle.weblogic.imagetool.logging.LoggingFacade; import com.oracle.weblogic.imagetool.logging.LoggingFactory; @@ -503,32 +499,6 @@ public Stream getPatches(String bugNumber, String userId, String passw } } - private List getPatchesOffline(String bugNumber) throws CacheStoreException { - List patchesInCache = new ArrayList<>(); - // Cache keys are in the form {bug number}_{version} or {bug number}_{version}_{architecture} - Pattern pattern = Pattern.compile("^([^_]+)_([^_]+)(?:_(.+))?$"); - // Get a list of patches in the cache for the given bug number - - for (String patchId: CacheStoreFactory.cache().getKeysForType(bugNumber)) { - AruPatch patch = new AruPatch(); - Matcher matcher = pattern.matcher(patchId); - if (matcher.find() && matcher.groupCount() < 2) { - logger.fine("While getting patches for {0}, discarded bad cache key {1}", bugNumber, patchId); - } - patch.patchId(matcher.group(1)); - patch.version(matcher.group(2)); - if (matcher.groupCount() == 3 && matcher.group(3) != null) { - int aruPlatform = Architecture.fromString(matcher.group(3)).getAruPlatform(); - patch.platform(Integer.toString(aruPlatform)); - } else { - // architecture was not specified in the cache key, assume generic platform - patch.platform("2000"); - } - patch.description("description unavailable while working offline"); - patchesInCache.add(patch); - } - return patchesInCache; - } /** * Download a patch file from ARU. diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cachestore/CacheStore.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cachestore/CacheStore.java index ba65441d..b320bf62 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cachestore/CacheStore.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cachestore/CacheStore.java @@ -3,69 +3,408 @@ package com.oracle.weblogic.imagetool.cachestore; + +import java.io.IOException; +import java.nio.file.Paths; +import java.util.ArrayList; +import java.util.EnumMap; +import java.util.HashMap; +import java.util.LinkedHashMap; import java.util.List; import java.util.Map; +import com.oracle.weblogic.imagetool.aru.AruPatch; +import com.oracle.weblogic.imagetool.installer.InstallerMetaData; +import com.oracle.weblogic.imagetool.installer.InstallerType; +import com.oracle.weblogic.imagetool.logging.LoggingFacade; +import com.oracle.weblogic.imagetool.logging.LoggingFactory; +import com.oracle.weblogic.imagetool.patch.PatchMetaData; +import com.oracle.weblogic.imagetool.settings.ConfigManager; +import com.oracle.weblogic.imagetool.settings.SettingsFile; +import com.oracle.weblogic.imagetool.settings.UserSettingsFile; +import com.oracle.weblogic.imagetool.util.Architecture; +import com.oracle.weblogic.imagetool.util.Utils; + +import static com.oracle.weblogic.imagetool.aru.AruUtil.getAruPlatformId; +import static com.oracle.weblogic.imagetool.util.Utils.getTodayDate; + /** - * This is the interface that helps keep track of application metadata like + * This is the helper class that helps keep track of application metadata like * which patches have been downloaded and their location on disk. */ -public interface CacheStore { +public class CacheStore { + + public static String CACHE_KEY_SEPARATOR = "_"; + public static String CACHE_DIR_ENV = "WLSIMG_CACHEDIR"; + private static final LoggingFacade logger = LoggingFactory.getLogger(UserSettingsFile.class); - String CACHE_KEY_SEPARATOR = "_"; /** - * Cache dir used by this application. cache dir is where the application downloads - * artifacts to. - * - * @return cache dir location on disk + * Return all the installers based on the configured directory for the yaml file. + * @return map of installers */ - String getCacheDir(); + public EnumMap>> getInstallers() { + + + // installers is a list of different installer types jdk, fmw, wdt etc .. + // For each installer type, there is a list of individual installer + //jdk: + // 11u22: + // - platform: linux/arm64 + // file: /path/to/installerarm.gz + // digest: e6a8e178e73aea2fc512799423822bf065758f5e + // version: 11.0.22 + // added: 20241201 + // - platform: linux/amd64 + // file: /path/to/installeramd.gz + // digest: 1d6dc346ba26bcf1d0c6b5efb030e0dd2f842add + // version: 11.0.22 + // added: 20241201 + // 8u401: + //wls: + // 12.2.1.4.0: + // - platform: linux/arm64 + // .... + // - platform: linux/arm64 + + Map allInstallers = new SettingsFile(Paths.get(ConfigManager.getInstance() + .getInstallerDetailsFile())).load(); + if (allInstallers == null) { + allInstallers = new HashMap<>(); + } + EnumMap>> installerDetails + = new EnumMap<>(InstallerType.class); + for (Map.Entry entry: allInstallers.entrySet()) { + String key = entry.getKey(); + if (key != null && !key.isEmpty()) { + Map> installerMetaData = new HashMap<>(); + key = key.toUpperCase(); // jdk, wls, fmw etc ... + try { + // process list of individual installers + // 12.2.1.4.0: + // - platform: linux/arm64 + // - platform: linux/amd64 + // 14.1.2.0.0: + // - platform: + // - platform + Map installerValues = (Map) entry.getValue(); + + for (Map.Entry individualInstaller: installerValues.entrySet()) { + String individualInstallerKey = individualInstaller.getKey(); // e.g. 12.2.1.4, 14.1.2 + List installerMetaDataList = new ArrayList<>(installerValues.size()); + + if (individualInstaller.getValue() instanceof ArrayList) { + for (Object installerValue: (ArrayList) individualInstaller.getValue()) { + installerMetaDataList.add(createInstallerMetaData((Map)installerValue)); + } + } else { + installerMetaDataList.add( + createInstallerMetaData((Map)individualInstaller.getValue())); + } + installerMetaData.put(individualInstallerKey, installerMetaDataList); + } + + installerDetails.put(InstallerType.valueOf(key), installerMetaData); + + } catch (IllegalArgumentException illegal) { + logger.warning("{0} could not be loaded: {1}", + key, InstallerType.class.getEnumConstants()); + } + } + } + return installerDetails; + } + /** - * Returns the value if key is present. Since the application tracks downloaded artifact location, - * key is usually patch number or artifact identifier. Value is location on disk. - * - * @param key key to look for. Ex: patch number - * @return value if present in cache or else null. + * Add installer to local file. + * @param installerType installer type + * @param commonName common name used + * @param metaData installer metadata */ - String getValueFromCache(String key); + public void addInstaller(InstallerType installerType, String commonName, InstallerMetaData metaData) + throws IOException { + + EnumMap>> installerDetails = getInstallers(); + Map> installerMetaDataMap; + List installerMetaDataList; + + if (installerDetails.containsKey(installerType)) { + installerMetaDataMap = installerDetails.get(installerType); + } else { + installerDetails.put(installerType, new HashMap<>()); + installerMetaDataMap = installerDetails.get(installerType); + } + if (installerMetaDataMap.containsKey(commonName)) { + installerMetaDataList = installerMetaDataMap.get(commonName); + } else { + installerMetaDataMap.put(commonName, new ArrayList<>()); + installerMetaDataList = installerMetaDataMap.get(commonName); + } + installerMetaDataList.add(metaData); + // Update the list + installerDetails.put(installerType, installerMetaDataMap); + saveAllInstallers(installerDetails, ConfigManager.getInstance().getInstallerDetailsFile()); + } /** - * Checks if cache contains the specified key. - * - * @param key artifact identifier - * @return true if found + * Return the metadata for the platformed installer. + * @param platformName platform name + * @param installerVersion version of the installer + * @return InstallerMetaData meta data for the installer */ - boolean containsKey(String key); + + public InstallerMetaData getInstallerForPlatform(InstallerType installerType, Architecture platformName, + String installerVersion) { + + if (platformName == null) { + platformName = Architecture.GENERIC; + } + Map> installers = getInstallers().get(installerType); + if (installers != null && !installers.isEmpty()) { + List installerMetaDataList = installers.get(installerVersion); + if (installerMetaDataList != null && !installerMetaDataList.isEmpty()) { + for (InstallerMetaData installerMetaData: installerMetaDataList) { + if (platformName.getAcceptableNames().contains(installerMetaData.getPlatform())) { + return installerMetaData; + } + } + if (Utils.isGenericInstallerAcceptable(installerType)) { + //If it can't find the specialized platform, try generic. + for (InstallerMetaData installerMetaData: installerMetaDataList) { + if (Architecture.GENERIC.getAcceptableNames().contains(installerMetaData.getPlatform())) { + return installerMetaData; + } + } + } + } + } + return null; + + } /** - * Add an entry to the cache metadata file. - * - * @param key artifact identifier - * @param value a file path + * Add a patch to the local system. + * @param bugNumber bug number + * @param patchArchitecture architecture of the patch + * @param patchLocation file location of the patch + * @param patchVersion version of the patch + * @throws IOException error */ - void addToCache(String key, String value) throws CacheStoreException; + public void addPatch(String bugNumber, String patchArchitecture, String patchLocation, + String patchVersion, String description) throws IOException { + ConfigManager configManager = ConfigManager.getInstance(); + Map> patches = configManager.getAllPatches(); + List latestPatches = patches.get(bugNumber); + if (latestPatches == null) { + latestPatches = new ArrayList<>(); + } + PatchMetaData newPatch = new PatchMetaData(patchArchitecture, patchLocation, patchVersion, description); + latestPatches.add(newPatch); + patches.put(bugNumber, latestPatches); + configManager.saveAllPatches(patches, configManager.getPatchDetailsFile()); + } /** - * Delete an entry from the cache. - * - * @param key key corresponding to an entry in the cache - * @return value or null + * Return the metadata for the platformed installer. + * @param platformName platform name + * @param bugNumber version of the installer + * @return InstallerMetaData meta data for the installer */ - String deleteFromCache(String key) throws CacheStoreException; + + public PatchMetaData getPatchForPlatform(String platformName, String bugNumber, String version) { + Map> patches = getAllPatches(); + if (patches != null && !patches.isEmpty()) { + List patchMetaDataList = patches.get(bugNumber); + if (patchMetaDataList != null && !patchMetaDataList.isEmpty()) { + for (PatchMetaData patchMetaData: patchMetaDataList) { + if (platformName == null || platformName.isEmpty()) { + if (patchMetaData.getPlatform().equalsIgnoreCase("Generic") + && patchMetaData.getPatchVersion().equals(version)) { + return patchMetaData; + } + } else { + if (patchMetaData.getPlatform().equalsIgnoreCase(platformName) + && patchMetaData.getPatchVersion().equals(version)) { + return patchMetaData; + } + } + } + // search for generic for opatch only?? + if (OPatchFile.DEFAULT_BUG_NUM.equals(bugNumber)) { + for (PatchMetaData patchMetaData: patchMetaDataList) { + if ("generic".equalsIgnoreCase(patchMetaData.getPlatform())) { + return patchMetaData; + } + } + } + } + + } + return null; + } /** - * Delete all entries from the cache. + * Return the list of AruPatch data from for the patches by bug number from local. + * @param bugNumber version of the installer + * @return list of AruPatch */ - void clearCache() throws CacheStoreException; + + public List getAruPatchForBugNumber(String bugNumber) { + Map> patches = getAllPatches(); + List aruPatchList = new ArrayList<>(); + if (patches != null && !patches.isEmpty()) { + List resultPatchMetaDataList = patches.get(bugNumber); + if (resultPatchMetaDataList != null && !resultPatchMetaDataList.isEmpty()) { + for (PatchMetaData patchMetaData: resultPatchMetaDataList) { + AruPatch aruPatch = new AruPatch(); + + aruPatch.platformName(patchMetaData.getPlatform()) + .platform(getAruPlatformId(patchMetaData.getPlatform())) + .patchId(bugNumber) + .fileName(patchMetaData.getLocation()) + .version(patchMetaData.getPatchVersion()); + aruPatchList.add(aruPatch); + } + } + } + + return aruPatchList; + } + + /** + * return all the patches. + * @return patch settings + */ + public Map> getAllPatches() { + + + Map allPatches = new SettingsFile(Paths.get(ConfigManager.getInstance() + .getPatchDetailsFile())).load(); + Map> patchList = new HashMap<>(); + if (allPatches != null && !allPatches.isEmpty()) { + for (Map.Entry entry: allPatches.entrySet()) { + String key = entry.getKey(); // bug number + List patchMetaDataList = new ArrayList<>(); + if (key != null) { + if (entry.getValue() instanceof ArrayList) { + for (Object installerValue: (ArrayList) entry.getValue()) { + patchMetaDataList.add(createPatchMetaData((Map)installerValue)); + } + } else { + patchMetaDataList.add(createPatchMetaData((Map)entry.getValue())); + } + } + patchList.put(key, patchMetaDataList); + } + } + return patchList; + } /** - * Returns a map of current items in the cache. - * - * @return map of current items + * Save all patches in the local metadata file. + * @param allPatches Map of all patch metadata + * @param location file location for store + * @throws IOException when error */ - Map getCacheItems(); + public void saveAllPatches(Map> allPatches, String location) throws IOException { + Map patchList = new HashMap<>(); + for (Map.Entry> entry: allPatches.entrySet()) { + String key = entry.getKey(); // bug number + if (key != null && !key.isEmpty()) { + ArrayList list = new ArrayList<>(); + if (entry.getValue() instanceof ArrayList) { + for (PatchMetaData patchMetaData: entry.getValue()) { + LinkedHashMap map = new LinkedHashMap<>(); + map.put("version", patchMetaData.getPatchVersion()); + map.put("location", patchMetaData.getLocation()); + map.put("digest", patchMetaData.getHash()); + map.put("added", patchMetaData.getDateAdded()); + map.put("platform", patchMetaData.getPlatform()); + if (patchMetaData.getDescription() != null) { + map.put("description", patchMetaData.getDescription()); + } + list.add(map); + } + } else { + PatchMetaData patchMetaData = (PatchMetaData) entry.getValue(); + LinkedHashMap map = new LinkedHashMap<>(); + map.put("version", patchMetaData.getPatchVersion()); + map.put("location", patchMetaData.getLocation()); + map.put("digest", patchMetaData.getHash()); + map.put("added", patchMetaData.getDateAdded()); + map.put("platform", patchMetaData.getPlatform()); + if (patchMetaData.getDescription() != null) { + map.put("description", patchMetaData.getDescription()); + } + list.add(map); + } + patchList.put(key, list); + } + } + new SettingsFile(Paths.get(location)).save(patchList); + } + + /** + * Save all installers in the local metadata file. + * @param allInstallers Map of all installers metadata + * @param location file location for store + * @throws IOException when error + */ + public void saveAllInstallers(Map>> allInstallers, + String location) throws IOException { + LinkedHashMap installerList = new LinkedHashMap<>(); + + if (allInstallers != null && !allInstallers.isEmpty()) { + for (Map.Entry>> entry: allInstallers.entrySet()) { + InstallerType installerType = entry.getKey(); + Map> installerMetaDataList = entry.getValue(); + LinkedHashMap typedInstallers = new LinkedHashMap<>(); + + for (String installerMetaData : installerMetaDataList.keySet()) { + List mdList = installerMetaDataList.get(installerMetaData); + ArrayList installerMetaDataArray = new ArrayList<>(); + for (InstallerMetaData md : mdList) { + LinkedHashMap map = new LinkedHashMap<>(); + map.put("version", md.getProductVersion()); + map.put("location", md.getLocation()); + map.put("digest", md.getDigest()); + map.put("added", md.getDateAdded()); + map.put("platform", md.getPlatform()); + installerMetaDataArray.add(map); + } + typedInstallers.put(installerMetaData, installerMetaDataArray); + } + installerList.put(installerType.toString(), typedInstallers); + } + } + new SettingsFile(Paths.get(location)).save(installerList); + } + + + private InstallerMetaData createInstallerMetaData(Map objectData) { + String hash = (String) objectData.get("digest"); + String dateAdded = (String) objectData.get("added"); + if (dateAdded == null) { + dateAdded = getTodayDate(); + } + String location = (String) objectData.get("location"); + String productVersion = (String) objectData.get("version"); + String platform = (String) objectData.get("platform"); + return new InstallerMetaData(platform, location, hash, dateAdded, productVersion); + } + + private PatchMetaData createPatchMetaData(Map objectData) { + String hash = (String) objectData.get("digest"); + String dateAdded = (String) objectData.get("added"); + if (dateAdded == null) { + dateAdded = getTodayDate(); + } + String location = (String) objectData.get("location"); + String productVersion = (String) objectData.get("version"); + String platform = (String) objectData.get("platform"); + String description = (String) objectData.get("description"); + return new PatchMetaData(platform, location, hash, dateAdded, productVersion, description); + } - List getKeysForType(String type); } diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cachestore/CacheStoreFactory.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cachestore/CacheStoreFactory.java deleted file mode 100644 index 18927996..00000000 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cachestore/CacheStoreFactory.java +++ /dev/null @@ -1,28 +0,0 @@ -// Copyright (c) 2019, 2021, 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.cachestore; - -/** - * Provides access to a Cache Store. - */ -public class CacheStoreFactory { - - private static CacheStore store; - - private CacheStoreFactory() { - // hidden constructor - } - - /** - * Get the cache store. - * @return the cached instance of the file cache store - */ - public static CacheStore cache() throws CacheStoreException { - if (store == null) { - store = new FileCacheStore(); - } - - return store; - } -} diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cachestore/FileCacheStore.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cachestore/FileCacheStore.java deleted file mode 100644 index e7d65524..00000000 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cachestore/FileCacheStore.java +++ /dev/null @@ -1,184 +0,0 @@ -// Copyright (c) 2019, 2024, 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.cachestore; - -import java.io.BufferedReader; -import java.io.File; -import java.io.FileOutputStream; -import java.io.FileReader; -import java.io.IOException; -import java.nio.file.Files; -import java.nio.file.LinkOption; -import java.nio.file.Path; -import java.nio.file.Paths; -import java.time.LocalDateTime; -import java.util.List; -import java.util.Map; -import java.util.Objects; -import java.util.Properties; -import java.util.stream.Collectors; -import java.util.stream.Stream; - -import com.oracle.weblogic.imagetool.logging.LoggingFacade; -import com.oracle.weblogic.imagetool.logging.LoggingFactory; -import com.oracle.weblogic.imagetool.util.Constants; -import com.oracle.weblogic.imagetool.util.Utils; - -public class FileCacheStore implements CacheStore { - - public static final String CACHE_DIR_ENV = "WLSIMG_CACHEDIR"; - private static final LoggingFacade logger = LoggingFactory.getLogger(FileCacheStore.class); - - private final Properties properties = new Properties(); - private final File metadataFile; - private final String cacheDir; - - FileCacheStore() throws CacheStoreException { - try { - cacheDir = initCacheDir(); - metadataFile = Paths.get(cacheDir, Constants.DEFAULT_META_FILE).toFile(); - if (metadataFile.exists() && metadataFile.isFile()) { - loadProperties(metadataFile); - } else { - if (!metadataFile.createNewFile()) { - throw new IOException("Failed to create file cache metadata file " + metadataFile.getName()); - } - } - } catch (IOException e) { - CacheStoreException error = - new CacheStoreException("Failed to establish a cache store on the filesystem", e); - logger.throwing(error); - throw error; - } - } - - @Override - public String getCacheDir() { - return cacheDir; - } - - @Override - public String getValueFromCache(String key) { - Objects.requireNonNull(key, Utils.getMessage("IMG-0066")); - return properties.getProperty(key.toLowerCase()); - } - - @Override - public boolean containsKey(String key) { - if (key == null) { - return false; - } - return properties.containsKey(key.toLowerCase()); - } - - @Override - public void addToCache(String key, String value) throws CacheStoreException { - Objects.requireNonNull(key, Utils.getMessage("IMG-0066")); - Objects.requireNonNull(value, "Cache item value cannot be null"); - properties.put(key.toLowerCase(), value); - persistToDisk(); - } - - @Override - public String deleteFromCache(String key) throws CacheStoreException { - Objects.requireNonNull(key, Utils.getMessage("IMG-0066")); - String oldValue = (String) properties.remove(key.toLowerCase()); - if (oldValue != null) { - persistToDisk(); - } - return oldValue; - } - - @Override - public void clearCache() throws CacheStoreException { - properties.clear(); - persistToDisk(); - } - - @Override - public Map getCacheItems() { - Stream> stream = properties.entrySet().stream(); - return stream.collect(Collectors.toMap( - e -> String.valueOf(e.getKey()), - e -> String.valueOf(e.getValue()))); - } - - /** - * Find the cache keys for entries that match the provided type. - * Cache keys are of the form type_version_architecture. - * @param type The patch type like "wls" or for bugs "12355678" - * @return a list of cache keys that start with the provided string - */ - @Override - public List getKeysForType(String type) { - return properties.keySet().stream() - .map(Object::toString) - .filter(k -> k.startsWith(type)) - .collect(Collectors.toList()); - } - - private void persistToDisk() throws CacheStoreException { - logger.entering(); - synchronized (properties) { - try (FileOutputStream outputStream = new FileOutputStream(metadataFile)) { - properties.store(outputStream, "changed on:" + LocalDateTime.now()); - } catch (IOException e) { - CacheStoreException error = new CacheStoreException("Could not persist cache file", e); - logger.throwing(error); - throw error; - } - } - logger.exiting(); - } - - private void loadProperties(File propsFile) { - logger.entering(); - try (BufferedReader bufferedReader = new BufferedReader(new FileReader(propsFile))) { - if (properties.isEmpty()) { - properties.load(bufferedReader); - } else { - Properties tmpProperties = new Properties(); - tmpProperties.load(bufferedReader); - tmpProperties.forEach((key, value) -> properties.put(((String) key).toLowerCase(), value)); - } - } catch (IOException e) { - // it is okay to fail, the constructor will attempt to create a new one - logger.fine("Failed to load properties file", e); - } - logger.exiting(); - } - - private static String defaultCacheDir() { - return System.getProperty("user.home") + File.separator + "cache"; - } - - String getCacheDirSetting() { - return Utils.getEnvironmentProperty(CACHE_DIR_ENV, FileCacheStore::defaultCacheDir); - } - - /** - * Initialize the cache store directory. - * - * @return cache directory - */ - private String initCacheDir() throws IOException { - String cacheDirStr = getCacheDirSetting(); - Path cacheDirectory = Paths.get(cacheDirStr); - - boolean pathExists = Files.exists(cacheDirectory, LinkOption.NOFOLLOW_LINKS); - - if (!pathExists) { - Files.createDirectory(cacheDirectory); - } else { - if (!Files.isDirectory(cacheDirectory)) { - throw new IOException("Cache Directory specified is not a directory " + cacheDirStr); - } - if (!Files.isWritable(cacheDirectory)) { - throw new IOException("Cache Directory specified is not writable " + cacheDirStr); - } - } - - return cacheDirStr; - } -} diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/AddEntry.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/AddEntry.java deleted file mode 100644 index 810e6087..00000000 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/AddEntry.java +++ /dev/null @@ -1,49 +0,0 @@ -// Copyright (c) 2019, 2021, 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.cli.cache; - -import com.oracle.weblogic.imagetool.api.model.CommandResponse; -import com.oracle.weblogic.imagetool.cachestore.CacheStoreException; -import com.oracle.weblogic.imagetool.util.Utils; -import picocli.CommandLine.Command; -import picocli.CommandLine.Option; - -import static com.oracle.weblogic.imagetool.cachestore.CacheStoreFactory.cache; - -@Command( - name = "addEntry", - description = "Command to add a cache entry. Use caution" -) -public class AddEntry extends CacheOperation { - - @Override - public CommandResponse call() throws CacheStoreException { - if (!Utils.isEmptyString(key) && !Utils.isEmptyString(location)) { - String oldValue = cache().getValueFromCache(key); - String msg; - if (oldValue != null) { - msg = String.format("Replaced old value %s with new value %s for key %s", oldValue, location, key); - } else { - msg = String.format("Added entry %s=%s", key, location); - } - cache().addToCache(key, location); - return CommandResponse.success(msg); - } - return CommandResponse.error("IMG-0044"); - } - - @Option( - names = {"--key"}, - description = "Key for the cache entry", - required = true - ) - private String key; - - @Option( - names = {"--value"}, - description = "Value for the cache entry", - required = true - ) - private String location; -} diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/ConfigManager.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/ConfigManager.java index 41c60fac..cf74d901 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/ConfigManager.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/ConfigManager.java @@ -12,6 +12,7 @@ import java.util.Map; import com.oracle.weblogic.imagetool.aru.AruPatch; +import com.oracle.weblogic.imagetool.cachestore.CacheStore; import com.oracle.weblogic.imagetool.installer.InstallerMetaData; import com.oracle.weblogic.imagetool.installer.InstallerType; import com.oracle.weblogic.imagetool.logging.LoggingFacade; @@ -19,13 +20,14 @@ import com.oracle.weblogic.imagetool.patch.PatchMetaData; import com.oracle.weblogic.imagetool.util.Architecture; -import static com.oracle.weblogic.imagetool.cachestore.FileCacheStore.CACHE_DIR_ENV; +import static com.oracle.weblogic.imagetool.cachestore.CacheStore.CACHE_DIR_ENV; import static com.oracle.weblogic.imagetool.util.Utils.getTodayDate; public class ConfigManager { private UserSettingsFile userSettingsFile; private static ConfigManager instance; private static final LoggingFacade logger = LoggingFactory.getLogger(UserSettingsFile.class); + private static CacheStore cacheStore = new CacheStore(); private ConfigManager(Path userSettingsFileName) { if (userSettingsFileName != null) { @@ -33,6 +35,7 @@ private ConfigManager(Path userSettingsFileName) { } else { userSettingsFile = new UserSettingsFile(); } + } /** @@ -63,33 +66,42 @@ public static synchronized ConfigManager getInstance(Path fileName) { return instance; } - public Map> getAllPatches() { - return userSettingsFile.getAllPatches(); + + public String getPatchDirectory() { + return userSettingsFile.getPatchDirectory(); } - public void saveAllPatches(Map> allPatches, String location) throws IOException { - userSettingsFile.saveAllPatches(allPatches, location); + public String getPatchDetailsFile() { + return userSettingsFile.getPatchDetailsFile(); } - public void addPatch(String bugNumber, String patchArchitecture, String patchLocation, - String patchVersion, String description) throws IOException { - userSettingsFile.addPatch(bugNumber, patchArchitecture, patchLocation, patchVersion, description); + public String getBuildEngine() { + return userSettingsFile.getBuildEngine(); } - public PatchMetaData getPatchForPlatform(String platformName, String bugNumber, String version) { - return userSettingsFile.getPatchForPlatform(platformName, bugNumber, version); + public String getInstallerDetailsFile() { + return userSettingsFile.getInstallerDetailsFile(); } - public String getPatchDirectory() { - return userSettingsFile.getPatchDirectory(); + public String getDefaultBuildPlatform() { + return userSettingsFile.getDefaultBuildPlatform(); } - public String getPatchDetailsFile() { - return userSettingsFile.getPatchDetailsFile(); + public Map> getAllPatches() { + return cacheStore.getAllPatches(); } - public String getBuildEngine() { - return userSettingsFile.getBuildEngine(); + public void saveAllPatches(Map> allPatches, String location) throws IOException { + cacheStore.saveAllPatches(allPatches, location); + } + + public void addPatch(String bugNumber, String patchArchitecture, String patchLocation, + String patchVersion, String description) throws IOException { + cacheStore.addPatch(bugNumber, patchArchitecture, patchLocation, patchVersion, description); + } + + public PatchMetaData getPatchForPlatform(String platformName, String bugNumber, String version) { + return cacheStore.getPatchForPlatform(platformName, bugNumber, version); } /** @@ -100,7 +112,7 @@ public String getBuildEngine() { */ public InstallerMetaData getInstallerForPlatform(InstallerType installerType, Architecture platformName, String installerVersion) { - return userSettingsFile.getInstallerForPlatform(installerType, platformName, installerVersion); + return cacheStore.getInstallerForPlatform(installerType, platformName, installerVersion); } /** @@ -108,12 +120,7 @@ public InstallerMetaData getInstallerForPlatform(InstallerType installerType, Ar * @return map of installers */ public EnumMap>> getInstallers() { - - return userSettingsFile.getInstallers(); - } - - public String getInstallerDetailsFile() { - return userSettingsFile.getInstallerDetailsFile(); + return cacheStore.getInstallers(); } /** @@ -125,7 +132,7 @@ public String getInstallerDetailsFile() { */ public void addInstaller(InstallerType installerType, String commonName, InstallerMetaData metaData) throws IOException { - userSettingsFile.addInstaller(installerType,commonName, metaData); + cacheStore.addInstaller(installerType, commonName, metaData); } /** @@ -136,7 +143,7 @@ public void addInstaller(InstallerType installerType, String commonName, Install */ public void saveAllInstallers(Map>> allInstallers, String location) throws IOException { - userSettingsFile.saveAllInstallers(allInstallers, location); + cacheStore.saveAllInstallers(allInstallers, location); } /** @@ -146,12 +153,9 @@ public void saveAllInstallers(Map getAruPatchForBugNumber(String bugNumber) { - return userSettingsFile.getAruPatchForBugNumber(bugNumber); + return cacheStore.getAruPatchForBugNumber(bugNumber); } - public String getDefaultBuildPlatform() { - return userSettingsFile.getDefaultBuildPlatform(); - } private InstallerMetaData createInstallerMetaData(Map objectData) { String hash = (String) objectData.get("digest"); @@ -178,5 +182,4 @@ private PatchMetaData createPatchMetaData(Map objectData) { return new PatchMetaData(platform, location, hash, dateAdded, productVersion, description); } - } diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/UserSettingsFile.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/UserSettingsFile.java index b3d29b7b..5000de79 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/UserSettingsFile.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/UserSettingsFile.java @@ -6,25 +6,12 @@ import java.io.IOException; import java.nio.file.Path; import java.nio.file.Paths; -import java.util.ArrayList; import java.util.EnumMap; -import java.util.HashMap; -import java.util.LinkedHashMap; -import java.util.List; import java.util.Map; -import com.oracle.weblogic.imagetool.aru.AruPatch; -import com.oracle.weblogic.imagetool.cachestore.OPatchFile; -import com.oracle.weblogic.imagetool.installer.InstallerMetaData; import com.oracle.weblogic.imagetool.installer.InstallerType; import com.oracle.weblogic.imagetool.logging.LoggingFacade; import com.oracle.weblogic.imagetool.logging.LoggingFactory; -import com.oracle.weblogic.imagetool.patch.PatchMetaData; -import com.oracle.weblogic.imagetool.util.Architecture; -import com.oracle.weblogic.imagetool.util.Utils; - -import static com.oracle.weblogic.imagetool.aru.AruUtil.getAruPlatformId; -import static com.oracle.weblogic.imagetool.util.Utils.getTodayDate; public class UserSettingsFile { private static final LoggingFacade logger = LoggingFactory.getLogger(UserSettingsFile.class); @@ -253,376 +240,6 @@ public InstallerSettings getInstallerSettings(InstallerType installerType) { return installerSettings.get(installerType); } - public Map getInstaller(InstallerType installerType) { - return null; - } - - private InstallerMetaData createInstallerMetaData(Map objectData) { - String hash = (String) objectData.get("digest"); - String dateAdded = (String) objectData.get("added"); - if (dateAdded == null) { - dateAdded = getTodayDate(); - } - String location = (String) objectData.get("location"); - String productVersion = (String) objectData.get("version"); - String platform = (String) objectData.get("platform"); - return new InstallerMetaData(platform, location, hash, dateAdded, productVersion); - } - - private PatchMetaData createPatchMetaData(Map objectData) { - String hash = (String) objectData.get("digest"); - String dateAdded = (String) objectData.get("added"); - if (dateAdded == null) { - dateAdded = getTodayDate(); - } - String location = (String) objectData.get("location"); - String productVersion = (String) objectData.get("version"); - String platform = (String) objectData.get("platform"); - String description = (String) objectData.get("description"); - return new PatchMetaData(platform, location, hash, dateAdded, productVersion, description); - } - - /** - * Return all the installers based on the configured directory for the yaml file. - * @return map of installers - */ - public EnumMap>> getInstallers() { - - - // installers is a list of different installer types jdk, fmw, wdt etc .. - // For each installer type, there is a list of individual installer - //jdk: - // 11u22: - // - platform: linux/arm64 - // file: /path/to/installerarm.gz - // digest: e6a8e178e73aea2fc512799423822bf065758f5e - // version: 11.0.22 - // added: 20241201 - // - platform: linux/amd64 - // file: /path/to/installeramd.gz - // digest: 1d6dc346ba26bcf1d0c6b5efb030e0dd2f842add - // version: 11.0.22 - // added: 20241201 - // 8u401: - //wls: - // 12.2.1.4.0: - // - platform: linux/arm64 - // .... - // - platform: linux/arm64 - - Map allInstallers = new SettingsFile(Paths.get(installerDetailsFile)).load(); - if (allInstallers == null) { - allInstallers = new HashMap<>(); - } - EnumMap>> installerDetails - = new EnumMap<>(InstallerType.class); - for (Map.Entry entry: allInstallers.entrySet()) { - String key = entry.getKey(); - if (key != null && !key.isEmpty()) { - Map> installerMetaData = new HashMap<>(); - key = key.toUpperCase(); // jdk, wls, fmw etc ... - try { - // process list of individual installers - // 12.2.1.4.0: - // - platform: linux/arm64 - // - platform: linux/amd64 - // 14.1.2.0.0: - // - platform: - // - platform - Map installerValues = (Map) entry.getValue(); - - for (Map.Entry individualInstaller: installerValues.entrySet()) { - String individualInstallerKey = individualInstaller.getKey(); // e.g. 12.2.1.4, 14.1.2 - List installerMetaDataList = new ArrayList<>(installerValues.size()); - - if (individualInstaller.getValue() instanceof ArrayList) { - for (Object installerValue: (ArrayList) individualInstaller.getValue()) { - installerMetaDataList.add(createInstallerMetaData((Map)installerValue)); - } - } else { - installerMetaDataList.add( - createInstallerMetaData((Map)individualInstaller.getValue())); - } - installerMetaData.put(individualInstallerKey, installerMetaDataList); - } - - installerDetails.put(InstallerType.valueOf(key), installerMetaData); - - } catch (IllegalArgumentException illegal) { - logger.warning("{0} could not be loaded: {1}", - key, InstallerType.class.getEnumConstants()); - } - } - } - return installerDetails; - } - - - /** - * Add installer to local file. - * @param installerType installer type - * @param commonName common name used - * @param metaData installer metadata - */ - public void addInstaller(InstallerType installerType, String commonName, InstallerMetaData metaData) - throws IOException { - - EnumMap>> installerDetails = getInstallers(); - Map> installerMetaDataMap; - List installerMetaDataList; - - if (installerDetails.containsKey(installerType)) { - installerMetaDataMap = installerDetails.get(installerType); - } else { - installerDetails.put(installerType, new HashMap<>()); - installerMetaDataMap = installerDetails.get(installerType); - } - if (installerMetaDataMap.containsKey(commonName)) { - installerMetaDataList = installerMetaDataMap.get(commonName); - } else { - installerMetaDataMap.put(commonName, new ArrayList<>()); - installerMetaDataList = installerMetaDataMap.get(commonName); - } - installerMetaDataList.add(metaData); - // Update the list - installerDetails.put(installerType, installerMetaDataMap); - saveAllInstallers(installerDetails, installerDetailsFile); - } - - /** - * Return the metadata for the platformed installer. - * @param platformName platform name - * @param installerVersion version of the installer - * @return InstallerMetaData meta data for the installer - */ - - public InstallerMetaData getInstallerForPlatform(InstallerType installerType, Architecture platformName, - String installerVersion) { - - // TODO - if (platformName == null) { - platformName = Architecture.GENERIC; - } - Map> installers = getInstallers().get(installerType); - if (installers != null && !installers.isEmpty()) { - List installerMetaDataList = installers.get(installerVersion); - if (installerMetaDataList != null && !installerMetaDataList.isEmpty()) { - for (InstallerMetaData installerMetaData: installerMetaDataList) { - if (platformName.getAcceptableNames().contains(installerMetaData.getPlatform())) { - return installerMetaData; - } - } - if (Utils.isGenericInstallerAcceptable(installerType)) { - //If it can't find the specialized platform, try generic. - for (InstallerMetaData installerMetaData: installerMetaDataList) { - if (Architecture.GENERIC.getAcceptableNames().contains(installerMetaData.getPlatform())) { - return installerMetaData; - } - } - } - } - } - return null; - - } - - /** - * Add a patch to the local system. - * @param bugNumber bug number - * @param patchArchitecture architecture of the patch - * @param patchLocation file location of the patch - * @param patchVersion version of the patch - * @throws IOException error - */ - public void addPatch(String bugNumber, String patchArchitecture, String patchLocation, - String patchVersion, String description) throws IOException { - ConfigManager configManager = ConfigManager.getInstance(); - Map> patches = configManager.getAllPatches(); - List latestPatches = patches.get(bugNumber); - if (latestPatches == null) { - latestPatches = new ArrayList<>(); - } - PatchMetaData newPatch = new PatchMetaData(patchArchitecture, patchLocation, patchVersion, description); - latestPatches.add(newPatch); - patches.put(bugNumber, latestPatches); - configManager.saveAllPatches(patches, configManager.getPatchDetailsFile()); - } - - /** - * Return the metadata for the platformed installer. - * @param platformName platform name - * @param bugNumber version of the installer - * @return InstallerMetaData meta data for the installer - */ - - public PatchMetaData getPatchForPlatform(String platformName, String bugNumber, String version) { - Map> patches = getAllPatches(); - if (patches != null && !patches.isEmpty()) { - List patchMetaDataList = patches.get(bugNumber); - if (patchMetaDataList != null && !patchMetaDataList.isEmpty()) { - for (PatchMetaData patchMetaData: patchMetaDataList) { - if (platformName == null || platformName.isEmpty()) { - if (patchMetaData.getPlatform().equalsIgnoreCase("Generic") - && patchMetaData.getPatchVersion().equals(version)) { - return patchMetaData; - } - } else { - if (patchMetaData.getPlatform().equalsIgnoreCase(platformName) - && patchMetaData.getPatchVersion().equals(version)) { - return patchMetaData; - } - } - } - // search for generic for opatch only?? - if (OPatchFile.DEFAULT_BUG_NUM.equals(bugNumber)) { - for (PatchMetaData patchMetaData: patchMetaDataList) { - if ("generic".equalsIgnoreCase(patchMetaData.getPlatform())) { - return patchMetaData; - } - } - } - } - - } - return null; - } - - /** - * Return the list of AruPatch data from for the patches by bug number from local. - * @param bugNumber version of the installer - * @return list of AruPatch - */ - - public List getAruPatchForBugNumber(String bugNumber) { - Map> patches = getAllPatches(); - List aruPatchList = new ArrayList<>(); - if (patches != null && !patches.isEmpty()) { - List resultPatchMetaDataList = patches.get(bugNumber); - if (resultPatchMetaDataList != null && !resultPatchMetaDataList.isEmpty()) { - for (PatchMetaData patchMetaData: resultPatchMetaDataList) { - AruPatch aruPatch = new AruPatch(); - - aruPatch.platformName(patchMetaData.getPlatform()) - .platform(getAruPlatformId(patchMetaData.getPlatform())) - .patchId(bugNumber) - .fileName(patchMetaData.getLocation()) - .version(patchMetaData.getPatchVersion()); - aruPatchList.add(aruPatch); - } - } - } - - return aruPatchList; - } - - /** - * return all the patches. - * @return patch settings - */ - public Map> getAllPatches() { - - - Map allPatches = new SettingsFile(Paths.get(patchDetailsFile)).load(); - Map> patchList = new HashMap<>(); - if (allPatches != null && !allPatches.isEmpty()) { - for (Map.Entry entry: allPatches.entrySet()) { - String key = entry.getKey(); // bug number - List patchMetaDataList = new ArrayList<>(); - if (key != null) { - if (entry.getValue() instanceof ArrayList) { - for (Object installerValue: (ArrayList) entry.getValue()) { - patchMetaDataList.add(createPatchMetaData((Map)installerValue)); - } - } else { - patchMetaDataList.add(createPatchMetaData((Map)entry.getValue())); - } - } - patchList.put(key, patchMetaDataList); - } - } - return patchList; - } - - /** - * Save all patches in the local metadata file. - * @param allPatches Map of all patch metadata - * @param location file location for store - * @throws IOException when error - */ - public void saveAllPatches(Map> allPatches, String location) throws IOException { - Map patchList = new HashMap<>(); - for (Map.Entry> entry: allPatches.entrySet()) { - String key = entry.getKey(); // bug number - if (key != null && !key.isEmpty()) { - ArrayList list = new ArrayList<>(); - if (entry.getValue() instanceof ArrayList) { - for (PatchMetaData patchMetaData: entry.getValue()) { - LinkedHashMap map = new LinkedHashMap<>(); - map.put("version", patchMetaData.getPatchVersion()); - map.put("location", patchMetaData.getLocation()); - map.put("digest", patchMetaData.getHash()); - map.put("added", patchMetaData.getDateAdded()); - map.put("platform", patchMetaData.getPlatform()); - if (patchMetaData.getDescription() != null) { - map.put("description", patchMetaData.getDescription()); - } - list.add(map); - } - } else { - PatchMetaData patchMetaData = (PatchMetaData) entry.getValue(); - LinkedHashMap map = new LinkedHashMap<>(); - map.put("version", patchMetaData.getPatchVersion()); - map.put("location", patchMetaData.getLocation()); - map.put("digest", patchMetaData.getHash()); - map.put("added", patchMetaData.getDateAdded()); - map.put("platform", patchMetaData.getPlatform()); - if (patchMetaData.getDescription() != null) { - map.put("description", patchMetaData.getDescription()); - } - list.add(map); - } - patchList.put(key, list); - } - } - new SettingsFile(Paths.get(location)).save(patchList); - } - - /** - * Save all installers in the local metadata file. - * @param allInstallers Map of all installers metadata - * @param location file location for store - * @throws IOException when error - */ - public void saveAllInstallers(Map>> allInstallers, - String location) throws IOException { - LinkedHashMap installerList = new LinkedHashMap<>(); - - if (allInstallers != null && !allInstallers.isEmpty()) { - for (Map.Entry>> entry: allInstallers.entrySet()) { - InstallerType installerType = entry.getKey(); - Map> installerMetaDataList = entry.getValue(); - LinkedHashMap typedInstallers = new LinkedHashMap<>(); - - for (String installerMetaData : installerMetaDataList.keySet()) { - List mdList = installerMetaDataList.get(installerMetaData); - ArrayList installerMetaDataArray = new ArrayList<>(); - for (InstallerMetaData md : mdList) { - LinkedHashMap map = new LinkedHashMap<>(); - map.put("version", md.getProductVersion()); - map.put("location", md.getLocation()); - map.put("digest", md.getDigest()); - map.put("added", md.getDateAdded()); - map.put("platform", md.getPlatform()); - installerMetaDataArray.add(map); - } - typedInstallers.put(installerMetaData, installerMetaDataArray); - } - installerList.put(installerType.toString(), typedInstallers); - } - } - new SettingsFile(Paths.get(location)).save(installerList); - } - private void applySettings(Map settings) { logger.entering(); if (settings == null || settings.isEmpty()) { diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/util/CacheConversion.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/util/CacheConversion.java index 91c0831e..03291ffe 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/util/CacheConversion.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/util/CacheConversion.java @@ -6,13 +6,23 @@ import java.io.BufferedReader; import java.io.FileReader; import java.io.IOException; +import java.nio.file.Files; +import java.nio.file.Path; +import java.nio.file.Paths; +import java.nio.file.attribute.FileTime; +import java.time.LocalDate; +import java.time.ZoneId; +import java.time.format.DateTimeFormatter; import java.util.regex.Matcher; import java.util.regex.Pattern; +import com.oracle.weblogic.imagetool.cachestore.CacheStore; import com.oracle.weblogic.imagetool.cachestore.OPatchFile; import com.oracle.weblogic.imagetool.installer.InstallerMetaData; +import com.oracle.weblogic.imagetool.installer.InstallerType; import com.oracle.weblogic.imagetool.logging.LoggingFacade; import com.oracle.weblogic.imagetool.logging.LoggingFactory; +import com.oracle.weblogic.imagetool.settings.ConfigManager; /** * Utility to convert image tool 1.x cache store to 2.0 format @@ -48,8 +58,11 @@ public void convert(String inputFile) throws IOException { String version = matcher.group(2); String arch = matcher.group(3); String filepath = matcher.group(4); - //ConfigManager.getInstance().addPatch(key, arch, filepath, version); - // TODO + String fileDate = getFileDate(filepath); + if (fileDate != null) { + ConfigManager.getInstance().addPatch(key, arch, filepath, version, + "Converted from v1 in " + fileDate); + } } else { logger.warning("IMG-0128", line); } @@ -61,10 +74,12 @@ public void convert(String inputFile) throws IOException { String version = matcher.group(2); String arch = matcher.group(3); String filepath = matcher.group(4); - InstallerMetaData metaData = new InstallerMetaData(arch, filepath, - Utils.getSha256Hash(filepath), Utils.getTodayDate(), version); - //ConfigManager.getInstance().addInstaller(InstallerType.valueOf(key), version, metaData); - //// TODO + String fileDate = getFileDate(filepath); + if (fileDate != null) { + InstallerMetaData metaData = new InstallerMetaData(arch, filepath, + Utils.getSha256Hash(filepath), fileDate, version); + ConfigManager.getInstance().addInstaller(InstallerType.valueOf(key), version, metaData); + } } else { logger.warning("IMG-0128", line); } @@ -74,8 +89,44 @@ public void convert(String inputFile) throws IOException { } } + private String getFileDate(String filepath) { + try { + Path path = Paths.get(filepath); + if (Files.exists(path)) { + FileTime modifiedTime = Files.getLastModifiedTime(path); + LocalDate today = modifiedTime.toInstant() + .atZone(ZoneId.systemDefault()) + .toLocalDate(); + return today.format(DateTimeFormatter.ISO_LOCAL_DATE); + } else { + logger.warning("IMG-0131", filepath); + return null; + } + } catch (IOException ioe) { + logger.warning("IMG-0132", filepath, ioe.getLocalizedMessage()); + return null; + } + } + + /** + * Main for converting v1 .metadata file + * @param args arguments + * @throws IOException when error converting .metadata file + */ public static void main(String[] args) throws IOException { + // TODO: Need some setup for settings first??? CacheConversion cacheConversion = new CacheConversion(); - cacheConversion.convert("/Users/JSHUM/dimtemp23/cache/.metadata"); + String cacheEnv = System.getenv(CacheStore.CACHE_DIR_ENV); + Path cacheMetaFile; + if (cacheEnv != null) { + cacheMetaFile = Paths.get(cacheEnv, ".metadata"); + } else { + cacheMetaFile = Paths.get(System.getProperty("user.home"), ".metadata"); + } + if (Files.exists(cacheMetaFile)) { + cacheConversion.convert(cacheMetaFile.toString()); + } else { + logger.info("IMG-0133", cacheMetaFile.toString()); + } } } diff --git a/imagetool/src/main/resources/ImageTool.properties b/imagetool/src/main/resources/ImageTool.properties index 4de52283..4e47df4e 100644 --- a/imagetool/src/main/resources/ImageTool.properties +++ b/imagetool/src/main/resources/ImageTool.properties @@ -126,6 +126,9 @@ IMG-0124=You must specify --type --version and --architecture for deleting an in IMG-0125=Specified installer to delete cannot be found. IMG-0126=You must specify --patchId --version and --architecture for deleting a patchr. IMG-0127=Specified installer to delete cannot be found. -IMG-0128=Cannot parse version 1 metadata file line: {0}. -IMG-0129=Missing --architecture value for adding installer type {0}. +IMG-0128=Cannot parse image tool version 1 metadata file line: {0}. +IMG-0129=Missing --architecture value for adding installer type {0}. IMG-0130=Successfully added patch to cache. [[cyan: bug:]] {0} [[cyan: version:]] {1} [[cyan: filepath:]] {2} +IMG-0131=Image tool v1 cache entry specified file {0} no longer exists, skipping conversion. You can add it manually. +IMG-0132=Image tool v1 cache entry specified file {0} cannot be accessed {1}, skipping conversion. You can add it manually. +IMG-0133=Image tool conversion cannot find .metadata file in {0}. diff --git a/imagetool/src/test/java/com/oracle/weblogic/imagetool/cachestore/CacheStoreTestImpl.java b/imagetool/src/test/java/com/oracle/weblogic/imagetool/cachestore/CacheStoreTestImpl.java deleted file mode 100644 index 71e1cce2..00000000 --- a/imagetool/src/test/java/com/oracle/weblogic/imagetool/cachestore/CacheStoreTestImpl.java +++ /dev/null @@ -1,63 +0,0 @@ -// Copyright (c) 2020, 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.cachestore; - -import java.nio.file.Path; -import java.util.ArrayList; -import java.util.HashMap; -import java.util.List; -import java.util.Map; - -public class CacheStoreTestImpl implements CacheStore { - - private final HashMap cache = new HashMap<>(); - private final Path cacheDir; - - public CacheStoreTestImpl(Path cacheDir) { - this.cacheDir = cacheDir; - } - - @Override - public String getCacheDir() { - return cacheDir.toString(); - } - - @Override - public String getValueFromCache(String key) { - return cache.get(key); - } - - @Override - public boolean containsKey(String key) { - if (key == null) { - return false; - } - return cache.containsKey(key.toLowerCase()); - } - - @Override - public void addToCache(String key, String value) { - cache.put(key.toLowerCase(), value); - } - - @Override - public String deleteFromCache(String key) { - return null; - } - - @Override - public void clearCache() { - cache.clear(); - } - - @Override - public Map getCacheItems() { - return cache; - } - - @Override - public List getKeysForType(String type) { - return new ArrayList<>(); - } -} diff --git a/imagetool/src/test/java/com/oracle/weblogic/imagetool/cachestore/CachedFileTest.java b/imagetool/src/test/java/com/oracle/weblogic/imagetool/cachestore/CachedFileTest.java index 43f23905..92859a21 100644 --- a/imagetool/src/test/java/com/oracle/weblogic/imagetool/cachestore/CachedFileTest.java +++ b/imagetool/src/test/java/com/oracle/weblogic/imagetool/cachestore/CachedFileTest.java @@ -7,6 +7,7 @@ import java.io.IOException; import java.nio.file.Files; import java.nio.file.Path; +import java.nio.file.Paths; import java.util.ArrayList; import java.util.Arrays; import java.util.List; @@ -21,6 +22,7 @@ import com.oracle.weblogic.imagetool.settings.ConfigManager; import com.oracle.weblogic.imagetool.test.annotations.ReduceTestLogging; import com.oracle.weblogic.imagetool.util.Architecture; +import com.oracle.weblogic.imagetool.util.TestSetup; import com.oracle.weblogic.imagetool.util.Utils; import org.junit.jupiter.api.BeforeAll; import org.junit.jupiter.api.Tag; @@ -52,22 +54,10 @@ static void setup(@TempDir Path tempDir, @TempDir Path cacheDir) throws IOExcept Path path1411 = tempDir.resolve("installer.file.141100.jar"); Files.write(path1411, fileContents); - Path settingsFileName = tempDir.resolve("settings.yaml"); - Path installerFile = tempDir.resolve("installers.yaml"); - Path patchFile = tempDir.resolve("patches.yaml"); - Files.createFile(settingsFileName); - Files.createFile(installerFile); - Files.createFile(patchFile); - - - List lines = Arrays.asList( - "installerSettingsFile: " + installerFile.toAbsolutePath().toString(), - "patchSettingsFile: " + patchFile.toAbsolutePath().toString(), - "installerDirectory: " + tempDir.toAbsolutePath().toString(), - "patchDirectory: " + tempDir.toAbsolutePath().toString() - ); - Files.write(settingsFileName, lines); - ConfigManager configManager = ConfigManager.getInstance(settingsFileName); + + TestSetup.setup(tempDir); + ConfigManager configManager = ConfigManager.getInstance(); + Path patchFile = Paths.get(configManager.getPatchDetailsFile()); InstallerMetaData installer1 = new InstallerMetaData("Generic", path12213.toString(), diff --git a/imagetool/src/test/java/com/oracle/weblogic/imagetool/cachestore/FileCacheStoreTest.java b/imagetool/src/test/java/com/oracle/weblogic/imagetool/cachestore/FileCacheStoreTest.java deleted file mode 100644 index 4464897a..00000000 --- a/imagetool/src/test/java/com/oracle/weblogic/imagetool/cachestore/FileCacheStoreTest.java +++ /dev/null @@ -1,81 +0,0 @@ -// Copyright (c) 2019, 2024, 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.cachestore; - -import java.io.File; - -import org.junit.jupiter.api.BeforeAll; -import org.junit.jupiter.api.MethodOrderer; -import org.junit.jupiter.api.Order; -import org.junit.jupiter.api.Tag; -import org.junit.jupiter.api.Test; -import org.junit.jupiter.api.TestMethodOrder; -import org.junit.jupiter.api.io.TempDir; - -import static com.oracle.weblogic.imagetool.cachestore.CacheStoreFactory.cache; -import static org.junit.jupiter.api.Assertions.assertDoesNotThrow; -import static org.junit.jupiter.api.Assertions.assertEquals; -import static org.junit.jupiter.api.Assertions.assertNotNull; -import static org.junit.jupiter.api.Assertions.assertNull; -import static org.junit.jupiter.api.Assertions.assertTrue; - -@Tag("unit") -@TestMethodOrder(MethodOrderer.OrderAnnotation.class) -class FileCacheStoreTest { - - private static final String TEST_KEY = "abc_xyz_123"; - private static final String TEST_VAL = "this_is_a_test"; - - @BeforeAll - static void init(@TempDir File tempDir) throws CacheStoreException { - System.setProperty(FileCacheStore.CACHE_DIR_ENV, tempDir.getAbsolutePath()); - cache().clearCache(); - } - - @Test - @Order(1) - void addingValueToCache() { - // add value to cache - assertDoesNotThrow(() -> cache().addToCache(TEST_KEY, TEST_VAL), "Add to cache threw an exception"); - } - - @Test - @Order(2) - void checkValueInCache() { - // check to see if the key that was just added is there, and value matches expected value - assertDoesNotThrow(() -> - assertTrue(cache().containsKey(TEST_KEY)), - "containsKey failed to find key or value that was just added"); - - // check (another way) that the value was just added - assertDoesNotThrow(() -> - assertEquals(TEST_VAL, cache().getValueFromCache(TEST_KEY), "Found unexpected value in cache"), - "Get from cache threw an exception"); - } - - @Test - @Order(3) - void deleteValueFromCache() { - assertDoesNotThrow(() -> - assertNull(cache().deleteFromCache("non_existent_key"), - "Deleting non-existent key should not have a value"), - "Delete from cache threw an exception"); - - assertDoesNotThrow(() -> - assertEquals(TEST_VAL, cache().deleteFromCache(TEST_KEY), "Value from deleted key did not match"), - "Delete from cache threw an exception"); - } - - @Test - @Order(4) - void verifyCacheSize() { - assertDoesNotThrow(() -> - assertNotNull(cache().getCacheItems(), "Get cache items should never be null"), - "getCacheItems threw an exception"); - - assertDoesNotThrow(() -> - assertEquals(0, cache().getCacheItems().size(), "Get cache items should never be null"), - "getCacheItems threw an exception"); - } -} diff --git a/imagetool/src/test/java/com/oracle/weblogic/imagetool/cachestore/OPatchFileTest.java b/imagetool/src/test/java/com/oracle/weblogic/imagetool/cachestore/OPatchFileTest.java index 42ff3672..f61ce9d5 100644 --- a/imagetool/src/test/java/com/oracle/weblogic/imagetool/cachestore/OPatchFileTest.java +++ b/imagetool/src/test/java/com/oracle/weblogic/imagetool/cachestore/OPatchFileTest.java @@ -6,6 +6,7 @@ import java.io.IOException; import java.nio.file.Files; import java.nio.file.Path; +import java.nio.file.Paths; import java.util.ArrayList; import java.util.Arrays; import java.util.List; @@ -18,6 +19,7 @@ import com.oracle.weblogic.imagetool.patch.PatchMetaData; import com.oracle.weblogic.imagetool.settings.ConfigManager; import com.oracle.weblogic.imagetool.test.annotations.ReduceTestLogging; +import com.oracle.weblogic.imagetool.util.TestSetup; import com.oracle.weblogic.imagetool.util.Utils; import org.junit.jupiter.api.AfterAll; import org.junit.jupiter.api.BeforeAll; @@ -43,29 +45,9 @@ static void setup(@TempDir Path tempDir, @TempDir Path cacheDir) // Mock REST calls to ARU for patches MockAruUtil.insertMockAruInstance(new MockAruUtil()); - // Create a fake cache with a fake OPatch install - //cacheStore = new CacheStoreTestImpl(cacheDir); - //Path installer = tempDir.resolve("opatch_install.zip"); - //Files.write(installer, Arrays.asList("A", "B", "C")); - //cacheStore.addToCache("28186730_13.9.4.2.10", installer.toString()); - - - Path settingsFileName = tempDir.resolve("settings.yaml"); - Path installerFile = tempDir.resolve("installers.yaml"); - Path patchFile = tempDir.resolve("patches.yaml"); - Files.createFile(settingsFileName); - Files.createFile(installerFile); - Files.createFile(patchFile); - - - List lines = Arrays.asList( - "installerSettingsFile: " + installerFile.toAbsolutePath().toString(), - "patchSettingsFile: " + patchFile.toAbsolutePath().toString(), - "installerDirectory: " + tempDir.toAbsolutePath().toString(), - "patchDirectory: " + tempDir.toAbsolutePath().toString() - ); - Files.write(settingsFileName, lines); - ConfigManager configManager = ConfigManager.getInstance(settingsFileName); + TestSetup.setup(tempDir); + ConfigManager configManager = ConfigManager.getInstance(); + Path patchFile = Paths.get(configManager.getPatchDetailsFile()); addPatchesToLocal(tempDir, configManager, patchFile, "28186730", "Generic", "patch1.zip","13.9.4.2.10"); diff --git a/imagetool/src/test/java/com/oracle/weblogic/imagetool/cachestore/PatchFileTest.java b/imagetool/src/test/java/com/oracle/weblogic/imagetool/cachestore/PatchFileTest.java index e8e12111..9ac2e6dc 100644 --- a/imagetool/src/test/java/com/oracle/weblogic/imagetool/cachestore/PatchFileTest.java +++ b/imagetool/src/test/java/com/oracle/weblogic/imagetool/cachestore/PatchFileTest.java @@ -32,6 +32,7 @@ import com.oracle.weblogic.imagetool.settings.ConfigManager; import com.oracle.weblogic.imagetool.settings.UserSettingsFile; import com.oracle.weblogic.imagetool.util.Architecture; +import com.oracle.weblogic.imagetool.util.TestSetup; import com.oracle.weblogic.imagetool.util.Utils; import org.junit.jupiter.api.AfterAll; import org.junit.jupiter.api.BeforeAll; @@ -57,32 +58,13 @@ class PatchFileTest { static Level originalLogLevel; static UserSettingsFile userSettingsFile; - private static void addToCache(Path tempDir, String key, String filename) throws IOException { - Path path = tempDir.resolve(filename); - Files.write(path, fileContents); - cacheStore.addToCache(key, path.toString()); - } @BeforeAll static void setup(@TempDir Path tempDir) throws IOException, NoSuchFieldException, IllegalAccessException { - Path settingsFileName = tempDir.resolve("settings.yaml"); - Path installerFile = tempDir.resolve("installers.yaml"); - Path patchFile = tempDir.resolve("patches.yaml"); - Files.createFile(settingsFileName); - Files.createFile(installerFile); - Files.createFile(patchFile); - - - List lines = Arrays.asList( - "installerSettingsFile: " + installerFile.toAbsolutePath().toString(), - "patchSettingsFile: " + patchFile.toAbsolutePath().toString(), - "installerDirectory: " + tempDir.toAbsolutePath().toString(), - "patchDirectory: " + tempDir.toAbsolutePath().toString() - ); - Files.write(settingsFileName, lines); - ConfigManager configManager = ConfigManager.getInstance(settingsFileName); - + TestSetup.setup(tempDir); + ConfigManager configManager = ConfigManager.getInstance(); + Path patchFile = Paths.get(configManager.getPatchDetailsFile()); addPatchesToLocal(tempDir, configManager, patchFile, BUGNUMBER, "Generic", "patch1.zip",SOME_VERSION); @@ -134,16 +116,6 @@ private static void addPatchesToLocal(Path tempDir, ConfigManager configManager, configManager.saveAllPatches(patches, patchListingFile.toAbsolutePath().toString()); } - public static class FileStoreTestImpl extends FileCacheStore { - public FileStoreTestImpl() throws CacheStoreException { - super(); - } - - @Override - String getCacheDirSetting() { - return PatchFileTest.cacheDir.toString(); - } - } /** * Intercept calls to the ARU REST API during unit testing. @@ -192,11 +164,6 @@ static void teardown() throws NoSuchFieldException, IllegalAccessException { aruRest.setAccessible(true); aruRest.set(aruRest, null); - // remove test class from CacheStoreFactory instance - Field cacheStore = CacheStoreFactory.class.getDeclaredField("store"); - cacheStore.setAccessible(true); - cacheStore.set(cacheStore, null); - // restore original logging level after this test suite completes LoggingFacade logger = LoggingFactory.getLogger(PatchFile.class); logger.setLevel(originalLogLevel); diff --git a/tests/src/test/java/com/oracle/weblogic/imagetool/tests/ITImagetool.java b/tests/src/test/java/com/oracle/weblogic/imagetool/tests/ITImagetool.java index f0909d5c..7b9b4926 100644 --- a/tests/src/test/java/com/oracle/weblogic/imagetool/tests/ITImagetool.java +++ b/tests/src/test/java/com/oracle/weblogic/imagetool/tests/ITImagetool.java @@ -40,7 +40,7 @@ import org.junit.jupiter.api.TestInfo; import org.junit.jupiter.api.TestMethodOrder; -import static com.oracle.weblogic.imagetool.cachestore.FileCacheStore.CACHE_DIR_ENV; +import static com.oracle.weblogic.imagetool.cachestore.CacheStore.CACHE_DIR_ENV; import static org.junit.jupiter.api.Assertions.assertEquals; import static org.junit.jupiter.api.Assertions.assertTrue; import static org.junit.jupiter.api.Assumptions.assumeTrue; From 9e46e6cac0d4cc1af718212389123ff91f227749 Mon Sep 17 00:00:00 2001 From: jshum Date: Wed, 18 Dec 2024 14:33:26 -0600 Subject: [PATCH 049/104] update cache conversion and make it subcommand of cache --- .../imagetool/cachestore/CacheStore.java | 41 ++++++- .../imagetool/cli/cache/CacheCLI.java | 4 +- .../installer/InstallerMetaData.java | 21 ++++ .../imagetool/patch/PatchMetaData.java | 41 +++++++ .../imagetool/settings/ConfigManager.java | 5 + .../imagetool/util/CacheConversion.java | 110 ++++++++++++++++-- .../src/main/resources/ImageTool.properties | 8 +- 7 files changed, 215 insertions(+), 15 deletions(-) diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cachestore/CacheStore.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cachestore/CacheStore.java index b320bf62..eaf079ef 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cachestore/CacheStore.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cachestore/CacheStore.java @@ -135,13 +135,19 @@ public void addInstaller(InstallerType installerType, String commonName, Install installerDetails.put(installerType, new HashMap<>()); installerMetaDataMap = installerDetails.get(installerType); } + if (installerMetaDataMap.containsKey(commonName)) { installerMetaDataList = installerMetaDataMap.get(commonName); } else { installerMetaDataMap.put(commonName, new ArrayList<>()); installerMetaDataList = installerMetaDataMap.get(commonName); } - installerMetaDataList.add(metaData); + // Before adding see if one same already existed. + if (installerMetaDataList.contains(metaData)) { + logger.info("IMG_0135", metaData.toString()); + } else { + installerMetaDataList.add(metaData); + } // Update the list installerDetails.put(installerType, installerMetaDataMap); saveAllInstallers(installerDetails, ConfigManager.getInstance().getInstallerDetailsFile()); @@ -200,7 +206,38 @@ public void addPatch(String bugNumber, String patchArchitecture, String patchLoc latestPatches = new ArrayList<>(); } PatchMetaData newPatch = new PatchMetaData(patchArchitecture, patchLocation, patchVersion, description); - latestPatches.add(newPatch); + if (latestPatches.contains(newPatch)) { + logger.info("IMG_0136", newPatch); + } else { + latestPatches.add(newPatch); + } + patches.put(bugNumber, latestPatches); + configManager.saveAllPatches(patches, configManager.getPatchDetailsFile()); + } + + /** + * Add a patch to the local system. + * @param bugNumber bug number + * @param patchArchitecture architecture of the patch + * @param patchLocation file location of the patch + * @param patchVersion version of the patch + * @throws IOException error + */ + public void addPatch(String bugNumber, String patchArchitecture, String patchLocation, + String patchVersion, String description, String dateAdded) throws IOException { + ConfigManager configManager = ConfigManager.getInstance(); + Map> patches = configManager.getAllPatches(); + List latestPatches = patches.get(bugNumber); + if (latestPatches == null) { + latestPatches = new ArrayList<>(); + } + PatchMetaData newPatch = new PatchMetaData(patchArchitecture, patchLocation, patchVersion, description, + dateAdded); + if (latestPatches.contains(newPatch)) { + logger.info("IMG_0136", newPatch.toString()); + } else { + latestPatches.add(newPatch); + } patches.put(bugNumber, latestPatches); configManager.saveAllPatches(patches, configManager.getPatchDetailsFile()); } diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/CacheCLI.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/CacheCLI.java index 20bd5540..5c64a5fc 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/CacheCLI.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/CacheCLI.java @@ -4,6 +4,7 @@ package com.oracle.weblogic.imagetool.cli.cache; import com.oracle.weblogic.imagetool.cli.HelpVersionProvider; +import com.oracle.weblogic.imagetool.util.CacheConversion; import picocli.CommandLine.Command; @Command( @@ -17,7 +18,8 @@ AddInstallerEntry.class, AddPatchEntry.class, DeleteInstaller.class, - DeletePatch.class + DeletePatch.class, + CacheConversion.class }, sortOptions = false ) diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/installer/InstallerMetaData.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/installer/InstallerMetaData.java index f22f65a8..4ed9115f 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/installer/InstallerMetaData.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/installer/InstallerMetaData.java @@ -5,6 +5,7 @@ import java.nio.file.Files; import java.nio.file.Paths; +import java.util.Objects; import com.oracle.weblogic.imagetool.util.Architecture; import com.oracle.weblogic.imagetool.util.Utils; @@ -88,4 +89,24 @@ public String toString() { return "InstallerMetaData [platform=" + platform + ", location=" + location + ", hash=" + digest + ", " + "dateAdded=" + dateAdded + ", version=" + productVersion + "]"; } + + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + InstallerMetaData metaData = (InstallerMetaData) o; + return Objects.equals(platform, metaData.platform) + && Objects.equals(location, metaData.location) && Objects.equals(digest, metaData.digest) + && Objects.equals(dateAdded, metaData.dateAdded) + && Objects.equals(productVersion, metaData.productVersion); + } + + @Override + public int hashCode() { + return Objects.hash(platform, location, digest, dateAdded, productVersion); + } } diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/patch/PatchMetaData.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/patch/PatchMetaData.java index ac4a9c53..3a54de0b 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/patch/PatchMetaData.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/patch/PatchMetaData.java @@ -3,6 +3,8 @@ package com.oracle.weblogic.imagetool.patch; +import java.util.Objects; + import com.oracle.weblogic.imagetool.util.Utils; public class PatchMetaData { @@ -36,6 +38,7 @@ public PatchMetaData(String platform, String location, String hash, String dateA * @param platform platform * @param location file path of the patch * @param patchVersion version + * @param description description of the patch */ public PatchMetaData(String platform, String location, String patchVersion, String description) { this.platform = platform; @@ -46,6 +49,23 @@ public PatchMetaData(String platform, String location, String patchVersion, Stri this.description = description; } + /** + * Constructor. + * @param platform platform + * @param location file path of the patch + * @param patchVersion version + * @param description description of the patch + * @param dateAdded date added + */ + public PatchMetaData(String platform, String location, String patchVersion, String description, String dateAdded) { + this.platform = platform; + this.location = location; + this.hash = Utils.getSha256Hash(location); + this.dateAdded = dateAdded; + this.patchVersion = patchVersion; + this.description = description; + } + public String getPlatform() { return platform; } @@ -81,4 +101,25 @@ public String toString() { + ", description='" + description + '\'' + '}'; } + + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + PatchMetaData metaData = (PatchMetaData) o; + return Objects.equals(platform, metaData.platform) + && Objects.equals(location, metaData.location) && Objects.equals(hash, metaData.hash) + && Objects.equals(dateAdded, metaData.dateAdded) + && Objects.equals(patchVersion, metaData.patchVersion) + && Objects.equals(description, metaData.description); + } + + @Override + public int hashCode() { + return Objects.hash(platform, location, hash, dateAdded, patchVersion, description); + } } diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/ConfigManager.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/ConfigManager.java index cf74d901..8f011ccb 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/ConfigManager.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/ConfigManager.java @@ -100,6 +100,11 @@ public void addPatch(String bugNumber, String patchArchitecture, String patchLoc cacheStore.addPatch(bugNumber, patchArchitecture, patchLocation, patchVersion, description); } + public void addPatch(String bugNumber, String patchArchitecture, String patchLocation, + String patchVersion, String description, String dateAdded) throws IOException { + cacheStore.addPatch(bugNumber, patchArchitecture, patchLocation, patchVersion, description, dateAdded); + } + public PatchMetaData getPatchForPlatform(String platformName, String bugNumber, String version) { return cacheStore.getPatchForPlatform(platformName, bugNumber, version); } diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/util/CacheConversion.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/util/CacheConversion.java index 03291ffe..ca38efb2 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/util/CacheConversion.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/util/CacheConversion.java @@ -4,6 +4,7 @@ package com.oracle.weblogic.imagetool.util; import java.io.BufferedReader; +import java.io.File; import java.io.FileReader; import java.io.IOException; import java.nio.file.Files; @@ -13,21 +14,33 @@ import java.time.LocalDate; import java.time.ZoneId; import java.time.format.DateTimeFormatter; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; import java.util.regex.Matcher; import java.util.regex.Pattern; +import com.oracle.weblogic.imagetool.api.model.CommandResponse; import com.oracle.weblogic.imagetool.cachestore.CacheStore; import com.oracle.weblogic.imagetool.cachestore.OPatchFile; +import com.oracle.weblogic.imagetool.cli.cache.CacheOperation; import com.oracle.weblogic.imagetool.installer.InstallerMetaData; import com.oracle.weblogic.imagetool.installer.InstallerType; import com.oracle.weblogic.imagetool.logging.LoggingFacade; import com.oracle.weblogic.imagetool.logging.LoggingFactory; import com.oracle.weblogic.imagetool.settings.ConfigManager; +import org.yaml.snakeyaml.Yaml; +import picocli.CommandLine; /** * Utility to convert image tool 1.x cache store to 2.0 format */ -public class CacheConversion { +@CommandLine.Command( + name = "convert", + description = "Convert cache settings from v1 to v2", + sortOptions = false +) +public class CacheConversion extends CacheOperation { private static final LoggingFacade logger = LoggingFactory.getLogger(OPatchFile.class); @@ -59,9 +72,12 @@ public void convert(String inputFile) throws IOException { String arch = matcher.group(3); String filepath = matcher.group(4); String fileDate = getFileDate(filepath); + if (arch == null) { + arch = Utils.standardPlatform(Architecture.getLocalArchitecture().toString()); + } if (fileDate != null) { ConfigManager.getInstance().addPatch(key, arch, filepath, version, - "Converted from v1 in " + fileDate); + "Converted from v1 in " + fileDate, fileDate); } } else { logger.warning("IMG-0128", line); @@ -75,10 +91,13 @@ public void convert(String inputFile) throws IOException { String arch = matcher.group(3); String filepath = matcher.group(4); String fileDate = getFileDate(filepath); + if (arch == null) { + arch = Utils.standardPlatform(Architecture.getLocalArchitecture().toString()); + } if (fileDate != null) { InstallerMetaData metaData = new InstallerMetaData(arch, filepath, Utils.getSha256Hash(filepath), fileDate, version); - ConfigManager.getInstance().addInstaller(InstallerType.valueOf(key), version, metaData); + ConfigManager.getInstance().addInstaller(InstallerType.fromString(key), version, metaData); } } else { logger.warning("IMG-0128", line); @@ -108,25 +127,94 @@ private String getFileDate(String filepath) { } } - /** - * Main for converting v1 .metadata file - * @param args arguments - * @throws IOException when error converting .metadata file - */ - public static void main(String[] args) throws IOException { - // TODO: Need some setup for settings first??? + private boolean initializeSettingFiles(String directory) { + boolean success = true; + logger.entering("Entering initializeSettingFiles " + directory); + try { + + if (directory != null) { + Path directoryPath = Paths.get(directory); + if (!Files.exists(directoryPath)) { + createIfNotExists(directoryPath, true); + } + + Path settingsPath = directoryPath.resolve("settings.yaml"); + if (!Files.exists(settingsPath)) { + logger.fine("No existing settings file creating it"); + createIfNotExists(settingsPath, false); + Path parentPath = settingsPath.getParent(); + List lines = new ArrayList<>(); + lines.add("installerDirectory: " + parentPath.resolve("installers").toString()); + lines.add("patchDirectory: " + parentPath.resolve("patches").toString()); + lines.add("installerSettingsFile: " + parentPath.resolve("installers.yaml").toString()); + lines.add("patchSettingsFile: " + parentPath.resolve("patches.yaml").toString()); + createIfNotExists(parentPath.resolve("installers"), true); + createIfNotExists(parentPath.resolve("patches"), true); + createIfNotExists(parentPath.resolve("installers.yaml"), false); + createIfNotExists(parentPath.resolve("patches.yaml"), false); + + Files.write(settingsPath, lines); + } else { + logger.fine("Existing settings file already exists"); + Yaml yaml = new Yaml(); + File yamlFile = new File(settingsPath.toAbsolutePath().toString()); + Map settings = yaml.loadAs(Files.newInputStream(yamlFile.toPath()), Map.class); + if (settings != null) { + if (!settings.containsKey("installerSettingsFile")) { + logger.warning("IMG_0137", "installerSettingsFile"); + return false; + } + if (!settings.containsKey("patchSettingsFile")) { + logger.warning("IMG_0137", "patchSettingsFile"); + return false; + } + } + } + } + } catch (Exception ex) { + logger.warning("IMG_0138", ex.getLocalizedMessage()); + return false; + } + logger.exiting("initializeSettingFiles"); + return success; + } + + private void createIfNotExists(Path entry, boolean isDir) throws IOException { + System.out.println(" create if not exists " + entry.toString() + " " + isDir); + if (Files.exists(entry)) { + return; + } + if (isDir) { + System.out.println(" create if not exists create dir"); + Files.createDirectory(entry); + } else { + System.out.println(" create if not exists create file"); + Files.createFile(entry); + } + } + + @Override + public CommandResponse call() throws Exception { CacheConversion cacheConversion = new CacheConversion(); String cacheEnv = System.getenv(CacheStore.CACHE_DIR_ENV); Path cacheMetaFile; if (cacheEnv != null) { cacheMetaFile = Paths.get(cacheEnv, ".metadata"); + if (!initializeSettingFiles(cacheMetaFile.getParent().toString())) { + return CommandResponse.error("IMG-0139"); + } } else { - cacheMetaFile = Paths.get(System.getProperty("user.home"), ".metadata"); + cacheMetaFile = Paths.get(System.getProperty("user.home"), "cache", ".metadata"); + if (!initializeSettingFiles(Paths.get(System.getProperty("user.home"), ".imagetool").toString())) { + return CommandResponse.error("IMG-0139"); + } } if (Files.exists(cacheMetaFile)) { cacheConversion.convert(cacheMetaFile.toString()); } else { logger.info("IMG-0133", cacheMetaFile.toString()); } + return CommandResponse.success("IMG-0134"); } + } diff --git a/imagetool/src/main/resources/ImageTool.properties b/imagetool/src/main/resources/ImageTool.properties index 4e47df4e..e55aaa5c 100644 --- a/imagetool/src/main/resources/ImageTool.properties +++ b/imagetool/src/main/resources/ImageTool.properties @@ -126,9 +126,15 @@ IMG-0124=You must specify --type --version and --architecture for deleting an in IMG-0125=Specified installer to delete cannot be found. IMG-0126=You must specify --patchId --version and --architecture for deleting a patchr. IMG-0127=Specified installer to delete cannot be found. -IMG-0128=Cannot parse image tool version 1 metadata file line: {0}. +IMG-0128=Cannot parse image tool version 1 metadata file line: {0}, skipping. IMG-0129=Missing --architecture value for adding installer type {0}. IMG-0130=Successfully added patch to cache. [[cyan: bug:]] {0} [[cyan: version:]] {1} [[cyan: filepath:]] {2} IMG-0131=Image tool v1 cache entry specified file {0} no longer exists, skipping conversion. You can add it manually. IMG-0132=Image tool v1 cache entry specified file {0} cannot be accessed {1}, skipping conversion. You can add it manually. IMG-0133=Image tool conversion cannot find .metadata file in {0}. +IMG-0134=Image tool successfully convert v1 cache data to v2. +IMG_0135=Installer [{0}] already exists in cache. +IMG_0136=Patch [{0}] already exists in cache. +IMG_0137=Existing settings.yaml file does not have the entry '{0', please add it using 'config set' command first. +IMG_0138=Image tool conversion failed to initialize files {0}. +IMG_0139=Image tool conversion failed. \ No newline at end of file From 0fe684d9fe3884e0d48ebd48a0b6761533507157 Mon Sep 17 00:00:00 2001 From: jshum Date: Fri, 20 Dec 2024 11:36:47 -0600 Subject: [PATCH 050/104] fix podman issues --- .../imagetool/builder/AbstractCommand.java | 122 ++++++++++++ .../imagetool/builder/BuildCommand.java | 174 +++++++----------- .../imagetool/builder/ManifestCommand.java | 97 ++++++++++ .../imagetool/builder/PushCommand.java | 58 ++++++ .../imagetool/cli/menu/CommonOptions.java | 15 +- .../imagetool/cli/menu/CreateImage.java | 72 +++++++- .../imagetool/util/CacheConversion.java | 2 +- .../src/main/resources/ImageTool.properties | 7 +- 8 files changed, 433 insertions(+), 114 deletions(-) create mode 100644 imagetool/src/main/java/com/oracle/weblogic/imagetool/builder/AbstractCommand.java create mode 100644 imagetool/src/main/java/com/oracle/weblogic/imagetool/builder/ManifestCommand.java create mode 100644 imagetool/src/main/java/com/oracle/weblogic/imagetool/builder/PushCommand.java diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/builder/AbstractCommand.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/builder/AbstractCommand.java new file mode 100644 index 00000000..74f2b75a --- /dev/null +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/builder/AbstractCommand.java @@ -0,0 +1,122 @@ +// Copyright (c) 2024, 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.builder; + +import java.io.BufferedReader; +import java.io.IOException; +import java.io.InputStream; +import java.io.InputStreamReader; +import java.io.OutputStream; +import java.io.OutputStreamWriter; +import java.io.PrintWriter; +import java.nio.file.Files; +import java.nio.file.Path; +import java.nio.file.Paths; +import java.util.ArrayList; +import java.util.List; + +import com.oracle.weblogic.imagetool.logging.LoggingFacade; +import com.oracle.weblogic.imagetool.logging.LoggingFactory; +import com.oracle.weblogic.imagetool.util.CloseableList; +import com.oracle.weblogic.imagetool.util.Utils; + +public abstract class AbstractCommand { + private static final LoggingFacade logger = LoggingFactory.getLogger(AbstractCommand.class); + + public abstract List getCommand(boolean showPasswords); + + /** + * Executes the given docker command and writes the process stdout to log. + * + * @param dockerLog log file to write to + * @throws IOException if an error occurs reading from the process inputstream. + * @throws InterruptedException when the process wait is interrupted. + */ + public void run(Path dockerLog) + throws IOException, InterruptedException { + // process builder + logger.entering(getCommand(false), dockerLog); + Path dockerLogPath = createFile(dockerLog); + logger.finer("Docker log: {0}", dockerLogPath); + List outputStreams = new ArrayList<>(); + + outputStreams.add(System.out); + + if (dockerLogPath != null) { + logger.info("dockerLog: " + dockerLog); + outputStreams.add(Files.newOutputStream(dockerLogPath)); + } + + ProcessBuilder processBuilder = new ProcessBuilder(getCommand(true)); + processBuilder.redirectErrorStream(true); + logger.finer("Starting docker process..."); + final Process process = processBuilder.start(); + logger.finer("Docker process started"); + writeFromInputToOutputStreams(process.getInputStream(), outputStreams); + logger.finer("Waiting for Docker to finish"); + if (process.waitFor() != 0) { + Utils.processError(process); + } + } + + /** + * Create a file with the given path. + * + * @param filePath the path of the file to create + * @return file path or null in case of error + */ + private Path createFile(Path filePath) { + Path logFilePath = filePath; + if (logFilePath != null) { + try { + if (!Files.exists(logFilePath)) { + Files.createDirectories(logFilePath.getParent()); + Files.createFile(logFilePath); + } else { + if (Files.isDirectory(logFilePath)) { + logFilePath = Paths.get(logFilePath.toAbsolutePath().toString(), "dockerbuild.log"); + if (Files.exists(logFilePath)) { + Files.delete(logFilePath); + } + Files.createFile(logFilePath); + } + } + } catch (IOException e) { + logger.fine("Failed to create log file for the build command", e); + logFilePath = null; + } + } + return logFilePath; + } + + private void writeFromInputToOutputStreams(InputStream inputStream, List outputStreams) { + Thread readerThread = new Thread(() -> { + try ( + BufferedReader processReader = new BufferedReader(new InputStreamReader(inputStream)); + CloseableList printWriters = createPrintWriters(outputStreams) + ) { + if (!printWriters.isEmpty()) { + String line; + while ((line = processReader.readLine()) != null) { + String finalLine = line; + printWriters.forEach(x -> x.println(finalLine)); + } + } + } catch (IOException e) { + logger.severe(e.getMessage()); + } + }); + readerThread.setDaemon(true); + readerThread.start(); + } + + private CloseableList createPrintWriters(List outputStreams) { + CloseableList retVal = new CloseableList<>(); + for (OutputStream outputStream : outputStreams) { + retVal.add(new PrintWriter(new OutputStreamWriter(outputStream), true)); + } + return retVal; + } + +} diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/builder/BuildCommand.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/builder/BuildCommand.java index b1c98683..c1f77be4 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/builder/BuildCommand.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/builder/BuildCommand.java @@ -3,16 +3,6 @@ package com.oracle.weblogic.imagetool.builder; -import java.io.BufferedReader; -import java.io.IOException; -import java.io.InputStream; -import java.io.InputStreamReader; -import java.io.OutputStream; -import java.io.OutputStreamWriter; -import java.io.PrintWriter; -import java.nio.file.Files; -import java.nio.file.Path; -import java.nio.file.Paths; import java.util.ArrayList; import java.util.List; import java.util.Map; @@ -20,10 +10,9 @@ import com.oracle.weblogic.imagetool.logging.LoggingFacade; import com.oracle.weblogic.imagetool.logging.LoggingFactory; -import com.oracle.weblogic.imagetool.util.CloseableList; import com.oracle.weblogic.imagetool.util.Utils; -public class BuildCommand { +public class BuildCommand extends AbstractCommand { private static final LoggingFacade logger = LoggingFactory.getLogger(BuildCommand.class); private final String executable; @@ -32,6 +21,7 @@ public class BuildCommand { private List additionalOptions; private final String context; private boolean useBuildx = false; + private List buildPlatforms = new ArrayList<>(); /** * Create a build command for creating an image. At some point, it might @@ -67,6 +57,7 @@ public BuildCommand tag(String value) { * @return this */ public BuildCommand platform(List value) { + buildPlatforms = value; if (value == null || value.isEmpty()) { return this; } @@ -186,100 +177,9 @@ public BuildCommand load(boolean value) { return this; } - /** - * Executes the given docker command and writes the process stdout to log. - * - * @param dockerLog log file to write to - * @throws IOException if an error occurs reading from the process inputstream. - * @throws InterruptedException when the process wait is interrupted. - */ - public void run(Path dockerLog) - throws IOException, InterruptedException { - // process builder - logger.entering(getCommand(false), dockerLog); - Path dockerLogPath = createFile(dockerLog); - logger.finer("Docker log: {0}", dockerLogPath); - List outputStreams = new ArrayList<>(); - - outputStreams.add(System.out); - - if (dockerLogPath != null) { - logger.info("dockerLog: " + dockerLog); - outputStreams.add(Files.newOutputStream(dockerLogPath)); - } - - ProcessBuilder processBuilder = new ProcessBuilder(getCommand(true)); - processBuilder.redirectErrorStream(true); - logger.finer("Starting docker process..."); - final Process process = processBuilder.start(); - logger.finer("Docker process started"); - writeFromInputToOutputStreams(process.getInputStream(), outputStreams); - logger.finer("Waiting for Docker to finish"); - if (process.waitFor() != 0) { - Utils.processError(process); - } - } - - /** - * Create a file with the given path. - * - * @param filePath the path of the file to create - * @return file path or null in case of error - */ - private Path createFile(Path filePath) { - Path logFilePath = filePath; - if (logFilePath != null) { - try { - if (!Files.exists(logFilePath)) { - Files.createDirectories(logFilePath.getParent()); - Files.createFile(logFilePath); - } else { - if (Files.isDirectory(logFilePath)) { - logFilePath = Paths.get(logFilePath.toAbsolutePath().toString(), "dockerbuild.log"); - if (Files.exists(logFilePath)) { - Files.delete(logFilePath); - } - Files.createFile(logFilePath); - } - } - } catch (IOException e) { - logger.fine("Failed to create log file for the build command", e); - logFilePath = null; - } - } - return logFilePath; - } - - private void writeFromInputToOutputStreams(InputStream inputStream, List outputStreams) { - Thread readerThread = new Thread(() -> { - try ( - BufferedReader processReader = new BufferedReader(new InputStreamReader(inputStream)); - CloseableList printWriters = createPrintWriters(outputStreams) - ) { - if (!printWriters.isEmpty()) { - String line; - while ((line = processReader.readLine()) != null) { - String finalLine = line; - printWriters.forEach(x -> x.println(finalLine)); - } - } - } catch (IOException e) { - logger.severe(e.getMessage()); - } - }); - readerThread.setDaemon(true); - readerThread.start(); - } - - private CloseableList createPrintWriters(List outputStreams) { - CloseableList retVal = new CloseableList<>(); - for (OutputStream outputStream : outputStreams) { - retVal.add(new PrintWriter(new OutputStreamWriter(outputStream), true)); - } - return retVal; - } - private List getCommand(boolean showPasswords) { + @Override + public List getCommand(boolean showPasswords) { List result = new ArrayList<>(); result.add(executable); if (useBuildx) { @@ -299,6 +199,70 @@ private List getCommand(boolean showPasswords) { return result; } + /** + * Return the build engine used. + * @return build engine passed or used + */ + public String getExecutable() { + return executable; + } + + /** + * Return the build platforms passed in. + * @return build platforms + */ + + public List getBuildPlatforms() { + return buildPlatforms; + } + + /** + * Substitute the platform value. + * @param platform platform value used for substitution + */ + public void substitutePlatform(String platform) { + for (int i = 0; i < command.size() - 1; i++) { + if (command.get(i).equals("--platform")) { + command.set(i + 1, platform); + } + } + } + + /** + * Substitute the tagname value. + * @param tagName platform value used for substitution + */ + public String substituteTagName(String tagName) { + for (int i = 0; i < command.size() - 1; i++) { + if (command.get(i).equals("--tag")) { + command.set(i + 1, tagName); + return command.get(i + 1); + } + } + return null; + } + + /** + * Return the tag name value. + * @return tag name + */ + public String getTagName() { + for (int i = 0; i < command.size() - 1; i++) { + if (command.get(i).equals("--tag")) { + return command.get(i + 1); + } + } + return null; + } + + /** + * Return context folder. + * @return context folder + */ + public String getContext() { + return context; + } + @Override public String toString() { return String.join(" ", getCommand(false)); diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/builder/ManifestCommand.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/builder/ManifestCommand.java new file mode 100644 index 00000000..f2c68d2e --- /dev/null +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/builder/ManifestCommand.java @@ -0,0 +1,97 @@ +// Copyright (c) 2024, 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.builder; + +import java.util.ArrayList; +import java.util.List; +import java.util.Objects; + +import com.oracle.weblogic.imagetool.logging.LoggingFacade; +import com.oracle.weblogic.imagetool.logging.LoggingFactory; +import com.oracle.weblogic.imagetool.util.Utils; + +public class ManifestCommand extends AbstractCommand { + private static final LoggingFacade logger = LoggingFactory.getLogger(ManifestCommand.class); + + private final String executable; + private final List command; + + /** + * Create a manifest command for manipulating manifest. + */ + public ManifestCommand(String buildEngine, String contextFolder) { + Objects.requireNonNull(contextFolder); + executable = buildEngine; + command = new ArrayList<>(); + } + + /** + * Add manifest name for this command. + * @param value name to be used as the manifest name. + * @return this + */ + public ManifestCommand name(String value) { + if (Utils.isEmptyString(value)) { + return this; + } + command.add(value); + return this; + } + + /** + * Add manifest create command. + * @return this + */ + public ManifestCommand create() { + command.add("create"); + return this; + } + + /** + * Add manifest add command. + * @return this + */ + public ManifestCommand add() { + command.add("add"); + return this; + } + + /** + * Add Docker image tag name for this build command. + * @param value name to be used as the image tag. + * @return this + */ + public ManifestCommand tag(String value) { + if (Utils.isEmptyString(value)) { + return this; + } + command.add(value); + return this; + } + + + /** + * Add a push to the manifest command. + */ + public ManifestCommand push() { + command.add("push"); + return this; + } + + + @Override + public List getCommand(boolean showPasswords) { + List result = new ArrayList<>(); + result.add(executable); + result.add("manifest"); + result.addAll(command); + return result; + } + + @Override + public String toString() { + return String.join(" ", getCommand(false)); + } + +} diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/builder/PushCommand.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/builder/PushCommand.java new file mode 100644 index 00000000..b9651b43 --- /dev/null +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/builder/PushCommand.java @@ -0,0 +1,58 @@ +// Copyright (c) 2024, 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.builder; + +import java.util.ArrayList; +import java.util.List; +import java.util.Objects; + +import com.oracle.weblogic.imagetool.logging.LoggingFacade; +import com.oracle.weblogic.imagetool.logging.LoggingFactory; +import com.oracle.weblogic.imagetool.util.Utils; + +public class PushCommand extends AbstractCommand { + private static final LoggingFacade logger = LoggingFactory.getLogger(PushCommand.class); + + private final String executable; + private final List command; + + /** + * Create a manifest command for manipulating manifest. + */ + public PushCommand(String buildEngine, String contextFolder) { + Objects.requireNonNull(contextFolder); + executable = buildEngine; + command = new ArrayList<>(); + } + + + /** + * Add Docker image tag name for this build command. + * @param value name to be used as the image tag. + * @return this + */ + public PushCommand tag(String value) { + if (Utils.isEmptyString(value)) { + return this; + } + command.add(value); + return this; + } + + + @Override + public List getCommand(boolean showPasswords) { + List result = new ArrayList<>(); + result.add(executable); + result.add("push"); + result.addAll(command); + return result; + } + + @Override + public String toString() { + return String.join(" ", getCommand(false)); + } + +} diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonOptions.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonOptions.java index 1ee69a75..7470adcc 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonOptions.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonOptions.java @@ -20,6 +20,7 @@ import com.oracle.weblogic.imagetool.api.model.CommandResponse; import com.oracle.weblogic.imagetool.aru.InvalidCredentialException; +import com.oracle.weblogic.imagetool.builder.AbstractCommand; import com.oracle.weblogic.imagetool.builder.BuildCommand; import com.oracle.weblogic.imagetool.cli.HelpVersionProvider; import com.oracle.weblogic.imagetool.inspect.OperatingSystemProperties; @@ -105,7 +106,7 @@ private void handleAdditionalBuildCommands() throws IOException { } } - void runDockerCommand(String dockerfile, BuildCommand command) throws IOException, InterruptedException { + void runDockerCommand(String dockerfile, AbstractCommand command) throws IOException, InterruptedException { logger.info("IMG-0078", command.toString()); if (dryRun) { @@ -140,10 +141,12 @@ BuildCommand getInitialBuildCmd(String contextFolder) { // if it is multiplatform build if (buildId != null && buildPlatform.size() > 1) { // if push is specified, ignore load value - if (push) { - cmdBuilder.push(push); - } else { - cmdBuilder.load(load); + if (!buildEngine.equalsIgnoreCase("podman")) { + if (push) { + cmdBuilder.push(push); + } else { + cmdBuilder.load(load); + } } } logger.exiting(); @@ -496,7 +499,7 @@ public List getBuildPlatform() { names = {"--load"}, description = "load the image to the local repository, only used when building multiplatform images" ) - private boolean load = true; + private boolean load = false; @Parameters( description = "Container build options.", diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CreateImage.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CreateImage.java index 42e39bdd..67e8fce6 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CreateImage.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CreateImage.java @@ -5,9 +5,15 @@ import java.io.File; import java.time.Instant; +import java.util.ArrayList; +import java.util.List; import java.util.concurrent.Callable; import com.oracle.weblogic.imagetool.api.model.CommandResponse; +import com.oracle.weblogic.imagetool.builder.AbstractCommand; +import com.oracle.weblogic.imagetool.builder.BuildCommand; +import com.oracle.weblogic.imagetool.builder.ManifestCommand; +import com.oracle.weblogic.imagetool.builder.PushCommand; import com.oracle.weblogic.imagetool.logging.LoggingFacade; import com.oracle.weblogic.imagetool.logging.LoggingFactory; import com.oracle.weblogic.imagetool.util.Utils; @@ -40,8 +46,52 @@ public CommandResponse call() throws Exception { // Create Dockerfile String dockerfile = Utils.writeDockerfile(buildDir() + File.separator + "Dockerfile", "Create_Image.mustache", dockerfileOptions, dryRun); + BuildCommand buildCommand = getInitialBuildCmd(buildDir()); + if ("podman".equalsIgnoreCase(buildCommand.getExecutable())) { + List abstractCommands = new ArrayList<>(); + List buildPlatforms = buildCommand.getBuildPlatforms(); + if (buildPlatforms.size() > 1) { + // build each platform first, then build manifest and the push the manifest if needed... + ManifestCommand createManifestCommand = new ManifestCommand(buildCommand.getExecutable(), + buildCommand.getContext()); + String manifestName = buildCommand.getTagName(); + createManifestCommand.create().name(manifestName); + abstractCommands.add(createManifestCommand); + logger.info("IMG_0140", manifestName); - runDockerCommand(dockerfile, getInitialBuildCmd(buildDir())); + for (String buildPlatform : buildPlatforms) { + buildCommand.substitutePlatform(buildPlatform); + String platformTag = buildCommand.substituteTagName(imageTag + "-" + + buildPlatform.replace('/', '-')); + runDockerCommand(dockerfile, buildCommand); + PushCommand pushCommand = new PushCommand(buildCommand.getExecutable(), + buildCommand.getContext()).tag(platformTag); + abstractCommands.add(pushCommand); + logger.info("IMG_0143", platformTag); + + ManifestCommand addManifestCommand = new ManifestCommand(buildCommand.getExecutable(), + buildCommand.getContext()); + addManifestCommand.add().name(manifestName).tag(platformTag); + abstractCommands.add(addManifestCommand); + logger.info("IMG_0141", manifestName, platformTag); + } + + ManifestCommand pushManifestCommand = new ManifestCommand(buildCommand.getExecutable(), + buildCommand.getContext()); + pushManifestCommand.push().name(manifestName).tag(manifestName); + abstractCommands.add(pushManifestCommand); + logger.info("IMG_0142", manifestName); + for (AbstractCommand abstractCommand : abstractCommands) { + logger.info("IMG_0144", abstractCommand.toString()); + runDockerCommand(dockerfile, abstractCommand); + } + + } else { + runDockerCommand(dockerfile, buildCommand); + } + } else { + runDockerCommand(dockerfile, buildCommand); + } if (!dryRun) { wdtOptions.handleResourceTemplates(imageTag()); } @@ -55,6 +105,26 @@ public CommandResponse call() throws Exception { return successfulBuildResponse(startTime); } + private ManifestCommand createManifestCommand(String buildEngine, String context, String manifestName) { + return new ManifestCommand(buildEngine, context) + .create() + .name(manifestName); + } + + private ManifestCommand addManifestCommand(String buildEngine, String context, String manifestName, String tag) { + return new ManifestCommand(buildEngine, context) + .add() + .name(manifestName) + .tag(tag); + } + + private ManifestCommand pushManifestCommand(String buildEngine, String context, String manifestName, String tag) { + return new ManifestCommand(buildEngine, context) + .push() + .name(manifestName) + .tag(tag); + } + @ArgGroup(exclusive = false, heading = "WDT Options%n") private final WdtFullOptions wdtOptions = new WdtFullOptions(); } \ No newline at end of file diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/util/CacheConversion.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/util/CacheConversion.java index ca38efb2..328bcacb 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/util/CacheConversion.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/util/CacheConversion.java @@ -192,7 +192,7 @@ private void createIfNotExists(Path entry, boolean isDir) throws IOException { Files.createFile(entry); } } - + @Override public CommandResponse call() throws Exception { CacheConversion cacheConversion = new CacheConversion(); diff --git a/imagetool/src/main/resources/ImageTool.properties b/imagetool/src/main/resources/ImageTool.properties index e55aaa5c..8ddc8efd 100644 --- a/imagetool/src/main/resources/ImageTool.properties +++ b/imagetool/src/main/resources/ImageTool.properties @@ -137,4 +137,9 @@ IMG_0135=Installer [{0}] already exists in cache. IMG_0136=Patch [{0}] already exists in cache. IMG_0137=Existing settings.yaml file does not have the entry '{0', please add it using 'config set' command first. IMG_0138=Image tool conversion failed to initialize files {0}. -IMG_0139=Image tool conversion failed. \ No newline at end of file +IMG_0139=Image tool conversion failed. +IMG_0140=Creating multiplatform image manifest {0}. +IMG_0141=Creating command: adding image {0} to manifest {1}. +IMG_0142=Creating command: push image manifest {0} to repo. +IMG_0143=Creating command: push image to repo {0}. +IMG_0144=Setting up manifest and image: {0}. \ No newline at end of file From 2c7e4fc51b9a69f6be360b1d0e8cb51649cad7d5 Mon Sep 17 00:00:00 2001 From: jshum Date: Fri, 20 Dec 2024 12:05:19 -0600 Subject: [PATCH 051/104] Adding notes --- documentation/site/content/userguide/tools/multiplatorm-build.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) create mode 100644 documentation/site/content/userguide/tools/multiplatorm-build.md diff --git a/documentation/site/content/userguide/tools/multiplatorm-build.md b/documentation/site/content/userguide/tools/multiplatorm-build.md new file mode 100644 index 00000000..e69de29b From 8da85d29a5abbb56ab410dd4f9a1eddaaf9fc9d8 Mon Sep 17 00:00:00 2001 From: jshum Date: Fri, 20 Dec 2024 20:20:33 -0600 Subject: [PATCH 052/104] fix delete problems --- .../userguide/tools/multiplatorm-build.md | 45 +++++++++++++++++++ .../imagetool/cli/cache/DeleteInstaller.java | 15 ++++--- .../imagetool/cli/cache/DeletePatch.java | 12 +++-- 3 files changed, 64 insertions(+), 8 deletions(-) diff --git a/documentation/site/content/userguide/tools/multiplatorm-build.md b/documentation/site/content/userguide/tools/multiplatorm-build.md index e69de29b..13642e97 100644 --- a/documentation/site/content/userguide/tools/multiplatorm-build.md +++ b/documentation/site/content/userguide/tools/multiplatorm-build.md @@ -0,0 +1,45 @@ +Set up qemu (unless the machine is already set up for that) + +docker: + docker run --privileged --rm tonistiigi/binfmt --install all + +podman: + sudo podman run --privileged --rm tonistiigi/binfmt --install all + +notes: + + In podman environment, sometimes the image build process stuck during installation of fmw, this can be : + +1. space issue, default is in /var/lib/containers/storage - check utilization by df -h . Change graphroot in /etc/containers/storage.conf for system wide or change the personal settings, see below. +2. try turn off selinux sudo setenforce 0 , it may come out with more information. +3. try ps axwww | grep qemu to see if there are multiple java processes for the installation. +4. after podman system prune - I have to run the qemu setup again +5. qemu is not installed properly, the above method put files in /proc/sys/fs/binfmt_misc/qemu* + + +--- + +echo 'username:100000:65536' | sudo tee -a /etc/subuid +echo 'username:100000:65536' | sudo tee -a /etc/subgid + +echo 'user.max_user_namespaces=28633' | sudo tee -a /etc/sysctl.d/userns.conf +sudo sysctl -p /etc/sysctl.d/userns.conf + +mkdir -p /path/to/storage/$USER + +mkdir -p ~/.config/containers +echo "[storage] +driver = \"overlay\" +rootless_storage_path = \"/path/to/storage/$USER\"" > ~/.config/containers/storage.conf + + +sudo loginctl enable-linger username + +======== + +TODO: + +podman does not take --load or --push +docker must have --load or --push for multiplatform build + + diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/DeleteInstaller.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/DeleteInstaller.java index 5fe7f984..d29ecdbb 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/DeleteInstaller.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/DeleteInstaller.java @@ -13,6 +13,7 @@ import com.oracle.weblogic.imagetool.installer.InstallerMetaData; import com.oracle.weblogic.imagetool.installer.InstallerType; import com.oracle.weblogic.imagetool.settings.ConfigManager; +import com.oracle.weblogic.imagetool.util.Architecture; import picocli.CommandLine.Command; import picocli.CommandLine.Option; @@ -43,13 +44,17 @@ public CommandResponse call() throws CacheStoreException { search = commonName; } exists = Optional.ofNullable(items.get(search)) - .map(list -> list.stream().anyMatch(i -> i.getPlatform().equalsIgnoreCase(architecture) - && i.getProductVersion().equalsIgnoreCase(version))) + .map(list -> list.stream().anyMatch(i -> Architecture.fromString(i.getPlatform()) + .equals(architecture) && i.getProductVersion().equalsIgnoreCase(version))) .orElse(false); if (exists) { Optional.ofNullable(items.get(search)) - .map(list -> list.removeIf(i -> i.getPlatform().equalsIgnoreCase(architecture) - && i.getProductVersion().equalsIgnoreCase(version))); + .map(list -> list.removeIf(i -> Architecture.fromString(i.getPlatform()) + .equals(architecture) && i.getProductVersion().equalsIgnoreCase(version))); + + if (items.get(search).isEmpty()) { + items.remove(search); + } break; } } @@ -86,6 +91,6 @@ public CommandResponse call() throws CacheStoreException { names = {"--architecture"}, description = "Specific architecture to delete" ) - private String architecture; + private Architecture architecture; } diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/DeletePatch.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/DeletePatch.java index 83119e1d..8277690b 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/DeletePatch.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/DeletePatch.java @@ -12,6 +12,7 @@ import com.oracle.weblogic.imagetool.cachestore.CacheStoreException; import com.oracle.weblogic.imagetool.patch.PatchMetaData; import com.oracle.weblogic.imagetool.settings.ConfigManager; +import com.oracle.weblogic.imagetool.util.Architecture; import picocli.CommandLine.Command; import picocli.CommandLine.Option; @@ -37,11 +38,16 @@ public CommandResponse call() throws CacheStoreException { List items = data.get(id); exists = Optional.ofNullable(items) .map(list -> list.stream().anyMatch(i -> i.getPatchVersion().equals(version) - && i.getPlatform().equalsIgnoreCase(architecture))).orElse(false); + && Architecture.fromString(i.getPlatform()).equals(architecture))).orElse(false); if (exists) { Optional.ofNullable(items) .map(list -> list.removeIf(i -> i.getPatchVersion().equals(version) - && i.getPlatform().equalsIgnoreCase(architecture))); + && Architecture.fromString(i.getPlatform()).equals(architecture))); + + if (items.isEmpty()) { + data.remove(id); + } + break; } } @@ -72,6 +78,6 @@ public CommandResponse call() throws CacheStoreException { names = {"--architecture"}, description = "Specific architecture to delete" ) - private String architecture; + private Architecture architecture; } From 1914c89557ef06b01e8cecd2f2bd941771964cba Mon Sep 17 00:00:00 2001 From: jshum Date: Sat, 21 Dec 2024 12:19:07 -0600 Subject: [PATCH 053/104] refactoring and correct missing stdout from multi platform build after first image --- .../imagetool/builder/AbstractCommand.java | 51 ++++++++++++------- 1 file changed, 34 insertions(+), 17 deletions(-) diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/builder/AbstractCommand.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/builder/AbstractCommand.java index 74f2b75a..ef343173 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/builder/AbstractCommand.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/builder/AbstractCommand.java @@ -4,6 +4,7 @@ package com.oracle.weblogic.imagetool.builder; import java.io.BufferedReader; +import java.io.BufferedWriter; import java.io.IOException; import java.io.InputStream; import java.io.InputStreamReader; @@ -13,7 +14,6 @@ import java.nio.file.Files; import java.nio.file.Path; import java.nio.file.Paths; -import java.util.ArrayList; import java.util.List; import com.oracle.weblogic.imagetool.logging.LoggingFacade; @@ -39,13 +39,9 @@ public void run(Path dockerLog) logger.entering(getCommand(false), dockerLog); Path dockerLogPath = createFile(dockerLog); logger.finer("Docker log: {0}", dockerLogPath); - List outputStreams = new ArrayList<>(); - - outputStreams.add(System.out); if (dockerLogPath != null) { logger.info("dockerLog: " + dockerLog); - outputStreams.add(Files.newOutputStream(dockerLogPath)); } ProcessBuilder processBuilder = new ProcessBuilder(getCommand(true)); @@ -53,11 +49,12 @@ public void run(Path dockerLog) logger.finer("Starting docker process..."); final Process process = processBuilder.start(); logger.finer("Docker process started"); - writeFromInputToOutputStreams(process.getInputStream(), outputStreams); + Thread readerThread = writeFromInputToOutputStreams(process.getInputStream(), dockerLogPath); logger.finer("Waiting for Docker to finish"); if (process.waitFor() != 0) { Utils.processError(process); } + readerThread.join(); } /** @@ -90,25 +87,45 @@ private Path createFile(Path filePath) { return logFilePath; } - private void writeFromInputToOutputStreams(InputStream inputStream, List outputStreams) { + private Thread writeFromInputToOutputStreams(InputStream inputStream, Path dockerLogPath) { Thread readerThread = new Thread(() -> { - try ( - BufferedReader processReader = new BufferedReader(new InputStreamReader(inputStream)); - CloseableList printWriters = createPrintWriters(outputStreams) - ) { - if (!printWriters.isEmpty()) { - String line; - while ((line = processReader.readLine()) != null) { - String finalLine = line; - printWriters.forEach(x -> x.println(finalLine)); + BufferedReader processReader = new BufferedReader(new InputStreamReader(inputStream)); + PrintWriter stdoutWriter = new PrintWriter(new BufferedWriter(new OutputStreamWriter(System.out))); + PrintWriter logWriter = null; + OutputStream fileOutputStream = null; + + try { + if (dockerLogPath != null) { + fileOutputStream = Files.newOutputStream(dockerLogPath); + logWriter = new PrintWriter(new BufferedWriter(new OutputStreamWriter(fileOutputStream))); + } + String line; + while ((line = processReader.readLine()) != null) { + // String finalLine = line; + if (logWriter != null) { + logWriter.println(line); } + stdoutWriter.println(line); } } catch (IOException e) { logger.severe(e.getMessage()); + } finally { + try { + processReader.close(); + if (logWriter != null) { + logWriter.close(); + } + if (fileOutputStream != null) { + fileOutputStream.close(); + } + } catch (IOException ioe) { + logger.finest(ioe.getMessage()); + } } }); - readerThread.setDaemon(true); + //readerThread.setDaemon(true); readerThread.start(); + return readerThread; } private CloseableList createPrintWriters(List outputStreams) { From 6f21127e7a24e035e18c3d28dff83d26076f83e1 Mon Sep 17 00:00:00 2001 From: jshum Date: Sat, 21 Dec 2024 12:19:23 -0600 Subject: [PATCH 054/104] refactoring --- .../imagetool/cli/menu/CreateImage.java | 19 ------------------- 1 file changed, 19 deletions(-) diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CreateImage.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CreateImage.java index 67e8fce6..af03726f 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CreateImage.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CreateImage.java @@ -105,25 +105,6 @@ public CommandResponse call() throws Exception { return successfulBuildResponse(startTime); } - private ManifestCommand createManifestCommand(String buildEngine, String context, String manifestName) { - return new ManifestCommand(buildEngine, context) - .create() - .name(manifestName); - } - - private ManifestCommand addManifestCommand(String buildEngine, String context, String manifestName, String tag) { - return new ManifestCommand(buildEngine, context) - .add() - .name(manifestName) - .tag(tag); - } - - private ManifestCommand pushManifestCommand(String buildEngine, String context, String manifestName, String tag) { - return new ManifestCommand(buildEngine, context) - .push() - .name(manifestName) - .tag(tag); - } @ArgGroup(exclusive = false, heading = "WDT Options%n") private final WdtFullOptions wdtOptions = new WdtFullOptions(); From 409ba5eff3ccfb62d7a9b4287d36fcb8fb4a3fb9 Mon Sep 17 00:00:00 2001 From: jshum Date: Sun, 22 Dec 2024 19:31:35 -0600 Subject: [PATCH 055/104] doc update and fix buffered printwriter issue --- .../userguide/tools/multiplatorm-build.md | 20 +++++++++++++++++++ .../imagetool/builder/AbstractCommand.java | 12 ++++++----- 2 files changed, 27 insertions(+), 5 deletions(-) diff --git a/documentation/site/content/userguide/tools/multiplatorm-build.md b/documentation/site/content/userguide/tools/multiplatorm-build.md index 13642e97..dd4627c4 100644 --- a/documentation/site/content/userguide/tools/multiplatorm-build.md +++ b/documentation/site/content/userguide/tools/multiplatorm-build.md @@ -35,6 +35,22 @@ rootless_storage_path = \"/path/to/storage/$USER\"" > ~/.config/containers/stora sudo loginctl enable-linger username +podman run --platform results in +ERROR: /etc/mtab symlink operation not permitted. + +podman info shows it is using native overlays, changing it to individual fuse overlays works + +sudo dnf install fuse-overlayfs + +create $USER/.config/containers/storage.conf + +[storage] +driver = "overlay" + +[storage.options.overlay] +mount_program = "/usr/bin/fuse-overlayfs" + + ======== TODO: @@ -42,4 +58,8 @@ TODO: podman does not take --load or --push docker must have --load or --push for multiplatform build +OL9 (not sure about OL8) defaults overlays doesn't work with emulator run + + + diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/builder/AbstractCommand.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/builder/AbstractCommand.java index ef343173..609eedcd 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/builder/AbstractCommand.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/builder/AbstractCommand.java @@ -90,22 +90,24 @@ private Path createFile(Path filePath) { private Thread writeFromInputToOutputStreams(InputStream inputStream, Path dockerLogPath) { Thread readerThread = new Thread(() -> { BufferedReader processReader = new BufferedReader(new InputStreamReader(inputStream)); - PrintWriter stdoutWriter = new PrintWriter(new BufferedWriter(new OutputStreamWriter(System.out))); + PrintWriter stdoutWriter = new PrintWriter(new BufferedWriter(new OutputStreamWriter(System.out)), + true); PrintWriter logWriter = null; OutputStream fileOutputStream = null; try { if (dockerLogPath != null) { fileOutputStream = Files.newOutputStream(dockerLogPath); - logWriter = new PrintWriter(new BufferedWriter(new OutputStreamWriter(fileOutputStream))); + logWriter = new PrintWriter(new BufferedWriter(new OutputStreamWriter(fileOutputStream)), + true); } String line; while ((line = processReader.readLine()) != null) { - // String finalLine = line; + String finalLine = line; if (logWriter != null) { - logWriter.println(line); + logWriter.println(finalLine); } - stdoutWriter.println(line); + stdoutWriter.println(finalLine); } } catch (IOException e) { logger.severe(e.getMessage()); From 7296c1833b4c16e3ee2bdd091490c0cff87f0f9f Mon Sep 17 00:00:00 2001 From: jshum Date: Mon, 23 Dec 2024 11:15:15 -0600 Subject: [PATCH 056/104] handle defaults from settings file --- .../imagetool/cachestore/CacheStore.java | 23 ++++++- .../cli/config/ConfigAttributeName.java | 40 +++++++++++- .../cli/menu/CommonCreateOptions.java | 54 +++++++++++++++- .../imagetool/settings/ConfigManager.java | 28 ++++++++- .../imagetool/settings/UserSettingsFile.java | 61 +++++++++++++++---- 5 files changed, 184 insertions(+), 22 deletions(-) diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cachestore/CacheStore.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cachestore/CacheStore.java index eaf079ef..854b1c3f 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cachestore/CacheStore.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cachestore/CacheStore.java @@ -66,7 +66,6 @@ public EnumMap>> getInstaller // - platform: linux/arm64 // .... // - platform: linux/arm64 - Map allInstallers = new SettingsFile(Paths.get(ConfigManager.getInstance() .getInstallerDetailsFile())).load(); if (allInstallers == null) { @@ -166,6 +165,28 @@ public InstallerMetaData getInstallerForPlatform(InstallerType installerType, Ar if (platformName == null) { platformName = Architecture.GENERIC; } + if (installerType == null) { + installerType = InstallerType.WLS; + } + if (installerVersion == null) { + switch (installerType) { + case WLS: + installerVersion = ConfigManager.getInstance().getDefaultWLSVersion(); + break; + case JDK: + installerVersion = ConfigManager.getInstance().getDefaultJDKVersion(); + break; + case WDT: + installerVersion = ConfigManager.getInstance().getDefaultWDTVersion(); + break; + default: + installerVersion = null; + } + if (installerVersion == null) { + logger.throwing(new IllegalArgumentException("Cannot determine installer version for installer type " + + installerType.toString())); + } + } Map> installers = getInstallers().get(installerType); if (installers != null && !installers.isEmpty()) { List installerMetaDataList = installers.get(installerVersion); diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/config/ConfigAttributeName.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/config/ConfigAttributeName.java index 96d1d8b4..0d1d6fd8 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/config/ConfigAttributeName.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/config/ConfigAttributeName.java @@ -3,6 +3,7 @@ package com.oracle.weblogic.imagetool.cli.config; + import com.oracle.weblogic.imagetool.settings.UserSettingsFile; public enum ConfigAttributeName { @@ -92,18 +93,51 @@ public void set(UserSettingsFile settings, String value) { @Override public String get(UserSettingsFile settings) { - return settings.getInstallerDetailsFile(); + return settings.getInstallerSettingsFile(); } }, patchSettingsFile("PatchSettingsFile") { @Override public void set(UserSettingsFile settings, String value) { - settings.setPatchDetailsFile(value); + settings.setPatchSettingsFile(value); + } + + @Override + public String get(UserSettingsFile settings) { + return settings.getPatchSettingsFile(); + } + }, + defaultWLSVersion("DefaultWLSVersion") { + @Override + public void set(UserSettingsFile settings, String value) { + settings.setDefaultWLSVersion(value); + } + + @Override + public String get(UserSettingsFile settings) { + return settings.getDefaultWLSVersion(); + } + }, + defaultWDTVersion("DefaultWDTVersion") { + @Override + public void set(UserSettingsFile settings, String value) { + settings.setDefaultWDTVersion(value); + } + + @Override + public String get(UserSettingsFile settings) { + return settings.getDefaultWDTVersion(); + } + }, + defaultJDKVersion("DefaultJDKVersion") { + @Override + public void set(UserSettingsFile settings, String value) { + settings.setDefaultJDKVersion(value); } @Override public String get(UserSettingsFile settings) { - return settings.getPatchDetailsFile(); + return settings.getDefaultJDKVersion(); } }, aruRetryInterval("AruRetryInterval") { diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonCreateOptions.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonCreateOptions.java index bd27ab6c..de224542 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonCreateOptions.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonCreateOptions.java @@ -29,6 +29,8 @@ import static com.oracle.weblogic.imagetool.util.Constants.AMD64_BLD; import static com.oracle.weblogic.imagetool.util.Constants.ARM64_BLD; import static com.oracle.weblogic.imagetool.util.Constants.CTX_JDK; +import static com.oracle.weblogic.imagetool.util.Constants.DEFAULT_JDK_VERSION; +import static com.oracle.weblogic.imagetool.util.Constants.DEFAULT_WLS_VERSION; public class CommonCreateOptions extends CommonPatchingOptions { @@ -109,20 +111,23 @@ void verifyInstallers(List buildPlatforms) throws IOException { // Verify version and installers exists first for (String buildPlatform : buildPlatforms) { Architecture arch = Architecture.fromString(buildPlatform); + jdkVersion = resetInstallerVersion(InstallerType.JDK, jdkVersion); InstallerMetaData jdkInstallerMetaData = configManager.getInstallerForPlatform(InstallerType.JDK, arch, jdkVersion); if (jdkInstallerMetaData == null) { - throw new IOException("Could not find installer for jdk " + jdkVersion + " " + buildPlatform); + throw new IOException(String.format("Could not find installer type: %s, platform: %s version: %s", + InstallerType.JDK, buildPlatform, jdkVersion)); } else { // If needed verifyInstallerHash(jdkInstallerMetaData); } for (InstallerType installerType : getInstallerType().installerList()) { + installerVersion = resetInstallerVersion(installerType, installerVersion); InstallerMetaData installerMetaData = configManager.getInstallerForPlatform(installerType, arch, installerVersion); if (installerMetaData == null) { - throw new IOException(String.format("Could not find installer type %s, platform %s and version %s", + throw new IOException(String.format("Could not find installer type: %s, platform: %s version: %s", installerType, buildPlatform, installerVersion)); } else { // If needed @@ -133,6 +138,49 @@ void verifyInstallers(List buildPlatforms) throws IOException { } + private String resetJDKVersion(String jdkVersion) { + String defaultJDKVersion = ConfigManager.getInstance().getDefaultJDKVersion(); + if (defaultJDKVersion != null) { + if (DEFAULT_JDK_VERSION.equals(jdkVersion)) { + jdkVersion = defaultJDKVersion; + } + } + return jdkVersion; + } + + private String resetInstallerVersion(InstallerType installerType, String installerVersion) { + String fixedVersion = installerVersion; + String defaultVersion = null; + + switch (installerType) { + case JDK: + String defaultJDKVersion = ConfigManager.getInstance().getDefaultJDKVersion(); + if (defaultJDKVersion != null) { + if (DEFAULT_JDK_VERSION.equals(installerVersion)) { + fixedVersion = defaultJDKVersion; + } + } + break; + case WLS: + String defaultWLSVersion = ConfigManager.getInstance().getDefaultWLSVersion(); + if (defaultWLSVersion != null) { + if (DEFAULT_WLS_VERSION.equals(installerVersion)) { + fixedVersion = defaultWLSVersion; + } + } + break; + case WDT: + defaultVersion = ConfigManager.getInstance().getDefaultWDTVersion(); + if (defaultVersion != null && installerVersion == null) { + fixedVersion = defaultVersion; + } + break; + default: + break; + } + return fixedVersion; + } + private static void verifyInstallerHash(InstallerMetaData installerMetaData) throws IOException { MessageDigest digest; try { @@ -167,7 +215,7 @@ String getInstallerVersion() { names = {"--version"}, description = "Installer version. Default: ${DEFAULT-VALUE}", required = true, - defaultValue = Constants.DEFAULT_WLS_VERSION + defaultValue = DEFAULT_WLS_VERSION ) private String installerVersion; diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/ConfigManager.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/ConfigManager.java index 8f011ccb..c4c372cc 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/ConfigManager.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/ConfigManager.java @@ -72,7 +72,7 @@ public String getPatchDirectory() { } public String getPatchDetailsFile() { - return userSettingsFile.getPatchDetailsFile(); + return userSettingsFile.getPatchSettingsFile(); } public String getBuildEngine() { @@ -80,7 +80,7 @@ public String getBuildEngine() { } public String getInstallerDetailsFile() { - return userSettingsFile.getInstallerDetailsFile(); + return userSettingsFile.getInstallerSettingsFile(); } public String getDefaultBuildPlatform() { @@ -128,6 +128,30 @@ public EnumMap>> getInstaller return cacheStore.getInstallers(); } + /** + * Return default wls installer version. + * @return default wls version if set + */ + public String getDefaultWLSVersion() { + return userSettingsFile.getDefaultWLSVersion(); + } + + /** + * Return default jdk installer version. + * @return default wls version if set + */ + public String getDefaultJDKVersion() { + return userSettingsFile.getDefaultJDKVersion(); + } + + /** + * Return default wdt installer version. + * @return default wls version if set + */ + public String getDefaultWDTVersion() { + return userSettingsFile.getDefaultWDTVersion(); + } + /** * Add installer. * @param installerType installer type diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/UserSettingsFile.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/UserSettingsFile.java index 5000de79..e3ec4d87 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/UserSettingsFile.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/UserSettingsFile.java @@ -61,12 +61,16 @@ public class UserSettingsFile { private final SettingsFile settingsFile; - private String installerDetailsFile = null; + private String installerSettingsFile = null; - private String patchDetailsFile = null; + private String patchSettingsFile = null; private String defaultBuildPlatform = null; + private String defaultWLSVersion = null; + private String defaultWDTVersion = null; + private String defaultJDKVersion = null; + /** * DLoads the settings.yaml file from ~/.imagetool/settings.yaml and applies the values found. */ @@ -220,14 +224,39 @@ public void setAruRetryInterval(Integer value) { aruRetryInterval = value; } - public String getPatchDetailsFile() { - return patchDetailsFile; + public String getPatchSettingsFile() { + return patchSettingsFile; + } + + public void setPatchSettingsFile(String value) { + patchSettingsFile = value; + } + + public void setDefaultWLSVersion(String value) { + defaultWLSVersion = value; + } + + public String getDefaultWLSVersion() { + return defaultWLSVersion; } - public void setPatchDetailsFile(String value) { - patchDetailsFile = value; + public void setDefaultWDTVersion(String value) { + defaultWDTVersion = value; } + public String getDefaultWDTVersion() { + return defaultWDTVersion; + } + + public void setDefaultJDKVersion(String value) { + defaultJDKVersion = value; + } + + public String getDefaultJDKVersion() { + return defaultJDKVersion; + } + + /** * The user settings for installer type. * @param installerType Installer type such as JDK, WLS, SOA, etc. @@ -256,8 +285,11 @@ private void applySettings(Map settings) { aruRetryMax = SettingsFile.getValue("aruRetryMax", Integer.class, settings); aruRetryInterval = SettingsFile.getValue("aruRetryInterval", Integer.class, settings); - installerDetailsFile = SettingsFile.getValue("installerSettingsFile", String.class, settings); - patchDetailsFile = SettingsFile.getValue("patchSettingsFile", String.class, settings); + installerSettingsFile = SettingsFile.getValue("installerSettingsFile", String.class, settings); + patchSettingsFile = SettingsFile.getValue("patchSettingsFile", String.class, settings); + defaultWLSVersion = SettingsFile.getValue("defaultWLSVersion", String.class, settings); + defaultJDKVersion = SettingsFile.getValue("defaultJDKVersion", String.class, settings); + defaultWDTVersion = SettingsFile.getValue("defaultWDTVersion", String.class, settings); // Just the settings about the installer not the individual installers installerSettings.clear(); Map installerFolder = SettingsFile.getFolder("installers", settings); @@ -279,12 +311,12 @@ private void applySettings(Map settings) { logger.exiting(); } - public String getInstallerDetailsFile() { - return installerDetailsFile; + public String getInstallerSettingsFile() { + return installerSettingsFile; } public String setInstallerDetailsFile(String value) { - return installerDetailsFile = value; + return installerSettingsFile = value; } public String getDefaultBuildPlatform() { @@ -307,8 +339,11 @@ public String toString() { + ", aruRetryMax=" + aruRetryMax + ", aruRetryInterval=" + aruRetryInterval + ", settingsFile=" + settingsFile - + ", installerDetailsFile='" + installerDetailsFile + '\'' - + ", patchDetailsFile='" + patchDetailsFile + '\'' + + ", installerDetailsFile='" + installerSettingsFile + '\'' + + ", patchDetailsFile='" + patchSettingsFile + '\'' + + ", defaultWLSVersion='" + defaultWLSVersion + '\'' + + ", defaultWDTVersion='" + defaultWDTVersion + '\'' + + ", defaultJDKVersion='" + defaultJDKVersion + '\'' + '}'; } } From 0de89db01251b91bc40a5ce70e38c60f60404cfe Mon Sep 17 00:00:00 2001 From: jshum Date: Mon, 23 Dec 2024 21:22:46 -0600 Subject: [PATCH 057/104] Fix config settings serialization. --- .../imagetool/cachestore/CacheStore.java | 5 + .../cli/config/ConfigAttributeName.java | 28 +---- .../imagetool/settings/ConfigManager.java | 23 +++- .../imagetool/settings/InstallerSettings.java | 5 +- .../imagetool/settings/SettingsFile.java | 36 ++++++- .../imagetool/settings/UserSettingsFile.java | 100 +++++++++--------- 6 files changed, 113 insertions(+), 84 deletions(-) diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cachestore/CacheStore.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cachestore/CacheStore.java index 854b1c3f..03f11267 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cachestore/CacheStore.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cachestore/CacheStore.java @@ -66,8 +66,13 @@ public EnumMap>> getInstaller // - platform: linux/arm64 // .... // - platform: linux/arm64 + + //ConfigManager cm = ConfigManager.getInstance(); + //Map allInstallers = cm.getInstallerSettingsFile().load(); + Map allInstallers = new SettingsFile(Paths.get(ConfigManager.getInstance() .getInstallerDetailsFile())).load(); + if (allInstallers == null) { allInstallers = new HashMap<>(); } diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/config/ConfigAttributeName.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/config/ConfigAttributeName.java index 0d1d6fd8..46806708 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/config/ConfigAttributeName.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/config/ConfigAttributeName.java @@ -85,28 +85,6 @@ public String get(UserSettingsFile settings) { return settings.getDefaultBuildPlatform(); } }, - installerSettingsFile("InstallerSettingsFile") { - @Override - public void set(UserSettingsFile settings, String value) { - settings.setInstallerDetailsFile(value); - } - - @Override - public String get(UserSettingsFile settings) { - return settings.getInstallerSettingsFile(); - } - }, - patchSettingsFile("PatchSettingsFile") { - @Override - public void set(UserSettingsFile settings, String value) { - settings.setPatchSettingsFile(value); - } - - @Override - public String get(UserSettingsFile settings) { - return settings.getPatchSettingsFile(); - } - }, defaultWLSVersion("DefaultWLSVersion") { @Override public void set(UserSettingsFile settings, String value) { @@ -115,7 +93,7 @@ public void set(UserSettingsFile settings, String value) { @Override public String get(UserSettingsFile settings) { - return settings.getDefaultWLSVersion(); + return settings.returnDefaultWLSVersion(); } }, defaultWDTVersion("DefaultWDTVersion") { @@ -126,7 +104,7 @@ public void set(UserSettingsFile settings, String value) { @Override public String get(UserSettingsFile settings) { - return settings.getDefaultWDTVersion(); + return settings.returnDefaultWDTVersion(); } }, defaultJDKVersion("DefaultJDKVersion") { @@ -137,7 +115,7 @@ public void set(UserSettingsFile settings, String value) { @Override public String get(UserSettingsFile settings) { - return settings.getDefaultJDKVersion(); + return settings.returnDefaultJDKVersion(); } }, aruRetryInterval("AruRetryInterval") { diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/ConfigManager.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/ConfigManager.java index c4c372cc..6f5f5b2b 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/ConfigManager.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/ConfigManager.java @@ -25,6 +25,8 @@ public class ConfigManager { private UserSettingsFile userSettingsFile; + private SettingsFile installerSettingsFile; + private SettingsFile patchSettingsFile; private static ConfigManager instance; private static final LoggingFacade logger = LoggingFactory.getLogger(UserSettingsFile.class); private static CacheStore cacheStore = new CacheStore(); @@ -72,7 +74,7 @@ public String getPatchDirectory() { } public String getPatchDetailsFile() { - return userSettingsFile.getPatchSettingsFile(); + return userSettingsFile.returnPatchSettingsFile(); } public String getBuildEngine() { @@ -80,7 +82,18 @@ public String getBuildEngine() { } public String getInstallerDetailsFile() { - return userSettingsFile.getInstallerSettingsFile(); + return userSettingsFile.returnInstallerSettingsFile(); + } + + /** + * Return the installer setting file. + * @return SettingsFile + */ + public SettingsFile getInstallerSettingsFile() { + if (installerSettingsFile == null) { + installerSettingsFile = new SettingsFile(Paths.get(userSettingsFile.returnInstallerSettingsFile())); + } + return installerSettingsFile; } public String getDefaultBuildPlatform() { @@ -133,7 +146,7 @@ public EnumMap>> getInstaller * @return default wls version if set */ public String getDefaultWLSVersion() { - return userSettingsFile.getDefaultWLSVersion(); + return userSettingsFile.returnDefaultWLSVersion(); } /** @@ -141,7 +154,7 @@ public String getDefaultWLSVersion() { * @return default wls version if set */ public String getDefaultJDKVersion() { - return userSettingsFile.getDefaultJDKVersion(); + return userSettingsFile.returnDefaultJDKVersion(); } /** @@ -149,7 +162,7 @@ public String getDefaultJDKVersion() { * @return default wls version if set */ public String getDefaultWDTVersion() { - return userSettingsFile.getDefaultWDTVersion(); + return userSettingsFile.returnDefaultWDTVersion(); } /** diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/InstallerSettings.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/InstallerSettings.java index e289e559..267caebd 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/InstallerSettings.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/InstallerSettings.java @@ -3,13 +3,11 @@ package com.oracle.weblogic.imagetool.settings; -import java.util.HashMap; import java.util.Map; public class InstallerSettings { - private String defaultVersion; - private Map installerList = new HashMap(); + public String defaultVersion; public InstallerSettings(Map settings) { applySettings(settings); @@ -24,7 +22,6 @@ private void applySettings(Map settings) { // return; //} defaultVersion = SettingsFile.getValue("defaultVersion", String.class, settings); - installerList = settings; } public String getDefaultVersion() { diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/SettingsFile.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/SettingsFile.java index cd3c3279..d1c951e6 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/SettingsFile.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/SettingsFile.java @@ -9,8 +9,10 @@ import java.nio.file.Files; import java.nio.file.Path; import java.util.Collections; +import java.util.EnumMap; import java.util.Map; +import com.oracle.weblogic.imagetool.installer.InstallerType; import com.oracle.weblogic.imagetool.logging.LoggingFacade; import com.oracle.weblogic.imagetool.logging.LoggingFactory; import org.yaml.snakeyaml.DumperOptions; @@ -60,13 +62,40 @@ public Map load() { return map; } + static class CustomRepresenter extends Representer { + private DumperOptions options; + + public CustomRepresenter(DumperOptions options) { + super(options); + this.options = options; + this.representers.put(EnumMap.class, data -> representMapping(Tag.MAP, (Map)data, + null)); + } + + @Override + protected NodeTuple representJavaBeanProperty(Object javaBean, Property property, Object propertyValue, + Tag customTag) { + // if value of property is null, ignore it. + if (propertyValue == null) { + return null; + } else { + return super.representJavaBeanProperty(javaBean, property, propertyValue, customTag); + } + } + + } + private static Representer getYamlRepresenter() { // Created this inline override to suppress the output of null for all unset user settings + //DumperOptions options = new DumperOptions(); + //options.setDefaultFlowStyle(DumperOptions.FlowStyle.BLOCK); + //CustomRepresenter representer = new CustomRepresenter(options); Representer representer = new Representer() { @Override protected NodeTuple representJavaBeanProperty(Object javaBean, Property property, Object propertyValue, Tag customTag) { // if value of property is null, ignore it. + this.representers.put(EnumMap.class, data -> representMapping(Tag.MAP, (Map)data, null)); if (propertyValue == null) { return null; } else { @@ -75,7 +104,10 @@ protected NodeTuple representJavaBeanProperty(Object javaBean, Property property } }; representer.addClassTag(UserSettingsFile.class, Tag.MAP); - representer.setDefaultFlowStyle(DumperOptions.FlowStyle.BLOCK); + representer.addClassTag(InstallerType.class, Tag.MAP); + representer.addClassTag(InstallerSettings.class, Tag.MAP); + //representer.addClassTag(Map.class, Tag.MAP); + //representer.setDefaultFlowStyle(DumperOptions.FlowStyle.BLOCK); PropertyUtils propertyUtils = new PropertyUtils(); propertyUtils.setAllowReadOnlyProperties(true); @@ -94,6 +126,8 @@ public void save(Object data) throws IOException { } try (OutputStreamWriter output = new OutputStreamWriter(Files.newOutputStream(filePath))) { + //DumperOptions options = new DumperOptions(); + //options.setDefaultFlowStyle(DumperOptions.FlowStyle.BLOCK); Yaml yaml = new Yaml(getYamlRepresenter()); yaml.dump(data, output); } catch (IOException ioe) { diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/UserSettingsFile.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/UserSettingsFile.java index e3ec4d87..39e76cba 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/UserSettingsFile.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/UserSettingsFile.java @@ -6,8 +6,9 @@ import java.io.IOException; import java.nio.file.Path; import java.nio.file.Paths; -import java.util.EnumMap; +import java.util.HashMap; import java.util.Map; +import java.util.Optional; import com.oracle.weblogic.imagetool.installer.InstallerType; import com.oracle.weblogic.imagetool.logging.LoggingFacade; @@ -18,9 +19,7 @@ public class UserSettingsFile { /** * Configured defaults associated with each installer. */ - private final EnumMap installerSettings; - - //private InstallerSettings patches = null; + private final Map installerSettings; /** * Parent directory for the build context directory. @@ -61,15 +60,10 @@ public class UserSettingsFile { private final SettingsFile settingsFile; - private String installerSettingsFile = null; - - private String patchSettingsFile = null; - private String defaultBuildPlatform = null; - private String defaultWLSVersion = null; - private String defaultWDTVersion = null; - private String defaultJDKVersion = null; + private String installerSettingsFile = null; + private String patchSettingsFile = null; /** * DLoads the settings.yaml file from ~/.imagetool/settings.yaml and applies the values found. @@ -84,8 +78,10 @@ public UserSettingsFile() { * @param pathToSettingsFile A map of key-value pairs read in from the YAML user settings file. */ public UserSettingsFile(Path pathToSettingsFile) { - installerSettings = new EnumMap<>(InstallerType.class); + installerSettings = new HashMap<>(); settingsFile = new SettingsFile(pathToSettingsFile); + installerSettingsFile = pathToSettingsFile.getParent().resolve("installers.yaml").toString(); + patchSettingsFile = pathToSettingsFile.getParent().resolve("patches.yaml").toString(); applySettings(settingsFile.load()); } @@ -224,39 +220,45 @@ public void setAruRetryInterval(Integer value) { aruRetryInterval = value; } - public String getPatchSettingsFile() { - return patchSettingsFile; - } - - public void setPatchSettingsFile(String value) { - patchSettingsFile = value; + /** + * Set the default WLS version. + * @param value version of WLS installer + */ + public void setDefaultWLSVersion(String value) { + setDefaultVersion(value, InstallerType.WLS); } - public void setDefaultWLSVersion(String value) { - defaultWLSVersion = value; + private void setDefaultVersion(String value, InstallerType type) { + Map installerSettingsMap = new HashMap<>(); + installerSettingsMap.put("defaultVersion", value); + InstallerSettings versionSettings = new InstallerSettings(installerSettingsMap); + installerSettings.put(type.toString(), versionSettings); } - public String getDefaultWLSVersion() { - return defaultWLSVersion; + // Do not use getXXX Snake Yaml will add separate entry in the serialized yaml file + public String returnDefaultWLSVersion() { + return Optional.ofNullable(installerSettings.get(InstallerType.WLS.toString())) + .map(InstallerSettings::getDefaultVersion).orElse(null); } public void setDefaultWDTVersion(String value) { - defaultWDTVersion = value; + setDefaultVersion(value, InstallerType.WDT); } - public String getDefaultWDTVersion() { - return defaultWDTVersion; + public String returnDefaultWDTVersion() { + return Optional.ofNullable(installerSettings.get(InstallerType.WDT.toString())) + .map(InstallerSettings::getDefaultVersion).orElse(null); } public void setDefaultJDKVersion(String value) { - defaultJDKVersion = value; + setDefaultVersion(value, InstallerType.JDK); } - public String getDefaultJDKVersion() { - return defaultJDKVersion; + public String returnDefaultJDKVersion() { + return Optional.ofNullable(installerSettings.get(InstallerType.JDK.toString())) + .map(InstallerSettings::getDefaultVersion).orElse(null); } - /** * The user settings for installer type. * @param installerType Installer type such as JDK, WLS, SOA, etc. @@ -266,7 +268,15 @@ public InstallerSettings getInstallerSettings(InstallerType installerType) { if (installerSettings == null) { return null; } - return installerSettings.get(installerType); + return installerSettings.get(installerType.toString()); + } + + public Map getInstallerSettings() { + return installerSettings; + } + + public String defaultWLSVersion() { + return "hello"; } private void applySettings(Map settings) { @@ -285,11 +295,6 @@ private void applySettings(Map settings) { aruRetryMax = SettingsFile.getValue("aruRetryMax", Integer.class, settings); aruRetryInterval = SettingsFile.getValue("aruRetryInterval", Integer.class, settings); - installerSettingsFile = SettingsFile.getValue("installerSettingsFile", String.class, settings); - patchSettingsFile = SettingsFile.getValue("patchSettingsFile", String.class, settings); - defaultWLSVersion = SettingsFile.getValue("defaultWLSVersion", String.class, settings); - defaultJDKVersion = SettingsFile.getValue("defaultJDKVersion", String.class, settings); - defaultWDTVersion = SettingsFile.getValue("defaultWDTVersion", String.class, settings); // Just the settings about the installer not the individual installers installerSettings.clear(); Map installerFolder = SettingsFile.getFolder("installers", settings); @@ -299,7 +304,7 @@ private void applySettings(Map settings) { key = key.toUpperCase(); try { installerSettings.put( - InstallerType.valueOf(key), + key, new InstallerSettings((Map) entry.getValue())); } catch (IllegalArgumentException illegal) { logger.warning("settings for {0} could not be loaded. {0} is not a valid installer type: {1}", @@ -311,14 +316,6 @@ private void applySettings(Map settings) { logger.exiting(); } - public String getInstallerSettingsFile() { - return installerSettingsFile; - } - - public String setInstallerDetailsFile(String value) { - return installerSettingsFile = value; - } - public String getDefaultBuildPlatform() { return defaultBuildPlatform; } @@ -327,6 +324,14 @@ public String setDefaultBuildPlatform(String value) { return defaultBuildPlatform = value; } + public String returnInstallerSettingsFile() { + return installerSettingsFile; + } + + public String returnPatchSettingsFile() { + return patchSettingsFile; + } + @Override public String toString() { return "UserSettingsFile{" @@ -339,11 +344,8 @@ public String toString() { + ", aruRetryMax=" + aruRetryMax + ", aruRetryInterval=" + aruRetryInterval + ", settingsFile=" + settingsFile - + ", installerDetailsFile='" + installerSettingsFile + '\'' - + ", patchDetailsFile='" + patchSettingsFile + '\'' - + ", defaultWLSVersion='" + defaultWLSVersion + '\'' - + ", defaultWDTVersion='" + defaultWDTVersion + '\'' - + ", defaultJDKVersion='" + defaultJDKVersion + '\'' + + ", installerSettings='" + installerSettings + '\'' + '}'; } + } From 9afd939c602283a2eb70dceb38b481701ee4f43b Mon Sep 17 00:00:00 2001 From: jshum Date: Tue, 24 Dec 2024 08:36:14 -0600 Subject: [PATCH 058/104] refactor to use snakeyaml serialization --- .../imagetool/cachestore/CacheStore.java | 125 +++++------------- .../imagetool/cachestore/PatchFile.java | 2 +- .../imagetool/cli/cache/DeleteInstaller.java | 8 +- .../imagetool/cli/cache/DeletePatch.java | 2 +- .../imagetool/cli/cache/ListInstallers.java | 6 +- .../imagetool/installer/InstallerType.java | 2 +- .../imagetool/settings/ConfigManager.java | 55 +++++--- .../imagetool/settings/SettingsFile.java | 6 +- .../imagetool/settings/YamlFileConstants.java | 16 +++ .../imagetool/cachestore/CachedFileTest.java | 2 +- .../imagetool/cachestore/OPatchFileTest.java | 2 +- .../imagetool/cachestore/PatchFileTest.java | 2 +- 12 files changed, 104 insertions(+), 124 deletions(-) create mode 100644 imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/YamlFileConstants.java diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cachestore/CacheStore.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cachestore/CacheStore.java index 03f11267..990ca11e 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cachestore/CacheStore.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cachestore/CacheStore.java @@ -7,9 +7,7 @@ import java.io.IOException; import java.nio.file.Paths; import java.util.ArrayList; -import java.util.EnumMap; import java.util.HashMap; -import java.util.LinkedHashMap; import java.util.List; import java.util.Map; @@ -26,6 +24,13 @@ import com.oracle.weblogic.imagetool.util.Utils; import static com.oracle.weblogic.imagetool.aru.AruUtil.getAruPlatformId; +import static com.oracle.weblogic.imagetool.settings.YamlFileConstants.DATE_ADDED; +import static com.oracle.weblogic.imagetool.settings.YamlFileConstants.DESCRIPTION; +import static com.oracle.weblogic.imagetool.settings.YamlFileConstants.DIGEST; +import static com.oracle.weblogic.imagetool.settings.YamlFileConstants.LOCATION; +import static com.oracle.weblogic.imagetool.settings.YamlFileConstants.PATCH_VERSION; +import static com.oracle.weblogic.imagetool.settings.YamlFileConstants.PLATFORM; +import static com.oracle.weblogic.imagetool.settings.YamlFileConstants.PRODUCT_VERSION; import static com.oracle.weblogic.imagetool.util.Utils.getTodayDate; /** @@ -43,7 +48,7 @@ public class CacheStore { * Return all the installers based on the configured directory for the yaml file. * @return map of installers */ - public EnumMap>> getInstallers() { + public Map>> getInstallers() { // installers is a list of different installer types jdk, fmw, wdt etc .. @@ -76,8 +81,8 @@ public EnumMap>> getInstaller if (allInstallers == null) { allInstallers = new HashMap<>(); } - EnumMap>> installerDetails - = new EnumMap<>(InstallerType.class); + Map>> installerDetails + = new HashMap<>(); for (Map.Entry entry: allInstallers.entrySet()) { String key = entry.getKey(); if (key != null && !key.isEmpty()) { @@ -108,7 +113,7 @@ public EnumMap>> getInstaller installerMetaData.put(individualInstallerKey, installerMetaDataList); } - installerDetails.put(InstallerType.valueOf(key), installerMetaData); + installerDetails.put(key, installerMetaData); } catch (IllegalArgumentException illegal) { logger.warning("{0} could not be loaded: {1}", @@ -129,14 +134,14 @@ public EnumMap>> getInstaller public void addInstaller(InstallerType installerType, String commonName, InstallerMetaData metaData) throws IOException { - EnumMap>> installerDetails = getInstallers(); + Map>> installerDetails = getInstallers(); Map> installerMetaDataMap; List installerMetaDataList; if (installerDetails.containsKey(installerType)) { installerMetaDataMap = installerDetails.get(installerType); } else { - installerDetails.put(installerType, new HashMap<>()); + installerDetails.put(installerType.toString(), new HashMap<>()); installerMetaDataMap = installerDetails.get(installerType); } @@ -153,8 +158,8 @@ public void addInstaller(InstallerType installerType, String commonName, Install installerMetaDataList.add(metaData); } // Update the list - installerDetails.put(installerType, installerMetaDataMap); - saveAllInstallers(installerDetails, ConfigManager.getInstance().getInstallerDetailsFile()); + installerDetails.put(installerType.toString(), installerMetaDataMap); + saveAllInstallers(installerDetails); } /** @@ -238,7 +243,7 @@ public void addPatch(String bugNumber, String patchArchitecture, String patchLoc latestPatches.add(newPatch); } patches.put(bugNumber, latestPatches); - configManager.saveAllPatches(patches, configManager.getPatchDetailsFile()); + configManager.saveAllPatches(patches); } /** @@ -265,7 +270,7 @@ public void addPatch(String bugNumber, String patchArchitecture, String patchLoc latestPatches.add(newPatch); } patches.put(bugNumber, latestPatches); - configManager.saveAllPatches(patches, configManager.getPatchDetailsFile()); + configManager.saveAllPatches(patches); } /** @@ -367,106 +372,48 @@ public Map> getAllPatches() { /** * Save all patches in the local metadata file. * @param allPatches Map of all patch metadata - * @param location file location for store * @throws IOException when error */ - public void saveAllPatches(Map> allPatches, String location) throws IOException { - Map patchList = new HashMap<>(); - for (Map.Entry> entry: allPatches.entrySet()) { - String key = entry.getKey(); // bug number - if (key != null && !key.isEmpty()) { - ArrayList list = new ArrayList<>(); - if (entry.getValue() instanceof ArrayList) { - for (PatchMetaData patchMetaData: entry.getValue()) { - LinkedHashMap map = new LinkedHashMap<>(); - map.put("version", patchMetaData.getPatchVersion()); - map.put("location", patchMetaData.getLocation()); - map.put("digest", patchMetaData.getHash()); - map.put("added", patchMetaData.getDateAdded()); - map.put("platform", patchMetaData.getPlatform()); - if (patchMetaData.getDescription() != null) { - map.put("description", patchMetaData.getDescription()); - } - list.add(map); - } - } else { - PatchMetaData patchMetaData = (PatchMetaData) entry.getValue(); - LinkedHashMap map = new LinkedHashMap<>(); - map.put("version", patchMetaData.getPatchVersion()); - map.put("location", patchMetaData.getLocation()); - map.put("digest", patchMetaData.getHash()); - map.put("added", patchMetaData.getDateAdded()); - map.put("platform", patchMetaData.getPlatform()); - if (patchMetaData.getDescription() != null) { - map.put("description", patchMetaData.getDescription()); - } - list.add(map); - } - patchList.put(key, list); - } - } - new SettingsFile(Paths.get(location)).save(patchList); + public void saveAllPatches(Map> allPatches) throws IOException { + + ConfigManager configManager = ConfigManager.getInstance(); + configManager.getPatchSettingsFile().save(allPatches); + } /** * Save all installers in the local metadata file. * @param allInstallers Map of all installers metadata - * @param location file location for store * @throws IOException when error */ - public void saveAllInstallers(Map>> allInstallers, - String location) throws IOException { - LinkedHashMap installerList = new LinkedHashMap<>(); - - if (allInstallers != null && !allInstallers.isEmpty()) { - for (Map.Entry>> entry: allInstallers.entrySet()) { - InstallerType installerType = entry.getKey(); - Map> installerMetaDataList = entry.getValue(); - LinkedHashMap typedInstallers = new LinkedHashMap<>(); - - for (String installerMetaData : installerMetaDataList.keySet()) { - List mdList = installerMetaDataList.get(installerMetaData); - ArrayList installerMetaDataArray = new ArrayList<>(); - for (InstallerMetaData md : mdList) { - LinkedHashMap map = new LinkedHashMap<>(); - map.put("version", md.getProductVersion()); - map.put("location", md.getLocation()); - map.put("digest", md.getDigest()); - map.put("added", md.getDateAdded()); - map.put("platform", md.getPlatform()); - installerMetaDataArray.add(map); - } - typedInstallers.put(installerMetaData, installerMetaDataArray); - } - installerList.put(installerType.toString(), typedInstallers); - } - } - new SettingsFile(Paths.get(location)).save(installerList); + public void saveAllInstallers(Map>> allInstallers) throws IOException { + + ConfigManager.getInstance().getInstallerSettingsFile().save(allInstallers); } private InstallerMetaData createInstallerMetaData(Map objectData) { - String hash = (String) objectData.get("digest"); - String dateAdded = (String) objectData.get("added"); + String hash = (String) objectData.get(DIGEST); + String dateAdded = (String) objectData.get(DATE_ADDED); if (dateAdded == null) { dateAdded = getTodayDate(); } - String location = (String) objectData.get("location"); - String productVersion = (String) objectData.get("version"); - String platform = (String) objectData.get("platform"); + String location = (String) objectData.get(LOCATION); + String productVersion = (String) objectData.get(PRODUCT_VERSION); + String platform = (String) objectData.get(PLATFORM); return new InstallerMetaData(platform, location, hash, dateAdded, productVersion); } private PatchMetaData createPatchMetaData(Map objectData) { - String hash = (String) objectData.get("digest"); - String dateAdded = (String) objectData.get("added"); + String hash = (String) objectData.get(DIGEST); + String dateAdded = (String) objectData.get(DATE_ADDED); if (dateAdded == null) { dateAdded = getTodayDate(); } - String location = (String) objectData.get("location"); - String productVersion = (String) objectData.get("version"); - String platform = (String) objectData.get("platform"); - String description = (String) objectData.get("description"); + String location = (String) objectData.get(LOCATION); + String productVersion = (String) objectData.get(PATCH_VERSION); + String platform = (String) objectData.get(PLATFORM); + String description = (String) objectData.get(DESCRIPTION); return new PatchMetaData(platform, location, hash, dateAdded, productVersion, description); } diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cachestore/PatchFile.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cachestore/PatchFile.java index ed029295..14980c92 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cachestore/PatchFile.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cachestore/PatchFile.java @@ -84,7 +84,7 @@ public String downloadPatch(AruPatch aruPatch, ConfigManager configManager) thro aruPatch.description())); allPatches.put(aruPatch.patchId(),patches); } - configManager.saveAllPatches(allPatches, configManager.getPatchDetailsFile()); + configManager.saveAllPatches(allPatches); } catch (Exception k) { throw new IOException(k.getMessage(), k); diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/DeleteInstaller.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/DeleteInstaller.java index d29ecdbb..48d254f1 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/DeleteInstaller.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/DeleteInstaller.java @@ -27,13 +27,13 @@ public class DeleteInstaller extends CacheOperation { @Override public CommandResponse call() throws CacheStoreException { ConfigManager configManager = ConfigManager.getInstance(); - Map>> data = configManager.getInstallers(); + Map>> data = configManager.getInstallers(); if (type == null || version == null || architecture == null) { return CommandResponse.success("IMG-0124"); } boolean exists = false; - for (InstallerType itemType : data.keySet()) { - if (type != null && type != itemType) { + for (String itemType : data.keySet()) { + if (type != null && type != InstallerType.fromString(itemType)) { continue; } Map> items = data.get(itemType); @@ -62,7 +62,7 @@ public CommandResponse call() throws CacheStoreException { return CommandResponse.success("IMG-0125"); } try { - configManager.saveAllInstallers(data, ConfigManager.getInstance().getInstallerDetailsFile()); + configManager.saveAllInstallers(data); } catch (IOException e) { throw new CacheStoreException(e.getMessage(), e); } diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/DeletePatch.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/DeletePatch.java index 8277690b..e5550094 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/DeletePatch.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/DeletePatch.java @@ -55,7 +55,7 @@ public CommandResponse call() throws CacheStoreException { return CommandResponse.success("IMG-0127"); } try { - configManager.saveAllPatches(data, ConfigManager.getInstance().getPatchDetailsFile()); + configManager.saveAllPatches(data); } catch (IOException e) { throw new CacheStoreException(e.getMessage(), e); } diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/ListInstallers.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/ListInstallers.java index 06f85c3f..99ad3b9f 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/ListInstallers.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/ListInstallers.java @@ -24,7 +24,7 @@ public class ListInstallers extends CacheOperation { @Override public CommandResponse call() throws CacheStoreException { ConfigManager configManager = ConfigManager.getInstance(); - Map>> data = configManager.getInstallers(); + Map>> data = configManager.getInstallers(); if (commonName != null && !commonName.isEmpty()) { if (type == null) { System.out.println("--type cannot be null when commonName is specified"); @@ -37,8 +37,8 @@ public CommandResponse call() throws CacheStoreException { System.exit(2); } } - for (InstallerType itemType : data.keySet()) { - if (type != null && type != itemType) { + for (String itemType : data.keySet()) { + if (type != null && type != InstallerType.fromString(itemType)) { continue; } System.out.println(itemType + ":"); diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/installer/InstallerType.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/installer/InstallerType.java index d06d3e98..3091777e 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/installer/InstallerType.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/installer/InstallerType.java @@ -48,7 +48,7 @@ public enum InstallerType { */ public static InstallerType fromString(String value) { for (InstallerType installerType : InstallerType.values()) { - if (installerType.toString().equals(value)) { + if (installerType.toString().equalsIgnoreCase(value)) { return installerType; } } diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/ConfigManager.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/ConfigManager.java index 6f5f5b2b..95222815 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/ConfigManager.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/ConfigManager.java @@ -1,4 +1,4 @@ -// Copyright (c) 2020, 2024, Oracle and/or its affiliates. +// Copyright (c) 2025, 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.settings; @@ -7,7 +7,6 @@ import java.nio.file.Files; import java.nio.file.Path; import java.nio.file.Paths; -import java.util.EnumMap; import java.util.List; import java.util.Map; @@ -21,6 +20,13 @@ import com.oracle.weblogic.imagetool.util.Architecture; import static com.oracle.weblogic.imagetool.cachestore.CacheStore.CACHE_DIR_ENV; +import static com.oracle.weblogic.imagetool.settings.YamlFileConstants.DATE_ADDED; +import static com.oracle.weblogic.imagetool.settings.YamlFileConstants.DESCRIPTION; +import static com.oracle.weblogic.imagetool.settings.YamlFileConstants.DIGEST; +import static com.oracle.weblogic.imagetool.settings.YamlFileConstants.LOCATION; +import static com.oracle.weblogic.imagetool.settings.YamlFileConstants.PATCH_VERSION; +import static com.oracle.weblogic.imagetool.settings.YamlFileConstants.PLATFORM; +import static com.oracle.weblogic.imagetool.settings.YamlFileConstants.PRODUCT_VERSION; import static com.oracle.weblogic.imagetool.util.Utils.getTodayDate; public class ConfigManager { @@ -96,6 +102,17 @@ public SettingsFile getInstallerSettingsFile() { return installerSettingsFile; } + /** + * Return the patch setting file. + * @return SettingsFile + */ + public SettingsFile getPatchSettingsFile() { + if (patchSettingsFile == null) { + patchSettingsFile = new SettingsFile(Paths.get(userSettingsFile.returnPatchSettingsFile())); + } + return patchSettingsFile; + } + public String getDefaultBuildPlatform() { return userSettingsFile.getDefaultBuildPlatform(); } @@ -104,8 +121,8 @@ public Map> getAllPatches() { return cacheStore.getAllPatches(); } - public void saveAllPatches(Map> allPatches, String location) throws IOException { - cacheStore.saveAllPatches(allPatches, location); + public void saveAllPatches(Map> allPatches) throws IOException { + cacheStore.saveAllPatches(allPatches); } public void addPatch(String bugNumber, String patchArchitecture, String patchLocation, @@ -137,7 +154,7 @@ public InstallerMetaData getInstallerForPlatform(InstallerType installerType, Ar * Return all the installers based on the configured directory for the yaml file. * @return map of installers */ - public EnumMap>> getInstallers() { + public Map>> getInstallers() { return cacheStore.getInstallers(); } @@ -180,12 +197,10 @@ public void addInstaller(InstallerType installerType, String commonName, Install /** * Save all installers. * @param allInstallers map of installers - * @param location file location * @throws IOException any error */ - public void saveAllInstallers(Map>> allInstallers, - String location) throws IOException { - cacheStore.saveAllInstallers(allInstallers, location); + public void saveAllInstallers(Map>> allInstallers) throws IOException { + cacheStore.saveAllInstallers(allInstallers); } /** @@ -200,27 +215,27 @@ public List getAruPatchForBugNumber(String bugNumber) { private InstallerMetaData createInstallerMetaData(Map objectData) { - String hash = (String) objectData.get("digest"); - String dateAdded = (String) objectData.get("added"); + String hash = (String) objectData.get(DIGEST); + String dateAdded = (String) objectData.get(DATE_ADDED); if (dateAdded == null) { dateAdded = getTodayDate(); } - String location = (String) objectData.get("location"); - String productVersion = (String) objectData.get("version"); - String platform = (String) objectData.get("platform"); + String location = (String) objectData.get(LOCATION); + String productVersion = (String) objectData.get(PRODUCT_VERSION); + String platform = (String) objectData.get(PLATFORM); return new InstallerMetaData(platform, location, hash, dateAdded, productVersion); } private PatchMetaData createPatchMetaData(Map objectData) { - String hash = (String) objectData.get("digest"); - String dateAdded = (String) objectData.get("added"); + String hash = (String) objectData.get(DIGEST); + String dateAdded = (String) objectData.get(DATE_ADDED); if (dateAdded == null) { dateAdded = getTodayDate(); } - String location = (String) objectData.get("location"); - String productVersion = (String) objectData.get("version"); - String platform = (String) objectData.get("platform"); - String description = (String) objectData.get("description"); + String location = (String) objectData.get(LOCATION); + String productVersion = (String) objectData.get(PATCH_VERSION); + String platform = (String) objectData.get(PLATFORM); + String description = (String) objectData.get(DESCRIPTION); return new PatchMetaData(platform, location, hash, dateAdded, productVersion, description); } diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/SettingsFile.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/SettingsFile.java index d1c951e6..214f4153 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/SettingsFile.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/SettingsFile.java @@ -12,9 +12,11 @@ import java.util.EnumMap; import java.util.Map; +import com.oracle.weblogic.imagetool.installer.InstallerMetaData; import com.oracle.weblogic.imagetool.installer.InstallerType; import com.oracle.weblogic.imagetool.logging.LoggingFacade; import com.oracle.weblogic.imagetool.logging.LoggingFactory; +import com.oracle.weblogic.imagetool.patch.PatchMetaData; import org.yaml.snakeyaml.DumperOptions; import org.yaml.snakeyaml.Yaml; import org.yaml.snakeyaml.introspector.Property; @@ -106,8 +108,8 @@ protected NodeTuple representJavaBeanProperty(Object javaBean, Property property representer.addClassTag(UserSettingsFile.class, Tag.MAP); representer.addClassTag(InstallerType.class, Tag.MAP); representer.addClassTag(InstallerSettings.class, Tag.MAP); - //representer.addClassTag(Map.class, Tag.MAP); - //representer.setDefaultFlowStyle(DumperOptions.FlowStyle.BLOCK); + representer.addClassTag(InstallerMetaData.class, Tag.MAP); + representer.addClassTag(PatchMetaData.class, Tag.MAP); PropertyUtils propertyUtils = new PropertyUtils(); propertyUtils.setAllowReadOnlyProperties(true); diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/YamlFileConstants.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/YamlFileConstants.java new file mode 100644 index 00000000..60f06359 --- /dev/null +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/YamlFileConstants.java @@ -0,0 +1,16 @@ +// Copyright (c) 2025, 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.settings; + +public class YamlFileConstants { + + // Do not change the values, it affect the persisted YAML file and will break compatibility + public static String DESCRIPTION = "description"; + public static String PATCH_VERSION = "patchVersion"; + public static String LOCATION = "location"; + public static String DIGEST = "digest"; + public static String PLATFORM = "platform"; + public static String PRODUCT_VERSION = "productVersion"; + public static String DATE_ADDED = "dateAdded"; +} diff --git a/imagetool/src/test/java/com/oracle/weblogic/imagetool/cachestore/CachedFileTest.java b/imagetool/src/test/java/com/oracle/weblogic/imagetool/cachestore/CachedFileTest.java index 92859a21..71c75cc0 100644 --- a/imagetool/src/test/java/com/oracle/weblogic/imagetool/cachestore/CachedFileTest.java +++ b/imagetool/src/test/java/com/oracle/weblogic/imagetool/cachestore/CachedFileTest.java @@ -102,7 +102,7 @@ private static void addPatchesToLocal(Path tempDir, ConfigManager configManager, Utils.getSha256Hash(path.toAbsolutePath().toString()),"2024-10-17", patchVersion,""); latestPatches.add(latestPatch); patches.put(bugNumber, latestPatches); - configManager.saveAllPatches(patches, patchListingFile.toAbsolutePath().toString()); + configManager.saveAllPatches(patches); } @Test diff --git a/imagetool/src/test/java/com/oracle/weblogic/imagetool/cachestore/OPatchFileTest.java b/imagetool/src/test/java/com/oracle/weblogic/imagetool/cachestore/OPatchFileTest.java index f61ce9d5..97b6c694 100644 --- a/imagetool/src/test/java/com/oracle/weblogic/imagetool/cachestore/OPatchFileTest.java +++ b/imagetool/src/test/java/com/oracle/weblogic/imagetool/cachestore/OPatchFileTest.java @@ -68,7 +68,7 @@ private static void addPatchesToLocal(Path tempDir, ConfigManager configManager, Utils.getSha256Hash(path.toAbsolutePath().toString()),"2024-10-17", patchVersion, ""); latestPatches.add(latestPatch); patches.put(bugNumber, latestPatches); - configManager.saveAllPatches(patches, patchListingFile.toAbsolutePath().toString()); + configManager.saveAllPatches(patches); } @AfterAll diff --git a/imagetool/src/test/java/com/oracle/weblogic/imagetool/cachestore/PatchFileTest.java b/imagetool/src/test/java/com/oracle/weblogic/imagetool/cachestore/PatchFileTest.java index 9ac2e6dc..47945c72 100644 --- a/imagetool/src/test/java/com/oracle/weblogic/imagetool/cachestore/PatchFileTest.java +++ b/imagetool/src/test/java/com/oracle/weblogic/imagetool/cachestore/PatchFileTest.java @@ -113,7 +113,7 @@ private static void addPatchesToLocal(Path tempDir, ConfigManager configManager, Utils.getSha256Hash(path.toAbsolutePath().toString()),"2024-10-17", patchVersion, ""); latestPatches.add(latestPatch); patches.put(bugNumber, latestPatches); - configManager.saveAllPatches(patches, patchListingFile.toAbsolutePath().toString()); + configManager.saveAllPatches(patches); } From 5a2f11ed14d58096bbaccb28a0e27bdf8c8036ba Mon Sep 17 00:00:00 2001 From: jshum Date: Tue, 24 Dec 2024 09:18:39 -0600 Subject: [PATCH 059/104] add initialization for first time user. --- .../imagetool/cachestore/CacheStore.java | 2 +- .../imagetool/settings/ConfigManager.java | 38 +++++++++++++++---- 2 files changed, 31 insertions(+), 9 deletions(-) diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cachestore/CacheStore.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cachestore/CacheStore.java index 990ca11e..9a7d7d97 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cachestore/CacheStore.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cachestore/CacheStore.java @@ -378,7 +378,7 @@ public void saveAllPatches(Map> allPatches) throws I ConfigManager configManager = ConfigManager.getInstance(); configManager.getPatchSettingsFile().save(allPatches); - + } /** diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/ConfigManager.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/ConfigManager.java index 95222815..d50a11ba 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/ConfigManager.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/ConfigManager.java @@ -7,6 +7,7 @@ import java.nio.file.Files; import java.nio.file.Path; import java.nio.file.Paths; +import java.util.Arrays; import java.util.List; import java.util.Map; @@ -51,17 +52,28 @@ private ConfigManager(Path userSettingsFileName) { * @return ConfigManager instance */ public static synchronized ConfigManager getInstance() { - if (instance == null) { - String result = System.getenv(CACHE_DIR_ENV); - if (result != null) { - if (Files.exists(Paths.get(result, "settings.yaml"))) { - return new ConfigManager(Paths.get(result, "settings.yaml")); + try { + Path file; + if (instance == null) { + String result = System.getenv(CACHE_DIR_ENV); + if (result != null) { + file = Paths.get(result, "settings.yaml"); + } else { + file = Paths.get(System.getProperty("user.home"), ".imagetool", + "settings.yaml"); } + if (!Files.exists(file)) { + Files.createDirectories(file.getParent()); + Files.createFile(file); + initImageTool(file); + } + return new ConfigManager(file); } - return new ConfigManager(Paths.get(System.getProperty("user.home"), ".imagetool", - "settings.yaml")); + return instance; + + } catch (IOException e) { + throw new IllegalArgumentException(e.getMessage()); } - return instance; } /** @@ -74,6 +86,16 @@ public static synchronized ConfigManager getInstance(Path fileName) { return instance; } + private static void initImageTool(Path file) throws IOException { + Path parentPath = file.getParent(); + Files.createFile(Paths.get(parentPath.toString(), "patches.yaml")); + Files.createFile(Paths.get(parentPath.toString(), "installer.yaml")); + String dirName = "downloaded_patches"; + Path path = Paths.get(parentPath.toString(), dirName); + List fileContents = Arrays.asList("patchDirectory: " + path.toString()); + Files.createDirectory(path); + Files.write(file, fileContents); + } public String getPatchDirectory() { return userSettingsFile.getPatchDirectory(); From 3f7c4d6744b1e90f2b280b8e8c661b103dcb1733 Mon Sep 17 00:00:00 2001 From: jshum Date: Mon, 30 Dec 2024 12:30:18 -0600 Subject: [PATCH 060/104] fix tests --- .../imagetool/cachestore/CacheStore.java | 16 +- .../weblogic/imagetool/cli/ImageTool.java | 1 - .../imagetool/settings/UserSettingsFile.java | 10 +- .../resources/settings/basic_settings.yaml | 6 +- .../weblogic/imagetool/tests/ITImagetool.java | 177 +++++++++++------- .../imagetool/tests/utils/CacheCommand.java | 14 +- 6 files changed, 138 insertions(+), 86 deletions(-) diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cachestore/CacheStore.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cachestore/CacheStore.java index 9a7d7d97..4af318a9 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cachestore/CacheStore.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cachestore/CacheStore.java @@ -137,12 +137,13 @@ public void addInstaller(InstallerType installerType, String commonName, Install Map>> installerDetails = getInstallers(); Map> installerMetaDataMap; List installerMetaDataList; + String installerKey = installerType.toString().toUpperCase(); - if (installerDetails.containsKey(installerType)) { - installerMetaDataMap = installerDetails.get(installerType); + if (installerDetails.containsKey(installerKey)) { + installerMetaDataMap = installerDetails.get(installerKey); } else { - installerDetails.put(installerType.toString(), new HashMap<>()); - installerMetaDataMap = installerDetails.get(installerType); + installerDetails.put(installerKey, new HashMap<>()); + installerMetaDataMap = installerDetails.get(installerKey); } if (installerMetaDataMap.containsKey(commonName)) { @@ -158,7 +159,7 @@ public void addInstaller(InstallerType installerType, String commonName, Install installerMetaDataList.add(metaData); } // Update the list - installerDetails.put(installerType.toString(), installerMetaDataMap); + installerDetails.put(installerKey, installerMetaDataMap); saveAllInstallers(installerDetails); } @@ -172,12 +173,15 @@ public void addInstaller(InstallerType installerType, String commonName, Install public InstallerMetaData getInstallerForPlatform(InstallerType installerType, Architecture platformName, String installerVersion) { + if (platformName == null) { platformName = Architecture.GENERIC; } if (installerType == null) { installerType = InstallerType.WLS; } + String installerKey = installerType.toString().toUpperCase(); + if (installerVersion == null) { switch (installerType) { case WLS: @@ -197,7 +201,7 @@ public InstallerMetaData getInstallerForPlatform(InstallerType installerType, Ar + installerType.toString())); } } - Map> installers = getInstallers().get(installerType); + Map> installers = getInstallers().get(installerKey); if (installers != null && !installers.isEmpty()) { List installerMetaDataList = installers.get(installerVersion); if (installerMetaDataList != null && !installerMetaDataList.isEmpty()) { diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/ImageTool.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/ImageTool.java index e99e43f2..87623cd7 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/ImageTool.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/ImageTool.java @@ -34,7 +34,6 @@ CreateImage.class, CreateAuxImage.class, UpdateImage.class, - RebaseImage.class, InspectImage.class }, requiredOptionMarker = '*', diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/UserSettingsFile.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/UserSettingsFile.java index 39e76cba..78f6e5f3 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/UserSettingsFile.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/UserSettingsFile.java @@ -232,12 +232,12 @@ private void setDefaultVersion(String value, InstallerType type) { Map installerSettingsMap = new HashMap<>(); installerSettingsMap.put("defaultVersion", value); InstallerSettings versionSettings = new InstallerSettings(installerSettingsMap); - installerSettings.put(type.toString(), versionSettings); + installerSettings.put(type.toString().toUpperCase(), versionSettings); } // Do not use getXXX Snake Yaml will add separate entry in the serialized yaml file public String returnDefaultWLSVersion() { - return Optional.ofNullable(installerSettings.get(InstallerType.WLS.toString())) + return Optional.ofNullable(installerSettings.get(InstallerType.WLS.toString().toUpperCase())) .map(InstallerSettings::getDefaultVersion).orElse(null); } @@ -246,7 +246,7 @@ public void setDefaultWDTVersion(String value) { } public String returnDefaultWDTVersion() { - return Optional.ofNullable(installerSettings.get(InstallerType.WDT.toString())) + return Optional.ofNullable(installerSettings.get(InstallerType.WDT.toString().toUpperCase())) .map(InstallerSettings::getDefaultVersion).orElse(null); } @@ -255,7 +255,7 @@ public void setDefaultJDKVersion(String value) { } public String returnDefaultJDKVersion() { - return Optional.ofNullable(installerSettings.get(InstallerType.JDK.toString())) + return Optional.ofNullable(installerSettings.get(InstallerType.JDK.toString().toUpperCase())) .map(InstallerSettings::getDefaultVersion).orElse(null); } @@ -268,7 +268,7 @@ public InstallerSettings getInstallerSettings(InstallerType installerType) { if (installerSettings == null) { return null; } - return installerSettings.get(installerType.toString()); + return installerSettings.get(installerType.toString().toUpperCase()); } public Map getInstallerSettings() { diff --git a/imagetool/src/test/resources/settings/basic_settings.yaml b/imagetool/src/test/resources/settings/basic_settings.yaml index 0343f519..5e829275 100644 --- a/imagetool/src/test/resources/settings/basic_settings.yaml +++ b/imagetool/src/test/resources/settings/basic_settings.yaml @@ -2,9 +2,9 @@ aruRetryInterval: 200 buildContextDirectory: ./builds patchDirectory: /home/user/patches installers: - jdk: + JDK: defaultVersion: 8u241 - wls: + WLS: defaultVersion: 12.2.1.4.0 - wdt: + WDT: defaultVersion: latest diff --git a/tests/src/test/java/com/oracle/weblogic/imagetool/tests/ITImagetool.java b/tests/src/test/java/com/oracle/weblogic/imagetool/tests/ITImagetool.java index 7b9b4926..c42b7cd2 100644 --- a/tests/src/test/java/com/oracle/weblogic/imagetool/tests/ITImagetool.java +++ b/tests/src/test/java/com/oracle/weblogic/imagetool/tests/ITImagetool.java @@ -42,6 +42,7 @@ import static com.oracle.weblogic.imagetool.cachestore.CacheStore.CACHE_DIR_ENV; 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.Assumptions.assumeTrue; @@ -483,67 +484,113 @@ void cacheAddPatch(TestInfo testInfo) throws Exception { } } - ///** - // * add an entry to the cache. - // * - // * @throws Exception - if any error occurs - // */ - //@Test - //@Order(4) - //@Tag("gate") - //@DisplayName("Add manual entry to cache") - //void cacheAddTestEntry(TestInfo testInfo) throws Exception { - // Path testEntryValue = Paths.get(STAGING_DIR, P27342434_INSTALLER); - // String command = new CacheCommand() - // .addEntry(true) - // .key(TEST_ENTRY_KEY) - // .value(testEntryValue) - // .build(); - // - // try (PrintWriter out = getTestMethodWriter(testInfo)) { - // CommandResult addEntryResult = Runner.run(command, out, logger); - // assertEquals(0, addEntryResult.exitValue(), "for command: " + command); - // - // // verify the result - // String listCommand = new CacheCommand().listItems(true).build(); - // CommandResult listResult = Runner.run(listCommand, out, logger); - // // the process return code for listItems should be 0 - // assertEquals(0, listResult.exitValue(), "for command: " + listCommand); - // // output should show newly added patch - // assertTrue(listResult.stdout().contains(TEST_ENTRY_KEY.toLowerCase() + "=" + testEntryValue)); - // // cache should also contain the installer that was added in the previous test (persistent cache) - // assertTrue(listResult.stdout().contains(P27342434_ID + "_" + WLS_VERSION + "=")); - // } - //} - // - ///** - // * test delete an entry from the cache. - // * - // * @throws Exception - if any error occurs - // */ - //@Test - //@Order(5) - //@Tag("gate") - //@DisplayName("Delete cache entry") - //void cacheDeleteTestEntry(TestInfo testInfo) throws Exception { - // String command = new CacheCommand() - // .deleteEntry(true) - // .key(TEST_ENTRY_KEY) - // .build(); - // - // try (PrintWriter out = getTestMethodWriter(testInfo)) { - // CommandResult result = Runner.run(command, out, logger); - // assertEquals(0, result.exitValue(), "for command: " + command); - // - // // verify the result - // String listCommand = new CacheCommand().listItems(true).build(); - // CommandResult listResult = Runner.run(listCommand, out, logger); - // // the process return code for listItems should be 0 - // assertEquals(0, listResult.exitValue(), "for command: " + listCommand); - // // output should NOT show deleted patch - // assertFalse(listResult.stdout().contains(TEST_ENTRY_KEY.toLowerCase())); - // } - //} + /** + * delete a patch from the cache. + * + * @throws Exception - if any error occurs + */ + @Test + @Order(4) + @Tag("gate") + @DisplayName("Delete a patch from cache") + void deletePatchTest(TestInfo testInfo) throws Exception { + Path patchPath = Paths.get(STAGING_DIR, P27342434_INSTALLER); + + String testPatchID = "27342430"; + String command = new CacheCommand() + .addPatch(true) + .path(patchPath) + .patchId(testPatchID) + .version(WLS_VERSION) + .architecture(GENERIC) + .build(); + + try (PrintWriter out = getTestMethodWriter(testInfo)) { + CommandResult result = Runner.run(command, out, logger); + // the process return code for addPatch should be 0 + assertEquals(0, result.exitValue(), "for command: " + command); + + // verify the result + String listCommand = new CacheCommand().listPatches(true).patchId(testPatchID).build(); + CommandResult listResult = Runner.run(listCommand, out, logger); + // the process return code for listItems should be 0 + assertEquals(0, listResult.exitValue(), "for command: " + listCommand); + // output should show newly added patch + assertTrue(listResult.stdout().contains(testPatchID)); + assertTrue(listResult.stdout().contains(WLS_VERSION)); + assertTrue(listResult.stdout().contains(patchPath.toString())); + } + + command = new CacheCommand() + .deletePatch(true) + .patchId(testPatchID) + .version(WLS_VERSION) + .architecture(GENERIC) + .build(); + + try (PrintWriter out = getTestMethodWriter(testInfo)) { + CommandResult result = Runner.run(command, out, logger); + assertEquals(0, result.exitValue(), "for command: " + command); + + // verify the result + String listCommand = new CacheCommand().listPatches(true).patchId(testPatchID).build(); + CommandResult listResult = Runner.run(listCommand, out, logger); + // the process return code for listItems should be 0 + assertEquals(0, listResult.exitValue(), "for command: " + listCommand); + // output should show newly added patch + assertFalse(listResult.stdout().contains(testPatchID)); + assertFalse(listResult.stdout().contains(WLS_VERSION)); + assertFalse(listResult.stdout().contains(patchPath.toString())); + } + } + + /** + * test delete an installer. + * + * @throws Exception - if any error occurs + */ + @Test + @Order(5) + @Tag("gate") + @DisplayName("Delete installer") + void deleteInstaller(TestInfo testInfo) throws Exception { + + String wdtVersion = "testonly"; + Path wdtPath = Paths.get(STAGING_DIR, WDT_INSTALLER); + String addCommand = new CacheCommand() + .addInstaller(true) + .type("WDT") + .version(wdtVersion) + .path(wdtPath) + .architecture(GENERIC) + .build(); + + try (PrintWriter out = getTestMethodWriter(testInfo)) { + CommandResult addResult = Runner.run(addCommand, out, logger); + // the process return code for addInstaller should be 0 + assertEquals(0, addResult.exitValue(), "for command: " + addCommand); + } + + String deleteCommand = new CacheCommand() + .deleteInstaller(true) + .architecture(GENERIC) + .type("WDT") + .version(wdtVersion) + .build(); + + try (PrintWriter out = getTestMethodWriter(testInfo)) { + CommandResult result = Runner.run(deleteCommand, out, logger); + assertEquals(0, result.exitValue(), "for command: " + deleteCommand); + + // verify the result + String listCommand = new CacheCommand().listInstallers(true).type("WDT").build(); + CommandResult listResult = Runner.run(listCommand, out, logger); + // the process return code for listItems should be 0 + assertEquals(0, listResult.exitValue(), "for command: " + listCommand); + // output should NOT show deleted installer + assertFalse(listResult.stdout().contains(wdtVersion.toLowerCase())); + } + } /** * Test manual caching of a patch JAR. @@ -741,10 +788,10 @@ void createWlsImgUsingWdt(TestInfo testInfo) throws Exception { * * @throws Exception - if any error occurs */ - @Test - @Order(13) - @Tag("gate") - @DisplayName("Rebase the WLS domain") + //@Test + //@Order(13) + //@Tag("gate") + //@DisplayName("Rebase the WLS domain") void rebaseWlsImg(TestInfo testInfo) throws Exception { assumeTrue(wlsImgBuilt); assumeTrue(domainImgBuilt); diff --git a/tests/src/test/java/com/oracle/weblogic/imagetool/tests/utils/CacheCommand.java b/tests/src/test/java/com/oracle/weblogic/imagetool/tests/utils/CacheCommand.java index 3ed97cd2..40b84b1c 100644 --- a/tests/src/test/java/com/oracle/weblogic/imagetool/tests/utils/CacheCommand.java +++ b/tests/src/test/java/com/oracle/weblogic/imagetool/tests/utils/CacheCommand.java @@ -16,8 +16,8 @@ public class CacheCommand extends ImageToolCommand { private boolean addPatch; private boolean listInstallers; private boolean listPatches; - private boolean addEntry; - private boolean deleteEntry; + private boolean deletePatch; + private boolean deleteInstaller; private String path; private String patchId; private String key; @@ -53,14 +53,14 @@ public CacheCommand listPatches(boolean value) { return this; } - public CacheCommand addEntry(boolean value) { - addEntry = value; + public CacheCommand deletePatch(boolean value) { + deletePatch = value; return this; } - public CacheCommand deleteEntry(boolean value) { - deleteEntry = value; + public CacheCommand deleteInstaller(boolean value) { + deleteInstaller = value; return this; } @@ -117,6 +117,8 @@ public String build() { return super.build() + field("addInstaller", addInstaller) + field("addPatch", addPatch) + + field("deleteInstaller", deleteInstaller) + + field("deletePatch", deletePatch) + field("listPatches", listPatches) + field("listInstallers", listInstallers) + field("--commonName", commonName) From 9e16bed6db85c528458b10c61f78c49e5ba9078e Mon Sep 17 00:00:00 2001 From: jshum Date: Mon, 30 Dec 2024 15:32:41 -0600 Subject: [PATCH 061/104] Refactor and first doc update --- .../site/content/quickstart/quickstart.md | 35 ++-- .../site/content/userguide/tools/cache.md | 134 ++++++++++++--- .../userguide/tools/create-aux-image.md | 1 + .../content/userguide/tools/create-image.md | 1 + .../content/userguide/tools/rebase-image.md | 159 ------------------ .../imagetool/cachestore/CacheStore.java | 20 +-- .../weblogic/imagetool/cli/ImageTool.java | 1 - .../imagetool/cli/cache/DeleteInstaller.java | 4 +- .../imagetool/cli/cache/DeletePatch.java | 4 +- .../imagetool/cli/cache/ListInstallers.java | 2 +- .../imagetool/cli/cache/ListPatches.java | 2 +- .../imagetool/cli/menu/RebaseImage.java | 142 ---------------- .../installer/InstallerMetaData.java | 25 +-- .../imagetool/patch/PatchMetaData.java | 31 ++-- .../imagetool/settings/ConfigManager.java | 6 +- .../imagetool/settings/YamlFileConstants.java | 8 +- 16 files changed, 188 insertions(+), 387 deletions(-) delete mode 100644 documentation/site/content/userguide/tools/rebase-image.md delete mode 100644 imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/RebaseImage.java diff --git a/documentation/site/content/quickstart/quickstart.md b/documentation/site/content/quickstart/quickstart.md index 94086fb2..4501f03d 100644 --- a/documentation/site/content/quickstart/quickstart.md +++ b/documentation/site/content/quickstart/quickstart.md @@ -24,35 +24,46 @@ The high level steps for creating an image are: and save them in a directory of your choice, for example, `/home/acmeuser/wls-installers`: `fmw_12.2.1.3.0_wls_Disk1_1of1.zip`\ - `jdk-8u202-linux-x64.tar.gz` + `jdk-8u231-linux-x64.tar.gz` 2. Use the [Cache Tool]({{< relref "/userguide/tools/cache.md" >}}) to add the installers: ```bash - $ imagetool cache addInstaller --type jdk --version 8u202 --path /home/acmeuser/wls-installers/jdk-8u202-linux-x64.tar.gz + $ imagetool cache addInstaller --type jdk --version 8u231 --path /home/acmeuser/wls-installers/jdk-8u231-linux-x64.tar.gz --architecture AMD64 ``` ```bash - $ imagetool cache addInstaller --type wls --version 12.2.1.3.0 --path /home/acmeuser/wls-installers/fmw_12.2.1.3.0_wls_Disk1_1of1.zip + $ imagetool cache addInstaller --type wls --version 12.2.1.3.0 --path /home/acmeuser/wls-installers/fmw_12.2.1.3.0_wls_Disk1_1of1.zip --architecture AMD64 ``` You can verify the cache entries by: ```bash - $ imagetool cache listItems + $ imagetool cache listInstallers ``` ```bash - Cache contents - jdk_8u202=/home/acmeuser/wls-installers/jdk-8u202-linux-x64.tar.gz - wls_12.2.1.3.0=/home/acmeuser/wls-installers/fmw_12.2.1.3.0_wls_Disk1_1of1.zip + JDK: + 8u231: + - location: /home/acmeuser/wls-installers/jdk-8u231-linux-x64.tar.gz + platform: linux/amd64 + digest: A011584A2C9378BF70C6903EF5FBF101B30B08937441DC2EC67932FB3620B2CF + dateAdded: 2024-12-30 + version: 8u231 + WLS: + 12.2.1.3.0: + - location: /home/acmeuser/wls-installers/fmw_12.2.1.3.0_wls_Disk1_1of1.zip + platform: linux/amd64 + digest: CBFD847E7F8993E199C30003BCB226BA2451911747099ADC33EA5CEA2C35E0BC + dateAdded: 2024-12-30 + version: 12.2.1.3.0 ``` 3. Run the [`imagetool create`]({{< relref "/userguide/tools/create-image.md" >}}) command: ```bash - $ imagetool create --tag wls:12.2.1.3.0 + $ imagetool create --tag wls:12.2.1.3.0 --version 12.2.1.3.0 --platform linux/amd64 ``` The final image will have the following structure: @@ -60,8 +71,8 @@ The final image will have the following structure: ```bash [oracle@c3fe8ee0167d oracle]$ ls -arlt /u01/ total 20 -drwxr-xr-x 7 oracle oracle 4096 May 28 23:40 jdk -drwxr-xr-x 11 oracle oracle 4096 May 28 23:40 oracle -drwxr-xr-x 5 oracle oracle 4096 May 28 23:40 . -drwxr-xr-x 18 root root 4096 May 29 01:31 .. +drwxr-xr-x 7 oracle oracle 4096 Jan 28 23:40 jdk +drwxr-xr-x 11 oracle oracle 4096 Jan 28 23:40 oracle +drwxr-xr-x 5 oracle oracle 4096 Jan 28 23:40 . +drwxr-xr-x 18 root root 4096 Jan 29 01:31 .. ``` diff --git a/documentation/site/content/userguide/tools/cache.md b/documentation/site/content/userguide/tools/cache.md index 62fd8717..a68c5639 100644 --- a/documentation/site/content/userguide/tools/cache.md +++ b/documentation/site/content/userguide/tools/cache.md @@ -1,6 +1,6 @@ --- title: "Cache" -date: 2019-02-23 +date: 2024-12-23 draft: false weight: 20 description: "The Image Tool maintains metadata on the local file system for patches and installers. You can use the cache command to manipulate the local metadata." @@ -8,9 +8,23 @@ description: "The Image Tool maintains metadata on the local file system for pat The Image Tool maintains a local file cache store. This store is used to look up where the Java, WebLogic Server installers, and WebLogic Server patches reside in the local file system. -By default, the cache store is located in the user's ```$HOME/cache``` directory. Under this directory, the lookup information is stored in the ```.metadata``` file. All automatically downloaded patches also reside in this directory. +By default, the cache store is located in the user's ```$HOME/.imagetool``` directory. Under this directory, the lookup information is stored in the ```.metadata``` file. All automatically downloaded patches also reside in this directory. -You can change the default cache store location by setting the environment variable `WLSIMG_CACHEDIR`: +In this release, there is a `settings.yaml` in the cache directory. This file controls the default settings of image tool. For example: + +```bash +defaultBuildPlatform: linux/arm64 +installerSettings: + JDK: {defaultVersion: 8u401} + WDT: {defaultVersion: latest} + WLS: {defaultVersion: 12.2.1.4.0} +patchDirectory: /home/acmeuser/.imagetool/oraclePatches +``` + +The installers and patches details are stored separately into two different files. `installers.yaml` and `patches.yaml`. By default these two files are stored in the same +directory of `settings.yaml`. + +You can change the default cache store location by setting the environment variable `WLSIMG_CACHEDIR`: ?? TODO ```bash $ export WLSIMG_CACHEDIR="/path/to/cachedir" @@ -25,36 +39,109 @@ List and set cache options | Option | Description | | --- | --- | -|`listItems`| List cache contents. | +|`listInstallers`| List cache installers. | +|`listPatches`| List cache patches. | |`addInstaller` | Add an installer to the cache. | | `addPatch` | Add a patch to the cache. | -| `addEntry` | Add a cache entry. Use with caution. | +| `deletePatch` | Delete a patch from the cache. | +| `deleteInstaller` | Delete an installer to the cache. | | `help` | Display help information for the specified command.| ### Usage scenarios -- `listItems`: Display the contents of the cache. Displays key value pairs of the installers and patches. - ``` - imagetool cache listItems - - Cache contents - jdk_8u202=/home/acmeuser/Downloads/cache/server-jre-8u202-linux-x64.tar.gz - wls_12.2.1.3.0=/home/acmeuser/Downloads/cache/fmw_12.2.1.3.0_wls_Disk1_1of1.zip - 28186730_opatch=/home/acmeuser/cache/p28186730_139400_Generic.zip - 29135930_12.2.1.3.190416=/home/acmeuser/cache/p29135930_12213190416_Generic.zip - 29135930_12.2.1.3.0=/home/acmeuser/cache/p29135930_122130_Generic.zip - cache.dir=/home/acemeuser/cache - ``` +- `listInstallers`: Display the contents of the cache. Displays key value pairs of the installers and patches. +``` +imagetool.sh cache listInstallers +JDK: + 8u401: + - location: /home/acmeuser/Downloads/jdk-8u401-fcs-bin-b10-linux-aarch64-19_dec_2023.tar.gz + platform: linux/arm64 + digest: 811af9aa1ce2eaa902c7923ea1a5b7012bddb787df0805aded5f3663b210aa47 + dateAdded: 2024-12-30 + version: 8.0.401 + - location: /home/acmeuser/Downloads/jdk-8u401-linux-x64.tar.gz + platform: linux/amd64 + digest: 19684fccd7ff32a8400e952a643f0049449a772ef63b8037d5b917cbd137d173 + dateAdded: 2024-12-30 + version: 8.0.401 + 11u22: + - location: /home/acmeuser/Downloads/jdk-11.0.22_linux-aarch64_bin.tar.gz + platform: linux/arm64 + digest: 97ee39f2a39ab9612a06b0d56882571f701cad082b7cf169b5cfdee174aec7eb + dateAdded: 2024-12-30 + version: 11.0.22 + - location: /home/acmeuser/Downloads/jdk-11.0.22_linux-x64_bin.tar.gz + platform: linux/amd64 + digest: f9eaf0f224fac4ff26f146089181a155d547ebcf2e033cf4cc850efa228086ba + dateAdded: 2024-12-30 + version: 11.0.22 +WLS: + 12.2.1.4.0: + - location: /home/acmeuser/Downloads/fmw_12.2.1.4.0_wls_generic_ARM_OCI.zip + platform: linux/arm64 + digest: 2630e4e3d6c8998da8aa97ff6ff4a4a44f95a568de8cf9de01dcd47b753ff324 + dateAdded: 2024-12-30 + version: 12.2.1.4.0 + - location: /home/acmeuser/Downloads/fmw_12.2.1.4.0_wls_lite_Disk1_1of1.zip + platform: linux/amd64 + digest: 4b3a2264875ce4d56cf6c4c70fc2e5895db1f5cbc39eb5d4e28e46bfa65d2671 + dateAdded: 2024-12-30 + version: 12.2.1.4.0 + 14.1.1.0.0: + - location: /home/acmeuser/Downloads/fmw14110.zip + platform: linux/arm64 + digest: 5b09f15b1d5ecb89c7f399160b9d7ee1586177cdf06372826770293b3e22132c + dateAdded: 2024-12-30 + version: 14.1.1.0.0 + - location: /home/acmeuser/Downloads/fmw_14.1.1.0.0_wls_lite_Disk1_1of1.zip + platform: linux/amd64 + digest: 9e9fe0264e38c34ccaef47a262474aa94bf169af0d06b202f2630eaae648ae09 + dateAdded: 2024-12-30 + version: 14.1.1.0.0 +``` + +- `listPatches`: List all the patches. + +```bash + +imagetool.sh cache listPatches + +36805124: + - location: /home/acmeuser/Downloads/oraclePatches/p36805124_122140_Generic.zip + platform: linux/amd64 + digest: null + dateAdded: 2024-11-18 + version: 12.2.1.4.0 + - location: /home/acmeuser/Downloads/oraclePatches/p36805124_122140_Generic.zip + platform: generic + digest: null + dateAdded: 2024-11-18 + version: 12.2.1.4.0.180516 +28186730: + - location: /home/acmeuser/Downloads/cache/p28186730_1394216_Generic.zip + platform: generic + digest: null + dateAdded: 2024-11-18 + version: 13.9.4.2.16 + - location: /home/acmeuser/Downloads/oraclePatches/p28186730_1394217_Generic.zip + platform: generic + digest: null + dateAdded: 2024-11-18 + version: 13.9.4.2.17 + + +``` + - `addInstaller`: Add an installer to the cache, for example, JDK. ```bash - $ imagetool 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 --architecture AMD64 ``` - `addPatch`: Add a patch to the cache. ```bash - $ imagetool cache addPatch --patchId 12345678_12.2.1.3.0 --path /path/to/patch.zip + $ imagetool cache addPatch --patchId 12345678_12.2.1.3.0 --path /path/to/patch.zip --architecture AMD64 ``` **Note**: When adding a patch to the cache store, the `patchId` should be in the following format: `99999999_9.9.9.9.99999` The first 8 digits is the patch ID, followed by an underscore, and then the release number to identify the patch between different patch versions. @@ -68,12 +155,13 @@ List and set cache options If you downloaded the release version ```12.2.1.3.190416``` of the patch, then you should use the argument ```--patchId 29135930_12.2.1.3.190416```. -- `addEntry`: Consider this an expert mode where you can add key value pairs to the cache without any validation. + +- `deleteInstaller`: Delete an installer from the cache for a given key. **Note**: This command does not delete files from the disk. ```bash - $ imagetool cache addEntry --key xyz_123 --value /path/to/file + $ imagetool cache deleteInstaller --version 14.1.1.0.0 --architecture ARM64 ``` -- `deleteEntry`: Delete an entry from the cache for a given key. **Note**: This command does not delete files from the disk. +- `deletePatch`: Delete a patch from the cache for a given key. **Note**: This command does not delete files from the disk. ```bash - $ imagetool cache deleteEntry --key xyz_123 + $ imagetool cache deletePatch --patchId 12345678 --version 14.1.1.0.0 --architecture ARM64 ``` diff --git a/documentation/site/content/userguide/tools/create-aux-image.md b/documentation/site/content/userguide/tools/create-aux-image.md index abe6c8b2..5c6f5f0a 100644 --- a/documentation/site/content/userguide/tools/create-aux-image.md +++ b/documentation/site/content/userguide/tools/create-aux-image.md @@ -42,6 +42,7 @@ Usage: imagetool createAuxImage [OPTIONS] | `--wdtModelHome` | The target location in the image to copy WDT model, variable, and archive files. | `{wdtHome}/models` | | `--wdtVariables` | A WDT variables file or comma-separated list of files. | | | `--wdtVersion` | WDT version to be installed in the container image in `{wdtHome}/weblogic-deploy`. For more details, see [Additional information](#--wdtversion). | `latest` | +| `--platform` | Comma separated list (no space between) of target platforms for the image: linux/amd64 or linux/arm64| ### Additional information diff --git a/documentation/site/content/userguide/tools/create-image.md b/documentation/site/content/userguide/tools/create-image.md index 68a1f5ae..392a2f22 100644 --- a/documentation/site/content/userguide/tools/create-image.md +++ b/documentation/site/content/userguide/tools/create-image.md @@ -65,6 +65,7 @@ Usage: imagetool create [OPTIONS] | `--wdtStrictValidation` | Use strict validation for the WDT validation method. Only applies when using model only. | `false` | | `--wdtVariables` | A WDT variables file or comma-separated list of files. | | | `--wdtVersion` | WDT version to use. | `latest` | +| `--platform` | Comma separated list (no space between) of target platforms for the image: linux/amd64 or linux/arm64| ### Additional information diff --git a/documentation/site/content/userguide/tools/rebase-image.md b/documentation/site/content/userguide/tools/rebase-image.md deleted file mode 100644 index 25f7fd54..00000000 --- a/documentation/site/content/userguide/tools/rebase-image.md +++ /dev/null @@ -1,159 +0,0 @@ ---- -title: "Rebase Image" -date: 2024-04-11 -draft: false -weight: 3 -description: "The rebase command creates a new container image using an existing WebLogic domain from an existing image." ---- - - -The `rebase` command creates a new container image and copies an existing WebLogic domain to that new image. -The new container image can be based on an existing image in the repository or created as part of the rebase operation -similar to the `create` command. - -``` -Usage: imagetool rebase [OPTIONS] -``` - -| Parameter | Definition | Default | -| --- | --- | --- | -| `--sourceImage` | (Required) Source Image containing the WebLogic domain. | | -| `--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. | Defaults to `docker`, or, when set, to the value in environment variable `WLSIMG_BUILDER`. | -| `--buildNetwork` | Networking mode for the RUN instructions during the image build. See `--network` for Docker `build`. | | -| `--chown` | `userid:groupid` to be used for creating files within the image, such as the JDK, the FMW/WLS installs, etc. If the user or group does not exist in the image, they will be added with useradd/groupadd. | `oracle:oracle` | -| `--dryRun` | Skip Docker build execution and print the Dockerfile to stdout. | | -| `--fromImage` | Container image to use as a base image when creating a new image. | `ghcr.io/oracle/oraclelinux:8-slim` | -| `--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` | | -| `--installerResponseFile` | One or more custom response files. A comma separated list of paths to installer response files. Overrides the default responses for the Oracle silent installer. | | -| `--inventoryPointerFile` | Path to custom inventory pointer file. | | -| `--inventoryPointerInstallLoc` | Target location for the inventory pointer file. | | -| `--jdkVersion` | Version of the server JDK to install. | `8u202` | -| `--latestPSU` | Find and apply the latest PatchSet Update. | | -| `--opatchBugNumber` | The patch number for OPatch (patching OPatch). | `28186730` | -| `--packageManager` | Override the default package manager for the base image's operating system. Supported values: `APK`, `APTGET`, `NONE`, `OS_DEFAULT`, `YUM`, `ZYPPER` | `OS_DEFAULT` | -| `--password` | Request password for the Oracle Support `--user` on STDIN, see `--user`. | | -| `--passwordEnv` | Environment variable containing the Oracle Support password, see `--user`. | | -| `--passwordFile` | Path to a file containing just the Oracle Support password, see `--user`. | | -| `--patches` | Comma separated list of patch IDs. Example: `12345678,87654321` | | -| `--platform` | Set the target platform to build. Supported values: `linux/amd64` or `linux/arm64`. | | -| `--pull` | Always attempt to pull a newer version of base images during the build. | | -| `--recommendedPatches` | Find and apply the latest PatchSet Update and recommended patches. This takes precedence over `--latestPSU`. | | -| `--skipcleanup` | Do not delete the build context folder, intermediate images, and failed build containers. For debugging purposes. | | -| `--strictPatchOrdering` | Instruct OPatch to apply patches one at a time (uses `apply` instead of `napply`). | | -| `--target` | Select the target environment in which the created image will be used. Supported values: `Default` (Docker/Kubernetes), `OpenShift`. See [Additional information](#--target). | `Default` | -| `--targetImage` | Container image to extend for the domain's new image. | | -| `--type` | Installer type. Supported values: `WLS`, `WLSDEV`, `WLSSLIM`, `FMW`, `IDM`, `MFT`, `OAM`, `ODI`, `OHS`, `OIG`, `OUD`, `OUD_WLS`, `OID`, `OSB`, `SOA`, `SOA_OSB`, `SOA_OSB_B2B`, `WCC`, `WCP`, `WCS` | `WLS` | -| `--user` | Your Oracle support email ID. When supplying `user`, you must supply the password either as an environment variable using `--passwordEnv`, or as a file using `--passwordFile`, or interactively, on the command line with `--password`. | | -| `--version` | Installer version. | `12.2.1.3.0` | - -### Additional information - -#### `--additionalBuildCommands` - -This is an advanced option that let's you provide additional commands to the Docker build step. -The input for this parameter is a simple text file that contains one or more of the valid sections. Valid sections for rebase: - -| Section | Available Variables | Build Stage | Timing | -| --- | --- | --- | --- | -| `initial-build-commands` | None | All | As root, and before any Image Tool actions. | -| `before-jdk-install` | `JAVA_HOME` `DOMAIN_HOME`| Intermediate (JDK_BUILD) | Before the JDK is installed. | -| `after-jdk-install` | `JAVA_HOME` `DOMAIN_HOME` | Intermediate (JDK_BUILD) | After the JDK is installed. | -| `before-fmw-install` | `JAVA_HOME` `ORACLE_HOME` `DOMAIN_HOME` | Intermediate (WLS_BUILD) | Before the Oracle Home is created. | -| `after-fmw-install` | `JAVA_HOME` `ORACLE_HOME` `DOMAIN_HOME` | Intermediate (WLS_BUILD) | After all of the Oracle middleware installers are finished. | -| `final-build-commands` | `JAVA_HOME` `ORACLE_HOME` `DOMAIN_HOME` | Final image | After all Image Tool actions are complete, and just before the container image is finalized. | - -**NOTE**: Changes made in intermediate stages may not be carried forward to the final image unless copied manually. -The Image Tool will copy the Java Home and the Oracle Home directories to the final image. -Changes fully contained within these directories do not need an additional `COPY` command in the `final-build-commands` section. -Each section can contain one or more valid Dockerfile commands and would look like the following: - -```dockerfile -[after-fmw-install] -RUN rm /some/dir/unnecessary-file -COPY --chown=oracle:oracle files/my_additional_file.txt /u01 - -[final-build-commands] -LABEL owner="middleware team" -``` - -#### `--additionalBuildFiles` - -This option provides a way to supply additional files to the image build command. -All provided files and directories are copied directly under the `files` subfolder of the build context. -To get those files into the image, additional build commands must be provided using the `additionalBuildCommands` options. -Access to these files using a build command, such as `COPY` or `ADD`, should use the original filename -with the folder prefix, `files/`. For example, if the -original file was provided as `--additionalBuildFiles /scratch/test1/convenience.sh`, the Docker build command `COPY` -provided in `--additionalBuildCommands` should look like -`COPY --chown=oracle:oracle files/convenience.sh /my/internal/image/location`. -Because Image Tool uses multi-stage -builds, it is important to place the build command (like `COPY`) in the appropriate section of the `Dockerfile` based -on when the build needs access to the file. For example, if the file is needed in the final image and not for -installation or domain creation steps, use the `final-build-commands` section so that the `COPY` command occurs in the -final stage of the image build. Or, if the file needs to change the Oracle Home prior to domain creation, use -the `after-fmw-install` or `before-wdt-command` sections. - -#### `--target` - -By default, the generated WLS domain in your image will use the best practices defined by Oracle WebLogic Server. -The `target` option allows you to toggle the defaults so that the generated domain is easier to use in the target -environment. For example, the `--target OpenShift` option will change the file permissions in the domain directory -so that the group permissions match the user permissions. - -| Target | Default File Permissions | Default File Ownership | -| --- | --- | --- | -| `Default` | `rwxr-x---` | `oracle:oracle` | -| `OpenShift` | `rwxrwx---` | `oracle:root` | - -#### Use an argument file - -You can save all arguments passed for the Image Tool in a file, then use the file as a parameter. - -For example, create a file called `build_args`: - -```bash -rebase ---tag wls:122140 ---sourceImage wls:122130 ---version 12.2.1.4.0 ---jdkVersion 8u221 -``` - -Use it on the command line, as follows: - -```bash -$ imagetool @/path/to/build_args -``` - - -### Usage scenarios - -**Note**: Use `--passwordEnv` or `--passwordFile` instead of `--password`. - -The commands below assume that all the required JDK, WLS, or FMW (WebLogic infrastructure) installers have been downloaded - to the cache directory. Use the [cache]({{< relref "/userguide/tools/cache.md" >}}) command to set it up. - - -- Update the JDK for an existing domain. Copy the existing domain from `sample:v1` where the JDK was 8u202 to a new -image called `sample:v2` and install the newer JDK 8u221 with WebLogic Server 12.2.1.3.0. - ```bash - $ imagetool rebase --tag sample:v2 --sourceImage sample:v1 --version 12.2.1.3.0 --jdkVersion 8u221 - ``` - -- Update the Oracle Home for an existing domain with a newer WebLogic version. Copy a domain from an existing image to -a new image with a new install of WebLogic Server 12.2.1.4.0. Copy the domain -from `sample:v1` and select the desired WebLogic installer using the `--version` argument. - ```bash - $ imagetool rebase --tag sample:v2 --sourceImage sample:v1 --version 12.2.1.4.0 --jdkVersion 8u221 - ``` - -- Update the JDK and/or Oracle Home for an existing domain using another image with pre-installed binaries. -Copy the domain from the source image named `sample:v1` to a new image called `sample:v2` based on a target image -named `fmw:12214`. **Note**: The Oracle Home and JDK must be installed in the same same folders on each image. - ```bash - $ imagetool rebase --tag sample:v2 --sourceImage sample:v1 --targetImage fmw:12214 - ``` diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cachestore/CacheStore.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cachestore/CacheStore.java index 4af318a9..30032a3f 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cachestore/CacheStore.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cachestore/CacheStore.java @@ -24,12 +24,12 @@ import com.oracle.weblogic.imagetool.util.Utils; import static com.oracle.weblogic.imagetool.aru.AruUtil.getAruPlatformId; +import static com.oracle.weblogic.imagetool.settings.YamlFileConstants.ARCHITECTURE; import static com.oracle.weblogic.imagetool.settings.YamlFileConstants.DATE_ADDED; import static com.oracle.weblogic.imagetool.settings.YamlFileConstants.DESCRIPTION; import static com.oracle.weblogic.imagetool.settings.YamlFileConstants.DIGEST; import static com.oracle.weblogic.imagetool.settings.YamlFileConstants.LOCATION; import static com.oracle.weblogic.imagetool.settings.YamlFileConstants.PATCH_VERSION; -import static com.oracle.weblogic.imagetool.settings.YamlFileConstants.PLATFORM; import static com.oracle.weblogic.imagetool.settings.YamlFileConstants.PRODUCT_VERSION; import static com.oracle.weblogic.imagetool.util.Utils.getTodayDate; @@ -206,14 +206,14 @@ public InstallerMetaData getInstallerForPlatform(InstallerType installerType, Ar List installerMetaDataList = installers.get(installerVersion); if (installerMetaDataList != null && !installerMetaDataList.isEmpty()) { for (InstallerMetaData installerMetaData: installerMetaDataList) { - if (platformName.getAcceptableNames().contains(installerMetaData.getPlatform())) { + if (platformName.getAcceptableNames().contains(installerMetaData.getArchitecture())) { return installerMetaData; } } if (Utils.isGenericInstallerAcceptable(installerType)) { //If it can't find the specialized platform, try generic. for (InstallerMetaData installerMetaData: installerMetaDataList) { - if (Architecture.GENERIC.getAcceptableNames().contains(installerMetaData.getPlatform())) { + if (Architecture.GENERIC.getAcceptableNames().contains(installerMetaData.getArchitecture())) { return installerMetaData; } } @@ -291,12 +291,12 @@ public PatchMetaData getPatchForPlatform(String platformName, String bugNumber, if (patchMetaDataList != null && !patchMetaDataList.isEmpty()) { for (PatchMetaData patchMetaData: patchMetaDataList) { if (platformName == null || platformName.isEmpty()) { - if (patchMetaData.getPlatform().equalsIgnoreCase("Generic") + if (patchMetaData.getArchitecture().equalsIgnoreCase("Generic") && patchMetaData.getPatchVersion().equals(version)) { return patchMetaData; } } else { - if (patchMetaData.getPlatform().equalsIgnoreCase(platformName) + if (patchMetaData.getArchitecture().equalsIgnoreCase(platformName) && patchMetaData.getPatchVersion().equals(version)) { return patchMetaData; } @@ -305,7 +305,7 @@ public PatchMetaData getPatchForPlatform(String platformName, String bugNumber, // search for generic for opatch only?? if (OPatchFile.DEFAULT_BUG_NUM.equals(bugNumber)) { for (PatchMetaData patchMetaData: patchMetaDataList) { - if ("generic".equalsIgnoreCase(patchMetaData.getPlatform())) { + if ("generic".equalsIgnoreCase(patchMetaData.getArchitecture())) { return patchMetaData; } } @@ -331,8 +331,8 @@ public List getAruPatchForBugNumber(String bugNumber) { for (PatchMetaData patchMetaData: resultPatchMetaDataList) { AruPatch aruPatch = new AruPatch(); - aruPatch.platformName(patchMetaData.getPlatform()) - .platform(getAruPlatformId(patchMetaData.getPlatform())) + aruPatch.platformName(patchMetaData.getArchitecture()) + .platform(getAruPlatformId(patchMetaData.getArchitecture())) .patchId(bugNumber) .fileName(patchMetaData.getLocation()) .version(patchMetaData.getPatchVersion()); @@ -404,7 +404,7 @@ private InstallerMetaData createInstallerMetaData(Map objectData } String location = (String) objectData.get(LOCATION); String productVersion = (String) objectData.get(PRODUCT_VERSION); - String platform = (String) objectData.get(PLATFORM); + String platform = (String) objectData.get(ARCHITECTURE); return new InstallerMetaData(platform, location, hash, dateAdded, productVersion); } @@ -416,7 +416,7 @@ private PatchMetaData createPatchMetaData(Map objectData) { } String location = (String) objectData.get(LOCATION); String productVersion = (String) objectData.get(PATCH_VERSION); - String platform = (String) objectData.get(PLATFORM); + String platform = (String) objectData.get(ARCHITECTURE); String description = (String) objectData.get(DESCRIPTION); return new PatchMetaData(platform, location, hash, dateAdded, productVersion, description); } diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/ImageTool.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/ImageTool.java index 87623cd7..181a1ae9 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/ImageTool.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/ImageTool.java @@ -11,7 +11,6 @@ import com.oracle.weblogic.imagetool.cli.menu.CreateAuxImage; import com.oracle.weblogic.imagetool.cli.menu.CreateImage; import com.oracle.weblogic.imagetool.cli.menu.InspectImage; -import com.oracle.weblogic.imagetool.cli.menu.RebaseImage; import com.oracle.weblogic.imagetool.cli.menu.UpdateImage; import com.oracle.weblogic.imagetool.logging.LoggingFacade; import com.oracle.weblogic.imagetool.logging.LoggingFactory; diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/DeleteInstaller.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/DeleteInstaller.java index 48d254f1..d45865cd 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/DeleteInstaller.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/DeleteInstaller.java @@ -44,12 +44,12 @@ public CommandResponse call() throws CacheStoreException { search = commonName; } exists = Optional.ofNullable(items.get(search)) - .map(list -> list.stream().anyMatch(i -> Architecture.fromString(i.getPlatform()) + .map(list -> list.stream().anyMatch(i -> Architecture.fromString(i.getArchitecture()) .equals(architecture) && i.getProductVersion().equalsIgnoreCase(version))) .orElse(false); if (exists) { Optional.ofNullable(items.get(search)) - .map(list -> list.removeIf(i -> Architecture.fromString(i.getPlatform()) + .map(list -> list.removeIf(i -> Architecture.fromString(i.getArchitecture()) .equals(architecture) && i.getProductVersion().equalsIgnoreCase(version))); if (items.get(search).isEmpty()) { diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/DeletePatch.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/DeletePatch.java index e5550094..9e0e2c23 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/DeletePatch.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/DeletePatch.java @@ -38,11 +38,11 @@ public CommandResponse call() throws CacheStoreException { List items = data.get(id); exists = Optional.ofNullable(items) .map(list -> list.stream().anyMatch(i -> i.getPatchVersion().equals(version) - && Architecture.fromString(i.getPlatform()).equals(architecture))).orElse(false); + && Architecture.fromString(i.getArchitecture()).equals(architecture))).orElse(false); if (exists) { Optional.ofNullable(items) .map(list -> list.removeIf(i -> i.getPatchVersion().equals(version) - && Architecture.fromString(i.getPlatform()).equals(architecture))); + && Architecture.fromString(i.getArchitecture()).equals(architecture))); if (items.isEmpty()) { data.remove(id); diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/ListInstallers.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/ListInstallers.java index 99ad3b9f..e0209e38 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/ListInstallers.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/ListInstallers.java @@ -53,7 +53,7 @@ public CommandResponse call() throws CacheStoreException { System.out.println(" " + installer + ":"); for (InstallerMetaData meta : metaData) { System.out.println(" - location: " + meta.getLocation()); - System.out.println(" platform: " + meta.getPlatform()); + System.out.println(" architecture: " + meta.getArchitecture()); System.out.println(" digest: " + meta.getDigest()); System.out.println(" dateAdded: " + meta.getDateAdded()); System.out.println(" version: " + meta.getProductVersion()); diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/ListPatches.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/ListPatches.java index 5a2dac17..ae38be1b 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/ListPatches.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/ListPatches.java @@ -44,7 +44,7 @@ public CommandResponse call() throws CacheStoreException { } } System.out.println(" - location: " + metaData.getLocation()); - System.out.println(" platform: " + metaData.getPlatform()); + System.out.println(" architecture: " + metaData.getArchitecture()); System.out.println(" digest: " + metaData.getHash()); System.out.println(" dateAdded: " + metaData.getDateAdded()); System.out.println(" version: " + metaData.getPatchVersion()); diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/RebaseImage.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/RebaseImage.java deleted file mode 100644 index cad7be31..00000000 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/RebaseImage.java +++ /dev/null @@ -1,142 +0,0 @@ -// Copyright (c) 2019, 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.cli.menu; - -import java.io.File; -import java.time.Instant; -import java.util.Properties; -import java.util.concurrent.Callable; - -import com.oracle.weblogic.imagetool.api.model.CommandResponse; -import com.oracle.weblogic.imagetool.logging.LoggingFacade; -import com.oracle.weblogic.imagetool.logging.LoggingFactory; -import com.oracle.weblogic.imagetool.util.Utils; -import picocli.CommandLine.Command; -import picocli.CommandLine.Option; - -@Command( - name = "rebase", - description = "Copy domain from one image to another", - requiredOptionMarker = '*', - abbreviateSynopsis = true -) -public class RebaseImage extends CommonCreateOptions implements Callable { - - private static final LoggingFacade logger = LoggingFactory.getLogger(RebaseImage.class); - - @Override - public CommandResponse call() throws Exception { - logger.entering(); - Instant startTime = Instant.now(); - - String newOracleHome = null; - String newJavaHome = null; - - try { - initializeOptions(); - - if (Utils.isEmptyString(sourceImage)) { - // sourceImage is a required parameter. This error will only occur if the user passes an empty string. - return CommandResponse.error(Utils.getMessage("IMG-0117")); - } - - logger.finer("IMG-0002", sourceImage); - dockerfileOptions.setSourceImage(sourceImage); - - logger.info("IMG-0091", sourceImage); - Properties sourceImageProperties = Utils.getBaseImageProperties(buildEngine, sourceImage, - "/probe-env/inspect-image.sh", buildDir()); - - String oldOracleHome = sourceImageProperties.getProperty("oracleHome", null); - String oldJavaHome = sourceImageProperties.getProperty("javaHome", null); - String domainHome = sourceImageProperties.getProperty("domainHome", null); - String wdtHome = sourceImageProperties.getProperty("wdtHome", null); - String modelHome = sourceImageProperties.getProperty("wdtModelHome", null); - boolean modelOnly = Boolean.parseBoolean(sourceImageProperties.getProperty("wdtModelOnly", null)); - - // If the user specified --targetImage, collect and apply the properties for the new image. - if (!Utils.isEmptyString(targetImage)) { - logger.finer("IMG-0002", targetImage); - dockerfileOptions.setTargetImage(targetImage); - dockerfileOptions.setRebaseToTarget(true); - - Properties targetImageProperties = Utils.getBaseImageProperties(buildEngine, targetImage, - "/probe-env/inspect-image.sh", buildDir()); - newOracleHome = targetImageProperties.getProperty("oracleHome", null); - newJavaHome = targetImageProperties.getProperty("javaHome", null); - useFileOwnerFromTarget(targetImageProperties); - } else { - dockerfileOptions.setRebaseToNew(true); - } - - if (newJavaHome != null && !newJavaHome.equals(oldJavaHome)) { - return CommandResponse.error(Utils.getMessage("IMG-0026")); - } - - if (newOracleHome != null && !newOracleHome.equals(oldOracleHome)) { - return CommandResponse.error(Utils.getMessage("IMG-0021")); - } - - if (Utils.isEmptyString(domainHome)) { - return CommandResponse.error(Utils.getMessage("IMG-0025")); - } - - if (modelOnly) { - logger.info("IMG-0090", domainHome); - if (Utils.isEmptyString(modelHome)) { - logger.info("IMG-0089", dockerfileOptions.wdt_model_home()); - } - } - - dockerfileOptions - .setDomainHome(domainHome) - .setWdtHome(wdtHome) - .setWdtModelHome(modelHome) - .setWdtModelOnly(modelOnly); - - if (dockerfileOptions.isRebaseToNew()) { - prepareNewImage(); - } - - // Create Dockerfile - String dockerfile = Utils.writeDockerfile(buildDir() + File.separator + "Dockerfile", - "Rebase_Image.mustache", dockerfileOptions, dryRun); - - // add directory to pass the context - runDockerCommand(dockerfile, getInitialBuildCmd(buildDir())); - } catch (Exception ex) { - logger.fine("**ERROR**", ex); - return CommandResponse.error(ex.getMessage()); - } finally { - cleanup(); - } - logger.exiting(); - return successfulBuildResponse(startTime); - } - - private void useFileOwnerFromTarget(Properties imageProperties) { - String userid = imageProperties.getProperty("oracleHomeUser", null); - String groupid = imageProperties.getProperty("oracleHomeGroup", null); - if (!Utils.isEmptyString(userid)) { - dockerfileOptions.setUserId(userid); - } - if (!Utils.isEmptyString(groupid)) { - dockerfileOptions.setGroupId(groupid); - } - } - - @Option( - names = {"--sourceImage"}, - required = true, - description = "Docker image containing source domain." - ) - private String sourceImage; - - @Option( - names = {"--targetImage"}, - description = "Docker image with updated JDK or MW Home" - ) - private String targetImage; - -} \ No newline at end of file diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/installer/InstallerMetaData.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/installer/InstallerMetaData.java index 4ed9115f..ba7c2a54 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/installer/InstallerMetaData.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/installer/InstallerMetaData.java @@ -11,7 +11,7 @@ import com.oracle.weblogic.imagetool.util.Utils; public class InstallerMetaData { - private String platform; + private String architecture; private String location; private String digest; private String dateAdded; @@ -19,13 +19,14 @@ public class InstallerMetaData { /** * Constructor InstallerMetaData stores details about this installer. - * @param platform platform linux/arm64, linux/amd64 + * @param architecture platform linux/arm64, linux/amd64 * @param location file path of the installer * @param digest sha256 hash value * @param dateAdded date added */ - public InstallerMetaData(String platform, String location, String digest, String dateAdded, String productVersion) { - this.platform = Utils.standardPlatform(platform); + public InstallerMetaData(String architecture, String location, String digest, String dateAdded, + String productVersion) { + this.architecture = Utils.standardPlatform(architecture); this.location = location; this.digest = digest; this.dateAdded = dateAdded; @@ -34,12 +35,12 @@ public InstallerMetaData(String platform, String location, String digest, String /** * Constructor InstallerMetaData stores details about this installer. - * @param platform platform linux/arm64, linux/amd64 + * @param architecture platform linux/arm64, linux/amd64 * @param location file path of the installer * @param productVersion real version of this installer */ - public InstallerMetaData(String platform, String location, String productVersion) { - this.platform = Utils.standardPlatform(platform); + public InstallerMetaData(String architecture, String location, String productVersion) { + this.architecture = Utils.standardPlatform(architecture); this.location = location; this.productVersion = productVersion; if (location != null) { @@ -50,8 +51,8 @@ public InstallerMetaData(String platform, String location, String productVersion } } - public String getPlatform() { - return platform; + public String getArchitecture() { + return architecture; } public String getLocation() { @@ -86,7 +87,7 @@ public String standardPlatform(String platform) { } public String toString() { - return "InstallerMetaData [platform=" + platform + ", location=" + location + ", hash=" + digest + ", " + return "InstallerMetaData [platform=" + architecture + ", location=" + location + ", hash=" + digest + ", " + "dateAdded=" + dateAdded + ", version=" + productVersion + "]"; } @@ -99,7 +100,7 @@ public boolean equals(Object o) { return false; } InstallerMetaData metaData = (InstallerMetaData) o; - return Objects.equals(platform, metaData.platform) + return Objects.equals(architecture, metaData.architecture) && Objects.equals(location, metaData.location) && Objects.equals(digest, metaData.digest) && Objects.equals(dateAdded, metaData.dateAdded) && Objects.equals(productVersion, metaData.productVersion); @@ -107,6 +108,6 @@ public boolean equals(Object o) { @Override public int hashCode() { - return Objects.hash(platform, location, digest, dateAdded, productVersion); + return Objects.hash(architecture, location, digest, dateAdded, productVersion); } } diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/patch/PatchMetaData.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/patch/PatchMetaData.java index 3a54de0b..3179ff27 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/patch/PatchMetaData.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/patch/PatchMetaData.java @@ -8,7 +8,7 @@ import com.oracle.weblogic.imagetool.util.Utils; public class PatchMetaData { - private String platform; + private String architecture; private String location; private String hash; private String dateAdded; @@ -17,15 +17,15 @@ public class PatchMetaData { /** * Constructor. - * @param platform platform + * @param architecture platform * @param location file path of the patch * @param hash sha256 hash * @param dateAdded date added * @param patchVersion version */ - public PatchMetaData(String platform, String location, String hash, String dateAdded, String patchVersion, + public PatchMetaData(String architecture, String location, String hash, String dateAdded, String patchVersion, String description) { - this.platform = platform; + this.architecture = architecture; this.location = location; this.hash = hash; this.dateAdded = dateAdded; @@ -35,13 +35,13 @@ public PatchMetaData(String platform, String location, String hash, String dateA /** * Constructor. - * @param platform platform + * @param architecture platform * @param location file path of the patch * @param patchVersion version * @param description description of the patch */ - public PatchMetaData(String platform, String location, String patchVersion, String description) { - this.platform = platform; + public PatchMetaData(String architecture, String location, String patchVersion, String description) { + this.architecture = architecture; this.location = location; this.hash = Utils.getSha256Hash(location); this.dateAdded = Utils.getTodayDate(); @@ -51,14 +51,15 @@ public PatchMetaData(String platform, String location, String patchVersion, Stri /** * Constructor. - * @param platform platform + * @param architecture platform * @param location file path of the patch * @param patchVersion version * @param description description of the patch * @param dateAdded date added */ - public PatchMetaData(String platform, String location, String patchVersion, String description, String dateAdded) { - this.platform = platform; + public PatchMetaData(String architecture, String location, String patchVersion, String description, + String dateAdded) { + this.architecture = architecture; this.location = location; this.hash = Utils.getSha256Hash(location); this.dateAdded = dateAdded; @@ -66,8 +67,8 @@ public PatchMetaData(String platform, String location, String patchVersion, Stri this.description = description; } - public String getPlatform() { - return platform; + public String getArchitecture() { + return architecture; } public String getLocation() { @@ -93,7 +94,7 @@ public String getDescription() { @Override public String toString() { return "PatchMetaData{" - + "platform='" + platform + '\'' + + "platform='" + architecture + '\'' + ", location='" + location + '\'' + ", hash='" + hash + '\'' + ", dateAdded='" + dateAdded + '\'' @@ -111,7 +112,7 @@ public boolean equals(Object o) { return false; } PatchMetaData metaData = (PatchMetaData) o; - return Objects.equals(platform, metaData.platform) + return Objects.equals(architecture, metaData.architecture) && Objects.equals(location, metaData.location) && Objects.equals(hash, metaData.hash) && Objects.equals(dateAdded, metaData.dateAdded) && Objects.equals(patchVersion, metaData.patchVersion) @@ -120,6 +121,6 @@ public boolean equals(Object o) { @Override public int hashCode() { - return Objects.hash(platform, location, hash, dateAdded, patchVersion, description); + return Objects.hash(architecture, location, hash, dateAdded, patchVersion, description); } } diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/ConfigManager.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/ConfigManager.java index d50a11ba..90e410e0 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/ConfigManager.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/ConfigManager.java @@ -21,12 +21,12 @@ import com.oracle.weblogic.imagetool.util.Architecture; import static com.oracle.weblogic.imagetool.cachestore.CacheStore.CACHE_DIR_ENV; +import static com.oracle.weblogic.imagetool.settings.YamlFileConstants.ARCHITECTURE; import static com.oracle.weblogic.imagetool.settings.YamlFileConstants.DATE_ADDED; import static com.oracle.weblogic.imagetool.settings.YamlFileConstants.DESCRIPTION; import static com.oracle.weblogic.imagetool.settings.YamlFileConstants.DIGEST; import static com.oracle.weblogic.imagetool.settings.YamlFileConstants.LOCATION; import static com.oracle.weblogic.imagetool.settings.YamlFileConstants.PATCH_VERSION; -import static com.oracle.weblogic.imagetool.settings.YamlFileConstants.PLATFORM; import static com.oracle.weblogic.imagetool.settings.YamlFileConstants.PRODUCT_VERSION; import static com.oracle.weblogic.imagetool.util.Utils.getTodayDate; @@ -244,7 +244,7 @@ private InstallerMetaData createInstallerMetaData(Map objectData } String location = (String) objectData.get(LOCATION); String productVersion = (String) objectData.get(PRODUCT_VERSION); - String platform = (String) objectData.get(PLATFORM); + String platform = (String) objectData.get(ARCHITECTURE); return new InstallerMetaData(platform, location, hash, dateAdded, productVersion); } @@ -256,7 +256,7 @@ private PatchMetaData createPatchMetaData(Map objectData) { } String location = (String) objectData.get(LOCATION); String productVersion = (String) objectData.get(PATCH_VERSION); - String platform = (String) objectData.get(PLATFORM); + String platform = (String) objectData.get(ARCHITECTURE); String description = (String) objectData.get(DESCRIPTION); return new PatchMetaData(platform, location, hash, dateAdded, productVersion, description); } diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/YamlFileConstants.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/YamlFileConstants.java index 60f06359..a367ade6 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/YamlFileConstants.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/YamlFileConstants.java @@ -6,11 +6,11 @@ public class YamlFileConstants { // Do not change the values, it affect the persisted YAML file and will break compatibility + public static String ARCHITECTURE = "architecture"; + public static String DATE_ADDED = "dateAdded"; public static String DESCRIPTION = "description"; - public static String PATCH_VERSION = "patchVersion"; - public static String LOCATION = "location"; public static String DIGEST = "digest"; - public static String PLATFORM = "platform"; + public static String LOCATION = "location"; + public static String PATCH_VERSION = "patchVersion"; public static String PRODUCT_VERSION = "productVersion"; - public static String DATE_ADDED = "dateAdded"; } From 7d54f6e3d7ab80c07d0619591f20831fd2af1fbc Mon Sep 17 00:00:00 2001 From: jshum Date: Mon, 30 Dec 2024 16:39:15 -0600 Subject: [PATCH 062/104] doc update --- .../site/content/userguide/tools/cache.md | 93 ++++++++++++++++++- .../userguide/tools/create-aux-image.md | 2 + .../content/userguide/tools/create-image.md | 2 + .../cli/cache/AddInstallerEntry.java | 6 +- .../imagetool/cli/cache/DeleteInstaller.java | 8 +- 5 files changed, 103 insertions(+), 8 deletions(-) diff --git a/documentation/site/content/userguide/tools/cache.md b/documentation/site/content/userguide/tools/cache.md index a68c5639..f8811283 100644 --- a/documentation/site/content/userguide/tools/cache.md +++ b/documentation/site/content/userguide/tools/cache.md @@ -51,8 +51,19 @@ List and set cache options ### Usage scenarios - `listInstallers`: Display the contents of the cache. Displays key value pairs of the installers and patches. -``` +```bash +Usage: imagetool cache listInstallers [--commonName=] + [--type=] [--version=] +List installers + --commonName= + Filter installer by common name. + --type= Filter installer type. e.g. wls, jdk, wdt + --version= Filter installer by version. + +e.g. + imagetool.sh cache listInstallers + JDK: 8u401: - location: /home/acmeuser/Downloads/jdk-8u401-fcs-bin-b10-linux-aarch64-19_dec_2023.tar.gz @@ -105,7 +116,14 @@ WLS: ```bash -imagetool.sh cache listPatches +Usage: imagetool cache listPatches [--patchId=] [--version=] +List patches + --patchId= Patch id + --version= Patch version + + + +$ imagetool.sh cache listPatches 36805124: - location: /home/acmeuser/Downloads/oraclePatches/p36805124_122140_Generic.zip @@ -136,11 +154,54 @@ imagetool.sh cache listPatches - `addInstaller`: Add an installer to the cache, for example, JDK. ```bash + + Usage: imagetool cache addInstaller [--force] -a= + [-c=] -p= [-t=] + -v= + Add cache entry for wls, fmw, jdk or wdt installer + --force Overwrite existing entry, if it exists + -p, --path= Location of the file on disk. For ex: + /path/to/patch-or-installer.zip + -t, --type= Type of installer. Valid values: wlsdev, wlsslim, + wls, fmw, soa, osb, b2b, mft, idm, oam, ohs, + db19, oud, oid, wcc, wcp, wcs, jdk, wdt, odi + -v, --version= Installer version. Ex: For WLS|FMW use 12.2.1.3.0 + For jdk, use 8u201. The version for WLS, FMW etc. + will be used to obtain patches. + -a, --architecture= + Installer architecture. Valid values: arm64, amd64, + Generic + -c, --commonName= + (Optional) common name. Valid values: Alphanumeric + values with no special characters. If not + specified, default to the version value. Use + this if you want to use a special name for the + particular version of the installer. + + + $ imagetool cache addInstaller --type jdk --version 8u202 --path /path/to/local/jdk.tar.gz --architecture AMD64 ``` - `addPatch`: Add a patch to the cache. ```bash + + Usage: imagetool cache addPatch [--force] -a= [-d=] + -p= --patchId= -v= + Add cache entry for wls|fmw patch or psu + --force Overwrite existing entry, if it exists + -p, --path= Location of the file on disk. For ex: + /path/to/patch-or-installer.zip + --patchId= Patch number. Ex: 28186730 + -v, --version= Patch version. + -a, --architecture= + Patch architecture. Valid values: arm64, amd64, + Generic + -d, --description= + Patch description. + + + $ imagetool cache addPatch --patchId 12345678_12.2.1.3.0 --path /path/to/patch.zip --architecture AMD64 ``` **Note**: When adding a patch to the cache store, the `patchId` should be in the following format: `99999999_9.9.9.9.99999` The first 8 digits is the patch ID, followed by an underscore, and then the release number to identify the patch between different patch versions. @@ -158,10 +219,38 @@ If you downloaded the release version ```12.2.1.3.190416``` of the patch, then y - `deleteInstaller`: Delete an installer from the cache for a given key. **Note**: This command does not delete files from the disk. ```bash + + Usage: imagetool cache deleteInstaller [--architecture=] + [--cn=] [--type=] + [--version=] + Delete a installer + --architecture= + Specific architecture to delete + --cn= Filter by common name. + --type= Filter installer type. e.g. wls, jdk, wdt + --version= Specific version to delete + + $ imagetool cache deleteInstaller --version 14.1.1.0.0 --architecture ARM64 ``` - `deletePatch`: Delete a patch from the cache for a given key. **Note**: This command does not delete files from the disk. ```bash + Usage: imagetool cache deletePatch [--architecture=] + [--patchId=] [--version=] + Delete a patch + --architecture= + Specific architecture to delete + --patchId= Bug num + --version= Specific version to delete + + $ imagetool cache deletePatch --patchId 12345678 --version 14.1.1.0.0 --architecture ARM64 ``` + +- `convert`: Convert Imagetool version 1.x to 2.0 format. + +```bash +Usage: imagetool cache convert +Convert cache settings from v1 to v2 +``` \ No newline at end of file diff --git a/documentation/site/content/userguide/tools/create-aux-image.md b/documentation/site/content/userguide/tools/create-aux-image.md index 5c6f5f0a..b2ac1762 100644 --- a/documentation/site/content/userguide/tools/create-aux-image.md +++ b/documentation/site/content/userguide/tools/create-aux-image.md @@ -43,6 +43,8 @@ Usage: imagetool createAuxImage [OPTIONS] | `--wdtVariables` | A WDT variables file or comma-separated list of files. | | | `--wdtVersion` | WDT version to be installed in the container image in `{wdtHome}/weblogic-deploy`. For more details, see [Additional information](#--wdtversion). | `latest` | | `--platform` | Comma separated list (no space between) of target platforms for the image: linux/amd64 or linux/arm64| +| `--push` | Push to remote repository - only valid for docker building multi platforms images, user is assumed logged in to the repo registry already. All others are ignored. | +| `--load` | Load into local repository - only valid for docker building multi platforms images, user is assumed logged in to the repo registry already. All others are ignored.| ### Additional information diff --git a/documentation/site/content/userguide/tools/create-image.md b/documentation/site/content/userguide/tools/create-image.md index 392a2f22..4c978072 100644 --- a/documentation/site/content/userguide/tools/create-image.md +++ b/documentation/site/content/userguide/tools/create-image.md @@ -66,6 +66,8 @@ Usage: imagetool create [OPTIONS] | `--wdtVariables` | A WDT variables file or comma-separated list of files. | | | `--wdtVersion` | WDT version to use. | `latest` | | `--platform` | Comma separated list (no space between) of target platforms for the image: linux/amd64 or linux/arm64| +| `--push` | Push to remote repository - only valid for docker building multi platforms images, user is assumed logged in to the repo registry already. All others are ignored. | +| `--load` | Load into local repository - only valid for docker building multi platforms images, user is assumed logged in to the repo registry already. All others are ignored.| ### Additional information diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/AddInstallerEntry.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/AddInstallerEntry.java index 69608c52..16969e33 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/AddInstallerEntry.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/AddInstallerEntry.java @@ -66,7 +66,8 @@ public String getDescription() { @Option( names = {"-v", "--version"}, - description = "Installer version. Ex: For WLS|FMW use 12.2.1.3.0 For jdk, use 8u201", + description = "Installer version. Ex: For WLS|FMW use 12.2.1.3.0 For jdk, use 8u201. The version for WLS, " + + "FMW etc. will be used to obtain patches.", required = true ) private String version; @@ -81,7 +82,8 @@ public String getDescription() { @Option( names = {"-c", "--commonName"}, description = "(Optional) common name. Valid values: Alphanumeric values with no special characters. " - + "If not specified, default to the version value." + + "If not specified, default to the version value. Use this if you want to use a special name for the " + + "particular version of the installer." ) private String commonName; diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/DeleteInstaller.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/DeleteInstaller.java index d45865cd..bd329af3 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/DeleteInstaller.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/DeleteInstaller.java @@ -71,25 +71,25 @@ public CommandResponse call() throws CacheStoreException { @Option( names = {"--type"}, - description = "Filter installer type. e.g. wls, jdk, wdt" + description = "Filter installer type. e.g. wls, jdk, wdt." ) private InstallerType type; @Option( names = {"--cn"}, - description = "Filter installer type. e.g. wls, jdk, wdt" + description = "Filter by common name." ) private String commonName; @Option( names = {"--version"}, - description = "Specific version to delete" + description = "Specific version to delete." ) private String version; @Option( names = {"--architecture"}, - description = "Specific architecture to delete" + description = "Specific architecture to delete." ) private Architecture architecture; From 8ca2e1ecd63f27cce0207a4badf4b1ed08721a49 Mon Sep 17 00:00:00 2001 From: jshum Date: Tue, 31 Dec 2024 11:37:12 -0600 Subject: [PATCH 063/104] Fix listing patch version available --- .../userguide/tools/create-aux-image.md | 7 +- .../content/userguide/tools/create-image.md | 7 +- .../weblogic/imagetool/aru/AruPatch.java | 7 +- .../imagetool/aru/PatchVersionException.java | 2 +- .../cli/menu/CommonCreateOptions.java | 8 +- .../src/main/resources/ImageTool.properties | 3 +- .../docker-files/Rebase_Image.mustache | 95 ------------------- 7 files changed, 19 insertions(+), 110 deletions(-) delete mode 100644 imagetool/src/main/resources/docker-files/Rebase_Image.mustache diff --git a/documentation/site/content/userguide/tools/create-aux-image.md b/documentation/site/content/userguide/tools/create-aux-image.md index b2ac1762..4456e702 100644 --- a/documentation/site/content/userguide/tools/create-aux-image.md +++ b/documentation/site/content/userguide/tools/create-aux-image.md @@ -31,9 +31,11 @@ Usage: imagetool createAuxImage [OPTIONS] | `--fromImage` | Container image to use as a base image when creating a new image. | `busybox` | | `--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` | | +| `--load` | Load into local repository - only valid for docker building multi platforms images, user is assumed logged in to the repo registry already. All others are ignored.| | `--packageManager` | Override the default package manager for the base image's operating system. Supported values: `APK`, `APTGET`, `NONE`, `YUM`, `ZYPPER` | | -| `--platform` | Set the target platform to build. Supported values: `linux/amd64` or `linux/arm64`. | | +| `--platform` | Comma separated list (no space between) of target platforms for the image: linux/amd64 or linux/arm64| | `--pull` | Always attempt to pull a newer version of base images during the build. | | +| `--push` | Push to remote repository - only valid for docker building multi platforms images, user is assumed logged in to the repo registry already. All others are ignored. | | `--skipcleanup` | Do not delete the build context folder, intermediate images, and failed build containers. For debugging purposes. | | | `--target` | Select the target environment in which the created image will be used. Supported values: `Default` (Docker/Kubernetes), `OpenShift`. See [Additional information](#--target). | `Default` | | `--wdtArchive` | A WDT archive ZIP file or comma-separated list of files. | | @@ -42,9 +44,6 @@ Usage: imagetool createAuxImage [OPTIONS] | `--wdtModelHome` | The target location in the image to copy WDT model, variable, and archive files. | `{wdtHome}/models` | | `--wdtVariables` | A WDT variables file or comma-separated list of files. | | | `--wdtVersion` | WDT version to be installed in the container image in `{wdtHome}/weblogic-deploy`. For more details, see [Additional information](#--wdtversion). | `latest` | -| `--platform` | Comma separated list (no space between) of target platforms for the image: linux/amd64 or linux/arm64| -| `--push` | Push to remote repository - only valid for docker building multi platforms images, user is assumed logged in to the repo registry already. All others are ignored. | -| `--load` | Load into local repository - only valid for docker building multi platforms images, user is assumed logged in to the repo registry already. All others are ignored.| ### Additional information diff --git a/documentation/site/content/userguide/tools/create-image.md b/documentation/site/content/userguide/tools/create-image.md index 4c978072..b4de9def 100644 --- a/documentation/site/content/userguide/tools/create-image.md +++ b/documentation/site/content/userguide/tools/create-image.md @@ -34,14 +34,16 @@ Usage: imagetool create [OPTIONS] | `--inventoryPointerInstallLoc` | Target location for the inventory pointer file. | | | `--jdkVersion` | Version of the server JDK to install. | `8u202` | | `--latestPSU` | Find and apply the latest PatchSet Update. | | +| `--load` | Load into local repository - only valid for docker building multi platforms images, user is assumed logged in to the repo registry already. All others are ignored.| | `--opatchBugNumber` | The patch number for OPatch (patching OPatch). | `28186730` | | `--packageManager` | Override the default package manager for the base image's operating system. Supported values: `APK`, `APTGET`, `NONE`, `OS_DEFAULT`, `YUM`, `ZYPPER` | `OS_DEFAULT` | | `--password` | Request password for the Oracle Support `--user` on STDIN, see `--user`. | | | `--passwordEnv` | Environment variable containing the Oracle Support password, see `--user`. | | | `--passwordFile` | Path to a file containing just the Oracle Support password, see `--user`. | | | `--patches` | Comma separated list of patch IDs. Example: `12345678,87654321` | | -| `--platform` | Set the target platform to build. Supported values: `linux/amd64` or `linux/arm64`. | | +| `--platform` | Comma separated list (no space between) of target platforms for the image: linux/amd64 or linux/arm64| | `--pull` | Always attempt to pull a newer version of base images during the build. | | +| `--push` | Push to remote repository - only valid for docker building multi platforms images, user is assumed logged in to the repo registry already. All others are ignored. | | `--recommendedPatches` | Find and apply the latest PatchSet Update and recommended patches. This takes precedence over `--latestPSU`. | | | `--resourceTemplates` | One or more files containing placeholders that need to be resolved by the Image Tool. See [Resource Template Files](#resource-template-files). | | | `--skipcleanup` | Do not delete the build context folder, intermediate images, and failed build containers. For debugging purposes. | | @@ -65,9 +67,6 @@ Usage: imagetool create [OPTIONS] | `--wdtStrictValidation` | Use strict validation for the WDT validation method. Only applies when using model only. | `false` | | `--wdtVariables` | A WDT variables file or comma-separated list of files. | | | `--wdtVersion` | WDT version to use. | `latest` | -| `--platform` | Comma separated list (no space between) of target platforms for the image: linux/amd64 or linux/arm64| -| `--push` | Push to remote repository - only valid for docker building multi platforms images, user is assumed logged in to the repo registry already. All others are ignored. | -| `--load` | Load into local repository - only valid for docker building multi platforms images, user is assumed logged in to the repo registry already. All others are ignored.| ### Additional information diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/aru/AruPatch.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/aru/AruPatch.java index f41c5b60..126d98f3 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/aru/AruPatch.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/aru/AruPatch.java @@ -3,6 +3,7 @@ package com.oracle.weblogic.imagetool.aru; +import java.util.ArrayList; import java.util.HashMap; import java.util.List; import java.util.Map; @@ -303,7 +304,11 @@ public static AruPatch selectPatch(List patches, String providedVersio } logger.exiting(selected); if (selected == null) { - throw logger.throwing(new PatchVersionException(patches.get(0).patchId(), patches)); + List versionStrings = new ArrayList<>(); + for (AruPatch aruPatch : patches) { + versionStrings.add(patches.get(0).patchId() + "_" + aruPatch.version()); + } + throw logger.throwing(new PatchVersionException(patches.get(0).patchId(), versionStrings)); } else { logger.info("IMG-0099", selected.patchId(), selected.version(), selected.description()); return selected; diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/aru/PatchVersionException.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/aru/PatchVersionException.java index df16fc55..a0f4195c 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/aru/PatchVersionException.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/aru/PatchVersionException.java @@ -16,7 +16,7 @@ public class PatchVersionException extends IOException { * @param bugNumber the bug number that was searched * @param versionsAvailable the list of versions for patches of that bug */ - public PatchVersionException(String bugNumber, List versionsAvailable) { + public PatchVersionException(String bugNumber, List versionsAvailable) { super(Utils.getMessage("IMG-0034", bugNumber, versionsAvailable)); } } diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonCreateOptions.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonCreateOptions.java index de224542..b55f15c8 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonCreateOptions.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonCreateOptions.java @@ -115,8 +115,8 @@ void verifyInstallers(List buildPlatforms) throws IOException { InstallerMetaData jdkInstallerMetaData = configManager.getInstallerForPlatform(InstallerType.JDK, arch, jdkVersion); if (jdkInstallerMetaData == null) { - throw new IOException(String.format("Could not find installer type: %s, platform: %s version: %s", - InstallerType.JDK, buildPlatform, jdkVersion)); + throw new IllegalArgumentException(Utils.getMessage("IMG_0145", InstallerType.JDK, + buildPlatform, jdkVersion)); } else { // If needed verifyInstallerHash(jdkInstallerMetaData); @@ -127,8 +127,8 @@ void verifyInstallers(List buildPlatforms) throws IOException { InstallerMetaData installerMetaData = configManager.getInstallerForPlatform(installerType, arch, installerVersion); if (installerMetaData == null) { - throw new IOException(String.format("Could not find installer type: %s, platform: %s version: %s", - installerType, buildPlatform, installerVersion)); + throw new IllegalArgumentException(Utils.getMessage("IMG_0145", installerType, + buildPlatform, installerVersion)); } else { // If needed verifyInstallerHash(installerMetaData); diff --git a/imagetool/src/main/resources/ImageTool.properties b/imagetool/src/main/resources/ImageTool.properties index 8ddc8efd..e6e1643f 100644 --- a/imagetool/src/main/resources/ImageTool.properties +++ b/imagetool/src/main/resources/ImageTool.properties @@ -142,4 +142,5 @@ IMG_0140=Creating multiplatform image manifest {0}. IMG_0141=Creating command: adding image {0} to manifest {1}. IMG_0142=Creating command: push image manifest {0} to repo. IMG_0143=Creating command: push image to repo {0}. -IMG_0144=Setting up manifest and image: {0}. \ No newline at end of file +IMG_0144=Setting up manifest and image: {0}. +IMG_0145=Cannot find installer [type: {0}, platform: {1}, version: {2}]. \ No newline at end of file diff --git a/imagetool/src/main/resources/docker-files/Rebase_Image.mustache b/imagetool/src/main/resources/docker-files/Rebase_Image.mustache deleted file mode 100644 index 2fd3bbd1..00000000 --- a/imagetool/src/main/resources/docker-files/Rebase_Image.mustache +++ /dev/null @@ -1,95 +0,0 @@ -# Copyright (c) 2019, 2024, Oracle and/or its affiliates. -# Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl. -# - -{{#isRebaseToTarget}} -FROM {{sourceImage}} as source_image -FROM {{targetImage}} as final_build -{{#buildArgs}}ARG {{{.}}} -{{/buildArgs}} -ARG TARGETPLATFORM - -ENV DOMAIN_HOME={{{domain_home}}} -LABEL com.oracle.weblogic.imagetool.buildid="{{buildId}}" - -{{/isRebaseToTarget}} -{{#isRebaseToNew}} - FROM {{sourceImage}} as source_image - FROM {{baseImage}} as os_update - ARG TARGETPLATFORM - - ENV DOMAIN_HOME={{{domain_home}}} - - LABEL com.oracle.weblogic.imagetool.buildid="{{buildId}}" - USER root - {{#initialBuildCommands}} - {{{.}}} - {{/initialBuildCommands}} - # Use package manager to make sure that unzip, tar, and other required packages are installed - {{> package-managers}} - - # Create the Oracle user that will be the owner of the installed software - {{> create-user-group}} - - # If Java is not already in the base image, install it - {{#installJava}} - {{> install-java }} - {{/installJava}} - - # If an Oracle Home is not already in the base image, install the middleware components - {{#installMiddleware}} - {{> install-middleware }} - {{/installMiddleware}} - - FROM os_update as final_build - {{#buildArgs}}ARG {{{.}}} - {{/buildArgs}} - ARG TARGETPLATFORM - - ENV ORACLE_HOME={{{oracle_home}}} \ - LD_LIBRARY_PATH={{{oracle_home}}}/oracle_common/adr:$LD_LIBRARY_PATH \ - {{#installJava}} - JAVA_HOME={{{java_home}}} \ - {{/installJava}} - PATH=${PATH}:{{{java_home}}}/bin:{{{oracle_home}}}/oracle_common/common/bin:{{{oracle_home}}}/wlserver/common/bin:{{{oracle_home}}} - - LABEL com.oracle.weblogic.imagetool.buildid="{{buildId}}" - - {{#installJava}} - COPY --from=jdk_build --chown={{userid}}:{{groupid}} {{{java_home}}} {{{java_home}}}/ - {{/installJava}} - - {{#installMiddleware}} - COPY --from=wls_build --chown={{userid}}:{{groupid}} {{{oracle_home}}} {{{oracle_home}}}/ - {{/installMiddleware}} - - {{#copyOraInst}} - COPY --from=wls_build --chown={{userid}}:{{groupid}} {{inv_loc}}/oraInst.loc {{inv_loc}}/oraInst.loc - {{/copyOraInst}} - {{#copyOraInventoryDir}} - COPY --from=wls_build --chown={{userid}}:{{groupid}} {{orainv_dir}} {{orainv_dir}}/ - {{/copyOraInventoryDir}} -{{/isRebaseToNew}} - -USER {{userid}} -RUN mkdir -p {{domain_home}} -{{^modelOnly}} - COPY --from=source_image --chown={{userid}}:{{groupid}} {{domain_home}} {{domain_home}}/ -{{/modelOnly}} -{{#modelOnly}} - COPY --from=source_image --chown={{userid}}:{{groupid}} {{{wdt_home}}} {{{wdt_home}}}/ - {{#isWdtModelHomeOutsideWdtHome}} - COPY --from=wdt_build --chown={{userid}}:{{groupid}} {{wdt_model_home}} {{wdt_model_home}}/ - {{/isWdtModelHomeOutsideWdtHome}} -{{/modelOnly}} - -{{#useOwnerPermsForGroup}} - RUN chmod -R g=u {{{domain_home}}} -{{/useOwnerPermsForGroup}} - -WORKDIR {{{work_dir}}} - -{{#finalBuildCommands}} - {{{.}}} -{{/finalBuildCommands}} - From 2fd60264960b096e69272c7b7f571629b0714e34 Mon Sep 17 00:00:00 2001 From: jshum Date: Tue, 31 Dec 2024 16:00:44 -0600 Subject: [PATCH 064/104] update notes --- .../userguide/tools/multiplatorm-build.md | 83 ++++++++++++++++++- 1 file changed, 82 insertions(+), 1 deletion(-) diff --git a/documentation/site/content/userguide/tools/multiplatorm-build.md b/documentation/site/content/userguide/tools/multiplatorm-build.md index dd4627c4..9f54ed8e 100644 --- a/documentation/site/content/userguide/tools/multiplatorm-build.md +++ b/documentation/site/content/userguide/tools/multiplatorm-build.md @@ -15,7 +15,7 @@ notes: 3. try ps axwww | grep qemu to see if there are multiple java processes for the installation. 4. after podman system prune - I have to run the qemu setup again 5. qemu is not installed properly, the above method put files in /proc/sys/fs/binfmt_misc/qemu* - +6. Completely disabled selinux seems to resolve issue, check also /var/log/messages , /var/log/audit/audit.log --- @@ -51,6 +51,87 @@ driver = "overlay" mount_program = "/usr/bin/fuse-overlayfs" +completely disabled selinux (rather than permissive by setenforce 0) + +/etc/selinux/config + + +podman system reset + +and install qemu again. + + +============================== + +cat /var/log/messages + +Dec 31 20:23:46 ol8-machine setroubleshoot[239987]: SELinux is preventing /usr/bin/qemu-aarch64 from read access on the file qemu-aarch64. For complete SELinux messages run: sealert -l 3e9c70c9-80e1-4abc-8a12-39f2846b5a10 +Dec 31 20:23:46 ol8-machine setroubleshoot[239987]: SELinux is preventing /usr/bin/qemu-aarch64 from read access on the file qemu-aarch64.#012#012***** Plugin catchall (100. confidence) suggests **************************#012#012If you believe that qemu-aarch64 should be allowed read access on the qemu-aarch64 file by default.#012Then you should report this as a bug.#012You can generate a local policy module to allow this access.#012Do#012allow this access for now by executing:#012# ausearch -c 'sh' --raw | audit2allow -M my-sh#012# semodule -X 300 -i my-sh.pp#012 +Dec 31 20:23:46 ol8-machine setroubleshoot[239987]: SELinux is preventing /usr/bin/qemu-aarch64 from read access on the file qemu-aarch64. For complete SELinux messages run: sealert -l 3e9c70c9-80e1-4abc-8a12-39f2846b5a10 +Dec 31 20:23:46 ol8-machine setroubleshoot[239987]: SELinux is preventing /usr/bin/qemu-aarch64 from read access on the file qemu-aarch64.#012#012***** Plugin catchall (100. confidence) suggests **************************#012#012If you believe that qemu-aarch64 should be allowed read access on the qemu-aarch64 file by default.#012Then you should report this as a bug.#012You can generate a local policy module to allow this access.#012Do#012allow this access for now by executing:#012# ausearch -c 'sh' --raw | audit2allow -M my-sh#012# semodule -X 300 -i my-sh.pp#012 +Dec 31 20:23:49 ol8-machine setroubleshoot[239987]: SELinux is preventing /usr/bin/qemu-aarch64 from read access on the file qemu-aarch64. For complete SELinux messages run: sealert -l 3e9c70c9-80e1-4abc-8a12-39f2846b5a10 +Dec 31 20:23:49 ol8-machine setroubleshoot[239987]: SELinux is preventing /usr/bin/qemu-aarch64 from read access on the file qemu-aarch64.#012#012***** Plugin catchall (100. confidence) suggests **************************#012#012If you believe that qemu-aarch64 should be allowed read access on the qemu-aarch64 file by default.#012Then you should report this as a bug.#012You can generate a local policy module to allow this access.#012Do#012allow this access for now by executing:#012# ausearch -c 'sh' --raw | audit2allow -M my-sh#012# semodule -X 300 -i my-sh.pp#012 +Dec 31 20:23:49 ol8-machine setroubleshoot[239987]: SELinux is preventing /usr/bin/qemu-aarch64 from read access on the file qemu-aarch64. For complete SELinux messages run: sealert -l 3e9c70c9-80e1-4abc-8a12-39f2846b5a10 +Dec 31 20:23:49 ol8-machine setroubleshoot[239987]: SELinux is preventing /usr/bin/qemu-aarch64 from read access on the file qemu-aarch64.#012#012***** Plugin catchall (100. confidence) suggests **************************#012#012If you believe that qemu-aarch64 should be allowed read access on the qemu-aarch64 file by default.#012Then you should report this as a bug.#012You can generate a local policy module to allow this access.#012Do#012allow this access for now by executing:#012# ausearch -c 'sh' --raw | audit2allow -M my-sh#012# semodule -X 300 -i my-sh.pp#012 + +======== + +When you encounter an error stating that Podman build is being prevented by SELinux from allowing "qemu-aarch64" to read access, it means that your system's Security Enhanced Linux (SELinux) policy is blocking the necessary permissions for the QEMU emulator to read files within the containerized environment, likely due to strict access controls; to fix this, you can create a custom SELinux policy rule to grant the required read access to QEMU within the container context. +Key points to understand: +SELinux and Containers: +SELinux assigns security labels to files and processes, which can sometimes restrict access when running containers, especially when using features like volume mounts. +QEMU and ARM emulation: +If you're building a container with an ARM architecture using "qemu-aarch64" on a different architecture, SELinux might need additional permissions to allow the emulation process to read necessary files. +How to troubleshoot and fix: +Check SELinux logs: +Run sudo grep 'qemu-aarch64' /var/log/audit/audit.log to see if there are any SELinux AVC (Access Vector Cache) messages related to the QEMU process. +Temporarily disable SELinux (not recommended): +To quickly test if SELinux is the issue, run sudo setenforce 0. +Important: Re-enable SELinux with sudo setenforce 1 after testing. +Create a custom SELinux policy: +Identify the issue: Analyze the SELinux logs to determine which specific file access is being denied and the SELinux context of the file. +Use sepolicy: +Edit the SELinux policy file (/etc/selinux/policy/base/container_file_t) to add a rule allowing the "qemu-aarch64" process to read files with the relevant context. +Example: +Code + + allow container_file_t qemu_aarch64_t:file r_file_perms; +Compile and reload the policy: +Run make within the /etc/selinux/policy directory to compile the modified policy. +Restart the SELinux daemon to apply the changes (usually done with a system reboot). +Important Considerations: +Security implications: +Always carefully review and test custom SELinux policy changes as granting too much access can introduce security vulnerabilities. +Consult documentation: + + +============ + +Step 1: Adjust the Command +The command ausearch -c 'sh' --raw | audit2allow -M my-sh might be too broad. Try to focus on the specific denials for qemu-aarch64. Use: +bash +ausearch -m avc -c qemu-aarch64 --raw | audit2allow -M my-qemu +This command will look for AVC (Access Vector Cache) messages related specifically to qemu-aarch64. + +Step 2: Review and Modify Policy +If the above command still results in errors, you might need to manually edit the generated .te file before compiling: +After running the audit2allow command, it should create my-qemu.te in your current directory. Open this file: +bash +nano my-qemu.te +Look for any lines starting with mlsconstrain. If they are causing issues, you might want to comment them out or remove them since they might not be necessary for your specific use case: +text +# mlsconstrain file { ioctl read lock execute execute_no_trans } ((h1 dom h2 -Fail-) or (t1 != mcs_constrained_type -Fail-) ); +# mlsconstrain file { write setattr append unlink link rename } ((h1 dom h2 -Fail-) or (t1 != mcs_constrained_type -Fail-) ); +After modifying, save the file. + +Step 3: Compile and Load the Policy +Try to compile the policy again: +bash +checkmodule -M -m -o my-qemu.mod my-qemu.te +semodule_package -o my-qemu.pp -m my-qemu.mod +semodule -i my-qemu.pp + + ======== TODO: From 80d429b3c06a50826b51935d6e2aa404d512df5b Mon Sep 17 00:00:00 2001 From: jshum Date: Fri, 3 Jan 2025 14:26:06 -0600 Subject: [PATCH 065/104] clean up --- .../userguide/tools/multiplatorm-build.md | 8 ++- .../imagetool/builder/AbstractCommand.java | 5 +- .../imagetool/cachestore/CacheStore.java | 6 +-- .../cli/cache/AddInstallerEntry.java | 3 +- .../cli/cache/CacheAddOperation.java | 5 +- .../imagetool/cli/cache/DeletePatch.java | 42 +++++++++------- .../imagetool/cli/cache/ListCacheItems.java | 50 ------------------- .../imagetool/cli/cache/ListInstallers.java | 21 ++++---- .../imagetool/cli/cache/ListPatches.java | 3 +- .../cli/menu/CommonCreateOptions.java | 2 +- .../imagetool/logging/ConsoleFormatter.java | 2 +- .../imagetool/logging/FileFormatter.java | 2 +- .../imagetool/settings/UserSettingsFile.java | 8 +-- .../imagetool/settings/YamlFileConstants.java | 14 +++--- .../oracle/weblogic/imagetool/util/Utils.java | 5 +- .../cli/cache/AddInstallerEntryTest.java | 2 +- .../cli/cache/AddPatchEntryTest.java | 3 +- 17 files changed, 63 insertions(+), 118 deletions(-) delete mode 100644 imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/ListCacheItems.java diff --git a/documentation/site/content/userguide/tools/multiplatorm-build.md b/documentation/site/content/userguide/tools/multiplatorm-build.md index 9f54ed8e..30f03a7b 100644 --- a/documentation/site/content/userguide/tools/multiplatorm-build.md +++ b/documentation/site/content/userguide/tools/multiplatorm-build.md @@ -25,12 +25,16 @@ echo 'username:100000:65536' | sudo tee -a /etc/subgid echo 'user.max_user_namespaces=28633' | sudo tee -a /etc/sysctl.d/userns.conf sudo sysctl -p /etc/sysctl.d/userns.conf -mkdir -p /path/to/storage/$USER +mkdir -p $HOME/containers/storage mkdir -p ~/.config/containers echo "[storage] driver = \"overlay\" -rootless_storage_path = \"/path/to/storage/$USER\"" > ~/.config/containers/storage.conf +rootless_storage_path = \"$HOME/containers/storage\" +[storage.options.overlay] +mount_program = \"/usr/bin/fuse-overlayfs\"" > ~/.config/containers/storage.conf + +podman system reset sudo loginctl enable-linger username diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/builder/AbstractCommand.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/builder/AbstractCommand.java index 609eedcd..894c9412 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/builder/AbstractCommand.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/builder/AbstractCommand.java @@ -103,11 +103,10 @@ private Thread writeFromInputToOutputStreams(InputStream inputStream, Path docke } String line; while ((line = processReader.readLine()) != null) { - String finalLine = line; if (logWriter != null) { - logWriter.println(finalLine); + logWriter.println(line); } - stdoutWriter.println(finalLine); + stdoutWriter.println(line); } } catch (IOException e) { logger.severe(e.getMessage()); diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cachestore/CacheStore.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cachestore/CacheStore.java index 30032a3f..ca811e38 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cachestore/CacheStore.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cachestore/CacheStore.java @@ -39,8 +39,8 @@ */ public class CacheStore { - public static String CACHE_KEY_SEPARATOR = "_"; - public static String CACHE_DIR_ENV = "WLSIMG_CACHEDIR"; + public static final String CACHE_KEY_SEPARATOR = "_"; + public static final String CACHE_DIR_ENV = "WLSIMG_CACHEDIR"; private static final LoggingFacade logger = LoggingFactory.getLogger(UserSettingsFile.class); @@ -194,7 +194,7 @@ public InstallerMetaData getInstallerForPlatform(InstallerType installerType, Ar installerVersion = ConfigManager.getInstance().getDefaultWDTVersion(); break; default: - installerVersion = null; + break; } if (installerVersion == null) { logger.throwing(new IllegalArgumentException("Cannot determine installer version for installer type " diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/AddInstallerEntry.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/AddInstallerEntry.java index 16969e33..6304a680 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/AddInstallerEntry.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/AddInstallerEntry.java @@ -6,7 +6,6 @@ import java.io.IOException; import com.oracle.weblogic.imagetool.api.model.CommandResponse; -import com.oracle.weblogic.imagetool.cachestore.CacheStoreException; import com.oracle.weblogic.imagetool.installer.InstallerType; import com.oracle.weblogic.imagetool.util.Architecture; import picocli.CommandLine.Command; @@ -20,7 +19,7 @@ public class AddInstallerEntry extends CacheAddOperation { @Override - public CommandResponse call() throws IOException, CacheStoreException { + public CommandResponse call() throws IOException { if ("NONE".equalsIgnoreCase(version)) { throw new IllegalArgumentException("IMG-0105"); } diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/CacheAddOperation.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/CacheAddOperation.java index e5376cfe..3e6bff61 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/CacheAddOperation.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/CacheAddOperation.java @@ -9,7 +9,6 @@ import com.oracle.weblogic.imagetool.api.model.CommandResponse; import com.oracle.weblogic.imagetool.cachestore.CacheStore; -import com.oracle.weblogic.imagetool.cachestore.CacheStoreException; import com.oracle.weblogic.imagetool.installer.InstallerMetaData; import com.oracle.weblogic.imagetool.installer.InstallerType; import com.oracle.weblogic.imagetool.patch.PatchMetaData; @@ -30,7 +29,7 @@ public abstract class CacheAddOperation extends CacheOperation { public abstract String getDescription(); - CommandResponse addInstallerToCache() throws IOException, CacheStoreException { + CommandResponse addInstallerToCache() throws IOException { if (filePath == null || !Files.isRegularFile(filePath)) { return CommandResponse.error("IMG-0049", filePath); } @@ -56,7 +55,7 @@ CommandResponse addInstallerToCache() throws IOException, CacheStoreException { return CommandResponse.success("IMG-0050", type, metaData.getProductVersion(), metaData.getLocation()); } - CommandResponse addPatchToCache() throws IOException, CacheStoreException { + CommandResponse addPatchToCache() throws IOException { // if file is invalid or does not exist, return an error if (filePath == null || !Files.isRegularFile(filePath)) { return CommandResponse.error("IMG-0049", filePath); diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/DeletePatch.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/DeletePatch.java index 9e0e2c23..04b07ce5 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/DeletePatch.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/DeletePatch.java @@ -4,6 +4,7 @@ package com.oracle.weblogic.imagetool.cli.cache; import java.io.IOException; +import java.util.Iterator; import java.util.List; import java.util.Map; import java.util.Optional; @@ -23,37 +24,42 @@ ) public class DeletePatch extends CacheOperation { + private boolean isPatchVersionMatched(List items) { + return Optional.ofNullable(items) + .map(list -> list.stream().anyMatch(i -> i.getPatchVersion().equals(version) + && Architecture.fromString(i.getArchitecture()).equals(architecture))).orElse(false); + } + @Override public CommandResponse call() throws CacheStoreException { ConfigManager configManager = ConfigManager.getInstance(); Map> data = configManager.getAllPatches(); + if (patchId == null || version == null || architecture == null) { return CommandResponse.success("IMG-0126"); } - boolean exists = false; - for (String id : data.keySet()) { - if (patchId != null && !patchId.equalsIgnoreCase(id)) { - continue; - } - List items = data.get(id); - exists = Optional.ofNullable(items) - .map(list -> list.stream().anyMatch(i -> i.getPatchVersion().equals(version) - && Architecture.fromString(i.getArchitecture()).equals(architecture))).orElse(false); - if (exists) { - Optional.ofNullable(items) + + for (Iterator iterator = data.keySet().iterator(); iterator.hasNext(); ) { + String id = iterator.next(); + if (patchId.equalsIgnoreCase(id)) { + List items = data.get(id); + if (isPatchVersionMatched(items)) { + + Optional.of(items) .map(list -> list.removeIf(i -> i.getPatchVersion().equals(version) && Architecture.fromString(i.getArchitecture()).equals(architecture))); - - if (items.isEmpty()) { - data.remove(id); + // if all patches are removed for this bug number, remove this bug number from the store. + if (items.isEmpty()) { + data.remove(id); + } + break; + + } else { + return CommandResponse.success("IMG-0127"); } - break; } } - if (!exists) { - return CommandResponse.success("IMG-0127"); - } try { configManager.saveAllPatches(data); } catch (IOException e) { diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/ListCacheItems.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/ListCacheItems.java deleted file mode 100644 index 54c7df4c..00000000 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/ListCacheItems.java +++ /dev/null @@ -1,50 +0,0 @@ -// Copyright (c) 2019, 2024, 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.cli.cache; - -import java.io.IOException; -import java.nio.file.Files; -import java.nio.file.Path; -import java.nio.file.Paths; - -import com.oracle.weblogic.imagetool.api.model.CommandResponse; -import com.oracle.weblogic.imagetool.cachestore.CacheStoreException; -import com.oracle.weblogic.imagetool.settings.ConfigManager; -import picocli.CommandLine.Command; -import picocli.CommandLine.Option; - - -@Command( - name = "listItems", - description = "List cache contents" -) -public class ListCacheItems extends CacheOperation { - - @Override - public CommandResponse call() throws CacheStoreException { - String fileName; - if ("patches".equalsIgnoreCase(type)) { - fileName = ConfigManager.getInstance().getPatchDetailsFile(); - } else { - fileName = ConfigManager.getInstance().getInstallerDetailsFile(); - } - if (fileName != null) { - try { - Path path = Paths.get(fileName); - Files.lines(path).forEach(System.out::println); - } catch (IOException ioException) { - System.err.println("Unable to read file: " + fileName); - } - } - return CommandResponse.success(null); - - } - - @Option( - names = {"--type"}, - description = "list type type : patches, installers (default: installers)" - ) - private String type; - -} diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/ListInstallers.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/ListInstallers.java index e0209e38..ee8f4409 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/ListInstallers.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/ListInstallers.java @@ -7,7 +7,6 @@ import java.util.Map; import com.oracle.weblogic.imagetool.api.model.CommandResponse; -import com.oracle.weblogic.imagetool.cachestore.CacheStoreException; import com.oracle.weblogic.imagetool.installer.InstallerMetaData; import com.oracle.weblogic.imagetool.installer.InstallerType; import com.oracle.weblogic.imagetool.settings.ConfigManager; @@ -22,21 +21,19 @@ public class ListInstallers extends CacheOperation { @Override - public CommandResponse call() throws CacheStoreException { + public CommandResponse call() { ConfigManager configManager = ConfigManager.getInstance(); Map>> data = configManager.getInstallers(); - if (commonName != null && !commonName.isEmpty()) { - if (type == null) { - System.out.println("--type cannot be null when commonName is specified"); - System.exit(2); - } + if (commonName != null && !commonName.isEmpty() && type == null) { + System.out.println("--type cannot be null when commonName is specified"); + System.exit(2); } - if (version != null && !version.isEmpty()) { - if (type == null) { - System.out.println("--type cannot be null when version is specified"); - System.exit(2); - } + + if (version != null && !version.isEmpty() && type == null) { + System.out.println("--type cannot be null when version is specified"); + System.exit(2); } + for (String itemType : data.keySet()) { if (type != null && type != InstallerType.fromString(itemType)) { continue; diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/ListPatches.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/ListPatches.java index ae38be1b..2aca27b8 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/ListPatches.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/ListPatches.java @@ -7,7 +7,6 @@ import java.util.Map; import com.oracle.weblogic.imagetool.api.model.CommandResponse; -import com.oracle.weblogic.imagetool.cachestore.CacheStoreException; import com.oracle.weblogic.imagetool.patch.PatchMetaData; import com.oracle.weblogic.imagetool.settings.ConfigManager; import picocli.CommandLine.Command; @@ -21,7 +20,7 @@ public class ListPatches extends CacheOperation { @Override - public CommandResponse call() throws CacheStoreException { + public CommandResponse call() { ConfigManager configManager = ConfigManager.getInstance(); Map> data = configManager.getAllPatches(); diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonCreateOptions.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonCreateOptions.java index b55f15c8..0c969039 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonCreateOptions.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonCreateOptions.java @@ -150,7 +150,7 @@ private String resetJDKVersion(String jdkVersion) { private String resetInstallerVersion(InstallerType installerType, String installerVersion) { String fixedVersion = installerVersion; - String defaultVersion = null; + String defaultVersion; switch (installerType) { case JDK: diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/logging/ConsoleFormatter.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/logging/ConsoleFormatter.java index 3182cce6..a31b9f4d 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/logging/ConsoleFormatter.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/logging/ConsoleFormatter.java @@ -17,7 +17,7 @@ * Format is "[ LEVEL ] message", with optional throw-ables. */ public class ConsoleFormatter extends Formatter { - private static final String LINE_SEPARATOR = System.getProperty("line.separator"); + private static final String LINE_SEPARATOR = System.lineSeparator(); public static final Pattern colorPattern = Pattern.compile("\\[\\[([a-z]+): (.+?)]]"); static { diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/logging/FileFormatter.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/logging/FileFormatter.java index 2a2ea434..d06937d8 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/logging/FileFormatter.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/logging/FileFormatter.java @@ -20,7 +20,7 @@ public class FileFormatter extends Formatter { private static final Pattern CATALOG_KEY_PATTERN = Pattern.compile(CATALOG_KEY_PATTERN_STRING); private static final String DATE_FORMAT_STRING = "####<{0,date,yyyy.MM.dd} {0,time,HH:mm:ss}>"; - private static final String LINE_SEPARATOR = System.getProperty("line.separator"); + private static final String LINE_SEPARATOR = System.lineSeparator(); private Object[] args; private MessageFormat formatter; diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/UserSettingsFile.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/UserSettingsFile.java index 78f6e5f3..eee349df 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/UserSettingsFile.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/UserSettingsFile.java @@ -275,10 +275,6 @@ public Map getInstallerSettings() { return installerSettings; } - public String defaultWLSVersion() { - return "hello"; - } - private void applySettings(Map settings) { logger.entering(); if (settings == null || settings.isEmpty()) { @@ -320,8 +316,8 @@ public String getDefaultBuildPlatform() { return defaultBuildPlatform; } - public String setDefaultBuildPlatform(String value) { - return defaultBuildPlatform = value; + public void setDefaultBuildPlatform(String value) { + defaultBuildPlatform = value; } public String returnInstallerSettingsFile() { diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/YamlFileConstants.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/YamlFileConstants.java index a367ade6..c4cda8f3 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/YamlFileConstants.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/YamlFileConstants.java @@ -6,11 +6,11 @@ public class YamlFileConstants { // Do not change the values, it affect the persisted YAML file and will break compatibility - public static String ARCHITECTURE = "architecture"; - public static String DATE_ADDED = "dateAdded"; - public static String DESCRIPTION = "description"; - public static String DIGEST = "digest"; - public static String LOCATION = "location"; - public static String PATCH_VERSION = "patchVersion"; - public static String PRODUCT_VERSION = "productVersion"; + public static final String ARCHITECTURE = "architecture"; + public static final String DATE_ADDED = "dateAdded"; + public static final String DESCRIPTION = "description"; + public static final String DIGEST = "digest"; + public static final String LOCATION = "location"; + public static final String PATCH_VERSION = "patchVersion"; + public static final String PRODUCT_VERSION = "productVersion"; } diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/util/Utils.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/util/Utils.java index 54ebfd6e..38b0bea3 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/util/Utils.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/util/Utils.java @@ -865,9 +865,6 @@ public static String standardPlatform(String platform) { */ public static boolean isGenericInstallerAcceptable(InstallerType type) { List types = Arrays.asList(InstallerType.WDT); - if (types.contains(type)) { - return true; - } - return false; + return types.contains(type); } } diff --git a/imagetool/src/test/java/com/oracle/weblogic/imagetool/cli/cache/AddInstallerEntryTest.java b/imagetool/src/test/java/com/oracle/weblogic/imagetool/cli/cache/AddInstallerEntryTest.java index a00bedab..f0f2d7a9 100644 --- a/imagetool/src/test/java/com/oracle/weblogic/imagetool/cli/cache/AddInstallerEntryTest.java +++ b/imagetool/src/test/java/com/oracle/weblogic/imagetool/cli/cache/AddInstallerEntryTest.java @@ -22,7 +22,7 @@ class AddInstallerEntryTest { @BeforeAll - static void setup(@TempDir Path tempDir) throws IOException, NoSuchFieldException, IllegalAccessException { + static void setup(@TempDir Path tempDir) throws IOException { TestSetup.setup(tempDir); } diff --git a/imagetool/src/test/java/com/oracle/weblogic/imagetool/cli/cache/AddPatchEntryTest.java b/imagetool/src/test/java/com/oracle/weblogic/imagetool/cli/cache/AddPatchEntryTest.java index 2bb3b0da..7594346a 100644 --- a/imagetool/src/test/java/com/oracle/weblogic/imagetool/cli/cache/AddPatchEntryTest.java +++ b/imagetool/src/test/java/com/oracle/weblogic/imagetool/cli/cache/AddPatchEntryTest.java @@ -30,8 +30,7 @@ class AddPatchEntryTest { @BeforeAll - static void setup(@TempDir Path tempDir) - throws IOException, NoSuchFieldException, IllegalAccessException { + static void setup(@TempDir Path tempDir) throws IOException { Path settingsFileName = tempDir.resolve("settings.yaml"); Path installerFile = tempDir.resolve("installers.yaml"); Path patchFile = tempDir.resolve("patches.yaml"); From f8c38ae144bbc3aaf54418205b783aa2bb17812a Mon Sep 17 00:00:00 2001 From: jshum Date: Fri, 3 Jan 2025 15:25:24 -0600 Subject: [PATCH 066/104] cleanup --- .../cli/cache/CacheAddOperation.java | 9 -- .../imagetool/util/CacheConversion.java | 128 ++++++++---------- 2 files changed, 60 insertions(+), 77 deletions(-) diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/CacheAddOperation.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/CacheAddOperation.java index 3e6bff61..e6a9d938 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/CacheAddOperation.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/CacheAddOperation.java @@ -86,15 +86,6 @@ CommandResponse addPatchToCache() throws IOException { filePath.toAbsolutePath().toString()); } - private Path absolutePath() { - if (absolutePath == null) { - absolutePath = filePath.toAbsolutePath(); - } - return absolutePath; - } - - private Path absolutePath = null; - @Option( names = {"--force"}, description = "Overwrite existing entry, if it exists" diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/util/CacheConversion.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/util/CacheConversion.java index 328bcacb..dac1dac2 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/util/CacheConversion.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/util/CacheConversion.java @@ -42,7 +42,7 @@ ) public class CacheConversion extends CacheOperation { - private static final LoggingFacade logger = LoggingFactory.getLogger(OPatchFile.class); + private static final LoggingFacade logger = LoggingFactory.getLogger(CacheConversion.class); private static final String PATCH_PATTERN = "^(wls|fmw|ohs|wlsdev|wlsslim|soa|osb|b2b|mft|idm|db19|" + "oud|oid|wcc|wcp|wcs|jdk|wdt|odi|\\d{8,9})(?:_(\\d\\d(?:\\.\\d){3,8}\\.\\d+)(?:_(.*))?)?=(.*)$"; @@ -65,49 +65,57 @@ public void convert(String inputFile) throws IOException { } // patches if (Character.isDigit(line.charAt(0))) { - Matcher matcher = patchPattern.matcher(line); - if (matcher.matches()) { - String key = matcher.group(1); - String version = matcher.group(2); - String arch = matcher.group(3); - String filepath = matcher.group(4); - String fileDate = getFileDate(filepath); - if (arch == null) { - arch = Utils.standardPlatform(Architecture.getLocalArchitecture().toString()); - } - if (fileDate != null) { - ConfigManager.getInstance().addPatch(key, arch, filepath, version, - "Converted from v1 in " + fileDate, fileDate); - } - } else { - logger.warning("IMG-0128", line); - } + handlePatchPattern(patchPattern, line); } else { // installer - Matcher matcher = installerPattern.matcher(line); - if (matcher.matches()) { - String key = matcher.group(1); - String version = matcher.group(2); - String arch = matcher.group(3); - String filepath = matcher.group(4); - String fileDate = getFileDate(filepath); - if (arch == null) { - arch = Utils.standardPlatform(Architecture.getLocalArchitecture().toString()); - } - if (fileDate != null) { - InstallerMetaData metaData = new InstallerMetaData(arch, filepath, - Utils.getSha256Hash(filepath), fileDate, version); - ConfigManager.getInstance().addInstaller(InstallerType.fromString(key), version, metaData); - } - } else { - logger.warning("IMG-0128", line); - } + handleInstallerPattern(installerPattern, line); } } } } + private void handleInstallerPattern(Pattern installerPattern, String line) throws IOException { + Matcher matcher = installerPattern.matcher(line); + if (matcher.matches()) { + String key = matcher.group(1); + String version = matcher.group(2); + String arch = matcher.group(3); + String filepath = matcher.group(4); + String fileDate = getFileDate(filepath); + if (arch == null) { + arch = Utils.standardPlatform(Architecture.getLocalArchitecture().toString()); + } + if (fileDate != null) { + InstallerMetaData metaData = new InstallerMetaData(arch, filepath, + Utils.getSha256Hash(filepath), fileDate, version); + ConfigManager.getInstance().addInstaller(InstallerType.fromString(key), version, metaData); + } + } else { + logger.warning("IMG-0128", line); + } + } + + private void handlePatchPattern(Pattern patchPattern, String line) throws IOException { + Matcher matcher = patchPattern.matcher(line); + if (matcher.matches()) { + String key = matcher.group(1); + String version = matcher.group(2); + String arch = matcher.group(3); + String filepath = matcher.group(4); + String fileDate = getFileDate(filepath); + if (arch == null) { + arch = Utils.standardPlatform(Architecture.getLocalArchitecture().toString()); + } + if (fileDate != null) { + ConfigManager.getInstance().addPatch(key, arch, filepath, version, + "Converted from v1 in " + fileDate, fileDate); + } + } else { + logger.warning("IMG-0128", line); + } + } + private String getFileDate(String filepath) { try { Path path = Paths.get(filepath); @@ -140,35 +148,7 @@ private boolean initializeSettingFiles(String directory) { Path settingsPath = directoryPath.resolve("settings.yaml"); if (!Files.exists(settingsPath)) { - logger.fine("No existing settings file creating it"); - createIfNotExists(settingsPath, false); - Path parentPath = settingsPath.getParent(); - List lines = new ArrayList<>(); - lines.add("installerDirectory: " + parentPath.resolve("installers").toString()); - lines.add("patchDirectory: " + parentPath.resolve("patches").toString()); - lines.add("installerSettingsFile: " + parentPath.resolve("installers.yaml").toString()); - lines.add("patchSettingsFile: " + parentPath.resolve("patches.yaml").toString()); - createIfNotExists(parentPath.resolve("installers"), true); - createIfNotExists(parentPath.resolve("patches"), true); - createIfNotExists(parentPath.resolve("installers.yaml"), false); - createIfNotExists(parentPath.resolve("patches.yaml"), false); - - Files.write(settingsPath, lines); - } else { - logger.fine("Existing settings file already exists"); - Yaml yaml = new Yaml(); - File yamlFile = new File(settingsPath.toAbsolutePath().toString()); - Map settings = yaml.loadAs(Files.newInputStream(yamlFile.toPath()), Map.class); - if (settings != null) { - if (!settings.containsKey("installerSettingsFile")) { - logger.warning("IMG_0137", "installerSettingsFile"); - return false; - } - if (!settings.containsKey("patchSettingsFile")) { - logger.warning("IMG_0137", "patchSettingsFile"); - return false; - } - } + createNewSettingsYaml(settingsPath); } } } catch (Exception ex) { @@ -179,16 +159,28 @@ private boolean initializeSettingFiles(String directory) { return success; } + private void createNewSettingsYaml(Path settingsPath) throws IOException { + logger.fine("No existing settings file creating it"); + createIfNotExists(settingsPath, false); + Path parentPath = settingsPath.getParent(); + List lines = new ArrayList<>(); + lines.add("installerDirectory: " + parentPath.resolve("installers").toString()); + lines.add("patchDirectory: " + parentPath.resolve("patches").toString()); + createIfNotExists(parentPath.resolve("installers"), true); + createIfNotExists(parentPath.resolve("patches"), true); + createIfNotExists(parentPath.resolve("installers.yaml"), false); + createIfNotExists(parentPath.resolve("patches.yaml"), false); + + Files.write(settingsPath, lines); + } + private void createIfNotExists(Path entry, boolean isDir) throws IOException { - System.out.println(" create if not exists " + entry.toString() + " " + isDir); if (Files.exists(entry)) { return; } if (isDir) { - System.out.println(" create if not exists create dir"); Files.createDirectory(entry); } else { - System.out.println(" create if not exists create file"); Files.createFile(entry); } } From 0136bc2b0553b6cde18bfcad38c1b5797643b631 Mon Sep 17 00:00:00 2001 From: jshum Date: Fri, 3 Jan 2025 17:53:50 -0600 Subject: [PATCH 067/104] cleanup --- .../com/oracle/weblogic/imagetool/util/CacheConversion.java | 5 ----- 1 file changed, 5 deletions(-) diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/util/CacheConversion.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/util/CacheConversion.java index dac1dac2..dd0318f8 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/util/CacheConversion.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/util/CacheConversion.java @@ -4,7 +4,6 @@ package com.oracle.weblogic.imagetool.util; import java.io.BufferedReader; -import java.io.File; import java.io.FileReader; import java.io.IOException; import java.nio.file.Files; @@ -16,20 +15,17 @@ import java.time.format.DateTimeFormatter; import java.util.ArrayList; import java.util.List; -import java.util.Map; import java.util.regex.Matcher; import java.util.regex.Pattern; import com.oracle.weblogic.imagetool.api.model.CommandResponse; import com.oracle.weblogic.imagetool.cachestore.CacheStore; -import com.oracle.weblogic.imagetool.cachestore.OPatchFile; import com.oracle.weblogic.imagetool.cli.cache.CacheOperation; import com.oracle.weblogic.imagetool.installer.InstallerMetaData; import com.oracle.weblogic.imagetool.installer.InstallerType; import com.oracle.weblogic.imagetool.logging.LoggingFacade; import com.oracle.weblogic.imagetool.logging.LoggingFactory; import com.oracle.weblogic.imagetool.settings.ConfigManager; -import org.yaml.snakeyaml.Yaml; import picocli.CommandLine; /** @@ -69,7 +65,6 @@ public void convert(String inputFile) throws IOException { } else { // installer handleInstallerPattern(installerPattern, line); - } } } From e7c752f0906e6010bfe5fe861a391f62d7a39d23 Mon Sep 17 00:00:00 2001 From: jshum Date: Tue, 7 Jan 2025 10:41:37 -0600 Subject: [PATCH 068/104] refactor --- .../userguide/tools/multiplatorm-build.md | 2 +- .../imagetool/cachestore/CacheStore.java | 6 ++--- .../cli/menu/CommonCreateOptions.java | 7 +++--- .../imagetool/cli/menu/CreateImage.java | 10 ++++---- .../installer/MiddlewareInstall.java | 12 ++++++---- .../imagetool/util/CacheConversion.java | 2 +- .../src/main/resources/ImageTool.properties | 24 ++++++++++--------- .../installer/MiddlewareInstallTest.java | 5 ++-- .../imagetool/util/DockerfileBuilderTest.java | 2 +- 9 files changed, 39 insertions(+), 31 deletions(-) diff --git a/documentation/site/content/userguide/tools/multiplatorm-build.md b/documentation/site/content/userguide/tools/multiplatorm-build.md index 30f03a7b..192099d3 100644 --- a/documentation/site/content/userguide/tools/multiplatorm-build.md +++ b/documentation/site/content/userguide/tools/multiplatorm-build.md @@ -5,7 +5,7 @@ docker: podman: sudo podman run --privileged --rm tonistiigi/binfmt --install all - + sudo podman run --rm --privileged multiarch/qemu-user-static --reset -p yes notes: In podman environment, sometimes the image build process stuck during installation of fmw, this can be : diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cachestore/CacheStore.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cachestore/CacheStore.java index ca811e38..de699136 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cachestore/CacheStore.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cachestore/CacheStore.java @@ -154,7 +154,7 @@ public void addInstaller(InstallerType installerType, String commonName, Install } // Before adding see if one same already existed. if (installerMetaDataList.contains(metaData)) { - logger.info("IMG_0135", metaData.toString()); + logger.info("IMG-0135", metaData.toString()); } else { installerMetaDataList.add(metaData); } @@ -242,7 +242,7 @@ public void addPatch(String bugNumber, String patchArchitecture, String patchLoc } PatchMetaData newPatch = new PatchMetaData(patchArchitecture, patchLocation, patchVersion, description); if (latestPatches.contains(newPatch)) { - logger.info("IMG_0136", newPatch); + logger.info("IMG-0136", newPatch); } else { latestPatches.add(newPatch); } @@ -269,7 +269,7 @@ public void addPatch(String bugNumber, String patchArchitecture, String patchLoc PatchMetaData newPatch = new PatchMetaData(patchArchitecture, patchLocation, patchVersion, description, dateAdded); if (latestPatches.contains(newPatch)) { - logger.info("IMG_0136", newPatch.toString()); + logger.info("IMG-0136", newPatch.toString()); } else { latestPatches.add(newPatch); } diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonCreateOptions.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonCreateOptions.java index 0c969039..e4096832 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonCreateOptions.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonCreateOptions.java @@ -76,7 +76,8 @@ void prepareNewImage() throws IOException, InterruptedException, XPathExpression if (dockerfileOptions.installMiddleware()) { MiddlewareInstall install = - new MiddlewareInstall(getInstallerType(), installerVersion, installerResponseFiles, buildPlatforms); + new MiddlewareInstall(getInstallerType(), installerVersion, installerResponseFiles, buildPlatforms, + buildEngine); install.copyFiles(buildDir()); dockerfileOptions.setMiddlewareInstall(install); } else { @@ -115,7 +116,7 @@ void verifyInstallers(List buildPlatforms) throws IOException { InstallerMetaData jdkInstallerMetaData = configManager.getInstallerForPlatform(InstallerType.JDK, arch, jdkVersion); if (jdkInstallerMetaData == null) { - throw new IllegalArgumentException(Utils.getMessage("IMG_0145", InstallerType.JDK, + throw new IllegalArgumentException(Utils.getMessage("IMG-0145", InstallerType.JDK, buildPlatform, jdkVersion)); } else { // If needed @@ -127,7 +128,7 @@ void verifyInstallers(List buildPlatforms) throws IOException { InstallerMetaData installerMetaData = configManager.getInstallerForPlatform(installerType, arch, installerVersion); if (installerMetaData == null) { - throw new IllegalArgumentException(Utils.getMessage("IMG_0145", installerType, + throw new IllegalArgumentException(Utils.getMessage("IMG-0145", installerType, buildPlatform, installerVersion)); } else { // If needed diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CreateImage.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CreateImage.java index af03726f..699057d2 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CreateImage.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CreateImage.java @@ -57,7 +57,7 @@ public CommandResponse call() throws Exception { String manifestName = buildCommand.getTagName(); createManifestCommand.create().name(manifestName); abstractCommands.add(createManifestCommand); - logger.info("IMG_0140", manifestName); + logger.info("IMG-0140", manifestName); for (String buildPlatform : buildPlatforms) { buildCommand.substitutePlatform(buildPlatform); @@ -67,22 +67,22 @@ public CommandResponse call() throws Exception { PushCommand pushCommand = new PushCommand(buildCommand.getExecutable(), buildCommand.getContext()).tag(platformTag); abstractCommands.add(pushCommand); - logger.info("IMG_0143", platformTag); + logger.info("IMG-0143", platformTag); ManifestCommand addManifestCommand = new ManifestCommand(buildCommand.getExecutable(), buildCommand.getContext()); addManifestCommand.add().name(manifestName).tag(platformTag); abstractCommands.add(addManifestCommand); - logger.info("IMG_0141", manifestName, platformTag); + logger.info("IMG-0141", manifestName, platformTag); } ManifestCommand pushManifestCommand = new ManifestCommand(buildCommand.getExecutable(), buildCommand.getContext()); pushManifestCommand.push().name(manifestName).tag(manifestName); abstractCommands.add(pushManifestCommand); - logger.info("IMG_0142", manifestName); + logger.info("IMG-0142", manifestName); for (AbstractCommand abstractCommand : abstractCommands) { - logger.info("IMG_0144", abstractCommand.toString()); + logger.info("IMG-0144", abstractCommand.toString()); runDockerCommand(dockerfile, abstractCommand); } diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/installer/MiddlewareInstall.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/installer/MiddlewareInstall.java index 842baae3..fb995cf0 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/installer/MiddlewareInstall.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/installer/MiddlewareInstall.java @@ -38,7 +38,7 @@ public class MiddlewareInstall { * @param type the requested middleware install type */ public MiddlewareInstall(FmwInstallerType type, String version, List responseFiles, - List buildPlatform) + List buildPlatform, String buildEngine) throws FileNotFoundException { logger.info("IMG-0039", type.installerListString(), version); fmwInstallerType = type; @@ -53,11 +53,18 @@ public MiddlewareInstall(FmwInstallerType type, String version, List respo buildPlatform.add(Architecture.getLocalArchitecture().name()); } } + Architecture localArchitecture = Architecture.getLocalArchitecture(); + for (InstallerType installerType : type.installerList()) { for (String platform : buildPlatform) { + platform = Utils.standardPlatform(platform); MiddlewareInstallPackage pkg = new MiddlewareInstallPackage(); Architecture arch = Architecture.fromString(platform); + if ("podman".equalsIgnoreCase(buildEngine) && localArchitecture != arch) { + logger.warning("IMG-0146"); + } + pkg.type = installerType; if (AMD64_BLD.equals(platform)) { pkg.installer = new CachedFile(installerType, version, Architecture.AMD64); @@ -76,7 +83,6 @@ public MiddlewareInstall(FmwInstallerType type, String version, List respo addInstaller(pkg); } } - // TODO: same response files for all platform? setResponseFiles(responseFiles); } @@ -119,8 +125,6 @@ public void copyFiles(String buildContextDir) throws IOException { } else if (installPackage.platform.equals(ARM64_BLD)) { buildContextDestination = buildContextDestination + "/" + CTX_FMW + ARM64_BLD; } - //Path filePath = installPackage.installer.copyFile(cacheStore, buildContextDestination); - //installPackage.installerFilename = filePath.getFileName().toString(); Files.copy(installPackage.installerPath, Paths.get(buildContextDestination).resolve(installPackage.installerPath.getFileName())); installPackage.jarName = getJarNameFromInstaller(installPackage.installerPath); diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/util/CacheConversion.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/util/CacheConversion.java index dd0318f8..792e80eb 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/util/CacheConversion.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/util/CacheConversion.java @@ -147,7 +147,7 @@ private boolean initializeSettingFiles(String directory) { } } } catch (Exception ex) { - logger.warning("IMG_0138", ex.getLocalizedMessage()); + logger.warning("IMG-0138", ex.getLocalizedMessage()); return false; } logger.exiting("initializeSettingFiles"); diff --git a/imagetool/src/main/resources/ImageTool.properties b/imagetool/src/main/resources/ImageTool.properties index e6e1643f..ebade1b1 100644 --- a/imagetool/src/main/resources/ImageTool.properties +++ b/imagetool/src/main/resources/ImageTool.properties @@ -133,14 +133,16 @@ IMG-0131=Image tool v1 cache entry specified file {0} no longer exists, skipping IMG-0132=Image tool v1 cache entry specified file {0} cannot be accessed {1}, skipping conversion. You can add it manually. IMG-0133=Image tool conversion cannot find .metadata file in {0}. IMG-0134=Image tool successfully convert v1 cache data to v2. -IMG_0135=Installer [{0}] already exists in cache. -IMG_0136=Patch [{0}] already exists in cache. -IMG_0137=Existing settings.yaml file does not have the entry '{0', please add it using 'config set' command first. -IMG_0138=Image tool conversion failed to initialize files {0}. -IMG_0139=Image tool conversion failed. -IMG_0140=Creating multiplatform image manifest {0}. -IMG_0141=Creating command: adding image {0} to manifest {1}. -IMG_0142=Creating command: push image manifest {0} to repo. -IMG_0143=Creating command: push image to repo {0}. -IMG_0144=Setting up manifest and image: {0}. -IMG_0145=Cannot find installer [type: {0}, platform: {1}, version: {2}]. \ No newline at end of file +IMG-0135=Installer [{0}] already exists in cache. +IMG-0136=Patch [{0}] already exists in cache. +IMG-0137=Existing settings.yaml file does not have the entry '{0}', please add it using 'config set' command first. +IMG-0138=Image tool conversion failed to initialize files {0}. +IMG-0139=Image tool conversion failed. +IMG-0140=Creating multiplatform image manifest {0}. +IMG-0141=Creating command: adding image {0} to manifest {1}. +IMG-0142=Creating command: push image manifest {0} to repo. +IMG-0143=Creating command: push image to repo {0}. +IMG-0144=Setting up manifest and image: {0}. +IMG-0145=Cannot find installer [type: {0}, platform: {1}, version: {2}]. +IMG-0146=When building a cross-platform image using podman, it may hang during middleware install. If it hangs, use \ + a machine matching with the target platform. \ No newline at end of file diff --git a/imagetool/src/test/java/com/oracle/weblogic/imagetool/installer/MiddlewareInstallTest.java b/imagetool/src/test/java/com/oracle/weblogic/imagetool/installer/MiddlewareInstallTest.java index 60d081b3..fbcffc95 100644 --- a/imagetool/src/test/java/com/oracle/weblogic/imagetool/installer/MiddlewareInstallTest.java +++ b/imagetool/src/test/java/com/oracle/weblogic/imagetool/installer/MiddlewareInstallTest.java @@ -59,7 +59,7 @@ static void setup(@TempDir Path cacheDir) throws IOException { void copyInstaller(@TempDir Path buildContextDir) throws IOException { // Test a simple WLS install type, and copy the files to the build context folder MiddlewareInstall install = new MiddlewareInstall(FmwInstallerType.WLS, "12.2.1.4.0", - null, null); + null, null, "docker"); install.copyFiles(buildContextDir.toString()); // 2 files should be copied from cache to build context folder assertTrue(Files.isRegularFile(buildContextDir.resolve("test-installer.zip"))); @@ -80,7 +80,8 @@ void customResponseFile(@TempDir Path buildContextDir) throws IOException { List customResponse = Collections.singletonList(ResourceUtils.resourcePath("/dummyInstallers/dummyResponse.txt")); // Test a simple WLS install type, and copy the files to the build context folder - MiddlewareInstall install = new MiddlewareInstall(FmwInstallerType.WLS, "12.2.1.4.0", customResponse, null); + MiddlewareInstall install = new MiddlewareInstall(FmwInstallerType.WLS, "12.2.1.4.0", customResponse, + null, "docker"); install.copyFiles(buildContextDir.toString()); // 2 files should be copied from cache to build context folder assertTrue(Files.isRegularFile(buildContextDir.resolve("test-installer.zip"))); diff --git a/imagetool/src/test/java/com/oracle/weblogic/imagetool/util/DockerfileBuilderTest.java b/imagetool/src/test/java/com/oracle/weblogic/imagetool/util/DockerfileBuilderTest.java index 04920c06..d6c5379e 100644 --- a/imagetool/src/test/java/com/oracle/weblogic/imagetool/util/DockerfileBuilderTest.java +++ b/imagetool/src/test/java/com/oracle/weblogic/imagetool/util/DockerfileBuilderTest.java @@ -67,7 +67,7 @@ static void setup(@TempDir Path cacheDir) throws IOException { @Test void validateMustacheAliases() throws IOException { MiddlewareInstall install = new MiddlewareInstall(FmwInstallerType.WLS, "12.2.1.4.0", - null, null); + null, null, "docker"); DockerfileOptions dockerfileOptions = new DockerfileOptions("123") .setPatchingEnabled() From 145f96acdf6c5222812eae0d7517da37e38be683 Mon Sep 17 00:00:00 2001 From: jshum Date: Tue, 7 Jan 2025 12:23:37 -0600 Subject: [PATCH 069/104] pull from main --- .../weblogic/imagetool/aru/AruPatch.java | 16 ++++++++++++ .../weblogic/imagetool/aru/AruProduct.java | 1 + .../weblogic/imagetool/aru/AruUtil.java | 4 +-- .../cli/menu/CommonCreateOptions.java | 3 ++- .../imagetool/installer/FmwInstallerType.java | 7 +++--- .../imagetool/util/DockerfileOptions.java | 25 +++++++++++++++++++ .../imagetool/installer/InstallerTest.java | 13 +++++----- .../imagetool/logging/FileFormatterTest.java | 3 +-- 8 files changed, 58 insertions(+), 14 deletions(-) diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/aru/AruPatch.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/aru/AruPatch.java index 126d98f3..be25d3d9 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/aru/AruPatch.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/aru/AruPatch.java @@ -205,6 +205,22 @@ public boolean isStackPatchBundle() { return description != null && description.contains("STACK PATCH BUNDLE"); } + /** + * Returns true if this patch is known irregular patch (not an actual patch). + *
    + *
  1. Stack Patch Bundle is a zip of patches, but is not a patch itself.
    2. + *
  2. DB Client 19c Upgrade (34761383) is an installer, and not a patch.
    3. + *
+ * @return true if this patch is a StackPatchBundle or known installer, false otherwise. + */ + public boolean isIrregularPatch() { + boolean result = "34761383".equals(patchId) || isStackPatchBundle(); + if (result) { + logger.fine("Detected irregular patch {0}: {1}", patchId, description); + } + return result; + } + public boolean isCoherenceFeaturePack() { return description != null && description.contains("Coherence 14.1.1 Feature Pack"); } diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/aru/AruProduct.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/aru/AruProduct.java index 759136b8..4ab970a3 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/aru/AruProduct.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/aru/AruProduct.java @@ -32,6 +32,7 @@ public enum AruProduct { ODI("13724", "Oracle Data Integrator"), OSS("16609", "Oracle Security Service"), OAM_WG("18388", "Oracle Access Manager Web Gates"), + FMW_GLCM("31939", "Oracle Global Lifecycle Management FMW Installer") ; private final String productId; diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/aru/AruUtil.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/aru/AruUtil.java index 902aa2aa..e6042697 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/aru/AruUtil.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/aru/AruUtil.java @@ -152,7 +152,7 @@ List getLatestPsu(AruProduct product, String version, Architecture arc return AruPatch.getPatches(aruRecommendations) .filter(p -> p.isApplicableToTarget(architecture.getAruPlatform())) .filter(AruPatch::isPsu) - .filter(not(AruPatch::isStackPatchBundle)) + .filter(not(AruPatch::isIrregularPatch)) .collect(Collectors.toList()); } catch (NoPatchesFoundException ex) { logger.exiting(); @@ -270,7 +270,7 @@ List getReleaseRecommendations(AruProduct product, String releaseNumbe return AruPatch.getPatches(patchesDocument) .filter(p -> p.isApplicableToTarget(architecture.getAruPlatform())) - .filter(not(AruPatch::isStackPatchBundle)) // remove the Stack Patch Bundle patch, if returned + .filter(not(AruPatch::isIrregularPatch)) // remove the Stack Patch Bundle patch, if returned // TODO: Need an option for the user to request the Coherence additional feature pack. .filter(not(AruPatch::isCoherenceFeaturePack)) // remove the Coherence feature pack, if returned .filter(p -> p.release().equals(releaseNumber)) diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonCreateOptions.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonCreateOptions.java index e4096832..79f5f09e 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonCreateOptions.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonCreateOptions.java @@ -15,6 +15,7 @@ import javax.xml.xpath.XPathExpressionException; import com.oracle.weblogic.imagetool.aru.AruException; +import com.oracle.weblogic.imagetool.installer.FmwInstallerType; import com.oracle.weblogic.imagetool.installer.InstallerMetaData; import com.oracle.weblogic.imagetool.installer.InstallerType; import com.oracle.weblogic.imagetool.installer.MiddlewareInstall; @@ -70,7 +71,6 @@ void prepareNewImage() throws IOException, InterruptedException, XPathExpression Files.copy(installerPath, Paths.get(buildContextDestination).resolve(installerPath.getFileName())); jdkFilePathList.add(installerPath.getFileName().toString()); } - // TODO: Why we need this? dockerfileOptions.setJavaInstaller(jdkFilePathList); } @@ -80,6 +80,7 @@ void prepareNewImage() throws IOException, InterruptedException, XPathExpression buildEngine); install.copyFiles(buildDir()); dockerfileOptions.setMiddlewareInstall(install); + dockerfileOptions.includeBinaryOsPackages(getInstallerType().equals(FmwInstallerType.OHS)); } else { dockerfileOptions.setWdtBase("os_update"); } diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/installer/FmwInstallerType.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/installer/FmwInstallerType.java index d22dbab5..e83da945 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/installer/FmwInstallerType.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/installer/FmwInstallerType.java @@ -25,6 +25,7 @@ public enum FmwInstallerType { // Oracle WebLogic Server WLS(Utils.toSet(AruProduct.WLS, AruProduct.COH, AruProduct.FMWPLAT, AruProduct.FIT, AruProduct.JDBC, + AruProduct.FMW_GLCM, AruProduct.OSS), InstallerType.WLS), // Added OSS for a special patching issue for 12.2.1.4 JDBC fix WLSSLIM(Utils.toSet(WLS.products), InstallerType.WLSSLIM), @@ -80,7 +81,7 @@ public enum FmwInstallerType { WCS(Utils.toSet(FMW.products, AruProduct.WCS), InstallerType.FMW, InstallerType.WCS), OHS(Utils.toSet(AruProduct.OHS, AruProduct.OAM_WG, AruProduct.WLS, AruProduct.JDBC, AruProduct.FMWPLAT, - AruProduct.OSS, AruProduct.FIT), + AruProduct.OSS, AruProduct.FIT, AruProduct.JRF, AruProduct.FMW_GLCM), InstallerType.OHS, InstallerType.DB19), ODI(Collections.singleton(AruProduct.ODI), InstallerType.ODI) @@ -111,8 +112,8 @@ public Set products() { private static final LoggingFacade logger = LoggingFactory.getLogger(FmwInstallerType.class); /** - * Return a list of all WebLogic Server types (not JRF types). - * @return list of WLS enum types. + * Returns true if the installer type is a WLS installer, WLS, WLSDEV, or WLSSLIM. + * @return true if the installer is a WLS installer type. */ public static boolean isBaseWeblogicServer(FmwInstallerType value) { return weblogicServerTypes.contains(value); diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/util/DockerfileOptions.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/util/DockerfileOptions.java index 069465cf..36fa0317 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/util/DockerfileOptions.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/util/DockerfileOptions.java @@ -43,6 +43,7 @@ public class DockerfileOptions { private static final List DEFAULT_OS_PACKAGES = Arrays.asList( "gzip", "tar", "unzip", "libaio", "libnsl", "jq", "findutils", "diffutils"); + private static final List BINARY_OS_PACKAGES = Arrays.asList("binutils", "make", "glibc-devel"); private static final String WLSIMG_OS_PACKAGES = System.getenv("WLSIMG_OS_PACKAGES"); private static final String DEFAULT_ORAINV_DIR = "/u01/oracle/oraInventory"; @@ -76,6 +77,7 @@ public class DockerfileOptions { private MiddlewareInstall mwInstallers; private boolean useOwnerPermsForGroup; private boolean usingBusybox; + private boolean includeBinaryOsPackages; private List buildArgs; // WDT values @@ -108,6 +110,7 @@ public DockerfileOptions(String buildId) { skipMiddlewareInstall = false; useOwnerPermsForGroup = false; usingBusybox = false; + includeBinaryOsPackages = false; buildArgs = new ArrayList<>(); javaHome = DEFAULT_JAVA_HOME; @@ -1167,6 +1170,25 @@ public boolean targetAMDPlatform() { return targetAMDPlatform; } + /** + * Include OS packages for binary patching such as make for OPatch. + * @param value true if additional OS patches for binary patching should be added to the image. + * @return this + */ + public DockerfileOptions includeBinaryOsPackages(boolean value) { + includeBinaryOsPackages = value; + return this; + } + + /** + * Returns true if additional OS patches for binary patching should be added to the image. + * @return true if additional OS patches for binary patching should be added to the image, false otherwise. + */ + public boolean includeBinaryOsPackages() { + return includeBinaryOsPackages; + } + + /** * Returns true if BusyBox options should be used in the Dockerfile. * @@ -1218,6 +1240,9 @@ public List osPackages() { if (Utils.isEmptyString(WLSIMG_OS_PACKAGES)) { // If the user did not provide a list of OS packages, use the default list result.addAll(DEFAULT_OS_PACKAGES); + if (includeBinaryOsPackages()) { + result.addAll(BINARY_OS_PACKAGES); + } } else { // When provided in the environment variable, use the list of OS packages provided by the user. result.addAll(Stream.of(WLSIMG_OS_PACKAGES.split(" ")).collect(Collectors.toList())); diff --git a/imagetool/src/test/java/com/oracle/weblogic/imagetool/installer/InstallerTest.java b/imagetool/src/test/java/com/oracle/weblogic/imagetool/installer/InstallerTest.java index 4e441429..c12dcf03 100644 --- a/imagetool/src/test/java/com/oracle/weblogic/imagetool/installer/InstallerTest.java +++ b/imagetool/src/test/java/com/oracle/weblogic/imagetool/installer/InstallerTest.java @@ -32,18 +32,19 @@ void fmwInstallerTypeListTest() { @Test void fmwInstallerProductIds() { - AruProduct[] list1 = {AruProduct.WLS, AruProduct.COH, AruProduct.FMWPLAT, AruProduct.JDBC, AruProduct.FIT, - AruProduct.OSS}; + AruProduct[] list1 = {AruProduct.WLS, AruProduct.FMW_GLCM, AruProduct.COH, AruProduct.FMWPLAT, AruProduct.JDBC, + AruProduct.FIT, AruProduct.OSS}; assertEquals(Utils.toSet(list1), FmwInstallerType.WLS.products(), "WLS product list is incorrect or out of order"); - AruProduct[] list2 = {AruProduct.WLS, AruProduct.COH, AruProduct.FMWPLAT, AruProduct.JDBC, AruProduct.FIT, - AruProduct.OSS, AruProduct.JRF, AruProduct.JDEV, AruProduct.OPSS, AruProduct.OWSM}; + AruProduct[] list2 = {AruProduct.WLS, AruProduct.COH, AruProduct.FMW_GLCM, AruProduct.FMWPLAT, AruProduct.JDBC, + AruProduct.FIT, AruProduct.OSS, AruProduct.JRF, AruProduct.JDEV, AruProduct.OPSS, AruProduct.OWSM}; assertEquals(Utils.toSet(list2), FmwInstallerType.FMW.products(), "FMW product list is incorrect or out of order"); - AruProduct[] list3 = {AruProduct.WLS, AruProduct.COH, AruProduct.FMWPLAT, AruProduct.JDBC, AruProduct.FIT, - AruProduct.OSS, AruProduct.JRF, AruProduct.JDEV, AruProduct.OPSS, AruProduct.OWSM, AruProduct.SOA}; + AruProduct[] list3 = {AruProduct.WLS, AruProduct.COH, AruProduct.FMW_GLCM, AruProduct.FMWPLAT, AruProduct.JDBC, + AruProduct.FIT, AruProduct.OSS, AruProduct.JRF, AruProduct.JDEV, AruProduct.OPSS, AruProduct.OWSM, + AruProduct.SOA}; assertEquals(Utils.toSet(list3), FmwInstallerType.SOA.products(), "SOA product list is incorrect or out of order"); } diff --git a/imagetool/src/test/java/com/oracle/weblogic/imagetool/logging/FileFormatterTest.java b/imagetool/src/test/java/com/oracle/weblogic/imagetool/logging/FileFormatterTest.java index 1f61ab2b..8b921045 100644 --- a/imagetool/src/test/java/com/oracle/weblogic/imagetool/logging/FileFormatterTest.java +++ b/imagetool/src/test/java/com/oracle/weblogic/imagetool/logging/FileFormatterTest.java @@ -6,12 +6,11 @@ import java.util.logging.Level; import java.util.logging.LogRecord; -import org.junit.jupiter.api.Tag; import org.junit.jupiter.api.Test; import static org.junit.jupiter.api.Assertions.assertTrue; -@Tag("unit") + class FileFormatterTest { @Test From c50572cb87337c619c3c365259c3a3566c9796ca Mon Sep 17 00:00:00 2001 From: jshum Date: Tue, 7 Jan 2025 14:59:48 -0600 Subject: [PATCH 070/104] refactor cache conversion. --- .../imagetool/cli/cache/ListPatches.java | 2 +- .../imagetool/patch/PatchMetaData.java | 22 +++--- .../imagetool/util/CacheConversion.java | 77 ++++++++++++++----- .../src/main/resources/ImageTool.properties | 10 ++- 4 files changed, 75 insertions(+), 36 deletions(-) diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/ListPatches.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/ListPatches.java index 2aca27b8..9b059b87 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/ListPatches.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/ListPatches.java @@ -44,7 +44,7 @@ public CommandResponse call() { } System.out.println(" - location: " + metaData.getLocation()); System.out.println(" architecture: " + metaData.getArchitecture()); - System.out.println(" digest: " + metaData.getHash()); + System.out.println(" digest: " + metaData.getDigest()); System.out.println(" dateAdded: " + metaData.getDateAdded()); System.out.println(" version: " + metaData.getPatchVersion()); }); diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/patch/PatchMetaData.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/patch/PatchMetaData.java index 3179ff27..d1fcf3da 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/patch/PatchMetaData.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/patch/PatchMetaData.java @@ -10,7 +10,7 @@ public class PatchMetaData { private String architecture; private String location; - private String hash; + private String digest; private String dateAdded; private String patchVersion; private String description; @@ -19,15 +19,15 @@ public class PatchMetaData { * Constructor. * @param architecture platform * @param location file path of the patch - * @param hash sha256 hash + * @param digest sha256 hash * @param dateAdded date added * @param patchVersion version */ - public PatchMetaData(String architecture, String location, String hash, String dateAdded, String patchVersion, + public PatchMetaData(String architecture, String location, String digest, String dateAdded, String patchVersion, String description) { this.architecture = architecture; this.location = location; - this.hash = hash; + this.digest = digest; this.dateAdded = dateAdded; this.patchVersion = patchVersion; this.description = description; @@ -43,7 +43,7 @@ public PatchMetaData(String architecture, String location, String hash, String d public PatchMetaData(String architecture, String location, String patchVersion, String description) { this.architecture = architecture; this.location = location; - this.hash = Utils.getSha256Hash(location); + this.digest = Utils.getSha256Hash(location); this.dateAdded = Utils.getTodayDate(); this.patchVersion = patchVersion; this.description = description; @@ -61,7 +61,7 @@ public PatchMetaData(String architecture, String location, String patchVersion, String dateAdded) { this.architecture = architecture; this.location = location; - this.hash = Utils.getSha256Hash(location); + this.digest = Utils.getSha256Hash(location); this.dateAdded = dateAdded; this.patchVersion = patchVersion; this.description = description; @@ -75,8 +75,8 @@ public String getLocation() { return location; } - public String getHash() { - return hash; + public String getDigest() { + return digest; } public String getDateAdded() { @@ -96,7 +96,7 @@ public String toString() { return "PatchMetaData{" + "platform='" + architecture + '\'' + ", location='" + location + '\'' - + ", hash='" + hash + '\'' + + ", digest='" + digest + '\'' + ", dateAdded='" + dateAdded + '\'' + ", patchVersion='" + patchVersion + '\'' + ", description='" + description + '\'' @@ -113,7 +113,7 @@ public boolean equals(Object o) { } PatchMetaData metaData = (PatchMetaData) o; return Objects.equals(architecture, metaData.architecture) - && Objects.equals(location, metaData.location) && Objects.equals(hash, metaData.hash) + && Objects.equals(location, metaData.location) && Objects.equals(digest, metaData.digest) && Objects.equals(dateAdded, metaData.dateAdded) && Objects.equals(patchVersion, metaData.patchVersion) && Objects.equals(description, metaData.description); @@ -121,6 +121,6 @@ public boolean equals(Object o) { @Override public int hashCode() { - return Objects.hash(architecture, location, hash, dateAdded, patchVersion, description); + return Objects.hash(architecture, location, digest, dateAdded, patchVersion, description); } } diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/util/CacheConversion.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/util/CacheConversion.java index 792e80eb..4db97c0e 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/util/CacheConversion.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/util/CacheConversion.java @@ -39,11 +39,11 @@ public class CacheConversion extends CacheOperation { private static final LoggingFacade logger = LoggingFactory.getLogger(CacheConversion.class); + public static final String IMG_0128 = "IMG-0128"; + public static final String IMG_0129 = "IMG-0129"; - private static final String PATCH_PATTERN = "^(wls|fmw|ohs|wlsdev|wlsslim|soa|osb|b2b|mft|idm|db19|" - + "oud|oid|wcc|wcp|wcs|jdk|wdt|odi|\\d{8,9})(?:_(\\d\\d(?:\\.\\d){3,8}\\.\\d+)(?:_(.*))?)?=(.*)$"; private static final String INSTALLER_PATTERN = "^(wls|fmw|ohs|wlsdev|wlsslim|soa|osb|b2b|mft|idm|db19|" - + "oud|oid|wcc|wcp|wcs|jdk|wdt|odi)_(.*?)(?:_(.*))?=(.*)$"; + + "oud|oid|wcc|wcp|wcs|jdk|wdt|odi)$"; /** * convert cache file to nee format. @@ -51,7 +51,6 @@ public class CacheConversion extends CacheOperation { * @throws IOException when error */ public void convert(String inputFile) throws IOException { - Pattern patchPattern = Pattern.compile(PATCH_PATTERN); Pattern installerPattern = Pattern.compile(INSTALLER_PATTERN); try (BufferedReader br = new BufferedReader(new FileReader(inputFile))) { String line; @@ -59,9 +58,10 @@ public void convert(String inputFile) throws IOException { if (line.charAt(0) == '#') { continue; } + logger.info("IMG-0137", line); // patches if (Character.isDigit(line.charAt(0))) { - handlePatchPattern(patchPattern, line); + handlePatchPattern(line); } else { // installer handleInstallerPattern(installerPattern, line); @@ -71,44 +71,81 @@ public void convert(String inputFile) throws IOException { } private void handleInstallerPattern(Pattern installerPattern, String line) throws IOException { - Matcher matcher = installerPattern.matcher(line); - if (matcher.matches()) { - String key = matcher.group(1); - String version = matcher.group(2); - String arch = matcher.group(3); - String filepath = matcher.group(4); + String[] tokens = line.split("="); + if (tokens.length == 2) { + String filepath = tokens[1]; + String key = null; + String version = null; + String arch = null; + tokens = tokens[0].split("_"); + + if (tokens.length == 2) { + key = tokens[0]; + version = tokens[1]; + Matcher matcher = installerPattern.matcher(key); + if (!matcher.matches()) { + logger.warning(IMG_0129, key, line); + return; + } + } else if (tokens.length == 3) { + key = tokens[0]; + version = tokens[1]; + arch = tokens[2]; + arch = Architecture.fromString(arch).toString(); + } else { + logger.warning(IMG_0128, line); + return; + } String fileDate = getFileDate(filepath); if (arch == null) { arch = Utils.standardPlatform(Architecture.getLocalArchitecture().toString()); } if (fileDate != null) { + logger.info("IMG-0147", key, version, filepath, arch); InstallerMetaData metaData = new InstallerMetaData(arch, filepath, Utils.getSha256Hash(filepath), fileDate, version); ConfigManager.getInstance().addInstaller(InstallerType.fromString(key), version, metaData); } } else { - logger.warning("IMG-0128", line); + logger.warning(IMG_0128, line); } + } - private void handlePatchPattern(Pattern patchPattern, String line) throws IOException { - Matcher matcher = patchPattern.matcher(line); - if (matcher.matches()) { - String key = matcher.group(1); - String version = matcher.group(2); - String arch = matcher.group(3); - String filepath = matcher.group(4); + private void handlePatchPattern(String line) throws IOException { + String[] tokens = line.split("="); + if (tokens.length == 2) { + String filepath = tokens[1]; + String key = null; + String version = null; + String arch = null; + tokens = tokens[0].split("_"); + if (tokens.length == 2) { + key = tokens[0]; + version = tokens[1]; + } else if (tokens.length == 3) { + key = tokens[0]; + version = tokens[1]; + arch = tokens[2]; + arch = Architecture.fromString(arch).toString(); + } else { + logger.warning(IMG_0128, line); + return; + } String fileDate = getFileDate(filepath); if (arch == null) { arch = Utils.standardPlatform(Architecture.getLocalArchitecture().toString()); } if (fileDate != null) { + logger.info("IMG-0148", key, version, filepath); + ConfigManager.getInstance().addPatch(key, arch, filepath, version, "Converted from v1 in " + fileDate, fileDate); } } else { - logger.warning("IMG-0128", line); + logger.warning(IMG_0128, line); } + } private String getFileDate(String filepath) { diff --git a/imagetool/src/main/resources/ImageTool.properties b/imagetool/src/main/resources/ImageTool.properties index ebade1b1..f2ca9ac7 100644 --- a/imagetool/src/main/resources/ImageTool.properties +++ b/imagetool/src/main/resources/ImageTool.properties @@ -127,15 +127,15 @@ IMG-0125=Specified installer to delete cannot be found. IMG-0126=You must specify --patchId --version and --architecture for deleting a patchr. IMG-0127=Specified installer to delete cannot be found. IMG-0128=Cannot parse image tool version 1 metadata file line: {0}, skipping. -IMG-0129=Missing --architecture value for adding installer type {0}. +IMG-0129=Cannot parse image tool version 1 metadata file line: unrecognized product {0} in line {1}. IMG-0130=Successfully added patch to cache. [[cyan: bug:]] {0} [[cyan: version:]] {1} [[cyan: filepath:]] {2} IMG-0131=Image tool v1 cache entry specified file {0} no longer exists, skipping conversion. You can add it manually. IMG-0132=Image tool v1 cache entry specified file {0} cannot be accessed {1}, skipping conversion. You can add it manually. -IMG-0133=Image tool conversion cannot find .metadata file in {0}. +IMG-0133=Image tool cache conversion cannot find .metadata file in {0}. IMG-0134=Image tool successfully convert v1 cache data to v2. IMG-0135=Installer [{0}] already exists in cache. IMG-0136=Patch [{0}] already exists in cache. -IMG-0137=Existing settings.yaml file does not have the entry '{0}', please add it using 'config set' command first. +IMG-0137=Image tool v1 cache converting line: {0}. IMG-0138=Image tool conversion failed to initialize files {0}. IMG-0139=Image tool conversion failed. IMG-0140=Creating multiplatform image manifest {0}. @@ -145,4 +145,6 @@ IMG-0143=Creating command: push image to repo {0}. IMG-0144=Setting up manifest and image: {0}. IMG-0145=Cannot find installer [type: {0}, platform: {1}, version: {2}]. IMG-0146=When building a cross-platform image using podman, it may hang during middleware install. If it hangs, use \ - a machine matching with the target platform. \ No newline at end of file + a machine matching with the target platform. +IMG-0147=Converting installer {0} version {1} path {2} architecture {3}. +IMG-0148=Converting patch {0} version {1} path {2} architecture {3}. \ No newline at end of file From 5249f67994a1196738d603cd983166d5d3444faa Mon Sep 17 00:00:00 2001 From: jshum Date: Thu, 9 Jan 2025 15:41:53 -0600 Subject: [PATCH 071/104] doc update --- .../userguide/tools/multiplatorm-build.md | 127 +++++++++++++++++- 1 file changed, 125 insertions(+), 2 deletions(-) diff --git a/documentation/site/content/userguide/tools/multiplatorm-build.md b/documentation/site/content/userguide/tools/multiplatorm-build.md index 192099d3..195b30bb 100644 --- a/documentation/site/content/userguide/tools/multiplatorm-build.md +++ b/documentation/site/content/userguide/tools/multiplatorm-build.md @@ -1,5 +1,124 @@ +--- +title: "Multi-Platform Build" +date: 2025-01-11 +draft: false +weight: 1 +description: "Support for building multi-platform images.." +--- + +This version supports building multi-platform images using Docker in a single `create` command. Using `podman` is +problematic and we do not recommend using it. You can however, always create separate images and manually create manifest +to build a multi-platform images. + +Prerequisite: + +When building multi-platform images, the `docker` command depends on QEMU emulation setup in the build environment. In +a Linux environment, you can add QEMU support depending on your distribution and releases. An alternative is to install +it using the command. + +```bash +$ docker run --privileged --rm tonistiigi/binfmt --install all +``` + +This will install all the emulated platform binaries. You need to verify the binaries are actually installed in + +```bash +$ ls -l /proc/sys/fs/binfmt_misc/ +-rw-r--r--. 1 root root 0 Jan 1 19:55 qemu-aarch64 +-rw-r--r--. 1 root root 0 Jan 1 19:55 qemu-arm +-rw-r--r--. 1 root root 0 Jan 1 19:55 qemu-mips64 +-rw-r--r--. 1 root root 0 Jan 1 19:55 qemu-mips64el +-rw-r--r--. 1 root root 0 Jan 1 19:55 qemu-ppc64le +-rw-r--r--. 1 root root 0 Jan 1 19:55 qemu-riscv64 +-rw-r--r--. 1 root root 0 Jan 1 19:55 qemu-s390x +--w-------. 1 root root 0 Jan 1 19:54 register +-rw-r--r--. 1 root root 0 Jan 1 19:54 status + +``` + +You can verify if you can run a pod using the emulator for a different platform. For example, if you are in a `amd64` +environment and want to run `arm64` images, then you can: + +```bash +$ docker run -it --platform linux/arm64 --rm ghcr.io/oracle/oraclelinux-8-slim sh +``` + +If it successfully launch the pod and get a terminal session, then the emulation is working. If it fails, then you can +check `/var/log/messages` or `/var/log/audit/audit.log` for errors. Most of the issues are related to SELinux settings, +a quick work around is set to `permissive` using: + +```bash +$ sudo setenforce 0 +``` + +You may need administrator and security expert to help to solve any SELinux related issue in your environment. + +Creating image using a single command: + +1. Make sure the installers are added to the cache, for example: + +```bash +$ imagetool.sh cache addInstaller --type wls --architecture AMD64 --version 14.1.1.0.0 --path /path/to/wls12214-amd-install.zip +$ imagetool.sh cache addInstaller --type wls --architecture ARM64 --version 14.1.1.0.0 --path /path/to/wls12214-arm-install.zip +$ imagetool.sh cache addInstaller --type jdk --architecture AMD64 --version 11u22 --path /path/to/jdk-11u22-amd.tar.gz +$ imagetool.sh cache addInstaller --type jdk --architecture ARM64 --version 11u22 --path /path/to/jdk-11u22-arm.tar.gz +``` + +2. Create the image: + +```bash +$ imagetool.sh create --tag myrepo/wls14110:20250111 --platform linux/arm64,linux/amd64 --version 14.1.1.0.0 --jdkVersion 11u22 --push +``` + +This command will build the multi-platform image containing both `linux/arm64` and `linux/amd64` in the manifest and push to the repository `myrepo`. + +Creating image using multiple commands: + +In case the emulation failed, such as when using `podman`, you can always do it manually with multiple commands. + +1. Build the `linux/amd64` image in a `amd64` machine and push it to the repository. + +```bash +$ imagetool.sh create --tag myrepo/wls14110:20250111-amd64 --platform linux/amd64 --version 14.1.1.0.0 --jdkVersion 11u22 +$ docker push myrepo/wls14110:20250111-amd64 +``` + +2. Build the `linux/arm64` image in a `arm64` machine and push it to the repository. + +```bash +$ imagetool.sh create --tag myrepo/wls14110:20250111-arm64 --platform linux/arm64 --version 14.1.1.0.0 --jdkVersion 11u22 +$ docker push myrepo/wls14110:20250111-arm64 +``` + +3. Create the manifest. + +```bash +$ docker manifest create myrepo/wls14110:20250111 +``` + +4. Add the images to the manifest. + +```bash +$ docker manifest add myrepo/wls14110:20250111 myrepo/wls14110:20250111-amd64 +$ docker manifest add myrepo/wls14110:20250111 myrepo/wls14110:20250111-arm64 +``` + +5. Push the manifest to the repository. + +```bash +$ docker manifest push myrepo/wls14110:20250111 myrepo/wls14110:20250111 +``` + + + +=============================== REMOVE THIS BEFORE RELEASE ====================================== + Set up qemu (unless the machine is already set up for that) + + + + docker: docker run --privileged --rm tonistiigi/binfmt --install all @@ -15,8 +134,12 @@ notes: 3. try ps axwww | grep qemu to see if there are multiple java processes for the installation. 4. after podman system prune - I have to run the qemu setup again 5. qemu is not installed properly, the above method put files in /proc/sys/fs/binfmt_misc/qemu* -6. Completely disabled selinux seems to resolve issue, check also /var/log/messages , /var/log/audit/audit.log - +6. Completely disabled selinux does not seems to resolve issue completely, check also /var/log/messages , /var/log/audit/audit.log +7. Whenever it is stuck , ps axww | grep qemu on the build machine shows two identical java processes, killing the last one will proceed most of time +but may become stuck again. Thread dumps shows it is stuck in RuntimeExec internal class, it looks like the installer is spawning +multiple threads and making native os calls when expanding files during FMW install, I suspect podman emulation may not +handle the multi thread context correctly. Note: kill -3 on the second process produces no thread dump - indicates it may be +a thread or sub process by itself. Interestingly it doesn't happen that much when using docker. --- echo 'username:100000:65536' | sudo tee -a /etc/subuid From 232083ffb032984f47973c17b15ab7afc800eaca Mon Sep 17 00:00:00 2001 From: jshum Date: Thu, 9 Jan 2025 18:22:13 -0600 Subject: [PATCH 072/104] Fix space character in file names from main branch --- .../resources/docker-files/install-middleware-pkg.mustache | 4 ++-- .../main/resources/docker-files/install-middleware.mustache | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/imagetool/src/main/resources/docker-files/install-middleware-pkg.mustache b/imagetool/src/main/resources/docker-files/install-middleware-pkg.mustache index b3e328c6..bcb6c4ec 100644 --- a/imagetool/src/main/resources/docker-files/install-middleware-pkg.mustache +++ b/imagetool/src/main/resources/docker-files/install-middleware-pkg.mustache @@ -1,5 +1,5 @@ && echo "INSTALLING {{type}}" \ -{{#isZip}}&& unzip -q {{{tempDir}}}/{{{type}}}/$TARGETPLATFORM/{{installerFilename}} -d {{{tempDir}}}/{{{type}}} {{/isZip}} \ +{{#isZip}}&& unzip -q "{{{tempDir}}}/{{{type}}}/$TARGETPLATFORM/{{installerFilename}}" -d {{{tempDir}}}/{{{type}}} {{/isZip}} \ {{#preinstallCommands}}&& {{{tempDir}}}/{{{type}}}/{{{.}}} {{/preinstallCommands}} \ {{^isBin}} && if [ ! -f {{{tempDir}}}/{{{type}}}/{{jarName}} ] ; then (cp {{{tempDir}}}/{{{type}}}/$TARGETPLATFORM/{{installerFilename}} {{{tempDir}}}/{{{type}}}) fi \ && {{{java_home}}}/bin/java -Xmx1024m -jar {{{tempDir}}}/{{{type}}}/{{jarName}} \ @@ -11,5 +11,5 @@ && chmod +x {{{tempDir}}}/{{{type}}}/{{jarName}} \ && {{{tempDir}}}/{{{type}}}/{{jarName}} \ -force -ignoreSysPrereqs -silent \ --responseFile {{{tempDir}}}/{{{type}}}/$TARGETPLATFORM/{{responseFile.name}} \ +-responseFile "{{{tempDir}}}/{{{type}}}/$TARGETPLATFORM/{{responseFile.name}}" \ -invPtrLoc {{inv_loc}}/oraInst.loc ORACLE_HOME={{{oracle_home}}} -jreLoc {{{java_home}}} {{/isBin}} \ \ No newline at end of file diff --git a/imagetool/src/main/resources/docker-files/install-middleware.mustache b/imagetool/src/main/resources/docker-files/install-middleware.mustache index 77c986cf..5d141a07 100644 --- a/imagetool/src/main/resources/docker-files/install-middleware.mustache +++ b/imagetool/src/main/resources/docker-files/install-middleware.mustache @@ -23,7 +23,7 @@ RUN mkdir -p {{{oracle_home}}} \ && chown {{userid}}:{{groupid}} {{orainv_dir}} \ && chown {{userid}}:{{groupid}} {{{oracle_home}}} -{{#installJava}}COPY --from=jdk_build --chown={{userid}}:{{groupid}} {{{java_home}}} {{{java_home}}}/ +{{#installJava}}COPY --from=jdk_build --chown={{userid}}:{{groupid}} ["{{{java_home}}}", "{{{java_home}}}/"] {{/installJava}} # copy all installers and response files to the stage directory {{#installPackages}}COPY --chown={{userid}}:{{groupid}} fmw {{{tempDir}}}/{{{type}}} From 69cd388a22e719090c07c1acb4ad6e9d8fa473cc Mon Sep 17 00:00:00 2001 From: jshum Date: Fri, 17 Jan 2025 15:38:26 -0600 Subject: [PATCH 073/104] refactoring sonar --- .../weblogic/imagetool/aru/AruUtil.java | 17 +- .../imagetool/builder/AbstractCommand.java | 1 - .../imagetool/cachestore/CacheStore.java | 281 +++++++++--------- .../src/main/resources/ImageTool.properties | 2 +- .../imagetool/tests/utils/CacheCommand.java | 20 +- 5 files changed, 156 insertions(+), 165 deletions(-) diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/aru/AruUtil.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/aru/AruUtil.java index e6042697..93448b7a 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/aru/AruUtil.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/aru/AruUtil.java @@ -41,6 +41,9 @@ public class AruUtil { private static final LoggingFacade logger = LoggingFactory.getLogger(AruUtil.class); + private static final String GENERIC_NAME = "Generic"; + private static final String AMD_NAME = "linux/amd64"; + private static final String ARM_NAME = "linux/arm64"; private static AruUtil instance; @@ -603,16 +606,16 @@ private static T retry(MethodToRetry call) throws AruException, RetryFail */ public static String getAruPlatformName(String id) { if ("2000".equals(id)) { - return "Generic"; + return GENERIC_NAME; } if ("541".equals(id)) { - return "linux/arm64"; + return ARM_NAME; } if ("226".equals(id)) { - return "linux/amd64"; + return AMD_NAME; } - return "Generic"; + return GENERIC_NAME; } /** @@ -621,13 +624,13 @@ public static String getAruPlatformName(String id) { * @return platform number */ public static String getAruPlatformId(String id) { - if ("Generic".equalsIgnoreCase(id)) { + if (GENERIC_NAME.equalsIgnoreCase(id)) { return "2000"; } - if ("linux/arm64".equals(id)) { + if (ARM_NAME.equals(id)) { return "541"; } - if ("linux/amd64".equals(id)) { + if (AMD_NAME.equals(id)) { return "226"; } diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/builder/AbstractCommand.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/builder/AbstractCommand.java index 894c9412..b1428f63 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/builder/AbstractCommand.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/builder/AbstractCommand.java @@ -124,7 +124,6 @@ private Thread writeFromInputToOutputStreams(InputStream inputStream, Path docke } } }); - //readerThread.setDaemon(true); readerThread.start(); return readerThread; } diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cachestore/CacheStore.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cachestore/CacheStore.java index de699136..b0eb94fb 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cachestore/CacheStore.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cachestore/CacheStore.java @@ -10,6 +10,7 @@ import java.util.HashMap; import java.util.List; import java.util.Map; +import java.util.Optional; import com.oracle.weblogic.imagetool.aru.AruPatch; import com.oracle.weblogic.imagetool.installer.InstallerMetaData; @@ -22,6 +23,7 @@ import com.oracle.weblogic.imagetool.settings.UserSettingsFile; import com.oracle.weblogic.imagetool.util.Architecture; import com.oracle.weblogic.imagetool.util.Utils; +import org.jetbrains.annotations.Nullable; import static com.oracle.weblogic.imagetool.aru.AruUtil.getAruPlatformId; import static com.oracle.weblogic.imagetool.settings.YamlFileConstants.ARCHITECTURE; @@ -51,77 +53,49 @@ public class CacheStore { public Map>> getInstallers() { - // installers is a list of different installer types jdk, fmw, wdt etc .. - // For each installer type, there is a list of individual installer - //jdk: - // 11u22: - // - platform: linux/arm64 - // file: /path/to/installerarm.gz - // digest: e6a8e178e73aea2fc512799423822bf065758f5e - // version: 11.0.22 - // added: 20241201 - // - platform: linux/amd64 - // file: /path/to/installeramd.gz - // digest: 1d6dc346ba26bcf1d0c6b5efb030e0dd2f842add - // version: 11.0.22 - // added: 20241201 - // 8u401: - //wls: - // 12.2.1.4.0: - // - platform: linux/arm64 - // .... - // - platform: linux/arm64 - - //ConfigManager cm = ConfigManager.getInstance(); - //Map allInstallers = cm.getInstallerSettingsFile().load(); - - Map allInstallers = new SettingsFile(Paths.get(ConfigManager.getInstance() - .getInstallerDetailsFile())).load(); + Map allInstallers = new SettingsFile( + Paths.get(ConfigManager.getInstance().getInstallerDetailsFile())).load(); if (allInstallers == null) { - allInstallers = new HashMap<>(); + return new HashMap<>(); } - Map>> installerDetails - = new HashMap<>(); - for (Map.Entry entry: allInstallers.entrySet()) { - String key = entry.getKey(); + + Map>> installerDetails = new HashMap<>(); + + allInstallers.forEach((key, value) -> { if (key != null && !key.isEmpty()) { - Map> installerMetaData = new HashMap<>(); - key = key.toUpperCase(); // jdk, wls, fmw etc ... + String upperKey = key.toUpperCase(); // Convert key to uppercase (e.g., jdk, wls, fmw) try { - // process list of individual installers - // 12.2.1.4.0: - // - platform: linux/arm64 - // - platform: linux/amd64 - // 14.1.2.0.0: - // - platform: - // - platform - Map installerValues = (Map) entry.getValue(); - - for (Map.Entry individualInstaller: installerValues.entrySet()) { - String individualInstallerKey = individualInstaller.getKey(); // e.g. 12.2.1.4, 14.1.2 - List installerMetaDataList = new ArrayList<>(installerValues.size()); - - if (individualInstaller.getValue() instanceof ArrayList) { - for (Object installerValue: (ArrayList) individualInstaller.getValue()) { - installerMetaDataList.add(createInstallerMetaData((Map)installerValue)); - } + @SuppressWarnings("unchecked") + Map installerValues = (Map) value; + + Map> installerMetaData = new HashMap<>(); + + installerValues.forEach((individualKey, individualValue) -> { + List metaDataList = new ArrayList<>(); + + if (individualValue instanceof List) { + @SuppressWarnings("unchecked") + List installerList = (List) individualValue; + installerList.forEach(installerValue -> + metaDataList.add(createInstallerMetaData((Map) installerValue))); } else { - installerMetaDataList.add( - createInstallerMetaData((Map)individualInstaller.getValue())); + metaDataList.add(createInstallerMetaData((Map) individualValue)); } - installerMetaData.put(individualInstallerKey, installerMetaDataList); - } - installerDetails.put(key, installerMetaData); + installerMetaData.put(individualKey, metaDataList); + }); + + installerDetails.put(upperKey, installerMetaData); - } catch (IllegalArgumentException illegal) { - logger.warning("{0} could not be loaded: {1}", - key, InstallerType.class.getEnumConstants()); + } catch (IllegalArgumentException e) { + logger.warning("{0} could not be loaded: {1}", upperKey, InstallerType.class.getEnumConstants()); } } - } + }); + return installerDetails; + } @@ -174,51 +148,15 @@ public InstallerMetaData getInstallerForPlatform(InstallerType installerType, Ar String installerVersion) { - if (platformName == null) { - platformName = Architecture.GENERIC; - } - if (installerType == null) { - installerType = InstallerType.WLS; - } + platformName = (platformName == null) ? Architecture.GENERIC : platformName; + installerType = (installerType == null) ? InstallerType.WLS : installerType; + String installerKey = installerType.toString().toUpperCase(); + installerVersion = verifyInstallerVersion(installerVersion, installerType); - if (installerVersion == null) { - switch (installerType) { - case WLS: - installerVersion = ConfigManager.getInstance().getDefaultWLSVersion(); - break; - case JDK: - installerVersion = ConfigManager.getInstance().getDefaultJDKVersion(); - break; - case WDT: - installerVersion = ConfigManager.getInstance().getDefaultWDTVersion(); - break; - default: - break; - } - if (installerVersion == null) { - logger.throwing(new IllegalArgumentException("Cannot determine installer version for installer type " - + installerType.toString())); - } - } Map> installers = getInstallers().get(installerKey); if (installers != null && !installers.isEmpty()) { - List installerMetaDataList = installers.get(installerVersion); - if (installerMetaDataList != null && !installerMetaDataList.isEmpty()) { - for (InstallerMetaData installerMetaData: installerMetaDataList) { - if (platformName.getAcceptableNames().contains(installerMetaData.getArchitecture())) { - return installerMetaData; - } - } - if (Utils.isGenericInstallerAcceptable(installerType)) { - //If it can't find the specialized platform, try generic. - for (InstallerMetaData installerMetaData: installerMetaDataList) { - if (Architecture.GENERIC.getAcceptableNames().contains(installerMetaData.getArchitecture())) { - return installerMetaData; - } - } - } - } + return getInstallerMetaData(installerVersion, installerType, platformName, installers); } return null; @@ -287,32 +225,37 @@ public void addPatch(String bugNumber, String patchArchitecture, String patchLoc public PatchMetaData getPatchForPlatform(String platformName, String bugNumber, String version) { Map> patches = getAllPatches(); if (patches != null && !patches.isEmpty()) { - List patchMetaDataList = patches.get(bugNumber); - if (patchMetaDataList != null && !patchMetaDataList.isEmpty()) { - for (PatchMetaData patchMetaData: patchMetaDataList) { - if (platformName == null || platformName.isEmpty()) { - if (patchMetaData.getArchitecture().equalsIgnoreCase("Generic") - && patchMetaData.getPatchVersion().equals(version)) { - return patchMetaData; - } - } else { - if (patchMetaData.getArchitecture().equalsIgnoreCase(platformName) - && patchMetaData.getPatchVersion().equals(version)) { - return patchMetaData; - } - } - } - // search for generic for opatch only?? - if (OPatchFile.DEFAULT_BUG_NUM.equals(bugNumber)) { - for (PatchMetaData patchMetaData: patchMetaDataList) { - if ("generic".equalsIgnoreCase(patchMetaData.getArchitecture())) { - return patchMetaData; - } - } - } + return getPatchMetaData(platformName, bugNumber, version, patches); + } + return null; + } + + private static @Nullable PatchMetaData getPatchMetaData(String platformName, String bugNumber, String version, + Map> patches) { + + List patchMetaDataList = patches.get(bugNumber); + if (patchMetaDataList == null || patchMetaDataList.isEmpty()) { + return null; + } + + for (PatchMetaData patchMetaData : patchMetaDataList) { + boolean isPlatformMatch = (platformName == null || platformName.isEmpty()) + ? "Generic".equalsIgnoreCase(patchMetaData.getArchitecture()) + : platformName.equalsIgnoreCase(patchMetaData.getArchitecture()); + + if (isPlatformMatch && patchMetaData.getPatchVersion().equals(version)) { + return patchMetaData; } + } + // Fallback to search for "Generic" for OPatchFile's default bug number + if (OPatchFile.DEFAULT_BUG_NUM.equals(bugNumber)) { + return patchMetaDataList.stream() + .filter(patchMetaData -> "Generic".equalsIgnoreCase(patchMetaData.getArchitecture())) + .findFirst() + .orElse(null); } + return null; } @@ -349,28 +292,34 @@ public List getAruPatchForBugNumber(String bugNumber) { * @return patch settings */ public Map> getAllPatches() { + Map allPatches = new SettingsFile( + Paths.get(ConfigManager.getInstance().getPatchDetailsFile())).load(); + if (allPatches == null || allPatches.isEmpty()) { + return new HashMap<>(); + } - Map allPatches = new SettingsFile(Paths.get(ConfigManager.getInstance() - .getPatchDetailsFile())).load(); Map> patchList = new HashMap<>(); - if (allPatches != null && !allPatches.isEmpty()) { - for (Map.Entry entry: allPatches.entrySet()) { - String key = entry.getKey(); // bug number + + allPatches.forEach((key, value) -> { + if (key != null) { List patchMetaDataList = new ArrayList<>(); - if (key != null) { - if (entry.getValue() instanceof ArrayList) { - for (Object installerValue: (ArrayList) entry.getValue()) { - patchMetaDataList.add(createPatchMetaData((Map)installerValue)); - } - } else { - patchMetaDataList.add(createPatchMetaData((Map)entry.getValue())); - } + + if (value instanceof List) { + @SuppressWarnings("unchecked") + List valueList = (List) value; + valueList.forEach(item -> + patchMetaDataList.add(createPatchMetaData((Map) item))); + } else { + patchMetaDataList.add(createPatchMetaData((Map) value)); } + patchList.put(key, patchMetaDataList); } - } + }); + return patchList; + } /** @@ -421,4 +370,62 @@ private PatchMetaData createPatchMetaData(Map objectData) { return new PatchMetaData(platform, location, hash, dateAdded, productVersion, description); } + private String verifyInstallerVersion(String installerVersion, InstallerType installerType) { + + if (installerVersion == null) { + switch (installerType) { + case WLS: + installerVersion = ConfigManager.getInstance().getDefaultWLSVersion(); + break; + case JDK: + installerVersion = ConfigManager.getInstance().getDefaultJDKVersion(); + break; + case WDT: + installerVersion = ConfigManager.getInstance().getDefaultWDTVersion(); + break; + default: + break; + } + if (installerVersion == null) { + logger.throwing(new IllegalArgumentException("Cannot determine installer version for installer type " + + installerType.toString())); + } + } + return installerVersion; + } + + + private InstallerMetaData getInstallerMetaData(String installerVersion, InstallerType installerType, + Architecture platformName, Map> installers) { + + List installerMetaDataList = installers.get(installerVersion); + + if (installerMetaDataList != null && !installerMetaDataList.isEmpty()) { + + Optional foundInstaller = installerMetaDataList.stream() + .filter(installerMetaData -> platformName.getAcceptableNames() + .contains(installerMetaData.getArchitecture())) + .findFirst(); + + if (foundInstaller.isPresent()) { + return foundInstaller.get(); + } + + if (Utils.isGenericInstallerAcceptable(installerType)) { + //If it can't find the specialized platform, try generic. + + foundInstaller = installerMetaDataList.stream() + .filter(installerMetaData -> Architecture.GENERIC.getAcceptableNames() + .contains(installerMetaData.getArchitecture())) + .findFirst(); + + if (foundInstaller.isPresent()) { + return foundInstaller.get(); + } + + } + } + + return null; + } } diff --git a/imagetool/src/main/resources/ImageTool.properties b/imagetool/src/main/resources/ImageTool.properties index f2ca9ac7..865a7b48 100644 --- a/imagetool/src/main/resources/ImageTool.properties +++ b/imagetool/src/main/resources/ImageTool.properties @@ -135,7 +135,7 @@ IMG-0133=Image tool cache conversion cannot find .metadata file in {0}. IMG-0134=Image tool successfully convert v1 cache data to v2. IMG-0135=Installer [{0}] already exists in cache. IMG-0136=Patch [{0}] already exists in cache. -IMG-0137=Image tool v1 cache converting line: {0}. +IMG-0137=Image tool v1 cache converting line: {0}.GG IMG-0138=Image tool conversion failed to initialize files {0}. IMG-0139=Image tool conversion failed. IMG-0140=Creating multiplatform image manifest {0}. diff --git a/tests/src/test/java/com/oracle/weblogic/imagetool/tests/utils/CacheCommand.java b/tests/src/test/java/com/oracle/weblogic/imagetool/tests/utils/CacheCommand.java index 40b84b1c..4f25b110 100644 --- a/tests/src/test/java/com/oracle/weblogic/imagetool/tests/utils/CacheCommand.java +++ b/tests/src/test/java/com/oracle/weblogic/imagetool/tests/utils/CacheCommand.java @@ -11,7 +11,6 @@ public class CacheCommand extends ImageToolCommand { private String type; // cache flags - private boolean listItems; private boolean addInstaller; private boolean addPatch; private boolean listInstallers; @@ -20,19 +19,12 @@ public class CacheCommand extends ImageToolCommand { private boolean deleteInstaller; private String path; private String patchId; - private String key; - private String value; private String architecture; public CacheCommand() { super("cache"); } - public CacheCommand listItems(boolean value) { - listItems = value; - return this; - } - public CacheCommand addInstaller(boolean value) { addInstaller = value; return this; @@ -68,17 +60,7 @@ public CacheCommand path(Path value) { path = value.toString(); return this; } - - public CacheCommand key(String value) { - key = value; - return this; - } - - public CacheCommand value(Path value) { - this.value = value.toString(); - return this; - } - + public CacheCommand patchId(String value) { patchId = value; return this; From 2c967618c54a318352010a7a6eb291c00a43952c Mon Sep 17 00:00:00 2001 From: jshum Date: Tue, 21 Jan 2025 09:49:22 -0600 Subject: [PATCH 074/104] Refactor --- .../imagetool/cli/cache/ListInstallers.java | 32 ++++++++++++--- .../imagetool/cli/cache/ListPatches.java | 40 ++++++++++++++----- .../imagetool/patch/PatchMetaData.java | 4 +- 3 files changed, 57 insertions(+), 19 deletions(-) diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/ListInstallers.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/ListInstallers.java index ee8f4409..ecf32048 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/ListInstallers.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/ListInstallers.java @@ -3,8 +3,10 @@ package com.oracle.weblogic.imagetool.cli.cache; +import java.util.Comparator; import java.util.List; import java.util.Map; +import java.util.stream.Collectors; import com.oracle.weblogic.imagetool.api.model.CommandResponse; import com.oracle.weblogic.imagetool.installer.InstallerMetaData; @@ -48,12 +50,23 @@ public CommandResponse call() { return; } System.out.println(" " + installer + ":"); - for (InstallerMetaData meta : metaData) { - System.out.println(" - location: " + meta.getLocation()); - System.out.println(" architecture: " + meta.getArchitecture()); - System.out.println(" digest: " + meta.getDigest()); - System.out.println(" dateAdded: " + meta.getDateAdded()); - System.out.println(" version: " + meta.getProductVersion()); + + List sortedList = metaData.stream() + .sorted(Comparator.comparing(InstallerMetaData::getArchitecture)) + .collect(Collectors.toList()); + + String currentArch = ""; + for (InstallerMetaData meta : sortedList) { + if (!currentArch.equals(meta.getArchitecture())) { + currentArch = meta.getArchitecture(); + System.out.println(" " + meta.getArchitecture() + ":"); + } + System.out.println(" version: " + meta.getProductVersion()); + System.out.println(" location: " + meta.getLocation()); + if (details) { + System.out.println(" digest: " + meta.getDigest()); + System.out.println(" dateAdded: " + meta.getDateAdded()); + } } }); } @@ -78,4 +91,11 @@ public CommandResponse call() { description = "Filter installer by version." ) private String version; + + @Option( + names = {"--details"}, + description = "Full details of the installers." + ) + private boolean details = false; + } diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/ListPatches.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/ListPatches.java index 9b059b87..301b403d 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/ListPatches.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/ListPatches.java @@ -5,6 +5,7 @@ import java.util.List; import java.util.Map; +import java.util.stream.Collectors; import com.oracle.weblogic.imagetool.api.model.CommandResponse; import com.oracle.weblogic.imagetool.patch.PatchMetaData; @@ -36,17 +37,28 @@ public CommandResponse call() { continue; } System.out.println(bug + ":"); - data.get(bug).forEach((metaData) -> { - if (version != null && !version.isEmpty()) { - if (!version.equalsIgnoreCase(metaData.getPatchVersion())) { - return; + + Map> groupByArchitecture = data.get(bug).stream() + .collect(Collectors.groupingBy(PatchMetaData::getArchitecture)); + + groupByArchitecture.forEach((architecture, metaDatas) -> { + System.out.println(" " + architecture + ":"); + + metaDatas.forEach(metaData -> { + if (version != null && !version.isEmpty()) { + if (!version.equalsIgnoreCase(metaData.getPatchVersion())) { + return; + } } - } - System.out.println(" - location: " + metaData.getLocation()); - System.out.println(" architecture: " + metaData.getArchitecture()); - System.out.println(" digest: " + metaData.getDigest()); - System.out.println(" dateAdded: " + metaData.getDateAdded()); - System.out.println(" version: " + metaData.getPatchVersion()); + System.out.println(" - version: " + metaData.getPatchVersion()); + System.out.println(" location: " + metaData.getLocation()); + if (details) { + System.out.println(" digest: " + metaData.getDigest()); + System.out.println(" dateAdded: " + metaData.getDateAdded()); + } + + }); + }); } @@ -62,7 +74,13 @@ public CommandResponse call() { @Option( names = {"--version"}, - description = "Patch version" + description = "List only the patch version" ) private String version; + + @Option( + names = {"--details"}, + description = "List all details about the patch" + ) + private boolean details = false; } diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/patch/PatchMetaData.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/patch/PatchMetaData.java index d1fcf3da..1d72e40d 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/patch/PatchMetaData.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/patch/PatchMetaData.java @@ -25,7 +25,7 @@ public class PatchMetaData { */ public PatchMetaData(String architecture, String location, String digest, String dateAdded, String patchVersion, String description) { - this.architecture = architecture; + this.architecture = Utils.standardPlatform(architecture);; this.location = location; this.digest = digest; this.dateAdded = dateAdded; @@ -41,7 +41,7 @@ public PatchMetaData(String architecture, String location, String digest, String * @param description description of the patch */ public PatchMetaData(String architecture, String location, String patchVersion, String description) { - this.architecture = architecture; + this.architecture = Utils.standardPlatform(architecture);; this.location = location; this.digest = Utils.getSha256Hash(location); this.dateAdded = Utils.getTodayDate(); From 10dd3f5656e8f44e2fda0982bcba0952cf3cff38 Mon Sep 17 00:00:00 2001 From: jshum Date: Sat, 25 Jan 2025 07:39:53 -0600 Subject: [PATCH 075/104] sonar --- .../imagetool/cli/cache/ListInstallers.java | 22 +++++++++++-------- .../imagetool/cli/cache/ListPatches.java | 20 ++++++++--------- 2 files changed, 23 insertions(+), 19 deletions(-) diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/ListInstallers.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/ListInstallers.java index ecf32048..55290097 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/ListInstallers.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/ListInstallers.java @@ -26,15 +26,7 @@ public class ListInstallers extends CacheOperation { public CommandResponse call() { ConfigManager configManager = ConfigManager.getInstance(); Map>> data = configManager.getInstallers(); - if (commonName != null && !commonName.isEmpty() && type == null) { - System.out.println("--type cannot be null when commonName is specified"); - System.exit(2); - } - - if (version != null && !version.isEmpty() && type == null) { - System.out.println("--type cannot be null when version is specified"); - System.exit(2); - } + verifyInput(); for (String itemType : data.keySet()) { if (type != null && type != InstallerType.fromString(itemType)) { @@ -74,6 +66,18 @@ public CommandResponse call() { return CommandResponse.success(null); } + private void verifyInput() { + if (commonName != null && !commonName.isEmpty() && type == null) { + System.out.println("--type cannot be null when commonName is specified"); + System.exit(2); + } + + if (version != null && !version.isEmpty() && type == null) { + System.out.println("--type cannot be null when version is specified"); + System.exit(2); + } + } + @Option( names = {"--type"}, description = "Filter installer type. e.g. wls, jdk, wdt" diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/ListPatches.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/ListPatches.java index 301b403d..796748a6 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/ListPatches.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/ListPatches.java @@ -25,12 +25,7 @@ public CommandResponse call() { ConfigManager configManager = ConfigManager.getInstance(); Map> data = configManager.getAllPatches(); - if (version != null && !version.isEmpty()) { - if (patchId == null) { - System.out.println("--patchId cannot be null when version is specified"); - System.exit(2); - } - } + verifyInput(); for (String bug : data.keySet()) { if (patchId != null && !patchId.equalsIgnoreCase(bug)) { @@ -45,10 +40,8 @@ public CommandResponse call() { System.out.println(" " + architecture + ":"); metaDatas.forEach(metaData -> { - if (version != null && !version.isEmpty()) { - if (!version.equalsIgnoreCase(metaData.getPatchVersion())) { - return; - } + if (version != null && !metaData.getPatchVersion().equalsIgnoreCase(version)) { + return; } System.out.println(" - version: " + metaData.getPatchVersion()); System.out.println(" location: " + metaData.getLocation()); @@ -66,6 +59,13 @@ public CommandResponse call() { } + private void verifyInput() { + if (version != null && !version.isEmpty() && patchId == null) { + System.out.println("--patchId cannot be null when version is specified"); + System.exit(2); + } + } + @Option( names = {"--patchId"}, description = "Patch id" From 8ba3f928275324c9a955d05b1fa5036cdc7b1ed7 Mon Sep 17 00:00:00 2001 From: jshum Date: Sat, 25 Jan 2025 07:49:24 -0600 Subject: [PATCH 076/104] refactor --- .../imagetool/cli/cache/ListInstallers.java | 30 +++++++++++-------- 1 file changed, 17 insertions(+), 13 deletions(-) diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/ListInstallers.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/ListInstallers.java index 55290097..4e2d7c0c 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/ListInstallers.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/ListInstallers.java @@ -47,25 +47,29 @@ public CommandResponse call() { .sorted(Comparator.comparing(InstallerMetaData::getArchitecture)) .collect(Collectors.toList()); - String currentArch = ""; - for (InstallerMetaData meta : sortedList) { - if (!currentArch.equals(meta.getArchitecture())) { - currentArch = meta.getArchitecture(); - System.out.println(" " + meta.getArchitecture() + ":"); - } - System.out.println(" version: " + meta.getProductVersion()); - System.out.println(" location: " + meta.getLocation()); - if (details) { - System.out.println(" digest: " + meta.getDigest()); - System.out.println(" dateAdded: " + meta.getDateAdded()); - } - } + printDetails(sortedList); }); } return CommandResponse.success(null); } + private void printDetails(List sortedList) { + String currentArch = ""; + for (InstallerMetaData meta : sortedList) { + if (!currentArch.equals(meta.getArchitecture())) { + currentArch = meta.getArchitecture(); + System.out.println(" " + meta.getArchitecture() + ":"); + } + System.out.println(" version: " + meta.getProductVersion()); + System.out.println(" location: " + meta.getLocation()); + if (details) { + System.out.println(" digest: " + meta.getDigest()); + System.out.println(" dateAdded: " + meta.getDateAdded()); + } + } + } + private void verifyInput() { if (commonName != null && !commonName.isEmpty() && type == null) { System.out.println("--type cannot be null when commonName is specified"); From b7a79d74bf7a1d5641369fb4446f0f4883a40cc0 Mon Sep 17 00:00:00 2001 From: jshum Date: Thu, 30 Jan 2025 08:12:36 -0600 Subject: [PATCH 077/104] doc update --- .../site/content/userguide/tools/cache.md | 112 ++++--- .../userguide/tools/multiplatform-build.md | 113 ++++++++ .../userguide/tools/multiplatorm-build.md | 273 ------------------ 3 files changed, 163 insertions(+), 335 deletions(-) create mode 100644 documentation/site/content/userguide/tools/multiplatform-build.md delete mode 100644 documentation/site/content/userguide/tools/multiplatorm-build.md diff --git a/documentation/site/content/userguide/tools/cache.md b/documentation/site/content/userguide/tools/cache.md index f8811283..ba31e70a 100644 --- a/documentation/site/content/userguide/tools/cache.md +++ b/documentation/site/content/userguide/tools/cache.md @@ -59,57 +59,57 @@ List installers Filter installer by common name. --type= Filter installer type. e.g. wls, jdk, wdt --version= Filter installer by version. - + --details Show the details about the installers e.g. imagetool.sh cache listInstallers JDK: + 17u11: + linux/arm64: + version: 17.0.11 + location: /Users/acme/Downloads/jdk-17_linux-aarch64_11bin.tar.gz 8u401: - - location: /home/acmeuser/Downloads/jdk-8u401-fcs-bin-b10-linux-aarch64-19_dec_2023.tar.gz - platform: linux/arm64 - digest: 811af9aa1ce2eaa902c7923ea1a5b7012bddb787df0805aded5f3663b210aa47 - dateAdded: 2024-12-30 - version: 8.0.401 - - location: /home/acmeuser/Downloads/jdk-8u401-linux-x64.tar.gz - platform: linux/amd64 - digest: 19684fccd7ff32a8400e952a643f0049449a772ef63b8037d5b917cbd137d173 - dateAdded: 2024-12-30 - version: 8.0.401 + linux/amd64: + version: 8.0.401 + location: /Users/acme/Downloads/jdk-8u401-linux-x64.tar.gz + linux/arm64: + version: 8.0.401 + location: /Users/acme/Downloads/jdk-8u401-fcs-bin-b10-linux-aarch64-19_dec_2023.tar.gz + 8u231: + linux/amd64: + version: 8u231 + location: /Users/acme/Downloads/jdk-8u231-linux-x64.tar.gz 11u22: - - location: /home/acmeuser/Downloads/jdk-11.0.22_linux-aarch64_bin.tar.gz - platform: linux/arm64 - digest: 97ee39f2a39ab9612a06b0d56882571f701cad082b7cf169b5cfdee174aec7eb - dateAdded: 2024-12-30 - version: 11.0.22 - - location: /home/acmeuser/Downloads/jdk-11.0.22_linux-x64_bin.tar.gz - platform: linux/amd64 - digest: f9eaf0f224fac4ff26f146089181a155d547ebcf2e033cf4cc850efa228086ba - dateAdded: 2024-12-30 - version: 11.0.22 + linux/amd64: + version: 11.0.22 + location: /Users/acme/Downloads/jdk-11.0.22_linux-x64_bin.tar.gz + linux/arm64: + version: 11.0.22 + location: /Users/acme/Downloads/jdk-11.0.22_linux-aarch64_bin.tar.gz WLS: 12.2.1.4.0: - - location: /home/acmeuser/Downloads/fmw_12.2.1.4.0_wls_generic_ARM_OCI.zip - platform: linux/arm64 - digest: 2630e4e3d6c8998da8aa97ff6ff4a4a44f95a568de8cf9de01dcd47b753ff324 - dateAdded: 2024-12-30 - version: 12.2.1.4.0 - - location: /home/acmeuser/Downloads/fmw_12.2.1.4.0_wls_lite_Disk1_1of1.zip - platform: linux/amd64 - digest: 4b3a2264875ce4d56cf6c4c70fc2e5895db1f5cbc39eb5d4e28e46bfa65d2671 - dateAdded: 2024-12-30 - version: 12.2.1.4.0 + linux/amd64: + version: 12.2.1.4.0 + location: /Users/acme/Downloads/fmw_12.2.1.4.0_wls_lite_Disk1_1of1.zip + linux/arm64: + version: 12.2.1.4.0 + location: /Users/acme/Downloads/fmw_12.2.1.4.0_wls_generic_ARM_OCI.zip 14.1.1.0.0: - - location: /home/acmeuser/Downloads/fmw14110.zip - platform: linux/arm64 - digest: 5b09f15b1d5ecb89c7f399160b9d7ee1586177cdf06372826770293b3e22132c - dateAdded: 2024-12-30 - version: 14.1.1.0.0 - - location: /home/acmeuser/Downloads/fmw_14.1.1.0.0_wls_lite_Disk1_1of1.zip - platform: linux/amd64 - digest: 9e9fe0264e38c34ccaef47a262474aa94bf169af0d06b202f2630eaae648ae09 - dateAdded: 2024-12-30 - version: 14.1.1.0.0 + linux/amd64: + version: 14.1.1.0.0 + location: /Users/acme/Downloads/fmw_14.1.1.0.0_wls_lite_Disk1_1of1.zip + linux/arm64: + version: 14.1.1.0.0 + location: /Users/acme/Downloads/fmw14110.zip + 12.2.1.3.0: + linux/amd64: + version: 12.2.1.3.0 + location: /Volumes/home/files/witsystest/fmw_12.2.1.3.0_wls_Disk1_1of1.zip + 14.1.2.0.0: + linux/arm64: + version: 14.1.2.0.0 + location: /Users/acme/Downloads/fmw_14.1.2.0.0_wls_generic-091024.jar ``` - `listPatches`: List all the patches. @@ -120,33 +120,21 @@ Usage: imagetool cache listPatches [--patchId=] [--version=] List patches --patchId= Patch id --version= Patch version - + --details Show details about the patches $ imagetool.sh cache listPatches 36805124: - - location: /home/acmeuser/Downloads/oraclePatches/p36805124_122140_Generic.zip - platform: linux/amd64 - digest: null - dateAdded: 2024-11-18 - version: 12.2.1.4.0 - - location: /home/acmeuser/Downloads/oraclePatches/p36805124_122140_Generic.zip - platform: generic - digest: null - dateAdded: 2024-11-18 - version: 12.2.1.4.0.180516 + linux/amd64: + - version: 12.2.1.4.0 + location: /Users/acme/oraclePatches/p36805124_122140_Generic.zip 28186730: - - location: /home/acmeuser/Downloads/cache/p28186730_1394216_Generic.zip - platform: generic - digest: null - dateAdded: 2024-11-18 - version: 13.9.4.2.16 - - location: /home/acmeuser/Downloads/oraclePatches/p28186730_1394217_Generic.zip - platform: generic - digest: null - dateAdded: 2024-11-18 - version: 13.9.4.2.17 + Generic: + - version: 13.9.4.2.16 + location: /Users/acme/cache/p28186730_1394216_Generic.zip + - version: 13.9.4.2.17 + location: /Users/acme/oraclePatches/p28186730_1394217_Generic.zip ``` diff --git a/documentation/site/content/userguide/tools/multiplatform-build.md b/documentation/site/content/userguide/tools/multiplatform-build.md new file mode 100644 index 00000000..917d9d28 --- /dev/null +++ b/documentation/site/content/userguide/tools/multiplatform-build.md @@ -0,0 +1,113 @@ +--- +title: "Multi-Platform Build" +date: 2025-01-11 +draft: false +weight: 1 +description: "Support for building multi-platform images.." +--- + +This version supports building multi-platform images using Docker in a single `create` command. Using `podman` is +problematic and we do not recommend using it. You can however, always create separate images and manually create manifest +to build a multi-platform images. + +Prerequisite: + +When building multi-platform images, the `docker` command depends on QEMU emulation setup in the build environment. In +a Linux environment, you can add QEMU support depending on your distribution and releases. An alternative is to install +it using the command. + +```bash +$ docker run --privileged --rm tonistiigi/binfmt --install all +``` + +This will install all the emulated platform binaries. You need to verify the binaries are actually installed in + +```bash +$ ls -l /proc/sys/fs/binfmt_misc/ +-rw-r--r--. 1 root root 0 Jan 1 19:55 qemu-aarch64 +-rw-r--r--. 1 root root 0 Jan 1 19:55 qemu-arm +-rw-r--r--. 1 root root 0 Jan 1 19:55 qemu-mips64 +-rw-r--r--. 1 root root 0 Jan 1 19:55 qemu-mips64el +-rw-r--r--. 1 root root 0 Jan 1 19:55 qemu-ppc64le +-rw-r--r--. 1 root root 0 Jan 1 19:55 qemu-riscv64 +-rw-r--r--. 1 root root 0 Jan 1 19:55 qemu-s390x +--w-------. 1 root root 0 Jan 1 19:54 register +-rw-r--r--. 1 root root 0 Jan 1 19:54 status + +``` + +You can verify if you can run a pod using the emulator for a different platform. For example, if you are in a `amd64` +environment and want to run `arm64` images, then you can: + +```bash +$ docker run -it --platform linux/arm64 --rm ghcr.io/oracle/oraclelinux-8-slim sh +``` + +If it successfully launch the pod and get a terminal session, then the emulation is working. If it fails, then you can +check `/var/log/messages` or `/var/log/audit/audit.log` for errors. Most of the issues are related to SELinux settings, +a quick work around is set to `permissive` using: + +```bash +$ sudo setenforce 0 +``` + +You may need administrator and security expert to help to solve any SELinux related issue in your environment. + +Creating image using a single command: + +1. Make sure the installers are added to the cache, for example: + +```bash +$ imagetool.sh cache addInstaller --type wls --architecture AMD64 --version 14.1.1.0.0 --path /path/to/wls12214-amd-install.zip +$ imagetool.sh cache addInstaller --type wls --architecture ARM64 --version 14.1.1.0.0 --path /path/to/wls12214-arm-install.zip +$ imagetool.sh cache addInstaller --type jdk --architecture AMD64 --version 11u22 --path /path/to/jdk-11u22-amd.tar.gz +$ imagetool.sh cache addInstaller --type jdk --architecture ARM64 --version 11u22 --path /path/to/jdk-11u22-arm.tar.gz +``` + +2. Create the image: + +```bash +$ imagetool.sh create --tag myrepo/wls14110:20250111 --platform linux/arm64,linux/amd64 --version 14.1.1.0.0 --jdkVersion 11u22 --push +``` + +This command will build the multi-platform image containing both `linux/arm64` and `linux/amd64` in the manifest and push to the repository `myrepo`. + +Creating image using multiple commands: + +In case the emulation failed, such as when using `podman`, you can always do it manually with multiple commands. + +1. Build the `linux/amd64` image in a `amd64` machine and push it to the repository. + +```bash +$ imagetool.sh create --tag myrepo/wls14110:20250111-amd64 --platform linux/amd64 --version 14.1.1.0.0 --jdkVersion 11u22 +$ docker push myrepo/wls14110:20250111-amd64 +``` + +2. Build the `linux/arm64` image in a `arm64` machine and push it to the repository. + +```bash +$ imagetool.sh create --tag myrepo/wls14110:20250111-arm64 --platform linux/arm64 --version 14.1.1.0.0 --jdkVersion 11u22 +$ docker push myrepo/wls14110:20250111-arm64 +``` + +3. Create the manifest. + +```bash +$ docker manifest create myrepo/wls14110:20250111 +``` + +4. Add the images to the manifest. + +```bash +$ docker manifest add myrepo/wls14110:20250111 myrepo/wls14110:20250111-amd64 +$ docker manifest add myrepo/wls14110:20250111 myrepo/wls14110:20250111-arm64 +``` + +5. Push the manifest to the repository. + +```bash +$ docker manifest push myrepo/wls14110:20250111 myrepo/wls14110:20250111 +``` + + + diff --git a/documentation/site/content/userguide/tools/multiplatorm-build.md b/documentation/site/content/userguide/tools/multiplatorm-build.md deleted file mode 100644 index 195b30bb..00000000 --- a/documentation/site/content/userguide/tools/multiplatorm-build.md +++ /dev/null @@ -1,273 +0,0 @@ ---- -title: "Multi-Platform Build" -date: 2025-01-11 -draft: false -weight: 1 -description: "Support for building multi-platform images.." ---- - -This version supports building multi-platform images using Docker in a single `create` command. Using `podman` is -problematic and we do not recommend using it. You can however, always create separate images and manually create manifest -to build a multi-platform images. - -Prerequisite: - -When building multi-platform images, the `docker` command depends on QEMU emulation setup in the build environment. In -a Linux environment, you can add QEMU support depending on your distribution and releases. An alternative is to install -it using the command. - -```bash -$ docker run --privileged --rm tonistiigi/binfmt --install all -``` - -This will install all the emulated platform binaries. You need to verify the binaries are actually installed in - -```bash -$ ls -l /proc/sys/fs/binfmt_misc/ --rw-r--r--. 1 root root 0 Jan 1 19:55 qemu-aarch64 --rw-r--r--. 1 root root 0 Jan 1 19:55 qemu-arm --rw-r--r--. 1 root root 0 Jan 1 19:55 qemu-mips64 --rw-r--r--. 1 root root 0 Jan 1 19:55 qemu-mips64el --rw-r--r--. 1 root root 0 Jan 1 19:55 qemu-ppc64le --rw-r--r--. 1 root root 0 Jan 1 19:55 qemu-riscv64 --rw-r--r--. 1 root root 0 Jan 1 19:55 qemu-s390x ---w-------. 1 root root 0 Jan 1 19:54 register --rw-r--r--. 1 root root 0 Jan 1 19:54 status - -``` - -You can verify if you can run a pod using the emulator for a different platform. For example, if you are in a `amd64` -environment and want to run `arm64` images, then you can: - -```bash -$ docker run -it --platform linux/arm64 --rm ghcr.io/oracle/oraclelinux-8-slim sh -``` - -If it successfully launch the pod and get a terminal session, then the emulation is working. If it fails, then you can -check `/var/log/messages` or `/var/log/audit/audit.log` for errors. Most of the issues are related to SELinux settings, -a quick work around is set to `permissive` using: - -```bash -$ sudo setenforce 0 -``` - -You may need administrator and security expert to help to solve any SELinux related issue in your environment. - -Creating image using a single command: - -1. Make sure the installers are added to the cache, for example: - -```bash -$ imagetool.sh cache addInstaller --type wls --architecture AMD64 --version 14.1.1.0.0 --path /path/to/wls12214-amd-install.zip -$ imagetool.sh cache addInstaller --type wls --architecture ARM64 --version 14.1.1.0.0 --path /path/to/wls12214-arm-install.zip -$ imagetool.sh cache addInstaller --type jdk --architecture AMD64 --version 11u22 --path /path/to/jdk-11u22-amd.tar.gz -$ imagetool.sh cache addInstaller --type jdk --architecture ARM64 --version 11u22 --path /path/to/jdk-11u22-arm.tar.gz -``` - -2. Create the image: - -```bash -$ imagetool.sh create --tag myrepo/wls14110:20250111 --platform linux/arm64,linux/amd64 --version 14.1.1.0.0 --jdkVersion 11u22 --push -``` - -This command will build the multi-platform image containing both `linux/arm64` and `linux/amd64` in the manifest and push to the repository `myrepo`. - -Creating image using multiple commands: - -In case the emulation failed, such as when using `podman`, you can always do it manually with multiple commands. - -1. Build the `linux/amd64` image in a `amd64` machine and push it to the repository. - -```bash -$ imagetool.sh create --tag myrepo/wls14110:20250111-amd64 --platform linux/amd64 --version 14.1.1.0.0 --jdkVersion 11u22 -$ docker push myrepo/wls14110:20250111-amd64 -``` - -2. Build the `linux/arm64` image in a `arm64` machine and push it to the repository. - -```bash -$ imagetool.sh create --tag myrepo/wls14110:20250111-arm64 --platform linux/arm64 --version 14.1.1.0.0 --jdkVersion 11u22 -$ docker push myrepo/wls14110:20250111-arm64 -``` - -3. Create the manifest. - -```bash -$ docker manifest create myrepo/wls14110:20250111 -``` - -4. Add the images to the manifest. - -```bash -$ docker manifest add myrepo/wls14110:20250111 myrepo/wls14110:20250111-amd64 -$ docker manifest add myrepo/wls14110:20250111 myrepo/wls14110:20250111-arm64 -``` - -5. Push the manifest to the repository. - -```bash -$ docker manifest push myrepo/wls14110:20250111 myrepo/wls14110:20250111 -``` - - - -=============================== REMOVE THIS BEFORE RELEASE ====================================== - -Set up qemu (unless the machine is already set up for that) - - - - - -docker: - docker run --privileged --rm tonistiigi/binfmt --install all - -podman: - sudo podman run --privileged --rm tonistiigi/binfmt --install all - sudo podman run --rm --privileged multiarch/qemu-user-static --reset -p yes -notes: - - In podman environment, sometimes the image build process stuck during installation of fmw, this can be : - -1. space issue, default is in /var/lib/containers/storage - check utilization by df -h . Change graphroot in /etc/containers/storage.conf for system wide or change the personal settings, see below. -2. try turn off selinux sudo setenforce 0 , it may come out with more information. -3. try ps axwww | grep qemu to see if there are multiple java processes for the installation. -4. after podman system prune - I have to run the qemu setup again -5. qemu is not installed properly, the above method put files in /proc/sys/fs/binfmt_misc/qemu* -6. Completely disabled selinux does not seems to resolve issue completely, check also /var/log/messages , /var/log/audit/audit.log -7. Whenever it is stuck , ps axww | grep qemu on the build machine shows two identical java processes, killing the last one will proceed most of time -but may become stuck again. Thread dumps shows it is stuck in RuntimeExec internal class, it looks like the installer is spawning -multiple threads and making native os calls when expanding files during FMW install, I suspect podman emulation may not -handle the multi thread context correctly. Note: kill -3 on the second process produces no thread dump - indicates it may be -a thread or sub process by itself. Interestingly it doesn't happen that much when using docker. ---- - -echo 'username:100000:65536' | sudo tee -a /etc/subuid -echo 'username:100000:65536' | sudo tee -a /etc/subgid - -echo 'user.max_user_namespaces=28633' | sudo tee -a /etc/sysctl.d/userns.conf -sudo sysctl -p /etc/sysctl.d/userns.conf - -mkdir -p $HOME/containers/storage - -mkdir -p ~/.config/containers -echo "[storage] -driver = \"overlay\" -rootless_storage_path = \"$HOME/containers/storage\" -[storage.options.overlay] -mount_program = \"/usr/bin/fuse-overlayfs\"" > ~/.config/containers/storage.conf - -podman system reset - - -sudo loginctl enable-linger username - -podman run --platform results in -ERROR: /etc/mtab symlink operation not permitted. - -podman info shows it is using native overlays, changing it to individual fuse overlays works - -sudo dnf install fuse-overlayfs - -create $USER/.config/containers/storage.conf - -[storage] -driver = "overlay" - -[storage.options.overlay] -mount_program = "/usr/bin/fuse-overlayfs" - - -completely disabled selinux (rather than permissive by setenforce 0) - -/etc/selinux/config - - -podman system reset - -and install qemu again. - - -============================== - -cat /var/log/messages - -Dec 31 20:23:46 ol8-machine setroubleshoot[239987]: SELinux is preventing /usr/bin/qemu-aarch64 from read access on the file qemu-aarch64. For complete SELinux messages run: sealert -l 3e9c70c9-80e1-4abc-8a12-39f2846b5a10 -Dec 31 20:23:46 ol8-machine setroubleshoot[239987]: SELinux is preventing /usr/bin/qemu-aarch64 from read access on the file qemu-aarch64.#012#012***** Plugin catchall (100. confidence) suggests **************************#012#012If you believe that qemu-aarch64 should be allowed read access on the qemu-aarch64 file by default.#012Then you should report this as a bug.#012You can generate a local policy module to allow this access.#012Do#012allow this access for now by executing:#012# ausearch -c 'sh' --raw | audit2allow -M my-sh#012# semodule -X 300 -i my-sh.pp#012 -Dec 31 20:23:46 ol8-machine setroubleshoot[239987]: SELinux is preventing /usr/bin/qemu-aarch64 from read access on the file qemu-aarch64. For complete SELinux messages run: sealert -l 3e9c70c9-80e1-4abc-8a12-39f2846b5a10 -Dec 31 20:23:46 ol8-machine setroubleshoot[239987]: SELinux is preventing /usr/bin/qemu-aarch64 from read access on the file qemu-aarch64.#012#012***** Plugin catchall (100. confidence) suggests **************************#012#012If you believe that qemu-aarch64 should be allowed read access on the qemu-aarch64 file by default.#012Then you should report this as a bug.#012You can generate a local policy module to allow this access.#012Do#012allow this access for now by executing:#012# ausearch -c 'sh' --raw | audit2allow -M my-sh#012# semodule -X 300 -i my-sh.pp#012 -Dec 31 20:23:49 ol8-machine setroubleshoot[239987]: SELinux is preventing /usr/bin/qemu-aarch64 from read access on the file qemu-aarch64. For complete SELinux messages run: sealert -l 3e9c70c9-80e1-4abc-8a12-39f2846b5a10 -Dec 31 20:23:49 ol8-machine setroubleshoot[239987]: SELinux is preventing /usr/bin/qemu-aarch64 from read access on the file qemu-aarch64.#012#012***** Plugin catchall (100. confidence) suggests **************************#012#012If you believe that qemu-aarch64 should be allowed read access on the qemu-aarch64 file by default.#012Then you should report this as a bug.#012You can generate a local policy module to allow this access.#012Do#012allow this access for now by executing:#012# ausearch -c 'sh' --raw | audit2allow -M my-sh#012# semodule -X 300 -i my-sh.pp#012 -Dec 31 20:23:49 ol8-machine setroubleshoot[239987]: SELinux is preventing /usr/bin/qemu-aarch64 from read access on the file qemu-aarch64. For complete SELinux messages run: sealert -l 3e9c70c9-80e1-4abc-8a12-39f2846b5a10 -Dec 31 20:23:49 ol8-machine setroubleshoot[239987]: SELinux is preventing /usr/bin/qemu-aarch64 from read access on the file qemu-aarch64.#012#012***** Plugin catchall (100. confidence) suggests **************************#012#012If you believe that qemu-aarch64 should be allowed read access on the qemu-aarch64 file by default.#012Then you should report this as a bug.#012You can generate a local policy module to allow this access.#012Do#012allow this access for now by executing:#012# ausearch -c 'sh' --raw | audit2allow -M my-sh#012# semodule -X 300 -i my-sh.pp#012 - -======== - -When you encounter an error stating that Podman build is being prevented by SELinux from allowing "qemu-aarch64" to read access, it means that your system's Security Enhanced Linux (SELinux) policy is blocking the necessary permissions for the QEMU emulator to read files within the containerized environment, likely due to strict access controls; to fix this, you can create a custom SELinux policy rule to grant the required read access to QEMU within the container context. -Key points to understand: -SELinux and Containers: -SELinux assigns security labels to files and processes, which can sometimes restrict access when running containers, especially when using features like volume mounts. -QEMU and ARM emulation: -If you're building a container with an ARM architecture using "qemu-aarch64" on a different architecture, SELinux might need additional permissions to allow the emulation process to read necessary files. -How to troubleshoot and fix: -Check SELinux logs: -Run sudo grep 'qemu-aarch64' /var/log/audit/audit.log to see if there are any SELinux AVC (Access Vector Cache) messages related to the QEMU process. -Temporarily disable SELinux (not recommended): -To quickly test if SELinux is the issue, run sudo setenforce 0. -Important: Re-enable SELinux with sudo setenforce 1 after testing. -Create a custom SELinux policy: -Identify the issue: Analyze the SELinux logs to determine which specific file access is being denied and the SELinux context of the file. -Use sepolicy: -Edit the SELinux policy file (/etc/selinux/policy/base/container_file_t) to add a rule allowing the "qemu-aarch64" process to read files with the relevant context. -Example: -Code - - allow container_file_t qemu_aarch64_t:file r_file_perms; -Compile and reload the policy: -Run make within the /etc/selinux/policy directory to compile the modified policy. -Restart the SELinux daemon to apply the changes (usually done with a system reboot). -Important Considerations: -Security implications: -Always carefully review and test custom SELinux policy changes as granting too much access can introduce security vulnerabilities. -Consult documentation: - - -============ - -Step 1: Adjust the Command -The command ausearch -c 'sh' --raw | audit2allow -M my-sh might be too broad. Try to focus on the specific denials for qemu-aarch64. Use: -bash -ausearch -m avc -c qemu-aarch64 --raw | audit2allow -M my-qemu -This command will look for AVC (Access Vector Cache) messages related specifically to qemu-aarch64. - -Step 2: Review and Modify Policy -If the above command still results in errors, you might need to manually edit the generated .te file before compiling: -After running the audit2allow command, it should create my-qemu.te in your current directory. Open this file: -bash -nano my-qemu.te -Look for any lines starting with mlsconstrain. If they are causing issues, you might want to comment them out or remove them since they might not be necessary for your specific use case: -text -# mlsconstrain file { ioctl read lock execute execute_no_trans } ((h1 dom h2 -Fail-) or (t1 != mcs_constrained_type -Fail-) ); -# mlsconstrain file { write setattr append unlink link rename } ((h1 dom h2 -Fail-) or (t1 != mcs_constrained_type -Fail-) ); -After modifying, save the file. - -Step 3: Compile and Load the Policy -Try to compile the policy again: -bash -checkmodule -M -m -o my-qemu.mod my-qemu.te -semodule_package -o my-qemu.pp -m my-qemu.mod -semodule -i my-qemu.pp - - -======== - -TODO: - -podman does not take --load or --push -docker must have --load or --push for multiplatform build - -OL9 (not sure about OL8) defaults overlays doesn't work with emulator run - - - - From 9383dcd91f79a69b5619965bacb8700f3f03ef76 Mon Sep 17 00:00:00 2001 From: jshum Date: Fri, 7 Feb 2025 07:59:42 -0600 Subject: [PATCH 078/104] update information about multiplatform build --- .../userguide/tools/multiplatform-build.md | 46 +++++++++++++++++-- .../imagetool/cli/menu/CommonOptions.java | 9 ++-- .../installer/MiddlewareInstall.java | 2 +- 3 files changed, 50 insertions(+), 7 deletions(-) diff --git a/documentation/site/content/userguide/tools/multiplatform-build.md b/documentation/site/content/userguide/tools/multiplatform-build.md index 917d9d28..bc20540e 100644 --- a/documentation/site/content/userguide/tools/multiplatform-build.md +++ b/documentation/site/content/userguide/tools/multiplatform-build.md @@ -3,10 +3,10 @@ title: "Multi-Platform Build" date: 2025-01-11 draft: false weight: 1 -description: "Support for building multi-platform images.." +description: "Experimental Support for building multi-platform images.." --- -This version supports building multi-platform images using Docker in a single `create` command. Using `podman` is +This version supports experimental building multi-platform images using Docker in a single `create` command. Using `podman` is problematic and we do not recommend using it. You can however, always create separate images and manually create manifest to build a multi-platform images. @@ -19,6 +19,11 @@ it using the command. ```bash $ docker run --privileged --rm tonistiigi/binfmt --install all ``` +or + +```bash +$ docker run --rm --privileged multiarch/qemu-user-static --reset -p yes +``` This will install all the emulated platform binaries. You need to verify the binaries are actually installed in @@ -41,6 +46,10 @@ environment and want to run `arm64` images, then you can: ```bash $ docker run -it --platform linux/arm64 --rm ghcr.io/oracle/oraclelinux-8-slim sh + +In the terminal session, issue + +microdnf update ``` If it successfully launch the pod and get a terminal session, then the emulation is working. If it fails, then you can @@ -74,7 +83,7 @@ This command will build the multi-platform image containing both `linux/arm64` a Creating image using multiple commands: -In case the emulation failed, such as when using `podman`, you can always do it manually with multiple commands. +In case the emulation failed when building cross platform image, you can always do it manually with multiple commands. 1. Build the `linux/amd64` image in a `amd64` machine and push it to the repository. @@ -110,4 +119,35 @@ $ docker manifest push myrepo/wls14110:20250111 myrepo/wls14110:20250111 ``` +## Known Problems. + +1. During building cross platform image, for example if you are on a `AMD644` platform building a `ARM64` platform, you will +see it stuck in `Copying Files` + +``` +#31 14.93 Setting ORACLE_HOME... +#31 20.06 Copyright (c) 1996, 2021, Oracle and/or its affiliates. All rights reserved. +#31 20.07 Reading response file.. +#31 20.17 Skipping Software Updates +#31 20.18 Validations are disabled for this session. +#31 20.18 Verifying data +#31 30.47 Copying Files +#31 52.05 Percent Complete : 10 +#31 56.19 Percent Complete : 20 + +``` + +If you run the command `ps axww | grep qemu` on the build machine, you will find duplicate java processes similar to this + +``` +1807143 ? Sl 2:01 .buildkit_qemu_emulator -0 /u01/jdk/bin/java /u01/jdk/bin/java -cp /tmp/OraInstall2025-02-07_01-38-49PM/oui/mw/common/framework/jlib/engine-nextgen.jar:/tmp/OraInstall2025-02-07_01-38-49PM/oui/mw/common/framework/jlib/message.jar:/tmp/OraInstall2025-02-07_01-38-49PM/oui/mw/common/framework/jlib/oneclick.jar:/tmp/OraInstall2025-02-07_01-38-49PM/oracle_common/modules/oracle.dms/dms.jar:/tmp/OraInstall2025-02-07_01-38-49PM/oracle_common/modules/oracle.odl/ojdl.jar:/tmp/OraInstall2025-02-07_01-38-49PM/oracle_common/modules/oracle.odl/ojdl2.jar:/tmp/OraInstall2025-02-07_01-38-49PM/oracle_common/modules/oracle.odl/ojdl-log4j.jar:/tmp/OraInstall2025-02-07_01-38-49PM/oracle_common/modules/oracle.bali.jewt/jewt4.jar:/tmp/OraInstall2025-02-07_01-38-49PM/oracle_common/modules/oracle.bali.jewt/olaf2.jar:/tmp/OraInstall2025-02-07_01-38-49PM/oracle_common/jlib/wizardCommonResources.jar:/tmp/OraInstall2025-02-07_01-38-49PM/oracle_common/modules/oracle.bali.share/share.jar:/tmp/OraInstall2025-02-07_01-38-49PM/oracle_common/modules/oracle.help/oracle_ice.jar:/tmp/OraInstall2025-02-07_01-38-49PM/oracle_common/modules/oracle.help/ohj.jar:/tmp/OraInstall2025-02-07_01-38-49PM/oracle_common/modules/oracle.help/help-share.jar:/tmp/OraInstall2025-02-07_01-38-49PM/oui/modules/installer-launch.jar:/tmp/OraInstall2025-02-07_01-38-49PM/oui/modules/xml.jar -mx512m -Doracle.installer.appendjre=true -Djava.io.tmpdir=/tmp -Doracle.installer.jre_loc=/u01/jdk -Doracle.installer.custom_inventory=/u01/oracle/oraInventory -Doracle.cie.logging.useodl=true -Doracle.installer.startup_location=/tmp/orcl4209283845595543233.tmp/Disk1/install/linux64 -Doracle.installer.nlsEnabled=true -Doracle.installer.bootstrap=true -Doracle.installer.paramFile=/tmp/orcl4209283845595543233.tmp/Disk1/install/linux64/oraparam.ini -Doracle.installer.oui_loc=/tmp/OraInstall2025-02-07_01-38-49PM/oui -Doracle.installer.launch_loc=/ -Doracle.installer.unixVersion=6.8.0-39-generic -Doracle.installer.scratchPath=/tmp/OraInstall2025-02-07_01-38-49PM -Doracle.installer.extjre=true -Doracle.installer.timestamp=2025-02-07_01-38-49PM -Doracle.installer.operation=install -DisNextGen=true -Doracle.installer.prereqConfigLoc=/tmp/OraInstall2025-02-07_01-38-49PM/oui/mw/wls/prereq -Doracle.installer.library_loc=/tmp/OraInstall2025-02-07_01-38-49PM/oui/lib/linux64 -Doracle.installer.logPath=/tmp/OraInstall2025-02-07_01-38-49PM oracle.sysman.oio.oioc.OiocOneClickInstaller -scratchPath /tmp/OraInstall2025-02-07_01-38-49PM -sourceType network -timestamp 2025-02-07_01-38-49PM -paramFile /tmp/orcl4209283845595543233.tmp/Disk1/install/linux64/oraparam.ini -silent ORACLE_HOME=/u01/oracle -responseFile /tmp/imagetool/wls/linux/amd64/wls.rsp -invPtrLoc /u01/oracle/oraInst.loc -ignoreSysPrereqs -force -novalidation -nocleanUpOnExit +1809542 ? Sl 0:00 .buildkit_qemu_emulator -0 /u01/jdk/bin/java /u01/jdk/bin/java -cp /tmp/OraInstall2025-02-07_01-38-49PM/oui/mw/common/framework/jlib/engine-nextgen.jar:/tmp/OraInstall2025-02-07_01-38-49PM/oui/mw/common/framework/jlib/message.jar:/tmp/OraInstall2025-02-07_01-38-49PM/oui/mw/common/framework/jlib/oneclick.jar:/tmp/OraInstall2025-02-07_01-38-49PM/oracle_common/modules/oracle.dms/dms.jar:/tmp/OraInstall2025-02-07_01-38-49PM/oracle_common/modules/oracle.odl/ojdl.jar:/tmp/OraInstall2025-02-07_01-38-49PM/oracle_common/modules/oracle.odl/ojdl2.jar:/tmp/OraInstall2025-02-07_01-38-49PM/oracle_common/modules/oracle.odl/ojdl-log4j.jar:/tmp/OraInstall2025-02-07_01-38-49PM/oracle_common/modules/oracle.bali.jewt/jewt4.jar:/tmp/OraInstall2025-02-07_01-38-49PM/oracle_common/modules/oracle.bali.jewt/olaf2.jar:/tmp/OraInstall2025-02-07_01-38-49PM/oracle_common/jlib/wizardCommonResources.jar:/tmp/OraInstall2025-02-07_01-38-49PM/oracle_common/modules/oracle.bali.share/share.jar:/tmp/OraInstall2025-02-07_01-38-49PM/oracle_common/modules/oracle.help/oracle_ice.jar:/tmp/OraInstall2025-02-07_01-38-49PM/oracle_common/modules/oracle.help/ohj.jar:/tmp/OraInstall2025-02-07_01-38-49PM/oracle_common/modules/oracle.help/help-share.jar:/tmp/OraInstall2025-02-07_01-38-49PM/oui/modules/installer-launch.jar:/tmp/OraInstall2025-02-07_01-38-49PM/oui/modules/xml.jar -mx512m -Doracle.installer.appendjre=true -Djava.io.tmpdir=/tmp -Doracle.installer.jre_loc=/u01/jdk -Doracle.installer.custom_inventory=/u01/oracle/oraInventory -Doracle.cie.logging.useodl=true -Doracle.installer.startup_location=/tmp/orcl4209283845595543233.tmp/Disk1/install/linux64 -Doracle.installer.nlsEnabled=true -Doracle.installer.bootstrap=true -Doracle.installer.paramFile=/tmp/orcl4209283845595543233.tmp/Disk1/install/linux64/oraparam.ini -Doracle.installer.oui_loc=/tmp/OraInstall2025-02-07_01-38-49PM/oui -Doracle.installer.launch_loc=/ -Doracle.installer.unixVersion=6.8.0-39-generic -Doracle.installer.scratchPath=/tmp/OraInstall2025-02-07_01-38-49PM -Doracle.installer.extjre=true -Doracle.installer.timestamp=2025-02-07_01-38-49PM -Doracle.installer.operation=install -DisNextGen=true -Doracle.installer.prereqConfigLoc=/tmp/OraInstall2025-02-07_01-38-49PM/oui/mw/wls/prereq -Doracle.installer.library_loc=/tmp/OraInstall2025-02-07_01-38-49PM/oui/lib/linux64 -Doracle.installer.logPath=/tmp/OraInstall2025-02-07_01-38-49PM oracle.sysman.oio.oioc.OiocOneClickInstaller -scratchPath /tmp/OraInstall2025-02-07_01-38-49PM -sourceType network -timestamp 2025-02-07_01-38-49PM -paramFile /tmp/orcl4209283845595543233.tmp/Disk1/install/linux64/oraparam.ini -silent ORACLE_HOME=/u01/oracle -responseFile /tmp/imagetool/wls/linux/amd64/wls.rsp -invPtrLoc /u01/oracle/oraInst.loc -ignoreSysPrereqs -force -novalidation -nocleanUpOnExit +``` + +This appears to be a `QEMU` process not handling sub process correctly, you can terminate the last process by `sudo kill -9 ` +, and the build will continue. The best way to solve this is use manual build in each respective platform as mentioned in last section. + +2. You may encounter `SELINUX` security issue, usually it appears some build commands failed. You can check for errors in `/var/log/messages` and search for +for `QEMU`. In this case, you need to work with your administrator either relax the security policy or setup customized policy. This is +environment specific. diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonOptions.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonOptions.java index 7470adcc..1234f7a2 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonOptions.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonOptions.java @@ -1,4 +1,4 @@ -// Copyright (c) 2019, 2024, Oracle and/or its affiliates. +// Copyright (c) 2019, 2025, 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.cli.menu; @@ -138,14 +138,17 @@ BuildCommand getInitialBuildCmd(String contextFolder) { .buildArg("https_proxy", httpsProxyUrl, httpsProxyUrl != null && httpsProxyUrl.contains("@")) .buildArg("no_proxy", nonProxyHosts); - // if it is multiplatform build + // if it is multiplatform build and using docker + if (buildId != null && buildPlatform.size() > 1) { // if push is specified, ignore load value if (!buildEngine.equalsIgnoreCase("podman")) { if (push) { cmdBuilder.push(push); - } else { + } else if (load) { cmdBuilder.load(load); + } else { + cmdBuilder.push(true); } } } diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/installer/MiddlewareInstall.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/installer/MiddlewareInstall.java index fb995cf0..f432f87c 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/installer/MiddlewareInstall.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/installer/MiddlewareInstall.java @@ -61,7 +61,7 @@ public MiddlewareInstall(FmwInstallerType type, String version, List respo platform = Utils.standardPlatform(platform); MiddlewareInstallPackage pkg = new MiddlewareInstallPackage(); Architecture arch = Architecture.fromString(platform); - if ("podman".equalsIgnoreCase(buildEngine) && localArchitecture != arch) { + if (localArchitecture != arch) { logger.warning("IMG-0146"); } From 6d938ffefea0178086f5d53291b864ee3d86bc48 Mon Sep 17 00:00:00 2001 From: jshum Date: Fri, 7 Feb 2025 09:24:02 -0600 Subject: [PATCH 079/104] update doc and update --force-rm from main --- .../content/userguide/tools/multiplatform-build.md | 11 ++++++----- .../weblogic/imagetool/builder/BuildCommand.java | 2 +- 2 files changed, 7 insertions(+), 6 deletions(-) diff --git a/documentation/site/content/userguide/tools/multiplatform-build.md b/documentation/site/content/userguide/tools/multiplatform-build.md index bc20540e..91825e95 100644 --- a/documentation/site/content/userguide/tools/multiplatform-build.md +++ b/documentation/site/content/userguide/tools/multiplatform-build.md @@ -13,16 +13,17 @@ to build a multi-platform images. Prerequisite: When building multi-platform images, the `docker` command depends on QEMU emulation setup in the build environment. In -a Linux environment, you can add QEMU support depending on your distribution and releases. An alternative is to install -it using the command. +a Linux environment, you can add QEMU support depending on your distribution and releases. You will also need to setup +the `bin-fmt` support in the container environment. Note: If you reboot, reset or purge the build system, you will need +to setup again before building cross platform images. ```bash -$ docker run --privileged --rm tonistiigi/binfmt --install all +$ docker run --rm --privileged multiarch/qemu-user-static --reset -p yes ``` -or +OR ```bash -$ docker run --rm --privileged multiarch/qemu-user-static --reset -p yes +$ docker run --privileged --rm tonistiigi/binfmt --install all ``` This will install all the emulated platform binaries. You need to verify the binaries are actually installed in diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/builder/BuildCommand.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/builder/BuildCommand.java index c1f77be4..48da95c5 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/builder/BuildCommand.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/builder/BuildCommand.java @@ -77,7 +77,7 @@ public BuildCommand platform(List value) { * @return this */ public BuildCommand forceRm(boolean value) { - if (value) { + if (value && !useBuildx) { command.add("--force-rm"); } return this; From 7d366fb16a4cd6e2999b3ee5e8744af153052acd Mon Sep 17 00:00:00 2001 From: jshum Date: Fri, 7 Feb 2025 10:13:55 -0600 Subject: [PATCH 080/104] update doc --- .../site/content/userguide/tools/multiplatform-build.md | 8 ++------ 1 file changed, 2 insertions(+), 6 deletions(-) diff --git a/documentation/site/content/userguide/tools/multiplatform-build.md b/documentation/site/content/userguide/tools/multiplatform-build.md index 91825e95..95796de4 100644 --- a/documentation/site/content/userguide/tools/multiplatform-build.md +++ b/documentation/site/content/userguide/tools/multiplatform-build.md @@ -15,16 +15,12 @@ Prerequisite: When building multi-platform images, the `docker` command depends on QEMU emulation setup in the build environment. In a Linux environment, you can add QEMU support depending on your distribution and releases. You will also need to setup the `bin-fmt` support in the container environment. Note: If you reboot, reset or purge the build system, you will need -to setup again before building cross platform images. +to setup again before building cross platform images. For `podman` the equivalent command is `sudo podman` instead of +`docker`. ```bash $ docker run --rm --privileged multiarch/qemu-user-static --reset -p yes ``` -OR - -```bash -$ docker run --privileged --rm tonistiigi/binfmt --install all -``` This will install all the emulated platform binaries. You need to verify the binaries are actually installed in From 39fbe03f49ec5d0aeae4398bfd530ccb8a903cc9 Mon Sep 17 00:00:00 2001 From: jshum Date: Fri, 7 Feb 2025 10:56:30 -0600 Subject: [PATCH 081/104] doc update --- .../userguide/tools/multiplatform-build.md | 24 +++++++++++++++---- 1 file changed, 19 insertions(+), 5 deletions(-) diff --git a/documentation/site/content/userguide/tools/multiplatform-build.md b/documentation/site/content/userguide/tools/multiplatform-build.md index 95796de4..1ad91aa7 100644 --- a/documentation/site/content/userguide/tools/multiplatform-build.md +++ b/documentation/site/content/userguide/tools/multiplatform-build.md @@ -10,7 +10,7 @@ This version supports experimental building multi-platform images using Docker i problematic and we do not recommend using it. You can however, always create separate images and manually create manifest to build a multi-platform images. -Prerequisite: +## Prerequisite: When building multi-platform images, the `docker` command depends on QEMU emulation setup in the build environment. In a Linux environment, you can add QEMU support depending on your distribution and releases. You will also need to setup @@ -50,7 +50,7 @@ microdnf update ``` If it successfully launch the pod and get a terminal session, then the emulation is working. If it fails, then you can -check `/var/log/messages` or `/var/log/audit/audit.log` for errors. Most of the issues are related to SELinux settings, +check `/var/log/messages` or `/var/log/audit/audit.log` for errors. Most of the issues are related to `SELinux` settings, a quick work around is set to `permissive` using: ```bash @@ -59,7 +59,21 @@ $ sudo setenforce 0 You may need administrator and security expert to help to solve any SELinux related issue in your environment. -Creating image using a single command: +If you want to unregister an particular emulator, for example + +```bash +$ sudo echo '-1' > /proc/sys/fs/binfmt_misc/qemu-aarch64 +``` + +For unregistering all emulators + +```bash +$ for f in /proc/sys/fs/binfmt_misc/qemu*; do + sudo echo '-1' > "$f" + done +``` + +## Creating image using a single command: 1. Make sure the installers are added to the cache, for example: @@ -78,7 +92,7 @@ $ imagetool.sh create --tag myrepo/wls14110:20250111 --platform linux/arm64,linu This command will build the multi-platform image containing both `linux/arm64` and `linux/amd64` in the manifest and push to the repository `myrepo`. -Creating image using multiple commands: +## Creating image using multiple commands: In case the emulation failed when building cross platform image, you can always do it manually with multiple commands. @@ -145,6 +159,6 @@ This appears to be a `QEMU` process not handling sub process correctly, you can , and the build will continue. The best way to solve this is use manual build in each respective platform as mentioned in last section. -2. You may encounter `SELINUX` security issue, usually it appears some build commands failed. You can check for errors in `/var/log/messages` and search for +2. You may encounter `SELinux` security issue, usually it appears some build commands failed. You can check for errors in `/var/log/messages` and search for for `QEMU`. In this case, you need to work with your administrator either relax the security policy or setup customized policy. This is environment specific. From 5f1452209f39e688a01a09d3111a9b36a38df787 Mon Sep 17 00:00:00 2001 From: jshum Date: Mon, 10 Feb 2025 10:45:35 -0600 Subject: [PATCH 082/104] doc update --- .../userguide/tools/multiplatform-build.md | 36 ++++++++++--------- 1 file changed, 19 insertions(+), 17 deletions(-) diff --git a/documentation/site/content/userguide/tools/multiplatform-build.md b/documentation/site/content/userguide/tools/multiplatform-build.md index 1ad91aa7..f4f4a91b 100644 --- a/documentation/site/content/userguide/tools/multiplatform-build.md +++ b/documentation/site/content/userguide/tools/multiplatform-build.md @@ -1,18 +1,17 @@ --- -title: "Multi-Platform Build" +title: "Cross-Platform and Multi-Platforms Build" date: 2025-01-11 draft: false weight: 1 -description: "Experimental Support for building multi-platform images.." +description: "Experimental Support for building cross-platform and multi-platforms images." --- -This version supports experimental building multi-platform images using Docker in a single `create` command. Using `podman` is -problematic and we do not recommend using it. You can however, always create separate images and manually create manifest -to build a multi-platform images. +This version supports experimental building multi-platform images using `Docker` or `Podman` in a single `create` command. +We have encountered any cross-platform or multi-platforms build may hang during build. You can always create separate images and manually create manifest to build a multi-platform images. ## Prerequisite: -When building multi-platform images, the `docker` command depends on QEMU emulation setup in the build environment. In +When building cross or multi-platform images, the `docker` or `podman` command depends on QEMU emulation setup in the build environment. In a Linux environment, you can add QEMU support depending on your distribution and releases. You will also need to setup the `bin-fmt` support in the container environment. Note: If you reboot, reset or purge the build system, you will need to setup again before building cross platform images. For `podman` the equivalent command is `sudo podman` instead of @@ -22,6 +21,12 @@ to setup again before building cross platform images. For `podman` the equivale $ docker run --rm --privileged multiarch/qemu-user-static --reset -p yes ``` +In ARM64, you can use + +```bash +$ docker run --privileged --rm tonistiigi/binfmt --install all +``` + This will install all the emulated platform binaries. You need to verify the binaries are actually installed in ```bash @@ -42,14 +47,11 @@ You can verify if you can run a pod using the emulator for a different platform. environment and want to run `arm64` images, then you can: ```bash -$ docker run -it --platform linux/arm64 --rm ghcr.io/oracle/oraclelinux-8-slim sh - -In the terminal session, issue - -microdnf update +$ docker run -it --platform linux/arm64 --rm ghcr.io/oracle/oraclelinux:8-slim sh ``` +In the terminal session, run `microdnf update` -If it successfully launch the pod and get a terminal session, then the emulation is working. If it fails, then you can +If the commands are successful, then the emulation is working. If it fails, then you can check `/var/log/messages` or `/var/log/audit/audit.log` for errors. Most of the issues are related to `SELinux` settings, a quick work around is set to `permissive` using: @@ -59,7 +61,7 @@ $ sudo setenforce 0 You may need administrator and security expert to help to solve any SELinux related issue in your environment. -If you want to unregister an particular emulator, for example +If you want to unregister an particular emulator, you can ```bash $ sudo echo '-1' > /proc/sys/fs/binfmt_misc/qemu-aarch64 @@ -151,12 +153,12 @@ see it stuck in `Copying Files` If you run the command `ps axww | grep qemu` on the build machine, you will find duplicate java processes similar to this ``` -1807143 ? Sl 2:01 .buildkit_qemu_emulator -0 /u01/jdk/bin/java /u01/jdk/bin/java -cp /tmp/OraInstall2025-02-07_01-38-49PM/oui/mw/common/framework/jlib/engine-nextgen.jar:/tmp/OraInstall2025-02-07_01-38-49PM/oui/mw/common/framework/jlib/message.jar:/tmp/OraInstall2025-02-07_01-38-49PM/oui/mw/common/framework/jlib/oneclick.jar:/tmp/OraInstall2025-02-07_01-38-49PM/oracle_common/modules/oracle.dms/dms.jar:/tmp/OraInstall2025-02-07_01-38-49PM/oracle_common/modules/oracle.odl/ojdl.jar:/tmp/OraInstall2025-02-07_01-38-49PM/oracle_common/modules/oracle.odl/ojdl2.jar:/tmp/OraInstall2025-02-07_01-38-49PM/oracle_common/modules/oracle.odl/ojdl-log4j.jar:/tmp/OraInstall2025-02-07_01-38-49PM/oracle_common/modules/oracle.bali.jewt/jewt4.jar:/tmp/OraInstall2025-02-07_01-38-49PM/oracle_common/modules/oracle.bali.jewt/olaf2.jar:/tmp/OraInstall2025-02-07_01-38-49PM/oracle_common/jlib/wizardCommonResources.jar:/tmp/OraInstall2025-02-07_01-38-49PM/oracle_common/modules/oracle.bali.share/share.jar:/tmp/OraInstall2025-02-07_01-38-49PM/oracle_common/modules/oracle.help/oracle_ice.jar:/tmp/OraInstall2025-02-07_01-38-49PM/oracle_common/modules/oracle.help/ohj.jar:/tmp/OraInstall2025-02-07_01-38-49PM/oracle_common/modules/oracle.help/help-share.jar:/tmp/OraInstall2025-02-07_01-38-49PM/oui/modules/installer-launch.jar:/tmp/OraInstall2025-02-07_01-38-49PM/oui/modules/xml.jar -mx512m -Doracle.installer.appendjre=true -Djava.io.tmpdir=/tmp -Doracle.installer.jre_loc=/u01/jdk -Doracle.installer.custom_inventory=/u01/oracle/oraInventory -Doracle.cie.logging.useodl=true -Doracle.installer.startup_location=/tmp/orcl4209283845595543233.tmp/Disk1/install/linux64 -Doracle.installer.nlsEnabled=true -Doracle.installer.bootstrap=true -Doracle.installer.paramFile=/tmp/orcl4209283845595543233.tmp/Disk1/install/linux64/oraparam.ini -Doracle.installer.oui_loc=/tmp/OraInstall2025-02-07_01-38-49PM/oui -Doracle.installer.launch_loc=/ -Doracle.installer.unixVersion=6.8.0-39-generic -Doracle.installer.scratchPath=/tmp/OraInstall2025-02-07_01-38-49PM -Doracle.installer.extjre=true -Doracle.installer.timestamp=2025-02-07_01-38-49PM -Doracle.installer.operation=install -DisNextGen=true -Doracle.installer.prereqConfigLoc=/tmp/OraInstall2025-02-07_01-38-49PM/oui/mw/wls/prereq -Doracle.installer.library_loc=/tmp/OraInstall2025-02-07_01-38-49PM/oui/lib/linux64 -Doracle.installer.logPath=/tmp/OraInstall2025-02-07_01-38-49PM oracle.sysman.oio.oioc.OiocOneClickInstaller -scratchPath /tmp/OraInstall2025-02-07_01-38-49PM -sourceType network -timestamp 2025-02-07_01-38-49PM -paramFile /tmp/orcl4209283845595543233.tmp/Disk1/install/linux64/oraparam.ini -silent ORACLE_HOME=/u01/oracle -responseFile /tmp/imagetool/wls/linux/amd64/wls.rsp -invPtrLoc /u01/oracle/oraInst.loc -ignoreSysPrereqs -force -novalidation -nocleanUpOnExit -1809542 ? Sl 0:00 .buildkit_qemu_emulator -0 /u01/jdk/bin/java /u01/jdk/bin/java -cp /tmp/OraInstall2025-02-07_01-38-49PM/oui/mw/common/framework/jlib/engine-nextgen.jar:/tmp/OraInstall2025-02-07_01-38-49PM/oui/mw/common/framework/jlib/message.jar:/tmp/OraInstall2025-02-07_01-38-49PM/oui/mw/common/framework/jlib/oneclick.jar:/tmp/OraInstall2025-02-07_01-38-49PM/oracle_common/modules/oracle.dms/dms.jar:/tmp/OraInstall2025-02-07_01-38-49PM/oracle_common/modules/oracle.odl/ojdl.jar:/tmp/OraInstall2025-02-07_01-38-49PM/oracle_common/modules/oracle.odl/ojdl2.jar:/tmp/OraInstall2025-02-07_01-38-49PM/oracle_common/modules/oracle.odl/ojdl-log4j.jar:/tmp/OraInstall2025-02-07_01-38-49PM/oracle_common/modules/oracle.bali.jewt/jewt4.jar:/tmp/OraInstall2025-02-07_01-38-49PM/oracle_common/modules/oracle.bali.jewt/olaf2.jar:/tmp/OraInstall2025-02-07_01-38-49PM/oracle_common/jlib/wizardCommonResources.jar:/tmp/OraInstall2025-02-07_01-38-49PM/oracle_common/modules/oracle.bali.share/share.jar:/tmp/OraInstall2025-02-07_01-38-49PM/oracle_common/modules/oracle.help/oracle_ice.jar:/tmp/OraInstall2025-02-07_01-38-49PM/oracle_common/modules/oracle.help/ohj.jar:/tmp/OraInstall2025-02-07_01-38-49PM/oracle_common/modules/oracle.help/help-share.jar:/tmp/OraInstall2025-02-07_01-38-49PM/oui/modules/installer-launch.jar:/tmp/OraInstall2025-02-07_01-38-49PM/oui/modules/xml.jar -mx512m -Doracle.installer.appendjre=true -Djava.io.tmpdir=/tmp -Doracle.installer.jre_loc=/u01/jdk -Doracle.installer.custom_inventory=/u01/oracle/oraInventory -Doracle.cie.logging.useodl=true -Doracle.installer.startup_location=/tmp/orcl4209283845595543233.tmp/Disk1/install/linux64 -Doracle.installer.nlsEnabled=true -Doracle.installer.bootstrap=true -Doracle.installer.paramFile=/tmp/orcl4209283845595543233.tmp/Disk1/install/linux64/oraparam.ini -Doracle.installer.oui_loc=/tmp/OraInstall2025-02-07_01-38-49PM/oui -Doracle.installer.launch_loc=/ -Doracle.installer.unixVersion=6.8.0-39-generic -Doracle.installer.scratchPath=/tmp/OraInstall2025-02-07_01-38-49PM -Doracle.installer.extjre=true -Doracle.installer.timestamp=2025-02-07_01-38-49PM -Doracle.installer.operation=install -DisNextGen=true -Doracle.installer.prereqConfigLoc=/tmp/OraInstall2025-02-07_01-38-49PM/oui/mw/wls/prereq -Doracle.installer.library_loc=/tmp/OraInstall2025-02-07_01-38-49PM/oui/lib/linux64 -Doracle.installer.logPath=/tmp/OraInstall2025-02-07_01-38-49PM oracle.sysman.oio.oioc.OiocOneClickInstaller -scratchPath /tmp/OraInstall2025-02-07_01-38-49PM -sourceType network -timestamp 2025-02-07_01-38-49PM -paramFile /tmp/orcl4209283845595543233.tmp/Disk1/install/linux64/oraparam.ini -silent ORACLE_HOME=/u01/oracle -responseFile /tmp/imagetool/wls/linux/amd64/wls.rsp -invPtrLoc /u01/oracle/oraInst.loc -ignoreSysPrereqs -force -novalidation -nocleanUpOnExit +1807143 ? Sl 2:01 /usr/bin/qemu-aarch64-static /u01/jdk/bin/java -cp /tmp/OraInstall2025-02-07_01-38-49PM/oui/mw/common/framework/jlib/engine-nextgen.jar:/tmp/OraInstall2025-02-07_01-38-49PM/oui/mw/common/framework/jlib/message.jar:/tmp/OraInstall2025-02-07_01-38-49PM/oui/mw/common/framework/jlib/oneclick.jar:/tmp/OraInstall2025-02-07_01-38-49PM/oracle_common/modules/oracle.dms/dms.jar:/tmp/OraInstall2025-02-07_01-38-49PM/oracle_common/modules/oracle.odl/ojdl.jar:/tmp/OraInstall2025-02-07_01-38-49PM/oracle_common/modules/oracle.odl/ojdl2.jar:/tmp/OraInstall2025-02-07_01-38-49PM/oracle_common/modules/oracle.odl/ojdl-log4j.jar:/tmp/OraInstall2025-02-07_01-38-49PM/oracle_common/modules/oracle.bali.jewt/jewt4.jar:/tmp/OraInstall2025-02-07_01-38-49PM/oracle_common/modules/oracle.bali.jewt/olaf2.jar:/tmp/OraInstall2025-02-07_01-38-49PM/oracle_common/jlib/wizardCommonResources.jar:/tmp/OraInstall2025-02-07_01-38-49PM/oracle_common/modules/oracle.bali.share/share.jar:/tmp/OraInstall2025-02-07_01-38-49PM/oracle_common/modules/oracle.help/oracle_ice.jar:/tmp/OraInstall2025-02-07_01-38-49PM/oracle_common/modules/oracle.help/ohj.jar:/tmp/OraInstall2025-02-07_01-38-49PM/oracle_common/modules/oracle.help/help-share.jar:/tmp/OraInstall2025-02-07_01-38-49PM/oui/modules/installer-launch.jar:/tmp/OraInstall2025-02-07_01-38-49PM/oui/modules/xml.jar -mx512m -Doracle.installer.appendjre=true -Djava.io.tmpdir=/tmp -Doracle.installer.jre_loc=/u01/jdk -Doracle.installer.custom_inventory=/u01/oracle/oraInventory -Doracle.cie.logging.useodl=true -Doracle.installer.startup_location=/tmp/orcl4209283845595543233.tmp/Disk1/install/linux64 -Doracle.installer.nlsEnabled=true -Doracle.installer.bootstrap=true -Doracle.installer.paramFile=/tmp/orcl4209283845595543233.tmp/Disk1/install/linux64/oraparam.ini -Doracle.installer.oui_loc=/tmp/OraInstall2025-02-07_01-38-49PM/oui -Doracle.installer.launch_loc=/ -Doracle.installer.unixVersion=6.8.0-39-generic -Doracle.installer.scratchPath=/tmp/OraInstall2025-02-07_01-38-49PM -Doracle.installer.extjre=true -Doracle.installer.timestamp=2025-02-07_01-38-49PM -Doracle.installer.operation=install -DisNextGen=true -Doracle.installer.prereqConfigLoc=/tmp/OraInstall2025-02-07_01-38-49PM/oui/mw/wls/prereq -Doracle.installer.library_loc=/tmp/OraInstall2025-02-07_01-38-49PM/oui/lib/linux64 -Doracle.installer.logPath=/tmp/OraInstall2025-02-07_01-38-49PM oracle.sysman.oio.oioc.OiocOneClickInstaller -scratchPath /tmp/OraInstall2025-02-07_01-38-49PM -sourceType network -timestamp 2025-02-07_01-38-49PM -paramFile /tmp/orcl4209283845595543233.tmp/Disk1/install/linux64/oraparam.ini -silent ORACLE_HOME=/u01/oracle -responseFile /tmp/imagetool/wls/linux/amd64/wls.rsp -invPtrLoc /u01/oracle/oraInst.loc -ignoreSysPrereqs -force -novalidation -nocleanUpOnExit +1809542 ? Sl 0:00 /usr/bin/qemu-aarch64-static /u01/jdk/bin/java -cp /tmp/OraInstall2025-02-07_01-38-49PM/oui/mw/common/framework/jlib/engine-nextgen.jar:/tmp/OraInstall2025-02-07_01-38-49PM/oui/mw/common/framework/jlib/message.jar:/tmp/OraInstall2025-02-07_01-38-49PM/oui/mw/common/framework/jlib/oneclick.jar:/tmp/OraInstall2025-02-07_01-38-49PM/oracle_common/modules/oracle.dms/dms.jar:/tmp/OraInstall2025-02-07_01-38-49PM/oracle_common/modules/oracle.odl/ojdl.jar:/tmp/OraInstall2025-02-07_01-38-49PM/oracle_common/modules/oracle.odl/ojdl2.jar:/tmp/OraInstall2025-02-07_01-38-49PM/oracle_common/modules/oracle.odl/ojdl-log4j.jar:/tmp/OraInstall2025-02-07_01-38-49PM/oracle_common/modules/oracle.bali.jewt/jewt4.jar:/tmp/OraInstall2025-02-07_01-38-49PM/oracle_common/modules/oracle.bali.jewt/olaf2.jar:/tmp/OraInstall2025-02-07_01-38-49PM/oracle_common/jlib/wizardCommonResources.jar:/tmp/OraInstall2025-02-07_01-38-49PM/oracle_common/modules/oracle.bali.share/share.jar:/tmp/OraInstall2025-02-07_01-38-49PM/oracle_common/modules/oracle.help/oracle_ice.jar:/tmp/OraInstall2025-02-07_01-38-49PM/oracle_common/modules/oracle.help/ohj.jar:/tmp/OraInstall2025-02-07_01-38-49PM/oracle_common/modules/oracle.help/help-share.jar:/tmp/OraInstall2025-02-07_01-38-49PM/oui/modules/installer-launch.jar:/tmp/OraInstall2025-02-07_01-38-49PM/oui/modules/xml.jar -mx512m -Doracle.installer.appendjre=true -Djava.io.tmpdir=/tmp -Doracle.installer.jre_loc=/u01/jdk -Doracle.installer.custom_inventory=/u01/oracle/oraInventory -Doracle.cie.logging.useodl=true -Doracle.installer.startup_location=/tmp/orcl4209283845595543233.tmp/Disk1/install/linux64 -Doracle.installer.nlsEnabled=true -Doracle.installer.bootstrap=true -Doracle.installer.paramFile=/tmp/orcl4209283845595543233.tmp/Disk1/install/linux64/oraparam.ini -Doracle.installer.oui_loc=/tmp/OraInstall2025-02-07_01-38-49PM/oui -Doracle.installer.launch_loc=/ -Doracle.installer.unixVersion=6.8.0-39-generic -Doracle.installer.scratchPath=/tmp/OraInstall2025-02-07_01-38-49PM -Doracle.installer.extjre=true -Doracle.installer.timestamp=2025-02-07_01-38-49PM -Doracle.installer.operation=install -DisNextGen=true -Doracle.installer.prereqConfigLoc=/tmp/OraInstall2025-02-07_01-38-49PM/oui/mw/wls/prereq -Doracle.installer.library_loc=/tmp/OraInstall2025-02-07_01-38-49PM/oui/lib/linux64 -Doracle.installer.logPath=/tmp/OraInstall2025-02-07_01-38-49PM oracle.sysman.oio.oioc.OiocOneClickInstaller -scratchPath /tmp/OraInstall2025-02-07_01-38-49PM -sourceType network -timestamp 2025-02-07_01-38-49PM -paramFile /tmp/orcl4209283845595543233.tmp/Disk1/install/linux64/oraparam.ini -silent ORACLE_HOME=/u01/oracle -responseFile /tmp/imagetool/wls/linux/amd64/wls.rsp -invPtrLoc /u01/oracle/oraInst.loc -ignoreSysPrereqs -force -novalidation -nocleanUpOnExit ``` -This appears to be a `QEMU` process not handling sub process correctly, you can terminate the last process by `sudo kill -9 ` -, and the build will continue. The best way to solve this is use manual build in each respective platform as mentioned in last section. +It appears to be a `QEMU` process not handling sub process correctly, you can terminate the last process by `sudo kill -9 `. For example +`sudo kill -9 1809542` then the build will continue and complete. The best way to solve this is use manual build in each respective platform as mentioned in last section. 2. You may encounter `SELinux` security issue, usually it appears some build commands failed. You can check for errors in `/var/log/messages` and search for From 638aaf5615c9bbd03aad2f816a42c78c79b746ff Mon Sep 17 00:00:00 2001 From: jshum Date: Fri, 21 Mar 2025 12:36:29 -0500 Subject: [PATCH 083/104] Add support for baseFMWVersion of upper stack installer --- .../imagetool/cachestore/CacheStore.java | 30 ++++++++++++++++- .../cli/cache/AddInstallerEntry.java | 17 ++++++++++ .../imagetool/cli/cache/AddPatchEntry.java | 5 +++ .../cli/cache/CacheAddOperation.java | 4 ++- .../imagetool/cli/cache/ListInstallers.java | 8 +++-- .../installer/InstallerMetaData.java | 32 +++++++++++++------ .../installer/MiddlewareInstall.java | 14 +++++++- .../imagetool/settings/ConfigManager.java | 4 ++- .../imagetool/settings/YamlFileConstants.java | 1 + .../imagetool/util/CacheConversion.java | 2 +- .../oracle/weblogic/imagetool/util/Utils.java | 12 +++++++ .../src/main/resources/ImageTool.properties | 3 +- .../imagetool/cachestore/CachedFileTest.java | 8 ++--- .../installer/MiddlewareInstallTest.java | 2 +- .../imagetool/util/DockerfileBuilderTest.java | 2 +- 15 files changed, 121 insertions(+), 23 deletions(-) diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cachestore/CacheStore.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cachestore/CacheStore.java index b0eb94fb..98f3807f 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cachestore/CacheStore.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cachestore/CacheStore.java @@ -27,6 +27,7 @@ import static com.oracle.weblogic.imagetool.aru.AruUtil.getAruPlatformId; import static com.oracle.weblogic.imagetool.settings.YamlFileConstants.ARCHITECTURE; +import static com.oracle.weblogic.imagetool.settings.YamlFileConstants.BASE_FMW_VERSION; import static com.oracle.weblogic.imagetool.settings.YamlFileConstants.DATE_ADDED; import static com.oracle.weblogic.imagetool.settings.YamlFileConstants.DESCRIPTION; import static com.oracle.weblogic.imagetool.settings.YamlFileConstants.DIGEST; @@ -132,11 +133,37 @@ public void addInstaller(InstallerType installerType, String commonName, Install } else { installerMetaDataList.add(metaData); } + + if (!baseFMWVersionExists(installerType, installerDetails, metaData.getBaseFMWVersion())) { + logger.severe("IMG-0149", metaData.getBaseFMWVersion()); + System.exit(2); + } + + if (!Utils.isBaseInstallerType(installerType) && metaData.getBaseFMWVersion() == null) { + metaData.setBaseFMWVersion(metaData.getProductVersion()); + } + // Update the list installerDetails.put(installerKey, installerMetaDataMap); saveAllInstallers(installerDetails); } + private boolean baseFMWVersionExists(InstallerType type, Map>> installerDetails, String baseFMWVersion) { + + if (!Utils.isBaseInstallerType(type)) { + if (baseFMWVersion == null) { + return true; + } else { + Map> installers = installerDetails.get( + InstallerType.WLS.toString().toUpperCase()); + return installers.containsKey(baseFMWVersion); + } + } else { + return true; + } + } + /** * Return the metadata for the platformed installer. * @param platformName platform name @@ -354,7 +381,8 @@ private InstallerMetaData createInstallerMetaData(Map objectData String location = (String) objectData.get(LOCATION); String productVersion = (String) objectData.get(PRODUCT_VERSION); String platform = (String) objectData.get(ARCHITECTURE); - return new InstallerMetaData(platform, location, hash, dateAdded, productVersion); + String baseFMWVersion = (String) objectData.get(BASE_FMW_VERSION); + return new InstallerMetaData(platform, location, hash, dateAdded, productVersion, baseFMWVersion); } private PatchMetaData createPatchMetaData(Map objectData) { diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/AddInstallerEntry.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/AddInstallerEntry.java index 6304a680..7db3eac6 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/AddInstallerEntry.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/AddInstallerEntry.java @@ -8,6 +8,7 @@ import com.oracle.weblogic.imagetool.api.model.CommandResponse; import com.oracle.weblogic.imagetool.installer.InstallerType; import com.oracle.weblogic.imagetool.util.Architecture; +import com.oracle.weblogic.imagetool.util.Utils; import picocli.CommandLine.Command; import picocli.CommandLine.Option; @@ -55,6 +56,15 @@ public String getDescription() { return ""; } + @Override + public String getBaseFMWVersion() { + if (!Utils.isBaseInstallerType(type)) { + return baseFMWVersion; + } else { + return null; + } + } + @Option( names = {"-t", "--type"}, description = "Type of installer. Valid values: ${COMPLETION-CANDIDATES}", @@ -86,4 +96,11 @@ public String getDescription() { ) private String commonName; + @Option( + names = {"-bv", "--baseFMWVersion"}, + description = "Base FMW version. Used by upper level product dependent on base WLS version different from the " + + " stack installer.", + required = false + ) + private String baseFMWVersion; } diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/AddPatchEntry.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/AddPatchEntry.java index d0541680..5b07ce5c 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/AddPatchEntry.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/AddPatchEntry.java @@ -42,6 +42,11 @@ public String getDescription() { return description; } + @Override + public String getBaseFMWVersion() { + return ""; + } + @Override public CommandResponse call() throws Exception { try { diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/CacheAddOperation.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/CacheAddOperation.java index e6a9d938..66154ea3 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/CacheAddOperation.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/CacheAddOperation.java @@ -29,6 +29,8 @@ public abstract class CacheAddOperation extends CacheOperation { public abstract String getDescription(); + public abstract String getBaseFMWVersion(); + CommandResponse addInstallerToCache() throws IOException { if (filePath == null || !Files.isRegularFile(filePath)) { return CommandResponse.error("IMG-0049", filePath); @@ -48,7 +50,7 @@ CommandResponse addInstallerToCache() throws IOException { return CommandResponse.success("IMG-0075"); } metaData = new InstallerMetaData(arch.toString(), filePath.toAbsolutePath().toString(), - getVersion()); + getVersion(), getBaseFMWVersion()); ConfigManager.getInstance().addInstaller(InstallerType.fromString(type), getCommonName(), metaData); // if the new value is the same as the existing cache value, do nothing diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/ListInstallers.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/ListInstallers.java index 4e2d7c0c..d9590d12 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/ListInstallers.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/ListInstallers.java @@ -12,6 +12,7 @@ import com.oracle.weblogic.imagetool.installer.InstallerMetaData; import com.oracle.weblogic.imagetool.installer.InstallerType; import com.oracle.weblogic.imagetool.settings.ConfigManager; +import com.oracle.weblogic.imagetool.util.Utils; import picocli.CommandLine.Command; import picocli.CommandLine.Option; @@ -47,14 +48,14 @@ public CommandResponse call() { .sorted(Comparator.comparing(InstallerMetaData::getArchitecture)) .collect(Collectors.toList()); - printDetails(sortedList); + printDetails(sortedList, InstallerType.fromString(itemType)); }); } return CommandResponse.success(null); } - private void printDetails(List sortedList) { + private void printDetails(List sortedList, InstallerType type) { String currentArch = ""; for (InstallerMetaData meta : sortedList) { if (!currentArch.equals(meta.getArchitecture())) { @@ -66,6 +67,9 @@ private void printDetails(List sortedList) { if (details) { System.out.println(" digest: " + meta.getDigest()); System.out.println(" dateAdded: " + meta.getDateAdded()); + if (!Utils.isBaseInstallerType(type)) { + System.out.println(" baseFMWVersion: " + meta.getBaseFMWVersion()); + } } } } diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/installer/InstallerMetaData.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/installer/InstallerMetaData.java index ba7c2a54..2b783584 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/installer/InstallerMetaData.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/installer/InstallerMetaData.java @@ -16,6 +16,7 @@ public class InstallerMetaData { private String digest; private String dateAdded; private String productVersion; + private String baseFMWVersion; /** * Constructor InstallerMetaData stores details about this installer. @@ -23,14 +24,17 @@ public class InstallerMetaData { * @param location file path of the installer * @param digest sha256 hash value * @param dateAdded date added + * @param productVersion version of this installer + * @param baseFMWVersion base WLS version used by this installer */ public InstallerMetaData(String architecture, String location, String digest, String dateAdded, - String productVersion) { + String productVersion, String baseFMWVersion) { this.architecture = Utils.standardPlatform(architecture); this.location = location; this.digest = digest; this.dateAdded = dateAdded; this.productVersion = productVersion; + this.baseFMWVersion = baseFMWVersion; } /** @@ -39,16 +43,15 @@ public InstallerMetaData(String architecture, String location, String digest, St * @param location file path of the installer * @param productVersion real version of this installer */ - public InstallerMetaData(String architecture, String location, String productVersion) { + public InstallerMetaData(String architecture, String location, String productVersion, String baseFMWVersion) { this.architecture = Utils.standardPlatform(architecture); this.location = location; this.productVersion = productVersion; - if (location != null) { - if (Files.exists(Paths.get(location))) { - this.digest = Utils.getSha256Hash(location); - this.dateAdded = Utils.getTodayDate(); - } + if (location != null && Files.exists(Paths.get(location))) { + this.digest = Utils.getSha256Hash(location); + this.dateAdded = Utils.getTodayDate(); } + this.baseFMWVersion = baseFMWVersion; } public String getArchitecture() { @@ -71,6 +74,14 @@ public String getProductVersion() { return productVersion; } + public String getBaseFMWVersion() { + return baseFMWVersion; + } + + public void setBaseFMWVersion(String baseFMWVersion) { + this.baseFMWVersion = baseFMWVersion; + } + /** * Return standard platform name from the possible names. * @param platform input value to convert @@ -86,9 +97,11 @@ public String standardPlatform(String platform) { return "Generic"; } + @Override public String toString() { return "InstallerMetaData [platform=" + architecture + ", location=" + location + ", hash=" + digest + ", " - + "dateAdded=" + dateAdded + ", version=" + productVersion + "]"; + + "dateAdded=" + dateAdded + ", version=" + productVersion + ", baseFMWVersion=" + baseFMWVersion + + "]"; } @Override @@ -103,11 +116,12 @@ public boolean equals(Object o) { return Objects.equals(architecture, metaData.architecture) && Objects.equals(location, metaData.location) && Objects.equals(digest, metaData.digest) && Objects.equals(dateAdded, metaData.dateAdded) + && Objects.equals(baseFMWVersion, metaData.baseFMWVersion) && Objects.equals(productVersion, metaData.productVersion); } @Override public int hashCode() { - return Objects.hash(architecture, location, digest, dateAdded, productVersion); + return Objects.hash(architecture, location, digest, dateAdded, productVersion, baseFMWVersion); } } diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/installer/MiddlewareInstall.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/installer/MiddlewareInstall.java index f432f87c..004dfe54 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/installer/MiddlewareInstall.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/installer/MiddlewareInstall.java @@ -54,6 +54,8 @@ public MiddlewareInstall(FmwInstallerType type, String version, List respo } } Architecture localArchitecture = Architecture.getLocalArchitecture(); + String originalType = type.toString(); + for (InstallerType installerType : type.installerList()) { for (String platform : buildPlatform) { @@ -72,7 +74,17 @@ public MiddlewareInstall(FmwInstallerType type, String version, List respo if (ARM64_BLD.equals(platform)) { pkg.installer = new CachedFile(installerType, version, Architecture.ARM64); } - InstallerMetaData metaData = configManager.getInstallerForPlatform(installerType, arch, version); + + // get the details from cache of whether there is a base version of WLS required. + String useVersion = version; + if (type.installerList().size() > 1 && installerType == InstallerType.FMW) { + InstallerMetaData productData = configManager.getInstallerForPlatform( + InstallerType.fromString(originalType), + Architecture.fromString(platform), version); + useVersion = productData.getBaseFMWVersion(); + } + + InstallerMetaData metaData = configManager.getInstallerForPlatform(installerType, arch, useVersion); pkg.installerPath = Paths.get(metaData.getLocation()); pkg.installerFilename = pkg.installerPath.getFileName().toString(); pkg.responseFile = new DefaultResponseFile(installerType, type); diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/ConfigManager.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/ConfigManager.java index 90e410e0..f5630b7a 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/ConfigManager.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/ConfigManager.java @@ -22,6 +22,7 @@ import static com.oracle.weblogic.imagetool.cachestore.CacheStore.CACHE_DIR_ENV; import static com.oracle.weblogic.imagetool.settings.YamlFileConstants.ARCHITECTURE; +import static com.oracle.weblogic.imagetool.settings.YamlFileConstants.BASE_FMW_VERSION; import static com.oracle.weblogic.imagetool.settings.YamlFileConstants.DATE_ADDED; import static com.oracle.weblogic.imagetool.settings.YamlFileConstants.DESCRIPTION; import static com.oracle.weblogic.imagetool.settings.YamlFileConstants.DIGEST; @@ -245,7 +246,8 @@ private InstallerMetaData createInstallerMetaData(Map objectData String location = (String) objectData.get(LOCATION); String productVersion = (String) objectData.get(PRODUCT_VERSION); String platform = (String) objectData.get(ARCHITECTURE); - return new InstallerMetaData(platform, location, hash, dateAdded, productVersion); + String baseFMWVersion = (String) objectData.get(BASE_FMW_VERSION); + return new InstallerMetaData(platform, location, hash, dateAdded, productVersion, baseFMWVersion); } private PatchMetaData createPatchMetaData(Map objectData) { diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/YamlFileConstants.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/YamlFileConstants.java index c4cda8f3..2b56d9cc 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/YamlFileConstants.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/YamlFileConstants.java @@ -13,4 +13,5 @@ public class YamlFileConstants { public static final String LOCATION = "location"; public static final String PATCH_VERSION = "patchVersion"; public static final String PRODUCT_VERSION = "productVersion"; + public static final String BASE_FMW_VERSION = "baseFMWVersion"; } diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/util/CacheConversion.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/util/CacheConversion.java index 4db97c0e..7cdcde90 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/util/CacheConversion.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/util/CacheConversion.java @@ -103,7 +103,7 @@ private void handleInstallerPattern(Pattern installerPattern, String line) throw if (fileDate != null) { logger.info("IMG-0147", key, version, filepath, arch); InstallerMetaData metaData = new InstallerMetaData(arch, filepath, - Utils.getSha256Hash(filepath), fileDate, version); + Utils.getSha256Hash(filepath), fileDate, version, version); ConfigManager.getInstance().addInstaller(InstallerType.fromString(key), version, metaData); } } else { diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/util/Utils.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/util/Utils.java index 38b0bea3..8b810a6c 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/util/Utils.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/util/Utils.java @@ -867,4 +867,16 @@ public static boolean isGenericInstallerAcceptable(InstallerType type) { List types = Arrays.asList(InstallerType.WDT); return types.contains(type); } + + /** + * Return true if the type is a base installer JDK, WDT, WLS, or FMW. + * @param type installer type + * @return true if the type is a base installer JDK, WDT, WLS, or FMW + */ + public static boolean isBaseInstallerType(InstallerType type) { + return type.equals(InstallerType.WDT) + || type.equals(InstallerType.WLS) + || type.equals(InstallerType.JDK) + || type.equals(InstallerType.FMW); + } } diff --git a/imagetool/src/main/resources/ImageTool.properties b/imagetool/src/main/resources/ImageTool.properties index 865a7b48..cb6a6904 100644 --- a/imagetool/src/main/resources/ImageTool.properties +++ b/imagetool/src/main/resources/ImageTool.properties @@ -147,4 +147,5 @@ IMG-0145=Cannot find installer [type: {0}, platform: {1}, version: {2}]. IMG-0146=When building a cross-platform image using podman, it may hang during middleware install. If it hangs, use \ a machine matching with the target platform. IMG-0147=Converting installer {0} version {1} path {2} architecture {3}. -IMG-0148=Converting patch {0} version {1} path {2} architecture {3}. \ No newline at end of file +IMG-0148=Converting patch {0} version {1} path {2} architecture {3}. +IMG-0149=Base WLS version {0} does not exists in the cache for adding installer. \ No newline at end of file diff --git a/imagetool/src/test/java/com/oracle/weblogic/imagetool/cachestore/CachedFileTest.java b/imagetool/src/test/java/com/oracle/weblogic/imagetool/cachestore/CachedFileTest.java index 71c75cc0..e425ebde 100644 --- a/imagetool/src/test/java/com/oracle/weblogic/imagetool/cachestore/CachedFileTest.java +++ b/imagetool/src/test/java/com/oracle/weblogic/imagetool/cachestore/CachedFileTest.java @@ -61,14 +61,14 @@ static void setup(@TempDir Path tempDir, @TempDir Path cacheDir) throws IOExcept InstallerMetaData installer1 = new InstallerMetaData("Generic", path12213.toString(), - VER_12213); + VER_12213, VER_12213); InstallerMetaData installer2 = new InstallerMetaData(Architecture.getLocalArchitecture().toString(), path12214.toString(), - "12.2.1.4.0"); + "12.2.1.4.0", "12.2.1.4.0"); InstallerMetaData installer3 = new InstallerMetaData("linux/amd64", path1411.toString(), - "14.1.1.0.0"); + "14.1.1.0.0", "14.1.1.0.0"); InstallerMetaData installer4 = new InstallerMetaData("linux/arm64", path1411.toString(), - "14.1.1.0.0"); + "14.1.1.0.0", "14.1.1.0.0"); configManager.addInstaller(InstallerType.WLS, VER_12213, installer1); configManager.addInstaller(InstallerType.WLS, "12.2.1.4.0", installer2); diff --git a/imagetool/src/test/java/com/oracle/weblogic/imagetool/installer/MiddlewareInstallTest.java b/imagetool/src/test/java/com/oracle/weblogic/imagetool/installer/MiddlewareInstallTest.java index fbcffc95..9ab653b1 100644 --- a/imagetool/src/test/java/com/oracle/weblogic/imagetool/installer/MiddlewareInstallTest.java +++ b/imagetool/src/test/java/com/oracle/weblogic/imagetool/installer/MiddlewareInstallTest.java @@ -50,7 +50,7 @@ static void setup(@TempDir Path cacheDir) throws IOException { ConfigManager configManager = ConfigManager.getInstance(settingsFileName); InstallerMetaData installer2 = new InstallerMetaData("Generic", path12214.toString(), - "12.2.1.4.0"); + "12.2.1.4.0", "12.2.1.4.0"); configManager.addInstaller(InstallerType.WLS, "12.2.1.4.0", installer2); } diff --git a/imagetool/src/test/java/com/oracle/weblogic/imagetool/util/DockerfileBuilderTest.java b/imagetool/src/test/java/com/oracle/weblogic/imagetool/util/DockerfileBuilderTest.java index d6c5379e..aee53590 100644 --- a/imagetool/src/test/java/com/oracle/weblogic/imagetool/util/DockerfileBuilderTest.java +++ b/imagetool/src/test/java/com/oracle/weblogic/imagetool/util/DockerfileBuilderTest.java @@ -55,7 +55,7 @@ static void setup(@TempDir Path cacheDir) throws IOException { ConfigManager configManager = ConfigManager.getInstance(settingsFileName); InstallerMetaData installer2 = new InstallerMetaData("Generic", path12214.toString(), - "12.2.1.4.0"); + "12.2.1.4.0", "12.2.1.4.0"); configManager.addInstaller(InstallerType.WLS, "12.2.1.4.0", installer2); } From 5ed5e9728b53d2082dbbdbe0fd3f569d37c53a19 Mon Sep 17 00:00:00 2001 From: jshum Date: Mon, 21 Apr 2025 09:55:28 -0500 Subject: [PATCH 084/104] force WDT architecture to Generic --- .../weblogic/imagetool/cli/cache/CacheAddOperation.java | 4 ++++ .../oracle/weblogic/imagetool/cli/menu/WdtBaseOptions.java | 3 ++- 2 files changed, 6 insertions(+), 1 deletion(-) diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/CacheAddOperation.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/CacheAddOperation.java index 66154ea3..59ec4c3b 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/CacheAddOperation.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/CacheAddOperation.java @@ -44,6 +44,10 @@ CommandResponse addInstallerToCache() throws IOException { } Architecture arch = getArchitecture(); + // Force WDT to be generic + if (InstallerType.fromString(type) == InstallerType.WDT) { + arch = Architecture.GENERIC; + } InstallerMetaData metaData = ConfigManager.getInstance().getInstallerForPlatform(InstallerType.fromString(type), arch, name); if (metaData != null) { diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/WdtBaseOptions.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/WdtBaseOptions.java index cfe54c7d..51742fd2 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/WdtBaseOptions.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/WdtBaseOptions.java @@ -15,6 +15,7 @@ import com.oracle.weblogic.imagetool.installer.InstallerType; import com.oracle.weblogic.imagetool.logging.LoggingFacade; import com.oracle.weblogic.imagetool.logging.LoggingFactory; +import com.oracle.weblogic.imagetool.util.Architecture; import com.oracle.weblogic.imagetool.util.DockerfileOptions; import com.oracle.weblogic.imagetool.util.Utils; import picocli.CommandLine.Option; @@ -83,7 +84,7 @@ public void handleWdtArgs(DockerfileOptions dockerfileOptions, String tmpDir) th } if (!skipWdtInstaller()) { - CachedFile wdtInstaller = new CachedFile(InstallerType.WDT, wdtVersion); + CachedFile wdtInstaller = new CachedFile(InstallerType.WDT, wdtVersion, Architecture.GENERIC); Path wdtfile = wdtInstaller.copyFile(tmpDir); dockerfileOptions.setWdtInstallerFilename(wdtfile.getFileName().toString()); } From 9db0f564d36680c07090b34919fc588c87b8f00d Mon Sep 17 00:00:00 2001 From: jshum Date: Tue, 29 Apr 2025 10:10:20 -0500 Subject: [PATCH 085/104] Correct OID image build --- .../imagetool/cachestore/CacheStore.java | 5 +- .../cli/menu/CommonCreateOptions.java | 55 ++++++++++++------- .../src/main/resources/ImageTool.properties | 3 +- 3 files changed, 41 insertions(+), 22 deletions(-) diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cachestore/CacheStore.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cachestore/CacheStore.java index 98f3807f..702d0843 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cachestore/CacheStore.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cachestore/CacheStore.java @@ -135,7 +135,8 @@ public void addInstaller(InstallerType installerType, String commonName, Install } if (!baseFMWVersionExists(installerType, installerDetails, metaData.getBaseFMWVersion())) { - logger.severe("IMG-0149", metaData.getBaseFMWVersion()); + logger.severe("IMG-0149", metaData.getBaseFMWVersion(), metaData.getProductVersion(), + installerType.toString().toUpperCase()); System.exit(2); } @@ -156,7 +157,7 @@ private boolean baseFMWVersionExists(InstallerType type, Map> installers = installerDetails.get( - InstallerType.WLS.toString().toUpperCase()); + InstallerType.FMW.toString().toUpperCase()); return installers.containsKey(baseFMWVersion); } } else { diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonCreateOptions.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonCreateOptions.java index 79f5f09e..2d8a6ad8 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonCreateOptions.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonCreateOptions.java @@ -114,30 +114,47 @@ void verifyInstallers(List buildPlatforms) throws IOException { for (String buildPlatform : buildPlatforms) { Architecture arch = Architecture.fromString(buildPlatform); jdkVersion = resetInstallerVersion(InstallerType.JDK, jdkVersion); - InstallerMetaData jdkInstallerMetaData = configManager.getInstallerForPlatform(InstallerType.JDK, - arch, jdkVersion); - if (jdkInstallerMetaData == null) { - throw new IllegalArgumentException(Utils.getMessage("IMG-0145", InstallerType.JDK, - buildPlatform, jdkVersion)); + verifyInstallerExists(configManager, InstallerType.JDK, arch, jdkVersion, buildPlatform); + if (getInstallerType().equals(FmwInstallerType.OID)) { + verifyOIDInstallers(configManager, arch, buildPlatform, installerVersion); } else { - // If needed - verifyInstallerHash(jdkInstallerMetaData); + verifyNormalInstallers(getInstallerType().installerList(), configManager, arch, buildPlatform); } + } - for (InstallerType installerType : getInstallerType().installerList()) { - installerVersion = resetInstallerVersion(installerType, installerVersion); - InstallerMetaData installerMetaData = configManager.getInstallerForPlatform(installerType, - arch, installerVersion); - if (installerMetaData == null) { - throw new IllegalArgumentException(Utils.getMessage("IMG-0145", installerType, - buildPlatform, installerVersion)); - } else { - // If needed - verifyInstallerHash(installerMetaData); - } - } + } + + void verifyOIDInstallers(ConfigManager configManager, Architecture arch, + String buildPlatform, String installerVersion) throws IOException { + verifyInstallerExists(configManager, InstallerType.OID, arch, installerVersion, buildPlatform); + InstallerMetaData installerMetaData = configManager.getInstallerForPlatform(InstallerType.OID, + arch, installerVersion); + String baseFMWVersion = installerMetaData.getBaseFMWVersion(); + verifyInstallerExists(configManager, InstallerType.FMW, arch, baseFMWVersion, buildPlatform); + } + + void verifyNormalInstallers(List installers, ConfigManager configManager, Architecture arch, + String buildPlatform) throws IOException { + for (InstallerType installerType : installers) { + installerVersion = resetInstallerVersion(installerType, installerVersion); + verifyInstallerExists(configManager, installerType, arch, installerVersion, buildPlatform); } + } + + void verifyInstallerExists(ConfigManager configManager, InstallerType installerType, Architecture arch, + String installerVersion, String buildPlatform) throws IOException { + logger.info("IMG-0150", installerType, installerVersion, arch); + + InstallerMetaData installerMetaData = configManager.getInstallerForPlatform(installerType, + arch, installerVersion); + if (installerMetaData == null) { + throw new IllegalArgumentException(Utils.getMessage("IMG-0145", installerType, + buildPlatform, installerVersion)); + } else { + // If needed + verifyInstallerHash(installerMetaData); + } } private String resetJDKVersion(String jdkVersion) { diff --git a/imagetool/src/main/resources/ImageTool.properties b/imagetool/src/main/resources/ImageTool.properties index cb6a6904..90e103dc 100644 --- a/imagetool/src/main/resources/ImageTool.properties +++ b/imagetool/src/main/resources/ImageTool.properties @@ -148,4 +148,5 @@ IMG-0146=When building a cross-platform image using podman, it may hang during m a machine matching with the target platform. IMG-0147=Converting installer {0} version {1} path {2} architecture {3}. IMG-0148=Converting patch {0} version {1} path {2} architecture {3}. -IMG-0149=Base WLS version {0} does not exists in the cache for adding installer. \ No newline at end of file +IMG-0149=Base FMW installer version {0} does not exists in the cache for adding installer {1} version {2}. +IMG-0150=Verifying installer type {0}, version {1}, architecture {2} exists. \ No newline at end of file From 15554e8bbccb8788e17fb897b9521bafc11dfe8b Mon Sep 17 00:00:00 2001 From: jshum Date: Tue, 29 Apr 2025 11:03:54 -0500 Subject: [PATCH 086/104] another oid create fix --- .../weblogic/imagetool/cli/menu/CommonCreateOptions.java | 3 +++ 1 file changed, 3 insertions(+) diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonCreateOptions.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonCreateOptions.java index 2d8a6ad8..6175d382 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonCreateOptions.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonCreateOptions.java @@ -130,6 +130,9 @@ void verifyOIDInstallers(ConfigManager configManager, Architecture arch, InstallerMetaData installerMetaData = configManager.getInstallerForPlatform(InstallerType.OID, arch, installerVersion); String baseFMWVersion = installerMetaData.getBaseFMWVersion(); + if (baseFMWVersion == null) { + baseFMWVersion = installerMetaData.getBaseFMWVersion(); + } verifyInstallerExists(configManager, InstallerType.FMW, arch, baseFMWVersion, buildPlatform); } From aa21896582a7bc1c7a4567c03723a43105dd3c28 Mon Sep 17 00:00:00 2001 From: jshum Date: Tue, 29 Apr 2025 11:04:46 -0500 Subject: [PATCH 087/104] set correct FMW version if no one provided --- .../oracle/weblogic/imagetool/cli/menu/CommonCreateOptions.java | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonCreateOptions.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonCreateOptions.java index 6175d382..1eb86c57 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonCreateOptions.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonCreateOptions.java @@ -131,7 +131,7 @@ void verifyOIDInstallers(ConfigManager configManager, Architecture arch, arch, installerVersion); String baseFMWVersion = installerMetaData.getBaseFMWVersion(); if (baseFMWVersion == null) { - baseFMWVersion = installerMetaData.getBaseFMWVersion(); + baseFMWVersion = installerVersion; } verifyInstallerExists(configManager, InstallerType.FMW, arch, baseFMWVersion, buildPlatform); } From 45ea99315572c557b27907b290f54ed8ce749b1b Mon Sep 17 00:00:00 2001 From: jshum Date: Tue, 29 Apr 2025 16:41:26 -0500 Subject: [PATCH 088/104] Fix conversion --- .../imagetool/cachestore/CacheStore.java | 2 +- .../imagetool/util/CacheConversion.java | 17 +++++++++++++++-- .../oracle/weblogic/imagetool/util/Utils.java | 2 ++ 3 files changed, 18 insertions(+), 3 deletions(-) diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cachestore/CacheStore.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cachestore/CacheStore.java index 702d0843..52813c38 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cachestore/CacheStore.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cachestore/CacheStore.java @@ -158,7 +158,7 @@ private boolean baseFMWVersionExists(InstallerType type, Map> installers = installerDetails.get( InstallerType.FMW.toString().toUpperCase()); - return installers.containsKey(baseFMWVersion); + return installers != null && installers.containsKey(baseFMWVersion); } } else { return true; diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/util/CacheConversion.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/util/CacheConversion.java index 7cdcde90..42863353 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/util/CacheConversion.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/util/CacheConversion.java @@ -89,7 +89,7 @@ private void handleInstallerPattern(Pattern installerPattern, String line) throw } } else if (tokens.length == 3) { key = tokens[0]; - version = tokens[1]; + version = convertVersionString(tokens[1]); arch = tokens[2]; arch = Architecture.fromString(arch).toString(); } else { @@ -125,7 +125,7 @@ private void handlePatchPattern(String line) throws IOException { version = tokens[1]; } else if (tokens.length == 3) { key = tokens[0]; - version = tokens[1]; + version = convertVersionString(tokens[1]); arch = tokens[2]; arch = Architecture.fromString(arch).toString(); } else { @@ -148,6 +148,19 @@ private void handlePatchPattern(String line) throws IOException { } + private String convertVersionString(String version) { + if (version != null && version.length() == 6) { + return String.format("%s.%s.%s.%s.%s", + version.substring(0,1), + version.substring(2,2), + version.substring(3,3), + version.substring(4,4), + version.substring(5,5)); + } else { + return version; + } + } + private String getFileDate(String filepath) { try { Path path = Paths.get(filepath); diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/util/Utils.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/util/Utils.java index 8b810a6c..24b7d59a 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/util/Utils.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/util/Utils.java @@ -877,6 +877,8 @@ public static boolean isBaseInstallerType(InstallerType type) { return type.equals(InstallerType.WDT) || type.equals(InstallerType.WLS) || type.equals(InstallerType.JDK) + || type.equals(InstallerType.DB19) + || type.equals(InstallerType.OHS) || type.equals(InstallerType.FMW); } } From 2d85333c501146d1f844a80d751a00b971b802b5 Mon Sep 17 00:00:00 2001 From: jshum Date: Tue, 29 Apr 2025 17:02:52 -0500 Subject: [PATCH 089/104] Fixed convert and list patches --- .../com/oracle/weblogic/imagetool/cli/cache/ListPatches.java | 1 + .../com/oracle/weblogic/imagetool/util/CacheConversion.java | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/ListPatches.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/ListPatches.java index 796748a6..131c5ee4 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/ListPatches.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/ListPatches.java @@ -47,6 +47,7 @@ public CommandResponse call() { System.out.println(" location: " + metaData.getLocation()); if (details) { System.out.println(" digest: " + metaData.getDigest()); + System.out.println(" description: " + metaData.getDescription()); System.out.println(" dateAdded: " + metaData.getDateAdded()); } diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/util/CacheConversion.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/util/CacheConversion.java index 42863353..bc872c4c 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/util/CacheConversion.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/util/CacheConversion.java @@ -140,7 +140,7 @@ private void handlePatchPattern(String line) throws IOException { logger.info("IMG-0148", key, version, filepath); ConfigManager.getInstance().addPatch(key, arch, filepath, version, - "Converted from v1 in " + fileDate, fileDate); + "Converted from v1", fileDate); } } else { logger.warning(IMG_0128, line); From f437adeeae33dc9c4137c0824a8dd173dc37ebb1 Mon Sep 17 00:00:00 2001 From: jshum Date: Wed, 30 Apr 2025 12:43:57 -0500 Subject: [PATCH 090/104] improve error detection when installer is not found --- .../imagetool/api/model/CachedFile.java | 11 +++---- .../weblogic/imagetool/aru/AruUtil.java | 29 +++++++++++++++++-- 2 files changed, 33 insertions(+), 7 deletions(-) diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/api/model/CachedFile.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/api/model/CachedFile.java index c3920811..6277e9c4 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/api/model/CachedFile.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/api/model/CachedFile.java @@ -107,17 +107,18 @@ public String resolve() throws IOException { if (metaData == null) { metaData = ConfigManager.getInstance() .getInstallerForPlatform(installerType, Architecture.getLocalArchitecture(), getVersion()); - } - if (metaData == null) { - metaData = ConfigManager.getInstance() - .getInstallerForPlatform(installerType, Architecture.GENERIC, getVersion()); + + if (metaData == null) { + metaData = ConfigManager.getInstance() + .getInstallerForPlatform(installerType, Architecture.GENERIC, getVersion()); + } } if (metaData != null) { filePath = metaData.getLocation(); } - if (!isFileOnDisk(filePath)) { + if (metaData == null || !isFileOnDisk(filePath)) { throw new FileNotFoundException(Utils.getMessage("IMG-0011", installerType, getVersion(), getArchitecture(), filePath)); } diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/aru/AruUtil.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/aru/AruUtil.java index 93448b7a..49370919 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/aru/AruUtil.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/aru/AruUtil.java @@ -18,6 +18,8 @@ import com.github.mustachejava.DefaultMustacheFactory; import com.oracle.weblogic.imagetool.installer.FmwInstallerType; +import com.oracle.weblogic.imagetool.installer.InstallerMetaData; +import com.oracle.weblogic.imagetool.installer.InstallerType; import com.oracle.weblogic.imagetool.logging.LoggingFacade; import com.oracle.weblogic.imagetool.logging.LoggingFactory; import com.oracle.weblogic.imagetool.settings.ConfigManager; @@ -110,7 +112,18 @@ public List getLatestPsu(FmwInstallerType type, String version, Archit throws AruException { List result = new ArrayList<>(); for (AruProduct product : type.products()) { - List psuList = getLatestPsu(product, version, architecture, userId, password); + + String baseVersion = version; + + if (type == FmwInstallerType.IDM && product == AruProduct.JRF) { + InstallerMetaData metaData = ConfigManager.getInstance().getInstallerForPlatform(InstallerType.IDM, + architecture, version); + if (metaData != null && metaData.getBaseFMWVersion() != null) { + baseVersion = metaData.getBaseFMWVersion(); + } + } + + List psuList = getLatestPsu(product, baseVersion, architecture, userId, password); if (!psuList.isEmpty()) { for (AruPatch psu: psuList) { String patchAndVersion = psu.patchId() + "_" + psu.version(); @@ -177,8 +190,20 @@ List getLatestPsu(AruProduct product, String version, Architecture arc public List getRecommendedPatches(FmwInstallerType type, String version, Architecture architecture, String userId, String password) throws AruException { List result = new ArrayList<>(); + for (AruProduct product : type.products()) { - List patches = getRecommendedPatches(type, product, version, architecture, userId, password); + + String baseVersion = version; + + if (type == FmwInstallerType.IDM && product == AruProduct.JRF) { + InstallerMetaData metaData = ConfigManager.getInstance().getInstallerForPlatform(InstallerType.IDM, + architecture, version); + if (metaData != null && metaData.getBaseFMWVersion() != null) { + baseVersion = metaData.getBaseFMWVersion(); + } + } + + List patches = getRecommendedPatches(type, product, baseVersion, architecture, userId, password); if (!patches.isEmpty()) { patches.forEach(p -> logger.info("IMG-0068", product.description(), p.patchId(), p.description())); From 1ea431d0c20a4ea440afecca57d6ba293e83c58e Mon Sep 17 00:00:00 2001 From: jshum Date: Fri, 2 May 2025 07:28:13 -0500 Subject: [PATCH 091/104] restructure mustache to increase readability --- .../imagetool/builder/BuildCommand.java | 12 +++++++++++ .../imagetool/cli/menu/CommonOptions.java | 8 +++++++ .../install-middleware-pkg.mustache | 21 ++++++++++--------- .../docker-files/install-middleware.mustache | 19 ++++++++--------- 4 files changed, 40 insertions(+), 20 deletions(-) diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/builder/BuildCommand.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/builder/BuildCommand.java index 48da95c5..32e72810 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/builder/BuildCommand.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/builder/BuildCommand.java @@ -50,6 +50,18 @@ public BuildCommand tag(String value) { return this; } + /** + * Toggle the use of the BuildKit. + * If true, the build command will start "buildx build". + * If false, the build command will start "build". + * @param value true to enable buildx + * @return this + */ + public BuildCommand useBuildx(boolean value) { + useBuildx = value; + return this; + } + /** * Add container build platform. Pass the desired * build architecture to the build process. diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonOptions.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonOptions.java index 1234f7a2..8370ee39 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonOptions.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonOptions.java @@ -127,6 +127,7 @@ void runDockerCommand(String dockerfile, AbstractCommand command) throws IOExcep BuildCommand getInitialBuildCmd(String contextFolder) { logger.entering(); BuildCommand cmdBuilder = new BuildCommand(buildEngine, contextFolder) + .useBuildx(useBuildx) .forceRm(!skipcleanup) .tag(imageTag) .platform(buildPlatform) @@ -504,12 +505,19 @@ public List getBuildPlatform() { ) private boolean load = false; + @Option( + names = {"--useBuildx"}, + description = "Use the BuildKit for building the container image (default when building multi-architecture)" + ) + private boolean useBuildx; + @Parameters( description = "Container build options.", hidden = true ) List buildOptions; + @Spec CommandLine.Model.CommandSpec spec; diff --git a/imagetool/src/main/resources/docker-files/install-middleware-pkg.mustache b/imagetool/src/main/resources/docker-files/install-middleware-pkg.mustache index bcb6c4ec..0227a2a1 100644 --- a/imagetool/src/main/resources/docker-files/install-middleware-pkg.mustache +++ b/imagetool/src/main/resources/docker-files/install-middleware-pkg.mustache @@ -1,15 +1,16 @@ && echo "INSTALLING {{type}}" \ -{{#isZip}}&& unzip -q "{{{tempDir}}}/{{{type}}}/$TARGETPLATFORM/{{installerFilename}}" -d {{{tempDir}}}/{{{type}}} {{/isZip}} \ -{{#preinstallCommands}}&& {{{tempDir}}}/{{{type}}}/{{{.}}} {{/preinstallCommands}} \ -{{^isBin}} && if [ ! -f {{{tempDir}}}/{{{type}}}/{{jarName}} ] ; then (cp {{{tempDir}}}/{{{type}}}/$TARGETPLATFORM/{{installerFilename}} {{{tempDir}}}/{{{type}}}) fi \ +{{#isZip}}&& unzip -q "{{{tempDir}}}/{{{type}}}/$TARGETPLATFORM/{{installerFilename}}" -d {{{tempDir}}}/{{{type}}} {{/isZip}}{{^isZip}}&& : {{/isZip}}\ +{{#preinstallCommands}}&& {{{tempDir}}}/{{{type}}}/{{{.}}} {{/preinstallCommands}}{{^preInstallCommands}}&& : {{/preInstallCommands}}\ +{{^isBin}}&& [ -f {{{tempDir}}}/{{{type}}}/{{jarName}} ] || cp {{{tempDir}}}/{{{type}}}/$TARGETPLATFORM/{{installerFilename}} {{{tempDir}}}/{{{type}}} \ && {{{java_home}}}/bin/java -Xmx1024m -jar {{{tempDir}}}/{{{type}}}/{{jarName}} \ -silent ORACLE_HOME={{{oracle_home}}} \ -responseFile {{{tempDir}}}/{{{type}}}/$TARGETPLATFORM/{{responseFile.name}} \ --invPtrLoc {{inv_loc}}/oraInst.loc \ --ignoreSysPrereqs -force -novalidation {{/isBin}} \ -{{#isBin}} && if [ ! -f {{{tempDir}}}/{{{type}}}/{{jarName}} ] ; then (cp {{{tempDir}}}/{{{type}}}/$TARGETPLATFORM/{{installerFilename}} {{{tempDir}}}/{{{type}}}) fi \ +-invPtrLoc {{inv_loc}}/oraInst.loc -ignoreSysPrereqs -force -novalidation {{/isBin}}{{#isBin}}&& : {{/isBin}}\ +{{#isBin}}&& [ -f {{{tempDir}}}/{{{type}}}/{{jarName}} ] || cp {{{tempDir}}}/{{{type}}}/$TARGETPLATFORM/{{installerFilename}} {{{tempDir}}}/{{{type}}} \ && chmod +x {{{tempDir}}}/{{{type}}}/{{jarName}} \ -&& {{{tempDir}}}/{{{type}}}/{{jarName}} \ --force -ignoreSysPrereqs -silent \ --responseFile "{{{tempDir}}}/{{{type}}}/$TARGETPLATFORM/{{responseFile.name}}" \ --invPtrLoc {{inv_loc}}/oraInst.loc ORACLE_HOME={{{oracle_home}}} -jreLoc {{{java_home}}} {{/isBin}} \ \ No newline at end of file +&& {{{tempDir}}}/{{{type}}}/{{jarName}} -force -ignoreSysPrereqs \ +-silent -responseFile "{{{tempDir}}}/{{{type}}}/$TARGETPLATFORM/{{responseFile.name}}" \ +-invPtrLoc {{inv_loc}}/oraInst.loc ORACLE_HOME={{{oracle_home}}} \ +-jreLoc {{{java_home}}} {{/isBin}}{{^isBin}}&& : {{/isBin}}\ +&& chmod -R g+r {{{oracle_home}}} \ +&& { grep -vh "NOTIFICATION" /tmp/OraInstall*/install*.log || true; } \ \ No newline at end of file diff --git a/imagetool/src/main/resources/docker-files/install-middleware.mustache b/imagetool/src/main/resources/docker-files/install-middleware.mustache index 5d141a07..eb315ce1 100644 --- a/imagetool/src/main/resources/docker-files/install-middleware.mustache +++ b/imagetool/src/main/resources/docker-files/install-middleware.mustache @@ -44,24 +44,23 @@ USER {{userid}} # installPackagesForAMD - list of packages to install for amd64 platform -RUN if [ "$TARGETPLATFORM" == "linux/arm64" ] ; then \ +RUN case "$TARGETPLATFORM" in \ + "linux/arm64") \ echo "INSTALLING MIDDLEWARE" \ {{#installPackagesForARM}} {{> install-middleware-pkg }} - {{/installPackagesForARM}} - && test $? -eq 0 \ - && chmod -R g+r {{{oracle_home}}} \ - || (grep -vh "NOTIFICATION" /tmp/OraInstall*/install*.log && exit 1); \ - fi && \ - if [ "$TARGETPLATFORM" == "linux/amd64" ] ; then \ + {{/installPackagesForARM}} + ;; \ + "linux/amd64") \ echo "INSTALLING MIDDLEWARE" \ {{#installPackagesForAMD}} {{> install-middleware-pkg }} {{/installPackagesForAMD}} - && test $? -eq 0 \ + ;; \ + esac \ && chmod -R g+r {{{oracle_home}}} \ - || (grep -vh "NOTIFICATION" /tmp/OraInstall*/install*.log && exit 1); \ - fi + || { grep -vh "NOTIFICATION" /tmp/OraInstall*/install*.log || true; } + {{#useOwnerPermsForGroup}} # OPatch needs write permissions to the logs folder and lock file when running in OpenShift From 8b07d4538df24d83d6f1ab59711fb5f2d0edc3e5 Mon Sep 17 00:00:00 2001 From: jshum Date: Fri, 2 May 2025 10:13:27 -0500 Subject: [PATCH 092/104] Fix NPE for invalid platform name and installer not found --- .../oracle/weblogic/imagetool/cachestore/CacheStore.java | 5 +++-- .../weblogic/imagetool/cli/menu/CommonOptions.java | 9 +++++++++ .../weblogic/imagetool/installer/MiddlewareInstall.java | 2 +- .../weblogic/imagetool/settings/ConfigManager.java | 7 ++++++- .../com/oracle/weblogic/imagetool/util/Architecture.java | 5 +++-- imagetool/src/main/resources/ImageTool.properties | 7 +++++-- 6 files changed, 27 insertions(+), 8 deletions(-) diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cachestore/CacheStore.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cachestore/CacheStore.java index 52813c38..55450e4b 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cachestore/CacheStore.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cachestore/CacheStore.java @@ -430,7 +430,7 @@ private InstallerMetaData getInstallerMetaData(String installerVersion, Installe List installerMetaDataList = installers.get(installerVersion); if (installerMetaDataList != null && !installerMetaDataList.isEmpty()) { - + logger.info("IMG-0151", installerType, installerVersion, platformName); Optional foundInstaller = installerMetaDataList.stream() .filter(installerMetaData -> platformName.getAcceptableNames() .contains(installerMetaData.getArchitecture())) @@ -442,6 +442,7 @@ private InstallerMetaData getInstallerMetaData(String installerVersion, Installe if (Utils.isGenericInstallerAcceptable(installerType)) { //If it can't find the specialized platform, try generic. + logger.info("IMG-0152", installerType, installerVersion, platformName); foundInstaller = installerMetaDataList.stream() .filter(installerMetaData -> Architecture.GENERIC.getAcceptableNames() @@ -454,7 +455,7 @@ private InstallerMetaData getInstallerMetaData(String installerVersion, Installe } } - + System.out.println("get InstallerMetaData return null"); return null; } } diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonOptions.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonOptions.java index 8370ee39..cb68b198 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonOptions.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonOptions.java @@ -366,6 +366,15 @@ public List getBuildPlatform() { } buildPlatform.add(platform); } + for (String platform : buildPlatform) { + boolean valid = Architecture.AMD64.getAcceptableNames().contains(platform) + || Architecture.ARM64.getAcceptableNames().contains(platform) + || Architecture.GENERIC.getAcceptableNames().contains(platform); + if (!valid) { + throw new IllegalArgumentException("Unknown platform: " + platform); + } + } + buildPlatform.replaceAll(value -> Utils.standardPlatform(Architecture.fromString(value).toString())); return buildPlatform; } diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/installer/MiddlewareInstall.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/installer/MiddlewareInstall.java index 004dfe54..d4024c55 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/installer/MiddlewareInstall.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/installer/MiddlewareInstall.java @@ -60,13 +60,13 @@ public MiddlewareInstall(FmwInstallerType type, String version, List respo for (InstallerType installerType : type.installerList()) { for (String platform : buildPlatform) { + logger.info("IMG-0153", installerType, version, platform); platform = Utils.standardPlatform(platform); MiddlewareInstallPackage pkg = new MiddlewareInstallPackage(); Architecture arch = Architecture.fromString(platform); if (localArchitecture != arch) { logger.warning("IMG-0146"); } - pkg.type = installerType; if (AMD64_BLD.equals(platform)) { pkg.installer = new CachedFile(installerType, version, Architecture.AMD64); diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/ConfigManager.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/ConfigManager.java index f5630b7a..c55a326e 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/ConfigManager.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/ConfigManager.java @@ -170,7 +170,12 @@ public PatchMetaData getPatchForPlatform(String platformName, String bugNumber, */ public InstallerMetaData getInstallerForPlatform(InstallerType installerType, Architecture platformName, String installerVersion) { - return cacheStore.getInstallerForPlatform(installerType, platformName, installerVersion); + InstallerMetaData metaData = cacheStore.getInstallerForPlatform(installerType, platformName, installerVersion); + if (metaData == null) { + throw new IllegalArgumentException("Cannot find Installer " + installerType + " architecture " + + platformName + " version " + installerVersion); + } + return metaData; } /** diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/util/Architecture.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/util/Architecture.java index 5cce402b..a8928301 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/util/Architecture.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/util/Architecture.java @@ -65,8 +65,9 @@ public static Architecture fromString(String value) { } } } - logger.warning("IMG-0121", value); - return AMD64; + + logger.warning("IMG-0121", value, Architecture.getLocalArchitecture()); + return Architecture.getLocalArchitecture(); } /** diff --git a/imagetool/src/main/resources/ImageTool.properties b/imagetool/src/main/resources/ImageTool.properties index 90e103dc..bf67a661 100644 --- a/imagetool/src/main/resources/ImageTool.properties +++ b/imagetool/src/main/resources/ImageTool.properties @@ -119,7 +119,7 @@ IMG-0117=The value for --sourceImage must not be empty. IMG-0118=Failed to clean up intermediate container images for build ID {0} IMG-0119=All parameters and options provided after the -- will be passed to the container image build command. IMG-0120=Retries exhausted, unable to download patch from Oracle. Try again later or manually add the patch to the cache to skip this download step. -IMG-0121=Did not recognize architecture name {0}. Defaulted to AMD64. +IMG-0121=Did not recognize '-platform' name {0}. Defaulted to {1}. IMG-0122=Invalid patch {0} for version {1}. A patch cannot be both generic and architecture specific. Remove the invalid entry from the cache, like {0}_{1}_xxx64. IMG-0123=Cannot find the patch {0} for platform {1}, no patch for this platform will be applied. IMG-0124=You must specify --type --version and --architecture for deleting an installer. @@ -149,4 +149,7 @@ IMG-0146=When building a cross-platform image using podman, it may hang during m IMG-0147=Converting installer {0} version {1} path {2} architecture {3}. IMG-0148=Converting patch {0} version {1} path {2} architecture {3}. IMG-0149=Base FMW installer version {0} does not exists in the cache for adding installer {1} version {2}. -IMG-0150=Verifying installer type {0}, version {1}, architecture {2} exists. \ No newline at end of file +IMG-0150=Verifying installer type {0}, version {1}, architecture {2} exists. +IMG-0151=Locating installer type {0}, version {1}, architecture {2}. +IMG-0152=Cannot find installer type {0}, version {1}, architecture {2} in the cache, trying Generic architecture. +IMG-0153=Preparing Middleware Installer {0}, version {1}, architecture {2}. \ No newline at end of file From e6110a02f44cf1d773d330ec88fe9b377245bf20 Mon Sep 17 00:00:00 2001 From: jshum Date: Fri, 2 May 2025 16:20:44 -0500 Subject: [PATCH 093/104] minor fixes --- .../oracle/weblogic/imagetool/cli/menu/CommonOptions.java | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonOptions.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonOptions.java index cb68b198..5d95af5a 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonOptions.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonOptions.java @@ -17,6 +17,7 @@ import java.util.UUID; import java.util.regex.Matcher; import java.util.regex.Pattern; +import java.util.stream.Collectors; import com.oracle.weblogic.imagetool.api.model.CommandResponse; import com.oracle.weblogic.imagetool.aru.InvalidCredentialException; @@ -368,14 +369,13 @@ public List getBuildPlatform() { } for (String platform : buildPlatform) { boolean valid = Architecture.AMD64.getAcceptableNames().contains(platform) - || Architecture.ARM64.getAcceptableNames().contains(platform) - || Architecture.GENERIC.getAcceptableNames().contains(platform); + || Architecture.ARM64.getAcceptableNames().contains(platform); if (!valid) { - throw new IllegalArgumentException("Unknown platform: " + platform); + throw new IllegalArgumentException("Unknown build platform: " + platform); } } buildPlatform.replaceAll(value -> Utils.standardPlatform(Architecture.fromString(value).toString())); - return buildPlatform; + return buildPlatform.stream().distinct().collect(Collectors.toList()); } @Option( From 1f0fc70844b3e42da9d0c148e142dc9e5c01bc0a Mon Sep 17 00:00:00 2001 From: jshum Date: Thu, 10 Jul 2025 15:11:33 -0500 Subject: [PATCH 094/104] Fix npe add new installer --- .../imagetool/cachestore/CacheStore.java | 1 - .../imagetool/cli/config/ShowCommand.java | 40 ++++++++++++++++--- .../cli/menu/CommonCreateOptions.java | 8 ++++ .../installer/MiddlewareInstall.java | 10 +++++ .../imagetool/settings/ConfigManager.java | 7 +--- .../imagetool/settings/SettingsFile.java | 18 +++++++++ .../imagetool/settings/UserSettingsFile.java | 6 ++- .../imagetool/cachestore/CachedFileTest.java | 5 ++- .../imagetool/settings/UserSettingsTest.java | 2 +- 9 files changed, 80 insertions(+), 17 deletions(-) diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cachestore/CacheStore.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cachestore/CacheStore.java index 55450e4b..1114f7de 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cachestore/CacheStore.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cachestore/CacheStore.java @@ -455,7 +455,6 @@ private InstallerMetaData getInstallerMetaData(String installerVersion, Installe } } - System.out.println("get InstallerMetaData return null"); return null; } } diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/config/ShowCommand.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/config/ShowCommand.java index 514a2a44..2750337b 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/config/ShowCommand.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/config/ShowCommand.java @@ -23,23 +23,51 @@ public class ShowCommand implements Callable { names = {"--name"}, description = "Name of the setting", order = 0, - required = true + required = false ) private ConfigAttributeName name; + @CommandLine.Option( + names = {"--all"}, + description = "Show all the settings", + order = 1, + required = false + ) + private boolean all; + @Override public CommandResponse call() throws Exception { logger.entering(); UserSettingsFile settings = new UserSettingsFile(); - String result = name.get(settings); - logger.exiting(); - if (result != null) { - System.out.println(result); + if (all) { + printAllSettings(settings); + return new CommandResponse(0, ""); + } + if (name != null) { + String result = name.get(settings); + printSettingValue(name.toString(), result); return new CommandResponse(0, ""); + } + return new CommandResponse(0, ""); + } + + private static void printSettingValue(String setting, Object value) { + if (value != null) { + System.out.println(setting + ": " + value); } else { - return new CommandResponse(CommandLine.ExitCode.SOFTWARE, "Not Found"); + System.out.println(setting + ": not set"); } } + + private static void printAllSettings(UserSettingsFile settings) { + printSettingValue("aruRetryInterval", settings.getAruRetryInterval()); + printSettingValue("aruRetryMax", settings.getAruRetryMax()); + printSettingValue("defaultBuildPlatform", settings.getDefaultBuildPlatform()); + printSettingValue("buildContextDirectory", settings.getBuildContextDirectory()); + printSettingValue("containerEngine", settings.getContainerEngine()); + printSettingValue("installerDirectory", settings.getInstallerDirectory()); + printSettingValue("patchDirectory", settings.getPatchDirectory()); + } } diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonCreateOptions.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonCreateOptions.java index 1eb86c57..5165a81f 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonCreateOptions.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonCreateOptions.java @@ -67,6 +67,10 @@ void prepareNewImage() throws IOException, InterruptedException, XPathExpression //Path installerPath = jdk.copyFile(cache(), buildContextDestination); InstallerMetaData installerMetaData = ConfigManager.getInstance() .getInstallerForPlatform(InstallerType.JDK, arch, jdkVersion); + if (installerMetaData == null) { + throw new IllegalArgumentException(Utils.getMessage("IMG-0145", InstallerType.JDK, + arch, jdkVersion)); + } Path installerPath = Paths.get(installerMetaData.getLocation()); Files.copy(installerPath, Paths.get(buildContextDestination).resolve(installerPath.getFileName())); jdkFilePathList.add(installerPath.getFileName().toString()); @@ -129,6 +133,10 @@ void verifyOIDInstallers(ConfigManager configManager, Architecture arch, verifyInstallerExists(configManager, InstallerType.OID, arch, installerVersion, buildPlatform); InstallerMetaData installerMetaData = configManager.getInstallerForPlatform(InstallerType.OID, arch, installerVersion); + if (installerMetaData == null) { + throw new IllegalArgumentException(Utils.getMessage("IMG-0145", InstallerType.OID, + arch, installerVersion)); + } String baseFMWVersion = installerMetaData.getBaseFMWVersion(); if (baseFMWVersion == null) { baseFMWVersion = installerVersion; diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/installer/MiddlewareInstall.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/installer/MiddlewareInstall.java index d4024c55..571560e0 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/installer/MiddlewareInstall.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/installer/MiddlewareInstall.java @@ -81,10 +81,20 @@ public MiddlewareInstall(FmwInstallerType type, String version, List respo InstallerMetaData productData = configManager.getInstallerForPlatform( InstallerType.fromString(originalType), Architecture.fromString(platform), version); + if (productData == null) { + throw new IllegalArgumentException(Utils.getMessage("IMG-0145", + InstallerType.fromString(originalType), + Architecture.fromString(platform), version)); + } + useVersion = productData.getBaseFMWVersion(); } InstallerMetaData metaData = configManager.getInstallerForPlatform(installerType, arch, useVersion); + if (metaData == null) { + throw new IllegalArgumentException(Utils.getMessage("IMG-0145", installerType, + arch, useVersion)); + } pkg.installerPath = Paths.get(metaData.getLocation()); pkg.installerFilename = pkg.installerPath.getFileName().toString(); pkg.responseFile = new DefaultResponseFile(installerType, type); diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/ConfigManager.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/ConfigManager.java index c55a326e..f5630b7a 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/ConfigManager.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/ConfigManager.java @@ -170,12 +170,7 @@ public PatchMetaData getPatchForPlatform(String platformName, String bugNumber, */ public InstallerMetaData getInstallerForPlatform(InstallerType installerType, Architecture platformName, String installerVersion) { - InstallerMetaData metaData = cacheStore.getInstallerForPlatform(installerType, platformName, installerVersion); - if (metaData == null) { - throw new IllegalArgumentException("Cannot find Installer " + installerType + " architecture " - + platformName + " version " + installerVersion); - } - return metaData; + return cacheStore.getInstallerForPlatform(installerType, platformName, installerVersion); } /** diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/SettingsFile.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/SettingsFile.java index 214f4153..21b376e4 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/SettingsFile.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/SettingsFile.java @@ -165,6 +165,24 @@ public static T getValue(String settingName, Class type, Map Default value + * @return The value of the requested attribute. + */ + public static T getValueOrDefault(String settingName, Class type, Map settings, + Object defaultValue) { + Object result = SettingsFile.getValue(settingName, type, settings); + if (result == null && defaultValue != null) { + result = defaultValue; + } + return type.cast(result); + } + /** * Get the folder for the settings by name from the provided settings map. * For nested maps withing the settings map. diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/UserSettingsFile.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/UserSettingsFile.java index eee349df..446c81c0 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/UserSettingsFile.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/UserSettingsFile.java @@ -289,8 +289,10 @@ private void applySettings(Map settings) { containerEngine = SettingsFile.getValue("containerEngine", String.class, settings); defaultBuildPlatform = SettingsFile.getValue("defaultBuildPlatform", String.class, settings); - aruRetryMax = SettingsFile.getValue("aruRetryMax", Integer.class, settings); - aruRetryInterval = SettingsFile.getValue("aruRetryInterval", Integer.class, settings); + aruRetryMax = SettingsFile.getValueOrDefault("aruRetryMax", Integer.class, settings, + new Integer(10)); + aruRetryInterval = SettingsFile.getValueOrDefault("aruRetryInterval", Integer.class, settings, + new Integer(10)); // Just the settings about the installer not the individual installers installerSettings.clear(); Map installerFolder = SettingsFile.getFolder("installers", settings); diff --git a/imagetool/src/test/java/com/oracle/weblogic/imagetool/cachestore/CachedFileTest.java b/imagetool/src/test/java/com/oracle/weblogic/imagetool/cachestore/CachedFileTest.java index e425ebde..399c9892 100644 --- a/imagetool/src/test/java/com/oracle/weblogic/imagetool/cachestore/CachedFileTest.java +++ b/imagetool/src/test/java/com/oracle/weblogic/imagetool/cachestore/CachedFileTest.java @@ -138,6 +138,7 @@ void resolveFileFindsFile() throws IOException { CachedFile wlsInstallerFile = new CachedFile(InstallerType.WLS, VER_12213); InstallerMetaData metaData = ConfigManager.getInstance().getInstallerForPlatform(InstallerType.WLS, Architecture.GENERIC, VER_12213); + assertNotNull(metaData); String expected = metaData.getLocation(); assertEquals(expected, wlsInstallerFile.resolve(), "CachedFile did not resolve file"); } @@ -154,6 +155,7 @@ void resolveNoArchFile() throws IOException { assertNull(metaData); metaData = ConfigManager.getInstance().getInstallerForPlatform(InstallerType.WLS, Architecture.GENERIC, VER_12213); + assertNotNull(metaData); String expected = metaData.getLocation(); assertEquals(expected, wlsNoArch.resolve(), "CachedFile returned wrong file"); } @@ -164,7 +166,7 @@ void resolveWithArchitecture() throws IOException { CachedFile wlsArch = new CachedFile(InstallerType.WLS, "14.1.1.0.0", Architecture.fromString("amd64")); InstallerMetaData metaData = ConfigManager.getInstance().getInstallerForPlatform(InstallerType.WLS, Architecture.AMD64, "14.1.1.0.0"); - + assertNotNull(metaData); // verify the cache is setup as expected. wls_14.1.1.0.0_amd64 is in the cache String expected = metaData.getLocation(); assertNotNull(expected); @@ -183,6 +185,7 @@ void resolveFallbackToLocalArch() throws IOException { assertNull(metaData); metaData = ConfigManager.getInstance().getInstallerForPlatform(InstallerType.WLS, Architecture.getLocalArchitecture(), "12.2.1.4.0"); + assertNotNull(metaData); String expected = metaData.getLocation(); //cacheStore.getValueFromCache("wls_12.2.1.4.0_" + Architecture.getLocalArchitecture()); assertNotNull(expected); diff --git a/imagetool/src/test/java/com/oracle/weblogic/imagetool/settings/UserSettingsTest.java b/imagetool/src/test/java/com/oracle/weblogic/imagetool/settings/UserSettingsTest.java index f97c5a65..86b8e30a 100644 --- a/imagetool/src/test/java/com/oracle/weblogic/imagetool/settings/UserSettingsTest.java +++ b/imagetool/src/test/java/com/oracle/weblogic/imagetool/settings/UserSettingsTest.java @@ -36,7 +36,7 @@ void testSimpleSettingsFile() { assertEquals("./builds", settings.getBuildContextDirectory()); assertNull(settings.getBuildEngine()); assertNull(settings.getContainerEngine()); - assertNull(settings.getAruRetryMax()); + assertEquals(10,settings.getAruRetryMax()); assertEquals(200, settings.getAruRetryInterval()); // value not set, should return default value assertNull(settings.getInstallerDirectory()); From 24213d1e9583e5f2370146da155a558c419d81c3 Mon Sep 17 00:00:00 2001 From: jshum Date: Thu, 10 Jul 2025 16:41:42 -0500 Subject: [PATCH 095/104] refactor listing option --- .../imagetool/cli/cache/ListInstallers.java | 26 +++++--- .../imagetool/cli/cache/ListPatches.java | 61 +++++++++++-------- .../src/main/resources/ImageTool.properties | 8 ++- 3 files changed, 58 insertions(+), 37 deletions(-) diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/ListInstallers.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/ListInstallers.java index d9590d12..5db55174 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/ListInstallers.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/ListInstallers.java @@ -33,7 +33,8 @@ public CommandResponse call() { if (type != null && type != InstallerType.fromString(itemType)) { continue; } - System.out.println(itemType + ":"); + printLine(itemType + ":"); + data.get(itemType).forEach((installer, metaData) -> { if (commonName != null && !commonName.equalsIgnoreCase(installer)) { return; @@ -42,7 +43,7 @@ public CommandResponse call() { if (version != null && !version.equalsIgnoreCase(installer)) { return; } - System.out.println(" " + installer + ":"); + printLine(" " + installer + ":"); List sortedList = metaData.stream() .sorted(Comparator.comparing(InstallerMetaData::getArchitecture)) @@ -50,6 +51,7 @@ public CommandResponse call() { printDetails(sortedList, InstallerType.fromString(itemType)); }); + } return CommandResponse.success(null); @@ -60,28 +62,32 @@ private void printDetails(List sortedList, InstallerType type for (InstallerMetaData meta : sortedList) { if (!currentArch.equals(meta.getArchitecture())) { currentArch = meta.getArchitecture(); - System.out.println(" " + meta.getArchitecture() + ":"); + printLine(" " + meta.getArchitecture() + ":"); } - System.out.println(" version: " + meta.getProductVersion()); - System.out.println(" location: " + meta.getLocation()); + printLine(" version: " + meta.getProductVersion()); + printLine(" location: " + meta.getLocation()); if (details) { - System.out.println(" digest: " + meta.getDigest()); - System.out.println(" dateAdded: " + meta.getDateAdded()); + printLine(" digest: " + meta.getDigest()); + printLine(" dateAdded: " + meta.getDateAdded()); if (!Utils.isBaseInstallerType(type)) { - System.out.println(" baseFMWVersion: " + meta.getBaseFMWVersion()); + printLine(" baseFMWVersion: " + meta.getBaseFMWVersion()); } } } } + private void printLine(String line) { + System.out.println(line); + } + private void verifyInput() { if (commonName != null && !commonName.isEmpty() && type == null) { - System.out.println("--type cannot be null when commonName is specified"); + printLine(Utils.getMessage("IMG-0156")); System.exit(2); } if (version != null && !version.isEmpty() && type == null) { - System.out.println("--type cannot be null when version is specified"); + printLine(Utils.getMessage("IMG-0157")); System.exit(2); } } diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/ListPatches.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/ListPatches.java index 131c5ee4..b7bd1540 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/ListPatches.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/ListPatches.java @@ -10,6 +10,7 @@ import com.oracle.weblogic.imagetool.api.model.CommandResponse; import com.oracle.weblogic.imagetool.patch.PatchMetaData; import com.oracle.weblogic.imagetool.settings.ConfigManager; +import com.oracle.weblogic.imagetool.util.Utils; import picocli.CommandLine.Command; import picocli.CommandLine.Option; @@ -27,42 +28,50 @@ public CommandResponse call() { Map> data = configManager.getAllPatches(); verifyInput(); - for (String bug : data.keySet()) { - if (patchId != null && !patchId.equalsIgnoreCase(bug)) { - continue; - } - System.out.println(bug + ":"); - - Map> groupByArchitecture = data.get(bug).stream() - .collect(Collectors.groupingBy(PatchMetaData::getArchitecture)); - - groupByArchitecture.forEach((architecture, metaDatas) -> { - System.out.println(" " + architecture + ":"); - - metaDatas.forEach(metaData -> { - if (version != null && !metaData.getPatchVersion().equalsIgnoreCase(version)) { - return; - } - System.out.println(" - version: " + metaData.getPatchVersion()); - System.out.println(" location: " + metaData.getLocation()); - if (details) { - System.out.println(" digest: " + metaData.getDigest()); - System.out.println(" description: " + metaData.getDescription()); - System.out.println(" dateAdded: " + metaData.getDateAdded()); - } + if (!data.isEmpty() && !data.containsKey(patchId)) { + printLine(Utils.getMessage("IMG-0160", patchId)); + } else { + for (String bug : data.keySet()) { + if (patchId != null && !patchId.equalsIgnoreCase(bug)) { + continue; + } + System.out.println(bug + ":"); + + Map> groupByArchitecture = data.get(bug).stream() + .collect(Collectors.groupingBy(PatchMetaData::getArchitecture)); + + groupByArchitecture.forEach((architecture, metaDatas) -> { + printLine(" " + architecture + ":"); + + metaDatas.forEach(metaData -> { + if (version != null && !metaData.getPatchVersion().equalsIgnoreCase(version)) { + return; + } + printLine(" - version: " + metaData.getPatchVersion()); + printLine(" location: " + metaData.getLocation()); + if (details) { + printLine(" digest: " + metaData.getDigest()); + printLine(" description: " + metaData.getDescription()); + printLine(" dateAdded: " + metaData.getDateAdded()); + } + + }); }); - - }); + } } return CommandResponse.success(null); } + private void printLine(String line) { + System.out.println(line); + } + private void verifyInput() { if (version != null && !version.isEmpty() && patchId == null) { - System.out.println("--patchId cannot be null when version is specified"); + printLine(Utils.getMessage("IMG-0158")); System.exit(2); } } diff --git a/imagetool/src/main/resources/ImageTool.properties b/imagetool/src/main/resources/ImageTool.properties index bf67a661..c513f457 100644 --- a/imagetool/src/main/resources/ImageTool.properties +++ b/imagetool/src/main/resources/ImageTool.properties @@ -152,4 +152,10 @@ IMG-0149=Base FMW installer version {0} does not exists in the cache for adding IMG-0150=Verifying installer type {0}, version {1}, architecture {2} exists. IMG-0151=Locating installer type {0}, version {1}, architecture {2}. IMG-0152=Cannot find installer type {0}, version {1}, architecture {2} in the cache, trying Generic architecture. -IMG-0153=Preparing Middleware Installer {0}, version {1}, architecture {2}. \ No newline at end of file +IMG-0153=Preparing Middleware Installer {0}, version {1}, architecture {2}. +IMG-0154=No installer found with commonName: {0}. +IMG-0155=No installer found for version: {0}. +IMG-0156=--type cannot be null when commonName is specified. +IMG-0157=--type cannot be null when version is specified. +IMG-0158=--patchId cannot be null when version is specified. +IMG-0160=patchId not found {0}. \ No newline at end of file From c2e70c66061e517cf108755c855fe8079d56b0ac Mon Sep 17 00:00:00 2001 From: jshum Date: Fri, 11 Jul 2025 12:02:10 -0500 Subject: [PATCH 096/104] add unit test --- .../imagetool/cli/config/SetCommand.java | 32 +++++++-- .../imagetool/cli/config/ShowCommand.java | 17 ++++- .../imagetool/settings/ConfigManager.java | 16 +++++ .../imagetool/settings/UserSettingsFile.java | 7 +- .../weblogic/imagetool/util/HttpUtil.java | 5 +- .../src/main/resources/ImageTool.properties | 3 +- .../imagetool/settings/ConfigManagerTest.java | 67 +++++++++++++++++++ .../resources/settings/basic_settings.yaml | 3 +- .../test/resources/settings/installers.yaml | 31 +++++++++ .../src/test/resources/settings/patches.yaml | 10 +++ 10 files changed, 177 insertions(+), 14 deletions(-) create mode 100644 imagetool/src/test/java/com/oracle/weblogic/imagetool/settings/ConfigManagerTest.java create mode 100644 imagetool/src/test/resources/settings/installers.yaml create mode 100644 imagetool/src/test/resources/settings/patches.yaml diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/config/SetCommand.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/config/SetCommand.java index 7ba3a23e..d73740f2 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/config/SetCommand.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/config/SetCommand.java @@ -1,4 +1,4 @@ -// Copyright (c) 2023, Oracle and/or its affiliates. +// Copyright (c) 2025, 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.cli.config; @@ -37,11 +37,33 @@ public class SetCommand implements Callable { public CommandResponse call() throws Exception { UserSettingsFile settings = new UserSettingsFile(); logger.entering(); - - name.set(settings, value); - settings.save(); + int status = 0; + String message = "done"; + if (verifyInput(name.toString(), value)) { + name.set(settings, value); + settings.save(); + } else { + status = -1; + message = "Failed to set configuration entry"; + } logger.exiting(); - return new CommandResponse(0, "done"); + return new CommandResponse(status, message); + } + + private boolean verifyInput(String name, String value) { + if ("aruRetryInterval".equalsIgnoreCase(name) || "aruRetryMax".equalsIgnoreCase(name)) { + try { + int n = Integer.parseInt(value); + if (n < 0) { + logger.severe("IMG-0161", name, value); + return false; + } + } catch (NumberFormatException e) { + logger.severe("IMG-0161", name, value); + return false; + } + } + return true; } } diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/config/ShowCommand.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/config/ShowCommand.java index 2750337b..ae37cfc8 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/config/ShowCommand.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/config/ShowCommand.java @@ -1,13 +1,15 @@ -// Copyright (c) 2023, Oracle and/or its affiliates. +// Copyright (c) 2025, 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.cli.config; +import java.util.Map; import java.util.concurrent.Callable; import com.oracle.weblogic.imagetool.api.model.CommandResponse; import com.oracle.weblogic.imagetool.logging.LoggingFacade; import com.oracle.weblogic.imagetool.logging.LoggingFactory; +import com.oracle.weblogic.imagetool.settings.InstallerSettings; import com.oracle.weblogic.imagetool.settings.UserSettingsFile; import picocli.CommandLine; @@ -61,6 +63,10 @@ private static void printSettingValue(String setting, Object value) { } } + private static void printLine(String line) { + System.out.println(line); + } + private static void printAllSettings(UserSettingsFile settings) { printSettingValue("aruRetryInterval", settings.getAruRetryInterval()); printSettingValue("aruRetryMax", settings.getAruRetryMax()); @@ -69,5 +75,14 @@ private static void printAllSettings(UserSettingsFile settings) { printSettingValue("containerEngine", settings.getContainerEngine()); printSettingValue("installerDirectory", settings.getInstallerDirectory()); printSettingValue("patchDirectory", settings.getPatchDirectory()); + Map installerSettings = settings.getInstallerSettings(); + if (installerSettings != null && !installerSettings.isEmpty()) { + printLine("Defaults: "); + for (Map.Entry entry: installerSettings.entrySet()) { + String key = entry.getKey(); + InstallerSettings value = entry.getValue(); + printSettingValue(" " + key, value.getDefaultVersion()); + } + } } } diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/ConfigManager.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/ConfigManager.java index f5630b7a..36ff17bd 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/ConfigManager.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/ConfigManager.java @@ -114,6 +114,22 @@ public String getInstallerDetailsFile() { return userSettingsFile.returnInstallerSettingsFile(); } + /** + * Return the ARU retry interval. + * @return retry interval + */ + public int getAruRetryInterval() { + return userSettingsFile.getAruRetryInterval(); + } + + /** + * Return the ARU retry max. + * @return retry max + */ + public int getAruRetryMax() { + return userSettingsFile.getAruRetryMax(); + } + /** * Return the installer setting file. * @return SettingsFile diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/UserSettingsFile.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/UserSettingsFile.java index 446c81c0..fc9789db 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/UserSettingsFile.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/UserSettingsFile.java @@ -1,4 +1,4 @@ -// Copyright (c) 2022, Oracle and/or its affiliates. +// Copyright (c) 2025, 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.settings; @@ -78,10 +78,10 @@ public UserSettingsFile() { * @param pathToSettingsFile A map of key-value pairs read in from the YAML user settings file. */ public UserSettingsFile(Path pathToSettingsFile) { - installerSettings = new HashMap<>(); settingsFile = new SettingsFile(pathToSettingsFile); installerSettingsFile = pathToSettingsFile.getParent().resolve("installers.yaml").toString(); patchSettingsFile = pathToSettingsFile.getParent().resolve("patches.yaml").toString(); + installerSettings = new HashMap<>(); applySettings(settingsFile.load()); } @@ -294,8 +294,7 @@ private void applySettings(Map settings) { aruRetryInterval = SettingsFile.getValueOrDefault("aruRetryInterval", Integer.class, settings, new Integer(10)); // Just the settings about the installer not the individual installers - installerSettings.clear(); - Map installerFolder = SettingsFile.getFolder("installers", settings); + Map installerFolder = SettingsFile.getFolder("installerSettings", settings); for (Map.Entry entry: installerFolder.entrySet()) { String key = entry.getKey(); if (key != null && !key.isEmpty()) { diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/util/HttpUtil.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/util/HttpUtil.java index 97b7ea6d..bf3c085d 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/util/HttpUtil.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/util/HttpUtil.java @@ -16,6 +16,7 @@ import com.oracle.weblogic.imagetool.logging.LoggingFacade; import com.oracle.weblogic.imagetool.logging.LoggingFactory; +import com.oracle.weblogic.imagetool.settings.ConfigManager; import org.apache.http.HttpEntity; import org.apache.http.HttpEntityEnclosingRequest; import org.apache.http.HttpHost; @@ -179,7 +180,7 @@ public static Executor getHttpExecutor(String supportUserName, String supportPas private static HttpRequestRetryHandler retryHandler() { return (exception, executionCount, context) -> { - if (executionCount > 10) { + if (executionCount > ConfigManager.getInstance().getAruRetryMax()) { // Do not retry if over max retries return false; } @@ -195,7 +196,7 @@ private static HttpRequestRetryHandler retryHandler() { boolean retriable = !(request instanceof HttpEntityEnclosingRequest); if (retriable) { try { - long waitTime = executionCount < 5 ? 2 : 10; + long waitTime = executionCount < 5 ? 2 : ConfigManager.getInstance().getAruRetryInterval(); logger.warning("Connect failed, retrying in {0} seconds, attempts={1} ", waitTime, executionCount); Thread.sleep(waitTime * 1000); } catch (InterruptedException e) { diff --git a/imagetool/src/main/resources/ImageTool.properties b/imagetool/src/main/resources/ImageTool.properties index c513f457..24c5f10c 100644 --- a/imagetool/src/main/resources/ImageTool.properties +++ b/imagetool/src/main/resources/ImageTool.properties @@ -158,4 +158,5 @@ IMG-0155=No installer found for version: {0}. IMG-0156=--type cannot be null when commonName is specified. IMG-0157=--type cannot be null when version is specified. IMG-0158=--patchId cannot be null when version is specified. -IMG-0160=patchId not found {0}. \ No newline at end of file +IMG-0160=patchId not found {0}. +IMG-0161=Attribute {0} value {1} must be an integer greater than 1. \ No newline at end of file diff --git a/imagetool/src/test/java/com/oracle/weblogic/imagetool/settings/ConfigManagerTest.java b/imagetool/src/test/java/com/oracle/weblogic/imagetool/settings/ConfigManagerTest.java new file mode 100644 index 00000000..f201e38f --- /dev/null +++ b/imagetool/src/test/java/com/oracle/weblogic/imagetool/settings/ConfigManagerTest.java @@ -0,0 +1,67 @@ +// Copyright (c) 2023, 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.settings; + +import java.nio.file.Path; +import java.nio.file.Paths; +import java.util.List; +import java.util.Map; + +import com.oracle.weblogic.imagetool.installer.InstallerMetaData; +import com.oracle.weblogic.imagetool.installer.InstallerType; +import com.oracle.weblogic.imagetool.patch.PatchMetaData; +import com.oracle.weblogic.imagetool.util.Architecture; +import org.junit.jupiter.api.Test; + +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertNotNull; +import static org.junit.jupiter.api.Assertions.assertNull; + +class ConfigManagerTest { + + Path settingsPath = Paths.get("src/test/resources/settings/basic_settings.yaml"); + + @Test + void testBasicInstallerSettings() { + ConfigManager cfgMgr = ConfigManager.getInstance(settingsPath); + assertNotNull(cfgMgr); + assertEquals(200, cfgMgr.getAruRetryInterval()); + assertEquals(10, cfgMgr.getAruRetryMax()); + assertEquals("12.2.1.4.0", cfgMgr.getDefaultWLSVersion()); + } + + @Test + void testGettingInstallers() { + ConfigManager cfgMgr = ConfigManager.getInstance(settingsPath); + assertNotNull(cfgMgr); + Map>> installers = cfgMgr.getInstallers(); + assertNotNull(installers); + assertEquals(4, installers.size()); + InstallerMetaData metaData = cfgMgr.getInstallerForPlatform(InstallerType.JDK, Architecture.AMD64, + "8u241"); + assertNotNull(metaData); + assertEquals("8u241", metaData.getProductVersion()); + metaData = cfgMgr.getInstallerForPlatform(InstallerType.JDK, Architecture.AMD64, + "8u301"); + assertNull(metaData); + } + + @Test + void testGettingPatches() { + ConfigManager cfgMgr = ConfigManager.getInstance(settingsPath); + assertNotNull(cfgMgr); + Map> patches = cfgMgr.getAllPatches(); + assertNotNull(patches); + assertEquals(2, patches.size()); + PatchMetaData metaData = cfgMgr.getPatchForPlatform("Generic", "37258699", + "12.2.1.4.241107"); + assertNull(metaData); + metaData = cfgMgr.getPatchForPlatform("Generic", "37258699", + "12.2.1.4.0"); + assertNotNull(metaData); + assertEquals("12.2.1.4.0", metaData.getPatchVersion()); + assertEquals("JDBC19.25 BUNDLE PATCH 12.2.1.4.241107", metaData.getDescription()); + } + +} diff --git a/imagetool/src/test/resources/settings/basic_settings.yaml b/imagetool/src/test/resources/settings/basic_settings.yaml index 5e829275..f717c8a0 100644 --- a/imagetool/src/test/resources/settings/basic_settings.yaml +++ b/imagetool/src/test/resources/settings/basic_settings.yaml @@ -1,7 +1,8 @@ aruRetryInterval: 200 +aruRetryMax: 10 buildContextDirectory: ./builds patchDirectory: /home/user/patches -installers: +installerSettings: JDK: defaultVersion: 8u241 WLS: diff --git a/imagetool/src/test/resources/settings/installers.yaml b/imagetool/src/test/resources/settings/installers.yaml new file mode 100644 index 00000000..59b7f01e --- /dev/null +++ b/imagetool/src/test/resources/settings/installers.yaml @@ -0,0 +1,31 @@ +JDK: + 17u11: + - {architecture: linux/arm64, dateAdded: '2025-03-20', digest: 7F1E921F932BD7E372CBBD277807BBBA774022558F2AA979FAFCDCED5D24619F, + location: /home/acme/Downloads/jdk-17_linux-aarch64_11bin.tar.gz, productVersion: 17u11} + 8u401: + - {architecture: linux/amd64, dateAdded: '2025-05-01', digest: 19684FCCD7FF32A8400E952A643F0049449A772EF63B8037D5B917CBD137D173, + location: /home/acme/Downloads/jdk-8u401-linux-x64.tar.gz, productVersion: 8u401} + - {architecture: linux/arm64, dateAdded: '2025-05-02', digest: 811AF9AA1CE2EAA902C7923EA1A5B7012BDDB787DF0805ADED5F3663B210AA47, + location: /home/acme/Downloads/jdk-8u401-fcs-bin-b10-linux-aarch64-19_dec_2023.tar.gz, + productVersion: 8u401} + 8u241: + - {architecture: linux/amd64, dateAdded: '2025-05-01', digest: 19784FCCD7FF32A8400E952A643F0049449A772EF63B8037D5B917CBD137D173, + location: /home/acme/Downloads/jdk-8u241-linux-x64.tar.gz, productVersion: 8u241} +FMW: + 14.1.2.0.0: + - {architecture: Generic, dateAdded: '2025-03-20', digest: 8D3125A358F5429B7EABE7AB28739A6053C4439DFD54EC351586875A4DE68BB0, + location: /home/acme/Downloads/V1045350-01.zip, productVersion: 14.1.2.0.0} +WDT: + latest: + - {architecture: Generic, dateAdded: '2025-04-18', digest: 88DA46CE489A5FB506F9DE45D8E9D242810FE3ED270AFB11EE67760729F7BBEE, + location: /home/acme/dev/oracle/weblogic-deploy-tooling/installer/target/weblogic-deploy.zip, + productVersion: latest} +WLS: + 12.2.1.4.0: + - {architecture: linux/arm64, dateAdded: '2025-03-20', digest: 2630E4E3D6C8998DA8AA97FF6FF4A4A44F95A568DE8CF9DE01DCD47B753FF324, + location: /home/acme/Downloads/fmw_12.2.1.4.0_wls_generic_ARM_OCI.zip, productVersion: 12.2.1.4.0} + - {architecture: linux/amd64, dateAdded: '2025-05-01', digest: 4B3A2264875CE4D56CF6C4C70FC2E5895DB1F5CBC39EB5D4E28E46BFA65D2671, + location: /home/acme/Downloads/fmw_12.2.1.4.0_wls_lite_Disk1_1of1.zip, productVersion: 12.2.1.4.0} + 14.1.2.0.0: + - {architecture: linux/arm64, dateAdded: '2025-04-24', digest: E0323E52FF26787E8397F813ABD44E1EB73814E9174146E852889127DB04F655, + location: /home/acme/Downloads/fmw_14.1.2.0.0_wls_generic._Disk1_1of1.zip, productVersion: 14.1.2.0.0} diff --git a/imagetool/src/test/resources/settings/patches.yaml b/imagetool/src/test/resources/settings/patches.yaml new file mode 100644 index 00000000..c4f31679 --- /dev/null +++ b/imagetool/src/test/resources/settings/patches.yaml @@ -0,0 +1,10 @@ +'37297691': + - {architecture: linux/arm64, dateAdded: '2024-12-23', description: OSS 19C BUNDLE + PATCH 12.2.1.4.241119, digest: 2F81E3FAF5832234B57BA845F2E869585E35B742996BA90F377AFB1D888C9D0E, + location: /home/acme/.imagetool/downloaded_patches/p37297691_122140_Linux-ARM-64.zip, + patchVersion: 12.2.1.4.0} +'37258699': + - {architecture: Generic, dateAdded: '2024-11-18', description: JDBC19.25 BUNDLE PATCH + 12.2.1.4.241107, digest: 5B40AEB1D642CB560AE9FB335802A4D9382B78D1875AD2A5FB19D4C1E0FA148E, + location: /home/acme/.imagetool/downloaded_patches/p37258699_122140_Generic.zip, + patchVersion: 12.2.1.4.0} From 430861a8e92b60e5171d8423417003e48103ab53 Mon Sep 17 00:00:00 2001 From: jshum Date: Mon, 14 Jul 2025 10:29:31 -0500 Subject: [PATCH 097/104] fix integration tests --- .../oracle/weblogic/imagetool/cli/cache/ListPatches.java | 2 +- imagetool/src/main/resources/ImageTool.properties | 2 +- .../com/oracle/weblogic/imagetool/tests/ITImagetool.java | 6 +++--- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/ListPatches.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/ListPatches.java index b7bd1540..d77381a6 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/ListPatches.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/ListPatches.java @@ -28,7 +28,7 @@ public CommandResponse call() { Map> data = configManager.getAllPatches(); verifyInput(); - if (!data.isEmpty() && !data.containsKey(patchId)) { + if (!data.isEmpty() && patchId != null && !data.containsKey(patchId)) { printLine(Utils.getMessage("IMG-0160", patchId)); } else { for (String bug : data.keySet()) { diff --git a/imagetool/src/main/resources/ImageTool.properties b/imagetool/src/main/resources/ImageTool.properties index 24c5f10c..bdebd52e 100644 --- a/imagetool/src/main/resources/ImageTool.properties +++ b/imagetool/src/main/resources/ImageTool.properties @@ -124,7 +124,7 @@ IMG-0122=Invalid patch {0} for version {1}. A patch cannot be both generic and a IMG-0123=Cannot find the patch {0} for platform {1}, no patch for this platform will be applied. IMG-0124=You must specify --type --version and --architecture for deleting an installer. IMG-0125=Specified installer to delete cannot be found. -IMG-0126=You must specify --patchId --version and --architecture for deleting a patchr. +IMG-0126=You must specify --patchId --version and --architecture for deleting a patch. IMG-0127=Specified installer to delete cannot be found. IMG-0128=Cannot parse image tool version 1 metadata file line: {0}, skipping. IMG-0129=Cannot parse image tool version 1 metadata file line: unrecognized product {0} in line {1}. diff --git a/tests/src/test/java/com/oracle/weblogic/imagetool/tests/ITImagetool.java b/tests/src/test/java/com/oracle/weblogic/imagetool/tests/ITImagetool.java index c42b7cd2..79a16316 100644 --- a/tests/src/test/java/com/oracle/weblogic/imagetool/tests/ITImagetool.java +++ b/tests/src/test/java/com/oracle/weblogic/imagetool/tests/ITImagetool.java @@ -538,9 +538,9 @@ void deletePatchTest(TestInfo testInfo) throws Exception { // the process return code for listItems should be 0 assertEquals(0, listResult.exitValue(), "for command: " + listCommand); // output should show newly added patch - assertFalse(listResult.stdout().contains(testPatchID)); - assertFalse(listResult.stdout().contains(WLS_VERSION)); - assertFalse(listResult.stdout().contains(patchPath.toString())); + String errorMessage = Utils.getMessage("IMG-0160", testPatchID); + System.out.println(errorMessage); + assertTrue(listResult.stdout().contains(errorMessage)); } } From 9fb7cbdd60a57d4019f7320701f3d40c22f0825f Mon Sep 17 00:00:00 2001 From: jshum Date: Tue, 15 Jul 2025 14:58:35 -0500 Subject: [PATCH 098/104] Fix create image use of commonName --- .../imagetool/api/model/CachedFile.java | 32 +++++++++++++-- .../weblogic/imagetool/aru/AruUtil.java | 13 +++--- .../imagetool/cachestore/CacheStore.java | 16 ++++++-- .../imagetool/cli/cache/DeleteInstaller.java | 12 +++--- .../cli/menu/CommonCreateOptions.java | 13 +++++- .../cli/menu/CommonPatchingOptions.java | 13 +++++- .../installer/MiddlewareInstall.java | 6 +-- .../imagetool/settings/ConfigManager.java | 14 ++++++- .../src/main/resources/ImageTool.properties | 2 +- .../weblogic/imagetool/aru/AruUtilTest.java | 3 +- .../cli/menu/CommonPatchingOptionsTest.java | 4 +- .../installer/MiddlewareInstallTest.java | 4 +- .../imagetool/util/DockerfileBuilderTest.java | 2 +- .../weblogic/imagetool/tests/ITImagetool.java | 40 +++++++++---------- 14 files changed, 122 insertions(+), 52 deletions(-) diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/api/model/CachedFile.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/api/model/CachedFile.java index 6277e9c4..4e69de3e 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/api/model/CachedFile.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/api/model/CachedFile.java @@ -27,6 +27,7 @@ public class CachedFile { private static final LoggingFacade logger = LoggingFactory.getLogger(CachedFile.class); private final String version; + private String commonName = null; private final Architecture architecture; private final InstallerType installerType; @@ -38,9 +39,25 @@ public class CachedFile { * @param architecture the system architecture that this file/installer is applicable */ public CachedFile(InstallerType id, String version, Architecture architecture) { + this(id, version, architecture, version); + } + + /** + * Represents a locally cached file. + * + * @param id cache ID (like installer type) + * @param version version number for the patch or installer. + * @param architecture the system architecture that this file/installer is applicable + * @param commonName common name of the installer + */ + public CachedFile(InstallerType id, String version, Architecture architecture, String commonName) { + if (commonName == null) { + commonName = version; + } this.installerType = id; this.version = version; this.architecture = architecture; + this.commonName = commonName; } /** @@ -86,6 +103,14 @@ public Architecture getArchitecture() { return architecture; } + /** + * Get the common name of the installer. + * @return common name + */ + public String getCommonName() { + return commonName; + } + /** * Get the path of the file stored locally in the cache. * Searching the cache starts with the specified key. If the key is not found in the cache, @@ -103,14 +128,15 @@ public String resolve() throws IOException { String filePath = null; InstallerMetaData metaData = ConfigManager.getInstance() - .getInstallerForPlatform(installerType, getArchitecture(), getVersion()); + .getInstallerForPlatform(installerType, getArchitecture(), getVersion(), getCommonName()); if (metaData == null) { metaData = ConfigManager.getInstance() - .getInstallerForPlatform(installerType, Architecture.getLocalArchitecture(), getVersion()); + .getInstallerForPlatform(installerType, Architecture.getLocalArchitecture(), getVersion(), + getCommonName()); if (metaData == null) { metaData = ConfigManager.getInstance() - .getInstallerForPlatform(installerType, Architecture.GENERIC, getVersion()); + .getInstallerForPlatform(installerType, Architecture.GENERIC, getVersion(), getCommonName()); } } diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/aru/AruUtil.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/aru/AruUtil.java index 49370919..88a73cc3 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/aru/AruUtil.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/aru/AruUtil.java @@ -108,7 +108,7 @@ protected AruUtil() { * @throws AruException when an error occurs trying to access ARU metadata */ public List getLatestPsu(FmwInstallerType type, String version, Architecture architecture, - String userId, String password) + String commonName, String userId, String password) throws AruException { List result = new ArrayList<>(); for (AruProduct product : type.products()) { @@ -117,7 +117,7 @@ public List getLatestPsu(FmwInstallerType type, String version, Archit if (type == FmwInstallerType.IDM && product == AruProduct.JRF) { InstallerMetaData metaData = ConfigManager.getInstance().getInstallerForPlatform(InstallerType.IDM, - architecture, version); + architecture, version, commonName); if (metaData != null && metaData.getBaseFMWVersion() != null) { baseVersion = metaData.getBaseFMWVersion(); } @@ -188,7 +188,7 @@ List getLatestPsu(AruProduct product, String version, Architecture arc * @return Document listing of all patches (full details) */ public List getRecommendedPatches(FmwInstallerType type, String version, Architecture architecture, - String userId, String password) throws AruException { + String commonName, String userId, String password) throws AruException { List result = new ArrayList<>(); for (AruProduct product : type.products()) { @@ -196,8 +196,9 @@ public List getRecommendedPatches(FmwInstallerType type, String versio String baseVersion = version; if (type == FmwInstallerType.IDM && product == AruProduct.JRF) { + InstallerMetaData metaData = ConfigManager.getInstance().getInstallerForPlatform(InstallerType.IDM, - architecture, version); + architecture, version, commonName); if (metaData != null && metaData.getBaseFMWVersion() != null) { baseVersion = metaData.getBaseFMWVersion(); } @@ -227,7 +228,7 @@ public List getRecommendedPatches(FmwInstallerType type, String versio * @throws AruException when response from ARU has an error or fails */ List getRecommendedPatches(FmwInstallerType type, AruProduct product, String version, - Architecture architecture, String userId, String password) throws AruException { + Architecture architecture, String userId, String password) throws AruException { logger.entering(product, version); List patches = Collections.emptyList(); try { @@ -290,7 +291,7 @@ private String getPsuVersion(String productName, Collection patches) { } List getReleaseRecommendations(AruProduct product, String releaseNumber, Architecture architecture, - String userId, String password) + String userId, String password) throws AruException, XPathExpressionException, RetryFailedException { Document patchesDocument = retry( diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cachestore/CacheStore.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cachestore/CacheStore.java index 1114f7de..a0766b2d 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cachestore/CacheStore.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cachestore/CacheStore.java @@ -173,7 +173,7 @@ private boolean baseFMWVersionExists(InstallerType type, Map> installers = getInstallers().get(installerKey); if (installers != null && !installers.isEmpty()) { - return getInstallerMetaData(installerVersion, installerType, platformName, installers); + return getInstallerMetaData(installerVersion, installerType, platformName, installers, commonName); } return null; @@ -425,15 +425,21 @@ private String verifyInstallerVersion(String installerVersion, InstallerType ins private InstallerMetaData getInstallerMetaData(String installerVersion, InstallerType installerType, - Architecture platformName, Map> installers) { + Architecture platformName, Map> installers, String commonName) { + String search = installerVersion; - List installerMetaDataList = installers.get(installerVersion); + if (commonName != null) { + search = commonName; + } + List installerMetaDataList = installers.get(search); if (installerMetaDataList != null && !installerMetaDataList.isEmpty()) { logger.info("IMG-0151", installerType, installerVersion, platformName); Optional foundInstaller = installerMetaDataList.stream() .filter(installerMetaData -> platformName.getAcceptableNames() .contains(installerMetaData.getArchitecture())) + .filter(installerMetaData -> + installerMetaData.getProductVersion().equals(installerVersion)) .findFirst(); if (foundInstaller.isPresent()) { @@ -447,6 +453,8 @@ private InstallerMetaData getInstallerMetaData(String installerVersion, Installe foundInstaller = installerMetaDataList.stream() .filter(installerMetaData -> Architecture.GENERIC.getAcceptableNames() .contains(installerMetaData.getArchitecture())) + .filter(installerMetaData -> + installerMetaData.getProductVersion().equals(installerVersion)) .findFirst(); if (foundInstaller.isPresent()) { diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/DeleteInstaller.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/DeleteInstaller.java index bd329af3..49923270 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/DeleteInstaller.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/DeleteInstaller.java @@ -28,7 +28,7 @@ public class DeleteInstaller extends CacheOperation { public CommandResponse call() throws CacheStoreException { ConfigManager configManager = ConfigManager.getInstance(); Map>> data = configManager.getInstallers(); - if (type == null || version == null || architecture == null) { + if (type == null || (version == null && commonName == null) || architecture == null) { return CommandResponse.success("IMG-0124"); } boolean exists = false; @@ -43,6 +43,8 @@ public CommandResponse call() throws CacheStoreException { } else { search = commonName; } + System.out.println("Deleting installer " + itemType + " from " + search); + exists = Optional.ofNullable(items.get(search)) .map(list -> list.stream().anyMatch(i -> Architecture.fromString(i.getArchitecture()) .equals(architecture) && i.getProductVersion().equalsIgnoreCase(version))) @@ -70,25 +72,25 @@ public CommandResponse call() throws CacheStoreException { } @Option( - names = {"--type"}, + names = {"-t", "--type"}, description = "Filter installer type. e.g. wls, jdk, wdt." ) private InstallerType type; @Option( - names = {"--cn"}, + names = {"-cn", "--commonName"}, description = "Filter by common name." ) private String commonName; @Option( - names = {"--version"}, + names = {"-v", "--version"}, description = "Specific version to delete." ) private String version; @Option( - names = {"--architecture"}, + names = {"-a", "--architecture"}, description = "Specific architecture to delete." ) private Architecture architecture; diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonCreateOptions.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonCreateOptions.java index 5165a81f..ab1a74a2 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonCreateOptions.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonCreateOptions.java @@ -81,13 +81,14 @@ void prepareNewImage() throws IOException, InterruptedException, XPathExpression if (dockerfileOptions.installMiddleware()) { MiddlewareInstall install = new MiddlewareInstall(getInstallerType(), installerVersion, installerResponseFiles, buildPlatforms, - buildEngine); + buildEngine, commonName); install.copyFiles(buildDir()); dockerfileOptions.setMiddlewareInstall(install); dockerfileOptions.includeBinaryOsPackages(getInstallerType().equals(FmwInstallerType.OHS)); } else { dockerfileOptions.setWdtBase("os_update"); } + setCommonName(commonName); // resolve required patches handlePatchFiles(); @@ -241,6 +242,10 @@ String getInstallerVersion() { return installerVersion; } + String getCommonName() { + return commonName; + } + @Option( names = {"--version"}, description = "Installer version. Default: ${DEFAULT-VALUE}", @@ -249,6 +254,12 @@ String getInstallerVersion() { ) private String installerVersion; + @Option( + names = {"--commonName"}, + description = "Installer version common name, used with --version" + ) + private String commonName; + @Option( names = {"--jdkVersion"}, description = "Version of server jdk to install. Default: ${DEFAULT-VALUE}", diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonPatchingOptions.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonPatchingOptions.java index 931e0467..48df54ec 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonPatchingOptions.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonPatchingOptions.java @@ -320,7 +320,7 @@ List getRecommendedPatchList() throws AruException { // Get the latest PSU and its recommended patches aruPatches = AruUtil.rest() .getRecommendedPatches(getInstallerType(), getInstallerVersion(), - Architecture.fromString(buildPlatform), + Architecture.fromString(buildPlatform), getCommonName(), userId, password); if (aruPatches.isEmpty()) { @@ -338,7 +338,7 @@ List getRecommendedPatchList() throws AruException { } else if (latestPsu) { // PSUs for WLS and JRF installers are considered WLS patches aruPatches = AruUtil.rest().getLatestPsu(getInstallerType(), getInstallerVersion(), - Architecture.fromString(buildPlatform), + Architecture.fromString(buildPlatform), getCommonName(), userId, password); if (aruPatches.isEmpty()) { @@ -377,6 +377,15 @@ String getPassword() { return password; } + private String commonName; + + void setCommonName(String commonName) { + this.commonName = commonName; + } + + String getCommonName() { + return commonName; + } @Option( names = {"--user"}, diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/installer/MiddlewareInstall.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/installer/MiddlewareInstall.java index 571560e0..1ee6cab7 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/installer/MiddlewareInstall.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/installer/MiddlewareInstall.java @@ -38,7 +38,7 @@ public class MiddlewareInstall { * @param type the requested middleware install type */ public MiddlewareInstall(FmwInstallerType type, String version, List responseFiles, - List buildPlatform, String buildEngine) + List buildPlatform, String buildEngine, String commonName) throws FileNotFoundException { logger.info("IMG-0039", type.installerListString(), version); fmwInstallerType = type; @@ -69,10 +69,10 @@ public MiddlewareInstall(FmwInstallerType type, String version, List respo } pkg.type = installerType; if (AMD64_BLD.equals(platform)) { - pkg.installer = new CachedFile(installerType, version, Architecture.AMD64); + pkg.installer = new CachedFile(installerType, version, Architecture.AMD64, commonName); } if (ARM64_BLD.equals(platform)) { - pkg.installer = new CachedFile(installerType, version, Architecture.ARM64); + pkg.installer = new CachedFile(installerType, version, Architecture.ARM64, commonName); } // get the details from cache of whether there is a base version of WLS required. diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/ConfigManager.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/ConfigManager.java index 36ff17bd..380b6fb2 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/ConfigManager.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/ConfigManager.java @@ -186,7 +186,19 @@ public PatchMetaData getPatchForPlatform(String platformName, String bugNumber, */ public InstallerMetaData getInstallerForPlatform(InstallerType installerType, Architecture platformName, String installerVersion) { - return cacheStore.getInstallerForPlatform(installerType, platformName, installerVersion); + return cacheStore.getInstallerForPlatform(installerType, platformName, installerVersion, installerVersion); + } + + /** + * Return the metadata for the platformed installer. + * @param platformName platform name + * @param installerVersion version of the installer + * @param commonName common name of the installer + * @return InstallerMetaData meta data for the installer + */ + public InstallerMetaData getInstallerForPlatform(InstallerType installerType, Architecture platformName, + String installerVersion, String commonName) { + return cacheStore.getInstallerForPlatform(installerType, platformName, installerVersion, commonName); } /** diff --git a/imagetool/src/main/resources/ImageTool.properties b/imagetool/src/main/resources/ImageTool.properties index bdebd52e..1e84b63a 100644 --- a/imagetool/src/main/resources/ImageTool.properties +++ b/imagetool/src/main/resources/ImageTool.properties @@ -122,7 +122,7 @@ IMG-0120=Retries exhausted, unable to download patch from Oracle. Try again lat IMG-0121=Did not recognize '-platform' name {0}. Defaulted to {1}. IMG-0122=Invalid patch {0} for version {1}. A patch cannot be both generic and architecture specific. Remove the invalid entry from the cache, like {0}_{1}_xxx64. IMG-0123=Cannot find the patch {0} for platform {1}, no patch for this platform will be applied. -IMG-0124=You must specify --type --version and --architecture for deleting an installer. +IMG-0124=You must specify --type (--version or --commonName) and --architecture for deleting an installer. IMG-0125=Specified installer to delete cannot be found. IMG-0126=You must specify --patchId --version and --architecture for deleting a patch. IMG-0127=Specified installer to delete cannot be found. diff --git a/imagetool/src/test/java/com/oracle/weblogic/imagetool/aru/AruUtilTest.java b/imagetool/src/test/java/com/oracle/weblogic/imagetool/aru/AruUtilTest.java index 179d5c15..350b99cd 100644 --- a/imagetool/src/test/java/com/oracle/weblogic/imagetool/aru/AruUtilTest.java +++ b/imagetool/src/test/java/com/oracle/weblogic/imagetool/aru/AruUtilTest.java @@ -86,7 +86,8 @@ void testRecommendedPatches() throws Exception { // if no recommended patches are found, method should return an empty list (test data does not have 12.2.1.4) recommendedPatches = - AruUtil.rest().getRecommendedPatches(FmwInstallerType.WLS, "12.2.1.4.0", Architecture.AMD64, "x", "x"); + AruUtil.rest().getRecommendedPatches(FmwInstallerType.WLS, "12.2.1.4.0", Architecture.AMD64, + "12.2.1.4.0", "x", "x"); assertTrue(recommendedPatches.isEmpty()); } diff --git a/imagetool/src/test/java/com/oracle/weblogic/imagetool/cli/menu/CommonPatchingOptionsTest.java b/imagetool/src/test/java/com/oracle/weblogic/imagetool/cli/menu/CommonPatchingOptionsTest.java index cc210725..00fa36ab 100644 --- a/imagetool/src/test/java/com/oracle/weblogic/imagetool/cli/menu/CommonPatchingOptionsTest.java +++ b/imagetool/src/test/java/com/oracle/weblogic/imagetool/cli/menu/CommonPatchingOptionsTest.java @@ -48,7 +48,7 @@ public boolean checkCredentials(String username, String password) { @Override public List getRecommendedPatches(FmwInstallerType type, String version, Architecture architecture, - String userId, String password) { + String commonName, String userId, String password) { if (type.equals(FmwInstallerType.WLS)) { List list = new ArrayList<>(); list.add(new AruPatch().patchId("1").product("15991").description("psu") @@ -63,7 +63,7 @@ public List getRecommendedPatches(FmwInstallerType type, String versio @Override public List getLatestPsu(FmwInstallerType type, String version, Architecture architecture, - String userId, String password) { + String commonName, String userId, String password) { if (type.equals(FmwInstallerType.WLS)) { List list = new ArrayList<>(); list.add(new AruPatch().patchId("1").description("psu").psuBundle("x")); diff --git a/imagetool/src/test/java/com/oracle/weblogic/imagetool/installer/MiddlewareInstallTest.java b/imagetool/src/test/java/com/oracle/weblogic/imagetool/installer/MiddlewareInstallTest.java index 9ab653b1..5c3c43e9 100644 --- a/imagetool/src/test/java/com/oracle/weblogic/imagetool/installer/MiddlewareInstallTest.java +++ b/imagetool/src/test/java/com/oracle/weblogic/imagetool/installer/MiddlewareInstallTest.java @@ -59,7 +59,7 @@ static void setup(@TempDir Path cacheDir) throws IOException { void copyInstaller(@TempDir Path buildContextDir) throws IOException { // Test a simple WLS install type, and copy the files to the build context folder MiddlewareInstall install = new MiddlewareInstall(FmwInstallerType.WLS, "12.2.1.4.0", - null, null, "docker"); + null, null, "docker", null); install.copyFiles(buildContextDir.toString()); // 2 files should be copied from cache to build context folder assertTrue(Files.isRegularFile(buildContextDir.resolve("test-installer.zip"))); @@ -81,7 +81,7 @@ void customResponseFile(@TempDir Path buildContextDir) throws IOException { Collections.singletonList(ResourceUtils.resourcePath("/dummyInstallers/dummyResponse.txt")); // Test a simple WLS install type, and copy the files to the build context folder MiddlewareInstall install = new MiddlewareInstall(FmwInstallerType.WLS, "12.2.1.4.0", customResponse, - null, "docker"); + null, "docker", null); install.copyFiles(buildContextDir.toString()); // 2 files should be copied from cache to build context folder assertTrue(Files.isRegularFile(buildContextDir.resolve("test-installer.zip"))); diff --git a/imagetool/src/test/java/com/oracle/weblogic/imagetool/util/DockerfileBuilderTest.java b/imagetool/src/test/java/com/oracle/weblogic/imagetool/util/DockerfileBuilderTest.java index aee53590..e15d1a9e 100644 --- a/imagetool/src/test/java/com/oracle/weblogic/imagetool/util/DockerfileBuilderTest.java +++ b/imagetool/src/test/java/com/oracle/weblogic/imagetool/util/DockerfileBuilderTest.java @@ -67,7 +67,7 @@ static void setup(@TempDir Path cacheDir) throws IOException { @Test void validateMustacheAliases() throws IOException { MiddlewareInstall install = new MiddlewareInstall(FmwInstallerType.WLS, "12.2.1.4.0", - null, null, "docker"); + null, null, "docker", null); DockerfileOptions dockerfileOptions = new DockerfileOptions("123") .setPatchingEnabled() diff --git a/tests/src/test/java/com/oracle/weblogic/imagetool/tests/ITImagetool.java b/tests/src/test/java/com/oracle/weblogic/imagetool/tests/ITImagetool.java index 79a16316..fe9bd6f1 100644 --- a/tests/src/test/java/com/oracle/weblogic/imagetool/tests/ITImagetool.java +++ b/tests/src/test/java/com/oracle/weblogic/imagetool/tests/ITImagetool.java @@ -18,6 +18,7 @@ import java.util.List; import com.oracle.weblogic.imagetool.cli.menu.KubernetesTarget; +import com.oracle.weblogic.imagetool.installer.InstallerType; import com.oracle.weblogic.imagetool.logging.LoggingFacade; import com.oracle.weblogic.imagetool.logging.LoggingFactory; import com.oracle.weblogic.imagetool.tests.annotations.IntegrationTest; @@ -26,7 +27,6 @@ import com.oracle.weblogic.imagetool.tests.utils.CommandResult; import com.oracle.weblogic.imagetool.tests.utils.CreateAuxCommand; import com.oracle.weblogic.imagetool.tests.utils.CreateCommand; -import com.oracle.weblogic.imagetool.tests.utils.RebaseCommand; import com.oracle.weblogic.imagetool.tests.utils.Runner; import com.oracle.weblogic.imagetool.tests.utils.UpdateCommand; import com.oracle.weblogic.imagetool.util.Utils; @@ -539,7 +539,6 @@ void deletePatchTest(TestInfo testInfo) throws Exception { assertEquals(0, listResult.exitValue(), "for command: " + listCommand); // output should show newly added patch String errorMessage = Utils.getMessage("IMG-0160", testPatchID); - System.out.println(errorMessage); assertTrue(listResult.stdout().contains(errorMessage)); } } @@ -784,30 +783,31 @@ void createWlsImgUsingWdt(TestInfo testInfo) throws Exception { } /** - * Use the Rebase function to move a domain to a new image. + * Create image with non existent installer. * * @throws Exception - if any error occurs */ - //@Test - //@Order(13) - //@Tag("gate") - //@DisplayName("Rebase the WLS domain") - void rebaseWlsImg(TestInfo testInfo) throws Exception { - assumeTrue(wlsImgBuilt); - assumeTrue(domainImgBuilt); - String tagName = build_tag + ":" + getMethodName(testInfo); - String command = new RebaseCommand() - .sourceImage(build_tag, "createWlsImgUsingWdt") - .targetImage(build_tag, "updateWlsImg") - .tag(tagName) - .build(); + @Test + @Order(13) + @Tag("gate") + @DisplayName("Creat the WLS domain with non existent installer") + void createImagewithWrongVersion(TestInfo testInfo) throws Exception { try (PrintWriter out = getTestMethodWriter(testInfo)) { - CommandResult result = Runner.run(command, out, logger); - assertEquals(0, result.exitValue(), "for command: " + command); - // verify the docker image is created - assertTrue(imageExists(tagName), "Image was not created: " + tagName); + String tagName = build_tag + ":" + getMethodName(testInfo); + // create a WLS image with a domain + String command = new CreateCommand() + .tag(tagName) + .version("NOSUCHTHING") + .platform(PLATFORM_AMD64) + .build(); + + CommandResult result = Runner.run(command, out, logger); + assertEquals(1, result.exitValue(), "for command: " + command); + String errorMessage = Utils.getMessage("IMG-0145", InstallerType.WLS.toString(), + PLATFORM_AMD64, "NOSUCHTHING"); + assertTrue(result.stdout().contains(errorMessage)); } } From 1976acf28d6c659b4cc0e8db42e8bdcbc2bd1434 Mon Sep 17 00:00:00 2001 From: jshum Date: Wed, 16 Jul 2025 08:25:49 -0500 Subject: [PATCH 099/104] Fix list installer using commmon name and add integration test of using common name --- .../imagetool/cli/cache/ListInstallers.java | 21 ++++-- .../weblogic/imagetool/tests/ITImagetool.java | 67 +++++++++++++++++++ .../imagetool/tests/utils/CreateCommand.java | 8 +++ 3 files changed, 91 insertions(+), 5 deletions(-) diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/ListInstallers.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/ListInstallers.java index 5db55174..a4968d02 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/ListInstallers.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/ListInstallers.java @@ -3,6 +3,7 @@ package com.oracle.weblogic.imagetool.cli.cache; +import java.util.ArrayList; import java.util.Comparator; import java.util.List; import java.util.Map; @@ -36,18 +37,28 @@ public CommandResponse call() { printLine(itemType + ":"); data.get(itemType).forEach((installer, metaData) -> { + if (commonName != null && !commonName.equalsIgnoreCase(installer)) { return; } // commonName is null or version is specified - if (version != null && !version.equalsIgnoreCase(installer)) { + if (commonName == null && version != null && !version.equalsIgnoreCase(installer)) { return; } printLine(" " + installer + ":"); - - List sortedList = metaData.stream() - .sorted(Comparator.comparing(InstallerMetaData::getArchitecture)) - .collect(Collectors.toList()); + List sortedList = new ArrayList<>(metaData); + + if (commonName != null && version != null) { + sortedList = metaData.stream() + .filter(c -> c.getProductVersion().equals(version)) + .sorted(Comparator.comparing(InstallerMetaData::getArchitecture)) + .collect(Collectors.toList()); + + } else { + sortedList = metaData.stream() + .sorted(Comparator.comparing(InstallerMetaData::getArchitecture)) + .collect(Collectors.toList()); + } printDetails(sortedList, InstallerType.fromString(itemType)); }); diff --git a/tests/src/test/java/com/oracle/weblogic/imagetool/tests/ITImagetool.java b/tests/src/test/java/com/oracle/weblogic/imagetool/tests/ITImagetool.java index fe9bd6f1..4ff11e5b 100644 --- a/tests/src/test/java/com/oracle/weblogic/imagetool/tests/ITImagetool.java +++ b/tests/src/test/java/com/oracle/weblogic/imagetool/tests/ITImagetool.java @@ -80,6 +80,7 @@ class ITImagetool { private static final String P27342434_ID = "27342434"; private static final String P28186730_ID = "28186730"; private static final String WLS_VERSION = "12.2.1.3.0"; + private static final String CUSTOM_WLS_VERSION = "custom122130"; private static final String OPATCH_VERSION = "13.9.4.2.17"; private static final String JDK_VERSION = "8u202"; private static final String JDK_VERSION_212 = "8u212"; @@ -896,6 +897,72 @@ void createAuxImage(TestInfo testInfo) throws Exception { } } + /** + * Test caching of an installer of type WLS. + * + * @throws Exception - if any error occurs + */ + @Test + @Order(16) + @Tag("gate") + @Tag("cache") + @DisplayName("Add WLS installer to cache using custom name") + void cacheAddInstallerWlsUsingCommonName(TestInfo testInfo) throws Exception { + Path wlsPath = Paths.get(STAGING_DIR, WLS_INSTALLER); + String command = new CacheCommand() + .addInstaller(true) + .type("wls") + .version(WLS_VERSION) + .commonName(CUSTOM_WLS_VERSION) + .path(wlsPath) + .architecture(AMD64) + .build(); + + try (PrintWriter out = getTestMethodWriter(testInfo)) { + CommandResult result = Runner.run(command, out, logger); + // the process return code for addInstaller should be 0 + System.out.println("Result: " + result.stdout()); + assertEquals(0, result.exitValue(), "for command: " + command); + // verify the result + String listCommand = new CacheCommand().listInstallers(true).type("wls") + .commonName(CUSTOM_WLS_VERSION).version(WLS_VERSION).build(); + CommandResult listResult = Runner.run(listCommand, out, logger); + // the process return code for listItems should be 0 + System.out.println("Result: " + listResult.stdout()); + assertEquals(0, listResult.exitValue(), "for command: " + listCommand); + // output should show newly added WLS installer + assertTrue(listResult.stdout().contains(wlsPath.toString())); + assertTrue(listResult.stdout().contains(CUSTOM_WLS_VERSION + ":")); + } + } + + /** + * create a WLS image with custom name. + * + * @throws Exception - if any error occurs + */ + @Test + @Order(17) + @Tag("gate") + @DisplayName("Create custom WebLogic Server image") + void createCustomWlsImg(TestInfo testInfo) throws Exception { + String tagName = build_tag + ":" + getMethodName(testInfo); + String command = new CreateCommand().platform(PLATFORM_AMD64).tag(tagName) + .commonName(CUSTOM_WLS_VERSION).version(WLS_VERSION).build(); + + try (PrintWriter out = getTestMethodWriter(testInfo)) { + CommandResult result = Runner.run(command, out, logger); + assertEquals(0, result.exitValue(), "for command: " + command); + + // verify the docker image is created + assertTrue(imageExists(tagName), "Image was not created: " + tagName); + + wlsImgBuilt = true; + } + } + + + /** * Create a FMW image with internet access to download PSU. * Oracle Support credentials must be provided to download the patches. diff --git a/tests/src/test/java/com/oracle/weblogic/imagetool/tests/utils/CreateCommand.java b/tests/src/test/java/com/oracle/weblogic/imagetool/tests/utils/CreateCommand.java index 99f4f0b3..879ca117 100644 --- a/tests/src/test/java/com/oracle/weblogic/imagetool/tests/utils/CreateCommand.java +++ b/tests/src/test/java/com/oracle/weblogic/imagetool/tests/utils/CreateCommand.java @@ -34,6 +34,7 @@ public class CreateCommand extends ImageToolCommand { private boolean wdtRunRcu; private boolean wdtModelOnly; private String platform; + private String commonName; public CreateCommand() { super("create"); @@ -148,6 +149,11 @@ public CreateCommand platform(String value) { return this; } + public CreateCommand commonName(String value) { + commonName = value; + return this; + } + /** * Generate the command using the provided command line options. @@ -176,6 +182,8 @@ public String build() { + field("--wdtDomainType", wdtDomainType) + field("--wdtRunRCU", wdtRunRcu) + field("--platform", platform) + + field("--commonName", commonName) + field("--wdtModelOnly", wdtModelOnly); + } } From fea8c5c350f33c8c4bab55ffea48013b7380e4dd Mon Sep 17 00:00:00 2001 From: jshum Date: Wed, 16 Jul 2025 15:15:51 -0500 Subject: [PATCH 100/104] add input check for other config attributes --- .../imagetool/cli/config/SetCommand.java | 18 ++++++++++++++++++ .../src/main/resources/ImageTool.properties | 4 +++- 2 files changed, 21 insertions(+), 1 deletion(-) diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/config/SetCommand.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/config/SetCommand.java index d73740f2..0f8f70c3 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/config/SetCommand.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/config/SetCommand.java @@ -3,6 +3,8 @@ package com.oracle.weblogic.imagetool.cli.config; +import java.nio.file.Files; +import java.nio.file.Paths; import java.util.concurrent.Callable; import com.oracle.weblogic.imagetool.api.model.CommandResponse; @@ -64,6 +66,22 @@ private boolean verifyInput(String name, String value) { return false; } } + + if ("defaultBuildPlatform".equalsIgnoreCase(name) || "containerEngine".equalsIgnoreCase(name)) { + if (!"linux/amd64".equals(value) && !"linux/arm64".equals(value)) { + logger.severe("IMG-0162"); + return false; + } + } + + if ("buildContextDirectory".equalsIgnoreCase(name) || "patchDirectory".equalsIgnoreCase(name) + || "installerDirectory".equalsIgnoreCase(name)) { + if (!Files.isDirectory(Paths.get(value))) { + logger.severe("IMG-0163", name, value); + return false; + } + return true; + } return true; } } diff --git a/imagetool/src/main/resources/ImageTool.properties b/imagetool/src/main/resources/ImageTool.properties index 1e84b63a..91d57b00 100644 --- a/imagetool/src/main/resources/ImageTool.properties +++ b/imagetool/src/main/resources/ImageTool.properties @@ -159,4 +159,6 @@ IMG-0156=--type cannot be null when commonName is specified. IMG-0157=--type cannot be null when version is specified. IMG-0158=--patchId cannot be null when version is specified. IMG-0160=patchId not found {0}. -IMG-0161=Attribute {0} value {1} must be an integer greater than 1. \ No newline at end of file +IMG-0161=Attribute {0} value {1} must be an integer greater than 1. +IMG-0162=defaultBuildPlatform must be either "linux/amd64" or "linux/arm64". +IMG-0163={0} must be a valid directory, {1} is not a directory. \ No newline at end of file From b7cefee645f38b89df17e4b57443febb7c17910c Mon Sep 17 00:00:00 2001 From: jshum Date: Thu, 17 Jul 2025 15:07:03 -0500 Subject: [PATCH 101/104] refactor cache conversion and unit test --- .../imagetool/util/CacheConversion.java | 156 +---------- .../imagetool/util/CacheConverterUtil.java | 250 ++++++++++++++++++ .../util/CacheConverterUtilTest.java | 228 ++++++++++++++++ .../imagetool/util/UnitTestLogHandler.java | 35 +++ 4 files changed, 515 insertions(+), 154 deletions(-) create mode 100644 imagetool/src/main/java/com/oracle/weblogic/imagetool/util/CacheConverterUtil.java create mode 100644 imagetool/src/test/java/com/oracle/weblogic/imagetool/util/CacheConverterUtilTest.java create mode 100644 imagetool/src/test/java/com/oracle/weblogic/imagetool/util/UnitTestLogHandler.java diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/util/CacheConversion.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/util/CacheConversion.java index bc872c4c..fe04772a 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/util/CacheConversion.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/util/CacheConversion.java @@ -1,31 +1,20 @@ -// Copyright (c) 2021, Oracle and/or its affiliates. +// Copyright (c) 2025, 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.util; -import java.io.BufferedReader; -import java.io.FileReader; import java.io.IOException; import java.nio.file.Files; import java.nio.file.Path; import java.nio.file.Paths; -import java.nio.file.attribute.FileTime; -import java.time.LocalDate; -import java.time.ZoneId; -import java.time.format.DateTimeFormatter; import java.util.ArrayList; import java.util.List; -import java.util.regex.Matcher; -import java.util.regex.Pattern; import com.oracle.weblogic.imagetool.api.model.CommandResponse; import com.oracle.weblogic.imagetool.cachestore.CacheStore; import com.oracle.weblogic.imagetool.cli.cache.CacheOperation; -import com.oracle.weblogic.imagetool.installer.InstallerMetaData; -import com.oracle.weblogic.imagetool.installer.InstallerType; import com.oracle.weblogic.imagetool.logging.LoggingFacade; import com.oracle.weblogic.imagetool.logging.LoggingFactory; -import com.oracle.weblogic.imagetool.settings.ConfigManager; import picocli.CommandLine; /** @@ -39,146 +28,6 @@ public class CacheConversion extends CacheOperation { private static final LoggingFacade logger = LoggingFactory.getLogger(CacheConversion.class); - public static final String IMG_0128 = "IMG-0128"; - public static final String IMG_0129 = "IMG-0129"; - - private static final String INSTALLER_PATTERN = "^(wls|fmw|ohs|wlsdev|wlsslim|soa|osb|b2b|mft|idm|db19|" - + "oud|oid|wcc|wcp|wcs|jdk|wdt|odi)$"; - - /** - * convert cache file to nee format. - * @param inputFile input cache file - * @throws IOException when error - */ - public void convert(String inputFile) throws IOException { - Pattern installerPattern = Pattern.compile(INSTALLER_PATTERN); - try (BufferedReader br = new BufferedReader(new FileReader(inputFile))) { - String line; - while ((line = br.readLine()) != null) { - if (line.charAt(0) == '#') { - continue; - } - logger.info("IMG-0137", line); - // patches - if (Character.isDigit(line.charAt(0))) { - handlePatchPattern(line); - } else { - // installer - handleInstallerPattern(installerPattern, line); - } - } - } - } - - private void handleInstallerPattern(Pattern installerPattern, String line) throws IOException { - String[] tokens = line.split("="); - if (tokens.length == 2) { - String filepath = tokens[1]; - String key = null; - String version = null; - String arch = null; - tokens = tokens[0].split("_"); - - if (tokens.length == 2) { - key = tokens[0]; - version = tokens[1]; - Matcher matcher = installerPattern.matcher(key); - if (!matcher.matches()) { - logger.warning(IMG_0129, key, line); - return; - } - } else if (tokens.length == 3) { - key = tokens[0]; - version = convertVersionString(tokens[1]); - arch = tokens[2]; - arch = Architecture.fromString(arch).toString(); - } else { - logger.warning(IMG_0128, line); - return; - } - String fileDate = getFileDate(filepath); - if (arch == null) { - arch = Utils.standardPlatform(Architecture.getLocalArchitecture().toString()); - } - if (fileDate != null) { - logger.info("IMG-0147", key, version, filepath, arch); - InstallerMetaData metaData = new InstallerMetaData(arch, filepath, - Utils.getSha256Hash(filepath), fileDate, version, version); - ConfigManager.getInstance().addInstaller(InstallerType.fromString(key), version, metaData); - } - } else { - logger.warning(IMG_0128, line); - } - - } - - private void handlePatchPattern(String line) throws IOException { - String[] tokens = line.split("="); - if (tokens.length == 2) { - String filepath = tokens[1]; - String key = null; - String version = null; - String arch = null; - tokens = tokens[0].split("_"); - if (tokens.length == 2) { - key = tokens[0]; - version = tokens[1]; - } else if (tokens.length == 3) { - key = tokens[0]; - version = convertVersionString(tokens[1]); - arch = tokens[2]; - arch = Architecture.fromString(arch).toString(); - } else { - logger.warning(IMG_0128, line); - return; - } - String fileDate = getFileDate(filepath); - if (arch == null) { - arch = Utils.standardPlatform(Architecture.getLocalArchitecture().toString()); - } - if (fileDate != null) { - logger.info("IMG-0148", key, version, filepath); - - ConfigManager.getInstance().addPatch(key, arch, filepath, version, - "Converted from v1", fileDate); - } - } else { - logger.warning(IMG_0128, line); - } - - } - - private String convertVersionString(String version) { - if (version != null && version.length() == 6) { - return String.format("%s.%s.%s.%s.%s", - version.substring(0,1), - version.substring(2,2), - version.substring(3,3), - version.substring(4,4), - version.substring(5,5)); - } else { - return version; - } - } - - private String getFileDate(String filepath) { - try { - Path path = Paths.get(filepath); - if (Files.exists(path)) { - FileTime modifiedTime = Files.getLastModifiedTime(path); - LocalDate today = modifiedTime.toInstant() - .atZone(ZoneId.systemDefault()) - .toLocalDate(); - return today.format(DateTimeFormatter.ISO_LOCAL_DATE); - } else { - logger.warning("IMG-0131", filepath); - return null; - } - } catch (IOException ioe) { - logger.warning("IMG-0132", filepath, ioe.getLocalizedMessage()); - return null; - } - } private boolean initializeSettingFiles(String directory) { boolean success = true; @@ -232,7 +81,6 @@ private void createIfNotExists(Path entry, boolean isDir) throws IOException { @Override public CommandResponse call() throws Exception { - CacheConversion cacheConversion = new CacheConversion(); String cacheEnv = System.getenv(CacheStore.CACHE_DIR_ENV); Path cacheMetaFile; if (cacheEnv != null) { @@ -247,7 +95,7 @@ public CommandResponse call() throws Exception { } } if (Files.exists(cacheMetaFile)) { - cacheConversion.convert(cacheMetaFile.toString()); + CacheConverterUtil.convert(cacheMetaFile.toString()); } else { logger.info("IMG-0133", cacheMetaFile.toString()); } diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/util/CacheConverterUtil.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/util/CacheConverterUtil.java new file mode 100644 index 00000000..cc67b813 --- /dev/null +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/util/CacheConverterUtil.java @@ -0,0 +1,250 @@ +// Copyright (c) 2025, 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.util; + +import java.io.BufferedReader; +import java.io.FileReader; +import java.io.IOException; +import java.nio.file.Files; +import java.nio.file.Path; +import java.nio.file.Paths; +import java.nio.file.attribute.FileTime; +import java.time.LocalDate; +import java.time.ZoneId; +import java.time.format.DateTimeFormatter; +import java.util.regex.Matcher; +import java.util.regex.Pattern; + +import com.oracle.weblogic.imagetool.installer.InstallerMetaData; +import com.oracle.weblogic.imagetool.installer.InstallerType; +import com.oracle.weblogic.imagetool.logging.LoggingFacade; +import com.oracle.weblogic.imagetool.logging.LoggingFactory; +import com.oracle.weblogic.imagetool.settings.ConfigManager; + + +public class CacheConverterUtil { + + private static final LoggingFacade logger = LoggingFactory.getLogger(CacheConverterUtil.class); + public static final String INSTALLER_PATTERN = "^(wls|fmw|ohs|wlsdev|wlsslim|soa|osb|b2b|mft|idm|db19|" + + "oud|oid|wcc|wcp|wcs|jdk|wls|odi|wdt)$"; + public static final String IMG_0128 = "IMG-0128"; + public static final String IMG_0129 = "IMG-0129"; + + /** + * convert cache file to new format. + * @param inputFile input cache file + * @throws IOException when error + */ + public static void convert(String inputFile) throws IOException { + Pattern installerPattern = Pattern.compile(INSTALLER_PATTERN); + try (BufferedReader br = new BufferedReader(new FileReader(inputFile))) { + String line; + while ((line = br.readLine()) != null) { + if (line.charAt(0) == '#') { + continue; + } + logger.info("IMG-0137", line); + // patches + if (Character.isDigit(line.charAt(0))) { + handlePatchPattern(line); + } else { + // installer + handleInstallerPattern(installerPattern, line); + } + } + } + } + + public static class ParsedInfo { + private final String filePath; + private final String key; + private final String version; + private final String architecture; + private final String fileDate; + + /** + * Constructor. + * @param filePath File Path + * @param key Installer type + * @param version Version + * @param architecture Architecture + * @param fileDate File date + */ + public ParsedInfo(String filePath, String key, String version, String architecture, String fileDate) { + this.filePath = filePath; + this.key = key; + this.version = version; + this.architecture = architecture; + this.fileDate = fileDate; + } + + public String getFilePath() { + return filePath; + } + + public String getKey() { + return key; + } + + public String getVersion() { + return version; + } + + public String getArchitecture() { + return architecture; + } + + public String getFileDate() { + return fileDate; + } + + } + + /** + * Convert installer line v1 to v2. + * @param installerPattern Installer pattern + * @param line input line + * @return ParsedInfo for temporary holder + */ + public static ParsedInfo convertInstallerEntry(Pattern installerPattern, String line) { + String[] tokens = line.split("="); + if (tokens.length == 2) { + String filepath = tokens[1]; + String key = null; + String version = null; + String arch = null; + tokens = tokens[0].split("_"); + + if (tokens.length == 2) { + key = tokens[0]; + version = tokens[1]; + Matcher matcher = installerPattern.matcher(key); + if (!matcher.matches()) { + logger.warning(IMG_0129, key, line); + return null; + } + } else if (tokens.length == 3) { + key = tokens[0]; + version = convertVersionString(tokens[1]); + arch = tokens[2]; + arch = Architecture.fromString(arch).toString(); + } else { + logger.warning(IMG_0128, line); + return null; + } + String fileDate = getFileDate(filepath); + if (arch == null) { + arch = Utils.standardPlatform(Architecture.getLocalArchitecture().toString()); + } + if (fileDate != null) { + return new ParsedInfo(filepath, key, version, arch, fileDate); + } + } else { + logger.warning(IMG_0128, line); + return null; + } + return null; + } + + + private static void handleInstallerPattern(Pattern installerPattern, String line) throws IOException { + + ParsedInfo info = convertInstallerEntry(installerPattern, line); + if (info != null) { + logger.info("IMG-0147", info.getKey(), info.getVersion(), info.getFilePath(), info.getArchitecture()); + InstallerMetaData metaData = new InstallerMetaData(info.getArchitecture(), info.getFilePath(), + Utils.getSha256Hash(info.getFilePath()), info.getFileDate(), info.getVersion(), info.getVersion()); + ConfigManager.getInstance().addInstaller(InstallerType.fromString(info.getKey()), info.getVersion(), + metaData); + } + } + + /** + * Convert patch line v1 to v2. + * @param line input line + * @return ParsedInfo for temporary holder + */ + public static ParsedInfo convertPatchEntry(String line) { + String[] tokens = line.split("="); + if (tokens.length == 2) { + String filepath = tokens[1]; + String key = null; + String version = null; + String arch = null; + tokens = tokens[0].split("_"); + if (tokens.length == 2) { + key = tokens[0]; + version = tokens[1]; + } else if (tokens.length == 3) { + key = tokens[0]; + version = convertVersionString(tokens[1]); + arch = tokens[2]; + arch = Architecture.fromString(arch).toString(); + } else { + logger.warning(IMG_0128, line); + return null; + } + String fileDate = getFileDate(filepath); + if (arch == null) { + arch = Utils.standardPlatform(Architecture.getLocalArchitecture().toString()); + } + if (fileDate != null) { + return new ParsedInfo(filepath, key, version, arch, fileDate); + } + } else { + logger.warning(IMG_0128, line); + } + return null; + } + + private static void handlePatchPattern(String line) throws IOException { + ParsedInfo info = convertPatchEntry(line); + if (info != null) { + logger.info("IMG-0148", info.getKey(), info.getVersion(), info.getFilePath()); + ConfigManager.getInstance().addPatch(info.getKey(), info.getArchitecture(), + info.getFilePath(), info.getVersion(), + "Converted from v1", info.getFileDate()); + } + } + + /** + * Convert a version string to standard format. + * @param version input string + * @return converted version format string + */ + public static String convertVersionString(String version) { + if (version != null && version.length() == 6) { + // e.g. 122140 141100 + return String.format("%s.%s.%s.%s.%s", + version.substring(0,2), + version.substring(2,3), + version.substring(3,4), + version.substring(4,5), + version.substring(5)); + } else { + return version; + } + } + + private static String getFileDate(String filepath) { + try { + Path path = Paths.get(filepath); + if (Files.exists(path)) { + FileTime modifiedTime = Files.getLastModifiedTime(path); + LocalDate today = modifiedTime.toInstant() + .atZone(ZoneId.systemDefault()) + .toLocalDate(); + return today.format(DateTimeFormatter.ISO_LOCAL_DATE); + } else { + logger.warning("IMG-0131", filepath); + return null; + } + } catch (IOException ioe) { + logger.warning("IMG-0132", filepath, ioe.getLocalizedMessage()); + return null; + } + } + + +} diff --git a/imagetool/src/test/java/com/oracle/weblogic/imagetool/util/CacheConverterUtilTest.java b/imagetool/src/test/java/com/oracle/weblogic/imagetool/util/CacheConverterUtilTest.java new file mode 100644 index 00000000..5dad8e08 --- /dev/null +++ b/imagetool/src/test/java/com/oracle/weblogic/imagetool/util/CacheConverterUtilTest.java @@ -0,0 +1,228 @@ +// Copyright (c) 2025, 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.util; + + +import java.io.IOException; +import java.nio.file.Files; +import java.nio.file.Path; +import java.time.LocalDate; +import java.time.format.DateTimeFormatter; +import java.util.Arrays; +import java.util.List; +import java.util.logging.Level; +import java.util.logging.LogRecord; +import java.util.regex.Pattern; + +import com.oracle.weblogic.imagetool.installer.InstallerType; +import com.oracle.weblogic.imagetool.logging.LoggingFacade; +import com.oracle.weblogic.imagetool.logging.LoggingFactory; +import org.junit.jupiter.api.AfterEach; +import org.junit.jupiter.api.BeforeAll; +import org.junit.jupiter.api.BeforeEach; +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.assertNotNull; +import static org.junit.jupiter.api.Assertions.assertNull; +import static org.junit.jupiter.api.Assertions.assertTrue; + +@Tag("unit") +class CacheConverterUtilTest { + + static final List fileContents = Arrays.asList("A", "B", "C"); + static Path path12213; + static Path patch; + static UnitTestLogHandler logHandler = new UnitTestLogHandler(); + static Pattern installerPattern; + + @BeforeAll + static void setup(@TempDir Path tempDir) throws IOException { + path12213 = tempDir.resolve("installer.file.122130.jar"); + Files.write(path12213, fileContents); + patch = tempDir.resolve("patch.file.122130.jar"); + Files.write(patch, fileContents); + + TestSetup.setup(tempDir); + + installerPattern = Pattern.compile(CacheConverterUtil.INSTALLER_PATTERN); + } + + @BeforeEach + void setupLogger() { + LoggingFacade logger = LoggingFactory.getLogger(CacheConverterUtil.class); + + logger.getUnderlyingLogger().setUseParentHandlers(false); + logger.getUnderlyingLogger().addHandler(logHandler); + logger.setLevel(Level.ALL); + logHandler.clear(); + } + + @AfterEach + void tearDownLogger() { + LoggingFacade logger = LoggingFactory.getLogger(CacheConverterUtil.class); + logger.getUnderlyingLogger().removeHandler(logHandler); + logger.getUnderlyingLogger().setUseParentHandlers(true); + } + + @Test + void testConvertVersionString() { + assertEquals("12.2.1.4.0", CacheConverterUtil.convertVersionString("122140")); + assertEquals("14.1.1.0.0", CacheConverterUtil.convertVersionString("141100")); + assertEquals("12.2.1.4.0", CacheConverterUtil.convertVersionString("12.2.1.4.0")); + } + + @Test + void testParseInstallerValidWithoutArch() { + String line = "wls_12.2.1.3.0=" + path12213.toString(); + + CacheConverterUtil.ParsedInfo result = CacheConverterUtil.convertInstallerEntry( + installerPattern, line); + assertNotNull(result); + + assertEquals(InstallerType.WLS.toString().toLowerCase(), result.getKey().toLowerCase()); + assertEquals("12.2.1.3.0", result.getVersion()); + assertEquals(Utils.standardPlatform(Architecture.getLocalArchitecture().toString()), result.getArchitecture()); + assertEquals(path12213.toString(), result.getFilePath()); + assertEquals(LocalDate.now().format(DateTimeFormatter.ISO_LOCAL_DATE), result.getFileDate()); + + } + + @Test + void testParseInstallerValidWithArch() { + String line = "wls_12.2.1.3.0_amd64=" + path12213.toString(); + + CacheConverterUtil.ParsedInfo result = CacheConverterUtil.convertInstallerEntry( + installerPattern, line); + assertNotNull(result); + + assertEquals(InstallerType.WLS.toString().toLowerCase(), result.getKey().toLowerCase()); + assertEquals("12.2.1.3.0", result.getVersion()); + assertEquals("amd64", result.getArchitecture()); + assertEquals(path12213.toString(), result.getFilePath()); + assertEquals(LocalDate.now().format(DateTimeFormatter.ISO_LOCAL_DATE), result.getFileDate()); + + } + + @Test + void testParseInstallerWithFakeFilePath() { + + String line = "wls_12.2.1.3.0_amd64=/tmp/nosuchfile.zip"; + + CacheConverterUtil.ParsedInfo result = CacheConverterUtil.convertInstallerEntry( + installerPattern, line); + assertNull(result); + List recs = logHandler.getRecords(); + boolean found = false; + for (LogRecord rec : recs) { + if (rec.getMessage().equals("IMG-0131")) { + assertEquals("/tmp/nosuchfile.zip", rec.getParameters()[0]); + found = true; + } + } + assertTrue(found); + } + + @Test + void testParseInstallerInvalidKey() { + String line = "invalid_122140=/fake/path.jar"; + CacheConverterUtil.ParsedInfo result = CacheConverterUtil.convertInstallerEntry( + installerPattern, line); + assertNull(result); + List recs = logHandler.getRecords(); + boolean found = false; + for (LogRecord rec : recs) { + //IMG-0129=Cannot parse image tool version 1 metadata file line: unrecognized product {0} in line {1}. + if (rec.getMessage().equals("IMG-0129")) { + assertEquals(line, rec.getParameters()[1]); + found = true; + } + } + assertTrue(found); + } + + @Test + void testParseInstallerBadFormat() { + String line = "wls_12.2.1.4.0"; + CacheConverterUtil.ParsedInfo result = CacheConverterUtil.convertInstallerEntry( + installerPattern, line); + assertNull(result); + List recs = logHandler.getRecords(); + boolean found = false; + for (LogRecord rec : recs) { + //IMG-0128=Cannot parse image tool version 1 metadata file line: {0}, skipping. + if (rec.getMessage().equals("IMG-0128")) { + assertEquals(line, rec.getParameters()[0]); + found = true; + } + } + assertTrue(found); + } + + + @Test + void testParsePatchValid() { + String line = "12345678_12.2.1.4.0=" + patch.toString(); + CacheConverterUtil.ParsedInfo result = CacheConverterUtil.convertPatchEntry(line); + assertNotNull(result); + + assertEquals("12345678", result.getKey()); + assertEquals("12.2.1.4.0", result.getVersion()); + assertEquals(patch.toString(), result.getFilePath()); + assertEquals(LocalDate.now().format(DateTimeFormatter.ISO_LOCAL_DATE), result.getFileDate()); + assertEquals(Utils.standardPlatform(Architecture.getLocalArchitecture().toString()), + result.getArchitecture()); + } + + @Test + void testParsePatchWithShortVersionAndArch() { + String line = "12345678_122140_amd64=" + patch.toString(); + + CacheConverterUtil.ParsedInfo result = CacheConverterUtil.convertPatchEntry(line); + assertNotNull(result); + + assertEquals("12345678", result.getKey()); + assertEquals("12.2.1.4.0", result.getVersion()); + assertEquals(patch.toString(), result.getFilePath()); + assertEquals(LocalDate.now().format(DateTimeFormatter.ISO_LOCAL_DATE), result.getFileDate()); + assertEquals("amd64", result.getArchitecture()); + } + + @Test + void testParsePatchBadFormat() { + String line = "12345678"; + CacheConverterUtil.ParsedInfo result = CacheConverterUtil.convertPatchEntry(line); + assertNull(result); + List recs = logHandler.getRecords(); + boolean found = false; + for (LogRecord rec : recs) { + //IMG-0128=Cannot parse image tool version 1 metadata file line: {0}, skipping. + if (rec.getMessage().equals("IMG-0128")) { + assertEquals(line, rec.getParameters()[0]); + found = true; + } + } + assertTrue(found); + } + + + @Test + void testParsePatchFileNotExist() { + String line = "12345678_12.2.1.4.0=/nonexistent.zip"; + CacheConverterUtil.ParsedInfo result = CacheConverterUtil.convertPatchEntry(line); + assertNull(result); + List recs = logHandler.getRecords(); + boolean found = false; + for (LogRecord rec : recs) { + if (rec.getMessage().equals("IMG-0131")) { + assertEquals("/nonexistent.zip", rec.getParameters()[0]); + found = true; + } + } + assertTrue(found); + } + +} diff --git a/imagetool/src/test/java/com/oracle/weblogic/imagetool/util/UnitTestLogHandler.java b/imagetool/src/test/java/com/oracle/weblogic/imagetool/util/UnitTestLogHandler.java new file mode 100644 index 00000000..37673c2b --- /dev/null +++ b/imagetool/src/test/java/com/oracle/weblogic/imagetool/util/UnitTestLogHandler.java @@ -0,0 +1,35 @@ +// Copyright (c) 2025, 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.util; + +import java.util.ArrayList; +import java.util.List; +import java.util.logging.Handler; +import java.util.logging.LogRecord; + +public class UnitTestLogHandler extends Handler { + private final List records = new ArrayList<>(); + + @Override + public void publish(LogRecord rec) { + records.add(rec); + } + + @Override + public void flush() { + } + + @Override + public void close() throws SecurityException { + } + + public List getRecords() { + return records; + } + + public void clear() { + records.clear(); + } +} + From 30b2d42b68eaf2421a7033a549e5dfd98929aab9 Mon Sep 17 00:00:00 2001 From: jshum Date: Fri, 18 Jul 2025 14:47:30 -0500 Subject: [PATCH 102/104] Allow omitting version when common name is specified. --- .../imagetool/cachestore/CacheStore.java | 26 ++++++++++++++ .../cli/cache/CacheAddOperation.java | 36 +++++++++++++++---- .../cli/menu/CommonCreateOptions.java | 20 +++++++++-- .../imagetool/settings/ConfigManager.java | 11 ++++++ .../src/main/resources/ImageTool.properties | 5 ++- 5 files changed, 88 insertions(+), 10 deletions(-) diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cachestore/CacheStore.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cachestore/CacheStore.java index a0766b2d..1cee5a99 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cachestore/CacheStore.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cachestore/CacheStore.java @@ -167,6 +167,7 @@ private boolean baseFMWVersionExists(InstallerType type, Map listInstallerByCommonName(InstallerType installerType, String commonName) { + + + installerType = (installerType == null) ? InstallerType.WLS : installerType; + + String installerKey = installerType.toString().toUpperCase(); + + Map> installers = getInstallers().get(installerKey); + if (installers != null && !installers.isEmpty()) { + for (String key : installers.keySet()) { + if (key.equals(commonName)) { + return installers.get(key); + } + } + } + return null; + } + /** * Add a patch to the local system. * @param bugNumber bug number diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/CacheAddOperation.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/CacheAddOperation.java index 59ec4c3b..7c14d1ad 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/CacheAddOperation.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/CacheAddOperation.java @@ -6,6 +6,7 @@ import java.io.IOException; import java.nio.file.Files; import java.nio.file.Path; +import java.util.List; import com.oracle.weblogic.imagetool.api.model.CommandResponse; import com.oracle.weblogic.imagetool.cachestore.CacheStore; @@ -39,23 +40,44 @@ CommandResponse addInstallerToCache() throws IOException { String type = getKey(); String name = getCommonName(); - if (name == null) { - name = getVersion(); - } - Architecture arch = getArchitecture(); // Force WDT to be generic if (InstallerType.fromString(type) == InstallerType.WDT) { arch = Architecture.GENERIC; } - InstallerMetaData metaData = ConfigManager.getInstance().getInstallerForPlatform(InstallerType.fromString(type), - arch, name); + + InstallerMetaData metaData; + + if (getCommonName() == null) { + metaData = ConfigManager.getInstance().getInstallerForPlatform(InstallerType.fromString(type), + arch, getVersion()); + name = getVersion(); + } else { + metaData = ConfigManager.getInstance().getInstallerForPlatform(InstallerType.fromString(type), + arch, getVersion(), getCommonName()); + } + if (metaData != null) { return CommandResponse.success("IMG-0075"); + } else { + if (getCommonName() != null) { + // Check the case for commonName, only one version is allowed + List tempList = ConfigManager.getInstance() + .listInstallerByCommonName(InstallerType.fromString(type), + getCommonName()); + if (tempList != null && !tempList.isEmpty()) { + for (InstallerMetaData installerMetaData : tempList) { + if (!installerMetaData.getProductVersion().equals(getVersion())) { + return CommandResponse.error("IMG-0164", installerMetaData.getProductVersion()); + } + } + } + } } + metaData = new InstallerMetaData(arch.toString(), filePath.toAbsolutePath().toString(), getVersion(), getBaseFMWVersion()); - ConfigManager.getInstance().addInstaller(InstallerType.fromString(type), getCommonName(), metaData); + ConfigManager.getInstance().addInstaller(InstallerType.fromString(type), name, metaData); // if the new value is the same as the existing cache value, do nothing return CommandResponse.success("IMG-0050", type, metaData.getProductVersion(), metaData.getLocation()); diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonCreateOptions.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonCreateOptions.java index ab1a74a2..155b65e5 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonCreateOptions.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CommonCreateOptions.java @@ -43,6 +43,23 @@ public class CommonCreateOptions extends CommonPatchingOptions { void prepareNewImage() throws IOException, InterruptedException, XPathExpressionException, AruException { logger.entering(); + + if (installerVersion == null && commonName == null) { + installerVersion = DEFAULT_WLS_VERSION; + } + + if (commonName != null) { + // reset version + List dataList = ConfigManager.getInstance() + .listInstallerByCommonName(InstallerType.fromString(getInstallerType().toString()), commonName); + if (dataList != null && !dataList.isEmpty()) { + installerVersion = dataList.get(0).getProductVersion(); + } else { + String errorMsg = Utils.getMessage("IMG-0166", commonName); + throw new IOException(errorMsg); + } + } + copyOptionsFromImage(); @@ -248,8 +265,7 @@ String getCommonName() { @Option( names = {"--version"}, - description = "Installer version. Default: ${DEFAULT-VALUE}", - required = true, + description = "Installer version.", defaultValue = DEFAULT_WLS_VERSION ) private String installerVersion; diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/ConfigManager.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/ConfigManager.java index 380b6fb2..9db28995 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/ConfigManager.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/settings/ConfigManager.java @@ -191,6 +191,7 @@ public InstallerMetaData getInstallerForPlatform(InstallerType installerType, Ar /** * Return the metadata for the platformed installer. + * @param installerType installer type * @param platformName platform name * @param installerVersion version of the installer * @param commonName common name of the installer @@ -201,6 +202,16 @@ public InstallerMetaData getInstallerForPlatform(InstallerType installerType, Ar return cacheStore.getInstallerForPlatform(installerType, platformName, installerVersion, commonName); } + /** + * Return the metadata for the platformed installer. + * @param installerType installer type + * @param commonName common name of the installer + * @return InstallerMetaData meta data for the installer + */ + public List listInstallerByCommonName(InstallerType installerType, String commonName) { + return cacheStore.listInstallerByCommonName(installerType, commonName); + } + /** * Return all the installers based on the configured directory for the yaml file. * @return map of installers diff --git a/imagetool/src/main/resources/ImageTool.properties b/imagetool/src/main/resources/ImageTool.properties index 91d57b00..e6efc4a0 100644 --- a/imagetool/src/main/resources/ImageTool.properties +++ b/imagetool/src/main/resources/ImageTool.properties @@ -161,4 +161,7 @@ IMG-0158=--patchId cannot be null when version is specified. IMG-0160=patchId not found {0}. IMG-0161=Attribute {0} value {1} must be an integer greater than 1. IMG-0162=defaultBuildPlatform must be either "linux/amd64" or "linux/arm64". -IMG-0163={0} must be a valid directory, {1} is not a directory. \ No newline at end of file +IMG-0163={0} must be a valid directory, {1} is not a directory. +IMG-0164=You can only add one version of installers with --commonName. There is already an existing version {0}. +IMG-0165=Using version {0} based on --commonName {1} instead. +IMG-0166=No installers found for commonName {0}. \ No newline at end of file From aff92b394ce97a898c50d659fa2549e3cab09c01 Mon Sep 17 00:00:00 2001 From: jshum Date: Wed, 23 Jul 2025 11:54:35 -0500 Subject: [PATCH 103/104] fix npe when resetting numeric entries --- .../imagetool/cli/config/ConfigAttributeName.java | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/config/ConfigAttributeName.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/config/ConfigAttributeName.java index 46806708..ee96fc03 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/config/ConfigAttributeName.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/config/ConfigAttributeName.java @@ -65,7 +65,11 @@ public String get(UserSettingsFile settings) { aruRetryMax("AruRetryMax") { @Override public void set(UserSettingsFile settings, String value) { - settings.setAruRetryMax(Integer.parseInt(value)); + if (value != null) { + settings.setAruRetryMax(Integer.parseInt(value)); + } else { + settings.setAruRetryMax(null); + } } @Override @@ -121,7 +125,11 @@ public String get(UserSettingsFile settings) { aruRetryInterval("AruRetryInterval") { @Override public void set(UserSettingsFile settings, String value) { - settings.setAruRetryInterval(Integer.parseInt(value)); + if (value != null) { + settings.setAruRetryInterval(Integer.parseInt(value)); + } else { + settings.setAruRetryInterval(null); + } } @Override From e47e5ffd8c253e0aa8bac96a55462ee1966966f0 Mon Sep 17 00:00:00 2001 From: jshum Date: Mon, 28 Jul 2025 16:08:28 -0500 Subject: [PATCH 104/104] minor fixes --- .../imagetool/cli/cache/DeleteInstaller.java | 21 +++++----- .../imagetool/cli/cache/DeletePatch.java | 41 +++++++++++-------- .../src/main/resources/ImageTool.properties | 8 ++-- 3 files changed, 38 insertions(+), 32 deletions(-) diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/DeleteInstaller.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/DeleteInstaller.java index 49923270..67fad81f 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/DeleteInstaller.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/DeleteInstaller.java @@ -43,7 +43,6 @@ public CommandResponse call() throws CacheStoreException { } else { search = commonName; } - System.out.println("Deleting installer " + itemType + " from " + search); exists = Optional.ofNullable(items.get(search)) .map(list -> list.stream().anyMatch(i -> Architecture.fromString(i.getArchitecture()) @@ -54,21 +53,21 @@ public CommandResponse call() throws CacheStoreException { .map(list -> list.removeIf(i -> Architecture.fromString(i.getArchitecture()) .equals(architecture) && i.getProductVersion().equalsIgnoreCase(version))); + if (items.get(search).isEmpty()) { items.remove(search); } - break; + + try { + configManager.saveAllInstallers(data); + } catch (IOException e) { + throw new CacheStoreException(e.getMessage(), e); + } + + return CommandResponse.success("IMG-0169", search, version, architecture); } } - if (!exists) { - return CommandResponse.success("IMG-0125"); - } - try { - configManager.saveAllInstallers(data); - } catch (IOException e) { - throw new CacheStoreException(e.getMessage(), e); - } - return CommandResponse.success(null); + return CommandResponse.error("IMG-0125"); } @Option( diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/DeletePatch.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/DeletePatch.java index 04b07ce5..00131539 100644 --- a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/DeletePatch.java +++ b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/DeletePatch.java @@ -4,7 +4,6 @@ package com.oracle.weblogic.imagetool.cli.cache; import java.io.IOException; -import java.util.Iterator; import java.util.List; import java.util.Map; import java.util.Optional; @@ -38,34 +37,40 @@ public CommandResponse call() throws CacheStoreException { if (patchId == null || version == null || architecture == null) { return CommandResponse.success("IMG-0126"); } - - for (Iterator iterator = data.keySet().iterator(); iterator.hasNext(); ) { - String id = iterator.next(); + for (String id : data.keySet()) { if (patchId.equalsIgnoreCase(id)) { List items = data.get(id); if (isPatchVersionMatched(items)) { - Optional.of(items) - .map(list -> list.removeIf(i -> i.getPatchVersion().equals(version) - && Architecture.fromString(i.getArchitecture()).equals(architecture))); - // if all patches are removed for this bug number, remove this bug number from the store. - if (items.isEmpty()) { - data.remove(id); + Optional d = Optional.of(items).flatMap(list -> list.stream().filter(i -> + i.getPatchVersion().equals(version) + && Architecture.fromString(i.getArchitecture()).equals(architecture)).findAny()); + + if (d.isPresent()) { + Optional.of(items) + .map(list -> list.removeIf(i -> i.getPatchVersion().equals(version) + && Architecture.fromString(i.getArchitecture()).equals(architecture))); + // if all patches are removed for this bug number, remove this bug number from the store. + if (items.isEmpty()) { + data.remove(id); + } + try { + configManager.saveAllPatches(data); + } catch (IOException e) { + throw new CacheStoreException(e.getMessage(), e); + } + + return CommandResponse.success("IMG-0168", patchId, version, architecture); } - break; + } else { - return CommandResponse.success("IMG-0127"); + return CommandResponse.error("IMG-0127"); } } } - try { - configManager.saveAllPatches(data); - } catch (IOException e) { - throw new CacheStoreException(e.getMessage(), e); - } - return CommandResponse.success(null); + return CommandResponse.error("IMG-0127"); } @Option( diff --git a/imagetool/src/main/resources/ImageTool.properties b/imagetool/src/main/resources/ImageTool.properties index e6efc4a0..6d0cd186 100644 --- a/imagetool/src/main/resources/ImageTool.properties +++ b/imagetool/src/main/resources/ImageTool.properties @@ -123,9 +123,9 @@ IMG-0121=Did not recognize '-platform' name {0}. Defaulted to {1}. IMG-0122=Invalid patch {0} for version {1}. A patch cannot be both generic and architecture specific. Remove the invalid entry from the cache, like {0}_{1}_xxx64. IMG-0123=Cannot find the patch {0} for platform {1}, no patch for this platform will be applied. IMG-0124=You must specify --type (--version or --commonName) and --architecture for deleting an installer. -IMG-0125=Specified installer to delete cannot be found. +IMG-0125=Specified installer for deletion cannot be found. IMG-0126=You must specify --patchId --version and --architecture for deleting a patch. -IMG-0127=Specified installer to delete cannot be found. +IMG-0127=Specified patch for deletion cannot be found. IMG-0128=Cannot parse image tool version 1 metadata file line: {0}, skipping. IMG-0129=Cannot parse image tool version 1 metadata file line: unrecognized product {0} in line {1}. IMG-0130=Successfully added patch to cache. [[cyan: bug:]] {0} [[cyan: version:]] {1} [[cyan: filepath:]] {2} @@ -164,4 +164,6 @@ IMG-0162=defaultBuildPlatform must be either "linux/amd64" or "linux/arm64". IMG-0163={0} must be a valid directory, {1} is not a directory. IMG-0164=You can only add one version of installers with --commonName. There is already an existing version {0}. IMG-0165=Using version {0} based on --commonName {1} instead. -IMG-0166=No installers found for commonName {0}. \ No newline at end of file +IMG-0166=No installers found for commonName {0}. +IMG-0168=Patch {0} version {1} architecture {2} deleted. +IMG-0169=Installer {0} version {1} architecture {2} deleted.