zfec/zfec/test/test_zfec.py

   1 #!/usr/bin/env python
   2
   3 import cStringIO, os, random, re
   4
   5 import unittest
   6
   7 global VERBOSE
   8 VERBOSE=False
   9
  10 import zfec
  11
  12 from pyutil import fileutil
  13
  14 from base64 import b32encode
  15 def ab(x): # debuggery
  16     if len(x) >= 3:
  17         return "%s:%s" % (len(x), b32encode(x[-3:]),)
  18     elif len(x) == 2:
  19         return "%s:%s" % (len(x), b32encode(x[-2:]),)
  20     elif len(x) == 1:
  21         return "%s:%s" % (len(x), b32encode(x[-1:]),)
  22     elif len(x) == 0:
  23         return "%s:%s" % (len(x), "--empty--",)
  24
  25 def randstr(n):
  26     return ''.join(map(chr, map(random.randrange, [0]*n, [256]*n)))
  27
  28 def _h(k, m, ss):
  29     encer = zfec.Encoder(k, m)
  30     nums_and_blocks = list(enumerate(encer.encode(ss)))
  31     assert isinstance(nums_and_blocks, list), nums_and_blocks
  32     assert len(nums_and_blocks) == m, (len(nums_and_blocks), m,)
  33     nums_and_blocks = random.sample(nums_and_blocks, k)
  34     blocks = [ x[1] for x in nums_and_blocks ]
  35     nums = [ x[0] for x in nums_and_blocks ]
  36     decer = zfec.Decoder(k, m)
  37     decoded = decer.decode(blocks, nums)
  38     assert len(decoded) == len(ss), (len(decoded), len(ss),)
  39     assert tuple([str(s) for s in decoded]) == tuple([str(s) for s in ss]), (tuple([ab(str(s)) for s in decoded]), tuple([ab(str(s)) for s in ss]),)
  40
  41 def _help_test_random():
  42     m = random.randrange(1, 257)
  43     k = random.randrange(1, m+1)
  44     l = random.randrange(0, 2**9)
  45     ss = [ randstr(l/k) for x in range(k) ]
  46     _h(k, m, ss)
  47
  48 def _help_test_random_with_l(l):
  49     m = random.randrange(1, 257)
  50     k = random.randrange(1, m+1)
  51     ss = [ randstr(l/k) for x in range(k) ]
  52     _h(k, m, ss)
  53
  54 def _h_easy(k, m, s):
  55     encer = zfec.easyfec.Encoder(k, m)
  56     nums_and_blocks = list(enumerate(encer.encode(s)))
  57     assert isinstance(nums_and_blocks, list), nums_and_blocks
  58     assert len(nums_and_blocks) == m, (len(nums_and_blocks), m,)
  59     nums_and_blocks = random.sample(nums_and_blocks, k)
  60     blocks = [ x[1] for x in nums_and_blocks ]
  61     nums = [ x[0] for x in nums_and_blocks ]
  62     decer = zfec.easyfec.Decoder(k, m)
  63
  64     decodeds = decer.decode(blocks, nums, padlen=k*len(blocks[0]) - len(s))
  65     assert len(decodeds) == len(s), (ab(decodeds), ab(s), k, m)
  66     assert decodeds == s, (ab(decodeds), ab(s),)
  67
  68 def _help_test_random_easy():
  69     m = random.randrange(1, 257)
  70     k = random.randrange(1, m+1)
  71     l = random.randrange(0, 2**9)
  72     s = randstr(l)
  73     _h_easy(k, m, s)
  74
  75 def _help_test_random_with_l_easy(l):
  76     m = random.randrange(1, 257)
  77     k = random.randrange(1, m+1)
  78     s = randstr(l)
  79     _h_easy(k, m, s)
  80
  81 class ZFecTest(unittest.TestCase):
  82     def test_instantiate_no_args(self):
  83         try:
  84             e = zfec.Encoder()
  85         except TypeError:
  86             # Okay, so that's because we're required to pass constructor args.
  87             pass
  88         else:
  89             # Oops, it should have raised an exception.
  90             self.fail("Should have raised exception from incorrect arguments to constructor.")
  91
  92     def test_from_agl_c(self):
  93         self.failUnless(zfec._fec.test_from_agl())
  94
  95     def test_from_agl_py(self):
  96         e = zfec.Encoder(3, 5)
  97         b0 = '\x01'*8 ; b1 = '\x02'*8 ; b2 = '\x03'*8
  98         # print "_from_py before encoding:"
  99         # print "b0: %s, b1: %s, b2: %s" % tuple(base64.b16encode(x) for x in [b0, b1, b2])
 100
 101         b3, b4 = e.encode([b0, b1, b2], (3, 4))
 102         # print "after encoding:"
 103         # print "b3: %s, b4: %s" % tuple(base64.b16encode(x) for x in [b3, b4])
 104
 105         d = zfec.Decoder(3, 5)
 106         r0, r1, r2 = d.decode((b2, b3, b4), (1, 2, 3))
 107
 108         # print "after decoding:"
 109         # print "b0: %s, b1: %s" % tuple(base64.b16encode(x) for x in [b0, b1])
 110
 111     def test_small(self):
 112         for i in range(16):
 113             _help_test_random_with_l(i)
 114         if VERBOSE:
 115             print "%d randomized tests pass." % (i+1)
 116
 117     def test_random(self):
 118         for i in range(3):
 119             _help_test_random()
 120         if VERBOSE:
 121             print "%d randomized tests pass." % (i+1)
 122
 123     def test_bad_args_construct_decoder(self):
 124         try:
 125             zfec.Decoder(-1, -1)
 126         except zfec.Error, e:
 127             assert "argument is required to be greater than or equal to 1" in str(e), e
 128         else:
 129             self.fail("Should have gotten an exception from out-of-range arguments.")
 130
 131         try:
 132             zfec.Decoder(1, 257)
 133         except zfec.Error, e:
 134             assert "argument is required to be less than or equal to 256" in str(e), e
 135         else:
 136             self.fail("Should have gotten an exception from out-of-range arguments.")
 137
 138         try:
 139             zfec.Decoder(3, 2)
 140         except zfec.Error, e:
 141             assert "first argument is required to be less than or equal to the second argument" in str(e), e
 142         else:
 143             self.fail("Should have gotten an exception from out-of-range arguments.")
 144
 145     def test_bad_args_construct_encoder(self):
 146         try:
 147             zfec.Encoder(-1, -1)
 148         except zfec.Error, e:
 149             assert "argument is required to be greater than or equal to 1" in str(e), e
 150         else:
 151             self.fail("Should have gotten an exception from out-of-range arguments.")
 152
 153         try:
 154             zfec.Encoder(1, 257)
 155         except zfec.Error, e:
 156             assert "argument is required to be less than or equal to 256" in str(e), e
 157         else:
 158             self.fail("Should have gotten an exception from out-of-range arguments.")
 159
 160     def test_bad_args_dec(self):
 161         decer = zfec.Decoder(2, 4)
 162
 163         try:
 164             decer.decode(98, []) # first argument is not a sequence
 165         except TypeError, e:
 166             assert "First argument was not a sequence" in str(e), e
 167         else:
 168             self.fail("Should have gotten TypeError for wrong type of second argument.")
 169
 170         try:
 171             decer.decode(["a", "b", ], ["c", "d",])
 172         except zfec.Error, e:
 173             assert "Precondition violation: second argument is required to contain int" in str(e), e
 174         else:
 175             self.fail("Should have gotten zfec.Error for wrong type of second argument.")
 176
 177         try:
 178             decer.decode(["a", "b", ], 98) # not a sequence at all
 179         except TypeError, e:
 180             assert "Second argument was not a sequence" in str(e), e
 181         else:
 182             self.fail("Should have gotten TypeError for wrong type of second argument.")
 183
 184 class EasyFecTest(unittest.TestCase):
 185     def test_small(self):
 186         for i in range(16):
 187             _help_test_random_with_l_easy(i)
 188         if VERBOSE:
 189             print "%d randomized tests pass." % (i+1)
 190
 191     def test_random(self):
 192         for i in range(3):
 193             _help_test_random_easy()
 194         if VERBOSE:
 195             print "%d randomized tests pass." % (i+1)
 196
 197     def test_bad_args_dec(self):
 198         decer = zfec.easyfec.Decoder(2, 4)
 199
 200         try:
 201             decer.decode(98, [0, 1], 0) # first argument is not a sequence
 202         except TypeError, e:
 203             assert "First argument was not a sequence" in str(e), e
 204         else:
 205             self.fail("Should have gotten TypeError for wrong type of second argument.")
 206
 207         try:
 208             decer.decode("ab", ["c", "d",], 0)
 209         except zfec.Error, e:
 210             assert "Precondition violation: second argument is required to contain int" in str(e), e
 211         else:
 212             self.fail("Should have gotten zfec.Error for wrong type of second argument.")
 213
 214         try:
 215             decer.decode("ab", 98, 0) # not a sequence at all
 216         except TypeError, e:
 217             assert "Second argument was not a sequence" in str(e), e
 218         else:
 219             self.fail("Should have gotten TypeError for wrong type of second argument.")
 220
 221 class FileFec(unittest.TestCase):
 222     def test_filefec_header(self):
 223         for m in [1, 2, 3, 5, 7, 9, 11, 17, 19, 33, 35, 65, 66, 67, 129, 130, 131, 254, 255, 256,]:
 224             for k in [1, 2, 3, 5, 9, 17, 33, 65, 129, 255, 256,]:
 225                 if k >= m:
 226                     continue
 227                 for pad in [0, 1, k-1,]:
 228                     if pad >= k:
 229                         continue
 230                     for sh in [0, 1, m-1,]:
 231                         if sh >= m:
 232                             continue
 233                         h = zfec.filefec._build_header(m, k, pad, sh)
 234                         hio = cStringIO.StringIO(h)
 235                         (rm, rk, rpad, rsh,) = zfec.filefec._parse_header(hio)
 236                         assert (rm, rk, rpad, rsh,) == (m, k, pad, sh,), h
 237
 238     def _help_test_filefec(self, teststr, k, m, numshs=None):
 239         if numshs == None:
 240             numshs = m
 241
 242         TESTFNAME = "testfile.txt"
 243         PREFIX = "test"
 244         SUFFIX = ".fec"
 245
 246         fsize = len(teststr)
 247
 248         tempdir = fileutil.NamedTemporaryDirectory(cleanup=True)
 249         try:
 250             tempf = tempdir.file(TESTFNAME, 'w+b')
 251             tempf.write(teststr)
 252             tempf.flush()
 253             tempf.seek(0)
 254
 255             # encode the file
 256             zfec.filefec.encode_to_files(tempf, fsize, tempdir.name, PREFIX, k, m, SUFFIX, verbose=VERBOSE)
 257
 258             # select some share files
 259             RE=re.compile(zfec.filefec.RE_FORMAT % (PREFIX, SUFFIX,))
 260             fns = os.listdir(tempdir.name)
 261             assert len(fns) >= m, (fns, tempdir, tempdir.name,)
 262             sharefs = [ open(os.path.join(tempdir.name, fn), "rb") for fn in fns if RE.match(fn) ]
 263             for sharef in sharefs:
 264                 tempdir.register_file(sharef)
 265             random.shuffle(sharefs)
 266             del sharefs[numshs:]
 267
 268             # decode from the share files
 269             outf = tempdir.file('recovered-testfile.txt', 'w+b')
 270             zfec.filefec.decode_from_files(outf, sharefs, verbose=VERBOSE)
 271             outf.flush()
 272             outf.seek(0)
 273             recovereddata = outf.read()
 274             assert recovereddata == teststr, (ab(recovereddata), ab(teststr),)
 275         finally:
 276             tempdir.shutdown()
 277
 278     def test_filefec_all_shares(self):
 279         return self._help_test_filefec("Yellow Whirled!", 3, 8)
 280
 281     def test_filefec_all_shares_1_b(self):
 282         return self._help_test_filefec("Yellow Whirled!", 4, 16)
 283
 284     def test_filefec_all_shares_2(self):
 285         return self._help_test_filefec("Yellow Whirled", 3, 8)
 286
 287     def test_filefec_all_shares_2_b(self):
 288         return self._help_test_filefec("Yellow Whirled", 4, 16)
 289
 290     def test_filefec_all_shares_3(self):
 291         return self._help_test_filefec("Yellow Whirle", 3, 8)
 292
 293     def test_filefec_all_shares_3_b(self):
 294         return self._help_test_filefec("Yellow Whirle", 4, 16)
 295
 296     def test_filefec_all_shares_with_padding(self, noisy=VERBOSE):
 297         return self._help_test_filefec("Yellow Whirled!A", 3, 8)
 298
 299     def test_filefec_min_shares_with_padding(self, noisy=VERBOSE):
 300         return self._help_test_filefec("Yellow Whirled!A", 3, 8, numshs=3)
 301
 302     def test_filefec_min_shares_with_crlf(self, noisy=VERBOSE):
 303         return self._help_test_filefec("llow Whirled!A\r\n", 3, 8, numshs=3)
 304
 305     def test_filefec_min_shares_with_lf(self, noisy=VERBOSE):
 306         return self._help_test_filefec("Yellow Whirled!A\n", 3, 8, numshs=3)
 307
 308     def test_filefec_min_shares_with_lflf(self, noisy=VERBOSE):
 309         return self._help_test_filefec("Yellow Whirled!A\n\n", 3, 8, numshs=3)
 310
 311     def test_filefec_min_shares_with_crcrlflf(self, noisy=VERBOSE):
 312         return self._help_test_filefec("Yellow Whirled!A\r\r\n\n", 3, 8, numshs=3)
 313
 314
 315 class Cmdline(unittest.TestCase):
 316     def test_basic(self, noisy=VERBOSE):
 317         tempdir = fileutil.NamedTemporaryDirectory(cleanup=True)
 318         fo = tempdir.file("test.data", "w+b")
 319         fo.write("WHEHWHJEKWAHDLJAWDHWALKDHA")
 320
 321         import sys
 322         realargv = sys.argv
 323         try:
 324             DEFAULT_M=8
 325             DEFAULT_K=3
 326             sys.argv = ["zfec", os.path.join(tempdir.name, "test.data"),]
 327
 328             retcode = zfec.cmdline_zfec.main()
 329             assert retcode == 0, retcode
 330
 331             RE=re.compile(zfec.filefec.RE_FORMAT % ('test.data', ".fec",))
 332             fns = os.listdir(tempdir.name)
 333             assert len(fns) >= DEFAULT_M, (fns, DEFAULT_M, tempdir, tempdir.name,)
 334             sharefns = [ os.path.join(tempdir.name, fn) for fn in fns if RE.match(fn) ]
 335             random.shuffle(sharefns)
 336             del sharefns[DEFAULT_K:]
 337
 338             sys.argv = ["zunfec",]
 339             sys.argv.extend(sharefns)
 340             sys.argv.extend(['-o', os.path.join(tempdir.name, 'test.data-recovered'),])
 341
 342             retcode = zfec.cmdline_zunfec.main()
 343             assert retcode == 0, retcode
 344             import filecmp
 345             assert filecmp.cmp(os.path.join(tempdir.name, 'test.data'), os.path.join(tempdir.name, 'test.data-recovered'))
 346         finally:
 347             sys.argv = realargv
 348
 349 if __name__ == "__main__":
 350     unittest.main()