Chatbot: Add software tests for workshop notebook

Author: amotl

.github/workflows/ml-chatbot.yml

@@ -0,0 +1,79 @@
+name: Chatbot
+
+on:
+  pull_request:
+    paths:
+    - '.github/workflows/ml-chatbot.yml'
+    - 'topic/chatbot/**'
+    - '/requirements.txt'
+  push:
+    branches: [ main ]
+    paths:
+    - '.github/workflows/ml-chatbot.yml'
+    - 'topic/chatbot/**'
+    - '/requirements.txt'
+
+  # Allow job to be triggered manually.
+  workflow_dispatch:
+
+  # Run job each night after CrateDB nightly has been published.
+  schedule:
+    - cron: '0 3 * * *'
+
+# Cancel in-progress jobs when pushing to the same branch.
+concurrency:
+  cancel-in-progress: true
+  group: ${{ github.workflow }}-${{ github.ref }}
+
+jobs:
+  test:
+    name: "
+     Python: ${{ matrix.python-version }}
+     CrateDB: ${{ matrix.cratedb-version }}
+     on ${{ matrix.os }}"
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ 'ubuntu-latest' ]
+        python-version: [
+          '3.10',
+          '3.13',
+        ]
+        cratedb-version: [ 'nightly' ]
+
+    services:
+      cratedb:
+        image: crate/crate:${{ matrix.cratedb-version }}
+        ports:
+          - 4200:4200
+          - 5432:5432
+        env:
+          CRATE_HEAP_SIZE: 4g
+
+    env:
+      OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
+
+    steps:
+
+      - name: Acquire sources
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+          architecture: x64
+          cache: 'pip'
+          cache-dependency-path: |
+            requirements.txt
+            topic/chatbot/table-augmented-generation/app/requirements.txt
+            topic/chatbot/table-augmented-generation/workshop/requirements-dev.txt
+
+      - name: Install utilities
+        run: |
+          pip install -r requirements.txt
+
+      - name: Validate topic/chatbot/table-augmented-generation/workshop
+        run: |
+          ngr test --accept-no-venv topic/chatbot/table-augmented-generation/workshop

topic/chatbot/table-augmented-generation/workshop/conftest.py

@@ -0,0 +1,34 @@
+import os
+from pathlib import Path
+
+import pytest
+import sqlalchemy as sa
+from pueblo.testing.notebook import generate_tests
+
+
+def pytest_generate_tests(metafunc):
+    """
+    Generate pytest test case per Jupyter Notebook.
+    """
+    here = Path(__file__).parent
+    generate_tests(metafunc, path=here)
+
+
+@pytest.fixture(autouse=True)
+def reset_database_tables():
+    """
+    Before running a test case, reset relevant tables in database.
+    """
+
+    connection_string = os.environ.get("CRATEDB_CONNECTION_STRING")
+
+    engine = sa.create_engine(connection_string, echo=os.environ.get("DEBUG"))
+    connection = engine.connect()
+
+    reset_tables = [
+        "machine_manuals",
+        "motor_readings",
+    ]
+
+    for table in reset_tables:
+        connection.execute(sa.text(f"DROP TABLE IF EXISTS {table};"))

topic/chatbot/table-augmented-generation/workshop/pyproject.toml

@@ -0,0 +1,19 @@
+[tool.pytest.ini_options]
+minversion = "2.0"
+addopts = """
+  -rfEX -p pytester --strict-markers --verbosity=3 --capture=no
+  """
+env = [
+    "CRATEDB_CONNECTION_STRING=crate://crate@localhost/?schema=notebook",
+    "PYDEVD_DISABLE_FILE_VALIDATION=1",
+]
+
+log_level = "DEBUG"
+log_cli_level = "DEBUG"
+
+testpaths = [
+    "*.py",
+]
+xfail_strict = true
+markers = [
+]

topic/chatbot/table-augmented-generation/workshop/requirements-dev.txt

@@ -0,0 +1 @@
+pueblo[notebook,testing]>=0.0.10

topic/chatbot/table-augmented-generation/workshop/test.py

@@ -0,0 +1,9 @@
+from testbook import testbook
+
+
+def test_notebook(notebook):
+    """
+    Execute Jupyter Notebook, one test case per .ipynb file.
+    """
+    with testbook(notebook) as tb:
+        tb.execute()