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     timeout = 480 # This takes longer than 240 seconds on Francois's arm box.
 693
 694     def job(self, i, foo):
 695         self.calls.append( (i, foo) )
 696         self.simultaneous += 1
 697         self.peak_simultaneous = max(self.simultaneous, self.peak_simultaneous)
 698         d = defer.Deferred()
 699         def _done():
 700             self.simultaneous -= 1
 701             d.callback("done %d" % i)
 702         reactor.callLater(1.0, _done)
 703         return d
 704
 705     def bad_job(self, i, foo):
 706         raise ValueError("bad_job %d" % i)
 707
 708     def test_limiter(self):
 709         self.calls = []
 710         self.simultaneous = 0
 711         self.peak_simultaneous = 0
 712         l = limiter.ConcurrencyLimiter()
 713         dl = []
 714         for i in range(20):
 715             dl.append(l.add(self.job, i, foo=str(i)))
 716         d = defer.DeferredList(dl, fireOnOneErrback=True)
 717         def _done(res):
 718             self.failUnlessEqual(self.simultaneous, 0)
 719             self.failUnless(self.peak_simultaneous <= 10)
 720             self.failUnlessEqual(len(self.calls), 20)
 721             for i in range(20):
 722                 self.failUnless( (i, str(i)) in self.calls)
 723         d.addCallback(_done)
 724         return d
 725
 726     def test_errors(self):
 727         self.calls = []
 728         self.simultaneous = 0
 729         self.peak_simultaneous = 0
 730         l = limiter.ConcurrencyLimiter()
 731         dl = []
 732         for i in range(20):
 733             dl.append(l.add(self.job, i, foo=str(i)))
 734         d2 = l.add(self.bad_job, 21, "21")
 735         d = defer.DeferredList(dl, fireOnOneErrback=True)
 736         def _most_done(res):
 737             results = []
 738             for (success, result) in res:
 739                 self.failUnlessEqual(success, True)
 740                 results.append(result)
 741             results.sort()
 742             expected_results = ["done %d" % i for i in range(20)]
 743             expected_results.sort()
 744             self.failUnlessEqual(results, expected_results)
 745             self.failUnless(self.peak_simultaneous <= 10)
 746             self.failUnlessEqual(len(self.calls), 20)
 747             for i in range(20):
 748                 self.failUnless( (i, str(i)) in self.calls)
 749             def _good(res):
 750                 self.fail("should have failed, not got %s" % (res,))
 751             def _err(f):
 752                 f.trap(ValueError)
 753                 self.failUnless("bad_job 21" in str(f))
 754             d2.addCallbacks(_good, _err)
 755             return d2
 756         d.addCallback(_most_done)
 757         def _all_done(res):
 758             self.failUnlessEqual(self.simultaneous, 0)
 759             self.failUnless(self.peak_simultaneous <= 10)
 760             self.failUnlessEqual(len(self.calls), 20)
 761             for i in range(20):
 762                 self.failUnless( (i, str(i)) in self.calls)
 763         d.addCallback(_all_done)
 764         return d
 765
 766 class TimeFormat(unittest.TestCase):
 767     def test_epoch(self):
 768         return self._help_test_epoch()
 769
 770     def test_epoch_in_London(self):
 771         # Europe/London is a particularly troublesome timezone.  Nowadays, its
 772         # offset from GMT is 0.  But in 1970, its offset from GMT was 1.
 773         # (Apparently in 1970 Britain had redefined standard time to be GMT+1
 774         # and stayed in standard time all year round, whereas today
 775         # Europe/London standard time is GMT and Europe/London Daylight
 776         # Savings Time is GMT+1.)  The current implementation of
 777         # time_format.iso_utc_time_to_localseconds() breaks if the timezone is
 778         # Europe/London.  (As soon as this unit test is done then I'll change
 779         # that implementation to something that works even in this case...)
 780         origtz = os.environ.get('TZ')
 781         os.environ['TZ'] = "Europe/London"
 782         if hasattr(time, 'tzset'):
 783             time.tzset()
 784         try:
 785             return self._help_test_epoch()
 786         finally:
 787             if origtz is None:
 788                 del os.environ['TZ']
 789             else:
 790                 os.environ['TZ'] = origtz
 791             if hasattr(time, 'tzset'):
 792                 time.tzset()
 793
 794     def _help_test_epoch(self):
 795         s = time_format.iso_utc_time_to_seconds("1970-01-01T00:00:01")
 796         self.failUnlessEqual(s, 1.0)
 797         s = time_format.iso_utc_time_to_seconds("1970-01-01_00:00:01")
 798         self.failUnlessEqual(s, 1.0)
 799         s = time_format.iso_utc_time_to_seconds("1970-01-01 00:00:01")
 800         self.failUnlessEqual(s, 1.0)
 801
 802         self.failUnlessEqual(time_format.iso_utc(1.0), "1970-01-01_00:00:01")
 803         self.failUnlessEqual(time_format.iso_utc(1.0, sep=" "),
 804                              "1970-01-01 00:00:01")
 805
 806         now = time.time()
 807         isostr = time_format.iso_utc(now)
 808         timestamp = time_format.iso_utc_time_to_seconds(isostr)
 809         self.failUnlessEqual(int(timestamp), int(now))
 810
 811         def my_time():
 812             return 1.0
 813         self.failUnlessEqual(time_format.iso_utc(t=my_time),
 814                              "1970-01-01_00:00:01")
 815         e = self.failUnlessRaises(ValueError,
 816                                   time_format.iso_utc_time_to_seconds,
 817                                   "invalid timestring")
 818         self.failUnless("not a complete ISO8601 timestamp" in str(e))
 819         s = time_format.iso_utc_time_to_seconds("1970-01-01_00:00:01.500")
 820         self.failUnlessEqual(s, 1.5)
 821
 822         # Look for daylight-savings-related errors.
 823         thatmomentinmarch = time_format.iso_utc_time_to_seconds("2009-03-20 21:49:02.226536")
 824         self.failUnlessEqual(thatmomentinmarch, 1237585742.226536)
 825
 826 class CacheDir(unittest.TestCase):
 827     def test_basic(self):
 828         basedir = "test_util/CacheDir/test_basic"
 829
 830         def _failIfExists(name):
 831             absfn = os.path.join(basedir, name)
 832             self.failIf(os.path.exists(absfn),
 833                         "%s exists but it shouldn't" % absfn)
 834
 835         def _failUnlessExists(name):
 836             absfn = os.path.join(basedir, name)
 837             self.failUnless(os.path.exists(absfn),
 838                             "%s doesn't exist but it should" % absfn)
 839
 840         cdm = cachedir.CacheDirectoryManager(basedir)
 841         a = cdm.get_file("a")
 842         b = cdm.get_file("b")
 843         c = cdm.get_file("c")
 844         f = open(a.get_filename(), "wb"); f.write("hi"); f.close(); del f
 845         f = open(b.get_filename(), "wb"); f.write("hi"); f.close(); del f
 846         f = open(c.get_filename(), "wb"); f.write("hi"); f.close(); del f
 847
 848         _failUnlessExists("a")
 849         _failUnlessExists("b")
 850         _failUnlessExists("c")
 851
 852         cdm.check()
 853
 854         _failUnlessExists("a")
 855         _failUnlessExists("b")
 856         _failUnlessExists("c")
 857
 858         del a
 859         # this file won't be deleted yet, because it isn't old enough
 860         cdm.check()
 861         _failUnlessExists("a")
 862         _failUnlessExists("b")
 863         _failUnlessExists("c")
 864
 865         # we change the definition of "old" to make everything old
 866         cdm.old = -10
 867
 868         cdm.check()
 869         _failIfExists("a")
 870         _failUnlessExists("b")
 871         _failUnlessExists("c")
 872
 873         cdm.old = 60*60
 874
 875         del b
 876
 877         cdm.check()
 878         _failIfExists("a")
 879         _failUnlessExists("b")
 880         _failUnlessExists("c")
 881
 882         b2 = cdm.get_file("b")
 883
 884         cdm.check()
 885         _failIfExists("a")
 886         _failUnlessExists("b")
 887         _failUnlessExists("c")
 888
 889 ctr = [0]
 890 class EqButNotIs:
 891     def __init__(self, x):
 892         self.x = x
 893         self.hash = ctr[0]
 894         ctr[0] += 1
 895     def __repr__(self):
 896         return "<%s %s>" % (self.__class__.__name__, self.x,)
 897     def __hash__(self):
 898         return self.hash
 899     def __le__(self, other):
 900         return self.x <= other
 901     def __lt__(self, other):
 902         return self.x < other
 903     def __ge__(self, other):
 904         return self.x >= other
 905     def __gt__(self, other):
 906         return self.x > other
 907     def __ne__(self, other):
 908         return self.x != other
 909     def __eq__(self, other):
 910         return self.x == other
 911
 912 class DictUtil(unittest.TestCase):
 913     def _help_test_empty_dict(self, klass):
 914         d1 = klass()
 915         d2 = klass({})
 916
 917         self.failUnless(d1 == d2, "d1: %r, d2: %r" % (d1, d2,))
 918         self.failUnless(len(d1) == 0)
 919         self.failUnless(len(d2) == 0)
 920
 921     def _help_test_nonempty_dict(self, klass):
 922         d1 = klass({'a': 1, 'b': "eggs", 3: "spam",})
 923         d2 = klass({'a': 1, 'b': "eggs", 3: "spam",})
 924
 925         self.failUnless(d1 == d2)
 926         self.failUnless(len(d1) == 3, "%s, %s" % (len(d1), d1,))
 927         self.failUnless(len(d2) == 3)
 928
 929     def _help_test_eq_but_notis(self, klass):
 930         d = klass({'a': 3, 'b': EqButNotIs(3), 'c': 3})
 931         d.pop('b')
 932
 933         d.clear()
 934         d['a'] = 3
 935         d['b'] = EqButNotIs(3)
 936         d['c'] = 3
 937         d.pop('b')
 938
 939         d.clear()
 940         d['b'] = EqButNotIs(3)
 941         d['a'] = 3
 942         d['c'] = 3
 943         d.pop('b')
 944
 945         d.clear()
 946         d['a'] = EqButNotIs(3)
 947         d['c'] = 3
 948         d['a'] = 3
 949
 950         d.clear()
 951         fake3 = EqButNotIs(3)
 952         fake7 = EqButNotIs(7)
 953         d[fake3] = fake7
 954         d[3] = 7
 955         d[3] = 8
 956         self.failUnless(filter(lambda x: x is 8,  d.itervalues()))
 957         self.failUnless(filter(lambda x: x is fake7,  d.itervalues()))
 958         # The real 7 should have been ejected by the d[3] = 8.
 959         self.failUnless(not filter(lambda x: x is 7,  d.itervalues()))
 960         self.failUnless(filter(lambda x: x is fake3,  d.iterkeys()))
 961         self.failUnless(filter(lambda x: x is 3,  d.iterkeys()))
 962         d[fake3] = 8
 963
 964         d.clear()
 965         d[3] = 7
 966         fake3 = EqButNotIs(3)
 967         fake7 = EqButNotIs(7)
 968         d[fake3] = fake7
 969         d[3] = 8
 970         self.failUnless(filter(lambda x: x is 8,  d.itervalues()))
 971         self.failUnless(filter(lambda x: x is fake7,  d.itervalues()))
 972         # The real 7 should have been ejected by the d[3] = 8.
 973         self.failUnless(not filter(lambda x: x is 7,  d.itervalues()))
 974         self.failUnless(filter(lambda x: x is fake3,  d.iterkeys()))
 975         self.failUnless(filter(lambda x: x is 3,  d.iterkeys()))
 976         d[fake3] = 8
 977
 978     def test_all(self):
 979         self._help_test_eq_but_notis(dictutil.UtilDict)
 980         self._help_test_eq_but_notis(dictutil.NumDict)
 981         self._help_test_eq_but_notis(dictutil.ValueOrderedDict)
 982         self._help_test_nonempty_dict(dictutil.UtilDict)
 983         self._help_test_nonempty_dict(dictutil.NumDict)
 984         self._help_test_nonempty_dict(dictutil.ValueOrderedDict)
 985         self._help_test_eq_but_notis(dictutil.UtilDict)
 986         self._help_test_eq_but_notis(dictutil.NumDict)
 987         self._help_test_eq_but_notis(dictutil.ValueOrderedDict)
 988
 989     def test_dict_of_sets(self):
 990         ds = dictutil.DictOfSets()
 991         ds.add(1, "a")
 992         ds.add(2, "b")
 993         ds.add(2, "b")
 994         ds.add(2, "c")
 995         self.failUnlessEqual(ds[1], set(["a"]))
 996         self.failUnlessEqual(ds[2], set(["b", "c"]))
 997         ds.discard(3, "d") # should not raise an exception
 998         ds.discard(2, "b")
 999         self.failUnlessEqual(ds[2], set(["c"]))
