remotivelabs-cli 0.2.0a2__py3-none-any.whl → 0.2.2__py3-none-any.whl

cli/settings/core.py

@@ -1,31 +1,27 @@
 from __future__ import annotations
 
 import os
-import shutil
 import stat
 import sys
-from dataclasses import dataclass
 from json import JSONDecodeError
 from pathlib import Path
-from typing import Optional, Tuple, Union
+from typing import Optional, Tuple
 
+from pydantic import ValidationError
 from rich.console import Console
 
 from cli.errors import ErrorPrinter
 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.state_file import StateFile
 from cli.settings.token_file import TokenFile
 
 err_console = Console(stderr=True)
 
-
 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"
+CLI_INTERNAL_STATE_FILE_NAME = "app-state.json"
 
 TokenFileMetadata = Tuple[TokenFile, Path]
 
@@ -34,67 +30,30 @@ 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
+    Settings handles tokens and other config for the remotive CLI
     """
 
     config_dir: Path
 
-    def __init__(self, config_dir: Path, deprecated_config_dirs: list[Path] | None = None) -> None:
+    def __init__(self, config_dir: Path) -> 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
-
-        if self.config_dir.exists():
-            return
-
-        # create the config dir and try to migrate legacy config dirs if they exist
         self.config_dir.mkdir(parents=True, exist_ok=True)
-        if deprecated_config_dirs:
-            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)
+        self.config_file_path = self.config_dir / CLI_CONFIG_FILE_NAME
+        if not self.config_file_path.exists():
+            self._write_config_file(ConfigFile())
+        self.state_dir = self.config_dir / "state"
+        self.state_file_path = self.state_dir / CLI_INTERNAL_STATE_FILE_NAME
+        if not self.state_file_path.exists():
+            self.write_state_file(StateFile())
 
     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)
@@ -108,7 +67,6 @@ class Settings:
             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:
         """
@@ -121,30 +79,22 @@ class Settings:
         """
         Get the current active token file
         """
-
         active_account = self.get_cli_config().get_active()
         if active_account is not None:
             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")
-        # return self._read_token_file(self._active_secret_token_path)
 
-    def activate_token(self, token: TokenFile) -> None:
+    def activate_token(self, token_file: 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)
         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)
