edu.hm.hafner.analysis.registry.ClairDescriptor Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of analysis-model Show documentation

This library provides a Java object model to read, aggregate, filter, and query static analysis reports. It is used by Jenkins' warnings next generation plug-in to visualize the warnings of individual builds. Additionally, this library is used by a GitHub action to autograde student software projects based on a given set of metrics (unit tests, code and mutation coverage, static analysis warnings).

There is a newer version: 13.3.0

Show newest version

package edu.hm.hafner.analysis.registry;

import edu.hm.hafner.analysis.IssueParser;
import edu.hm.hafner.analysis.parser.ClairParser;

/**
 * A descriptor for {@code clair-scanner} json report.
 *
 * @author Lorenz Munsch
 */
class ClairDescriptor extends ParserDescriptor {
    private static final String ID = "clair";
    private static final String NAME = "Clair Scanner";

    ClairDescriptor() {
        super(ID, NAME);
    }

    @Override
    public IssueParser createParser(final Option... options) {
        return new ClairParser();
    }

    @Override
    public String getHelp() {
        return "Reads Clair json data. "
                + "Use commandline clair-scanner --report=\"/target/clair.json\" output.
"
                + "See "
                + "clair-scanner on Github for usage details.";
    }

    @Override
    public String getUrl() {
        return "https://github.com/arminc/clair-scanner";
    }
}