[test] Extract xml schema module by oowekyala · Pull Request #3976 · pmd/pmd

oowekyala · 2022-05-21T11:24:57Z

This is to be able to change the schema (#3302) without needing to update the designer as well. The designer will be able to depend on this module without depending on pmd-test (which itself depends on junit and other things). It also cleans up RuleTst which implemented the parsing adhoc.

There is now a copy of the schema in pmd-test and another in pmd-test-schema. The only functional change to the schema is the introduction of an disabled attribute to replace isRegressionTest (see #3302). isRegressionTest is still supported but produces a deprecation warning.

~~The PR is currently blocked on #2435. I need a Rule instance to write tests, but there is no language on the classpath. I really really don't want to have to write another dummy language module...~~ update This PR contains #4024, which unblocks it.

Related issues

Relates to [test] Improve xml test schema #3302
Fixes [test] Move pmd-test to java 8 #3758

Ready?

Added unit tests for fixed bug/feature
Passing all unit tests
unblock [test] Remove duplicated Dummy language module #2435
Think about what APIs to deprecate in pmd-test
- At least, TestDescriptor (in pmd-test) should be replaced by RuleTestDescriptor (in the new module). Currently changes are minimal in that module
Complete build ./mvnw clean verify passes (checked automatically by github actions)
Added (in-code) documentation (if needed)

Need a release of nice-xml-messages Need an update to pmd-test Need to add the 'ignored' attribute to schema

(This is backward compatible)

…-schema-module

oowekyala · 2022-07-10T12:54:48Z

+        <attribute name="regressionTest" type="boolean" default="true"/>
+        <attribute name="useAuxClasspath" type="boolean" default="true"/>
+
+        <attribute name="ignored" type="string" default="">


todo change that to bool, rename to disabled like junit 5

For a patch to the thing causing the stackOverflow.

ghost · 2022-07-13T19:33:56Z

	1 Message
📖	No regression tested rules have been changed.

Generated by 🚫 Danger

adangel

Looks good!

I'll do the change "ignored" -> "disabled" and update the release notes

adangel · 2022-07-21T17:29:33Z

+        parseBoolAttribute(testCode, "useAuxClasspath", true, err, "Attribute 'useAuxClasspath' is deprecated and ignored, assumed true");
+
+        boolean ignored = parseBoolAttribute(testCode, "ignored", false, err, null)
+                          | !parseBoolAttribute(testCode, "regressionTest", true, err, "Attribute ''regressionTest'' is deprecated, use ''ignored'' with inverted value");


FYI - for this "regressionTest" flag, there is also a System.property that can disable the disabling...

pmd/pmd-test/src/main/java/net/sourceforge/pmd/testframework/TestDescriptor.java

Lines 121 to 134 in 029b4b2

public static boolean inRegressionTestMode() {

boolean inRegressionMode = true; // default

try {

// get the "pmd.regress" System property

String property = System.getProperty("pmd.regress");

if (property != null) {

inRegressionMode = Boolean.parseBoolean(property);

}

} catch (IllegalArgumentException e) {

throw new RuntimeException("Invalid system property 'pmd.regress'", e);

}

return inRegressionMode;

}

I personally never used this. The system property is used here when deciding whether to run the test or not:

pmd/pmd-test/src/main/java/net/sourceforge/pmd/testframework/RuleTestRunner.java

Line 140 in 029b4b2

return TestDescriptor.inRegressionTestMode() && !child.isRegressionTest();

And the property "pmd.regress" also not documented: https://pmd.github.io/latest/pmd_userdocs_extending_testing.html

…tests (pmd#3976 / pmd#3302)

oowekyala added 7 commits May 17, 2022 23:34

Most of the work to extract module

60139c8

Need a release of nice-xml-messages Need an update to pmd-test Need to add the 'ignored' attribute to schema

Add tests

1801b69

Cleanups

519ad31

Update RuleTst

42dcc3c

Cleanup schema, add ignore attribute

b9342f7

Cleanup new schema

bf0b451

Replace old schema with newer one

ebd009e

(This is backward compatible)

oowekyala mentioned this pull request May 21, 2022

[test] Remove duplicated Dummy language module #2435

Closed

oowekyala added 2 commits June 25, 2022 14:45

Merge branch 'pmd6-plain-text-lang' into pmd6-extract-test-schema-module

b77fe07

Fix tests using PlainTextLang

76d5a0b

oowekyala mentioned this pull request Jun 25, 2022

[core] Add plain text language #4024

Merged

4 tasks

oowekyala added 5 commits June 25, 2022 14:57

Merge branch 'pmd6-plain-text-lang' into pmd6-extract-test-schema-module

e66ec71

Merge remote-tracking branch 'upstream/master' into pmd6-extract-test…

5a87894

…-schema-module

Merge remote-tracking branch 'upstream/master' into pmd6-extract-test…

0c1bad6

…-schema-module

Fix ignore behavior

07121bc

fix remaining problems

9bbee06

oowekyala commented Jul 10, 2022

View reviewed changes

oowekyala added this to the 6.48.0 milestone Jul 13, 2022

oowekyala added 2 commits July 13, 2022 21:18

Merge branch 'master' into pmd6-extract-test-schema-module

fe0643d

Bump dependency nice-xml-messages

8f36f5d

For a patch to the thing causing the stackOverflow.

oowekyala marked this pull request as ready for review July 15, 2022 12:00

adangel self-requested a review July 18, 2022 19:32

adangel added 3 commits July 21, 2022 19:10

Merge branch 'master' into pr-3976

d09f981

Fix pom parent ref

6471faa

[test] Rename ignored -> disabled

bc1dd85

adangel mentioned this pull request Jul 21, 2022

[test] Improve xml test schema #3302

Closed

[doc] Update release notes (pmd#3758, pmd#3976)

bed3b17

adangel approved these changes Jul 21, 2022

View reviewed changes

adangel merged commit a8efa19 into pmd:master Jul 21, 2022

oowekyala deleted the pmd6-extract-test-schema-module branch July 21, 2022 20:59

adangel added a commit to oowekyala/pmd that referenced this pull request Jul 22, 2022

[java] Remove usages of reinitializeRule and useAuxClasspath in rule …

cb5acd6

…tests (pmd#3976 / pmd#3302)

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

[test] Extract xml schema module#3976

[test] Extract xml schema module#3976
adangel merged 20 commits into
pmd:masterfrom
oowekyala:pmd6-extract-test-schema-module

oowekyala commented May 21, 2022 •

edited by adangel

Loading

Uh oh!

oowekyala Jul 10, 2022 •

edited

Loading

Uh oh!

ghost commented Jul 13, 2022

Uh oh!

adangel left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

adangel Jul 21, 2022

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

	public static boolean inRegressionTestMode() {
	boolean inRegressionMode = true; // default
	try {
	// get the "pmd.regress" System property
	String property = System.getProperty("pmd.regress");
	if (property != null) {
	inRegressionMode = Boolean.parseBoolean(property);
	}
	} catch (IllegalArgumentException e) {
	throw new RuntimeException("Invalid system property 'pmd.regress'", e);
	}

	return inRegressionMode;
	}

Uh oh!

Conversation

oowekyala commented May 21, 2022 • edited by adangel Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Related issues

Ready?

Uh oh!

oowekyala Jul 10, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ghost commented Jul 13, 2022

Uh oh!

adangel left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

adangel Jul 21, 2022

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

oowekyala commented May 21, 2022 •

edited by adangel

Loading

oowekyala Jul 10, 2022 •

edited

Loading