Merge pull request #5 from KieranBrantnerMagee/kibrantn/servicebus/track2-control-client-queue-create-tests

Initial commit of queue creation tests

Author: YijunXieMS

sdk/servicebus/azure-servicebus/azure/servicebus/management/_management_client.py

@@ -14,6 +14,7 @@
 from azure.core.pipeline.transport import RequestsTransport
 from azure.servicebus import ServiceBusSharedKeyCredential
 from msrest.serialization import Model
+from msrest.exceptions import ValidationError
 
 from .._common.constants import JWT_TOKEN_SCOPE
 from .._common.utils import parse_conn_str
@@ -44,13 +45,13 @@ def _handle_response_error():
         raise new_response_error
 
 
-def _convert_xml_to_object(queue_name, et, clazz):
+def _convert_xml_to_object(queue_name, et, class_):
     # type: (str, Union[Element, ElementTree], Type[Model]) -> Union[QueueDescription, QueueRuntimeInfo]
     content_ele = cast(ElementTree, et).find(constants.CONTENT_TAG)
     if not content_ele:
         raise ResourceNotFoundError("Queue '{}' does not exist".format(queue_name))
     qc_ele = content_ele.find(constants.QUEUE_DESCRIPTION_TAG)
-    obj = clazz.deserialize(qc_ele)
+    obj = class_.deserialize(qc_ele)
     obj.queue_name = queue_name
     return obj
 
@@ -116,7 +117,7 @@ def from_connection_string(cls, connection_string, **kwargs):
             endpoint = endpoint[endpoint.index("//")+2:]
         return cls(endpoint, ServiceBusSharedKeyCredential(shared_access_key_name, shared_access_key))
 
-    def _get_queue_object(self, queue_name, clazz):
+    def _get_queue_object(self, queue_name, class_):
         # type: (str, Type[Model]) -> Union[QueueDescription, QueueRuntimeInfo]
 
         if not queue_name:
@@ -127,10 +128,10 @@ def _get_queue_object(self, queue_name, clazz):
                 ElementTree,
                 self._impl.queue.get(queue_name, enrich=False, api_version=constants.API_VERSION)
             )
-        return _convert_xml_to_object(queue_name, et, clazz)
+        return _convert_xml_to_object(queue_name, et, class_)
 
