WebDriverFactoryIntegrationTests.cs

using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.DependencyInjection;
using OpenQA.Selenium;

namespace CSF.Extensions.WebDriver.Factories;

[TestFixture,Parallelizable]
public class WebDriverFactoryIntegrationTests
{
    [Test]
    public void GetDefaultWebDriverShouldThrowAnExceptionBecauseOfAnInvalidUrlScheme()
    {
        var services = GetServiceProvider();
        var driverFactory = services.GetRequiredService<IGetsWebDriver>();
        Assert.That(() => driverFactory.GetDefaultWebDriver(), Throws.InstanceOf<NotSupportedException>().And.Message.Contains("'invalid'"));
    }

    [Test]
    public void GetDefaultWebDriverAfterConfigurationCallbackShouldThrowAnExceptionBecauseOfANonsenseUrlScheme()
    {
        var services = GetServiceProvider(o => o.SelectedConfiguration = "DefaultNonsense");
        var driverFactory = services.GetRequiredService<IGetsWebDriver>();
        Assert.That(() => driverFactory.GetDefaultWebDriver(), Throws.InstanceOf<NotSupportedException>().And.Message.Contains("'nonsense'"));
    }

    [Test]
    public void GetDefaultWebDriverShouldReturnADriverProxyWithIdentification()
    {
        var services = GetServiceProvider(o => o.SelectedConfiguration = "DefaultFake");
        var driverFactory = services.GetRequiredService<IGetsWebDriver>();
        using var driver = driverFactory.GetDefaultWebDriver();
        Assert.That(() => driver.WebDriver.GetBrowserId(), Is.Not.Null);
    }

    [Test]
    public void GetWebDriverWithOptionsShouldNotThrow()
    {
        var services = GetServiceProvider(o => o.SelectedConfiguration = "FakeWithOptions");
        var driverFactory = services.GetRequiredService<IGetsWebDriver>();
        using var driver = driverFactory.GetDefaultWebDriver();
        Assert.That(() => driver.WebDriver.GetBrowserId(), Is.Not.Null);
    }

    [Test]
    public void DriverTypeNorOptionsTypeShouldBeMandatoryIfACustomFactoryTypeIsSpecified()
    {
        var services = GetServiceProvider(o => o.SelectedConfiguration = "OmittedDriverAndOptionsType");
        var driverFactory = services.GetRequiredService<IGetsWebDriver>();
        using var driver = driverFactory.GetDefaultWebDriver();
        Assert.That(() => driver.WebDriver.GetBrowserId(), Is.Not.Null);
    }

    [Test]
    public void GetWebDriverShouldReturnADriverWithTheCorrectQuirksForChrome()
    {
        var services = GetServiceProvider(extraRegistrations: services => services.AddWebDriverQuirks(GetCommonBrowserQuirks()));

        var driverFactory = services.GetRequiredService<IGetsWebDriver>();
        using var driver = driverFactory.GetWebDriver("Chrome");

        Assert.Multiple(() =>
        {
            Assert.That(driver.WebDriver.HasQuirk("IAmChrome"), Is.True, "Chrome quirk");
            Assert.That(driver.WebDriver.HasQuirk("IAmFirefox"), Is.False, "Firefox quirk");            
        });
    }

    [Test]
    public void GetWebDriverShouldReturnADriverWithTheCorrectQuirksForFirefox()
    {
        var services = GetServiceProvider(extraRegistrations: services => services.AddWebDriverQuirks(GetCommonBrowserQuirks()));

        var driverFactory = services.GetRequiredService<IGetsWebDriver>();
        using var driver = driverFactory.GetWebDriver("Firefox");

        Assert.Multiple(() =>
        {
            Assert.That(driver.WebDriver.HasQuirk("IAmChrome"), Is.False, "Chrome quirk");
            Assert.That(driver.WebDriver.HasQuirk("IAmFirefox"), Is.True, "Firefox quirk");            
        });
    }

    Quirks.QuirksData GetCommonBrowserQuirks()
    {
        return new ()
        {
            Quirks = new Dictionary<string, Quirks.BrowserInfoCollection>
            {
                { "IAmChrome", new () { AffectedBrowsers = new HashSet<Quirks.BrowserInfo>() { new () { Name = "chrome" } } } },
                { "IAmFirefox", new () { AffectedBrowsers = new HashSet<Quirks.BrowserInfo>() { new () { Name = "firefox" } } } },
            }
        };
    }

    IServiceProvider GetServiceProvider(Action<WebDriverCreationOptionsCollection>? configureOptions = null,
                                        Action<IServiceCollection>? extraRegistrations = null)
    {
        var services = new ServiceCollection();
        services.AddSingleton(GetConfiguration());
        services.AddWebDriverFactory(configureOptions: configureOptions);
        extraRegistrations?.Invoke(services);
        services.AddLogging();
        return services.BuildServiceProvider();
    }

    IConfiguration GetConfiguration()
    {
        return new ConfigurationBuilder()
            .AddJsonFile("appsettings.WebDriverFactoryIntegrationTests.json")
            .Build();
    }

    public class FakeWebDriverFactory : ICreatesWebDriverFromOptions
    {
        public WebDriverAndOptions GetWebDriver(WebDriverCreationOptions options, Action<DriverOptions>? supplementaryConfiguration = null)
        {
            return new(Mock.Of<IWebDriver>(), Mock.Of<DriverOptions>());
        }
    }

    public class FakeOptionsUsingWebDriverFactory : ICreatesWebDriverFromOptions
    {
        public WebDriverAndOptions GetWebDriver(WebDriverCreationOptions options, Action<DriverOptions>? supplementaryConfiguration = null)
        {
            return new(Mock.Of<IWebDriver>(), options.OptionsFactory());
        }
    }
}