Added support for TryValidateModel and its corresponding tests

This commit is contained in:
Kirthi Krishnamraju 2015-01-13 16:30:06 -08:00
parent 12565daf88
commit e41e5066f9
6 changed files with 324 additions and 1 deletions

View File

@ -1030,6 +1030,57 @@ namespace Microsoft.AspNet.Mvc
predicate);
}
/// <summary>
/// Validates the specified <paramref name="model"/> instance.
/// </summary>
/// <param name="model">The model to validate.</param>
/// <returns><c>true</c> if the <see cref="ModelState"/> is valid; <c>false</c> otherwise. </returns>
[NonAction]
public virtual bool TryValidateModel([NotNull] object model)
{
return TryValidateModel(model, prefix: null);
}
/// <summary>
/// Validates the specified <paramref name="model"/> instance.
/// </summary>
/// <param name="model">The model to validate.</param>
/// <param name="prefix">The key to use when looking up information in <see cref="ModelState"/>.
/// </param>
/// <returns><c>true</c> if the <see cref="ModelState"/> is valid;<c>false</c> otherwise. </returns>
[NonAction]
public virtual bool TryValidateModel([NotNull] object model, string prefix)
{
if (BindingContext == null)
{
var message = Resources.FormatPropertyOfTypeCannotBeNull(
nameof(BindingContext),
typeof(Controller).FullName);
throw new InvalidOperationException(message);
}
var modelMetadata = MetadataProvider.GetMetadataForType(
modelAccessor: () => model,
modelType: model.GetType());
var validationContext = new ModelValidationContext(
MetadataProvider,
BindingContext.ValidatorProvider,
ModelState,
modelMetadata,
containerMetadata: null);
var modelName = prefix ?? string.Empty;
var validationNode = new ModelValidationNode(modelMetadata, modelName)
{
ValidateAllProperties = true
};
validationNode.Validate(validationContext);
return ModelState.IsValid;
}
public void Dispose()
{
Dispose(disposing: true);
@ -1040,4 +1091,4 @@ namespace Microsoft.AspNet.Mvc
{
}
}
}
}

View File

