]> git.rkrishnan.org Git - tahoe-lafs/zfec.git/blobdiff - zfec/zfec/test/test_zfec.py
fix segfault when invalid arguments are passed to constructor
[tahoe-lafs/zfec.git] / zfec / zfec / test / test_zfec.py
index 8cb929550b0d00f6de4499fcb5f4a961d39b675c..5fd9173c6e8c7f90ca46ab4c9a02c5306bf8344e 100755 (executable)
@@ -9,6 +9,8 @@ VERBOSE=False
 
 import zfec
 
+from pyutil import fileutil
+
 from base64 import b32encode
 def ab(x): # debuggery
     if len(x) >= 3:
@@ -20,6 +22,9 @@ def ab(x): # debuggery
     elif len(x) == 0:
         return "%s:%s" % (len(x), "--empty--",)
 
+def randstr(n):
+    return ''.join(map(chr, map(random.randrange, [0]*n, [256]*n)))
+
 def _h(k, m, ss):
     encer = zfec.Encoder(k, m)
     nums_and_blocks = list(enumerate(encer.encode(ss)))
@@ -33,64 +38,171 @@ def _h(k, m, ss):
     assert len(decoded) == len(ss), (len(decoded), len(ss),)
     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]),)
 
-def randstr(n):
-    return ''.join(map(chr, map(random.randrange, [0]*n, [256]*n)))
-
 def _help_test_random():
     m = random.randrange(1, 257)
     k = random.randrange(1, m+1)
-    l = random.randrange(0, 2**10)
+    l = random.randrange(0, 2**9)
     ss = [ randstr(l/k) for x in range(k) ]
     _h(k, m, ss)
 
 def _help_test_random_with_l(l):
-    m = 83
-    k = 19
+    m = random.randrange(1, 257)
+    k = random.randrange(1, m+1)
     ss = [ randstr(l/k) for x in range(k) ]
     _h(k, m, ss)
 
-class ZFec(unittest.TestCase):
+def _h_easy(k, m, s):
+    encer = zfec.easyfec.Encoder(k, m)
+    nums_and_blocks = list(enumerate(encer.encode(s)))
+    assert isinstance(nums_and_blocks, list), nums_and_blocks
+    assert len(nums_and_blocks) == m, (len(nums_and_blocks), m,)
+    nums_and_blocks = random.sample(nums_and_blocks, k)
+    blocks = [ x[1] for x in nums_and_blocks ]
+    nums = [ x[0] for x in nums_and_blocks ]
+    decer = zfec.easyfec.Decoder(k, m)
+    
+    decodeds = decer.decode(blocks, nums, padlen=k*len(blocks[0]) - len(s))
+    assert len(decodeds) == len(s), (ab(decodeds), ab(s), k, m)
+    assert decodeds == s, (ab(decodeds), ab(s),)
+
+def _help_test_random_easy():
+    m = random.randrange(1, 257)
+    k = random.randrange(1, m+1)
+    l = random.randrange(0, 2**9)
+    s = randstr(l)
+    _h_easy(k, m, s)
+
+def _help_test_random_with_l_easy(l):
+    m = random.randrange(1, 257)
+    k = random.randrange(1, m+1)
+    s = randstr(l)
+    _h_easy(k, m, s)
+    
+class ZFecTest(unittest.TestCase):
+    def test_from_agl_c(self):
+        self.failUnless(zfec._fec.test_from_agl())
+            
+    def test_from_agl_py(self):
+        e = zfec.Encoder(3, 5)
+        b0 = '\x01'*8 ; b1 = '\x02'*8 ; b2 = '\x03'*8
+        # print "_from_py before encoding:"
+        # print "b0: %s, b1: %s, b2: %s" % tuple(base64.b16encode(x) for x in [b0, b1, b2])
+
+        b3, b4 = e.encode([b0, b1, b2], (3, 4))
+        # print "after encoding:"
+        # print "b3: %s, b4: %s" % tuple(base64.b16encode(x) for x in [b3, b4])
+
+        d = zfec.Decoder(3, 5)
+        r0, r1, r2 = d.decode((b2, b3, b4), (1, 2, 3))
+        
+        # print "after decoding:"
+        # print "b0: %s, b1: %s" % tuple(base64.b16encode(x) for x in [b0, b1])
+
+    def test_small(self):
+        for i in range(16):
+            _help_test_random_with_l(i)
+        if VERBOSE:
+            print "%d randomized tests pass." % (i+1)
+
     def test_random(self):
         for i in range(3):
             _help_test_random()
         if VERBOSE:
             print "%d randomized tests pass." % (i+1)
 
