TestPrunes fails occasionally still

[Martin Packman]

TestPrunes was changed as part of bug bug 1459291 due to intermittent failures, but still fails sometimes.

http://reports.vapour.ws/releases/issue/5565dd10749a5670af648404

FAIL: txnpruner_test.go:22: com_juju_juju_worker_txnpruner_test.TestPrunes.pN57_github.com_juju_juju_worker_txnpruner_test.TxnPrunerSuite

txnpruner_test.go:38:
    c.Assert(td >= interval, jc.IsTrue, gc.Commentf("td=%s", td))
... obtained bool = false
... td=9.29ms

This failure is on ppc64/gccgo but that may not be a factor beyond that setup hitting timing issues more often.

[Menno Finlay-Smits (menno.smits)]

As noted in a TODO in the code, this code and its tests need to use an injected Clock.

[Martin Packman (gz)]

From bug 1618560 see Roger's reasoning:

"""
The reason for the failure is that the test relies on the scheduler.

There are two goroutines in play here.

When the test works, this happens:

   txnpruner: receives on timer channe
   txnpruner: calls MaybePruneTransaction, which sends on the test channel
   test: receives on test channel
   test: set t0
   txnpruner: reset timer to 10ms
   txnpruner: receives on timer channel at t0+10ms+something small
   txnpruner: calls MaybePruneTransaction, which sends on the test channel
   test: receives on test channel
   test: set t1
   test: t1 >= t0 + 10ms, all ok

But this can happen instead:

   txnpruner: receives on timer channe
   txnpruner: calls MaybePruneTransaction, which sends on the test channel
   test: receives on test channel
   txnpruner: reset timer to 10ms
   test: set t0
   txnpruner: receives on timer channel at t0+10ms+something small
   txnpruner: calls MaybePruneTransaction, which sends on the test channel
   test: receives on test channel
   test: set t1
   test: t1 < t0 + 10ms, fail

That is, there's nothing stopping the timer from resetting before the
test has decided on what time the previous event was set.

To fix this, the time should be set deterministically before the
code can continue running (for example by using a reply channel
or changing the test mock to send the time on the channel)
"""