Fix merge output and diff color, add tests (idaholab#19001)

dschwen · Oct 21, 2021 · 8eb9113 · 8eb9113
1 parent 4d81a65
commit 8eb9113
Show file tree

Hide file tree

Showing 10 changed files with 307 additions and 10 deletions.
diff --git a/framework/contrib/hit/main.cc b/framework/contrib/hit/main.cc
@@ -529,9 +529,6 @@ merge(int argc, char ** argv)
     return 1;
   }
 
-  std::string fname(flags.val("output"));
-  std::ofstream output(fname);
-
   hit::Node * root = nullptr;
   for (int i = 0; i < positional.size(); i++)
   {
@@ -545,7 +542,14 @@ merge(int argc, char ** argv)
       root = hit::parse(fname, input);
   }
 
-  output << root->render();
+  std::string fname(flags.val("output"));
+  if (fname == "-")
+    std::cout << root->render();
+  else
+  {
+    std::ofstream output(fname);
+    output << root->render();
+  }
 
   return 0;
 }
@@ -580,7 +584,7 @@ diff(int argc, char ** argv)
     return 1;
   }
 
-  bool use_color = flags.have("C");
+  bool use_color = flags.have("C") || flags.have("color");
 
   // terminal colors
   std::string color_red = use_color ? "\33[31m" : "";

