CoverityCommand.java

/*******************************************************************************
 * Copyright (c) 2017 Synopsys, Inc
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *    Synopsys, Inc - initial implementation and documentation
 *******************************************************************************/
package jenkins.plugins.coverity.CoverityTool;

import hudson.EnvVars;
import hudson.FilePath;
import hudson.Launcher;
import hudson.model.AbstractBuild;
import hudson.model.TaskListener;
import jenkins.plugins.coverity.*;
import org.apache.commons.lang.StringUtils;
import org.apache.commons.lang.Validate;

import javax.annotation.Nonnull;

public abstract class CoverityCommand extends Command {

    protected static final String intermediateDirArguments = "--dir";
    private static final String covIdirEnvVar = "COV_IDIR";
    protected static final String useSslArg = "--ssl";
    private static final String onNewCertArg = "--on-new-cert";
    private static final String trustArg = "trust";
    private static final String certArg = "--cert";

    public CoverityCommand(@Nonnull String command, AbstractBuild<?, ?> build, Launcher launcher, TaskListener listener, CoverityPublisher publisher, String home, EnvVars envVars) {
        super(build, launcher, listener, publisher, envVars);

        Validate.notEmpty(command, "Command cannot be null empty or null");

        addCommand(command, home);
        addIntermediateDir();
    }

    private void addCommand(String cmd, String home){
        String command = cmd;

        if (!StringUtils.isEmpty(home)){
            command = new FilePath(launcher.getChannel(), home).child("bin").child(command).getRemote();
        }
        commandLine.add(command);
    }

    protected void addIntermediateDir(){
        commandLine.add(intermediateDirArguments);
        String idir = envVars.get(covIdirEnvVar);
        if (!StringUtils.isEmpty(idir)){
            commandLine.add(idir);
        }else{
            CoverityTempDir tempDir = build.getAction(CoverityTempDir.class);
            if (tempDir != null) {
                commandLine.add(tempDir.getTempDir().getRemote());
            } else {
                // This is fall-back logic since when the command is invoked through launcher,
                // the launcher checks the intermeidate directory with the $COV_IDIR environment variable
                commandLine.add("$COV_IDIR");
            }

        }
    }

    protected void addTaCommandArgs(){
        if (publisher == null){
            return;
        }
        TaOptionBlock taOptionBlock = publisher.getTaOptionBlock();
        if (taOptionBlock != null){
            addArguments(taOptionBlock.getTaCommandArgs());
        }
    }

    protected void addSslConfiguration(CIMInstance cimInstance, CoverityVersion version) {
        if (cimInstance.isUseSSL()){
            if (version.compareTo(CoverityVersion.VERSION_JASPER) >= 0) {
                boolean isTrustNewSelfSignedCert = false;
                String certFileName = null;
                SSLConfigurations sslConfigurations = publisher.getDescriptor().getSslConfigurations();
                if(sslConfigurations != null){
                    isTrustNewSelfSignedCert = sslConfigurations.isTrustNewSelfSignedCert();
                    certFileName = sslConfigurations.getCertFileName();

                    if(isTrustNewSelfSignedCert){
                        addArgument(onNewCertArg);
                        addArgument(trustArg);
                    }
                    if(certFileName != null){
                        addArgument(certArg);
                        addArgument(certFileName);
                    }
                }
            }
        }
    }
}