Merge branch 'is-structured-unit-tests' into 'develop-4.0'

Added unit test for application deployer _is_structured_app(), with fixes

See merge request weblogic-cloud/weblogic-deploy-tooling!1646

Author: robertpatrick

core/src/main/python/wlsdeploy/tool/deploy/applications_deployer.py

@@ -522,11 +522,12 @@ def __is_external_structured_app(self, model_source_path, combined_plan_path):
 
         result = False
         structured_app_dir = None
-        if not string_utils.is_empty(model_source_path) and not string_utils.is_empty(combined_plan_path):
+        if not string_utils.is_empty(model_source_path) and not string_utils.is_empty(combined_plan_path) \
+                and not WLSDeployArchive.isPathIntoArchive(model_source_path):
+
             source_path_to_compare = model_source_path.replace('\\', '/')
             plan_path_to_compare = combined_plan_path.replace('\\', '/')
 
-
             # Try to determine the structured application_directory as best we can.
             source_path_elements = source_path_to_compare.split('/')
             app_dir_index = -1
@@ -537,7 +538,7 @@ def __is_external_structured_app(self, model_source_path, combined_plan_path):
                     app_dir_index = idx
 
             if app_dir_index > 0:
-                fake_str_app_dir = '/'.join(source_path_elements[0:app_dir_index - 1])
+                fake_str_app_dir = '/'.join(source_path_elements[0:app_dir_index])
                 if plan_path_to_compare.startswith(fake_str_app_dir + '/'):
                     result = True
                     structured_app_dir = model_source_path[0:len(fake_str_app_dir)]

core/src/test/python/wlsdeploy/tool/deploy/applications_deployer_test.py

@@ -0,0 +1,118 @@
+"""
+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.
+"""
+
+from base_test import BaseTestCase
+from wlsdeploy.aliases.aliases import Aliases
+from wlsdeploy.aliases.wlst_modes import WlstModes
+from wlsdeploy.logging.platform_logger import PlatformLogger
+from wlsdeploy.tool.deploy import deployer_utils
+from wlsdeploy.util.model import Model
+from wlsdeploy.util.model_context import ModelContext
+
+
+class ApplicationsDeployerTest(BaseTestCase):
+    __class_name = 'ApplicationsDeployerTest'
+    __logger = PlatformLogger('wlsdeploy.deploy')
+
+    wls_version = '12.2.1.3'
+
+    def __init__(self, *args):
+        BaseTestCase.__init__(self, *args)
+
+    def setUp(self):
+        BaseTestCase.setUp(self)
+
+    def tearDown(self):
+        BaseTestCase.tearDown(self)
+
+    def test_is_structured_app(self):
+        """
+        Test that _is_structured_app() returns correct values for different deployments.
+        """
+        # structured app in the archive
+        self.check_is_structured_app('wlsdeploy/structuredApplications/myApp/app/my.war',
+                                     'wlsdeploy/structuredApplications/myApp/plan/Plan.xml',
+                                     True)
+
+        # not structured: need a parent dir under structuredApplications/myApp
+        self.check_is_structured_app('wlsdeploy/structuredApplications/my.war',
+                                     'wlsdeploy/structuredApplications/Plan.xml',
+                                     False)
+
+        # not structured: archive location for non-structured apps
+        self.check_is_structured_app('wlsdeploy/applications/myApp/app/my.war',
+                                     'wlsdeploy/applications/myApp/plan/Plan.xml',
+                                     False)
+
+        # structured app using plan dir
+        self.check_is_structured_app('wlsdeploy/structuredApplications/myApp/app/my.war',
+                                     'plan/Plan.xml',
+                                     True,
+                                     plan_dir='wlsdeploy/structuredApplications/myApp')
+
+        # not structured: app in archive, plan dir outside archive
+        self.check_is_structured_app('wlsdeploy/structuredApplications/myApp/app/my.war',
+                                     'plan/Plan.xml',
+                                     False,
+                                     plan_dir='/myApp')
+
+        # structured app outside archive
+        self.check_is_structured_app('/home/myApp/app/my.war',
+                                     '/home/myApp/plan/Plan.xml',
+                                     True)
+
+        # not structured: app outside archive no match
+        self.check_is_structured_app('/home/myApp/app/my.war',
+                                     '/home/myOtherApp/plan/Plan.xml',
+                                     False)
+
+        # structured app outside archive using plan dir
+        self.check_is_structured_app('/home/myApp/app/my.war',
+                                     'plan/Plan.xml',
+                                     True,
+                                     plan_dir='/home/myApp')
+
+        # not structured: app outside archive, plan dir doesn't match
+        self.check_is_structured_app('/home/myApp/app/my.war',
+                                     'plan/Plan.xml',
+                                     False,
+                                     plan_dir='/home/myOtherApp')
+
+        # not structured: app outside archive no plan path or dir
+        self.check_is_structured_app('/home/myApp/app/my.war',
+                                     None,
+                                     False)
+
+    def check_is_structured_app(self, source_path, plan_path, expected_result, plan_dir=None):
+        """
+        Check if the source path and plan path identify a structured application.
+        :param source_path: the source path to check
+        :param plan_path: the plan path to check
+        :param expected_result: the expected result, True or False
+        :param plan_dir: plan directory to check (optional)
+        """
+        app_dict = {
+            'SourcePath': source_path,
+            'PlanPath': plan_path,
+            'PlanDir': plan_dir
+        }
+
+        model_dict = {
+            'appDeployments': {
+                'Application': {
+                    'myApp': app_dict
+                }
+            }
+        }
+
+        model = Model(model_dict)
+        model_context = ModelContext(self.__class_name, {'-archive_file': 'fake.zip'})
+        aliases = Aliases(model_context=model_context, wlst_mode=WlstModes.OFFLINE, wls_version=self.wls_version)
+        applications_deployer = deployer_utils.get_applications_deployer(model, model_context, aliases)
+
+        result, structured_app_dir = applications_deployer._is_structured_app(app_dict)
+        self.assertEqual(expected_result, result, '_is_structured_app() should return ' + str(expected_result)
+                         + ' for source path ' + str(source_path) + ', plan path ' + str(plan_path)
+                         + ', and plan dir ' + str(plan_dir))