Browse Source

Check validation on SetProperty.

pull/3834/head
Halil İbrahim Kalkan 6 years ago
parent
commit
50d416dd25
  1. 11
      framework/Volo.Abp.sln
  2. 3
      framework/src/Volo.Abp.ObjectExtending/Volo.Abp.ObjectExtending.csproj
  3. 13
      framework/src/Volo.Abp.ObjectExtending/Volo/Abp/Data/HasExtraPropertiesExtensions.cs
  4. 8
      framework/src/Volo.Abp.ObjectExtending/Volo/Abp/ObjectExtending/AbpObjectExtendingModule.cs
  5. 143
      framework/src/Volo.Abp.ObjectExtending/Volo/Abp/ObjectExtending/ExtensibleObjectValidator.cs
  6. 1
      framework/src/Volo.Abp.ObjectExtending/Volo/Abp/ObjectExtending/ObjectExtensionPropertyValidationContext.cs
  7. 3
      framework/src/Volo.Abp.Validation.Abstractions/FodyWeavers.xml
  8. 30
      framework/src/Volo.Abp.Validation.Abstractions/FodyWeavers.xsd
  9. 21
      framework/src/Volo.Abp.Validation.Abstractions/Volo.Abp.Validation.Abstractions.csproj
  10. 9
      framework/src/Volo.Abp.Validation.Abstractions/Volo/Abp/Validation/AbpValidationAbstractionsModule.cs
  11. 0
      framework/src/Volo.Abp.Validation.Abstractions/Volo/Abp/Validation/AbpValidationException.cs
  12. 0
      framework/src/Volo.Abp.Validation.Abstractions/Volo/Abp/Validation/IHasValidationErrors.cs
  13. 1
      framework/src/Volo.Abp.Validation/Volo.Abp.Validation.csproj
  14. 1
      framework/src/Volo.Abp.Validation/Volo/Abp/Validation/AbpValidationModule.cs
  15. 35
      framework/test/Volo.Abp.ObjectExtending.Tests/Volo/Abp/ObjectExtending/ExtensibleObjectValidator_Tests.cs
  16. 1
      nupkg/common.ps1

11
framework/Volo.Abp.sln

@ -279,9 +279,11 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Volo.Abp.ObjectExtending",
EndProject
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Volo.Abp.ObjectExtending.Tests", "test\Volo.Abp.ObjectExtending.Tests\Volo.Abp.ObjectExtending.Tests.csproj", "{17F8CA89-D9A2-4863-A5BD-B8E4D2901FD5}"
EndProject
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Volo.Abp.TextTemplating", "src\Volo.Abp.TextTemplating\Volo.Abp.TextTemplating.csproj", "{9E53F91F-EACD-4191-A487-E727741F1311}"
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Volo.Abp.TextTemplating", "src\Volo.Abp.TextTemplating\Volo.Abp.TextTemplating.csproj", "{9E53F91F-EACD-4191-A487-E727741F1311}"
EndProject
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Volo.Abp.TextTemplating.Tests", "test\Volo.Abp.TextTemplating.Tests\Volo.Abp.TextTemplating.Tests.csproj", "{251C7FD3-D313-4BCE-8068-352EC7EEA275}"
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Volo.Abp.TextTemplating.Tests", "test\Volo.Abp.TextTemplating.Tests\Volo.Abp.TextTemplating.Tests.csproj", "{251C7FD3-D313-4BCE-8068-352EC7EEA275}"
EndProject
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Volo.Abp.Validation.Abstractions", "src\Volo.Abp.Validation.Abstractions\Volo.Abp.Validation.Abstractions.csproj", "{FA5D1D6A-2A05-4A3D-99C1-2B6C1D1F99A3}"
EndProject
Global
GlobalSection(SolutionConfigurationPlatforms) = preSolution
@ -841,6 +843,10 @@ Global
{251C7FD3-D313-4BCE-8068-352EC7EEA275}.Debug|Any CPU.Build.0 = Debug|Any CPU
{251C7FD3-D313-4BCE-8068-352EC7EEA275}.Release|Any CPU.ActiveCfg = Release|Any CPU
{251C7FD3-D313-4BCE-8068-352EC7EEA275}.Release|Any CPU.Build.0 = Release|Any CPU
{FA5D1D6A-2A05-4A3D-99C1-2B6C1D1F99A3}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
{FA5D1D6A-2A05-4A3D-99C1-2B6C1D1F99A3}.Debug|Any CPU.Build.0 = Debug|Any CPU
{FA5D1D6A-2A05-4A3D-99C1-2B6C1D1F99A3}.Release|Any CPU.ActiveCfg = Release|Any CPU
{FA5D1D6A-2A05-4A3D-99C1-2B6C1D1F99A3}.Release|Any CPU.Build.0 = Release|Any CPU
EndGlobalSection
GlobalSection(SolutionProperties) = preSolution
HideSolutionNode = FALSE
@ -984,6 +990,7 @@ Global
{17F8CA89-D9A2-4863-A5BD-B8E4D2901FD5} = {447C8A77-E5F0-4538-8687-7383196D04EA}
{9E53F91F-EACD-4191-A487-E727741F1311} = {5DF0E140-0513-4D0D-BE2E-3D4D85CD70E6}
{251C7FD3-D313-4BCE-8068-352EC7EEA275} = {447C8A77-E5F0-4538-8687-7383196D04EA}
{FA5D1D6A-2A05-4A3D-99C1-2B6C1D1F99A3} = {5DF0E140-0513-4D0D-BE2E-3D4D85CD70E6}
EndGlobalSection
GlobalSection(ExtensibilityGlobals) = postSolution
SolutionGuid = {BB97ECF4-9A84-433F-A80B-2A3285BDD1D5}

