Templetize SubResource and WritableSubResource classes, and added unit tests

sdk/resourcemanager/Azure.ResourceManager.Core/src/Resources/SubResource.Serialization.cs

@@ -10,7 +10,7 @@ namespace Azure.ResourceManager.Core
     /// <summary>
     /// A class representing a sub-resource that contains only the ID.
     /// </summary>
-    public partial class SubResource : IUtf8JsonSerializable
+    public partial class SubResource<TIdentifier> : IUtf8JsonSerializable
     {
         /// <summary>
         /// Serialize the input SubResource object.
@@ -37,7 +37,7 @@ void IUtf8JsonSerializable.Write(Utf8JsonWriter writer)
         /// </summary>
         /// <param name="element">The JSON element to be deserialized.</param>
         /// <returns>Deserialized SubResource object.</returns>
-        internal static SubResource DeserializeSubResource(JsonElement element)
+        internal static SubResource<TIdentifier> DeserializeSubResource(JsonElement element)
         {
             Optional<string> id = default;
             foreach (var property in element.EnumerateObject())
@@ -48,7 +48,7 @@ internal static SubResource DeserializeSubResource(JsonElement element)
                     continue;
                 }
             }
-            return new SubResource(id.Value);
+            return new SubResource<TIdentifier>(id.Value);
         }
     }
 }

sdk/resourcemanager/Azure.ResourceManager.Core/src/Resources/SubResource.cs

@@ -1,34 +1,89 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License.
 
+using System;
+
 namespace Azure.ResourceManager.Core
 {
+    /// <summary>
+    /// A class representing the a sub resource of ResourceIdentifier.
+    /// </summary>
+    public class SubResource : SubResource<ResourceIdentifier>
+    {
+        /// <summary>
+        /// Initializes an empty instance of <see cref="SubResource"/> for mocking.
+        /// </summary>
+        [InitializationConstructor]
+        protected SubResource() { }
+
+        /// <summary> Initializes a new instance of <see cref="SubResource"/>. </summary>
+        /// <param name="id"> ARM resource Id. </param>
+        [SerializationConstructor]
+        protected internal SubResource(string id) : base(id) { }
+    }
+
     /// <summary>
     /// A class representing a sub-resource that contains only the ID.
     /// </summary>
     [ReferenceType]
-    public partial class SubResource
+    [System.Diagnostics.CodeAnalysis.SuppressMessage("StyleCop.CSharp.MaintainabilityRules", "SA1402:File may only contain a single type", Justification = "Types differ by type argument only")]
+    public partial class SubResource<TIdentifier> : IEquatable<SubResource<TIdentifier>>, IEquatable<string>,
+        IComparable<SubResource<TIdentifier>>, IComparable<string> where TIdentifier : ResourceIdentifier
     {
         /// <summary>
-        /// Initializes an empty instance of <see cref="SubResource"/> for mocking.
+        /// Initializes an empty instance of <see cref="SubResource{TIdentifier}"/> for mocking.
         /// </summary>
         [InitializationConstructor]
-        public SubResource()
-        {
-        }
+        protected SubResource() { }
 
-        /// <summary> Initializes a new instance of SubResource. </summary>
+        /// <summary> Initializes a new instance of <see cref="SubResource{TIdentifier}"/>. </summary>
         /// <param name="id"> ARM resource Id. </param>
         [SerializationConstructor]
         protected internal SubResource(string id)
         {
-            Id = id;
+            Id = ResourceIdentifier.Create(id) as TIdentifier;
         }
 
         /// <summary>
         /// Gets the ARM resource identifier.
         /// </summary>
         /// <value></value>
-        public virtual ResourceIdentifier Id { get; }
+        public virtual TIdentifier Id { get; }
+
+        /// <inheritdoc/>
+        public int CompareTo(string other)
+        {
+            return string.Compare(Id, other, StringComparison.InvariantCultureIgnoreCase);
+        }
+
+        /// <inheritdoc/>
+        public int CompareTo(SubResource<TIdentifier> other)
+        {
+            if (other is null)
+                return 1;
+
+            if (ReferenceEquals(this, other))
+                return 0;
+
+            return Id.CompareTo(other.Id);
+        }
+
+        /// <inheritdoc/>
+        public bool Equals(SubResource<TIdentifier> other)
+        {
+            if (Id is null)
+                return false;
+
+            return Id.Equals(other?.Id);
+        }
+
+        /// <inheritdoc/>
+        public bool Equals(string other)
+        {
+            if (Id is null)
+                return false;
+
+            return Id.Equals(other);
+        }
     }
 }

