net.sourceforge.pmd.lang.test.AbstractMetricTestRule Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of pmd-lang-test Show documentation
Module containing utilities to test language implementations, including parsers and ASTs. This module uses Kotlin.
There is a newer version: 7.5.0
/*
 * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
 */

package net.sourceforge.pmd.lang.test;

import java.text.MessageFormat;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

import net.sourceforge.pmd.lang.ast.Node;
import net.sourceforge.pmd.lang.metrics.Metric;
import net.sourceforge.pmd.lang.metrics.MetricOption;
import net.sourceforge.pmd.lang.metrics.MetricOptions;
import net.sourceforge.pmd.lang.rule.AbstractRule;
import net.sourceforge.pmd.properties.PropertyDescriptor;
import net.sourceforge.pmd.properties.PropertyFactory;
import net.sourceforge.pmd.reporting.RuleContext;


/**
 * Abstract test rule for a metric. Tests of metrics use the standard
 * framework for rule testing, using one dummy rule per metric. Default
 * parameters can be overridden by overriding the protected methods of
 * this class.
 *
 * @param  Result type of the metric. The nested subclasses provide
 *            defaults for common result types
 *
 * @author Clément Fournier
 */
public abstract class AbstractMetricTestRule> extends AbstractRule {

    private final PropertyDescriptor> optionsDescriptor =
        PropertyFactory.enumListProperty("metricOptions", optionMappings())
                       .desc("Choose a variant of the metric or the standard")
                       .emptyDefaultValue()
                       .build();

    private final PropertyDescriptor reportLevelDescriptor =
        PropertyFactory.stringProperty("reportLevel")
                       .desc("Minimum value required to report")
                       .defaultValue("" + defaultReportLevel())
                       .build();

    private final Metric metric;

    public AbstractMetricTestRule(Metric metric) {
        this.metric = metric;

        definePropertyDescriptor(reportLevelDescriptor);
        definePropertyDescriptor(optionsDescriptor);
    }

    protected abstract N parseReportLevel(String value);

    protected boolean reportOn(Node node) {
        return metric.supports(node);
    }

    /**
     * Mappings of labels to options for use in the options property.
     *
     * @return A map of labels to options
     */
    protected Map optionMappings() {
        return new HashMap<>();
    }


    /**
     * Default report level, which is 0.
     *
     * @return The default report level.
     */
    protected abstract N defaultReportLevel();

    protected String violationMessage(Node node, N result) {
        return MessageFormat.format("At line {0} level {1}", node.getBeginLine(), result);
    }

    @Override
    public void apply(Node target, RuleContext ctx) {
        if (reportOn(target)) {
            MetricOptions options = MetricOptions.ofOptions(getProperty(optionsDescriptor));
            N reportLevel = parseReportLevel(getProperty(reportLevelDescriptor));
            N result = Metric.compute(metric, target, options);

            if (result != null && reportLevel.compareTo(result) <= 0) {
                ctx.addViolationWithMessage(target, violationMessage(target, result));
            }
        }

        // visit the whole tree
        for (Node child : target.children()) {
            apply(child, ctx);
        }
    }


    public abstract static class OfInt extends AbstractMetricTestRule {

        protected OfInt(Metric metric) {
            super(metric);
        }

        @Override
        protected Integer parseReportLevel(String value) {
            return Integer.parseInt(value);
        }

        @Override
        protected Integer defaultReportLevel() {
            return 0;
        }
    }

    public abstract static class OfDouble extends AbstractMetricTestRule {

        protected OfDouble(Metric metric) {
            super(metric);
        }

        @Override
        protected Double parseReportLevel(String value) {
            return Double.parseDouble(value);
        }

        @Override
        protected Double defaultReportLevel() {
            return 0.;
        }
    }

}