1000         ds.discard(2, "c")
1001         self.failIf(2 in ds)
1002
1003         ds.union(1, ["a", "e"])
1004         ds.union(3, ["f"])
1005         self.failUnlessEqual(ds[1], set(["a","e"]))
1006         self.failUnlessEqual(ds[3], set(["f"]))
1007         ds2 = dictutil.DictOfSets()
1008         ds2.add(3, "f")
1009         ds2.add(3, "g")
1010         ds2.add(4, "h")
1011         ds.update(ds2)
1012         self.failUnlessEqual(ds[1], set(["a","e"]))
1013         self.failUnlessEqual(ds[3], set(["f", "g"]))
1014         self.failUnlessEqual(ds[4], set(["h"]))
1015
1016     def test_move(self):
1017         d1 = {1: "a", 2: "b"}
1018         d2 = {2: "c", 3: "d"}
1019         dictutil.move(1, d1, d2)
1020         self.failUnlessEqual(d1, {2: "b"})
1021         self.failUnlessEqual(d2, {1: "a", 2: "c", 3: "d"})
1022
1023         d1 = {1: "a", 2: "b"}
1024         d2 = {2: "c", 3: "d"}
1025         dictutil.move(2, d1, d2)
1026         self.failUnlessEqual(d1, {1: "a"})
1027         self.failUnlessEqual(d2, {2: "b", 3: "d"})
1028
1029         d1 = {1: "a", 2: "b"}
1030         d2 = {2: "c", 3: "d"}
1031         self.failUnlessRaises(KeyError, dictutil.move, 5, d1, d2, strict=True)
1032
1033     def test_subtract(self):
1034         d1 = {1: "a", 2: "b"}
1035         d2 = {2: "c", 3: "d"}
1036         d3 = dictutil.subtract(d1, d2)
1037         self.failUnlessEqual(d3, {1: "a"})
1038
1039         d1 = {1: "a", 2: "b"}
1040         d2 = {2: "c"}
1041         d3 = dictutil.subtract(d1, d2)
1042         self.failUnlessEqual(d3, {1: "a"})
1043
1044     def test_utildict(self):
1045         d = dictutil.UtilDict({1: "a", 2: "b"})
1046         d.del_if_present(1)
1047         d.del_if_present(3)
1048         self.failUnlessEqual(d, {2: "b"})
1049         def eq(a, b):
1050             return a == b
1051         self.failUnlessRaises(TypeError, eq, d, "not a dict")
1052
1053         d = dictutil.UtilDict({1: "b", 2: "a"})
1054         self.failUnlessEqual(d.items_sorted_by_value(),
1055                              [(2, "a"), (1, "b")])
1056         self.failUnlessEqual(d.items_sorted_by_key(),
1057                              [(1, "b"), (2, "a")])
1058         self.failUnlessEqual(repr(d), "{1: 'b', 2: 'a'}")
1059         self.failUnless(1 in d)
1060
1061         d2 = dictutil.UtilDict({3: "c", 4: "d"})
1062         self.failUnless(d != d2)
1063         self.failUnless(d2 > d)
1064         self.failUnless(d2 >= d)
1065         self.failUnless(d <= d2)
1066         self.failUnless(d < d2)
1067         self.failUnlessEqual(d[1], "b")
1068         self.failUnlessEqual(sorted(list([k for k in d])), [1,2])
1069
1070         d3 = d.copy()
1071         self.failUnlessEqual(d, d3)
1072         self.failUnless(isinstance(d3, dictutil.UtilDict))
1073
1074         d4 = d.fromkeys([3,4], "e")
1075         self.failUnlessEqual(d4, {3: "e", 4: "e"})
1076
1077         self.failUnlessEqual(d.get(1), "b")
1078         self.failUnlessEqual(d.get(3), None)
1079         self.failUnlessEqual(d.get(3, "default"), "default")
1080         self.failUnlessEqual(sorted(list(d.items())),
1081                              [(1, "b"), (2, "a")])
1082         self.failUnlessEqual(sorted(list(d.iteritems())),
1083                              [(1, "b"), (2, "a")])
1084         self.failUnlessEqual(sorted(d.keys()), [1, 2])
1085         self.failUnlessEqual(sorted(d.values()), ["a", "b"])
1086         x = d.setdefault(1, "new")
1087         self.failUnlessEqual(x, "b")
1088         self.failUnlessEqual(d[1], "b")
1089         x = d.setdefault(3, "new")
1090         self.failUnlessEqual(x, "new")
1091         self.failUnlessEqual(d[3], "new")
1092         del d[3]
1093
1094         x = d.popitem()
1095         self.failUnless(x in [(1, "b"), (2, "a")])
1096         x = d.popitem()
1097         self.failUnless(x in [(1, "b"), (2, "a")])
1098         self.failUnlessRaises(KeyError, d.popitem)
1099
1100     def test_numdict(self):
1101         d = dictutil.NumDict({"a": 1, "b": 2})
1102
1103         d.add_num("a", 10, 5)
1104         d.add_num("c", 20, 5)
1105         d.add_num("d", 30)
1106         self.failUnlessEqual(d, {"a": 11, "b": 2, "c": 25, "d": 30})
1107
1108         d.subtract_num("a", 10)
1109         d.subtract_num("e", 10)
1110         d.subtract_num("f", 10, 15)
1111         self.failUnlessEqual(d, {"a": 1, "b": 2, "c": 25, "d": 30,
1112                                  "e": -10, "f": 5})
1113
1114         self.failUnlessEqual(d.sum(), sum([1, 2, 25, 30, -10, 5]))
1115
1116         d = dictutil.NumDict()
1117         d.inc("a")
1118         d.inc("a")
1119         d.inc("b", 5)
1120         self.failUnlessEqual(d, {"a": 2, "b": 6})
1121         d.dec("a")
1122         d.dec("c")
1123         d.dec("d", 5)
1124         self.failUnlessEqual(d, {"a": 1, "b": 6, "c": -1, "d": 4})
1125         self.failUnlessEqual(d.items_sorted_by_key(),
1126                              [("a", 1), ("b", 6), ("c", -1), ("d", 4)])
1127         self.failUnlessEqual(d.items_sorted_by_value(),
1128                              [("c", -1), ("a", 1), ("d", 4), ("b", 6)])
1129         self.failUnlessEqual(d.item_with_largest_value(), ("b", 6))
1130
1131         d = dictutil.NumDict({"a": 1, "b": 2})
1132         self.failUnlessEqual(repr(d), "{'a': 1, 'b': 2}")
1133         self.failUnless("a" in d)
1134
1135         d2 = dictutil.NumDict({"c": 3, "d": 4})
1136         self.failUnless(d != d2)
1137         self.failUnless(d2 > d)
1138         self.failUnless(d2 >= d)
1139         self.failUnless(d <= d2)
1140         self.failUnless(d < d2)
1141         self.failUnlessEqual(d["a"], 1)
1142         self.failUnlessEqual(sorted(list([k for k in d])), ["a","b"])
1143         def eq(a, b):
1144             return a == b
1145         self.failUnlessRaises(TypeError, eq, d, "not a dict")
1146
1147         d3 = d.copy()
1148         self.failUnlessEqual(d, d3)
1149         self.failUnless(isinstance(d3, dictutil.NumDict))
1150
1151         d4 = d.fromkeys(["a","b"], 5)
1152         self.failUnlessEqual(d4, {"a": 5, "b": 5})
1153
1154         self.failUnlessEqual(d.get("a"), 1)
1155         self.failUnlessEqual(d.get("c"), 0)
1156         self.failUnlessEqual(d.get("c", 5), 5)
1157         self.failUnlessEqual(sorted(list(d.items())),
1158                              [("a", 1), ("b", 2)])
1159         self.failUnlessEqual(sorted(list(d.iteritems())),
1160                              [("a", 1), ("b", 2)])
1161         self.failUnlessEqual(sorted(d.keys()), ["a", "b"])
1162         self.failUnlessEqual(sorted(d.values()), [1, 2])
1163         self.failUnless(d.has_key("a"))
1164         self.failIf(d.has_key("c"))
1165
1166         x = d.setdefault("c", 3)
1167         self.failUnlessEqual(x, 3)
1168         self.failUnlessEqual(d["c"], 3)
1169         x = d.setdefault("c", 5)
1170         self.failUnlessEqual(x, 3)
1171         self.failUnlessEqual(d["c"], 3)
1172         del d["c"]
1173
1174         x = d.popitem()
1175         self.failUnless(x in [("a", 1), ("b", 2)])
1176         x = d.popitem()
1177         self.failUnless(x in [("a", 1), ("b", 2)])
1178         self.failUnlessRaises(KeyError, d.popitem)
1179
1180         d.update({"c": 3})
1181         d.update({"c": 4, "d": 5})
1182         self.failUnlessEqual(d, {"c": 4, "d": 5})
1183
1184     def test_del_if_present(self):
1185         d = {1: "a", 2: "b"}
1186         dictutil.del_if_present(d, 1)
1187         dictutil.del_if_present(d, 3)
1188         self.failUnlessEqual(d, {2: "b"})
1189
1190     def test_valueordereddict(self):
1191         d = dictutil.ValueOrderedDict()
1192         d["a"] = 3
1193         d["b"] = 2
1194         d["c"] = 1
1195
1196         self.failUnlessEqual(d, {"a": 3, "b": 2, "c": 1})
1197         self.failUnlessEqual(d.items(), [("c", 1), ("b", 2), ("a", 3)])
1198         self.failUnlessEqual(d.values(), [1, 2, 3])
1199         self.failUnlessEqual(d.keys(), ["c", "b", "a"])
1200         self.failUnlessEqual(repr(d), "<ValueOrderedDict {c: 1, b: 2, a: 3}>")
1201         def eq(a, b):
1202             return a == b
1203         self.failIf(d == {"a": 4})
1204         self.failUnless(d != {"a": 4})
1205
1206         x = d.setdefault("d", 0)
1207         self.failUnlessEqual(x, 0)
1208         self.failUnlessEqual(d["d"], 0)
1209         x = d.setdefault("d", -1)
1210         self.failUnlessEqual(x, 0)
1211         self.failUnlessEqual(d["d"], 0)
1212
1213         x = d.remove("e", "default", False)
1214         self.failUnlessEqual(x, "default")
1215         self.failUnlessRaises(KeyError, d.remove, "e", "default", True)
1216         x = d.remove("d", 5)
1217         self.failUnlessEqual(x, 0)
1218
1219         x = d.__getitem__("c")
1220         self.failUnlessEqual(x, 1)
1221         x = d.__getitem__("e", "default", False)
1222         self.failUnlessEqual(x, "default")
1223         self.failUnlessRaises(KeyError, d.__getitem__, "e", "default", True)
1224
1225         self.failUnlessEqual(d.popitem(), ("c", 1))
1226         self.failUnlessEqual(d.popitem(), ("b", 2))
1227         self.failUnlessEqual(d.popitem(), ("a", 3))
1228         self.failUnlessRaises(KeyError, d.popitem)
1229
1230         d = dictutil.ValueOrderedDict({"a": 3, "b": 2, "c": 1})
1231         x = d.pop("d", "default", False)
1232         self.failUnlessEqual(x, "default")
1233         self.failUnlessRaises(KeyError, d.pop, "d", "default", True)
1234         x = d.pop("b")
1235         self.failUnlessEqual(x, 2)
1236         self.failUnlessEqual(d.items(), [("c", 1), ("a", 3)])
1237
1238         d = dictutil.ValueOrderedDict({"a": 3, "b": 2, "c": 1})
1239         x = d.pop_from_list(1) # pop the second item, b/2
1240         self.failUnlessEqual(x, "b")
1241         self.failUnlessEqual(d.items(), [("c", 1), ("a", 3)])
1242
1243 class Pipeline(unittest.TestCase):
1244     def pause(self, *args, **kwargs):
1245         d = defer.Deferred()
1246         self.calls.append( (d, args, kwargs) )
1247         return d
1248
1249     def failUnlessCallsAre(self, expected):
1250         #print self.calls
1251         #print expected
1252         self.failUnlessEqual(len(self.calls), len(expected), self.calls)
1253         for i,c in enumerate(self.calls):
1254             self.failUnlessEqual(c[1:], expected[i], str(i))
1255
1256     def test_basic(self):
1257         self.calls = []
1258         finished = []
1259         p = pipeline.Pipeline(100)
1260
1261         d = p.flush() # fires immediately
1262         d.addCallbacks(finished.append, log.err)
1263         self.failUnlessEqual(len(finished), 1)
1264         finished = []
1265
1266         d = p.add(10, self.pause, "one")
1267         # the call should start right away, and our return Deferred should
1268         # fire right away
1269         d.addCallbacks(finished.append, log.err)
1270         self.failUnlessEqual(len(finished), 1)
1271         self.failUnlessEqual(finished[0], None)
1272         self.failUnlessCallsAre([ ( ("one",) , {} ) ])
1273         self.failUnlessEqual(p.gauge, 10)
1274
1275         # pipeline: [one]
1276
1277         finished = []
1278         d = p.add(20, self.pause, "two", kw=2)
1279         # pipeline: [one, two]
1280
1281         # the call and the Deferred should fire right away
1282         d.addCallbacks(finished.append, log.err)
1283         self.failUnlessEqual(len(finished), 1)
1284         self.failUnlessEqual(finished[0], None)
1285         self.failUnlessCallsAre([ ( ("one",) , {} ),
1286                                   ( ("two",) , {"kw": 2} ),
1287                                   ])
1288         self.failUnlessEqual(p.gauge, 30)
1289
1290         self.calls[0][0].callback("one-result")
1291         # pipeline: [two]
1292         self.failUnlessEqual(p.gauge, 20)
1293
1294         finished = []
1295         d = p.add(90, self.pause, "three", "posarg1")
1296         # pipeline: [two, three]
1297         flushed = []
1298         fd = p.flush()
1299         fd.addCallbacks(flushed.append, log.err)
1300         self.failUnlessEqual(flushed, [])
1301
1302         # the call will be made right away, but the return Deferred will not,
1303         # because the pipeline is now full.
1304         d.addCallbacks(finished.append, log.err)
1305         self.failUnlessEqual(len(finished), 0)
1306         self.failUnlessCallsAre([ ( ("one",) , {} ),
1307                                   ( ("two",) , {"kw": 2} ),
1308                                   ( ("three", "posarg1"), {} ),
1309                                   ])
1310         self.failUnlessEqual(p.gauge, 110)
1311
1312         self.failUnlessRaises(pipeline.SingleFileError, p.add, 10, self.pause)
1313
1314         # retiring either call will unblock the pipeline, causing the #3
1315         # Deferred to fire
1316         self.calls[2][0].callback("three-result")
1317         # pipeline: [two]
1318
1319         self.failUnlessEqual(len(finished), 1)
1320         self.failUnlessEqual(finished[0], None)
1321         self.failUnlessEqual(flushed, [])
1322
1323         # retiring call#2 will finally allow the flush() Deferred to fire
1324         self.calls[1][0].callback("two-result")
1325         self.failUnlessEqual(len(flushed), 1)
1326
1327     def test_errors(self):
1328         self.calls = []
1329         p = pipeline.Pipeline(100)
1330
1331         d1 = p.add(200, self.pause, "one")
1332         d2 = p.flush()
1333
1334         finished = []
1335         d1.addBoth(finished.append)
1336         self.failUnlessEqual(finished, [])
1337
1338         flushed = []
1339         d2.addBoth(flushed.append)
1340         self.failUnlessEqual(flushed, [])
1341
1342         self.calls[0][0].errback(ValueError("oops"))
1343
1344         self.failUnlessEqual(len(finished), 1)
1345         f = finished[0]
1346         self.failUnless(isinstance(f, Failure))
1347         self.failUnless(f.check(pipeline.PipelineError))
1348         r = repr(f.value)
1349         self.failUnless("ValueError" in r, r)
1350         f2 = f.value.error
1351         self.failUnless(f2.check(ValueError))
1352
1353         self.failUnlessEqual(len(flushed), 1)
1354         f = flushed[0]
1355         self.failUnless(isinstance(f, Failure))
1356         self.failUnless(f.check(pipeline.PipelineError))
1357         f2 = f.value.error
1358         self.failUnless(f2.check(ValueError))
1359
1360         # now that the pipeline is in the failed state, any new calls will
1361         # fail immediately
1362
1363         d3 = p.add(20, self.pause, "two")
1364
1365         finished = []
1366         d3.addBoth(finished.append)
1367         self.failUnlessEqual(len(finished), 1)
1368         f = finished[0]
1369         self.failUnless(isinstance(f, Failure))
1370         self.failUnless(f.check(pipeline.PipelineError))
1371         r = repr(f.value)
1372         self.failUnless("ValueError" in r, r)
1373         f2 = f.value.error
1374         self.failUnless(f2.check(ValueError))
1375
1376         d4 = p.flush()
1377         flushed = []
1378         d4.addBoth(flushed.append)
1379         self.failUnlessEqual(len(flushed), 1)
1380         f = flushed[0]
1381         self.failUnless(isinstance(f, Failure))
1382         self.failUnless(f.check(pipeline.PipelineError))
1383         f2 = f.value.error
1384         self.failUnless(f2.check(ValueError))
1385
1386     def test_errors2(self):
1387         self.calls = []
1388         p = pipeline.Pipeline(100)
1389
1390         d1 = p.add(10, self.pause, "one")
1391         d2 = p.add(20, self.pause, "two")
1392         d3 = p.add(30, self.pause, "three")
1393         d4 = p.flush()
1394
1395         # one call fails, then the second one succeeds: make sure
1396         # ExpandableDeferredList tolerates the second one
1397
1398         flushed = []
1399         d4.addBoth(flushed.append)
1400         self.failUnlessEqual(flushed, [])
1401
1402         self.calls[0][0].errback(ValueError("oops"))
1403         self.failUnlessEqual(len(flushed), 1)
1404         f = flushed[0]
1405         self.failUnless(isinstance(f, Failure))
1406         self.failUnless(f.check(pipeline.PipelineError))
1407         f2 = f.value.error
1408         self.failUnless(f2.check(ValueError))
1409
1410         self.calls[1][0].callback("two-result")
1411         self.calls[2][0].errback(ValueError("three-error"))