Merge branch 'dev' into dev

Author: Emil Einarsson

src/Microsoft.Azure.ServiceBus/Management/ManagementClient.cs

@@ -78,6 +78,18 @@ public static HttpRequestMessage CloneRequest(HttpRequestMessage req)
             return clone;
         }
 
+        /// <summary>
+        /// Gets information related to the currently used namespace.
+        /// </summary>
+        /// <param name="cancellationToken"></param>
+        /// <returns><see cref="NamespaceInfo"/> containing namespace information.</returns>
+        /// <remarks>Works with any claim (Send/Listen/Manage).</remarks>
+        public virtual async Task<NamespaceInfo> GetNamespaceInfoAsync(CancellationToken cancellationToken = default)
+        {
+            var content = await GetEntity("$namespaceinfo", null, false, cancellationToken).ConfigureAwait(false);
+            return NamespaceInfoExtensions.ParseFromContent(content);
+        }
+
         #region DeleteEntity
 
         /// <summary>

src/Microsoft.Azure.ServiceBus/Management/MessagingSku.cs

@@ -0,0 +1,31 @@
+// Copyright (c) Microsoft. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+namespace Microsoft.Azure.ServiceBus.Management
+{
+    /// <summary>
+    /// Specifies the SKU/tier of the messaging namespace.
+    /// </summary>
+    public enum MessagingSku
+    {
+        /// <summary>
+        /// Basic namespace. Shared Resource. Only queues are available.
+        /// </summary>
+        Basic = 1,
+
+        /// <summary>
+        /// Standard namespace. Shared Resource. Queues and topics.
+        /// </summary>
+        Standard = 2,
+
+        /// <summary>
+        /// Premium namespace. Dedicated Resource. Queues and topics.
+        /// </summary>
+        Premium = 3,
+
+        /// <summary>
+        /// Other SKUs.
+        /// </summary>
+        Others = 99
+    }
+}

src/Microsoft.Azure.ServiceBus/Management/NamespaceInfo.cs

@@ -0,0 +1,49 @@
+// Copyright (c) Microsoft. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+namespace Microsoft.Azure.ServiceBus.Management
+{
+    using System;
+
+    /// <summary>
+    /// Represents the metadata related to a service bus namespace.
+    /// </summary>
+    public class NamespaceInfo
+    {
+        /// <summary>
+        /// Name of the namespace.
+        /// </summary>
+        public string Name { get; set; }
+
+        /// <summary>
+        /// Type of entities present in the namespace.
+        /// </summary>
+        public NamespaceType NamespaceType { get; set; }
+
+        /// <summary>
+        /// The time at which the namespace was created.
+        /// </summary>
+        public DateTime CreatedTime { get; set; }
+
+        /// <summary>
+        /// The last time at which the namespace was modified.
+        /// </summary>
+        public DateTime ModifiedTime { get; set; }
+
+        /// <summary>
+        /// The SKU/tier of the namespace. Valid only for <see cref="NamespaceType.ServiceBus"/>
+        /// </summary>
+        public MessagingSku MessagingSku { get; set; }
+
+        /// <summary>
+        /// Number of messaging units allocated for namespace. 
+        /// Valid only for <see cref="NamespaceType.ServiceBus"/> and <see cref="MessagingSku.Premium"/>
+        /// </summary>
+        public int MessagingUnits { get; set; }
+
+        /// <summary>
+        /// Alias for the namespace.
+        /// </summary>
+        public string Alias { get; set; }
+    }
+}

src/Microsoft.Azure.ServiceBus/Management/NamespaceInfoExtensions.cs

