Introduce neuro config quota show

README.md

@@ -31,6 +31,8 @@
 		* [neuro image pull](#neuro-image-pull)
 		* [neuro image tags](#neuro-image-tags)
 	* [neuro config](#neuro-config)
+		* [neuro config quota](#neuro-config-quota)
+			* [neuro config quota show](#neuro-config-quota-show)
 		* [neuro config login](#neuro-config-login)
 		* [neuro config login-with-token](#neuro-config-login-with-token)
 		* [neuro config login-headless](#neuro-config-login-headless)
@@ -983,6 +985,13 @@ Name | Description|
 |_--help_|Show this message and exit.|
 
 
+**Command Groups:**
+
+|Usage|Description|
+|---|---|
+| _[neuro config quota](#neuro-config-quota)_| Quota configuration |
+
+
 **Commands:**
 
 |Usage|Description|
@@ -998,6 +1007,51 @@ Name | Description|
 
 
 
+### neuro config quota
+
+Quota configuration.
+
+**Usage:**
+
+```bash
+neuro config quota [OPTIONS] COMMAND [ARGS]...
+```
+
+**Options:**
+
+Name | Description|
+|----|------------|
+|_--help_|Show this message and exit.|
+
+
+**Commands:**
+
+|Usage|Description|
+|---|---|
+| _[neuro config quota show](#neuro-config-quota-show)_| Print quota and remaining computation time |
+
+
+
+
+#### neuro config quota show
+
+Print quota and remaining computation time.
+
+**Usage:**
+
+```bash
+neuro config quota show [OPTIONS]
+```
+
+**Options:**
+
+Name | Description|
+|----|------------|
+|_--help_|Show this message and exit.|
+
+
+
+
 ### neuro config login
 
 Log into Neuromation Platform.<br/><br/>URL is a platform entrypoint URL.

neuromation/api/client.py

@@ -6,6 +6,8 @@
 
 import aiohttp
 
+from neuromation.api.quota import Quota
+
 from .config import _Config
 from .core import _Core
 from .images import Images
@@ -46,6 +48,7 @@ def __init__(
         self._storage = Storage._create(self._core, self._config)
         self._users = Users._create(self._core)
         self._parser = Parser._create(self._config, self.username)
+        self._quota = Quota._create(self._core, self._config)
         self._images: Optional[Images] = None
 
     async def close(self) -> None:
@@ -98,6 +101,10 @@ def images(self) -> Images:
     def parse(self) -> Parser:
         return self._parser
 
+    @property
+    def quota(self) -> Quota:
+        return self._quota
+
     def _get_session_cookie(self) -> Optional["Morsel[str]"]:
         for cookie in self._core._session.cookie_jar:
             if cookie.key == "NEURO_SESSION":

neuromation/api/quota.py

@@ -0,0 +1,59 @@
+from dataclasses import dataclass
+from typing import Any, Dict, Optional
+
+from yarl import URL
+
+from neuromation.api.config import _Config
+from neuromation.api.core import _Core
+from neuromation.api.utils import NoPublicConstructor
+
+
+@dataclass(frozen=True)
+class QuotaDetails:
+    spent_minutes: int
+    limit_minutes: Optional[int]
+
+    @property
+    def remain_minutes(self) -> Optional[int]:
+        if self.limit_minutes is None:
+            # remain: infinity
+            return None
+        if self.limit_minutes > self.spent_minutes:
+            return self.limit_minutes - self.spent_minutes
+        return 0
+
+
+@dataclass(frozen=True)
+class QuotaInfo:
+    name: str
+    gpu_details: QuotaDetails
+    cpu_details: QuotaDetails
+
+
+class Quota(metaclass=NoPublicConstructor):
+    def __init__(self, core: _Core, config: _Config) -> None:
+        self._core = core
+        self._config = config
+
+    async def get(self) -> QuotaInfo:
+        url = URL(f"stats/users/{self._config.auth_token.username}")
+        async with self._core.request("GET", url) as resp:
+            res = await resp.json()
+            return _quota_info_from_api(res)
+
+
+def _quota_info_from_api(payload: Dict[str, Any]) -> QuotaInfo:
+    total_gpu_str = payload["quota"].get("total_gpu_run_time_minutes")
+    total_cpu_str = payload["quota"].get("total_non_gpu_run_time_minutes")
+
+    gpu_details = QuotaDetails(
+        spent_minutes=int(payload["jobs"]["total_gpu_run_time_minutes"]),
+        limit_minutes=int(total_gpu_str) if total_gpu_str else None,
+    )
+    cpu_details = QuotaDetails(
+        spent_minutes=int(payload["jobs"]["total_non_gpu_run_time_minutes"]),
+        limit_minutes=int(total_cpu_str) if total_gpu_str else None,
+    )
+    return QuotaInfo(
+        name=payload["name"], gpu_details=gpu_details, cpu_details=cpu_details
+    )

neuromation/cli/config.py

@@ -17,6 +17,7 @@
     login_with_token as api_login_with_token,
     logout as api_logout,
 )
+from neuromation.cli.formatters.config import QuotaInfoFormatter
 
 from .formatters import ConfigFormatter
 from .root import Root
@@ -28,6 +29,11 @@ def config() -> None:
     """Client configuration."""
 
 
+@group()
+def quota() -> None:
+    """Quota configuration."""
+
+
 @command()
 @async_cmd()
 async def show(root: Root) -> None:
@@ -38,6 +44,17 @@ async def show(root: Root) -> None:
     click.echo(fmt(root))
 
 
+@command("show")
+@async_cmd()
+async def quota_show(root: Root) -> None:
+    """
+    Print quota and remaining computation time.
+    """
+    quota = await root.client.quota.get()
+    fmt = QuotaInfoFormatter()
+    click.echo(fmt(quota))
+
+
 @command()
 @async_cmd()
 async def show_token(root: Root) -> None:
@@ -194,3 +211,6 @@ async def docker(root: Root, docker_config: str) -> None:
 config.add_command(docker)
 
 config.add_command(logout)
+config.add_command(quota)
+
+quota.add_command(quota_show)

neuromation/cli/formatters/config.py

@@ -4,6 +4,7 @@
 from click import style
 
 from neuromation.api import Preset
+from neuromation.api.quota import QuotaDetails, QuotaInfo
 from neuromation.cli.root import Root
 from neuromation.cli.utils import format_size
 
@@ -66,3 +67,35 @@ def _format_presets(self, presets: Dict[str, Preset]) -> Iterator[str]:
         yield from table(
             rows=rows, aligns=[Align.LEFT, Align.RIGHT, Align.RIGHT, Align.CENTER]
         )
+
+
+class QuotaInfoFormatter:
+    QUOTA_NOT_SET = "infinity"
+
+    def __call__(self, quota: QuotaInfo) -> str:
+        return (
+            f"{style('GPU:', bold=True)}"
+            f" {self._format_quota_details(quota.gpu_details)}"
+            "\n"
+            f"{style('CPU:', bold=True)}"
+            f" {self._format_quota_details(quota.cpu_details)}"
+        )
+
+    def _format_quota_details(self, details: QuotaDetails) -> str:
+        spent_str = f"spent: {self._format_time(details.spent_minutes)}"
+        quota_str = "quota: "
+        if details.limit_minutes is not None:
+            quota_str += self._format_time(details.limit_minutes)
+            assert details.remain_minutes is not None
+            quota_str += f", left: {self._format_time(details.remain_minutes)}"
+        else:
+            quota_str += self.QUOTA_NOT_SET
+        return f"{spent_str} ({quota_str})"
+
+    def _format_time(self, minutes_total: int) -> str:
+        hours = minutes_total // 60
+        minutes = minutes_total % 60
+        minutes_zero_padded = "{0:02d}m".format(minutes)
+        hours_zero_padded = "{0:02d}".format(hours)
+        hours_space_padded = f"{hours_zero_padded:>2}h"
+        return f"{hours_space_padded} {minutes_zero_padded}"

tests/api/test_quota.py

@@ -0,0 +1,69 @@
+from typing import Callable
+
+from aiohttp import web
+
+from neuromation.api import Client
+from neuromation.api.quota import QuotaDetails, QuotaInfo
+from tests import _TestServerFactory
+
+
+_MakeClient = Callable[..., Client]
+
+
+async def test_quota_get(
+    aiohttp_server: _TestServerFactory, make_client: _MakeClient
+) -> None:
+    async def handle_stats(request: web.Request) -> web.StreamResponse:
+        data = {
+            "name": request.match_info["name"],
+            "jobs": {
+                "total_gpu_run_time_minutes": 101,
+                "total_non_gpu_run_time_minutes": 102,
+            },
+            "quota": {
+                "total_gpu_run_time_minutes": 201,
+                "total_non_gpu_run_time_minutes": 202,
+            },
+        }
+        return web.json_response(data)
+
+    app = web.Application()
+    app.router.add_get("/stats/users/{name}", handle_stats)
+
+    srv = await aiohttp_server(app)
+
+    async with make_client(srv.make_url("/")) as client:
+        quota = await client.quota.get()
+        assert quota == QuotaInfo(
+            name=client.username,
+            gpu_details=QuotaDetails(spent_minutes=101, limit_minutes=201),
+            cpu_details=QuotaDetails(spent_minutes=102, limit_minutes=202),
+        )
+
+
+async def test_quota_get_no_quota(
+    aiohttp_server: _TestServerFactory, make_client: _MakeClient
+) -> None:
+    async def handle_stats(request: web.Request) -> web.StreamResponse:
+        data = {
+            "name": request.match_info["name"],
+            "jobs": {
+                "total_gpu_run_time_minutes": 101,
+                "total_non_gpu_run_time_minutes": 102,
+            },
+            "quota": {},
+        }
+        return web.json_response(data)
+
+    app = web.Application()
+    app.router.add_get("/stats/users/{name}", handle_stats)
+
+    srv = await aiohttp_server(app)
+
+    async with make_client(srv.make_url("/")) as client:
+        quota = await client.quota.get()
+        assert quota == QuotaInfo(
+            name=client.username,
+            gpu_details=QuotaDetails(spent_minutes=101, limit_minutes=None),
+            cpu_details=QuotaDetails(spent_minutes=102, limit_minutes=None),
+        )