Exclude methods annotated with @lombok.Generated #513

marchof · 2017-04-03T07:57:42Z

This is a follow-up for #495 to migrate @t1 's work to the new filtering APIs.

Based in initial contribution by Rüdiger zu Dohna.

Godin · 2017-04-03T09:55:58Z

...jacoco.core.test/src/org/jacoco/core/internal/analysis/filter/LombokGeneratedFilterTest.java

+ * http://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ *    Rüdiger zu Dohna - initial API and implementation


@marchof even if initial analysis wasn't done by you, all code of this PR was entirely written by you, so I believe this line should be changed - anyway there will be credits in changelog

Godin · 2017-04-03T09:58:45Z

...jacoco.core.test/src/org/jacoco/core/internal/analysis/filter/LombokGeneratedFilterTest.java

+	@Test
+	public void testLombokGeneratedAnnotation() {
+		final MethodNode m = new MethodNode(InstrSupport.ASM_API_VERSION,
+				Opcodes.ACC_SYNTHETIC, "lambda$1", "()V", null, null);


@marchof synthetic access flag and name of lambda are unrelated to this test, so I believe that for clarity should be changed. Name can be changed for example on hashCode as one of examples of methods that Lombok generates. Can be changed for the all test cases.

Godin · 2017-04-03T10:00:13Z

org.jacoco.core/src/org/jacoco/core/internal/analysis/filter/LombokGeneratedFilter.java

+	}
+
+	private boolean hasLombokGeneratedAnnotation(final MethodNode methodNode) {
+		final List<AnnotationNode> list = methodNode.invisibleAnnotations;


@marchof I'd prefer to name local variable invisibleAnnotations or even better runtimeInvisibleAnnotations instead of just list

Godin · 2017-04-03T10:06:50Z

org.jacoco.doc/docroot/doc/changes.html

@@ -28,6 +28,9 @@
  <li>Exclude from a report a part of bytecode that compiler generates for a
      synchronized statement
      (GitHub <a href="https://github.com/jacoco/jacoco/issues/501">#501</a>).</li>
+  <li>Exclude methods generated by Lombok. Initial analysis and contribution by


@marchof I'd prefer to be more explicit here and state that

they are excluded from report - to avoid confusion with exclusion from instrumentation

only methods annotated with lombok.Generated are excluded - because annotation can be turned off

For consistency with previous changelog entries - we don't put dot before opening parenthesis.

So something like:

Exclude from a report methods annotated by <code>lombok.Generated</code>, initial analysis contributed by Rüdiger zu Dohna (GitHub ...).

Godin · 2017-04-03T10:12:23Z

org.jacoco.core/src/org/jacoco/core/internal/analysis/filter/LombokGeneratedFilter.java

+import org.objectweb.asm.tree.MethodNode;
+
+/**
+ * Filter for methods generated by Lombok which are annotated with


@marchof for consistency with existing filters, I'd prefer to change on

Filters methods annotated with <code>@lombok.Generated</code>.

Godin · 2017-04-03T10:13:18Z

...jacoco.core.test/src/org/jacoco/core/internal/analysis/filter/LombokGeneratedFilterTest.java

+	@Test
+	public void testOtherAnnotation() {
+		final MethodNode m = new MethodNode(InstrSupport.ASM_API_VERSION,
+				Opcodes.ACC_SYNTHETIC, "name", "()V", null, null);


@marchof synthetic access flag is unrelated to this test, so I'd prefer to remove it

Godin · 2017-04-03T10:16:55Z

...jacoco.core.test/src/org/jacoco/core/internal/analysis/filter/LombokGeneratedFilterTest.java

+		m.visitInsn(Opcodes.RETURN);
+
+		AnnotationNode a = new AnnotationNode("Llombok/Generated;");
+		m.invisibleAnnotations = Arrays.asList(a);


@marchof maybe simply

m.visitAnnotation("Llombok/Generated;", false);

?

Based on initial contribution by Rüdiger zu Dohna.

marchof · 2017-04-03T12:06:48Z

@Godin thx for the review! Hopefully fixed all issues.

Based on initial contribution by Rüdiger zu Dohna.

Godin · 2017-04-03T15:03:22Z

End-to-end test - example.zip

Without this change using JaCoCo 0.7.9 :

After this change :

MichaelZett · 2017-04-06T15:30:40Z

Hi, nice one. I'd like to try this out. I let lombok generate "lombok.Generated" and use the jacoco-agent with gradle. I tried the snapshot from 20170404 (-17) and it does not seem to be in there. Or do I have to configure jacoco somehow?

marchof · 2017-04-06T19:54:34Z

@MichaelZett I just double checked the latest snaphot (from 20170404 on) has this feature. Are you sure you're using the latest version of Lombok? The @Generated annotation has been introduced recently in version 1.16.14.

t1 · 2017-04-07T04:20:39Z

Works fine. Big thanks!

When I first looked at the code, I thought it might not work when there are other annotations next to @lombok.Generated. Something like:

    @lombok.Getter(onMethod_ = { @javax.xml.bind.annotation.XmlAttribute(name = "bar") })
    private String foo;

But it does work ;-)

Is it foreseeable when this may get released?

MichaelZett · 2017-04-07T06:01:57Z

@marchof yes, Lombok annotation is generated. I checked with delombok. Do I have to configure the filters to use? Does anyone has checked it with gradle (3.4.1)? Gradle uses the jacoco agent lib.

Godin · 2017-04-07T08:55:44Z

@MichaelZett here is an example with Gradle that works just perfectly - example.zip

Godin · 2017-04-07T09:20:14Z

@t1

Is it foreseeable when this may get released?

please be patient and give us some time to first finish some other filters. Thank you for your understanding.

t1 · 2017-04-08T04:53:34Z

@Godin

please be patient and give us some time to first finish some other filters.

Am I wrong to assume that this may take quite a while, as most of those filters are much harder to build than @lombok.Generated? How much work is it to build a release? I understand that also users might be annoyed by too many releases... at least I am annoyed by too many releases of Mockito ;-)... so this has to be taken into account, but I also have the need to get coverage reports that are expressive. We heavily rely on Lombok and often see coverage as low as 30% in DTO packages. We hardly look at the coverage there. If we had this fix, we would get up to maybe 90%, which already would help us greatly in seeing and then focussing on the important parts. The last 10% also would be cool, but they won't stop us from looking at the coverage.

I don't like the alternative to internally release a fork.

BeneStem · 2017-04-09T13:35:54Z

@Godin @t1 We would love to have this feature released as soon as possible as well.

Thank you all for the great work. We will be patient and wait :)

For now we will be using the SNAPSHOT version. It is working great!

Godin · 2017-04-10T20:36:59Z

@t1

Am I wrong to assume that this may take quite a while, as most of those filters are much harder to build than @lombok.Generated?

Filters for synchronized statement and methods in enums are already in master - see eaef191 and e94c7af respectively. We're finalizing filters for try-with-resources statement and String in switch statement in PRs #500 and #496 respectively. From here IMO we'd better finish current work than do two releases within short timeframe. So please be a bit patient.

MichaelZett · 2017-04-11T07:20:53Z

@Godin Thanks for the zip. When I take this and run gradlew clean build, it produces the attached test.exec. When I look at this in intellij or sonarqube it shows still 4 missed lines. What could be the problem?
test.exec.tar.gz

Godin · 2017-04-11T07:36:12Z

@MichaelZett filtering is performed at a time of report generation (creation of html, xml, etc), not at a time of collection of execution information (creation of exec file). So that tools that read execution data directly instead of reading of xml (which is a kind of mistake on their side to rely on purely internal intermediate format, but what's done is done) and create their own report (such as SonarQube, Jenkins, etc) will need to update their dependency on JaCoCo once it will be released in order to get filtering for reports. We will notify explicitly downstream projects (in particular all mentioned above) about this when our release will be done. So once again - please be patient. Thank you for your understanding.

Godin · 2017-04-11T08:09:35Z

@MichaelZett also should be mentioned that reports produced by JaCoCo Gradle Plugin (in build/reports/jacoco/test/html/ after gradle clean test jacocoTestReport) and JaCoCo Maven Plugin (in target/site/jacoco/ after mvn clean verify) in the given examples do have filtering because they already use snapshot version of JaCoCo.

MichaelZett · 2017-04-11T13:07:59Z

@Godin I see, thanks. Will be waiting.

t1 · 2017-04-11T13:13:34Z

@Godin : I'll be patient... but I feel a little like a child before christmas ;-)

tenleo · 2017-04-14T07:57:18Z

I have successfully used the snapshot build to exclude Lombok generated code. The generated report works nicely now, thanks for this update.

Just curious though: on individual maven projects it works fine, but I have trouble generating an aggregated report for a multi-module Maven project. The reports in each module look fine, but the aggregated report is empty. Has anyone else had this issue?

Maybe its a configuration fault on my side, this is what I added to my root pom:

<plugin>

	<groupId>org.jacoco</groupId>

	<artifactId>jacoco-maven-plugin</artifactId>
	<version>0.7.10-SNAPSHOT</version>
	<configuration>
		<destFile>${project.basedir}/../target/jacoco.exec</destFile>
		<append>true</append>
	</configuration>
	<executions>
		<execution>
			<id>default-prepare-agent</id>
			<goals>
				<goal>prepare-agent</goal>
			</goals>
		</execution>
		<execution>
			<id>report-aggregate</id>
			<phase>prepare-package</phase>
			<goals>
				<goal>report-aggregate</goal>
			</goals>
		</execution>
		<execution>
			<id>default-check</id>
			<goals>
				<goal>check</goal>
			</goals>
			<configuration>
				<rules/>
			</configuration>
		</execution>
	</executions>
</plugin>

marchof · 2017-04-14T15:51:57Z

@tenleo Thanks for your feedback! Aggregate reports work differently. Please see documentation. You need to specify a separate module which defined the content of the report. As this is a completely different issue please use our mailing list for further questions.

sir4ur0n · 2017-04-21T09:22:57Z

Hi guys,

I'm curious, did anyone make it work with SonarQube?
I seem to have a clean JaCoCo report with the latest snapshot (0.7.10-SNAPSHOT) when I look at ./target/site/jacoco/index.html report.
However the report in SonarQube is completely different: different code coverage (a lot less), different values for metrics like Complexity, Lines of code, etc...

Is it just me?
I even tried with the tiny example project provided by @Godin on the 2017-04-03 (I wrote one test method covering one stupid method doing a System.out.println for the sake of having one test) and then published in my SonarQube, and the results are massively different.

I created a small github project to ease reproduction of the issue: https://github.com/Sir4ur0n/example-jacoco-lombok-sonarqube

Here's the JaCoCo report:

Here's the SonarQube report:

Any help or pointer on what's wrong would be greatly appreciated :(

Godin · 2017-04-21T09:25:45Z

@sir4ur0n please read carefully comments in this thread prior to yours, in particular - #513 (comment)

sir4ur0n · 2017-04-21T09:31:46Z

@Godin Thanks, I had completely missed this comment :'(

charlesritchea · 2017-06-30T20:25:46Z

Do we have an ETA on when 0.7.10 will be released? I couldn't find a release schedule anywhere. Asking specifically for this fix.

Godin · 2017-06-30T21:16:37Z

@novaterata please read already existing answers on such question:
https://groups.google.com/forum/#!msg/jacoco/gd8xD30TDNo/SHj-hEq1AAAJ
https://groups.google.com/forum/#!msg/jacoco/-MmsVzC6szM/Q9sPTbAeBAAJ
and in few words - no exact ETA, but as soon as it will be fully ready.
So please be patient and thank you for your understanding.

charlesritchea · 2017-06-30T21:19:06Z

@Godin Thank you, I didn't know where to even look

Elena6789 · 2017-07-03T12:59:04Z

Is the filter out of lombok supported already in a released version of JaCoCo?Thanks

charlesritchea · 2017-07-03T13:03:18Z

No, it's coming in 0.7.10 You can read the release notes to see when issues are released

…

On Mon, Jul 3, 2017, 8:59 AM Elena6789 ***@***.***> wrote: Is the filter out of lombok supported already in a released version of JaCoCo?Thanks — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#513 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/ABlGHeO_HHrJK9GYoRYVYchOgEYFfkQPks5sKOWbgaJpZM4MxMmI> .

Glamdring · 2017-07-18T15:26:02Z

I tried using the latest snapshot, but the report generated in target/site includes the equals(..) method. Has anything changed? Are there specific configurations that one has to enable?

Godin · 2017-07-18T16:07:30Z

@Glamdring please read this thread carefully from the beginning - in particular there is full end-to-end example with all the required configuration on Lombok side in #513 (comment)

Glamdring · 2017-07-19T13:43:09Z

@Godin apologies for overlooking that, thanks.

miualinionut · 2017-08-01T07:55:48Z

Guys, I am waiting for about 4 months for this feature. Can you please give a DL when will this feature be released ?

t1 · 2017-08-01T08:47:06Z

@miualinionut: I guess it's done when it's done. That's the way open source projects work when they are driven by people spending their spare time.

@Godin: I'd rather request an intermediate release of the things that already work instead of waiting until everything is complete. Would that be possible?

charlesritchea · 2017-08-01T14:47:58Z

@t1 you can use the snapshot build. There is a repository you can add https://oss.sonatype.org/content/repositories/snapshots then the snapshot version should be available via maven dependencies

MAGGGG · 2017-08-02T06:25:02Z

Hello everyone ...
Same question like earlier. When 0.7.10 will be released ?
Waiting for this features:

Exclude from a report methods which are annotated with @lombok.Generated. Initial analysis and contribution by Rüdiger zu Dohna. (GitHub Exclude methods annotated with @lombok.Generated #513).

uzonyib · 2017-11-08T21:26:02Z

Hi, is there an ETA for the release of this feature?

marchof · 2017-11-08T21:36:43Z

@uzonyib See #513 (comment)

marchof added component: core.filters type: enhancement labels Apr 3, 2017

marchof self-assigned this Apr 3, 2017

marchof added a commit that referenced this pull request Apr 3, 2017

GitHub #513: Exclude methods annotated with @lombok.Generated

fb8fe73

Based in initial contribution by Rüdiger zu Dohna.

marchof mentioned this pull request Apr 3, 2017

Exclude from a report methods annotated by "lombok/Generated" #495

Closed

Godin added this to the 0.7.10 milestone Apr 3, 2017

Godin requested changes Apr 3, 2017

View reviewed changes

marchof force-pushed the issue-513 branch from fb8fe73 to 7c6e67b Compare April 3, 2017 12:06

marchof added a commit that referenced this pull request Apr 3, 2017

GitHub #513: Exclude methods annotated with @lombok.Generated

7c6e67b

Based on initial contribution by Rüdiger zu Dohna.

Godin force-pushed the issue-513 branch from 7c6e67b to 0cb2bd4 Compare April 3, 2017 12:54

Add filter for methods annotated with @lombok.Generated

e31d0c4

Based on initial contribution by Rüdiger zu Dohna.

Godin force-pushed the issue-513 branch from 0cb2bd4 to e31d0c4 Compare April 3, 2017 13:50

Godin approved these changes Apr 3, 2017

View reviewed changes

Godin merged commit 7f719c8 into master Apr 3, 2017

Godin deleted the issue-513 branch April 3, 2017 15:04

kernle32dll mentioned this pull request May 12, 2017

suggestion : Ignore the generated code hcoles/pitest#347

Closed

ianhomer mentioned this pull request Jun 6, 2017

Poor code coverage on lombok beans ianhomer/odin#4

Open

rainerhahnekamp mentioned this pull request Aug 4, 2017

addLombokGeneratedAnnotation not recognized by jacoco.exec #575

Closed

Godin mentioned this pull request Nov 6, 2017

Exclude from a report private empty constructors that do not have arguments #529

Merged

jacoco locked and limited conversation to collaborators Nov 8, 2017

Exclude methods annotated with @lombok.Generated #513

Exclude methods annotated with @lombok.Generated #513

Conversation

marchof commented Apr 3, 2017

Godin Apr 3, 2017

Choose a reason for hiding this comment

Godin Apr 3, 2017

Choose a reason for hiding this comment

Godin Apr 3, 2017

Choose a reason for hiding this comment

Godin Apr 3, 2017

Choose a reason for hiding this comment

Godin Apr 3, 2017

Choose a reason for hiding this comment

Godin Apr 3, 2017

Choose a reason for hiding this comment

Godin Apr 3, 2017

Choose a reason for hiding this comment

marchof commented Apr 3, 2017

Godin commented Apr 3, 2017

MichaelZett commented Apr 6, 2017

marchof commented Apr 6, 2017

t1 commented Apr 7, 2017

MichaelZett commented Apr 7, 2017

Godin commented Apr 7, 2017

Godin commented Apr 7, 2017 • edited Loading

t1 commented Apr 8, 2017

BeneStem commented Apr 9, 2017 • edited Loading

Godin commented Apr 10, 2017

MichaelZett commented Apr 11, 2017

Godin commented Apr 11, 2017 • edited Loading

Godin commented Apr 11, 2017

MichaelZett commented Apr 11, 2017

t1 commented Apr 11, 2017

tenleo commented Apr 14, 2017 • edited Loading

marchof commented Apr 14, 2017

sir4ur0n commented Apr 21, 2017

Godin commented Apr 21, 2017 • edited Loading

sir4ur0n commented Apr 21, 2017

charlesritchea commented Jun 30, 2017 • edited Loading

Godin commented Jun 30, 2017

charlesritchea commented Jun 30, 2017

Elena6789 commented Jul 3, 2017

charlesritchea commented Jul 3, 2017 via email

Glamdring commented Jul 18, 2017

Godin commented Jul 18, 2017 • edited Loading

Glamdring commented Jul 19, 2017

miualinionut commented Aug 1, 2017

t1 commented Aug 1, 2017

charlesritchea commented Aug 1, 2017

MAGGGG commented Aug 2, 2017

uzonyib commented Nov 8, 2017

marchof commented Nov 8, 2017 • edited Loading

Godin commented Apr 7, 2017 •

edited

Loading

BeneStem commented Apr 9, 2017 •

edited

Loading

Godin commented Apr 11, 2017 •

edited

Loading

tenleo commented Apr 14, 2017 •

edited

Loading

Godin commented Apr 21, 2017 •

edited

Loading

charlesritchea commented Jun 30, 2017 •

edited

Loading

Godin commented Jul 18, 2017 •

edited

Loading

marchof commented Nov 8, 2017 •

edited

Loading