remotivelabs-cli 0.3.0__py3-none-any.whl → 0.3.2__py3-none-any.whl

cli/remotive.py

@@ -3,12 +3,10 @@ from __future__ import annotations
 import os
 
 import typer
-from rich import print as rich_print
-from rich.console import Console
 from trogon import Trogon
 from typer.main import get_group
 
-from cli.broker.brokers import app as broker_app
+from cli.broker import app as broker_app
 from cli.cloud import app as cloud_app
 from cli.connect.connect import app as connect_app
 from cli.settings import Settings, settings
@@ -19,8 +17,7 @@ from cli.tools.tools import app as tools_app
 from cli.topology.cmd import app as topology_app
 from cli.typer import typer_utils
 from cli.utils import versions
-
-err_console = Console(stderr=True)
+from cli.utils.console import print_generic_error, print_generic_message
 
 
 def is_featue_flag_enabled(env_var: str) -> bool:
@@ -48,7 +45,7 @@ def version_callback(value: bool) -> None:
 
 def test_callback(value: int) -> None:
     if value:
-        rich_print(value)
+        print_generic_message(str(value))
         raise typer.Exit()
 
 
@@ -72,7 +69,7 @@ def run_migrations(settings: Settings) -> None:
     migrate_config_file(settings.config_file_path, settings)
 
     if has_migrated_tokens:
-        err_console.print("Migrated old credentials and configuration files, you may need to login again or activate correct credentials")
+        print_generic_error("Migrated old credentials and configuration files, you may need to login again or activate correct credentials")
 
 
 def set_default_org_as_env(settings: Settings) -> None:

cli/settings/core.py

@@ -8,13 +8,13 @@ from typing import Optional
 
 from rich.console import Console
 
-from cli.errors import ErrorPrinter
 from cli.settings import config_file as cf
 from cli.settings import state_file as sf
 from cli.settings import token_file as tf
 from cli.settings.config_file import Account, ConfigFile
 from cli.settings.state_file import StateFile
 from cli.settings.token_file import TokenFile
+from cli.utils.console import print_hint
 
 err_console = Console(stderr=True)
 
@@ -63,11 +63,13 @@ class Settings:
     def set_default_organisation(self, organisation: str) -> None:
         """
         Set the default organization for the active account
+
+        TODO: Raise error, dont sys.exit
         """
         config = self._get_cli_config()
         active_account = config.get_active_account()
         if not active_account:
-            ErrorPrinter.print_hint("You must have an account activated in order to set default organization")
+            print_hint("You must have an account activated in order to set default organization")
             sys.exit(1)
         active_account.default_organization = organisation
         self._write_config_file(config)

cli/settings/migration/migration_tools.py

@@ -4,6 +4,7 @@ from itertools import chain
 from pathlib import Path
 
 from cli.settings.token_file import TokenFile
+from cli.utils.console import print_generic_message
 
 
 def list_token_files(config_dir: Path) -> list[TokenFile]:
@@ -20,7 +21,7 @@ def list_token_files(config_dir: Path) -> list[TokenFile]:
             token_file = TokenFile.from_json_str(file.read_text())
             token_files.append(token_file)
         except Exception:
-            print(f"warning: invalid token file {file}. Consider removing it.")
+            print_generic_message(f"warning: invalid token file {file}. Consider removing it.")
     return token_files
 
 

cli/tools/can/can.py

@@ -2,12 +2,9 @@ from pathlib import Path
 
 import can
 import typer
-from rich.console import Console
 
 from cli.typer import typer_utils
-
-err_console = Console(stderr=True)
-console = Console()
+from cli.utils.console import print_generic_error, print_success
 
 HELP = """
 CAN related tools
@@ -49,7 +46,7 @@ def convert(
                 for msg in reader:
                     writer.on_message_received(msg)
         except Exception as e:
-            err_console.print(f":boom: [bold red]Failed to convert file[/bold red]: {e}")
+            print_generic_error(f"Failed to convert file: {e}")
 
 
 @app.command("validate")
@@ -76,6 +73,6 @@ def validate(
                 for msg in reader:
                     if print_to_terminal:
                         writer.on_message_received(msg)
-            console.print(f"Successfully verified {in_file}")
+            print_success(f"{in_file} verified")
         except Exception as e:
-            err_console.print(f":boom: [bold red]Failed to convert file[/bold red]: {e}")
+            print_generic_error(f"Failed to convert file: {e}")

cli/topology/__init__.py

@@ -0,0 +1,3 @@
+from cli.topology.cmd import app
+
+__all__ = ["app"]

cli/topology/cmd.py

@@ -1,101 +1,79 @@
 from __future__ import annotations
 
-import dataclasses
-import datetime
-from typing import Any
-
 import typer
-from rich.console import Console
 
-from cli.errors import ErrorPrinter
-from cli.settings import settings
+from cli.topology.start_trial import (
+    MissingOrganizationError,
+    NoActiveAccountError,
+    NotAuthorizedError,
+    NotAuthorizedToStartTrialError,
+    NotSignedInError,
+    SubscriptionExpiredError,
+    start_trial,
+)
 from cli.typer import typer_utils
-from cli.utils.rest_helper import RestHelper
+from cli.utils.console import print_generic_error, print_generic_message, print_hint
 
 HELP = """
