Umbraco-CMS/tests/Umbraco.Tests.Common/Builders/UserGroupBuilder.cs

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

using System.Collections.Generic;
using System.Linq;
using Moq;
using Umbraco.Cms.Core.Models.Membership;
using Umbraco.Cms.Core.Strings;
using Umbraco.Cms.Tests.Common.Builders.Interfaces;
using Umbraco.Cms.Tests.Common.Builders.Extensions;

namespace Umbraco.Cms.Tests.Common.Builders
{
    public class UserGroupBuilder : UserGroupBuilder<object>
    {
        public UserGroupBuilder()
            : base(null)
        {
        }
    }

    public class UserGroupBuilder<TParent>
        : ChildBuilderBase<TParent, IUserGroup>,
            IWithIdBuilder,
            IWithIconBuilder,
            IWithAliasBuilder,
            IWithNameBuilder
    {
        private int? _id;
        private string _alias;
        private string _icon;
        private string _name;
        private IEnumerable<string> _permissions = Enumerable.Empty<string>();
        private IEnumerable<string> _allowedSections = Enumerable.Empty<string>();
        private string _suffix;
        private int? _startContentId;
        private int? _startMediaId;
        private int? _userCount;

        public UserGroupBuilder(TParent parentBuilder)
            : base(parentBuilder)
        {
        }

        /// <summary>
        /// Will suffix the name, email and username for testing.
        /// </summary>
        /// <param name="suffix">Suffix to add to user group properties.</param>
        /// <returns>Current builder instance.</returns>
        public UserGroupBuilder<TParent> WithSuffix(string suffix)
        {
            _suffix = suffix;
            return this;
        }

        public UserGroupBuilder<TParent> WithUserCount(int userCount)
        {
            _userCount = userCount;
            return this;
        }

        public UserGroupBuilder<TParent> WithPermissions(string permissions)
        {
            _permissions = permissions.ToCharArray().Select(x => x.ToString());
            return this;
        }

        public UserGroupBuilder<TParent> WithPermissions(IList<string> permissions)
        {
            _permissions = permissions;
            return this;
        }

        public UserGroupBuilder<TParent> WithAllowedSections(IList<string> allowedSections)
        {
            _allowedSections = allowedSections;
            return this;
        }

        public UserGroupBuilder<TParent> WithStartContentId(int startContentId)
        {
            _startContentId = startContentId;
            return this;
        }

        public UserGroupBuilder<TParent> WithStartMediaId(int startMediaId)
        {
            _startMediaId = startMediaId;
            return this;
        }

        public IReadOnlyUserGroup BuildReadOnly(IUserGroup userGroup) =>
            Mock.Of<IReadOnlyUserGroup>(x =>
                x.Permissions == userGroup.Permissions &&
                x.Alias == userGroup.Alias &&
                x.Icon == userGroup.Icon &&
                x.Name == userGroup.Name &&
                x.StartContentId == userGroup.StartContentId &&
                x.StartMediaId == userGroup.StartMediaId &&
                x.AllowedSections == userGroup.AllowedSections &&
                x.Id == userGroup.Id);

        public override IUserGroup Build()
        {
            var id = _id ?? 0;
            var name = _name ?? ("TestUserGroup" + _suffix);
            var alias = _alias ?? ("testUserGroup" + _suffix);
            var userCount = _userCount ?? 0;
            var startContentId = _startContentId ?? -1;
            var startMediaId = _startMediaId ?? -1;
            var icon = _icon ?? "icon-group";

            var shortStringHelper = new DefaultShortStringHelper(new DefaultShortStringHelperConfig());

            var userGroup = new UserGroup(shortStringHelper, userCount, alias, name, _permissions, icon)
            {
                Id = id,
                StartContentId = startContentId,
                StartMediaId = startMediaId
            };

            foreach (var section in _allowedSections)
            {
                userGroup.AddAllowedSection(section);
            }

            return userGroup;
        }

        public static UserGroup CreateUserGroup(string alias = "testGroup", string name = "Test Group", string suffix = "", string[] permissions = null, string[] allowedSections = null) =>
            (UserGroup)new UserGroupBuilder()
                .WithAlias(alias + suffix)
                .WithName(name + suffix)
                .WithPermissions(permissions ?? new[] { "A", "B", "C" })
                .WithAllowedSections(allowedSections ?? new[] { "content", "media" })
                .Build();

        int? IWithIdBuilder.Id
        {
            get => _id;
            set => _id = value;
        }

        string IWithIconBuilder.Icon
        {
            get => _icon;
            set => _icon = value;
        }

        string IWithAliasBuilder.Alias
        {
            get => _alias;
            set => _alias = value;
        }

        string IWithNameBuilder.Name
        {
            get => _name;
            set => _name = value;
        }
    }
}