Class Logs

dotnet/src/webdriver/Logs.cs:27–100

Provides a mechanism for examining logs for the driver during the test.

/// Provides a mechanism for examining logs for the driver during the test.
/// </summary>
public class Logs : ILogs
{
    private readonly WebDriver driver;

    /// <summary>
    /// Initializes a new instance of the <see cref="Logs"/> class.
    /// </summary>
    /// <param name="driver">Instance of the driver currently in use</param>
    /// <exception cref="ArgumentNullException">If <paramref name="driver"/> is <see langword="null"/>.</exception>
    public Logs(WebDriver driver)
    {
        ArgumentNullException.ThrowIfNull(driver);
        this.driver = driver;
    }

    /// <summary>
    /// Gets the list of available log types for this driver.
    /// </summary>
    public ReadOnlyCollection<string> AvailableLogTypes
    {
        get
        {
            List<string> availableLogTypes = new List<string>();
            try
            {
                Response commandResponse = this.driver.Execute(DriverCommand.GetAvailableLogTypes, null);
                if (commandResponse.Value is object[] responseValue)
                {
                    foreach (object logKind in responseValue)
                    {
                        availableLogTypes.Add(logKind.ToString()!);
                    }
                }
            }
            catch (NotImplementedException)
            {
                // Swallow for backwards compatibility
            }

            return availableLogTypes.AsReadOnly();
        }
    }

    /// <summary>
    /// Gets the set of <see cref="LogEntry"/> objects for a specified log.
    /// </summary>
    /// <param name="logKind">The log for which to retrieve the log entries.
    /// Log types can be found in the <see cref="LogType"/> class.</param>
    /// <returns>The list of <see cref="LogEntry"/> objects for the specified log.</returns>
    /// <exception cref="ArgumentNullException">If <paramref name="logKind"/> is <see langword="null"/>.</exception>
    public ReadOnlyCollection<LogEntry> GetLog(string logKind)
    {
        ArgumentNullException.ThrowIfNull(logKind);

        List<LogEntry> entries = new List<LogEntry>();

        Dictionary<string, object?> parameters = new Dictionary<string, object?>();
        parameters.Add("type", logKind);