Merge pull request #48 from csf-dev/47-hanging-build

WIP #47 - Attempt to fix hanging build

Author: craigfowler

.appveyor.yml

@@ -4,7 +4,11 @@ init:
 - cmd: git config --global core.autocrlf true
 before_build:
     - dotnet tool update -g docfx
+    # I need to install ChromeDriver from Chcolatey because the preinstalled ChromeDriver is
+    # not compatible with the Chrome browser version installed by the Visual Studio 2022 image
+    # This originally caused tests to fail and also to hang, which caused issue #47.
     - choco install chromedriver
+    - cmd: PATH=C:\ProgramData\chocolatey\lib\chromedriver\tools\chromedriver-win32;%PATH%
 build_script:
     - dotnet build
     - docfx CSF.Extensions.WebDriver.Docs\docfx.json

CSF.Extensions.WebDriver.Tests/Factories/WebDriverFactoryIntegrationTests.cs

@@ -28,7 +28,8 @@ public void GetDefaultWebDriverShouldReturnADriverProxyWithIdentification()
     {
         var services = GetServiceProvider(o => o.SelectedConfiguration = "DefaultFake");
         var driverFactory = services.GetRequiredService<IGetsWebDriver>();
-        Assert.That(() => driverFactory.GetDefaultWebDriver().WebDriver.GetBrowserId(), Is.Not.Null);
+        using var driver = driverFactory.GetDefaultWebDriver();
+        Assert.That(() => driver.WebDriver.GetBrowserId(), Is.Not.Null);
     }
 
     IServiceProvider GetServiceProvider(Action<WebDriverCreationOptionsCollection>? configureOptions = null)

CSF.Extensions.WebDriver.Tests/Factories/WebDriverFromOptionsFactoryTests.cs

@@ -1,5 +1,3 @@
-using System.Reflection;
-using OpenQA.Selenium;
 using OpenQA.Selenium.Chrome;
 
 namespace CSF.Extensions.WebDriver.Factories;
@@ -17,29 +15,8 @@ public void GetWebDriverShouldCreateALocalChromeDriverFromAppropriateOptions([St
             OptionsFactory = () => new ChromeOptions(),
         };
 
-        try
-        {
-            using var driver = sut.GetWebDriver(options).WebDriver;
-            Assert.That(driver, Is.Not.Null);
-        }
-        catch (Exception e) when (e is TargetInvocationException { InnerException: DriverServiceNotFoundException } or DriverServiceNotFoundException)
-        {
-            Assert.Pass("Despite the exception raised, this is only because the driver isn't installed on the environment running the test; this is more than enough to prove that the driver was being created.");
-        }
-        catch(TargetInvocationException e) when (e is { InnerException: InvalidOperationException })
-        {
-            if(e.InnerException.Message.StartsWith("session not created:"))
-                Assert.Pass("Despite the exception raised, this is only because the wrong version of the driver is installed on the environment running the test; this is more than enough to prove that the driver was being created.");
-            else
-                throw;
-        }
-        catch(InvalidOperationException invOpEx)
-        {
-            if(invOpEx.Message.StartsWith("session not created:"))
-                Assert.Pass("Despite the exception raised, this is only because the wrong version of the driver is installed on the environment running the test; this is more than enough to prove that the driver was being created.");
-            else
-                throw;
-        }
+        using var driver = sut.GetWebDriver(options).WebDriver;
+        Assert.That(driver, Is.Not.Null);
     }
 
     [Test,AutoMoqData]
@@ -53,23 +30,7 @@ public void GetWebDriverShouldCustomiseDriverOptionsWithCallbackWhenItIsSpecifie
             OptionsFactory = () => driverOptions,
         };
 
-        try
-        {
-            using var driver = sut.GetWebDriver(options, o => o.AddAdditionalOption("Foo", "Bar")).WebDriver;
-        }
-        catch (Exception e) when (e is TargetInvocationException { InnerException: DriverServiceNotFoundException } or DriverServiceNotFoundException)
-        {
-            // Intentionally ignore this exception; we know it's going to fail but I care only about how the options were manipulated in this test.
-        }
-        catch(TargetInvocationException e) when (e is { InnerException: InvalidOperationException })
-        {
-            // Intentionally ignore this exception; we know it's going to fail but I care only about how the options were manipulated in this test.
-        }
-        catch(InvalidOperationException)
-        {
-            // Intentionally ignore this exception; we know it's going to fail but I care only about how the options were manipulated in this test.
-        }
-                
+        using var driver = sut.GetWebDriver(options, o => o.AddAdditionalOption("Foo", "Bar")).WebDriver;
         Assert.That(driverOptions.ToCapabilities()["Foo"], Is.EqualTo("Bar"));
     }
 }

CSF.Extensions.WebDriver/Factories/WebDriverAndOptions.cs

@@ -4,14 +4,17 @@
 namespace CSF.Extensions.WebDriver.Factories
 {
     /// <summary>A model containing a WebDriver and the <see cref="DriverOptions"/> which were used to create it.</summary>
-    public class WebDriverAndOptions
+    public sealed class WebDriverAndOptions : IDisposable
     {
         /// <summary>Gets the WebDriver</summary>
         public IWebDriver WebDriver { get; }
 
         /// <summary>Gets the <see cref="DriverOptions"/> which were used to create the <see cref="WebDriver"/></summary>
         public DriverOptions DriverOptions { get; }
 
+        /// <inheritdoc/>
+        public void Dispose() => WebDriver.Dispose();
+
         /// <summary>
         /// Initialises a new instance of <see cref="WebDriverAndOptions"/>.
         /// </summary>