This repository has been archived by the owner on Feb 11, 2022. It is now read-only.
PT-434: Better classes filtering for Findbugs tasks #23
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…rce collection found
mr-archano
commented
Feb 15, 2017
| @@ -62,12 +62,16 @@ class FindbugsConfigurator extends CodeQualityConfigurator<FindBugs, FindBugsExt | |||
| sourceFilter.applyTo(task) | |||
| task.conventionMapping.map("classes", { | |||
| List<String> includes = createIncludePatterns(task.source, androidSourceDirs) | |||
| project.fileTree(variant.javaCompile.destinationDir).include(includes) | |||
| }.memoize()); | |||
There was a problem hiding this comment.
During the investigation of the bug I realised that the classes property is evaluated multiple times during the configuration phase of an Android project, so I decided to avoid possible side-effects of memoization.
ouchadam
reviewed
Feb 15, 2017
| } | ||
|
|
||
| /** | ||
| * <p>While integrating the plugin in one of our projects we realised that Findbugs was analysing a source folder |
There was a problem hiding this comment.
as great as this information is, do you think the first paragraph helps?
It's an awesome PR description though!
There was a problem hiding this comment.
No, I don't think it adds more insight really. I wanted to put some explanation on why that (gross) task exists tho, maybe I can shave all the context and leave only the hint about the check?
ouchadam
approved these changes
Feb 15, 2017
devisnik
approved these changes
Feb 15, 2017
| main = 'edu.umd.cs.findbugs.PrintingBugReporter' | ||
| standardOutput = new FileOutputStream(htmlReportFile) | ||
| args '-html', xmlReportFile | ||
| super.exec() |
Merged
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Scope of the PR
While integrating the plugin in one of our projects we realised that Findbugs was analysing a source folder even though an exclude rule was provided for it.
Considerations and implementation
After quite some investigation we realised that the issue is related to the way* we create include patterns from the filtered collection in
source. When the source is empty (eg: all the source files have been filtered out) no include pattern can be generated, therefore the collection of classes won't be filtered at all. This sometimes is not a problem because the analysis task is skipped anyway (sourceproperty is marked as@SkipWhenEmpty), but this doesn't seem enough to cover all cases.We decided then to enforce an empty collection for
classeswhen an empty collection is found insource.Incidentally the task generating html reports for findbugs is now skipped when the related analysis has not run.
Test(s) added
FindbugsIntegrationTestnow contains few more tests to check::findbug*task has been executed/skippedclassesproperty is provided to eachfindbugs*task with an emptysource