@openhands/extensions 0.20.0 → 0.22.0

package/tests/fixtures/automations/github-pr-reviewer.json

@@ -17,7 +17,8 @@
         "timezone": "UTC",
         "repositories": [
           "OpenHands/agent-server-gui"
-        ]
+        ],
+        "githubTokenSecret": "GITHUB_PERSONAL_ACCESS_TOKEN"
       },
       "upload": {
         "request": {
@@ -29,7 +30,9 @@
           "contentType": "application/gzip",
           "packs": [
             "config.json",
-            "main.py"
+            "main.py",
+            "github_client.py",
+            "worker.py"
           ]
         },
         "response": {
@@ -57,17 +60,18 @@
                 "timezone": "UTC"
               },
               "tarball_path": "oh-internal://uploads/00000000-0000-0000-0000-000000000000",
-              "entrypoint": "python3 main.py",
-              "timeout": 600,
+              "entrypoint": "python3 worker.py",
+              "timeout": 300,
               "template": {
                 "id": "github-pr-reviewer",
-                "version": "1.0.0",
+                "version": "1.1.0",
                 "config": {
                   "repos": [
                     "OpenHands/agent-server-gui"
                   ],
                   "trigger_label": "openhands-review",
-                  "review_tone": "thorough"
+                  "review_tone": "thorough",
+                  "github_token_secret": "GITHUB_PERSONAL_ACCESS_TOKEN"
                 }
               }
             }
@@ -93,17 +97,18 @@
               "timezone": "UTC"
             },
             "tarball_path": "oh-internal://uploads/2c1f9a70-77c4-4a1e-9a9d-6f1f2b0c1d34",
-            "entrypoint": "python3 main.py",
-            "timeout": 600,
+            "entrypoint": "python3 worker.py",
+            "timeout": 300,
             "template": {
               "id": "github-pr-reviewer",
-              "version": "1.0.0",
+              "version": "1.1.0",
               "config": {
                 "repos": [
                   "OpenHands/agent-server-gui"
                 ],
                 "trigger_label": "openhands-review",
-                "review_tone": "thorough"
+                "review_tone": "thorough",
+                "github_token_secret": "GITHUB_PERSONAL_ACCESS_TOKEN"
               }
             }
           }
@@ -124,8 +129,8 @@
             },
             "tarball_path": "oh-internal://uploads/8d2c1f90-7e34-4a55-b0d1-6c9e3a2f4b88",
             "setup_script_path": "setup.sh",
-            "entrypoint": ".venv/bin/python main.py",
-            "timeout": 600,
+            "entrypoint": "python3 worker.py",
+            "timeout": 300,
             "keep_alive": null,
             "enabled": true,
             "last_triggered_at": null,
@@ -146,7 +151,8 @@
         "repositories": [
           "OpenHands/agent-server-gui",
           "OpenHands/automation"
-        ]
+        ],
+        "githubTokenSecret": "GITHUB_PERSONAL_ACCESS_TOKEN"
       },
       "upload": {
         "request": {
@@ -158,7 +164,9 @@
           "contentType": "application/gzip",
           "packs": [
             "config.json",
-            "main.py"
+            "main.py",
+            "github_client.py",
+            "worker.py"
           ]
         },
         "response": {
@@ -186,18 +194,19 @@
                 "timezone": "UTC"
               },
               "tarball_path": "oh-internal://uploads/00000000-0000-0000-0000-000000000000",
-              "entrypoint": "python3 main.py",
-              "timeout": 600,
+              "entrypoint": "python3 worker.py",
+              "timeout": 300,
               "template": {
                 "id": "github-pr-reviewer",
-                "version": "1.0.0",
+                "version": "1.1.0",
                 "config": {
                   "repos": [
                     "OpenHands/agent-server-gui",
                     "OpenHands/automation"
                   ],
                   "trigger_label": "openhands-review",
-                  "review_tone": "thorough"
+                  "review_tone": "thorough",
+                  "github_token_secret": "GITHUB_PERSONAL_ACCESS_TOKEN"
                 }
               }
             }
@@ -223,18 +232,19 @@
               "timezone": "UTC"
             },
             "tarball_path": "oh-internal://uploads/2c1f9a70-77c4-4a1e-9a9d-6f1f2b0c1d34",