-    def _list_queues(self, skip, max_count, clazz):
-        # type: (int, int, Type[Model]) -> Union[List[QueueDescription], List[QueueRuntimeInfo]]
+    def _list_queues(self, skip, max_count, class_):
+        # type: (int, int, Type[Model]) -> Union[List[QueueDescription], List[QueueRuntimeInfo])
         with _handle_response_error():
             et = cast(
                 ElementTree,
@@ -145,7 +146,7 @@ def _list_queues(self, skip, max_count, clazz):
             queue_description = _convert_xml_to_object(
                 entity_name,   # type: ignore
                 cast(Element, entry),
-                clazz
+                class_
             )
             queues.append(queue_description)
         return queues
@@ -169,36 +170,40 @@ def get_queue_runtime_info(self, queue_name):
     def create_queue(self, queue):
         # type: (Union[str, QueueDescription]) -> QueueDescription
         """Create a queue
-
+        
         :param queue: The queue name or a `QueueDescription` instance. When it's a str, it will be the name
          of the created queue. Other properties of the created queue will have default values decided by the
          ServiceBus. Use a `QueueDesceiption` if you want to set queue properties other than the queue name.
         :type queue: Union[str, QueueDescription].
         :returns: `QueueDescription` returned from ServiceBus.
         """
-
-        try:  # queue is a QueueDescription
-            queue_name = queue.queue_name
+        queue_name = None
+        try:
+            queue_name = queue.queue_name # type: ignore
             to_create = copy(queue)
-            to_create.queue_name = None
-        except AttributeError:  # str expected. But if not str, it might work and might not work.
+            to_create.queue_name = None            
+        except AttributeError:
             queue_name = queue
-            to_create = QueueDescription()
-        if queue_name is None:
-            raise ValueError("queue should be a non-empty str or a QueueDescription with non-empty queue_name")
+            to_create = QueueDescription()  # Use an empty queue description.
 
         create_entity_body = CreateQueueBody(
             content=CreateQueueBodyContent(
                 queue_description=to_create,
             )
         )
         request_body = create_entity_body.serialize(is_xml=True)
+        try:
+            with _handle_response_error():
+                et = cast(
+                    ElementTree,
+                    self._impl.queue.put(queue_name, request_body, api_version=constants.API_VERSION)
+                )
+        except ValidationError as e:
+            # post-hoc try to give a somewhat-justifiable failure reason.
+            if isinstance(queue, str) or (isinstance(queue, QueueDescription) and isinstance(queue.queue_name, str)):
+                raise ValueError("queue must be a non-empty str or a QueueDescription with non-empty str queue_name", e)
+            raise TypeError("queue must be a non-empty str or a QueueDescription with non-empty str queue_name", e)
 
-        with _handle_response_error():
-            et = cast(
-                ElementTree,
-                self._impl.queue.put(queue_name, request_body, api_version=constants.API_VERSION)
-            )
         return _convert_xml_to_object(queue_name, et, QueueDescription)
 
     def update_queue(self, queue_description):

sdk/servicebus/azure-servicebus/tests/test_mgmt_queues.py

@@ -0,0 +1,112 @@
+#-------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for
+# license information.
+#--------------------------------------------------------------------------
+
+import logging
+import pytest
+import uuid
+import datetime
+
+from azure.servicebus.management import ServiceBusManagementClient, QueueDescription
+from azure.servicebus._common.utils import utc_now
+from azure.core.exceptions import ResourceExistsError
+
+from devtools_testutils import AzureMgmtTestCase, CachedResourceGroupPreparer
+from servicebus_preparer import CachedServiceBusNamespacePreparer, ServiceBusQueuePreparer, CachedServiceBusQueuePreparer
+from utilities import get_logger
+
+_logger = get_logger(logging.DEBUG)
+
+class ServiceBusMgmtQueueTests(AzureMgmtTestCase):
+
+    @pytest.mark.liveTest
+    @CachedResourceGroupPreparer(name_prefix='servicebustest')
+    @CachedServiceBusNamespacePreparer(name_prefix='servicebustest')
+    def test_mgmt_queue_create_by_name(self, servicebus_namespace_connection_string, **kwargs):
+        mgmt_service = ServiceBusManagementClient.from_connection_string(servicebus_namespace_connection_string)
+
+        queue_name = str(uuid.uuid4())
+        created_at = utc_now()
+        mgmt_service.create_queue(queue_name)
+
+        queue = mgmt_service.get_queue(queue_name)
+        assert queue.queue_name == queue_name
+        assert queue.entity_availability_status == 'Available'
+        assert queue.status == 'Available'
+        assert created_at < queue.created_at < utc_now() + datetime.timedelta(minutes=10) # TODO: Should be created_at_utc for consistency with dataplane.
+
+    @pytest.mark.liveTest
+    @CachedResourceGroupPreparer(name_prefix='servicebustest')
+    @CachedServiceBusNamespacePreparer(name_prefix='servicebustest')
+    def test_mgmt_queue_create_with_invalid_name(self, servicebus_namespace_connection_string, **kwargs):
+        mgmt_service = ServiceBusManagementClient.from_connection_string(servicebus_namespace_connection_string)
+
+        with pytest.raises(TypeError):
+            mgmt_service.create_queue(Exception())
+
+        with pytest.raises(TypeError):
+            mgmt_service.create_queue(QueueDescription(queue_name=Exception()))
+
+        with pytest.raises(ValueError):
+            mgmt_service.create_queue('')
+
+        with pytest.raises(ValueError):
+            mgmt_service.create_queue(QueueDescription(queue_name=''))
+
+    @pytest.mark.liveTest
+    @CachedResourceGroupPreparer(name_prefix='servicebustest')
+    @CachedServiceBusNamespacePreparer(name_prefix='servicebustest')
+    def test_mgmt_queue_create_with_queue_description(self, servicebus_namespace_connection_string, **kwargs):
+        mgmt_service = ServiceBusManagementClient.from_connection_string(servicebus_namespace_connection_string)
+
+        queue_name = str(uuid.uuid4())
+        #TODO: Why don't we have an input model (queueOptions? as superclass of QueueDescription?) and output model to not show these params?
+        #TODO: This fails with the following: E           msrest.exceptions.DeserializationError: Find several XML 'prefix:DeadLetteringOnMessageExpiration' where it was not expected .tox\whl\lib\site-packages\msrest\serialization.py:1262: DeserializationError
+        mgmt_service.create_queue(QueueDescription(queue_name=queue_name,
+                                                    auto_delete_on_idle=datetime.timedelta(minutes=10),
+                                                    dead_lettering_on_message_expiration=True, 
+                                                    default_message_time_to_live=datetime.timedelta(minutes=11),
+                                                    duplicate_detection_history_time_window=datetime.timedelta(minutes=12),
+                                                    enable_batched_operations=True,
+                                                    enable_express=True,
+                                                    enable_partitioning=True,
+                                                    is_anonymous_accessible=True,
+                                                    lock_duration=datetime.timedelta(minutes=13),
+                                                    max_delivery_count=14,
+                                                    max_size_in_megabytes=15,
+                                                    requires_duplicate_detection=True, 
+                                                    requires_session=True,
+                                                    support_ordering=True
+                                                    ))
+
+        queue = mgmt_service.get_queue(queue_name)
+        assert queue.queue_name == queue_name
+        assert queue.auto_delete_on_idle == datetime.timedelta(minutes=10)
+        assert queue.dead_lettering_on_message_expiration == True
+        assert queue.default_message_time_to_live == datetime.timedelta(minutes=11)
+        assert queue.duplicate_detection_history_time_window == datetime.timedelta(minutes=12)
+        assert queue.enable_batched_operations == True
+        assert queue.enable_express == True
+        assert queue.enable_partitioning == True
+        assert queue.is_anonymous_accessible == True
+        assert queue.lock_duration == datetime.timedelta(minutes=13)
+        assert queue.max_delivery_count == 14
+        assert queue.max_size_in_megabytes == 15
+        assert queue.requires_duplicate_detection == True
+        assert queue.requires_session == True
+        assert queue.support_ordering == True
+
+    @pytest.mark.liveTest
+    @CachedResourceGroupPreparer(name_prefix='servicebustest')
+    @CachedServiceBusNamespacePreparer(name_prefix='servicebustest')
+    def test_mgmt_queue_create_duplicate(self, servicebus_namespace_connection_string, **kwargs):
+        mgmt_service = ServiceBusManagementClient.from_connection_string(servicebus_namespace_connection_string)
+
+        queue_name = str(uuid.uuid4())
+        created_at = utc_now()
+        mgmt_service.create_queue(queue_name)
+        with pytest.raises(ResourceExistsError):
+            mgmt_service.create_queue(queue_name)
+