Umbraco-CMS/tests/Umbraco.Tests.UnitTests/Umbraco.Infrastructure/BackOffice/BackOfficeClaimsPrincipalFactoryTests.cs

// Copyright (c) Umbraco.
// See LICENSE for more details.

using System;
using System.Collections.Generic;
using System.Security.Claims;
using System.Threading.Tasks;
using Microsoft.AspNetCore.Identity;
using Microsoft.Extensions.Options;
using Moq;
using NUnit.Framework;
using Umbraco.Cms.Core.Configuration.Models;
using Umbraco.Cms.Core.Models.Membership;
using Umbraco.Cms.Core.Security;
using Umbraco.Extensions;
using Constants = Umbraco.Cms.Core.Constants;

namespace Umbraco.Cms.Tests.UnitTests.Umbraco.Core.BackOffice
{
    [TestFixture]
    public class BackOfficeClaimsPrincipalFactoryTests
    {
        private const int TestUserId = 2;
        private const string TestUserName = "bob";
        private const string TestUserGivenName = "Bob";
        private const string TestUserCulture = "en-US";
        private const string TestUserSecurityStamp = "B6937738-9C17-4C7D-A25A-628A875F5177";
        private BackOfficeIdentityUser _testUser;
        private Mock<UserManager<BackOfficeIdentityUser>> _mockUserManager;

        private static Mock<UserManager<BackOfficeIdentityUser>> GetMockedUserManager()
            => new Mock<UserManager<BackOfficeIdentityUser>>(new Mock<IUserStore<BackOfficeIdentityUser>>().Object, null, null, null, null, null, null, null, null);

        [Test]
        public void Ctor_When_UserManager_Is_Null_Expect_ArgumentNullException()
            => Assert.Throws<ArgumentNullException>(() => new BackOfficeClaimsPrincipalFactory(
                                                            null,
                                                            new OptionsWrapper<BackOfficeIdentityOptions>(new BackOfficeIdentityOptions())));

        [Test]
        public void Ctor_When_Options_Are_Null_Expect_ArgumentNullException()
            => Assert.Throws<ArgumentNullException>(() => new BackOfficeClaimsPrincipalFactory(GetMockedUserManager().Object, null));

        [Test]
        public void Ctor_When_Options_Value_Is_Null_Expect_ArgumentNullException()
            => Assert.Throws<ArgumentNullException>(() => new BackOfficeClaimsPrincipalFactory(
                                                            GetMockedUserManager().Object,
                                                            new OptionsWrapper<BackOfficeIdentityOptions>(null)));

        [Test]
        public void CreateAsync_When_User_Is_Null_Expect_ArgumentNullException()
        {
            BackOfficeClaimsPrincipalFactory sut = CreateSut();

            Assert.ThrowsAsync<ArgumentNullException>(async () => await sut.CreateAsync(null));
        }

        [Test]
        public async Task CreateAsync_Should_Create_Principal_With_Claims_Identity()
        {
            BackOfficeClaimsPrincipalFactory sut = CreateSut();

            ClaimsPrincipal claimsPrincipal = await sut.CreateAsync(_testUser);

            var umbracoBackOfficeIdentity = claimsPrincipal.Identity as ClaimsIdentity;
            Assert.IsNotNull(umbracoBackOfficeIdentity);
        }

        [TestCase(ClaimTypes.NameIdentifier, TestUserId)]
        [TestCase(ClaimTypes.Name, TestUserName)]
        public async Task CreateAsync_Should_Include_Claim(string expectedClaimType, object expectedClaimValue)
        {
            BackOfficeClaimsPrincipalFactory sut = CreateSut();

            ClaimsPrincipal claimsPrincipal = await sut.CreateAsync(_testUser);

            Assert.True(claimsPrincipal.HasClaim(expectedClaimType, expectedClaimValue.ToString()));
            Assert.True(claimsPrincipal.GetUmbracoIdentity().HasClaim(expectedClaimType, expectedClaimValue.ToString()));
        }

