edu.hm.hafner.analysis.parser.AnsibleLintParser 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.parser;

import java.util.Optional;
import java.util.regex.Matcher;

import edu.hm.hafner.analysis.Issue;
import edu.hm.hafner.analysis.IssueBuilder;
import edu.hm.hafner.analysis.LookaheadParser;
import edu.hm.hafner.util.LookaheadStream;

/**
 * A parser for Ansible Lint warnings.
 *
 * 
 * The parser expects the Ansible Lint output to be in a "parseable output in the format of pep8".
 * Pass the argument {@code -p} to Ansible Lint to get a compatible output.
 * 
 *
 * @author Ce Qi
 */
public class AnsibleLintParser extends LookaheadParser {
    private static final long serialVersionUID = 8481090596321427484L;

    private static final String ANSIBLE_LINT_WARNING_PATTERN = "(?.*)\\:(?[0-9]*)\\:\\s*(\\[(?[a-zA-Z0-9\\-\\[\\]]+)\\]|(?[^\\[][a-zA-Z0-9\\[\\]\\-]+)):?\\s(?.*)";

    /**
     * Creates a new instance of {@link AnsibleLintParser}.
     */
    public AnsibleLintParser() {
        super(ANSIBLE_LINT_WARNING_PATTERN);
    }

    @Override
    protected boolean isLineInteresting(final String line) {
        return line.contains(":");
    }

    @Override
    protected Optional createIssue(final Matcher matcher, final LookaheadStream lookahead,
            final IssueBuilder builder) {
        final String cat;

        /* Ansible-lint has changed the style of parseable output. This requires
         * to distinguish between rule names in square brackets and rule names
         * containing square brackets. */
        if (matcher.group("cat") != null) {
            cat = matcher.group("cat");
        }
        else {
            cat = matcher.group("newcat");
        }

        return builder.setFileName(matcher.group("file"))
                .setLineStart(matcher.group("lineno"))
                .setCategory(cat)
                .setMessage(matcher.group("msg"))
                .buildOptional();
    }
}