@@ -0,0 +1,86 @@
+// Copyright (c) Microsoft. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+namespace Microsoft.Azure.ServiceBus.Management
+{
+    using System;
+    using System.Xml.Linq;
+
+    internal class NamespaceInfoExtensions
+    {
+        public static NamespaceInfo ParseFromContent(string xml)
+        {
+            try
+            {
+                var xDoc = XElement.Parse(xml);
+                if (!xDoc.IsEmpty)
+                {
+                    if (xDoc.Name.LocalName == "entry")
+                    {
+                        return ParseFromEntryElement(xDoc);
+                    }
+                }
+            }
+            catch (Exception ex) when (!(ex is ServiceBusException))
+            {
+                throw new ServiceBusException(false, ex);
+            }
+
+            throw new ServiceBusException(false, "Unknown error.");
+        }
+
+        private static NamespaceInfo ParseFromEntryElement(XElement xEntry)
+        {
+            var nsInfo = new NamespaceInfo();
+
+            var nsInfoXml = xEntry.Element(XName.Get("content", ManagementClientConstants.AtomNs))?
+                .Element(XName.Get("NamespaceInfo", ManagementClientConstants.SbNs));
+
+            if (nsInfoXml == null)
+            {
+                throw new ServiceBusException(true);
+            }
+
+            foreach (var element in nsInfoXml.Elements())
+            {
+                switch (element.Name.LocalName)
+                {
+                    case "CreatedTime":
+                        nsInfo.CreatedTime = DateTime.Parse(element.Value);
+                        break;
+                    case "ModifiedTime":
+                        nsInfo.ModifiedTime = DateTime.Parse(element.Value);
+                        break;
+                    case "Name":
+                        nsInfo.Name = element.Value;
+                        break;
+                    case "Alias":
+                        nsInfo.Alias = element.Value;
+                        break;
+                    case "NamespaceType":
+                        if (Enum.TryParse<NamespaceType>(element.Value, out var nsType))
+                        {
+                            nsInfo.NamespaceType = nsType;
+                        }
+                        else
+                        {
+                            nsInfo.NamespaceType = NamespaceType.Others;
+                        }
+                        break;
+                    case "MessagingSKU":
+                        if (Enum.TryParse<MessagingSku>(element.Value, out var nsSku))
+                        {
+                            nsInfo.MessagingSku = nsSku;
+                        }
+                        else
+                        {
+                            nsInfo.MessagingSku = MessagingSku.Others;
+                        }
+                        break;
+                }
+            }
+
+            return nsInfo;
+        }
+    }
+}

src/Microsoft.Azure.ServiceBus/Management/NamespaceType.cs

@@ -0,0 +1,27 @@
+// Copyright (c) Microsoft. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+namespace Microsoft.Azure.ServiceBus.Management
+{
+    /// <summary>
+    /// Specifies the type of entities the namespace can contain.
+    /// </summary>
+    public enum NamespaceType
+    {
+        /// <summary>
+        /// Namespace contains service bus entities (queues, topics)
+        /// </summary>
+        ServiceBus = 0,
+
+        /// <summary>
+        /// Supported only for backward compatibility.
+        /// Namespace can contain mixture of messaging entities and notification hubs. 
+        /// </summary>
+        Mixed = 2,
+
+        /// <summary>
+        /// Other type of resource.
+        /// </summary>
+        Others = 99,
+    }
+}

src/Microsoft.Azure.ServiceBus/Management/QueueDescription.cs

@@ -20,7 +20,6 @@ public class QueueDescription : IEquatable<QueueDescription>
         int maxDeliveryCount = 10;
         string forwardTo = null;
         string forwardDeadLetteredMessagesTo = null;
-        AuthorizationRules authorizationRules = null;
         string userMetadata = null;
 
         /// <summary>
@@ -185,17 +184,7 @@ public int MaxDeliveryCount
         /// <summary>
         /// The <see cref="AuthorizationRules"/> on the queue to control user access at entity level.
         /// </summary>
-        public AuthorizationRules AuthorizationRules
-        {
-            get
-            {
-                return this.authorizationRules ?? (this.authorizationRules = new AuthorizationRules());
-            }
-            internal set
-            {
-                this.authorizationRules = value;
-            }
-        }
+        public AuthorizationRules AuthorizationRules { get; internal set; } = new AuthorizationRules();
 
         /// <summary>
         /// The current status of the queue (Enabled / Disabled).
@@ -320,9 +309,9 @@ public bool Equals(QueueDescription otherDescription)
                 && this.RequiresSession.Equals(other.RequiresSession)
                 && this.Status.Equals(other.Status)
                 && string.Equals(this.userMetadata, other.userMetadata, StringComparison.OrdinalIgnoreCase)