3
framework/src/Volo.Abp.ObjectExtending/Volo.Abp.ObjectExtending.csproj

@ -1,4 +1,4 @@
<Project Sdk="Microsoft.NET.Sdk">
<Project Sdk="Microsoft.NET.Sdk">
<Import Project="..\..\..\configureawait.props" />
<Import Project="..\..\..\common.props" />
@ -15,6 +15,7 @@
</PropertyGroup>
<ItemGroup>
<ProjectReference Include="..\Volo.Abp.Validation.Abstractions\Volo.Abp.Validation.Abstractions.csproj" />
<ProjectReference Include="..\Volo.Abp.Localization.Abstractions\Volo.Abp.Localization.Abstractions.csproj" />
</ItemGroup>

13
framework/src/Volo.Abp.ObjectExtending/Volo/Abp/Data/HasExtraPropertiesExtensions.cs

@ -1,6 +1,7 @@
using System;
using System.Collections.Generic;
using System.Globalization;
using Volo.Abp.DynamicProxy;
using Volo.Abp.ObjectExtending;
using Volo.Abp.Reflection;
@ -37,10 +38,20 @@ namespace Volo.Abp.Data
throw new AbpException("GetProperty<TProperty> does not support non-primitive types. Use non-generic GetProperty method and handle type casting manually.");
}
public static TSource SetProperty<TSource>(this TSource source, string name, object value)
public static TSource SetProperty<TSource>(
this TSource source,
string name,
object value,
bool validate = true)
where TSource : IHasExtraProperties
{
if (validate)
{
ExtensibleObjectValidator.CheckValue(source, name, value);
}
source.ExtraProperties[name] = value;
return source;
}

8
framework/src/Volo.Abp.ObjectExtending/Volo/Abp/ObjectExtending/AbpObjectExtendingModule.cs