diff --git a/test/tests/misc/hit_cli/gold/diff_color b/test/tests/misc/hit_cli/gold/diff_color
@@ -0,0 +1,57 @@
+Left hand side:
+    input1.i
+
+Right hand side:
+    input2.i
+
+Parameters removed left -> right:
+[31m
+        [BCs]
+          [left]
+            type = DirichletBC
+            value = 0
+            variable = u
+          []
+          [right]
+            type = NeumannBC
+            value = 0
+            variable = v
+          []
+        []
+        [Kernels]
+          [diff_u]
+            type = Diffusion
+            variable = u
+          []
+          [diff_v]
+            type = Diffusion
+            variable = v
+          []
+        []
+
+[39mParameters added left -> right:
+[32m
+        [Outputs]
+          [out]
+            type = Exodus
+          []
+        []
+        [PostProcessor]
+          [max]
+            mode = MAX
+            type = Calculation
+            value = 1
+          []
+          [min]
+            mode = min
+            type = Calculation
+            value = 1
+          []
+        []
+
+[39mParameters with differing values:
+
+    [33mPostProcessor/min2/value[34m (input1.i:34)[39m has differing values
+      '[31m0[39m' -> '[32m1[39m'
+
+
diff --git a/test/tests/misc/hit_cli/gold/diff_common b/test/tests/misc/hit_cli/gold/diff_common
@@ -0,0 +1,15 @@
+Left hand side:
+    input1.i
+
+Right hand side:
+    input2.i
+
+Common parameters:
+
+        [PostProcessor]
+          [min2]
+            mode = MIN
+            type = Calculation
+          []
+        []
+
diff --git a/test/tests/misc/hit_cli/gold/diff_vanilla b/test/tests/misc/hit_cli/gold/diff_vanilla
@@ -0,0 +1,57 @@
+Left hand side:
+    input1.i
+
+Right hand side:
+    input2.i
+
+Parameters removed left -> right:
+
+        [BCs]
+          [left]
+            type = DirichletBC
+            value = 0
+            variable = u
+          []
+          [right]
+            type = NeumannBC
+            value = 0
+            variable = v
+          []
+        []
+        [Kernels]
+          [diff_u]
+            type = Diffusion
+            variable = u
+          []
+          [diff_v]
+            type = Diffusion
+            variable = v
+          []
+        []
+
+Parameters added left -> right:
+
+        [Outputs]
+          [out]
+            type = Exodus
+          []
+        []
+        [PostProcessor]
+          [max]
+            mode = MAX
+            type = Calculation
+            value = 1
+          []
+          [min]
+            mode = min
+            type = Calculation
+            value = 1
+          []
+        []
+
+Parameters with differing values:
+
+    PostProcessor/min2/value (input1.i:34) has differing values
+      '0' -> '1'
+
+
diff --git a/test/tests/misc/hit_cli/gold/diff_verbose b/test/tests/misc/hit_cli/gold/diff_verbose
@@ -0,0 +1,33 @@
+Left hand side:
+    input1.i
+
+Right hand side:
+    input2.i
+
+Parameters removed left -> right:
+BCs/left/type (input1.i:19) is missing on the right.
+BCs/left/value (input1.i:21) is missing on the right.
+BCs/left/variable (input1.i:20) is missing on the right.
+BCs/right/type (input1.i:24) is missing on the right.
+BCs/right/value (input1.i:26) is missing on the right.
+BCs/right/variable (input1.i:25) is missing on the right.
+Kernels/diff_u/type (input1.i:8) is missing on the right.
+Kernels/diff_u/variable (input1.i:9) is missing on the right.
+Kernels/diff_v/type (input1.i:12) is missing on the right.
+Kernels/diff_v/variable (input1.i:13) is missing on the right.
+
+Parameters added left -> right:
+Outputs/out/type (input2.i:8) is missing on the left.
+PostProcessor/max/mode (input2.i:15) is missing on the left.
+PostProcessor/max/type (input2.i:14) is missing on the left.
+PostProcessor/max/value (input2.i:16) is missing on the left.
+PostProcessor/min/mode (input2.i:20) is missing on the left.
+PostProcessor/min/type (input2.i:19) is missing on the left.
+PostProcessor/min/value (input2.i:21) is missing on the left.
+
+Parameters with differing values:
+
+    PostProcessor/min2/value (input1.i:34) has differing values
+      '0' -> '1'
+
+
diff --git a/test/tests/misc/hit_cli/gold/diff_verbose_color b/test/tests/misc/hit_cli/gold/diff_verbose_color
@@ -0,0 +1,33 @@
+Left hand side:
+    input1.i
+
+Right hand side:
+    input2.i
+
+Parameters removed left -> right:
+[31m[31mBCs/left/type[34m (input1.i:19)[39m is missing on the right.
+[31mBCs/left/value[34m (input1.i:21)[39m is missing on the right.
+[31mBCs/left/variable[34m (input1.i:20)[39m is missing on the right.
+[31mBCs/right/type[34m (input1.i:24)[39m is missing on the right.
+[31mBCs/right/value[34m (input1.i:26)[39m is missing on the right.
+[31mBCs/right/variable[34m (input1.i:25)[39m is missing on the right.
+[31mKernels/diff_u/type[34m (input1.i:8)[39m is missing on the right.
+[31mKernels/diff_u/variable[34m (input1.i:9)[39m is missing on the right.
+[31mKernels/diff_v/type[34m (input1.i:12)[39m is missing on the right.
+[31mKernels/diff_v/variable[34m (input1.i:13)[39m is missing on the right.
+
+[39mParameters added left -> right:
+[32m[32mOutputs/out/type[34m (input2.i:8)[39m is missing on the left.
+[32mPostProcessor/max/mode[34m (input2.i:15)[39m is missing on the left.
+[32mPostProcessor/max/type[34m (input2.i:14)[39m is missing on the left.
+[32mPostProcessor/max/value[34m (input2.i:16)[39m is missing on the left.
+[32mPostProcessor/min/mode[34m (input2.i:20)[39m is missing on the left.
+[32mPostProcessor/min/type[34m (input2.i:19)[39m is missing on the left.
+[32mPostProcessor/min/value[34m (input2.i:21)[39m is missing on the left.
+
+[39mParameters with differing values:
+
+    [33mPostProcessor/min2/value[34m (input1.i:34)[39m has differing values
+      '[31m0[39m' -> '[32m1[39m'
+
+
diff --git a/test/tests/misc/hit_cli/gold/merge b/test/tests/misc/hit_cli/gold/merge
@@ -0,0 +1,51 @@
+#
+# This is not a valid MOOSE input, it is only used for testing the HIT command
+# line utility.
+#
+
+[Kernels]
+  [diff_u]
+    type = Diffusion
+    variable = u
+  []
+  [diff_v]
+    type = Diffusion
+    variable = v
+  []
+[]
+
+[BCs]
+  [left]
+    type = DirichletBC
+    variable = u
+    value = 0
+  []
+  [right]
+    type = NeumannBC
+    variable = v
+    value = 0
+  []
+[]
+
+[PostProcessor]
+  [min2]
+    type = Calculation
+    mode = MIN
+    value = 1
+  []
+  [max]
+    type = Calculation
+    mode = MAX
+    value = 1
+  []
+  [min]
+    type = Calculation
+    mode = min
+    value = 1
+  []
+[]
+[Outputs]
+  [out]
+    type = Exodus
+  []
+[]
diff --git a/test/tests/misc/hit_cli/hit_wrapper.py b/test/tests/misc/hit_cli/hit_wrapper.py
@@ -19,7 +19,8 @@
 with open(gold_file, 'rb') as f:
     gold = f.read()
 
-out = subprocess.check_output([hit] + hit_args)
+result = subprocess.run([hit] + hit_args, capture_output=True)
+out = result.stdout
 
 if out == gold:
     sys.exit(0)

diff --git a/test/tests/misc/hit_cli/input1.i b/test/tests/misc/hit_cli/input1.i
@@ -26,3 +26,11 @@
     value = 0
   []
 []
+
+[PostProcessor]
+  [min2]
+    type = Calculation
+    mode = MIN
+    value = 0
+  []
+[]
diff --git a/test/tests/misc/hit_cli/tests b/test/tests/misc/hit_cli/tests
@@ -3,7 +3,7 @@
   design = 'hit.md'
 
   [find]
-    requirement = 'The hit find command shall be able to find'
+    requirement = 'The `hit find` command shall be able to find'
     [parameter_exists]
       type = RunCommand
       command = './hit_wrapper.py gold/parameter_exists find Kernels/\*/variable input1.i input2.i'
@@ -29,13 +29,51 @@
 
     [additional_pattern]
       type = RunCommand
-      command = './hit_wrapper.py gold/additional_pattern find -p type=DirichletBC -- \*/value input1.i input2.i'
+      command = './hit_wrapper.py gold/additional_pattern find -p type=DirichletBC -- \*/value '
+                'input1.i input2.i'
       detail = 'parameters with additional pattern constraints,'
     []
     [additional_pattern_negative]
       type = RunCommand
-      command = './hit_wrapper.py gold/additional_pattern_negative find -p type!=DirichletBC -- \*/value input1.i input2.i'
-      detail = 'parameters with additional pattern constraints,'
+      command = './hit_wrapper.py gold/additional_pattern_negative find -p type!=DirichletBC -- '
+                '\*/value input1.i input2.i'
+      detail = 'parameters with additional pattern constraints.'
+    []
+  []
+
+  [merge]
+    type = RunCommand
+    command = './hit_wrapper.py gold/merge merge -output - input1.i input2.i'
+    requirement = 'The `hit merge` command shall be able to combine input files.'
+  []
+
+  [diff]
+    requirement = 'The `hit diff` command shall be able to'
+    [vanilla]
+      type = RunCommand
+      command = './hit_wrapper.py gold/diff_vanilla diff input1.i input2.i'
+      detail = 'show differences between input files,'
+    []
+    [color]
+      type = RunCommand
+      command = './hit_wrapper.py gold/diff_color diff -color input1.i input2.i'
+      detail = 'show differences between input files marked up using terminal colors,'
+    []
+    [verbose]
+      type = RunCommand
+      command = './hit_wrapper.py gold/diff_verbose diff -v input1.i input2.i'
+      detail = 'show differences between input files with verbose explanations,'
+    []
+    [verbose_color]
+      type = RunCommand
+      command = './hit_wrapper.py gold/diff_verbose_color diff -v -color input1.i input2.i'
+      detail = 'show differences between input files with verbose explanations marked up using '
+               'terminal colors,'
+    []
+    [common]
+      type = RunCommand
+      command = './hit_wrapper.py gold/diff_common diff -common input1.i input2.i'
+      detail = 'show common parameters/value pairs between input files,'
     []
   []
 []