Include schema name and group name in SchemaProperties (Azure#27641)

* Include schema name and group name in SchemaProperties

* Fix test

Author: JoshLove-msft

sdk/schemaregistry/Azure.Data.SchemaRegistry/api/Azure.Data.SchemaRegistry.netstandard2.0.cs

@@ -21,7 +21,9 @@ public partial class SchemaProperties
     {
         internal SchemaProperties() { }
         public Azure.Data.SchemaRegistry.SchemaFormat Format { get { throw null; } }
+        public string GroupName { get { throw null; } }
         public string Id { get { throw null; } }
+        public string Name { get { throw null; } }
     }
     public partial class SchemaRegistryClient
     {
@@ -46,7 +48,10 @@ public enum ServiceVersion
     }
     public static partial class SchemaRegistryModelFactory
     {
+        [System.ComponentModel.EditorBrowsableAttribute(System.ComponentModel.EditorBrowsableState.Never)]
         public static Azure.Data.SchemaRegistry.SchemaProperties SchemaProperties(Azure.Data.SchemaRegistry.SchemaFormat format, string schemaId) { throw null; }
+        [System.ComponentModel.EditorBrowsableAttribute(System.ComponentModel.EditorBrowsableState.Never)]
+        public static Azure.Data.SchemaRegistry.SchemaProperties SchemaProperties(Azure.Data.SchemaRegistry.SchemaFormat format, string schemaId, string groupName, string name) { throw null; }
     }
     public partial class SchemaRegistrySchema
     {

sdk/schemaregistry/Azure.Data.SchemaRegistry/src/SchemaProperties.cs

@@ -8,10 +8,12 @@ namespace Azure.Data.SchemaRegistry
     /// </summary>
     public class SchemaProperties
     {
-        internal SchemaProperties(SchemaFormat format, string schemaId)
+        internal SchemaProperties(SchemaFormat format, string schemaId, string groupName, string name)
         {
             Id = schemaId;
             Format = format;
+            GroupName = groupName;
+            Name = name;
         }
 
         /// <summary>
@@ -23,5 +25,15 @@ internal SchemaProperties(SchemaFormat format, string schemaId)
         /// Serialization type for the schema being stored.
         /// </summary>
         public SchemaFormat Format { get; }
+
+        /// <summary>
+        /// The group name for the schema.
+        /// </summary>
+        public string GroupName { get; }
+
+        /// <summary>
+        /// The name of the schema.
+        /// </summary>
+        public string Name { get; }
     }
 }

sdk/schemaregistry/Azure.Data.SchemaRegistry/src/SchemaRegistryClient.cs

@@ -123,7 +123,7 @@ private async Task<Response<SchemaProperties>> RegisterSchemaInternalAsync(
                     response = RestClient.Register(groupName, schemaName,format.ContentType, new BinaryData(schemaDefinition).ToStream(), cancellationToken);
                 }
 
-                var properties = new SchemaProperties(format, response.Headers.SchemaId);
+                var properties = new SchemaProperties(format, response.Headers.SchemaId, response.Headers.SchemaGroupName, response.Headers.SchemaName);
 
                 return Response.FromValue(properties, response);
             }
@@ -195,7 +195,7 @@ private async Task<Response<SchemaProperties>> GetSchemaPropertiesInternalAsync(
                     response = RestClient.QueryIdByContent(groupName, schemaName, format.ContentType, new BinaryData(schemaDefinition).ToStream(), cancellationToken);
                 }
 
-                var properties = new SchemaProperties(format, response.Headers.SchemaId);
+                var properties = new SchemaProperties(format, response.Headers.SchemaId, response.Headers.SchemaGroupName, response.Headers.SchemaName);
 
                 return Response.FromValue(properties, response);
             }
@@ -245,7 +245,7 @@ private async Task<Response<SchemaRegistrySchema>> GetSchemaInternalAsync(string
                 }
 
                 SchemaFormat format = new SchemaFormat(response.Headers.ContentType.Split('=')[1]);
-                var properties = new SchemaProperties(format, response.Headers.SchemaId);
+                var properties = new SchemaProperties(format, response.Headers.SchemaId, response.Headers.SchemaGroupName, response.Headers.SchemaName);
                 var schema = new SchemaRegistrySchema(properties, BinaryData.FromStream(response.Value).ToString());
 
                 return Response.FromValue(schema, response);

sdk/schemaregistry/Azure.Data.SchemaRegistry/src/SchemaRegistryModelFactory.cs

@@ -1,6 +1,8 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License.
 
+using System.ComponentModel;
+
 namespace Azure.Data.SchemaRegistry
 {
     /// <summary>
@@ -14,6 +16,18 @@ public static class SchemaRegistryModelFactory
         /// <param name="format">The format for the schema.</param>
         /// <param name="schemaId">The ID of the schema.</param>
         /// <returns></returns>
-        public static SchemaProperties SchemaProperties(SchemaFormat format, string schemaId) => new(format, schemaId);
+        [EditorBrowsable(EditorBrowsableState.Never)]
+        public static SchemaProperties SchemaProperties(SchemaFormat format, string schemaId) => SchemaProperties(format, schemaId, null, null);
+
+        /// <summary>
+        /// Constructs a SchemaProperties instance for mocking.
+        /// </summary>
+        /// <param name="format">The format for the schema.</param>
+        /// <param name="schemaId">The ID of the schema.</param>
+        /// <param name="groupName">The group name for the schema.</param>
+        /// <param name="name">The name of the schema.</param>
+        /// <returns></returns>
+        [EditorBrowsable(EditorBrowsableState.Never)]
+        public static SchemaProperties SchemaProperties(SchemaFormat format, string schemaId, string groupName, string name) => new(format, schemaId, groupName, name);
     }
 }

