oks-cli 1.14__py3-none-any.whl

oks_cli/main.py

@@ -0,0 +1,91 @@
+#!/usr/bin/env python3
+import click
+import os
+import json
+import logging
+from .project import project
+from .cluster import cluster
+from .profile import profile
+from .cache import cache
+from .quotas import quotas
+
+from .utils import ctx_update, login_profile, install_completions, profile_completer
+
+# Main CLI entry point
+@click.group(invoke_without_command=True)
+@click.option("--profile", help="Configuration profile to use", shell_complete=profile_completer)
+@click.option('--project-name', '-p', required = False, help="Project Name")
+@click.option('--cluster-name', '-c', required = False, help="Cluster Name")
+@click.option('-v', '--verbose', count=True)
+@click.pass_context
+def cli(ctx, project_name, cluster_name, profile, verbose):
+    """
+    CLI tool to manage projects and clusters.
+
+    You can run commands on two scopes: 'project' and 'cluster'.
+    Each scope has several actions like 'list', 'get', 'create', etc.
+    """
+    ctx_update(ctx, project_name, cluster_name, profile)
+
+    LOGLEVEL = os.environ.get('LOGLEVEL', 'WARNING').upper()
+
+    if verbose >= 1:
+        LOGLEVEL = "INFO"
+
+    if verbose >= 2:
+        LOGLEVEL = "DEBUG"
+
+    logging.basicConfig(
+        format='%(asctime)s %(levelname)-8s %(filename)s:%(funcName)s %(message)s',
+        level=LOGLEVEL,
+        datefmt='%Y-%m-%d %H:%M:%S'
+    )
+    logging.info("Set loglevel to %s", LOGLEVEL)
+
+    if ctx.invoked_subcommand is None:
+        click.echo(ctx.get_help())
+
+    if not hasattr(ctx, 'obj') or not ctx.obj:
+        ctx.obj = dict()
+
+    if project_name != None:
+        ctx.obj['project_name'] = project_name
+
+    if cluster_name != None:
+        ctx.obj['cluster_name'] = cluster_name
+
+# Register the project and cluster groups with the main CLI
+cli.add_command(project)
+cli.add_command(cluster)
+cli.add_command(profile)
+cli.add_command(cache)
+cli.add_command(quotas)
+
+def recursive_help(cmd, parent=None):
+    """Recursively prints help for all commands and subcommands."""
+    ctx = click.core.Context(cmd, info_name=cmd.name, parent=parent)
+    print(cmd.get_help(ctx))
+    print()
+    commands = getattr(cmd, 'commands', {})
+    for sub in commands.values():
+        recursive_help(sub, ctx)
+
+@cli.command('fullhelp', help="Display detailed help information for all commands.")
+def fullhelp():
+    """Display comprehensive help for all CLI commands."""
+    recursive_help(cli)
+
+@cli.command('version', help="Show the current CLI version.")
+def version():
+    """Display the current CLI version."""
+    import importlib.metadata
+    print(importlib.metadata.version(__package__))
+
+@cli.command("install-completion", help="Install shell completion scripts.")
+@click.option('--type', help="Shell")
+def install_completion(type):
+    """Install shell completion scripts for the CLI."""
+    install_completions(type)
+
+if __name__ == '__main__':
+    cli()

oks_cli/profile.py

