Core - Improve IRequestContext.SetProxy extension Method

- Add tests
- Add better validation

Issue #3235

Author: amaitland

CefSharp.Core.RefAssembly/CefSharp.Core.cs

@@ -77,6 +77,7 @@ public static void EnableWaitForBrowsersToClose() { }
         public static string GetMimeType(string extension) { throw null; }
         public static System.Threading.Tasks.Task<System.Collections.Generic.List<CefSharp.WebPluginInfo>> GetPlugins() { throw null; }
         public static bool Initialize(CefSharp.CefSettingsBase cefSettings) { throw null; }
+        public static bool Initialize(CefSharp.CefSettingsBase cefSettings, bool performDependencyCheck) { throw null; }
         public static bool Initialize(CefSharp.CefSettingsBase cefSettings, bool performDependencyCheck, CefSharp.IApp cefApp) { throw null; }
         public static bool Initialize(CefSharp.CefSettingsBase cefSettings, bool performDependencyCheck, CefSharp.IBrowserProcessHandler browserProcessHandler) { throw null; }
         public static void PreShutdown() { }

CefSharp.Test/CefSharp.Test.csproj

@@ -133,6 +133,7 @@
     <Compile Include="Framework\LegacyCamelCaseJavascriptNameConverterFacts.cs" />
     <Compile Include="Framework\MimeTypeMappingFacts.cs" />
     <Compile Include="Framework\PathCheckFacts.cs" />
+    <Compile Include="Framework\RequestContextExtensionFacts.cs" />
     <Compile Include="Framework\TestMemberInfo.cs" />
     <Compile Include="JavascriptBinding\IntegrationTestFacts.cs" />
     <Compile Include="OffScreen\OffScreenBrowserBasicFacts.cs" />

CefSharp.Test/Framework/RequestContextExtensionFacts.cs

@@ -0,0 +1,72 @@
+// Copyright © 2020 The CefSharp Authors. All rights reserved.
+//
+// Use of this source code is governed by a BSD-style license that can be found in the LICENSE file.
+
+using System;
+using System.Collections.Generic;
+using Moq;
+using Xunit;
+using Xunit.Abstractions;
+
+namespace CefSharp.Test.Framework
+{
+    public class RequestContextExtensionFacts
+    {
+        private const string ProxyPreferenceKey = "proxy";
+
+        private readonly ITestOutputHelper output;
+
+        private delegate void SetPreferenceDelegate(string name, object value, out string errorMessage);
+
+        public RequestContextExtensionFacts(ITestOutputHelper output)
+        {
+            this.output = output;
+        }
+
+        [Theory]
+        [InlineData("http", "localhost", 8080, "http://localhost:8080")]
+        [InlineData("socks", "localhost", null, "socks://localhost")]
+        [InlineData(null, "localhost", null, "http://localhost")]
+        public void CanSetProxyWithSchemeHostAndPort(string scheme, string host, int? port, string expected)
+        {
+            string preferenceName = "";
+            object preferenceValue = null;
+            var mockRequestContext = new Mock<IRequestContext>();
+            
+            mockRequestContext.Setup(x => x.SetPreference(ProxyPreferenceKey, It.IsAny<IDictionary<string, object>>(), out It.Ref<string>.IsAny))
+                .Callback(new SetPreferenceDelegate((string name, object value, out string errorMessage) =>
+                {
+                    preferenceName = name;
+                    preferenceValue = value;
+                    errorMessage = "OK";
+                }))
+                .Returns(true);
+
+            string msg;
+
+            var result = mockRequestContext.Object.SetProxy(scheme, host, port, out msg);
+            var dict = (Dictionary<string, object>)preferenceValue;
+
+            Assert.True(result);
+            Assert.Equal("OK", msg);
+            Assert.Equal(ProxyPreferenceKey, preferenceName);
+            Assert.Equal(2, dict.Count);
+            Assert.Equal("fixed_servers", dict["mode"]);
+            Assert.Equal(expected, dict["server"]);
+        }
+
+        [Fact]
+        public void SetProxyThrowsExceptionOnInvalidScheme()
+        {
+            var mockRequestContext = new Mock<IRequestContext>();
+
+            mockRequestContext.Setup(x => x.SetPreference(ProxyPreferenceKey, It.IsAny<IDictionary<string, object>>(), out It.Ref<string>.IsAny)) .Returns(true);
+
+            Assert.Throws<ArgumentException>(() =>
+            {
+                string msg;
+                mockRequestContext.Object.SetProxy("myscheme", "localhost", 0, out msg);
+            });
+        }
+    }
+}

CefSharp/RequestContextExtensions.cs

@@ -5,6 +5,8 @@
 using System;
 using System.Collections.Generic;
 using System.IO;
+using System.Linq;
+using System.Net;
 using System.Threading.Tasks;
 
 namespace CefSharp