sdk/resourcemanager/Azure.ResourceManager.Core/src/Resources/WritableSubResource.Serialization.cs

@@ -10,10 +10,10 @@ namespace Azure.ResourceManager.Core
     /// <summary>
     /// A class representing a sub-resource that contains only the ID.
     /// </summary>
-    public partial class WritableSubResource : IUtf8JsonSerializable
+    public partial class WritableSubResource<TIdentifier> : IUtf8JsonSerializable
     {
         /// <summary>
-        /// Serialize the input SubResourceReadOnly object.
+        /// Serialize the input WritableSubResource object.
         /// </summary>
         /// <param name="writer"> Input Json writer. </param>
         void IUtf8JsonSerializable.Write(Utf8JsonWriter writer)
@@ -28,11 +28,11 @@ void IUtf8JsonSerializable.Write(Utf8JsonWriter writer)
         }
 
         /// <summary>
-        /// Deserialize the input JSON element to a SubResourceReadOnly object.
+        /// Deserialize the input JSON element to a WritableSubResource object.
         /// </summary>
         /// <param name="element">The JSON element to be deserialized.</param>
-        /// <returns>Deserialized SubResourceReadOnly object.</returns>
-        internal static WritableSubResource DeserializeSubResourceReadOnly(JsonElement element)
+        /// <returns>Deserialized WritableSubResource object.</returns>
+        internal static WritableSubResource<TIdentifier> DeserializeWritableSubResource(JsonElement element)
         {
             Optional<string> id = default;
             foreach (var property in element.EnumerateObject())
@@ -43,7 +43,7 @@ internal static WritableSubResource DeserializeSubResourceReadOnly(JsonElement e
                     continue;
                 }
             }
-            return new WritableSubResource(id.Value);
+            return new WritableSubResource<TIdentifier>(id.Value);
         }
     }
 }

sdk/resourcemanager/Azure.ResourceManager.Core/src/Resources/WritableSubResource.cs

@@ -1,32 +1,88 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License.
 
