Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature: add activate-launchplan command to pyflyte #1588

Merged
merged 4 commits into from
Apr 18, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
74 changes: 74 additions & 0 deletions flytekit/clis/sdk_in_container/launchplan.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
import click

from flytekit.clis.sdk_in_container.helpers import get_and_save_remote_with_click_context
from flytekit.models.launch_plan import LaunchPlanState

_launchplan_help = """
The launchplan command activates or deactivates a specified or the latest version of the launchplan.
If ``--activate`` is chosen then the previous version of the launchplan will be deactivated.
- ``launchplan`` refers to the name of the Launchplan
- ``launchplan_version`` is optional and should be a valid version for a Launchplan version. If not specified the latest will be used.
"""


@click.command("launchplan", help=_launchplan_help)
@click.option(
"-p",
"--project",
required=False,
type=str,
default="flytesnacks",
help="Fecth launchplan from this project",
)
@click.option(
"-d",
"--domain",
required=False,
type=str,
default="development",
help="Fetch launchplan from this domain",
)
@click.option(
"--activate/--deactivate",
required=True,
type=bool,
is_flag=True,
help="Activate or Deactivate the launchplan",
)
@click.argument(
"launchplan",
required=True,
type=str,
)
@click.argument(
"launchplan-version",
required=False,
type=str,
default=None,
)
@click.pass_context
def launchplan(
ctx: click.Context,
project: str,
domain: str,
activate: bool,
launchplan: str,
launchplan_version: str,
):
remote = get_and_save_remote_with_click_context(ctx, project, domain)
try:
launchplan = remote.fetch_launch_plan(
project=project,
domain=domain,
name=launchplan,
version=launchplan_version,
)
state = LaunchPlanState.ACTIVE if activate else LaunchPlanState.INACTIVE
remote.client.update_launch_plan(id=launchplan.id, state=state)
click.secho(
f"\n Launchplan was set to {LaunchPlanState.enum_to_string(state)}: {launchplan.name}:{launchplan.id.version}",
fg="green",
)
except StopIteration as e:
click.secho(f"{e.value}", fg="red")
2 changes: 2 additions & 0 deletions flytekit/clis/sdk_in_container/pyflyte.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
from flytekit.clis.sdk_in_container.build import build
from flytekit.clis.sdk_in_container.constants import CTX_CONFIG_FILE, CTX_PACKAGES, CTX_VERBOSE
from flytekit.clis.sdk_in_container.init import init
from flytekit.clis.sdk_in_container.launchplan import launchplan
from flytekit.clis.sdk_in_container.local_cache import local_cache
from flytekit.clis.sdk_in_container.package import package
from flytekit.clis.sdk_in_container.register import register
Expand Down Expand Up @@ -134,6 +135,7 @@ def main(ctx, pkgs: typing.List[str], config: str, verbose: bool):
main.add_command(register)
main.add_command(backfill)
main.add_command(build)
main.add_command(launchplan)
main.epilog

if __name__ == "__main__":
Expand Down
34 changes: 34 additions & 0 deletions tests/flytekit/unit/cli/pyflyte/test_launchplan.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
import pytest
from click.testing import CliRunner
from mock import mock

from flytekit.clis.sdk_in_container import pyflyte
from flytekit.remote import FlyteRemote


@mock.patch("flytekit.clis.sdk_in_container.helpers.FlyteRemote", spec=FlyteRemote)
@pytest.mark.parametrize(
("action", "expected_state"),
[
("activate", "ACTIVE"),
("deactivate", "INACTIVE"),
],
)
def test_pyflyte_launchplan(mock_remote, action, expected_state):
mock_remote.generate_console_url.return_value = "ex"
runner = CliRunner()
with runner.isolated_filesystem():
result = runner.invoke(
pyflyte.main,
[
"launchplan",
f"--{action}",
"-p",
"flytesnacks",
"-d",
"development",
"daily",
],
)
assert result.exit_code == 0
assert f"Launchplan was set to {expected_state}: " in result.output