Add Context cancellation to clock.

common/clock/systemclock_test.go

+// Copyright 2016 The Chromium Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+package clock
+
+import (
+        "testing"
+        "time"
+
+        "golang.org/x/net/context"
+
+        . "github.com/smartystreets/goconvey/convey"
+)
+
+// timeBase is the amount of time where short-response goroutine events "should
+// happen". This isn't a great measure, since scheduling can take longer. Making
+// this short will make the test run faster at the possible expense of increased
+// raciness. Making this longer will increase test time, but will potentially
+// reduce the change of race-related errors.
+//
+// This should be kept >60ms which is a fairly gratuitous RTC-based scheduler
+// delay (1 hr / 2^16) that some older OSes may be subject to.
+const timeBase = 60 * time.Millisecond

[iannucci, 2016/02/11 02:24:04]

Note that runtime.Gosched may also be pertinent here, which explicitly allows go
to run something else.

[dnj (Google), 2016/02/11 17:22:37]

I've used it in a some of the test code. The problem is that while it yields, it
doesn't guarantee goroutine order or that other gorotuines will run, so it's
flaky at best.

Using actual timing is important for specifically this suite of tests because
I'm specifically testing how the real system clock would work. There are one or
two cases that could be flaky (e.g., they may or may not assert their test
condition) because of this, but their role is mostly to assert conformance, and
the flake will result in a success either way (so not breaking flake), either
passes and asserts condition or passes and does not.

+
+// veryLongTime is a time long enough that it won't feasably happen during the
+// course of test execution.
+const veryLongTime = 1000 * timeBase
+
+// TestSystemClock tests the non-trivial system clock methods.
+func TestSystemClock(t *testing.T) {
+        t.Parallel()
+
+        Convey(`A cancelable Context`, t, func() {
+                c, cancelFunc := context.WithCancel(context.Background())
+                sc := GetSystemClock()
+
+                Convey(`Will perform a full sleep if the Context isn't canceled.`, func() {
+                        So(sc.Sleep(c, timeBase), ShouldBeNil)
+                })
+
+                Convey(`Will terminate the Sleep prematurely if the Context is canceled.`, func() {
+                        cancelFunc()
+                        So(sc.Sleep(c, veryLongTime), ShouldEqual, context.Canceled)
+                })
+        })
+}