Turn on test_*.py for examples in integration test (#1679)

Co-authored-by: Bethany Nicholson <[email protected]>
Co-authored-by: Sufi Kaur <[email protected]>

Author: 3 people

.github/actions/run-examples/action.yml

@@ -31,6 +31,16 @@ inputs:
     required: false
     default: ''
 
+  run-notebooks:
+    description: "Run notebook tests (via nbmake)"
+    required: false
+    default: 'true'
+
+  run-pyfiles:
+    description: "Run Python *.py tests (test_*.py, *_test.py)"
+    required: false
+    default: 'true'
+
 runs:
   using: composite
   steps:
@@ -63,6 +73,8 @@ runs:
       shell: bash -l {0}
       env:
         PYTHONPATH: ${{ github.action_path }}
+        EXAMPLES_RUN_NOTEBOOKS: ${{ inputs.run-notebooks }}
+        EXAMPLES_RUN_PYFILES: ${{ inputs.run-pyfiles }}
         PYTEST_ADDOPTS: >-
           --color=yes
           --durations=0

.github/actions/run-examples/examples_for_idaes_ci.py

@@ -3,9 +3,7 @@
 """
 
 from contextlib import contextmanager
-from dataclasses import dataclass, field
 import fnmatch
-import logging
 import os
 from pathlib import Path
 import sys
@@ -21,6 +19,12 @@
 matchmarker = pytest.StashKey()
 marked = pytest.StashKey()
 
+# Environment triggers for use either locally
+# or in GitHub Action
+_ENV_TRUE = {"1", "true", "yes", "on"}
+RUN_NOTEBOOKS = str(os.getenv("EXAMPLES_RUN_NOTEBOOKS", "1")).lower() in _ENV_TRUE
+RUN_PYFILES = str(os.getenv("EXAMPLES_RUN_PYFILES", "1")).lower() in _ENV_TRUE
+
 
 def _matches_pattern(item: pytest.Item, pattern: str) -> bool:
     to_match = os.fspath(item.path)
@@ -44,16 +48,31 @@ def pytest_sessionstart(session: pytest.Session):
 
 
 def pytest_ignore_collect(collection_path: Path, config: pytest.Config):
+    """Control what gets collected. By default, notebooks and tests; ignore other files."""
     if "_dev" in collection_path.parts:
         return True
     if not collection_path.is_file():
         return
-    if collection_path.suffix == ".py":
-        # specifically ignore python files
-        return True
-    if not collection_path.match("**/*_test.ipynb"):
+
+    suffix = collection_path.suffix
+    # Notebook tests (only *_test.ipynb)
+    if suffix == ".ipynb":
+        if not RUN_NOTEBOOKS:
+            return True
+        return not collection_path.match("**/*_test.ipynb")
+
+    # Python tests (only test_*.py or *_test.py)
+    if suffix == ".py":
+        if not RUN_PYFILES:
+            return True
+        name = collection_path.name
+        if fnmatch.fnmatch(name, "test_*.py") or fnmatch.fnmatch(name, "*_test.py"):
+            return False
         return True
 
+    # Ignore everything else
+    return True
+
 
 def pytest_collection_modifyitems(config: pytest.Config, items):
     for item in items:
@@ -102,7 +121,7 @@ def run_pytest(
         empty_file_for_ignoring.write_text("")
         args += ["-c", empty_file_for_ignoring]
 
-    with _temp_cwd(rootdir) as p:
+    with _temp_cwd(rootdir):
         res = pytest.main(
             args,
             **kwargs,
@@ -114,6 +133,7 @@ def run_pytest(
 def main(args):
     rootdir = Path(idaes_examples.__path__[0])
 
+    # Always include --nbmake, but notebook collection can be disabled by env
     res = run_pytest(
         rootdir,
         [