PMD / Issues / #1511 [core] Inconsistent behavior of Rule.start/Rule.end

#1511 [core] Inconsistent behavior of Rule.start/Rule.end

Milestone: PMD-5.4.4

Status: closed

Owner: Juan Sotuyo

Labels: None

Module: PMD

Priority: 3-Major

Type: Bug

Affects version:

Ruleset / Rule:

Updated: 2017-01-22

Created: 2016-08-07

Creator: Andreas Dangel

Private: No

See also [#1506].

Looking at the code, there is a difference in when/how often start&end is called: MonoThreadProcessor
calls it for each file, while the MultiThreadProcessor calls it only once - and for a ruleset instance, that is
never used, as for the threads, new rule instances will be created.

Define correct behavior: once per file? once per PMD run? once per thread?
Document the behavior: http://pmd.github.io/pmd-5.5.1/customizing/howtowritearule.html
Use Case is: analyzing more than one class...
Fix and test

Juan Sotuyo - 2017-01-14

status: open --> in-progress

assigned_to: Juan Sotuyo

Milestone: New Tickets --> PMD-5.4.4
If you would like to refer to this comment somewhere else in this project, copy and paste the following link:

Juan Sotuyo - 2017-01-14

PR submitted at https://github.com/pmd/pmd/pull/190

If you would like to refer to this comment somewhere else in this project, copy and paste the following link:

Andreas Dangel - 2017-01-22

It will be: Once Per File.

the method start() will be called once per file, right before it's analysis starts,
so you can initialize properly your rule here. Once the rule have finished analyzing the
file's source code, the method end() will be invoked and you can assert there if your
rule has been violated or not.

Sharing data for one rule between files must happen differently, as in multithreaded case, multiple instances of the rule will be running. So you'll need some kind of static/shared data, if you need to analyze more than one class...

If you would like to refer to this comment somewhere else in this project, copy and paste the following link:

Andreas Dangel - 2017-01-22

status: in-progress --> closed
If you would like to refer to this comment somewhere else in this project, copy and paste the following link:

Andreas Dangel - 2017-01-22

Thanks for fixing!

If you would like to refer to this comment somewhere else in this project, copy and paste the following link:

[core] Inconsistent behavior of Rule.start/Rule.end

A source code analyzer

Milestone

Searches

Help

#1511 [core] Inconsistent behavior of Rule.start/Rule.end

Related

Discussion