remotivelabs-cli 0.1.1__tar.gz → 0.2.0a2__tar.gz

{remotivelabs_cli-0.1.1 → remotivelabs_cli-0.2.0a2}/PKG-INFO

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

{remotivelabs_cli-0.1.1 → remotivelabs_cli-0.2.0a2}/cli/cloud/auth/cmd.py

@@ -61,9 +61,9 @@ def print_access_token(
     else:
         config = settings.get_cli_config()
         if account in config.accounts:
-            token_name = config.accounts[account].credentials_name
+            token_file_name = config.accounts[account].credentials_file
             try:
-                print(settings.get_token_file(token_name).token)
+                print(settings.get_token_file(token_file_name).token)
             except TokenNotFoundError:
                 ErrorPrinter.print_generic_error(f"Token file for {account} could not be found", exit_code=1)
         else:

{remotivelabs_cli-0.1.1 → remotivelabs_cli-0.2.0a2}/cli/cloud/auth/login.py

@@ -18,7 +18,8 @@ from typing_extensions import override
 
 from cli.cloud.auth_tokens import do_activate, prompt_to_set_org
 from cli.errors import ErrorPrinter
-from cli.settings import TokenFile, TokenNotFoundError, settings
+from cli.settings import TokenNotFoundError, settings
+from cli.settings.token_file import TokenFile
 from cli.utils.rest_helper import RestHelper as Rest
 
 httpd: HTTPServer

{remotivelabs_cli-0.1.1 → remotivelabs_cli-0.2.0a2}/cli/cloud/auth_tokens.py

@@ -9,7 +9,9 @@ from rich.table import Table
 from cli.api.cloud import tokens
 from cli.cloud.organisations import do_select_default_org
 from cli.errors import ErrorPrinter
-from cli.settings import TokenFile, TokenNotFoundError, settings
+from cli.settings import TokenNotFoundError, settings
+from cli.settings.config_file import Account
+from cli.settings.token_file import TokenFile
 from cli.typer import typer_utils
 from cli.utils.rest_helper import RestHelper as Rest
 
@@ -39,8 +41,13 @@ def _prompt_choice(  # noqa: C901, PLR0912
 
     for token in choices:
         account = accounts.get(token.account.email)
-        if account and account.credentials_name and account.credentials_name in (token.name or ""):
-            included_tokens.append(token)
+        if account and account.credentials_file:
+            try:
+                token_file = settings.get_token_file(account.credentials_file)
+                if token_file.name in (token.name or ""):
+                    included_tokens.append(token)
+            except TokenNotFoundError:
+                excluded_tokens.append(token)
         else:
             excluded_tokens.append(token)
 
@@ -49,9 +56,18 @@ def _prompt_choice(  # noqa: C901, PLR0912
 
     included_tokens.sort(key=lambda token: token.created, reverse=True)
 
+    def get_token_or_none(account: Optional[Account]) -> Optional[TokenFile]:
+        if account is None:
+            return None
+        try:
+            return settings.get_token_file(account.credentials_file)
+        except TokenNotFoundError:
+            return None
+
     active_token_index = None
     for idx, choice in enumerate(included_tokens, start=1):
-        is_active = active_account is not None and active_account.credentials_name == choice.name
+        active_token = get_token_or_none(active_account)
+        is_active = active_account is not None and active_token is not None and active_token.name == choice.name
         active_token_index = idx if is_active else active_token_index
         table.add_row(
             f"[yellow]{idx}",

{remotivelabs_cli-0.1.1 → remotivelabs_cli-0.2.0a2}/cli/cloud/organisations.py

@@ -85,7 +85,7 @@ def do_select_default_org(organisation_uid: Optional[str] = None, get: bool = Fa
     else:
         account = settings.get_cli_config().get_active()
         if account is not None:
-            token = settings.get_token_file(account.credentials_name)
+            token = settings.get_token_file(account.credentials_file)
             if token.type != "authorized_user":
                 ErrorPrinter.print_hint(
                     "You must supply the organization name as argument when using a service-account since the "

{remotivelabs_cli-0.1.1 → remotivelabs_cli-0.2.0a2}/cli/errors.py

@@ -41,4 +41,4 @@ class ErrorPrinter:
 
     @staticmethod
     def print_generic_message(message: str) -> None:
-        err_console.print(f"[bold]{message}[/bold]:")
+        err_console.print(f"[bold]{message}[/bold]")

{remotivelabs_cli-0.1.1 → remotivelabs_cli-0.2.0a2}/cli/remotive.py

@@ -9,14 +9,14 @@ from rich.console import Console
 from trogon import Trogon  # type: ignore
 from typer.main import get_group
 
+from cli.broker.brokers import app as broker_app
+from cli.cloud.cloud_cli import app as cloud_app
+from cli.connect.connect import app as connect_app
+from cli.settings import settings
 from cli.settings.migrate_all_token_files import migrate_any_legacy_tokens
-
-from .broker.brokers import app as broker_app
-from .cloud.cloud_cli import app as cloud_app
-from .connect.connect import app as connect_app
-from .settings import settings
-from .tools.tools import app as tools_app
-from .typer import typer_utils
+from cli.tools.tools import app as tools_app
+from cli.topology.cmd import app as topology_app
+from cli.typer import typer_utils
 
 err_console = Console(stderr=True)
 
@@ -90,5 +90,14 @@ app.add_typer(
     name="cloud",
     help="Manage resources in RemotiveCloud",
 )
+app.add_typer(
+    topology_app,
+    name="topology",
+    help="""
+RemotiveTopology actions
+
+Read more at https://docs.remotivelabs.com/docs/remotive-topology
+""",
+)
 app.add_typer(connect_app, name="connect", help="Integrations with other systems")
 app.add_typer(tools_app, name="tools")

remotivelabs_cli-0.2.0a2/cli/settings/__init__.py

@@ -0,0 +1,5 @@
+from cli.settings.core import InvalidSettingsFilePathError, Settings, TokenNotFoundError, settings
+
+# from cli.settings.token_file import TokenFile
+
+__all__ = ["settings", "TokenNotFoundError", "InvalidSettingsFilePathError", "Settings"]

{remotivelabs_cli-0.1.1 → remotivelabs_cli-0.2.0a2}/cli/settings/config_file.py

@@ -4,15 +4,64 @@ import dataclasses
 import json
 from dataclasses import dataclass
 from json import JSONDecodeError
-from typing import Dict, Optional
+from typing import Any, Dict, Optional
 
 from dacite import from_dict
 
+from cli.settings.token_file import TokenFile
+
+
+def upgrade_config(config: dict[str, Any]) -> Optional[dict[str, Any]]:
+    """
+    Reads a JSON config from in_path, replaces each account's 'credentials_name'
+    with 'credentials_file' (by calling get_filename_for_name), and writes the result
+    back to out_path (or overwrites in_path if out_path is None).
+    """
+    from cli.settings import TokenNotFoundError, settings
+
+    accounts = config.get("accounts", {})
+    to_delete = []
+    found_old = False
+    for account, info in list(accounts.items()):
+        cred_name = info.pop("credentials_name", None)
+        if not cred_name:
+            continue
+        found_old = True
+        try:
+            cred_file = settings.get_token_file(cred_name).get_token_file_name()
+        except TokenNotFoundError:
+            # schedule this account for removal
+            to_delete.append(account)
+            print(f"Dropping account {account!r}: token file for {cred_name} not found")
+            continue
+
+        info["credentials_file"] = cred_file
+
+    # actually remove them
+    for account in to_delete:
+        del accounts[account]
+
+    if found_old:
+        return config
+    return None
+
+
+def _from_dict(data: dict[str, Any]) -> ConfigFile:
+    from cli.settings import settings
+
+    config = upgrade_config(data)
+    if config is not None:
+        print("Migrating old configuration format")
+        updated_config: ConfigFile = from_dict(ConfigFile, config)
+        settings.write_config_file(updated_config)
+        return updated_config
+    return from_dict(ConfigFile, data)
+
 
 def loads(data: str) -> ConfigFile:
     try:
         d = json.loads(data)
-        return from_dict(ConfigFile, d)
+        return _from_dict(d)
     except JSONDecodeError as e:
         # ErrorPrinter.print_generic_error("Invalid json format, config.json")
         raise JSONDecodeError(
@@ -26,7 +75,7 @@ def dumps(config: ConfigFile) -> str:
 
 @dataclass
 class Account:
-    credentials_name: str
+    credentials_file: str
     default_organization: Optional[str] = None
     # Add project as well
 
@@ -66,15 +115,15 @@ class ConfigFile:
         if self.accounts:
             self.accounts.pop(email, None)
 
-    def init_account(self, email: str, token_name: str) -> None:
+    def init_account(self, email: str, token_file: TokenFile) -> None:
         if self.accounts is None:
             self.accounts = {}
 
         account = self.accounts.get(email)
         if not account:
-            account = Account(credentials_name=token_name)
+            account = Account(credentials_file=token_file.get_token_file_name())
         else:
-            account.credentials_name = token_name
+            account.credentials_file = token_file.get_token_file_name()
         self.accounts[email] = account
 
     def set_account_field(self, email: str, default_organization: Optional[str] = None) -> ConfigFile:

{remotivelabs_cli-0.1.1 → remotivelabs_cli-0.2.0a2}/cli/settings/core.py

@@ -1,7 +1,6 @@
 from __future__ import annotations
 
 import os
-import re
 import shutil
 import stat
 import sys
@@ -13,7 +12,7 @@ from typing import Optional, Tuple, Union
 from rich.console import Console
 
 from cli.errors import ErrorPrinter
-from cli.settings import config_file
+from cli.settings import config_file, token_file
 from cli.settings import token_file as tf
 from cli.settings.config_file import ConfigFile
 from cli.settings.token_file import TokenFile
@@ -27,9 +26,6 @@ DEPRECATED_CONFIG_DIR_PATH = Path.home() / ".remotive"
 
 CLI_CONFIG_FILE_NAME = "config.json"
 ACTIVE_TOKEN_FILE_NAME = "cloud.secret.token"
-PERSONAL_TOKEN_FILE_PREFIX = "personal-token-"
-SERVICE_ACCOUNT_TOKEN_FILE_PREFIX = "service-account-token-"
-
 
 TokenFileMetadata = Tuple[TokenFile, Path]
 
@@ -128,8 +124,9 @@ class Settings:
 
         active_account = self.get_cli_config().get_active()
         if active_account is not None:
-            token_name = active_account.credentials_name
-            return self.get_token_file(token_name)
+            token_file_name = active_account.credentials_file
+            return self._read_token_file(self.config_dir / token_file_name)
+
         raise TokenNotFoundError
         # if not self._active_secret_token_path.exists():
         #    raise TokenNotFoundError("no active token file found")
@@ -213,21 +210,14 @@ class Settings:
         Add a personal token
         """
         token_file = tf.loads(token)
-
-        def email_to_safe_filename(email: str) -> str:
-            # Replace any invalid character with an underscore
-            return re.sub(r'[<>:"/\\|?*]', "_", email)
-
-        # From now, user will never be None when adding a token so in this case token_file.user is never None
-        email = email_to_safe_filename(token_file.account.email) if token_file.account is not None else "unknown"
-        file = f"{PERSONAL_TOKEN_FILE_PREFIX}{token_file.name}-{email}.json"
+        file = token_file.get_token_file_name()
         path = self.config_dir / file
         if path.exists() and not overwrite_if_exists:
             raise FileExistsError(f"Token file already exists: {path}")
 
         self._write_token_file(path, token_file)
         cli_config = self.get_cli_config()
-        cli_config.init_account(email=token_file.account.email, token_name=token_file.name)
+        cli_config.init_account(email=token_file.account.email, token_file=token_file)
         self._write_config_file(cli_config)
 
         if activate:
@@ -249,21 +239,15 @@ class Settings:
 
     def add_service_account_token(self, token: str) -> TokenFile:
         token_file = tf.loads(token)
-
-        def email_to_safe_filename(email: str) -> str:
-            # Replace any invalid character with an underscore
-            return re.sub(r'[<>:"/\\|?*]', "_", email)
-
-            # From now, user will never be None when adding a token so in this case token_file.user is never None
-
-        email = email_to_safe_filename(token_file.account.email) if token_file.account is not None else "unknown"
-        file = f"{SERVICE_ACCOUNT_TOKEN_FILE_PREFIX}{token_file.name}-{email}.json"
+        if token_file.type != "service_account":
+            raise ValueError("Token type MUST be service_account")
+        file = token_file.get_token_file_name()
         path = self.config_dir / file
 
         self._write_token_file(path, token_file)
         print(f"Service account token stored at {path}")
         cli_config = self.get_cli_config()
-        cli_config.init_account(email=token_file.account.email, token_name=token_file.name)
+        cli_config.init_account(email=token_file.account.email, token_file=token_file)
         self._write_config_file(cli_config)
 
         # if activate:
@@ -293,10 +277,10 @@ class Settings:
         return [f[1] for f in self._list_service_account_tokens()]
 
     def _list_personal_tokens(self) -> list[TokenFileMetadata]:
-        return self._list_token_files(prefix=PERSONAL_TOKEN_FILE_PREFIX)
+        return self._list_token_files(prefix=token_file.PERSONAL_TOKEN_FILE_PREFIX)
 
     def _list_service_account_tokens(self) -> list[TokenFileMetadata]:
-        return self._list_token_files(prefix=SERVICE_ACCOUNT_TOKEN_FILE_PREFIX)
+        return self._list_token_files(prefix=token_file.SERVICE_ACCOUNT_TOKEN_FILE_PREFIX)
 
     def _get_token_by_name(self, name: str) -> TokenFileMetadata:
         token_files = self._list_token_files()
@@ -318,7 +302,9 @@ class Settings:
                 return False
 
         def is_valid_token_file(path: Path) -> bool:
-            is_token_file = path.name.startswith(SERVICE_ACCOUNT_TOKEN_FILE_PREFIX) or path.name.startswith(PERSONAL_TOKEN_FILE_PREFIX)
+            is_token_file = path.name.startswith(tf.SERVICE_ACCOUNT_TOKEN_FILE_PREFIX) or path.name.startswith(
+                tf.PERSONAL_TOKEN_FILE_PREFIX
+            )
             has_correct_prefix = path.is_file() and path.name.startswith(prefix)
             is_active_secret = path == self._active_secret_token_path
             is_cli_config = path == self._cli_config
@@ -347,6 +333,10 @@ class Settings:
         os.chmod(path, stat.S_IRUSR | stat.S_IWUSR)
         return path
 
+    # Temporary function while considering how to solve this
+    def write_config_file(self, config: ConfigFile) -> Path:
+        return self._write_config_file(config)
+
     def _write_config_file(self, config: ConfigFile) -> Path:
         data = config_file.dumps(config)
         path = self._write_file(self._cli_config, data)

{remotivelabs_cli-0.1.1 → remotivelabs_cli-0.2.0a2}/cli/settings/token_file.py

@@ -2,10 +2,13 @@ from __future__ import annotations
 
 import dataclasses
 import json
+import re
 from dataclasses import dataclass
 from datetime import date, datetime
 from typing import Any, Literal
 
+# from cli.settings.core import PERSONAL_TOKEN_FILE_PREFIX, SERVICE_ACCOUNT_TOKEN_FILE_PREFIX
+
 DEFAULT_EMAIL = "unknown@remotivecloud.com"
 
 TokenType = Literal["authorized_user", "service_account"]
@@ -62,6 +65,10 @@ class TokenFileAccount:
     email: str
 
 
+PERSONAL_TOKEN_FILE_PREFIX = "personal-token-"
+SERVICE_ACCOUNT_TOKEN_FILE_PREFIX = "service-account-token-"
+
+
 @dataclass
 class TokenFile:
     version: str
@@ -72,6 +79,17 @@ class TokenFile:
     expires: date
     account: TokenFileAccount
 
+    def get_token_file_name(self) -> str:
+        def email_to_safe_filename(email: str) -> str:
+            # Replace any invalid character with an underscore
+            return re.sub(r'[<>:"/\\|?*]', "_", email)
+
+        # From now, user will never be None when adding a token so in this case token_file.user is never None
+        email = email_to_safe_filename(self.account.email) if self.account is not None else "unknown"
+        if self.type == "authorized_user":
+            return f"{PERSONAL_TOKEN_FILE_PREFIX}{self.name}-{email}.json"
+        return f"{SERVICE_ACCOUNT_TOKEN_FILE_PREFIX}{self.name}-{email}.json"
+
     def is_expired(self) -> bool:
         return datetime.today().date() > self.expires
 

remotivelabs_cli-0.2.0a2/cli/topology/cmd.py

@@ -0,0 +1,98 @@
+import dataclasses
+import datetime
+from typing import Any
+
+import typer
+from rich.console import Console
+
+from cli.errors import ErrorPrinter
+from cli.settings import TokenNotFoundError, settings
+from cli.typer import typer_utils
+from cli.utils.rest_helper import RestHelper
+
+HELP = """
+RemotiveTopology commands
+"""
+console = Console()
+app = typer_utils.create_typer(help=HELP)
+
+
+@dataclasses.dataclass
+class Subscription:
+    type: str
+    display_name: str
+    feature: str
+    start_date: str
+    end_date: str
+
+
+def _print_current_subscription(subscription_info: dict[str, Any]) -> None:
+    subscription_type = subscription_info["subscriptionType"]
+
+    if subscription_type == "trial":
+        expires = datetime.datetime.fromisoformat(subscription_info["endDate"])
+        if expires < datetime.datetime.now():
+            console.print(f"Your Topology trial expired {subscription_info['endDate']}, please contact support@remotivelabs.com")
+        else:
+            console.print(f"You already have an active topology trial, it expires {subscription_info['endDate']}")
+        # A paid subscription might not have an endDate
+    elif subscription_type == "paid":
+        if "endDate" in subscription_type:
+            expires = datetime.datetime.fromisoformat(subscription_info["endDate"])
+        else:
+            expires = None
+
+        if expires is not None and expires < datetime.datetime.now():
+            console.print(f"Topology subscription has ended, expired {subscription_info['endDate']}")
+        else:
+            console.print(f"You already have an active topology subscription, it expires {expires if expires is not None else 'Never'}")
+
+    else:
+        ErrorPrinter.print_generic_error("Unexpected exception, please contact support@remotivelabs.com")
+        raise typer.Exit(1)
+
+
+@app.command("start-trial")
+def start_trial(
+    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.
+
+    """
+    RestHelper.use_progress("Checking access tokens...", transient=True)
+    try:
+        _ = settings.get_active_token_file()
+    except TokenNotFoundError:
+        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 active 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)
+
+    if organization is None and settings.get_cli_config().get_active_default_organisation() is None:
+        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}")
+        raise typer.Exit(1)
+    else:
+        subscription_info = sub.json()
+        _print_current_subscription(subscription_info)
+    return

{remotivelabs_cli-0.1.1 → remotivelabs_cli-0.2.0a2}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "remotivelabs-cli"
-version = "0.1.1"
+version = "0.2.0a2"
 description = "CLI for operating RemotiveCloud and RemotiveBroker"
 authors = ["Johan Rask <johan.rask@remotivelabs.com>"]
 readme = "README.md"

remotivelabs_cli-0.1.1/cli/settings/__init__.py

@@ -1,4 +0,0 @@
-from cli.settings.core import InvalidSettingsFilePathError, Settings, TokenNotFoundError, settings
-from cli.settings.token_file import TokenFile
-
-__all__ = ["settings", "TokenFile", "TokenNotFoundError", "InvalidSettingsFilePathError", "Settings"]