{AKS} Update custom preparers (#3994)

* sync custom preparers with cli

* fix

src/aks-preview/azext_aks_preview/tests/latest/custom_preparers.py

@@ -3,9 +3,18 @@
 # Licensed under the MIT License. See License.txt in the project root for license information.
 # --------------------------------------------------------------------------------------------
 
+from datetime import datetime
 import os
 
-from azure.cli.testsdk.preparers import ResourceGroupPreparer
+from azure.cli.testsdk.preparers import (
+    ResourceGroupPreparer,
+    VirtualNetworkPreparer,
+    RoleBasedServicePrincipalPreparer,
+    KEY_RESOURCE_GROUP,
+    KEY_VIRTUAL_NETWORK,
+)
+from azure.cli.testsdk.utilities import GraphClientPasswordReplacer
+from azext_aks_preview.tests.latest.recording_processors import MOCK_GUID, MOCK_SECRET
 
 
 class AKSCustomResourceGroupPreparer(ResourceGroupPreparer):
@@ -19,6 +28,7 @@ def __init__(
         dev_setting_location="AZURE_CLI_TEST_DEV_RESOURCE_GROUP_LOCATION",
         random_name_length=75,
         key="rg",
+        preserve_default_location=False,
     ):
         super(AKSCustomResourceGroupPreparer, self).__init__(
             name_prefix,
@@ -31,9 +41,170 @@ def __init__(
             key,
         )
 
+        # use environment variable to modify the default value of location
+        self.dev_setting_location = os.environ.get(dev_setting_location, None)
+        if not preserve_default_location and self.dev_setting_location:
+            self.location = self.dev_setting_location
+        else:
+            self.dev_setting_location = location
+
+
+class AKSCustomVirtualNetworkPreparer(VirtualNetworkPreparer):
+    def __init__(
+        self,
+        name_prefix="clitest.vn",
+        location="westus",
+        parameter_name="virtual_network",
+        resource_group_parameter_name="resource_group",
+        resource_group_key=KEY_RESOURCE_GROUP,
+        address_prefixes="10.128.0.0/24",
+        address_prefixes_parameter_name="address_prefixes",
+        dev_setting_name="AZURE_CLI_TEST_DEV_VIRTUAL_NETWORK_NAME",
+        dev_setting_location="AZURE_CLI_TEST_DEV_RESOURCE_GROUP_LOCATION",
+        random_name_length=24,
+        key=KEY_VIRTUAL_NETWORK,
+    ):
+        super(AKSCustomVirtualNetworkPreparer, self).__init__(
+            name_prefix,
+            location,
+            parameter_name,
+            resource_group_parameter_name,
+            resource_group_key,
+            dev_setting_name,
+            random_name_length,
+            key,
+        )
+
         # use environment variable to modify the default value of location
         self.dev_setting_location = os.environ.get(dev_setting_location, None)
         if self.dev_setting_location:
             self.location = self.dev_setting_location
         else:
             self.dev_setting_location = location
+
+        # get address_prefixes
+        # custom address_prefixes to avoid conflict with aks cluster/service cidr
+        self.address_prefixes = address_prefixes
+        self.address_prefixes_parameter_name = address_prefixes_parameter_name
+
+    def create_resource(self, name, **kwargs):
+        if self.dev_setting_name:
+            self.test_class_instance.kwargs[self.key] = name
+            return {
+                self.parameter_name: self.dev_setting_name,
+            }
+
+        tags = {
+            "product": "azurecli",
+            "cause": "automation",
+            "date": datetime.utcnow().strftime("%Y-%m-%dT%H:%M:%SZ"),
+        }
+        if "ENV_JOB_NAME" in os.environ:
+            tags["job"] = os.environ["ENV_JOB_NAME"]
+        tags = " ".join(
+            ["{}={}".format(key, value) for key, value in tags.items()]
+        )
+        template = (
+            "az network vnet create --resource-group {} --location {} --name {}"
+            " --subnet-name default --address-prefixes {} --tag " + tags
+        )
+        self._update_address_prefixes(**kwargs)
+        self.live_only_execute(
+            self.cli_ctx,
+            template.format(
+                self._get_resource_group(**kwargs),
+                self.location,
+                name,
+                self.address_prefixes,
+            ),
+        )
+
+        self.test_class_instance.kwargs[self.key] = name
+        return {self.parameter_name: name}
+
+    def remove_resource(self, name, **kwargs):
+        # The exception "CloudError" used in "VirtualNetworkPreparer" is deprecated
+        # since the SDK that network commands relies on has been migrated to track 2,
+        # the new exception class should be "HttpResponseError".
+        # Only one test case ("test_aks_create_default_service_with_virtual_node_addon")
+        # uses this preparer currently, and the network resources are still used
+        # by some resources (such as vmss) after the test, since there is no clean way
+        # to sort out dependencies and delete resources one by one, we do
+        # rely on deleting the resource group later to clean up
+        pass
+
+    def _update_address_prefixes(self, **kwargs):
+        if self.address_prefixes_parameter_name in kwargs:
+            self.address_prefixes = kwargs.get(
+                self.address_prefixes_parameter_name
+            )
+
+
+class AKSCustomRoleBasedServicePrincipalPreparer(
+    RoleBasedServicePrincipalPreparer
+):
+    def __init__(
+        self,
+        name_prefix="clitest",
+        skip_assignment=True,
+        parameter_name="sp_name",
+        parameter_password="sp_password",
+        dev_setting_sp_name="AZURE_CLI_TEST_DEV_SP_NAME",
+        dev_setting_sp_password="AZURE_CLI_TEST_DEV_SP_PASSWORD",
+        key="sp",
+    ):
+        super(AKSCustomRoleBasedServicePrincipalPreparer, self).__init__(
+            name_prefix,
+            skip_assignment,
+            parameter_name,
+            parameter_password,
+            dev_setting_sp_name,
+            dev_setting_sp_password,
+            key,
+        )
+
+    def create_resource(self, name, **kwargs):
+        if not self.dev_setting_sp_name:
+            command = "az ad sp create-for-rbac -n {}{}".format(
+                name, " --skip-assignment" if self.skip_assignment else ""
+            )
+
+            try:
+                self.result = self.live_only_execute(
+                    self.cli_ctx, command
+                ).get_output_in_json()
+            except AttributeError:  # live only execute returns None if playing from record
+                pass
+
+            if self.live_test or self.test_class_instance.in_recording:
+                sp_name = name
+                sp_password = self.result.get("password") or GraphClientPasswordReplacer.PWD_REPLACEMENT
+            else:
+                sp_name = MOCK_GUID
+                sp_password = MOCK_SECRET
+        else:
+            # call AbstractPreparer.moniker to make resource counts and self.resource_moniker consistent between live
+            # and play-back. see SingleValueReplacer.process_request, AbstractPreparer.__call__._preparer_wrapper
+            # and ScenarioTest.create_random_name. This is so that when self.create_random_name is called for the
+            # first time during live or playback, it would have the same value.
+            # In short, the default sp preparer in live mode does not call moniker, which leads to inconsistent counts.
+            _ = self.moniker
+
+            # When performing live test and recording, original sp and secret will be returned, but sp and secret would
+            # be replaced by azure.cli.command_modules.acs.tests.latest.recording_processors.KeyReplacer with
+            # MOCK_GUID and MOCK_SECRET while recording. When performing recording test, MOCK_GUID and MOCK_SECRET will
+            # be returned.
+            if self.live_test or self.test_class_instance.in_recording:
+                sp_name = self.dev_setting_sp_name
+                sp_password = self.dev_setting_sp_password
+            else:
+                sp_name = MOCK_GUID
+                sp_password = MOCK_SECRET
+
+        # update kwargs and return
+        self.test_class_instance.kwargs[self.key] = sp_name
+        self.test_class_instance.kwargs["{}_pass".format(self.key)] = sp_password
+        return {
+            self.parameter_name: sp_name,
+            self.parameter_password: sp_password,
+        }