Cleaning up examples

Author: William McLendon

.github/workflows/test-driver-core.yml

@@ -46,7 +46,6 @@ jobs:
           source ${{ env.venv-name }}/bin/activate
           echo "VIRTUAL_ENV = ${VIRTUAL_ENV}"
           cd source
-          # python3 -m pip install wheel configparserenhanced @ git+https://github.com/sandialabs/ConfigParserEnhanced.git@master#egg=configparserenhanced
           python3 -m pip install wheel -r requirements.txt -r requirements-test.txt -r doc/requirements.txt
           #ls -ltrhF
 
@@ -68,18 +67,39 @@ jobs:
         with:
           path: source
 
-      - name: Execute
+      - name: Execute Unit Tests
         run: |
           source ${{ env.venv-name }}/bin/activate
+          echo "VIRTUAL_ENV = ${VIRTUAL_ENV}"
           cd source
           python3 -m pytest --version
-          #ls -ltrhF
-          echo "VIRTUAL_ENV = ${VIRTUAL_ENV}"
           python3 -m pytest --cov=setprogramoptions --cov-report=term --cov-report=html:${{ github.workspace }}/htmlcov --cov-config=.coveragerc
-          echo "htmlcov"
           ls -ltrhF ${{ github.workspace }}/htmlcov
 
-      - name: Save Artifacts
+      - name: Test Installation
+        run: |
+            source ${{ env.venv-name }}/bin/activate
+            echo "VIRTUAL_ENV = ${VIRTUAL_ENV}"
+            cd source
+            python3 -m pip install .
+
+      - name: Test Examples
+        run: |
+            source ${{ env.venv-name }}/bin/activate
+            echo "VIRTUAL_ENV = ${VIRTUAL_ENV}"
+            cd source/examples
+            python3 ./example-01.py
+            python3 ./example-02.py
+            python3 ./example-03.py
+
+      - name: Test Uninstaller
+        run: |
+            source ${{ env.venv-name }}/bin/activate
+            echo "VIRTUAL_ENV = ${VIRTUAL_ENV}"
+            cd source
+            python3 -m pip uninstall -y setprogramoptions
+
+      - name: Save Coverage Artifacts
         uses: actions/upload-artifact@v2
         with:
           name: coverage

examples/example-01.log

@@ -0,0 +1,5 @@
+--------------------------------------------------------------------------------
+- example-01.py
+--------------------------------------------------------------------------------
+ls -l -t -r --time-style="+%Y-%m-%d %H:%M:%S"
+Done

examples/example-01.py

@@ -1,8 +1,11 @@
 #!/usr/bin/env python3
 # -*- mode: python; py-indent-offset: 4; py-continuation-offset: 4 -*-
-
+from pathlib import Path
 import setprogramoptions
 
+print(80*"-")
+print(f"- {Path(__file__).name}")
+print(80*"-")
 
 filename = "example-01.ini"
 popts = setprogramoptions.SetProgramOptions(filename)

examples/example-02.ini

@@ -11,9 +11,9 @@ opt-set -G : Ninja
 opt-set -G : "Unix Makefiles"
 
 [MYPROJ_OPTIONS]
-opt-set-cmake-var  MYPROJ_CXX_FLAGS                         : "-O0 -fopenmp"
-opt-set-cmake-var  MYPROJ_ENABLE_OPTION_A BOOL FORCE        : ON
-opt-set-cmake-var  MYPROJ_ENABLE_OPTION_B BOOL PARENT_SCOPE : ON
+opt-set-cmake-var  MYPROJ_CXX_FLAGS       STRING       : "-O0 -fopenmp"
+opt-set-cmake-var  MYPROJ_ENABLE_OPTION_A BOOL   FORCE : ON
+opt-set-cmake-var  MYPROJ_ENABLE_OPTION_B BOOL         : ON
 
 [MYPROJ_SOURCE_DIR]
 opt-set /path/to/source/dir

examples/example-02.log

