TRILFRAME-120-A: Minor cleanup pass

Author: William McLendon

SetProgramOptions.wpr

@@ -90,8 +90,7 @@ proj.launch-config = {loc('../../coding/pyExampleLib/configparser/configparser-e
         'ustom',
         (u'',
          'launch-5Gyw4cvA0PytPLLy'))}
-proj.main-file = loc('examples/example-01.py')
+proj.main-file = loc('exec-example-SetProgramOptions.py')
 testing.auto-test-file-specs = (('regex',
-                                 'setprogramoptions\\\\unittests\\\\test_.*'\
-                                 '\\.py'),)
+                                 'unittests\\\\test_.*\\.py'),)
 testing.test-framework = {None: ':internal pytest'}

src/setprogramoptions/SetProgramOptionsCMake.py

@@ -222,12 +222,13 @@ def _program_option_handler_opt_set_cmake_var_bash(self, params: list, value: st
         params = params[1 : 4]
         param_opts = self._helper_opt_set_cmake_var_parse_parameters(params)
 
-        # PARENT_SCOPE (i.e., type-1 non-cached operations) should not be
+        # Type-1 (non-cached / PARENT_SCOPE / non-typed) entries should not be
         # written to the set of Bash parameters.
         if param_opts['VARIANT'] == 1:
             msg = f"bash generator - `{varname}={value}` skipped because"
             msg += f" it is a non-cached (type-1) operation."
-            msg += f" To generate a bash arg for this consider adding FORCE or a TYPE."
+            msg += f" To generate a bash arg for this consider adding FORCE or a TYPE"
+            msg += f" and remove PARENT_SCOPE if it exists."
             self.exception_control_event("WARNING", ValueError, message=msg)
             return None
 
@@ -246,7 +247,6 @@ def _program_option_handler_opt_set_cmake_var_bash(self, params: list, value: st
 
         # If the type is provided then include the `:<typename>` argument.
         # Note: CMake defaults to STRING if not provided.
-        #if param_opts['VARIANT'] == 2 and param_opts['TYPE'] is not None:           # DEADCODE: this can't be false now
         params.append(":" + param_opts['TYPE'])
 
         # Save variable to the cache of 'known'/'set' cmake variables
@@ -376,12 +376,15 @@ def _helper_opt_set_cmake_var_parse_parameters(self, params: list):
         """
         default_cache_var_type = "STRING"
 
-        output = {'FORCE': False, 'PARENT_SCOPE': False, 'TYPE': None}
+        output = {'FORCE': False, 'PARENT_SCOPE': False, 'TYPE': None, 'VARIANT': None}
 
         for option in params[: 4]:
             if option == "FORCE":
                 output['FORCE'] = True
                 # If FORCE is found but we have no TYPE yet, set to the default.
+                # TODO: Should we be setting the default to STRING here when FORCE
+                #       is provided with no explicit type? Future CMake versions might
+                #       someday change the default which would possibly break this?
                 if output['TYPE'] is None:
                     output['TYPE'] = default_cache_var_type
             elif option == "PARENT_SCOPE":
@@ -395,6 +398,7 @@ def _helper_opt_set_cmake_var_parse_parameters(self, params: list):
         if output['FORCE'] and output['PARENT_SCOPE']:
             msg = "ERROR: CMake does not allow `FORCE` and `PARENT_SCOPE` to both be used."
             self.exception_control_event("CATASTROPHIC", ValueError, message=msg)
+
         # Case 2: PARENT_SCOPE and CACHE will cause a CMake warning
         #         and the value will include the cache entries as a list:
         #             `set(FOO "VAL" CACHE STRING "docstring" PARENT_SCOPE)`

src/setprogramoptions/unittests/files_ini/config_test_setprogramoptions.ini

@@ -65,12 +65,23 @@ opt-set-cmake-var CMAKE_VAR_E FORCE BOOL   : ON
 opt-set-cmake-var CMAKE_VAR_F BOOL PARENT_SCOPE : ON
 opt-set-cmake-var CMAKE_VAR_G PARENT_SCOPE BOOL : ON
 
+
 [TEST_CMAKE_CACHE_PARAM_TEST_02]
 # Validate what happens if there's a bad param.
 # Note: FORCE option will make this a CACHE var of type STRING
 opt-set-cmake-var CMAKE_VAR_A FORCE FOOBAR: ON
 
 
+# This section is to be used to ensure that PARENT_SCOPE
+# will force a type-1 (non-cache) var.
+# The entries with PARENT_SCOPE enabled should not appear
+# in generated BASH output.
+[TEST_CMAKE_PARENT_SCOPE_NOT_BASH]
+opt-set-cmake-var FOO_VAR_A PARENT_SCOPE        : FOO_VAL A
+opt-set-cmake-var FOO_VAR_B STRING PARENT_SCOPE : FOO_VAL B
+
+
+
 #
 # Sample Test Configurations
 #

src/setprogramoptions/unittests/test_SetProgramOptionsCMake.py

@@ -426,11 +426,10 @@ def test_SetProgramOptionsCMake_param_order_01(self):
 
         print("-----[ TEST BEGIN ]----------------------------------------")
         option_list_bash_expect = [
-            '-DCMAKE_VAR_A:STRING="ON"', #'-DCMAKE_VAR_B=ON',
+            '-DCMAKE_VAR_A:STRING="ON"',
             '-DCMAKE_VAR_C:BOOL=ON',
             '-DCMAKE_VAR_D:BOOL=ON',
-            '-DCMAKE_VAR_E:BOOL=ON',     #'-DCMAKE_VAR_F=ON;CACHE;BOOL;',
-                                         #'-DCMAKE_VAR_G=ON;CACHE;BOOL;'
+            '-DCMAKE_VAR_E:BOOL=ON',
         ]
 
         option_list_bash_actual = parser.gen_option_list(section, generator="bash")
@@ -474,7 +473,36 @@ def test_SetProgramOptionsCMake_param_order_02(self):
         print("-----[ TEST END ]------------------------------------------")
 
         print("OK")
-        return
+        return 0
+
+    def test_SetProgramOptionsCMake_bash_generator_ignores_PARENT_SCOPE(self):
+        """
+        Verify that the bash generator will not add a ``-D`` entry for a
+        ``opt-set-cmake-var`` that has the ``PARENT_SCOPE`` flag since that
+        will always force CMake to create a type-1 (non-cache) var assignment.
+        """
+        parser = self._create_standard_parser()
+
+        section = "TEST_CMAKE_PARENT_SCOPE_NOT_BASH"
+        print("Section  : {}".format(section))
+
+        print("-----[ TEST BEGIN ]----------------------------------------")
+        option_list_bash_expect = []
+        option_list_bash_actual = parser.gen_option_list(section, generator="bash")
+        self.assertListEqual(option_list_bash_expect, option_list_bash_actual)
+        print("-----[ TEST END ]------------------------------------------")
+
+        print("-----[ TEST BEGIN ]----------------------------------------")
+        option_list_cmake_fragment_expect = [
+            'set(FOO_VAR_A "FOO_VAL A" PARENT_SCOPE)',
+            'set(FOO_VAR_B "FOO_VAL B" CACHE STRING "from .ini configuration" PARENT_SCOPE)'
+        ]
+        option_list_cmake_fragment_actual = parser.gen_option_list(section, generator="cmake_fragment")
+        self.assertListEqual(option_list_cmake_fragment_expect, option_list_cmake_fragment_actual)
+        print("-----[ TEST END ]------------------------------------------")
+
+        print("OK")
+        return 0
 
     def test_SetProgramOptionsCMake_fail_on_FORCE_and_PARENT_SCOPE(self):
         """
@@ -646,4 +674,3 @@ def _execute_parser(self, parser, section):
 
 
 
-# TEST_CMAKE_CACHE_PARAM_TEST_02