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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: remotivelabs-cli
-Version: 0.1.1
+Version: 0.2.0
 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.0}/cli/cloud/auth/cmd.py

@@ -27,9 +27,6 @@ def login(browser: bool = typer.Option(default=True, help="Does not automaticall
     If not able to open a browser it will show fallback to headless login and show a link that
     users can copy into any browser when this is unsupported where running the cli - such as in docker,
     virtual machine or ssh sessions.
-
-    This will be used as the current access token in all subsequent requests. This would
-    be the same as activating a personal access key or service-account access key.
     """
     do_login(headless=not browser)
 
@@ -61,9 +58,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.0}/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.0}/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
 
@@ -27,10 +29,6 @@ def _prompt_choice(  # noqa: C901, PLR0912
     info_message: Optional[str] = None,
 ) -> Optional[TokenFile]:
     accounts = settings.get_cli_config().accounts
-    try:
-        active_account = settings.get_cli_config().get_active()
-    except TokenNotFoundError:
-        active_account = None
 
     table = Table("#", "Active", "Type", "Token", "Account", "Created", "Expires")
 
@@ -39,8 +37,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,10 +52,27 @@ def _prompt_choice(  # noqa: C901, PLR0912
 
     included_tokens.sort(key=lambda token: token.created, reverse=True)
 
+    def get_active_account_or_none() -> Optional[Account]:
+        try:
+            return settings.get_cli_config().get_active()
+        except TokenNotFoundError:
+            return None
+
+    def get_active_token_or_none() -> Optional[TokenFile]:
+        try:
+            active_account = get_active_account_or_none()
+            if active_account is not None:
+                return settings.get_token_file(active_account.credentials_file)
+        except TokenNotFoundError:
+            pass
+        return None
+
+    active_token = get_active_token_or_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
+        is_active = 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}",
             ":white_check_mark:" if is_active else "",
@@ -62,7 +82,6 @@ def _prompt_choice(  # noqa: C901, PLR0912
             str(choice.created),
             str(choice.expires),
         )
-    # console.print("It seems like you have access tokens from previous login, you can select one of these instead of logging in")
     console.print(table)
 
     if skip_prompt:
@@ -165,9 +184,7 @@ def select_personal_token(
     do_activate(token_name)
 
 
-def do_activate(
-    token_name: Optional[str],
-) -> Optional[TokenFile]:
+def do_activate(token_name: Optional[str]) -> Optional[TokenFile]:
     if token_name is not None:
         try:
             token_file = settings.get_token_file(token_name)
@@ -208,8 +225,6 @@ def list_and_select_personal_token(
         sa_tokens = settings.list_service_account_tokens()
         personal_tokens.extend(sa_tokens)
 
-    # merged = _merge_local_tokens_with_cloud(personal_tokens)
-
     selected_token = _prompt_choice(personal_tokens, skip_prompt=skip_prompt, info_message=info_message)
     if selected_token is not None:
         settings.activate_token(selected_token)

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

@@ -76,7 +76,7 @@ def do_select_default_org(organisation_uid: Optional[str] = None, get: bool = Fa
     """
     if get:
         default_organisation = settings.get_cli_config().get_active_default_organisation()
-        if default_organisation is not None:
+        if default_organisation:
             console.print(default_organisation)
         else:
             console.print("No default organization set")
@@ -84,8 +84,8 @@ def do_select_default_org(organisation_uid: Optional[str] = None, get: bool = Fa
         settings.set_default_organisation(organisation_uid)
     else:
         account = settings.get_cli_config().get_active()
-        if account is not None:
-            token = settings.get_token_file(account.credentials_name)
+        if account:
+            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.0}/cli/cloud/recordings.py

@@ -137,14 +137,13 @@ def mount(  # noqa: C901
         r = Rest.handle_get(url=f"/api/project/{project}/brokers/personal", return_response=True, allow_status_codes=[404])
 
         if r.status_code == 200:
-            broker = r.json()["shortName"]
-
+            broker_info = r.json()
+            broker = broker_info["shortName"]
         elif r.status_code == 404:
             r = do_start("personal", project, "", return_response=True)
             if r.status_code != 200:
                 print(r.text)
                 sys.exit(0)
-            broker = r.json()["shortName"]
         else:
             sys.stderr.write(f"Got http status code {r.status_code}")
             raise typer.Exit(0)
@@ -154,7 +153,6 @@ def mount(  # noqa: C901
         if r.status_code == 404:
             if ensure_broker_started:
                 r = do_start(broker, project, "", return_response=True)
-
                 if r.status_code != 200:
                     print(r.text)
                     sys.exit(1)
@@ -164,6 +162,9 @@ def mount(  # noqa: C901
         elif r.status_code != 200:
             sys.stderr.write(f"Got http status code {r.status_code}")
             raise typer.Exit(1)
+
+    broker_info = r.json()
+    broker = broker_info["shortName"]
     broker_config_query = ""
     if transformation_name != "default":
         broker_config_query = f"?brokerConfigName={transformation_name}"
@@ -174,7 +175,8 @@ def mount(  # noqa: C901
         return_response=True,
         progress_label="Preparing recording on broker...",
     )
-    print("Successfully mounted recording on broker")
+    err_console.print("Successfully mounted recording on broker")
+    print(json.dumps(broker_info))
 
 
 @app.command(help="Downloads the specified recording file to disk")

{remotivelabs_cli-0.1.1 → remotivelabs_cli-0.2.0}/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.0}/cli/remotive.py

@@ -6,20 +6,29 @@ from importlib.metadata import version
 import typer
 from rich import print as rich_print
 from rich.console import Console
-from trogon import Trogon  # type: ignore
+from trogon import Trogon
 from typer.main import get_group
 
-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.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.core import Settings
+from cli.settings.migration.migrate_all_token_files import migrate_any_legacy_tokens
+from cli.settings.migration.migrate_config_file import migrate_config_file
+from cli.settings.migration.migrate_legacy_dirs import migrate_legacy_settings_dirs
+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)
 
+
+def is_featue_flag_enabled(env_var: str) -> bool:
+    """Check if an environment variable indicates a feature is enabled."""
+    return os.getenv(env_var, "").lower() in ("true", "1", "yes", "on")
+
+
 if os.getenv("GRPC_VERBOSITY") is None:
     os.environ["GRPC_VERBOSITY"] = "NONE"
 
@@ -32,8 +41,6 @@ For documentation - https://docs.remotivelabs.com
 """,
 )
 
-# settings.set_default_config_as_env()
-
 
 def version_callback(value: bool) -> None:
     if value:
@@ -48,14 +55,26 @@ def test_callback(value: int) -> None:
         raise typer.Exit()
 
 
-def _migrate_old_tokens() -> None:
-    tokens = settings.list_personal_tokens()
-    tokens.extend(settings.list_service_account_tokens())
-    if migrate_any_legacy_tokens(tokens):
+def run_migrations(settings: Settings) -> None:
+    """
+    Run all migration scripts.
+
+    Each migration script is responsible for a particular migration, and order matters.
+    """
+    # 1. Migrate legacy settings dirs
+    migrate_legacy_settings_dirs(settings.config_dir)
+
+    # 2. Migrate any legacy tokens
+    has_migrated_tokens = migrate_any_legacy_tokens(settings)
+
+    # 3. Migrate legacy config file format
+    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")
 
 
-def _set_default_org_as_env() -> None:
+def set_default_org_as_env(settings: Settings) -> None:
     """
     If not already set, take the default organisation from file and set as env
     This has to be done early before it is read
@@ -68,10 +87,16 @@ def _set_default_org_as_env() -> None:
 
 @app.callback()
 def main(
-    _the_version: bool = typer.Option(None, "--version", callback=version_callback, is_eager=False, help="Print current version"),
+    _the_version: bool = typer.Option(
+        None,
+        "--version",
+        callback=version_callback,
+        is_eager=False,
+        help="Print current version",
+    ),
 ) -> None:
-    _set_default_org_as_env()
-    _migrate_old_tokens()
+    run_migrations(settings)
+    set_default_org_as_env(settings)
     # Do other global stuff, handle other global options here
 
 
@@ -92,3 +117,14 @@ app.add_typer(
 )
 app.add_typer(connect_app, name="connect", help="Integrations with other systems")
 app.add_typer(tools_app, name="tools")
+
+if is_featue_flag_enabled("REMOTIVE_TOPOLOGY_ENABLED"):
+    app.add_typer(
+        topology_app,
+        name="topology",
+        help="""
+    RemotiveTopology actions
+
+    Read more at https://docs.remotivelabs.com/docs/remotive-topology
+    """,
+    )

remotivelabs_cli-0.2.0/cli/settings/__init__.py

@@ -0,0 +1,21 @@
+from cli.settings.config_file import Account, ConfigFile
+from cli.settings.config_file import dumps as dumps_config_file
+from cli.settings.config_file import loads as loads_config_file
+from cli.settings.core import InvalidSettingsFilePathError, Settings, TokenNotFoundError, settings
+from cli.settings.token_file import TokenFile
+from cli.settings.token_file import dumps as dumps_token_file
+from cli.settings.token_file import loads as loads_token_file
+
+__all__ = [
+    "settings",
+    "TokenNotFoundError",
+    "InvalidSettingsFilePathError",
+    "Settings",
+    "TokenFile",
+    "ConfigFile",
+    "Account",
+    "dumps_config_file",
+    "loads_config_file",
+    "dumps_token_file",
+    "loads_token_file",
+]

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

@@ -3,21 +3,16 @@ from __future__ import annotations
 import dataclasses
 import json
 from dataclasses import dataclass
-from json import JSONDecodeError
-from typing import Dict, Optional
+from typing import Any, Optional
 
 from dacite import from_dict
 
+from cli.settings.token_file import TokenFile
+
 
 def loads(data: str) -> ConfigFile:
-    try:
-        d = json.loads(data)
-        return from_dict(ConfigFile, d)
-    except JSONDecodeError as e:
-        # ErrorPrinter.print_generic_error("Invalid json format, config.json")
-        raise JSONDecodeError(
-            f"File config.json is not valid json, please edit or remove file to have it re-created ({e.msg})", pos=e.pos, doc=e.doc
-        )
+    d = json.loads(data)
+    return from_dict(ConfigFile, d)
 
 
 def dumps(config: ConfigFile) -> str:
@@ -26,7 +21,7 @@ def dumps(config: ConfigFile) -> str:
 
 @dataclass
 class Account:
-    credentials_name: str
+    credentials_file: str
     default_organization: Optional[str] = None
     # Add project as well
 
@@ -35,53 +30,51 @@ class Account:
 class ConfigFile:
     version: str = "1.0"
     active: Optional[str] = None
-    accounts: Dict[str, Account] = dataclasses.field(default_factory=dict)
+    accounts: dict[str, Account] = dataclasses.field(default_factory=dict)
 
     def get_active_default_organisation(self) -> Optional[str]:
         active_account = self.get_active()
-        return active_account.default_organization if active_account is not None else None
+        return active_account.default_organization if active_account else None
 
     def get_active(self) -> Optional[Account]:
-        if self.active is not None:
-            account = self.accounts.get(self.active)
-            if account is not None:
-                return account
+        if not self.active:
+            return None
+        account = self.get_account(self.active)
+        if not account:
             raise KeyError(f"Activated account {self.active} is not a valid account")
-        return None
+        return account
 
     def activate(self, email: str) -> None:
-        account = self.accounts.get(email)
-
-        if account is not None:
-            self.active = email
-        else:
+        account = self.get_account(email)
+        if not account:
             raise KeyError(f"Account {email} does not exists")
+        self.active = email
 
     def get_account(self, email: str) -> Optional[Account]:
-        if self.accounts:
-            return self.accounts[email]
-        return None
+        if not self.accounts:
+            return None
+        return self.accounts.get(email, None)
 
     def remove_account(self, email: str) -> None:
         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)
+        account = self.get_account(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:
         if self.accounts is None:
             self.accounts = {}
 
-        account = self.accounts.get(email)
+        account = self.get_account(email)
         if not account:
             raise KeyError(f"Account with email {email} has not been initialized with token")
 
@@ -90,3 +83,11 @@ class ConfigFile:
             account.default_organization = default_organization
 
         return self
+
+    @staticmethod
+    def from_json_str(data: str) -> ConfigFile:
+        return loads(data)
+
+    @staticmethod
+    def from_dict(data: dict[str, Any]) -> ConfigFile:
+        return from_dict(ConfigFile, data)