-RemotiveTopology commands
+Manage RemotiveTopology resources
 """
-console = Console()
-app = typer_utils.create_typer(help=HELP)
-
-
-@dataclasses.dataclass
-class Subscription:
-    type: str
-    display_name: str
-    feature: str
-    start_date: str  # TODO: add datetime
-    end_date: str  # TODO: add datetime
-
 
-def _print_current_subscription(subscription_info: dict[str, Any]) -> None:
-    subscription_type = subscription_info.get("subscriptionType")
-    end_date_str = subscription_info.get("endDate")
-    now = datetime.datetime.now()
-
-    def parse_date(date_str: str | None) -> datetime.datetime | None:
-        return datetime.datetime.fromisoformat(date_str) if date_str else None
-
-    expires = parse_date(end_date_str)
-
-    if subscription_type == "trial":
-        if expires and expires < now:
-            console.print(f"Your Topology trial expired {end_date_str}, please contact support@remotivelabs.com")
-        else:
-            console.print(f"You already have an active topology trial, it expires {end_date_str}")
-
-    elif subscription_type == "paid":
-        if expires and expires < now:
-            console.print(f"Topology subscription has ended, expired {end_date_str}")
-        else:
-            console.print(f"You already have an active topology subscription, it expires {end_date_str or 'Never'}")
-
-    else:
-        ErrorPrinter.print_generic_error("Unexpected exception, please contact support@remotivelabs.com")
-        raise typer.Exit(1)
+app = typer_utils.create_typer(rich_markup_mode="rich", help=HELP)
 
 
 @app.command("start-trial")
-def start_trial(
+def start_trial_cmd(  # noqa: C901
     organization: str = typer.Option(None, help="Organization to start trial for", envvar="REMOTIVE_CLOUD_ORGANIZATION"),
 ) -> None:
     """
-    Allows you ta start a 30 day trial subscription for running RemotiveTopology, you can read more at https://docs.remotivelabs.com/docs/remotive-topology.
+    Allows you ta start a 30 day trial subscription for running RemotiveTopology.
 