@@ -0,0 +1,20 @@
+--------------------------------------------------------------------------------
+- example-02.py
+--------------------------------------------------------------------------------
+
+Bash output
+-----------
+cmake \
+   -G=Ninja \
+   -DMYPROJ_CXX_FLAGS:STRING="-O0 -fopenmp" \
+   -DMYPROJ_ENABLE_OPTION_A:BOOL=ON \
+   -DMYPROJ_ENABLE_OPTION_B:BOOL=ON \
+   /path/to/source/dir
+
+CMake fragment output
+---------------------
+set(MYPROJ_CXX_FLAGS "-O0 -fopenmp" CACHE STRING "from .ini configuration")
+set(MYPROJ_ENABLE_OPTION_A ON CACHE BOOL "from .ini configuration" FORCE)
+set(MYPROJ_ENABLE_OPTION_B ON CACHE BOOL "from .ini configuration")
+
+Done

examples/example-02.py

@@ -1,8 +1,12 @@
 #!/usr/bin/env python3
 # -*- mode: python; py-indent-offset: 4; py-continuation-offset: 4 -*-
-
+from pathlib import Path
 import setprogramoptions
 
+print(80*"-")
+print(f"- {Path(__file__).name}")
+print(80*"-")
+
 
 filename = "example-02.ini"
 popts = setprogramoptions.SetProgramOptionsCMake(filename)

examples/example-03.ini

@@ -11,14 +11,5 @@ opt-set-cmake-var CMAKE_CXX_FLAGS STRING : "${LDFLAGS|ENV} -foo"
 [TEST_VAR_EXPANSION_UPDATE_01]
 opt-set cmake
 use TEST_VAR_EXPANSION_COMMON
+# This will be skipped by the BASH generator without a FORCE option added
 opt-set-cmake-var CMAKE_CXX_FLAGS STRING: "${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"

examples/example-03.log

@@ -0,0 +1,39 @@
+--------------------------------------------------------------------------------
+- example-03.py
+--------------------------------------------------------------------------------
+filename: example-03.ini
+section_name = TEST_VAR_EXPANSION_UPDATE_01
+
+parser.configparserenhanceddata[TEST_VAR_EXPANSION_UPDATE_01]
+-------------------------------------------------------------
+{}
+
+Show parser.options
+-------------------
+{'TEST_VAR_EXPANSION_UPDATE_01': [{'type': ['opt_set'], 'value': None, 'params': ['cmake']},
+                                  {'type': ['opt_set_cmake_var'], 'value': '${LDFLAGS|ENV} -foo', 'params': ['CMAKE_CXX_FLAGS', 'STRING']},
+                                  {'type': ['opt_set_cmake_var'], 'value': '${CMAKE_CXX_FLAGS|CMAKE} -bar', 'params': ['CMAKE_CXX_FLAGS', 'STRING']}]}
+
+Bash Output
+-----------
+Note: The _second_ assignment to `CMAKE_CXX_FLAGS` is skipped by a BASH generator
+      without a `FORCE` option since by definition all CMake `-D` options on a 
+      BASH command line are both CACHE and FORCE. Within a CMake source fragment
+      changing an existing CACHE var requires a FORCE option to be set so we should
+      skip the second assignment to maintain consistency between the bash and cmake
+      fragment generators with respect to the CMakeCache.txt file that would be
+      generated.
+      The `WARNING` message below is terse since it's in compact form -- disable
+      the `exception_control_compact_warnings` flag to get the full warning message.
+
+!! EXCEPTION SKIPPED (WARNING : ValueError) @ File "/Users/wcmclen/Library/Python/3.9/lib/python/site-packages/setprogramoptions/SetProgramOptionsCMake.py", line 294, in _program_option_handler_opt_set_cmake_var_bash
+
+cmake \
+    -DCMAKE_CXX_FLAGS:STRING="${LDFLAGS} -foo"
+
+CMake Fragment
+--------------
+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")
+
+Done.

examples/example-03.py

@@ -1,67 +1,49 @@
 #!/usr/bin/env python3
 # -*- mode: python; py-indent-offset: 4; py-continuation-offset: 4 -*-
-
-import os
+from pathlib import Path
 from pprint import pprint
-
 import setprogramoptions
 
