psteitz 2003/09/14 20:50:41
Modified: collections/src/test/org/apache/commons/collections/decorators
TestAll.java
Added: collections/src/test/org/apache/commons/collections/decorators
TestBlockingBuffer.java
Log:
Added a test class for BlockingBuffer.
Patch submitted by Janek Bogucki (Pr# 23158).
Reviewed (and extended slightly) by Phil Steitz.
The test case testBlockedGetWithAdd() verifies the current behavior of
BlockingBuffer.add() as described in Pr# 23159, i.e., the add method uses notify, not
notifyAll, so only one waiting thread is "unblocked" by add.
Revision Changes Path
1.13 +3 -2
jakarta-commons/collections/src/test/org/apache/commons/collections/decorators/TestAll.java
Index: TestAll.java
===================================================================
RCS file:
/home/cvs/jakarta-commons/collections/src/test/org/apache/commons/collections/decorators/TestAll.java,v
retrieving revision 1.12
retrieving revision 1.13
diff -u -r1.12 -r1.13
--- TestAll.java 14 Sep 2003 03:30:23 -0000 1.12
+++ TestAll.java 15 Sep 2003 03:50:41 -0000 1.13
@@ -108,6 +108,7 @@
suite.addTest(TestPredicatedSortedMap.suite());
suite.addTest(TestLazyMap.suite());
suite.addTest(TestLazySortedMap.suite());
+ suite.addTest(TestBlockingBuffer.suite());
return suite;
}
1.1
jakarta-commons/collections/src/test/org/apache/commons/collections/decorators/TestBlockingBuffer.java
Index: TestBlockingBuffer.java
===================================================================
/*
* $Header:
/home/cvs/jakarta-commons/collections/src/test/org/apache/commons/collections/decorators/TestBlockingBuffer.java,v
1.1 2003/09/15 03:50:41 psteitz Exp $
* ====================================================================
*
* The Apache Software License, Version 1.1
*
* Copyright (c) 2003 The Apache Software Foundation. All rights
* reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* 3. The end-user documentation included with the redistribution, if
* any, must include the following acknowledgement:
* "This product includes software developed by the
* Apache Software Foundation (http://www.apache.org/)."
* Alternately, this acknowledgement may appear in the software itself,
* if and wherever such third-party acknowledgements normally appear.
*
* 4. The names "The Jakarta Project", "Commons", and "Apache Software
* Foundation" must not be used to endorse or promote products derived
* from this software without prior written permission. For written
* permission, please contact [EMAIL PROTECTED]
*
* 5. Products derived from this software may not be called "Apache"
* nor may "Apache" appear in their names without prior written
* permission of the Apache Software Foundation.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
* ====================================================================
*
* This software consists of voluntary contributions made by many
* individuals on behalf of the Apache Software Foundation. For more
* information on the Apache Software Foundation, please see
* <http://www.apache.org/>.
*
*/
package org.apache.commons.collections.decorators;
import java.util.Collections;
import java.util.LinkedList;
import java.util.ArrayList;
import junit.framework.Test;
import junit.framework.TestSuite;
import org.apache.commons.collections.Buffer;
import org.apache.commons.collections.ArrayStack;
import org.apache.commons.collections.BufferUnderflowException;
import org.apache.commons.collections.decorators.BlockingBuffer;
import org.apache.commons.collections.TestObject;
/**
* Extension of [EMAIL PROTECTED] TestObject} for exercising the [EMAIL PROTECTED]
BlockingBuffer}
* implementation.
*
* @since Commons Collections 3.0
* @version $Revision: 1.1 $
*
* @author Janek Bogucki
* @author Phil Steitz
*/
public class TestBlockingBuffer extends TestObject {
public TestBlockingBuffer(String testName) {
super(testName);
}
public static Test suite() {
return new TestSuite(TestBlockingBuffer.class);
}
public static void main(String args[]) {
String[] testCaseName = { TestBlockingBuffer.class.getName()};
junit.textui.TestRunner.main(testCaseName);
}
protected Object makeObject() {
return BlockingBuffer.decorate(new MyBuffer());
}
//-----------------------------------------------------------------------
/**
* Tests [EMAIL PROTECTED] BlockingBuffer#get()}.
*/
public void testGetWithAdd() {
Buffer blockingBuffer = BlockingBuffer.decorate(new MyBuffer());
Object obj = new Object();
new DelayedAdd(blockingBuffer, obj).start();
// verify does not throw BufferUnderflowException; should block until other
thread has added to the buffer .
assertSame(obj, blockingBuffer.get());
}
//-----------------------------------------------------------------------
/**
* Tests [EMAIL PROTECTED] BlockingBuffer#get()}.
*/
public void testGetWithAddAll() {
Buffer blockingBuffer = BlockingBuffer.decorate(new MyBuffer());
Object obj = new Object();
new DelayedAddAll(blockingBuffer, obj).start();
// verify does not throw BufferUnderflowException; should block until other
thread has added to the buffer .
assertSame(obj, blockingBuffer.get());
}
//-----------------------------------------------------------------------
/**
* Tests [EMAIL PROTECTED] BlockingBuffer#remove()}.
*/
public void testRemoveWithAdd() {
Buffer blockingBuffer = BlockingBuffer.decorate(new MyBuffer());
Object obj = new Object();
new DelayedAdd(blockingBuffer, obj).start();
// verify does not throw BufferUnderflowException; should block until other
thread has added to the buffer .
assertSame(obj, blockingBuffer.remove());
}
//-----------------------------------------------------------------------
/**
* Tests [EMAIL PROTECTED] BlockingBuffer#remove()}.
*/
public void testRemoveWithAddAll() {
Buffer blockingBuffer = BlockingBuffer.decorate(new MyBuffer());
Object obj = new Object();
new DelayedAddAll(blockingBuffer, obj).start();
// verify does not throw BufferUnderflowException; should block until other
thread has added to the buffer .
assertSame(obj, blockingBuffer.remove());
}
//-----------------------------------------------------------------------
/**
* Tests get using multiple read threads.
*
* Verifies that multiple adds are required to allow gets by
* multiple threads on an empty buffer to complete.
*/
public void testBlockedGetWithAdd() {
Buffer blockingBuffer = BlockingBuffer.decorate(new MyBuffer());
Object obj = new Object();
// run methods will get and compare -- must wait for adds
Thread thread1 = new ReadThread(blockingBuffer, obj);
Thread thread2 = new ReadThread(blockingBuffer, obj);
thread1.start();
thread2.start();
// give hungry read threads ample time to hang
try {
Thread.currentThread().sleep(100);
} catch (InterruptedException e) {}
// notify should allow one read thread to complete
blockingBuffer.add(obj);
// allow notified thread(s) to complete
try {
Thread.currentThread().sleep(100);
} catch (InterruptedException e) {}
// There shoould still be one thread waiting. Verify this.
// This check will fail if add is changed to notifyAll.
assertTrue("One read thread should be waiting",
thread1.isAlive() || thread2.isAlive());
// now add again so the second thread will be notified
blockingBuffer.add(obj);
// wait to exit until both threads are dead, or appear to be hung
boolean finished = false;
for (int i = 1; i < 10; i++) {
if (thread1.isAlive() || thread2.isAlive()) {
try {
Thread.currentThread().sleep(100);
}
catch (InterruptedException e) {}
} else {
finished = true;
break;
}
}
if (!finished) {
fail("Read thread did not finish.");
}
}
/**
* Tests get using multiple read threads.
* Shows that one addAll allows multiple gets to complete.
*/
public void testBlockedGetWithAddAll() {
Buffer blockingBuffer = BlockingBuffer.decorate(new MyBuffer());
Object obj = new Object();
// run methods will get and compare -- must wait for adds
Thread thread1 = new ReadThread(blockingBuffer, obj);
Thread thread2 = new ReadThread(blockingBuffer, obj);
thread1.start();
thread2.start();
// give hungry read threads ample time to hang
try {
Thread.currentThread().sleep(100);
} catch (InterruptedException e) {}
// notifyAll should allow both read threads to complete
blockingBuffer.addAll(Collections.singleton(obj));
// wait to exit until both threads are dead, or appear to be hung
boolean finished = false;
for (int i = 1; i < 10; i++) {
if (thread1.isAlive() || thread2.isAlive()) {
try {
Thread.currentThread().sleep(100);
}
catch (InterruptedException e) {}
} else {
finished = true;
break;
}
}
if (!finished) {
fail("Read thread did not finish.");
}
}
/**
* Tests interrupted get.
*/
public void testInterruptedGet() {
Buffer blockingBuffer = BlockingBuffer.decorate(new MyBuffer());
Object obj = new Object();
// spawn a read thread to wait on the empty buffer
ArrayList exceptionList = new ArrayList();
Thread thread = new ReadThread(blockingBuffer, obj, exceptionList);
thread.start();
// Interrupting the thread should cause it to throw BufferUnderflowException
thread.interrupt();
// Chill, so thread can throw and add message to exceptionList
try {
Thread.currentThread().sleep(100);
} catch (InterruptedException e) {}
assertTrue("Thread interrupt should have led to underflow",
exceptionList.contains("BufferUnderFlow"));
if (thread.isAlive()) {
fail("Hung read thread");
}
}
/**
* Tests interrupted remove.
*/
public void testInterruptedRemove() {
Buffer blockingBuffer = BlockingBuffer.decorate(new MyBuffer());
Object obj = new Object();
// spawn a read thread to wait on the empty buffer
ArrayList exceptionList = new ArrayList();
Thread thread = new ReadThread(blockingBuffer, obj, exceptionList, "remove");
thread.start();
// Interrupting the thread should cause it to throw BufferUnderflowException
thread.interrupt();
// Chill, so thread can throw and add message to exceptionList
try {
Thread.currentThread().sleep(100);
} catch (InterruptedException e) {}
assertTrue("Thread interrupt should have led to underflow",
exceptionList.contains("BufferUnderFlow"));
if (thread.isAlive()) {
fail("Hung read thread");
}
}
protected static class DelayedAdd extends Thread {
Buffer buffer;
Object obj;
DelayedAdd (Buffer buffer, Object obj) {
super();
this.buffer = buffer;
this.obj = obj;
}
public void run() {
try {
// wait for other thread to block on get() or remove()
Thread.currentThread().sleep(100);
}
catch (InterruptedException e) {}
buffer.add(obj);
}
}
protected static class DelayedAddAll extends Thread {
Buffer buffer;
Object obj;
DelayedAddAll (Buffer buffer, Object obj) {
super();
this.buffer = buffer;
this.obj = obj;
}
public void run() {
try {
// wait for other thread to block on get() or remove()
Thread.currentThread().sleep(100);
}
catch (InterruptedException e) {}
buffer.addAll(Collections.singleton(obj));
}
}
protected static class ReadThread extends Thread {
Buffer buffer;
Object obj;
ArrayList exceptionList = null;
String action = "get";
ReadThread (Buffer buffer, Object obj) {
super();
this.buffer = buffer;
this.obj = obj;
}
ReadThread (Buffer buffer, Object obj, ArrayList exceptionList) {
super();
this.buffer = buffer;
this.obj = obj;
this.exceptionList = exceptionList;
}
ReadThread (Buffer buffer, Object obj, ArrayList exceptionList, String
action) {
super();
this.buffer = buffer;
this.obj = obj;
this.exceptionList = exceptionList;
this.action = action;
}
public void run() {
try {
if (action == "get") {
assertSame(obj, buffer.get());
} else {
assertSame(obj, buffer.remove());
}
} catch (BufferUnderflowException ex) {
exceptionList.add("BufferUnderFlow");
}
}
}
protected static class MyBuffer extends LinkedList implements Buffer {
public Object get() {
if(isEmpty())
throw new BufferUnderflowException();
return get(0);
}
public Object remove() {
if(isEmpty())
throw new BufferUnderflowException();
return remove(0);
}
}
}
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
