BrowserStackBuildWrapperOperations.java

package com.browserstack.automate.ci.common;

import com.browserstack.automate.ci.common.constants.Constants;
import com.browserstack.automate.ci.jenkins.BrowserStackCredentials;
import com.browserstack.automate.ci.jenkins.local.JenkinsBrowserStackLocal;
import com.browserstack.automate.ci.jenkins.local.LocalConfig;
import com.browserstack.automate.ci.jenkins.observability.ObservabilityConfig;
import com.cloudbees.plugins.credentials.CredentialsMatchers;
import com.cloudbees.plugins.credentials.CredentialsProvider;
import com.cloudbees.plugins.credentials.common.StandardListBoxModel;
import com.cloudbees.plugins.credentials.domains.DomainRequirement;
import hudson.FilePath;
import hudson.Util;
import hudson.model.AbstractProject;
import hudson.model.Item;
import hudson.security.ACL;
import hudson.util.FormValidation;
import hudson.util.ListBoxModel;
import org.apache.tools.ant.FileScanner;
import org.apache.tools.ant.types.FileSet;

import java.io.File;
import java.io.IOException;
import java.io.PrintStream;
import java.util.ArrayList;
import java.util.Map;

import static com.browserstack.automate.ci.common.logger.PluginLogger.log;

public class BrowserStackBuildWrapperOperations {
    private static final String ENV_JENKINS_BUILD_TAG = "BUILD_TAG";
    private BrowserStackCredentials credentials;
    private boolean isTearDownPhase;
    private PrintStream logger;
    private LocalConfig localConfig;
    private JenkinsBrowserStackLocal browserstackLocal;
    private ObservabilityConfig observabilityConfig;

    public BrowserStackBuildWrapperOperations(BrowserStackCredentials credentials,
                                              boolean isTearDownPhase, PrintStream logger, LocalConfig localConfig,
                                              JenkinsBrowserStackLocal browserStackLocal, ObservabilityConfig observabilityConfig) {
        super();
        this.credentials = credentials;
        this.isTearDownPhase = isTearDownPhase;
        this.logger = logger;
        this.localConfig = localConfig;
        this.browserstackLocal = browserStackLocal;
        this.observabilityConfig = observabilityConfig;
    }

    public static ListBoxModel doFillCredentialsIdItems(Item context) {
        if (context != null && !context.hasPermission(Item.CONFIGURE)) {
            return new StandardListBoxModel();
        }

        return new StandardListBoxModel().withMatching(
                CredentialsMatchers.anyOf(CredentialsMatchers.instanceOf(BrowserStackCredentials.class)),
                CredentialsProvider.lookupCredentials(BrowserStackCredentials.class, context, ACL.SYSTEM,
                        new ArrayList<DomainRequirement>()));
    }

    public static FormValidation doCheckLocalPath(final AbstractProject project,
                                                  final String localPath) {
        final String path = Util.fixEmptyAndTrim(localPath);
        if (Util.fixEmptyAndTrim(path) == null) {
            return FormValidation.ok();
        }

        try {
            File f = resolvePath(project, localPath);
            if (f != null) {
                return FormValidation.ok();
            }
        } catch (Exception e) {
            return FormValidation.error(e.getMessage());
        }

        return FormValidation.error("Invalid path.");
    }

    private static File resolvePath(final AbstractProject project, final String path)
            throws IOException, InterruptedException {
        File f = new File(path);
        if (f.isAbsolute() && (!f.isFile() || !f.canExecute())) {
            return null;
        }

        // For absolute paths
        FormValidation validateExec = FormValidation.validateExecutable(path);
        if (validateExec.kind == FormValidation.Kind.OK) {
            return f;
        }

        // Ant style path definitions
        FilePath workspace = project.getSomeWorkspace();
        if (workspace != null) {
            File workspaceRoot = new File(workspace.toURI());
            FileSet fileSet = Util.createFileSet(workspaceRoot, path);
            FileScanner fs = fileSet.getDirectoryScanner();
            fs.setIncludes(new String[]{path});
            fs.scan();

            String[] includedFiles = fs.getIncludedFiles();
            if (includedFiles.length > 0) {
                File includedFile = new File(workspaceRoot, includedFiles[0]);
                if (includedFile.exists() && includedFile.isFile() && includedFile.canExecute()) {
                    return includedFile;
                }
            }
        }
        return null;
    }

