remotivelabs-cli 0.0.42__py3-none-any.whl → 0.1.0a1__py3-none-any.whl

cli/settings/core.py

@@ -1,15 +1,20 @@
 from __future__ import annotations
 
-import datetime
+import os
+import re
 import shutil
+import stat
 import sys
-from json import JSONDecodeError
+from dataclasses import dataclass
 from pathlib import Path
-from typing import Tuple
+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 token_file as tf
+from cli.settings.config_file import ConfigFile
 from cli.settings.token_file import TokenFile
 
 err_console = Console(stderr=True)
@@ -19,6 +24,7 @@ CONFIG_DIR_PATH = Path.home() / ".config" / "remotive"
 INCORRECT_CONFIG_DIR_PATH = Path.home() / ".config" / ".remotive"
 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-"
@@ -31,10 +37,19 @@ class InvalidSettingsFilePathError(Exception):
     """Raised when trying to access an invalid settings file or file path"""
 
 
+class NotFoundError(Exception):
+    """Raised when a token cannot be found in settings"""
+
+
 class TokenNotFoundError(Exception):
     """Raised when a token cannot be found in settings"""
 
 
+@dataclass()
+class CliConfigFile:
+    default_organisation: Union[str, None]
+
+
 class Settings:
     """
     Settings for the remotive CLI
@@ -45,8 +60,8 @@ class Settings:
     def __init__(self, config_dir: Path, deprecated_config_dirs: list[Path] | None = None) -> None:
         self.config_dir = config_dir
         self._active_secret_token_path = self.config_dir / ACTIVE_TOKEN_FILE_NAME
+        self._cli_config = self.config_dir / CLI_CONFIG_FILE_NAME
 
-        # no migration of deprecated config dirs if the new config dir already exists
         if self.config_dir.exists():
             return
 
@@ -56,6 +71,65 @@ class Settings:
             for deprecated_config_dir in deprecated_config_dirs:
                 self._migrate_legacy_config_dir(deprecated_config_dir)
 
+    # def _write_properties(self, filepath: Path, props: CliConfigFile) -> None:
+    #    with open(filepath, "w", encoding="utf-8") as file:
+    #        # keys = sorted(props.keys()) if sort_keys else props.keys()
+    #        # for key in keys:
+    #        file.write(f"default_organisation={props.default_organisation}\n")
+
+    def _read_properties(self, filepath: Path) -> CliConfigFile:
+        props = {}
+        with open(filepath, "r", encoding="utf-8") as file:
+            for line_num, line in enumerate(file, start=1):
+                line_stripped = line.strip()
+                if not line_stripped or line_stripped.startswith("#"):
+                    continue
+                if "=" not in line_stripped:
+                    raise ValueError(f"Invalid line format at line {line_num}: {line}")
+                key, value = line_stripped.split("=", 1)
+                key, value = key.strip(), value.strip()
+                if key in props:
+                    raise ValueError(f"Duplicate key '{key}' found at line {line_num}")
+                props[key] = value
+        if "default_organisation" in props:
+            return CliConfigFile(default_organisation=props["default_organisation"])
+        return CliConfigFile(default_organisation=None)
+
+    def set_default_organisation(self, organisation: str) -> None:
+        cli_config = self.get_cli_config()
+
+        try:
+            token = settings.get_active_token_file()
+            cli_config.set_account_field(token.account.email, organisation)
+            self._write_config_file(cli_config)
+        except TokenNotFoundError:
+            ErrorPrinter.print_hint("You must have an account activated in order to set default organisation")
+            sys.exit(1)
+
+    # def set_default_config_as_env(self) -> None:
+    #    config = self.get_cli_config()
+    #    if config.default_organisation is not None:
+    #        if "REMOTIVE_CLOUD_ORGANISATION" not in os.environ:
+    #            os.environ["REMOTIVE_CLOUD_ORGANISATION"] = config.default_organisation
+
+    # def get_active_cli_account(self) -> Optional[Account]:
+    #    try:
+    #        token = self.get_active_token_file()
+    #        config = self.get_cli_config()
+    #        if token.account.email in config.accounts:
+    #            return config.accounts[token.account.email]
+    #        return None
+    #    except TokenNotFoundError:
+    #        ErrorPrinter.print_hint("Cannot get active config without activating account credentials first")
+    #        sys.exit(1)
+
+    def get_cli_config(self) -> ConfigFile:
+        try:
+            return self._read_config_file()
+        except TokenNotFoundError:
+            return ConfigFile()
+            # self._write_properties(CONFIG_DIR_PATH / CLI_CONFIG_FILE_NAME, [])
+
     def get_active_token(self) -> str:
         """
         Get the current active token secret
