Files
Umbraco-CMS/tests/Umbraco.Tests.UnitTests/Umbraco.Core/DeliveryApi/MediaPickerWithCropsValueConverterTests.cs
Andy Butland 44aa5dcf1c Provides an abstraction for creating the JavaScriptEncoder used in SystemTextConfigurationEditorJsonSerializer (#19849)
* Provides an abstraction for creating the JavaScriptEncoder used in SystemTextConfigurationEditorJsonSerializer.

* Generalised JSON serialization encoder factory to work for all System.Tex.Json serializers.
Added the serializer's name as a parameter to allow for different encodings per serializer if required.

* Fixed tests by removing use of obsolete constructors.

* Removed name parameter and used a generic type instead.
2025-08-07 09:08:09 +02:00

406 lines
18 KiB
C#

using Moq;
using NUnit.Framework;
using Umbraco.Cms.Core;
using Umbraco.Cms.Core.DeliveryApi;
using Umbraco.Cms.Core.Models.DeliveryApi;
using Umbraco.Cms.Core.Models.PublishedContent;
using Umbraco.Cms.Core.PropertyEditors;
using Umbraco.Cms.Core.PropertyEditors.ValueConverters;
using Umbraco.Cms.Infrastructure.DeliveryApi;
using Umbraco.Cms.Infrastructure.Serialization;
namespace Umbraco.Cms.Tests.UnitTests.Umbraco.Core.DeliveryApi;
[TestFixture]
public class MediaPickerWithCropsValueConverterTests : PropertyValueConverterTests
{
private MediaPickerWithCropsValueConverter MediaPickerWithCropsValueConverter()
{
var serializer = new SystemTextJsonSerializer(new DefaultJsonSerializerEncoderFactory());
var publishedValueFallback = Mock.Of<IPublishedValueFallback>();
var apiUrlProvider = new ApiMediaUrlProvider(PublishedUrlProvider);
var apiMediaWithCropsBuilder = new ApiMediaWithCropsBuilder(
new ApiMediaBuilder(
new ApiContentNameProvider(),
apiUrlProvider,
publishedValueFallback,
CreateOutputExpansionStrategyAccessor()),
publishedValueFallback);
return new MediaPickerWithCropsValueConverter(
CacheManager.Media,
PublishedUrlProvider,
publishedValueFallback,
serializer,
apiMediaWithCropsBuilder);
}
[Test]
public void MediaPickerWithCropsValueConverter_InSingleMode_ConvertsValueToCollectionOfApiMedia()
{
var publishedPropertyType = SetupMediaPropertyType(false);
var mediaKey = SetupMedia("My media", ".jpg", 200, 400, "My alt text", 800);
var serializer = new SystemTextJsonSerializer(new DefaultJsonSerializerEncoderFactory());
var valueConverter = MediaPickerWithCropsValueConverter();
Assert.AreEqual(typeof(IEnumerable<IApiMediaWithCrops>), valueConverter.GetDeliveryApiPropertyValueType(publishedPropertyType));
var inter = serializer.Serialize(new[]
{
new MediaPicker3PropertyEditor.MediaPicker3PropertyValueEditor.MediaWithCropsDto
{
Key = Guid.NewGuid(),
MediaKey = mediaKey,
Crops = new []
{
new ImageCropperValue.ImageCropperCrop
{
Alias = "one",
Coordinates = new ImageCropperValue.ImageCropperCropCoordinates { X1 = 1m, X2 = 2m, Y1 = 10m, Y2 = 20m }
}
},
FocalPoint = new ImageCropperValue.ImageCropperFocalPoint { Left = .2m, Top = .4m }
}
});
var result = valueConverter.ConvertIntermediateToDeliveryApiObject(Mock.Of<IPublishedElement>(), publishedPropertyType, PropertyCacheLevel.Element, inter, false, false) as IEnumerable<IApiMediaWithCrops>;
Assert.NotNull(result);
Assert.AreEqual(1, result.Count());
var first = result.Single();
ValidateMedia(first, "My media", "my-media", ".jpg", 200, 400, 800);
ValidateFocalPoint(first.FocalPoint, .2m, .4m);
Assert.NotNull(first.Crops);
Assert.AreEqual(1, first.Crops.Count());
ValidateCrop(first.Crops.First(), "one", 200, 100, 1m, 2m, 10m, 20m);
Assert.NotNull(first.Properties);
Assert.AreEqual(1, first.Properties.Count);
Assert.AreEqual("My alt text", first.Properties["altText"]);
}
[Test]
public void MediaPickerWithCropsValueConverter_InMultiMode_ConvertsValueToMedias()
{
var publishedPropertyType = SetupMediaPropertyType(true);
var mediaKey1 = SetupMedia("My media", ".jpg", 200, 400, "My alt text", 800);
var mediaKey2 = SetupMedia("My other media", ".png", 800, 600, "My other alt text", 200);
var serializer = new SystemTextJsonSerializer(new DefaultJsonSerializerEncoderFactory());
var valueConverter = MediaPickerWithCropsValueConverter();
Assert.AreEqual(typeof(IEnumerable<IApiMediaWithCrops>), valueConverter.GetDeliveryApiPropertyValueType(publishedPropertyType));
var inter = serializer.Serialize(new[]
{
new MediaPicker3PropertyEditor.MediaPicker3PropertyValueEditor.MediaWithCropsDto
{
Key = Guid.NewGuid(),
MediaKey = mediaKey1,
Crops = new []
{
new ImageCropperValue.ImageCropperCrop
{
Alias = "one",
Coordinates = new ImageCropperValue.ImageCropperCropCoordinates { X1 = 1m, X2 = 2m, Y1 = 10m, Y2 = 20m }
}
},
FocalPoint = new ImageCropperValue.ImageCropperFocalPoint { Left = .2m, Top = .4m }
},
new MediaPicker3PropertyEditor.MediaPicker3PropertyValueEditor.MediaWithCropsDto
{
Key = Guid.NewGuid(),
MediaKey = mediaKey2,
Crops = new []
{
new ImageCropperValue.ImageCropperCrop
{
Alias = "one",
Coordinates = new ImageCropperValue.ImageCropperCropCoordinates { X1 = 40m, X2 = 20m, Y1 = 2m, Y2 = 1m }
}
},
FocalPoint = new ImageCropperValue.ImageCropperFocalPoint { Left = .8m, Top = .6m }
}
});
var result = valueConverter.ConvertIntermediateToDeliveryApiObject(Mock.Of<IPublishedElement>(), publishedPropertyType, PropertyCacheLevel.Element, inter, false, false) as IEnumerable<IApiMediaWithCrops>;
Assert.NotNull(result);
Assert.AreEqual(2, result.Count());
var first = result.First();
var last = result.Last();
ValidateMedia(first, "My media", "my-media", ".jpg", 200, 400, 800);
ValidateFocalPoint(first.FocalPoint, .2m, .4m);
Assert.NotNull(first.Crops);
Assert.AreEqual(1, first.Crops.Count());
ValidateCrop(first.Crops.First(), "one", 200, 100, 1m, 2m, 10m, 20m);
Assert.NotNull(first.Properties);
Assert.AreEqual(1, first.Properties.Count);
Assert.AreEqual("My alt text", first.Properties["altText"]);
ValidateMedia(last, "My other media", "my-other-media", ".png", 800, 600, 200);
ValidateFocalPoint(last.FocalPoint, .8m, .6m);
Assert.NotNull(last.Crops);
Assert.AreEqual(1, last.Crops.Count());
ValidateCrop(last.Crops.First(), "one", 200, 100, 40m, 20m, 2m, 1m);
Assert.NotNull(last.Properties);
Assert.AreEqual(1, last.Properties.Count);
Assert.AreEqual("My other alt text", last.Properties["altText"]);
}
[Test]
public void MediaPickerWithCropsValueConverter_MergesMediaCropsWithLocalCrops()
{
var publishedPropertyType = SetupMediaPropertyType(false);
var mediaCrops = new ImageCropperValue
{
Crops = new[]
{
new ImageCropperValue.ImageCropperCrop
{
Alias = "mediaOne",
Width = 111,
Height = 222,
Coordinates = new ImageCropperValue.ImageCropperCropCoordinates { X1 = 2m, X2 = 4m, Y1 = 20m, Y2 = 40m }
}
},
FocalPoint = new ImageCropperValue.ImageCropperFocalPoint { Left = .9m, Top = .1m }
};
var mediaKey = SetupMedia("Some media", ".123", 123, 456, "My alt text", 789, mediaCrops);
var serializer = new SystemTextJsonSerializer(new DefaultJsonSerializerEncoderFactory());
var valueConverter = MediaPickerWithCropsValueConverter();
Assert.AreEqual(typeof(IEnumerable<IApiMediaWithCrops>), valueConverter.GetDeliveryApiPropertyValueType(publishedPropertyType));
var inter = serializer.Serialize(new[]
{
new MediaPicker3PropertyEditor.MediaPicker3PropertyValueEditor.MediaWithCropsDto
{
Key = Guid.NewGuid(),
MediaKey = mediaKey,
Crops = new []
{
new ImageCropperValue.ImageCropperCrop
{
Alias = "one",
Coordinates = new ImageCropperValue.ImageCropperCropCoordinates { X1 = 1m, X2 = 2m, Y1 = 10m, Y2 = 20m }
}
}
}
});
var result = valueConverter.ConvertIntermediateToDeliveryApiObject(Mock.Of<IPublishedElement>(), publishedPropertyType, PropertyCacheLevel.Element, inter, false, false) as IEnumerable<IApiMediaWithCrops>;
Assert.NotNull(result);
Assert.AreEqual(1, result.Count());
var mediaWithCrops = result.Single();
ValidateMedia(mediaWithCrops, "Some media", "some-media", ".123", 123, 456, 789);
// no local focal point, should revert to media focal point
ValidateFocalPoint(mediaWithCrops.FocalPoint, .9m, .1m);
// media crops should be merged with local crops
Assert.NotNull(mediaWithCrops.Crops);
Assert.AreEqual(2, mediaWithCrops.Crops.Count());
// local crops should be first, media crops should be last
ValidateCrop(mediaWithCrops.Crops.First(), "one", 200, 100, 1m, 2m, 10m, 20m);
ValidateCrop(mediaWithCrops.Crops.Last(), "mediaOne", 111, 222, 2m, 4m, 20m, 40m);
}
[Test]
public void MediaPickerWithCropsValueConverter_LocalCropsAndFocalPointTakesPrecedenceOverMediaCropsAndFocalPoint()
{
var publishedPropertyType = SetupMediaPropertyType(false);
var mediaCrops = new ImageCropperValue
{
Crops = new[]
{
new ImageCropperValue.ImageCropperCrop
{
Alias = "one",
Width = 111,
Height = 222,
Coordinates = new ImageCropperValue.ImageCropperCropCoordinates { X1 = 2m, X2 = 4m, Y1 = 20m, Y2 = 40m }
}
},
FocalPoint = new ImageCropperValue.ImageCropperFocalPoint { Left = .9m, Top = .1m }
};
var mediaKey = SetupMedia("Some media", ".123", 123, 456, "My alt text", 789, mediaCrops);
var serializer = new SystemTextJsonSerializer(new DefaultJsonSerializerEncoderFactory());
var valueConverter = MediaPickerWithCropsValueConverter();
Assert.AreEqual(typeof(IEnumerable<IApiMediaWithCrops>), valueConverter.GetDeliveryApiPropertyValueType(publishedPropertyType));
var inter = serializer.Serialize(new[]
{
new MediaPicker3PropertyEditor.MediaPicker3PropertyValueEditor.MediaWithCropsDto
{
Key = Guid.NewGuid(),
MediaKey = mediaKey,
Crops = new []
{
new ImageCropperValue.ImageCropperCrop
{
Alias = "one",
Coordinates = new ImageCropperValue.ImageCropperCropCoordinates { X1 = 1m, X2 = 2m, Y1 = 10m, Y2 = 20m }
}
},
FocalPoint = new ImageCropperValue.ImageCropperFocalPoint { Left = .2m, Top = .3m }
}
});
var result = valueConverter.ConvertIntermediateToDeliveryApiObject(Mock.Of<IPublishedElement>(), publishedPropertyType, PropertyCacheLevel.Element, inter, false, false) as IEnumerable<IApiMediaWithCrops>;
Assert.NotNull(result);
Assert.AreEqual(1, result.Count());
var mediaWithCrops = result.Single();
ValidateMedia(mediaWithCrops, "Some media", "some-media", ".123", 123, 456, 789);
// local focal point should take precedence over media focal point
ValidateFocalPoint(mediaWithCrops.FocalPoint, .2m, .3m);
// media crops should be discarded when merging with local crops (matching aliases, local ones take precedence)
Assert.NotNull(mediaWithCrops.Crops);
Assert.AreEqual(1, mediaWithCrops.Crops.Count());
// local crops should be first, media crops should be last
ValidateCrop(mediaWithCrops.Crops.First(), "one", 200, 100, 1m, 2m, 10m, 20m);
}
[TestCase("")]
[TestCase(null)]
[TestCase(123)]
[TestCase("123")]
public void MediaPickerWithCropsValueConverter_InSingleMode_ConvertsInvalidValueToEmptyCollection(object inter)
{
var publishedPropertyType = SetupMediaPropertyType(false);
var valueConverter = MediaPickerWithCropsValueConverter();
var result = valueConverter.ConvertIntermediateToDeliveryApiObject(Mock.Of<IPublishedElement>(), publishedPropertyType, PropertyCacheLevel.Element, inter, false, false) as IEnumerable<IApiMediaWithCrops>;
Assert.NotNull(result);
Assert.IsEmpty(result);
}
[TestCase("")]
[TestCase(null)]
[TestCase(123)]
[TestCase("123")]
public void MediaPickerWithCropsValueConverter_InMultiMode_ConvertsInvalidValueToEmptyCollection(object inter)
{
var publishedPropertyType = SetupMediaPropertyType(true);
var valueConverter = MediaPickerWithCropsValueConverter();
var result = valueConverter.ConvertIntermediateToDeliveryApiObject(Mock.Of<IPublishedElement>(), publishedPropertyType, PropertyCacheLevel.Element, inter, false, false) as IEnumerable<IApiMediaWithCrops>;
Assert.NotNull(result);
Assert.IsEmpty(result);
}
private IPublishedPropertyType SetupMediaPropertyType(bool multiSelect)
{
var publishedDataType = new PublishedDataType(123, "test", "test", new Lazy<object>(() => new MediaPicker3Configuration
{
Multiple = multiSelect,
EnableLocalFocalPoint = true,
Crops = new MediaPicker3Configuration.CropConfiguration[]
{
new MediaPicker3Configuration.CropConfiguration
{
Alias = "one", Width = 200, Height = 100
}
}
}));
var publishedPropertyType = new Mock<IPublishedPropertyType>();
publishedPropertyType.SetupGet(p => p.DataType).Returns(publishedDataType);
return publishedPropertyType.Object;
}
private Guid SetupMedia(string name, string extension, int width, int height, string altText, int bytes, ImageCropperValue? imageCropperValue = null)
{
var publishedMediaType = new Mock<IPublishedContentType>();
publishedMediaType.SetupGet(c => c.ItemType).Returns(PublishedItemType.Media);
var mediaKey = Guid.NewGuid();
var media = SetupPublishedContent(name, mediaKey, PublishedItemType.Media, publishedMediaType.Object);
var mediaProperties = new List<IPublishedProperty>();
media.SetupGet(m => m.Properties).Returns(mediaProperties);
void AddProperty(string alias, object value)
{
var property = new Mock<IPublishedProperty>();
property.SetupGet(p => p.Alias).Returns(alias);
property.Setup(p => p.HasValue(It.IsAny<string?>(), It.IsAny<string?>())).Returns(true);
property.Setup(p => p.GetValue(It.IsAny<string?>(), It.IsAny<string?>())).Returns(value);
property.Setup(p => p.GetDeliveryApiValue(It.IsAny<bool>(), It.IsAny<string?>(), It.IsAny<string?>())).Returns(value);
media.Setup(m => m.GetProperty(alias)).Returns(property.Object);
mediaProperties.Add(property.Object);
}
AddProperty(Constants.Conventions.Media.Extension, extension);
AddProperty(Constants.Conventions.Media.Width, width);
AddProperty(Constants.Conventions.Media.Height, height);
AddProperty(Constants.Conventions.Media.Bytes, bytes);
AddProperty(Constants.Conventions.Media.File, imageCropperValue);
AddProperty("altText", altText);
PublishedMediaCacheMock
.Setup(pcc => pcc.GetById(mediaKey))
.Returns(media.Object);
PublishedMediaCacheMock
.Setup(pcc => pcc.GetById(It.IsAny<bool>(), mediaKey))
.Returns(media.Object);
PublishedUrlProviderMock
.Setup(p => p.GetMediaUrl(media.Object, It.IsAny<UrlMode>(), It.IsAny<string?>(), It.IsAny<string?>(), It.IsAny<Uri?>()))
.Returns(name.ToLowerInvariant().Replace(" ", "-"));
return mediaKey;
}
private void ValidateMedia(
IApiMediaWithCrops actual,
string expectedName,
string expectedUrl,
string expectedExtension,
int expectedWidth,
int expectedHeight,
int expectedBytes)
{
Assert.AreEqual(expectedName, actual.Name);
Assert.AreEqual(expectedUrl, actual.Url);
Assert.AreEqual(expectedExtension, actual.Extension);
Assert.AreEqual(expectedWidth, actual.Width);
Assert.AreEqual(expectedHeight, actual.Height);
Assert.AreEqual(expectedBytes, actual.Bytes);
}
private void ValidateFocalPoint(ImageFocalPoint? actual, decimal expectedLeft, decimal expectedTop)
{
Assert.NotNull(actual);
Assert.AreEqual(expectedLeft, actual.Left);
Assert.AreEqual(expectedTop, actual.Top);
}
private void ValidateCrop(
ImageCrop actual,
string expectedAlias,
int expectedWidth,
int expectedHeight,
decimal expectedX1,
decimal expectedX2,
decimal expectedY1,
decimal expectedY2)
{
Assert.AreEqual(expectedAlias, actual.Alias);
Assert.AreEqual(expectedWidth, actual.Width);
Assert.AreEqual(expectedHeight, actual.Height);
Assert.NotNull(actual.Coordinates);
Assert.AreEqual(expectedX1, actual.Coordinates.X1);
Assert.AreEqual(expectedX2, actual.Coordinates.X2);
Assert.AreEqual(expectedY1, actual.Coordinates.Y1);
Assert.AreEqual(expectedY2, actual.Coordinates.Y2);
}
}