Merge branch 'sb_control_client' into kibrantn/servicebus/track2-control-client-queue-create-tests

Author: YijunXieMS

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

@@ -34,11 +34,14 @@ def _handle_response_error():
     try:
         yield
     except HttpResponseError as response_error:
-        new_response_error = HttpResponseError(
-            message=response_error.model.detail,
-            response=response_error.response,
-            model=response_error.model
-        )
+        try:
+            new_response_error = HttpResponseError(
+                message=response_error.model.detail,
+                response=response_error.response,
+                model=response_error.model
+            )
+        except AttributeError:
+            new_response_error = response_error
         raise new_response_error
 
 
@@ -54,13 +57,20 @@ def _convert_xml_to_object(queue_name, et, class_):
 
 
 class ServiceBusManagementClient:
+    """Use this client to create, update, list, and delete resources of a ServiceBus namespace
+
+    :param str fully_qualified_namespace:
+    :param credential:
+    :type credential: Union[TokenCredential, ServiceBusSharedKeyCredential]
+    :keyword Pipeline pipeline: If omitted, the standard pipeline is used.
+    :keyword HttpTransport transport: If omitted, the standard pipeline is used.
+    :keyword List[HTTPPolicy] policies: If omitted, the standard pipeline is used.
+
+    For keyword arguments, refer to TODO: add a link here
+    """
 
     def __init__(self, fully_qualified_namespace, credential, **kwargs):
         # type: (str, Union[TokenCredential, ServiceBusSharedKeyCredential], Dict[str, Any]) -> None
-        """
-        :param fully_qualified_namespace:
-        :param kwargs:
-        """
         self.fully_qualified_namespace = fully_qualified_namespace
         self._credential = credential
         self._endpoint = "https://" + fully_qualified_namespace
@@ -93,12 +103,14 @@ def _build_pipeline(self, **kwargs):  # pylint: disable=no-self-use
         return Pipeline(transport, policies)
 
     @classmethod
-    def from_connection_string(cls, connection_string):
-        # type: (str) -> ServiceBusManagementClient
-        """
+    def from_connection_string(cls, connection_string, **kwargs):
+        # type: (str, Any) -> ServiceBusManagementClient
+        """Create a client from connection string
 
         :param str connection_string:
