truefoundry 0.2.10__py3-none-any.whl → 0.3.0__py3-none-any.whl

truefoundry/deploy/cli/commands/patch_command.py

@@ -0,0 +1,70 @@
+import subprocess
+from typing import Optional
+
+import rich_click as click
+
+from truefoundry.deploy.cli.const import GROUP_CLS
+from truefoundry.deploy.cli.util import handle_exception_wrapper
+from truefoundry.deploy.io.rich_output_callback import RichOutputCallBack
+
+
+@click.group(
+    name="patch",
+    cls=GROUP_CLS,
+    invoke_without_command=True,
+    help="Patch parts of servicefoundry.yaml file",
+)
+@click.option(
+    "-f",
+    "--file",
+    type=click.Path(exists=True, dir_okay=False, resolve_path=True),
+    default="./servicefoundry.yaml",
+    help="Path to servicefoundry.yaml file",
+    show_default=True,
+)
+@click.option(
+    "--filter",
+    type=click.STRING,
+    required=True,
+    help="`yq` filter",
+)
+@click.option(
+    "-o",
+    "--output-file",
+    type=click.Path(exists=False, writable=True, resolve_path=True),
+    help="Path to yaml file to redirect the output",
+    show_default=True,
+)
+@click.option(
+    "-I",
+    "--indent",
+    default=4,
+    type=click.INT,
+    help="Indent level for output",
+    show_default=True,
+)
+@handle_exception_wrapper
+def patch_command(
+    file: str, filter: str, output_file: Optional[str], indent: int
+) -> None:
+    yq_command = [
+        "yq",
+        "--output-format",
+        "yaml",
+        "--indent",
+        str(indent),
+        filter,
+        file,
+    ]
+    if output_file:
+        with open(output_file, "w") as fd:
+            subprocess.run(yq_command, stdout=fd)
+    else:
+        p = subprocess.run(yq_command, stdout=subprocess.PIPE)
+        output = p.stdout.decode("UTF-8")
+        callback = RichOutputCallBack()
+        callback.print_line(output)
+
+
+def get_patch_command():
+    return patch_command

truefoundry/deploy/cli/commands/redeploy_command.py

@@ -0,0 +1,41 @@
+import rich_click as click
+
+from truefoundry.deploy.cli.const import COMMAND_CLS
+from truefoundry.deploy.cli.util import handle_exception_wrapper
+from truefoundry.deploy.lib.dao import application as application_lib
+
+
+@click.command(name="redeploy", cls=COMMAND_CLS)
+@click.option(
+    "--application-fqn",
+    type=click.STRING,
+    default=None,
+    help="Application fqn",
+    required=True,
+)
+@click.option(
+    "--version",
+    type=click.STRING,
+    default=None,
+    help="Application deployment version",
+    required=True,
+)
+@click.option(
+    "--wait/--no-wait",
+    is_flag=True,
+    show_default=True,
+    default=True,
+    help="wait and tail the deployment progress",
+)
+@handle_exception_wrapper
+def redeploy_command(application_fqn: str, version: int, wait: bool):
+    """
+    Redeploy specific version of an application
+    """
+    _deployment = application_lib.redeploy_application(
+        application_fqn=application_fqn, version=version, wait=wait
+    )
+
+
+def get_redeploy_command():
+    return redeploy_command

truefoundry/deploy/cli/commands/terminate_comand.py

