Merge pull request #2 from benchling/unit-tests

Add unit tests, linting, and CI checks for chem-sync-local-flask

Author: bowenwr

.github/workflows/chem-sync-local-flask-test.yaml

@@ -0,0 +1,37 @@
+name: Chem Sync Local Flask App Tests
+
+# Taken from https://github.com/actions/starter-workflows/blob/main/ci/python-app.yml
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    types: [opened, edited, synchronize]
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+
+    runs-on: ubuntu-20.04
+    name: Quality Checks + Tests
+    defaults:
+      run:
+        working-directory: ./examples/chem-sync-local-flask
+
+    steps:
+    - uses: actions/checkout@v3
+    - uses: actions/setup-python@v4
+      with:
+        python-version: "3.11"
+    - name: Install requirements
+      run: pip install -r requirements.txt
+    - name: Install dev requirements
+      run: pip install -r dev_requirements.txt
+    - name: Lint
+      run: ruff check .
+    - name: Mypy
+      run: mypy .
+    - name: Run Tests
+      run: pytest tests/unit

examples/chem-sync-local-flask/local_app/benchling_app/handler.py

@@ -1,5 +1,6 @@
 from typing import Any
 
+from benchling_sdk.apps.status.errors import AppUserFacingError
 from benchling_sdk.models.webhooks.v0 import (
     CanvasInitializeWebhookV0,
     CanvasInteractionWebhookV0,
@@ -25,11 +26,17 @@ def handle_webhook(webhook_dict: dict[str, Any]) -> None:
     # Could also choose to route on webhook.message.type
     # Note: if your manifest specifies more than one item in `features`,
     # then `webhook.message.feature_id` may also need to be part of your routing logic
-    if isinstance(webhook.message, CanvasInitializeWebhookV0):
-        render_search_canvas(app, webhook.message)
-    elif isinstance(webhook.message, CanvasInteractionWebhookV0):
-        route_interaction_webhook(app, webhook.message)
-    else:
-        # Should only happen if the app's manifest requests webhooks that aren't handled in its code paths
-        raise UnsupportedWebhookError(f"Received an unsupported webhook type: {webhook}")
-    logger.debug("Successfully completed request for webhook: %s", webhook_dict)
+    try:
+        if isinstance(webhook.message, CanvasInitializeWebhookV0):
+            render_search_canvas(app, webhook.message)
+        elif isinstance(webhook.message, CanvasInteractionWebhookV0):
+            route_interaction_webhook(app, webhook.message)
+        else:
+            # Should only happen if the app's manifest requests webhooks that aren't handled in its code paths
+            raise UnsupportedWebhookError(f"Received an unsupported webhook type: {webhook}")
+        logger.debug("Successfully completed request for webhook: %s", webhook_dict)
+    # We want errors shown to the user to end control flow, but we don't want them to propagate
+    # and show as errors in our logs.
+    # For this example, Flask error handler won't intercept this since we're within a thread
+    except AppUserFacingError as e:
+        logger.debug("Exiting with client error: %s", e)

examples/chem-sync-local-flask/requirements.txt

@@ -1,4 +1,4 @@
 flask~=3.0.0
 # TODO Upgrade to stable SDK version once changes are released
 # Cryptography extra needed for webhook verification
-benchling-sdk[cryptography]==1.10.0a9
+benchling-sdk[cryptography]==1.10.0a11

examples/chem-sync-local-flask/ruff.toml

@@ -4,4 +4,7 @@ target-version = "py311"
 line-length = 110
 
 select = ["ALL"]
-ignore = ["D100", "D101", "D103", "D104", "EM101", "EM102", "S101", "TRY003"]
+ignore = ["D100", "D101", "D103", "D104", "EM101", "EM102", "S101", "TRY003"]
+
+[per-file-ignores]
+"**/tests/*" = ["ANN001", "ANN101", "D102", "PLR2004"]