[dotnet] Re-pack Selenium Manager as native dependency

dotnet/src/webdriver/BUILD.bazel

@@ -162,21 +162,21 @@ csharp_library(
 )
 
 copy_file(
-    name = "readme",
-    src = "//dotnet/src/webdriver/assets:README.md",
+    name = "assets-nuget-readme",
+    src = "//dotnet/src/webdriver/assets:nuget/README.md",
     out = "README.md",
 )
 
 copy_file(
-    name = "props",
-    src = "//dotnet/src/webdriver/assets:Selenium.WebDriver.targets",
+    name = "assets-nuget-build-netstandard20-targets",
+    src = "//dotnet/src/webdriver/assets:nuget/build/netstandard2.0/Selenium.WebDriver.targets",
     out = "Selenium.WebDriver.targets",
 )
 
 copy_file(
-    name = "transitive-props",
-    src = "//dotnet/src/webdriver/assets:Selenium.WebDriver.targets",
-    out = "transitive.Selenium.WebDriver.targets",
+    name = "assets-nuget-buildtransitive-netstandard20-targets",
+    src = "//dotnet/src/webdriver/assets:nuget/buildTransitive/netstandard2.0/Selenium.WebDriver.targets",
+    out = "transitiveSelenium.WebDriver.targets",
 )
 
 copy_file(
@@ -207,9 +207,9 @@ nuget_pack(
         "//common/manager:selenium-manager-linux": "manager/linux/selenium-manager",
         "//common/manager:selenium-manager-macos": "manager/macos/selenium-manager",
         "//common/manager:selenium-manager-windows": "manager/windows/selenium-manager.exe",
-        ":readme": "README.md",
-        ":props": "build/Selenium.WebDriver.targets",
-        ":transitive-props": "buildTransitive/Selenium.WebDriver.targets",
+        ":assets-nuget-readme": "README.md",
+        ":assets-nuget-build-netstandard20-targets": "build/netstandard2.0/Selenium.WebDriver.targets",
+        ":assets-nuget-buildtransitive-netstandard20-targets": "buildTransitive/netstandard2.0/Selenium.WebDriver.targets",
     },
     id = "Selenium.WebDriver",
     libs = {
@@ -233,9 +233,9 @@ nuget_pack(
         "//common/manager:selenium-manager-linux": "manager/linux/selenium-manager",
         "//common/manager:selenium-manager-macos": "manager/macos/selenium-manager",
         "//common/manager:selenium-manager-windows": "manager/windows/selenium-manager.exe",
-        ":readme": "README.md",
-        ":props": "build/Selenium.WebDriver.StrongNamed.targets",
-        ":transitive-props": "buildTransitive/Selenium.WebDriver.StrongNamed.targets",
+        ":assets-nuget-readme": "README.md",
+        ":assets-nuget-build-netstandard20-targets": "build/netstandard2.0/Selenium.WebDriver.StrongNamed.targets",
+        ":assets-nuget-buildtransitive-netstandard20-targets": "buildTransitive/netstandard2.0/Selenium.WebDriver.StrongNamed.targets",
     },
     id = "Selenium.WebDriver.StrongNamed",
     libs = {

dotnet/src/webdriver/Selenium.WebDriver.StrongNamed.nuspec

@@ -43,12 +43,12 @@
     <file src="lib/net8.0/WebDriver.StrongNamed.pdb" target="lib/net8.0/WebDriver.StrongNamed.pdb" />
     <file src="lib/net8.0/WebDriver.StrongNamed.xml" target="lib/net8.0/WebDriver.StrongNamed.xml" />
 
-    <file src="build/Selenium.WebDriver.StrongNamed.targets" target="build/Selenium.WebDriver.StrongNamed.targets"/>
-    <file src="buildTransitive/Selenium.WebDriver.StrongNamed.targets" target="buildTransitive/Selenium.WebDriver.StrongNamed.targets"/>
+    <file src="build/netstandard2.0/Selenium.WebDriver.StrongNamed.targets" target="build/netstandard2.0/Selenium.WebDriver.StrongNamed.targets"/>
+    <file src="buildTransitive/netstandard2.0/Selenium.WebDriver.StrongNamed.targets" target="buildTransitive/netstandard2.0/Selenium.WebDriver.StrongNamed.targets"/>
 
-    <file src="manager/linux/selenium-manager" target="manager/linux/selenium-manager" />
-    <file src="manager/macos/selenium-manager" target="manager/macos/selenium-manager" />
-    <file src="manager/windows/selenium-manager.exe" target="manager/windows/selenium-manager.exe" />
+    <file src="manager/linux/selenium-manager" target="runtimes/linux/native/selenium-manager" />
+    <file src="manager/macos/selenium-manager" target="runtimes/osx/native/selenium-manager" />
+    <file src="manager/windows/selenium-manager.exe" target="runtimes/win/native/selenium-manager.exe" />
 
     <file src="icon.png" />
     <file src="README.md" />

dotnet/src/webdriver/Selenium.WebDriver.csproj

@@ -43,6 +43,10 @@
     <GenerateDocumentationFile>true</GenerateDocumentationFile>
   </PropertyGroup>
 
+  <PropertyGroup>
+    <BaseSeleniumManagerPath>$(MSBuildThisFileDirectory)..\..\..\bazel-bin\dotnet\src\webdriver\manager</BaseSeleniumManagerPath>
+  </PropertyGroup>
+
   <!--TODO when AOT is ready https://github.com/SeleniumHQ/selenium/issues/14480-->
   <!--<PropertyGroup Condition="$([MSBuild]::IsTargetFrameworkCompatible('$(TargetFramework)', 'net8.0'))">
     <IsAotCompatible>true</IsAotCompatible>
@@ -56,29 +60,25 @@
     <PackageReference Include="System.Text.Json" Version="8.0.5" />
   </ItemGroup>
 
-  <PropertyGroup>
-    <BaseImagePath>..\..\..\bazel-bin\dotnet\src\webdriver\images</BaseImagePath>
-  </PropertyGroup>
-
   <ItemGroup>
-    <None Include="assets\Selenium.WebDriver.targets" Pack="true" PackagePath="build\" />
-    <None Include="assets\Selenium.WebDriver.targets" Pack="true" PackagePath="buildTransitive\" />
-
-    <None Include="$(BaseImagePath)\selenium_logo_small.png" Pack="true" PackagePath="logo.png" Visible="false" />
-
-    <None Include="$(BaseSeleniumManagerPath)\linux\selenium-manager" Pack="true" PackagePath="manager\linux" Visible="false" />
-    <None Include="$(BaseSeleniumManagerPath)\macos\selenium-manager" Pack="true" PackagePath="manager\macos" Visible="false" />
-    <None Include="$(BaseSeleniumManagerPath)\windows\selenium-manager.exe" Pack="true" PackagePath="manager\windows" Visible="false" />
+    <None Include="assets\nuget\build\netstandard2.0\Selenium.WebDriver.targets" Pack="true" PackagePath="build\netstandard2.0\" />
+    <None Include="assets\nuget\buildTransitive\netstandard2.0\Selenium.WebDriver.targets" Pack="true" PackagePath="buildTransitive\netstandard2.0\" />
   </ItemGroup>
 
   <Target Name="GenerateSeleniumManagerBinaries" BeforeTargets="BeforeBuild">
     <Exec Command="bazel build //dotnet/src/webdriver:manager-linux //dotnet/src/webdriver:manager-windows //dotnet/src/webdriver:manager-macos" WorkingDirectory="../../.." />
-
-    <PropertyGroup>
-      <BaseSeleniumManagerPath>..\..\..\bazel-bin\dotnet\src\webdriver\manager</BaseSeleniumManagerPath>
-    </PropertyGroup>
   </Target>
 
+  <ItemGroup>
+    <None Include="$(BaseSeleniumManagerPath)\linux\selenium-manager" Pack="true" PackagePath="runtimes\linux\native\" Visible="false" CopyToOutputDirectory="PreserveNewest" Link="runtimes\linux\native\selenium-manager" />
+    <None Include="$(BaseSeleniumManagerPath)\macos\selenium-manager" Pack="true" PackagePath="runtimes\osx\native\" Visible="false" CopyToOutputDirectory="PreserveNewest" Link="runtimes\osx\native\selenium-manager" />
+    <None Include="$(BaseSeleniumManagerPath)\windows\selenium-manager.exe" Pack="true" PackagePath="runtimes\win\native\" Visible="false" CopyToOutputDirectory="PreserveNewest" Link="runtimes\win\native\selenium-manager.exe" />
+  </ItemGroup>
+
+  <ItemGroup>
+    <None Include="..\..\..\common\images\selenium_logo_small.png" Pack="true" PackagePath="logo.png" Visible="false" />
+  </ItemGroup>
+
   <Target Name="GenerateAtoms" BeforeTargets="BeforeBuild">
     <Exec Command="bazel build //javascript/webdriver/atoms:get-attribute.js //javascript/atoms/fragments:is-displayed.js //javascript/atoms/fragments:find-elements.js" WorkingDirectory="../../.." />
 
@@ -114,4 +114,4 @@
     </ItemGroup>
   </Target>
 
-</Project>
+</Project>

dotnet/src/webdriver/Selenium.WebDriver.nuspec

@@ -43,12 +43,12 @@
     <file src="lib/net8.0/WebDriver.pdb" target="lib/net8.0/WebDriver.pdb" />
     <file src="lib/net8.0/WebDriver.xml" target="lib/net8.0/WebDriver.xml" />
 
-    <file src="build/Selenium.WebDriver.targets" target="build/Selenium.WebDriver.targets"/>
-    <file src="buildTransitive/Selenium.WebDriver.targets" target="buildTransitive/Selenium.WebDriver.targets"/>
+    <file src="build/netstandard2.0/Selenium.WebDriver.targets" target="build/netstandard2.0/Selenium.WebDriver.targets"/>
+    <file src="buildTransitive/netstandard2.0/Selenium.WebDriver.targets" target="buildTransitive/netstandard2.0/Selenium.WebDriver.targets"/>
 
-    <file src="manager/linux/selenium-manager" target="manager/linux/selenium-manager" />
-    <file src="manager/macos/selenium-manager" target="manager/macos/selenium-manager" />
-    <file src="manager/windows/selenium-manager.exe" target="manager/windows/selenium-manager.exe" />
+    <file src="manager/linux/selenium-manager" target="runtimes/linux/native/selenium-manager" />
+    <file src="manager/macos/selenium-manager" target="runtimes/osx/native/selenium-manager" />
+    <file src="manager/windows/selenium-manager.exe" target="runtimes/win/native/selenium-manager.exe" />
 
     <file src="icon.png" />
     <file src="README.md" />

dotnet/src/webdriver/SeleniumManager.cs

@@ -22,6 +22,7 @@
 using System.Collections.Generic;
 using System.Diagnostics;
 using System.IO;
+using System.Linq;
 using System.Runtime.InteropServices;
 using System.Text;
 using System.Text.Json;
@@ -41,56 +42,120 @@ public static class SeleniumManager
 
     private static readonly ILogger _logger = Log.GetLogger(typeof(SeleniumManager));
 
+    // This logic to find Selenium Manager binary is complex and strange.
+    // As soon as Selenium Manager will be real native library (dll ,so, dynlib),
+    // we will be able to use it directly from the .NET bindings, and this logic will be removed.
     private static readonly Lazy<string> _lazyBinaryFullPath = new(() =>
     {
         string? binaryFullPath = Environment.GetEnvironmentVariable("SE_MANAGER_PATH");
-        if (binaryFullPath == null)
-        {
-            SupportedPlatform? platform = null;
 
-#if NET8_0_OR_GREATER
-            if (OperatingSystem.IsWindows())
-            {
-                platform = SupportedPlatform.Windows;
-            }
-            else if (OperatingSystem.IsLinux() || OperatingSystem.IsFreeBSD())
-            {
-                platform = SupportedPlatform.Linux;
-            }
-            else if (OperatingSystem.IsMacOS() || OperatingSystem.IsMacCatalyst())
+        if (binaryFullPath is not null)
+        {
+            if (!File.Exists(binaryFullPath))
             {
-                platform = SupportedPlatform.MacOS;
+                throw new FileNotFoundException($"Unable to locate provided Selenium Manager binary at '{binaryFullPath}'.");
             }
+
+            return binaryFullPath;
+        }
+
+        SupportedPlatform? platform = null;
+
+#if NET8_0_OR_GREATER
+        if (OperatingSystem.IsWindows())
+        {
+            platform = SupportedPlatform.Windows;
+        }
+        else if (OperatingSystem.IsLinux() || OperatingSystem.IsFreeBSD())
+        {
+            platform = SupportedPlatform.Linux;
+        }
+        else if (OperatingSystem.IsMacOS() || OperatingSystem.IsMacCatalyst())
+        {
+            platform = SupportedPlatform.MacOS;
+        }
 #else
-            if (RuntimeInformation.IsOSPlatform(OSPlatform.Windows))
-            {
-                platform = SupportedPlatform.Windows;
-            }
-            else if (RuntimeInformation.IsOSPlatform(OSPlatform.Linux))
-            {
-                platform = SupportedPlatform.Linux;
-            }
-            else if (RuntimeInformation.IsOSPlatform(OSPlatform.OSX))
-            {
-                platform = SupportedPlatform.MacOS;
-            }
+        if (RuntimeInformation.IsOSPlatform(OSPlatform.Windows))
+        {
+            platform = SupportedPlatform.Windows;
+        }
+        else if (RuntimeInformation.IsOSPlatform(OSPlatform.Linux))
+        {
+            platform = SupportedPlatform.Linux;
+        }
+        else if (RuntimeInformation.IsOSPlatform(OSPlatform.OSX))
+        {
+            platform = SupportedPlatform.MacOS;
+        }
 #endif
 
-            var currentDirectory = AppContext.BaseDirectory;
+        var seleniumManagerFileName = platform switch
+        {
+            SupportedPlatform.Windows => "selenium-manager.exe",
+            SupportedPlatform.Linux => "selenium-manager",
+            SupportedPlatform.MacOS => "selenium-manager",
+            _ => throw new PlatformNotSupportedException(
+                $"Selenium Manager doesn't support your runtime platform: {RuntimeInformation.OSDescription}"),
+        };
+
+        var baseDirectory = AppContext.BaseDirectory;
 
-            binaryFullPath = platform switch
+        List<string> probingPaths = [];
+
+        if (baseDirectory is not null)
+        {
+            probingPaths.Add(Path.Combine(baseDirectory, seleniumManagerFileName));
+
+            switch (platform)
             {
-                SupportedPlatform.Windows => Path.Combine(currentDirectory, "selenium-manager", "windows", "selenium-manager.exe"),
-                SupportedPlatform.Linux => Path.Combine(currentDirectory, "selenium-manager", "linux", "selenium-manager"),
-                SupportedPlatform.MacOS => Path.Combine(currentDirectory, "selenium-manager", "macos", "selenium-manager"),
-                _ => throw new PlatformNotSupportedException(
-                                        $"Selenium Manager doesn't support your runtime platform: {RuntimeInformation.OSDescription}"),
-            };
+                case SupportedPlatform.Windows:
+                    probingPaths.Add(Path.Combine(baseDirectory, "runtimes", "win", "native", seleniumManagerFileName));
+                    break;
+                case SupportedPlatform.Linux:
+                    probingPaths.Add(Path.Combine(baseDirectory, "runtimes", "linux", "native", seleniumManagerFileName));
+                    break;
+                case SupportedPlatform.MacOS:
+                    probingPaths.Add(Path.Combine(baseDirectory, "runtimes", "osx", "native", seleniumManagerFileName));
+                    break;
+            }
         }
 
-        if (!File.Exists(binaryFullPath))
+        // Supporting .NET5+ applications deployed as bundled applications (single file or AOT).
+        // In this case bootstrapper extracts the native libraries into a temporary directory.
+        // Most interesting build properties: "IncludeNativeLibrariesForSelfExtract" and "IncludeAllContentForSelfExtract".
+        var nativeDllSearchDirectories = AppContext.GetData("NATIVE_DLL_SEARCH_DIRECTORIES")?.ToString();
+
+        if (nativeDllSearchDirectories is not null)
         {
-            throw new WebDriverException($"Unable to locate or obtain Selenium Manager binary at {binaryFullPath}");
+            probingPaths.AddRange(nativeDllSearchDirectories.Split(new char[] { Path.PathSeparator }, StringSplitOptions.RemoveEmptyEntries).Select(path => Path.Combine(path, seleniumManagerFileName)));
+        }
+
+        // Covering the case when the application is hosted by another application, most likely
+        // we can find Selenium Manager in the assembly location, because "AppContext.BaseDirectory"
+        // might return the path of the host application.
+        var assemblyDirectory = Path.GetDirectoryName(typeof(SeleniumManager).Assembly.Location);
+
+        if (assemblyDirectory is not null)
+        {
+            probingPaths.Add(Path.Combine(assemblyDirectory, seleniumManagerFileName));
+        }
+
+        probingPaths = [.. probingPaths.Distinct()];
+
+        binaryFullPath = probingPaths.FirstOrDefault(File.Exists);
+
+        if (binaryFullPath is null)
+        {
+            var messageBuilder = new StringBuilder();
+            messageBuilder.AppendFormat("Selenium Manager binary '{0}' was not found in the following paths:", seleniumManagerFileName);
+
+            foreach (var probingPath in probingPaths)
+            {
+                messageBuilder.AppendLine();
+                messageBuilder.AppendFormat("  - {0}", probingPath);
+            }
+
+            throw new FileNotFoundException(messageBuilder.ToString());
         }
 
         return binaryFullPath;
@@ -113,7 +178,7 @@ public static Dictionary<string, string> BinaryPaths(string arguments)
             argsBuilder.Append(" --debug");
         }
 
-        var smCommandResult = RunCommand(_lazyBinaryFullPath.Value, argsBuilder.ToString());
+        var smCommandResult = RunCommand(argsBuilder.ToString());
         Dictionary<string, string> binaryPaths = new()
         {
             { BrowserPathKey, smCommandResult.BrowserPath },
@@ -132,12 +197,11 @@ public static Dictionary<string, string> BinaryPaths(string arguments)
     /// <summary>
     /// Executes a process with the given arguments.
     /// </summary>
-    /// <param name="fileName">The path to the Selenium Manager.</param>
     /// <param name="arguments">The switches to be used by Selenium Manager.</param>
     /// <returns>
     /// the standard output of the execution.
     /// </returns>
-    private static ResultResponse RunCommand(string fileName, string arguments)
+    private static ResultResponse RunCommand(string arguments)
     {
         Process process = new Process();
         process.StartInfo.FileName = _lazyBinaryFullPath.Value;
@@ -171,7 +235,7 @@ private static ResultResponse RunCommand(string fileName, string arguments)
             {
                 // We do not log any warnings coming from Selenium Manager like the other bindings, as we don't have any logging in the .NET bindings
 
-                var exceptionMessageBuilder = new StringBuilder($"Selenium Manager process exited abnormally with {process.ExitCode} code: {fileName} {arguments}");
+                var exceptionMessageBuilder = new StringBuilder($"Selenium Manager process exited abnormally with {process.ExitCode} code: {process.StartInfo.FileName} {arguments}");
 
                 if (!string.IsNullOrWhiteSpace(errorOutputBuilder.ToString()))
                 {
@@ -194,7 +258,7 @@ private static ResultResponse RunCommand(string fileName, string arguments)
         }
         catch (Exception ex)
         {
-            throw new WebDriverException($"Error starting process: {fileName} {arguments}", ex);
+            throw new WebDriverException($"Error starting process: {process.StartInfo.FileName} {arguments}", ex);
         }
         finally
         {

dotnet/src/webdriver/assets/BUILD.bazel

@@ -1,4 +1,5 @@
 exports_files([
-    "README.md",
-    "Selenium.WebDriver.targets",
+    "nuget/README.md",
+    "nuget/build/netstandard2.0/Selenium.WebDriver.targets",
+    "nuget/buildTransitive/netstandard2.0/Selenium.WebDriver.targets",
 ])