Added a unit test for wko_filter

Author: rakillen

core/src/main/python/wlsdeploy/tool/util/filters/wko_filter.py

@@ -22,7 +22,7 @@
 from wlsdeploy.util import dictionary_utils
 
 _class_name = 'wko_filter'
-_logger = PlatformLogger('wlsdeploy.aliases')
+_logger = PlatformLogger('wlsdeploy.tool.util')
 
 
 def filter_model(model, model_context):

core/src/test/python/base_test.py

@@ -66,7 +66,7 @@ def _restore_logs(self):
 
     def _match(self, value, dictionary, *args):
         dictionary_value = self._traverse(dictionary, *args)
-        if dictionary_value != str(value):
+        if str(dictionary_value) != str(value):
             key = '/'.join(list(args))
             self.fail(key + ' equals ' + str(dictionary_value) + ', should equal ' + str(value))
 

core/src/test/python/wlsdeploy/tool/util/filters/wko_filter_test.py

@@ -0,0 +1,84 @@
+"""
+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.
+"""
+import os
+
+from base_test import BaseTestCase
+from wlsdeploy.aliases.model_constants import APPLICATION
+from wlsdeploy.aliases.model_constants import APP_DEPLOYMENTS
+from wlsdeploy.aliases.model_constants import AUTHENTICATION_PROVIDER
+from wlsdeploy.aliases.model_constants import CALCULATED_LISTEN_PORTS
+from wlsdeploy.aliases.model_constants import CLUSTER
+from wlsdeploy.aliases.model_constants import DEFAULT_AUTHENTICATOR
+from wlsdeploy.aliases.model_constants import DYNAMIC_SERVERS
+from wlsdeploy.aliases.model_constants import REALM
+from wlsdeploy.aliases.model_constants import SECURITY_CONFIGURATION
+from wlsdeploy.aliases.model_constants import TOPOLOGY
+from wlsdeploy.tool.util.filters import wko_filter
+from wlsdeploy.util.model_context import ModelContext
+from wlsdeploy.util.model_translator import FileToPython
+
+
+class WkoFilterTestCase(BaseTestCase):
+    _program_name = 'wko_filter_test'
+    _jta_cluster = 'JTACluster'
+    _jta_cluster_info_list = 'DeterminerCandidateResourceInfoList'
+    _provider_class_name = 'ProviderClassName'
+    _multi_version_app = 'MultiVersionApp'
+
+    def __init__(self, *args):
+        BaseTestCase.__init__(self, *args)
+        self.MODELS_DIR = os.path.join(self.TEST_CLASSES_DIR, 'prepare')
+        self.PREPARE_OUTPUT_DIR = os.path.join(self.TEST_OUTPUT_DIR, 'prepare')
+
+    def setUp(self):
+        BaseTestCase.setUp(self)
+        self._establish_directory(self.PREPARE_OUTPUT_DIR)
+
+    def testFilter(self):
+        """
+        Filter the model and verify the results
+        """
+        model_file = os.path.join(self.MODELS_DIR, 'wko-filter.yaml')
+        translator = FileToPython(model_file, use_ordering=True)
+        model = translator.parse()
+
+        # online attributes are in the model before filtering
+
+        jta_cluster = self._traverse(model, TOPOLOGY, CLUSTER, 'staticCluster', self._jta_cluster)
+        self.assertEqual(True, self._jta_cluster_info_list in jta_cluster,
+                         self._jta_cluster_info_list + " should be in " + self._jta_cluster + " before filtering")
+
+        authenticator = self._traverse(model, TOPOLOGY, SECURITY_CONFIGURATION, REALM, 'yourRealm',
+                                       AUTHENTICATION_PROVIDER, DEFAULT_AUTHENTICATOR, DEFAULT_AUTHENTICATOR)
+        self.assertEqual(True, self._provider_class_name in authenticator,
+                         self._provider_class_name + " should be in " + DEFAULT_AUTHENTICATOR + " before filtering")
+
+        my_app = self._traverse(model, APP_DEPLOYMENTS, APPLICATION, 'myApp')
+        self.assertEqual(True, self._multi_version_app in my_app,
+                         self._multi_version_app + " should be in \"myApp\" before filtering")
+
+        # Apply the filter
+
+        self._suspend_logs('wlsdeploy.tool.util')
+        model_context = ModelContext(self._program_name, {})
+        wko_filter.filter_model(model, model_context)
+        self._restore_logs()
+
+        # Dynamic clusters should have "CalculatedListenPorts" set to false
+
+        self._match(0, model, TOPOLOGY, CLUSTER, 'dynamicCluster', DYNAMIC_SERVERS, CALCULATED_LISTEN_PORTS)
+        self._match(0, model, TOPOLOGY, CLUSTER, 'dynamicCluster2', DYNAMIC_SERVERS, CALCULATED_LISTEN_PORTS)
+
+        # Online-only attributes should be removed from the model
+
+        jta_cluster = self._traverse(model, TOPOLOGY, CLUSTER, 'staticCluster', self._jta_cluster)
+        self._no_dictionary_key(jta_cluster, self._jta_cluster_info_list)
+
+        authenticator = self._traverse(model, TOPOLOGY, SECURITY_CONFIGURATION, REALM, 'yourRealm',
+                                       AUTHENTICATION_PROVIDER, DEFAULT_AUTHENTICATOR, DEFAULT_AUTHENTICATOR)
+        self._no_dictionary_key(authenticator, self._provider_class_name)
+
+        my_app = self._traverse(model, APP_DEPLOYMENTS, APPLICATION, 'myApp')
+        self._no_dictionary_key(my_app, self._multi_version_app)

core/src/test/resources/prepare/wko-filter.yaml

@@ -0,0 +1,59 @@
+domainInfo:
+    AdminUserName: weblogic
+    AdminPassword: 'welcome1'
+topology:
+    Name: DemoDomain
+    Cluster:
+        staticCluster:
+            CoherenceClusterSystemResource: DataGridConfig
+            JTACluster:
+                # remove, attribute is online only
+                DeterminerCandidateResourceInfoList: []
+                Notes: not here
+        dynamicCluster:
+            DynamicServers:
+                # add CalculatedListenPorts set to false
+                MaxDynamicClusterSize: 4
+                DynamicClusterSize: 3
+        dynamicCluster2:
+            DynamicServers:
+                MaxDynamicClusterSize: 4
+                # change CalculatedListenPorts to false
+                CalculatedListenPorts: true
+                DynamicClusterSize: 3
+    Server:
+        m1:
+            Cluster: staticCluster
+            ListenPort: 5001
+        m2:
+            Cluster: staticCluster
+            # string value should match numeric value
+            ListenPort: "5001"
+        m3:
+            Cluster: staticCluster
+            # this should cause a warning message
+            ListenPort: 5002
+
+    # confirm that model traversal deals with artificial type folders correctly
+    SecurityConfiguration:
+        Realm:
+            yourRealm:
+                AuthenticationProvider:
+                    DefaultAuthenticator:
+                        DefaultAuthenticator:
+                            ControlFlag: OPTIONAL
+                            # remove, attribute is online only
+                            ProviderClassName: 'com.defaultClass'
+                    'My custom IdentityAsserter':
+                        # confirm that model traversal allows unrecognized provider type,
+                        # such as this custom provider
+                        'com.custom.CustomIdentityAsserter':
+                            ControlFlag: SUFFICIENT
+                            UseDefaultUserNameMapper: true
+
+appDeployments:
+    Application:
+        myApp:
+            SourcePath: 'wlsdeploy/applications/sample-app.war'
+            # remove, attribute is online only
+            MultiVersionApp: false