src/allmydata/test/test_util.py

   1
   2 def foo(): pass # keep the line number constant
   3
   4 import os, time
   5 from StringIO import StringIO
   6 from twisted.trial import unittest
   7 from twisted.internet import defer, reactor
   8 from twisted.python.failure import Failure
   9 from twisted.python import log
  10
  11 from allmydata.util import base32, idlib, humanreadable, mathutil, hashutil
  12 from allmydata.util import assertutil, fileutil, deferredutil, abbreviate
  13 from allmydata.util import limiter, time_format, pollmixin, cachedir
  14 from allmydata.util import statistics, dictutil, pipeline
  15
  16 class Base32(unittest.TestCase):
  17     def test_b2a_matches_Pythons(self):
  18         import base64
  19         y = "\x12\x34\x45\x67\x89\x0a\xbc\xde\xf0"
  20         x = base64.b32encode(y)
  21         while x and x[-1] == '=':
  22             x = x[:-1]
  23         x = x.lower()
  24         self.failUnlessEqual(base32.b2a(y), x)
  25     def test_b2a(self):
  26         self.failUnlessEqual(base32.b2a("\x12\x34"), "ci2a")
  27     def test_b2a_or_none(self):
  28         self.failUnlessEqual(base32.b2a_or_none(None), None)
  29         self.failUnlessEqual(base32.b2a_or_none("\x12\x34"), "ci2a")
  30     def test_a2b(self):
  31         self.failUnlessEqual(base32.a2b("ci2a"), "\x12\x34")
  32         self.failUnlessRaises(AssertionError, base32.a2b, "b0gus")
  33
  34 class IDLib(unittest.TestCase):
  35     def test_nodeid_b2a(self):
  36         self.failUnlessEqual(idlib.nodeid_b2a("\x00"*20), "a"*32)
  37
  38 class NoArgumentException(Exception):
  39     def __init__(self):
  40         pass
  41
  42 class HumanReadable(unittest.TestCase):
  43     def test_repr(self):
  44         hr = humanreadable.hr
  45         self.failUnlessEqual(hr(foo), "<foo() at test_util.py:2>")
  46         self.failUnlessEqual(hr(self.test_repr),
  47                              "<bound method HumanReadable.test_repr of <allmydata.test.test_util.HumanReadable testMethod=test_repr>>")
  48         self.failUnlessEqual(hr(1L), "1")
  49         self.failUnlessEqual(hr(10**40),
  50                              "100000000000000000...000000000000000000")
  51         self.failUnlessEqual(hr(self), "<allmydata.test.test_util.HumanReadable testMethod=test_repr>")
  52         self.failUnlessEqual(hr([1,2]), "[1, 2]")
  53         self.failUnlessEqual(hr({1:2}), "{1:2}")
  54         try:
  55             raise ValueError
  56         except Exception, e:
  57             self.failUnless(
  58                 hr(e) == "<ValueError: ()>" # python-2.4
  59                 or hr(e) == "ValueError()") # python-2.5
  60         try:
  61             raise ValueError("oops")
  62         except Exception, e:
  63             self.failUnless(
  64                 hr(e) == "<ValueError: 'oops'>" # python-2.4
  65                 or hr(e) == "ValueError('oops',)") # python-2.5
  66         try:
  67             raise NoArgumentException
  68         except Exception, e:
  69             self.failUnless(
  70                 hr(e) == "<NoArgumentException>" # python-2.4
  71                 or hr(e) == "NoArgumentException()") # python-2.5
  72
  73
  74 class MyList(list):
  75     pass
  76
  77 class Math(unittest.TestCase):
  78     def test_div_ceil(self):
  79         f = mathutil.div_ceil
  80         self.failUnlessEqual(f(0, 1), 0)
  81         self.failUnlessEqual(f(0, 2), 0)
  82         self.failUnlessEqual(f(0, 3), 0)
  83         self.failUnlessEqual(f(1, 3), 1)
  84         self.failUnlessEqual(f(2, 3), 1)
  85         self.failUnlessEqual(f(3, 3), 1)
  86         self.failUnlessEqual(f(4, 3), 2)
  87         self.failUnlessEqual(f(5, 3), 2)
  88         self.failUnlessEqual(f(6, 3), 2)
  89         self.failUnlessEqual(f(7, 3), 3)
  90
  91     def test_next_multiple(self):
  92         f = mathutil.next_multiple
  93         self.failUnlessEqual(f(5, 1), 5)
  94         self.failUnlessEqual(f(5, 2), 6)
  95         self.failUnlessEqual(f(5, 3), 6)
  96         self.failUnlessEqual(f(5, 4), 8)
  97         self.failUnlessEqual(f(5, 5), 5)
  98         self.failUnlessEqual(f(5, 6), 6)
  99         self.failUnlessEqual(f(32, 1), 32)
 100         self.failUnlessEqual(f(32, 2), 32)
 101         self.failUnlessEqual(f(32, 3), 33)
 102         self.failUnlessEqual(f(32, 4), 32)
 103         self.failUnlessEqual(f(32, 5), 35)
 104         self.failUnlessEqual(f(32, 6), 36)
 105         self.failUnlessEqual(f(32, 7), 35)
 106         self.failUnlessEqual(f(32, 8), 32)
 107         self.failUnlessEqual(f(32, 9), 36)
 108         self.failUnlessEqual(f(32, 10), 40)
 109         self.failUnlessEqual(f(32, 11), 33)
 110         self.failUnlessEqual(f(32, 12), 36)
 111         self.failUnlessEqual(f(32, 13), 39)
 112         self.failUnlessEqual(f(32, 14), 42)
 113         self.failUnlessEqual(f(32, 15), 45)
 114         self.failUnlessEqual(f(32, 16), 32)
 115         self.failUnlessEqual(f(32, 17), 34)
 116         self.failUnlessEqual(f(32, 18), 36)
 117         self.failUnlessEqual(f(32, 589), 589)
 118
 119     def test_pad_size(self):
 120         f = mathutil.pad_size
 121         self.failUnlessEqual(f(0, 4), 0)
 122         self.failUnlessEqual(f(1, 4), 3)
 123         self.failUnlessEqual(f(2, 4), 2)
 124         self.failUnlessEqual(f(3, 4), 1)
 125         self.failUnlessEqual(f(4, 4), 0)
 126         self.failUnlessEqual(f(5, 4), 3)
 127
 128     def test_is_power_of_k(self):
 129         f = mathutil.is_power_of_k
 130         for i in range(1, 100):
 131             if i in (1, 2, 4, 8, 16, 32, 64):
 132                 self.failUnless(f(i, 2), "but %d *is* a power of 2" % i)
 133             else:
 134                 self.failIf(f(i, 2), "but %d is *not* a power of 2" % i)
 135         for i in range(1, 100):
 136             if i in (1, 3, 9, 27, 81):
 137                 self.failUnless(f(i, 3), "but %d *is* a power of 3" % i)
 138             else:
 139                 self.failIf(f(i, 3), "but %d is *not* a power of 3" % i)
 140
 141     def test_next_power_of_k(self):
 142         f = mathutil.next_power_of_k
 143         self.failUnlessEqual(f(0,2), 1)
 144         self.failUnlessEqual(f(1,2), 1)
 145         self.failUnlessEqual(f(2,2), 2)
 146         self.failUnlessEqual(f(3,2), 4)
 147         self.failUnlessEqual(f(4,2), 4)
 148         for i in range(5, 8): self.failUnlessEqual(f(i,2), 8, "%d" % i)
 149         for i in range(9, 16): self.failUnlessEqual(f(i,2), 16, "%d" % i)
 150         for i in range(17, 32): self.failUnlessEqual(f(i,2), 32, "%d" % i)
 151         for i in range(33, 64): self.failUnlessEqual(f(i,2), 64, "%d" % i)
 152         for i in range(65, 100): self.failUnlessEqual(f(i,2), 128, "%d" % i)
 153
 154         self.failUnlessEqual(f(0,3), 1)
 155         self.failUnlessEqual(f(1,3), 1)
 156         self.failUnlessEqual(f(2,3), 3)
 157         self.failUnlessEqual(f(3,3), 3)
 158         for i in range(4, 9): self.failUnlessEqual(f(i,3), 9, "%d" % i)
 159         for i in range(10, 27): self.failUnlessEqual(f(i,3), 27, "%d" % i)
 160         for i in range(28, 81): self.failUnlessEqual(f(i,3), 81, "%d" % i)
 161         for i in range(82, 200): self.failUnlessEqual(f(i,3), 243, "%d" % i)
 162
 163     def test_ave(self):
 164         f = mathutil.ave
 165         self.failUnlessEqual(f([1,2,3]), 2)
 166         self.failUnlessEqual(f([0,0,0,4]), 1)
 167         self.failUnlessAlmostEqual(f([0.0, 1.0, 1.0]), .666666666666)
 168
 169     def test_round_sigfigs(self):
 170         f = mathutil.round_sigfigs
 171         self.failUnlessEqual(f(22.0/3, 4), 7.3330000000000002)
 172
 173 class Statistics(unittest.TestCase):
 174     def should_assert(self, msg, func, *args, **kwargs):
 175         try:
 176             func(*args, **kwargs)
 177             self.fail(msg)
 178         except AssertionError, e:
 179             pass
 180
 181     def failUnlessListEqual(self, a, b, msg = None):
 182         self.failUnlessEqual(len(a), len(b))
 183         for i in range(len(a)):
 184             self.failUnlessEqual(a[i], b[i], msg)
 185
 186     def failUnlessListAlmostEqual(self, a, b, places = 7, msg = None):
 187         self.failUnlessEqual(len(a), len(b))
 188         for i in range(len(a)):
 189             self.failUnlessAlmostEqual(a[i], b[i], places, msg)
 190
 191     def test_binomial_coeff(self):
 192         f = statistics.binomial_coeff
 193         self.failUnlessEqual(f(20, 0), 1)
 194         self.failUnlessEqual(f(20, 1), 20)
 195         self.failUnlessEqual(f(20, 2), 190)
 196         self.failUnlessEqual(f(20, 8), f(20, 12))
 197         self.should_assert("Should assert if n < k", f, 2, 3)
 198
 199     def test_binomial_distribution_pmf(self):
 200         f = statistics.binomial_distribution_pmf
 201
 202         pmf_comp = f(2, .1)
 203         pmf_stat = [0.81, 0.18, 0.01]
 204         self.failUnlessListAlmostEqual(pmf_comp, pmf_stat)
 205
 206         # Summing across a PMF should give the total probability 1
 207         self.failUnlessAlmostEqual(sum(pmf_comp), 1)
 208         self.should_assert("Should assert if not 0<=p<=1", f, 1, -1)
 209         self.should_assert("Should assert if n < 1", f, 0, .1)
 210
 211         out = StringIO()
 212         statistics.print_pmf(pmf_comp, out=out)
 213         lines = out.getvalue().splitlines()
 214         self.failUnlessEqual(lines[0], "i=0: 0.81")
 215         self.failUnlessEqual(lines[1], "i=1: 0.18")
 216         self.failUnlessEqual(lines[2], "i=2: 0.01")
 217
 218     def test_survival_pmf(self):
 219         f = statistics.survival_pmf
 220         # Cross-check binomial-distribution method against convolution
 221         # method.
 222         p_list = [.9999] * 100 + [.99] * 50 + [.8] * 20
 223         pmf1 = statistics.survival_pmf_via_conv(p_list)
 224         pmf2 = statistics.survival_pmf_via_bd(p_list)
 225         self.failUnlessListAlmostEqual(pmf1, pmf2)
 226         self.failUnlessTrue(statistics.valid_pmf(pmf1))
 227         self.should_assert("Should assert if p_i > 1", f, [1.1]);
 228         self.should_assert("Should assert if p_i < 0", f, [-.1]);
 229
 230     def test_repair_count_pmf(self):
 231         survival_pmf = statistics.binomial_distribution_pmf(5, .9)
 232         repair_pmf = statistics.repair_count_pmf(survival_pmf, 3)
 233         # repair_pmf[0] == sum(survival_pmf[0,1,2,5])
 234         # repair_pmf[1] == survival_pmf[4]
 235         # repair_pmf[2] = survival_pmf[3]
 236         self.failUnlessListAlmostEqual(repair_pmf,
 237                                        [0.00001 + 0.00045 + 0.0081 + 0.59049,
 238                                         .32805,
 239                                         .0729,
 240                                         0, 0, 0])
 241
 242     def test_repair_cost(self):
 243         survival_pmf = statistics.binomial_distribution_pmf(5, .9)
 244         bwcost = statistics.bandwidth_cost_function
 245         cost = statistics.mean_repair_cost(bwcost, 1000,
 246                                            survival_pmf, 3, ul_dl_ratio=1.0)
 247         self.failUnlessAlmostEqual(cost, 558.90)
 248         cost = statistics.mean_repair_cost(bwcost, 1000,
 249                                            survival_pmf, 3, ul_dl_ratio=8.0)
 250         self.failUnlessAlmostEqual(cost, 1664.55)
 251
 252         # I haven't manually checked the math beyond here -warner
 253         cost = statistics.eternal_repair_cost(bwcost, 1000,
 254                                               survival_pmf, 3,
 255                                               discount_rate=0, ul_dl_ratio=1.0)
 256         self.failUnlessAlmostEqual(cost, 65292.056074766246)
 257         cost = statistics.eternal_repair_cost(bwcost, 1000,
 258                                               survival_pmf, 3,
 259                                               discount_rate=0.05,
 260                                               ul_dl_ratio=1.0)
 261         self.failUnlessAlmostEqual(cost, 9133.6097158191551)
 262
 263     def test_convolve(self):
 264         f = statistics.convolve
 265         v1 = [ 1, 2, 3 ]
 266         v2 = [ 4, 5, 6 ]
 267         v3 = [ 7, 8 ]
 268         v1v2result = [ 4, 13, 28, 27, 18 ]
 269         # Convolution is commutative
 270         r1 = f(v1, v2)
 271         r2 = f(v2, v1)
 272         self.failUnlessListEqual(r1, r2, "Convolution should be commutative")
 273         self.failUnlessListEqual(r1, v1v2result, "Didn't match known result")
 274         # Convolution is associative
 275         r1 = f(f(v1, v2), v3)
 276         r2 = f(v1, f(v2, v3))
 277         self.failUnlessListEqual(r1, r2, "Convolution should be associative")
 278         # Convolution is distributive
 279         r1 = f(v3, [ a + b for a, b in zip(v1, v2) ])
 280         tmp1 = f(v3, v1)
 281         tmp2 = f(v3, v2)
 282         r2 = [ a + b for a, b in zip(tmp1, tmp2) ]
 283         self.failUnlessListEqual(r1, r2, "Convolution should be distributive")
 284         # Convolution is scalar multiplication associative
 285         tmp1 = f(v1, v2)
 286         r1 = [ a * 4 for a in tmp1 ]
 287         tmp2 = [ a * 4 for a in v1 ]
 288         r2 = f(tmp2, v2)
 289         self.failUnlessListEqual(r1, r2, "Convolution should be scalar multiplication associative")
 290
 291     def test_find_k(self):
 292         f = statistics.find_k
 293         g = statistics.pr_file_loss
 294         plist = [.9] * 10 + [.8] * 10 # N=20
 295         t = .0001
 296         k = f(plist, t)
 297         self.failUnlessEqual(k, 10)
 298         self.failUnless(g(plist, k) < t)
 299
 300     def test_pr_file_loss(self):
 301         f = statistics.pr_file_loss
 302         plist = [.5] * 10
 303         self.failUnlessEqual(f(plist, 3), .0546875)
 304
 305     def test_pr_backup_file_loss(self):
 306         f = statistics.pr_backup_file_loss
 307         plist = [.5] * 10
 308         self.failUnlessEqual(f(plist, .5, 3), .02734375)
 309
 310
 311 class Asserts(unittest.TestCase):
 312     def should_assert(self, func, *args, **kwargs):
 313         try:
 314             func(*args, **kwargs)
 315         except AssertionError, e:
 316             return str(e)
 317         except Exception, e:
 318             self.fail("assert failed with non-AssertionError: %s" % e)
 319         self.fail("assert was not caught")
 320
 321     def should_not_assert(self, func, *args, **kwargs):
 322         if "re" in kwargs:
 323             regexp = kwargs["re"]
 324             del kwargs["re"]
 325         try:
 326             func(*args, **kwargs)
 327         except AssertionError, e:
 328             self.fail("assertion fired when it should not have: %s" % e)
 329         except Exception, e:
 330             self.fail("assertion (which shouldn't have failed) failed with non-AssertionError: %s" % e)
 331         return # we're happy
 332
 333
 334     def test_assert(self):
 335         f = assertutil._assert
 336         self.should_assert(f)
 337         self.should_assert(f, False)
 338         self.should_not_assert(f, True)
 339
 340         m = self.should_assert(f, False, "message")
 341         self.failUnlessEqual(m, "'message' <type 'str'>", m)
 342         m = self.should_assert(f, False, "message1", othermsg=12)
 343         self.failUnlessEqual("'message1' <type 'str'>, othermsg: 12 <type 'int'>", m)
 344         m = self.should_assert(f, False, othermsg="message2")
 345         self.failUnlessEqual("othermsg: 'message2' <type 'str'>", m)
 346
 347     def test_precondition(self):
 348         f = assertutil.precondition
 349         self.should_assert(f)
 350         self.should_assert(f, False)
 351         self.should_not_assert(f, True)
 352
 353         m = self.should_assert(f, False, "message")
 354         self.failUnlessEqual("precondition: 'message' <type 'str'>", m)
 355         m = self.should_assert(f, False, "message1", othermsg=12)
 356         self.failUnlessEqual("precondition: 'message1' <type 'str'>, othermsg: 12 <type 'int'>", m)
 357         m = self.should_assert(f, False, othermsg="message2")
 358         self.failUnlessEqual("precondition: othermsg: 'message2' <type 'str'>", m)
 359
 360     def test_postcondition(self):
 361         f = assertutil.postcondition
 362         self.should_assert(f)
 363         self.should_assert(f, False)
 364         self.should_not_assert(f, True)
 365
 366         m = self.should_assert(f, False, "message")
 367         self.failUnlessEqual("postcondition: 'message' <type 'str'>", m)
 368         m = self.should_assert(f, False, "message1", othermsg=12)
 369         self.failUnlessEqual("postcondition: 'message1' <type 'str'>, othermsg: 12 <type 'int'>", m)
 370         m = self.should_assert(f, False, othermsg="message2")
 371         self.failUnlessEqual("postcondition: othermsg: 'message2' <type 'str'>", m)
 372
 373 class FileUtil(unittest.TestCase):
 374     def mkdir(self, basedir, path, mode=0777):
 375         fn = os.path.join(basedir, path)
 376         fileutil.make_dirs(fn, mode)
 377
 378     def touch(self, basedir, path, mode=None, data="touch\n"):
 379         fn = os.path.join(basedir, path)
 380         f = open(fn, "w")
 381         f.write(data)
 382         f.close()
 383         if mode is not None:
 384             os.chmod(fn, mode)
 385
 386     def test_rm_dir(self):
 387         basedir = "util/FileUtil/test_rm_dir"
 388         fileutil.make_dirs(basedir)
 389         # create it again to test idempotency
 390         fileutil.make_dirs(basedir)
 391         d = os.path.join(basedir, "doomed")
 392         self.mkdir(d, "a/b")
 393         self.touch(d, "a/b/1.txt")
 394         self.touch(d, "a/b/2.txt", 0444)
 395         self.touch(d, "a/b/3.txt", 0)
 396         self.mkdir(d, "a/c")
 397         self.touch(d, "a/c/1.txt")
 398         self.touch(d, "a/c/2.txt", 0444)
 399         self.touch(d, "a/c/3.txt", 0)
 400         os.chmod(os.path.join(d, "a/c"), 0444)
 401         self.mkdir(d, "a/d")
 402         self.touch(d, "a/d/1.txt")
 403         self.touch(d, "a/d/2.txt", 0444)
 404         self.touch(d, "a/d/3.txt", 0)
 405         os.chmod(os.path.join(d, "a/d"), 0)
 406
 407         fileutil.rm_dir(d)
 408         self.failIf(os.path.exists(d))
 409         # remove it again to test idempotency
 410         fileutil.rm_dir(d)
 411
 412     def test_remove_if_possible(self):
 413         basedir = "util/FileUtil/test_remove_if_possible"
 414         fileutil.make_dirs(basedir)
 415         self.touch(basedir, "here")
 416         fn = os.path.join(basedir, "here")
 417         fileutil.remove_if_possible(fn)
 418         self.failIf(os.path.exists(fn))
 419         fileutil.remove_if_possible(fn) # should be idempotent
 420         fileutil.rm_dir(basedir)
 421         fileutil.remove_if_possible(fn) # should survive errors
 422
 423     def test_open_or_create(self):
 424         basedir = "util/FileUtil/test_open_or_create"
 425         fileutil.make_dirs(basedir)
 426         fn = os.path.join(basedir, "here")
 427         f = fileutil.open_or_create(fn)
 428         f.write("stuff.")
 429         f.close()
 430         f = fileutil.open_or_create(fn)
 431         f.seek(0, 2)
 432         f.write("more.")
 433         f.close()
 434         f = open(fn, "r")
 435         data = f.read()
 436         f.close()
 437         self.failUnlessEqual(data, "stuff.more.")
 438
 439     def test_NamedTemporaryDirectory(self):
 440         basedir = "util/FileUtil/test_NamedTemporaryDirectory"
 441         fileutil.make_dirs(basedir)
 442         td = fileutil.NamedTemporaryDirectory(dir=basedir)
 443         name = td.name
 444         self.failUnless(basedir in name)
 445         self.failUnless(basedir in repr(td))
 446         self.failUnless(os.path.isdir(name))
 447         del td
 448         # it is conceivable that we need to force gc here, but I'm not sure
 449         self.failIf(os.path.isdir(name))
 450
 451     def test_rename(self):
 452         basedir = "util/FileUtil/test_rename"
 453         fileutil.make_dirs(basedir)
 454         self.touch(basedir, "here")
 455         fn = os.path.join(basedir, "here")
 456         fn2 = os.path.join(basedir, "there")
 457         fileutil.rename(fn, fn2)
 458         self.failIf(os.path.exists(fn))
 459         self.failUnless(os.path.exists(fn2))
 460
 461     def test_du(self):
 462         basedir = "util/FileUtil/test_du"
 463         fileutil.make_dirs(basedir)
 464         d = os.path.join(basedir, "space-consuming")
 465         self.mkdir(d, "a/b")
 466         self.touch(d, "a/b/1.txt", data="a"*10)
 467         self.touch(d, "a/b/2.txt", data="b"*11)
 468         self.mkdir(d, "a/c")
 469         self.touch(d, "a/c/1.txt", data="c"*12)
 470         self.touch(d, "a/c/2.txt", data="d"*13)
 471
 472         used = fileutil.du(basedir)
 473         self.failUnlessEqual(10+11+12+13, used)
 474
 475 class PollMixinTests(unittest.TestCase):
 476     def setUp(self):
 477         self.pm = pollmixin.PollMixin()
 478
 479     def test_PollMixin_True(self):
 480         d = self.pm.poll(check_f=lambda : True,
 481                          pollinterval=0.1)
 482         return d
 483
 484     def test_PollMixin_False_then_True(self):
 485         i = iter([False, True])
 486         d = self.pm.poll(check_f=i.next,
 487                          pollinterval=0.1)
 488         return d
 489
 490     def test_timeout(self):
 491         d = self.pm.poll(check_f=lambda: False,
 492                          pollinterval=0.01,
 493                          timeout=1)
 494         def _suc(res):
 495             self.fail("poll should have failed, not returned %s" % (res,))
 496         def _err(f):
 497             f.trap(pollmixin.TimeoutError)
 498             return None # success
 499         d.addCallbacks(_suc, _err)
 500         return d
 501
 502 class DeferredUtilTests(unittest.TestCase):
 503     def test_gather_results(self):
 504         d1 = defer.Deferred()
 505         d2 = defer.Deferred()
 506         res = deferredutil.gatherResults([d1, d2])
 507         d1.errback(ValueError("BAD"))
 508         def _callb(res):
 509             self.fail("Should have errbacked, not resulted in %s" % (res,))
 510         def _errb(thef):
 511             thef.trap(ValueError)
 512         res.addCallbacks(_callb, _errb)
 513         return res
 514
 515     def test_success(self):
 516         d1, d2 = defer.Deferred(), defer.Deferred()
 517         good = []
 518         bad = []
 519         dlss = deferredutil.DeferredListShouldSucceed([d1,d2])
 520         dlss.addCallbacks(good.append, bad.append)
 521         d1.callback(1)
 522         d2.callback(2)
 523         self.failUnlessEqual(good, [[1,2]])
 524         self.failUnlessEqual(bad, [])
 525
 526     def test_failure(self):
 527         d1, d2 = defer.Deferred(), defer.Deferred()
 528         good = []
 529         bad = []
 530         dlss = deferredutil.DeferredListShouldSucceed([d1,d2])
 531         dlss.addCallbacks(good.append, bad.append)
 532         d1.addErrback(lambda _ignore: None)
 533         d2.addErrback(lambda _ignore: None)
 534         d1.callback(1)
 535         d2.errback(ValueError())
 536         self.failUnlessEqual(good, [])
 537         self.failUnlessEqual(len(bad), 1)
 538         f = bad[0]
 539         self.failUnless(isinstance(f, Failure))
 540         self.failUnless(f.check(ValueError))
 541
 542 class HashUtilTests(unittest.TestCase):
 543
 544     def test_random_key(self):
 545         k = hashutil.random_key()
 546         self.failUnlessEqual(len(k), hashutil.KEYLEN)
 547
 548     def test_sha256d(self):
 549         h1 = hashutil.tagged_hash("tag1", "value")
 550         h2 = hashutil.tagged_hasher("tag1")
 551         h2.update("value")
 552         h2a = h2.digest()
 553         h2b = h2.digest()
 554         self.failUnlessEqual(h1, h2a)
 555         self.failUnlessEqual(h2a, h2b)
 556
 557     def test_sha256d_truncated(self):
 558         h1 = hashutil.tagged_hash("tag1", "value", 16)
 559         h2 = hashutil.tagged_hasher("tag1", 16)
 560         h2.update("value")
 561         h2 = h2.digest()
 562         self.failUnlessEqual(len(h1), 16)
 563         self.failUnlessEqual(len(h2), 16)
 564         self.failUnlessEqual(h1, h2)
 565
 566     def test_chk(self):
 567         h1 = hashutil.convergence_hash(3, 10, 1000, "data", "secret")
 568         h2 = hashutil.convergence_hasher(3, 10, 1000, "secret")
 569         h2.update("data")
 570         h2 = h2.digest()
 571         self.failUnlessEqual(h1, h2)
 572
 573     def test_hashers(self):
 574         h1 = hashutil.block_hash("foo")
 575         h2 = hashutil.block_hasher()
 576         h2.update("foo")
 577         self.failUnlessEqual(h1, h2.digest())
 578
 579         h1 = hashutil.uri_extension_hash("foo")
 580         h2 = hashutil.uri_extension_hasher()
 581         h2.update("foo")
 582         self.failUnlessEqual(h1, h2.digest())
 583
 584         h1 = hashutil.plaintext_hash("foo")
 585         h2 = hashutil.plaintext_hasher()
 586         h2.update("foo")
 587         self.failUnlessEqual(h1, h2.digest())
 588
 589         h1 = hashutil.crypttext_hash("foo")
 590         h2 = hashutil.crypttext_hasher()
 591         h2.update("foo")
 592         self.failUnlessEqual(h1, h2.digest())
 593
 594         h1 = hashutil.crypttext_segment_hash("foo")
 595         h2 = hashutil.crypttext_segment_hasher()
 596         h2.update("foo")
 597         self.failUnlessEqual(h1, h2.digest())
 598
 599         h1 = hashutil.plaintext_segment_hash("foo")
 600         h2 = hashutil.plaintext_segment_hasher()
 601         h2.update("foo")
 602         self.failUnlessEqual(h1, h2.digest())
 603
 604     def test_constant_time_compare(self):
 605         self.failUnless(hashutil.constant_time_compare("a", "a"))
 606         self.failUnless(hashutil.constant_time_compare("ab", "ab"))
 607         self.failIf(hashutil.constant_time_compare("a", "b"))
 608         self.failIf(hashutil.constant_time_compare("a", "aa"))
 609
 610 class Abbreviate(unittest.TestCase):
 611     def test_time(self):
 612         a = abbreviate.abbreviate_time
 613         self.failUnlessEqual(a(None), "unknown")
 614         self.failUnlessEqual(a(0), "0 seconds")
 615         self.failUnlessEqual(a(1), "1 second")
 616         self.failUnlessEqual(a(2), "2 seconds")
 617         self.failUnlessEqual(a(119), "119 seconds")
 618         MIN = 60
 619         self.failUnlessEqual(a(2*MIN), "2 minutes")
 620         self.failUnlessEqual(a(60*MIN), "60 minutes")
 621         self.failUnlessEqual(a(179*MIN), "179 minutes")
 622         HOUR = 60*MIN
 623         self.failUnlessEqual(a(180*MIN), "3 hours")
 624         self.failUnlessEqual(a(4*HOUR), "4 hours")
 625         DAY = 24*HOUR
 626         MONTH = 30*DAY
 627         self.failUnlessEqual(a(2*DAY), "2 days")
 628         self.failUnlessEqual(a(2*MONTH), "2 months")
 629         YEAR = 365*DAY
 630         self.failUnlessEqual(a(5*YEAR), "5 years")
 631
 632     def test_space(self):
 633         tests_si = [(None, "unknown"),
 634                     (0, "0 B"),
 635                     (1, "1 B"),
 636                     (999, "999 B"),
 637                     (1000, "1000 B"),
 638                     (1023, "1023 B"),
 639                     (1024, "1.02 kB"),
 640                     (20*1000, "20.00 kB"),
 641                     (1024*1024, "1.05 MB"),
 642                     (1000*1000, "1.00 MB"),
 643                     (1000*1000*1000, "1.00 GB"),
 644                     (1000*1000*1000*1000, "1.00 TB"),
 645                     (1000*1000*1000*1000*1000, "1.00 PB"),
 646                     (1234567890123456, "1.23 PB"),
 647                     ]
 648         for (x, expected) in tests_si:
 649             got = abbreviate.abbreviate_space(x, SI=True)
 650             self.failUnlessEqual(got, expected)
 651
 652         tests_base1024 = [(None, "unknown"),
 653                           (0, "0 B"),
 654                           (1, "1 B"),
 655                           (999, "999 B"),
 656                           (1000, "1000 B"),
 657                           (1023, "1023 B"),
 658                           (1024, "1.00 kiB"),
 659                           (20*1024, "20.00 kiB"),
 660                           (1000*1000, "976.56 kiB"),
 661                           (1024*1024, "1.00 MiB"),
 662                           (1024*1024*1024, "1.00 GiB"),
 663                           (1024*1024*1024*1024, "1.00 TiB"),
 664                           (1000*1000*1000*1000*1000, "909.49 TiB"),
 665                           (1024*1024*1024*1024*1024, "1.00 PiB"),
 666                           (1234567890123456, "1.10 PiB"),
 667                     ]
 668         for (x, expected) in tests_base1024:
 669             got = abbreviate.abbreviate_space(x, SI=False)
 670             self.failUnlessEqual(got, expected)
 671
 672         self.failUnlessEqual(abbreviate.abbreviate_space_both(1234567),
 673                              "(1.23 MB, 1.18 MiB)")
 674
 675     def test_parse_space(self):
 676         p = abbreviate.parse_abbreviated_size
 677         self.failUnlessEqual(p(""), None)
 678         self.failUnlessEqual(p(None), None)
 679         self.failUnlessEqual(p("123"), 123)
 680         self.failUnlessEqual(p("123B"), 123)
 681         self.failUnlessEqual(p("2K"), 2000)
 682         self.failUnlessEqual(p("2kb"), 2000)
 683         self.failUnlessEqual(p("2KiB"), 2048)
 684         self.failUnlessEqual(p("10MB"), 10*1000*1000)
 685         self.failUnlessEqual(p("10MiB"), 10*1024*1024)
 686         self.failUnlessEqual(p("5G"), 5*1000*1000*1000)
 687         self.failUnlessEqual(p("4GiB"), 4*1024*1024*1024)
 688         e = self.failUnlessRaises(ValueError, p, "12 cubits")
 689         self.failUnless("12 cubits" in str(e))
 690
 691 class Limiter(unittest.TestCase):
 692     def job(self, i, foo):
 693         self.calls.append( (i, foo) )
 694         self.simultaneous += 1
 695         self.peak_simultaneous = max(self.simultaneous, self.peak_simultaneous)
 696         d = defer.Deferred()
 697         def _done():
 698             self.simultaneous -= 1
 699             d.callback("done %d" % i)
 700         reactor.callLater(1.0, _done)
 701         return d
 702
 703     def bad_job(self, i, foo):
 704         raise ValueError("bad_job %d" % i)
 705
 706     def test_limiter(self):
 707         self.calls = []
 708         self.simultaneous = 0
 709         self.peak_simultaneous = 0
 710         l = limiter.ConcurrencyLimiter()
 711         dl = []
 712         for i in range(20):
 713             dl.append(l.add(self.job, i, foo=str(i)))
 714         d = defer.DeferredList(dl, fireOnOneErrback=True)
 715         def _done(res):
 716             self.failUnlessEqual(self.simultaneous, 0)
 717             self.failUnless(self.peak_simultaneous <= 10)
 718             self.failUnlessEqual(len(self.calls), 20)
 719             for i in range(20):
 720                 self.failUnless( (i, str(i)) in self.calls)
 721         d.addCallback(_done)
 722         return d
 723
 724     def test_errors(self):
 725         self.calls = []
 726         self.simultaneous = 0
 727         self.peak_simultaneous = 0
 728         l = limiter.ConcurrencyLimiter()
 729         dl = []
 730         for i in range(20):
 731             dl.append(l.add(self.job, i, foo=str(i)))
 732         d2 = l.add(self.bad_job, 21, "21")
 733         d = defer.DeferredList(dl, fireOnOneErrback=True)
 734         def _most_done(res):
 735             results = []
 736             for (success, result) in res:
 737                 self.failUnlessEqual(success, True)
 738                 results.append(result)
 739             results.sort()
 740             expected_results = ["done %d" % i for i in range(20)]
 741             expected_results.sort()
 742             self.failUnlessEqual(results, expected_results)
 743             self.failUnless(self.peak_simultaneous <= 10)
 744             self.failUnlessEqual(len(self.calls), 20)
 745             for i in range(20):
 746                 self.failUnless( (i, str(i)) in self.calls)
 747             def _good(res):
 748                 self.fail("should have failed, not got %s" % (res,))
 749             def _err(f):
 750                 f.trap(ValueError)
 751                 self.failUnless("bad_job 21" in str(f))
 752             d2.addCallbacks(_good, _err)
 753             return d2
 754         d.addCallback(_most_done)
 755         def _all_done(res):
 756             self.failUnlessEqual(self.simultaneous, 0)
 757             self.failUnless(self.peak_simultaneous <= 10)
 758             self.failUnlessEqual(len(self.calls), 20)
 759             for i in range(20):
 760                 self.failUnless( (i, str(i)) in self.calls)
 761         d.addCallback(_all_done)
 762         return d
 763
 764 class TimeFormat(unittest.TestCase):
 765     def test_epoch(self):
 766         s = time_format.iso_utc_time_to_seconds("1970-01-01T00:00:01")
 767         self.failUnlessEqual(s, 1.0)
 768         s = time_format.iso_utc_time_to_seconds("1970-01-01_00:00:01")
 769         self.failUnlessEqual(s, 1.0)
 770         s = time_format.iso_utc_time_to_seconds("1970-01-01 00:00:01")
 771         self.failUnlessEqual(s, 1.0)
 772
 773         self.failUnlessEqual(time_format.iso_utc(1.0), "1970-01-01_00:00:01")
 774         self.failUnlessEqual(time_format.iso_utc(1.0, sep=" "),
 775                              "1970-01-01 00:00:01")
 776
 777         now = time.time()
 778         isostr = time_format.iso_utc(now)
 779         timestamp = time_format.iso_utc_time_to_seconds(isostr)
 780         self.failUnlessEqual(int(timestamp), int(now))
 781
 782         def my_time():
 783             return 1.0
 784         self.failUnlessEqual(time_format.iso_utc(t=my_time),
 785                              "1970-01-01_00:00:01")
 786         e = self.failUnlessRaises(ValueError,
 787                                   time_format.iso_utc_time_to_seconds,
 788                                   "invalid timestring")
 789         self.failUnless("not a complete ISO8601 timestamp" in str(e))
 790         s = time_format.iso_utc_time_to_seconds("1970-01-01_00:00:01.500")
 791         self.failUnlessEqual(s, 1.5)
 792
 793         # Look for daylight-savings-related errors.
 794         thatmomentinmarch = time_format.iso_utc_time_to_seconds("2009-03-20 21:49:02.226536")
 795         self.failUnlessEqual(thatmomentinmarch, 1237585742.226536)
 796
 797 class CacheDir(unittest.TestCase):
 798     def test_basic(self):
 799         basedir = "test_util/CacheDir/test_basic"
 800
 801         def _failIfExists(name):
 802             absfn = os.path.join(basedir, name)
 803             self.failIf(os.path.exists(absfn),
 804                         "%s exists but it shouldn't" % absfn)
 805
 806         def _failUnlessExists(name):
 807             absfn = os.path.join(basedir, name)
 808             self.failUnless(os.path.exists(absfn),
 809                             "%s doesn't exist but it should" % absfn)
 810
 811         cdm = cachedir.CacheDirectoryManager(basedir)
 812         a = cdm.get_file("a")
 813         b = cdm.get_file("b")
 814         c = cdm.get_file("c")
 815         f = open(a.get_filename(), "wb"); f.write("hi"); f.close(); del f
 816         f = open(b.get_filename(), "wb"); f.write("hi"); f.close(); del f
 817         f = open(c.get_filename(), "wb"); f.write("hi"); f.close(); del f
 818
 819         _failUnlessExists("a")
 820         _failUnlessExists("b")
 821         _failUnlessExists("c")
 822
 823         cdm.check()
 824
 825         _failUnlessExists("a")
 826         _failUnlessExists("b")
 827         _failUnlessExists("c")
 828
 829         del a
 830         # this file won't be deleted yet, because it isn't old enough
 831         cdm.check()
 832         _failUnlessExists("a")
 833         _failUnlessExists("b")
 834         _failUnlessExists("c")
 835
 836         # we change the definition of "old" to make everything old
 837         cdm.old = -10
 838
 839         cdm.check()
 840         _failIfExists("a")
 841         _failUnlessExists("b")
 842         _failUnlessExists("c")
 843
 844         cdm.old = 60*60
 845
 846         del b
 847
 848         cdm.check()
 849         _failIfExists("a")
 850         _failUnlessExists("b")
 851         _failUnlessExists("c")
 852
 853         b2 = cdm.get_file("b")
 854
 855         cdm.check()
 856         _failIfExists("a")
 857         _failUnlessExists("b")
 858         _failUnlessExists("c")
 859
 860 ctr = [0]
 861 class EqButNotIs:
 862     def __init__(self, x):
 863         self.x = x
 864         self.hash = ctr[0]
 865         ctr[0] += 1
 866     def __repr__(self):
 867         return "<%s %s>" % (self.__class__.__name__, self.x,)
 868     def __hash__(self):
 869         return self.hash
 870     def __le__(self, other):
 871         return self.x <= other
 872     def __lt__(self, other):
 873         return self.x < other
 874     def __ge__(self, other):
 875         return self.x >= other
 876     def __gt__(self, other):
 877         return self.x > other
 878     def __ne__(self, other):
 879         return self.x != other
 880     def __eq__(self, other):
 881         return self.x == other
 882
 883 class DictUtil(unittest.TestCase):
 884     def _help_test_empty_dict(self, klass):
 885         d1 = klass()
 886         d2 = klass({})
 887
 888         self.failUnless(d1 == d2, "d1: %r, d2: %r" % (d1, d2,))
 889         self.failUnless(len(d1) == 0)
 890         self.failUnless(len(d2) == 0)
 891
 892     def _help_test_nonempty_dict(self, klass):
 893         d1 = klass({'a': 1, 'b': "eggs", 3: "spam",})
 894         d2 = klass({'a': 1, 'b': "eggs", 3: "spam",})
 895
 896         self.failUnless(d1 == d2)
 897         self.failUnless(len(d1) == 3, "%s, %s" % (len(d1), d1,))
 898         self.failUnless(len(d2) == 3)
 899
 900     def _help_test_eq_but_notis(self, klass):
 901         d = klass({'a': 3, 'b': EqButNotIs(3), 'c': 3})
 902         d.pop('b')
 903
 904         d.clear()
 905         d['a'] = 3
 906         d['b'] = EqButNotIs(3)
 907         d['c'] = 3
 908         d.pop('b')
 909
 910         d.clear()
 911         d['b'] = EqButNotIs(3)
 912         d['a'] = 3
 913         d['c'] = 3
 914         d.pop('b')
 915
 916         d.clear()
 917         d['a'] = EqButNotIs(3)
 918         d['c'] = 3
 919         d['a'] = 3
 920
 921         d.clear()
 922         fake3 = EqButNotIs(3)
 923         fake7 = EqButNotIs(7)
 924         d[fake3] = fake7
 925         d[3] = 7
 926         d[3] = 8
 927         self.failUnless(filter(lambda x: x is 8,  d.itervalues()))
 928         self.failUnless(filter(lambda x: x is fake7,  d.itervalues()))
 929         # The real 7 should have been ejected by the d[3] = 8.
 930         self.failUnless(not filter(lambda x: x is 7,  d.itervalues()))
 931         self.failUnless(filter(lambda x: x is fake3,  d.iterkeys()))
 932         self.failUnless(filter(lambda x: x is 3,  d.iterkeys()))
 933         d[fake3] = 8
 934
 935         d.clear()
 936         d[3] = 7
 937         fake3 = EqButNotIs(3)
 938         fake7 = EqButNotIs(7)
 939         d[fake3] = fake7
 940         d[3] = 8
 941         self.failUnless(filter(lambda x: x is 8,  d.itervalues()))
 942         self.failUnless(filter(lambda x: x is fake7,  d.itervalues()))
 943         # The real 7 should have been ejected by the d[3] = 8.
 944         self.failUnless(not filter(lambda x: x is 7,  d.itervalues()))
 945         self.failUnless(filter(lambda x: x is fake3,  d.iterkeys()))
 946         self.failUnless(filter(lambda x: x is 3,  d.iterkeys()))
 947         d[fake3] = 8
 948
 949     def test_all(self):
 950         self._help_test_eq_but_notis(dictutil.UtilDict)
 951         self._help_test_eq_but_notis(dictutil.NumDict)
 952         self._help_test_eq_but_notis(dictutil.ValueOrderedDict)
 953         self._help_test_nonempty_dict(dictutil.UtilDict)
 954         self._help_test_nonempty_dict(dictutil.NumDict)
 955         self._help_test_nonempty_dict(dictutil.ValueOrderedDict)
 956         self._help_test_eq_but_notis(dictutil.UtilDict)
 957         self._help_test_eq_but_notis(dictutil.NumDict)
 958         self._help_test_eq_but_notis(dictutil.ValueOrderedDict)
 959
 960     def test_dict_of_sets(self):
 961         ds = dictutil.DictOfSets()
 962         ds.add(1, "a")
 963         ds.add(2, "b")
 964         ds.add(2, "b")
 965         ds.add(2, "c")
 966         self.failUnlessEqual(ds[1], set(["a"]))
 967         self.failUnlessEqual(ds[2], set(["b", "c"]))
 968         ds.discard(3, "d") # should not raise an exception
 969         ds.discard(2, "b")
 970         self.failUnlessEqual(ds[2], set(["c"]))
 971         ds.discard(2, "c")
 972         self.failIf(2 in ds)
 973
 974         ds.union(1, ["a", "e"])
 975         ds.union(3, ["f"])
 976         self.failUnlessEqual(ds[1], set(["a","e"]))
 977         self.failUnlessEqual(ds[3], set(["f"]))
 978         ds2 = dictutil.DictOfSets()
 979         ds2.add(3, "f")
 980         ds2.add(3, "g")
 981         ds2.add(4, "h")
 982         ds.update(ds2)
 983         self.failUnlessEqual(ds[1], set(["a","e"]))
 984         self.failUnlessEqual(ds[3], set(["f", "g"]))
 985         self.failUnlessEqual(ds[4], set(["h"]))
 986
 987     def test_move(self):
 988         d1 = {1: "a", 2: "b"}
 989         d2 = {2: "c", 3: "d"}
 990         dictutil.move(1, d1, d2)
 991         self.failUnlessEqual(d1, {2: "b"})
 992         self.failUnlessEqual(d2, {1: "a", 2: "c", 3: "d"})
 993
 994         d1 = {1: "a", 2: "b"}
 995         d2 = {2: "c", 3: "d"}
 996         dictutil.move(2, d1, d2)
 997         self.failUnlessEqual(d1, {1: "a"})
 998         self.failUnlessEqual(d2, {2: "b", 3: "d"})
 999
