6c9df461813185a892c0fae0093f345f24b999ea
[utils] / support / general / src / test / java / org / wamblee / concurrency / AbstractLockTestCase.java
1 /*
2  * Copyright 2005 the original author or authors.
3  * 
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  * 
8  *      http://www.apache.org/licenses/LICENSE-2.0
9  * 
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16
17 package org.wamblee.concurrency;
18
19 import org.wamblee.test.EventTracker;
20 import org.wamblee.test.TimingUtils;
21
22 import junit.framework.TestCase;
23
24 /**
25  * Tests for the JVMLock.
26  *
27  * @author Erik Brakkee
28  */
29 public abstract class AbstractLockTestCase extends TestCase {
30
31     protected static final int SLEEP_TIME = 1000;
32
33     protected static final String STARTED = "started";
34
35     protected static final String ACQUIRED = "acquired";
36
37     protected static final String RELEASED = "released";
38
39     private EventTracker<String> tracker;
40
41     /*
42      * (non-Javadoc)
43      * 
44      * @see junit.framework.TestCase#setUp()
45      */
46     @Override
47     protected void setUp() throws Exception {
48         tracker = new EventTracker<String>();
49     }
50     
51     protected EventTracker<String> getTracker() { 
52         return tracker;
53     }
54
55     /**
56      * Must be implemented to generate the events 
57      * {@link #STARTED}, {@link #ACQUIRED}, and {@link #RELEASED} in 
58      * that order. The lock should be acquired for
59      * the time specified by {@link #SLEEP_TIME}.
60      * @return Thread which does the work. 
61      */
62     protected abstract Thread runThread();
63
64     /**
65      * Tests the operation of the lock.
66      */
67     public void testLock() throws InterruptedException {
68         Thread t1 = runThread();
69         Thread t2 = runThread();
70         TimingUtils.sleep(SLEEP_TIME / 10); // give threads a chance to start
71         // up.
72         assertEquals(2, tracker.getEventCount(STARTED)); // both threads
73         // should have
74         // started.
75         assertEquals(1, tracker.getEventCount(ACQUIRED)); // one thread has
76                                                             // acquired the
77                                                             // lock.
78         TimingUtils.sleep(SLEEP_TIME);
79         assertEquals(2, tracker.getEventCount(ACQUIRED)); // now the other
80                                                             // thread could also
81                                                             // acquire the lock
82         assertEquals(1, tracker.getEventCount(RELEASED)); // and the first
83                                                             // thread has
84                                                             // released it.
85         TimingUtils.sleep(SLEEP_TIME);
86         assertEquals(2, tracker.getEventCount(RELEASED)); // both threads
87                                                             // should be
88                                                             // finished.
89         t1.join();
90         t2.join();
91     }
92 }