Merge pull request #5 from marimo-team/aka/smoke-tests

tests: test notebooks for syntax errors

Author: akshayka

.github/workflows/test.yaml

@@ -0,0 +1,21 @@
+name: Tests
+
+on:
+  push:
+    branches: [main]
+  pull_request: {}
+
+jobs:
+  test:
+    name: Test notebooks
+    runs-on: ubuntu-latest
+    steps:
+      - name: 🛑 Cancel Previous Runs
+        uses: styfle/[email protected]
+      - name: Checkout the repository
+        uses: actions/checkout@main
+      - name: 🐍 Setup uv
+        uses: astral-sh/setup-uv@v5
+      - name: Run tests
+        run: |
+          uvx --with marimo pytest -v

.github/workflows/test_typos.yaml

@@ -22,3 +22,10 @@ repos:
     rev: dictgen-v0.3.1
     hooks:
       - id: typos
+
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.9.1
+    hooks:
+      # Run the formatter
+      - id: ruff-format
+

.pre-commit-config.yaml

@@ -13,9 +13,8 @@ and apps.
 
 ## Running examples
 
-Each example has a README that tells you how to run it locally.
-
-Most examples can also be opened in marimo's [online
+Each example has a README that tells you how to run it locally. Most examples
+can also be opened in marimo's [online
 playground](https://docs.marimo.io/guides/publishing/playground/) by clicking
 the "open in marimo" badge in its README.
 
@@ -25,7 +24,8 @@ We welcome community contributions of examples; you don't need to be
 an expert to help out!
 
 Open a pull request to contribute a new example. Each example should be placed
-in its own folder and include a short `README.md`.
+in its own folder and include a short `README.md`. We also include smoke tests
+for each notebook in `tests/`. Run tests with `uvx --with marimo pytest .`
 
 Looking for a specific example or template but can't find it? Feel free
 to file an issue and request it!

README.md

@@ -94,9 +94,7 @@ def _(annotate, mo):
 
 @app.cell
 def _(CHOICES_PATH, PARAGRAPHS, load_choices, mo):
-    get_choices, set_choices = mo.state(
-        load_choices(CHOICES_PATH, len(PARAGRAPHS))
-    )
+    get_choices, set_choices = mo.state(load_choices(CHOICES_PATH, len(PARAGRAPHS)))
     return get_choices, set_choices
 
 
@@ -137,9 +135,7 @@ def _(PARAGRAPHS, SPANS, annotate, index, mo):
 
 @app.cell
 def _(mo, model_A_prediction, model_B_prediction):
-    mo.hstack(
-        [model_A_prediction, model_B_prediction], gap=2, justify="space-around"
-    )
+    mo.hstack([model_A_prediction, model_B_prediction], gap=2, justify="space-around")
     return
 
 
@@ -169,19 +165,18 @@ def load_choices(path, number_of_examples):
         assert len(choices) == number_of_examples
         return choices
 
-
     def write_choices(choices, path):
         # Trunacate notes
         with open(path, "w") as f:
             f.write(json.dumps(choices))
+
     return load_choices, write_choices
 
 
 @app.cell
 def _(PARAGRAPHS, random):
     random.seed(0)
 
-
     def predict_spans(text):
         first = [random.randint(0, len(text) - 2)]
         first.append(random.randint(first[0] + 1, len(text) - 1))
@@ -190,17 +185,14 @@ def predict_spans(text):
 
         return first, second
 
-
     SPANS = [predict_spans(p) for p in PARAGRAPHS]
     return SPANS, predict_spans
 
 
 @app.cell
 def _(HAMLET, textwrap):
     PARAGRAPHS = [
-        textwrap.dedent(block).strip()[:1000]
-        for block in HAMLET.split("\n\n")
-        if block
+        textwrap.dedent(block).strip()[:1000] for block in HAMLET.split("\n\n") if block
     ]
     return (PARAGRAPHS,)
 
@@ -216,6 +208,7 @@ def annotate(text, span, color):
             + "</mark>"
             + text[span[1] :]
         )
+
     return (annotate,)
 
 
@@ -237,6 +230,7 @@ def _(urllib):
 @app.cell
 def _():
     import marimo as mo
+
     return (mo,)
 
 
@@ -247,6 +241,7 @@ def _():
     import random
     import textwrap
     import urllib
+
     return json, os, random, textwrap, urllib
 
 

nlp_span_comparison/nlp_span_comparison.py

@@ -0,0 +1,13 @@
+"""Smoke tests that check notebooks don't have syntax errors."""
+
+import pathlib
+import sys
+
+ROOT = pathlib.Path(__file__).parent.parent
+sys.path.append(str(ROOT))
+
+
+def test_nlp_span_comparison() -> None:
+    from nlp_span_comparison import nlp_span_comparison
+
+    assert not nlp_span_comparison.app._unparsable