1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492
|
// Copyright (c) Microsoft Corporation. All rights reserved. See License.txt in the project root for license information.
using System.ComponentModel;
using System.Linq;
using System.Net.Http;
using System.Reflection;
using System.Threading;
using System.Web.Http.Controllers;
using System.Web.Http.ValueProviders;
using Xunit;
using Assert = Microsoft.TestCommon.AssertEx;
namespace System.Web.Http.ModelBinding
{
// These tests primarily focus on getting the right binding contract. They don't actually execute the contract.
public class DefaultActionValueBinderTest
{
[Fact]
public void BindValuesAsync_Throws_Null_ActionDescriptor()
{
// Arrange
HttpActionDescriptor actionDescriptor = new ReflectedHttpActionDescriptor { MethodInfo = (MethodInfo)MethodInfo.GetCurrentMethod() };
// Act and Assert
Assert.ThrowsArgumentNull(
() => new DefaultActionValueBinder().GetBinding(null),
"actionDescriptor");
}
private void Action_Int(int id) { }
[Fact]
public void Check_Int_Is_ModelBound()
{
DefaultActionValueBinder binder = new DefaultActionValueBinder();
var binding = binder.GetBinding(GetAction("Action_Int"));
Assert.Equal(1, binding.ParameterBindings.Length);
AssertIsModelBound(binding, 0);
}
private void Action_Int_FromUri([FromUri] int id) { }
[Fact]
public void Check_Explicit_Int_Is_ModelBound()
{
// Even though int is implicitly model bound, still ok to specify it explicitly
DefaultActionValueBinder binder = new DefaultActionValueBinder();
var binding = binder.GetBinding(GetAction("Action_Int_FromUri"));
Assert.Equal(1, binding.ParameterBindings.Length);
AssertIsModelBound(binding, 0);
}
// All types in this signature are model bound
private void Action_SimpleTypes(char ch, Byte b, Int16 i16, UInt16 u16, Int32 i32, UInt32 u32, Int64 i64, UInt64 u64, string s, DateTime d, Decimal dec, Guid g, DateTimeOffset dateTimeOffset, TimeSpan timespan) { }
[Fact]
public void Check_SimpleTypes_Are_ModelBound()
{
DefaultActionValueBinder binder = new DefaultActionValueBinder();
var binding = binder.GetBinding(GetAction("Action_SimpleTypes"));
for(int i = 0; i < binding.ParameterBindings.Length; i++)
{
AssertIsModelBound(binding, 0);
}
}
private void Action_ComplexTypeWithStringConverter(ComplexTypeWithStringConverter x) { }
[Fact]
public void Check_String_TypeConverter_Is_ModelBound()
{
DefaultActionValueBinder binder = new DefaultActionValueBinder();
var binding = binder.GetBinding(GetAction("Action_ComplexTypeWithStringConverter"));
Assert.Equal(1, binding.ParameterBindings.Length);
AssertIsModelBound(binding, 0);
}
private void Action_ComplexTypeWithStringConverter_Body_Override([FromBody] ComplexTypeWithStringConverter x) { }
[Fact]
public void Check_String_TypeConverter_With_Body_Override()
{
DefaultActionValueBinder binder = new DefaultActionValueBinder();
var binding = binder.GetBinding(GetAction("Action_ComplexTypeWithStringConverter_Body_Override"));
Assert.Equal(1, binding.ParameterBindings.Length);
AssertIsBody(binding, 0);
}
private void Action_NullableInt(Nullable<int> id) { }
[Fact]
public void Check_NullableInt_Is_ModelBound()
{
DefaultActionValueBinder binder = new DefaultActionValueBinder();
var binding = binder.GetBinding(GetAction("Action_NullableInt"));
Assert.Equal(1, binding.ParameterBindings.Length);
AssertIsModelBound(binding, 0);
}
private void Action_Nullable_ValueType(Nullable<ComplexValueType> id) { }
[Fact]
public void Check_Nullable_ValueType_Is_FromBody()
{
DefaultActionValueBinder binder = new DefaultActionValueBinder();
var binding = binder.GetBinding(GetAction("Action_Nullable_ValueType"));
Assert.Equal(1, binding.ParameterBindings.Length);
AssertIsBody(binding, 0);
}
private void Action_IntArray(int[] arrayFrombody) { }
[Fact]
public void Check_IntArray_Is_FromBody()
{
DefaultActionValueBinder binder = new DefaultActionValueBinder();
var binding = binder.GetBinding(GetAction("Action_IntArray"));
Assert.Equal(1, binding.ParameterBindings.Length);
AssertIsBody(binding, 0);
}
private void Action_SimpleType_Body([FromBody] int i) { }
[Fact]
public void Check_SimpleType_Body()
{
DefaultActionValueBinder binder = new DefaultActionValueBinder();
var binding = binder.GetBinding(GetAction("Action_SimpleType_Body"));
Assert.Equal(1, binding.ParameterBindings.Length);
AssertIsBody(binding, 0);
}
private void Action_Empty() { }
[Fact]
public void Check_Empty_Action()
{
DefaultActionValueBinder binder = new DefaultActionValueBinder();
var binding = binder.GetBinding(GetAction("Action_Empty"));
Assert.NotNull(binding.ParameterBindings);
Assert.Equal(0, binding.ParameterBindings.Length);
}
private void Action_String_String(string s1, string s2) { }
[Fact]
public void Check_String_String_IsModelBound()
{
DefaultActionValueBinder binder = new DefaultActionValueBinder();
var binding = binder.GetBinding(GetAction("Action_String_String"));
Assert.Equal(2, binding.ParameterBindings.Length);
AssertIsModelBound(binding, 0);
AssertIsModelBound(binding, 1);
}
private void Action_Complex_Type(ComplexType complex) { }
[Fact]
public void Check_Complex_Type_FromBody()
{
DefaultActionValueBinder binder = new DefaultActionValueBinder();
var binding = binder.GetBinding(GetAction("Action_Complex_Type"));
Assert.Equal(1, binding.ParameterBindings.Length);
AssertIsBody(binding, 0);
}
private void Action_Complex_ValueType(ComplexValueType complex) { }
[Fact]
public void Check_Complex_ValueType_FromBody()
{
DefaultActionValueBinder binder = new DefaultActionValueBinder();
var binding = binder.GetBinding(GetAction("Action_Complex_ValueType"));
Assert.Equal(1, binding.ParameterBindings.Length);
AssertIsBody(binding, 0);
}
private void Action_Default_Custom_Model_Binder([ModelBinder] ComplexType complex) { }
[Fact]
public void Check_Customer_Binder()
{
// Mere presence of a ModelBinder attribute means the type is model bound.
DefaultActionValueBinder binder = new DefaultActionValueBinder();
var binding = binder.GetBinding(GetAction("Action_Default_Custom_Model_Binder"));
Assert.Equal(1, binding.ParameterBindings.Length);
AssertIsModelBound(binding, 0);
}
private void Action_Complex_Type_Uri([FromUri] ComplexType complex) { }
[Fact]
public void Check_Complex_Type_FromUri()
{
// [FromUri] is just a specific instance of ModelBinder attribute
DefaultActionValueBinder binder = new DefaultActionValueBinder();
var binding = binder.GetBinding(GetAction("Action_Complex_Type_Uri"));
Assert.Equal(1, binding.ParameterBindings.Length);
AssertIsModelBound(binding, 0);
}
private void Action_Two_Complex_Types(ComplexType complexBody1, ComplexType complexBody2) { }
[Fact]
public void Check_Two_Complex_Types_FromBody()
{
DefaultActionValueBinder binder = new DefaultActionValueBinder();
// It's illegal to have multiple parameters from the body.
// But we should still be able to get a binding for it. We just can't execute it.
var binding = binder.GetBinding(GetAction("Action_Two_Complex_Types"));
Assert.Equal(2, binding.ParameterBindings.Length);
AssertIsError(binding, 0);
AssertIsError(binding, 1);
}
private void Action_Complex_Type_UriAndBody([FromUri] ComplexType complexUri, ComplexType complexBody) { }
[Fact]
public void Check_Complex_Type_FromBody_And_FromUri()
{
DefaultActionValueBinder binder = new DefaultActionValueBinder();
var binding = binder.GetBinding(GetAction("Action_Complex_Type_UriAndBody"));
Assert.Equal(2, binding.ParameterBindings.Length);
AssertIsModelBound(binding, 0);
AssertIsBody(binding, 1);
}
private void Action_CancellationToken(CancellationToken ct) { }
[Fact]
public void Check_Cancellation_Token()
{
DefaultActionValueBinder binder = new DefaultActionValueBinder();
var binding = binder.GetBinding(GetAction("Action_CancellationToken"));
Assert.Equal(1, binding.ParameterBindings.Length);
AssertIsCancellationToken(binding, 0);
}
private void Action_CustomModelBinder_On_Parameter_WithProvider([ModelBinder(typeof(CustomModelBinderProvider))] ComplexType complex) { }
[Fact]
public void Check_CustomModelBinder_On_Parameter()
{
HttpConfiguration config = new HttpConfiguration();
config.Services.ReplaceRange(typeof(ValueProviderFactory), new ValueProviderFactory[] {
new CustomValueProviderFactory(),
});
DefaultActionValueBinder binder = new DefaultActionValueBinder();
var binding = binder.GetBinding(GetAction("Action_CustomModelBinder_On_Parameter_WithProvider", config));
Assert.Equal(1, binding.ParameterBindings.Length);
AssertIsModelBound(binding, 0);
ModelBinderParameterBinding p = (ModelBinderParameterBinding) binding.ParameterBindings[0];
Assert.IsType<CustomModelBinderProvider>(p.ModelBinderProvider);
// Since the ModelBinderAttribute didn't specify the valueproviders, we should pull those from config.
Assert.Equal(1, p.ValueProviderFactories.Count());
Assert.IsType<CustomValueProviderFactory>(p.ValueProviderFactories.First());
}
// Model binder attribute is on the type's declaration.
private void Action_ComplexParameter_With_ModelBinder(ComplexTypeWithModelBinder complex) { }
[Fact]
public void Check_Parameter_With_ModelBinder_Attribute_On_Type()
{
DefaultActionValueBinder binder = new DefaultActionValueBinder();
var binding = binder.GetBinding(GetAction("Action_ComplexParameter_With_ModelBinder"));
Assert.Equal(1, binding.ParameterBindings.Length);
AssertIsModelBound(binding, 0);
}
private void Action_Conflicting_Attributes([FromBody][FromUri] int i) { }
[Fact]
public void Error_Conflicting_Attributes()
{
DefaultActionValueBinder binder = new DefaultActionValueBinder();
var binding = binder.GetBinding(GetAction("Action_Conflicting_Attributes"));
// Have 2 attributes that conflict with each other. Still get the contract, but it has an error in it.
Assert.Equal(1, binding.ParameterBindings.Length);
AssertIsError(binding, 0);
}
private void Action_HttpContent_Parameter(HttpContent c) { }
[Fact]
public void Check_HttpContent()
{
DefaultActionValueBinder binder = new DefaultActionValueBinder();
var binding = binder.GetBinding(GetAction("Action_HttpContent_Parameter"));
Assert.Equal(1, binding.ParameterBindings.Length);
AssertIsError(binding, 0);
}
private void Action_Derived_HttpContent_Parameter(StreamContent c) { }
[Fact]
public void Check_Derived_HttpContent()
{
DefaultActionValueBinder binder = new DefaultActionValueBinder();
var binding = binder.GetBinding(GetAction("Action_Derived_HttpContent_Parameter"));
Assert.Equal(1, binding.ParameterBindings.Length);
AssertIsError(binding, 0);
}
private void Action_Request_Parameter(HttpRequestMessage request) { }
[Fact]
public void Check_Request_Parameter()
{
DefaultActionValueBinder binder = new DefaultActionValueBinder();
var binding = binder.GetBinding(GetAction("Action_Request_Parameter"));
Assert.Equal(1, binding.ParameterBindings.Length);
AssertIsCustomBinder<HttpRequestParameterBinding>(binding, 0);
}
// Assert that the binding contract says the given parameter comes from the body
private void AssertIsBody(HttpActionBinding binding, int paramIdx)
{
HttpParameterBinding p = binding.ParameterBindings[paramIdx];
Assert.NotNull(p);
Assert.True(p.IsValid);
Assert.True(p.WillReadBody);
}
// Assert that the binding contract says the given parameter is not from the body (will be handled by model binding)
private void AssertIsModelBound(HttpActionBinding binding, int paramIdx)
{
HttpParameterBinding p = binding.ParameterBindings[paramIdx];
Assert.NotNull(p);
Assert.IsType<ModelBinderParameterBinding>(p);
Assert.True(p.IsValid);
Assert.False(p.WillReadBody);
}
// Assert that the binding contract says the given parameter will be bound to the cancellation token.
private void AssertIsCancellationToken(HttpActionBinding binding, int paramIdx)
{
AssertIsCustomBinder<CancellationTokenParameterBinding>(binding, paramIdx);
}
private void AssertIsError(HttpActionBinding binding, int paramIdx)
{
HttpParameterBinding p = binding.ParameterBindings[paramIdx];
Assert.NotNull(p);
Assert.False(p.IsValid);
Assert.False(p.WillReadBody);
}
private void AssertIsCustomBinder<T>(HttpActionBinding binding, int paramIdx)
{
HttpParameterBinding p = binding.ParameterBindings[paramIdx];
Assert.NotNull(p);
Assert.IsType<T>(p);
Assert.True(p.IsValid);
Assert.False(p.WillReadBody);
}
// Helper to get an ActionDescriptor for a method name.
private HttpActionDescriptor GetAction(string name)
{
return GetAction(name, new HttpConfiguration());
}
private HttpActionDescriptor GetAction(string name, HttpConfiguration config)
{
MethodInfo method = this.GetType().GetMethod(name, BindingFlags.Instance | BindingFlags.Public | BindingFlags.NonPublic);
Assert.NotNull(method);
return new ReflectedHttpActionDescriptor { MethodInfo = method, Configuration = config };
}
// Complex type to use with tests
class ComplexType
{
}
struct ComplexValueType
{
}
// Complex type to use with tests
[ModelBinder]
class ComplexTypeWithModelBinder
{
}
// Add Type converter for string, which causes the type to be viewed as a Simple type.
[TypeConverter(typeof(MyTypeConverter))]
public class ComplexTypeWithStringConverter
{
public string Data { get; set; }
public ComplexTypeWithStringConverter(string data)
{
Data = data;
}
}
// A string type converter
public class MyTypeConverter : TypeConverter
{
public override bool CanConvertFrom(ITypeDescriptorContext context, Type sourceType)
{
if (sourceType == typeof(string))
{
return true;
}
return base.CanConvertFrom(context, sourceType);
}
public override object ConvertFrom(ITypeDescriptorContext context, System.Globalization.CultureInfo culture, object value)
{
if (value is string)
{
return new ComplexTypeWithStringConverter((string)value);
}
return base.ConvertFrom(context, culture, value);
}
}
class CustomModelBinderProvider : ModelBinderProvider
{
public override IModelBinder GetBinder(HttpActionContext actionContext, ModelBindingContext bindingContext)
{
throw new NotImplementedException();
}
}
class CustomValueProviderFactory : ValueProviderFactory
{
public override IValueProvider GetValueProvider(HttpActionContext actionContext)
{
throw new NotImplementedException();
}
}
}
}
|