Files
Umbraco-CMS/tests/Umbraco.Tests.Integration/Umbraco.Infrastructure/Services/ContentServicePublishBranchTests.cs
Andy Butland 825f791d01 Remove the non-controversial, straightforward obsoleted constructs for Umbraco 16 (#18661)
* Removed obsoletes from IConfigManipulator.

* Removed obsolete models builder extensions.

* Removed the obsolete ContentDashboardSettings.

* Removed the obsolete InstallMissingDatabase setting on GlobalSettings.

* Removed obsolete NuCache settings.

* Removed obsolete RuntimeMinificationSettings.

* Removed obsolete health check constant.

* Removed obsolete icon constant.

* Removed obsolete telemetry constant.

* Removed obsolete property and constructor on UmbracoBuilder.

* Removed obsolete constructor on AuditNotificationsHandler.

* Removed obsolete constructor on HTTP header health checks.

* Removed obsolete constructor on MediaFileManager.

* Removed obsolete GetDefaultFileContent on ViewHelper.

* Remove obsoleted methods on embed providers.

* Fix tests.

* Removed obsolete constructors on BlockEditorDataConverter.

* Removed obsolete SeedCacheDuration property on CacheSettings.

* Removed obsolete PublishCulture on ContentRepositoryExtensions.

* Removed obsolete MonitorLock.

* Removed obsolete synchronous HasSavedValues from IDataTypeUsageService and IDataTypeUsageRepository.

* Removed obsolete HasSavedPropertyValues from IPropertyTypeUsageService and IPropertyTypeUsageRepository.

* Removed obsolete methods in ITrackedReferencesService and ITrackedReferencesRepository.

* Removed obsolete DateValueEditor constructors.

* Removed obsolete GetAutomaticRelationTypesAliases.

* Removed obsolete constructor on TextOnlyValueEditor.

* Removed obsolete constructors on RegexValidator and RequiredValidator.

* Removed obsolete constructs on SliderValueConverter and TagsValueConverter.

* Removed obsolete GetContentType methods from IPublishedCache.

* Removed ContentFinderByIdPath.

* Removed obsolete constructor on DefaultMediaUrlProvider.

* Removed obsolete constructor on Domain.

* Removed obsolete constructor on PublishedRequest.

* Removed obsolete methods on CheckPermissions.

* Removed obsolete GetUserId from IBackOfficeSecurity.

* Removed obsolete methods on LegacyPasswordSecurity.

* Removed obsolete constructors on AuditService.

* Removed obsolete methods on IContentEditingService.

* Remove obsolete constructors and methods on ContentService/IContentService.

* Removed obsolete constructor in ContentTypeEditingService.

* Removed obsolete constructor in MediaTypeEditingService.

* Removed obsolete constructor in MemberTypeEditingService.

* Removed obsolete constructor in ContentTypeService.

* Removed obsolete constructors in ContentTypeServiceBase.

* Removed obsolete constructors and methods in ContentVersionService.

* Removed obsolete constructor in DataTypeUsageService.

* Removed obsolete constructor in DomainService.

* Removed obsolete constructor in FileService.

* Removes obsolete AttemptMove from IContentService.

* Removes obsolete SetPreventCleanup from IContentVersionService.

* Removes obsolete GetReferences from IDataTypeService.

* Removed obsolete SetConsentLevel from IMetricsConsentService.

* Removed obsolete methods from IPackageDataInstallation.

* Removed obsolete methods from IPackagingService.

* Removed obsolete methods on ITwoFactorLoginService.
Removed obsolete ITemporaryMediaService.

* Removed obsolete constructor from MediaService, MemberTypeService and MediaTypeService.

* More obsolete constructors.

* Removed obsoleted overloads on IPropertyValidationService.

* Fixed build for tests.

* Removed obsolete constructor for PublicAccessService, UserService and RelationService.

* Removed GetDefaultMemberType.

* Removed obsolete user group functionality from IUserService.

* Removed obsolete extension methods on IUserService.

* Removed obsolete method from ITelemetryService.

* Removed obsolete UdiParserServiceConnectors.

* Removed obsolete method on ICookieManager.

* Removed obsolete DynamicContext.

* Removed obsolete XmlHelper.

* Fixed failing integration tests.

* Removed obsoletes in Umbraco.Cms.Api.Common

* Removed obsoletes in Umbraco.Cms.Api.Delivery

* Removed obsoletes in Umbraco.Cms.Api.Management

* Removed obsoletes in Umbraco.Examine.Lucene

* Removed obsoletes in Umbraco.Infrastructure

* Fix failing delivery API contract integration test.

* Made integration tests internal.

* Removed obsoletes from web projects.

* Fix build.

* Removed Twitter OEmbed provider

* Removed obsolete constructor on PublishedDataType.

* Removed obsolete constructors on PublishedCacheBase.

* Removed the obsolete PropertyEditorTagsExtensions.

* Removed obsoletion properties on configuration response  models (#18697)

* Removed obsolete methods from server-side models.

* Update client-side types and sdk.

* Update client-side files.

* Removed obsoletion of Utf8ToAsciiConverter.ToAsciiString overload. (#18694)

* Removed obsolete method in UserService. (#18710)

* Removed obsoleted group alias keys from being publicly available. (#18682)

* Removed unneceessary ApiVersion attribute.

* Clean-up obsoletions on MemberService (#18703)

* Removed obsoleted method on MemberService, added future obsoletion to interface and updated all callers.

* Removed obsoletion on member service method that's not obsolete on the interface.
2025-03-21 17:02:31 +00:00

666 lines
28 KiB
C#

// Copyright (c) Umbraco.
// See LICENSE for more details.
using NUnit.Framework;
using Umbraco.Cms.Core;
using Umbraco.Cms.Core.Models;
using Umbraco.Cms.Core.Services;
using Umbraco.Cms.Tests.Common.Attributes;
using Umbraco.Cms.Tests.Common.Testing;
using Umbraco.Cms.Tests.Integration.Testing;
// ReSharper disable CommentTypo
// ReSharper disable StringLiteralTypo
namespace Umbraco.Cms.Tests.Integration.Umbraco.Infrastructure.Services;
[TestFixture]
[UmbracoTest(Database = UmbracoTestOptions.Database.NewSchemaPerTest, PublishedRepositoryEvents = true,
WithApplication = true)]
internal sealed class ContentServicePublishBranchTests : UmbracoIntegrationTest
{
private IContentService ContentService => GetRequiredService<IContentService>();
private ILanguageService LanguageService => GetRequiredService<ILanguageService>();
private IContentTypeService ContentTypeService => GetRequiredService<IContentTypeService>();
[TestCase(1)] // publish w/ culture: content.AvailableCultures.ToArray()
[TestCase(2)] // publish w/ cultures: new [] { "*" }
[TestCase(3)] // publish w/ cultures: Array.Empty<string>()
[LongRunning]
public void Can_Publish_Invariant_Branch(int method)
{
CreateTypes(out var iContentType, out _);
IContent iRoot = new Content("iroot", -1, iContentType);
iRoot.SetValue("ip", "iroot");
ContentService.Save(iRoot);
IContent ii1 = new Content("ii1", iRoot, iContentType);
ii1.SetValue("ip", "vii1");
ContentService.Save(ii1);
IContent ii2 = new Content("ii2", iRoot, iContentType);
ii2.SetValue("ip", "vii2");
ContentService.Save(ii2);
// iroot !published !edited
// ii1 !published !edited
// ii2 !published !edited
// PublishBranchFilter.Default = publishes those that are actually published, and have changes
// here: root (root is always published)
var r = PublishInvariantBranch(iRoot, PublishBranchFilter.Default, method).ToArray();
// not forcing, ii1 and ii2 not published yet: only root got published
AssertPublishResults(r, x => x.Content.Name, "iroot");
AssertPublishResults(r, x => x.Result, PublishResultType.SuccessPublish);
// prepare
ContentService.Publish(iRoot, iRoot.AvailableCultures.ToArray());
ContentService.Publish(ii1, ii1.AvailableCultures.ToArray());
IContent ii11 = new Content("ii11", ii1, iContentType);
ii11.SetValue("ip", "vii11");
ContentService.Save(ii11);
ContentService.Publish(ii11, ii11.AvailableCultures.ToArray());
IContent ii12 = new Content("ii12", ii1, iContentType);
ii11.SetValue("ip", "vii12");
ContentService.Save(ii12);
ContentService.Publish(ii2, ii2.AvailableCultures.ToArray());
IContent ii21 = new Content("ii21", ii2, iContentType);
ii21.SetValue("ip", "vii21");
ContentService.Save(ii21);
ContentService.Publish(ii21, ii21.AvailableCultures.ToArray());
IContent ii22 = new Content("ii22", ii2, iContentType);
ii22.SetValue("ip", "vii22");
ContentService.Save(ii22);
ContentService.Unpublish(ii2);
// iroot published !edited
// ii1 published !edited
// ii11 published !edited
// ii12 !published !edited
// ii2 !published !edited
// ii21 (published) !edited
// ii22 !published !edited
// PublishBranchFilter.Default = publishes those that are actually published, and have changes
// here: nothing
r = PublishInvariantBranch(iRoot, PublishBranchFilter.Default, method).ToArray();
// not forcing, ii12 and ii2, ii21, ii22 not published yet: only root, ii1, ii11 got published
AssertPublishResults(r, x => x.Content.Name, "iroot", "ii1", "ii11");
AssertPublishResults(
r,
x => x.Result,
PublishResultType.SuccessPublishAlready,
PublishResultType.SuccessPublishAlready,
PublishResultType.SuccessPublishAlready);
// prepare
iRoot.SetValue("ip", "changed");
ContentService.Save(iRoot);
ii11.SetValue("ip", "changed");
ContentService.Save(ii11);
// iroot published edited ***
// ii1 published !edited
// ii11 published edited ***
// ii12 !published !edited
// ii2 !published !edited
// ii21 (published) !edited
// ii22 !published !edited
// PublishBranchFilter.Default = publishes those that are actually published, and have changes
// here: iroot and ii11
// not forcing, ii12 and ii2, ii21, ii22 not published yet: only root, ii1, ii11 got published
r = PublishInvariantBranch(iRoot, PublishBranchFilter.Default, method).ToArray();
AssertPublishResults(r, x => x.Content.Name, "iroot", "ii1", "ii11");
AssertPublishResults(
r,
x => x.Result,
PublishResultType.SuccessPublish,
PublishResultType.SuccessPublishAlready,
PublishResultType.SuccessPublish);
// PublishBranchFilter.IncludeUnpublished = publishes everything that has changes
// here: ii12, ii2, ii22 - ii21 was published already but masked
r = PublishInvariantBranch(iRoot, PublishBranchFilter.IncludeUnpublished, method).ToArray();
AssertPublishResults(
r,
x => x.Content.Name,
"iroot",
"ii1",
"ii11",
"ii12",
"ii2",
"ii21",
"ii22");
AssertPublishResults(
r,
x => x.Result,
PublishResultType.SuccessPublishAlready,
PublishResultType.SuccessPublishAlready,
PublishResultType.SuccessPublishAlready,
PublishResultType.SuccessPublish,
PublishResultType.SuccessPublish,
PublishResultType.SuccessPublishAlready, // was masked
PublishResultType.SuccessPublish);
ii21 = ContentService.GetById(ii21.Id);
Assert.IsTrue(ii21.Published);
}
[Test]
public void Can_Publish_Variant_Branch_When_No_Changes_On_Root_All_Cultures()
{
CreateTypes(out _, out var vContentType);
// create/publish root
IContent vRoot = new Content("vroot", -1, vContentType, "de");
vRoot.SetCultureName("vroot.de", "de");
vRoot.SetCultureName("vroot.ru", "ru");
vRoot.SetCultureName("vroot.es", "es");
vRoot.SetValue("ip", "vroot");
vRoot.SetValue("vp", "vroot.de", "de");
vRoot.SetValue("vp", "vroot.ru", "ru");
vRoot.SetValue("vp", "vroot.es", "es");
ContentService.Save(vRoot);
ContentService.Publish(vRoot, vRoot.AvailableCultures.ToArray());
// create/publish child
IContent iv1 = new Content("iv1", vRoot, vContentType, "de");
iv1.SetCultureName("iv1.de", "de");
iv1.SetCultureName("iv1.ru", "ru");
iv1.SetCultureName("iv1.es", "es");
iv1.SetValue("ip", "iv1");
iv1.SetValue("vp", "iv1.de", "de");
iv1.SetValue("vp", "iv1.ru", "ru");
iv1.SetValue("vp", "iv1.es", "es");
ContentService.Save(iv1);
ContentService.Publish(iv1, iv1.AvailableCultures.ToArray());
// update the child
iv1.SetValue("vp", "UPDATED-iv1.de", "de");
ContentService.Save(iv1);
var r = ContentService.PublishBranch(vRoot, PublishBranchFilter.Default, vRoot.AvailableCultures.ToArray())
.ToArray(); // no culture specified so "*" is used, so all cultures
Assert.AreEqual(PublishResultType.SuccessPublishAlready, r[0].Result);
Assert.AreEqual(PublishResultType.SuccessPublishCulture, r[1].Result);
}
[Test]
public void Can_Publish_Variant_Branch_When_No_Changes_On_Root_Specific_Culture()
{
CreateTypes(out _, out var vContentType);
// create/publish root
IContent vRoot = new Content("vroot", -1, vContentType, "de");
vRoot.SetCultureName("vroot.de", "de");
vRoot.SetCultureName("vroot.ru", "ru");
vRoot.SetCultureName("vroot.es", "es");
vRoot.SetValue("ip", "vroot");
vRoot.SetValue("vp", "vroot.de", "de");
vRoot.SetValue("vp", "vroot.ru", "ru");
vRoot.SetValue("vp", "vroot.es", "es");
ContentService.Save(vRoot);
ContentService.Publish(vRoot, vRoot.AvailableCultures.ToArray());
// create/publish child
IContent iv1 = new Content("iv1", vRoot, vContentType, "de");
iv1.SetCultureName("iv1.de", "de");
iv1.SetCultureName("iv1.ru", "ru");
iv1.SetCultureName("iv1.es", "es");
iv1.SetValue("ip", "iv1");
iv1.SetValue("vp", "iv1.de", "de");
iv1.SetValue("vp", "iv1.ru", "ru");
iv1.SetValue("vp", "iv1.es", "es");
ContentService.Save(iv1);
ContentService.Publish(iv1, iv1.AvailableCultures.ToArray());
// update the child
iv1.SetValue("vp", "UPDATED-iv1.de", "de");
var saveResult = ContentService.Save(iv1);
var r = ContentService.PublishBranch(vRoot, PublishBranchFilter.Default, ["de"]).ToArray();
Assert.AreEqual(PublishResultType.SuccessPublishAlready, r[0].Result);
Assert.AreEqual(PublishResultType.SuccessPublishCulture, r[1].Result);
}
[Test]
public void Can_Publish_Variant_Branch()
{
CreateTypes(out _, out var vContentType);
IContent vRoot = new Content("vroot", -1, vContentType, "de");
vRoot.SetCultureName("vroot.de", "de");
vRoot.SetCultureName("vroot.ru", "ru");
vRoot.SetCultureName("vroot.es", "es");
vRoot.SetValue("ip", "vroot");
vRoot.SetValue("vp", "vroot.de", "de");
vRoot.SetValue("vp", "vroot.ru", "ru");
vRoot.SetValue("vp", "vroot.es", "es");
ContentService.Save(vRoot);
IContent iv1 = new Content("iv1", vRoot, vContentType, "de");
iv1.SetCultureName("iv1.de", "de");
iv1.SetCultureName("iv1.ru", "ru");
iv1.SetCultureName("iv1.es", "es");
iv1.SetValue("ip", "iv1");
iv1.SetValue("vp", "iv1.de", "de");
iv1.SetValue("vp", "iv1.ru", "ru");
iv1.SetValue("vp", "iv1.es", "es");
ContentService.Save(iv1);
IContent iv2 = new Content("iv2", vRoot, vContentType, "de");
iv2.SetCultureName("iv2.de", "de");
iv2.SetCultureName("iv2.ru", "ru");
iv2.SetCultureName("iv2.es", "es");
iv2.SetValue("ip", "iv2");
iv2.SetValue("vp", "iv2.de", "de");
iv2.SetValue("vp", "iv2.ru", "ru");
iv2.SetValue("vp", "iv2.es", "es");
ContentService.Save(iv2);
// vroot !published !edited
// iv1 !published !edited
// iv2 !published !edited
// PublishBranchFilter.Default = publishes those that are actually published, and have changes
// here: nothing
var r = ContentService.PublishBranch(vRoot, PublishBranchFilter.Default, ["*"]).ToArray(); // no culture specified = all cultures
// not forcing, iv1 and iv2 not published yet: only root got published
AssertPublishResults(r, x => x.Content.Name, "vroot.de");
AssertPublishResults(r, x => x.Result, PublishResultType.SuccessPublishCulture);
// prepare
vRoot.SetValue("ip", "changed");
vRoot.SetValue("vp", "changed.de", "de");
vRoot.SetValue("vp", "changed.ru", "ru");
vRoot.SetValue("vp", "changed.es", "es");
ContentService.Save(vRoot); // now root has drafts in all cultures
ContentService.Publish(iv1, new[] { "de", "ru" }); // now iv1 de and ru are published
iv1.SetValue("ip", "changed");
iv1.SetValue("vp", "changed.de", "de");
iv1.SetValue("vp", "changed.ru", "ru");
iv1.SetValue("vp", "changed.es", "es");
ContentService.Save(iv1); // now iv1 has drafts in all cultures
// validate - everything published for root, because no culture was specified = all
Assert.IsTrue(vRoot.Published);
Assert.IsTrue(vRoot.IsCulturePublished("de"));
Assert.IsTrue(vRoot.IsCulturePublished("ru"));
Assert.IsTrue(vRoot.IsCulturePublished("es"));
// validate - only some cultures published for iv1
Assert.IsTrue(iv1.Published);
Assert.IsTrue(iv1.IsCulturePublished("de"));
Assert.IsTrue(iv1.IsCulturePublished("ru"));
Assert.IsFalse(iv1.IsCulturePublished("es"));
r = ContentService.PublishBranch(vRoot, PublishBranchFilter.Default, ["de"]).ToArray();
// not forcing, iv2 not published yet: only root and iv1 got published
AssertPublishResults(r, x => x.Content.Name, "vroot.de", "iv1.de");
AssertPublishResults(
r,
x => x.Result,
PublishResultType.SuccessPublishCulture,
PublishResultType.SuccessPublishCulture);
// reload - SaveAndPublishBranch has modified other instances
Reload(ref iv1);
Reload(ref iv2);
// validate - root
Assert.IsTrue(vRoot.Published);
Assert.IsTrue(vRoot.IsCulturePublished("de"));
Assert.IsFalse(vRoot.IsCultureEdited("de")); // no drafts, this was just published
Assert.IsTrue(vRoot.IsCulturePublished("ru"));
Assert.IsTrue(vRoot.IsCultureEdited("ru")); // has draft
Assert.IsTrue(vRoot.IsCulturePublished("es"));
Assert.IsTrue(vRoot.IsCultureEdited("es")); // has draft
Assert.AreEqual("changed", vRoot.GetValue("ip", published: true)); // publishing de implies publishing invariants
Assert.AreEqual("changed.de", vRoot.GetValue("vp", "de", published: true));
// validate - de and ru are published, es has not been published
Assert.IsTrue(iv1.Published);
Assert.IsTrue(iv1.IsCulturePublished("de"));
Assert.IsTrue(iv1.IsCulturePublished("ru"));
Assert.IsFalse(iv1.IsCulturePublished("es"));
Assert.AreEqual("changed", iv1.GetValue("ip", published: true));
Assert.AreEqual("changed.de", iv1.GetValue("vp", "de", published: true));
Assert.AreEqual("iv1.ru", iv1.GetValue("vp", "ru", published: true));
}
private void Can_Publish_Mixed_Branch(out IContent iRoot, out IContent ii1, out IContent iv11)
{
// invariant root -> variant -> invariant
// variant root -> variant -> invariant
// variant root -> invariant -> variant
CreateTypes(out var iContentType, out var vContentType);
// invariant root -> invariant -> variant
iRoot = new Content("iroot", -1, iContentType);
iRoot.SetValue("ip", "iroot");
ContentService.Save(iRoot);
ContentService.Publish(iRoot, iRoot.AvailableCultures.ToArray());
ii1 = new Content("ii1", iRoot, iContentType);
ii1.SetValue("ip", "vii1");
ContentService.Save(ii1);
ContentService.Publish(ii1, ii1.AvailableCultures.ToArray());
ii1.SetValue("ip", "changed");
ContentService.Save(ii1);
iv11 = new Content("iv11.de", ii1, vContentType, "de");
iv11.SetValue("ip", "iv11");
iv11.SetValue("vp", "iv11.de", "de");
iv11.SetValue("vp", "iv11.ru", "ru");
iv11.SetValue("vp", "iv11.es", "es");
ContentService.Save(iv11);
iv11.SetCultureName("iv11.ru", "ru");
ContentService.Save(iv11);
var xxx = ContentService.Publish(iv11, new[] { "de", "ru" });
Assert.AreEqual("iv11.de", iv11.GetValue("vp", "de", published: true));
Assert.AreEqual("iv11.ru", iv11.GetValue("vp", "ru", published: true));
iv11.SetValue("ip", "changed");
iv11.SetValue("vp", "changed.de", "de");
iv11.SetValue("vp", "changed.ru", "ru");
ContentService.Save(iv11);
}
[Test]
public void Can_Publish_Mixed_Branch_1()
{
Can_Publish_Mixed_Branch(out var iRoot, out var ii1, out var iv11);
var r = ContentService.PublishBranch(iRoot, PublishBranchFilter.Default, ["de"]).ToArray();
AssertPublishResults(r, x => x.Content.Name, "iroot", "ii1", "iv11.de");
AssertPublishResults(
r,
x => x.Result,
PublishResultType.SuccessPublishAlready,
PublishResultType.SuccessPublish,
PublishResultType.SuccessPublishCulture);
// reload - SaveAndPublishBranch has modified other instances
Reload(ref ii1);
Reload(ref iv11);
// the invariant child has been published
// the variant child has been published for 'de' only
Assert.AreEqual("changed", ii1.GetValue("ip", published: true));
Assert.AreEqual("changed", iv11.GetValue("ip", published: true));
Assert.AreEqual("changed.de", iv11.GetValue("vp", "de", published: true));
Assert.AreEqual("iv11.ru", iv11.GetValue("vp", "ru", published: true));
}
[Test]
public void Can_Publish_MixedBranch_2()
{
Can_Publish_Mixed_Branch(out var iRoot, out var ii1, out var iv11);
var r = ContentService.PublishBranch(iRoot, PublishBranchFilter.Default, ["de", "ru"]).ToArray();
AssertPublishResults(r, x => x.Content.Name, "iroot", "ii1", "iv11.de");
AssertPublishResults(
r,
x => x.Result,
PublishResultType.SuccessPublishAlready,
PublishResultType.SuccessPublish,
PublishResultType.SuccessPublishCulture);
// reload - SaveAndPublishBranch has modified other instances
Reload(ref ii1);
Reload(ref iv11);
// the invariant child has been published
// the variant child has been published for 'de' and 'ru'
Assert.AreEqual("changed", ii1.GetValue("ip", published: true));
Assert.AreEqual("changed", iv11.GetValue("ip", published: true));
Assert.AreEqual("changed.de", iv11.GetValue("vp", "de", published: true));
Assert.AreEqual("changed.ru", iv11.GetValue("vp", "ru", published: true));
}
[TestCase(PublishBranchFilter.Default)]
[TestCase(PublishBranchFilter.IncludeUnpublished)]
[TestCase(PublishBranchFilter.ForceRepublish)]
[TestCase(PublishBranchFilter.All)]
public void Can_Publish_Invariant_Branch_With_Force_Options(PublishBranchFilter publishBranchFilter)
{
CreateTypes(out var iContentType, out _);
// Create content (published root, published child, unpublished child, changed child).
IContent iRoot = new Content("iroot", -1, iContentType);
iRoot.SetValue("ip", "iroot");
ContentService.Save(iRoot);
ContentService.Publish(iRoot, iRoot.AvailableCultures.ToArray());
IContent ii1 = new Content("ii1", iRoot, iContentType);
ii1.SetValue("ip", "vii1");
ContentService.Save(ii1);
ContentService.Publish(ii1, ii1.AvailableCultures.ToArray());
IContent ii2 = new Content("ii2", iRoot, iContentType);
ii2.SetValue("ip", "vii2");
ContentService.Save(ii2);
IContent ii3 = new Content("ii3", iRoot, iContentType);
ii3.SetValue("ip", "vii3");
ContentService.Save(ii3);
ContentService.Publish(ii3, ii3.AvailableCultures.ToArray());
ii3.SetValue("ip", "vii3a");
ContentService.Save(ii3);
var result = ContentService.PublishBranch(iRoot, publishBranchFilter, ["*"]).ToArray();
var expectedContentNames = GetExpectedContentNamesForForceOptions(publishBranchFilter);
var expectedPublishResultTypes = GetExpectedPublishResultTypesForForceOptions(publishBranchFilter);
AssertPublishResults(result, x => x.Content.Name, expectedContentNames);
AssertPublishResults(
result,
x => x.Result,
expectedPublishResultTypes);
}
[TestCase("*", PublishBranchFilter.Default)]
[TestCase("*", PublishBranchFilter.IncludeUnpublished)]
[TestCase("*", PublishBranchFilter.ForceRepublish)]
[TestCase("*", PublishBranchFilter.All)]
[TestCase("de", PublishBranchFilter.Default)]
[TestCase("de", PublishBranchFilter.IncludeUnpublished)]
[TestCase("de", PublishBranchFilter.ForceRepublish)]
[TestCase("de", PublishBranchFilter.All)]
public void Can_Publish_Variant_Branch_With_Force_Options(string culture, PublishBranchFilter publishBranchFilter)
{
CreateTypes(out _, out var vContentType);
// Create content (published root, published child, unpublished child, changed child).
IContent vRoot = new Content("vroot", -1, vContentType);
vRoot.SetCultureName("vroot.de", "de");
vRoot.SetCultureName("vroot.ru", "ru");
vRoot.SetValue("ip", "vroot");
vRoot.SetValue("vp", "vroot.de", "de");
vRoot.SetValue("vp", "vroot.ru", "ru");
ContentService.Save(vRoot);
ContentService.Publish(vRoot, vRoot.AvailableCultures.ToArray());
IContent iv1 = new Content("iv1", vRoot, vContentType, "de");
iv1.SetCultureName("iv1.de", "de");
iv1.SetCultureName("iv1.ru", "ru");
iv1.SetValue("ip", "iv1");
iv1.SetValue("vp", "iv1.de", "de");
iv1.SetValue("vp", "iv1.ru", "ru");
ContentService.Save(iv1);
ContentService.Publish(iv1, iv1.AvailableCultures.ToArray());
IContent iv2 = new Content("iv2", vRoot, vContentType, "de");
iv2.SetCultureName("iv2.de", "de");
iv2.SetCultureName("iv2.ru", "ru");
iv2.SetValue("ip", "iv2");
iv2.SetValue("vp", "iv2.de", "de");
iv2.SetValue("vp", "iv2.ru", "ru");
ContentService.Save(iv2);
// When testing with a specific culture, publish the other one, so we can test that
// the specified unpublished culture is handled correctly.
if (culture != "*")
{
ContentService.Publish(iv2, ["ru"]);
}
IContent iv3 = new Content("iv3", vRoot, vContentType, "de");
iv3.SetCultureName("iv3.de", "de");
iv3.SetCultureName("iv3.ru", "ru");
iv3.SetValue("ip", "iv3");
iv3.SetValue("vp", "iv3.de", "de");
iv3.SetValue("vp", "iv3.ru", "ru");
ContentService.Save(iv3);
ContentService.Publish(iv3, iv3.AvailableCultures.ToArray());
iv3.SetValue("ip", "iv3a");
iv3.SetValue("vp", "iv3a.de", "de");
iv3.SetValue("vp", "iv3a.ru", "ru");
ContentService.Save(iv3);
var cultures = culture == "*" ? vRoot.AvailableCultures.ToArray() : new[] { culture };
var result = ContentService.PublishBranch(vRoot, publishBranchFilter, cultures).ToArray();
var expectedContentNames = GetExpectedContentNamesForForceOptions(publishBranchFilter, true);
var expectedPublishResultTypes = GetExpectedPublishResultTypesForForceOptions(publishBranchFilter, true);
AssertPublishResults(result, x => x.Content.Name, expectedContentNames);
AssertPublishResults(
result,
x => x.Result,
expectedPublishResultTypes);
}
private static string[] GetExpectedContentNamesForForceOptions(PublishBranchFilter options, bool isVariant = false)
{
var rootName = isVariant ? "vroot.de" : "iroot";
var childPrefix = isVariant ? "iv" : "ii";
var childSuffix = isVariant ? ".de" : string.Empty;
if (options.HasFlag(PublishBranchFilter.IncludeUnpublished))
{
return [rootName, $"{childPrefix}1{childSuffix}", $"{childPrefix}2{childSuffix}", $"{childPrefix}3{childSuffix}"];
}
return [rootName, $"{childPrefix}1{childSuffix}", $"{childPrefix}3{childSuffix}"];
}
private static PublishResultType[] GetExpectedPublishResultTypesForForceOptions(PublishBranchFilter options, bool isVariant = false)
{
var successPublish = isVariant ? PublishResultType.SuccessPublishCulture : PublishResultType.SuccessPublish;
if (options.HasFlag(PublishBranchFilter.IncludeUnpublished) && options.HasFlag(PublishBranchFilter.ForceRepublish))
{
return [successPublish,
successPublish,
successPublish,
successPublish];
}
if (options.HasFlag(PublishBranchFilter.IncludeUnpublished))
{
return [PublishResultType.SuccessPublishAlready,
PublishResultType.SuccessPublishAlready,
successPublish,
successPublish];
}
if (options.HasFlag(PublishBranchFilter.ForceRepublish))
{
return [successPublish,
successPublish,
successPublish];
}
return [PublishResultType.SuccessPublishAlready,
PublishResultType.SuccessPublishAlready,
successPublish];
}
private void AssertPublishResults<T>(PublishResult[] values, Func<PublishResult, T> getter, params T[] expected)
{
if (expected.Length != values.Length)
{
Console.WriteLine(string.Join(", ", values.Select(x => getter(x).ToString())));
}
Assert.AreEqual(expected.Length, values.Length);
for (var i = 0; i < values.Length; i++)
{
var value = getter(values[i]);
Assert.AreEqual(expected[i], value, $"Expected {expected[i]} at {i} but got {value}.");
}
}
private void Reload(ref IContent document)
=> document = ContentService.GetById(document.Id);
private void CreateTypes(out IContentType iContentType, out IContentType vContentType)
{
var langDe = new Language("de", "German") { IsDefault = true };
LanguageService.CreateAsync(langDe, Constants.Security.SuperUserKey).GetAwaiter().GetResult();
var langRu = new Language("ru", "Russian");
LanguageService.CreateAsync(langRu, Constants.Security.SuperUserKey).GetAwaiter().GetResult();
var langEs = new Language("es", "Spanish");
LanguageService.CreateAsync(langEs, Constants.Security.SuperUserKey).GetAwaiter().GetResult();
iContentType = new ContentType(ShortStringHelper, -1)
{
Alias = "ict",
Name = "Invariant Content Type",
Variations = ContentVariation.Nothing
};
iContentType.AddPropertyType(
new PropertyType(ShortStringHelper, Constants.PropertyEditors.Aliases.TextBox, ValueStorageType.Nvarchar,
"ip")
{ Variations = ContentVariation.Nothing });
ContentTypeService.Save(iContentType);
vContentType = new ContentType(ShortStringHelper, -1)
{
Alias = "vct",
Name = "Variant Content Type",
Variations = ContentVariation.Culture
};
vContentType.AddPropertyType(
new PropertyType(ShortStringHelper, Constants.PropertyEditors.Aliases.TextBox, ValueStorageType.Nvarchar,
"ip")
{ Variations = ContentVariation.Nothing });
vContentType.AddPropertyType(
new PropertyType(ShortStringHelper, Constants.PropertyEditors.Aliases.TextBox, ValueStorageType.Nvarchar,
"vp")
{ Variations = ContentVariation.Culture });
ContentTypeService.Save(vContentType);
}
private IEnumerable<PublishResult> PublishInvariantBranch(IContent content, PublishBranchFilter publishBranchFilter, int method)
{
// ReSharper disable RedundantArgumentDefaultValue
// ReSharper disable ArgumentsStyleOther
switch (method)
{
case 1:
return ContentService.PublishBranch(content, publishBranchFilter, content.AvailableCultures.ToArray());
case 2:
return ContentService.PublishBranch(content, publishBranchFilter, cultures: ["*"]);
case 3:
return ContentService.PublishBranch(content, publishBranchFilter, cultures: Array.Empty<string>());
default:
throw new ArgumentOutOfRangeException(nameof(method));
}
// ReSharper restore RedundantArgumentDefaultValue
// ReSharper restore ArgumentsStyleOther
}
}