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

cli/cloud/service_account_tokens.py

@@ -4,13 +4,12 @@ import typer
 
 from cli.settings import settings
 from cli.typer import typer_utils
-
-from .rest_helper import RestHelper as Rest
+from cli.utils.rest_helper import RestHelper as Rest
 
 app = typer_utils.create_typer()
 
 
-# TODO: add add interactive flag to set target directory # pylint: disable=fixme
+# TODO: add add interactive flag to set target directory
 @app.command(name="create", help="Create and download a new service account access token")
 def create(
     expire_in_days: int = typer.Option(default=365, help="Number of this token is valid"),
@@ -23,7 +22,7 @@ def create(
         body=json.dumps({"daysUntilExpiry": expire_in_days}),
     )
 
-    sat = settings.add_service_account_token(service_account, response.text)
+    sat = settings.add_service_account_token(response.text)
     print(f"Service account access token added: {sat.name}")
     print("\033[93m This file contains secrets and must be kept safe")
 
@@ -36,10 +35,27 @@ def list_tokens(
     Rest.handle_get(f"/api/project/{project}/admin/accounts/{service_account}/keys")
 
 
+@app.command(name="describe", help="Describe service account access token")
+def describe(
+    name: str = typer.Argument(..., help="Access token name"),
+    service_account: str = typer.Option(..., help="Service account name"),
+    project: str = typer.Option(..., help="Project ID", envvar="REMOTIVE_CLOUD_PROJECT"),
+) -> None:
+    Rest.handle_get(f"/api/project/{project}/admin/accounts/{service_account}/keys/{name}")
+
+
 @app.command(name="revoke", help="Revoke service account access token")
 def revoke(
     name: str = typer.Argument(..., help="Access token name"),
+    delete: bool = typer.Option(True, help="Also deletes the token after revocation"),
     service_account: str = typer.Option(..., help="Service account name"),
     project: str = typer.Option(..., help="Project ID", envvar="REMOTIVE_CLOUD_PROJECT"),
 ) -> None:
-    Rest.handle_delete(f"/api/project/{project}/admin/accounts/{service_account}/keys/{name}")
+    res = Rest.handle_get(f"/api/project/{project}/admin/accounts/{service_account}/keys/{name}", return_response=True)
+    if not res.json()["revoked"]:
+        Rest.handle_patch(f"/api/project/{project}/admin/accounts/{service_account}/keys/{name}/revoke", quiet=True)
+    if delete:
+        Rest.handle_delete(f"/api/project/{project}/admin/accounts/{service_account}/keys/{name}", quiet=True)
+        token_with_name = [token for token in settings.list_service_account_tokens() if token.name == name]
+        if len(token_with_name) > 0:
+            settings.remove_token_file(name)

cli/cloud/service_accounts.py

@@ -6,9 +6,9 @@ from typing import List
 import typer
 
 from cli.typer import typer_utils
+from cli.utils.rest_helper import RestHelper as Rest
 
 from . import service_account_tokens
-from .rest_helper import RestHelper as Rest
 
 app = typer_utils.create_typer()
 
@@ -18,7 +18,27 @@ def list_service_accounts(project: str = typer.Option(..., help="Project ID", en
     Rest.handle_get(f"/api/project/{project}/admin/accounts")
 
 
-@app.command(name="create", help="Create service account")
+ROLES_DESCRIPTION = """
+    [bold]Supported roles [/bold]
+    project/admin          - Full project support, view, edit, delete and manage users
+    project/user           - View, edit, upload, delete but no admin
+    project/viewer         - View only
+    project/storageCreator - Can upload to storage but not view, overwrite or delete
+    org/topologyRunner     - Can start RemotiveTopology
+"""
+
+
+@app.command(
+    name="create",
+    help=f"""
+    Create a new service account with one or more roles.
+
+    [bold]Must only use lowercase letters, digits, or dashes, and must not contain -- or end with a dash.[/bold]
+
+    remotive cloud service-accounts create --role project/user --role project/storageCreator
+    {ROLES_DESCRIPTION}
+    """,
+)
 def create_service_account(
     name: str,
     role: List[str] = typer.Option(..., help="Roles to apply"),
@@ -28,9 +48,17 @@ def create_service_account(
     Rest.handle_post(url=f"/api/project/{project}/admin/accounts", body=json.dumps(data))
 
 
-@app.command(name="update", help="Update service account")
+@app.command(
+    name="update",
+    help=f"""
+    Update an existing service account with one or more roles.
+
+    remotive cloud service-accounts update --role project/user --role project/storageCreator
+    {ROLES_DESCRIPTION}
+    """,
+)
 def update_service_account(
-    service_account: str = typer.Option(..., help="Service account name"),
+    service_account: str = typer.Argument(..., help="Service account name"),
     role: List[str] = typer.Option(..., help="Roles to apply"),
     project: str = typer.Option(..., help="Project ID", envvar="REMOTIVE_CLOUD_PROJECT"),
 ) -> None:

cli/cloud/storage/cmd.py

@@ -3,13 +3,13 @@ import sys
 import typer
 from typing_extensions import Annotated
 
-from cli.cloud.rest_helper import RestHelper as Rest
 from cli.cloud.storage.copy import copy
 from cli.cloud.storage.uri_or_path import UriOrPath
 from cli.cloud.storage.uri_or_path import uri as uri_parser
 from cli.cloud.uri import URI, InvalidURIError, JoinURIError
 from cli.errors import ErrorPrinter
 from cli.typer import typer_utils
+from cli.utils.rest_helper import RestHelper as Rest
 
 HELP = """
 Manage files ([yellow]Beta feature not available for all customers[/yellow])

cli/cloud/storage/copy.py

@@ -3,9 +3,9 @@ from __future__ import annotations
 import json
 from pathlib import Path
 
-from cli.cloud.rest_helper import RestHelper as Rest
 from cli.cloud.resumable_upload import upload_signed_url
 from cli.cloud.uri import URI
+from cli.utils.rest_helper import RestHelper as Rest
 
 _RCS_STORAGE_PATH = "/api/project/{project}/files/storage{path}"
 
@@ -73,9 +73,8 @@ def _download(source: URI, dest: Path, project: str, overwrite: bool = False) ->
         # create a target file name if destination is a dir
         dest = dest / source.filename
 
-    else:
-        if not dest.parent.is_dir() or not dest.parent.exists():
-            raise FileNotFoundError(f"Destination directory {dest.parent} does not exist")
+    elif not dest.parent.is_dir() or not dest.parent.exists():
+        raise FileNotFoundError(f"Destination directory {dest.parent} does not exist")
 
     if dest.exists() and not overwrite:
         raise FileExistsError(f"Destination file {dest} already exists")

cli/connect/connect.py

@@ -17,7 +17,7 @@ app = typer_utils.create_typer()
 
 
 @app.command()
-def protopie(  # pylint: disable=R0913
+def protopie(  # noqa: PLR0913
     config: Path = typer.Option(
         None,
         exists=True,

cli/connect/protopie/protopie.py

@@ -1,26 +1,25 @@
 # type: ignore
-# pylint: skip-file
 from __future__ import annotations
 
 import json
 import os
+import sys
 import time
 import traceback
 from pathlib import Path
 from typing import Any, Dict, List, Tuple, Union
 
 import grpc
-import socketio  # type: ignore
+import socketio
 from remotivelabs.broker.sync import BrokerException, Client, SignalIdentifier, SignalsInFrame
 from rich import print as pretty_print
 from rich.console import Console
-from socketio.exceptions import ConnectionError as SocketIoConnectionError  # type: ignore
+from socketio.exceptions import ConnectionError as SocketIoConnectionError
 
 from cli.broker.lib.broker import SubscribableSignal
 from cli.errors import ErrorPrinter
 from cli.settings import settings
 
-global PP_CONNECT_APP_NAME
 PP_CONNECT_APP_NAME = "RemotiveBridge"
 
 io = socketio.Client()
@@ -34,13 +33,13 @@ x_api_key: str
 broker: Any
 
 
-@io.on("connect")  # type: ignore
+@io.on("connect")
 def on_connect() -> None:
     print("Connected to ProtoPie Connect")
     io.emit("ppBridgeApp", {"name": PP_CONNECT_APP_NAME})
     io.emit("PLUGIN_STARTED", {"name": PP_CONNECT_APP_NAME})
 
-    global is_connected
+    global is_connected  # noqa: PLW0603
     is_connected = True
 
 
@@ -90,7 +89,7 @@ def _connect_to_broker(
     signals, namespaces, sub = get_signals_and_namespaces(config, signals_to_subscribe_to)
 
     def on_signals(frame: SignalsInFrame) -> None:
-        global _has_received_signal
+        global _has_received_signal  # noqa: PLW0603
         if not _has_received_signal:
             pretty_print("Bridge-app is properly receiving signals, you are good to go :thumbsup:")
             _has_received_signal = True
@@ -151,10 +150,9 @@ def grpc_connect(
     except Exception as e:
         print(traceback.format_exc())
         err_console.print(f":boom: {e}")
-        # exit(1)
 
 
-def do_connect(
+def do_connect(  # noqa: PLR0913
     address: str,
     broker_url: str,
     api_key: Union[str, None],
@@ -163,9 +161,9 @@ def do_connect(
     expression: Union[str, None],
     on_change_only: bool = False,
 ) -> None:
-    global broker
-    global x_api_key
-    global config_path
+    global broker  # noqa: PLW0603
+    global x_api_key  # noqa: PLW0603
+    global config_path  # noqa: PLW0603
     broker = broker_url
 
     if broker_url.startswith("https"):
@@ -188,8 +186,8 @@ def do_connect(
     except SocketIoConnectionError as e:
         err_console.print(":boom: [bold red]Failed to connect to ProtoPie Connect[/bold red]")
         err_console.print(e)
-        exit(1)
+        sys.exit(1)
     except Exception as e:
         err_console.print(":boom: [bold red]Unexpected error[/bold red]")
         err_console.print(e)
-        exit(1)
+        sys.exit(1)

cli/remotive.py

@@ -1,18 +1,25 @@
+from __future__ import annotations
+
 import os
 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 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.cmd import app as settings_app
+from .settings import settings
 from .tools.tools import app as tools_app
 from .typer import typer_utils
 
+err_console = Console(stderr=True)
+
 if os.getenv("GRPC_VERBOSITY") is None:
     os.environ["GRPC_VERBOSITY"] = "NONE"
 
@@ -25,6 +32,8 @@ For documentation - https://docs.remotivelabs.com
 """,
 )
 
+# settings.set_default_config_as_env()
+
 
 def version_callback(value: bool) -> None:
     if value:
@@ -37,17 +46,33 @@ def test_callback(value: int) -> None:
     if value:
         rich_print(value)
         raise typer.Exit()
-    # if value:
-    #    typer.echo(f"Awesome CLI Version: 0.0.22a")
-    #    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):
+        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:
+    """
+    If not already set, take the default organisation from file and set as env
+    This has to be done early before it is read
+    """
+    if "REMOTIVE_CLOUD_ORGANISATION" not in os.environ:
+        org = settings.get_cli_config().get_active_default_organisation()
+        if org is not None:
+            os.environ["REMOTIVE_CLOUD_ORGANISATION"] = org
 
 
 @app.callback()
 def main(
     _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()
     # Do other global stuff, handle other global options here
-    return
 
 
 @app.command()
@@ -65,6 +90,5 @@ app.add_typer(
     name="cloud",
     help="Manage resources in RemotiveCloud",
 )
-app.add_typer(settings_app, name="config", help="Manage access tokens")
 app.add_typer(connect_app, name="connect", help="Integrations with other systems")
 app.add_typer(tools_app, name="tools")

cli/settings/__init__.py

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

cli/settings/config_file.py

@@ -0,0 +1,85 @@
+from __future__ import annotations
+
+import dataclasses
+import json
+from dataclasses import dataclass
+from typing import Dict, Optional
+
+from dacite import from_dict
+
+
+def loads(data: str) -> ConfigFile:
+    d = json.loads(data)
+    return from_dict(ConfigFile, d)
+
+
+def dumps(config: ConfigFile) -> str:
+    return json.dumps(dataclasses.asdict(config), default=str)
+
+
+@dataclass
+class Account:
+    credentials_name: str
+    default_organization: Optional[str] = None
+    # Add project as well
+
+
+@dataclass
+class ConfigFile:
+    version: str = "1.0"
+    active: Optional[str] = None
+    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
+
+    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
+            raise KeyError(f"Activated account {self.active} is not a valid account")
+        return None
+
+    def activate(self, email: str) -> None:
+        account = self.accounts.get(email)
+
+        if account is not None:
+            self.active = email
+        else:
+            raise KeyError(f"Account {email} does not exists")
+
+    def get_account(self, email: str) -> Optional[Account]:
+        if self.accounts:
+            return self.accounts[email]
+        return 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:
+        if self.accounts is None:
+            self.accounts = {}
+
+        account = self.accounts.get(email)
+        if not account:
+            account = Account(credentials_name=token_name)
+        else:
+            account.credentials_name = token_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)
+        if not account:
+            raise KeyError(f"Account with email {email} has not been initialized with token")
+
+        # Update only fields explicitly passed
+        if default_organization is not None:
+            account.default_organization = default_organization
+
+        return self