Add new vme command list

Author: caoyihua

src/vme/azext_vme/_format.py

@@ -0,0 +1,21 @@
+# --------------------------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for license information.
+# --------------------------------------------------------------------------------------------
+
+from collections import OrderedDict
+
+
+def vme_list_table_format(results):
+    return [__get_table_row(result) for result in results]
+
+
+def __get_table_row(result):
+    return OrderedDict([
+        ('name', result['name']),
+        ('extensionType', result.get('properties', {}).get('extensionType', '')),
+        ('version', result.get('properties', {}).get('version', '')),
+        ('provisioningState', result.get('properties', {}).get('provisioningState', '')),
+        ('isSystemExtension', result.get('properties', {}).get('isSystemExtension', '')),
+        ('lastModifiedAt', result.get('systemData', {}).get('lastModifiedAt', '')),
+    ])

src/vme/azext_vme/_help.py

@@ -47,3 +47,15 @@
         text: |-
           az vme upgrade --resource-group my-resource-group --cluster-name my-cluster --wait
 """
+
+helps['vme list'] = """
+    type: command
+    short-summary: List version managed extensions.
+    examples:
+      - name: List version managed extensions
+        text: |-
+          az vme list --resource-group my-resource-group --cluster-name my-cluster
+      - name: List version managed extensions with table format
+        text: |-
+          az vme list --resource-group my-resource-group --cluster-name my-cluster --output table
+"""

src/vme/azext_vme/_params.py

@@ -92,3 +92,15 @@ def load_arguments(self, _):
             help='Extension types to be uninstalled.',
             arg_type=get_enum_type(IncludedExtensionTypes),
         )
+
+    with self.argument_context('vme list') as c:
+        c.argument(
+            'resource_group',
+            options_list=['--resource-group', '-g'],
+            help='Name of the resource group'
+        )
+        c.argument(
+            'cluster_name',
+            options_list=['--cluster-name', '-c'],
+            help='Name of the Kubernetes cluster'
+        )

src/vme/azext_vme/commands.py

@@ -4,10 +4,13 @@
 # --------------------------------------------------------------------------------------------
 
 # pylint: disable=line-too-long
+from ._format import vme_list_table_format
+
 
 def load_command_table(self, _):
 
     with self.command_group('vme') as g:
         g.custom_command('upgrade', 'upgrade_vme')
         g.custom_command('install', 'install_vme')
         g.custom_command('uninstall', 'uninstall_vme')
+        g.custom_command('list', 'list_vme', table_transformer=vme_list_table_format)

src/vme/azext_vme/consts.py

@@ -20,11 +20,11 @@
 SUCCEEDED = "Succeeded"
 CANCELLED = "Cancelled"
 Bundle_FeatureFlag_NotEnabled = "Bundle feature flag is not enabled."
-UPGRADE_IN_PROGRESS_MSG = "Version managed extensions upgrade is in progress …"
+UPGRADE_IN_PROGRESS_MSG = "Version managed extensions upgrade is in progress..."
 UPGRADE_SUCCEEDED_MSG = "Version managed extensions upgrade completed!"
 UPGRADE_FAILED_MSG = "Version managed extensions upgrade failed. Error: "
 UPGRADE_CANCELED_MSG = "Version managed extensions upgrade is canceled."
-UPGRADE_NOTSTARTED_MSG = "Waiting for version managed extensions upgrade to start …"
+UPGRADE_NOTSTARTED_MSG = "Waiting for version managed extensions upgrade to start..."
 UPGRADE_TIMEOUT_MSG = """
 Error: version managed extensions upgrade could not start in {0} seconds. Check out common issues here: <url>
 """
@@ -34,9 +34,14 @@
     "microsoft.azure.secretstore"
 ]
 
-BundleExtensionNames = {
+BundleExtensionTypeNames = {
     "microsoft.arc.containerstorage": "azure-arc-containerstorage",
     "microsoft.azure.secretstore": "azure-secret-store",
 }
 
 IncludedExtensionTypes = BundleExtensionTypes + ["all"]
+BundleExtensionNames = [
+    "azure-arc-containerstorage",
+    "azure-secret-store",
+    "microsoft.extensiondiagnostics-v0"
+]

src/vme/azext_vme/custom.py

@@ -41,10 +41,12 @@ def install_vme(
     for extension_type in include_extension_types:
         extension_resource_id = (
             f"{cluster_resource_id}/Providers/Microsoft.KubernetesConfiguration/"
-            f"extensions/{consts.BundleExtensionNames[extension_type]}"
+            f"extensions/{consts.BundleExtensionTypeNames[extension_type]}"
         )
         try:
-            resources.get_by_id(extension_resource_id, '2022-11-01')
+            ext = resources.get_by_id(extension_resource_id, '2022-11-01')
+            if ext.properties['provisioningState'] == 'Failed':
+                raise ResourceNotFoundError()
             print(f"Extension {extension_type} already exists, skipping installation.")
             continue
         except ResourceNotFoundError:
@@ -61,14 +63,15 @@ def install_vme(
                 "--cluster-type",
                 consts.CONNECTEDCLUSTER_TYPE,
                 "--name",
-                consts.BundleExtensionNames[extension_type],
+                consts.BundleExtensionTypeNames[extension_type],
                 "--extension-type",
                 extension_type,
                 "--scope",
                 "cluster"
             ]
-            utils.call_subprocess_raise_output(command)
+            result = utils.call_subprocess_raise_output(command)
             print(f"Installed extension {extension_type} successfully.")
+            print(result)
 
     print("All extensions installed successfully.")
 
@@ -103,7 +106,7 @@ def uninstall_vme(
                    "--cluster-type",
                    "connectedClusters",
                    "--name",
-                   consts.BundleExtensionNames[extension_type],
+                   consts.BundleExtensionTypeNames[extension_type],
                    "--force",
                    "--yes"]
         utils.call_subprocess_raise_output(command)
@@ -177,3 +180,31 @@ def upgrade_vme(
 
     if (not deployment):
         raise CLIError(consts.UPGRADE_TIMEOUT_MSG.format(wait_timeout))
+
+
+def list_vme(
+        cmd,
+        resource_group_name: str,
+        cluster_name: str):
+    subscription_id = get_subscription_id(cmd.cli_ctx)
+
+    # Check whether the cluster exists
+    resources = cf_resources(cmd.cli_ctx, subscription_id)
+    cluster_resource_id = '/subscriptions/{0}/resourceGroups/{1}/providers/{2}/{3}/{4}'.format(
+        subscription_id, resource_group_name, consts.CONNECTEDCLUSTER_RP, consts.CONNECTEDCLUSTER_TYPE, cluster_name)
+    resources.get_by_id(cluster_resource_id, '2024-12-01-preview')
+
+    results = []
+    extension_names = consts.BundleExtensionNames
+    for extension_name in extension_names:
+        extension_resource_id = (
+            f"{cluster_resource_id}/Providers/Microsoft.KubernetesConfiguration/"
+            f"extensions/{extension_name}"
+        )
+        try:
+            ext = resources.get_by_id(extension_resource_id, '2022-11-01')
+            results.append(ext)
+        except ResourceNotFoundError:
+            continue
+
+    return results

src/vme/azext_vme/utils.py

@@ -6,16 +6,36 @@
 import shutil
 import subprocess
 import time
+import sys
 from azure.core.exceptions import ResourceNotFoundError
 from knack.util import CLIError
 from knack.log import get_logger
 from azext_vme import consts
-
+import threading
 
 logger = get_logger(__name__)
 
 
-def call_subprocess_raise_output(cmd: list, logcmd: bool = True) -> str:
+class PollingAnimation:
+    def __init__(self):
+        self.tickers = ["/", "|", "\\", "-", "/", "|", "\\", "-"]
+        self.currTicker = 0
+        self.running = True
+
+    def tick(self):
+        while self.running:  # Keep the animation going
+            sys.stdout.write('\r' + self.tickers[self.currTicker] + " Running ..")
+            sys.stdout.flush()
+            self.currTicker = (self.currTicker + 1) % len(self.tickers)
+            time.sleep(0.5)  # Adjust speed if needed
+
+    def flush(self):
+        self.running = False  # Stop the animation
+        sys.stdout.write("\r\033[K")  # Clears the line
+        sys.stdout.flush()
+
+
+def call_subprocess_raise_output(cmd: list, logcmd: bool = False, logstatus: bool = True) -> str:
     """
     Call a subprocess and raise a CLIError with the output if it fails.
 
