{test} Add communication resource preparer

src/azure-cli-testsdk/azure/cli/testsdk/__init__.py

@@ -7,7 +7,8 @@
 
 from .base import ScenarioTest, LiveScenarioTest, LocalContextScenarioTest
 from .preparers import (StorageAccountPreparer, ResourceGroupPreparer, RoleBasedServicePrincipalPreparer,
-                        KeyVaultPreparer, ManagedApplicationPreparer, VirtualNetworkPreparer, VnetNicPreparer)
+                        KeyVaultPreparer, ManagedApplicationPreparer, VirtualNetworkPreparer, VnetNicPreparer,
+                        CommunicationResourcePreparer)
 from .exceptions import CliTestError
 from .checkers import (JMESPathCheck, JMESPathCheckExists, JMESPathCheckGreaterThan, NoneCheck, StringCheck,
                        StringContainCheck)
@@ -20,7 +21,7 @@
            'JMESPathCheckExists', 'NoneCheck', 'live_only', 'record_only', 'StringCheck', 'StringContainCheck',
            'get_sha1_hash', 'KeyVaultPreparer', 'JMESPathCheckGreaterThan', 'api_version_constraint',
            'create_random_name', 'MOCKED_USER_NAME', 'AADGraphUserReplacer', 'LocalContextScenarioTest',
-           'VirtualNetworkPreparer', 'VnetNicPreparer']
+           'VirtualNetworkPreparer', 'VnetNicPreparer', 'CommunicationResourcePreparer']
 
 
 __version__ = '0.1.0'

src/azure-cli-testsdk/azure/cli/testsdk/preparers.py

@@ -153,6 +153,59 @@ def _get_resource_group(self, **kwargs):
             raise CliTestError(template.format(ResourceGroupPreparer.__name__))
 
 
+# Communication resource Preparer and its shorthand decorator
+
+# pylint: disable=too-many-instance-attributes
+class CommunicationResourcePreparer(NoTrafficRecordingPreparer, SingleValueReplacer):
+    def __init__(self, name_prefix='clitest', location='Global', data_location='United States', length=24,
+                 parameter_name='communication_resource', resource_group_parameter_name='resource_group', skip_delete=True,
+                 dev_setting_name='AZURE_CLI_TEST_DEV_COMMUNICATION_RESOURCE_NAME', key='cr'):
+        super(CommunicationResourcePreparer, self).__init__(name_prefix, length)
+        self.cli_ctx = get_dummy_cli()
+        self.location = location
+        self.data_location = data_location
+        self.resource_group_parameter_name = resource_group_parameter_name
+        self.skip_delete = skip_delete
+        self.parameter_name = parameter_name
+        self.key = key
+        self.dev_setting_name = os.environ.get(dev_setting_name, None)
+
+    def create_resource(self, name, **kwargs):
+        group = self._get_resource_group(**kwargs)
+
+        if not self.dev_setting_name:
+
+            template = 'az communication create --name {} --location {} --data-location "{}" --resource-group {} '
+            self.live_only_execute(self.cli_ctx, template.format(
+                name, self.location, self.data_location, group))
+        else:
+            name = self.dev_setting_name
+
+        try:
+            account_key = self.live_only_execute(self.cli_ctx,
+                                                 'az communication list-key --name {} --resource-group {} --query "primaryConnectionString" -otsv'
+                                                 .format(name, group)).output.strip()
+        except AttributeError:  # live only execute returns None if playing from record
+            account_key = None
+
+        self.test_class_instance.kwargs[self.key] = name
+        return {self.parameter_name: name,
+                self.parameter_name + '_info': (name, account_key or 'veryFakedCommunicationResourceKey==')}
+
+    def remove_resource(self, name, **kwargs):
+        if not self.skip_delete and not self.dev_setting_name:
+            group = self._get_resource_group(**kwargs)
+            self.live_only_execute(self.cli_ctx, 'az communication delete --name {} --resource-group {} --yes'.format(name, group))
+
+    def _get_resource_group(self, **kwargs):
+        try:
+            return kwargs.get(self.resource_group_parameter_name)
+        except KeyError:
+            template = 'To create a communication resource a resource group is required. Please add ' \
+                       'decorator @{} in front of this communication resource preparer.'
+            raise CliTestError(template.format(ResourceGroupPreparer.__name__))
+
+
 # KeyVault Preparer and its shorthand decorator
 
 # pylint: disable=too-many-instance-attributes