@@ -0,0 +1,44 @@
+import rich_click as click
+
+from truefoundry.deploy.cli.const import COMMAND_CLS, GROUP_CLS
+from truefoundry.deploy.cli.display_util import print_json
+from truefoundry.deploy.cli.util import handle_exception_wrapper
+from truefoundry.deploy.lib.dao import application as application_lib
+
+
+@click.group(name="terminate", cls=GROUP_CLS)
+def terminate_command():
+    """
+    Terminate the job
+    """
+    pass
+
+
+@click.command(name="job", cls=COMMAND_CLS, help="Terminate the Job")
+@click.option(
+    "--job-fqn",
+    "--job_fqn",
+    type=click.STRING,
+    default=None,
+    help="FQN of the Job",
+    required=True,
+)
+@click.option(
+    "--job-run-name",
+    "--job_run_name",
+    type=click.STRING,
+    default=None,
+    help="Run name of the job",
+    required=True,
+)
+@handle_exception_wrapper
+def terminate_job_run(job_fqn, job_run_name):
+    job_run = application_lib.terminate_job_run(
+        application_fqn=job_fqn, job_run_name=job_run_name
+    )
+    print_json(data=job_run)
+
+
+def get_terminate_command():
+    terminate_command.add_command(terminate_job_run)
+    return terminate_command

truefoundry/deploy/cli/commands/trigger_command.py

@@ -0,0 +1,145 @@
+from typing import Optional, Sequence
+
+import rich_click as click
+from click import ClickException
+
+from truefoundry.deploy.cli.const import COMMAND_CLS, GROUP_CLS
+from truefoundry.deploy.cli.util import handle_exception_wrapper
+from truefoundry.deploy.lib.dao import application
+
+
+@click.group(name="trigger", cls=GROUP_CLS)
+def trigger_command():
+    """
+    Trigger a Job asynchronously
+    """
+    pass
+
+
+@click.command(
+    name="job",
+    cls=COMMAND_CLS,
+    context_settings={"ignore_unknown_options": True, "allow_extra_args": True},
+)
+@click.option(
+    "--application-fqn",
+    "--application_fqn",
+    type=click.STRING,
+    required=True,
+    help="FQN of the deployment of the Job. This can be found on the Job details page.",
+)
+@click.option("--command", type=click.STRING, required=False, help="Command to run")
+@click.argument(
+    "params",
+    type=click.STRING,
+    nargs=-1,
+    required=False,
+)
+@handle_exception_wrapper
+def trigger_job(application_fqn: str, command: Optional[Sequence[str]], params):
+    """
+    Trigger a Job on TrueFoundry asynchronously
+
+        [b]tfy trigger job --application-fqn "my-cluster:my-workspace:my-job"[/]
+
+    \n
+    Additionally, you can either pass `--command` or params (if defined in the spec)\n
+
+
+    Passing a command:
+
+        [b]tfy trigger job --application-fqn "my-cluster:my-workspace:my-job" --command "python run.py"[/]
+    \n
+
+    Passing params:
+
+        [b]tfy trigger job --application-fqn "my-cluster:my-workspace:my-job" -- --param1_name param1_value --param2_name param2_value ...[/]
+    """
+    if params:
+        params_dict = {}
+        if len(params) % 2 != 0:
+            raise ClickException(
+                f"Found odd number of argument pairs: {params}. "
+                "Perhaps you forgot to pass a value for one of the params? "
+                "Job params should be passed in the "
+                "format `--param1_name param1_value --param2_name param2_value ...`"
+            )
+        for i in range(0, len(params), 2):
+            key = params[i]
+            value = params[i + 1]
+            if not key.startswith("--"):
+                raise ClickException(
+                    f"Got ambiguous argument {key!r} in params: {params}. "
+                    f"Param names should be prefixed with '--' i.e. "
+                    "Job params should be passed in the "
+                    "format `--param1_name param1_value --param2_name param2_value ...`"
+                )
+            key = key.lstrip("-")
+            params_dict[key] = value
+
+    application.trigger_job(
+        application_fqn=application_fqn, command=command, params=params
+    )
+
+
+@click.command(
+    name="workflow",
+    cls=COMMAND_CLS,
+    context_settings={"ignore_unknown_options": True, "allow_extra_args": True},
+)
+@click.option(
+    "--application-fqn",
+    "--application_fqn",
+    type=click.STRING,
+    required=True,
+    help="FQN of the workflow application",
+)
+@click.argument(
+    "inputs",
+    type=click.STRING,
+    nargs=-1,
+    required=False,
+)
+@handle_exception_wrapper
+def trigger_workflow(application_fqn: str, inputs):
+    """
+    Trigger a Workflow on TrueFoundry
+
+        [b]tfy trigger workflow --application-fqn "my-cluster:my-workspace:my-workflow"[/]
+
+    \n
+    Additionally, you can pass inputs (if defined in the workflow)\n\n
+
+    Passing inputs:
+
+        [b]tfy trigger workflow --application-fqn "my-cluster:my-workspace:my-workflow" -- --input1_name input1_value --input2_name input2_value ...[/]
+    """
+    if inputs:
+        inputs_dict = {}
+        if len(inputs) % 2 != 0:
+            raise ClickException(
+                f"Found odd number of argument pairs: {inputs}. "
+                "Perhaps you forgot to pass a value for one of the inputs? "
+                "inputs for workflow should be passed in the "
+                "format `--input1_name input1_value --input2_name input2_value ...`"
+            )
+        for i in range(0, len(inputs), 2):
+            key = inputs[i]
+            value = inputs[i + 1]
+            if not key.startswith("--"):
+                raise ClickException(
+                    f"Got ambiguous argument {key!r} in inputs: {inputs}. "
+                    f"input names should be prefixed with '--' i.e. "
+                    "inputs for workflow should be passed in the "
+                    "format `--input1_name input1_value --input2_name input2_value ...`"
+                )
+            key = key.lstrip("-")
+            inputs_dict[key] = value
+
+    application.trigger_workflow(application_fqn=application_fqn, inputs=inputs)
+
+
+def get_trigger_command():
+    trigger_command.add_command(trigger_job)
+    trigger_command.add_command(trigger_workflow)
+    return trigger_command

