ViewVC Help
View File | Revision Log | Show Annotations | Download File | Root Listing
root/jsr166/jsr166/src/test/tck/JSR166TestCase.java
(Generate patch)

Comparing jsr166/src/test/tck/JSR166TestCase.java (file contents):
Revision 1.73 by jsr166, Mon Nov 29 07:39:53 2010 UTC vs.
Revision 1.89 by jsr166, Fri Jun 3 05:07:14 2011 UTC

# Line 1 | Line 1
1   /*
2   * Written by Doug Lea with assistance from members of JCP JSR-166
3   * Expert Group and released to the public domain, as explained at
4 < * http://creativecommons.org/licenses/publicdomain
4 > * http://creativecommons.org/publicdomain/zero/1.0/
5   * Other contributors include Andrew Wright, Jeffrey Hayes,
6   * Pat Fisher, Mike Judd.
7   */
8  
9   import junit.framework.*;
10 + import java.io.ByteArrayInputStream;
11 + import java.io.ByteArrayOutputStream;
12 + import java.io.ObjectInputStream;
13 + import java.io.ObjectOutputStream;
14   import java.util.Arrays;
15 + import java.util.Date;
16   import java.util.NoSuchElementException;
17   import java.util.PropertyPermission;
18   import java.util.concurrent.*;
19 + import java.util.concurrent.atomic.AtomicBoolean;
20   import java.util.concurrent.atomic.AtomicReference;
21   import static java.util.concurrent.TimeUnit.MILLISECONDS;
22   import static java.util.concurrent.TimeUnit.NANOSECONDS;
# Line 254 | Line 260 | public class JSR166TestCase extends Test
260          return 50;
261      }
262  
257
263      /**
264       * Sets delays as multiples of SHORT_DELAY.
265       */
# Line 266 | Line 271 | public class JSR166TestCase extends Test
271      }
272  
273      /**
274 +     * Returns a timeout in milliseconds to be used in tests that
275 +     * verify that operations block or time out.
276 +     */
277 +    long timeoutMillis() {
278 +        return SHORT_DELAY_MS / 4;
279 +    }
280 +
281 +    /**
282 +     * Returns a new Date instance representing a time delayMillis
283 +     * milliseconds in the future.
284 +     */
285 +    Date delayedDate(long delayMillis) {
286 +        return new Date(System.currentTimeMillis() + delayMillis);
287 +    }
288 +
289 +    /**
290       * The first exception encountered if any threadAssertXXX method fails.
291       */
292      private final AtomicReference<Throwable> threadFailure
# Line 286 | Line 307 | public class JSR166TestCase extends Test
307      }
308  
309      /**
310 +     * Extra checks that get done for all test cases.
311 +     *
312       * Triggers test case failure if any thread assertions have failed,
313       * by rethrowing, in the test harness thread, any exception recorded
314       * earlier by threadRecordFailure.
315 +     *
316 +     * Triggers test case failure if interrupt status is set in the main thread.
317       */
318      public void tearDown() throws Exception {
319          Throwable t = threadFailure.getAndSet(null);
# Line 306 | Line 331 | public class JSR166TestCase extends Test
331                  throw afe;
332              }
333          }
334 +
335 +        if (Thread.interrupted())
336 +            throw new AssertionFailedError("interrupt status set in main thread");
337      }
338  
339      /**
# Line 437 | Line 465 | public class JSR166TestCase extends Test
465          else {
466              AssertionFailedError afe =
467                  new AssertionFailedError("unexpected exception: " + t);
468 <            t.initCause(t);
468 >            afe.initCause(t);
469              throw afe;
470          }
471      }
472  
473      /**
474 +     * Delays, via Thread.sleep, for the given millisecond delay, but
475 +     * if the sleep is shorter than specified, may re-sleep or yield
476 +     * until time elapses.
477 +     */
478 +    static void delay(long millis) throws InterruptedException {
479 +        long startTime = System.nanoTime();
480 +        long ns = millis * 1000 * 1000;
481 +        for (;;) {
482 +            if (millis > 0L)
483 +                Thread.sleep(millis);
484 +            else // too short to sleep
485 +                Thread.yield();
486 +            long d = ns - (System.nanoTime() - startTime);
487 +            if (d > 0L)
488 +                millis = d / (1000 * 1000);
489 +            else
490 +                break;
491 +        }
492 +    }
493 +
494 +    /**
495       * Waits out termination of a thread pool or fails doing so.
496       */
497 <    public void joinPool(ExecutorService exec) {
497 >    void joinPool(ExecutorService exec) {
498          try {
499              exec.shutdown();
500              assertTrue("ExecutorService did not terminate in a timely manner",
# Line 457 | Line 506 | public class JSR166TestCase extends Test
506          }
507      }
508  
509 +    /**
510 +     * Checks that thread does not terminate within the default
511 +     * millisecond delay of {@code timeoutMillis()}.
512 +     */
513 +    void assertThreadStaysAlive(Thread thread) {
514 +        assertThreadStaysAlive(thread, timeoutMillis());
515 +    }
516 +
517 +    /**
518 +     * Checks that thread does not terminate within the given millisecond delay.
519 +     */
520 +    void assertThreadStaysAlive(Thread thread, long millis) {
521 +        try {
522 +            // No need to optimize the failing case via Thread.join.
523 +            delay(millis);
524 +            assertTrue(thread.isAlive());
525 +        } catch (InterruptedException ie) {
526 +            fail("Unexpected InterruptedException");
527 +        }
528 +    }
529 +
530 +    /**
531 +     * Checks that future.get times out, with the default timeout of
532 +     * {@code timeoutMillis()}.
533 +     */
534 +    void assertFutureTimesOut(Future future) {
535 +        assertFutureTimesOut(future, timeoutMillis());
536 +    }
537 +
538 +    /**
539 +     * Checks that future.get times out, with the given millisecond timeout.
540 +     */
541 +    void assertFutureTimesOut(Future future, long timeoutMillis) {
542 +        long startTime = System.nanoTime();
543 +        try {
544 +            future.get(timeoutMillis, MILLISECONDS);
545 +            shouldThrow();
546 +        } catch (TimeoutException success) {
547 +        } catch (Exception e) {
548 +            threadUnexpectedException(e);
549 +        } finally { future.cancel(true); }
550 +        assertTrue(millisElapsedSince(startTime) >= timeoutMillis);
551 +    }
552  
553      /**
554       * Fails with message "should throw exception".
# Line 588 | Line 680 | public class JSR166TestCase extends Test
680       */
681      void sleep(long millis) {
682          try {
683 <            Thread.sleep(millis);
683 >            delay(millis);
684          } catch (InterruptedException ie) {
685              AssertionFailedError afe =
686                  new AssertionFailedError("Unexpected InterruptedException");
# Line 598 | Line 690 | public class JSR166TestCase extends Test
690      }
691  
692      /**
693 <     * Sleeps until the timeout has elapsed, or interrupted.
602 <     * Does <em>NOT</em> throw InterruptedException.
603 <     */
604 <    void sleepTillInterrupted(long timeoutMillis) {
605 <        try {
606 <            Thread.sleep(timeoutMillis);
607 <        } catch (InterruptedException wakeup) {}
608 <    }
609 <
610 <    /**
611 <     * Waits up to the specified number of milliseconds for the given
693 >     * Spin-waits up to the specified number of milliseconds for the given
694       * thread to enter a wait state: BLOCKED, WAITING, or TIMED_WAITING.
695       */
696      void waitForThreadToEnterWaitState(Thread thread, long timeoutMillis) {
697 <        long timeoutNanos = timeoutMillis * 1000L * 1000L;
616 <        long t0 = System.nanoTime();
697 >        long startTime = System.nanoTime();
698          for (;;) {
699              Thread.State s = thread.getState();
700              if (s == Thread.State.BLOCKED ||
# Line 622 | Line 703 | public class JSR166TestCase extends Test
703                  return;
704              else if (s == Thread.State.TERMINATED)
705                  fail("Unexpected thread termination");
706 <            else if (System.nanoTime() - t0 > timeoutNanos) {
706 >            else if (millisElapsedSince(startTime) > timeoutMillis) {
707                  threadAssertTrue(thread.isAlive());
708                  return;
709              }
# Line 631 | Line 712 | public class JSR166TestCase extends Test
712      }
713  
714      /**
715 +     * Waits up to LONG_DELAY_MS for the given thread to enter a wait
716 +     * state: BLOCKED, WAITING, or TIMED_WAITING.
717 +     */
718 +    void waitForThreadToEnterWaitState(Thread thread) {
719 +        waitForThreadToEnterWaitState(thread, LONG_DELAY_MS);
720 +    }
721 +
722 +    /**
723       * Returns the number of milliseconds since time given by
724       * startNanoTime, which must have been previously returned from a
725       * call to {@link System.nanoTime()}.
# Line 660 | Line 749 | public class JSR166TestCase extends Test
749          } catch (InterruptedException ie) {
750              threadUnexpectedException(ie);
751          } finally {
752 <            if (t.isAlive()) {
752 >            if (t.getState() != Thread.State.TERMINATED) {
753                  t.interrupt();
754                  fail("Test timed out");
755              }
756          }
757      }
758  
759 +    /**
760 +     * Waits for LONG_DELAY_MS milliseconds for the thread to
761 +     * terminate (using {@link Thread#join(long)}), else interrupts
762 +     * the thread (in the hope that it may terminate later) and fails.
763 +     */
764 +    void awaitTermination(Thread t) {
765 +        awaitTermination(t, LONG_DELAY_MS);
766 +    }
767 +
768      // Some convenient Runnable classes
769  
770      public abstract class CheckedRunnable implements Runnable {
# Line 729 | Line 827 | public class JSR166TestCase extends Test
827                  realRun();
828                  threadShouldThrow("InterruptedException");
829              } catch (InterruptedException success) {
830 +                threadAssertFalse(Thread.interrupted());
831              } catch (Throwable t) {
832                  threadUnexpectedException(t);
833              }
# Line 758 | Line 857 | public class JSR166TestCase extends Test
857                  threadShouldThrow("InterruptedException");
858                  return result;
859              } catch (InterruptedException success) {
860 +                threadAssertFalse(Thread.interrupted());
861              } catch (Throwable t) {
862                  threadUnexpectedException(t);
863              }
# Line 792 | Line 892 | public class JSR166TestCase extends Test
892      public Runnable awaiter(final CountDownLatch latch) {
893          return new CheckedRunnable() {
894              public void realRun() throws InterruptedException {
895 <                latch.await();
895 >                await(latch);
896              }};
897      }
898  
899 +    public void await(CountDownLatch latch) {
900 +        try {
901 +            assertTrue(latch.await(LONG_DELAY_MS, MILLISECONDS));
902 +        } catch (Throwable t) {
903 +            threadUnexpectedException(t);
904 +        }
905 +    }
906 +
907 +    public void await(Semaphore semaphore) {
908 +        try {
909 +            assertTrue(semaphore.tryAcquire(LONG_DELAY_MS, MILLISECONDS));
910 +        } catch (Throwable t) {
911 +            threadUnexpectedException(t);
912 +        }
913 +    }
914 +
915 + //     /**
916 + //      * Spin-waits up to LONG_DELAY_MS until flag becomes true.
917 + //      */
918 + //     public void await(AtomicBoolean flag) {
919 + //         await(flag, LONG_DELAY_MS);
920 + //     }
921 +
922 + //     /**
923 + //      * Spin-waits up to the specified timeout until flag becomes true.
924 + //      */
925 + //     public void await(AtomicBoolean flag, long timeoutMillis) {
926 + //         long startTime = System.nanoTime();
927 + //         while (!flag.get()) {
928 + //             if (millisElapsedSince(startTime) > timeoutMillis)
929 + //                 throw new AssertionFailedError("timed out");
930 + //             Thread.yield();
931 + //         }
932 + //     }
933 +
934      public static class NPETask implements Callable<String> {
935          public String call() { throw new NullPointerException(); }
936      }
# Line 806 | Line 941 | public class JSR166TestCase extends Test
941  
942      public class ShortRunnable extends CheckedRunnable {
943          protected void realRun() throws Throwable {
944 <            Thread.sleep(SHORT_DELAY_MS);
944 >            delay(SHORT_DELAY_MS);
945          }
946      }
947  
948      public class ShortInterruptedRunnable extends CheckedInterruptedRunnable {
949          protected void realRun() throws InterruptedException {
950 <            Thread.sleep(SHORT_DELAY_MS);
950 >            delay(SHORT_DELAY_MS);
951          }
952      }
953  
954      public class SmallRunnable extends CheckedRunnable {
955          protected void realRun() throws Throwable {
956 <            Thread.sleep(SMALL_DELAY_MS);
956 >            delay(SMALL_DELAY_MS);
957          }
958      }
959  
960      public class SmallPossiblyInterruptedRunnable extends CheckedRunnable {
961          protected void realRun() {
962              try {
963 <                Thread.sleep(SMALL_DELAY_MS);
963 >                delay(SMALL_DELAY_MS);
964              } catch (InterruptedException ok) {}
965          }
966      }
967  
968      public class SmallCallable extends CheckedCallable {
969          protected Object realCall() throws InterruptedException {
970 <            Thread.sleep(SMALL_DELAY_MS);
970 >            delay(SMALL_DELAY_MS);
971              return Boolean.TRUE;
972          }
973      }
974  
975      public class MediumRunnable extends CheckedRunnable {
976          protected void realRun() throws Throwable {
977 <            Thread.sleep(MEDIUM_DELAY_MS);
977 >            delay(MEDIUM_DELAY_MS);
978          }
979      }
980  
981      public class MediumInterruptedRunnable extends CheckedInterruptedRunnable {
982          protected void realRun() throws InterruptedException {
983 <            Thread.sleep(MEDIUM_DELAY_MS);
983 >            delay(MEDIUM_DELAY_MS);
984          }
985      }
986  
# Line 853 | Line 988 | public class JSR166TestCase extends Test
988          return new CheckedRunnable() {
989              protected void realRun() {
990                  try {
991 <                    Thread.sleep(timeoutMillis);
991 >                    delay(timeoutMillis);
992                  } catch (InterruptedException ok) {}
993              }};
994      }
# Line 861 | Line 996 | public class JSR166TestCase extends Test
996      public class MediumPossiblyInterruptedRunnable extends CheckedRunnable {
997          protected void realRun() {
998              try {
999 <                Thread.sleep(MEDIUM_DELAY_MS);
999 >                delay(MEDIUM_DELAY_MS);
1000              } catch (InterruptedException ok) {}
1001          }
1002      }
# Line 869 | Line 1004 | public class JSR166TestCase extends Test
1004      public class LongPossiblyInterruptedRunnable extends CheckedRunnable {
1005          protected void realRun() {
1006              try {
1007 <                Thread.sleep(LONG_DELAY_MS);
1007 >                delay(LONG_DELAY_MS);
1008              } catch (InterruptedException ok) {}
1009          }
1010      }
# Line 893 | Line 1028 | public class JSR166TestCase extends Test
1028                  public boolean isDone() { return done; }
1029                  public void run() {
1030                      try {
1031 <                        Thread.sleep(timeoutMillis);
1031 >                        delay(timeoutMillis);
1032                          done = true;
1033                      } catch (InterruptedException ok) {}
1034                  }
# Line 904 | Line 1039 | public class JSR166TestCase extends Test
1039          public volatile boolean done = false;
1040          public void run() {
1041              try {
1042 <                Thread.sleep(SHORT_DELAY_MS);
1042 >                delay(SHORT_DELAY_MS);
1043                  done = true;
1044              } catch (InterruptedException ok) {}
1045          }
# Line 914 | Line 1049 | public class JSR166TestCase extends Test
1049          public volatile boolean done = false;
1050          public void run() {
1051              try {
1052 <                Thread.sleep(SMALL_DELAY_MS);
1052 >                delay(SMALL_DELAY_MS);
1053                  done = true;
1054              } catch (InterruptedException ok) {}
1055          }
# Line 924 | Line 1059 | public class JSR166TestCase extends Test
1059          public volatile boolean done = false;
1060          public void run() {
1061              try {
1062 <                Thread.sleep(MEDIUM_DELAY_MS);
1062 >                delay(MEDIUM_DELAY_MS);
1063                  done = true;
1064              } catch (InterruptedException ok) {}
1065          }
# Line 934 | Line 1069 | public class JSR166TestCase extends Test
1069          public volatile boolean done = false;
1070          public void run() {
1071              try {
1072 <                Thread.sleep(LONG_DELAY_MS);
1072 >                delay(LONG_DELAY_MS);
1073                  done = true;
1074              } catch (InterruptedException ok) {}
1075          }
# Line 951 | Line 1086 | public class JSR166TestCase extends Test
1086          public volatile boolean done = false;
1087          public Object call() {
1088              try {
1089 <                Thread.sleep(SMALL_DELAY_MS);
1089 >                delay(SMALL_DELAY_MS);
1090                  done = true;
1091              } catch (InterruptedException ok) {}
1092              return Boolean.TRUE;
# Line 998 | Line 1133 | public class JSR166TestCase extends Test
1133      }
1134  
1135      /**
1136 <     * A CyclicBarrier that fails with AssertionFailedErrors instead
1137 <     * of throwing checked exceptions.
1136 >     * A CyclicBarrier that uses timed await and fails with
1137 >     * AssertionFailedErrors instead of throwing checked exceptions.
1138       */
1139      public class CheckedBarrier extends CyclicBarrier {
1140          public CheckedBarrier(int parties) { super(parties); }
1141  
1142          public int await() {
1143              try {
1144 <                return super.await();
1144 >                return super.await(2 * LONG_DELAY_MS, MILLISECONDS);
1145 >            } catch (TimeoutException e) {
1146 >                throw new AssertionFailedError("timed out");
1147              } catch (Exception e) {
1148                  AssertionFailedError afe =
1149                      new AssertionFailedError("Unexpected exception: " + e);
# Line 1016 | Line 1153 | public class JSR166TestCase extends Test
1153          }
1154      }
1155  
1156 <    public void checkEmpty(BlockingQueue q) {
1156 >    void checkEmpty(BlockingQueue q) {
1157          try {
1158              assertTrue(q.isEmpty());
1159              assertEquals(0, q.size());
# Line 1043 | Line 1180 | public class JSR166TestCase extends Test
1180          }
1181      }
1182  
1183 +    @SuppressWarnings("unchecked")
1184 +    <T> T serialClone(T o) {
1185 +        try {
1186 +            ByteArrayOutputStream bos = new ByteArrayOutputStream();
1187 +            ObjectOutputStream oos = new ObjectOutputStream(bos);
1188 +            oos.writeObject(o);
1189 +            oos.flush();
1190 +            oos.close();
1191 +            ObjectInputStream ois = new ObjectInputStream
1192 +                (new ByteArrayInputStream(bos.toByteArray()));
1193 +            T clone = (T) ois.readObject();
1194 +            assertSame(o.getClass(), clone.getClass());
1195 +            return clone;
1196 +        } catch (Throwable t) {
1197 +            threadUnexpectedException(t);
1198 +            return null;
1199 +        }
1200 +    }
1201   }

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines