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?

sonarcloud · 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

…TypeMemberOrdering

… `LBRACE`

github-actions · 2024-05-24T11:28:58Z

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

class	surviving	killed
🧟`tech.picnic.errorprone.bugpatterns.TypeMemberOrder`	9	65
🧟`tech.picnic.errorprone.utils.MoreASTHelpers`	5	0
🧟`tech.picnic.errorprone.bugpatterns.TypeMemberOrder$MovableTypeMember`	1	4

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

github-actions · 2024-05-27T06:52:37Z

Surviving mutants in this change: 14
Killed mutants in this change: 72

class	surviving	killed
🧟`tech.picnic.errorprone.bugpatterns.TypeMemberOrder`	8	68
🧟`tech.picnic.errorprone.utils.MoreASTHelpers`	5	0
🧟`tech.picnic.errorprone.bugpatterns.TypeMemberOrder$MovableTypeMember`	1	4

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

rickie

Sorry I didn't put comments everywhere. The main idea behind the changes is that we now do only one "scan" and collect only the members that we can actually change. After that we check is the list sorted, and if not we do the same as before. But now, we know for sure that we only have items that we can and want to switch around :). Makes it a bit easier as we don't need to check for empty/present optionals and have all the data.

So there is still a specific case not working and I didn't finish reviewing all the tests yet, but man this will be an epic check.

Oh and we should still move this to experimental :).

Credits to @Stephan202 as we paired on this.

rickie · 2024-03-23T20:01:33Z

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

+      return Position.NOPOS;
+    }
+
+    /* We return the source code position of the first token that follows the first left brace. */


Didn't go through it with the debugger yet, but we mean the { of the classTree right? In that case we can also say

Suggested change

/* We return the source code position of the first token that follows the first left brace. */

/* Return the source code position of the first token that comes after the first curly bracket. */

`

github-actions · 2024-06-02T14:19:23Z

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

class	surviving	killed
🧟`tech.picnic.errorprone.experimental.bugpatterns.TypeMemberOrder`	13	46
🧟`tech.picnic.errorprone.experimental.bugpatterns.TypeMemberOrder$TypeMember`	1	5

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

github-actions · 2024-06-02T15:03:20Z

Surviving mutants in this change: 12
Killed mutants in this change: 53

class	surviving	killed
🧟`tech.picnic.errorprone.experimental.bugpatterns.TypeMemberOrder`	11	48
🧟`tech.picnic.errorprone.experimental.bugpatterns.TypeMemberOrder$TypeMember`	1	5

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

github-actions · 2024-06-02T15:06:02Z

Surviving mutants in this change: 12
Killed mutants in this change: 53

class	surviving	killed
🧟`tech.picnic.errorprone.experimental.bugpatterns.TypeMemberOrder`	11	48
🧟`tech.picnic.errorprone.experimental.bugpatterns.TypeMemberOrder$TypeMember`	1	5

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

sonarcloud · 2024-06-05T06:40:32Z

Quality Gate passed

Issues
1 New issue
0 Accepted issues

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

See analysis details on SonarCloud

github-actions · 2024-06-05T06:40:55Z

Surviving mutants in this change: 12
Killed mutants in this change: 53

class	surviving	killed
🧟`tech.picnic.errorprone.experimental.bugpatterns.TypeMemberOrder`	11	48
🧟`tech.picnic.errorprone.experimental.bugpatterns.TypeMemberOrder$TypeMember`	1	5

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

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 12 commits May 24, 2024 13:25

Test not-ordering unordered members annotated w/ SuppressWarnings

48c9cf3

Stop sorting unsorted members annotated w/ SuppressWarnings - all or …

8cedd99

…TypeMemberOrdering

Rename TypeMemberWithComments to TypeMember

f90fb63

Support classes, interfaces and enums

9080a42

Post rebase fix

e419129

Pair programming session

b831e5a

Test abstract and default methods

9d24bb4

Tweaks

fc8d1ff

Suggestions

63a187a

Improve more tests

84685d9

Reproduce syntactically wrong replacement with annotations containing…

c0a8b15

… `LBRACE`

Fix syntactically wrong replecement with annotations containing LBRACE

8d2c426

rickie force-pushed the benhalasi/sort-members-constructors-methods branch from df1d962 to 8d2c426 Compare May 24, 2024 11:25

Suggestions

8c83401

rickie added 3 commits May 30, 2024 14:15

Suggestions part 1

ce62e7e

Try to implement new thing

55416f7

Final suggestions, but three failing tests

588a3e7

rickie reviewed May 30, 2024

View reviewed changes

benhalasi changed the title ~~Introduce ClassMemberOrdering bug checker~~ Introduce TypeMemberOrder bug checker Jun 1, 2024

Move TypeMemberOrder BugChecker into experimental module

8c0cd45

Fix & enable TypeMemberOrderEnumTest

50ee382

benhalasi force-pushed the benhalasi/sort-members-constructors-methods branch from 2f0bef9 to 50ee382 Compare June 2, 2024 15:03

Cleanup

e6ffb44

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

This comment was marked as outdated.

github-actions bot commented May 18, 2023

benhalasi commented May 18, 2023 •

edited

github-actions bot commented May 18, 2023

github-actions bot commented May 24, 2023

rickie left a comment •

edited

github-actions bot commented May 25, 2023

rickie commented May 25, 2023

sonarcloud bot commented May 25, 2023

github-actions bot commented May 25, 2023

rickie commented May 25, 2023 •

edited

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

github-actions bot commented May 24, 2024

github-actions bot commented May 27, 2024

rickie left a comment

rickie Mar 23, 2024

github-actions bot commented Jun 2, 2024

github-actions bot commented Jun 2, 2024

github-actions bot commented Jun 2, 2024

sonarcloud bot commented Jun 5, 2024

github-actions bot commented Jun 5, 2024

	/* We return the source code position of the first token that follows the first left brace. */
	/* Return the source code position of the first token that comes after the first curly bracket. */

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

Suggested commit message

This comment was marked as outdated.

github-actions bot commented May 18, 2023

benhalasi commented May 18, 2023 • edited

github-actions bot commented May 18, 2023

github-actions bot commented May 24, 2023

rickie left a comment • edited

Choose a reason for hiding this comment

github-actions bot commented May 25, 2023

rickie commented May 25, 2023

sonarcloud bot commented May 25, 2023

github-actions bot commented May 25, 2023

rickie commented May 25, 2023 • edited

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

github-actions bot commented May 24, 2024

github-actions bot commented May 27, 2024

rickie left a comment

Choose a reason for hiding this comment

rickie Mar 23, 2024

Choose a reason for hiding this comment

github-actions bot commented Jun 2, 2024

github-actions bot commented Jun 2, 2024

github-actions bot commented Jun 2, 2024

sonarcloud bot commented Jun 5, 2024

Quality Gate passed

github-actions bot commented Jun 5, 2024

Introduce `TypeMemberOrder` bug checker #636

Introduce `TypeMemberOrder` bug checker #636

benhalasi commented May 18, 2023 •

edited

benhalasi commented May 18, 2023 •

edited

rickie left a comment •

edited

rickie commented May 25, 2023 •

edited

benhalasi commented Jul 25, 2023 •

edited