-        :return:
+        :keyword Pipeline pipeline: If omitted, the standard pipeline is used.
+        :keyword HttpTransport transport: If omitted, the standard pipeline is used.
+        :keyword List[HTTPPolicy] policies: If omitted, the standard pipeline is used.
         """
         endpoint, shared_access_key_name, shared_access_key, _ = parse_conn_str(connection_string)
         if "//" in endpoint:
@@ -141,16 +153,30 @@ def _list_queues(self, skip, max_count, class_):
 
     def get_queue(self, queue_name):
         # type: (str) -> QueueDescription
+        """Get a QueueDescription
+
+        :param str queue_name: The name of the queue
+        """
         return self._get_queue_object(queue_name, QueueDescription)
 
     def get_queue_runtime_info(self, queue_name):
         # type: (str) -> QueueRuntimeInfo
+        """Get the runtime information of a queue
+
+        :param str queue_name: The name of the queue
+        """
         return self._get_queue_object(queue_name, QueueRuntimeInfo)
 
     def create_queue(self, queue):
         # type: (Union[str, QueueDescription]) -> QueueDescription
-        """Create a queue"""
-
+        """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.
+        """
         queue_name = None
         try:
             queue_name = queue.queue_name # type: ignore
@@ -182,7 +208,13 @@ def create_queue(self, queue):
 
     def update_queue(self, queue_description):
         # type: (QueueDescription) -> QueueDescription
-        """Update a queue"""
+        """
+
+        :param queue_description: The properties of this `QueueDescription` will be applied to the queue in
+         ServiceBus. Only a portion of properties can be updated.
+         Refer to https://docs.microsoft.com/en-us/rest/api/servicebus/update-queue.
+        :type queue_description: QueueDescription
+        """
         if not queue_description.queue_name:
             raise ValueError("queue_description must have a non-empty queue_name")
 
@@ -208,7 +240,10 @@ def update_queue(self, queue_description):
 
     def delete_queue(self, queue_name):
         # type: (str) -> None
-        """Create a queue"""
+        """Delete a queue
+
+        :param str queue_name: The name of the queue
+        """
 
         if not queue_name:
             raise ValueError("queue_name must not be None or empty")
@@ -217,8 +252,20 @@ def delete_queue(self, queue_name):
 
     def list_queues(self, skip=0, max_count=100):
         # type: (int, int) -> List[QueueDescription]
+        """List the queues of a ServiceBus namespace
+
+        :param int skip: skip this number of queues
+        :param int max_count: return at most this number of queues if there are more than this number in
+         the ServiceBus namespace
+        """
         return self._list_queues(skip, max_count, QueueDescription)
 
     def list_queues_runtime_info(self, skip=0, max_count=100):
         # type: (int, int) -> List[QueueRuntimeInfo]
+        """List the queues runtime info of a ServiceBus namespace
+
+        :param int skip: skip this number of queues
+        :param int max_count: return at most this number of queues if there are more than this number in
+         the ServiceBus namespace
+        """
         return self._list_queues(skip, max_count, QueueRuntimeInfo)

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

@@ -5,11 +5,18 @@
 
 import time
 import six
+from azure.core.pipeline import PipelineRequest
 from azure.core.pipeline.policies import SansIOHTTPPolicy
 from .._base_handler import ServiceBusSharedKeyCredential
 
 
 class ServiceBusSharedKeyCredentialPolicy(SansIOHTTPPolicy):
+    """A policy that put token generated by ServiceBusSharedKeyCredential into HTTP request header
+
+    :param str endpoint:
+    :param ServiceBusSharedKeyCredential credential:
+    :param str name:
+    """
     def __init__(self, endpoint, credential, name):
         # type: (str, ServiceBusSharedKeyCredential, str) -> None
         super(ServiceBusSharedKeyCredentialPolicy, self).__init__()
@@ -29,5 +36,11 @@ def _update_token(self):
             self._token = access_token.decode("utf-8")
 
     def on_request(self, request):
+        # type: (PipelineRequest) -> None
+        """Adds an Authorization header to request and sends request to next policy.
+
+        :param request: The pipeline request object
+        :type request: ~azure.core.pipeline.PipelineRequest
+        """
         self._update_token()
         request.http_request.headers[self._name] = self._token

sdk/servicebus/azure-servicebus/azure/servicebus/management/aio/_management_client_async.py

@@ -95,7 +95,7 @@ async def _get_queue_object(self, queue_name, clazz):
         return _convert_xml_to_object(queue_name, et, clazz)
 
     async def _list_queues(self, skip, max_count, clazz):
-        # type: (int, int, Type[Model]) -> Union[List[QueueDescription], List[QueueRuntimeInfo])
+        # type: (int, int, Type[Model]) -> Union[List[QueueDescription], List[QueueRuntimeInfo]]
         with _handle_response_error():
             et = cast(
                 ElementTree,
@@ -126,18 +126,19 @@ async def get_queue_runtime_info(self, queue_name):
     async def create_queue(self, queue):
         # type: (Union[str, QueueDescription]) -> QueueDescription
         """Create a queue"""
-        if not queue or not queue.queue_name:  # type: ignore
-            raise ValueError("queue must be a non-empty str or a QueueDescription with non-empty queue_name")
-        if isinstance(queue, str):
+        try:  # queue is a QueueDescription
+            queue_name = queue.queue_name
+            to_create = copy(queue)
+            to_create.queue_name = None
+        except AttributeError:  # str expected. But if not str, it might work and might not work.
             queue_name = queue
-            queue_description = QueueDescription()
-        else:
-            queue_name = queue.queue_name  # type: ignore
-            queue_description = copy(queue)
-            queue_description.queue_name = None
+            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")
+
         create_entity_body = CreateQueueBody(
             content=CreateQueueBodyContent(
-                queue_description=queue_description,
+                queue_description=to_create,
             )
         )
         request_body = create_entity_body.serialize(is_xml=True)