@ -1,10 +1,12 @@
using Volo.Abp.Localization;
using Volo.Abp.Modularity;
using Volo.Abp.Modularity;
using Volo.Abp.Validation;
using Volo.Abp.Localization;
namespace Volo.Abp.ObjectExtending
{
[DependsOn(
typeof(AbpLocalizationAbstractionsModule)
typeof(AbpLocalizationAbstractionsModule),
typeof(AbpValidationAbstractionsModule)
)]
public class AbpObjectExtendingModule : AbpModule
{

143
framework/src/Volo.Abp.ObjectExtending/Volo/Abp/ObjectExtending/ExtensibleObjectValidator.cs

@ -4,18 +4,49 @@ using System.Linq;
using JetBrains.Annotations;
using Volo.Abp.Data;
using Volo.Abp.DynamicProxy;
using Volo.Abp.Validation;
namespace Volo.Abp.ObjectExtending
{
public static class ExtensibleObjectValidator
{
[NotNull]
public static void CheckValue(
[NotNull] IHasExtraProperties extensibleObject,
[NotNull] string propertyName,
[CanBeNull] object value)
{
var validationErrors = GetValidationErrors(
extensibleObject,
propertyName,
value
);
if (validationErrors.Any())
{
throw new AbpValidationException(validationErrors);
}
}
public static bool IsValid(
[NotNull] IHasExtraProperties extensibleObject,
[CanBeNull] ValidationContext objectValidationContext = null)
{
return GetValidationErrors(
extensibleObject,
objectValidationContext
).Any();
}
public static bool IsValid(
[NotNull] IHasExtraProperties extensibleObject,
[NotNull] string propertyName,
[CanBeNull] object value,
[CanBeNull] ValidationContext objectValidationContext = null)
{
return GetValidationErrors(
extensibleObject,
propertyName,
value,
objectValidationContext
).Any();
}
@ -26,10 +57,30 @@ namespace Volo.Abp.ObjectExtending
[CanBeNull] ValidationContext objectValidationContext = null)
{
var validationErrors = new List<ValidationResult>();
AddValidationErrors(
extensibleObject,
validationErrors,
objectValidationContext
);
return validationErrors;
}
[NotNull]
public static List<ValidationResult> GetValidationErrors(
[NotNull] IHasExtraProperties extensibleObject,
[NotNull] string propertyName,
[CanBeNull] object value,
[CanBeNull] ValidationContext objectValidationContext = null)
{
var validationErrors = new List<ValidationResult>();
AddValidationErrors(
extensibleObject,
validationErrors,
propertyName,
value,
objectValidationContext
);
@ -78,10 +129,55 @@ namespace Volo.Abp.ObjectExtending
);
}
public static void AddValidationErrors(
[NotNull] IHasExtraProperties extensibleObject,
[NotNull] List<ValidationResult> validationErrors,
[NotNull] string propertyName,
[CanBeNull] object value,
[CanBeNull] ValidationContext objectValidationContext = null)
{
Check.NotNull(extensibleObject, nameof(extensibleObject));
Check.NotNull(validationErrors, nameof(validationErrors));
Check.NotNullOrWhiteSpace(propertyName, nameof(propertyName));
if (objectValidationContext == null)
{
objectValidationContext = new ValidationContext(
extensibleObject,
null,
new Dictionary<object, object>()
);
}
var objectType = ProxyHelper.UnProxy(extensibleObject).GetType();
var objectExtensionInfo = ObjectExtensionManager.Instance
.GetOrNull(objectType);
if (objectExtensionInfo == null)
{
return;
}
var property = objectExtensionInfo.GetPropertyOrNull(propertyName);
if (property == null)
{
return;
}
AddPropertyValidationErrors(
extensibleObject,
validationErrors,
objectValidationContext,
property,
value
);
}
private static void AddPropertyValidationErrors(
IHasExtraProperties extensibleObject,
IHasExtraProperties extensibleObject,
List<ValidationResult> validationErrors,
ValidationContext objectValidationContext,
ValidationContext objectValidationContext,
ObjectExtensionInfo objectExtensionInfo)
{
var properties = objectExtensionInfo.GetProperties();
@ -92,36 +188,46 @@ namespace Volo.Abp.ObjectExtending
foreach (var property in properties)
{
AddPropertyValidationErrors(extensibleObject, validationErrors, objectValidationContext, property);
AddPropertyValidationErrors(
extensibleObject,
validationErrors,
objectValidationContext,
property,
extensibleObject.GetProperty(property.Name)
);
}
}
private static void AddPropertyValidationErrors(
IHasExtraProperties extensibleObject,
IHasExtraProperties extensibleObject,
List<ValidationResult> validationErrors,
ValidationContext objectValidationContext,
ObjectExtensionPropertyInfo property)
ValidationContext objectValidationContext,
ObjectExtensionPropertyInfo property,
object value)
{
AddPropertyValidationAttributeErrors(
extensibleObject,
validationErrors,
objectValidationContext,
property
property,
value
);
ExecuteCustomPropertyValidationActions(
extensibleObject,
validationErrors,
objectValidationContext,
property
property,
value
);
}
private static void AddPropertyValidationAttributeErrors(
IHasExtraProperties extensibleObject,
IHasExtraProperties extensibleObject,
List<ValidationResult> validationErrors,
ValidationContext objectValidationContext,
ObjectExtensionPropertyInfo property)
ValidationContext objectValidationContext,
ObjectExtensionPropertyInfo property,
object value)
{
var validationAttributes = property.GetValidationAttributes();
@ -139,7 +245,7 @@ namespace Volo.Abp.ObjectExtending
foreach (var attribute in validationAttributes)
{
var result = attribute.GetValidationResult(
extensibleObject.GetProperty(property.Name),
value,
propertyValidationContext
);
@ -154,7 +260,8 @@ namespace Volo.Abp.ObjectExtending
IHasExtraProperties extensibleObject,
List<ValidationResult> validationErrors,
ValidationContext objectValidationContext,
ObjectExtensionPropertyInfo property)
ObjectExtensionPropertyInfo property,
object value)
{
if (!property.Validators.Any())
{
@ -166,7 +273,7 @@ namespace Volo.Abp.ObjectExtending
extensibleObject,
validationErrors,
objectValidationContext,
extensibleObject.GetProperty(property.Name)
value
);
foreach (var validator in property.Validators)
@ -176,9 +283,9 @@ namespace Volo.Abp.ObjectExtending
}
private static void ExecuteCustomObjectValidationActions(
IHasExtraProperties extensibleObject,
IHasExtraProperties extensibleObject,
List<ValidationResult> validationErrors,
ValidationContext objectValidationContext,
ValidationContext objectValidationContext,
ObjectExtensionInfo objectExtensionInfo)
{
if (!objectExtensionInfo.Validators.Any())

1
framework/src/Volo.Abp.ObjectExtending/Volo/Abp/ObjectExtending/ObjectExtensionPropertyValidationContext.cs

@ -40,6 +40,7 @@ namespace Volo.Abp.ObjectExtending
/// <summary>
/// Can be used to resolve services from the dependency injection container.
/// This can be null when SetProperty method is used on the object.
/// </summary>
[CanBeNull]
public IServiceProvider ServiceProvider => ValidationContext;

3
framework/src/Volo.Abp.Validation.Abstractions/FodyWeavers.xml

@ -0,0 +1,3 @@
<Weavers xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="FodyWeavers.xsd">
<ConfigureAwait ContinueOnCapturedContext="false" />
</Weavers>

30
framework/src/Volo.Abp.Validation.Abstractions/FodyWeavers.xsd

@ -0,0 +1,30 @@
<?xml version="1.0" encoding="utf-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
<!-- This file was generated by Fody. Manual changes to this file will be lost when your project is rebuilt. -->
<xs:element name="Weavers">
<xs:complexType>
<xs:all>
<xs:element name="ConfigureAwait" minOccurs="0" maxOccurs="1">
<xs:complexType>
<xs:attribute name="ContinueOnCapturedContext" type="xs:boolean" />
</xs:complexType>
</xs:element>
</xs:all>
<xs:attribute name="VerifyAssembly" type="xs:boolean">
<xs:annotation>
<xs:documentation>'true' to run assembly verification (PEVerify) on the target assembly after all weavers have been executed.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="VerifyIgnoreCodes" type="xs:string">
<xs:annotation>
<xs:documentation>A comma-separated list of error codes that can be safely ignored in assembly verification.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="GenerateXsd" type="xs:boolean">
<xs:annotation>
<xs:documentation>'false' to turn off automatic generation of the XML Schema file.</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
</xs:element>
</xs:schema>

21
framework/src/Volo.Abp.Validation.Abstractions/Volo.Abp.Validation.Abstractions.csproj

@ -0,0 +1,21 @@
<Project Sdk="Microsoft.NET.Sdk">
<Import Project="..\..\..\configureawait.props" />
<Import Project="..\..\..\common.props" />
<PropertyGroup>
<TargetFramework>netstandard2.0</TargetFramework>
<AssemblyName>Volo.Abp.Validation.Abstractions</AssemblyName>
<PackageId>Volo.Abp.Validation.Abstractions</PackageId>
<AssetTargetFallback>$(AssetTargetFallback);portable-net45+win8+wp8+wpa81;</AssetTargetFallback>
<GenerateAssemblyConfigurationAttribute>false</GenerateAssemblyConfigurationAttribute>
<GenerateAssemblyCompanyAttribute>false</GenerateAssemblyCompanyAttribute>
<GenerateAssemblyProductAttribute>false</GenerateAssemblyProductAttribute>
<RootNamespace />
</PropertyGroup>
<ItemGroup>
<ProjectReference Include="..\Volo.Abp.Core\Volo.Abp.Core.csproj" />
</ItemGroup>
</Project>

9
framework/src/Volo.Abp.Validation.Abstractions/Volo/Abp/Validation/AbpValidationAbstractionsModule.cs

@ -0,0 +1,9 @@
using Volo.Abp.Modularity;
namespace Volo.Abp.Validation
{
public class AbpValidationAbstractionsModule : AbpModule
{
}
}

0
framework/src/Volo.Abp.Validation/Volo/Abp/Validation/AbpValidationException.cs → framework/src/Volo.Abp.Validation.Abstractions/Volo/Abp/Validation/AbpValidationException.cs

0
framework/src/Volo.Abp.Validation/Volo/Abp/Validation/IHasValidationErrors.cs → framework/src/Volo.Abp.Validation.Abstractions/Volo/Abp/Validation/IHasValidationErrors.cs

1
framework/src/Volo.Abp.Validation/Volo.Abp.Validation.csproj

@ -21,6 +21,7 @@
<ItemGroup>
<ProjectReference Include="..\Volo.Abp.Localization\Volo.Abp.Localization.csproj" />
<ProjectReference Include="..\Volo.Abp.Validation.Abstractions\Volo.Abp.Validation.Abstractions.csproj" />
</ItemGroup>
</Project>

1
framework/src/Volo.Abp.Validation/Volo/Abp/Validation/AbpValidationModule.cs

@ -9,6 +9,7 @@ using Volo.Abp.VirtualFileSystem;
namespace Volo.Abp.Validation
{
[DependsOn(
typeof(AbpValidationAbstractionsModule),
typeof(AbpLocalizationModule)
)]
public class AbpValidationModule : AbpModule

35
framework/test/Volo.Abp.ObjectExtending.Tests/Volo/Abp/ObjectExtending/ExtensibleObjectValidator_Tests.cs

@ -2,6 +2,7 @@
using Shouldly;
using Volo.Abp.Data;
using Volo.Abp.Threading;
using Volo.Abp.Validation;
using Xunit;
namespace Volo.Abp.ObjectExtending
@ -85,8 +86,8 @@ namespace Volo.Abp.ObjectExtending
ExtensibleObjectValidator
.GetValidationErrors(
new ExtensiblePersonObject()
.SetProperty("Name", "John")
.SetProperty("Age", 42)
.SetProperty("Name", "John", validate: false)
.SetProperty("Age", 42, validate: false)
).Count.ShouldBe(0); //All Valid
}
@ -101,39 +102,49 @@ namespace Volo.Abp.ObjectExtending
ExtensibleObjectValidator
.GetValidationErrors(
new ExtensiblePersonObject()
.SetProperty("Address", new string('x', 256))
.SetProperty("Address", new string('x', 256), validate: false)
).Count.ShouldBe(3); // Name, Age & Address
ExtensibleObjectValidator
.GetValidationErrors(
new ExtensiblePersonObject()
.SetProperty("Age", 42)
.SetProperty("Age", 42, validate: false)
).Count.ShouldBe(1); // Name
ExtensibleObjectValidator
.GetValidationErrors(
new ExtensiblePersonObject()
.SetProperty("Address", new string('x', 256))
.SetProperty("Age", 100)
.SetProperty("Address", new string('x', 256), validate: false)
.SetProperty("Age", 100, validate: false)
).Count.ShouldBe(3); // Name, Age & Address
ExtensibleObjectValidator
.GetValidationErrors(
new ExtensiblePersonObject()
.SetProperty("Name", "John")
.SetProperty("Age", 42)
.SetProperty("Password", "123")
.SetProperty("PasswordRepeat", "1256")
.SetProperty("Name", "John", validate: false)
.SetProperty("Age", 42, validate: false)
.SetProperty("Password", "123", validate: false)
.SetProperty("PasswordRepeat", "1256", validate: false)
).Count.ShouldBe(1); // PasswordRepeat != Password
ExtensibleObjectValidator
.GetValidationErrors(
new ExtensiblePersonObject()
.SetProperty("Name", "BadValue")
.SetProperty("Age", 42)
.SetProperty("Name", "BadValue", validate: false)
.SetProperty("Age", 42, validate: false)
).Count.ShouldBe(1); //Name is 'BadValue'!
}
[Fact]
public void Should_Check_Validation_On_SetProperty()
{
Assert.Throws<AbpValidationException>(() =>
{
new ExtensiblePersonObject()
.SetProperty("Address", new string('x', 256));
});
}
private class ExtensiblePersonObject : ExtensibleObject
{

1
nupkg/common.ps1

@ -107,6 +107,7 @@ $projects = (
"framework/src/Volo.Abp.UI",
"framework/src/Volo.Abp.UI.Navigation",
"framework/src/Volo.Abp.Uow",
"framework/src/Volo.Abp.Validation.Abstractions",
"framework/src/Volo.Abp.Validation",
"framework/src/Volo.Abp.VirtualFileSystem",

Loading…
Cancel
Save