velopack/test/Divergic.Logging.Xunit/LoggingConfig.cs

namespace Divergic.Logging.Xunit
{
    using System;
    using System.Collections.ObjectModel;
    using Microsoft.Extensions.Logging;

    /// <summary>
    ///     The <see cref="LoggingConfig" />
    ///     class is used to configure how logging operates.
    /// </summary>
    public class LoggingConfig
    {
        private ILogFormatter _formatter;
        private ILogFormatter _scopeFormatter;

        /// <summary>
        ///     Initializes a new instance of the <see cref="LoggingConfig" /> class.
        /// </summary>
        public LoggingConfig()
        {
            _formatter = new DefaultFormatter(this);
            _scopeFormatter = new DefaultScopeFormatter(this);
        }

        /// <summary>
        ///     Gets or sets a custom formatting for rendering log messages to xUnit test output.
        /// </summary>
        public ILogFormatter Formatter
        {
            get => _formatter;
            set =>
                _formatter = value ?? throw new ArgumentNullException(nameof(value));
        }

        /// <summary>
        ///     Gets or sets whether exceptions thrown while logging outside of the test execution will be ignored.
        /// </summary>
        public bool IgnoreTestBoundaryException { get; set; }

        /// <summary>
        ///     Gets or sets the minimum logging level.
        /// </summary>
        public LogLevel LogLevel { get; set; } = LogLevel.Trace;

        /// <summary>
        ///     Gets or sets a custom formatting for rendering scope beginning and end messages to xUnit test output.
        /// </summary>
        public ILogFormatter ScopeFormatter
        {
            get => _scopeFormatter;
            set =>
                _scopeFormatter = value ?? throw new ArgumentNullException(nameof(value));
        }

        /// <summary>
        ///     Identifies the number of spaces to use for indenting scopes.
        /// </summary>
        public int ScopePaddingSpaces { get; set; } = 3;

        /// <summary>
        ///     Gets the set of sensitive values that should be filtered out when writing log messages.
        /// </summary>
        public Collection<string> SensitiveValues { get; } = new();
    }
}