Merge pull request pmd#4058 from oowekyala:pmd6-focused-test-attr

[test-schema] Add focused attr to the test schema pmd#4058

Author: adangel

docs/_plugins/jdoc_namespace_tag.rb

@@ -102,7 +102,7 @@ def self.parse_fqcn(fqcn, var_ctx, allow_sym = true)
   RESERVED_NSPACES = ['apex', 'core', 'cpp', 'cs', 'dart', 'dist', 'doc', 'fortran', 'go', 'groovy', 'java',
     'javascript', 'jsp',
     'kotlin', 'lua', 'matlab', 'objectivec', 'perl', 'php', 'plsql', 'python', 'ruby', 'scala', 'swift',
-    'test', 'ui',
+    'test', 'test-schema', 'ui',
     'modelica', 'visualforce', 'vm', 'xml'].flat_map {|m| [m, "pmd-" + m]}
 
   def self.make_base_namespaces

docs/pages/pmd/userdocs/extending/testing.md

@@ -135,14 +135,18 @@ between different test cases.
 
 The `<test-code>` elements understands the following optional attributes:
 
-* **reinitializeRule**: By default, it's `true`, so each test case starts with a fresh instantiated rule. Set it
-    to `false` to reproduce cases, where the previous run has influences.
+* **disabled**: By default, it's `false`. Set it to `true`, to ignore and skip a test case.
 
-* **disabled**: By default, it's `false`. Set ti to `true`, to ignore and skip a test case.
+* **focused**: By default, it's `false`. Set it to `true`, to ignore all other test cases.
 
-* **useAuxClasspath**: By default, it's `true`. Set it to `false` to reproduce issues which only
+* **useAuxClasspath**: _deprecated since PMD 6.48.0: assumed true, has no effect anymore._
+    By default, it's `true`. Set it to `false` to reproduce issues which only
     appear without type resolution.
 
+* **reinitializeRule**: _deprecated since PMD 6.48.0: assumed true, has no effect anymore._
+    By default, it's `true`, so each test case starts with a fresh instantiated rule. Set it
+    to `false` to reproduce cases, where the previous run has influences.
+
 * **regressionTest**: _deprecated since PMD 6.48.0: Use `disabled` instead. Note: It has the opposite boolean
   semantic._ By default, it's `true`. Set it to `false`, to ignore and skip a test case.
 

docs/pages/release_notes.md