-            "entrypoint": "python3 main.py",
-            "timeout": 600,
+            "entrypoint": "python3 worker.py",
+            "timeout": 300,
             "template": {
               "id": "github-pr-reviewer",
-              "version": "1.0.0",
+              "version": "1.1.0",
               "config": {
                 "repos": [
                   "OpenHands/agent-server-gui",
                   "OpenHands/automation"
                 ],
                 "trigger_label": "openhands-review",
-                "review_tone": "thorough"
+                "review_tone": "thorough",
+                "github_token_secret": "GITHUB_PERSONAL_ACCESS_TOKEN"
               }
             }
           }
@@ -255,8 +265,8 @@
             },
             "tarball_path": "oh-internal://uploads/8d2c1f90-7e34-4a55-b0d1-6c9e3a2f4b88",
             "setup_script_path": "setup.sh",
-            "entrypoint": ".venv/bin/python main.py",
-            "timeout": 600,
+            "entrypoint": "python3 worker.py",
+            "timeout": 300,
             "keep_alive": null,
             "enabled": true,
             "last_triggered_at": null,
@@ -265,14 +275,15 @@
             "preset_metadata": {
               "template": {
                 "id": "github-pr-reviewer",
-                "version": "1.0.0",
+                "version": "1.1.0",
                 "config": {
                   "repos": [
                     "OpenHands/agent-server-gui",
                     "OpenHands/automation"
                   ],
                   "trigger_label": "openhands-review",
-                  "review_tone": "thorough"
+                  "review_tone": "thorough",
+                  "github_token_secret": "GITHUB_PERSONAL_ACCESS_TOKEN"
                 }
               }
             }
@@ -290,7 +301,8 @@
         "timezone": "UTC",
         "repositories": [
           "OpenHands/agent-server-gui"
-        ]
+        ],
+        "githubTokenSecret": "GITHUB_PERSONAL_ACCESS_TOKEN"
       },
       "preflight": {
         "request": {
@@ -307,17 +319,18 @@
                 "timezone": "UTC"
               },
               "tarball_path": "oh-internal://uploads/00000000-0000-0000-0000-000000000000",
-              "entrypoint": "python3 main.py",
-              "timeout": 600,
+              "entrypoint": "python3 worker.py",
+              "timeout": 300,
               "template": {
                 "id": "github-pr-reviewer",
-                "version": "1.0.0",
+                "version": "1.1.0",
                 "config": {
                   "repos": [
                     "OpenHands/agent-server-gui"
                   ],
                   "trigger_label": "openhands-review",
-                  "review_tone": "concise"
+                  "review_tone": "concise",
+                  "github_token_secret": "GITHUB_PERSONAL_ACCESS_TOKEN"
                 }
               }
             }
@@ -351,7 +364,8 @@
         "timezone": "UTC",
         "repositories": [
           "OpenHands/agent-server-gui"
-        ]
+        ],
+        "githubTokenSecret": "GITHUB_PERSONAL_ACCESS_TOKEN"
       },
       "upload": {
         "request": {
@@ -363,7 +377,9 @@
           "contentType": "application/gzip",
           "packs": [
             "config.json",
-            "main.py"
+            "main.py",
+            "github_client.py",
+            "worker.py"
           ]
         },
         "response": {
@@ -388,17 +404,18 @@
               "timezone": "UTC"
             },
             "tarball_path": "oh-internal://uploads/2c1f9a70-77c4-4a1e-9a9d-6f1f2b0c1d34",
-            "entrypoint": "python3 main.py",
-            "timeout": 600,
+            "entrypoint": "python3 worker.py",
+            "timeout": 300,
             "template": {
               "id": "github-pr-reviewer",
-              "version": "1.0.0",
+              "version": "1.1.0",
               "config": {
                 "repos": [
                   "OpenHands/agent-server-gui"
                 ],
                 "trigger_label": "openhands-review",
-                "review_tone": "concise"
+                "review_tone": "concise",
+                "github_token_secret": "GITHUB_PERSONAL_ACCESS_TOKEN"
               }
             }
           }
