5fe91f837d
* Validation for block level variation * Make the "missing property value" JSON path expression valid * Update src/Umbraco.Core/Services/ContentValidationServiceBase.cs Co-authored-by: Nikolaj Geisle <70372949+Zeegaan@users.noreply.github.com> * Update src/Umbraco.Core/Services/ContentValidationServiceBase.cs Co-authored-by: Nikolaj Geisle <70372949+Zeegaan@users.noreply.github.com> * Update src/Umbraco.Infrastructure/PropertyEditors/BlockEditorValidatorBase.cs Co-authored-by: Nikolaj Geisle <70372949+Zeegaan@users.noreply.github.com> --------- Co-authored-by: Nikolaj Geisle <70372949+Zeegaan@users.noreply.github.com>
560 lines
25 KiB
C#
560 lines
25 KiB
C#
using NUnit.Framework;
|
|
using Umbraco.Cms.Core;
|
|
using Umbraco.Cms.Core.Models;
|
|
using Umbraco.Cms.Core.Models.ContentEditing;
|
|
using Umbraco.Cms.Core.PropertyEditors;
|
|
using Umbraco.Cms.Core.Serialization;
|
|
using Umbraco.Cms.Core.Services;
|
|
using Umbraco.Cms.Tests.Common.Builders;
|
|
using Umbraco.Cms.Tests.Common.Builders.Extensions;
|
|
using Umbraco.Cms.Tests.Common.Testing;
|
|
using Umbraco.Cms.Tests.Integration.Testing;
|
|
|
|
namespace Umbraco.Cms.Tests.Integration.Umbraco.Infrastructure.Services;
|
|
|
|
[TestFixture]
|
|
[UmbracoTest(
|
|
Database = UmbracoTestOptions.Database.NewSchemaPerTest,
|
|
PublishedRepositoryEvents = true,
|
|
WithApplication = true)]
|
|
public class ContentValidationServiceTests : UmbracoIntegrationTestWithContent
|
|
{
|
|
private IContentValidationService ContentValidationService => GetRequiredService<IContentValidationService>();
|
|
|
|
private ILanguageService LanguageService => GetRequiredService<ILanguageService>();
|
|
|
|
[Test]
|
|
public async Task Can_Validate_Block_List_Nested_In_Block_List()
|
|
{
|
|
var setup = await SetupBlockListTest();
|
|
|
|
var validationResult = await ContentValidationService.ValidatePropertiesAsync(
|
|
new ContentCreateModel
|
|
{
|
|
ContentTypeKey = setup.DocumentType.Key,
|
|
InvariantName = "Test Document",
|
|
InvariantProperties = new[]
|
|
{
|
|
new PropertyValueModel
|
|
{
|
|
Alias = "blocks",
|
|
Value = $$"""
|
|
{
|
|
"layout": {
|
|
"Umbraco.BlockList": [{
|
|
"contentKey": "9addc377-c02c-4db0-88c2-73b933704f7b",
|
|
"settingsKey": "65db1ecd-78e0-41a5-84f0-7296123a0a73"
|
|
}, {
|
|
"contentKey": "3af93b5b-5e40-4c64-b142-2564309fc4c7",
|
|
"settingsKey": "efb9583c-e670-43f2-82fb-2a0cb0f3e736"
|
|
}
|
|
]
|
|
},
|
|
"contentData": [{
|
|
"contentTypeKey": "{{setup.ElementType.Key}}",
|
|
"key": "9addc377-c02c-4db0-88c2-73b933704f7b",
|
|
"values": [
|
|
{
|
|
"alias": "title",
|
|
"value": "Valid root content title"
|
|
},
|
|
{
|
|
"alias": "blocks",
|
|
"value": {
|
|
"layout": {
|
|
"Umbraco.BlockList": [{
|
|
"contentKey": "f36cebfa-d03b-4451-9e60-4bf32c5b1e2f",
|
|
"settingsKey": "c9129a46-71bb-4b4e-8f0a-d525ad4a5de3"
|
|
}, {
|
|
"contentKey": "b8173e4a-0618-475c-8277-c3c6af68bee6",
|
|
"settingsKey": "77f7ea35-0766-4395-bf7f-0c9df04530f7"
|
|
}
|
|
]
|
|
},
|
|
"contentData": [{
|
|
"contentTypeKey": "{{setup.ElementType.Key}}",
|
|
"key": "f36cebfa-d03b-4451-9e60-4bf32c5b1e2f",
|
|
"values": [
|
|
{ "alias": "title", "value": "Invalid nested content title (ref #4)" },
|
|
{ "alias": "text", "value": "Valid nested content text" }
|
|
]
|
|
}, {
|
|
"contentTypeKey": "{{setup.ElementType.Key}}",
|
|
"key": "b8173e4a-0618-475c-8277-c3c6af68bee6",
|
|
"values": [
|
|
{ "alias": "title", "value": "Valid nested content title" },
|
|
{ "alias": "text", "value": "Invalid nested content text (ref #5)" }
|
|
]
|
|
}
|
|
],
|
|
"settingsData": [{
|
|
"contentTypeKey": "{{setup.ElementType.Key}}",
|
|
"key": "c9129a46-71bb-4b4e-8f0a-d525ad4a5de3",
|
|
"values": [
|
|
{ "alias": "title", "value": "Valid nested setting title" },
|
|
{ "alias": "text", "value": "Invalid nested setting text (ref #6)" }
|
|
]
|
|
}, {
|
|
"contentTypeKey": "{{setup.ElementType.Key}}",
|
|
"key": "77f7ea35-0766-4395-bf7f-0c9df04530f7",
|
|
"values": [
|
|
{ "alias": "title", "value": "Invalid nested setting title (ref #7)" },
|
|
{ "alias": "text", "value": "Valid nested setting text)" }
|
|
]
|
|
}
|
|
],
|
|
"expose": [
|
|
{ "contentKey": "f36cebfa-d03b-4451-9e60-4bf32c5b1e2f", "culture": null, "segment": null },
|
|
{ "contentKey": "b8173e4a-0618-475c-8277-c3c6af68bee6", "culture": null, "segment": null }
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}, {
|
|
"contentTypeKey": "{{setup.ElementType.Key}}",
|
|
"key": "3af93b5b-5e40-4c64-b142-2564309fc4c7",
|
|
"values": [
|
|
{ "alias": "title", "value": "Invalid root content title (ref #1)" },
|
|
{ "alias": "text", "value": "Valid root content text" }
|
|
]
|
|
}
|
|
],
|
|
"settingsData": [{
|
|
"contentTypeKey": "{{setup.ElementType.Key}}",
|
|
"key": "65db1ecd-78e0-41a5-84f0-7296123a0a73",
|
|
"values": [
|
|
{ "alias": "title", "value": "Invalid root setting title (ref #2)" },
|
|
{ "alias": "text", "value": "Valid root setting text" }
|
|
]
|
|
}, {
|
|
"contentTypeKey": "{{setup.ElementType.Key}}",
|
|
"key": "efb9583c-e670-43f2-82fb-2a0cb0f3e736",
|
|
"values": [
|
|
{ "alias": "title", "value": "Valid root setting title" },
|
|
{ "alias": "text", "value": "Invalid root setting text (ref #3)" }
|
|
]
|
|
}
|
|
],
|
|
"expose": [
|
|
{ "contentKey": "9addc377-c02c-4db0-88c2-73b933704f7b", "culture": null, "segment": null },
|
|
{ "contentKey": "3af93b5b-5e40-4c64-b142-2564309fc4c7", "culture": null, "segment": null }
|
|
]
|
|
}
|
|
"""
|
|
}
|
|
}
|
|
},
|
|
setup.DocumentType);
|
|
|
|
Assert.AreEqual(7, validationResult.ValidationErrors.Count());
|
|
|
|
// ref #1
|
|
Assert.IsNotNull(validationResult.ValidationErrors.SingleOrDefault(r => r.Alias == "blocks" && r.JsonPath == ".contentData[1].values[0].value"));
|
|
// ref #2
|
|
Assert.IsNotNull(validationResult.ValidationErrors.SingleOrDefault(r => r.Alias == "blocks" && r.JsonPath == ".settingsData[0].values[0].value"));
|
|
// ref #3
|
|
Assert.IsNotNull(validationResult.ValidationErrors.SingleOrDefault(r => r.Alias == "blocks" && r.JsonPath == ".settingsData[1].values[1].value"));
|
|
|
|
// ref #4
|
|
Assert.IsNotNull(validationResult.ValidationErrors.SingleOrDefault(r => r.Alias == "blocks" && r.JsonPath == ".contentData[0].values[1].value.contentData[0].values[0].value"));
|
|
// ref #5
|
|
Assert.IsNotNull(validationResult.ValidationErrors.SingleOrDefault(r => r.Alias == "blocks" && r.JsonPath == ".contentData[0].values[1].value.contentData[1].values[1].value"));
|
|
// ref #6
|
|
Assert.IsNotNull(validationResult.ValidationErrors.SingleOrDefault(r => r.Alias == "blocks" && r.JsonPath == ".contentData[0].values[1].value.settingsData[0].values[1].value"));
|
|
// ref #7
|
|
Assert.IsNotNull(validationResult.ValidationErrors.SingleOrDefault(r => r.Alias == "blocks" && r.JsonPath == ".contentData[0].values[1].value.settingsData[1].values[0].value"));
|
|
}
|
|
|
|
[TestCase(true)]
|
|
[TestCase(false)]
|
|
public async Task Can_Validate_RegEx_For_Simple_Property_On_Document(bool valid)
|
|
{
|
|
var contentType = SetupSimpleTest();
|
|
|
|
var validationResult = await ContentValidationService.ValidatePropertiesAsync(
|
|
new ContentCreateModel
|
|
{
|
|
ContentTypeKey = contentType.Key,
|
|
InvariantName = "Test Document",
|
|
InvariantProperties = new[]
|
|
{
|
|
new PropertyValueModel
|
|
{
|
|
Alias = "title",
|
|
Value = "The title value"
|
|
},
|
|
new PropertyValueModel
|
|
{
|
|
Alias = "author",
|
|
Value = valid ? "Valid value" : "Invalid value"
|
|
}
|
|
}
|
|
},
|
|
contentType);
|
|
|
|
if (valid)
|
|
{
|
|
Assert.IsEmpty(validationResult.ValidationErrors);
|
|
}
|
|
else
|
|
{
|
|
Assert.AreEqual(1, validationResult.ValidationErrors.Count());
|
|
Assert.IsNotNull(validationResult.ValidationErrors.SingleOrDefault(r => r.Alias == "author" && r.JsonPath == string.Empty));
|
|
}
|
|
}
|
|
|
|
[TestCase(true)]
|
|
[TestCase(false)]
|
|
public async Task Can_Validate_Mandatory_For_Simple_Property_On_Document(bool valid)
|
|
{
|
|
var contentType = SetupSimpleTest();
|
|
|
|
var validationResult = await ContentValidationService.ValidatePropertiesAsync(
|
|
new ContentCreateModel
|
|
{
|
|
ContentTypeKey = contentType.Key,
|
|
InvariantName = "Test Document",
|
|
InvariantProperties = new[]
|
|
{
|
|
new PropertyValueModel
|
|
{
|
|
Alias = "title",
|
|
Value = valid ? "A value" : string.Empty
|
|
},
|
|
new PropertyValueModel
|
|
{
|
|
Alias = "author",
|
|
Value = "Valid value"
|
|
}
|
|
}
|
|
},
|
|
contentType);
|
|
|
|
if (valid)
|
|
{
|
|
Assert.IsEmpty(validationResult.ValidationErrors);
|
|
}
|
|
else
|
|
{
|
|
Assert.AreEqual(1, validationResult.ValidationErrors.Count());
|
|
Assert.IsNotNull(validationResult.ValidationErrors.SingleOrDefault(r => r.Alias == "title" && r.JsonPath == string.Empty));
|
|
}
|
|
}
|
|
|
|
[Test]
|
|
public async Task Can_Validate_Mandatory_For_Property_Not_Present_In_Document()
|
|
{
|
|
var contentType = SetupSimpleTest();
|
|
|
|
var validationResult = await ContentValidationService.ValidatePropertiesAsync(
|
|
new ContentCreateModel
|
|
{
|
|
ContentTypeKey = contentType.Key,
|
|
InvariantName = "Test Document",
|
|
InvariantProperties = new[]
|
|
{
|
|
new PropertyValueModel
|
|
{
|
|
Alias = "author",
|
|
Value = "Valid value"
|
|
}
|
|
}
|
|
},
|
|
contentType);
|
|
|
|
Assert.AreEqual(1, validationResult.ValidationErrors.Count());
|
|
Assert.IsNotNull(validationResult.ValidationErrors.SingleOrDefault(r => r.Alias == "title" && r.JsonPath == string.Empty));
|
|
}
|
|
|
|
[Test]
|
|
public async Task Uses_Localizaton_Keys_For_Validation_Error_Messages()
|
|
{
|
|
var contentType = SetupSimpleTest();
|
|
|
|
var validationResult = await ContentValidationService.ValidatePropertiesAsync(
|
|
new ContentCreateModel
|
|
{
|
|
ContentTypeKey = contentType.Key,
|
|
InvariantName = "Test Document",
|
|
InvariantProperties = new[]
|
|
{
|
|
new PropertyValueModel
|
|
{
|
|
Alias = "author",
|
|
Value = "Invalid value"
|
|
}
|
|
}
|
|
},
|
|
contentType);
|
|
|
|
Assert.AreEqual(2, validationResult.ValidationErrors.Count());
|
|
Assert.IsNotNull(validationResult.ValidationErrors.SingleOrDefault(
|
|
r => r.Alias == "title"
|
|
&& r.ErrorMessages.Length == 1
|
|
&& r.ErrorMessages.First() == Constants.Validation.ErrorMessages.Properties.Missing));
|
|
Assert.IsNotNull(validationResult.ValidationErrors.SingleOrDefault(
|
|
r => r.Alias == "author"
|
|
&& r.ErrorMessages.Length == 1
|
|
&& r.ErrorMessages.First() == Constants.Validation.ErrorMessages.Properties.PatternMismatch));
|
|
}
|
|
|
|
[Test]
|
|
public async Task Custom_Validation_Error_Messages_Replaces_Localizaton_Keys()
|
|
{
|
|
var contentType = SetupSimpleTest();
|
|
contentType.PropertyTypes.First(pt => pt.Alias == "title").MandatoryMessage = "Custom mandatory message";
|
|
contentType.PropertyTypes.First(pt => pt.Alias == "author").ValidationRegExpMessage = "Custom regex message";
|
|
ContentTypeService.Save(contentType);
|
|
|
|
var validationResult = await ContentValidationService.ValidatePropertiesAsync(
|
|
new ContentCreateModel
|
|
{
|
|
ContentTypeKey = contentType.Key,
|
|
InvariantName = "Test Document",
|
|
InvariantProperties = new[]
|
|
{
|
|
new PropertyValueModel
|
|
{
|
|
Alias = "author",
|
|
Value = "Invalid value"
|
|
}
|
|
}
|
|
},
|
|
contentType);
|
|
|
|
Assert.AreEqual(2, validationResult.ValidationErrors.Count());
|
|
Assert.IsNotNull(validationResult.ValidationErrors.SingleOrDefault(
|
|
r => r.Alias == "title"
|
|
&& r.ErrorMessages.Length == 1
|
|
&& r.ErrorMessages.First() == "Custom mandatory message"));
|
|
Assert.IsNotNull(validationResult.ValidationErrors.SingleOrDefault(
|
|
r => r.Alias == "author"
|
|
&& r.ErrorMessages.Length == 1
|
|
&& r.ErrorMessages.First() == "Custom regex message"));
|
|
}
|
|
|
|
[TestCase("en-US", true)]
|
|
[TestCase("en-us", false)]
|
|
[TestCase("da-DK", true)]
|
|
[TestCase("da-dk", false)]
|
|
[TestCase("de-DE", false)]
|
|
[TestCase("de-de", false)]
|
|
public async Task Can_Validate_Culture_Code(string cultureCode, bool expectedResult)
|
|
{
|
|
var language = new LanguageBuilder()
|
|
.WithCultureInfo("da-DK")
|
|
.Build();
|
|
await LanguageService.CreateAsync(language, Constants.Security.SuperUserKey);
|
|
|
|
var result = await ContentValidationService.ValidateCulturesAsync(
|
|
new ContentCreateModel
|
|
{
|
|
Variants = new []
|
|
{
|
|
new VariantModel
|
|
{
|
|
Culture = cultureCode,
|
|
Name = "Whatever",
|
|
Properties = new []
|
|
{
|
|
new PropertyValueModel { Alias = "title", Value = "Something" }
|
|
}
|
|
}
|
|
}
|
|
});
|
|
|
|
Assert.AreEqual(expectedResult, result);
|
|
}
|
|
|
|
[Test]
|
|
public async Task Can_Validate_For_All_Languages()
|
|
{
|
|
var contentType = await SetupLanguageTest();
|
|
|
|
var validationResult = await ContentValidationService.ValidatePropertiesAsync(
|
|
new ContentCreateModel
|
|
{
|
|
ContentTypeKey = contentType.Key,
|
|
Variants = [
|
|
new()
|
|
{
|
|
Name = "Test Document (EN)",
|
|
Culture = "en-US",
|
|
Properties = [
|
|
new()
|
|
{
|
|
Alias = "title",
|
|
Value = "Invalid value in English",
|
|
}
|
|
]
|
|
},
|
|
new()
|
|
{
|
|
Name = "Test Document (DA)",
|
|
Culture = "da-DK",
|
|
Properties = [
|
|
new()
|
|
{
|
|
Alias = "title",
|
|
Value = "Invalid value in Danish",
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
contentType);
|
|
|
|
Assert.AreEqual(2, validationResult.ValidationErrors.Count());
|
|
Assert.IsNotNull(validationResult.ValidationErrors.SingleOrDefault(r => r.Alias == "title" && r.Culture == "en-US" && r.JsonPath == string.Empty));
|
|
Assert.IsNotNull(validationResult.ValidationErrors.SingleOrDefault(r => r.Alias == "title" && r.Culture == "da-DK" && r.JsonPath == string.Empty));
|
|
}
|
|
|
|
[TestCase("da-DK")]
|
|
[TestCase("en-US")]
|
|
public async Task Can_Validate_For_Specific_Language(string culture)
|
|
{
|
|
var contentType = await SetupLanguageTest();
|
|
|
|
var validationResult = await ContentValidationService.ValidatePropertiesAsync(
|
|
new ContentCreateModel
|
|
{
|
|
ContentTypeKey = contentType.Key,
|
|
Variants = [
|
|
new()
|
|
{
|
|
Name = "Test Document (EN)",
|
|
Culture = "en-US",
|
|
Properties = [
|
|
new()
|
|
{
|
|
Alias = "title",
|
|
Value = "Invalid value in English",
|
|
}
|
|
]
|
|
},
|
|
new()
|
|
{
|
|
Name = "Test Document (DA)",
|
|
Culture = "da-DK",
|
|
Properties = [
|
|
new()
|
|
{
|
|
Alias = "title",
|
|
Value = "Invalid value in Danish",
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
contentType,
|
|
[culture]);
|
|
|
|
Assert.AreEqual(1, validationResult.ValidationErrors.Count());
|
|
Assert.IsNotNull(validationResult.ValidationErrors.SingleOrDefault(r => r.Alias == "title" && r.Culture == culture && r.JsonPath == string.Empty));
|
|
}
|
|
|
|
private async Task<(IContentType DocumentType, IContentType ElementType)> SetupBlockListTest()
|
|
{
|
|
var propertyEditorCollection = GetRequiredService<PropertyEditorCollection>();
|
|
if (propertyEditorCollection.TryGet(Constants.PropertyEditors.Aliases.BlockList, out IDataEditor dataEditor) is false)
|
|
{
|
|
Assert.Fail("Could not get the Block List data editor");
|
|
}
|
|
|
|
var elementType = new ContentType(ShortStringHelper, Constants.System.Root)
|
|
{
|
|
Name = "Test Element Type", Alias = "testElementType", IsElement = true
|
|
};
|
|
await ContentTypeService.SaveAsync(elementType, Constants.Security.SuperUserKey);
|
|
Assert.IsTrue(elementType.HasIdentity, "Could not create the element type");
|
|
|
|
var configurationEditorJsonSerializer = GetRequiredService<IConfigurationEditorJsonSerializer>();
|
|
IDataType blockListDataType = new DataType(dataEditor, configurationEditorJsonSerializer)
|
|
{
|
|
Name = "Test Block List",
|
|
ParentId = Constants.System.Root,
|
|
DatabaseType = ValueTypes.ToStorageType(dataEditor.GetValueEditor().ValueType),
|
|
ConfigurationData = new Dictionary<string, object>
|
|
{
|
|
{
|
|
nameof(BlockListConfiguration.Blocks).ToFirstLowerInvariant(),
|
|
new[]
|
|
{
|
|
new BlockListConfiguration
|
|
{
|
|
Blocks = new[]
|
|
{
|
|
new BlockListConfiguration.BlockConfiguration
|
|
{
|
|
ContentElementTypeKey = elementType.Key,
|
|
SettingsElementTypeKey = elementType.Key
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
};
|
|
|
|
var dataTypeService = GetRequiredService<IDataTypeService>();
|
|
var dataTypeCreateResult = await dataTypeService.CreateAsync(blockListDataType, Constants.Security.SuperUserKey);
|
|
Assert.IsTrue(dataTypeCreateResult.Success, "Could not create the block list data type");
|
|
|
|
blockListDataType = dataTypeCreateResult.Result;
|
|
|
|
// add the block list and a regex validated text box to the element type
|
|
elementType.AddPropertyType(new PropertyType(ShortStringHelper, blockListDataType, "blocks"));
|
|
var textBoxDataType = await dataTypeService.GetAsync("Textstring");
|
|
Assert.IsNotNull(textBoxDataType, "Could not get the default TextBox data type");
|
|
elementType.AddPropertyType(new PropertyType(ShortStringHelper, textBoxDataType, "title")
|
|
{
|
|
ValidationRegExp = "^Valid.*$"
|
|
});
|
|
elementType.AddPropertyType(new PropertyType(ShortStringHelper, textBoxDataType, "text")
|
|
{
|
|
ValidationRegExp = "^Valid.*$"
|
|
});
|
|
await ContentTypeService.SaveAsync(elementType, Constants.Security.SuperUserKey);
|
|
|
|
// create a document type with the block list and a regex validated text box
|
|
var documentType = new ContentType(ShortStringHelper, Constants.System.Root)
|
|
{
|
|
Name = "Test Document Type", Alias = "testDocumentType", IsElement = false, AllowedAsRoot = true
|
|
};
|
|
documentType.AddPropertyType(new PropertyType(ShortStringHelper, blockListDataType, "blocks"));
|
|
await ContentTypeService.SaveAsync(documentType, Constants.Security.SuperUserKey);
|
|
Assert.IsTrue(documentType.HasIdentity, "Could not create the document type");
|
|
|
|
return (documentType, elementType);
|
|
}
|
|
|
|
private IContentType SetupSimpleTest()
|
|
{
|
|
var contentType = ContentTypeBuilder.CreateSimpleContentType("umbMandatory", "Mandatory Doc Type");
|
|
contentType.PropertyTypes.First(pt => pt.Alias == "title").Mandatory = true;
|
|
contentType.PropertyTypes.First(pt => pt.Alias == "author").ValidationRegExp = "^Valid.*$";
|
|
contentType.AllowedAsRoot = true;
|
|
ContentTypeService.Save(contentType);
|
|
|
|
return contentType;
|
|
}
|
|
|
|
private async Task<IContentType> SetupLanguageTest()
|
|
{
|
|
var language = new LanguageBuilder()
|
|
.WithCultureInfo("da-DK")
|
|
.Build();
|
|
await LanguageService.CreateAsync(language, Constants.Security.SuperUserKey);
|
|
|
|
var contentType = ContentTypeBuilder.CreateSimpleContentType("umbMandatory", "Mandatory Doc Type");
|
|
contentType.Variations = ContentVariation.Culture;
|
|
var titlePropertyType = contentType.PropertyTypes.First(pt => pt.Alias == "title");
|
|
titlePropertyType.Variations = ContentVariation.Culture;
|
|
titlePropertyType.ValidationRegExp = "^Valid.*$";
|
|
contentType.AllowedAsRoot = true;
|
|
await ContentTypeService.CreateAsync(contentType, Constants.Security.SuperUserKey);
|
|
|
|
return contentType;
|
|
}
|
|
}
|