[core] RuleSetFactory - recognize rule reference for same ruleset

There are two variants, how a renamed rule can be expressed in the ruleset via a deprecated rule reference: referencing just the new rule name or referencing the ruleset+new rule name. The latter case was not covered yet, it was not detected, that the rule ref references are rule in the same ruleset. Fixes pmd#2096
adangel · Nov 4, 2019 · 007de29 · 007de29
1 parent bfa2d1e
commit 007de29
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 0 deletions.
diff --git a/docs/pages/release_notes.md b/docs/pages/release_notes.md
@@ -16,6 +16,9 @@ This is a {{ site.pmd.release_type }} release.
 
 ### Fixed Issues
 
+*   core
+    *   [#2096](https://github.com/pmd/pmd/issues/2096): \[core] Referencing category errorprone.xml produces deprecation warnings for InvalidSlf4jMessageFormat
+
 ### API Changes
 
 ### External Contributions

diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/RuleSetFactory.java b/pmd-core/src/main/java/net/sourceforge/pmd/RuleSetFactory.java
@@ -639,6 +639,10 @@ private void parseRuleReferenceNode(RuleSetReferenceId ruleSetReferenceId, RuleS
                 && containsRule(ruleSetReferenceId, otherRuleSetReferenceId.getRuleName())) {
             otherRuleSetReferenceId = new RuleSetReferenceId(ref, ruleSetReferenceId);
             isSameRuleSet = true;
+        } else if (otherRuleSetReferenceId.isExternal()
+                && otherRuleSetReferenceId.getRuleSetFileName().equals(ruleSetReferenceId.getRuleSetFileName())) {
+            otherRuleSetReferenceId = new RuleSetReferenceId(otherRuleSetReferenceId.getRuleName(), ruleSetReferenceId);
+            isSameRuleSet = true;
         }
         // do not ignore deprecated rule references
         Rule referencedRule = ruleSetFactory.createRule(otherRuleSetReferenceId, true);

diff --git a/pmd-core/src/test/resources/rulesets/dummy/basic.xml b/pmd-core/src/test/resources/rulesets/dummy/basic.xml
@@ -18,7 +18,11 @@ Just for test
      </example>
     </rule>
 
+    <!-- variant 1 of a renamed rule. This is definitively within the same ruleset. -->
     <rule deprecated="true" name="OldNameOfDummyBasicMockRule" ref="DummyBasicMockRule"/>
+    <!-- variant 2 of a renamed and/or moved rule. This could also keep the rule name but
+         move the rule into a different rule or do any combination of both -->
+    <rule deprecated="true" name="OldNameOfDummyBasicMockRule2" ref="rulesets/dummy/basic.xml/DummyBasicMockRule"/>
 
     <rule name="SampleXPathRule" language="dummy" since="1.1" message="Test Rule 2" class="net.sourceforge.pmd.lang.rule.XPathRule"
         externalInfoUrl="${pmd.website.baseurl}/rules/dummy/basic.xml#SampleXPathRule">

diff --git a/pmd-dist/src/test/java/net/sourceforge/pmd/it/AllRulesIT.java b/pmd-dist/src/test/java/net/sourceforge/pmd/it/AllRulesIT.java
@@ -40,6 +40,7 @@ private static void assertDefaultExecutionResult(ExecutionResult result) {
         result.assertNoError("Exception applying rule");
         result.assertNoError("Ruleset not found");
         result.assertNoError("Use of deprecated attribute");
+        result.assertNoError("instead of the deprecated"); // rule deprecations
         result.assertNoErrorInReport("Error while processing");
         result.assertNoErrorInReport("Error while parsing");
     }