net.sourceforge.pmd.Rule Java Examples

private static Set<Language> getApplicableLanguages(PMDConfiguration configuration, RuleSets ruleSets) {
    Set<Language> languages = new HashSet<>();
    LanguageVersionDiscoverer discoverer = configuration.getLanguageVersionDiscoverer();

    for (Rule rule : ruleSets.getAllRules()) {
        Language language = rule.getLanguage();
        if (languages.contains(language)) {
            continue;
        }
        LanguageVersion version = discoverer.getDefaultLanguageVersion(language);
        if (RuleSet.applies(rule, version)) {
            languages.add(language);
            if (LOG.isLoggable(Level.FINE)) {
                LOG.fine("Using " + language.getShortName() + " version: " + version.getShortName());
            }
        }
    }
    return languages;
}
 

/**
 * Paste from PMD
 */
private static Set<Language> getApplicableLanguages(PMDConfiguration configuration, RuleSets ruleSets) {
    Set<Language> languages = new HashSet<>();
    LanguageVersionDiscoverer discoverer = configuration.getLanguageVersionDiscoverer();

    for (Rule rule : ruleSets.getAllRules()) {
        Language language = rule.getLanguage();
        if (languages.contains(language))
            continue;
        LanguageVersion version = discoverer.getDefaultLanguageVersion(language);
        if (RuleSet.applies(rule, version)) {
            languages.add(language);
            log.debug("Using {} version: {}", language.getShortName(), version.getShortName());
        }
    }
    return languages;
}
 

@Test
public void should_convert_pmd_violation_to_sonar_violation() {
  org.sonar.api.rules.Rule sonarRule = createRuleInRuleFinder("RULE");
  File file1 = new File("src/source.java");
  DefaultInputFile inputFile1 = addToFileSystem(file1);
  Issuable issuable = createIssuable(inputFile1);
  RuleViolation pmdViolation = createPmdViolation(file1, 42, "Description", "RULE");

  Issue issue = mock(Issue.class);
  IssueBuilder issueBuilder = mock(IssueBuilder.class);
  when(issuable.newIssueBuilder()).thenReturn(issueBuilder);
  when(issueBuilder.ruleKey(sonarRule.ruleKey())).thenReturn(issueBuilder);
  when(issueBuilder.message("Description")).thenReturn(issueBuilder);
  when(issueBuilder.line(42)).thenReturn(issueBuilder);
  when(issueBuilder.build()).thenReturn(issue);

  pmdViolationRecorder.saveViolation(pmdViolation);
  verify(issuable).addIssue(issue);
  verify(issueBuilder).ruleKey(sonarRule.ruleKey());
  verify(issueBuilder).message("Description");
  verify(issueBuilder).line(42);
  verify(sonarRule, atLeastOnce()).ruleKey();
}
 

@Test
public void should_ignore_violation_on_non_issuable_resource() {
  org.sonar.api.rules.Rule sonarRule = createRuleInRuleFinder("RULE");
  File file1 = new File("test/source.java");
  addToFileSystem(file1);
  RuleViolation pmdViolation = createPmdViolation(file1, 42, "Description", "RULE");

  pmdViolationRecorder.saveViolation(pmdViolation);
  verifyZeroInteractions(sonarRule);
}
 

@NotNull
private RuleViolation createRuleViolation(@NotNull Rule rule, String violationDescription, @NotNull Configuration config) {
    renderer = new CollectorRenderer(config);
    RuleViolation violation = mock(RuleViolation.class);
    when(violation.getRule()).thenReturn(rule);
    when(violation.getDescription()).thenReturn(violationDescription);

    return violation;
}
 

@NotNull
private Rule createRule(String ruleDescription, String externalInfoUrl, RulePriority priority, @NotNull Configuration config) {
    renderer = new CollectorRenderer(config);
    Rule rule = mock(Rule.class);
    when(rule.getDescription()).thenReturn(ruleDescription);
    when(rule.getExternalInfoUrl()).thenReturn(externalInfoUrl);
    when(rule.getPriority()).thenReturn(priority);

    return rule;
}
 

@Test
void shouldReportViolationWithoutDetails() throws IOException {
    Configuration config = new ConfigurationSetup().setUp(ImmutableMap.of(GeneralOption.PMD_SHOW_VIOLATION_DETAILS.getKey(), "false"));
    Rule rule = createRule(RULE_DESCRIPTION, EXTERNAL_INFO_URL, RulePriority.MEDIUM, config);
    Report report = createReportWithVolation(createRuleViolation(rule, VIOLATION_DESCRIPTION, config), config);

    renderer.renderFileReport(report);

    Violation violation = renderer.getReviewResult().getViolations().get(0);
    assertThat(violation.getMessage()).isEqualTo(VIOLATION_DESCRIPTION);
}
 

