Issue#576 collect foreign server bindings archive (#577)

CarolynRountree · web-flow · commit af87cd967004 · 2020-03-27T13:17:09.000-05:00
* Fix java.lang.Boolean issues for ActiveDirectoryAuthenticator

* If file scheme for foreign server URL collect file into archive
diff --git a/core/src/main/java/oracle/weblogic/deploy/util/WLSDeployArchive.java b/core/src/main/java/oracle/weblogic/deploy/util/WLSDeployArchive.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2017, 2020, Oracle Corporation and/or its affiliates.  All rights reserved.
+ * Copyright (c) 2017, 2020, Oracle Corporation and/or its affiliates.
  * Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl.
  */
 package oracle.weblogic.deploy.util;
@@ -103,6 +103,17 @@ public class WLSDeployArchive {
      */
     public static final String ARCHIVE_SCRIPTS_DIR = WLSDPLY_ARCHIVE_BINARY_DIR + "/scripts";
 
+    /**
+     * Top-level archive subdirectory for JMS and in which its sub-directories will be separated.
+     */
+    public static final String ARCHIVE_JMS_DIR = WLSDPLY_ARCHIVE_BINARY_DIR + "/jms";
+
+    /**
+     * Top-level archive subdirectory where the JMS Foreign Server bindings files are stored and the
+     * subdirectory to which they will be extracted.
+     */
+    public static final String ARCHIVE_JMS_FOREIGN_SERVER_DIR = ARCHIVE_JMS_DIR + "/foreignServer";
+
     // Used by the unit tests so it requires package level scoping...
     //
     /* package */
@@ -950,7 +961,6 @@ public String addMimeMappingFile(File mimeMappingFile) throws WLSDeployArchiveIO
         LOGGER.exiting(CLASS, METHOD, newName);
         return newName;
     }
