Merge branch 'TRILFRAME-120' into 'master'

TRILFRAME-120: Fix SetProgramOptions bash generation

See merge request trilinos-devops-consolidation/code/SetProgramOptions!13

Author: e10harvey

CHANGELOG.md

@@ -44,6 +44,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 #### Deprecated
 #### Removed
 #### Fixed
+- Bash generation handling of the FORCE flag. See TRILFRAME-120 for details.
 #### Security
 #### Internal
 - Add test to verify that `opt-remove` also works to remove variables added
@@ -91,5 +92,3 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 #### Added
 - Initial version release. From now on changes should be noted in the
   CHANGELOG.
-
-

src/setprogramoptions/SetProgramOptionsCMake.py

@@ -20,8 +20,8 @@
 ``-DVAR_NAME:BOOL=ON`` using the ``SetProgramOptions`` method ``gen_option_list``
 with the ``bash`` generator.
 
-In the case of bash command entries the ``FORCE`` and ``PARENT_SCOPE`` optional
-parameters are ignored.
+In the case of bash command entries the ``PARENT_SCOPE`` optional parameter is
+ignored.
 
 See CMake documentation on the `set() <https://cmake.org/cmake/help/latest/command/set.html>`_
 command for more information on how fragment file entries are generated.
@@ -213,6 +213,13 @@ def _program_option_handler_opt_set_cmake_var_bash(self, params, value) -> str:
             params.append(":" + param_opts['TYPE'])
 
         # Cache 'known' CMake vars here.
+        try:
+            if self._var_formatter_cache[varname] is not None and not param_opts['FORCE']:
+                # Do not add this to the output unless it's a forceful set
+                return None
+        except:
+            pass
+
         self._var_formatter_cache[varname] = value
 
         return self._generic_program_option_handler_bash(params, value)

src/setprogramoptions/unittests/files_ini/config_test_setprogramoptions.ini

@@ -143,15 +143,21 @@ opt-set-cmake-var CMAKE_CXX_FLAGS STRING : "${LDFLAGS|ENV} -foo"
 [TEST_VAR_EXPANSION_UPDATE_01]
 opt-set cmake
 use TEST_VAR_EXPANSION_COMMON
-opt-set-cmake-var CMAKE_CXX_FLAGS STRING: "${CMAKE_CXX_FLAGS|CMAKE} -bar"
+opt-set-cmake-var CMAKE_CXX_FLAGS STRING FORCE : "${CMAKE_CXX_FLAGS|CMAKE} -bar"
 
 [TEST_VAR_EXPANSION_UPDATE_02]
 use TEST_VAR_EXPANSION_UPDATE_01
 opt-set-cmake-var CMAKE_F90_FLAGS STRING: "${CMAKE_F90_FLAGS|CMAKE} -baz"
 
 [TEST_VAR_EXPANSION_UPDATE_03]
 use TEST_VAR_EXPANSION_UPDATE_01
-opt-set-cmake-var CMAKE_CXX_FLAGS STRING: "${CMAKE_CXX_FLAGS|CMAKE} -bif"
+opt-set-cmake-var CMAKE_CXX_FLAGS STRING FORCE : "${CMAKE_CXX_FLAGS|CMAKE} -bif"
+
+[TEST_VAR_EXPANSION_UPDATE_04]
+opt-set cmake
+use TEST_VAR_EXPANSION_COMMON
+# Test (return None) at SetProgramOptionsCMake.py:_program_option_handler_opt_set_cmake_var_bash:188
+opt-set-cmake-var CMAKE_CXX_FLAGS STRING : "${LDFLAGS|ENV} -foobar"
 
 
 [TEST_STRING_DOUBLE_QUOTES]

src/setprogramoptions/unittests/test_SetProgramOptionsCMake.py

@@ -219,6 +219,27 @@ def test_SetProgramOptionsCMake_gen_option_list_bash_expandvars(self):
         option_list_actual = parser.gen_option_list(section, generator="bash")
         pprint(option_list_actual, width=200)
 
+        self.assertListEqual(option_list_expect, option_list_actual)
+        print("-----[ TEST END ]------------------------------------------")
+        print("OK")
+
+        print("-----[ TEST BEGIN ]----------------------------------------")
+        section = "TEST_VAR_EXPANSION_UPDATE_04"
+        print("Section  : {}".format(section))
+
+        self._execute_parser(parser, section)
+
+        print("-" * 40)
+        print("Option List")
+        print("-" * 40)
+        option_list_expect = [
+            'cmake',
+            '-DCMAKE_CXX_FLAGS:STRING="${LDFLAGS} -foo"',
+        ]
+
+        option_list_actual = parser.gen_option_list(section, generator="bash")
+        pprint(option_list_actual, width=200)
+
         self.assertListEqual(option_list_expect, option_list_actual)
         print("-----[ TEST END ]------------------------------------------")
         print("OK")
@@ -338,7 +359,7 @@ def test_SetProgramOptionsCMake_gen_option_list_cmake_fragment_expandvars(self):
 
         option_list_expect = [
             'set(CMAKE_CXX_FLAGS "$ENV{LDFLAGS} -foo" CACHE STRING "from .ini configuration")',
-            'set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -bar" CACHE STRING "from .ini configuration")',
+            'set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -bar" CACHE STRING "from .ini configuration" FORCE)',
             'set(CMAKE_F90_FLAGS "${CMAKE_F90_FLAGS} -baz" CACHE STRING "from .ini configuration")'
         ]
 
@@ -350,8 +371,40 @@ def test_SetProgramOptionsCMake_gen_option_list_cmake_fragment_expandvars(self):
         self.assertListEqual(option_list_expect, option_list_actual)
 
         print("-----[ TEST END ]------------------------------------------")
+        print("OK")
 
+        # The following TEST_VAR_EXPANSION_UPDATE_04 does not increase coverage
+        # but is here to illustrate the correctness issue reported in
+        # TRILFRAME-120. To compare the option_list_expect below to that
+        # of the option_list_expect for the bash generator, see the
+        # TEST_VAR_EXPANSION_UPDATE_04 test above in
+        # test_SetProgramOptionsCMake_gen_option_list_bash_expandvars.
+        print("-----[ TEST BEGIN ]----------------------------------------")
+        section = "TEST_VAR_EXPANSION_UPDATE_04"
+        print("Section  : {}".format(section))
+
+        # parse a section
+        self._execute_parser(parser, section)
+
+        parser.gen_option_list(section, generator="cmake_fragment")
+
+        option_list_expect = [
+            # Only the first set with "-foo" sticks in the cmake cache.
+            # If the second set with "-foobar" used FORCE, it would stick.
+            'set(CMAKE_CXX_FLAGS "$ENV{LDFLAGS} -foo" CACHE STRING "from .ini configuration")',
+            'set(CMAKE_CXX_FLAGS "$ENV{LDFLAGS} -foobar" CACHE STRING "from .ini configuration")',
+        ]
+
+        option_list_actual = parser.gen_option_list(section, generator="cmake_fragment")
+
+        print("Expected Output:\n{}\n".format("\n".join(option_list_expect)))
+        print("Actual Output:\n{}\n".format("\n".join(option_list_actual)))
+
+        self.assertListEqual(option_list_expect, option_list_actual)
+
+        print("-----[ TEST END ]------------------------------------------")
         print("OK")
+
         return 0
 
     def test_SetProgramOptionsCMake_param_order_01(self):