server/test/Core.Test/AdminConsole/Helpers/PermissionsHelpers.cs

using Bit.Core.Context;
using Bit.Core.Enums;
using Bit.Core.Models.Data;

namespace Bit.Core.Test.AdminConsole.Helpers;

public static class PermissionsHelpers
{
    /// <summary>
    /// Sets the specified permission.
    /// </summary>
    /// <param name="permissionName">The permission name specified as a string - using `nameof` is highly recommended.</param>
    /// <param name="value">The value to set the permission to.</param>
    /// <returns>No value; this mutates the permissions object.</returns>
    public static void SetPermission(this Permissions permissions, string permissionName, bool value)
    {
        var prop = typeof(Permissions).GetProperty(permissionName);
        if (prop == null)
        {
            throw new NullReferenceException("Invalid property name.");
        }

        prop.SetValue(permissions, true);
    }

    /// <summary>
    /// Return a new Permission object with inverted permissions.
    /// This is useful to test negative cases, e.g. "all other permissions should fail".
    /// </summary>
    /// <param name="permissions"></param>
    /// <returns></returns>
    public static Permissions Invert(this Permissions permissions)
    {
        // Get all false boolean properties of input object
        var inputsToFlip = permissions
            .GetType()
            .GetProperties()
            .Where(p =>
                p.PropertyType == typeof(bool) &&
                (bool)p.GetValue(permissions, null)! == false)
            .Select(p => p.Name);

        var result = new Permissions();

        // Set these to true on the result object
        result
            .GetType()
            .GetProperties()
            .Where(p => inputsToFlip.Contains(p.Name))
            .ToList()
            .ForEach(p => p.SetValue(result, true));

        return result;
    }

    /// <summary>
    /// Returns a sequence of Permission objects, where each Permission object has a different permission flag set.
    /// </summary>
    public static IEnumerable<Permissions> GetAllPermissions()
    {
        // Get all boolean properties of input object
        var props = typeof(Permissions)
            .GetProperties()
            .Where(p => p.PropertyType == typeof(bool));

        foreach (var prop in props)
        {
            var result = new Permissions();
            prop.SetValue(result, true);
            yield return result;
        }
    }

    /// <summary>
    /// Returns a sequence of all possible roles and permissions represented as CurrentContextOrganization objects.
    /// Used largely for authorization testing.
    /// </summary>
    /// <returns></returns>
    public static IEnumerable<CurrentContextOrganization> AllRoles() => new List<CurrentContextOrganization>
    {
        new () { Type = OrganizationUserType.Owner },
        new () { Type = OrganizationUserType.Admin },
        new () { Type = OrganizationUserType.Custom, Permissions = new Permissions() },
        new () { Type = OrganizationUserType.Custom, Permissions = new Permissions().Invert() },
        new () { Type = OrganizationUserType.User },
    };
}