dotnet/test/common/GetLogsTest.cs

// <copyright file="GetLogsTest.cs" company="Selenium Committers">
// Licensed to the Software Freedom Conservancy (SFC) under one
// or more contributor license agreements.  See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership.  The SFC licenses this file
// to you under the Apache License, Version 2.0 (the
// "License"); you may not use this file except in compliance
// with the License.  You may obtain a copy of the License at
//
//   http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing,
// software distributed under the License is distributed on an
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied.  See the License for the
// specific language governing permissions and limitations
// under the License.
// </copyright>

using NUnit.Framework;
using OpenQA.Selenium.Chrome;
using System.Collections.Generic;
using System.Collections.ObjectModel;

namespace OpenQA.Selenium;

[TestFixture]
[IgnoreBrowser(Browser.Firefox, "Firefox driver (when using Marionette/Geckodriver) does not support logs API")]
[IgnoreBrowser(Browser.IE, "IE driver does not support logs API")]
[IgnoreBrowser(Browser.Safari, "Edge driver does not support logs API")]
public class GetLogsTest : DriverTestFixture
{
    private IWebDriver localDriver;

    [TearDown]
    public void QuitDriver()
    {
        if (localDriver != null)
        {
            localDriver.Quit();
            localDriver = null;
        }
    }

    //[Test]
    public void LogBufferShouldBeResetAfterEachGetLogCall()
    {
        ReadOnlyCollection<string> logTypes = driver.Manage().Logs.AvailableLogTypes;
        foreach (string logType in logTypes)
        {
            driver.Url = simpleTestPage;
            ReadOnlyCollection<LogEntry> firstEntries = driver.Manage().Logs.GetLog(logType);
            if (firstEntries.Count > 0)
            {
                ReadOnlyCollection<LogEntry> secondEntries = driver.Manage().Logs.GetLog(logType);
                Assert.That(HasOverlappingLogEntries(firstEntries, secondEntries), Is.False, string.Format("There should be no overlapping log entries in consecutive get log calls for {0} logs", logType));
            }
        }
    }

    //[Test]
    public void DifferentLogsShouldNotContainTheSameLogEntries()
    {
        driver.Url = simpleTestPage;
        Dictionary<string, ReadOnlyCollection<LogEntry>> logTypeToEntriesDictionary = new Dictionary<string, ReadOnlyCollection<LogEntry>>();
        ReadOnlyCollection<string> logTypes = driver.Manage().Logs.AvailableLogTypes;
        foreach (string logType in logTypes)
        {
            logTypeToEntriesDictionary.Add(logType, driver.Manage().Logs.GetLog(logType));
        }

        foreach (string firstLogType in logTypeToEntriesDictionary.Keys)
        {
            foreach (string secondLogType in logTypeToEntriesDictionary.Keys)
            {
                if (firstLogType != secondLogType)
                {
                    Assert.That(HasOverlappingLogEntries(logTypeToEntriesDictionary[firstLogType], logTypeToEntriesDictionary[secondLogType]), Is.False, string.Format("Two different log types ({0}, {1}) should not contain the same log entries", firstLogType, secondLogType));
                }
            }
        }
    }

    //[Test]
    public void TurningOffLogShouldMeanNoLogMessages()
    {
        ReadOnlyCollection<string> logTypes = driver.Manage().Logs.AvailableLogTypes;
        foreach (string logType in logTypes)
        {
            CreateWebDriverWithLogging(logType, LogLevel.Off);
            ReadOnlyCollection<LogEntry> entries = localDriver.Manage().Logs.GetLog(logType);
            Assert.That(entries, Is.Empty, string.Format("There should be no log entries for log type {0} when logging is turned off.", logType));
            QuitDriver();
        }
    }

    private void CreateWebDriverWithLogging(string logType, LogLevel logLevel)
    {
        if (TestUtilities.IsChrome(driver))
        {
            ChromeOptions options = new ChromeOptions();
            options.SetLoggingPreference(logType, logLevel);
            localDriver = new ChromeDriver(options);
        }

        localDriver.Url = simpleTestPage;
    }

    private bool HasOverlappingLogEntries(ReadOnlyCollection<LogEntry> firstLog, ReadOnlyCollection<LogEntry> secondLog)
    {
        foreach (LogEntry firstEntry in firstLog)
        {
            foreach (LogEntry secondEntry in secondLog)
            {
                if (firstEntry.Level == secondEntry.Level && firstEntry.Message == secondEntry.Message && firstEntry.Timestamp == secondEntry.Timestamp)
                {
                    return true;
                }
            }
        }

        return false;
    }
}