Add unit test and integration test for compareModel (#833)

* Add unit test and integration test for compareModel

* update comments

* Fix compile error

* change script variable name

* copyright updates

Author: jshum2479

core/src/test/python/compare_model_test.py

@@ -523,6 +523,47 @@ def testCompareModel4(self):
 
         self.assertEqual(return_code, 0)
 
+    # This test is to ensure any behavior change does not impact WKO
+    def testCompareModel5(self):
+        _method_name = 'testCompareModel5'
+
+        _models_dir = self._resources_dir + '/compare'
+        _new_model_file = _models_dir + '/model-4-new.yaml'
+        _old_model_file = _models_dir + '/model-4-new.yaml'
+
+        _output_dir = os.path.join(self._results_dir, 'model-5')
+        if not os.path.isdir(_output_dir):
+            os.mkdir(_output_dir)
+
+        args_map = {
+            '-oracle_home': '/oracle',
+            '-output_dir': _output_dir,
+            '-trailing_arguments': [_new_model_file, _old_model_file]
+        }
+
+        try:
+            model_context = ModelContext('CompareModelTestCase', args_map)
+            differ = ModelFileDiffer(_new_model_file, _old_model_file, model_context, _output_dir)
+            return_code = differ.compare()
+            self.assertEqual(return_code, 0)
+
+            yaml_result = _output_dir + os.sep + 'diffed_model.yaml'
+            self.assertEqual(os.path.exists(yaml_result), False, "YAML result should not exist: " + yaml_result)
+
+            json_result = _output_dir + os.sep + 'diffed_model.json'
+            self.assertEqual(os.path.exists(json_result), False, "JSON result should not exist: " + json_result)
+
+            json_result = _output_dir + os.sep + 'compare_model_stdout'
+            self.assertEqual(os.path.exists(json_result), False, "compare_model.stdout result should not exist: " +
+                             json_result)
+
+        except (CompareException, PyWLSTException), te:
+            return_code = 2
+            self._logger.severe('WLSDPLY-05709', te.getLocalizedMessage(), error=te,
+                                class_name=self._program_name, method_name=_method_name)
+
+        self.assertEqual(return_code, 0)
+
 
 if __name__ == '__main__':
     unittest.main()

system-test/src/test/java/oracle/weblogic/deploy/integration/BaseTest.java

@@ -1,4 +1,4 @@
-// Copyright 2019, 2020, Oracle Corporation and/or its affiliates. 
+// Copyright 2019, 2021, Oracle Corporation and/or its affiliates.
 // Licensed under the Universal Permissive License v 1.0 as shown at http://oss.oracle.com/licenses/upl.
 
 package oracle.weblogic.deploy.integration;
@@ -30,6 +30,7 @@ public class BaseTest {
     private static String projectRoot = "";
     protected static String mwhome_12213 = "";
     protected static String createDomainScript = "";
+    protected static String compareModelScript = "";
     protected static String discoverDomainScript = "";
     protected static String updateDomainScript = "";
     protected static String deployAppScript = "";
@@ -54,6 +55,8 @@ protected static void initialize() {
         deployAppScript = getWDTScriptsHome() + FS + "deployApps.sh";
         encryptModelScript = getWDTScriptsHome() + FS + "encryptModel.sh";
         validateModelScript = getWDTScriptsHome() + FS + "validateModel.sh";
+        compareModelScript = getWDTScriptsHome() + FS + "compareModel.sh";
+
         domainParent12213 = "." + FS + "domains";
     }
 
@@ -183,6 +186,18 @@ protected void verifyModelFile(String modelFile) throws Exception {
         }
     }
 
+    protected void verifyFileExists(String filePath) throws Exception {
+      if (!Files.exists(Paths.get(filePath))) {
+        throw new Exception("File does not exists but should " + filePath);
+      }
+    }
+
+    protected void verifyFileDoesNotExists(String filePath) throws Exception {
+      if (Files.exists(Paths.get(filePath))) {
+        throw new Exception("File exists but should not " + filePath);
+      }
+    }
+
     protected void logTestBegin(String testMethodName) throws Exception {
         logger.info("=======================================");
         logger.info("BEGIN test " + testMethodName + " ...");

system-test/src/test/java/oracle/weblogic/deploy/integration/ITWdt.java

@@ -1,4 +1,4 @@
-// Copyright 2019, 2020, Oracle Corporation and/or its affiliates.
+// Copyright 2019, 2021, Oracle Corporation and/or its affiliates.
 // Licensed under the Universal Permissive License v 1.0 as shown at
 // http://oss.oracle.com/licenses/upl.
 
@@ -773,6 +773,31 @@ public void testNValidateModelWithoutVariableFile() throws Exception {
         logTestEnd(testMethodName);
     }
 
+    /**
+     * test compareModel.sh with only attribute difference.  The files existences test whether it impacts WKO operation
+     * @throws Exception - if any error occurs
+     */
+    @Test
+    public void testCompareModelRemoveAttribute() throws Exception {
+        String testMethodName = new Object() {}.getClass().getEnclosingMethod().getName();
+        logTestBegin(testMethodName);
+        Path tempPath = Files.createTempDirectory("wdt_temp_output");
+        String tmpdir = tempPath.toFile().getAbsolutePath();
+        tempPath.toFile().deleteOnExit();
+        String cmd = compareModelScript + " -oracle_home " + mwhome_12213 + " -output_dir " + tmpdir
+            + " " + getSampleModelFile("1-lessattribute") + " " +  getSampleModelFile("1");
+        logger.info("Executing command: " + cmd);
+        ExecResult result = ExecCommand.exec(cmd);
+        verifyResult(result, "compareModel.sh completed successfully");
+
+        String diffedModelYaml = tmpdir + File.separator + "diffed_model.yaml";
+        String compareModelStdout = tmpdir + File.separator + "compare_model_stdout";
+        verifyFileExists(compareModelStdout);
+        verifyFileDoesNotExists(diffedModelYaml);
+
+        logTestEnd(testMethodName);
+    }
+
     /**
      * test validateModel.sh with invalid model file
      * @throws Exception - if any error occurs

system-test/src/test/resources/simple-topology1-lessattribute.yaml

@@ -0,0 +1,39 @@
+domainInfo:
+    AdminUserName: weblogic
+    AdminPassword: welcome1
+    ServerStartMode: '@@PROP:SERVER_START_MODE@@'
+topology:
+    Name: '@@PROP:DOMAIN_NAME@@'
+    AdminServerName: '@@PROP:ADMIN_NAME@@'
+    ProductionModeEnabled: '@@PROP:PRODUCTION_MODE_ENABLED@@'
+    Cluster:
+        '@@PROP:CLUSTER_NAME@@':
+            ClientCertProxyEnabled: true
+            #FrontendHost: localhost
+            DynamicServers:
+                ServerTemplate: template1
+                CalculatedListenPorts: true
+                ServerNamePrefix: '@@PROP:MANAGED_SERVER_NAME_BASE@@'
+                DynamicClusterSize: '@@PROP:CONFIGURED_MANAGED_SERVER_COUNT@@'
+                MaxDynamicClusterSize: '@@PROP:CONFIGURED_MANAGED_SERVER_COUNT@@'
+    Server:
+        '@@PROP:ADMIN_NAME@@':
+            ListenPort: '@@PROP:ADMIN_PORT@@'
+            NetworkAccessPoint:
+                T3Channel:
+                    ListenAddress: None
+                    ListenPort: '@@PROP:T3_CHANNEL_PORT@@'
+                    PublicAddress: '@@PROP:T3_PUBLIC_ADDRESS@@'
+                    PublicPort: '@@PROP:T3_CHANNEL_PORT@@'
+    ServerTemplate:
+        template1:
+            ListenPort: '@@PROP:MANAGED_SERVER_PORT@@'
+appDeployments:
+    Application:
+        # Quote needed because of hyphen in string
+        'simple-app':
+            SourcePath: 'wlsdeploy/applications/simple-app.war'
+            Target: '@@PROP:CLUSTER_NAME@@'
+            ModuleType: war
+            StagingMode: nostage
+            PlanStagingMode: nostage