    public void buildEnvVars(Map<String, String> env) {
        if (credentials != null) {
            if (credentials.hasUsername()) {
                String username = credentials.getUsername();

                env.put(BrowserStackEnvVars.BROWSERSTACK_USER, username + "-jenkins");
                env.put(BrowserStackEnvVars.BROWSERSTACK_USERNAME, username + "-jenkins");
                logEnvVar(BrowserStackEnvVars.BROWSERSTACK_USERNAME, username);
            }

            if (credentials.hasAccesskey()) {
                String accesskey = credentials.getDecryptedAccesskey();
                env.put(BrowserStackEnvVars.BROWSERSTACK_ACCESSKEY, accesskey);
                env.put(BrowserStackEnvVars.BROWSERSTACK_ACCESS_KEY, accesskey);
                logEnvVar(BrowserStackEnvVars.BROWSERSTACK_ACCESS_KEY, Tools.maskString(accesskey));
            }
        }

        String grr_region = env.get(BrowserStackEnvVars.GRR_JENKINS_KEY);
        if ( grr_region != null ) {
            logEnvVar(BrowserStackEnvVars.GRR_JENKINS_KEY, grr_region);
            if ( Constants.GRR_AUTO_REGION_VS_APIURL.containsKey(grr_region.toLowerCase()) ) {
                setSystemProperty(BrowserStackEnvVars.AUTOMATE_API_ENV_KEY, Constants.GRR_AUTO_REGION_VS_APIURL.get(grr_region.toLowerCase()));
                setSystemProperty(BrowserStackEnvVars.APP_AUTOMATE_API_ENV_KEY, Constants.GRR_APPAUTO_REGION_VS_APIURL.get(grr_region.toLowerCase()));
            }
            else {
                log(logger, "Invalid GRR REGION passed. Supported values are US, EU. Skipping GRR Region for this job.");
            }
        }

        String buildTag = env.get(ENV_JENKINS_BUILD_TAG);
        if (buildTag != null) {
            env.put(BrowserStackEnvVars.BROWSERSTACK_BUILD, buildTag);
            logEnvVar(BrowserStackEnvVars.BROWSERSTACK_BUILD, buildTag);

            // Maintaining build name separately to have more control over it.
            // To keep it consistent with other CI/CD plugins.
            env.put(BrowserStackEnvVars.BROWSERSTACK_BUILD_NAME, buildTag);
            logEnvVar(BrowserStackEnvVars.BROWSERSTACK_BUILD_NAME, buildTag);

            // Maintaining this to verify if above env vars were set by plugin
            env.put("BROWSERSTACK_PLUGIN_INVOKED", "true");
        }

        String isLocalEnabled = localConfig != null ? "true" : "false";

        if (isLocalEnabled.equals("true")) {
            env.put(BrowserStackEnvVars.BROWSERSTACK_LOCAL, "" + isLocalEnabled);
            logEnvVar(BrowserStackEnvVars.BROWSERSTACK_LOCAL, isLocalEnabled);
        }

        String localIdentifier =
                (browserstackLocal != null) ? browserstackLocal.getLocalIdentifier() : "";

        if (Util.fixEmptyAndTrim(localIdentifier) != null) {
            env.put(BrowserStackEnvVars.BROWSERSTACK_LOCAL_IDENTIFIER, localIdentifier);
            logEnvVar(BrowserStackEnvVars.BROWSERSTACK_LOCAL_IDENTIFIER, localIdentifier);
        }

        String tests =
                (observabilityConfig != null) ? observabilityConfig.getTests() : "";

        if (Util.fixEmptyAndTrim(tests) != null) {
            env.put(BrowserStackEnvVars.BROWSERSTACK_RERUN_TESTS, tests);
            logEnvVar(BrowserStackEnvVars.BROWSERSTACK_RERUN_TESTS, tests);
        }

        String reRun =
                (observabilityConfig != null) ? observabilityConfig.getReRun() : "";

        if (Util.fixEmptyAndTrim(reRun) != null) {
            env.put(BrowserStackEnvVars.BROWSERSTACK_RERUN, reRun);
            logEnvVar(BrowserStackEnvVars.BROWSERSTACK_RERUN, reRun);
        }

        String host = env.get(BrowserStackEnvVars.QEI_URL);
        if ( host != null ) {
            logEnvVar(BrowserStackEnvVars.QEI_URL, host);
            Constants.QualityDashboardAPI.setHost(host);
        } else {
            Constants.QualityDashboardAPI.setHost(Constants.QualityDashboardAPI.QEI_DEFAULT_URL);
        }
    }

    public void logEnvVar(String key, String value) {
        if (!isTearDownPhase) {
            log(logger, key + "=" + value);
        }
    }

    public void setSystemProperty(String key, String value) {
        if(key != null){
            System.setProperty(key, value);
            logEnvVar(key.toUpperCase(), value);
        }
    }

}