Fixes #2389 : Parallel use of mocks with deep stubbing may lead to ConcurrentModificationException

[LeMikaelF]

Fixes #2389 "Parallel use of mocks with deep stubbing may lead to ConcurrentModificationException"

The issue was that ReturnsDeepStubs (line 82) retrieved the existings stubbings via InvocationContainerImpl::getStubbingsDescending, and iterating on it to find existing stubbings resulted in a ConcurrentModificationException because other threads were adding their own Answer to the stubbings list (InvocationContainerImpl::addAnswer called at ReturnsDeepStubs line 150).

All of the methods in InvocationContainerImpl that mutate the LinkedList<StubbedInvocationMatcher> stubbed field are synchronized on stubbed, but the getters aren't (getStubbingsAscending and getStubbingsDescending). I added a InvocationMatcherImpl::findStubbedAnswer that does basically what ReturnsDeepStubs used to do, but synchronizing on stubbed.

Somebody had been there before and had noticed there was something weird, because there was a TODO in the code:

// TODO why don't we do container.findAnswer here?

However, I tried that in my original solution (using findAnswerFor()), but it didn't work because it used the matches() method from the elements of stubbed, which don't have the matchers from verify() (see test and debugger screenshots below).

I also added a test for regressions.

EDIT: described new solution

[LeMikaelF]

I see the CI tests are failing. I ran ./gradlew check before pushing this, and didn't get any error. I'll look into it some more tomorrow.

[LeMikaelF]

I pushed a new implementation for this. Everything passed locally, the CI is still failing but it looks like it's not related to the tests or application code:

Publishing build scan...
https://gradle.com/s/r5ulppd5d6ofq
 
/dev/fd/63: line 1: $'{\r': command not found
/dev/fd/63: line 2: type:: command not found
/dev/fd/63: line 3: message:: command not found
/dev/fd/63: line 4: syntax error near unexpected token }' /dev/fd/63: line 4: }'
Error: Process completed with exit code 2.

I will be happy to address any comments on this PR.

[TimvdLippe]

Yeah that must be a flake in Gradle infrastructure. I have restarted the jobs, hopefully that fixes the issue.

[TimvdLippe]

@LeMikaelF Thank you so much for your contribution and fix!