Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

V15: Handle empty permissions #17801

Merged
merged 6 commits into from
Dec 17, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -42,16 +42,31 @@

public IEnumerable<IGranularPermission> MapToGranularPermissions(IPermissionPresentationModel permissionViewModel)
{
if (permissionViewModel is DocumentPermissionPresentationModel documentPermissionPresentationModel)
if (permissionViewModel is not DocumentPermissionPresentationModel documentPermissionPresentationModel)
{
foreach (var verb in documentPermissionPresentationModel.Verbs)
yield break;
}

if(documentPermissionPresentationModel.Verbs.Any() is false || (documentPermissionPresentationModel.Verbs.Count == 1 && documentPermissionPresentationModel.Verbs.Contains(string.Empty)))

Check warning on line 50 in src/Umbraco.Cms.Api.Management/Mapping/Permissions/DocumentPermissionMapper.cs

View check run for this annotation

CodeScene Delta Analysis / CodeScene Cloud Delta Analysis (v15/dev)

❌ New issue: Complex Conditional

MapToGranularPermissions has 1 complex conditionals with 2 branches, threshold = 2. A complex conditional is an expression inside a branch (e.g. if, for, while) which consists of multiple, logical operators such as AND/OR. The more logical operators in an expression, the more severe the code smell.
{
yield return new DocumentGranularPermission
{
yield return new DocumentGranularPermission
{
Key = documentPermissionPresentationModel.Document.Id,
Permission = verb,
};
Key = documentPermissionPresentationModel.Document.Id,
Permission = string.Empty,
};
yield break;
}
foreach (var verb in documentPermissionPresentationModel.Verbs)
{
if (string.IsNullOrEmpty(verb))
{
continue;
}
yield return new DocumentGranularPermission
{
Key = documentPermissionPresentationModel.Document.Id,
Permission = verb,
};
}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,168 @@
using Microsoft.Extensions.DependencyInjection;
using NUnit.Framework;
using Umbraco.Cms.Api.Management.Factories;
using Umbraco.Cms.Api.Management.Mapping.Permissions;
using Umbraco.Cms.Api.Management.ViewModels;
using Umbraco.Cms.Api.Management.ViewModels.UserGroup;
using Umbraco.Cms.Api.Management.ViewModels.UserGroup.Permissions;
using Umbraco.Cms.Core;
using Umbraco.Cms.Core.Models;
using Umbraco.Cms.Core.Services;
using Umbraco.Cms.Core.Services.ContentTypeEditing;
using Umbraco.Cms.Core.Services.OperationStatus;
using Umbraco.Cms.Infrastructure.Persistence.Mappers;
using Umbraco.Cms.Tests.Common.Builders;
using Umbraco.Cms.Tests.Common.TestHelpers;
using Umbraco.Cms.Tests.Common.Testing;
using Umbraco.Cms.Tests.Integration.Testing;

namespace Umbraco.Cms.Tests.Integration.ManagementApi.Factories;

[TestFixture]
[UmbracoTest(Database = UmbracoTestOptions.Database.NewSchemaPerTest)]
public class UserGroupPresentationFactoryTests : UmbracoIntegrationTest
{
public IUserGroupPresentationFactory UserGroupPresentationFactory => GetRequiredService<IUserGroupPresentationFactory>();
public IUserGroupService UserGroupService => GetRequiredService<IUserGroupService>();
public ITemplateService TemplateService => GetRequiredService<ITemplateService>();
public IContentTypeEditingService ContentTypeEditingService => GetRequiredService<IContentTypeEditingService>();

public IContentEditingService ContentEditingService => GetRequiredService<IContentEditingService>();

protected override void ConfigureTestServices(IServiceCollection services)
{
services.AddTransient<IUserGroupPresentationFactory, UserGroupPresentationFactory>();
services.AddSingleton<IPermissionPresentationFactory, PermissionPresentationFactory>();
services.AddSingleton<DocumentPermissionMapper>();
services.AddSingleton<IPermissionMapper>(x=>x.GetRequiredService<DocumentPermissionMapper>());
services.AddSingleton<IPermissionPresentationMapper>(x=>x.GetRequiredService<DocumentPermissionMapper>());
}


[Test]
public async Task Can_Map_Create_Model_And_Create()
{
var updateModel = new CreateUserGroupRequestModel()
{
Alias = "testAlias",
FallbackPermissions = new HashSet<string>(),
HasAccessToAllLanguages = true,
Languages = new List<string>(),
Name = "Test Name",
Sections = new [] {"Umb.Section.Content"},
Permissions = new HashSet<IPermissionPresentationModel>()
};

var attempt = await UserGroupPresentationFactory.CreateAsync(updateModel);
Assert.IsTrue(attempt.Success);

var userGroupCreateAttempt = await UserGroupService.CreateAsync(attempt.Result, Constants.Security.SuperUserKey);

var userGroup = userGroupCreateAttempt.Result;

Assert.Multiple(() =>
{
Assert.IsTrue(userGroupCreateAttempt.Success);
Assert.IsNotNull(userGroup);
Assert.IsEmpty(userGroup.GranularPermissions);
});
}

[Test]
public async Task Cannot_Create_UserGroup_With_Unexisting_Document_Reference()
{
var updateModel = new CreateUserGroupRequestModel()
{
Alias = "testAlias",
FallbackPermissions = new HashSet<string>(),
HasAccessToAllLanguages = true,
Languages = new List<string>(),
Name = "Test Name",
Sections = new [] {"Umb.Section.Content"},
Permissions = new HashSet<IPermissionPresentationModel>()
{
new DocumentPermissionPresentationModel()
{
Document = new ReferenceByIdModel(Guid.NewGuid()),
Verbs = new HashSet<string>()
}
}
};

var attempt = await UserGroupPresentationFactory.CreateAsync(updateModel);
Assert.IsTrue(attempt.Success);

var userGroupCreateAttempt = await UserGroupService.CreateAsync(attempt.Result, Constants.Security.SuperUserKey);

Assert.Multiple(() =>
{
Assert.IsFalse(userGroupCreateAttempt.Success);
Assert.AreEqual(UserGroupOperationStatus.DocumentPermissionKeyNotFound, userGroupCreateAttempt.Status);
});
}

[Test]
public async Task Can_Create_Usergroup_With_Empty_Granluar_Permissions_For_Document()
{
var contentKey = await CreateContent();

var updateModel = new CreateUserGroupRequestModel()
{
Alias = "testAlias",
FallbackPermissions = new HashSet<string>(),
HasAccessToAllLanguages = true,
Languages = new List<string>(),
Name = "Test Name",
Sections = new [] {"Umb.Section.Content"},
Permissions = new HashSet<IPermissionPresentationModel>
{
new DocumentPermissionPresentationModel()
{
Document = new ReferenceByIdModel(contentKey),
Verbs = new HashSet<string>()
}
}
};

var attempt = await UserGroupPresentationFactory.CreateAsync(updateModel);
Assert.IsTrue(attempt.Success);

var userGroupCreateAttempt = await UserGroupService.CreateAsync(attempt.Result, Constants.Security.SuperUserKey);
var userGroup = userGroupCreateAttempt.Result;

Assert.Multiple(() =>
{
Assert.IsTrue(userGroupCreateAttempt.Success);
Assert.IsNotNull(userGroup);
Assert.IsNotEmpty(userGroup.GranularPermissions);
Assert.AreEqual(contentKey, userGroup.GranularPermissions.First().Key);
Assert.AreEqual(string.Empty, userGroup.GranularPermissions.First().Permission);
});
}

private async Task<Guid> CreateContent()
{
// NOTE Maybe not the best way to create/save test data as we are using the services, which are being tested.
var template = TemplateBuilder.CreateTextPageTemplate("defaultTemplate");
await TemplateService.CreateAsync(template, Constants.Security.SuperUserKey);
// Create and Save ContentType "umbTextpage" -> 1051 (template), 1052 (content type)
var contentTypeCreateModel = ContentTypeEditingBuilder.CreateSimpleContentType("umbTextpage", "Textpage", defaultTemplateKey: template.Key);
var contentTypeAttempt = await ContentTypeEditingService.CreateAsync(contentTypeCreateModel, Constants.Security.SuperUserKey);
Assert.IsTrue(contentTypeAttempt.Success);

var contentTypeResult = contentTypeAttempt.Result;
var contentTypeUpdateModel = ContentTypeUpdateHelper.CreateContentTypeUpdateModel(contentTypeResult); contentTypeUpdateModel.AllowedContentTypes = new[]
{
new ContentTypeSort(contentTypeResult.Key, 0, contentTypeCreateModel.Alias),
};
var updatedContentTypeResult = await ContentTypeEditingService.UpdateAsync(contentTypeResult, contentTypeUpdateModel, Constants.Security.SuperUserKey);
Assert.IsTrue(updatedContentTypeResult.Success);

// Create and Save Content "Homepage" based on "umbTextpage" -> 1053
var textPage = ContentEditingBuilder.CreateSimpleContent(updatedContentTypeResult.Result.Key);
var createContentResultTextPage = await ContentEditingService.CreateAsync(textPage, Constants.Security.SuperUserKey);
Assert.IsTrue(createContentResultTextPage.Success);

return createContentResultTextPage.Result.Content.Key;
}
}
Loading