@@ -32,6 +52,11 @@ def call_subprocess_raise_output(cmd: list, logcmd: bool = True) -> str:
         # Log the command to be run, but do not log the password.
         print(f"Running command: {' '.join(log_cmd)}")
 
+    if logstatus:
+        animation = PollingAnimation()
+        spinner_thread = threading.Thread(target=animation.tick)
+        spinner_thread.start()
+
     try:
         called_process = subprocess.run(
             cmd, encoding="utf-8", capture_output=True, text=True, check=True
@@ -43,15 +68,21 @@ def call_subprocess_raise_output(cmd: list, logcmd: bool = True) -> str:
             called_process.stderr,
         )
 
+        if logstatus:
+            animation.running = False
+            spinner_thread.join()
+            animation.flush()
         return called_process.stdout
     except subprocess.CalledProcessError as error:
+        if logstatus:
+            animation.running = False
+            spinner_thread.join()
+            animation.flush()
         all_output: str = (
             f"Command: {' '.join(log_cmd)}\n"
-            f"stdout: {error.stdout}\n"
-            f"stderr: {error.stderr}\n"
-            f"Return code: {error.returncode}"
+            f"{error.stderr}"
         )
-        logger.debug("The following command failed to run:\n%s", all_output)
+
         # Raise the error without the original exception, which may contain secrets.
         raise CLIError(all_output) from None
 
@@ -89,10 +120,10 @@ def check_and_add_cli_extension(cli_extension_name):
         "-o",
         "tsv"
     ]
-    result = call_subprocess_raise_output(command, False)
+    result = call_subprocess_raise_output(command, False, False)
 
     if not (cli_extension_name in result.strip()):
-        print(f"{cli_extension_name} is not installed. Adding it now...")
+        print(f"Installing az cli extension {cli_extension_name}...")
         command = [
             str(shutil.which("az")),
             "extension",
@@ -101,6 +132,7 @@ def check_and_add_cli_extension(cli_extension_name):
             cli_extension_name
         ]
         call_subprocess_raise_output(command)
+        print(f"Installed az cli extension {cli_extension_name} successfully.")
 
 
 def check_and_enable_bundle_feature_flag(
@@ -131,7 +163,8 @@ def check_and_enable_bundle_feature_flag(
         call_subprocess_raise_output(command)
 
         # Wait for the feature flag to be enabled on the dp side
-        time.sleep(5)
+        time.sleep(30)
+        print("Enabled the bundle feature flag successfully.")
 
 
 def check_deployment_status(resources, deployment, timestamp):

src/vme/setup.py

@@ -10,7 +10,7 @@
 from setuptools import setup, find_packages
 
 # HISTORY.rst entry.
-VERSION = '1.0.0b1'
+VERSION = '1.0.1b1'
 
 # The full list of classifiers is available at
 # https://pypi.python.org/pypi?%3Aaction=list_classifiers