truefoundry/deploy/cli/config.py

@@ -0,0 +1,10 @@
+class CliConfig:
+    __conf = {"json": False}
+
+    @staticmethod
+    def get(name):
+        return CliConfig.__conf[name]
+
+    @staticmethod
+    def set(name, value):
+        CliConfig.__conf[name] = value

truefoundry/deploy/cli/console.py

@@ -0,0 +1,5 @@
+from rich.console import Console
+
+# TODO: this file should not exist here, it is being imported even outside cli
+#       moreover there is RichOutputCallBack now which can be used instead of console directly
+console = Console(soft_wrap=True)

truefoundry/deploy/cli/const.py

@@ -0,0 +1,12 @@
+import os
+
+import rich_click as click
+
+DISPLAY_DATETIME_FORMAT = "%d %b %Y %H:%M:%S %Z"
+
+# TODO (chiragjn): This is a hacky solution used while generating docs. Although
+#                  this does not cover cases where custom cls class already inherited from rich_click classes
+#                  is being used
+RICH_CLICK_DISABLED = os.getenv("RICH_CLICK_DISABLED")
+GROUP_CLS = click.Group if RICH_CLICK_DISABLED else click.RichGroup
+COMMAND_CLS = click.Command if RICH_CLICK_DISABLED else click.RichCommand

truefoundry/deploy/cli/display_util.py