@@ -14,6 +16,11 @@ namespace CefSharp
     /// </summary>
     public static class RequestContextExtensions
     {
+        /// <summary>
+        /// Array of valid proxy schemes
+        /// </summary>
+        private static string[] ProxySchemes = new string[] { "http", "socks", "socks4", "socks5" };
+
         /// <summary>
         /// Load an extension from the given directory. To load a crx file you must unzip it first.
         /// For further details see <seealso cref="IRequestContext.LoadExtension(string, string, IExtensionHandler)"/>
@@ -55,34 +62,39 @@ public static void LoadExtensionsFromDirectory(this IRequestContext requestConte
         /// </summary>
         /// <param name="requestContext">request context</param>
         /// <param name="scheme">is the protocol of the proxy server, and is one of: 'http', 'socks', 'socks4', 'socks5'. Also note that 'socks' is equivalent to 'socks5'.</param>
-        /// <param name="host">host</param>
-        /// <param name="port">post</param>
+        /// <param name="host">proxy host</param>
+        /// <param name="port">proxy port</param>
         /// <param name="errorMessage">error message</param>
         /// <returns>returns true if successfull, false otherwise.</returns>
         /// <remarks>Internally calls <seealso cref="IRequestContext.SetPreference(string, object, out string)"/> with
         /// preference 'proxy' and mode of 'fixed_servers'</remarks>
-        public static bool SetProxy(this IRequestContext requestContext, string scheme, string host, string port, out string errorMessage)
+        public static bool SetProxy(this IRequestContext requestContext, string scheme, string host, int? port, out string errorMessage)
         {
-            if (string.IsNullOrWhiteSpace(host))
+            //Default to using http scheme if non provided
+            if (string.IsNullOrWhiteSpace(scheme))
             {
-                throw new ArgumentException("Cannot be null or empty", "host");
+                scheme = "http";
             }
 
-            if (string.IsNullOrWhiteSpace(port))
+            if (!ProxySchemes.Contains(scheme.ToLower()))
             {
-                throw new ArgumentException("Cannot be null or empty", port);
+                throw new ArgumentException("Invalid Scheme, see https://bitbucket.org/chromiumembedded/cef/wiki/GeneralUsage.md#markdown-header-proxy-resolution for a list of valid schemes.", "scheme");
             }
 
-            //Default to using http scheme if non provided
-            if (string.IsNullOrWhiteSpace(scheme))
+            if (string.IsNullOrWhiteSpace(host))
             {
-                scheme = "http";
+                throw new ArgumentException("Cannot be null or empty", "host");
+            }
+
+            if (port.HasValue && (port < IPEndPoint.MinPort || port > IPEndPoint.MaxPort))
+            {
+                throw new ArgumentOutOfRangeException("port", port, "Invalid TCP Port");
             }
 
             var v = new Dictionary<string, object>
             {
                 ["mode"] = "fixed_servers",
-                ["server"] = scheme + "://" + host + ":" + port
+                ["server"] = scheme + "://" + host + (port.HasValue ? (":" + port) : "")
             };
 
             return requestContext.SetPreference("proxy", v, out errorMessage);
@@ -94,17 +106,33 @@ public static bool SetProxy(this IRequestContext requestContext, string scheme,
         /// MUST be called on the CEF UI Thread
         /// </summary>
         /// <param name="requestContext">request context</param>
-        /// <param name="host">host</param>
-        /// <param name="port">post</param>
+        /// <param name="host">proxy host</param>
+        /// <param name="port">proxy port</param>
         /// <param name="errorMessage">error message</param>
         /// <returns>returns true if successfull, false otherwise.</returns>
         /// <remarks>Internally calls <seealso cref="IRequestContext.SetPreference(string, object, out string)"/> with
         /// preference 'proxy' and mode of 'fixed_servers'</remarks>
-        public static bool SetProxy(this IRequestContext requestContext, string host, string port, out string errorMessage)
+        public static bool SetProxy(this IRequestContext requestContext, string host, int? port, out string errorMessage)
         {
             return requestContext.SetProxy(null, host, port, out errorMessage);
         }
 
+        /// <summary>
+        /// Sets the proxy server for the specified <see cref="IRequestContext"/>.
+        /// Protocol for the proxy server is http
+        /// MUST be called on the CEF UI Thread
+        /// </summary>
+        /// <param name="requestContext">request context</param>
+        /// <param name="host">proxy host</param>
+        /// <param name="errorMessage">error message</param>
+        /// <returns>returns true if successfull, false otherwise.</returns>
+        /// <remarks>Internally calls <seealso cref="IRequestContext.SetPreference(string, object, out string)"/> with
+        /// preference 'proxy' and mode of 'fixed_servers'</remarks>
+        public static bool SetProxy(this IRequestContext requestContext, string host, out string errorMessage)
+        {
+            return requestContext.SetProxy(null, host, null, out errorMessage);
+        }
+
         /// <summary>
         /// Clears all HTTP authentication credentials that were added as part of handling
         /// <see cref="IRequestHandler.GetAuthCredentials(IWebBrowser, IBrowser, string, bool, string, int, string, string, IAuthCallback)"/>.