[#262] made Browser constructor with DriverService parameter with nul…

…l by default
aquality-automation · Sep 18, 2024 · d09a50d · d09a50d
1 parent 1b645ee
commit d09a50d
Show file tree

Hide file tree

Showing 9 changed files with 47 additions and 36 deletions.
diff --git a/Aquality.Selenium/src/Aquality.Selenium/Aquality.Selenium.csproj b/Aquality.Selenium/src/Aquality.Selenium/Aquality.Selenium.csproj
@@ -16,7 +16,6 @@
     <PackageLicenseFile>LICENSE</PackageLicenseFile>
     <Copyright>Copyright 2024 Aquality Automation</Copyright>
     <IsPackable>true</IsPackable>
-    <LangVersion>8</LangVersion>
   </PropertyGroup>
 
   <PropertyGroup>

diff --git a/Aquality.Selenium/src/Aquality.Selenium/Aquality.Selenium.xml b/Aquality.Selenium/src/Aquality.Selenium/Aquality.Selenium.xml
diff --git a/Aquality.Selenium/src/Aquality.Selenium/Browsers/Browser.cs b/Aquality.Selenium/src/Aquality.Selenium/Browsers/Browser.cs
@@ -26,17 +26,19 @@ public class Browser : IApplication
 
         private readonly IBrowserProfile browserProfile;
         private readonly IConditionalWait conditionalWait;
+        private readonly DriverService driverService;
 
         /// <summary>
         /// Instantiate browser.
         /// </summary>
-        /// <param name="driverContext">Context of the webdriver (for example: DriverService is a part of context)</param>
-        public Browser(DriverContext driverContext)
+        /// <param name="webDriver">Instance of Selenium WebDriver for desired web browser.</param>
+        /// <param name="driverService">Exposes the service provided by a native WebDriver server executable.</param>
+        public Browser(WebDriver webDriver, DriverService driverService = null)
         {
-            Driver = driverContext.Driver;
-            DriverContext = driverContext;
-            Network = new NetworkHandling(driverContext.Driver);
-            JavaScriptEngine = new JavaScriptHandling(driverContext.Driver);
+            Driver = webDriver;
+            this.driverService = driverService;
+            Network = new NetworkHandling(webDriver);
+            JavaScriptEngine = new JavaScriptHandling(webDriver);
             Logger = AqualityServices.LocalizedLogger;
             LocalizationManager = AqualityServices.Get<ILocalizationManager>();
             browserProfile = AqualityServices.Get<IBrowserProfile>();
@@ -58,9 +60,21 @@ public Browser(DriverContext driverContext)
         public WebDriver Driver { get; }
 
         /// <summary>
-        /// Container of WebDriver and other objects which are involved into webdriver instantiation process
+        /// Exposes the service provided by a native WebDriver server executable.
         /// </summary>
-        public DriverContext DriverContext { get; }
+        public DriverService DriverService
+        {
+            get
+            {
+                if (driverService != null)
+                {
+                    return driverService;
+                }
+
+                throw new InvalidOperationException("DriverService hasn't been provided during Browser instantiation." +
+                                                    "\nPlease, check your BrowserFactory if it passes DriverService during the Browser instantiation.");
+            }
+        }
 
         /// <summary>
         /// Provides Network Handling functionality <see cref="NetworkHandling"/>

diff --git a/Aquality.Selenium/src/Aquality.Selenium/Browsers/BrowserFactory.cs b/Aquality.Selenium/src/Aquality.Selenium/Browsers/BrowserFactory.cs
@@ -25,14 +25,20 @@ protected BrowserFactory(IActionRetrier actionRetrier, IBrowserProfile browserPr
         protected ILocalizedLogger LocalizedLogger { get; }
 
         protected abstract WebDriver Driver { get; }
-        protected abstract DriverContext DriverContext { get; }
+        protected virtual DriverContext DriverContext { get; }
 
         public virtual Browser Browser
         {
             get
             {
-                var driverCtx = ActionRetrier.DoWithRetry(() => DriverContext, new[] { typeof(WebDriverException), typeof(InvalidOperationException) });
-                var browser = new Browser(driverCtx);
+                var driverCtx = ActionRetrier.DoWithRetry(() => DriverContext,
+                    new[] { typeof(WebDriverException), typeof(InvalidOperationException) });
+
+                Browser browser;
+                browser = driverCtx != null 
+                    ? new Browser(driverCtx.Driver, driverCtx.DriverService) 
+                    : new Browser(ActionRetrier.DoWithRetry(() => Driver, new[] { typeof(WebDriverException), typeof(InvalidOperationException) }));
+
                 LocalizedLogger.Info("loc.browser.ready", BrowserProfile.BrowserName);
                 return browser;
             }

diff --git a/Aquality.Selenium/src/Aquality.Selenium/Browsers/DriverContext.cs b/Aquality.Selenium/src/Aquality.Selenium/Browsers/DriverContext.cs
@@ -1,16 +1,16 @@
-#nullable enable
-using OpenQA.Selenium;
+using OpenQA.Selenium;
 
 namespace Aquality.Selenium.Browsers
 {
     public class DriverContext
     {
-        public DriverContext(WebDriver driver)
+        public DriverContext(WebDriver driver, DriverService driverService)
         {
             Driver = driver;
+            DriverService = driverService;
         }
 
         public WebDriver Driver { get; }
-        public DriverService? DriverService { get; set; }
+        public DriverService DriverService { get; }
     }
 }
diff --git a/Aquality.Selenium/src/Aquality.Selenium/Browsers/LocalBrowserFactory.cs b/Aquality.Selenium/src/Aquality.Selenium/Browsers/LocalBrowserFactory.cs
@@ -111,10 +111,7 @@ private DriverContext CreateWebDriverInstance<T>(Func<DriverService> driverServi
         {
             var driverService = driverServiceProvider.Invoke();
             var driver = (T)Activator.CreateInstance(typeof(T), driverService, driverOptions, commandTimeout);
-            var context = new DriverContext(driver)
-            {
-                DriverService = driverService
-            };
+            var context = new DriverContext(driver, driverService);
             return context;
         }
     }

diff --git a/Aquality.Selenium/src/Aquality.Selenium/Browsers/RemoteBrowserFactory.cs b/Aquality.Selenium/src/Aquality.Selenium/Browsers/RemoteBrowserFactory.cs
@@ -28,7 +28,7 @@ protected override DriverContext DriverContext
                 try
                 {
                     var driver = new RemoteWebDriver(BrowserProfile.RemoteConnectionUrl, capabilities, TimeoutConfiguration.Command);
-                    var context = new DriverContext(driver);
+                    var context = new DriverContext(driver, null);
                     return context;
                 }
                 catch (Exception e)

diff --git a/Aquality.Selenium/tests/Aquality.Selenium.Tests/Integration/BrowserTests.cs b/Aquality.Selenium/tests/Aquality.Selenium.Tests/Integration/BrowserTests.cs
@@ -262,7 +262,7 @@ public void Should_BePossibleTo_GetDownloadDir()
         [Test]
         public void Should_BePossibleTo_GetAccessToDriverContext()
         {
-            var driverProcessId = AqualityServices.Browser.DriverContext.DriverService?.ProcessId;
+            var driverProcessId = AqualityServices.Browser.DriverService?.ProcessId;
             Assert.That(driverProcessId, Is.Not.Null.And.Not.EqualTo(0), "DriverProcessId should not be null or zero.");
         }
     }

diff --git a/....Selenium/tests/Aquality.Selenium.Tests/Integration/Usecases/CustomBrowserFactoryTests.cs b/....Selenium/tests/Aquality.Selenium.Tests/Integration/Usecases/CustomBrowserFactoryTests.cs
@@ -52,22 +52,16 @@ public CustomLocalBrowserFactory() :
             {
             }
 
-            protected override WebDriver Driver => DriverContext.Driver;
-
-            protected override DriverContext DriverContext {
+            protected override WebDriver Driver
+            {
                 get
                 {
                     var driverSettings = BrowserProfile.DriverSettings;
                     SetUpDriver(new());
-                    var driverService = ChromeDriverService.CreateDefaultService();
-                    var driver = new ChromeDriver(driverService, (ChromeOptions)driverSettings.DriverOptions);
-                    return new DriverContext(driver)
-                    {
-                        DriverService = driverService
-                    };
+                    return new ChromeDriver((ChromeOptions)driverSettings.DriverOptions);
                 }
             }
-
+            
             private static void SetUpDriver(ChromeConfig driverConfig)
             {
                 var architecture = ArchitectureHelper.GetArchitecture();