Framework/Streamlit: Add software tests

Author: amotl

.github/dependabot.yml

@@ -80,6 +80,11 @@ updates:
     schedule:
       interval: "daily"
 
+  - directory: "/framework/streamlit"
+    package-ecosystem: "pip"
+    schedule:
+      interval: "daily"
+
   # Topics.
 
   - directory: "/topic/machine-learning/automl"

.github/workflows/framework-streamlit.yml

@@ -0,0 +1,74 @@
+name: Streamlit
+
+on:
+  pull_request:
+    branches: ~
+    paths:
+    - '.github/workflows/framework-streamlit.yml'
+    - 'framework/streamlit/**'
+    - '/requirements.txt'
+  push:
+    branches: [ main ]
+    paths:
+    - '.github/workflows/framework-streamlit.yml'
+    - 'framework/streamlit/**'
+    - '/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.11', '3.12' ]
+        cratedb-version: [ 'nightly' ]
+
+    services:
+      cratedb:
+        image: crate/crate:${{ matrix.cratedb-version }}
+        ports:
+          - 4200:4200
+          - 5432:5432
+        env:
+          CRATE_HEAP_SIZE: 4g
+
+    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
+            framework/streamlit/requirements.txt
+            framework/streamlit/requirements-dev.txt
+
+      - name: Install utilities
+        run: |
+          pip install -r requirements.txt
+
+      - name: Validate framework/streamlit
+        run: |
+          ngr test --accept-no-venv framework/streamlit

framework/streamlit/README.md

@@ -32,3 +32,20 @@ streamlit run basic_sys_summits.py
 Enjoy the list of mountains.
 
 ![image](https://github.com/crate/cratedb-examples/assets/453543/7dc54224-06d0-4cfb-a5e0-b216c03bf3d2)
+
+
+## Development
+
+Acquire `cratedb-example` repository, and set up sandbox:
+```shell
+git clone https://github.com/crate/cratedb-examples
+cd cratedb-examples
+python3 -m venv .venv
+source .venv/bin/activate
+pip install -r requirements.txt
+```
+
+Then, invoke the integration test cases:
+```shell
+ngr test framework/streamlit
+```

framework/streamlit/pyproject.toml

@@ -0,0 +1,12 @@
+[tool.pytest.ini_options]
+minversion = "2.0"
+addopts = """
+  -rfEX -p pytester --strict-markers --verbosity=3
+  --capture=no
+  """
+log_level = "DEBUG"
+log_cli_level = "DEBUG"
+testpaths = ["*.py"]
+xfail_strict = true
+markers = [
+]

framework/streamlit/requirements-dev.txt

@@ -0,0 +1 @@
+pytest<9

framework/streamlit/test.py

@@ -0,0 +1,29 @@
+from streamlit.testing.v1 import AppTest
+
+
+def test_read_sys_summits():
+    """
+    Verify reading CrateDB's built-in `sys.summits` database table through Streamlit.
+    """
+
+    # Invoke Streamlit application.
+    at = AppTest.from_file("basic_sys_summits.py").run()
+
+    # There should not be an exception.
+    assert not at.exception
+
+    # Probe dataframe output.
+    df = at.dataframe.values[0]
+    mountains = df["mountain"].values
+    assert "Mont Blanc" in mountains
+    assert "Matterhorn" in mountains
+
+    # Probe table output.
+    df = at.table.values[0]
+    mountains = df["mountain"].values
+    assert "Mont Blanc" in mountains
+    assert "Matterhorn" in mountains
+
+    # Probe Markdown output.
+    assert "Mont Blanc" in at.markdown.values
+    assert "Monte Rosa" in at.markdown.values