com.synopsys.integration.coverity.executable.Executable Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of coverity-common Show documentation
A library for using various capabilities of Coverity.
The newest version!
/*
 * coverity-common
 *
 * Copyright (c) 2021 Synopsys, Inc.
 *
 * Use subject to the terms and conditions of the Synopsys End User Software License and Maintenance Agreement. All rights reserved worldwide.
 */
package com.synopsys.integration.coverity.executable;

import java.io.File;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

import org.apache.commons.lang3.StringUtils;

import com.synopsys.integration.coverity.exception.ExecutableException;

public class Executable extends EnvironmentContributor {
    public static final String MASKED_PASSWORD = "********";
    private final File workingDirectory;
    private final Map environmentVariables = new HashMap<>();
    private final List executableArguments = new ArrayList<>();

    public Executable(final List executableArguments) {
        this(executableArguments, new File(System.getProperty("user.dir")));
    }

    public Executable(final List executableArguments, final File workingDirectory) {
        this(executableArguments, workingDirectory, Collections.emptyMap());
    }

    public Executable(final List executableArguments, final File workingDirectory, final Map environmentVariables) {
        this.workingDirectory = workingDirectory;
        this.executableArguments.addAll(executableArguments);
        this.environmentVariables.putAll(environmentVariables);
    }

    public String getJoinedExecutableArguments() {
        return StringUtils.join(getExecutableArguments(), ' ');
    }

    public List getExecutableArguments() {
        return executableArguments;
    }

    public String getMaskedExecutableArguments() throws ExecutableException {
        final List arguments = new ArrayList<>(getExecutableArguments());
        return getMaskedExecutableArguments(arguments);
    }

    public String getMaskedExecutableArguments(final List arguments) throws ExecutableException {
        int passwordIndex = getPasswordIndex(arguments);

        if (passwordIndex != -1) {
            arguments.set(passwordIndex, MASKED_PASSWORD);
        }

        return StringUtils.join(arguments, ' ');
    }

    public Map getEnvironmentVariables() {
        return environmentVariables;
    }

    public File getWorkingDirectory() {
        return workingDirectory;
    }

    public List processExecutableArguments() throws ExecutableException {
        // If the User provided the password as an argument, we want to set it as the environment variable of the process so it is not exposed when looking up the process
        // Passwords are provided using --password password OR --pa password
        final List processedExecutableArguments = new ArrayList<>(getExecutableArguments());

        final int passwordIndex = getPasswordIndex(processedExecutableArguments);
        if (passwordIndex != -1) {
            final String removedValue = processedExecutableArguments.remove(passwordIndex);
            //also remove the argument before the password
            processedExecutableArguments.remove(passwordIndex - 1);
            populateEnvironmentMap(getEnvironmentVariables(), CoverityToolEnvironmentVariable.PASSPHRASE, removedValue);
        }
        return processedExecutableArguments;
    }

    private int getPasswordIndex(final List list) throws ExecutableException {
        // Passwords are provided using --password password OR --pa password
        int passwordIndex = -1;
        for (int i = 1; i < list.size(); i++) {
            final String lastArgument = list.get(i - 1);
            if (lastArgument.equals("--password") || lastArgument.equals("--pa")) {
                if (passwordIndex != -1) {
                    throw new ExecutableException("Cannot provide multiple password arguments.");
                }
                passwordIndex = i;
            }
        }
        return passwordIndex;
    }

}