Add distro validation for osm-arc (Azure#50)

* Add distro validation for osm-arc

* fixed indentation

* Fix linting

* Resolve comments

* Add unit test

* fix lint

Co-authored-by: Jonathan Innis <[email protected]>

Author: nshankar13

src/k8s-extension/HISTORY.rst

@@ -7,7 +7,6 @@ Release History
 ++++++++++++++++++
 * Add SSL support for AzureML
 
-
 0.4.2
 ++++++++++++++++++
 

src/k8s-extension/azext_k8s_extension/partner_extensions/OpenServiceMesh.py

@@ -5,20 +5,36 @@
 
 # pylint: disable=unused-argument
 
-from azure.cli.core.azclierror import InvalidArgumentValueError, RequiredArgumentMissingError
 from knack.log import get_logger
 
-from ..vendored_sdks.models import ExtensionInstance
-from ..vendored_sdks.models import ExtensionInstanceUpdate
-from ..vendored_sdks.models import ScopeCluster
-from ..vendored_sdks.models import Scope
+from azure.cli.core.azclierror import InvalidArgumentValueError, RequiredArgumentMissingError
+from azure.cli.core.commands.client_factory import get_subscription_id
+
+from pyhelm.chartbuilder import ChartBuilder
+from pyhelm.repo import VersionError
+from packaging import version
+import yaml
+
+from ..partner_extensions import PartnerExtensionModel
 
 from .PartnerExtensionModel import PartnerExtensionModel
 
+from ..vendored_sdks.models import (
+    ExtensionInstance,
+    ExtensionInstanceUpdate,
+    ScopeCluster,
+    Scope
+)
+
+from .._client_factory import cf_resources
+
 logger = get_logger(__name__)
 
 
 class OpenServiceMesh(PartnerExtensionModel):
+    CHART_NAME = "osm-arc"
+    CHART_LOCATION = "https://azure.github.io/osm-azure"
+
     def Create(self, cmd, client, resource_group_name, cluster_name, name, cluster_type, extension_type,
                scope, auto_upgrade_minor_version, release_train, version, target_namespace,
                release_namespace, configuration_settings, configuration_protected_settings,
@@ -62,6 +78,9 @@ def Create(self, cmd, client, resource_group_name, cluster_name, name, cluster_t
 
         # NOTE-2: Return a valid ExtensionInstance object, Instance name and flag for Identity
         create_identity = False
+
+        _validate_tested_distro(cmd, resource_group_name, cluster_name, version)
+
         extension_instance = ExtensionInstance(
             extension_type=extension_type,
             auto_upgrade_minor_version=auto_upgrade_minor_version,
@@ -93,3 +112,60 @@ def Update(self, extension, auto_upgrade_minor_version, release_train, version):
             release_train=release_train,
             version=version
         )
+
+
+def _validate_tested_distro(cmd, cluster_resource_group_name, cluster_name, extension_version):
+
+    field_unavailable_error = '\"testedDistros\" field unavailable for version {0} of microsoft.openservicemesh, ' \
+        'cannot determine if this Kubernetes distribution has been properly tested'.format(extension_version)
+
+    if version.parse(str(extension_version)) <= version.parse("0.8.3"):
+        logger.warning(field_unavailable_error)
+        return
+
+    subscription_id = get_subscription_id(cmd.cli_ctx)
+    resources = cf_resources(cmd.cli_ctx, subscription_id)
+
+    cluster_resource_id = '/subscriptions/{0}/resourceGroups/{1}/providers/Microsoft.Kubernetes' \
+        '/connectedClusters/{2}'.format(subscription_id, cluster_resource_group_name, cluster_name)
+
+    resource = resources.get_by_id(cluster_resource_id, '2020-01-01-preview')
+    cluster_distro = resource.properties['distribution'].lower()
+
+    if cluster_distro == "general":
+        logger.warning('Unable to determine if distro has been tested for microsoft.openservicemesh, '
+                       'kubernetes distro: \"general\"')
+        return
+
+    tested_distros = _get_tested_distros(extension_version)
+
+    if tested_distros is None:
+        logger.warning(field_unavailable_error)
+    elif cluster_distro not in tested_distros.split():
+        logger.warning('Untested kubernetes distro for microsoft.openservicemesh, Kubernetes distro is %s',
+                       cluster_distro)
+
+
+def _get_tested_distros(chart_version):
+
+    try:
+        chart_arc = ChartBuilder({
+            "name": OpenServiceMesh.CHART_NAME,
+            "version": str(chart_version),
+            "source": {
+                "type": "repo",
+                "location": OpenServiceMesh.CHART_LOCATION
+            }
+        })
+    except VersionError:
+        raise InvalidArgumentValueError(
+            "Invalid version '{}' for microsoft.openservicemesh".format(chart_version)
+        )
+
+    values = chart_arc.get_values()
+    values_yaml = yaml.load(values.raw, Loader=yaml.FullLoader)
+
+    try:
+        return values_yaml['OpenServiceMesh']['testedDistros']
+    except KeyError:
+        return None

src/k8s-extension/azext_k8s_extension/tests/latest/test_open_service_mesh.py

@@ -0,0 +1,22 @@
+# --------------------------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for license information.
+# --------------------------------------------------------------------------------------------
+
+# pylint: disable=protected-access
+
+import os
+import unittest
+
+from azext_k8s_extension.partner_extensions.OpenServiceMesh import _get_tested_distros
+from azure.cli.core.azclierror import InvalidArgumentValueError
+
+TEST_DIR = os.path.abspath(os.path.join(os.path.abspath(__file__), '..'))
+
+class TestOpenServiceMesh(unittest.TestCase):
+    def test_bad_osm_arc_version(self):
+        version = "0.7.1"
+        err = "Invalid version \'" + str(version) + "\' for microsoft.openservicemesh"
+        with self.assertRaises(InvalidArgumentValueError) as argError:
+            _get_tested_distros(version)
+        self.assertEqual(str(argError.exception), err)

src/k8s-extension/setup.py

@@ -30,7 +30,9 @@
 ]
 
 # TODO: Add any additional SDK dependencies here
-DEPENDENCIES = []
+DEPENDENCIES = [
+    'pyhelm'
+]
 
 VERSION = "0.4.3"