Introduce `TypeMemberOrder` bug checker #636

benhalasi · 2023-05-18T08:31:49Z

Suggested commit message

Introduce `TypeMemberOrder` check (#636)

github-actions · 2023-05-18T08:51:36Z

Surviving mutants in this change: 23
Killed mutants in this change: 63

class	surviving	killed
🧟`tech.picnic.errorprone.bugpatterns.MemberOrdering`	23	63

Mutation testing report by Pitest. Review any surviving mutants by inspecting the line comments under Files changed.

benhalasi · 2023-05-18T17:08:00Z

Verifying that the whitespace is untouched maybe a bit harder than I thought because TestMode.TEXT_MATCH formats both input and output.

I looked into doTest and TestMode and it doesn't seem too hard to just implement a new one that doesn't format, but I'll wait for some input before getting into it.

Indentation of replaced code might cause some challenge.

github-actions · 2023-05-18T18:06:10Z

Surviving mutants in this change: 11
Killed mutants in this change: 61

class	surviving	killed
🧟`tech.picnic.errorprone.bugpatterns.MemberOrdering`	11	61

Mutation testing report by Pitest. Review any surviving mutants by inspecting the line comments under Files changed.

github-actions · 2023-05-24T13:02:35Z

Surviving mutants in this change: 11
Killed mutants in this change: 61

class	surviving	killed
🧟`tech.picnic.errorprone.bugpatterns.MemberOrdering`	11	61

Mutation testing report by Pitest. Review any surviving mutants by inspecting the line comments under Files changed.

rickie

There were some imports from ASTHelpers that we usually do not statically import :).

Added a commit! The setup looks nice, didn't get till the end, but already flushing my comments 😄.

error-prone-contrib/src/main/java/tech/picnic/errorprone/bugpatterns/MemberOrdering.java

github-actions · 2023-05-25T11:34:05Z

Surviving mutants in this change: 11
Killed mutants in this change: 61

class	surviving	killed
🧟`tech.picnic.errorprone.bugpatterns.MemberOrdering`	11	61

Mutation testing report by Pitest. Review any surviving mutants by inspecting the line comments under Files changed.

error-prone-contrib/src/main/java/tech/picnic/errorprone/bugpatterns/MemberOrdering.java

rickie · 2023-05-25T11:41:44Z

(Okay apparently I had to rebuild, the test locally passed 😄, will take a look).

I didn't test if MemberOrdering respects annotations, I assumed annotations are part of the member Tree.

@benhalasi I would add a testcase with an annotation in that case 😉 .

I'm not sure how to approach verifying that this checker doesn't mess with whitespaces - as it's hard to test something it shouldn't do - I'm leaning towards to have a separate test method that has all the whitespace cases we want to test, which I'd need input on - and have the other cases properly formatted.

When using the suppression for ErrorProneTestHelperSourceFormat it should be fine to test the whitespaces right?

sonarqubecloud · 2023-05-25T11:49:20Z

Kudos, SonarCloud Quality Gate passed!

0 Bugs
0 Vulnerabilities
0 Security Hotspots
3 Code Smells

91.5% Coverage
0.0% Duplication

github-actions · 2023-05-25T11:50:06Z

Surviving mutants in this change: 11
Killed mutants in this change: 61

class	surviving	killed
🧟`tech.picnic.errorprone.bugpatterns.MemberOrdering`	11	61

Mutation testing report by Pitest. Review any surviving mutants by inspecting the line comments under Files changed.

rickie · 2023-05-25T11:51:17Z

I reverted the commit as I'd need some more time to properly fix this. I'm wondering however, maybe we should use a different method altogether. In the SourceCode file and in our recently moved StringLocaleUsage check (see here), we have examples of going over the ErrorProneTokens.getTokens. Maybe we should use that to get "the full Tree" that we need to replace. I'm not sure which direction is currently the best way to go in.

github-actions · 2023-07-08T17:54:33Z

Surviving mutants in this change: 11
Killed mutants in this change: 61

class	surviving	killed
🧟`tech.picnic.errorprone.bugpatterns.MemberOrdering`	11	61

Mutation testing report by Pitest. Review any surviving mutants by inspecting the line comments under Files changed.