+using System;
+
 namespace Azure.ResourceManager.Core
 {
+    /// <summary>
+    /// A class representing the a writable sub resource of ResourceIdentifier.
+    /// </summary>
+    public class WritableSubResource : WritableSubResource<ResourceIdentifier>
+    {
+        /// <summary>
+        /// Initializes an empty instance of <see cref="WritableSubResource"/> for mocking.
+        /// </summary>
+        [InitializationConstructor]
+        protected WritableSubResource() { }
+
+        /// <summary> Initializes a new instance of <see cref="WritableSubResource"/>. </summary>
+        /// <param name="id"> ARM resource Id. </param>
+        [SerializationConstructor]
+        protected internal WritableSubResource(string id) : base(id) { }
+    }
+
     /// <summary>
     /// A class representing a sub-resource that contains only the read-only ID.
     /// </summary>
     [ReferenceType]
-    public partial class WritableSubResource
+    [System.Diagnostics.CodeAnalysis.SuppressMessage("StyleCop.CSharp.MaintainabilityRules", "SA1402:File may only contain a single type", Justification = "Types differ by type argument only")]
+    public partial class WritableSubResource <TIdentifier> : IEquatable<WritableSubResource<TIdentifier>>, IEquatable<string>,
+        IComparable<WritableSubResource<TIdentifier>>, IComparable<string> where TIdentifier : ResourceIdentifier
     {
-        /// <summary> Initializes a new instance of SubResourceReadOnly. </summary>
+        /// <summary>
+        /// Initializes an empty instance of <see cref="WritableSubResource{TIdentifier}"/> for mocking.
+        /// </summary>
         [InitializationConstructor]
-        public WritableSubResource()
-        {
-        }
+        protected WritableSubResource() { }
 
-        /// <summary> Initializes a new instance of SubResourceReadOnly. </summary>
+        /// <summary> Initializes a new instance of <see cref="WritableSubResource{TIdentifier}"/>. </summary>
         /// <param name="id"> ARM resource Id. </param>
         [SerializationConstructor]
         protected internal WritableSubResource(string id)
         {
-            Id = id;
+            Id = ResourceIdentifier.Create(id) as TIdentifier;
         }
 
         /// <summary>
         /// Gets or sets the ARM resource identifier.
         /// </summary>
         /// <value></value>
-        public virtual ResourceIdentifier Id { get; set; }
+        public virtual TIdentifier Id { get; set; }
+
+        /// <inheritdoc/>
+        public int CompareTo(string other)
+        {
+            return string.Compare(Id, other, StringComparison.InvariantCultureIgnoreCase);
+        }
+
+        /// <inheritdoc/>
+        public int CompareTo(WritableSubResource<TIdentifier> other)
+        {
+            if (other is null)
+                return 1;
+
+            if (ReferenceEquals(this, other))
+                return 0;
+            return Id.CompareTo(other.Id);
+        }
+
+        /// <inheritdoc/>
+        public bool Equals(WritableSubResource<TIdentifier> other)
+        {
+            if (Id is null)
+                return false;
+
+            return Id.Equals(other?.Id);
+        }
+
+        /// <inheritdoc/>
+        public bool Equals(string other)
+        {
+            if (Id is null)
+                return false;
+
+            return Id.Equals(other);
+        }
     }
 }

sdk/resourcemanager/Azure.ResourceManager.Core/tests/Unit/SubResourceTests.cs

@@ -0,0 +1,65 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+using NUnit.Framework;
+
+namespace Azure.ResourceManager.Core.Tests
+{
+    [Parallelizable]
+    public class SubResourceTests
+    {
+        [TestCase(0, "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.ClassicStorage/storageAccounts/account1",
+           "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.ClassicStorage/storageAccounts/account1")]
+        [TestCase(0, "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.ClassicStorage/storageAccounts/account1",
+           "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.classicStorage/storageAccounts/account1")]
+        [TestCase(-1, "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.ClassicStorage/storageAccounts/account1",
+           "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.DiffSpace/storageAccounts/account2")]
+        [TestCase(1, "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.DiffSpace/storageAccounts/account1",
+           "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.ClassicStorage/storageAccounts/account2")]
+        [TestCase(0, "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.${?>._`/storageAccounts/account1",
+           "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.${?>._`/storageAccounts/account1")]
+        [TestCase(-1, "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.ClassicStorage/storageAccounts/${?>._`",
+           "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.ClassicStorage/storageAccounts/account2")]
+        public void CompareToObject(int expected, string id1, string id2)
+        {
+            SubResource resource1 = new SubResource(id1);
+            SubResource resource2 = new SubResource(id2);
+            Assert.AreEqual(expected, resource1.CompareTo(resource2));
+        }
+
+        [TestCase(0, "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.ClassicStorage/storageAccounts/account1",
+            "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.ClassicStorage/storageAccounts/account1")]
+        [TestCase(0, "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.ClassicStorage/storageAccounts/account1",
+            "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.classicStorage/storageAccounts/account1")]
+        [TestCase(-1, "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.ClassicStorage/storageAccounts/account1",
+            "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.DiffSpace/storageAccounts/account2")]
+        [TestCase(1, "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.DiffSpace/storageAccounts/account1",
+            "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.ClassicStorage/storageAccounts/account2")]
+        [TestCase(0, "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.${?>._`/storageAccounts/account1",
+            "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.${?>._`/storageAccounts/account1")]
+        [TestCase(-1, "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.ClassicStorage/storageAccounts/${?>._`",
+            "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.ClassicStorage/storageAccounts/account2")]
+        public void CompareToString(int expected, string id1, string id2)
+        {
+            SubResource resource1 = new SubResource(id1);
+            Assert.AreEqual(expected, resource1.CompareTo(id2));
+        }
+
+        [Test]
+        public void CompareToNull()
+        {
+            var resource1 = new SubResource("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.ClassicStorage/storageAccounts/account1");
+            SubResource resource2 = null;
+            Assert.AreEqual(1, resource1.CompareTo(resource2));
+            Assert.AreEqual(1, resource1.CompareTo((string)null));
+        }
+
+        [Test]
+        public void CompareToSame()
+        {
+            var resource1 = new SubResource("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.ClassicStorage/storageAccounts/account1");
+            var resource2 = resource1;
+            Assert.AreEqual(0, resource1.CompareTo(resource2));
+        }
+    }
+}