@@ -435,7 +452,8 @@
         "timezone": "UTC",
         "repositories": [
           "OpenHands/agent-server-gui"
-        ]
+        ],
+        "githubTokenSecret": "GITHUB_PERSONAL_ACCESS_TOKEN"
       },
       "upload": {
         "request": {
@@ -447,7 +465,9 @@
           "contentType": "application/gzip",
           "packs": [
             "config.json",
-            "main.py"
+            "main.py",
+            "github_client.py",
+            "worker.py"
           ]
         },
         "response": {
@@ -472,17 +492,18 @@
               "timezone": "UTC"
             },
             "tarball_path": "oh-internal://uploads/2c1f9a70-77c4-4a1e-9a9d-6f1f2b0c1d34",
-            "entrypoint": "python3 main.py",
-            "timeout": 600,
+            "entrypoint": "python3 worker.py",
+            "timeout": 300,
             "template": {
               "id": "github-pr-reviewer",
-              "version": "1.0.0",
+              "version": "1.1.0",
               "config": {
                 "repos": [
                   "OpenHands/agent-server-gui"
                 ],
                 "trigger_label": "openhands-review",
-                "review_tone": "concise"
+                "review_tone": "concise",
+                "github_token_secret": "GITHUB_PERSONAL_ACCESS_TOKEN"
               }
             },
             "repos": [

package/tests/github_automation_helpers.py

@@ -0,0 +1,31 @@
+"""Exercise the actual shipped entrypoints with mocked GitHub/SDK boundaries."""
+
+import importlib.util
+import json
+import sys
+from pathlib import Path
+
+ROOT = Path(__file__).resolve().parents[1]
+
+
+def worker(name, tmp_path, monkeypatch):
+    manifest = json.loads(
+        (ROOT / f"automations/catalog/{name}/manifest.json").read_text()
+    )
+    bundle = tmp_path / name
+    bundle.mkdir()
+    for filename, source in manifest["setup"]["bundle"]["files"].items():
+        (bundle / filename).write_text((ROOT / source).read_text())
+    for module in (
+        "agent_conversation",
+        "main",
+        "github_client",
+        "qa_prompt",
+        "worker",
+    ):
+        monkeypatch.delitem(sys.modules, module, raising=False)
+    monkeypatch.syspath_prepend(str(bundle))
+    spec = importlib.util.spec_from_file_location("worker", bundle / "worker.py")
+    module = importlib.util.module_from_spec(spec)
+    spec.loader.exec_module(module)
+    return module

package/tests/test_agent_conversation_dispatch.py

@@ -0,0 +1,180 @@
+import json
+from unittest.mock import MagicMock
+from uuid import NAMESPACE_URL, UUID, uuid5
+
+import agent_conversation
+import github_client
+from openhands.sdk.conversation.state import ConversationExecutionStatus
+
+
+def _dispatcher(monkeypatch):
+    monkeypatch.setenv("AGENT_SERVER_URL", "http://agent")
+    monkeypatch.setenv("SESSION_API_KEY", "session")
+    monkeypatch.setenv(
+        "AUTOMATION_AGENT_PROFILE_ID", "11111111-1111-4111-8111-111111111111"
+    )
+    monkeypatch.setenv(
+        "AUTOMATION_EVENT_PAYLOAD", json.dumps({"automation_id": "automation-1"})
+    )
+    return agent_conversation.AgentConversationDispatcher()
+
+
+def _state_key(subject):
+    conversation_id = uuid5(NAMESPACE_URL, f"automation-1:{subject}")
+    return f"agent-conversation-{conversation_id}"
+
+
+def _fake_kv(monkeypatch, state):
+    def request(key, method, value=None):
+        if method == "GET":
+            return state.get(key)
+        state[key] = value
+        return {"key": key, "value": value}
+
+    monkeypatch.setattr(agent_conversation, "_kv_request", request)
+
+
+def test_github_secret_falls_back_to_agent_server(monkeypatch):
+    monkeypatch.delenv("REVIEW_TOKEN", raising=False)
+    monkeypatch.setenv("AGENT_SERVER_URL", "http://agent")
+    monkeypatch.setenv("SESSION_API_KEY", "session")
+    secret = MagicMock()
+    secret.get_value.return_value = "saved-token"
+    workspace = MagicMock()
+    workspace.get_secrets.return_value = {"REVIEW_TOKEN": secret}
+    monkeypatch.setattr(
+        "openhands.sdk.workspace.RemoteWorkspace", lambda **kwargs: workspace
+    )
+
+    assert github_client._load_secret("REVIEW_TOKEN") == "saved-token"
+    workspace.get_secrets.assert_called_once_with(["REVIEW_TOKEN"])
+    workspace.reset_client.assert_called_once_with()
+
+
+def test_new_subject_uses_selected_profile_and_persists_mapping(monkeypatch):
+    state = {}
+    _fake_kv(monkeypatch, state)
+    monkeypatch.setattr(agent_conversation, "_register_tools", lambda: None)
+    workspace = MagicMock()
+    workspace.__enter__.return_value = workspace
+    monkeypatch.setattr(
+        agent_conversation, "RemoteWorkspace", lambda **kwargs: workspace
+    )
+    missing = agent_conversation.httpx.HTTPStatusError(
+        "missing",
+        request=MagicMock(),
+        response=MagicMock(status_code=404),
+    )
+    monkeypatch.setattr(
+        agent_conversation.RemoteConversation, "attach", MagicMock(side_effect=missing)
+    )
+    conversation = MagicMock()
+    create = MagicMock(return_value=conversation)
+    monkeypatch.setattr(agent_conversation.RemoteConversation, "create", create)
+
+    with _dispatcher(monkeypatch) as dispatcher:
+        result = dispatcher.deliver("repo:issue:7", "revision-1", "work")
+
+    request = create.call_args.args[1]
+    assert request.agent_profile_id == UUID("11111111-1111-4111-8111-111111111111")
+    assert request.initial_message.run is True
+    assert result["disposition"] == "created"
+    record = state[_state_key("repo:issue:7")]
+    assert record == {
+        "subject": "repo:issue:7",
+        "conversation_id": result["conversation_id"],
+        "delivery": "revision-1",
+    }
+
+
+def test_known_subject_resumes_once_per_delivery(monkeypatch):
+    state = {
+        _state_key("repo:pr:9"): {
+            "subject": "repo:pr:9",
+            "conversation_id": "22222222-2222-4222-8222-222222222222",
+            "delivery": "head-1",
+        }
+    }
+    _fake_kv(monkeypatch, state)
+    monkeypatch.setattr(agent_conversation, "_register_tools", lambda: None)
+    workspace = MagicMock()
+    workspace.__enter__.return_value = workspace
+    monkeypatch.setattr(
+        agent_conversation, "RemoteWorkspace", lambda **kwargs: workspace
+    )
+    conversation = MagicMock()
+    conversation.state.execution_status = ConversationExecutionStatus.FINISHED
+    attach = MagicMock(return_value=conversation)
+    monkeypatch.setattr(agent_conversation.RemoteConversation, "attach", attach)
+    with _dispatcher(monkeypatch) as dispatcher:
+        duplicate = dispatcher.deliver("repo:pr:9", "head-1", "old")
+        resumed = dispatcher.deliver("repo:pr:9", "head-2", "new")
+
+    assert duplicate["disposition"] == "deduplicated"
+    assert resumed["disposition"] == "resumed"
+    conversation.send_message.assert_called_once_with("new")
+    conversation.run.assert_called_once_with(blocking=False)
+
+
+def test_same_delivery_resumes_paused_conversation(monkeypatch):
+    state = {
+        _state_key("repo:pr:9"): {
+            "subject": "repo:pr:9",
+            "conversation_id": "22222222-2222-4222-8222-222222222222",
+            "delivery": "head-1",
+        }
+    }
+    _fake_kv(monkeypatch, state)
+    monkeypatch.setattr(agent_conversation, "_register_tools", lambda: None)
+    workspace = MagicMock()
+    workspace.__enter__.return_value = workspace
+    monkeypatch.setattr(
+        agent_conversation, "RemoteWorkspace", lambda **kwargs: workspace
+    )
+    conversation = MagicMock()
+    conversation.state.execution_status = ConversationExecutionStatus.PAUSED
+    monkeypatch.setattr(
+        agent_conversation.RemoteConversation,
+        "attach",
+        MagicMock(return_value=conversation),
+    )
+
+    with _dispatcher(monkeypatch) as dispatcher:
+        result = dispatcher.deliver("repo:pr:9", "head-1", "old")
+
+    assert result["disposition"] == "resumed"
+    conversation.send_message.assert_not_called()
+    conversation.run.assert_called_once_with(blocking=False)
+
+
+def test_subjects_use_independent_kv_records(monkeypatch):
+    state = {}
+    _fake_kv(monkeypatch, state)
+    monkeypatch.setattr(agent_conversation, "_register_tools", lambda: None)
+    workspace = MagicMock()
+    workspace.__enter__.return_value = workspace
+    monkeypatch.setattr(
+        agent_conversation, "RemoteWorkspace", lambda **kwargs: workspace
+    )
+    missing = agent_conversation.httpx.HTTPStatusError(
+        "missing",
+        request=MagicMock(),
+        response=MagicMock(status_code=404),
+    )
+    monkeypatch.setattr(
+        agent_conversation.RemoteConversation, "attach", MagicMock(side_effect=missing)
+    )
+    monkeypatch.setattr(
+        agent_conversation.RemoteConversation,
+        "create",
+        MagicMock(side_effect=[MagicMock(), MagicMock()]),
+    )
+
+    with _dispatcher(monkeypatch) as dispatcher:
+        dispatcher.deliver("repo:issue:7", "revision-1", "first")
+        dispatcher.deliver("repo:issue:8", "revision-1", "second")
+
+    assert set(state) == {
+        _state_key("repo:issue:7"),
+        _state_key("repo:issue:8"),
+    }

package/tests/test_automation_setup.py

@@ -676,9 +676,9 @@ def test_schema_rejects_content_a_setup_block_must_never_carry() -> None:
     rejected.append(("{{env.GITHUB_TOKEN}}", with_unknown_placeholder))
 
     with_secret_value = deepcopy(entry)
-    with_secret_value["requires"]["integrations"]["github"]["value"] = (
-        "ghp_notarealtokenvalue00"
-    )
+    with_secret_value["requires"]["integrations"]["github"] = {
+        "value": "ghp_notarealtokenvalue00"
+    }
     rejected.append(("value", with_secret_value))
 
     with_repeated_identity = deepcopy(entry)

package/tests/test_github_automation_foundation.py

@@ -0,0 +1,73 @@
+"""Contracts for the shared GitHub automation foundation."""
+
+import json
+from urllib.error import HTTPError
+
+import github_client
+import pytest
+
+
+def test_repository_runs_are_isolated(tmp_path, monkeypatch):
+    monkeypatch.chdir(tmp_path)
+    monkeypatch.setattr("sys.argv", ["worker.py"])
+    (tmp_path / "config.json").write_text(
+        json.dumps(
+            {
+                "repos": ["owner/failed", "owner/next"],
+                "github_token_secret": "GITHUB_TOKEN",
+            }
+        )
+    )
+    visited = []
+
+    class Automation:
+        def __init__(self, *, repository, github_token_secret, conversation):
+            assert github_token_secret == "GITHUB_TOKEN"
+            self.repository = repository
+
+        def run(self):
+            visited.append(self.repository)
+            if self.repository == "owner/failed":
+                raise TimeoutError
+
+    with pytest.raises(RuntimeError, match="owner/failed"):
+        github_client.run_repositories(Automation)
+
+    assert visited == ["owner/failed", "owner/next"]
+
+
+def test_pagination_rejects_a_non_list_response(monkeypatch):
+    monkeypatch.setattr(
+        github_client, "github_request", lambda *args, **kwargs: ({}, {})
+    )
+
+    with pytest.raises(TypeError, match="paginated GitHub list"):
+        github_client.github_paginate("token", "/repos/owner/repo/issues")
+
+
+@pytest.mark.parametrize(
+    "state,reason,expected",
+    [
+        ("closed", "completed", True),
+        ("closed", "not_planned", False),
+        ("open", None, False),
+    ],
+)
+def test_dependencies_must_be_completed(state, reason, expected):
+    repository = object.__new__(github_client.GitHubRepository)
+    repository._completed_dependencies = {}
+    repository.gh = lambda *args: {"state": state, "state_reason": reason}
+
+    assert repository.dependencies_complete({"body": "Depends on: #12"}) is expected
+
+
+def test_dependency_permission_errors_fail_closed():
+    repository = object.__new__(github_client.GitHubRepository)
+    repository._completed_dependencies = {}
+
+    def denied(*args):
+        raise HTTPError("https://api.github.com", 403, "Forbidden", {}, None)
+
+    repository.gh = denied
+    with pytest.raises(HTTPError):
+        repository.dependencies_complete({"body": "Depends on: #12"})