github-actions · 2023-07-09T10:33:04Z

Surviving mutants in this change: 10
Killed mutants in this change: 51

class	surviving	killed
🧟`tech.picnic.errorprone.bugpatterns.MemberOrdering`	10	49
🎉`tech.picnic.errorprone.bugpatterns.MemberOrdering$MemberWithComments`	0	2

Mutation testing report by Pitest. Review any surviving mutants by inspecting the line comments under Files changed.

github-actions · 2023-07-10T06:34:30Z

Surviving mutants in this change: 10
Killed mutants in this change: 51

class	surviving	killed
🧟`tech.picnic.errorprone.bugpatterns.MemberOrdering`	10	49
🎉`tech.picnic.errorprone.bugpatterns.MemberOrdering$MemberWithComments`	0	2

Mutation testing report by Pitest. Review any surviving mutants by inspecting the line comments under Files changed.

error-prone-contrib/src/main/java/tech/picnic/errorprone/bugpatterns/MemberOrdering.java

github-actions · 2023-07-24T13:02:41Z

Surviving mutants in this change: 4
Killed mutants in this change: 44

class	surviving	killed
🧟`tech.picnic.errorprone.bugpatterns.MemberOrdering`	4	42
🎉`tech.picnic.errorprone.bugpatterns.MemberOrdering$ClassMemberWithComments`	0	2

Mutation testing report by Pitest. Review any surviving mutants by inspecting the line comments under Files changed.

oxkitsune · 2023-07-24T13:02:49Z

ErrorProneTokens#getTokens(String, Context) doesn't include comments as it relies on the start position of the provided member (e.g., the position of void). Comments don't count as tokens but do affect token positions.

To include comments, we can use VisitorState#getOffsetTokens(int, int) to obtain tokens in a specific range. By starting the range at the end position of the previous token and ending it at the end of the current member, we'll obtain the same tokens, now including comments in the resulting ErrorProneToken.

github-actions · 2023-07-24T13:10:10Z

Surviving mutants in this change: 4
Killed mutants in this change: 44

class	surviving	killed
🧟`tech.picnic.errorprone.bugpatterns.MemberOrdering`	4	42
🎉`tech.picnic.errorprone.bugpatterns.MemberOrdering$ClassMemberWithComments`	0	2

Mutation testing report by Pitest. Review any surviving mutants by inspecting the line comments under Files changed.

github-actions · 2023-07-25T08:19:50Z

Surviving mutants in this change: 4
Killed mutants in this change: 44

class	surviving	killed
🧟`tech.picnic.errorprone.bugpatterns.MemberOrdering`	4	42
🎉`tech.picnic.errorprone.bugpatterns.MemberOrdering$ClassMemberWithComments`	0	2

Mutation testing report by Pitest. Review any surviving mutants by inspecting the line comments under Files changed.

github-actions · 2023-07-25T15:23:57Z

Surviving mutants in this change: 5
Killed mutants in this change: 50

class	surviving	killed
🧟`tech.picnic.errorprone.bugpatterns.MemberOrdering`	5	48
🎉`tech.picnic.errorprone.bugpatterns.MemberOrdering$ClassMemberWithComments`	0	2

Mutation testing report by Pitest. Review any surviving mutants by inspecting the line comments under Files changed.

benhalasi · 2023-07-25T15:24:37Z

Thanks oxkitsune for the ErrorProneTokens#getTokens(String, Context)!

Apart from the minor questions below, the only big thing to tackle is verifying that this checker reserves whitespaces or deciding that we don't verify it.

error-prone-contrib/src/main/java/tech/picnic/errorprone/bugpatterns/MemberOrdering.java

github-actions · 2024-12-04T08:21:52Z

Surviving mutants in this change: 11
Killed mutants in this change: 82

class	surviving	killed
🧟`tech.picnic.errorprone.experimental.bugpatterns.TypeMemberOrder`	11	81
🎉`tech.picnic.errorprone.experimental.bugpatterns.TypeMemberOrder$TypeMember`	0	1

Mutation testing report by Pitest. Review any surviving mutants by inspecting the line comments under Files changed.

