Add cmd: apolo app logs (#3249)

Author: paul-gsd

CHANGELOG.D/3249.feature.md

@@ -0,0 +1 @@
+Added new command `apolo app logs [id]` - view logs from a running app

CLI.md

@@ -56,6 +56,7 @@
 		* [apolo app get-values](#apolo-app-get-values)
 		* [apolo app install](#apolo-app-install)
 		* [apolo app list](#apolo-app-list)
+		* [apolo app logs](#apolo-app-logs)
 		* [apolo app ls](#apolo-app-ls)
 		* [apolo app uninstall](#apolo-app-uninstall)
 	* [apolo app-template](#apolo-app-template)
@@ -1418,6 +1419,7 @@ Name | Description|
 | _[apolo app get-values](#apolo-app-get-values)_| Get application values |
 | _[apolo app install](#apolo-app-install)_| Install an app from a YAML file |
 | _[apolo app list](#apolo-app-list)_| List apps |
+| _[apolo app logs](#apolo-app-logs)_| Print the logs for an app |
 | _[apolo app ls](#apolo-app-ls)_| Alias to list |
 | _[apolo app uninstall](#apolo-app-uninstall)_| Uninstall an app |
 
@@ -1493,6 +1495,30 @@ Name | Description|
 
 
 
+### apolo app logs
+
+Print the logs for an app.
+
+**Usage:**
+
+```bash
+apolo app logs [OPTIONS] APP_ID
+```
+
+**Options:**
+
+Name | Description|
+|----|------------|
+|_--help_|Show this message and exit.|
+|_--cluster CLUSTER_|Look on a specified cluster \(the current cluster by default).|
+|_--org ORG_|Look on a specified org \(the current org by default).|
+|_--project PROJECT_|Look on a specified project \(the current project by default).|
+|_--since DATE\_OR_TIMEDELTA_|Only return logs after a specific date \(including). Use value of format '1d2h3m4s' to specify moment in past relatively to current time.|
+|_--timestamps_|Include timestamps on each line in the log output.|
+
+
+
+
 ### apolo app ls
 
 Alias to list

apolo-cli/docs/app.md

@@ -16,6 +16,7 @@ Operations with applications.
 | [_get-values_](app.md#get-values) | Get application values |
 | [_install_](app.md#install) | Install an app from a YAML file |
 | [_list_](app.md#list) | List apps |
+| [_logs_](app.md#logs) | Print the logs for an app |
 | [_ls_](app.md#ls) | Alias to list |
 | [_uninstall_](app.md#uninstall) | Uninstall an app |
 
@@ -97,6 +98,32 @@ List apps.
 
 
 
+### logs
+
+Print the logs for an app
+
+
+#### Usage
+
+```bash
+apolo app logs [OPTIONS] APP_ID
+```
+
+Print the logs for an app.
+
+#### Options
+
+| Name | Description |
+| :--- | :--- |
+| _--help_ | Show this message and exit. |
+| _--cluster CLUSTER_ | Look on a specified cluster \(the current cluster by default\). |
+| _--org ORG_ | Look on a specified org \(the current org by default\). |
+| _--project PROJECT_ | Look on a specified project \(the current project by default\). |
+| _--since DATE\_OR\_TIMEDELTA_ | Only return logs after a specific date \(including\). Use value of format '1d2h3m4s' to specify moment in past relatively to current time. |
+| _--timestamps_ | Include timestamps on each line in the log output. |
+
+
+
 ### ls
 
 Alias to list

apolo-cli/src/apolo_cli/apps.py

@@ -1,3 +1,4 @@
+import codecs
 import sys
 from typing import List, Optional
 
@@ -12,6 +13,7 @@
     SimpleAppValuesFormatter,
 )
 from .formatters.apps import AppsFormatter, BaseAppsFormatter, SimpleAppsFormatter
+from .job import _parse_date
 from .root import Root
 from .utils import alias, argument, command, group, option
 
@@ -238,8 +240,71 @@ async def get_values(
             root.print("No app values found.")
 
 
+@command()
+@argument("app_id")
+@option(
+    "--since",
+    metavar="DATE_OR_TIMEDELTA",
+    help="Only return logs after a specific date (including). "
+    "Use value of format '1d2h3m4s' to specify moment in "
+    "past relatively to current time.",
+)
+@option(
+    "--timestamps",
+    is_flag=True,
+    help="Include timestamps on each line in the log output.",
+)
+@option(
+    "--cluster",
+    type=CLUSTER,
+    help="Look on a specified cluster (the current cluster by default).",
+)
+@option(
+    "--org",
+    type=ORG,
+    help="Look on a specified org (the current org by default).",
+)
+@option(
+    "--project",
+    type=PROJECT,
+    help="Look on a specified project (the current project by default).",
+)
+async def logs(
+    root: Root,
+    app_id: str,
+    since: Optional[str],
+    timestamps: bool,
+    cluster: Optional[str],
+    org: Optional[str],
+    project: Optional[str],
+) -> None:
+    """
+    Print the logs for an app.
+    """
+    decoder = codecs.lookup("utf8").incrementaldecoder("replace")
+
+    async with root.client.apps.logs(
+        app_id=app_id,
+        cluster_name=cluster,
+        org_name=org,
+        project_name=project,
+        since=_parse_date(since) if since else None,
+        timestamps=timestamps,
+    ) as it:
+        async for chunk in it:
+            if not chunk:  # pragma: no cover
+                txt = decoder.decode(b"", final=True)
+                if not txt:
+                    break
+            else:
+                txt = decoder.decode(chunk)
+            sys.stdout.write(txt)
+            sys.stdout.flush()
+
+
 app.add_command(list)
 app.add_command(alias(list, "ls", help="Alias to list", deprecated=False))
 app.add_command(install)
 app.add_command(uninstall)
 app.add_command(get_values)
+app.add_command(logs)

apolo-cli/tests/unit/test_apps.py

@@ -287,3 +287,63 @@ def test_app_get_values_quiet_mode(run_cli: _RunCli) -> None:
     external_api_value += '{"url": "https://api.example.com"}'
     assert external_api_value in capture.out
     assert capture.code == 0
+
+
+@contextmanager
+def mock_apps_logs() -> Iterator[None]:
+    """Context manager to mock the Apps.logs method."""
+    with mock.patch.object(Apps, "logs") as mocked:
+
+        @asynccontextmanager
+        async def async_cm(**kwargs: Any) -> AsyncIterator[AsyncIterator[bytes]]:
+            async def async_iterator() -> AsyncIterator[bytes]:
+                logs = [
+                    b"Starting app...\n",
+                    b"App initialized\n",
+                    b"App ready\n",
+                ]
+                for log in logs:
+                    yield log
+
+            yield async_iterator()
+
+        mocked.side_effect = async_cm
+        yield
+
+
+def test_app_logs(run_cli: _RunCli) -> None:
+    """Test the app logs command."""
+    app_id = "app-123"
+
+    with mock_apps_logs():
+        capture = run_cli(["app", "logs", app_id])
+
+    assert not capture.err
+    assert "Starting app..." in capture.out
+    assert "App initialized" in capture.out
+    assert "App ready" in capture.out
+    assert capture.code == 0
+
+
+def test_app_logs_with_since(run_cli: _RunCli) -> None:
+    """Test the app logs command with since parameter."""
+    app_id = "app-123"
+
+    with mock_apps_logs():
+        capture = run_cli(["app", "logs", app_id, "--since", "1h"])
+
+    assert not capture.err
+    assert "Starting app..." in capture.out
+    assert capture.code == 0
+
+
+def test_app_logs_with_timestamps(run_cli: _RunCli) -> None:
+    """Test the app logs command with timestamps."""
+    app_id = "app-123"
+
+    with mock_apps_logs():
+        capture = run_cli(["app", "logs", app_id, "--timestamps"])
+
+    assert not capture.err
+    assert "Starting app..." in capture.out
+    assert capture.code == 0

apolo-cli/tests/unit/test_shell_completion.py

@@ -1577,6 +1577,8 @@ def test_app_autocomplete(run_autocomplete: _RunAC) -> None:
     assert "uninstall" in zsh_out
     assert "get-values" in bash_out
     assert "get-values" in zsh_out
+    assert "logs" in bash_out
+    assert "logs" in zsh_out
 
 
 @skip_on_windows

apolo-sdk/docs/apps.rst

@@ -52,6 +52,18 @@ Apps
       :param str org_name: org to get values from. Default is current org.
       :param str project_name: project to get values from. Default is current project.
 
+   .. method:: logs(app_id: str, *, cluster_name: Optional[str] = None, org_name: Optional[str] = None, project_name: Optional[str] = None, since: Optional[datetime] = None, timestamps: bool = False) -> AsyncContextManager[AsyncIterator[bytes]]
+      :async:
+
+      Get logs for an app instance, async iterator. Yields chunks of logs as :class:`bytes`.
+
+      :param str app_id: The ID of the app instance.
+      :param str cluster_name: Cluster where the app is deployed. Default is current cluster.
+      :param str org_name: Organization where the app is deployed. Default is current org.
+      :param str project_name: Project where the app is deployed. Default is current project.
+      :param datetime since: Optional timestamp to start logs from.
+      :param bool timestamps: Include timestamps in the logs output.
+
 ===
 
 .. class:: App

apolo-sdk/src/apolo_sdk/_apps.py

@@ -1,6 +1,8 @@
 from dataclasses import dataclass, field
+from datetime import datetime
 from typing import Any, AsyncIterator, List, Optional
 
+from aiohttp import WSMsgType
 from yarl import URL
 
 from ._config import Config
@@ -76,6 +78,13 @@ def _build_base_url(
         )
         return url
 
+    def _get_monitoring_url(self, cluster_name: Optional[str]) -> URL:
+        if cluster_name is None:
+            cluster_name = self._config.cluster_name
+        return self._config.get_cluster(cluster_name).monitoring_url.with_path(
+            "/api/v1"
+        )
+
     @asyncgeneratorcontextmanager
     async def list(
         self,
@@ -265,3 +274,58 @@ async def list_template_versions(
                     short_description=item.get("short_description", ""),
                     tags=item.get("tags", []),
                 )
+
+    @asyncgeneratorcontextmanager
+    async def logs(
+        self,
+        app_id: str,
+        *,
+        cluster_name: Optional[str] = None,
+        org_name: Optional[str] = None,
+        project_name: Optional[str] = None,
+        since: Optional[datetime] = None,
+        timestamps: bool = False,
+    ) -> AsyncIterator[bytes]:
+        """Get logs for an app instance.
+
+        Args:
+            app_id: The ID of the app instance
+            cluster_name: Optional cluster name override
+            org_name: Optional organization name override
+            project_name: Optional project name override
+            since: Optional timestamp to start logs from
+            timestamps: Include timestamps in the logs output
+
+        Returns:
+            An async iterator of log chunks as bytes
+        """
+        url = self._get_monitoring_url(cluster_name) / "apps" / app_id / "log_ws"
+
+        if url.scheme == "https":  # pragma: no cover
+            url = url.with_scheme("wss")
+        else:
+            url = url.with_scheme("ws")
+
+        if since is not None:
+            if since.tzinfo is None:
+                # Interpret naive datetime object as local time.
+                since = since.astimezone()  # pragma: no cover
+            url = url.update_query(since=since.isoformat())
+        if timestamps:
+            url = url.update_query(timestamps="true")
+
+        auth = await self._config._api_auth()
+        async with self._core.ws_connect(
+            url,
+            auth=auth,
+            timeout=None,
+            heartbeat=30,
+        ) as ws:
+            async for msg in ws:
+                if msg.type == WSMsgType.BINARY:
+                    if msg.data:
+                        yield msg.data
+                elif msg.type == WSMsgType.ERROR:  # pragma: no cover
+                    raise ws.exception()  # type: ignore
+                else:  # pragma: no cover
+                    raise RuntimeError(f"Incorrect WebSocket message: {msg!r}")