@@ -0,0 +1,118 @@
+import datetime
+import json
+
+from rich import box
+from rich import print_json as _rich_print_json
+from rich.table import Table
+
+from truefoundry.deploy.cli.config import CliConfig
+from truefoundry.deploy.cli.console import console
+from truefoundry.deploy.cli.const import DISPLAY_DATETIME_FORMAT
+from truefoundry.deploy.json_util import json_default_encoder
+
+
+def print_json(data, default=json_default_encoder):
+    return _rich_print_json(
+        json.dumps(data, default=default), highlight=False, default=default
+    )
+
+
+NO_WRAP_COLUMNS = {"fqn"}
+
+
+def get_table(title):
+    return Table(title=title, show_lines=False, safe_box=True, box=box.MINIMAL)
+
+
+def stringify(x):
+    if isinstance(x, datetime.datetime):
+        return x.astimezone().strftime(DISPLAY_DATETIME_FORMAT)
+    elif isinstance(x, str):
+        return x
+    else:
+        return str(x)
+
+
+def display_time_passed(seconds: int):
+    m, s = divmod(seconds, 60)
+    h, m = divmod(m, 60)
+    d, h = divmod(h, 24)
+    result = ""
+    if d != 0:
+        result = f"{int(d)}D"
+    elif h != 0 and m != 0:
+        result = f"{int(h)}h {int(m)}m"
+    elif h != 0:
+        result = f"{int(h)}h"
+    elif m != 0 and s != 0:
+        result = f"{int(m)}m {int(s)}s"
+    elif m != 0:
+        result = f"{int(m)}m"
+    elif s != 0:
+        result = f"{int(s)}s"
+    return result
+
+
+def print_entity_list(title, items):
+    items = [item.list_row_data() for item in items]
+    if CliConfig.get("json"):
+        print_json(data=items)
+        return
+
+    table = get_table(title)
+
+    columns = []
+    if items:
+        columns = items[0].keys()
+        for column in columns:
+            no_wrap = column in NO_WRAP_COLUMNS
+            table.add_column(column, justify="left", overflow="fold", no_wrap=no_wrap)
+
+    for item in items:
+        row = []
+        for c in columns:
+            row.append(stringify(item[c]))
+        table.add_row(*row)
+    console.print(table)
+
+
+def print_obj(title, item, columns=None):
+    if CliConfig.get("json"):
+        print_json(data=item)
+        return
+
+    table = get_table(title)
+
+    if not columns:
+        columns = item.keys()
+
+    # transpose
+    keys, columns = columns, ["key", "value"]
+
+    for column in columns:
+        no_wrap = column in NO_WRAP_COLUMNS
+        table.add_column(column, justify="left", overflow="fold", no_wrap=no_wrap)
+    for key in keys:
+        table.add_row(f"[bold]{stringify(key)}[/]", stringify(item[key]))
+    console.print(table)
+
+
+def print_entity_obj(title, entity):
+    if CliConfig.get("json"):
+        print_json(data=entity)
+        return
+
+    table = get_table(title)
+
+    columns = entity.get_data().keys()
+
+    # transpose
+    keys, columns = columns, ["key", "value"]
+
+    for column in columns:
+        no_wrap = "FQN" in column or "Name" in column
+        table.add_column(column, justify="left", overflow="fold", no_wrap=no_wrap)
+    entity_data = entity.get_data()
+    for key in keys:
+        table.add_row(f"[bold]{stringify(key)}[/]", stringify(entity_data[key]))
+    console.print(table)

truefoundry/deploy/cli/util.py