+        cli_config.activate(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:
         """
@@ -154,9 +104,12 @@ class Settings:
         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]:
+        """
+        Get a token file by email.
+
+        If multiple tokens are found, the first one is returned.
+        """
         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]
@@ -169,11 +122,15 @@ class Settings:
         """
         Get a token file by name or path
         """
+        # 1. Try relative path
+        if (self.config_dir / name).exists():
+            return self._read_token_file(self.config_dir / name)
+
+        # 2. Try absolute path
         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))
 
+        # 3. Try name
         return self._get_token_by_name(name)[0]
 
     def remove_token_file(self, name: str) -> None:
@@ -189,41 +146,39 @@ class Settings:
 
         # TODO: what about the active token?
         path = self._get_token_by_name(name)[1]
-        # print("Deleting", 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_personal_token(
-        self,
-        token: str,
-        activate: bool = False,
-        overwrite_if_exists: bool = False,
-    ) -> TokenFile:
+    def add_personal_token(self, token: str, activate: bool = False, overwrite_if_exists: bool = False) -> TokenFile:
         """
         Add a personal token
         """
-        token_file = tf.loads(token)
-        file = token_file.get_token_file_name()
-        path = self.config_dir / file
+        file = tf.loads(token)
+        if file.type != "authorized_user":
+            raise ValueError("Token type MUST be authorized_user")
+
+        file_name = file.get_token_file_name()
+        path = self.config_dir / file_name
         if path.exists() and not overwrite_if_exists:
             raise FileExistsError(f"Token file already exists: {path}")
 
-        self._write_token_file(path, token_file)
+        self._write_token_file(path, file)
         cli_config = self.get_cli_config()
-        cli_config.init_account(email=token_file.account.email, token_file=token_file)
+        cli_config.init_account(email=file.account.email, token_file=file)
         self._write_config_file(cli_config)
 
         if activate:
-            self.activate_token(token_file)
+            self.activate_token(file)
 
-        return token_file
+        return file
+
+    def read_state_file(self) -> StateFile:
+        try:
+            return StateFile.loads(self.state_file_path.read_text(encoding="utf-8"))
+        except Exception:
+            return StateFile()
+
+    def write_state_file(self, state_file: StateFile) -> None:
+        self._write_file(self.state_file_path, state_file.dumps())
 
     def list_personal_tokens(self) -> list[TokenFile]:
         """
@@ -237,33 +192,26 @@ class Settings:
         """
         return [f[1] for f in self._list_personal_tokens()]
 
-    def add_service_account_token(self, token: str) -> TokenFile:
+    def add_service_account_token(self, token: str, overwrite_if_exists: bool = False) -> TokenFile:
+        """
+        Add a service account token
+        """
         token_file = tf.loads(token)
         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
+        if path.exists() and not overwrite_if_exists:
+            raise FileExistsError(f"Token file already exists: {path}")
 
         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_file=token_file)
         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
@@ -290,13 +238,17 @@ 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 files that are not token files"""
+        """
+        list all tokens with the correct prefix in the config dir, but omit files that are not token files
+
+        TODO: improve is_valid_json and is_valid_token_file using token_file parsing instead
+        """
 
         def is_valid_json(path: Path) -> bool:
             try:
                 self._read_token_file(path)
                 return True
-            except JSONDecodeError:
+            except (JSONDecodeError, ValidationError):
                 # TODO - this should be printed but printing it here causes it to be displayed to many times
                 # err_console.print(f"File is not valid json, skipping. {path}")
                 return False
@@ -306,12 +258,13 @@ class Settings:
                 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
-            return is_token_file and is_valid_json(path) and has_correct_prefix and not is_active_secret and not is_cli_config
+            is_cli_config = path == self.config_file_path
+            is_present_in_cli_config_accounts = any(
+                path.name == account.credentials_file for account in self.get_cli_config().accounts.values()
+            )
+            return is_token_file and is_valid_json(path) and has_correct_prefix and not is_cli_config and is_present_in_cli_config_accounts
 
         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]
 
     def _read_token_file(self, path: Path) -> TokenFile:
@@ -338,8 +291,11 @@ class Settings:
         return self._write_config_file(config)
 
     def _write_config_file(self, config: ConfigFile) -> Path:
+        """
+        TODO: add read cache to avoid parsing the config every time we read it
+        """
         data = config_file.dumps(config)
-        path = self._write_file(self._cli_config, data)
+        path = self._write_file(self.config_file_path, data)
         os.chmod(path, stat.S_IRUSR | stat.S_IWUSR)
         return path
 
@@ -350,43 +306,8 @@ class Settings:
         path.write_text(data, encoding="utf8")
         return path
 
-    def _migrate_legacy_config_dir(self, path: Path) -> None:
-        if not path.exists():
-            return
-
-        sys.stderr.write(f"migrating deprecated config directory {path} to {self.config_dir}\n")
-        shutil.copytree(str(path), str(self.config_dir), dirs_exist_ok=True)
-        secret = path / ACTIVE_TOKEN_FILE_NAME
-        if secret.exists():
-            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(
-            #        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],
-    )
-
-
-settings = create_settings()
+
+settings = Settings(CONFIG_DIR_PATH)
 """
 Global/module-level settings instance. Module-level variables are only loaded once, at import time.
 

cli/settings/{migrate_all_token_files.py → migration/migrate_all_token_files.py}

@@ -1,12 +1,14 @@
 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.core import Settings
+from cli.settings.migration.migrate_token_file import InvalidTokenError, UnsupportedTokenVersionError, migrate_legacy_token
+from cli.settings.migration.migration_tools import list_token_files
 from cli.settings.token_file import TokenFile, dumps
 
+ACTIVE_TOKEN_FILE_NAME = "cloud.secret.token"
 
-def _migrate_legacy_tokens(tokens: list[TokenFile]) -> tuple[list[TokenFile], set[str]]:
+
+def migrate_legacy_tokens(tokens: list[TokenFile]) -> tuple[list[TokenFile], set[str]]:
     """
     Determine which tokens can be updated and which should be removed.
 