1000         d1 = {1: "a", 2: "b"}
1001         d2 = {2: "c", 3: "d"}
1002         self.failUnlessRaises(KeyError, dictutil.move, 5, d1, d2, strict=True)
1003
1004     def test_subtract(self):
1005         d1 = {1: "a", 2: "b"}
1006         d2 = {2: "c", 3: "d"}
1007         d3 = dictutil.subtract(d1, d2)
1008         self.failUnlessEqual(d3, {1: "a"})
1009
1010         d1 = {1: "a", 2: "b"}
1011         d2 = {2: "c"}
1012         d3 = dictutil.subtract(d1, d2)
1013         self.failUnlessEqual(d3, {1: "a"})
1014
1015     def test_utildict(self):
1016         d = dictutil.UtilDict({1: "a", 2: "b"})
1017         d.del_if_present(1)
1018         d.del_if_present(3)
1019         self.failUnlessEqual(d, {2: "b"})
1020         def eq(a, b):
1021             return a == b
1022         self.failUnlessRaises(TypeError, eq, d, "not a dict")
1023
1024         d = dictutil.UtilDict({1: "b", 2: "a"})
1025         self.failUnlessEqual(d.items_sorted_by_value(),
1026                              [(2, "a"), (1, "b")])
1027         self.failUnlessEqual(d.items_sorted_by_key(),
1028                              [(1, "b"), (2, "a")])
1029         self.failUnlessEqual(repr(d), "{1: 'b', 2: 'a'}")
1030         self.failUnless(1 in d)
1031
1032         d2 = dictutil.UtilDict({3: "c", 4: "d"})
1033         self.failUnless(d != d2)
1034         self.failUnless(d2 > d)
1035         self.failUnless(d2 >= d)
1036         self.failUnless(d <= d2)
1037         self.failUnless(d < d2)
1038         self.failUnlessEqual(d[1], "b")
1039         self.failUnlessEqual(sorted(list([k for k in d])), [1,2])
1040
1041         d3 = d.copy()
1042         self.failUnlessEqual(d, d3)
1043         self.failUnless(isinstance(d3, dictutil.UtilDict))
1044
1045         d4 = d.fromkeys([3,4], "e")
1046         self.failUnlessEqual(d4, {3: "e", 4: "e"})
1047
1048         self.failUnlessEqual(d.get(1), "b")
1049         self.failUnlessEqual(d.get(3), None)
1050         self.failUnlessEqual(d.get(3, "default"), "default")
1051         self.failUnlessEqual(sorted(list(d.items())),
1052                              [(1, "b"), (2, "a")])
1053         self.failUnlessEqual(sorted(list(d.iteritems())),
1054                              [(1, "b"), (2, "a")])
1055         self.failUnlessEqual(sorted(d.keys()), [1, 2])
1056         self.failUnlessEqual(sorted(d.values()), ["a", "b"])
1057         x = d.setdefault(1, "new")
1058         self.failUnlessEqual(x, "b")
1059         self.failUnlessEqual(d[1], "b")
1060         x = d.setdefault(3, "new")
1061         self.failUnlessEqual(x, "new")
1062         self.failUnlessEqual(d[3], "new")
1063         del d[3]
1064
1065         x = d.popitem()
1066         self.failUnless(x in [(1, "b"), (2, "a")])
1067         x = d.popitem()
1068         self.failUnless(x in [(1, "b"), (2, "a")])
1069         self.failUnlessRaises(KeyError, d.popitem)
1070
1071     def test_numdict(self):
1072         d = dictutil.NumDict({"a": 1, "b": 2})
1073
1074         d.add_num("a", 10, 5)
1075         d.add_num("c", 20, 5)
1076         d.add_num("d", 30)
1077         self.failUnlessEqual(d, {"a": 11, "b": 2, "c": 25, "d": 30})
1078
1079         d.subtract_num("a", 10)
1080         d.subtract_num("e", 10)
1081         d.subtract_num("f", 10, 15)
1082         self.failUnlessEqual(d, {"a": 1, "b": 2, "c": 25, "d": 30,
1083                                  "e": -10, "f": 5})
1084
1085         self.failUnlessEqual(d.sum(), sum([1, 2, 25, 30, -10, 5]))
1086
1087         d = dictutil.NumDict()
1088         d.inc("a")
1089         d.inc("a")
1090         d.inc("b", 5)
1091         self.failUnlessEqual(d, {"a": 2, "b": 6})
1092         d.dec("a")
1093         d.dec("c")
1094         d.dec("d", 5)
1095         self.failUnlessEqual(d, {"a": 1, "b": 6, "c": -1, "d": 4})
1096         self.failUnlessEqual(d.items_sorted_by_key(),
1097                              [("a", 1), ("b", 6), ("c", -1), ("d", 4)])
1098         self.failUnlessEqual(d.items_sorted_by_value(),
1099                              [("c", -1), ("a", 1), ("d", 4), ("b", 6)])
1100         self.failUnlessEqual(d.item_with_largest_value(), ("b", 6))
1101
1102         d = dictutil.NumDict({"a": 1, "b": 2})
1103         self.failUnlessEqual(repr(d), "{'a': 1, 'b': 2}")
1104         self.failUnless("a" in d)
1105
1106         d2 = dictutil.NumDict({"c": 3, "d": 4})
1107         self.failUnless(d != d2)
1108         self.failUnless(d2 > d)
1109         self.failUnless(d2 >= d)
1110         self.failUnless(d <= d2)
1111         self.failUnless(d < d2)
1112         self.failUnlessEqual(d["a"], 1)
1113         self.failUnlessEqual(sorted(list([k for k in d])), ["a","b"])
1114         def eq(a, b):
1115             return a == b
1116         self.failUnlessRaises(TypeError, eq, d, "not a dict")
1117
1118         d3 = d.copy()
1119         self.failUnlessEqual(d, d3)
1120         self.failUnless(isinstance(d3, dictutil.NumDict))
1121
1122         d4 = d.fromkeys(["a","b"], 5)
1123         self.failUnlessEqual(d4, {"a": 5, "b": 5})
1124
1125         self.failUnlessEqual(d.get("a"), 1)
1126         self.failUnlessEqual(d.get("c"), 0)
1127         self.failUnlessEqual(d.get("c", 5), 5)
1128         self.failUnlessEqual(sorted(list(d.items())),
1129                              [("a", 1), ("b", 2)])
1130         self.failUnlessEqual(sorted(list(d.iteritems())),
1131                              [("a", 1), ("b", 2)])
1132         self.failUnlessEqual(sorted(d.keys()), ["a", "b"])
1133         self.failUnlessEqual(sorted(d.values()), [1, 2])
1134         self.failUnless(d.has_key("a"))
1135         self.failIf(d.has_key("c"))
1136
1137         x = d.setdefault("c", 3)
1138         self.failUnlessEqual(x, 3)
1139         self.failUnlessEqual(d["c"], 3)
1140         x = d.setdefault("c", 5)
1141         self.failUnlessEqual(x, 3)
1142         self.failUnlessEqual(d["c"], 3)
1143         del d["c"]
1144
1145         x = d.popitem()
1146         self.failUnless(x in [("a", 1), ("b", 2)])
1147         x = d.popitem()
1148         self.failUnless(x in [("a", 1), ("b", 2)])
1149         self.failUnlessRaises(KeyError, d.popitem)
1150
1151         d.update({"c": 3})
1152         d.update({"c": 4, "d": 5})
1153         self.failUnlessEqual(d, {"c": 4, "d": 5})
1154
1155     def test_del_if_present(self):
1156         d = {1: "a", 2: "b"}
1157         dictutil.del_if_present(d, 1)
1158         dictutil.del_if_present(d, 3)
1159         self.failUnlessEqual(d, {2: "b"})
1160
1161     def test_valueordereddict(self):
1162         d = dictutil.ValueOrderedDict()
1163         d["a"] = 3
1164         d["b"] = 2
1165         d["c"] = 1
1166
1167         self.failUnlessEqual(d, {"a": 3, "b": 2, "c": 1})
1168         self.failUnlessEqual(d.items(), [("c", 1), ("b", 2), ("a", 3)])
1169         self.failUnlessEqual(d.values(), [1, 2, 3])
1170         self.failUnlessEqual(d.keys(), ["c", "b", "a"])
1171         self.failUnlessEqual(repr(d), "<ValueOrderedDict {c: 1, b: 2, a: 3}>")
1172         def eq(a, b):
1173             return a == b
1174         self.failIf(d == {"a": 4})
1175         self.failUnless(d != {"a": 4})
1176
1177         x = d.setdefault("d", 0)
1178         self.failUnlessEqual(x, 0)
1179         self.failUnlessEqual(d["d"], 0)
1180         x = d.setdefault("d", -1)
1181         self.failUnlessEqual(x, 0)
1182         self.failUnlessEqual(d["d"], 0)
1183
1184         x = d.remove("e", "default", False)
1185         self.failUnlessEqual(x, "default")
1186         self.failUnlessRaises(KeyError, d.remove, "e", "default", True)
1187         x = d.remove("d", 5)
1188         self.failUnlessEqual(x, 0)
1189
1190         x = d.__getitem__("c")
1191         self.failUnlessEqual(x, 1)
1192         x = d.__getitem__("e", "default", False)
1193         self.failUnlessEqual(x, "default")
1194         self.failUnlessRaises(KeyError, d.__getitem__, "e", "default", True)
1195
1196         self.failUnlessEqual(d.popitem(), ("c", 1))
1197         self.failUnlessEqual(d.popitem(), ("b", 2))
1198         self.failUnlessEqual(d.popitem(), ("a", 3))
1199         self.failUnlessRaises(KeyError, d.popitem)
1200
1201         d = dictutil.ValueOrderedDict({"a": 3, "b": 2, "c": 1})
1202         x = d.pop("d", "default", False)
1203         self.failUnlessEqual(x, "default")
1204         self.failUnlessRaises(KeyError, d.pop, "d", "default", True)
1205         x = d.pop("b")
1206         self.failUnlessEqual(x, 2)
1207         self.failUnlessEqual(d.items(), [("c", 1), ("a", 3)])
1208
1209         d = dictutil.ValueOrderedDict({"a": 3, "b": 2, "c": 1})
1210         x = d.pop_from_list(1) # pop the second item, b/2
1211         self.failUnlessEqual(x, "b")
1212         self.failUnlessEqual(d.items(), [("c", 1), ("a", 3)])
1213
1214 class Pipeline(unittest.TestCase):
1215     def pause(self, *args, **kwargs):
1216         d = defer.Deferred()
1217         self.calls.append( (d, args, kwargs) )
1218         return d
1219
1220     def failUnlessCallsAre(self, expected):
1221         #print self.calls
1222         #print expected
1223         self.failUnlessEqual(len(self.calls), len(expected), self.calls)
1224         for i,c in enumerate(self.calls):
1225             self.failUnlessEqual(c[1:], expected[i], str(i))
1226
1227     def test_basic(self):
1228         self.calls = []
1229         finished = []
1230         p = pipeline.Pipeline(100)
1231
1232         d = p.flush() # fires immediately
1233         d.addCallbacks(finished.append, log.err)
1234         self.failUnlessEqual(len(finished), 1)
1235         finished = []
1236
1237         d = p.add(10, self.pause, "one")
1238         # the call should start right away, and our return Deferred should
1239         # fire right away
1240         d.addCallbacks(finished.append, log.err)
1241         self.failUnlessEqual(len(finished), 1)
1242         self.failUnlessEqual(finished[0], None)
1243         self.failUnlessCallsAre([ ( ("one",) , {} ) ])
1244         self.failUnlessEqual(p.gauge, 10)
1245
1246         # pipeline: [one]
1247
1248         finished = []
1249         d = p.add(20, self.pause, "two", kw=2)
1250         # pipeline: [one, two]
1251
1252         # the call and the Deferred should fire right away
1253         d.addCallbacks(finished.append, log.err)
1254         self.failUnlessEqual(len(finished), 1)
1255         self.failUnlessEqual(finished[0], None)
1256         self.failUnlessCallsAre([ ( ("one",) , {} ),
1257                                   ( ("two",) , {"kw": 2} ),
1258                                   ])
1259         self.failUnlessEqual(p.gauge, 30)
1260
1261         self.calls[0][0].callback("one-result")
1262         # pipeline: [two]
1263         self.failUnlessEqual(p.gauge, 20)
1264
1265         finished = []
1266         d = p.add(90, self.pause, "three", "posarg1")
1267         # pipeline: [two, three]
1268         flushed = []
1269         fd = p.flush()
1270         fd.addCallbacks(flushed.append, log.err)
1271         self.failUnlessEqual(flushed, [])
1272
1273         # the call will be made right away, but the return Deferred will not,
1274         # because the pipeline is now full.
1275         d.addCallbacks(finished.append, log.err)
1276         self.failUnlessEqual(len(finished), 0)
1277         self.failUnlessCallsAre([ ( ("one",) , {} ),
1278                                   ( ("two",) , {"kw": 2} ),
1279                                   ( ("three", "posarg1"), {} ),
1280                                   ])
1281         self.failUnlessEqual(p.gauge, 110)
1282
1283         self.failUnlessRaises(pipeline.SingleFileError, p.add, 10, self.pause)
1284
1285         # retiring either call will unblock the pipeline, causing the #3
1286         # Deferred to fire
1287         self.calls[2][0].callback("three-result")
1288         # pipeline: [two]
1289
1290         self.failUnlessEqual(len(finished), 1)
1291         self.failUnlessEqual(finished[0], None)
1292         self.failUnlessEqual(flushed, [])
1293
1294         # retiring call#2 will finally allow the flush() Deferred to fire
1295         self.calls[1][0].callback("two-result")
1296         self.failUnlessEqual(len(flushed), 1)
1297
1298     def test_errors(self):
1299         self.calls = []
1300         p = pipeline.Pipeline(100)
1301
1302         d1 = p.add(200, self.pause, "one")
1303         d2 = p.flush()
1304
1305         finished = []
1306         d1.addBoth(finished.append)
1307         self.failUnlessEqual(finished, [])
1308
1309         flushed = []
1310         d2.addBoth(flushed.append)
1311         self.failUnlessEqual(flushed, [])
1312
1313         self.calls[0][0].errback(ValueError("oops"))
1314
1315         self.failUnlessEqual(len(finished), 1)
1316         f = finished[0]
1317         self.failUnless(isinstance(f, Failure))
1318         self.failUnless(f.check(pipeline.PipelineError))
1319         r = repr(f.value)
1320         self.failUnless("ValueError" in r, r)
1321         f2 = f.value.error
1322         self.failUnless(f2.check(ValueError))
1323
1324         self.failUnlessEqual(len(flushed), 1)
1325         f = flushed[0]
1326         self.failUnless(isinstance(f, Failure))
1327         self.failUnless(f.check(pipeline.PipelineError))
1328         f2 = f.value.error
1329         self.failUnless(f2.check(ValueError))
1330
1331         # now that the pipeline is in the failed state, any new calls will
1332         # fail immediately
1333
1334         d3 = p.add(20, self.pause, "two")
1335
1336         finished = []
1337         d3.addBoth(finished.append)
1338         self.failUnlessEqual(len(finished), 1)
1339         f = finished[0]
1340         self.failUnless(isinstance(f, Failure))
1341         self.failUnless(f.check(pipeline.PipelineError))
1342         r = repr(f.value)
1343         self.failUnless("ValueError" in r, r)
1344         f2 = f.value.error
1345         self.failUnless(f2.check(ValueError))
1346
1347         d4 = p.flush()
1348         flushed = []
1349         d4.addBoth(flushed.append)
1350         self.failUnlessEqual(len(flushed), 1)
1351         f = flushed[0]
1352         self.failUnless(isinstance(f, Failure))
1353         self.failUnless(f.check(pipeline.PipelineError))
1354         f2 = f.value.error
1355         self.failUnless(f2.check(ValueError))
1356
1357     def test_errors2(self):
1358         self.calls = []
1359         p = pipeline.Pipeline(100)
1360
1361         d1 = p.add(10, self.pause, "one")
1362         d2 = p.add(20, self.pause, "two")
1363         d3 = p.add(30, self.pause, "three")
1364         d4 = p.flush()
1365
1366         # one call fails, then the second one succeeds: make sure
1367         # ExpandableDeferredList tolerates the second one
1368
1369         flushed = []
1370         d4.addBoth(flushed.append)
1371         self.failUnlessEqual(flushed, [])
1372
1373         self.calls[0][0].errback(ValueError("oops"))
1374         self.failUnlessEqual(len(flushed), 1)
1375         f = flushed[0]
1376         self.failUnless(isinstance(f, Failure))
1377         self.failUnless(f.check(pipeline.PipelineError))
1378         f2 = f.value.error
1379         self.failUnless(f2.check(ValueError))
1380
1381         self.calls[1][0].callback("two-result")
1382         self.calls[2][0].errback(ValueError("three-error"))