-
-
-def find_config_ini(filename="config.ini", rootpath="."):
-    """
-    Recursively searches for a particular file among the subdirectory structure.
-    If we find it, then we return the full relative path to `pwd` to that file.
-
-    The _first_ match will be returned.
-
-    Args:
-        filename (str): The _filename_ of the file we're searching for. Default: 'config.ini'
-        rootpath (str): The _root_ path where we will begin our search from. Default: '.'
-
-    Returns:
-        String containing the path to the file if it was found. If a matching filename is not
-        found then `None` is returned.
-
-    """
-    output = None
-    for dirpath, dirnames, filename_list in os.walk(rootpath):
-        if filename in filename_list:
-            output = os.path.join(dirpath, filename)
-            break
-    if output is None:
-        raise FileNotFoundError("Unable to find {} in {}".format(filename, os.getcwd())) # pragma: no cover
-    return output
-
-
+def print_separator(label):
+    print("")
+    print(f"{label}")
+    print("-"*len(label))
+    return
 
 def test_setprogramoptions(filename="config.ini"):
-    print("filename    : {}".format(filename))
-    print("")
+    print(f"filename: {filename}")
+
+    section_name = "TEST_VAR_EXPANSION_UPDATE_01"
+    print(f"section_name = {section_name}")
 
     parser = setprogramoptions.SetProgramOptionsCMake(filename=filename)
     parser.debug_level = 0
     parser.exception_control_level = 4
     parser.exception_control_compact_warnings = True
 
-    section_name = "TEST_VAR_EXPANSION_UPDATE_01"
-
-    parse_section(parser, section_name)
+    data = parser.configparserenhanceddata[section_name]
+    print_separator(f"parser.configparserenhanceddata[{section_name}]")
+    pprint(data, width=120)
 
-    print("")
-    print("parser.options")
-    print("--------------")
+    print_separator("Show parser.options")
     pprint(parser.options, width=200, sort_dicts=False)
 
+    print_separator("Bash Output")
+    print("Note: The _second_ assignment to `CMAKE_CXX_FLAGS` is skipped by a BASH generator")
+    print("      without a `FORCE` option since by definition all CMake `-D` options on a ")
+    print("      BASH command line are both CACHE and FORCE. Within a CMake source fragment")
+    print("      changing an existing CACHE var requires a FORCE option to be set so we should")
+    print("      skip the second assignment to maintain consistency between the bash and cmake")
+    print("      fragment generators with respect to the CMakeCache.txt file that would be")
+    print("      generated.")
+    print("      The `WARNING` message below is terse since it's in compact form -- disable")
+    print("      the `exception_control_compact_warnings` flag to get the full warning message.")
     print("")
-    print("Bash Output")
-    print("-----------")
     option_list = parser.gen_option_list(section_name, generator="bash")
+    print("")
     print(" \\\n    ".join(option_list))
 
-    print("")
-    print("CMake Fragment")
-    print("--------------")
+    print_separator("CMake Fragment")
     option_list = parser.gen_option_list(section_name, generator="cmake_fragment")
     if len(option_list) > 0:
         print("\n".join(option_list))
@@ -72,42 +54,17 @@ def test_setprogramoptions(filename="config.ini"):
     return 0
 
 
-
-def parse_section(parser, section):
-
-    data = parser.configparserenhanceddata[section]
-
-    print("\nData")
-    print("----")
-    pprint(data, width=120)
-
-    # Print the loginfo from the last search (change if to True to enable)
-    if (False):
-        print("\nLogInfo")
-        print("-------")
-        #parser._loginfo_print(pretty=True)
-
-        # Filter out just the entry and exits for handlers
-        handler_list = [
-            (d['type'], d['name']) for d in parser._loginfo if d['type'] in ['handler-entry', 'handler-exit']
-        ]
-        pprint(handler_list, width=120)
-
-    return data
-
-
-
 def main():
     """
     main app
     """
-    fname_ini = "example-03.ini"
-    fpath_ini = find_config_ini(filename=fname_ini)
-    test_setprogramoptions(filename=fpath_ini)
+    print(80*"-")
+    print(f"- {Path(__file__).name}")
+    print(80*"-")
+    test_setprogramoptions(filename="example-03.ini")
     return 0
 
 
-
 if __name__ == "__main__":
     main()
     print("Done.")