@@ -0,0 +1,129 @@
+import functools
+import sys
+import zipfile
+from typing import Dict
+
+import rich_click as click
+from packaging.version import parse as parse_version
+from requests.exceptions import ConnectionError
+from rich.padding import Padding
+from rich.panel import Panel
+from rich.table import Table
+
+from truefoundry.deploy.cli.console import console
+from truefoundry.deploy.lib.exceptions import (
+    BadRequestException,
+    ConfigurationException,
+)
+from truefoundry.deploy.lib.util import is_debug_env_set
+
+
+def setup_rich_click():
+    click.rich_click.STYLE_ERRORS_SUGGESTION = "blue italic"
+    click.rich_click.SHOW_ARGUMENTS = True
+    click.rich_click.USE_RICH_MARKUP = True
+    click.rich_click.STYLE_HELPTEXT = ""
+
+
+def handle_exception(exception):
+    if is_debug_env_set():
+        console.print_exception(show_locals=True)
+    if isinstance(exception, BadRequestException):
+        print_dict_as_table_panel(
+            {"Status Code": str(exception.status_code), "Error": exception.message},
+            title="Command Failed",
+            border_style="red",
+        )
+    elif isinstance(exception, ConnectionError):
+        print_dict_as_table_panel(
+            {"Error": "Couldn't connect to TrueFoundry"},
+            title="Command Failed",
+            border_style="red",
+        )
+    elif isinstance(exception, ConfigurationException):
+        print_dict_as_table_panel(
+            {"Error": exception.message},
+            title="Command Failed",
+            border_style="red",
+        )
+    else:
+        print_dict_as_table_panel(
+            {"Error": str(exception)},
+            title="Command Failed",
+            border_style="red",
+        )
+
+
+def handle_exception_wrapper(fn):
+    @functools.wraps(fn)
+    def inner(*args, **kwargs):
+        try:
+            return fn(*args, **kwargs)
+        except Exception as e:
+            handle_exception(e)
+            sys.exit(1)
+
+    return inner
+
+
+def print_error(message):
+    text = Padding(message, (0, 1))
+    console.print(
+        Panel(
+            text,
+            border_style="red",
+            title="Command failed",
+            title_align="left",
+            width=click.rich_click.MAX_WIDTH,
+        )
+    )
+
+
+def print_message(message):
+    text = Padding(message, (0, 1))
+    console.print(
+        Panel(
+            text,
+            border_style="cyan",
+            title="Success",
+            title_align="left",
+            width=click.rich_click.MAX_WIDTH,
+        )
+    )
+
+
+def print_dict_as_table_panel(
+    dct: Dict[str, str],
+    title: str,
+    border_style: str = "cyan",
+    key_color: str = "cyan",
+):
+    table = Table(show_header=False, box=None)
+    table.add_column("Key", style=f"bold {key_color}", width=15)
+    table.add_column("Value")
+    for key, value in dct.items():
+        table.add_row(key, value)
+    console.print(
+        Panel(
+            table,
+            border_style=border_style,
+            title=title,
+            title_align="left",
+            width=click.rich_click.MAX_WIDTH,
+        )
+    )
+
+
+def unzip_package(path_to_package, destination):
+    with zipfile.ZipFile(path_to_package, "r") as zip_ref:
+        zip_ref.extractall(destination)
+
+
+def _prompt_if_no_value_and_supported(prompt: str, hide_input: bool = True):
+    import click as _click
+
+    kwargs = {}
+    if parse_version(_click.__version__).major >= 8:
+        kwargs = {"prompt": prompt, "hide_input": hide_input, "prompt_required": False}
+
+    return kwargs

truefoundry/deploy/core/__init__.py

@@ -0,0 +1,7 @@
+from truefoundry.deploy.core.login import login
+from truefoundry.deploy.core.logout import logout
+
+__all__ = [
+    "login",
+    "logout",
+]

truefoundry/deploy/core/login.py

@@ -0,0 +1,9 @@
+from typing import Optional
+
+from truefoundry.deploy.lib import session
+
+
+def login(
+    host: Optional[str] = None, api_key: Optional[str] = None, relogin: bool = False
+):
+    session.login(api_key=api_key, relogin=relogin, host=host)

truefoundry/deploy/core/logout.py

@@ -0,0 +1,5 @@
+from truefoundry.deploy.lib import session
+
+
+def logout():
+    session.logout()

truefoundry/deploy/function_service/__init__.py

@@ -0,0 +1,3 @@
+from truefoundry.deploy.function_service.build import BuildConfig
+from truefoundry.deploy.function_service.remote import remote
+from truefoundry.deploy.function_service.service import FunctionService

truefoundry/deploy/function_service/__main__.py

@@ -0,0 +1,27 @@
+import json
+
+import click
+
+from truefoundry.deploy.function_service.app import build_and_run_app
+from truefoundry.deploy.function_service.route import RouteGroups
+
+
+####
+# I am keeping the CLI here for now. This will get refactored going forward.
+@click.group()
+def cli():
+    pass
+
+
+# python -m truefoundry.deploy.function_service run --port 8000 --route-group-json ""
+# I am going to use this as "CMD" in the dockerfile to bring up the service
+@cli.command()
+@click.option("--route-groups-json", required=True, type=str)
+@click.option("--port", required=True, type=int)
+def run(port: int, route_groups_json: str):
+    route_groups = RouteGroups.parse_obj(json.loads(route_groups_json))
+    build_and_run_app(route_groups=route_groups, port=port)
+
+
+if __name__ == "__main__":
+    cli()