@Test
void shouldReportViolationWithDetails() throws IOException {
    Configuration config = new ConfigurationSetup().setUp(ImmutableMap.of(GeneralOption.PMD_SHOW_VIOLATION_DETAILS.getKey(), "true"));
    Rule rule = createRule(RULE_DESCRIPTION, EXTERNAL_INFO_URL, RulePriority.HIGH, config);
    Report report = createReportWithVolation(createRuleViolation(rule, VIOLATION_DESCRIPTION, config), config);

    renderer.renderFileReport(report);

    Violation violation = renderer.getReviewResult().getViolations().get(0);
    assertThat(violation.getMessage()).isEqualTo(DESCRIPTION_WITH_DETAILS);
    assertThat(violation.getSeverity()).isEqualTo(Severity.ERROR);
}
 

/**
 * Creates the message string to be shown for the specified rule.
 *
 * @param rule
 *         the rule
 *
 * @return the message string to be shown for the specified rule
 */
private String createMessage(final Rule rule) {
    StringBuilder message = new StringBuilder(rule.getDescription());
    List<String> examples = rule.getExamples();
    if (!examples.isEmpty()) {
        message.append(pre().with(code(examples.get(0))).renderFormatted());
    }
    if (StringUtils.isNotBlank(rule.getExternalInfoUrl())) {
        message.append(a().withHref(rule.getExternalInfoUrl()).withText("See PMD documentation.").renderFormatted());
    }
    return message.toString();
}
 

/**
 * Returns the message for the specified PMD rule.
 *
 * @param ruleSetName
 *         PMD rule set
 * @param ruleName
 *         PMD rule ID
 *
 * @return the message
 */
public String getMessage(final String ruleSetName, final String ruleName) {
    if (rules.containsKey(ruleSetName)) {
        RuleSet ruleSet = rules.get(ruleSetName);
        Rule rule = ruleSet.getRuleByName(ruleName);
        if (rule != null) {
            return createMessage(rule);
        }
    }
    return StringUtils.EMPTY;
}
 

private RuleViolation createPmdViolation(File file, int line, String description, String ruleName) {
  Rule rule = mock(Rule.class);
  when(rule.getName()).thenReturn(ruleName);
  RuleViolation pmdViolation = mock(RuleViolation.class);
  when(pmdViolation.getFilename()).thenReturn(file.getAbsolutePath());
  when(pmdViolation.getBeginLine()).thenReturn(line);
  when(pmdViolation.getDescription()).thenReturn(description);
  when(pmdViolation.getRule()).thenReturn(rule);
  return pmdViolation;
}
 

/**
 * Create a report, filter out any defective rules, and keep a record of
 * them.
 *
 * @param rs the rules
 * @param ctx the rule context
 * @param fileName the filename of the source file, which should appear in the report
 * @return the Report
 */
public static Report setupReport(RuleSets rs, RuleContext ctx, String fileName) {

    Set<Rule> brokenRules = removeBrokenRules(rs);
    Report report = Report.createReport(ctx, fileName);

    for (Rule rule : brokenRules) {
        report.addConfigError(new Report.RuleConfigurationError(rule, rule.dysfunctionReason()));
    }

    return report;
}
 

@Test
public void should_ignore_violation_on_unknown_resource() {
  org.sonar.api.rules.Rule sonarRule = createRuleInRuleFinder("RULE");
  File unknownFile = new File("src/UNKNOWN.java");
  RuleViolation pmdViolation = createPmdViolation(unknownFile, 42, "Description", "RULE");

  pmdViolationRecorder.saveViolation(pmdViolation);
  verifyZeroInteractions(sonarRule);
}
 

/**
 * Remove and return the misconfigured rules from the rulesets and log them
 * for good measure.
 *
 * @param ruleSets
 *            RuleSets
 * @return Set<Rule>
 */
private static Set<Rule> removeBrokenRules(RuleSets ruleSets) {

    Set<Rule> brokenRules = new HashSet<>();
    ruleSets.removeDysfunctionalRules(brokenRules);

    for (Rule rule : brokenRules) {
        if (LOG.isLoggable(Level.WARNING)) {
            LOG.log(Level.WARNING,
                "Removed misconfigured rule: " + rule.getName() + "  cause: " + rule.dysfunctionReason());
        }
    }

    return brokenRules;
}
 

private org.sonar.api.rules.Rule createRuleInRuleFinder(String ruleName) {
  org.sonar.api.rules.Rule sonarRule = mock(org.sonar.api.rules.Rule.class);
  when(ruleFinder.findByKey("pmd", ruleName)).thenReturn(sonarRule);
  when(sonarRule.ruleKey()).thenReturn(RuleKey.of("pmd", ruleName));
  return sonarRule;
}
 

@Override
protected void visit(Rule rule, Node node, RuleContext ctx) {
    rule.apply(Collections.singletonList(node), ctx);
}
 

@Override
protected RuleViolation createRuleViolation(Rule rule, RuleContext ruleContext, Node node, String s, int i, int i1) {
    return new ParametricRuleViolation<>(rule, ruleContext, node, s);
}
 

@Override
protected RuleViolation createRuleViolation(Rule rule, RuleContext ruleContext, Node node, String s) {
    return new ParametricRuleViolation<>(rule, ruleContext, node, s);
}
 

private static <T> void setRulePropertyCapture(Rule rule, PropertyDescriptor<T> descriptor, String value) {
    rule.setProperty(descriptor, descriptor.valueFrom(value));
}