@@ -67,25 +141,48 @@ class Settings:
         """
         Get the current active token file
         """
-        if not self._active_secret_token_path.exists():
-            raise TokenNotFoundError("no active token file found")
 
-        return self._read_token_file(self._active_secret_token_path)
+        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)
+        raise TokenNotFoundError
+        # if not self._active_secret_token_path.exists():
+        #    raise TokenNotFoundError("no active token file found")
+        # return self._read_token_file(self._active_secret_token_path)
 
-    def activate_token(self, name: str) -> None:
+    def activate_token(self, token: TokenFile) -> None:
         """
         Activate a token by name or path
 
         The token secret will be set as the current active secret.
         """
-        token_file = self.get_token_file(name)
-        self._write_token_file(self._active_secret_token_path, token_file)
+        # token_file = self.get_token_file(name)
+        cli_config = self.get_cli_config()
+        cli_config.activate(token.account.email)
+        # if token_file.account.email not in cli_config.accounts:
+        #    cli_config.set_account_field(token_file.account.email)
+        self._write_config_file(cli_config)
+        # self._write_token_file(self._active_secret_token_path, token_file)
 
     def clear_active_token(self) -> None:
         """
         Clear the current active token
         """
-        self._active_secret_token_path.unlink(missing_ok=True)
+        config = self.get_cli_config()
+        config.active = None
+        self._write_config_file(config)
+
+    # self._active_secret_token_path.unlink(missing_ok=True)
+
+    def get_token_file_by_email(self, email: str) -> Optional[TokenFile]:
+        tokens = [t for t in self.list_personal_tokens() if t.account is not None and t.account.email == email]
+        if len(tokens) > 0:
+            return tokens[0]
+        tokens = [t for t in self.list_service_account_tokens() if t.account is not None and t.account.email == email]
+        if len(tokens) > 0:
+            return tokens[0]
+        return None
 
     def get_token_file(self, name: str) -> TokenFile:
         """
@@ -93,6 +190,8 @@ class Settings:
         """
         if Path(name).exists():
             return self._read_token_file(Path(name))
+        if Path(CONFIG_DIR_PATH / name).exists():
+            return self._read_token_file(Path(CONFIG_DIR_PATH / name))
 
         return self._get_token_by_name(name)[0]
 
@@ -107,18 +206,19 @@ class Settings:
                 raise InvalidSettingsFilePathError(f"cannot remove a token file not located in settings dir {self.config_dir}")
             return Path(name).unlink()
 
-        # TODO: what about the active token? # pylint: disable=fixme
-
+        # TODO: what about the active token?
         path = self._get_token_by_name(name)[1]
+        # print("Deleting", path)
+        print(path)
         return path.unlink()
 
-    def add_and_activate_short_lived_cli_token(self, token: str) -> TokenFile:
-        """
-        Activates a short lived token
-        """
-        token_file = tf.loads(token)
-        self._write_token_file(self._active_secret_token_path, token_file)
-        return token_file
+    # def add_and_activate_short_lived_cli_token(self, token: str) -> TokenFile:
+    #    """
+    #    Activates a short lived token
+    #    """
+    #    token_file = tf.loads(token)
+    #    self._write_token_file(self._active_secret_token_path, token_file)
+    #    return token_file
 
     def add_personal_token(
         self,
@@ -131,15 +231,24 @@ class Settings:
         """
         token_file = tf.loads(token)
 
-        file = f"{PERSONAL_TOKEN_FILE_PREFIX}{token_file.name}.json"
+        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"
         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)
+        self._write_config_file(cli_config)
 
         if activate:
-            self.activate_token(token_file.name)
+            self.activate_token(token_file)
 
         return token_file
 
@@ -155,20 +264,38 @@ class Settings:
         """
         return [f[1] for f in self._list_personal_tokens()]
 
-    def add_service_account_token(self, service_account: str, token: str) -> TokenFile:
-        """
-        Add a service account token to the config directory
-        """
+    def add_service_account_token(self, token: str) -> TokenFile:
         token_file = tf.loads(token)
 
-        file = f"{SERVICE_ACCOUNT_TOKEN_FILE_PREFIX}{service_account}-{token_file.name}.json"
+        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}{email}-{token_file.name}.json"
         path = self.config_dir / file