+    You can read more at https://docs.remotivelabs.com/docs/remotive-topology.
     """
-    RestHelper.use_progress("Checking access tokens...", transient=True)
-    active_token = settings.get_active_token_file()
-    if not active_token:
-        if len(settings.list_personal_token_files()) == 0:
-            console.print(
-                "You must first sign in to RemotiveCloud, please use [bold]remotive cloud auth login[/bold] to sign-in"
-                "This requires a RemotiveCloud account, if you do not have an account you can sign-up at https://cloud.remotivelabs.com"
-            )
-        else:
-            console.print(
-                "You have not actived your account, please run [bold]remotive cloud auth activate[/bold] to choose an account"
-                "or [bold]remotive cloud auth login[/bold] to sign-in"
-            )
-        return
-
-    has_access = RestHelper.has_access("/api/whoami")
-    if not has_access:
-        ErrorPrinter.print_generic_message("Your current active credentials are not valid")
-        raise typer.Exit(1)
-
-    active_account = settings.get_active_account()
-    if active_account and not organization and not active_account.default_organization:
-        ErrorPrinter.print_hint("You have not specified any organization and no default organization is set")
-        raise typer.Exit(1)
-
-    sub = RestHelper.handle_get(f"/api/bu/{organization}/features/topology", return_response=True, allow_status_codes=[404, 403])
-    if sub.status_code == 404:
-        created = RestHelper.handle_post(f"/api/bu/{organization}/features/topology", return_response=True)
-        console.print(f"Topology trial started, it expires {created.json()['endDate']}")
-    elif sub.status_code == 403:
-        ErrorPrinter.print_generic_error(f"You are not allowed to start-trial topology in organization {organization}")
+    try:
+        subscription = start_trial(organization)
+        if subscription.type == "trial":
+            print_generic_message(f"topology trial active, expires {subscription.end_date}")
+        elif subscription.type == "paid":
+            print_generic_message(f"you already have a topology subscription, expires {subscription.end_date or 'Never'}")
+
+    except NotSignedInError:
+        print_generic_error(
+            "You must first sign in to RemotiveCloud, please use [bold]remotive cloud auth login[/bold] to sign-in"
+            "This requires a RemotiveCloud account, if you do not have an account you can sign-up at https://cloud.remotivelabs.com"
+        )
+        raise typer.Exit(2)
+
+    except NoActiveAccountError:
+        print_hint(
+            "You have not actived your account, please run [bold]remotive cloud auth activate[/bold] to choose an account"
+            "or [bold]remotive cloud auth login[/bold] to sign-in"
+        )
+        raise typer.Exit(3)
+
+    except NotAuthorizedError:
+        print_hint(
+            "Your current active credentials are not valid, please run [bold]remotive cloud auth login[/bold] to sign-in again."
+            "This requires a RemotiveCloud account, if you do not have an account you can sign-up at https://cloud.remotivelabs.com"
+        )
+        raise typer.Exit(4)
+
+    except MissingOrganizationError:
+        print_hint("You have not specified any organization and no default organization is set")
+        raise typer.Exit(5)
+
+    except NotAuthorizedToStartTrialError as e:
+        print_generic_error(f"You are not allowed to start-trial topology in organization {e.organization}")
+        raise typer.Exit(6)
+
+    except SubscriptionExpiredError as e:
+        if e.subscription.type == "trial":
+            print_generic_error(f"Your Topology trial expired {e.subscription.end_date}, please contact support@remotivelabs.com")
+            raise typer.Exit(7)
+
+        print_generic_error(f"Your Topology subscription has expired {e.subscription.end_date}, please contact support@remotivelabs.com")
+        raise typer.Exit(7)
+
+    except Exception as e:
+        print_generic_error(f"Unexpected error: {e}")
         raise typer.Exit(1)
-    else:
-        subscription_info = sub.json()
-        _print_current_subscription(subscription_info)
-    return

cli/topology/start_trial.py

@@ -0,0 +1,105 @@
+from __future__ import annotations
+
+import datetime
+from dataclasses import dataclass
+from datetime import date
+from typing import Any
+
+from cli.settings import settings
+from cli.settings.config_file import Account
+from cli.utils.rest_helper import RestHelper
+from cli.utils.time import parse_date
+
+
+class NoActiveAccountError(Exception):
+    """Raised when the user has no active account, but there are available accounts to activate"""
+
+
+class NotSignedInError(Exception):
+    """Raised when the user has no active account, and no available accounts to activate"""
+
+
+class NotAuthorizedError(Exception):
+    """Raised when the user is not authorized"""
+
+    def __init__(self, account: Account):
+        self.account = account
+
+
+class MissingOrganizationError(Exception):
+    """Raised when the user has not specified an organization and no default organization is set"""
+
+
+class NotAuthorizedToStartTrialError(Exception):
+    """Raised when the user is not authorized to start a topology trial"""
+
+    def __init__(self, account: Account, organization: str):
+        self.account = account
+        self.organization = organization
+
+
+class SubscriptionExpiredError(Exception):
+    """Raised when the subscription has expired"""
+
+    def __init__(self, subscription: Subscription):
+        self.subscription = subscription
+
+
+@dataclass
+class Subscription:
+    type: str
+    display_name: str
+    feature: str
+    start_date: date
+    end_date: date
+
+    @staticmethod
+    def from_dict(data: Any) -> Subscription:
+        if not isinstance(data, dict):
+            raise ValueError(f"Invalid subscription data {data}")
+
+        return Subscription(
+            type=data["subscriptionType"],
+            display_name=data["displayName"],
+            feature=data["feature"],
+            start_date=parse_date(data["startDate"]),
+            end_date=parse_date(data["endDate"]),
+        )
+
+
+def start_trial(organization: str | None = None) -> Subscription:
+    """
+    Start a 30 day trial subscription for running RemotiveTopology.
+
+    # TODO: move authentication (and basic authorization) to a logged_in decorator
+    """
+    active_account = settings.get_active_account()
+    active_token_file = settings.get_active_token_file()
+
+    if not active_account or not active_token_file:
+        if len(settings.list_accounts()) == 0:
+            raise NotSignedInError()
+        raise NoActiveAccountError()
+
+    if not RestHelper.has_access("/api/whoami"):
+        raise NotAuthorizedError(account=active_account)
+
+    valid_org = organization or active_account.default_organization
+    if not valid_org:
+        raise MissingOrganizationError()
+
+    res = RestHelper.handle_get(f"/api/bu/{valid_org}/features/topology", return_response=True, allow_status_codes=[403, 404])
+    if res.status_code == 403:
+        raise NotAuthorizedToStartTrialError(account=active_account, organization=valid_org)
+    if res.status_code == 404:
+        created = RestHelper.handle_post(f"/api/bu/{valid_org}/features/topology", return_response=True)
+        subscription = Subscription.from_dict(created.json())
+    else:
+        # 200 OK means we already have a valid subscription
+        subscription = Subscription.from_dict(res.json())
+
+    # check subscription validity
+    if subscription.end_date < datetime.datetime.now().date():
+        raise SubscriptionExpiredError(subscription=subscription)
+
+    return subscription

cli/typer/typer_utils.py

@@ -2,24 +2,21 @@ from typing import Any
 
 import typer
 from click import Context
-from rich.console import Console
 from typer.core import TyperGroup
 
+from cli.utils.console import print_generic_message
+
 
 class OrderCommands(TyperGroup):
     def list_commands(self, _ctx: Context):  # type: ignore
         return list(self.commands)
 
 
-console = Console()
-
-
 def create_typer(**kwargs: Any) -> typer.Typer:
     """Create a Typer instance with default settings."""
-    # return typer.Typer(no_args_is_help=True, **kwargs)
     return typer.Typer(cls=OrderCommands, no_args_is_help=True, invoke_without_command=True, **kwargs)
 
 
 def print_padded(label: str, right_text: str, length: int = 30) -> None:
     padded_label = label.ljust(length)  # pad to 30 characters
-    console.print(f"{padded_label} {right_text}")
+    print_generic_message(f"{padded_label} {right_text}")

cli/utils/console.py

@@ -0,0 +1,61 @@
+from __future__ import annotations
+
+import os
+import sys
+from typing import Any
+
+import grpc
+from rich.console import Console
+
+console = Console(soft_wrap=True)
+err_console = Console(stderr=True, soft_wrap=True)
+
+
+def print_grpc_error(error: grpc.RpcError) -> None:
+    if error.code() == grpc.StatusCode.UNAUTHENTICATED:
+        is_access_token = os.environ["ACCESS_TOKEN"]
+        if is_access_token is not None and is_access_token == "true":
+            err_console.print(f":boom: [bold red]Authentication failed[/bold red]: {error.details()}")
+            err_console.print("Please login again")
+        else:
+            err_console.print(":boom: [bold red]Authentication failed[/bold red]")
+            err_console.print("Failed to verify api-key")
+    else:
+        err_console.print(f":boom: [bold red]Unexpected error, status code[/bold red]: {error.code()}")
+        err_console.print(error.details())
+    sys.exit(1)
+
+
+def print_hint(message: str) -> None:
+    err_console.print(f":point_right: [bold]{message}[/bold]")
+
+
+def print_generic_error(message: str) -> None:
+    err_console.print(f":boom: [bold red]Failed[/bold red]: {message}")
+
+
+def print_success(message: str) -> None:
+    console.print(f"[bold green]Success![/bold green] {message}")
+
+
+def print_generic_message(message: str) -> None:
+    console.print(f"[bold]{message}[/bold]")
+
+
+def print_newline() -> None:
+    """TODO: is this needed?"""
+    console.print("\n")
+
+
+def print_url(url: str) -> None:
+    console.print(url, style="bold")
+
+
+def print_unformatted(message: Any) -> None:
+    """TODO: should we allow this?"""
+    console.print(message)
+
+
+def print_unformatted_to_stderr(message: Any) -> None:
+    """TODO: should we allow this?"""
+    err_console.print(message)

cli/utils/rest_helper.py

@@ -12,14 +12,11 @@ from typing import Any, BinaryIO, Dict, List, Optional, Union, cast
 
 import requests
 from requests.exceptions import JSONDecodeError
-from rich.console import Console
 from rich.progress import Progress, SpinnerColumn, TextColumn, wrap_file
 
-from cli.errors import ErrorPrinter
 from cli.settings import settings
 from cli.utils import versions
-
-err_console = Console(stderr=True)
+from cli.utils.console import print_generic_error, print_generic_message, print_hint, print_unformatted, print_unformatted_to_stderr
 
 if "REMOTIVE_CLOUD_HTTP_LOGGING" in os.environ:
     logging.basicConfig()
@@ -84,7 +81,10 @@ class RestHelper:
 
     @staticmethod
     def ensure_auth_token(quiet: bool = False, access_token: Optional[str] = None) -> None:
-        # TODO: remove this? We already set the default organization as env in remotive.py
+        """
+        TODO: remove setting org, as we already set the default organization as env in remotive.py?
+        TODO: don't sys.exit, raise error instead
+        """
         if "REMOTIVE_CLOUD_ORGANIZATION" not in os.environ:
             active_account = settings.get_active_account()
             if active_account:
@@ -98,7 +98,7 @@ class RestHelper:
             if not token:
                 if quiet:
                     return
-                ErrorPrinter.print_hint("you are not logged in, please login using [green]remotive cloud auth login[/green]")
+                print_hint("you are not logged in, please login using [green]remotive cloud auth login[/green]")
                 sys.exit(1)
 
         RestHelper.__headers["Authorization"] = f"Bearer {token.strip()}"
@@ -155,38 +155,45 @@ class RestHelper:
 
     @staticmethod
     def check_api_result(response: requests.Response, allow_status_codes: List[int] | None = None) -> None:
+        """
+        TODO: don't sys.exit, raise error instead
+        """
         if response.status_code == 426:  # CLI upgrade
-            ErrorPrinter.print_hint(response.text)
+            print_hint(response.text)
             sys.exit(1)
         if response.status_code > 299:
             if allow_status_codes is not None and response.status_code in allow_status_codes:
                 return
-            err_console.print(f":boom: [bold red]Got status code[/bold red]: {response.status_code}")
+            print_generic_error(f"Got status code: {response.status_code}")
             if response.status_code == 401:
-                err_console.print("Your token is not valid or has expired, please login again or activate another account")
+                print_generic_message("Your token is not valid or has expired, please login again or activate another account")
             else:
-                err_console.print(response.text)
+                print_unformatted_to_stderr(response.text)
             sys.exit(1)
 
     @staticmethod
     def print_api_result(response: requests.Response) -> None:
+        """
+        TODO: don't sys.exit, raise error instead
+        TODO: dont print from here, return and let caller print instead
+        """
         if response.status_code == 426:  # CLI upgrade
-            ErrorPrinter.print_hint(response.text)
+            print_hint(response.text)
             sys.exit(1)
 
         if response.status_code >= 200 and response.status_code < 300:
             if len(response.content) >= 2:
                 try:
-                    print(json.dumps(response.json()))
+                    print_unformatted(json.dumps(response.json()))
                 except JSONDecodeError:
-                    err_console.print(":boom: [bold red]Json parse error[/bold red]: Please try again and report if the error persists")
+                    print_generic_error("Json parse error: Please try again and report if the error persists")
             sys.exit(0)
         else:
-            err_console.print(f":boom: [bold red]Got status code[/bold red]: {response.status_code}")
+            print_generic_error(f"Got status code: {response.status_code}")
             if response.status_code == 401:
-                err_console.print("Your token is not valid or has expired, please login again or activate another account")
+                print_generic_message("Your token is not valid or has expired, please login again or activate another account")
             else:
-                err_console.print(response.text)
+                print_unformatted_to_stderr(response.text)
             sys.exit(1)
 
     @staticmethod

cli/utils/versions.py

@@ -10,8 +10,8 @@ from importlib.metadata import version as python_project_version
 
 from packaging.version import InvalidVersion, Version
 
-from cli.errors import ErrorPrinter
 from cli.settings import Settings
+from cli.utils.console import print_hint
 
 
 def cli_version() -> str:
@@ -117,6 +117,4 @@ def _print_update_info(cur: str, latest: str) -> None:
         else "upgrade with: pipx install -U remotivelabs-cli"
     )
 
-    ErrorPrinter.print_hint(
-        f"Update available: remotivelabs-cli {cur} → {latest} , ({instructions}) we always recommend to use latest version"
-    )
+    print_hint(f"Update available: remotivelabs-cli {cur} → {latest} , ({instructions}) we always recommend to use latest version")

{remotivelabs_cli-0.3.0.dist-info → remotivelabs_cli-0.3.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: remotivelabs-cli
-Version: 0.3.0
+Version: 0.3.2
 Summary: CLI for operating RemotiveCloud and RemotiveBroker
 Author: Johan Rask
 Author-email: johan.rask@remotivelabs.com