509 lines
21 KiB
C#
509 lines
21 KiB
C#
// Copyright (c) Microsoft Open Technologies, Inc. All rights reserved.
|
|
// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
|
|
|
|
using System;
|
|
using System.IO;
|
|
using System.Linq;
|
|
using System.Runtime.Serialization;
|
|
using System.Text;
|
|
using System.Threading.Tasks;
|
|
using System.Xml;
|
|
using Microsoft.AspNet.Http;
|
|
using Microsoft.AspNet.Mvc.ModelBinding;
|
|
using Microsoft.AspNet.Mvc.Xml;
|
|
using Microsoft.AspNet.Testing;
|
|
using Moq;
|
|
using Xunit;
|
|
|
|
namespace Microsoft.AspNet.Mvc
|
|
{
|
|
public class XmlDataContractSerializerInputFormatterTest
|
|
{
|
|
[DataContract(Name = "DummyClass", Namespace = "")]
|
|
public class DummyClass
|
|
{
|
|
[DataMember]
|
|
public int SampleInt { get; set; }
|
|
}
|
|
|
|
[DataContract(Name = "SomeDummyClass", Namespace = "")]
|
|
public class SomeDummyClass : DummyClass
|
|
{
|
|
[DataMember]
|
|
public string SampleString { get; set; }
|
|
}
|
|
|
|
[DataContract(Name = "TestLevelOne", Namespace = "")]
|
|
public class TestLevelOne
|
|
{
|
|
[DataMember]
|
|
public int SampleInt { get; set; }
|
|
[DataMember]
|
|
public string sampleString;
|
|
public DateTime SampleDate { get; set; }
|
|
}
|
|
|
|
[DataContract(Name = "TestLevelTwo", Namespace = "")]
|
|
public class TestLevelTwo
|
|
{
|
|
[DataMember]
|
|
public string SampleString { get; set; }
|
|
[DataMember]
|
|
public TestLevelOne TestOne { get; set; }
|
|
}
|
|
|
|
[Theory]
|
|
[InlineData("application/xml", true)]
|
|
[InlineData("application/*", true)]
|
|
[InlineData("*/*", true)]
|
|
[InlineData("text/xml", true)]
|
|
[InlineData("text/*", true)]
|
|
[InlineData("text/json", false)]
|
|
[InlineData("application/json", false)]
|
|
[InlineData("", false)]
|
|
[InlineData(null, false)]
|
|
[InlineData("invalid", false)]
|
|
public void CanRead_ReturnsTrueForAnySupportedContentType(string requestContentType, bool expectedCanRead)
|
|
{
|
|
// Arrange
|
|
var formatter = new XmlDataContractSerializerInputFormatter();
|
|
var contentBytes = Encoding.UTF8.GetBytes("content");
|
|
|
|
var actionContext = GetActionContext(contentBytes, contentType: requestContentType);
|
|
var formatterContext = new InputFormatterContext(actionContext, typeof(string));
|
|
|
|
// Act
|
|
var result = formatter.CanRead(formatterContext);
|
|
|
|
// Assert
|
|
Assert.Equal(expectedCanRead, result);
|
|
}
|
|
|
|
[Fact]
|
|
public void HasProperSuppportedMediaTypes()
|
|
{
|
|
// Arrange & Act
|
|
var formatter = new XmlDataContractSerializerInputFormatter();
|
|
|
|
// Assert
|
|
Assert.True(formatter.SupportedMediaTypes
|
|
.Select(content => content.ToString())
|
|
.Contains("application/xml"));
|
|
Assert.True(formatter.SupportedMediaTypes
|
|
.Select(content => content.ToString())
|
|
.Contains("text/xml"));
|
|
}
|
|
|
|
[Fact]
|
|
public void HasProperSuppportedEncodings()
|
|
{
|
|
// Arrange & Act
|
|
var formatter = new XmlDataContractSerializerInputFormatter();
|
|
|
|
// Assert
|
|
Assert.True(formatter.SupportedEncodings.Any(i => i.WebName == "utf-8"));
|
|
Assert.True(formatter.SupportedEncodings.Any(i => i.WebName == "utf-16"));
|
|
}
|
|
|
|
[Fact]
|
|
public async Task ReadAsync_ReadsSimpleTypes()
|
|
{
|
|
// Arrange
|
|
var expectedInt = 10;
|
|
var expectedString = "TestString";
|
|
|
|
var input = "<?xml version=\"1.0\" encoding=\"UTF-8\"?>" +
|
|
"<TestLevelOne><SampleInt>" + expectedInt + "</SampleInt>" +
|
|
"<sampleString>" + expectedString + "</sampleString></TestLevelOne>";
|
|
|
|
var formatter = new XmlDataContractSerializerInputFormatter();
|
|
var contentBytes = Encoding.UTF8.GetBytes(input);
|
|
var context = GetInputFormatterContext(contentBytes, typeof(TestLevelOne));
|
|
|
|
// Act
|
|
var model = await formatter.ReadAsync(context);
|
|
|
|
// Assert
|
|
Assert.NotNull(model);
|
|
Assert.IsType<TestLevelOne>(model);
|
|
|
|
var levelOneModel = model as TestLevelOne;
|
|
Assert.Equal(expectedInt, levelOneModel.SampleInt);
|
|
Assert.Equal(expectedString, levelOneModel.sampleString);
|
|
}
|
|
|
|
[Fact]
|
|
public async Task ReadAsync_ReadsComplexTypes()
|
|
{
|
|
// Arrange
|
|
var expectedInt = 10;
|
|
var expectedString = "TestString";
|
|
var expectedLevelTwoString = "102";
|
|
|
|
var input = "<?xml version=\"1.0\" encoding=\"UTF-8\"?>" +
|
|
"<TestLevelTwo><SampleString>" + expectedLevelTwoString + "</SampleString>" +
|
|
"<TestOne><SampleInt>" + expectedInt + "</SampleInt>" +
|
|
"<sampleString>" + expectedString + "</sampleString></TestOne></TestLevelTwo>";
|
|
|
|
var formatter = new XmlDataContractSerializerInputFormatter();
|
|
var contentBytes = Encoding.UTF8.GetBytes(input);
|
|
var context = GetInputFormatterContext(contentBytes, typeof(TestLevelTwo));
|
|
|
|
// Act
|
|
var model = await formatter.ReadAsync(context);
|
|
|
|
// Assert
|
|
Assert.NotNull(model);
|
|
Assert.IsType<TestLevelTwo>(model);
|
|
|
|
var levelTwoModel = model as TestLevelTwo;
|
|
Assert.Equal(expectedLevelTwoString, levelTwoModel.SampleString);
|
|
Assert.Equal(expectedInt, levelTwoModel.TestOne.SampleInt);
|
|
Assert.Equal(expectedString, levelTwoModel.TestOne.sampleString);
|
|
}
|
|
|
|
[Fact]
|
|
public async Task ReadAsync_ReadsWhenMaxDepthIsModified()
|
|
{
|
|
// Arrange
|
|
var expectedInt = 10;
|
|
|
|
var input = "<?xml version=\"1.0\" encoding=\"UTF-8\"?>" +
|
|
"<DummyClass><SampleInt>" + expectedInt + "</SampleInt></DummyClass>";
|
|
var formatter = new XmlDataContractSerializerInputFormatter();
|
|
formatter.MaxDepth = 10;
|
|
var contentBytes = Encoding.UTF8.GetBytes(input);
|
|
var context = GetInputFormatterContext(contentBytes, typeof(DummyClass));
|
|
|
|
|
|
// Act
|
|
var model = await formatter.ReadAsync(context);
|
|
|
|
// Assert
|
|
Assert.NotNull(model);
|
|
Assert.IsType<DummyClass>(model);
|
|
var dummyModel = model as DummyClass;
|
|
Assert.Equal(expectedInt, dummyModel.SampleInt);
|
|
}
|
|
|
|
[Fact]
|
|
public async Task ReadAsync_ThrowsOnExceededMaxDepth()
|
|
{
|
|
if (TestPlatformHelper.IsMono)
|
|
{
|
|
// ReaderQuotas are not honored on Mono
|
|
return;
|
|
}
|
|
|
|
// Arrange
|
|
var input = "<?xml version=\"1.0\" encoding=\"UTF-8\"?>" +
|
|
"<TestLevelTwo><SampleString>test</SampleString>" +
|
|
"<TestOne><SampleInt>10</SampleInt>" +
|
|
"<sampleString>test</sampleString></TestOne></TestLevelTwo>";
|
|
var formatter = new XmlDataContractSerializerInputFormatter();
|
|
formatter.MaxDepth = 1;
|
|
var contentBytes = Encoding.UTF8.GetBytes(input);
|
|
var context = GetInputFormatterContext(contentBytes, typeof(TestLevelTwo));
|
|
|
|
// Act & Assert
|
|
await Assert.ThrowsAsync(typeof(SerializationException), async () => await formatter.ReadAsync(context));
|
|
}
|
|
|
|
[Fact]
|
|
public async Task ReadAsync_ThrowsWhenReaderQuotasAreChanged()
|
|
{
|
|
if (TestPlatformHelper.IsMono)
|
|
{
|
|
// ReaderQuotas are not honored on Mono
|
|
return;
|
|
}
|
|
|
|
// Arrange
|
|
var input = "<?xml version=\"1.0\" encoding=\"UTF-8\"?>" +
|
|
"<TestLevelTwo><SampleString>test</SampleString>" +
|
|
"<TestOne><SampleInt>10</SampleInt>" +
|
|
"<sampleString>test</sampleString></TestOne></TestLevelTwo>";
|
|
var formatter = new XmlDataContractSerializerInputFormatter();
|
|
formatter.XmlDictionaryReaderQuotas.MaxStringContentLength = 2;
|
|
var contentBytes = Encoding.UTF8.GetBytes(input);
|
|
var context = GetInputFormatterContext(contentBytes, typeof(TestLevelTwo));
|
|
|
|
// Act & Assert
|
|
await Assert.ThrowsAsync(typeof(SerializationException), async () => await formatter.ReadAsync(context));
|
|
}
|
|
|
|
[Fact]
|
|
public void SetMaxDepth_ThrowsWhenMaxDepthIsBelowOne()
|
|
{
|
|
// Arrange
|
|
var formatter = new XmlDataContractSerializerInputFormatter();
|
|
|
|
// Act & Assert
|
|
Assert.Throws(typeof(ArgumentException), () => formatter.MaxDepth = 0);
|
|
}
|
|
|
|
[Fact]
|
|
public async Task ReadAsync_VerifyStreamIsOpenAfterRead()
|
|
{
|
|
// Arrange
|
|
var input = "<?xml version=\"1.0\" encoding=\"UTF-8\"?>" +
|
|
"<DummyClass><SampleInt>10</SampleInt></DummyClass>";
|
|
var formatter = new XmlDataContractSerializerInputFormatter();
|
|
var contentBytes = Encoding.UTF8.GetBytes(input);
|
|
var context = GetInputFormatterContext(contentBytes, typeof(DummyClass));
|
|
|
|
// Act
|
|
var model = await formatter.ReadAsync(context);
|
|
|
|
// Assert
|
|
Assert.NotNull(model);
|
|
Assert.True(context.ActionContext.HttpContext.Request.Body.CanRead);
|
|
}
|
|
|
|
[Fact]
|
|
public async Task ReadAsync_ThrowsOnInvalidCharacters()
|
|
{
|
|
// Arrange
|
|
var expectedException = TestPlatformHelper.IsMono ? typeof(SerializationException) :
|
|
typeof(XmlException);
|
|
var expectedMessage = TestPlatformHelper.IsMono ?
|
|
"Expected element 'TestLevelTwo' in namespace '', but found Element node 'DummyClass' in namespace ''" :
|
|
"The encoding in the declaration 'UTF-8' does not match the encoding of the document 'utf-16LE'.";
|
|
var inpStart = Encodings.UTF16EncodingLittleEndian.GetBytes("<?xml version=\"1.0\" encoding=\"UTF-8\"?>" +
|
|
"<DummyClass><SampleInt>");
|
|
byte[] inp = { 192, 193 };
|
|
var inpEnd = Encodings.UTF16EncodingLittleEndian.GetBytes("</SampleInt></DummyClass>");
|
|
|
|
var contentBytes = new byte[inpStart.Length + inp.Length + inpEnd.Length];
|
|
Buffer.BlockCopy(inpStart, 0, contentBytes, 0, inpStart.Length);
|
|
Buffer.BlockCopy(inp, 0, contentBytes, inpStart.Length, inp.Length);
|
|
Buffer.BlockCopy(inpEnd, 0, contentBytes, inpStart.Length + inp.Length, inpEnd.Length);
|
|
|
|
var formatter = new XmlDataContractSerializerInputFormatter();
|
|
var context = GetInputFormatterContext(contentBytes, typeof(TestLevelTwo));
|
|
|
|
// Act
|
|
var ex = await Assert.ThrowsAsync(expectedException, () => formatter.ReadAsync(context));
|
|
Assert.Equal(expectedMessage, ex.Message);
|
|
}
|
|
|
|
[Fact]
|
|
public async Task ReadAsync_IgnoresBOMCharacters()
|
|
{
|
|
// Arrange
|
|
var sampleString = "Test";
|
|
var sampleStringBytes = Encoding.UTF8.GetBytes(sampleString);
|
|
var inputStart = Encoding.UTF8.GetBytes("<?xml version=\"1.0\" encoding=\"UTF-8\"?>" + Environment.NewLine +
|
|
"<TestLevelTwo><SampleString>" + sampleString);
|
|
byte[] bom = { 0xef, 0xbb, 0xbf };
|
|
var inputEnd = Encoding.UTF8.GetBytes("</SampleString></TestLevelTwo>");
|
|
var expectedBytes = new byte[sampleString.Length + bom.Length];
|
|
|
|
var contentBytes = new byte[inputStart.Length + bom.Length + inputEnd.Length];
|
|
Buffer.BlockCopy(inputStart, 0, contentBytes, 0, inputStart.Length);
|
|
Buffer.BlockCopy(bom, 0, contentBytes, inputStart.Length, bom.Length);
|
|
Buffer.BlockCopy(inputEnd, 0, contentBytes, inputStart.Length + bom.Length, inputEnd.Length);
|
|
|
|
var formatter = new XmlDataContractSerializerInputFormatter();
|
|
var context = GetInputFormatterContext(contentBytes, typeof(TestLevelTwo));
|
|
|
|
// Act
|
|
var model = await formatter.ReadAsync(context);
|
|
|
|
// Assert
|
|
Assert.NotNull(model);
|
|
var levelTwoModel = model as TestLevelTwo;
|
|
Buffer.BlockCopy(sampleStringBytes, 0, expectedBytes, 0, sampleStringBytes.Length);
|
|
Buffer.BlockCopy(bom, 0, expectedBytes, sampleStringBytes.Length, bom.Length);
|
|
Assert.Equal(expectedBytes, Encoding.UTF8.GetBytes(levelTwoModel.SampleString));
|
|
}
|
|
|
|
[Fact]
|
|
public async Task ReadAsync_AcceptsUTF16Characters()
|
|
{
|
|
// Arrange
|
|
var expectedInt = 10;
|
|
var expectedString = "TestString";
|
|
|
|
var input = "<?xml version=\"1.0\" encoding=\"UTF-16\"?>" +
|
|
"<TestLevelOne><SampleInt>" + expectedInt + "</SampleInt>" +
|
|
"<sampleString>" + expectedString + "</sampleString></TestLevelOne>";
|
|
|
|
var formatter = new XmlDataContractSerializerInputFormatter();
|
|
var contentBytes = Encodings.UTF16EncodingLittleEndian.GetBytes(input);
|
|
var context = GetInputFormatterContext(contentBytes, typeof(TestLevelOne));
|
|
|
|
// Act
|
|
var model = await formatter.ReadAsync(context);
|
|
|
|
// Assert
|
|
Assert.NotNull(model);
|
|
Assert.IsType<TestLevelOne>(model);
|
|
|
|
var levelOneModel = model as TestLevelOne;
|
|
Assert.Equal(expectedInt, levelOneModel.SampleInt);
|
|
Assert.Equal(expectedString, levelOneModel.sampleString);
|
|
}
|
|
|
|
[Fact]
|
|
public async Task ReadAsync_ReadsSerializableErrorXml()
|
|
{
|
|
// Arrange
|
|
var serializableErrorXml = "<?xml version=\"1.0\" encoding=\"utf-8\"?>" +
|
|
"<Error><key1>Test Error 1 Test Error 2</key1><key2>Test Error 3</key2></Error>";
|
|
var formatter = new XmlDataContractSerializerInputFormatter();
|
|
var contentBytes = Encodings.UTF8EncodingWithoutBOM.GetBytes(serializableErrorXml);
|
|
var context = GetInputFormatterContext(contentBytes, typeof(SerializableError));
|
|
|
|
// Act
|
|
var model = await formatter.ReadAsync(context);
|
|
|
|
// Assert
|
|
var serializableError = model as SerializableError;
|
|
Assert.NotNull(serializableError);
|
|
Assert.Equal("Test Error 1 Test Error 2", serializableError["key1"]);
|
|
Assert.Equal("Test Error 3", serializableError["key2"]);
|
|
}
|
|
|
|
[Fact]
|
|
public async Task ReadAsync_ThrowsWhenNotConfiguredWithRootName()
|
|
{
|
|
// Arrange
|
|
var SubstituteRootName = "SomeOtherClass";
|
|
var SubstituteRootNamespace = "http://tempuri.org";
|
|
|
|
var input = string.Format(
|
|
"<{0} xmlns=\"{1}\"><SampleInt xmlns=\"\">1</SampleInt></{0}>",
|
|
SubstituteRootName,
|
|
SubstituteRootNamespace);
|
|
var formatter = new XmlDataContractSerializerInputFormatter();
|
|
var contentBytes = Encoding.UTF8.GetBytes(input);
|
|
var context = GetInputFormatterContext(contentBytes, typeof(DummyClass));
|
|
|
|
// Act & Assert
|
|
await Assert.ThrowsAsync(typeof(SerializationException), async () => await formatter.ReadAsync(context));
|
|
}
|
|
|
|
[Fact]
|
|
public async Task ReadAsync_ReadsWhenConfiguredWithRootName()
|
|
{
|
|
// Arrange
|
|
var expectedInt = 10;
|
|
var SubstituteRootName = "SomeOtherClass";
|
|
var SubstituteRootNamespace = "http://tempuri.org";
|
|
|
|
var input = string.Format(
|
|
"<{0} xmlns=\"{1}\"><SampleInt xmlns=\"\">{2}</SampleInt></{0}>",
|
|
SubstituteRootName,
|
|
SubstituteRootNamespace,
|
|
expectedInt);
|
|
|
|
var dictionary = new XmlDictionary();
|
|
var settings = new DataContractSerializerSettings
|
|
{
|
|
RootName = dictionary.Add(SubstituteRootName),
|
|
RootNamespace = dictionary.Add(SubstituteRootNamespace)
|
|
};
|
|
var formatter = new XmlDataContractSerializerInputFormatter
|
|
{
|
|
SerializerSettings = settings
|
|
};
|
|
var contentBytes = Encoding.UTF8.GetBytes(input);
|
|
var context = GetInputFormatterContext(contentBytes, typeof(DummyClass));
|
|
|
|
// Act
|
|
var model = await formatter.ReadAsync(context);
|
|
|
|
// Assert
|
|
Assert.NotNull(model);
|
|
var dummyModel = Assert.IsType<DummyClass>(model);
|
|
Assert.Equal(expectedInt, dummyModel.SampleInt);
|
|
}
|
|
|
|
[Fact]
|
|
public async Task ReadAsync_ThrowsWhenNotConfiguredWithKnownTypes()
|
|
{
|
|
// Arrange
|
|
var KnownTypeName = "SomeDummyClass";
|
|
var InstanceNamespace = "http://www.w3.org/2001/XMLSchema-instance";
|
|
|
|
var input = string.Format(
|
|
"<DummyClass i:type=\"{0}\" xmlns:i=\"{1}\"><SampleInt>1</SampleInt>"
|
|
+ "<SampleString>Some text</SampleString></DummyClass>",
|
|
KnownTypeName,
|
|
InstanceNamespace);
|
|
var formatter = new XmlDataContractSerializerInputFormatter();
|
|
var contentBytes = Encoding.UTF8.GetBytes(input);
|
|
var context = GetInputFormatterContext(contentBytes, typeof(DummyClass));
|
|
|
|
// Act & Assert
|
|
await Assert.ThrowsAsync(typeof(SerializationException), async () => await formatter.ReadAsync(context));
|
|
}
|
|
|
|
[Fact]
|
|
public async Task ReadAsync_ReadsWhenConfiguredWithKnownTypes()
|
|
{
|
|
// Arrange
|
|
var expectedInt = 10;
|
|
var expectedString = "TestString";
|
|
var KnownTypeName = "SomeDummyClass";
|
|
var InstanceNamespace = "http://www.w3.org/2001/XMLSchema-instance";
|
|
|
|
var input = string.Format(
|
|
"<DummyClass i:type=\"{0}\" xmlns:i=\"{1}\"><SampleInt>{2}</SampleInt>"
|
|
+ "<SampleString>{3}</SampleString></DummyClass>",
|
|
KnownTypeName,
|
|
InstanceNamespace,
|
|
expectedInt,
|
|
expectedString);
|
|
var settings = new DataContractSerializerSettings
|
|
{
|
|
KnownTypes = new[] { typeof(SomeDummyClass) }
|
|
};
|
|
var formatter = new XmlDataContractSerializerInputFormatter
|
|
{
|
|
SerializerSettings = settings
|
|
};
|
|
var contentBytes = Encoding.UTF8.GetBytes(input);
|
|
var context = GetInputFormatterContext(contentBytes, typeof(DummyClass));
|
|
|
|
// Act
|
|
var model = await formatter.ReadAsync(context);
|
|
|
|
// Assert
|
|
Assert.NotNull(model);
|
|
var dummyModel = Assert.IsType<SomeDummyClass>(model);
|
|
Assert.Equal(expectedInt, dummyModel.SampleInt);
|
|
Assert.Equal(expectedString, dummyModel.SampleString);
|
|
}
|
|
|
|
private InputFormatterContext GetInputFormatterContext(byte[] contentBytes, Type modelType)
|
|
{
|
|
var actionContext = GetActionContext(contentBytes);
|
|
var metadata = new EmptyModelMetadataProvider().GetMetadataForType(null, modelType);
|
|
return new InputFormatterContext(actionContext, metadata.ModelType);
|
|
}
|
|
|
|
private static ActionContext GetActionContext(byte[] contentBytes,
|
|
string contentType = "application/xml")
|
|
{
|
|
return new ActionContext(GetHttpContext(contentBytes, contentType),
|
|
new AspNet.Routing.RouteData(),
|
|
new ActionDescriptor());
|
|
}
|
|
private static HttpContext GetHttpContext(byte[] contentBytes,
|
|
string contentType = "application/xml")
|
|
{
|
|
var request = new Mock<HttpRequest>();
|
|
var headers = new Mock<IHeaderDictionary>();
|
|
request.SetupGet(r => r.Headers).Returns(headers.Object);
|
|
request.SetupGet(f => f.Body).Returns(new MemoryStream(contentBytes));
|
|
request.SetupGet(f => f.ContentType).Returns(contentType);
|
|
|
|
var httpContext = new Mock<HttpContext>();
|
|
httpContext.SetupGet(c => c.Request).Returns(request.Object);
|
|
httpContext.SetupGet(c => c.Request).Returns(request.Object);
|
|
return httpContext.Object;
|
|
}
|
|
}
|
|
} |