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.74 by jsr166, Tue Mar 15 19:47:06 2011 UTC vs.
Revision 1.96 by jsr166, Mon Jan 21 19:51:46 2013 UTC

# Line 7 | Line 7
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.lang.management.ManagementFactory;
15 + import java.lang.management.ThreadInfo;
16 + import java.util.ArrayList;
17   import java.util.Arrays;
18 + import java.util.Date;
19 + import java.util.Enumeration;
20 + import java.util.List;
21   import java.util.NoSuchElementException;
22   import java.util.PropertyPermission;
23   import java.util.concurrent.*;
24 + import java.util.concurrent.atomic.AtomicBoolean;
25   import java.util.concurrent.atomic.AtomicReference;
26   import static java.util.concurrent.TimeUnit.MILLISECONDS;
27   import static java.util.concurrent.TimeUnit.NANOSECONDS;
# Line 63 | Line 74 | import java.security.SecurityPermission;
74   *
75   * </ol>
76   *
77 < * <p> <b>Other notes</b>
77 > * <p><b>Other notes</b>
78   * <ul>
79   *
80   * <li> Usually, there is one testcase method per JSR166 method
# Line 136 | Line 147 | public class JSR166TestCase extends Test
147      }
148  
149      /**
150 <     * Runs all JSR166 unit tests using junit.textui.TestRunner
150 >     * Runs all JSR166 unit tests using junit.textui.TestRunner.
151 >     * Optional command line arg provides the number of iterations to
152 >     * repeat running the tests.
153       */
154      public static void main(String[] args) {
155          if (useSecurityManager) {
# Line 254 | Line 267 | public class JSR166TestCase extends Test
267          return 50;
268      }
269  
257
270      /**
271       * Sets delays as multiples of SHORT_DELAY.
272       */
# Line 266 | Line 278 | public class JSR166TestCase extends Test
278      }
279  
280      /**
281 +     * Returns a timeout in milliseconds to be used in tests that
282 +     * verify that operations block or time out.
283 +     */
284 +    long timeoutMillis() {
285 +        return SHORT_DELAY_MS / 4;
286 +    }
287 +
288 +    /**
289 +     * Returns a new Date instance representing a time delayMillis
290 +     * milliseconds in the future.
291 +     */
292 +    Date delayedDate(long delayMillis) {
293 +        return new Date(System.currentTimeMillis() + delayMillis);
294 +    }
295 +
296 +    /**
297       * The first exception encountered if any threadAssertXXX method fails.
298       */
299      private final AtomicReference<Throwable> threadFailure
# Line 286 | Line 314 | public class JSR166TestCase extends Test
314      }
315  
316      /**
317 +     * Extra checks that get done for all test cases.
318 +     *
319       * Triggers test case failure if any thread assertions have failed,
320       * by rethrowing, in the test harness thread, any exception recorded
321       * earlier by threadRecordFailure.
322 +     *
323 +     * Triggers test case failure if interrupt status is set in the main thread.
324       */
325      public void tearDown() throws Exception {
326          Throwable t = threadFailure.getAndSet(null);
# Line 306 | Line 338 | public class JSR166TestCase extends Test
338                  throw afe;
339              }
340          }
341 +
342 +        if (Thread.interrupted())
343 +            throw new AssertionFailedError("interrupt status set in main thread");
344      }
345  
346      /**
# Line 437 | Line 472 | public class JSR166TestCase extends Test
472          else {
473              AssertionFailedError afe =
474                  new AssertionFailedError("unexpected exception: " + t);
475 <            t.initCause(t);
475 >            afe.initCause(t);
476              throw afe;
477          }
478      }
479  
480      /**
481 +     * Delays, via Thread.sleep, for the given millisecond delay, but
482 +     * if the sleep is shorter than specified, may re-sleep or yield
483 +     * until time elapses.
484 +     */
485 +    static void delay(long millis) throws InterruptedException {
486 +        long startTime = System.nanoTime();
487 +        long ns = millis * 1000 * 1000;
488 +        for (;;) {
489 +            if (millis > 0L)
490 +                Thread.sleep(millis);
491 +            else // too short to sleep
492 +                Thread.yield();
493 +            long d = ns - (System.nanoTime() - startTime);
494 +            if (d > 0L)
495 +                millis = d / (1000 * 1000);
496 +            else
497 +                break;
498 +        }
499 +    }
500 +
501 +    /**
502       * Waits out termination of a thread pool or fails doing so.
503       */
504 <    public void joinPool(ExecutorService exec) {
504 >    void joinPool(ExecutorService exec) {
505          try {
506              exec.shutdown();
507              assertTrue("ExecutorService did not terminate in a timely manner",
# Line 457 | Line 513 | public class JSR166TestCase extends Test
513          }
514      }
515  
516 +    /**
517 +     * A debugging tool to print all stack traces, as jstack does.
518 +     */
519 +    static void printAllStackTraces() {
520 +        for (ThreadInfo info :
521 +                 ManagementFactory.getThreadMXBean()
522 +                 .dumpAllThreads(true, true))
523 +            System.err.print(info);
524 +    }
525 +
526 +    /**
527 +     * Checks that thread does not terminate within the default
528 +     * millisecond delay of {@code timeoutMillis()}.
529 +     */
530 +    void assertThreadStaysAlive(Thread thread) {
531 +        assertThreadStaysAlive(thread, timeoutMillis());
532 +    }
533 +
534 +    /**
535 +     * Checks that thread does not terminate within the given millisecond delay.
536 +     */
537 +    void assertThreadStaysAlive(Thread thread, long millis) {
538 +        try {
539 +            // No need to optimize the failing case via Thread.join.
540 +            delay(millis);
541 +            assertTrue(thread.isAlive());
542 +        } catch (InterruptedException ie) {
543 +            fail("Unexpected InterruptedException");
544 +        }
545 +    }
546 +
547 +    /**
548 +     * Checks that the threads do not terminate within the default
549 +     * millisecond delay of {@code timeoutMillis()}.
550 +     */
551 +    void assertThreadsStayAlive(Thread... threads) {
552 +        assertThreadsStayAlive(timeoutMillis(), threads);
553 +    }
554 +
555 +    /**
556 +     * Checks that the threads do not terminate within the given millisecond delay.
557 +     */
558 +    void assertThreadsStayAlive(long millis, Thread... threads) {
559 +        try {
560 +            // No need to optimize the failing case via Thread.join.
561 +            delay(millis);
562 +            for (Thread thread : threads)
563 +                assertTrue(thread.isAlive());
564 +        } catch (InterruptedException ie) {
565 +            fail("Unexpected InterruptedException");
566 +        }
567 +    }
568 +
569 +    /**
570 +     * Checks that future.get times out, with the default timeout of
571 +     * {@code timeoutMillis()}.
572 +     */
573 +    void assertFutureTimesOut(Future future) {
574 +        assertFutureTimesOut(future, timeoutMillis());
575 +    }
576 +
577 +    /**
578 +     * Checks that future.get times out, with the given millisecond timeout.
579 +     */
580 +    void assertFutureTimesOut(Future future, long timeoutMillis) {
581 +        long startTime = System.nanoTime();
582 +        try {
583 +            future.get(timeoutMillis, MILLISECONDS);
584 +            shouldThrow();
585 +        } catch (TimeoutException success) {
586 +        } catch (Exception e) {
587 +            threadUnexpectedException(e);
588 +        } finally { future.cancel(true); }
589 +        assertTrue(millisElapsedSince(startTime) >= timeoutMillis);
590 +    }
591  
592      /**
593       * Fails with message "should throw exception".
# Line 509 | Line 640 | public class JSR166TestCase extends Test
640          SecurityManager sm = System.getSecurityManager();
641          if (sm == null) {
642              r.run();
643 +        }
644 +        runWithSecurityManagerWithPermissions(r, permissions);
645 +    }
646 +
647 +    /**
648 +     * Runs Runnable r with a security policy that permits precisely
649 +     * the specified permissions.  If there is no current security
650 +     * manager, a temporary one is set for the duration of the
651 +     * Runnable.  We require that any security manager permit
652 +     * getPolicy/setPolicy.
653 +     */
654 +    public void runWithSecurityManagerWithPermissions(Runnable r,
655 +                                                      Permission... permissions) {
656 +        SecurityManager sm = System.getSecurityManager();
657 +        if (sm == null) {
658              Policy savedPolicy = Policy.getPolicy();
659              try {
660                  Policy.setPolicy(permissivePolicy());
661                  System.setSecurityManager(new SecurityManager());
662 <                runWithPermissions(r, permissions);
662 >                runWithSecurityManagerWithPermissions(r, permissions);
663              } finally {
664                  System.setSecurityManager(null);
665                  Policy.setPolicy(savedPolicy);
# Line 561 | Line 707 | public class JSR166TestCase extends Test
707              return perms.implies(p);
708          }
709          public void refresh() {}
710 +        public String toString() {
711 +            List<Permission> ps = new ArrayList<Permission>();
712 +            for (Enumeration<Permission> e = perms.elements(); e.hasMoreElements();)
713 +                ps.add(e.nextElement());
714 +            return "AdjustablePolicy with permissions " + ps;
715 +        }
716      }
717  
718      /**
# Line 588 | Line 740 | public class JSR166TestCase extends Test
740       */
741      void sleep(long millis) {
742          try {
743 <            Thread.sleep(millis);
743 >            delay(millis);
744          } catch (InterruptedException ie) {
745              AssertionFailedError afe =
746                  new AssertionFailedError("Unexpected InterruptedException");
# Line 598 | Line 750 | public class JSR166TestCase extends Test
750      }
751  
752      /**
753 <     * 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
753 >     * Spin-waits up to the specified number of milliseconds for the given
754       * thread to enter a wait state: BLOCKED, WAITING, or TIMED_WAITING.
755       */
756      void waitForThreadToEnterWaitState(Thread thread, long timeoutMillis) {
757 <        long timeoutNanos = timeoutMillis * 1000L * 1000L;
616 <        long t0 = System.nanoTime();
757 >        long startTime = System.nanoTime();
758          for (;;) {
759              Thread.State s = thread.getState();
760              if (s == Thread.State.BLOCKED ||
# Line 622 | Line 763 | public class JSR166TestCase extends Test
763                  return;
764              else if (s == Thread.State.TERMINATED)
765                  fail("Unexpected thread termination");
766 <            else if (System.nanoTime() - t0 > timeoutNanos) {
766 >            else if (millisElapsedSince(startTime) > timeoutMillis) {
767                  threadAssertTrue(thread.isAlive());
768                  return;
769              }
# Line 631 | Line 772 | public class JSR166TestCase extends Test
772      }
773  
774      /**
775 +     * Waits up to LONG_DELAY_MS for the given thread to enter a wait
776 +     * state: BLOCKED, WAITING, or TIMED_WAITING.
777 +     */
778 +    void waitForThreadToEnterWaitState(Thread thread) {
779 +        waitForThreadToEnterWaitState(thread, LONG_DELAY_MS);
780 +    }
781 +
782 +    /**
783       * Returns the number of milliseconds since time given by
784       * startNanoTime, which must have been previously returned from a
785       * call to {@link System.nanoTime()}.
# Line 660 | Line 809 | public class JSR166TestCase extends Test
809          } catch (InterruptedException ie) {
810              threadUnexpectedException(ie);
811          } finally {
812 <            if (t.isAlive()) {
812 >            if (t.getState() != Thread.State.TERMINATED) {
813                  t.interrupt();
814                  fail("Test timed out");
815              }
816          }
817      }
818  
819 +    /**
820 +     * Waits for LONG_DELAY_MS milliseconds for the thread to
821 +     * terminate (using {@link Thread#join(long)}), else interrupts
822 +     * the thread (in the hope that it may terminate later) and fails.
823 +     */
824 +    void awaitTermination(Thread t) {
825 +        awaitTermination(t, LONG_DELAY_MS);
826 +    }
827 +
828      // Some convenient Runnable classes
829  
830      public abstract class CheckedRunnable implements Runnable {
# Line 729 | Line 887 | public class JSR166TestCase extends Test
887                  realRun();
888                  threadShouldThrow("InterruptedException");
889              } catch (InterruptedException success) {
890 +                threadAssertFalse(Thread.interrupted());
891              } catch (Throwable t) {
892                  threadUnexpectedException(t);
893              }
# Line 758 | Line 917 | public class JSR166TestCase extends Test
917                  threadShouldThrow("InterruptedException");
918                  return result;
919              } catch (InterruptedException success) {
920 +                threadAssertFalse(Thread.interrupted());
921              } catch (Throwable t) {
922                  threadUnexpectedException(t);
923              }
# Line 792 | Line 952 | public class JSR166TestCase extends Test
952      public Runnable awaiter(final CountDownLatch latch) {
953          return new CheckedRunnable() {
954              public void realRun() throws InterruptedException {
955 <                latch.await();
955 >                await(latch);
956              }};
957      }
958  
959 +    public void await(CountDownLatch latch) {
960 +        try {
961 +            assertTrue(latch.await(LONG_DELAY_MS, MILLISECONDS));
962 +        } catch (Throwable t) {
963 +            threadUnexpectedException(t);
964 +        }
965 +    }
966 +
967 +    public void await(Semaphore semaphore) {
968 +        try {
969 +            assertTrue(semaphore.tryAcquire(LONG_DELAY_MS, MILLISECONDS));
970 +        } catch (Throwable t) {
971 +            threadUnexpectedException(t);
972 +        }
973 +    }
974 +
975 + //     /**
976 + //      * Spin-waits up to LONG_DELAY_MS until flag becomes true.
977 + //      */
978 + //     public void await(AtomicBoolean flag) {
979 + //         await(flag, LONG_DELAY_MS);
980 + //     }
981 +
982 + //     /**
983 + //      * Spin-waits up to the specified timeout until flag becomes true.
984 + //      */
985 + //     public void await(AtomicBoolean flag, long timeoutMillis) {
986 + //         long startTime = System.nanoTime();
987 + //         while (!flag.get()) {
988 + //             if (millisElapsedSince(startTime) > timeoutMillis)
989 + //                 throw new AssertionFailedError("timed out");
990 + //             Thread.yield();
991 + //         }
992 + //     }
993 +
994      public static class NPETask implements Callable<String> {
995          public String call() { throw new NullPointerException(); }
996      }
# Line 806 | Line 1001 | public class JSR166TestCase extends Test
1001  
1002      public class ShortRunnable extends CheckedRunnable {
1003          protected void realRun() throws Throwable {
1004 <            Thread.sleep(SHORT_DELAY_MS);
1004 >            delay(SHORT_DELAY_MS);
1005          }
1006      }
1007  
1008      public class ShortInterruptedRunnable extends CheckedInterruptedRunnable {
1009          protected void realRun() throws InterruptedException {
1010 <            Thread.sleep(SHORT_DELAY_MS);
1010 >            delay(SHORT_DELAY_MS);
1011          }
1012      }
1013  
1014      public class SmallRunnable extends CheckedRunnable {
1015          protected void realRun() throws Throwable {
1016 <            Thread.sleep(SMALL_DELAY_MS);
1016 >            delay(SMALL_DELAY_MS);
1017          }
1018      }
1019  
1020      public class SmallPossiblyInterruptedRunnable extends CheckedRunnable {
1021          protected void realRun() {
1022              try {
1023 <                Thread.sleep(SMALL_DELAY_MS);
1023 >                delay(SMALL_DELAY_MS);
1024              } catch (InterruptedException ok) {}
1025          }
1026      }
1027  
1028      public class SmallCallable extends CheckedCallable {
1029          protected Object realCall() throws InterruptedException {
1030 <            Thread.sleep(SMALL_DELAY_MS);
1030 >            delay(SMALL_DELAY_MS);
1031              return Boolean.TRUE;
1032          }
1033      }
1034  
1035      public class MediumRunnable extends CheckedRunnable {
1036          protected void realRun() throws Throwable {
1037 <            Thread.sleep(MEDIUM_DELAY_MS);
1037 >            delay(MEDIUM_DELAY_MS);
1038          }
1039      }
1040  
1041      public class MediumInterruptedRunnable extends CheckedInterruptedRunnable {
1042          protected void realRun() throws InterruptedException {
1043 <            Thread.sleep(MEDIUM_DELAY_MS);
1043 >            delay(MEDIUM_DELAY_MS);
1044          }
1045      }
1046  
# Line 853 | Line 1048 | public class JSR166TestCase extends Test
1048          return new CheckedRunnable() {
1049              protected void realRun() {
1050                  try {
1051 <                    Thread.sleep(timeoutMillis);
1051 >                    delay(timeoutMillis);
1052                  } catch (InterruptedException ok) {}
1053              }};
1054      }
# Line 861 | Line 1056 | public class JSR166TestCase extends Test
1056      public class MediumPossiblyInterruptedRunnable extends CheckedRunnable {
1057          protected void realRun() {
1058              try {
1059 <                Thread.sleep(MEDIUM_DELAY_MS);
1059 >                delay(MEDIUM_DELAY_MS);
1060              } catch (InterruptedException ok) {}
1061          }
1062      }
# Line 869 | Line 1064 | public class JSR166TestCase extends Test
1064      public class LongPossiblyInterruptedRunnable extends CheckedRunnable {
1065          protected void realRun() {
1066              try {
1067 <                Thread.sleep(LONG_DELAY_MS);
1067 >                delay(LONG_DELAY_MS);
1068              } catch (InterruptedException ok) {}
1069          }
1070      }
# Line 893 | Line 1088 | public class JSR166TestCase extends Test
1088                  public boolean isDone() { return done; }
1089                  public void run() {
1090                      try {
1091 <                        Thread.sleep(timeoutMillis);
1091 >                        delay(timeoutMillis);
1092                          done = true;
1093                      } catch (InterruptedException ok) {}
1094                  }
# Line 904 | Line 1099 | public class JSR166TestCase extends Test
1099          public volatile boolean done = false;
1100          public void run() {
1101              try {
1102 <                Thread.sleep(SHORT_DELAY_MS);
1102 >                delay(SHORT_DELAY_MS);
1103                  done = true;
1104              } catch (InterruptedException ok) {}
1105          }
# Line 914 | Line 1109 | public class JSR166TestCase extends Test
1109          public volatile boolean done = false;
1110          public void run() {
1111              try {
1112 <                Thread.sleep(SMALL_DELAY_MS);
1112 >                delay(SMALL_DELAY_MS);
1113                  done = true;
1114              } catch (InterruptedException ok) {}
1115          }
# Line 924 | Line 1119 | public class JSR166TestCase extends Test
1119          public volatile boolean done = false;
1120          public void run() {
1121              try {
1122 <                Thread.sleep(MEDIUM_DELAY_MS);
1122 >                delay(MEDIUM_DELAY_MS);
1123                  done = true;
1124              } catch (InterruptedException ok) {}
1125          }
# Line 934 | Line 1129 | public class JSR166TestCase extends Test
1129          public volatile boolean done = false;
1130          public void run() {
1131              try {
1132 <                Thread.sleep(LONG_DELAY_MS);
1132 >                delay(LONG_DELAY_MS);
1133                  done = true;
1134              } catch (InterruptedException ok) {}
1135          }
# Line 951 | Line 1146 | public class JSR166TestCase extends Test
1146          public volatile boolean done = false;
1147          public Object call() {
1148              try {
1149 <                Thread.sleep(SMALL_DELAY_MS);
1149 >                delay(SMALL_DELAY_MS);
1150                  done = true;
1151              } catch (InterruptedException ok) {}
1152              return Boolean.TRUE;
# Line 998 | Line 1193 | public class JSR166TestCase extends Test
1193      }
1194  
1195      /**
1196 <     * A CyclicBarrier that fails with AssertionFailedErrors instead
1197 <     * of throwing checked exceptions.
1196 >     * A CyclicBarrier that uses timed await and fails with
1197 >     * AssertionFailedErrors instead of throwing checked exceptions.
1198       */
1199      public class CheckedBarrier extends CyclicBarrier {
1200          public CheckedBarrier(int parties) { super(parties); }
1201  
1202          public int await() {
1203              try {
1204 <                return super.await();
1204 >                return super.await(2 * LONG_DELAY_MS, MILLISECONDS);
1205 >            } catch (TimeoutException e) {
1206 >                throw new AssertionFailedError("timed out");
1207              } catch (Exception e) {
1208                  AssertionFailedError afe =
1209                      new AssertionFailedError("Unexpected exception: " + e);
# Line 1016 | Line 1213 | public class JSR166TestCase extends Test
1213          }
1214      }
1215  
1216 <    public void checkEmpty(BlockingQueue q) {
1216 >    void checkEmpty(BlockingQueue q) {
1217          try {
1218              assertTrue(q.isEmpty());
1219              assertEquals(0, q.size());
# Line 1043 | Line 1240 | public class JSR166TestCase extends Test
1240          }
1241      }
1242  
1243 +    void assertSerialEquals(Object x, Object y) {
1244 +        assertTrue(Arrays.equals(serialBytes(x), serialBytes(y)));
1245 +    }
1246 +
1247 +    void assertNotSerialEquals(Object x, Object y) {
1248 +        assertFalse(Arrays.equals(serialBytes(x), serialBytes(y)));
1249 +    }
1250 +
1251 +    byte[] serialBytes(Object o) {
1252 +        try {
1253 +            ByteArrayOutputStream bos = new ByteArrayOutputStream();
1254 +            ObjectOutputStream oos = new ObjectOutputStream(bos);
1255 +            oos.writeObject(o);
1256 +            oos.flush();
1257 +            oos.close();
1258 +            return bos.toByteArray();
1259 +        } catch (Throwable t) {
1260 +            threadUnexpectedException(t);
1261 +            return new byte[0];
1262 +        }
1263 +    }
1264 +
1265 +    @SuppressWarnings("unchecked")
1266 +    <T> T serialClone(T o) {
1267 +        try {
1268 +            ObjectInputStream ois = new ObjectInputStream
1269 +                (new ByteArrayInputStream(serialBytes(o)));
1270 +            T clone = (T) ois.readObject();
1271 +            assertSame(o.getClass(), clone.getClass());
1272 +            return clone;
1273 +        } catch (Throwable t) {
1274 +            threadUnexpectedException(t);
1275 +            return null;
1276 +        }
1277 +    }
1278   }

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines