fix: proxy issues. update: automate-client-java version

1. PluginsTracker static to instance specific client to prevent
overriding
2. Credentials check via proxy
3. pom update for automate-client-java for optional proxy-auth params

Author: rchougule

src/main/java/com/browserstack/automate/ci/common/clienthandler/ClientHandler.java

@@ -12,6 +12,16 @@
 
 public class ClientHandler {
 
+    /**
+     * Returns BrowserStackClient based on Project, i.e Automate or App Automate.
+     * Also decides and sets the proxy for the client
+     * @param project ProjectType
+     * @param username Username of BrowserStack
+     * @param accessKey Access Key of BrowserStack
+     * @param customProxy Custom Proxy String
+     * @param logger Logger
+     * @return BrowserStackClient
+     */
     public static BrowserStackClient getBrowserStackClient(@Nonnull final ProjectType project, @Nonnull final String username,
                                                            @Nonnull final String accessKey, @Nullable final String customProxy,
                                                            @Nullable final PrintStream logger) {
@@ -31,6 +41,13 @@ public static BrowserStackClient getBrowserStackClient(@Nonnull final ProjectTyp
         return client;
     }
 
+    /**
+     * Initializes BrowserStack client based on project type
+     * @param project ProjectType
+     * @param username Username of BrowserStack
+     * @param accessKey Access Key of BrowserStack
+     * @return BrowserStackClient
+     */
     private static BrowserStackClient decideAndGetClient(@Nonnull final ProjectType project, @Nonnull final String username, @Nonnull final String accessKey) {
         if (project == ProjectType.APP_AUTOMATE) {
             return new AppAutomateClient(username, accessKey);

src/main/java/com/browserstack/automate/ci/common/proxysettings/JenkinsProxySettings.java

@@ -152,9 +152,9 @@ private void decideJenkinsProxy(final String customProxyString) {
         if (this.finalProxyHost != null && this.finalProxyPort != 0) {
             this.hasProxy = true;
 
-            String proxyDataToLog = "\nHost: " + this.getHost() + "\nPort: " + this.getPort();
+            String proxyDataToLog = "Host: " + this.getHost() + ", Port: " + this.getPort();
             if (this.hasAuth()) {
-                proxyDataToLog += "\nUsername: " + this.getUsername() + "\nPassword: " + Tools.maskString(this.getPassword());
+                proxyDataToLog += ", Username: " + this.getUsername() + ", Password: " + Tools.maskString(this.getPassword());
             }
 
             if (logger != null) log(logger, "Proxy Selected for BrowserStack Plugin: " + proxyDataToLog);
@@ -178,6 +178,10 @@ private String getSystemProxyString() {
         return systemHttpsProxyEnv == null ? systemHttpProxyEnv : systemHttpsProxyEnv;
     }
 
+    /**
+     * Returns Jenkins proxy configuration in Proxy object
+     * @return Proxy object
+     */
     public Proxy getJenkinsProxy() {
         if (this.hasProxy()) {
             return new Proxy(Proxy.Type.HTTP, new InetSocketAddress(this.finalProxyHost, this.finalProxyPort));

src/main/java/com/browserstack/automate/ci/common/tracking/PluginsTracker.java

@@ -25,7 +25,7 @@
 public class PluginsTracker {
     private static final MediaType JSON = MediaType.get("application/json; charset=utf-8");
     private static final String URL = "https://api.browserstack.com/ci_plugins/track";
-    private static OkHttpClient client;
+    private transient OkHttpClient client;
     private final String trackingId;
     private String username;
     private String accessKey;
@@ -51,7 +51,7 @@ public PluginsTracker(@Nullable final String customProxy) {
         initializeClient();
     }
 
-    private static void asyncPostRequestSilent(final String url, final String json) {
+    private void asyncPostRequestSilent(final String url, final String json) {
         RequestBody body = RequestBody.create(JSON, json);
         Request request = new Request.Builder()
                 .url(url)
@@ -86,7 +86,7 @@ private void initializeClient() {
 
         final Proxy proxy = jenkinsProxy.getJenkinsProxy();
         if (proxy != Proxy.NO_PROXY) {
-            System.out.println("Selected some proxy for plugins tracker. " + proxy.toString());
+            System.out.println("Selected some proxy for plugins tracker. " + proxy.toString() + ". And auth: " + jenkinsProxy.hasAuth());
             if (jenkinsProxy.hasAuth()) {
                 final String username = jenkinsProxy.getUsername();
                 final String password = jenkinsProxy.getPassword();
@@ -99,12 +99,12 @@ public Request authenticate(Route route, Response response) throws IOException {
                                 .build();
                     }
                 };
-                this.client = new OkHttpClient.Builder().proxy(proxy).proxyAuthenticator(proxyAuthenticator).build();
+                client = new OkHttpClient.Builder().proxy(proxy).proxyAuthenticator(proxyAuthenticator).build();
             } else {
-                this.client = new OkHttpClient.Builder().proxy(proxy).build();
+                client = new OkHttpClient.Builder().proxy(proxy).build();
             }
         } else {
-            this.client = new OkHttpClient.Builder().build();
+            client = new OkHttpClient.Builder().build();
         }
     }
 

src/main/java/com/browserstack/automate/ci/common/uploader/AppUploader.java

@@ -13,7 +13,7 @@ public class AppUploader {
 
     String appPath;
     BrowserStackCredentials credentials;
-    private final PrintStream logger;
+    private final transient PrintStream logger;
     private final String customProxy;
 
     public AppUploader(String appPath, BrowserStackCredentials credentials, final String customProxy, final PrintStream logger) {
@@ -36,6 +36,8 @@ public String uploadFile()
         }
 
         if (proxy.hasProxy()) {
+            System.out.println("App upload setting proxy for app automate client...");
+            System.out.println(proxy.getHost() + ":" + proxy.getPort() + "," + proxy.getUsername() + ":" + proxy.getPassword());
             appAutomateClient.setProxy(proxy.getHost(), proxy.getPort(), proxy.getUsername(), proxy.getPassword());
         }
         return appAutomateClient.uploadApp(this.appPath).getAppUrl();

src/main/java/com/browserstack/automate/ci/jenkins/BrowserStackCredentials.java

@@ -2,7 +2,8 @@
 
 import com.browserstack.automate.AutomateClient;
 import com.browserstack.automate.ci.common.analytics.Analytics;
-import com.browserstack.automate.ci.common.proxysettings.JenkinsProxySettings;
+import com.browserstack.automate.ci.common.clienthandler.ClientHandler;
+import com.browserstack.automate.ci.common.enums.ProjectType;
 import com.browserstack.automate.exception.AutomateException;
 import com.cloudbees.plugins.credentials.BaseCredentials;
 import com.cloudbees.plugins.credentials.CredentialsDescriptor;
@@ -72,11 +73,8 @@ public static FormValidation testAuthentication(final String username, final Str
         }
 
         try {
-            AutomateClient client = new AutomateClient(username, accesskey);
-            System.out.println("Inside BrowserStackCredentials....");
-//            if (JenkinsProxySettings.hasProxy()) {
-//                client.setProxy(JenkinsProxySettings.getHost(), JenkinsProxySettings.getPort(), JenkinsProxySettings.getUsername(), JenkinsProxySettings.getPassword());
-//            }
+            AutomateClient client =
+                    (AutomateClient) ClientHandler.getBrowserStackClient(ProjectType.AUTOMATE, username, accesskey, null, null);
             if (client.getAccountUsage() != null) {
                 return FormValidation.ok(OK_VALID_AUTH);
             }

src/main/java/com/browserstack/automate/ci/jenkins/BrowserStackReportForBuild.java

@@ -37,7 +37,7 @@ public class BrowserStackReportForBuild extends AbstractBrowserStackReportForBui
     private final ProjectType projectType;
     private final transient PrintStream logger;
     private final String customProxy;
-    private final PluginsTracker tracker;
+    private final transient PluginsTracker tracker;
     private final boolean pipelineStatus;
     // to make them available in jelly
     private final String errorConst = Constants.SessionStatus.ERROR;
@@ -61,6 +61,7 @@ public BrowserStackReportForBuild(final Run<?, ?> build,
         this.projectType = projectType;
         this.logger = logger;
         this.customProxy = customProxy;
+        System.out.println("Initialized BrowserStackReportForBuild with customProxy: " + this.customProxy);
         this.tracker = tracker;
         this.pipelineStatus = pipelineStatus;
         fetchBuildAndSessions();

src/main/java/com/browserstack/automate/ci/jenkins/pipeline/AppUploadStepExecution.java

@@ -40,6 +40,7 @@ protected Void run() throws Exception {
         String customProxy = parentContextEnvVars.get("https_proxy");
         customProxy = Optional.ofNullable(customProxy).orElse(parentContextEnvVars.get("http_proxy"));
 
+        System.out.println("App upload custom proxy: " + customProxy);
         String appId = AppUploaderHelper.uploadApp(run, logger, this.appPath, customProxy);
 
         if (StringUtils.isEmpty(appId)) {

src/main/java/com/browserstack/automate/ci/jenkins/pipeline/BrowserStackPipelineStepExecution.java

@@ -55,7 +55,7 @@ public boolean start() throws Exception {
 
         final PluginsTracker tracker = new PluginsTracker(customProxy);
 
-        System.out.println("\ncustomProxy: " + customProxy);
+        System.out.println("\ncustomProxy in pipeline execution: " + customProxy);
 
         BrowserStackCredentials credentials =
                 BrowserStackCredentials.getCredentials(run.getParent(), credentialsId);