Test viz in CI

Author: EwoutH

.github/workflows/test_viz.yml

@@ -0,0 +1,61 @@
+name: Test viz
+
+on:
+  push:
+    paths:
+      - 'examples/**/app.py'  # If an example visualisation is modified
+      - 'examples/**/viz.py'  # If an example visualisation is modified
+      - 'viz.py'  # If the test script is modified
+      - '.github/workflows/test_viz.yml'  # If this workflow is modified
+  pull_request:
+    paths:
+      - 'examples/**/*.py'
+      - 'test_examples.py'
+      - '.github/workflows/test_examples.yml'
+  workflow_dispatch:
+  schedule:
+    - cron: '0 6 * * 1'  # Monday at 6:00 UTC
+
+jobs:
+  # build-stable:
+  #   runs-on: ubuntu-latest
+  #   steps:
+  #   - uses: actions/checkout@v4
+  #   - name: Set up Python
+  #     uses: actions/setup-python@v5
+  #     with:
+  #       python-version: "3.12"
+  #   - name: Install dependencies
+  #     run: pip install mesa pytest
+  #   - name: Test with pytest
+  #     run: pytest -rA -Werror test_examples.py
+
+  build-pre:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: "3.12"
+    - name: Install dependencies
+      run: |
+        pip install --pre mesa[viz]
+        pip install .[test]
+    - name: Test with pytest
+      run: pytest -rA -Werror -Wdefault::FutureWarning viz.py
+
+#  build-main:
+#    runs-on: ubuntu-latest
+#    steps:
+#    - uses: actions/checkout@v4
+#    - name: Set up Python
+#      uses: actions/setup-python@v5
+#      with:
+#        python-version: "3.12"
+#    - name: Install dependencies
+#      run: |
+#        pip install .[test]
+#        pip install -U git+https://github.com/projectmesa/mesa@main#egg=mesa
+#    - name: Test with pytest
+#      run: pytest -rA -Werror -Wdefault::FutureWarning test_examples.py

viz.py

@@ -0,0 +1,70 @@
+import os
+import subprocess
+import time
+import pytest
+
+
+def find_viz_files(directory):
+    viz_files = []
+    for root, _, files in os.walk(directory):
+        for file in files:
+            if file in ['app.py', 'viz.py']:
+                viz_files.append(os.path.join(root, file))
+    return viz_files
+
+
+def run_solara_app(file_path):
+    process = subprocess.Popen(['solara', 'run', file_path])
+    time.sleep(5)  # Wait for the app to start
+    return process
+
+
+def send_step_command(times=1):
+    for _ in range(times):
+        subprocess.run(['xdotool', 'key', 'space'])
+        time.sleep(0.5)
+
+
+def send_pause_command():
+    subprocess.run(['xdotool', 'key', 'p'])
+    time.sleep(0.5)
+
+
+def send_reset_command():
+    subprocess.run(['xdotool', 'key', 'r'])
+    time.sleep(0.5)
+
+
+@pytest.mark.parametrize('viz_file', find_viz_files('examples'))
+def test_viz_app(viz_file):
+    process = run_solara_app(viz_file)
+
+    try:
+        # Do 3 steps
+        send_step_command(3)
+
+        # Pause
+        send_pause_command()
+
+        # 3 steps
+        send_step_command(3)
+
+        # Reset
+        send_reset_command()
+
+        # Run steps for 5 seconds
+        start_time = time.time()
+        while time.time() - start_time < 5:
+            send_step_command()
+
+        # Pause
+        send_pause_command()
+
+    finally:
+        # Clean up: terminate the Solara app process
+        process.terminate()
+        process.wait()
+
+
+if __name__ == '__main__':
+    pytest.main([__file__])