Create TestMethodDetector Lint to detect common naming patterns we want to avoid

[SimonMarquis]

This will need to be applied on top of this PR to run correctly on all modules:

• Android Lint improvements #759

Closes #345

[mmoczkowski]

Hey Simon, can you solve the conflicts please? Thanks!

[SimonMarquis]

Hopefully these 3 new Lint checks makes sense for this repository.
And if they do, we can proceed to fix the corresponding warnings 🤓.

[SimonMarquis]

🛎️ Ping

[SimonMarquis]

🛎️ Ping 🥺

[dturner]

This is really cool. Thanks for adding, and sorry for the delay in reviewing.

[dturner]

Was a bit quick to approve there. Looking a bit more closely, the UNDERSCORE check isn't valid.

We want tests follow this format: given_when_then where given, when and then are in camel case e.g. uiState_whenFollowedTopicsAreLoading_thenShowLoading.

What we don't want is for underscores to be used to replace spaces between words e.g. network_news_resource_can_be_mapped_to_news_resource_entity

or for no underscores to be used e.g. deepLinkedNewsResourceIsFetchedAndResetAfterViewing

I'm not sure if it's possible to create lint checks for this. Or whether it'd be simpler to just rename the existing tests which don't follow the format.

[SimonMarquis]

We can definitely enforce this through Lint checks. We simply need to find the right regex.
But from the examples you give, I'm not sure what is expected. I can see the words when and then but no given.

So what you actually want is something like: [^\W_]+?_when[^\W_]+?_then[^\W_]+??

[dturner]

Looking through some of the test, the clearest test names seem to be those that follow these formats:

when_then e.g. whenFilteredByFollowedTopics_matchingNewsResourcesAreReturned
given_when_then e.g oneBookmark_whenRemoving_removesFromFeed

In which case the format should be:

• one underscore minimum
• two underscores maximum
• words before and after each underscore

My regex isn't great but I think it's: [\w]([_\w])([_\w])?

Here's some methods which will require a rename:

stateIsInitiallyLoading => whenCreated_stateIsLoading
stateIsLoadingWhenFollowedTopicsAreLoading => whenFollowedTopicsAreLoading_stateIsLoading

I haven't had a chance to look through all the tests to see whether there are other cases which don't fit this format. Feedback or other suggestions welcome.

[SimonMarquis]

The detector has been updated to conform to your specs: [^\W_]+(_[^\W_]+){1,2} and matches the when_then or given_when_then format.
Tests have bee updated as well.

[dturner]

Thanks for bearing with me on this one. I've never written a lint check so it took me a while to figure out whether this was the correct approach.

[SimonMarquis]

No worries.
Seems like this issue still happens here:

• [Bug]: Build workflows remained queued #993