-
Notifications
You must be signed in to change notification settings - Fork 2.3k
/
DelayedRenewableTimeoutServiceTest.java
203 lines (163 loc) · 7.09 KB
/
DelayedRenewableTimeoutServiceTest.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
/*
* Copyright (c) 2002-2016 "Neo Technology,"
* Network Engine for Objects in Lund AB [http://neotechnology.com]
*
* This file is part of Neo4j.
*
* Neo4j is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
package org.neo4j.coreedge.raft;
import org.junit.After;
import org.junit.Before;
import org.junit.Test;
import java.util.concurrent.CountDownLatch;
import java.util.concurrent.atomic.AtomicLong;
import org.neo4j.function.Predicates;
import org.neo4j.helpers.Clock;
import org.neo4j.helpers.FakeClock;
import org.neo4j.kernel.lifecycle.LifeSupport;
import org.neo4j.logging.NullLogProvider;
import static java.util.concurrent.TimeUnit.MILLISECONDS;
import static org.hamcrest.CoreMatchers.equalTo;
import static org.hamcrest.CoreMatchers.is;
import static org.hamcrest.Matchers.greaterThanOrEqualTo;
import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertThat;
public class DelayedRenewableTimeoutServiceTest
{
// The base timeout for timers in tests, should be short.
private final long TIMEOUT_MS = 100;
// The maximum time for awaiting conditions in tests.. used for failing tests.
private final long LONG_TIME_MS = 30000;
// Used for allowing for example a timer to fire slightly earlier then asked for
// since in general tests can assert on tardiness but not on promptness.
// The error could be due to the timer service itself or the test.
private final long ERROR_MS = 1;
private final LifeSupport life = new LifeSupport();
@Before
public void startupLife()
{
life.init();
life.start();
}
@After
public void shutdownLife()
{
life.stop();
life.shutdown();
}
enum Timeouts implements RenewableTimeoutService.TimeoutName
{
FOOBAR
}
@Test
public void shouldTimeOutAfterTimeoutPeriod() throws Throwable
{
// given
final AtomicLong timeoutCount = new AtomicLong();
DelayedRenewableTimeoutService timeoutService = new DelayedRenewableTimeoutService( Clock.SYSTEM_CLOCK, NullLogProvider.getInstance() );
timeoutService.create( Timeouts.FOOBAR, TIMEOUT_MS, 0, timeout -> timeoutCount.incrementAndGet() );
long startTime = System.currentTimeMillis();
life.add( timeoutService );
Predicates.await( timeoutCount::get, count -> count == 1, LONG_TIME_MS, MILLISECONDS, 1, MILLISECONDS );
long runTime = System.currentTimeMillis() - startTime;
assertThat( runTime, greaterThanOrEqualTo( TIMEOUT_MS - ERROR_MS ) );
}
@Test
public void shouldNotTimeOutWhenRenewedWithinTimeoutPeriod() throws Throwable
{
// given
final AtomicLong timeoutCount = new AtomicLong();
DelayedRenewableTimeoutService timeoutService = new DelayedRenewableTimeoutService( Clock.SYSTEM_CLOCK, NullLogProvider.getInstance() );
RenewableTimeoutService.RenewableTimeout timeout =
timeoutService.create( Timeouts.FOOBAR, TIMEOUT_MS, 0, timeout1 -> timeoutCount.incrementAndGet() );
long startTime = System.currentTimeMillis();
life.add( timeoutService );
// when
Thread.sleep( TIMEOUT_MS/2 );
long timeoutCountSample = timeoutCount.get();
long sampleTime = System.currentTimeMillis();
if( sampleTime < startTime + TIMEOUT_MS )
{
assertThat( timeoutCountSample, is( 0L ) );
}
long renewTime = System.currentTimeMillis();
timeout.renew();
if( System.currentTimeMillis() < startTime + TIMEOUT_MS )
{
// we managed to renew before it expired
Predicates.await( timeoutCount::get, count -> count == 1, LONG_TIME_MS, MILLISECONDS, 1, MILLISECONDS );
assertThat( System.currentTimeMillis(), greaterThanOrEqualTo( renewTime + TIMEOUT_MS - ERROR_MS ) );
}
}
@Test
public void shouldNotTimeOutWhenStopped() throws Throwable
{
// given
final AtomicLong timeoutCount = new AtomicLong();
FakeClock clock = new FakeClock();
DelayedRenewableTimeoutService timeoutService = new DelayedRenewableTimeoutService( clock, NullLogProvider.getInstance() );
RenewableTimeoutService.RenewableTimeout timeout = timeoutService.create( Timeouts.FOOBAR, TIMEOUT_MS, 0, t -> timeoutCount
.incrementAndGet() );
life.add( timeoutService );
clock.forward( TIMEOUT_MS, MILLISECONDS );
Predicates.await( timeoutCount::get, count -> count == 1, LONG_TIME_MS, MILLISECONDS, 1, MILLISECONDS );
// when
timeoutService.stop();
timeoutService.shutdown();
timeout.renew();
Thread.sleep( TIMEOUT_MS/2 );
clock.forward( TIMEOUT_MS, MILLISECONDS );
Thread.sleep( TIMEOUT_MS/2 );
// then
assertThat( timeoutCount.get(), equalTo( 1L ) );
}
@Test
public void shouldNotDeadLockWhenCancellingDuringExpiryHandling() throws Throwable
{
// given: a timeout handler that blocks on a latch
final CountDownLatch latch = new CountDownLatch( 1 );
FakeClock clock = new FakeClock();
DelayedRenewableTimeoutService timeoutService = new DelayedRenewableTimeoutService( clock, NullLogProvider.getInstance() );
RenewableTimeoutService.RenewableTimeout timeout = timeoutService.create( Timeouts.FOOBAR, TIMEOUT_MS, 0, handler -> {
try
{
latch.await( LONG_TIME_MS, MILLISECONDS );
}
catch ( InterruptedException ignored )
{
}
} );
life.add( timeoutService );
clock.forward( TIMEOUT_MS, MILLISECONDS );
Thread.sleep( TIMEOUT_MS/2 ); // to allow the scheduled timeout to fire and get stuck in the latch
// given: another thread that wants to cancel the timeout while the handler is in progress
Thread cancelThread = new Thread()
{
@Override
public void run()
{
timeout.cancel(); // this would previously deadlock, because the timeout service was stuck handling the handler callback
}
};
// when: we cancel the timeout, then it should not deadlock, and the latch be immediately released
cancelThread.start();
// so the following join should finish quicker than the latch expiry, and the cancelThread should be dead
cancelThread.join( LONG_TIME_MS/2 );
assertFalse( cancelThread.isAlive() );
// cleanup
latch.countDown();
cancelThread.interrupt();
}
}