net.sourceforge.pmd.cli.commands.internal.AbstractAnalysisPmdSubcommand Maven / Gradle / Ivy

Go to download
/**
 * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
 */

package net.sourceforge.pmd.cli.commands.internal;

import java.net.URI;
import java.nio.file.Files;
import java.nio.file.Path;
import java.util.LinkedHashSet;
import java.util.List;
import java.util.Set;

import net.sourceforge.pmd.AbstractConfiguration;
import net.sourceforge.pmd.cli.commands.mixins.internal.EncodingMixin;
import net.sourceforge.pmd.cli.internal.CliExitCode;
import net.sourceforge.pmd.cli.internal.PmdRootLogger;

import picocli.CommandLine.Mixin;
import picocli.CommandLine.Option;
import picocli.CommandLine.ParameterException;
import picocli.CommandLine.Parameters;

public abstract class AbstractAnalysisPmdSubcommand extends AbstractPmdSubcommand {

    @Mixin
    protected EncodingMixin encoding;

    // see the setters #setInputPaths and setPositionalInputPaths for @Option and @Parameters annotations
    // Note: can't use annotations on the fields here, as otherwise the complete list would be replaced
    // rather than accumulated.
    protected Set inputPaths;

    @Option(names = "--file-list",
            description =
                "Path to a file containing a list of files to analyze, one path per line. "
                + "One of --dir, --file-list or --uri must be provided.")
    protected Path fileListPath;
    
    @Option(names = { "--uri", "-u" },
            description = "Database URI for sources. "
                          + "One of --dir, --file-list or --uri must be provided.")
    protected URI uri;
    
    @Option(names = "--no-fail-on-violation",
            description = "By default PMD exits with status 4 if violations or duplications are found. "
                    + "Disable this option with '--no-fail-on-violation' to exit with 0 instead. In any case a report with the found violations or duplications will be written.",
            defaultValue = "true", negatable = true)
    protected boolean failOnViolation;

    @Option(names = "--no-fail-on-error",
            description = "By default PMD exits with status 5 if recoverable errors occurred (whether or not there are violations or duplications). "
                    + "Disable this option with '--no-fail-on-error' to exit with 0 instead. In any case, a report with the found violations or duplications will be written.",
            defaultValue = "true", negatable = true)
    protected boolean failOnError;

    protected List relativizeRootPaths;

    @Option(names = { "--relativize-paths-with", "-z"}, description = "Path relative to which directories are rendered in the report. "
            + "This option allows shortening directories in the report; "
            + "without it, paths are rendered as mentioned in the source directory (option \"--dir\"). "
            + "The option can be repeated, in which case the shortest relative path will be used. "
            + "If the root path is mentioned (e.g. \"/\" or \"C:\\\"), then the paths will be rendered as absolute.",
            arity = "1..*", split = ",")
    protected void setRelativizePathsWith(List rootPaths) {
        this.relativizeRootPaths = rootPaths;

        for (Path path : this.relativizeRootPaths) {
            if (Files.isRegularFile(path)) {
                throw new ParameterException(spec.commandLine(),
                        "Expected a directory path for option '--relativize-paths-with', found a file: " + path);
            }
        }
    }

    @Option(names = { "--dir", "-d" },
            description = "Path to a source file, or directory containing source files to analyze. "
                    + "Zip and Jar files are also supported, if they are specified directly "
                    + "(archive files found while exploring a directory are not recursively expanded). "
                    + "This option can be repeated, and multiple arguments can be provided to a single occurrence of the option. "
                    + "One of --dir, --file-list or --uri must be provided.",
            arity = "1..*", split = ",")
    protected void setInputPaths(final List inputPaths) {
        if (this.inputPaths == null) {
            this.inputPaths = new LinkedHashSet<>(); // linked hashSet in order to maintain order
        }

        this.inputPaths.addAll(inputPaths);
    }

    @Parameters(arity = "*", description = "Path to a source file, or directory containing source files to analyze. "
            + "Equivalent to using --dir.")
    protected void setPositionalInputPaths(final List inputPaths) {
        this.setInputPaths(inputPaths);
    }

    @Override
    protected final void validate() throws ParameterException {
        super.validate();

        if ((inputPaths == null || inputPaths.isEmpty()) && uri == null && fileListPath == null) {
            throw new ParameterException(spec.commandLine(),
                                         "Please provide a parameter for source root directory (--dir or -d), "
                                             + "database URI (--uri or -u), or file list path (--file-list)");
        }
    }


    protected abstract C toConfiguration();

    protected abstract CliExitCode doExecute(C conf);


    @Override
    protected CliExitCode execute() {
        final C configuration = toConfiguration();
        return PmdRootLogger.executeInLoggingContext(configuration,
                                                     debug,
                                                     this::doExecute);
    }

}