@@ -0,0 +1,128 @@
+import click
+from .utils import set_profile, remove_profile, profile_list, DEFAULT_API_URL, get_profiles
+
+
+# DEFINE THE PROFILE COMMAND GROUP
+@click.group(help="Profile related commands.")
+def profile():
+    """Profile management command group."""
+    pass
+
+
+@profile.command('add', help="Add AK/SK or username/password new profile")
+@click.option('--profile-name', required=False, help="Name of profile, optional", type=click.STRING)
+@click.option('--access-key', required=False, help="AK of profile", type=click.STRING)
+@click.option('--secret-key', required=False, help="SK of profile", type=click.STRING)
+@click.option('--username', required=False, help="Username", type=click.STRING)
+@click.option('--password', required=False, help="Password", type=click.STRING)
+@click.option('--region', required=True, help="Region name", type=click.Choice(['eu-west-2', 'cloudgouv-eu-west-1']))
+@click.option('--endpoint', required=False, help="API endpoint", type=click.STRING)
+@click.option('--jwt', required=False, help="Enable jwt, by default is false", type=click.BOOL)
+def add_profile(profile_name, access_key, secret_key, username, password, region, endpoint, jwt):
+    """Add a new profile with AK/SK or username/password authentication."""
+    if not profile_name:
+        profile_name = "default"
+
+    existing_profiles = get_profiles()
+    if profile_name in existing_profiles:
+        confirm = click.confirm(
+            f"The profile '{profile_name}' already exists. Do you want to replace it?",
+            default=False
+        )
+        if not confirm:
+            click.echo("Aborted.")
+            return
+
+    obj = {
+        "region_name": region
+    }
+
+    if endpoint:
+        obj["endpoint"] = endpoint
+
+    if access_key and secret_key:
+        obj["type"] = "ak/sk"
+        obj["access_key"] = access_key
+        obj["secret_key"] = secret_key
+
+    elif username and password:
+        obj["type"] = "username/password"
+        obj["username"] = username
+        obj["password"] = password
+    else:
+        raise click.UsageError("--access-key and --secret-key or --username and --password must be specified")
+
+    if jwt is not None:
+        obj["jwt"] = jwt
+
+    set_profile(profile_name, obj)
+
+    profile_name_styled = click.style(profile_name, bold=True)
+    click.echo(f"Profile {profile_name_styled} has been successfully added")
+
+@profile.command('update', help="Update an existing profile")
+@click.option('--profile-name', required=True, help="Name of profile", type=click.STRING)
+@click.option('--region', required=False, help="Region name", type=click.Choice(['eu-west-2', 'cloudgouv-eu-west-1']))
+@click.option('--endpoint', required=False, help="API endpoint", type=click.STRING)
+@click.option('--jwt', required=False, help="Enable jwt, by default is false", type=click.BOOL)
+def update_profile(profile_name, region, endpoint, jwt):
+    """Update configuration settings for an existing profile."""
+    profiles = profile_list()
+    if profile_name not in profiles:
+        raise click.ClickException(f"There no profile with name: {profile_name}")
+
+    profile = profiles[profile_name]
+    if region:
+        profile["region_name"] = region
+
+    if endpoint:
+        profile["endpoint"] = endpoint
+
+    if jwt is not None:
+        profile["jwt"] = jwt
+
+    set_profile(profile_name, profile)
+
+    profile_name = click.style(profile_name, bold=True)
+
+    click.echo(f"Profile {profile_name} has been successfully updated")
+
+@profile.command('delete', help="Delete a profile by name")
+@click.option('--profile-name', required=True, help="Name of profile", type=click.STRING)
+@click.option('--force', is_flag=True, help="Force deletion without confirmation")
+def delete_profile(profile_name, force):
+    """Delete a profile with confirmation."""
+    profiles = profile_list()
+    profile_name_bold = click.style(profile_name, bold=True)
+
+    if profile_name not in profiles:
+        raise click.ClickException(f"There no profile with name: {profile_name_bold}")
+
+    if force or click.confirm(f"Are you sure you want to delete the profile with name {profile_name_bold}?", abort=True):
+        remove_profile(profile_name)
+        click.echo(f"Profile {profile_name_bold} has been successfully deleted")
+
+@profile.command('list', help="List existing profiles")
+def list_profiles():
+    """Display all configured profiles with their settings."""
+    profiles = profile_list()
+
+    if not profiles:
+        return click.echo("There are no profiles")
+
+    profiles_keys = list(profiles.keys())
+
+    for key in profiles_keys:
+        if 'endpoint' not in profiles[key]:
+            if 'region_name' in profiles[key]:
+                endpoint = click.style(DEFAULT_API_URL.format(region=profiles[key]['region_name']), bold=True)
+            else:
+                endpoint = None
+        else:
+            endpoint = click.style(profiles[key]["endpoint"], bold=True)
+        name = click.style(key, bold=True)
+        account_type = click.style(profiles[key]["type"], bold=True)
+        region = click.style(profiles[key]["region_name"], bold=True)
+        jwt = click.style(profiles[key].get("jwt", False), bold=True)
+
+        click.echo(f"Profile: {name} Account type: {account_type} Region: {region} Endpoint: {endpoint} Enabled JWT auth: {jwt}")

