FASTPLOTLIB_NB_TESTS required for nb test funcs to run (#460)

kushalkolar · web-flow · commit 60cf919cd5c3 · 2024-03-30T01:48:49.000-04:00
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -93,7 +93,7 @@ jobs:
         PYGFX_EXPECT_LAVAPIPE: true
       run: |
         pytest -v examples
-        pytest --nbmake examples/notebooks/
+        FASTPLOTLIB_NB_TESTS=1 pytest --nbmake examples/notebooks/
     - uses: actions/upload-artifact@v3
       if: ${{ failure() }}
       with:
diff --git a/examples/notebooks/nb_test_utils.py b/examples/notebooks/nb_test_utils.py
@@ -21,7 +21,19 @@
 FAILURES = list()
 
 
+def _run_tests():
+    if "FASTPLOTLIB_NB_TESTS" not in os.environ.keys():
+        return False
+
+    if os.environ["FASTPLOTLIB_NB_TESTS"] == "1":
+        return True
+
+    return False
+
+
 def plot_test(name, plot: Union[Plot, GridPlot]):
+    if not _run_tests():
+        return
     snapshot = plot.canvas.snapshot()
 
     if "REGENERATE_SCREENSHOTS" in os.environ.keys():
@@ -81,6 +93,9 @@ def get_diffs_rgba(slicer):
 
 
 def notebook_finished():
+    if not _run_tests():
+        return
+
     if len(FAILURES) > 0:
         raise AssertionError(
             f"Failures for plots:\n{FAILURES}"
