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

Go to download
Show more of this group Show more artifacts with this name
Show all versions of integration-common Show documentation
The base library for all other integration libraries to encompass and export common dependencies and code.
There is a newer version: 26.1.2
/**
 * integration-common
 *
 * Copyright (c) 2020 Synopsys, Inc.
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements. See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership. The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License. You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied. See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
package com.synopsys.integration.executable;

import org.apache.commons.lang3.StringUtils;

import java.io.File;
import java.util.*;

public class Executable {
    private final File workingDirectory;
    private final Map environmentVariables = new HashMap<>();
    private final List commandWithArguments = new ArrayList<>();

    public static Executable create(final File workingDirectory, Map environmentVariables, final List commandWithArguments) {
        return new Executable(workingDirectory, environmentVariables, commandWithArguments);
    }

    public static Executable create(final File workingDirectory, Map environmentVariables, final String command, final List arguments) {
        List commandWithArguments = new ArrayList<>();
        commandWithArguments.add(command);
        commandWithArguments.addAll(arguments);
        return new Executable(workingDirectory, environmentVariables, commandWithArguments);
    }

    public static Executable create(final File workingDirectory, final List commandWithArguments) {
        return create(workingDirectory, Collections.emptyMap(), commandWithArguments);
    }

    public static Executable create(final File workingDirectory, final String command, final List arguments) {
        return create(workingDirectory, Collections.emptyMap(), command, arguments);
    }

    public static Executable create(final File workingDirectory, Map environmentVariables, File executableFile) {
        return create(workingDirectory, environmentVariables, executableFile.getAbsolutePath(), Collections.emptyList());
    }

    public static Executable create(final File workingDirectory, Map environmentVariables, File executableFile, List arguments) {
        return create(workingDirectory, environmentVariables, executableFile.getAbsolutePath(), arguments);
    }

    public static Executable create(final File workingDirectory, File executableFile) {
        return create(workingDirectory, executableFile.getAbsolutePath(), Collections.emptyList());
    }

    public static Executable create(final File workingDirectory, File executableFile, List arguments) {
        return create(workingDirectory, executableFile.getAbsolutePath(), arguments);
    }

    public static String getMaskedCommand(List commandWithArguments) {
        final List pieces = new ArrayList<>();
        for (final String argument : commandWithArguments) {
            if (argument.matches(".*password.*=.*")) {
                final String maskedArgument = argument.substring(0, argument.indexOf('=') + 1) + "********";
                pieces.add(maskedArgument);
            } else {
                pieces.add(argument);
            }
        }
        return StringUtils.join(pieces, ' ');
    }

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

    public String getExecutableDescription() {
        return Executable.getMaskedCommand(commandWithArguments);
    }

    /**
     * As some executables can contain password arguments, this method is not recommended for production runtimes.
     */
    public String getUnmaskedInsecureExecutableDescription() {
        return StringUtils.join(commandWithArguments, ' ');
    }

    public File getWorkingDirectory() {
        return workingDirectory;
    }

    public Map getEnvironmentVariables() {
        return environmentVariables;
    }

    public List getCommandWithArguments() {
        return commandWithArguments;
    }

}