-    def test_bad_args_enc(self):
-        encer = zfec.Encoder(2, 4)
+    def test_bad_args_construct_decoder(self):
+        try:
+            zfec.Decoder(-1, -1)
+        except zfec.Error, e:
+            assert "argument is required to be greater than or equal to 1" in str(e), e
+        else:
+            self.fail("Should have gotten an exception from out-of-range arguments.")
+
+        try:
+            zfec.Decoder(1, 257)
+        except zfec.Error, e:
+            assert "argument is required to be less than or equal to 256" in str(e), e
+        else:
+            self.fail("Should have gotten an exception from out-of-range arguments.")
+
+        try:
+            zfec.Decoder(3, 2)
+        except zfec.Error, e:
+            assert "first argument is required to be less than or equal to the second argument" in str(e), e
+        else:
+            self.fail("Should have gotten an exception from out-of-range arguments.")
+
+    def test_bad_args_construct_encoder(self):
+        try:
+            zfec.Encoder(-1, -1)
+        except zfec.Error, e:
+            assert "argument is required to be greater than or equal to 1" in str(e), e
+        else:
+            self.fail("Should have gotten an exception from out-of-range arguments.")
+
         try:
-            encer.encode(["a", "b", ], ["c", "I am not an integer blocknum",])
+            zfec.Encoder(1, 257)
+        except zfec.Error, e:
+            assert "argument is required to be less than or equal to 256" in str(e), e
+        else:
+            self.fail("Should have gotten an exception from out-of-range arguments.")
+
+    def test_bad_args_dec(self):
+        decer = zfec.Decoder(2, 4)
+
+        try:
+            decer.decode(98, []) # first argument is not a sequence
+        except TypeError, e:
+            assert "First argument was not a sequence" in str(e), e
+        else:
+            raise "Should have gotten TypeError for wrong type of second argument."
+
+        try:
+            decer.decode(["a", "b", ], ["c", "d",])
         except zfec.Error, e:
             assert "Precondition violation: second argument is required to contain int" in str(e), e
         else:
             raise "Should have gotten zfec.Error for wrong type of second argument."
 
         try:
-            encer.encode(["a", "b", ], 98) # not a sequence at all
+            decer.decode(["a", "b", ], 98) # not a sequence at all
         except TypeError, e:
-            assert "Second argument (optional) was not a sequence" in str(e), e
+            assert "Second argument was not a sequence" in str(e), e
         else:
             raise "Should have gotten TypeError for wrong type of second argument."
 
+class EasyFecTest(unittest.TestCase):
+    def test_small(self):
+        for i in range(16):
+            _help_test_random_with_l_easy(i)
+        if VERBOSE:
+            print "%d randomized tests pass." % (i+1)
+
+    def test_random(self):
+        for i in range(3):
+            _help_test_random_easy()
+        if VERBOSE:
+            print "%d randomized tests pass." % (i+1)
+
     def test_bad_args_dec(self):
-        decer = zfec.Decoder(2, 4)
+        decer = zfec.easyfec.Decoder(2, 4)
 
         try:
-            decer.decode(98, [0, 1]) # first argument is not a sequence
+            decer.decode(98, [0, 1], 0) # first argument is not a sequence
         except TypeError, e:
             assert "First argument was not a sequence" in str(e), e
         else:
             raise "Should have gotten TypeError for wrong type of second argument."
 
         try:
-            decer.decode(["a", "b", ], ["c", "d",])
+            decer.decode("ab", ["c", "d",], 0)
         except zfec.Error, e:
             assert "Precondition violation: second argument is required to contain int" in str(e), e
         else:
             raise "Should have gotten zfec.Error for wrong type of second argument."
 
         try:
-            decer.decode(["a", "b", ], 98) # not a sequence at all
+            decer.decode("ab", 98, 0) # not a sequence at all
         except TypeError, e:
             assert "Second argument was not a sequence" in str(e), e
         else:
@@ -98,8 +210,8 @@ class ZFec(unittest.TestCase):
 
 class FileFec(unittest.TestCase):
     def test_filefec_header(self):
-        for m in [3, 5, 7, 9, 11, 17, 19, 33, 35, 65, 66, 67, 129, 130, 131, 254, 255, 256,]:
-            for k in [2, 3, 5, 9, 17, 33, 65, 129, 255,]:
+        for m in [1, 2, 3, 5, 7, 9, 11, 17, 19, 33, 35, 65, 66, 67, 129, 130, 131, 254, 255, 256,]:
+            for k in [1, 2, 3, 5, 9, 17, 33, 65, 129, 255, 256,]:
                 if k >= m:
                     continue
                 for pad in [0, 1, k-1,]:
@@ -123,10 +235,11 @@ class FileFec(unittest.TestCase):
 
         fsize = len(teststr)
 
