dotnet/test/testing.nunit/DriverTestFixture.cs

// <copyright file="DriverTestFixture.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.Interfaces;
using OpenQA.Selenium.Support.UI;
using OpenQA.Selenium.Testing.NUnit.Environment;

namespace OpenQA.Selenium.Testing.NUnit;

public abstract class DriverTestFixture
{
    protected static UrlBuilder Urls => EnvironmentManager.Instance.WebServer.Urls;

    protected internal IWebDriver Driver { get; set; }

    public bool IsNativeEventsEnabled
    {
        get
        {
            if (Driver is IHasCapabilities capabilitiesDriver &&
                capabilitiesDriver.Capabilities.HasCapability(CapabilityType.HasNativeEvents) &&
                (bool)capabilitiesDriver.Capabilities.GetCapability(CapabilityType.HasNativeEvents))
            {
                return true;
            }

            return false;
        }
    }

    protected DriverFactory DriverFactory { get; private set; }

    [OneTimeSetUp]
    public void InitFixtureDriver()
    {
        DriverFactory = CreateDriverFactory();
        Driver = CreateDriverInstance();
    }

    [OneTimeTearDown]
    public void DisposeFixtureDriver()
    {
        Driver?.Dispose();
        Driver = null;
    }

    [TearDown]
    public void ResetOnError()
    {
        if (TestContext.CurrentContext.Result.Outcome == ResultState.Error)
        {
            Driver?.Dispose();
            Driver = CreateDriverInstance();
        }
    }

    protected virtual DriverFactory CreateDriverFactory()
    {
        return new DriverFactory(EnvironmentManager.Instance);
    }

    protected virtual void ConfigureDriverOptions(DriverOptions options)
    {
    }

    protected IWebDriver CreateDriverInstance(DriverOptions options = null, Action<DriverOptions> configureOptions = null)
    {
        return DriverFactory.CreateDriver(options, configureOptions: driverOptions =>
        {
            ConfigureDriverOptions(driverOptions);
            configureOptions?.Invoke(driverOptions);
        });
    }

    protected internal void CloseDriver()
    {
        Driver?.Dispose();
        Driver = null;
    }

    protected internal void CreateFreshDriver()
    {
        CloseDriver();
        Driver = CreateDriverInstance();
    }

    protected void WaitFor(Func<bool> waitFunction, string timeoutMessage)
    {
        WaitFor<bool>(waitFunction, timeoutMessage);
    }

    protected T WaitFor<T>(Func<T> waitFunction, string timeoutMessage)
    {
        return WaitFor(waitFunction, TimeSpan.FromSeconds(5), timeoutMessage);
    }

    protected T WaitFor<T>(Func<T> waitFunction, TimeSpan timeout, string timeoutMessage)
    {
        // Not bound to Driver: callers may wait on a local driver while the fixture driver is closed.
        var waiter = new DefaultWait<Func<T>>(waitFunction)
        {
            Timeout = timeout,
            PollingInterval = TimeSpan.FromMilliseconds(100),
            Message = $"Condition timed out: {timeoutMessage}",
        };

        waiter.IgnoreExceptionTypes(typeof(Exception));

        return waiter.Until(func => func());
    }
}