Support Print Output to Console in HIP-RA-X. WIP to capture/assert logs in unit test

Author: softwareengineerprogrammer

src/hip_ra_x/hip_ra_x.py

@@ -27,6 +27,7 @@
 from geophires_x.Parameter import Parameter
 from geophires_x.Parameter import ParameterEntry
 from geophires_x.Parameter import ReadParameter
+from geophires_x.Parameter import boolParameter
 from geophires_x.Parameter import floatParameter
 from geophires_x.Parameter import intParameter
 from geophires_x.Parameter import strParameter
@@ -353,6 +354,15 @@ def parameter_dict_entry(param: Parameter) -> Parameter:
             )
         )
 
+        self.print_output_to_console = parameter_dict_entry(
+            boolParameter(
+                'Print Output to Console',
+                DefaultValue=True,
+                UnitType=Units.NONE,
+                ToolTipText='Whether to print output to the console ',
+            )
+        )
+
         # Output parameters
         self.reservoir_volume = self.OutputParameterDict[self.reservoir_volume.Name] = OutputParameter(
             Name='Reservoir Volume (reservoir)',
@@ -925,7 +935,7 @@ def render_scientific(p: Parameter) -> str:
         if self.html_output_file.Provided:
             # write the outputs to the output file as HTML and the screen as a table
             self.PrintOutputsHTML(case_data_inputs, case_data_results, self.html_output_file.value)
-        else:
+        elif self.print_output_to_console.value:
             # copy the output file to the screen
             with open(outputfile, encoding='UTF-8') as f:
                 content = f.readlines()  # store all output in one long list

tests/hip_ra_x_tests/test_hip_ra_x.py

@@ -53,6 +53,25 @@ def get_output_file_for_example(example_file: Path):
                     # TODO
                     # self.assertFileContentsEqual(expected_result_output_file_path, result.output_file_path)
 
+    def test_print_output_to_console(self):
+        example_files = self._list_test_files_dir(test_files_dir='./examples')
+        assert len(example_files) > 0  # test integrity check - no files means something is misconfigured
+
+        params = {
+            'Reservoir Temperature': 250.0,
+            'Rejection Temperature': 60.0,
+            'Reservoir Porosity': 10.0,
+            'Reservoir Area': 55.0,
+            'Reservoir Thickness': 0.25,
+            'Reservoir Life Cycle': 25,
+            'Print Output to Console': False,
+        }
+
+        result: HipRaResult = HipRaXClient().get_hip_ra_result(HipRaInputParameters(params))
+        self.assertIsNotNone(result)
+
+        # FIXME WIP verify output not printed to console
+
     def test_result_parsing_1(self):
         result = HipRaResult(self._get_test_file_path('hip-result_example-1.out'))
         self.assertIsNotNone(result.result)