        [Test]
        public async Task CreateAsync_When_SecurityStamp_Supported_Expect_SecurityStamp_Claim()
        {
            const string expectedClaimType = Constants.Security.SecurityStampClaimType;
            var expectedClaimValue = _testUser.SecurityStamp;

            _mockUserManager.Setup(x => x.SupportsUserSecurityStamp).Returns(true);
            _mockUserManager.Setup(x => x.GetSecurityStampAsync(_testUser)).ReturnsAsync(_testUser.SecurityStamp);

            BackOfficeClaimsPrincipalFactory sut = CreateSut();

            ClaimsPrincipal claimsPrincipal = await sut.CreateAsync(_testUser);

            Assert.True(claimsPrincipal.HasClaim(expectedClaimType, expectedClaimValue));
            Assert.True(claimsPrincipal.GetUmbracoIdentity().HasClaim(expectedClaimType, expectedClaimValue));
        }

        [Test]
        public async Task CreateAsync_When_Roles_Supported_Expect_Role_Claims_In_UmbracoIdentity()
        {
            const string expectedClaimType = ClaimTypes.Role;
            const string expectedClaimValue = "b87309fb-4caf-48dc-b45a-2b752d051508";

            _testUser.Roles.Add(new IdentityUserRole<string> { RoleId = expectedClaimValue });
            _mockUserManager.Setup(x => x.SupportsUserRole).Returns(true);
            _mockUserManager.Setup(x => x.GetRolesAsync(_testUser)).ReturnsAsync(new[] { expectedClaimValue });

            BackOfficeClaimsPrincipalFactory sut = CreateSut();

            ClaimsPrincipal claimsPrincipal = await sut.CreateAsync(_testUser);

            Assert.True(claimsPrincipal.HasClaim(expectedClaimType, expectedClaimValue));
        }

        [Test]
        public async Task CreateAsync_When_UserClaims_Supported_Expect_UserClaims_In_Actor()
        {
            const string expectedClaimType = "custom";
            const string expectedClaimValue = "val";

            _testUser.Claims.Add(new IdentityUserClaim<string> { ClaimType = expectedClaimType, ClaimValue = expectedClaimValue });
            _mockUserManager.Setup(x => x.SupportsUserClaim).Returns(true);
            _mockUserManager.Setup(x => x.GetClaimsAsync(_testUser)).ReturnsAsync(
                new List<Claim> { new Claim(expectedClaimType, expectedClaimValue) });

            BackOfficeClaimsPrincipalFactory sut = CreateSut();

            ClaimsPrincipal claimsPrincipal = await sut.CreateAsync(_testUser);

            Assert.True(claimsPrincipal.GetUmbracoIdentity().HasClaim(expectedClaimType, expectedClaimValue));
        }

        [SetUp]
        public void Setup()
        {
            var globalSettings = new GlobalSettings { DefaultUILanguage = "test" };

            _testUser = new BackOfficeIdentityUser(globalSettings, TestUserId, new List<IReadOnlyUserGroup>())
            {
                UserName = TestUserName,
                Name = TestUserGivenName,
                Email = "bob@umbraco.test",
                SecurityStamp = TestUserSecurityStamp,
                Culture = TestUserCulture
            };

            _mockUserManager = GetMockedUserManager();
            _mockUserManager.Setup(x => x.GetUserIdAsync(_testUser)).ReturnsAsync(_testUser.Id.ToString);
            _mockUserManager.Setup(x => x.GetUserNameAsync(_testUser)).ReturnsAsync(_testUser.UserName);
            _mockUserManager.Setup(x => x.SupportsUserSecurityStamp).Returns(false);
            _mockUserManager.Setup(x => x.SupportsUserClaim).Returns(false);
            _mockUserManager.Setup(x => x.SupportsUserRole).Returns(false);
        }

        private BackOfficeClaimsPrincipalFactory CreateSut() => new BackOfficeClaimsPrincipalFactory(
                _mockUserManager.Object,
                new OptionsWrapper<BackOfficeIdentityOptions>(new BackOfficeIdentityOptions()));
    }
}