Buzz/stream events (#1247)

Author: buzztroll

changelog.d/20260212_141047_john.md

@@ -0,0 +1,4 @@
+
+### Enhancements
+
+* Added a command to show tunnel events

pyproject.toml

@@ -28,7 +28,7 @@ classifiers = [
 ]
 requires-python = ">=3.9"
 dependencies = [
-    "globus-sdk==4.3.1",
+    "globus-sdk==4.4.0",
     "click>=8.1.4,<8.4",
     "jmespath==1.1.0",
     "packaging>=17.0",

src/globus_cli/commands/streams/tunnel/__init__.py

@@ -10,6 +10,7 @@
         "list": (".list", "list_tunnel_command"),
         "show": (".show", "show_tunnel_command"),
         "stop": (".stop", "stop_tunnel_command"),
+        "events": (".events", "events_command"),
     },
 )
 def tunnel_command() -> None:

src/globus_cli/commands/streams/tunnel/events.py

@@ -0,0 +1,37 @@
+from __future__ import annotations
+
+import uuid
+
+import click
+
+from globus_cli.login_manager import LoginManager
+from globus_cli.parsing import command
+from globus_cli.termio import Field, display
+
+TUNNEL_EVENT_LIST_FIELDS = [
+    Field("Code", "attributes.code"),
+    Field("Error", "attributes.is_error"),
+    Field("Details", "attributes.details"),
+    Field("Time", "attributes.time"),
+]
+
+
+@command("events", short_help="List tunnel events.")
+@click.argument("tunnel_id", metavar="TUNNEL_ID", type=click.UUID)
+@LoginManager.requires_login("auth", "transfer")
+def events_command(
+    login_manager: LoginManager,
+    *,
+    tunnel_id: uuid.UUID,
+) -> None:
+    """
+    Show the events that have occurred on the tunnel.
+    """
+    tunnel_client = login_manager.get_transfer_client()
+    res = tunnel_client.get_tunnel_events(tunnel_id)
+    display(
+        res,
+        text_mode=display.TABLE,
+        fields=TUNNEL_EVENT_LIST_FIELDS,
+        response_key="data",
+    )

tests/files/api_fixtures/tunnel_operations.yaml

@@ -147,3 +147,48 @@ transfer:
           "request_id": "yDZD2RwPk"
         }
       }
+
+  - path: /v2/tunnels/689dcb43-cdbe-46bb-9a59-dad71091a247/events
+    method: GET
+    json:
+      {
+        "data": [
+          {
+            "type": "TunnelEvent",
+            "id": 2768,
+            "attributes": {
+              "code": "STARTED",
+              "is_error": false,
+              "description": "started",
+              "details": "Attempting tunnel establishment",
+              "time": "2026-02-12T21:59:01.857473"
+            }
+          },
+          {
+            "type": "TunnelEvent",
+            "id": 2769,
+            "attributes": {
+              "code": "TUNNEL_ACTIVE",
+              "is_error": false,
+              "description": "tunnel is active",
+              "details": "Tunnel has been established",
+              "time": "2026-02-12T21:59:02.876253"
+            }
+          },
+          {
+            "type": "TunnelEvent",
+            "id": 2777,
+            "attributes": {
+              "code": "TUNNEL_STOPPED",
+              "is_error": false,
+              "description": "tunnel has been stopped",
+              "details": "Tunnel stopped as requested.",
+              "time": "2026-02-12T22:12:03.655877"
+            }
+          }
+        ],
+        "links": null,
+        "meta": {
+          "request_id": "8eZwBInC5"
+        }
+      }

tests/functional/streams/test_tunnels.py

@@ -80,3 +80,24 @@ def test_tunnel_update(run_line, output_format):
 
     sent_data = json.loads(get_last_request().body)
     assert sent_data["data"]["attributes"]["label"] == meta["display_name"]
+
+
+@pytest.mark.parametrize("output_format", ["json", "text"])
+def test_tunnel_events(run_line, output_format):
+    meta = load_response_set("cli.tunnel_operations").metadata
+    result = run_line(
+        [
+            "globus",
+            "streams",
+            "tunnel",
+            "events",
+            meta["tunnel_id"],
+            "-F",
+            output_format,
+        ]
+    )
+    if output_format == "json":
+        res = json.loads(result.output)
+        assert res["data"][0]["type"] == "TunnelEvent"
+    else:
+        assert "Code" in result.output