3d8707e536
* fix: split attribute regex into two to be able to ignore the order of attributes * the regex should not care for the ending of the tag * test: adds test cases to test order of attributes * remove image sources using new regex * adds more documentation * adds test cases to test removal of source with and without parameters * test for null value * test: adds more cases for null and reversed parameters
227 lines
9.9 KiB
C#
227 lines
9.9 KiB
C#
// Copyright (c) Umbraco.
|
|
// See LICENSE for more details.
|
|
|
|
using System.Diagnostics;
|
|
using System.Linq;
|
|
using Microsoft.Extensions.Options;
|
|
using Moq;
|
|
using NUnit.Framework;
|
|
using Umbraco.Cms.Core;
|
|
using Umbraco.Cms.Core.Configuration.Models;
|
|
using Umbraco.Cms.Core.Models;
|
|
using Umbraco.Cms.Core.Models.PublishedContent;
|
|
using Umbraco.Cms.Core.PublishedCache;
|
|
using Umbraco.Cms.Core.Routing;
|
|
using Umbraco.Cms.Core.Services.Navigation;
|
|
using Umbraco.Cms.Core.Templates;
|
|
using Umbraco.Cms.Tests.Common;
|
|
using Umbraco.Cms.Tests.UnitTests.TestHelpers.Objects;
|
|
|
|
namespace Umbraco.Cms.Tests.UnitTests.Umbraco.Core.Templates;
|
|
|
|
[TestFixture]
|
|
public class HtmlImageSourceParserTests
|
|
{
|
|
[Test]
|
|
public void Returns_Udis_From_Data_Udi_Html_Attributes()
|
|
{
|
|
var input = @"<p>
|
|
<div>
|
|
<img src='/media/12312.jpg' data-udi='umb://media/D4B18427A1544721B09AC7692F35C264' />
|
|
</div>
|
|
</p><p><img src='/media/234234.jpg' data-udi=""umb://media-type/B726D735E4C446D58F703F3FBCFC97A5"" /></p>";
|
|
|
|
var imageSourceParser = new HtmlImageSourceParser(Mock.Of<IPublishedUrlProvider>());
|
|
|
|
var result = imageSourceParser.FindUdisFromDataAttributes(input).ToList();
|
|
Assert.AreEqual(2, result.Count);
|
|
Assert.AreEqual(UdiParser.Parse("umb://media/D4B18427A1544721B09AC7692F35C264"), result[0]);
|
|
Assert.AreEqual(UdiParser.Parse("umb://media-type/B726D735E4C446D58F703F3FBCFC97A5"), result[1]);
|
|
}
|
|
|
|
[TestCase(
|
|
@"<p>
|
|
<div>
|
|
<img src=""/media/12354/test.jpg"" />
|
|
</div></p>
|
|
<p>
|
|
<div><img src=""/media/987645/test.jpg"" data-udi=""umb://media/81BB2036-034F-418B-B61F-C7160D68DCD4"" /></div>
|
|
</p>",
|
|
ExpectedResult = @"<p>
|
|
<div>
|
|
<img src=""/media/12354/test.jpg"" />
|
|
</div></p>
|
|
<p>
|
|
<div><img src="""" data-udi=""umb://media/81BB2036-034F-418B-B61F-C7160D68DCD4"" /></div>
|
|
</p>",
|
|
TestName = "Remove image source with data-udi set")]
|
|
[TestCase(
|
|
@"<img alt title=""Title"" src=""/media/12354/test.jpg?width=400&height=400&hmac=test"" data-udi=""umb://media/81BB2036-034F-418B-B61F-C7160D68DCD4"" />",
|
|
ExpectedResult = @"<img alt title=""Title"" src=""?width=400&height=400&hmac=test"" data-udi=""umb://media/81BB2036-034F-418B-B61F-C7160D68DCD4"" />",
|
|
TestName = "Remove image source but keep querystring")]
|
|
[TestCase(
|
|
@"<img alt title=""Title"" src="""" data-udi=""umb://media/81BB2036-034F-418B-B61F-C7160D68DCD4"" />",
|
|
ExpectedResult = @"<img alt title=""Title"" src="""" data-udi=""umb://media/81BB2036-034F-418B-B61F-C7160D68DCD4"" />",
|
|
TestName = "Remove image source with empty src")]
|
|
[TestCase(
|
|
@"<img src=""/media/12345/test.jpg"" />",
|
|
ExpectedResult = @"<img src=""/media/12345/test.jpg"" />",
|
|
TestName = "Do not remove image source without data-udi set")]
|
|
[Category("Remove image sources")]
|
|
public string Remove_Image_Sources(string sourceHtml)
|
|
{
|
|
var imageSourceParser = new HtmlImageSourceParser(Mock.Of<IPublishedUrlProvider>());
|
|
|
|
var actual = imageSourceParser.RemoveImageSources(sourceHtml);
|
|
|
|
return actual;
|
|
}
|
|
|
|
[Test]
|
|
public void Ensure_Image_Sources()
|
|
{
|
|
// setup a mock URL provider which we'll use for testing
|
|
var mediaType = new PublishedContentType(
|
|
Guid.NewGuid(),
|
|
777,
|
|
"image",
|
|
PublishedItemType.Media,
|
|
Enumerable.Empty<string>(),
|
|
Enumerable.Empty<PublishedPropertyType>(),
|
|
ContentVariation.Nothing);
|
|
var media = new Mock<IPublishedContent>();
|
|
media.Setup(x => x.ContentType).Returns(mediaType);
|
|
var mediaUrlProvider = new Mock<IMediaUrlProvider>();
|
|
mediaUrlProvider.Setup(x => x.GetMediaUrl(
|
|
It.IsAny<IPublishedContent>(),
|
|
It.IsAny<string>(),
|
|
It.IsAny<UrlMode>(),
|
|
It.IsAny<string>(),
|
|
It.IsAny<Uri>()))
|
|
.Returns(UrlInfo.Url("/media/1001/my-image.jpg"));
|
|
|
|
var umbracoContextAccessor = new TestUmbracoContextAccessor();
|
|
|
|
var umbracoContextFactory = TestUmbracoContextFactory.Create(
|
|
umbracoContextAccessor: umbracoContextAccessor);
|
|
|
|
var webRoutingSettings = new WebRoutingSettings();
|
|
var publishedUrlProvider = new UrlProvider(
|
|
umbracoContextAccessor,
|
|
Options.Create(webRoutingSettings),
|
|
new UrlProviderCollection(() => Enumerable.Empty<IUrlProvider>()),
|
|
new MediaUrlProviderCollection(() => new[] { mediaUrlProvider.Object }),
|
|
Mock.Of<IVariationContextAccessor>(),
|
|
Mock.Of<IDocumentNavigationQueryService>(),
|
|
Mock.Of<IPublishedContentStatusFilteringService>());
|
|
|
|
using (var reference = umbracoContextFactory.EnsureUmbracoContext())
|
|
{
|
|
var mediaCache = Mock.Get(reference.UmbracoContext.Media);
|
|
mediaCache.Setup(x => x.GetById(It.IsAny<Guid>())).Returns(media.Object);
|
|
|
|
var imageSourceParser = new HtmlImageSourceParser(publishedUrlProvider);
|
|
|
|
var result = imageSourceParser.EnsureImageSources(@"<p>
|
|
<div>
|
|
<img src="""" />
|
|
</div></p>
|
|
<p>
|
|
<div><img src="""" data-udi=""umb://media/81BB2036-034F-418B-B61F-C7160D68DCD4"" /></div>
|
|
</p>
|
|
<p>
|
|
<div><img src=""?width=100"" data-udi=""umb://media/81BB2036-034F-418B-B61F-C7160D68DCD4"" /></div>
|
|
</p>");
|
|
|
|
Assert.AreEqual(
|
|
@"<p>
|
|
<div>
|
|
<img src="""" />
|
|
</div></p>
|
|
<p>
|
|
<div><img src=""/media/1001/my-image.jpg"" data-udi=""umb://media/81BB2036-034F-418B-B61F-C7160D68DCD4"" /></div>
|
|
</p>
|
|
<p>
|
|
<div><img src=""/media/1001/my-image.jpg?width=100"" data-udi=""umb://media/81BB2036-034F-418B-B61F-C7160D68DCD4"" /></div>
|
|
</p>",
|
|
result);
|
|
}
|
|
}
|
|
|
|
[TestCase(
|
|
@"<div><img src="""" /></div>",
|
|
ExpectedResult = @"<div><img src="""" /></div>",
|
|
TestName = "Empty source is not updated with no data-udi set")]
|
|
[TestCase(
|
|
@"<div><img src="""" data-udi=""umb://media/81BB2036034F418BB61FC7160D68DCD4""/></div>",
|
|
ExpectedResult = @"<div><img src=""/media/1001/image.jpg"" data-udi=""umb://media/81BB2036034F418BB61FC7160D68DCD4""/></div>",
|
|
TestName = "Empty source is updated with data-udi set")]
|
|
[TestCase(
|
|
@"<div><img src=""non empty src"" data-udi=""umb://media/81BB2036034F418BB61FC7160D68DCD4""/></div>",
|
|
ExpectedResult = @"<div><img src=""/media/1001/image.jpg"" data-udi=""umb://media/81BB2036034F418BB61FC7160D68DCD4""/></div>",
|
|
TestName = "Filled source is overwritten with data-udi set")]
|
|
[TestCase(
|
|
@"<div><img alt title=""Test"" data-udi=""umb://media/81BB2036034F418BB61FC7160D68DCD4"" src=""non empty src"" /></div>",
|
|
ExpectedResult = @"<div><img alt title=""Test"" data-udi=""umb://media/81BB2036034F418BB61FC7160D68DCD4"" src=""/media/1001/image.jpg"" /></div>",
|
|
TestName = "Order of attributes does not matter")]
|
|
[TestCase(
|
|
@"<div><img src=""some src"" some-attribute data-udi=""umb://media/81BB2036034F418BB61FC7160D68DCD4"" another-attribute/></div>",
|
|
ExpectedResult = @"<div><img src=""/media/1001/image.jpg"" some-attribute data-udi=""umb://media/81BB2036034F418BB61FC7160D68DCD4"" another-attribute/></div>",
|
|
TestName = "Attributes are persisted")]
|
|
[TestCase(
|
|
@"<div><img src=""somesrc?width=100&height=500"" data-udi=""umb://media/81BB2036034F418BB61FC7160D68DCD4""/></div>",
|
|
ExpectedResult = @"<div><img src=""/media/1001/image.jpg?width=100&height=500"" data-udi=""umb://media/81BB2036034F418BB61FC7160D68DCD4""/></div>",
|
|
TestName = "Source is trimmed and parameters are prefixed")]
|
|
[TestCase(
|
|
@"<div><img src=""?width=100&height=500"" data-udi=""umb://media/81BB2036034F418BB61FC7160D68DCD4""/></div>",
|
|
ExpectedResult = @"<div><img src=""/media/1001/image.jpg?width=100&height=500"" data-udi=""umb://media/81BB2036034F418BB61FC7160D68DCD4""/></div>",
|
|
TestName = "Parameters are prefixed")]
|
|
[TestCase(
|
|
@"<div><img data-udi=""umb://media/81BB2036034F418BB61FC7160D68DCD4"" src=""?width=100&height=500"" /></div>",
|
|
ExpectedResult = @"<div><img data-udi=""umb://media/81BB2036034F418BB61FC7160D68DCD4"" src=""/media/1001/image.jpg?width=100&height=500"" /></div>",
|
|
TestName = "Parameters are prefixed (order of attributes reversed)")]
|
|
[TestCase(
|
|
@"<div>
|
|
<img src="""" data-udi=""umb://media/81BB2036034F418BB61FC7160D68DCD4""/>
|
|
<img src=""src"" data-udi=""umb://media/81BB2036034F418BB61FC7160D68DCD5""/>
|
|
<img src=""?asd"" data-udi=""umb://media/81BB2036034F418BB61FC7160D68DCD6""/>
|
|
</div>",
|
|
ExpectedResult =
|
|
@"<div>
|
|
<img src=""/media/1001/image.jpg"" data-udi=""umb://media/81BB2036034F418BB61FC7160D68DCD4""/>
|
|
<img src=""/media/1001/image.jpg"" data-udi=""umb://media/81BB2036034F418BB61FC7160D68DCD5""/>
|
|
<img src=""/media/1001/image.jpg?asd"" data-udi=""umb://media/81BB2036034F418BB61FC7160D68DCD6""/>
|
|
</div>",
|
|
TestName = "Multiple img tags are handled")]
|
|
[Category("Ensure image sources")]
|
|
public string Ensure_ImageSources_Processing(string sourceHtml)
|
|
{
|
|
var fakeMediaUrl = "/media/1001/image.jpg";
|
|
var parser = new HtmlImageSourceParser(guid => fakeMediaUrl);
|
|
var actual = parser.EnsureImageSources(sourceHtml);
|
|
|
|
return actual;
|
|
}
|
|
|
|
[Category("Ensure image sources")]
|
|
[Test]
|
|
public void Ensure_Large_Html_Is_Processed_Quickly()
|
|
{
|
|
var symbolCount = 25000;
|
|
var maxMsToRun = 200;
|
|
|
|
var longText = new string('*', symbolCount);
|
|
var text = $@"<img src=""{longText}"" />";
|
|
|
|
var fakeMediaUrl = "/media/1001/image.jpg";
|
|
var parser = new HtmlImageSourceParser(guid => fakeMediaUrl);
|
|
|
|
var timer = new Stopwatch();
|
|
timer.Start();
|
|
parser.EnsureImageSources(text);
|
|
timer.Stop();
|
|
|
|
Assert.IsTrue(timer.ElapsedMilliseconds <= maxMsToRun);
|
|
}
|
|
}
|