Gradle Plugin: Add Test Structure Comment Check

[sorndotdev]

Create a Groovy-based Gradle plugin in buildSrc that verifies each test contains all three required comment blocks:

// given
// when
// then

The plugin should allow the blocks to appear on the same line (e.g., // given // when) or split across multiple lines in the given order, as long as all three (given, when, then) are present somewhere in the test body.

Register the plugin so the check runs automatically as part of gradle build.

[sorndotdev]

CC @andyyngo

[andyyngo]

I'll take this

[andyyngo]

There is a technical problem: Using regex (similar to the other ticket) to capture the unit test method body, the limitation of this approach is that Java Regex does not work well with nested brackets. Read https://stackoverflow.com/questions/68696817/regex-that-captures-a-method-and-its-body

I am looking into using javaparser with LexicalPreservingPrinter

[andyyngo]

We need to rethink this ticket. Although, we can detect the absence of the keywords, we can't decide the exact location of these //given //when //then in a block of code. When running spotlessApply we can reliably transform the code to its correct format.

[sorndotdev]

@andyyngo in that case, detecting that they're missing will be sufficient

[andyyngo]

I understand that, but the spirit of spotlessApply action is to "fix" the problem; it does not have a mechanism to report a problem and stop.

I can make this work for spotlessCheck but not spotlessApply

[sorndotdev]

@andyyngo does it have to be done with spotless or are there other frameworks the Groovy plugin can leverage? (preferably built in)