Adding user-agent string for .NET remote HTTP requests

Addresses #5657 for .NET.

Author: jimevans

dotnet/src/webdriver/Internal/ResourceUtilities.cs

@@ -1,4 +1,4 @@
-// <copyright file="ResourceUtilities.cs" company="WebDriver Committers">
+// <copyright file="ResourceUtilities.cs" company="WebDriver 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
@@ -16,10 +16,13 @@
 // limitations under the License.
 // </copyright>
 
+using System;
 using System.Collections.Generic;
+using System.Diagnostics;
 using System.Globalization;
 using System.IO;
 using System.Reflection;
+using System.Runtime.InteropServices;
 
 namespace OpenQA.Selenium.Internal
 {
@@ -28,6 +31,43 @@ namespace OpenQA.Selenium.Internal
     /// </summary>
     public static class ResourceUtilities
     {
+        private static string assemblyVersion;
+        private static string platformFamily;
+
+        /// <summary>
+        /// Gets a string representing the version of the Selenium assembly.
+        /// </summary>
+        public static string AssemblyVersion
+        {
+            get
+            {
+                if (string.IsNullOrEmpty(assemblyVersion))
+                {
+                    Assembly executingAssembly = Assembly.GetCallingAssembly();
+                    Version versionResource = executingAssembly.GetName().Version;
+                    assemblyVersion = string.Format(CultureInfo.InvariantCulture, "{0}.{1}.{2}", versionResource.Major, versionResource.Minor, versionResource.Revision);
+                }
+
+                return assemblyVersion;
+            }
+        }
+
+        /// <summary>
+        /// Gets a string representing the platform family on which the Selenium assembly is executing.
+        /// </summary>
+        public static string PlatformFamily
+        {
+            get
+            {
+                if (string.IsNullOrEmpty(platformFamily))
+                {
+                    platformFamily = GetPlatformString();
+                }
+
+                return platformFamily;
+            }
+        }
+
         /// <summary>
         /// Gets a <see cref="Stream"/> that contains the resource to use.
         /// </summary>
@@ -89,5 +129,56 @@ public static bool IsValidResourceName(string resourceId)
             List<string> resourceNames = new List<string>(executingAssembly.GetManifestResourceNames());
             return resourceNames.Contains(resourceId);
         }
+
+        private static string GetPlatformString()
+        {
+            string platformName = "unknown";
+#if NETSTANDARD2_0 || NETCOREAPP2_0
+            if (RuntimeInformation.IsOSPlatform(OSPlatform.Linux))
+            {
+                platformName = "windows";
+            }
+            else if (RuntimeInformation.IsOSPlatform(OSPlatform.Linux))
+            {
+                platformName = "linux";
+            }
+            else if (RuntimeInformation.IsOSPlatform(OSPlatform.OSX))
+            {
+                platformName = "mac";
+            }
+#else
+            // Unfortunately, detecting the currently running platform isn't as
+            // straightforward as you might hope.
+            // See: http://mono.wikia.com/wiki/Detecting_the_execution_platform
+            // and https://msdn.microsoft.com/en-us/library/3a8hyw88(v=vs.110).aspx
+            const int PlatformMonoUnixValue = 128;
+            PlatformID platformId = Environment.OSVersion.Platform;
+            if (platformId == PlatformID.Unix || platformId == PlatformID.MacOSX || (int)platformId == PlatformMonoUnixValue)
+            {
+                using (Process unameProcess = new Process())
+                {
+                    unameProcess.StartInfo.FileName = "uname";
+                    unameProcess.StartInfo.UseShellExecute = false;
+                    unameProcess.StartInfo.RedirectStandardOutput = true;
+                    unameProcess.Start();
+                    unameProcess.WaitForExit(1000);
+                    string output = unameProcess.StandardOutput.ReadToEnd();
+                    if (output.ToLowerInvariant().StartsWith("darwin"))
+                    {
+                        platformName = "mac";
+                    }
+                    else
+                    {
+                        platformName = "linux";
+                    }
+                }
+            }
+            else if (platformId == PlatformID.Win32NT || platformId == PlatformID.Win32S || platformId == PlatformID.Win32Windows || platformId == PlatformID.WinCE)
+            {
+                platformName = "windows";
+            }
+#endif
+            return platformName;
+        }
     }
 }

dotnet/src/webdriver/Remote/HttpCommandExecutor.cs

@@ -22,6 +22,7 @@
 using System.IO;
 using System.Net;
 using System.Text;
+using OpenQA.Selenium.Internal;
 
 namespace OpenQA.Selenium.Remote
 {
@@ -35,6 +36,7 @@ public class HttpCommandExecutor : ICommandExecutor
         private const string CharsetType = "charset=utf-8";
         private const string ContentTypeHeader = JsonMimeType + ";" + CharsetType;
         private const string RequestAcceptHeader = JsonMimeType + ", " + PngMimeType;
+        private const string UserAgentHeaderTemplate = "selenium/{0} (.net {1})";
         private Uri remoteServerUri;
         private TimeSpan serverResponseTimeout;
         private bool enableKeepAlive;
@@ -84,6 +86,8 @@ public HttpCommandExecutor(Uri addressOfRemoteServer, TimeSpan timeout, bool ena
             {
                 HttpWebRequest.DefaultMaximumErrorResponseLength = -1;
             }
+
+
         }
 
         public event EventHandler<BeforeRemoteHttpRequestEventArgs> BeforeRemoteHttpRequest;
@@ -175,6 +179,8 @@ private HttpResponseInfo MakeHttpRequest(HttpRequestInfo requestInfo)
                 request.PreAuthenticate = true;
             }
 
+            string userAgentString = string.Format(CultureInfo.InvariantCulture, UserAgentHeaderTemplate, ResourceUtilities.AssemblyVersion, ResourceUtilities.PlatformFamily);
+            request.UserAgent = userAgentString;
             request.Method = requestInfo.HttpMethod;
             request.Timeout = (int)this.serverResponseTimeout.TotalMilliseconds;
             request.Accept = RequestAcceptHeader;