-        tempdir = zfec.util.fileutil.NamedTemporaryDirectory(cleanup=False)
+        tempdir = fileutil.NamedTemporaryDirectory(cleanup=True)
         try:
             tempf = tempdir.file(TESTFNAME, 'w+b')
             tempf.write(teststr)
+            tempf.flush()
             tempf.seek(0)
 
             # encode the file
@@ -145,30 +258,31 @@ class FileFec(unittest.TestCase):
             # decode from the share files
             outf = tempdir.file('recovered-testfile.txt', 'w+b')
             zfec.filefec.decode_from_files(outf, sharefs, verbose=VERBOSE)
+            outf.flush()
             outf.seek(0)
             recovereddata = outf.read()
-            assert recovereddata == teststr
+            assert recovereddata == teststr, (ab(recovereddata), ab(teststr),)
         finally:
             tempdir.shutdown()
 
     def test_filefec_all_shares(self):
         return self._help_test_filefec("Yellow Whirled!", 3, 8)
 
+    def test_filefec_all_shares_1_b(self):
+        return self._help_test_filefec("Yellow Whirled!", 4, 16)
+
     def test_filefec_all_shares_2(self):
         return self._help_test_filefec("Yellow Whirled", 3, 8)
 
+    def test_filefec_all_shares_2_b(self):
+        return self._help_test_filefec("Yellow Whirled", 4, 16)
+
     def test_filefec_all_shares_3(self):
         return self._help_test_filefec("Yellow Whirle", 3, 8)
 
     def test_filefec_all_shares_3_b(self):
         return self._help_test_filefec("Yellow Whirle", 4, 16)
 
-    def test_filefec_all_shares_2_b(self):
-        return self._help_test_filefec("Yellow Whirled", 4, 16)
-
-    def test_filefec_all_shares_1_b(self):
-        return self._help_test_filefec("Yellow Whirled!", 4, 16)
-
     def test_filefec_all_shares_with_padding(self, noisy=VERBOSE):
         return self._help_test_filefec("Yellow Whirled!A", 3, 8)
 
@@ -190,15 +304,15 @@ class FileFec(unittest.TestCase):
  
 class Cmdline(unittest.TestCase):
     def test_basic(self, noisy=VERBOSE):
-        tempdir = zfec.util.fileutil.NamedTemporaryDirectory(cleanup=False)
+        tempdir = fileutil.NamedTemporaryDirectory(cleanup=True)
         fo = tempdir.file("test.data", "w+b")
         fo.write("WHEHWHJEKWAHDLJAWDHWALKDHA")
 
         import sys
         realargv = sys.argv
         try:
-            DEFAULT_M=16
-            DEFAULT_K=4
+            DEFAULT_M=8
+            DEFAULT_K=3
             sys.argv = ["zfec", os.path.join(tempdir.name, "test.data"),]
         
             retcode = zfec.cmdline_zfec.main()
@@ -206,7 +320,7 @@ class Cmdline(unittest.TestCase):
 
             RE=re.compile(zfec.filefec.RE_FORMAT % ('test.data', ".fec",))
             fns = os.listdir(tempdir.name)
-            assert len(fns) >= DEFAULT_M, (fns, tempdir, tempdir.name,)
+            assert len(fns) >= DEFAULT_M, (fns, DEFAULT_M, tempdir, tempdir.name,)
             sharefns = [ os.path.join(tempdir.name, fn) for fn in fns if RE.match(fn) ]
             random.shuffle(sharefns)
             del sharefns[DEFAULT_K:]
@@ -215,7 +329,6 @@ class Cmdline(unittest.TestCase):
             sys.argv.extend(sharefns)
             sys.argv.extend(['-o', os.path.join(tempdir.name, 'test.data-recovered'),])
             
-            print os.system("ls -ald %s" % (os.path.join(tempdir.name, 'test.data-recovered')))
             retcode = zfec.cmdline_zunfec.main()
             assert retcode == 0, retcode
             import filecmp
@@ -223,29 +336,5 @@ class Cmdline(unittest.TestCase):
         finally:
             sys.argv = realargv
 
-
-# zfec -- fast forward error correction library with Python interface
-#
-# Copyright (C) 2007 Allmydata, Inc.
-# Author: Zooko Wilcox-O'Hearn
-# mailto:zooko@zooko.com
-#
-# This file is part of zfec.
-#
-# This program is free software; you can redistribute it and/or modify it under
-# the terms of the GNU General Public License as published by the Free Software
-# Foundation; either version 2 of the License, or (at your option) any later
-# version.  This program also comes with the added permission that, in the case
-# that you are obligated to release a derived work under this licence (as per
-# section 2.b of the GPL), you may delay the fulfillment of this obligation for
-# up to 12 months.
-#
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with this program; if not, write to the Free Software
-# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
-
+if __name__ == "__main__":
+    unittest.main()