Merge branch 'add_remove_test_for_cmake' into 'master'

TEST: Validate that `opt-remove` works for cmake

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

Author: William McLendon

CHANGELOG.md

@@ -33,6 +33,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 #### Fixed
 #### Security
 #### Internal
+- Add test to verify that `opt-remove` also works to remove variables added
+  by `opt-set-cmake-var`.
 - Changed `VariableFieldData` so that it won't use `dataclasses` to keep our
   Python compatibilty to 3.6 (`dataclasses` requires 3.7 and higher).
 #### Todo (for Unreleased)

src/setprogramoptions/unittests/files_ini/config_test_setprogramoptions.ini

@@ -156,6 +156,17 @@ opt-set-cmake-var CMAKE_F90_FLAGS STRING: "${CMAKE_F90_FLAGS|CMAKE} -baz"
 use TEST_VAR_EXPANSION_UPDATE_01
 opt-set-cmake-var CMAKE_CXX_FLAGS STRING: "${CMAKE_CXX_FLAGS|CMAKE} -bif"
 
+
 [TEST_STRING_DOUBLE_QUOTES]
-opt-set-cmake-var Panzer_FADTYPE STRING: Sacado::Fad::DFad<RealType>
-opt-set-cmake-var DART_TESTING_TIMEOUT STRING: "600"
+opt-set-cmake-var FOO STRING: foo::bar::baz<Type>
+opt-set-cmake-var BAR STRING: "600"
+
+
+[TEST_CMAKE_VAR_REMOVE]
+# Test whether or not opt-remove works for a cmake var
+opt-set-cmake-var FOO_TEST: "FOO"
+opt-set-cmake-var BAR_TEST: "BAR"
+opt-set-cmake-var FOO     : "BAZ"
+# this should remove `FOO_TEST` from the option list so we will only
+# have `BAR_TEST` and `FOO` left.
+opt-remove FOO_TEST

src/setprogramoptions/unittests/test_SetProgramOptionsCMake.py

@@ -446,8 +446,8 @@ def test_SetProgramOptionsCMake_test_STRING_value_surrounded_by_double_quotes(se
         print("Section  : {}".format(section))
 
         option_list_expect = [
-            '-DPanzer_FADTYPE:STRING="Sacado::Fad::DFad<RealType>"',
-            '-DDART_TESTING_TIMEOUT:STRING="600"',
+            '-DFOO:STRING="foo::bar::baz<Type>"',
+            '-DBAR:STRING="600"'
         ]
         option_list_actual = parser.gen_option_list(section, generator="bash")
 
@@ -467,6 +467,32 @@ def test_SetProgramOptionsCMake_test_STRING_value_surrounded_by_double_quotes(se
         print("OK")
         return 0
 
+    def test_SetProgramOptionsCMake_opt_remove(self):
+        """
+        This test validates that `opt-remove` will correctly remove a CMake var
+        that was created using `opt-set-cmake-var`
+        """
+        parser = self._create_standard_parser()
+
+        print("-----[ TEST BEGIN ]----------------------------------------")
+        section = "TEST_CMAKE_VAR_REMOVE"
+        print("Section  : {}".format(section))
+        option_list_bash_actual = parser.gen_option_list('TEST_CMAKE_VAR_REMOVE', 'bash')
+        option_list_bash_expect = [ '-DBAR_TEST=BAR', '-DFOO=BAZ' ]
+        self.assertListEqual(option_list_bash_expect, option_list_bash_actual)
+        print("-----[ TEST END ]------------------------------------------")
+
+        print("-----[ TEST BEGIN ]----------------------------------------")
+        section = "TEST_CMAKE_VAR_REMOVE"
+        print("Section  : {}".format(section))
+        option_list_cmake_fragment_actual = parser.gen_option_list('TEST_CMAKE_VAR_REMOVE', 'cmake_fragment')
+        option_list_cmake_fragment_expect = [ 'set(BAR_TEST BAR)', 'set(FOO BAZ)' ]
+        self.assertListEqual(option_list_cmake_fragment_expect, option_list_cmake_fragment_actual)
+        print("-----[ TEST END ]------------------------------------------")
+
+        print("OK")
+        return 0
+
     def _create_standard_parser(
         self, filename=DEFAULT_VALUE(), debug_level=5, ece_level=4, ece_compact=False
     ):