@ -1237,6 +1237,101 @@ namespace Microsoft.AspNet.Mvc.Test
Assert.True(controller.DisposeCalled);
}
[Fact]
public void TryValidateModelWithValidModel_ReturnsTrue()
{
// Arrange
var binder = new Mock<IModelBinder>();
var controller = GetController(binder.Object, provider: null);
controller.BindingContext.ValidatorProvider = Mock.Of<IModelValidatorProvider>();
var model = new TryValidateModelModel();
// Act
var result = controller.TryValidateModel(model);
// Assert
Assert.True(result);
Assert.True(controller.ModelState.IsValid);
}
[Fact]
public void TryValidateModelWithInvalidModelWithPrefix_ReturnsFalse()
{
// Arrange
var model = new TryValidateModelModel();
var validationResult = new []
{
new ModelValidationResult(string.Empty, "Out of range!")
};
var validator1 = new Mock<IModelValidator>();
validator1.Setup(v => v.Validate(It.IsAny<ModelValidationContext>()))
.Returns(validationResult);
var provider = new Mock<IModelValidatorProvider>();
provider.Setup(v => v.GetValidators(It.IsAny<ModelMetadata>()))
.Returns(new[] { validator1.Object });
var binder = new Mock<IModelBinder>();
var controller = GetController(binder.Object, provider: null);
controller.BindingContext.ValidatorProvider = provider.Object;
// Act
var result = controller.TryValidateModel(model, "Prefix");
// Assert
Assert.False(result);
Assert.Equal(1, controller.ModelState.Count);
var error = Assert.Single(controller.ModelState["Prefix.IntegerProperty"].Errors);
Assert.Equal("Out of range!", error.ErrorMessage);
}
[Fact]
public void TryValidateModelWithInvalidModelNoPrefix_ReturnsFalse()
{
// Arrange
var model = new TryValidateModelModel();
var validationResult = new[]
{
new ModelValidationResult(string.Empty, "Out of range!")
};
var validator1 = new Mock<IModelValidator>();
validator1.Setup(v => v.Validate(It.IsAny<ModelValidationContext>()))
.Returns(validationResult);
var provider = new Mock<IModelValidatorProvider>();
provider.Setup(v => v.GetValidators(It.IsAny<ModelMetadata>()))
.Returns(new[] { validator1.Object });
var binder = new Mock<IModelBinder>();
var controller = GetController(binder.Object, provider: null);
controller.BindingContext.ValidatorProvider = provider.Object;
// Act
var result = controller.TryValidateModel(model);
// Assert
Assert.False(result);
Assert.Equal(1, controller.ModelState.Count);
var error = Assert.Single(controller.ModelState["IntegerProperty"].Errors);
Assert.Equal("Out of range!", error.ErrorMessage);
}
[Fact]
public void TryValidateModelEmptyBindingContextThrowsException()
{
// Arrange
var controller = new Controller();
var model = new TryValidateModelModel();
// Act & Assert
var exception = Assert.Throws<InvalidOperationException>(() => controller.TryValidateModel(model));
Assert.Equal("The 'BindingContext' property of 'Microsoft.AspNet.Mvc.Controller' must not be null.", exception.Message);
}
private static Controller GetController(IModelBinder binder, IValueProvider provider)
{
var metadataProvider = new DataAnnotationsModelMetadataProvider();
@ -1287,6 +1382,11 @@ namespace Microsoft.AspNet.Mvc.Test
public int Zip { get; set; }
}
private class TryValidateModelModel
{
public int IntegerProperty { get; set; }
}
private class DisposableController : Controller
{
public bool DisposeCalled { get; private set; }

View File

@ -0,0 +1,73 @@
// 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.Collections.Generic;
using System.Net;
using System.Threading.Tasks;
using Microsoft.AspNet.Builder;
using Microsoft.AspNet.TestHost;
using Newtonsoft.Json;
using Xunit;
namespace Microsoft.AspNet.Mvc.FunctionalTests
{
public class TryValidateModelTest
{
private readonly IServiceProvider _services = TestHelper.CreateServices(nameof(FormatterWebSite));
private readonly Action<IApplicationBuilder> _app = new FormatterWebSite.Startup().Configure;
[Fact]
public async Task TryValidateModel_SimpleModelInvalidProperties()
{
// Arrange
var server = TestServer.Create(_services, _app);
var client = server.CreateClient();
// Act
var response = await client.GetAsync("http://localhost/TryValidateModel/GetInvalidUser");
// Assert
Assert.Equal(HttpStatusCode.BadRequest, response.StatusCode);
var json = JsonConvert.DeserializeObject<Dictionary<string, string[]>>(
await response.Content.ReadAsStringAsync());
Assert.Equal("The field Id must be between 1 and 2000.", json["Id"][0]);
Assert.Equal(
"The field Name must be a string or array type with a minimum length of '5'.", json["Name"][0]);
}
[Fact]
public async Task TryValidateModel_DerivedModelInvalidType()
{
// Arrange
var server = TestServer.Create(_services, _app);
var client = server.CreateClient();
// Act
var response = await client.GetAsync("http://localhost/TryValidateModel/GetInvalidAdminWithPrefix");
// Assert
Assert.Equal(HttpStatusCode.BadRequest, response.StatusCode);
var json = JsonConvert.DeserializeObject<Dictionary<string, string[]>>(
await response.Content.ReadAsStringAsync());
Assert.Equal("AdminAccessCode property does not have the right value", json["admin"][0]);
}
[Fact]
public async Task TryValidateModel_ValidDerivedModel()
{
// Arrange
var server = TestServer.Create(_services, _app);
var client = server.CreateClient();
// Act
var response = await client.GetAsync("http://localhost/TryValidateModel/GetValidAdminWithPrefix");
// Assert
Assert.Equal(HttpStatusCode.OK, response.StatusCode);
Assert.Equal("Admin user created successfully", await response.Content.ReadAsStringAsync());
}
}
}

View File

@ -0,0 +1,64 @@
// 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 Microsoft.AspNet.Mvc;
namespace FormatterWebSite
{
public class TryValidateModelController : Controller
{
[HttpGet]
public IActionResult GetInvalidUser()
{
var user = new User
{
Id = 0,
Name = "x"
};
// If ModelState.InValid is false return BadRequestOjectResult; else return empty string.
if (!TryValidateModel(user))
{
return new BadRequestObjectResult(ModelState);
}
return Content(string.Empty);
}
[HttpGet]
public IActionResult GetInvalidAdminWithPrefix()
{
var admin = new Administrator()
{
Id = 1,
Name = "John Doe",
Designation = "Administrator",
AdminAccessCode = 0
};
if (!TryValidateModel(admin,"admin"))
{
return new BadRequestObjectResult(ModelState);
}
return Content(string.Empty);
}
[HttpGet]
public IActionResult GetValidAdminWithPrefix()
{
var admin = new Administrator()
{
Id = 1,
Name = "John Doe",
Designation = "Administrator",
AdminAccessCode = 1
};
if (!TryValidateModel(admin, "admin"))
{
return new BadRequestObjectResult(ModelState);
}
return Content("Admin user created successfully");
}
}
}

View File

@ -0,0 +1,22 @@
// 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.ComponentModel.DataAnnotations;
namespace FormatterWebSite
{
public class AdminValidator : ValidationAttribute
{
protected override ValidationResult IsValid(object value, ValidationContext validationContext)
{
var admin = (Administrator)value;
if (admin.AdminAccessCode != 1)
{
return new ValidationResult ("AdminAccessCode property does not have the right value");
}
return null;
}
}
}

View File

@ -0,0 +1,13 @@
// 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;
namespace FormatterWebSite
{
[AdminValidator]
public class Administrator : User
{
public int AdminAccessCode { get; set; }
}
}