-        if path.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)
+        self._write_config_file(cli_config)
+
+        # if activate:
+        #    self.activate_token(token_file.account.email)
+
         return token_file
 
+        # token_file = tf.loads(token)
+        # file = f"{SERVICE_ACCOUNT_TOKEN_FILE_PREFIX}{service_account}-{token_file.name}.json"
+        # path = self.config_dir / file
+        # if path.exists():
+        #    raise FileExistsError(f"Token file already exists: {path}")
+
+        # self._write_token_file(path, token_file)
+        # return token_file
+
     def list_service_account_tokens(self) -> list[TokenFile]:
         """
         List all service account tokens
@@ -195,13 +322,15 @@ class Settings:
         return matches[0]
 
     def _list_token_files(self, prefix: str = "") -> list[TokenFileMetadata]:
-        # list all tokens with the correct prefix in the config dir, but omit the special active token file
-        def is_path_prefixed_and_not_active_secret(path: Path) -> bool:
+        """list all tokens with the correct prefix in the config dir, but omit files that are not token files"""
+
+        def is_valid_token_file(path: Path) -> bool:
             has_correct_prefix = path.is_file() and path.name.startswith(prefix)
             is_active_secret = path == self._active_secret_token_path
-            return has_correct_prefix and not is_active_secret
+            is_cli_config = path == self._cli_config
+            return has_correct_prefix and not is_active_secret and not is_cli_config
 
-        paths = [path for path in self.config_dir.iterdir() if is_path_prefixed_and_not_active_secret(path)]
+        paths = [path for path in self.config_dir.iterdir() if is_valid_token_file(path)]
 
         return [(self._read_token_file(token_file), token_file) for token_file in paths]
 
@@ -209,6 +338,10 @@ class Settings:
         data = self._read_file(path)
         return tf.loads(data)
 
+    def _read_config_file(self) -> ConfigFile:
+        data = self._read_file(self.config_dir / CLI_CONFIG_FILE_NAME)
+        return config_file.loads(data)
+
     def _read_file(self, path: Path) -> str:
         if not path.exists():
             raise TokenNotFoundError(f"File could not be found: {path}")
@@ -216,7 +349,15 @@ class Settings:
 
     def _write_token_file(self, path: Path, token: TokenFile) -> Path:
         data = tf.dumps(token)
-        return self._write_file(path, data)
+        path = self._write_file(path, data)
+        os.chmod(path, stat.S_IRUSR | stat.S_IWUSR)
+        return path
+
+    def _write_config_file(self, config: ConfigFile) -> Path:
+        data = config_file.dumps(config)
+        path = self._write_file(self._cli_config, data)
+        os.chmod(path, stat.S_IRUSR | stat.S_IWUSR)
+        return path
 
     def _write_file(self, path: Path, data: str) -> Path:
         if self.config_dir not in path.parents:
@@ -233,24 +374,32 @@ class Settings:
         shutil.copytree(str(path), str(self.config_dir), dirs_exist_ok=True)
         secret = path / ACTIVE_TOKEN_FILE_NAME
         if secret.exists():
-            value = secret.read_text(encoding="utf-8").strip()
+            sys.stderr.write(f"Removing old activated token {secret}")
+            secret.unlink(missing_ok=True)
+            # value = secret.read_text(encoding="utf-8").strip()
             # The existing token file might either be a token file, or simply a string. We handle both cases...
-            try:
-                token = tf.loads(value)
-            except JSONDecodeError:
-                token = tf.TokenFile(
-                    name="MigratedActiveToken",
-                    token=value,
-                    created=str(datetime.datetime.now().isoformat()),
-                    expires="unknown",
-                )
-            self.add_and_activate_short_lived_cli_token(tf.dumps(token))
+            # try:
+            #    token = tf.loads(value)
+            # except JSONDecodeError:
+            #    token = tf.TokenFile(
+            #        version="1.0",
+            #        type="service-account" if value.startswith("sa") else "authorized_user",
+            #        name="MigratedActiveToken",
+            #        token=value,
+            #        created=str(datetime.datetime.now().isoformat()),
+            #        expires="unknown",
+            #        account=TokenFileAccount(email="unknown@remotivecloud.com"),
+            #    )
+            # self.add_and_activate_short_lived_cli_token(tf.dumps(token))
         shutil.rmtree(str(path))
 
 
 def create_settings() -> Settings:
     """Create remotive CLI config directory and return its settings instance"""
-    return Settings(CONFIG_DIR_PATH, deprecated_config_dirs=[DEPRECATED_CONFIG_DIR_PATH, INCORRECT_CONFIG_DIR_PATH])
+    return Settings(
+        CONFIG_DIR_PATH,
+        deprecated_config_dirs=[DEPRECATED_CONFIG_DIR_PATH, INCORRECT_CONFIG_DIR_PATH],
+    )
 
 
 settings = create_settings()

cli/settings/migrate_all_token_files.py

@@ -0,0 +1,74 @@
+from __future__ import annotations
+
+from cli.settings import settings
+from cli.settings.core import ACTIVE_TOKEN_FILE_NAME
+from cli.settings.migrate_token_file import InvalidTokenError, UnsupportedTokenVersionError, migrate_legacy_token
+from cli.settings.token_file import TokenFile, dumps
+
+
+def _migrate_legacy_tokens(tokens: list[TokenFile]) -> tuple[list[TokenFile], set[str]]:
+    """
+    Determine which tokens can be updated and which should be removed.
+
+    Returns:
+        tuple of (updated_tokens, invalid_tokens)
+    """
+    updated_tokens: list[TokenFile] = []
+    invalid_tokens: set[str] = set()
+
+    for token in tokens:
+        try:
+            migrated_token = migrate_legacy_token(token)
+            if migrated_token.version != token.version:
+                updated_tokens.append(migrated_token)
+        except (InvalidTokenError, UnsupportedTokenVersionError):
+            # Token not valid or unsupported version, mark for removal
+            invalid_tokens.add(token.name)
+
+    return updated_tokens, invalid_tokens
+
+
+def _write_updated_tokens(updated_tokens: list[TokenFile]) -> None:
+    for updated_token in updated_tokens:
+        settings.remove_token_file(name=updated_token.name)
+        if updated_token.type == "authorized_user":
+            settings.add_personal_token(dumps(updated_token), overwrite_if_exists=True)
+        elif updated_token.type == "service_account":
+            settings.add_service_account_token(dumps(updated_token))
+        else:
+            raise ValueError(f"Unsupported token type: {updated_token.type}")
+
+
+def _remove_invalid_tokens(invalid_tokens: set[str]) -> None:
+    for token_name in invalid_tokens:
+        settings.remove_token_file(name=token_name)
+
+
+def _remove_old_secret_file() -> bool:
+    old_activated_secret_file = settings.config_dir / ACTIVE_TOKEN_FILE_NAME
+    old_secret_exists = old_activated_secret_file.exists()
+    if old_secret_exists:
+        old_activated_secret_file.unlink(missing_ok=True)
+    return old_secret_exists
+
+
+def migrate_any_legacy_tokens(tokens: list[TokenFile]) -> bool:
+    """
+    Migrate any legacy tokens to the latest TokenFile format.
+
+    Returns True if any tokens were migrated, False otherwise.
+    """
+    # Get tokens to update/remove
+    updated_tokens, invalid_tokens = _migrate_legacy_tokens(tokens)
+
+    # Perform file operations
+    _write_updated_tokens(updated_tokens)
+    _remove_invalid_tokens(invalid_tokens)
+
+    # Remove old secret file if exists
+    old_secret_removed = _remove_old_secret_file()
+    if old_secret_removed:
+        return True  # We migrated at least one token
+
+    # only return True if we migrated at least one token
+    return len(updated_tokens) + len(invalid_tokens) > 0

cli/settings/migrate_token_file.py

@@ -0,0 +1,52 @@
+from __future__ import annotations
+
+from cli.settings.token_file import TokenFile, TokenFileAccount
+from cli.utils.rest_helper import RestHelper
+
+
+class InvalidTokenError(Exception):
+    """Raised when a token is invalid."""
+
+
+class UnsupportedTokenVersionError(Exception):
+    """Raised when a token version is not supported."""
+
+
+def migrate_legacy_token(token: TokenFile) -> TokenFile:
+    """
+    Migrate a token from a legacy format to the latest format.
+
+    Args:
+        token: The token to migrate.
+
+    Returns:
+        TokenFile: The migrated token.
+
+    Raises:
+        InvalidTokenError: If the token is invalid.
+        UnsupportedTokenVersionError: If the token version is not supported.
+    """
+    # use a naive approach to compare versions for now
+    version = float(token.version)
+
+    # already migrated
+    if version >= 1.1:
+        return token
+
+    if version == 1.0:
+        res = RestHelper.handle_get("/api/whoami", return_response=True, allow_status_codes=[401, 400, 403], access_token=token.token)
+        if res.status_code != 200:
+            raise InvalidTokenError(f"Token {token.name} is invalid")
+
+        email = res.json()["email"]
+        return TokenFile(
+            version="1.1",
+            type=token.type,
+            name=token.name,
+            token=token.token,
+            created=token.created,
+            expires=token.expires,
+            account=TokenFileAccount(email=email),
+        )
+
+    raise UnsupportedTokenVersionError(f"Unsupported token version: {token.version}")

cli/settings/token_file.py

@@ -3,20 +3,85 @@ from __future__ import annotations
 import dataclasses
 import json
 from dataclasses import dataclass
+from datetime import date, datetime
+from typing import Any, Literal
+
+DEFAULT_EMAIL = "unknown@remotivecloud.com"
+
+TokenType = Literal["authorized_user", "service_account"]
+
+
+def _parse_date(date_str: str) -> date:
+    normalized = date_str.replace("Z", "+00:00")
+    return datetime.fromisoformat(normalized).date()
+
+
+def _parse_token_type(token: str) -> TokenType:
+    if token.startswith("pa"):
+        return "authorized_user"
+    if token.startswith("sa"):
+        return "service_account"
+    raise ValueError(f"Unknown token type for token: {token}")
+
+
+def _from_dict(d: dict[str, Any]) -> TokenFile:
+    if "version" not in d:
+        token_type = _parse_token_type(d["token"])
+        return TokenFile(
+            version="1.0",
+            type=token_type,
+            name=d["name"],
+            token=d["token"],
+            created=_parse_date(d["created"]),
+            expires=_parse_date(d["expires"]),
+            account=TokenFileAccount(email=DEFAULT_EMAIL),
+        )
+
+    account_email = d.get("account", {}).get("email", DEFAULT_EMAIL)
+    return TokenFile(
+        version=d["version"],
+        type=d["type"],
+        name=d["name"],
+        token=d["token"],
+        created=_parse_date(d["created"]),
+        expires=_parse_date(d["expires"]),
+        account=TokenFileAccount(email=account_email),
+    )
 
 
 def loads(data: str) -> TokenFile:
-    d = json.loads(data)
-    return TokenFile(name=d["name"], token=d["token"], created=d["created"], expires=d["expires"])
+    return _from_dict(json.loads(data))
 
 
 def dumps(token: TokenFile) -> str:
     return json.dumps(dataclasses.asdict(token), default=str)
 
 
+@dataclass
+class TokenFileAccount:
+    email: str
+
+
 @dataclass
 class TokenFile:
+    version: str
+    type: TokenType
     name: str
     token: str
-    created: str
-    expires: str
+    created: date
+    expires: date
+    account: TokenFileAccount
+
+    def is_expired(self) -> bool:
+        return datetime.today().date() > self.expires
+
+    def expires_in_days(self) -> int:
+        return (self.expires - datetime.today().date()).days
+
+    @staticmethod
+    def from_json_str(data: str) -> TokenFile:
+        return loads(data)
+
+    @staticmethod
+    def from_dict(data: dict[str, Any]) -> TokenFile:
+        return _from_dict(data)

cli/tools/can/can.py

@@ -48,7 +48,7 @@ def convert(
             with can.Logger(out_file) as writer:
                 for msg in reader:
                     writer.on_message_received(msg)
-        except Exception as e:  # pylint: disable=W0718
+        except Exception as e:
             err_console.print(f":boom: [bold red]Failed to convert file[/bold red]: {e}")
 
 
@@ -77,5 +77,5 @@ def validate(
                     if print_to_terminal:
                         writer.on_message_received(msg)
             console.print(f"Successfully verified {in_file}")
-        except Exception as e:  # pylint: disable=W0718
+        except Exception as e:
             err_console.print(f":boom: [bold red]Failed to convert file[/bold red]: {e}")

cli/typer/typer_utils.py

@@ -1,8 +1,25 @@
 from typing import Any
 
 import typer
+from click import Context
+from rich.console import Console
+from typer.core import TyperGroup
+
+
+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(no_args_is_help=True, **kwargs)
+    return typer.Typer(cls=OrderCommands, no_args_is_help=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}")