Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[MPMD-304] - maven-pmd-plugin should be toolchains-aware #31

Closed
wants to merge 19 commits into from
Closed

[MPMD-304] - maven-pmd-plugin should be toolchains-aware #31

wants to merge 19 commits into from

Conversation

adangel
Copy link
Member

@adangel adangel commented Oct 2, 2020

This PR adds toolchain support for PMD and CPD (see https://issues.apache.org/jira/browse/MPMD-304).

In order to do this, the following changes are made:

  • Execution is now separated from PmdReport/CpdReport and moved to PmdExecutor/CpdExecutor
  • The properties/parameter are handed over as PmdRequest/CpdRequest
  • If a toolchain is in use, then PmdExecutor/CpdExecutor is called in a forked JVM. PmdRequest/CpdRequest is serialized/deserialized.
  • The result is provided for reporting via PmdResult/CpdResult. These classes are just wrappers around the always created target/pmd.xml and target/cpd.xml files. So basically, PMD serializeds the result into these XML files, and m-pmd-p picks it up from there.

There are two possible incompatibilities:

  • The public method PmdReport.getPMDConfiguration() is gone - the PMDConfiguration instance is created now by PmdExecutor and is not exposed anymore.
  • PmdReportGenerator and CpdReportGenerator now work with the classes generated by m-pmd-p's generated modello classes instead of the PMD classes.

Following this checklist to help us incorporate your
contribution quickly and easily:

  • Make sure there is a JIRA issue filed
    for the change (usually before you start working on it). Trivial changes like typos do not
    require a JIRA issue. Your pull request should address just this issue, without
    pulling in other changes.
  • Each commit in the pull request should have a meaningful subject line and body.
  • Format the pull request title like [MPMD-XXX] - Subject of the JIRA Ticket,
    where you replace MPMD-XXX with the appropriate JIRA issue. Best practice
    is to use the JIRA issue title in the pull request title and in the first line of the
    commit message.
  • Write a pull request description that is detailed enough to understand what the pull request does, how, and why.
  • Run mvn clean verify to make sure basic checks pass. A more thorough check will
    be performed on your pull request automatically.
  • You have run the integration tests successfully (mvn -Prun-its clean verify).

If your pull request is about ~20 lines of code you don't need to sign an
Individual Contributor License Agreement if you are unsure
please ask on the developers list.

To make clear that you license your contribution under
the Apache License Version 2.0, January 2004
you have to acknowledge this by using the following check-box.

First step: Separating the execution of PMD into
a separate class. See PmdExecutor and PmdRequest.
Further refactoring.
Resolve deprecated usages.
Add CpdExecutor, CpdRequest, CpdResult
@adangel adangel closed this in f39c001 Oct 16, 2020
@adangel adangel deleted the toolchain-support-mpmd-304 branch October 16, 2020 11:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
1 participant