-                && (this.authorizationRules != null && other.authorizationRules != null
-                    || this.authorizationRules == null && other.authorizationRules == null)
-                && (this.authorizationRules == null || this.AuthorizationRules.Equals(other.AuthorizationRules)))
+                && (this.AuthorizationRules != null && other.AuthorizationRules != null
+                    || this.AuthorizationRules == null && other.AuthorizationRules == null)
+                && (this.AuthorizationRules == null || this.AuthorizationRules.Equals(other.AuthorizationRules)))
             {
                 return true;
             }

src/Microsoft.Azure.ServiceBus/Management/TopicDescription.cs

@@ -15,7 +15,6 @@ public class TopicDescription : IEquatable<TopicDescription>
         internal string path;
         TimeSpan defaultMessageTimeToLive = TimeSpan.MaxValue;
         TimeSpan autoDeleteOnIdle = TimeSpan.MaxValue;
-        AuthorizationRules authorizationRules = null;
         string userMetadata = null;
 
         /// <summary>
@@ -123,22 +122,7 @@ public string Path
         /// <summary>
         /// The <see cref="AuthorizationRules"/> on the topic to control user access at entity level.
         /// </summary>
-        public AuthorizationRules AuthorizationRules
-        {
-            get
-            {
-                if (this.authorizationRules == null)
-                {
-                    this.authorizationRules = new AuthorizationRules();
-                }
-
-                return this.authorizationRules;
-            }
-            internal set
-            {
-                this.authorizationRules = value;
-            }
-        }
+        public AuthorizationRules AuthorizationRules { get; internal set; } = new AuthorizationRules();
 
         /// <summary>
         /// The current status of the topic (Enabled / Disabled).
@@ -218,9 +202,9 @@ public bool Equals(TopicDescription otherDescription)
                 && this.RequiresDuplicateDetection.Equals(other.RequiresDuplicateDetection)
                 && this.Status.Equals(other.Status)
                 && string.Equals(this.userMetadata, other.userMetadata, StringComparison.OrdinalIgnoreCase)
-                && (this.authorizationRules != null && other.authorizationRules != null
-                    || this.authorizationRules == null && other.authorizationRules == null)
-                && (this.authorizationRules == null || this.AuthorizationRules.Equals(other.AuthorizationRules)))
+                && (this.AuthorizationRules != null && other.AuthorizationRules != null
+                    || this.AuthorizationRules == null && other.AuthorizationRules == null)
+                && (this.AuthorizationRules == null || this.AuthorizationRules.Equals(other.AuthorizationRules)))
             {
                 return true;
             }

src/Microsoft.Azure.ServiceBus/Microsoft.Azure.ServiceBus.csproj

@@ -2,7 +2,7 @@
 
   <PropertyGroup>
     <Description>This is the next generation Azure Service Bus .NET Standard client library that focuses on queues &amp; topics. For more information about Service Bus, see https://azure.microsoft.com/en-us/services/service-bus/</Description>
-    <Version>3.2.1</Version>
+    <Version>3.3.0</Version>
     <Authors>Microsoft</Authors>
     <copyright>© Microsoft Corporation. All rights reserved.</copyright>
     <TargetFrameworks>netstandard2.0;net461</TargetFrameworks>

test/Microsoft.Azure.ServiceBus.UnitTests/API/ApiApprovals.ApproveAzureServiceBus.approved.txt

@@ -675,6 +675,7 @@ namespace Microsoft.Azure.ServiceBus.Management
         public virtual System.Threading.Tasks.Task DeleteRuleAsync(string topicPath, string subscriptionName, string ruleName, System.Threading.CancellationToken cancellationToken = null) { }
         public virtual System.Threading.Tasks.Task DeleteSubscriptionAsync(string topicPath, string subscriptionName, System.Threading.CancellationToken cancellationToken = null) { }
         public virtual System.Threading.Tasks.Task DeleteTopicAsync(string topicPath, System.Threading.CancellationToken cancellationToken = null) { }