oks_cli/project.py

@@ -0,0 +1,398 @@
+import click
+import time
+import datetime
+import dateutil.parser
+import human_readable
+import prettytable
+import os
+
+from .utils import do_request, print_output, find_project_id_by_name, get_project_id, set_project_id, detect_and_parse_input, transform_tuple, ctx_update, set_cluster_id, get_template, get_project_name, format_changed_row, is_interesting_status, login_profile, profile_completer
+
+# DEIFNE THE PROJECT COMMAND GROUP
+@click.group(help="Project related commands.")
+@click.option('--project', 'project_name', required = False, help="Project Name")
+@click.option('--project-name', '-p', required = False, help="Project Name")
+@click.option("--profile", help="Configuration profile to use", shell_complete=profile_completer)
+@click.pass_context
+def project(ctx, project_name, profile):
+    """Group of commands related to project management."""
+    ctx_update(ctx, project_name, None, profile)
+
+# LOGIN ON PROJECT
+@project.command('login', help="Set a default project by name")
+@click.option('--project-name', '-p', required=False, help="Name of project", type=click.STRING)
+@click.option('--profile', help="Configuration profile to use", shell_complete=profile_completer)
+@click.pass_context
+def project_login(ctx, project_name, profile):
+    """Set a default project by its name and log in."""
+    project_name, _, profile = ctx_update(ctx, project_name, None, profile)
+    login_profile(profile)
+
+    data = do_request("GET", 'projects', params={"name": project_name})
+    if len(data) != 1:
+        raise click.BadParameter(
+            f"{len(data)} projects found by name: {project_name}")
+    project = data.pop()
+
+    project_id = project['id']
+    project_name = project['name']
+
+    set_project_id(project_id)
+    set_cluster_id("")
+
+    project_name = click.style(project_name, bold=True)
+
+    click.echo(f"Logged into project: {project_name}")
+
+# LOGOUT ON PROJECT
+@project.command('logout', help="Unset default project")
+@click.option("--profile", help="Configuration profile to use", shell_complete=profile_completer)
+@click.pass_context
+def project_logout(ctx, profile):
+    """Unset the current default project and log out."""
+    _, _, profile = ctx_update(ctx, None, None, profile)
+    login_profile(profile)
+    set_project_id("")
+    set_cluster_id("")
+    click.echo("Logged out from the current project")
+
+# LIST PROJECTS
+@project.command('list', help="List all projects")
+@click.option('--project-name', '-p', help="Name of project", type=click.STRING)
+@click.option('--deleted', is_flag=True, help="List deleted projects")
+@click.option('--plain', is_flag=True, help="Plain table format")
+@click.option('--msword', is_flag=True, help="Microsoft Word table format")
+@click.option('--uuid', is_flag=True, help="show uuid")
+@click.option('--watch', '-w', is_flag=True, help="Watch the changes")
+@click.option('-o', '--output', type=click.Choice(["json", "yaml"]), help="Specify output format, by default is json")
+@click.option('--profile', help="Configuration profile to use")
+@click.pass_context
+def project_list(ctx, project_name, deleted, plain, msword, uuid, watch, output, profile):
+    """List projects with filtering, formatting, and live watch capabilities."""
+    project_name, _, profile = ctx_update(ctx, project_name, None, profile)
+    login_profile(profile)
+
+    project_id = get_project_id()
+    params = {}
+    if project_name:
+        params['name'] = project_name
+
+    if deleted:
+        params['deleted'] = True
+
+    data = do_request("GET", 'projects', params=params)
+
+    if output:
+        print_output(data, output)
+        return
+
+    field_names = ["NAME", "CREATED", "UPDATED", "STATUS", "DEFAULT"]
+    if uuid:
+        field_names.append('UUID')
+
+    table = prettytable.PrettyTable()
+    table.field_names = field_names
+
+    table._min_width = {"CREATED": 13, "UPDATED": 13, "STATUS": 10}
+
+    if plain or watch:
+        table.set_style(prettytable.PLAIN_COLUMNS)
+
+    if msword:
+        table.set_style(prettytable.MSWORD_FRIENDLY)
+
+    def format_row(project):
+        status = project.get('status')
+        is_default = True if project.get('id') == project_id else False
+
+        if status == 'ready':
+            msg = click.style(status, fg='green')
+        elif status == 'failed' or status == 'deleted':
+            msg = click.style(status, fg='red')
+        elif status == 'deploying':
+            msg = click.style(status, fg='yellow')
+        else:
+            msg = status
+
+        name = click.style(project['name'], bold=True)
+        if is_default:
+            default = "*"
+        else:
+            default = ""
+
+        created_at = dateutil.parser.parse(project['created_at'])
+        updated_at = dateutil.parser.parse(project['updated_at'])
+        now = datetime.datetime.now(tz=created_at.tzinfo)
+
+        row = [name, human_readable.date_time(now - created_at), human_readable.date_time(now - updated_at), msg, default]
+        if uuid:
+            row.append(project['id'])
+
+        return row, status, project['name']
+
+    initial_projects = {}
+
+    for project in data:
+        row, _, name = format_row(project)
+        table.add_row(row)
+        initial_projects[name] = project
+
+    click.echo(table)
+
+
+    if watch:
+        total_sleep = 0
+        try:
+            while True:
+                time.sleep(2)
+                total_sleep += 2
+                try:
+                    data = do_request("GET", 'projects', params=params)
+                except click.ClickException as err:
+                    click.echo(f"Error during watch: {err}")
+                    continue
+
+                current_project_names = {project['name'] for project in data}
+
+                for name, project in list(initial_projects.items()):
+                    if name not in current_project_names:
+                        deleted_project = project.copy()
+                        deleted_project['status'] = 'deleted'
+
+                        row, current_status, _ = format_row(deleted_project)
+
+                        new_table = format_changed_row(table, row)
+                        click.echo(new_table)
+
+                        del initial_projects[name]
+
+                for project in data:
+                    row, current_status, name = format_row(project)
+
+                    if name not in initial_projects:
+                        new_table = format_changed_row(table, row)
+                        click.echo(new_table)
+                        initial_projects[name] = project
+                        continue
+
+                    stored_project = initial_projects[name]
+                    project_status = stored_project.get('status')
+                    if project_status != current_status:
+                        new_table = format_changed_row(table, row)
+                        click.echo(new_table)
+                        initial_projects[name] = project
+                        continue
+
+                    if total_sleep % 10 == 0 and is_interesting_status(current_status):
+                        new_table = format_changed_row(table, row)
+                        click.echo(new_table)
+                        initial_projects[name] = project
+
+        except KeyboardInterrupt:
+            click.echo("\nWatch stopped.")
+
+# CREATE PROJECT BY NAME
+@project.command('create', help="Create a new project")
+@click.option('--project-name', '-p', help="Name of the project")
+@click.option('--description', help="Description of the project")
+@click.option('--cidr', help='CIDR for the project')
+@click.option('--quirk', multiple=True, help="Quirk")
+@click.option('--tags', help="Comma-separated list of tags, example: 'key1=value1,key2=value2'")
+@click.option('--disable-api-termination', type=click.BOOL, help="Disable delete action by API")
+@click.option('--dry-run', is_flag=True, help="Client dry-run, only print the object that would be sent, without sending it")
+@click.option('-o', '--output', type=click.Choice(["json", "yaml", "silent"]), help="Specify output format, by default is json")
+@click.option('-f', '--filename', type=click.File("r"), help="Path to file to use to create the project ")
+@click.option('--profile', help="Configuration profile to use", shell_complete=profile_completer)
+@click.pass_context
+def project_create(ctx, project_name, description, cidr, quirk, tags, disable_api_termination, dry_run, output, filename, profile):
+    """Create a new project from options or file, with support for dry-run and output formatting."""
+    project_name, _, profile = ctx_update(ctx, project_name, None, profile)
+    login_profile(profile)
+
+    project_config = None
+
+    if filename:
+        input_data = filename.read()
+        project_config = detect_and_parse_input(input_data)
+    else:
+        project_config = get_template("project")
+        if os.getenv("OKS_REGION"):
+            project_config["region"] = os.getenv("OKS_REGION")
+
+    if project_name:
+        project_config['name'] = project_name
+
+    if description:
+        project_config['description'] = description
+
+    if cidr:
+        project_config['cidr'] = cidr
+
+    if quirk:
+        project_config['quirks'] = transform_tuple(quirk)
+    
+    if tags:
+        parsed_tags = {}
+
+        pairs = tags.split(',')
+        for pair in pairs:
+            if '=' not in pair:
+                raise click.ClickException(f"Malformed tags: '{pair}' (expected key=value)")
+            key, value = pair.split('=', 1)
+            parsed_tags[key.strip()] = value.strip()
+
+        project_config['tags'] = parsed_tags
+
+    if disable_api_termination is not None:
+        project_config["disable_api_termination"] = disable_api_termination
+
+    if not dry_run:
+        data = do_request("POST", 'projects', json=project_config)
+        print_output(data, output)
+    else:
+        print_output(project_config, output)
+
+# GET PROJECT BY NAME
+@project.command('get', help="Get default project or the project by name")
+@click.option('--project-name', '-p', help="Name of the project")
+@click.option('-o', '--output', type=click.Choice(["json", "yaml"]), help="Specify output format, by default is json")
+@click.option('--profile', help="Configuration profile to use", shell_complete=profile_completer)
+@click.pass_context
+def project_get(ctx, project_name, output, profile):
+    """Retrieve and display project details by name or default project."""
+    project_name, _, profile = ctx_update(ctx, project_name, None, profile)
+    login_profile(profile)
+
+    project_id = find_project_id_by_name(project_name)
+
+    data = do_request("GET", f'projects/{project_id}')
+    print_output(data, output)
+
+# DELETE PROJECT BY NAME
+@project.command('delete', help="Delete a project by name")
+@click.option('--project-name', '-p', required=False, help="Project Name")
+@click.option('-o', '--output', type=click.Choice(["json", "yaml"]), help="Specify output format, by default is json")
+@click.option('--dry-run', is_flag=True, help="Run without any action")
+@click.option('--force', is_flag=True, help="Force deletion without confirmation")
+@click.option('--profile', help="Configuration profile to use", shell_complete=profile_completer)
+@click.pass_context
+def project_delete_command(ctx, project_name, output, dry_run, force, profile):
+    """Delete a project by name, with optional dry-run and confirmation."""
+    project_name, _, profile = ctx_update(ctx, project_name, None, profile)
+    login_profile(profile)
+
+    project_id = find_project_id_by_name(project_name)
+    project_name = get_project_name(project_name)
+
+    current_project_id = get_project_id()
+
+    if dry_run:
+        message = {"message": "Dry run: The project would be deleted."}
+        print_output(message, output)
+        return
+
+    if force or click.confirm(f"Are you sure you want to delete the project with name {project_name}?", abort=True):
+        data = do_request("DELETE", f'projects/{project_id}')
+
+        if current_project_id == project_id:
+            set_project_id("")
+            set_cluster_id("")
+        print_output(data, output)
+
+
+# UPDATE PROJECT BY NAME
+@project.command('update', help="Update a project by name")
+@click.option('--project-name', '-p', required=False, help="Project Name")
+@click.option('--description', help="Description of the project")
+@click.option('--quirk', multiple=True, help="Quirk")
+@click.option('--tags', help="Comma-separated list of tags, example: 'key1=value1,key2=value2'")
+@click.option('--disable-api-termination', type=click.BOOL, help="Disable delete action by API")
+@click.option('-o', '--output', type=click.Choice(["json", "yaml"]), help="Specify output format, by default is json")
+@click.option('--dry-run', is_flag=True, help="Run without any action")
+@click.option('--profile', help="Configuration profile to use", shell_complete=profile_completer)
+@click.pass_context
+def project_update_command(ctx, project_name, description, quirk, tags, disable_api_termination, output, dry_run, profile):
+    """Update project details by name, supporting dry-run and output formatting."""
+    project_name, _, profile = ctx_update(ctx, project_name, None, profile)
+    login_profile(profile)
+
+    project_id = find_project_id_by_name(project_name)
+
+    project_config = {}
+
+    if disable_api_termination is not None:
+        project_config["disable_api_termination"] = disable_api_termination
+
+    if description:
+        project_config['description'] = description
+
+    if quirk:
+        project_config['quirks'] = transform_tuple(quirk)
+
+    if tags is not None:
+        parsed_tags = {}
+
+        if not len(tags) == 0:
+            pairs = tags.split(',')
+            for pair in pairs:
+                if '=' not in pair:
+                    raise click.ClickException(f"Malformed tags: '{pair}' (expected key=value)")
+                key, value = pair.split('=', 1)
+                parsed_tags[key.strip()] = value.strip()
+
+        project_config['tags'] = parsed_tags
+
+    if dry_run:
+        print_output(project_config, output)
+    else:
+        data = do_request("PATCH", f'projects/{project_id}', json = project_config)
+        print_output(data, output)
+
+# GET PROJECT QUOTAS BY PROJECT NAME
+@project.command('quotas', help="Get project quotas")
+@click.option('--project-name', '-p', help="Name of the project")
+@click.option('-o', '--output', type=click.Choice(["json", "yaml"]), help="Specify output format, by default is json")
+@click.option('--profile', help="Configuration profile to use", shell_complete=profile_completer)
+@click.pass_context
+def project_get_quotas(ctx, project_name, output, profile):
+    """Retrieve resource quotas for the specified project."""
+    project_name, _, profile = ctx_update(ctx, project_name, None, profile)
+    login_profile(profile)
+
+    project_id = find_project_id_by_name(project_name)
+
+    data = do_request("GET", f'projects/{project_id}/quotas')["data"]
+    print_output(data, output)
+
+
+# GET PROJECT SNAPSHOTS BY PROJECT NAME
+@project.command('snapshots', help="Get project snapshots")
+@click.option('--project-name', '-p', help="Name of the project")
+@click.option('-o', '--output', type=click.Choice(["json", "yaml"]), help="Specify output format, by default is json")
+@click.option('--profile', help="Configuration profile to use", shell_complete=profile_completer)
+@click.pass_context
+def project_get(ctx, project_name, output, profile):
+    """Retrieve snapshots associated with the specified project."""
+    project_name, _, profile = ctx_update(ctx, project_name, None, profile)
+    login_profile(profile)
+
+    project_id = find_project_id_by_name(project_name)
+
+    response = do_request("GET", f'projects/{project_id}/snapshots')
+    print_output(response, output)
+
+# GET PUBLIC IPS BY PROJECT NAME
+@project.command('publicips', help="Get project public ips")
+@click.option('--project-name', '-p', help="Name of the project")
+@click.option('-o', '--output', type=click.Choice(["json", "yaml"]), help="Specify output format, by default is json")
+@click.option('--profile', help="Configuration profile to use")
+@click.pass_context
+def project_get_public_ips(ctx, project_name, output, profile):
+    """Retrieve the list of public IPs associated with the specified project."""
+    project_name, _, profile = ctx_update(ctx, project_name, None, profile)
+    login_profile(profile)
+
+    project_id = find_project_id_by_name(project_name)
+
+    data = do_request("GET", f'projects/{project_id}/public_ips')
+    print_output(data, output)

oks_cli/quotas.py

@@ -0,0 +1,14 @@
+import click
+from .utils import do_request, print_output, ctx_update, login_profile, profile_completer
+
+@click.command(help="Get Quotas")
+@click.option("--profile", help="Configuration profile to use", shell_complete=profile_completer)
+@click.option('-o', '--output', type=click.Choice(["json", "yaml"]), help="Specify output format, by default is json")
+@click.pass_context
+def quotas(ctx, profile, output):
+    """Retrieve global quotas across all projects for the given profile."""
+    _, _, profile = ctx_update(ctx, None, None, profile)
+    login_profile(profile)
+
+    data = do_request("GET", 'quotas')
+    print_output(data, output)