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