Sync typespec-java core: support XML serialization

.chronus/changes/typespec-java-dpg-xml-2026-07-21-14-26-0.md

@@ -0,0 +1,7 @@
+---
+changeKind: fix
+packages:
+  - "@azure-tools/typespec-java"
+---
+
+Support XML serialization for models: generate XmlSerializer helper classes and use the XML ObjectSerializer overload of toObject/fromObject in convenience methods for XML request/response bodies.

packages/typespec-java/core-commit.json

@@ -1 +1 @@
-{ "sha": "8cef6d928a2ac3237d5eacb69b4ac671a54bcf92" }
+{ "sha": "d012e83129830c7b71a44999c4f3681dcdd9041c" }

packages/typespec-java/emitter-tests/Generate.ps1

@@ -190,8 +190,6 @@ try {
   # generate for http-specs/azure-http-specs test sources
   Copy-Item -Path node_modules/@typespec/http-specs/specs -Destination ./ -Recurse -Force
   Copy-Item -Path node_modules/@azure-tools/azure-http-specs/specs -Destination ./ -Recurse -Force
-  # remove xml tests, emitter has not supported xml model
-  Remove-Item ./specs/payload/xml -Recurse -Force
 
   $specFiles = Get-ChildItem ./specs -Include "main.tsp","old.tsp" -File -Recurse
   # ensure multi-service client specs are processed even though they do not match the default filter

packages/typespec-java/emitter-tests/src/test/java/payload/xml/XmlTests.java

@@ -0,0 +1,359 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+package payload.xml;
+
+import com.azure.core.exception.HttpResponseException;
+import java.time.OffsetDateTime;
+import java.time.ZoneOffset;
+import java.util.Collections;
+import java.util.List;
+import java.util.Map;
+import org.junit.jupiter.api.Assertions;
+import org.junit.jupiter.api.Disabled;
+import org.junit.jupiter.api.Test;
+import payload.xml.models.Author;
+import payload.xml.models.Book;
+import payload.xml.models.ModelWithArrayOfModel;
+import payload.xml.models.ModelWithAttributes;
+import payload.xml.models.ModelWithDatetime;
+import payload.xml.models.ModelWithDictionary;
+import payload.xml.models.ModelWithEmptyArray;
+import payload.xml.models.ModelWithEncodedNames;
+import payload.xml.models.ModelWithEnum;
+import payload.xml.models.ModelWithNamespace;
+import payload.xml.models.ModelWithNamespaceOnProperties;
+import payload.xml.models.ModelWithNestedModel;
+import payload.xml.models.ModelWithOptionalField;
+import payload.xml.models.ModelWithRenamedArrays;
+import payload.xml.models.ModelWithRenamedAttribute;
+import payload.xml.models.ModelWithRenamedFields;
+import payload.xml.models.ModelWithRenamedNestedModel;
+import payload.xml.models.ModelWithRenamedProperty;
+import payload.xml.models.ModelWithRenamedUnwrappedModelArray;
+import payload.xml.models.ModelWithRenamedWrappedAndItemModelArray;
+import payload.xml.models.ModelWithRenamedWrappedModelArray;
+import payload.xml.models.ModelWithSimpleArrays;
+import payload.xml.models.ModelWithText;
+import payload.xml.models.ModelWithUnwrappedArray;
+import payload.xml.models.ModelWithUnwrappedModelArray;
+import payload.xml.models.ModelWithWrappedPrimitiveCustomItemNames;
+import payload.xml.models.SimpleModel;
+import payload.xml.models.Status;
+
+public final class XmlTests {
+
+    @Test
+    public void testSimpleModel() {
+        SimpleModelValueClient client = new XmlClientBuilder().buildSimpleModelValueClient();
+
+        client.put(new SimpleModel("foo", 123));
+
+        SimpleModel model = client.get();
+        Assertions.assertEquals("foo", model.getName());
+        Assertions.assertEquals(123, model.getAge());
+    }
+
+    @Test
+    public void testModelWithSimpleArrays() {
+        ModelWithSimpleArraysValueClient client = new XmlClientBuilder().buildModelWithSimpleArraysValueClient();
+
+        client.put(new ModelWithSimpleArrays(List.of("red", "green", "blue"), List.of(1, 2)));
+
+        ModelWithSimpleArrays model = client.get();
+        Assertions.assertEquals(List.of("red", "green", "blue"), model.getColors());
+        Assertions.assertEquals(List.of(1, 2), model.getCounts());
+    }
+
+    @Test
+    public void testModelWithArrayOfModel() {
+        ModelWithArrayOfModelValueClient client = new XmlClientBuilder().buildModelWithArrayOfModelValueClient();
+
+        client.put(new ModelWithArrayOfModel(List.of(new SimpleModel("foo", 123), new SimpleModel("bar", 456))));
+
+        ModelWithArrayOfModel model = client.get();
+        Assertions.assertEquals(2, model.getItems().size());
+        Assertions.assertEquals("foo", model.getItems().get(0).getName());
+        Assertions.assertEquals(123, model.getItems().get(0).getAge());
+        Assertions.assertEquals("bar", model.getItems().get(1).getName());
+        Assertions.assertEquals(456, model.getItems().get(1).getAge());
+    }
+
+    @Test
+    public void testModelWithOptionalField() {
+        ModelWithOptionalFieldValueClient client = new XmlClientBuilder().buildModelWithOptionalFieldValueClient();
+
+        client.put(new ModelWithOptionalField("widget"));
+
+        ModelWithOptionalField model = client.get();
+        Assertions.assertEquals("widget", model.getItem());
+    }
+
+    @Test
+    public void testModelWithAttributes() {
+        ModelWithAttributesValueClient client = new XmlClientBuilder().buildModelWithAttributesValueClient();
+
+        client.put(new ModelWithAttributes(123, "foo", true));
+
+        ModelWithAttributes model = client.get();
+        Assertions.assertEquals(123, model.getId1());
+        Assertions.assertEquals("foo", model.getId2());
+        Assertions.assertEquals(true, model.isEnabled());
+    }
+
+    @Test
+    public void testModelWithUnwrappedArray() {
+        ModelWithUnwrappedArrayValueClient client = new XmlClientBuilder().buildModelWithUnwrappedArrayValueClient();
+
+        client.put(new ModelWithUnwrappedArray(List.of("red", "green", "blue"), List.of(1, 2)));
+
+        ModelWithUnwrappedArray model = client.get();
+        Assertions.assertEquals(List.of("red", "green", "blue"), model.getColors());
+        Assertions.assertEquals(List.of(1, 2), model.getCounts());
+    }
+
+    @Test
+    public void testModelWithRenamedArrays() {
+        ModelWithRenamedArraysValueClient client = new XmlClientBuilder().buildModelWithRenamedArraysValueClient();
+
+        client.put(new ModelWithRenamedArrays(List.of("red", "green", "blue"), List.of(1, 2)));
+
+        ModelWithRenamedArrays model = client.get();
+        Assertions.assertEquals(List.of("red", "green", "blue"), model.getColors());
+        Assertions.assertEquals(List.of(1, 2), model.getCounts());
+    }
+
+    @Test
+    public void testModelWithRenamedFields() {
+        ModelWithRenamedFieldsValueClient client = new XmlClientBuilder().buildModelWithRenamedFieldsValueClient();
+
+        client.put(new ModelWithRenamedFields(new SimpleModel("foo", 123), new SimpleModel("bar", 456)));
+
+        ModelWithRenamedFields model = client.get();
+        Assertions.assertEquals("foo", model.getInputData().getName());
+        Assertions.assertEquals(123, model.getInputData().getAge());
+        Assertions.assertEquals("bar", model.getOutputData().getName());
+        Assertions.assertEquals(456, model.getOutputData().getAge());
+    }
+
+    @Test
+    public void testModelWithEmptyArray() {
+        ModelWithEmptyArrayValueClient client = new XmlClientBuilder().buildModelWithEmptyArrayValueClient();
+
+        client.put(new ModelWithEmptyArray(Collections.emptyList()));
+
+        ModelWithEmptyArray model = client.get();
+        Assertions.assertTrue(model.getItems() == null || model.getItems().isEmpty());
+    }
+
+    @Test
+    public void testModelWithText() {
+        ModelWithTextValueClient client = new XmlClientBuilder().buildModelWithTextValueClient();
+
+        client.put(new ModelWithText("foo", "\n  This is some text.\n"));
+
+        ModelWithText model = client.get();
+        Assertions.assertEquals("foo", model.getLanguage());
+        Assertions.assertEquals("\n  This is some text.\n", model.getContent());
+    }
+
+    @Test
+    public void testModelWithDictionary() {
+        ModelWithDictionaryValueClient client = new XmlClientBuilder().buildModelWithDictionaryValueClient();
+
+        client.put(new ModelWithDictionary(Map.of("Color", "blue", "Count", "123", "Enabled", "false")));
+
+        ModelWithDictionary model = client.get();
+        Assertions.assertEquals("blue", model.getMetadata().get("Color"));
+        Assertions.assertEquals("123", model.getMetadata().get("Count"));
+        Assertions.assertEquals("false", model.getMetadata().get("Enabled"));
+    }
+
+    @Test
+    public void testModelWithEncodedNames() {
+        ModelWithEncodedNamesValueClient client = new XmlClientBuilder().buildModelWithEncodedNamesValueClient();
+
+        client.put(new ModelWithEncodedNames(new SimpleModel("foo", 123), List.of("red", "green", "blue")));
+
+        ModelWithEncodedNames model = client.get();
+        Assertions.assertEquals("foo", model.getModelData().getName());
+        Assertions.assertEquals(123, model.getModelData().getAge());
+        Assertions.assertEquals(List.of("red", "green", "blue"), model.getColors());
+    }
+
+    @Test
+    public void testModelWithEnum() {
+        ModelWithEnumValueClient client = new XmlClientBuilder().buildModelWithEnumValueClient();
+
+        client.put(new ModelWithEnum(Status.SUCCESS));
+
+        ModelWithEnum model = client.get();
+        Assertions.assertEquals(Status.SUCCESS, model.getStatus());
+    }
+
+    @Test
+    public void testModelWithDatetime() {
+        ModelWithDatetimeValueClient client = new XmlClientBuilder().buildModelWithDatetimeValueClient();
+
+        OffsetDateTime rfc3339 = OffsetDateTime.of(2022, 8, 26, 18, 38, 0, 0, ZoneOffset.UTC);
+        OffsetDateTime rfc7231 = OffsetDateTime.of(2022, 8, 26, 14, 38, 0, 0, ZoneOffset.UTC);
+
+        client.put(new ModelWithDatetime(rfc3339, rfc7231));
+
+        ModelWithDatetime model = client.get();
+        Assertions.assertEquals(rfc3339, model.getRfc3339());
+        Assertions.assertEquals(rfc7231, model.getRfc7231());
+    }
+
+    @Test
+    public void testXmlErrorValue() {
+        XmlErrorValueClient client = new XmlClientBuilder().buildXmlErrorValueClient();
+
+        HttpResponseException exception = Assertions.assertThrows(HttpResponseException.class, client::get);
+        Assertions.assertEquals(400, exception.getResponse().getStatusCode());
+    }
+
+    @Test
+    public void testModelWithRenamedProperty() {
+        ModelWithRenamedPropertyValueClient client = new XmlClientBuilder().buildModelWithRenamedPropertyValueClient();
+
+        client.put(new ModelWithRenamedProperty("foo", "bar"));
+
+        ModelWithRenamedProperty model = client.get();
+        Assertions.assertEquals("foo", model.getTitle());
+        Assertions.assertEquals("bar", model.getAuthor());
+    }
+
+    @Test
+    public void testModelWithNestedModel() {
+        ModelWithNestedModelValueClient client = new XmlClientBuilder().buildModelWithNestedModelValueClient();
+
+        client.put(new ModelWithNestedModel(new SimpleModel("foo", 123)));
+
+        ModelWithNestedModel model = client.get();
+        Assertions.assertEquals("foo", model.getNested().getName());
+        Assertions.assertEquals(123, model.getNested().getAge());
+    }
+
+    @Test
+    public void testModelWithRenamedNestedModel() {
+        ModelWithRenamedNestedModelValueClient client
+            = new XmlClientBuilder().buildModelWithRenamedNestedModelValueClient();
+
+        client.put(new ModelWithRenamedNestedModel(new Author("foo")));
+
+        ModelWithRenamedNestedModel model = client.get();
+        Assertions.assertEquals("foo", model.getAuthor().getName());
+    }
+
+    @Test
+    public void testModelWithWrappedPrimitiveCustomItemNames() {
+        ModelWithWrappedPrimitiveCustomItemNamesValueClient client
+            = new XmlClientBuilder().buildModelWithWrappedPrimitiveCustomItemNamesValueClient();
+
+        client.put(new ModelWithWrappedPrimitiveCustomItemNames(List.of("fiction", "classic")));
+
+        ModelWithWrappedPrimitiveCustomItemNames model = client.get();
+        Assertions.assertEquals(List.of("fiction", "classic"), model.getTags());
+    }
+
+    @Test
+    public void testModelWithUnwrappedModelArray() {
+        ModelWithUnwrappedModelArrayValueClient client
+            = new XmlClientBuilder().buildModelWithUnwrappedModelArrayValueClient();
+
+        client.put(new ModelWithUnwrappedModelArray(List.of(new SimpleModel("foo", 123), new SimpleModel("bar", 456))));
+
+        ModelWithUnwrappedModelArray model = client.get();
+        Assertions.assertEquals(2, model.getItems().size());
+        Assertions.assertEquals("foo", model.getItems().get(0).getName());
+        Assertions.assertEquals(123, model.getItems().get(0).getAge());
+        Assertions.assertEquals("bar", model.getItems().get(1).getName());
+        Assertions.assertEquals(456, model.getItems().get(1).getAge());
+    }
+
+    @Test
+    public void testModelWithRenamedWrappedModelArray() {
+        ModelWithRenamedWrappedModelArrayValueClient client
+            = new XmlClientBuilder().buildModelWithRenamedWrappedModelArrayValueClient();
+
+        client.put(
+            new ModelWithRenamedWrappedModelArray(List.of(new SimpleModel("foo", 123), new SimpleModel("bar", 456))));
+
+        ModelWithRenamedWrappedModelArray model = client.get();
+        Assertions.assertEquals(2, model.getItems().size());
+        Assertions.assertEquals("foo", model.getItems().get(0).getName());
+        Assertions.assertEquals(123, model.getItems().get(0).getAge());
+        Assertions.assertEquals("bar", model.getItems().get(1).getName());
+        Assertions.assertEquals(456, model.getItems().get(1).getAge());
+    }
+
+    @Test
+    public void testModelWithRenamedUnwrappedModelArray() {
+        ModelWithRenamedUnwrappedModelArrayValueClient client
+            = new XmlClientBuilder().buildModelWithRenamedUnwrappedModelArrayValueClient();
+
+        client.put(
+            new ModelWithRenamedUnwrappedModelArray(List.of(new SimpleModel("foo", 123), new SimpleModel("bar", 456))));
+
+        ModelWithRenamedUnwrappedModelArray model = client.get();
+        Assertions.assertEquals(2, model.getItems().size());
+        Assertions.assertEquals("foo", model.getItems().get(0).getName());
+        Assertions.assertEquals(123, model.getItems().get(0).getAge());
+        Assertions.assertEquals("bar", model.getItems().get(1).getName());
+        Assertions.assertEquals(456, model.getItems().get(1).getAge());
+    }
+
+    @Test
+    public void testModelWithRenamedWrappedAndItemModelArray() {
+        ModelWithRenamedWrappedAndItemModelArrayValueClient client
+            = new XmlClientBuilder().buildModelWithRenamedWrappedAndItemModelArrayValueClient();
+
+        client.put(new ModelWithRenamedWrappedAndItemModelArray(
+            List.of(new Book("The Great Gatsby"), new Book("Les Miserables"))));
+
+        ModelWithRenamedWrappedAndItemModelArray model = client.get();
+        Assertions.assertEquals(2, model.getBooks().size());
+        Assertions.assertEquals("The Great Gatsby", model.getBooks().get(0).getTitle());
+        Assertions.assertEquals("Les Miserables", model.getBooks().get(1).getTitle());
+    }
+
+    @Test
+    public void testModelWithRenamedAttribute() {
+        ModelWithRenamedAttributeValueClient client
+            = new XmlClientBuilder().buildModelWithRenamedAttributeValueClient();
+
+        client.put(new ModelWithRenamedAttribute(123, "The Great Gatsby", "F. Scott Fitzgerald"));
+
+        ModelWithRenamedAttribute model = client.get();
+        Assertions.assertEquals(123, model.getId());
+        Assertions.assertEquals("The Great Gatsby", model.getTitle());
+        Assertions.assertEquals("F. Scott Fitzgerald", model.getAuthor());
+    }
+
+    @Disabled("namespace mismatch")
+    @Test
+    public void testModelWithNamespace() {
+        ModelWithNamespaceValueClient client = new XmlClientBuilder().buildModelWithNamespaceValueClient();
+
+        client.put(new ModelWithNamespace(123, "The Great Gatsby"));
+
+        ModelWithNamespace model = client.get();
+        Assertions.assertEquals(123, model.getId());
+        Assertions.assertEquals("The Great Gatsby", model.getTitle());
+    }
+
+    @Disabled("namespace mismatch")
+    @Test
+    public void testModelWithNamespaceOnProperties() {
+        ModelWithNamespaceOnPropertiesValueClient client
+            = new XmlClientBuilder().buildModelWithNamespaceOnPropertiesValueClient();
+
+        client.put(new ModelWithNamespaceOnProperties(123, "The Great Gatsby", "F. Scott Fitzgerald"));
+
+        ModelWithNamespaceOnProperties model = client.get();
+        Assertions.assertEquals(123, model.getId());
+        Assertions.assertEquals("The Great Gatsby", model.getTitle());
+        Assertions.assertEquals("F. Scott Fitzgerald", model.getAuthor());
+    }
+}