@@ -28,7 +30,7 @@ def _migrate_legacy_tokens(tokens: list[TokenFile]) -> tuple[list[TokenFile], se
     return updated_tokens, invalid_tokens
 
 
-def _write_updated_tokens(updated_tokens: list[TokenFile]) -> None:
+def _write_updated_tokens(settings: Settings, 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":
@@ -39,12 +41,12 @@ def _write_updated_tokens(updated_tokens: list[TokenFile]) -> None:
             raise ValueError(f"Unsupported token type: {updated_token.type}")
 
 
-def _remove_invalid_tokens(invalid_tokens: set[str]) -> None:
+def _remove_invalid_tokens(settings: Settings, invalid_tokens: set[str]) -> None:
     for token_name in invalid_tokens:
         settings.remove_token_file(name=token_name)
 
 
-def _remove_old_secret_file() -> bool:
+def _remove_old_secret_file(settings: Settings) -> bool:
     old_activated_secret_file = settings.config_dir / ACTIVE_TOKEN_FILE_NAME
     old_secret_exists = old_activated_secret_file.exists()
     if old_secret_exists:
@@ -52,21 +54,25 @@ def _remove_old_secret_file() -> bool:
     return old_secret_exists
 
 
-def migrate_any_legacy_tokens(tokens: list[TokenFile]) -> bool:
+def migrate_any_legacy_tokens(settings: Settings) -> bool:
     """
     Migrate any legacy tokens to the latest TokenFile format.
 
+    If the legacy secret file exists (cloud.secret.token), it will be removed.
+
     Returns True if any tokens were migrated, False otherwise.
     """
+    tokens = list_token_files(settings.config_dir)
+
     # Get tokens to update/remove
-    updated_tokens, invalid_tokens = _migrate_legacy_tokens(tokens)
+    updated_tokens, invalid_tokens = migrate_legacy_tokens(tokens)
 
     # Perform file operations
-    _write_updated_tokens(updated_tokens)
-    _remove_invalid_tokens(invalid_tokens)
+    _write_updated_tokens(settings, updated_tokens)
+    _remove_invalid_tokens(settings, invalid_tokens)
 
     # Remove old secret file if exists
-    old_secret_removed = _remove_old_secret_file()
+    old_secret_removed = _remove_old_secret_file(settings)
     if old_secret_removed:
         return True  # We migrated at least one token
 

cli/settings/migration/migrate_config_file.py

@@ -0,0 +1,59 @@
+from __future__ import annotations
+
+import json
+import sys
+from pathlib import Path
+from typing import Any, Optional
+
+from dacite import from_dict
+
+from cli.settings.config_file import ConfigFile, loads
+from cli.settings.core import Settings, TokenNotFoundError
+from cli.settings.migration.migration_tools import get_token_file
+
+
+def migrate_account_data(config: dict[str, Any], settings: Settings) -> Optional[dict[str, Any]]:
+    """
+    Migrates Account property credentials_name to credentials_file
+    """
+    accounts = config.get("accounts", {})
+    to_delete = []
+    found_old = False
+    for account_email, account_info in list(accounts.items()):
+        cred_name = account_info.pop("credentials_name", None)
+        if not cred_name:
+            continue
+        found_old = True
+        try:
+            cred_file = get_token_file(cred_name, settings.config_dir).get_token_file_name()
+        except TokenNotFoundError:
+            # schedule this account for removal
+            to_delete.append(account_email)
+            sys.stderr.write(f"Dropping account {account_email!r}: token file for {cred_name} not found")
+            continue
+
+        account_info["credentials_file"] = cred_file
+
+    # actually remove them (also remove active if it was the one being removed)
+    for account_email in to_delete:
+        del accounts[account_email]
+        if config.get("active", None) == account_email:
+            config["active"] = None
+
+    return config if found_old else None
+
+
+def migrate_config_file(path: Path, settings: Settings) -> ConfigFile:
+    """
+    Migrates data in config file to new format
+    """
+    data = path.read_text()
+    loaded_data: dict[str, Any] = json.loads(data)
+    migrated_data = migrate_account_data(loaded_data, settings)
+    if not migrated_data:
+        return loads(data)
+
+    sys.stderr.write("Migrating old configuration format")
+    migrated_config: ConfigFile = from_dict(data_class=ConfigFile, data=migrated_data)
+    settings.write_config_file(migrated_config)
+    return migrated_config

cli/settings/migration/migrate_legacy_dirs.py

@@ -0,0 +1,50 @@
+"""
+Migrate all files from legacy config directories to the new config directory. Any migration of the content is handled by specific migration
+scripts later in the migration process.
+"""
+
+import shutil
+import sys
+from pathlib import Path
+
+INCORRECT_CONFIG_DIR_PATH = Path.home() / ".config" / ".remotive"
+DEPRECATED_CONFIG_DIR_PATH = Path.home() / ".remotive"
+DEPRECATED_CONFIG_DIRS = [DEPRECATED_CONFIG_DIR_PATH, INCORRECT_CONFIG_DIR_PATH]
+
+
+def _copy_dir_fail_on_conflict(src: Path, dst: Path) -> None:
+    if not dst.is_dir():
+        dst.mkdir(parents=True, exist_ok=True)
+
+    for item in src.iterdir():
+        src_file = src / item.name
+        dst_file = dst / item.name
+
+        if src_file.is_file():
+            if dst_file.exists():
+                raise FileExistsError(f"File '{dst_file}' already exists.")
+            shutil.copy2(src_file, dst_file)  # preserve metadata
+
+
+def migrate_legacy_settings_dir(path: Path, target_dir: Path) -> None:
+    if not path.exists():
+        return
+
+    sys.stderr.write(f"found legacy config directory {path}, trying to migrate to {target_dir}\n")
+    try:
+        _copy_dir_fail_on_conflict(path, target_dir)
+        shutil.rmtree(str(path))
+    except FileExistsError as e:
+        sys.stderr.write(
+            f"file {e.filename} already exists in {target_dir}, so files in {path} cannot be migrated without risk of data loss. \
+            Please remove or move the files to {target_dir} manually and make sure to remove {path}.\n"
+        )
+        raise e
+
+
+def migrate_legacy_settings_dirs(target_dir: Path) -> None:
+    """
+    Migrate any valid configuration from legacy config directories to the new config directory.
+    """
+    for deprecated_config_dir in DEPRECATED_CONFIG_DIRS:
+        migrate_legacy_settings_dir(deprecated_config_dir, target_dir)

cli/settings/migration/migration_tools.py

@@ -0,0 +1,36 @@
+from itertools import chain
+from pathlib import Path
+
+from cli.settings.core import TokenNotFoundError
+from cli.settings.token_file import TokenFile
+
+
+def list_token_files(config_dir: Path) -> list[TokenFile]:
+    """
+    List all token files in the config directory
+
+    Note! Dont use settings, as that will couple settings to the old config and token formats we want to migrate away from.
+    """
+    token_files = []
+    patterns = ["personal-token-*.json", "service-account-token-*.json"]
+    files = list(chain.from_iterable(config_dir.glob(pattern) for pattern in patterns))
+    for file in files:
+        try:
+            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.")
+    return token_files
+
+
+def get_token_file(cred_name: str, config_dir: Path) -> TokenFile:
+    """
+    Get the token file for a given credentials name.
+
+    Note! Dont use settings, as that will couple settings to the old config and token formats we want to migrate away from.
+    """
+    token_files = list_token_files(config_dir)
+    matches = [token_file for token_file in token_files if token_file.name == cred_name]
+    if len(matches) != 1:
+        raise TokenNotFoundError(f"Token file for {cred_name} not found")
+    return matches[0]

cli/settings/state_file.py

@@ -0,0 +1,32 @@
+from __future__ import annotations
+
+import dataclasses
+import json
+from dataclasses import dataclass
+from datetime import datetime
+from typing import Optional
+
+from dacite import from_dict
+
+from cli.utils.time import parse_datetime
+
+
+@dataclass
+class StateFile:
+    version: str = "1.0"
+    last_update_check_time: Optional[str] = None
+
+    def dumps(self) -> str:
+        return json.dumps(dataclasses.asdict(self), default=str)
+
+    def should_perform_update_check(self) -> bool:
+        if self.last_update_check_time:
+            seconds = (datetime.now() - parse_datetime(self.last_update_check_time)).seconds
+            return (seconds / 3600) > 2
+        # This will solve the issue
+        return True
+
+    @staticmethod
+    def loads(data: str) -> StateFile:
+        d = json.loads(data)
+        return from_dict(StateFile, d)