feat(deployment): adds command to update deployments

This commit introduces update deployment command that enables users
to conveniently update existing deployments by providing deployment
name or regex that can update multiple deployments

Usage: python -m rio deployment update [OPTIONS]
                                          [DEPLOYMENT_NAME_OR_REGEX]

  Updates one more deployments

Options:
  -f, --force, --silent  Skip confirmation
  -a, --update-all       Updates all deployments
  -w, --workers INTEGER  number of parallel workers while running update
                         deployment command. defaults to 10.
  --help                 Show this message and exit.

riocli/deployment/__init__.py

@@ -22,6 +22,7 @@
 from riocli.deployment.status import status
 from riocli.deployment.wait import wait_for_deployment
 from riocli.deployment.execute import execute_command
+from riocli.deployment.update import update_deployment
 
 
 @click.group(
@@ -46,3 +47,4 @@ def deployment():
 deployment.add_command(ssh_deployment)
 deployment.add_command(ssh_init)
 deployment.add_command(execute_command)
+deployment.add_command(update_deployment)

riocli/deployment/update.py

@@ -0,0 +1,199 @@
+# Copyright 2023 Rapyuta Robotics
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+import functools
+import re
+from concurrent.futures import ThreadPoolExecutor
+from queue import Queue
+from typing import List
+
+import click
+from click_help_colors import HelpColorsCommand
+from rapyuta_io import Client, DeploymentPhaseConstants
+from rapyuta_io.clients.deployment import Deployment
+from yaspin.api import Yaspin
+
+from riocli.config import new_client
+from riocli.constants import Symbols, Colors
+from riocli.utils import tabulate_data
+from riocli.utils.spinner import with_spinner
+
+
+@click.command(
+    'update',
+    cls=HelpColorsCommand,
+    help_headers_color=Colors.YELLOW,
+    help_options_color=Colors.GREEN,
+)
+@click.option('--force', '-f', '--silent', is_flag=True, default=False,
+              help='Skip confirmation')
+@click.option('--update-all', '-a', is_flag=True, default=False,
+              help='Updates all deployments')
+@click.option('--workers', '-w',
+              help="number of parallel workers while running update deployment "
+                   "command. defaults to 10.", type=int, default=10)
+@click.argument('deployment-name-or-regex', type=str, default="")
+@with_spinner(text="Updating...")
+def update_deployment(
+        force: bool,
+        update_all: bool,
+        workers: int,
+        deployment_name_or_regex: str,
+        spinner: Yaspin = None,
+) -> None:
+    """
+    Updates one more deployments
+    """
+    client = new_client()
+    if not (deployment_name_or_regex or update_all):
+        spinner.text = "Nothing to update"
+        spinner.green.ok(Symbols.SUCCESS)
+        return
+
+    try:
+        deployments = fetch_deployments(
+            client, deployment_name_or_regex, update_all)
+    except Exception as e:
+        spinner.text = click.style(
+            'Failed to update deployment(s): {}'.format(e), Colors.RED)
+        spinner.red.fail(Symbols.ERROR)
+        raise SystemExit(1) from e
+
+    if not deployments:
+        spinner.text = "Nothing to update"
+        spinner.ok(Symbols.SUCCESS)
+        return
+
+    headers = ['Name', 'GUID', 'Phase', 'Status']
+    data = [[d.name, d.deploymentId, d.phase, d.status] for d in deployments]
+
+    with spinner.hidden():
+        tabulate_data(data, headers)
+
+    spinner.write('')
+
+    if not force:
+        with spinner.hidden():
+            click.confirm('Do you want to update above deployment(s)?',
+                          default=True, abort=True)
+        spinner.write('')
+
+    try:
+        result = Queue()
+        func = functools.partial(_apply_update, client, result)
+        with ThreadPoolExecutor(max_workers=workers) as executor:
+            executor.map(func, deployments)
+
+        result = sorted(list(result.queue), key=lambda x: x[0])
+
+        data, fg, statuses = [], Colors.GREEN, []
+        for name, status in result:
+            fg = Colors.GREEN if status else Colors.RED
+            icon = Symbols.SUCCESS if status else Symbols.ERROR
+            statuses.append(status)
+            data.append([
+                click.style(name, fg),
+                click.style(icon, fg)
+            ])
+
+        with spinner.hidden():
+            tabulate_data(data, headers=['Name', 'Status'])
+
+        icon = Symbols.SUCCESS if all(statuses) else Symbols.WARNING
+        fg = Colors.GREEN if all(statuses) else Colors.YELLOW
+        text = "successfully" if all(statuses) else "partially"
+
+        spinner.write('')
+        spinner.text = click.style(
+            'Deployment(s) updated {}.'.format(text), fg)
+        spinner.ok(click.style(icon, fg))
+    except Exception as e:
+        spinner.text = click.style(
+            'Failed to update deployment(s): {}'.format(e), Colors.RED)
+        spinner.red.fail(Symbols.ERROR)
+        raise SystemExit(1) from e
+
+
+def fetch_deployments(
+        client: Client,
+        deployment_name_or_regex: str,
+        update_all: bool,
+) -> List[Deployment]:
+    deployments = client.get_all_deployments(
+        phases=[DeploymentPhaseConstants.SUCCEEDED,
+                DeploymentPhaseConstants.PROVISIONING])
+    result = []
+    for deployment in deployments:
+        if (update_all or deployment.name == deployment_name_or_regex or
+                (deployment_name_or_regex not in deployment.name and
+                 re.search(deployment_name_or_regex, deployment.name))):
+            result.append(deployment)
+
+    return result
+
+
+def get_component_context(component_info) -> dict:
+    result = {}
+
+    for component in component_info:
+        comp = {}
+        executables = []
+        exec_metadata = component.get("executableMetaData", []) or []
+
+        for e in exec_metadata:
+            # Component will be considered only if any of its executables is
+            # docker or build
+            if not (e.get("docker") or e.get("buildGUID")):
+                continue
+
+            executable = {}
+
+            if e.get("buildGUID"):
+                executable["buildGUID"] = e["buildGUID"]
+
+            if e.get("docker"):
+                executable["docker"] = e["docker"]
+
+            executable["id"] = e.get("id", "")
+            executable["name"] = e.get("name", "")
+            executables.append(executable)
+
+        if len(executables) > 0:
+            result[component["componentID"]] = comp
+            comp["component"] = {"executables": executables}
+            comp["update_deployment"] = True
+
+    return result
+
+
+def _apply_update(
+        client: Client,
+        result: Queue,
+        deployment: Deployment,
+) -> None:
+    try:
+        dep = client.get_deployment(deployment['deploymentId'])
+        component_context = get_component_context(dep.get("componentInfo", {}))
+        payload = {
+            "service_id": dep["packageId"],
+            "plan_id": dep["planId"],
+            "deployment_id": dep["deploymentId"],
+            "context": {
+                "component_context": component_context
+            }
+        }
+        client.update_deployment(payload)
+        result.put((deployment["name"], True))
+    except Exception:
+        result.put((deployment["name"], False))