sdk/resourcemanager/Azure.ResourceManager.Core/tests/Unit/WritableSubResourceTests.cs

@@ -0,0 +1,65 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+using NUnit.Framework;
+
+namespace Azure.ResourceManager.Core.Tests
+{
+    [Parallelizable]
+    public class WritableSubResourceTests
+    {
+        [TestCase(0, "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.ClassicStorage/storageAccounts/account1",
+           "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.ClassicStorage/storageAccounts/account1")]
+        [TestCase(0, "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.ClassicStorage/storageAccounts/account1",
+           "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.classicStorage/storageAccounts/account1")]
+        [TestCase(-1, "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.ClassicStorage/storageAccounts/account1",
+           "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.DiffSpace/storageAccounts/account2")]
+        [TestCase(1, "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.DiffSpace/storageAccounts/account1",
+           "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.ClassicStorage/storageAccounts/account2")]
+        [TestCase(0, "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.${?>._`/storageAccounts/account1",
+           "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.${?>._`/storageAccounts/account1")]
+        [TestCase(-1, "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.ClassicStorage/storageAccounts/${?>._`",
+           "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.ClassicStorage/storageAccounts/account2")]
+        public void CompareToObject(int expected, string id1, string id2)
+        {
+            WritableSubResource resource1 = new WritableSubResource(id1);
+            WritableSubResource resource2 = new WritableSubResource(id2);
+            Assert.AreEqual(expected, resource1.CompareTo(resource2));
+        }
+
+        [TestCase(0, "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.ClassicStorage/storageAccounts/account1",
+            "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.ClassicStorage/storageAccounts/account1")]
+        [TestCase(0, "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.ClassicStorage/storageAccounts/account1",
+            "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.classicStorage/storageAccounts/account1")]
+        [TestCase(-1, "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.ClassicStorage/storageAccounts/account1",
+            "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.DiffSpace/storageAccounts/account2")]
+        [TestCase(1, "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.DiffSpace/storageAccounts/account1",
+            "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.ClassicStorage/storageAccounts/account2")]
+        [TestCase(0, "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.${?>._`/storageAccounts/account1",
+            "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.${?>._`/storageAccounts/account1")]
+        [TestCase(-1, "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.ClassicStorage/storageAccounts/${?>._`",
+            "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.ClassicStorage/storageAccounts/account2")]
+        public void CompareToString(int expected, string id1, string id2)
+        {
+            WritableSubResource resource1 = new WritableSubResource(id1);
+            Assert.AreEqual(expected, resource1.CompareTo(id2));
+        }
+
+        [Test]
+        public void CompareToNull()
+        {
+            var resource1 = new WritableSubResource("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.ClassicStorage/storageAccounts/account1");
+            WritableSubResource resource2 = null;
+            Assert.AreEqual(1, resource1.CompareTo(resource2));
+            Assert.AreEqual(1, resource1.CompareTo((string)null));
+        }
+
+        [Test]
+        public void CompareToSame()
+        {
+            var resource1 = new WritableSubResource("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.ClassicStorage/storageAccounts/account1");
+            var resource2 = resource1;
+            Assert.AreEqual(0, resource1.CompareTo(resource2));
+        }
+    }
+}