@@ -54,6 +54,7 @@ Being based on a proper Antlr grammar, CPD can:
 * java-performance
     * [#3625](https://github.com/pmd/pmd/issues/3625): \[java] AddEmptyString - false negative with empty var
 * test
+    * [#3302](https://github.com/pmd/pmd/pull/3302): \[test] Improve xml test schema
     * [#3758](https://github.com/pmd/pmd/issues/3758): \[test] Move pmd-test to java 8
     * [#3976](https://github.com/pmd/pmd/pull/3976): \[test] Extract xml schema module
 
@@ -65,8 +66,12 @@ Being based on a proper Antlr grammar, CPD can:
   this module for testing your own custom rules, you'll need to make sure to use at least Java 8.
 * The new module "pmd-test-schema" contains now the XSD schema and the code to parse the rule test XML files. The
   schema has been extracted in order to easily share it with other tools like the Rule Designer or IDE plugins.
-* The attribute `isRegressionTest` is deprecated and the new attribute `disabled` should be used instead for
-  defining whether a rule test should be skipped or not.
+* Test schema changes:
+    * The attribute `isRegressionTest` of `test-code` is deprecated. The new
+    attribute `disabled` should be used instead for defining whether a rule test should be skipped or not.
+    * The attributes `reinitializeRule` and `useAuxClasspath` of `test-code` are deprecated and assumed true.
+    They will not be replaced.
+    * The new attribute `focused` of `test-code` allows disabling all tests except the focused one temporarily.
 * More information about the rule test framework can be found in the documentation:
   [Testing your rules](pmd_userdocs_extending_testing.html)
 
@@ -77,6 +82,8 @@ Being based on a proper Antlr grammar, CPD can:
   but it is no longer supported with Java 19 Preview.
 * The interface {% jdoc core::cpd.renderer.CPDRenderer %} is deprecated. For custom CPD renderers
   the new interface {% jdoc core::cpd.renderer.CPDReportRenderer %} should be used.
+* The class {% jdoc test::testframework.TestDescriptor %} is deprecated, replaced with {% jdoc test-schema::testframework.RuleTestDescriptor %}.
+* Many methods of {% jdoc test::testframework.RuleTst %} have been deprecated as internal API.
 
 #### Experimental APIs
 

pmd-java/src/test/java/net/sourceforge/pmd/jaxen/RegexpAcceptanceTest.java

@@ -4,33 +4,64 @@
 
 package net.sourceforge.pmd.jaxen;
 
+import static org.junit.Assert.assertEquals;
+
+import java.util.List;
+
+import org.junit.Before;
 import org.junit.Test;
 
+import net.sourceforge.pmd.PMDConfiguration;
+import net.sourceforge.pmd.PmdAnalysis;
+import net.sourceforge.pmd.Report;
 import net.sourceforge.pmd.Rule;
+import net.sourceforge.pmd.RuleSet;
+import net.sourceforge.pmd.RuleViolation;
 import net.sourceforge.pmd.lang.LanguageRegistry;
 import net.sourceforge.pmd.lang.java.JavaLanguageModule;
 import net.sourceforge.pmd.lang.rule.XPathRule;
-import net.sourceforge.pmd.testframework.SimpleAggregatorTst;
-import net.sourceforge.pmd.testframework.TestDescriptor;
+import net.sourceforge.pmd.lang.rule.xpath.XPathVersion;
 
-public class RegexpAcceptanceTest extends SimpleAggregatorTst {
+public class RegexpAcceptanceTest {
 
     private static final String XPATH = "//ClassOrInterfaceDeclaration[matches(@Image, 'F?o')]";
 
-    @Override
-    protected void setUp() {
-        // not registering any rule
+    private Rule rule;
+
+    @Before
+    public void setUp() {
+        rule = new XPathRule(XPathVersion.XPATH_1_0, XPATH);
+        rule.setLanguage(LanguageRegistry.getLanguage(JavaLanguageModule.NAME));
+        rule.setMessage("F?o matched");
+    }
+
+    @Test
+    public void shouldMatchFoo() {
+        List<RuleViolation> violations = eval("public class Foo {}");
+        assertEquals(1, violations.size());
+    }
+
+    @Test
+    public void shouldNotMatchBar() {
+        List<RuleViolation> violations = eval("public class Bar {}");
+        assertEquals(0, violations.size());
     }
 
     @Test
-    public void testSimple() {
-        Rule r = new XPathRule(XPATH);
-        r.setLanguage(LanguageRegistry.getLanguage(JavaLanguageModule.NAME));
-        r.setMessage("");
-        TestDescriptor[] testDescriptors = extractTestsFromXml(r, "RegexpAcceptance");
-        for (TestDescriptor testDescriptor : testDescriptors) {
-            testDescriptor.setReinitializeRule(false);
+    public void shouldMatchFlo() {
+        List<RuleViolation> violations = eval("public class Flo {}");
+        assertEquals(1, violations.size());
+    }
+
+    private List<RuleViolation> eval(String code) {
+        PMDConfiguration config = new PMDConfiguration();
+        config.setIgnoreIncrementalAnalysis(true);
+        try (PmdAnalysis pmd = PmdAnalysis.create(config)) {
+            pmd.addRuleSet(RuleSet.forSingleRule(rule));
+            pmd.files().addSourceFile(code, "RegexpAcceptanceTest.java");
+
+            Report report = pmd.performAnalysisAndCollectReport();
+            return report.getViolations();
         }
-        runTests(testDescriptors);
     }
 }

pmd-java/src/test/resources/net/sourceforge/pmd/jaxen/xml/RegexpAcceptance.xml

@@ -178,7 +178,8 @@ public class TournamentTest extends TestCase {
         ]]></code>
     </test-code>
 
-    <test-code useAuxClasspath="false">
+    <!-- it's not possible anymore to test without auxclasspath. junit4 is always on the test auxclasspath -->
+    <test-code disabled="true">
         <description>JUnit 4 test detection without proper auxclasspath</description>
         <expected-problems>1</expected-problems>
         <expected-linenumbers>8</expected-linenumbers>

pmd-java/src/test/resources/net/sourceforge/pmd/lang/java/rule/codestyle/xml/MethodNamingConventions.xml

@@ -149,7 +149,7 @@ public class Test {
         <code-ref id="constructor-violation"/>
     </test-code>
 
-    <test-code reinitializeRule="true">
+    <test-code>
         <description>#985 Suppressed methods shouldn't affect avg CyclomaticComplexity</description>
         <rule-property name="methodReportLevel">2</rule-property>
         <expected-problems>0</expected-problems>

pmd-java/src/test/resources/net/sourceforge/pmd/lang/java/rule/design/xml/CyclomaticComplexity.xml

@@ -164,7 +164,7 @@ public class Test {
         <code-ref id="constructor-violation"/>
     </test-code>
 
-    <test-code reinitializeRule="true">
+    <test-code>
         <description>#985 Suppressed methods shouldn't affect avg CyclomaticComplexity</description>
         <rule-property name="reportLevel">2</rule-property>
         <expected-problems>0</expected-problems>

pmd-java/src/test/resources/net/sourceforge/pmd/lang/java/rule/design/xml/StdCyclomaticComplexity.xml

@@ -249,7 +249,7 @@ public class Foo {
         ]]></code>
     </test-code>
 
-    <test-code reinitializeRule="true">
+    <test-code>
         <description>invoke an external method that close the resource: bug 2920057</description>
         <rule-property name="closeTargets">closeStatement,closeStatement,closeResultSet,closeConnexion</rule-property>
         <rule-property name="types">java.sql.Connection,java.sql.Statement,java.sql.ResultSet,java.sql.PreparedStatement</rule-property>
@@ -280,7 +280,7 @@ public class StructureFactory {
         ]]></code>
     </test-code>
 
-    <test-code reinitializeRule="true">
+    <test-code>
         <description>invoke an external method that closes the resource, but one is not the right method and an another is not the right variable: see bug 2920057</description>
         <rule-property name="closeTargets">closeStatement,closeStatement,closeResultSet,closeConnexion</rule-property>
         <rule-property name="types">java.sql.Connection,java.sql.Statement,java.sql.ResultSet,java.sql.PreparedStatement</rule-property>
@@ -312,7 +312,7 @@ public class StructureFactory {
         ]]></code>
     </test-code>
 
-    <test-code reinitializeRule="true">
+    <test-code>
         <description>#1011 CloseResource Rule ignores Constructors</description>
         <expected-problems>1</expected-problems>
         <code><![CDATA[
@@ -326,7 +326,7 @@ public class Test {
         ]]></code>
     </test-code>
 
-    <test-code reinitializeRule="true">
+    <test-code>
         <description>#1011 CloseResource Rule ignores Constructors - closed in finally</description>
         <expected-problems>0</expected-problems>
         <code><![CDATA[
@@ -345,7 +345,7 @@ public class Test {
         ]]></code>
     </test-code>
 
-    <test-code reinitializeRule="true">
+    <test-code>
         <description>#1011 CloseResource Rule ignores Constructors - not a problem - instance variable</description>
         <expected-problems>0</expected-problems>
         <code><![CDATA[
@@ -360,7 +360,7 @@ public class Test {
         ]]></code>
     </test-code>
 
-    <test-code reinitializeRule="true">
+    <test-code>
         <description>#1029 No instance level check in the close resource rule</description>
         <expected-problems>0</expected-problems>
         <code><![CDATA[

pmd-java/src/test/resources/net/sourceforge/pmd/lang/java/rule/errorprone/xml/CloseResource.xml

@@ -100,6 +100,13 @@ private void parseSingleTest(Element testCode,
 
         descriptor.setDisabled(disabled);
 
+
+        boolean focused = parseBoolAttribute(testCode, "focused", false, err,
+                                             "Attribute focused is used, do not forget to remove it when checking in sources");
+
+        descriptor.setFocused(focused);
+
+
         Properties properties = parseRuleProperties(testCode, descriptor.getRule(), err);
         descriptor.getProperties().putAll(properties);