Fix #784 Enable BasicAuth through Selenide proxy server

config/checkstyle/checkstyle.xml

@@ -57,7 +57,7 @@
     <module name="UnnecessaryParentheses"/>
     <!--<module name="MutableException"/>-->
     <module name="ClassFanOutComplexity">
-      <property name="max" value="28"/>
+      <property name="max" value="29"/>
     </module>
     <module name="CyclomaticComplexity">
       <property name="max" value="20"/>

src/main/java/com/codeborne/selenide/AuthenticationType.java

@@ -0,0 +1,25 @@
+package com.codeborne.selenide;
+
+/**
+ * Authentication schemes.
+ *
+ * @see <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication#Authentication_schemes">Web HTTP reference</a>
+ */
+public enum AuthenticationType {
+  BASIC("Basic"),
+  BEARER("Bearer"),
+  DIGEST("Digest"),
+  HOBA("HOBA"),
+  MUTUAL("Mutual"),
+  AWS4_HMAC_SHA256("AWS4-HMAC-SHA256");
+
+  private String value;
+
+  AuthenticationType(final String value) {
+    this.value = value;
+  }
+
+  public String getValue() {
+    return value;
+  }
+}

src/main/java/com/codeborne/selenide/Credentials.java

@@ -0,0 +1,34 @@
+package com.codeborne.selenide;
+
+import java.util.Base64;
+
+import static java.nio.charset.StandardCharsets.UTF_8;
+
+public final class Credentials {
+  private String login;
+  private String password;
+
+  public Credentials(final String login, final String password) {
+    this.login = login;
+    this.password = password;
+  }
+
+  /**
+   * The resulting string is base64 encoded (YWxhZGRpbjpvcGVuc2VzYW1l).
+   *
+   * @return encoded string
+   */
+  public String encode() {
+    final byte[] credentialsBytes = combine().getBytes(UTF_8);
+    return Base64.getEncoder().encodeToString(credentialsBytes);
+  }
+
+  /**
+   * Combine credentials with a colon (login:password).
+   *
+   * @return combined credentials
+   */
+  private String combine() {
+    return String.format("%s:%s", login, password);
+  }
+}

src/main/java/com/codeborne/selenide/Selenide.java

@@ -101,6 +101,28 @@ public static void open(String relativeOrAbsoluteUrl, String domain, String logi
     mockModalDialogs();
   }
 
+  /**
+   *
+   * The main starting point in your tests.
+   * <p>
+   * Open browser and pass authentication using build-in proxy.
+   * <p>
+   * A common authenticationType is "Basic". See Web HTTP reference for other types.
+   * <p>
+   * {@code Configuration.fileDownload == Configuration.FileDownloadMode.PROXY;} - is required configuration.
+   *
+   * @param relativeOrAbsoluteUrl
+   * @param authenticationType
+   * @param login
+   * @param password
+   *
+   * @see <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Proxy-Authorization">Web HTTP reference</a>
+   * @see AuthenticationType
+   */
+  public static void open(String relativeOrAbsoluteUrl, AuthenticationType authenticationType, String login, String password) {
+    navigator.open(relativeOrAbsoluteUrl, authenticationType, login, password);
+  }
+
   /**
    * @see Selenide#open(URL, String, String, String)
    */

src/main/java/com/codeborne/selenide/impl/Navigator.java

@@ -1,7 +1,10 @@
 package com.codeborne.selenide.impl;
 
+import com.codeborne.selenide.AuthenticationType;
+import com.codeborne.selenide.Credentials;
 import com.codeborne.selenide.logevents.SelenideLog;
 import com.codeborne.selenide.logevents.SelenideLogger;
+import io.netty.handler.codec.http.HttpHeaders;
 import org.openqa.selenium.JavascriptExecutor;
 import org.openqa.selenium.WebDriver;
 import org.openqa.selenium.WebDriverException;
@@ -12,6 +15,7 @@
 import static com.codeborne.selenide.Configuration.baseUrl;
 import static com.codeborne.selenide.Configuration.captureJavascriptErrors;
 import static com.codeborne.selenide.WebDriverRunner.getAndCheckWebDriver;
+import static com.codeborne.selenide.WebDriverRunner.getSelenideProxy;
 import static com.codeborne.selenide.WebDriverRunner.getWebDriver;
 import static com.codeborne.selenide.WebDriverRunner.isIE;
 import static com.codeborne.selenide.logevents.LogEvent.EventStatus.PASS;
@@ -39,6 +43,19 @@ public void open(URL url, String domain, String login, String password) {
     navigateToAbsoluteUrl(url.toExternalForm());
   }
 
+  public void open(String relativeOrAbsoluteUrl, AuthenticationType authenticationType, String login, String password) {
+    getAndCheckWebDriver();
+    Credentials credentials = new Credentials(login, password);
+    String authorization = String.format("%s %s", authenticationType.getValue(), credentials.encode());
+    getSelenideProxy().addRequestFilter("headers.request", (request, contents, messageInfo) -> {
+      final HttpHeaders headers = request.headers();
+      headers.add("Authorization", authorization);
+      headers.add("Proxy-Authorization", authorization);
+      return null;
+    });
+    open(relativeOrAbsoluteUrl);
+  }
+
   protected String absoluteUrl(String relativeUrl) {
     return baseUrl + relativeUrl;
   }

src/test/java/integration/BasicAuthTest.java

@@ -1,5 +1,8 @@
 package integration;
 
+import com.codeborne.selenide.AuthenticationType;
+import com.codeborne.selenide.Configuration;
+import com.codeborne.selenide.Configuration.FileDownloadMode;
 import org.junit.jupiter.api.Test;
 
 import static com.codeborne.selenide.Condition.text;
@@ -12,4 +15,11 @@ void canPassBasicAuth() {
     open("/basic-auth/hello", "", "scott", "tiger");
     $("body").shouldHave(text("Hello, scott:tiger!"));
   }
+
+  @Test
+  void canAuthUsingProxy() {
+    Configuration.fileDownload = FileDownloadMode.PROXY;
+    open("/basic-auth/hello", AuthenticationType.BASIC, "scott", "tiger");
+    $("body").shouldHave(text("Hello, scott:tiger!"));
+  }
 }