… `LBRACE`

github-actions · 2024-12-04T08:25:41Z

Surviving mutants in this change: 16
Killed mutants in this change: 82

class	surviving	killed
🧟`tech.picnic.errorprone.experimental.bugpatterns.TypeMemberOrder`	11	81
🧟`tech.picnic.errorprone.utils.MoreASTHelpers`	5	0
🎉`tech.picnic.errorprone.experimental.bugpatterns.TypeMemberOrder$TypeMember`	0	1

Mutation testing report by Pitest. Review any surviving mutants by inspecting the line comments under Files changed.

github-actions · 2024-12-07T07:30:14Z

Surviving mutants in this change: 15
Killed mutants in this change: 84

class	surviving	killed
🧟`tech.picnic.errorprone.experimental.bugpatterns.TypeMemberOrder`	10	82
🧟`tech.picnic.errorprone.utils.MoreASTHelpers`	5	0
🎉`tech.picnic.errorprone.experimental.bugpatterns.TypeMemberOrder$TypeMember`	0	2

Mutation testing report by Pitest. Review any surviving mutants by inspecting the line comments under Files changed.

…n one-go

github-actions · 2024-12-07T10:40:53Z

Surviving mutants in this change: 15
Killed mutants in this change: 84

class	surviving	killed
🧟`tech.picnic.errorprone.experimental.bugpatterns.TypeMemberOrder`	10	82
🧟`tech.picnic.errorprone.utils.MoreASTHelpers`	5	0
🎉`tech.picnic.errorprone.experimental.bugpatterns.TypeMemberOrder$TypeMember`	0	2

Mutation testing report by Pitest. Review any surviving mutants by inspecting the line comments under Files changed.

sonarqubecloud · 2024-12-07T10:40:59Z

Quality Gate passed

Issues
3 New issues
0 Accepted issues

Measures
0 Security Hotspots
93.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

rickie · 2024-12-07T11:40:44Z

/integration-test

benhalasi · 2024-12-10T13:46:01Z

/integration-test

rickie · 2024-12-10T13:47:17Z

It's not working as this check is in the experimental module 😬. So we will need to tweak something, or to run it locally 😄 @benhalasi.

This comment was marked as outdated.

Sign in to view

benhalasi force-pushed the benhalasi/sort-members-constructors-methods branch from 00eebf3 to ebb9041 Compare May 18, 2023 08:48

benhalasi linked an issue May 18, 2023 that may be closed by this pull request

Sort member variables, constructors, and methods #595

Open

3 tasks

rickie self-requested a review May 23, 2023 14:51

benhalasi force-pushed the benhalasi/sort-members-constructors-methods branch from ca7ada8 to 11816d9 Compare May 24, 2023 12:59

rickie reviewed May 25, 2023

View reviewed changes

error-prone-contrib/src/main/java/tech/picnic/errorprone/bugpatterns/MemberOrdering.java Outdated Show resolved Hide resolved

benhalasi force-pushed the benhalasi/sort-members-constructors-methods branch from 2fcedcd to 291a517 Compare July 8, 2023 17:52

oxkitsune reviewed Jul 24, 2023

View reviewed changes

error-prone-contrib/src/main/java/tech/picnic/errorprone/bugpatterns/MemberOrdering.java Outdated Show resolved Hide resolved

benhalasi force-pushed the benhalasi/sort-members-constructors-methods branch from ee2cb5e to b0a23ba Compare July 25, 2023 08:17

benhalasi self-assigned this Jul 25, 2023

benhalasi commented Jul 25, 2023

View reviewed changes

benhalasi and others added 6 commits December 4, 2024 09:21

Rename TypeMemberWithComments to TypeMember

738dcf2

Support classes, interfaces and enums

e5d1aa2

Post rebase fix

4e33c52

Pair programming session

fb14933

Test abstract and default methods

d444106

Tweaks

ecd91d1

rickie and others added 13 commits December 4, 2024 09:22

Suggestions

00bd247

Improve more tests

8f171a5

Reproduce syntactically wrong replacement with annotations containing…

d0b9479

… `LBRACE`

Fix syntactically wrong replecement with annotations containing LBRACE

5652cb6

