FileFlowsPlugins/PluginTestLibrary/_TestLogger.cs

using FileFlows.Plugin;

#if (DEBUG)

namespace PluginTestLibrary;

/// <summary>
/// A logger for tests that stores the logs in memory
/// </summary>
public class TestLogger : ILogger
{
    private readonly List<string> Messages = new();

    /// <summary>
    /// Writes an information log message
    /// </summary>
    /// <param name="args">the log parameters</param>
    public void ILog(params object[] args)
        => Log(LogType.Info, args);

    /// <inheritdoc />
    public void Raw(params object[] args)
        => Log(LogType.Raw, args);

    /// <summary>
    /// Writes an debug log message
    /// </summary>
    /// <param name="args">the log parameters</param>
    public void DLog(params object[] args)
        => Log(LogType.Debug, args);

    /// <summary>
    /// Writes an warning log message
    /// </summary>
    /// <param name="args">the log parameters</param>
    public void WLog(params object[] args)
        => Log(LogType.Warning, args);

    /// <summary>
    /// Writes an error log message
    /// </summary>
    /// <param name="args">the log parameters</param>
    public void ELog(params object[] args)
        => Log(LogType.Error, args);

    /// <summary>
    /// Gets the tail of the log
    /// </summary>
    /// <param name="length">the number of messages to get</param>
    public string GetTail(int length = 50)
    {
        if (Messages.Count <= length)
            return string.Join(Environment.NewLine, Messages);
        return string.Join(Environment.NewLine, Messages.TakeLast(50));
    }

    /// <summary>
    /// Logs a message
    /// </summary>
    /// <param name="type">the type of log to record</param>
    /// <param name="args">the arguments of the message</param>
    private void Log(LogType type, params object[] args)
    {
        string prefix = type == LogType.Raw ? string.Empty : type + " -> ";
        string message = prefix + string.Join(", ", args.Select(x =>
            x == null ? "null" :
            x.GetType().IsPrimitive ? x.ToString() :
            x is string ? x.ToString() :
            System.Text.Json.JsonSerializer.Serialize(x)));
        Writer?.Invoke(message);
        Messages.Add(message);
    }

    /// <summary>
    /// Gets or sets an optional writer
    /// </summary>
    public Action<string> Writer { get; set; } = null!;

    /// <summary>
    /// Returns the entire log as a string
    /// </summary>
    /// <returns>the entire log</returns>
    public override string ToString()
        => string.Join(Environment.NewLine, Messages);

    /// <summary>
    /// Checks if the log contains the text
    /// </summary>
    /// <param name="text">the text to check for</param>
    /// <returns>true if it contains it, otherwise false</returns>
    public bool Contains(string text)
        => Messages.Any(x => x.Contains(text));
}

#endif