sdk/schemaregistry/Azure.Data.SchemaRegistry/tests/SchemaPropertiesTest.cs

@@ -10,9 +10,11 @@ public class SchemaPropertiesTest
         [Test]
         public void CanCreateFromCtor()
         {
-            var properties = new SchemaProperties(SchemaFormat.Avro, "schemaId");
+            var properties = new SchemaProperties(SchemaFormat.Avro, "schemaId", "groupName", "name");
             Assert.AreEqual(SchemaFormat.Avro, properties.Format);
             Assert.AreEqual("schemaId", properties.Id);
+            Assert.AreEqual("groupName", properties.GroupName);
+            Assert.AreEqual("name", properties.Name);
         }
 
         [Test]
@@ -22,5 +24,15 @@ public void CanCreateFromFactory()
             Assert.AreEqual(SchemaFormat.Avro, properties.Format);
             Assert.AreEqual("schemaId", properties.Id);
         }
+
+        [Test]
+        public void CanCreateFromFactoryCurrent()
+        {
+            var properties = SchemaRegistryModelFactory.SchemaProperties(SchemaFormat.Avro, "schemaId", "groupName", "name");
+            Assert.AreEqual(SchemaFormat.Avro, properties.Format);
+            Assert.AreEqual("schemaId", properties.Id);
+            Assert.AreEqual("groupName", properties.GroupName);
+            Assert.AreEqual("name", properties.Name);
+        }
     }
 }

sdk/schemaregistry/Azure.Data.SchemaRegistry/tests/SchemaRegistryClientLiveTests.cs

@@ -24,6 +24,7 @@ private SchemaRegistryClient CreateClient() =>
             ));
 
         private const string SchemaContent = "{\"type\" : \"record\",\"namespace\" : \"TestSchema\",\"name\" : \"Employee\",\"fields\" : [{ \"name\" : \"Name\" , \"type\" : \"string\" },{ \"name\" : \"Age\", \"type\" : \"int\" }]}";
+        private const string SchemaContent_V2 = "{\"type\" : \"record\",\"namespace\" : \"TestSchema\",\"name\" : \"Employee_V2\",\"fields\" : [{ \"name\" : \"Name\" , \"type\" : \"string\" },{ \"name\" : \"Age\", \"type\" : \"int\" }]}";
 
         [RecordedTest]
         public async Task CanRegisterSchema()
@@ -41,6 +42,26 @@ public async Task CanRegisterSchema()
             AssertPropertiesAreEqual(registerProperties, schemaProperties);
         }
 
+        [RecordedTest]
+        public async Task CanRegisterNewVersionOfSchema()
+        {
+            var client = CreateClient();
+            var schemaName = "test1";
+            var groupName = TestEnvironment.SchemaRegistryGroup;
+            var format = SchemaFormat.Avro;
+
+            SchemaProperties registerProperties = await client.RegisterSchemaAsync(groupName, schemaName, SchemaContent, format);
+            AssertSchemaProperties(registerProperties);
+
+            SchemaProperties schemaProperties = await client.GetSchemaPropertiesAsync(groupName, schemaName, SchemaContent, format);
+            AssertSchemaProperties(schemaProperties);
+            AssertPropertiesAreEqual(registerProperties, schemaProperties);
+
+            SchemaProperties newVersion = await client.RegisterSchemaAsync(schemaProperties.GroupName, schemaProperties.Name, SchemaContent_V2, schemaProperties.Format);
+            AssertSchemaProperties(newVersion);
+            Assert.AreNotEqual(registerProperties.Id, newVersion.Id);
+        }
+
         [RecordedTest]
         public async Task CanGetSchemaId()
         {
@@ -111,12 +132,16 @@ private void AssertSchemaProperties(SchemaProperties properties)
             Assert.IsNotNull(properties.Id);
             Assert.IsTrue(Guid.TryParse(properties.Id, out Guid _));
             Assert.AreEqual(SchemaFormat.Avro, properties.Format);
+            Assert.AreEqual("test1", properties.Name);
+            Assert.AreEqual(TestEnvironment.SchemaRegistryGroup, properties.GroupName);
         }
 
         private void AssertPropertiesAreEqual(SchemaProperties registeredSchema, SchemaProperties schema)
         {
             Assert.AreEqual(registeredSchema.Id, schema.Id);
             Assert.AreEqual(registeredSchema.Format, schema.Format);
+            Assert.AreEqual(registeredSchema.GroupName, schema.GroupName);
+            Assert.AreEqual(registeredSchema.Name, schema.Name);
         }
     }
 }