-
     /**
      * Add a Coherence configuration file to the archive.
      *
@@ -972,6 +982,27 @@ public String addCoherenceConfigFile(String clusterName, File configFile) throws
         return newName;
     }
 
+    /**
+     * Add a Foreign Server binding file to the archive
+     *
+     * @param foreignServer the Foreign Server name used to segregate the directories
+     * @param configFile  the file to add
+     * @return the new location of the file to use in the model
+     * @throws WLSDeployArchiveIOException if an error occurs while archiving the file
+     * @throws IllegalArgumentException    if the file does not exist or the foreignServer is empty or null
+     */
+    public String addForeignServerFile(String foreignServer, File configFile) throws WLSDeployArchiveIOException {
+        final String METHOD = "addForeignServerFile";
+
+        LOGGER.entering(CLASS, METHOD, foreignServer, configFile);
+
+        validateNonEmptyString(foreignServer, "foreignServerName", METHOD);
+        validateExistingFile(configFile, "configFile", getArchiveFileName(), METHOD);
+        String newName = addItemToZip(ARCHIVE_JMS_FOREIGN_SERVER_DIR + ZIP_SEP + foreignServer, configFile);
+        LOGGER.exiting(CLASS, METHOD, newName);
+        return newName;
+    }
+
     /**
      * Add a Coherence configuration file to the archive from an http site.
      *
diff --git a/core/src/main/python/wlsdeploy/aliases/model_constants.py b/core/src/main/python/wlsdeploy/aliases/model_constants.py
@@ -1,5 +1,5 @@
 """
-Copyright (c) 2017, 2020, Oracle Corporation and/or its affiliates.  All rights reserved.
+Copyright (c) 2017, 2020, Oracle Corporation and/or its affiliates.
 Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl.
 """
 
@@ -66,6 +66,7 @@
 COHERENCE_WELL_KNOWN_ADDRESS = 'CoherenceClusterWellKnownAddress'
 CONFIGURATION_PROPERTY = 'ConfigurationProperty'
 CONNECTION_FACTORY = 'ConnectionFactory'
+CONNECTION_URL = 'ConnectionURL'
 CONTEXT_CASE = 'ContextCase'
 CONTEXT_REQUEST_CLASS = 'ContextRequestClass'
 CPU_UTILIZATION = 'CpuUtilization'
diff --git a/core/src/main/python/wlsdeploy/tool/discover/coherence_resources_discoverer.py b/core/src/main/python/wlsdeploy/tool/discover/coherence_resources_discoverer.py
@@ -1,14 +1,12 @@
 """
-Copyright (c) 2017, 2019, Oracle Corporation and/or its affiliates.  All rights reserved.
+Copyright (c) 2017, 2020, Oracle Corporation and/or its affiliates.
 Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl.
 """
 from java.io import File
 from java.io import IOException
 from java.lang import IllegalArgumentException
 from java.lang import SecurityException
-from java.net import URI
-from java.net import URISyntaxException
-from java.net import MalformedURLException
+
 
 from oracle.weblogic.deploy.util import FileUtils
 from oracle.weblogic.deploy.util import PyOrderedDict as OrderedDict
@@ -200,8 +198,8 @@ def _add_cache_config(self, model_name, model_value, location):
         _logger.entering(cluster_name, model_name, model_value, class_name=_class_name, method_name=_method_name)
         new_name = model_value
         if model_value is not None:
+            success, url, file_name = self._get_from_url('Coherence Cluster ' + cluster_name + ' Cache Configuration', model_value)
             archive_file = self._model_context.get_archive_file()
-            success, url = _get_from_url(cluster_name, model_value)
             if success:
                 if url is not None:
                     try:
@@ -212,8 +210,8 @@ def _add_cache_config(self, model_name, model_value, location):
                         _logger.warning('WLSDPLY-06318', cluster_name, model_value, 'url', wioe.getLocalizedMessage(),
                                         class_name=_class_name, method_name=_method_name)
                         new_name = None
-                else:
-                    file_name = self._convert_path(model_value)
+                elif file_name is not None:
+                    file_name = self._convert_path(file_name)
                     try:
                         new_name = archive_file.addCoherenceConfigFile(cluster_name, File(file_name))
                         _logger.info('WLSDPLY-06319', cluster_name, file_name, new_name, class_name=_class_name,
@@ -263,23 +261,3 @@ def _add_persistence_directory(self, model_name, model_value, location, dir_type
 
         _logger.exiting(class_name=_class_name, method_name=_method_name, result=new_name)
         return new_name
-
-
-def _get_from_url(cluster_name, file_name):
-    """
-    Determine if the provided file name is a URL location where the file is hosted. If it is a URL, return
-    a URL stream that can be used to retrieve the file from the hosted location.
-    :param cluster_name: of the coherence cluster being discovered
-    :param file_name: of the file to be tested as a URL
-    :return: True if the file is hosted at a URL: URL file handle for the archive file to retrieve the file
-    """
-    url = None
-    try:
-        uri = URI(file_name)
-        if 'http' == uri.getScheme():
-            url = uri.toURL()
-    except (URISyntaxException, MalformedURLException), e:
-        _logger.warning('WLSDPLY-06321', cluster_name, file_name, e.getLocalizedMessage)
-        return False, None
-
-    return True, url
diff --git a/core/src/main/python/wlsdeploy/tool/discover/discoverer.py b/core/src/main/python/wlsdeploy/tool/discover/discoverer.py
@@ -1,13 +1,16 @@
 """
-Copyright (c) 2017, 2020, Oracle Corporation and/or its affiliates.  All rights reserved.
+Copyright (c) 2017, 2020, Oracle Corporation and/or its affiliates.
 Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl.
 """
 import os
 
+from java.net import URI
+from java.net import URISyntaxException
+from java.net import MalformedURLException
+
 from oracle.weblogic.deploy.aliases import AliasException
 from oracle.weblogic.deploy.discover import DiscoverException
 from oracle.weblogic.deploy.util import PyOrderedDict as OrderedDict
-from oracle.weblogic.deploy.util import PyWLSTException
 from oracle.weblogic.deploy.util import StringUtils
 
 from wlsdeploy.aliases.aliases import Aliases
@@ -723,6 +726,29 @@ def _massage_online_folders(self, lsc_folders):
         return folder_list
 
 
+    def _get_from_url(self, owner_name, file_name):
+        """
+        Determine if the provided file name is a URL location where the file is hosted. If it is a URL, return
+        a URL stream that can be used to retrieve the file from the hosted location.
+        :param owner_name: of the file being discovered
+        :param file_name: of the file to be tested as a URL
+        :return: True if the file is hosted at a URL: URL file handle for the archive file to retrieve the file, or path
+                 from file name
+        """
+        url = None
+        path = None
+        try:
+            uri = URI(file_name)
+            if 'http' == uri.getScheme():
+                url = uri.toURL()
+            elif 'file' == uri.getScheme() or uri.getScheme() is None:
+                path = uri.getPath()
+        except (URISyntaxException, MalformedURLException), e:
+            _logger.warning('WLSDPLY-06321', owner_name, file_name, e.getLocalizedMessage)
+            return False, None, None
+
+        return True, url, path
+
 def add_to_model_if_not_empty(dictionary, entry_name, entry_value):
     """
     Helper method for discover to add a non-empty value to the dictionary with the provided entry-name
diff --git a/core/src/main/python/wlsdeploy/tool/discover/jms_resources_discoverer.py b/core/src/main/python/wlsdeploy/tool/discover/jms_resources_discoverer.py
@@ -1,8 +1,12 @@
 """
-Copyright (c) 2017, 2019, Oracle Corporation and/or its affiliates.  All rights reserved.
+Copyright (c) 2017, 2020, Oracle Corporation and/or its affiliates.
 Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl.
 """
+from java.io import File
+from java.lang import IllegalArgumentException
+
 from oracle.weblogic.deploy.util import PyOrderedDict as OrderedDict
+from oracle.weblogic.deploy.util import WLSDeployArchiveIOException
 
 from wlsdeploy.aliases import model_constants
 from wlsdeploy.aliases.location_context import LocationContext
@@ -244,6 +248,11 @@ def _get_foreign_servers(self, location):
                 result[server] = OrderedDict()
                 location.add_name_token(name_token, server)
                 self._populate_model_parameters(result[server], location)
+                if model_constants.CONNECTION_URL in result[server]:
+                    _logger.finer('WLSDPLY-06494', server, class_name=_class_name, method_name=_method_name)
+                    result[server][model_constants.CONNECTION_URL] = \
+                        self._add_foreign_server_binding(server, model_constants.CONNECTION_URL,
+                                                         result[server][model_constants.CONNECTION_URL])
                 wlst_subfolders = self._find_subfolders(location)
                 if wlst_subfolders is not None:
                     for wlst_subfolder in wlst_subfolders:
@@ -371,3 +380,32 @@ def _get_foreign_server_properties(self, location):
         location.pop_location()
         _logger.exiting(class_name=_class_name, method_name=_method_name, result=subfolder_result)
         return model_subfolder_name, subfolder_result
+
+    def _add_foreign_server_binding(self, server_name, model_name, model_value):
+        """
+        If the foreign server connection URL contains a file URI, then collect the file into the archive.
+        The attribute value will be updated to point to the location where the file will
+        exist after the archive file is deployed.
+        :param model_name: name of the foreign server connection URL name attribute
+        :param model_value: containing the foreign connection URI value
+        :return: updated foreign server file value or original URL
+        """
+        _method_name = '_add_foreign_server_binding'
+        _logger.entering(server_name, model_name, model_value, class_name=_class_name, method_name=_method_name)
+        new_name = model_value
+        if model_value is not None:
+            success, _, file_name = self._get_from_url('Foreign Server ' + server_name + ' Connection URL', model_value)
+            archive_file = self._model_context.get_archive_file()
+            if success and file_name is not None:
+                file_name = self._convert_path(file_name)
+                _logger.finer('WLSDPLY-06495', server_name, file_name, class_name=_class_name, method_name=_method_name)
+                try:
+                    new_name = archive_file.addForeignServerFile(server_name, File(file_name))
+                    _logger.info('WLSDPLY-06492', server_name, file_name, new_name, class_name=_class_name,
+                                 method_name=_method_name)
+                except (IllegalArgumentException, WLSDeployArchiveIOException), wioe:
+                    _logger.warning('WLSDPLY-06493', server_name, file_name, wioe.getLocalizedMessage())
+                    new_name = None
+
+        _logger.exiting(class_name=_class_name, method_name=_method_name, result=new_name)
+        return new_name
diff --git a/core/src/main/resources/oracle/weblogic/deploy/aliases/category_modules/JMSSystemResource.json b/core/src/main/resources/oracle/weblogic/deploy/aliases/category_modules/JMSSystemResource.json
@@ -1,5 +1,5 @@
 {
-      "copyright": "Copyright (c) 2017, 2019, Oracle Corporation and/or its affiliates.  All rights reserved.",
+      "copyright": "Copyright (c) 2017, 2020, Oracle Corporation and/or its affiliates.",
       "license": "Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl",
       "wlst_type": "JMSSystemResource${:s}",
       "child_folders_type": "multiple",
@@ -271,8 +271,8 @@
                                     }
                               },
                               "attributes": {
-                                    "ConnectionURL":                     [ {"version": "[10,12.2.1.4)",      "wlst_mode": "both", "wlst_name": "ConnectionURL",                         "wlst_path": "WP001", "value": {"default": "None"                                          }, "wlst_type": "string",   "restart_required": "true" } ,
-                                                                           {"version": "[12.2.1.4,)",        "wlst_mode": "both", "wlst_name": "ConnectionURL",                         "wlst_path": "WP001", "value": {"default": "None"                                          }, "wlst_type": "string"    } ],
+                                    "ConnectionURL":                     [ {"version": "[10,12.2.1.4)",      "wlst_mode": "both", "wlst_name": "ConnectionURL",                         "wlst_path": "WP001", "value": {"default": "None"                                          }, "wlst_type": "string",   "uses_path_tokens": "true", "restart_required": "true" } ,
+                                                                           {"version": "[12.2.1.4,)",        "wlst_mode": "both", "wlst_name": "ConnectionURL",                         "wlst_path": "WP001", "value": {"default": "None"                                          }, "wlst_type": "string",   "uses_path_tokens": "true" } ],
                                     "DefaultTargetingEnabled":           [ {"version": "[10,)",              "wlst_mode": "both", "wlst_name": "DefaultTargetingEnabled",               "wlst_path": "WP001", "value": {"default": "None"                                          }, "wlst_type": "boolean",  "restart_required": "true" } ],
                                     "InitialContextFactory":             [ {"version": "[10,)",              "wlst_mode": "both", "wlst_name": "InitialContextFactory",                 "wlst_path": "WP001", "value": {"default": "${None:weblogic.jndi.WLInitialContextFactory}" }, "wlst_type": "string"    } ],
                                     "JNDIPropertiesCredentialEncrypted": [ {"version": "[10,)",              "wlst_mode": "both", "wlst_name": "JNDIPropertiesCredentialEncrypted",     "wlst_path": "WP001", "value": {"default": "None"                                          }, "wlst_type": "password", "get_method": "GET" } ],
diff --git a/core/src/main/resources/oracle/weblogic/deploy/messages/wlsdeploy_rb.properties b/core/src/main/resources/oracle/weblogic/deploy/messages/wlsdeploy_rb.properties
@@ -566,8 +566,7 @@ WLSDPLY-06317=Added Coherence Cluster {0} cache configuration file from URL loca
 WLSDPLY-06318=Unable to add Coherence Cluster {0} persistence directory {1} type {2} to archive file : {3}
 WLSDPLY-06319=Added Coherence Cluster {0} cache configuration file from location {1} to archive file with name {2}
 WLSDPLY-06320=Added Coherence Cluster {0} persistence directory {1} type {2} to archive file
-WLSDPLY-06321=Unable to access Coherence Cluster {0} cache configuration file {1} and will not add the file to \
-  the archive : {2}
+WLSDPLY-06321=Unable to access {0} file {1} and will not add the file to the archive : {2}
 WLSDPLY-06322=Skipping {0} Coherence Cluster System Resource {1}
 
 # common_resources_discoverer.py
@@ -672,6 +671,10 @@ WLSDPLY-06488=Key missing for Foreign JNDI Property Foreign Server {0} to {1}. T
 WLSDPLY-06489=Adding JNDI Property with name {0} to {1}
 WLSDPLY-06490=Skipping {0} JMS Server {1}
 WLSDPLY-06491=Skipping {0} JMS System Resource {1}
+WLSDPLY-06492=Unable to add Foreign Server {0} bindings file {1} to archive file : {2}
+WLSDPLY-06493=Added Foreign Server {0} bindings file from location {1} to archive file with name {2}
+WLSDPLY-06494=Check for Foreign Server {0} connection URL binding file
+WLSDPLY-06495=Add Connection URL file {1} to archive file for Foreign Server {0}
 
 # topology_discoverer.py
 WLSDPLY-06600=Discovering domain model topology