Suggestions

173aebf

Suggestions part 1

2ae6f20

Try to implement new thing

c521778

Final suggestions, but three failing tests

167e321

Move TypeMemberOrder BugChecker into experimental module

1306bc0

Fix & enable TypeMemberOrderEnumTest

59a0616

Cleanup

284a153

Pair programming

070e065

Merge fixes of inner type decls, enable sorting nested types in one-go

47e27eb

benhalasi force-pushed the benhalasi/sort-members-constructors-methods branch from f84a759 to 47e27eb Compare December 4, 2024 08:23

fixup! Merge fixes of inner type decls, enable sorting nested types i…

0bc5f94

…n one-go

benhalasi force-pushed the benhalasi/sort-members-constructors-methods branch from dc1f77b to 0bc5f94 Compare December 7, 2024 10:38

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Introduce `TypeMemberOrder` bug checker #636

Introduce `TypeMemberOrder` bug checker #636

benhalasi commented May 18, 2023 •

edited

Loading

This comment was marked as outdated.

github-actions bot commented May 18, 2023

benhalasi commented May 18, 2023 •

edited

Loading

github-actions bot commented May 18, 2023

github-actions bot commented May 24, 2023

rickie left a comment •

edited

Loading

github-actions bot commented May 25, 2023

rickie commented May 25, 2023

sonarqubecloud bot commented May 25, 2023

github-actions bot commented May 25, 2023

rickie commented May 25, 2023 •

edited

Loading

github-actions bot commented Jul 8, 2023

github-actions bot commented Jul 9, 2023

github-actions bot commented Jul 10, 2023

github-actions bot commented Jul 24, 2023

oxkitsune commented Jul 24, 2023

github-actions bot commented Jul 24, 2023

github-actions bot commented Jul 25, 2023

github-actions bot commented Jul 25, 2023

benhalasi commented Jul 25, 2023 •

edited

Loading

github-actions bot commented Dec 4, 2024

github-actions bot commented Dec 4, 2024

github-actions bot commented Dec 7, 2024

github-actions bot commented Dec 7, 2024

sonarqubecloud bot commented Dec 7, 2024

rickie commented Dec 7, 2024

benhalasi commented Dec 10, 2024

rickie commented Dec 10, 2024

Introduce TypeMemberOrder bug checker #636

Are you sure you want to change the base?

Introduce TypeMemberOrder bug checker #636

Conversation

benhalasi commented May 18, 2023 • edited Loading

Suggested commit message

This comment was marked as outdated.

github-actions bot commented May 18, 2023

benhalasi commented May 18, 2023 • edited Loading

github-actions bot commented May 18, 2023

github-actions bot commented May 24, 2023

rickie left a comment • edited Loading

Choose a reason for hiding this comment

github-actions bot commented May 25, 2023

rickie commented May 25, 2023

sonarqubecloud bot commented May 25, 2023

github-actions bot commented May 25, 2023

rickie commented May 25, 2023 • edited Loading

github-actions bot commented Jul 8, 2023

github-actions bot commented Jul 9, 2023

github-actions bot commented Jul 10, 2023

github-actions bot commented Jul 24, 2023

oxkitsune commented Jul 24, 2023

github-actions bot commented Jul 24, 2023

github-actions bot commented Jul 25, 2023

github-actions bot commented Jul 25, 2023

benhalasi commented Jul 25, 2023 • edited Loading

github-actions bot commented Dec 4, 2024

github-actions bot commented Dec 4, 2024

github-actions bot commented Dec 7, 2024

github-actions bot commented Dec 7, 2024

sonarqubecloud bot commented Dec 7, 2024

Quality Gate passed

rickie commented Dec 7, 2024

benhalasi commented Dec 10, 2024

rickie commented Dec 10, 2024

Introduce `TypeMemberOrder` bug checker #636

Introduce `TypeMemberOrder` bug checker #636

benhalasi commented May 18, 2023 •

edited

Loading

benhalasi commented May 18, 2023 •

edited

Loading

rickie left a comment •

edited

Loading

rickie commented May 25, 2023 •

edited

Loading

benhalasi commented Jul 25, 2023 •

edited

Loading