+        public virtual System.Threading.Tasks.Task<Microsoft.Azure.ServiceBus.Management.NamespaceInfo> GetNamespaceInfoAsync(System.Threading.CancellationToken cancellationToken = null) { }
         public virtual System.Threading.Tasks.Task<Microsoft.Azure.ServiceBus.Management.QueueDescription> GetQueueAsync(string queuePath, System.Threading.CancellationToken cancellationToken = null) { }
         public virtual System.Threading.Tasks.Task<Microsoft.Azure.ServiceBus.Management.QueueRuntimeInfo> GetQueueRuntimeInfoAsync(string queuePath, System.Threading.CancellationToken cancellationToken = null) { }
         public virtual System.Threading.Tasks.Task<System.Collections.Generic.IList<Microsoft.Azure.ServiceBus.Management.QueueDescription>> GetQueuesAsync(int count = 100, int skip = 0, System.Threading.CancellationToken cancellationToken = null) { }
@@ -708,6 +709,30 @@ namespace Microsoft.Azure.ServiceBus.Management
         public MessagingEntityAlreadyExistsException(string message) { }
         public MessagingEntityAlreadyExistsException(string message, System.Exception innerException) { }
     }
+    public enum MessagingSku
+    {
+        Basic = 1,
+        Standard = 2,
+        Premium = 3,
+        Others = 99,
+    }
+    public class NamespaceInfo
+    {
+        public NamespaceInfo() { }
+        public string Alias { get; set; }
+        public System.DateTime CreatedTime { get; set; }
+        public Microsoft.Azure.ServiceBus.Management.MessagingSku MessagingSku { get; set; }
+        public int MessagingUnits { get; set; }
+        public System.DateTime ModifiedTime { get; set; }
+        public string Name { get; set; }
+        public Microsoft.Azure.ServiceBus.Management.NamespaceType NamespaceType { get; set; }
+    }
+    public enum NamespaceType
+    {
+        ServiceBus = 0,
+        Mixed = 2,
+        Others = 99,
+    }
     public class QueueDescription : System.IEquatable<Microsoft.Azure.ServiceBus.Management.QueueDescription>
     {
         public QueueDescription(string path) { }

test/Microsoft.Azure.ServiceBus.UnitTests/Management/ManagementClientTests.cs

@@ -550,6 +550,34 @@ public void AuthRulesEqualityCheckTest()
             Assert.Equal(qd, qd2);
         }
 
+        [Fact]
+        [DisplayTestMethodName]
+        public async Task QueueDescriptionParsedFromResponseEqualityCheckTest()
+        {
+            var name = Guid.NewGuid().ToString("D").Substring(0, 8);
+            var queueDescription = new QueueDescription(name);
+            var createdQueueDescription = await client.CreateQueueAsync(queueDescription);
+
+            var identicalQueueDescription = new QueueDescription(name);
+            Assert.Equal(identicalQueueDescription, createdQueueDescription);
+
+            await client.DeleteQueueAsync(name);
+        }
+
+        [Fact]
+        [DisplayTestMethodName]
+        public async Task TopicDescriptionParsedFromResponseEqualityCheckTest()
+        {
+            var name = Guid.NewGuid().ToString("D").Substring(0, 8);
+            var topicDescription = new TopicDescription(name);
+            var createdTopicDescription = await client.CreateTopicAsync(topicDescription);
+
+            var identicalTopicDescription = new TopicDescription(name);
+            Assert.Equal(identicalTopicDescription, createdTopicDescription);
+
+            await client.DeleteTopicAsync(name);
+        }
+
         [Fact]
         [DisplayTestMethodName]
         public async Task SqlFilterParamsTest()
@@ -605,6 +633,15 @@ public async Task CorrelationFilterPropertiesTest()
             await client.DeleteTopicAsync(topicName);
         }
 
+        [Fact]
+        [DisplayTestMethodName]
+        public async Task GetNamespaceInfoTest()
+        {
+            var nsInfo = await client.GetNamespaceInfoAsync();
+            Assert.NotNull(nsInfo);
+            Assert.Equal(MessagingSku.Standard, nsInfo.MessagingSku);   // Most CI systems generally use standard, hence this check just to ensure the API is working.
+        }
+
         public void Dispose()
         {
             client.CloseAsync().Wait();