improving benchmark tests and their documentation

diff --git a/docs/benchmark.txt b/docs/benchmark.txt
deleted file mode 100644 (file)
index 28dffa9..0000000
--- a/docs/benchmark.txt
+++ /dev/null
@@ -1,31 +0,0 @@
-For testing tarfile and zlib with different python version:
-
-* python-delta-tar tarfile
-    Make test using two modes: without compress and with gz compress.
-    Run wgeneration.py for create a directory with files. (python2)
-    python wgeneration.py --help for more infomation.
-        example: wgeneration.py --ndir 20 --nfile 100 --size 100 --path source_dir
-    Time:
-        time python3.3.2 run.py --test delta-tarfile
-        time python3.4.1 run.py --test delta-tarfile
-    Profiling:
-        python3.3.2 run.py --test delta-tarfile --profile
-        python3.4.1 run.py --test delta-tarfile --profile
-
-
-* tarfile
-    Make test using two modes: without compress and with gz compress.
-    Same as python-delta-tar, change for --test tarfile
-
-
-* zlib
-    Make test using three modes: without compress(0), middle compress(6) and better compress(9)
-    Run wgeneration.py for create a directory with a file.
-    python wgeneration.py --help for more infomation.
-        example: wgeneration.py --ndir 1 --nfile 1 --size 10 --distribute_size 100 --distribute_files 100 --path source_dir
-    Time:
-        time python3.3.2 run.py --test zlib
-        time python3.4.1 run.py --test zlib
-    Profiling:
-        python3.3.2 run.py --test zlib --profile
-        python3.4.1 run.py --test zlib --profile

diff --git a/run.py b/run.py
deleted file mode 100644 (file)
index 196a24d..0000000
--- a/run.py
+++ /dev/null
@@ -1,84 +0,0 @@
-import argparse
-import os
-import zlib
-import fnmatch
-import cProfile
-import io
-import pstats
-
-
-def main(parser):
-    results = parser.parse_args()
-    if results.test.endswith("tarfile"):
-        test_tarfile(results.test, results.profile, results.sort)
-    elif results.test == 'zlib':
-        test_zlib(results.profile, results.sort)
-    else:
-        parser.print_help()
-
-
-def test_tarfile(res, profile=False, sort=None):
-    if res == 'delta-tarfile':
-        from deltatar.tarfile import TarFile
-    elif res == 'tarfile':
-        import tarfile as TarFile
-    if profile:
-        pr = cProfile.Profile()
-        pr.enable()
-    modes = ('w', 'w:gz')
-    for m in range(len(modes)):
-        print(modes[m])
-        fo = open('tarfile_dir%d.tar' % m, 'wb')
-        tar = TarFile.open(mode=modes[m], fileobj=fo)
-        tar.add('source_dir/')
-        fo.close()
-    if profile:
-        pr.disable()
-        print_profile(pr, sort)
-    os.system('rm -rf tarfile_dir*')
-
-
-def test_zlib(profile=False, sort=None):
-    for root, dirnames, filenames in os.walk('source_dir/'):
-        for filename in fnmatch.filter(filenames, '*'):
-            match = os.path.join(root, filename)
-            break
-    if not match:
-        print('file not found. ')
-        return
-    fo = open(match, 'r')
-    lines = fo.readlines()
-    fo.close()
-
-    if profile:
-        pr = cProfile.Profile()
-        pr.enable()
-    for m in [0, 6, 9]:
-        print(m)
-        compress_lines = zlib.compress(bytes(''.join(lines), 'utf-8'), m)
-        decompress_lines = zlib.decompress(compress_lines)
-    if profile:
-        pr.disable()
-        print_profile(pr, sort)
-
-
-def print_profile(pr, sort):
-    s = io.StringIO()
-    if not sort:
-        sort = 'cumulative'
-    ps = pstats.Stats(pr, stream=s).sort_stats(sort)
-    ps.print_stats()
-    print(s.getvalue())
-
-
-if __name__ == '__main__':
-    parser = argparse.ArgumentParser(description='Profiling test options. ')
-    parser.add_argument('--test', choices=['delta-tarfile', 'tarfile', 'zlib'],
-            help='Select option for testing. ')
-    parser.add_argument('--profile', action='store_true',
-            help='Enable profile')
-    parser.add_argument('--sort', help='Sort output profile', choices=[
-            'calls', 'cumulative', 'cumtime', 'file', 'filename', 'module',
-            'ncalls', 'pcalls', 'line', 'name', 'nfl', 'stdname', 'time',
-            'tottime'])
-    main(parser)

diff --git a/wgeneration.py b/testing/create_pseudo_random_files.py
similarity index 95%
rename from wgeneration.py
rename to testing/create_pseudo_random_files.py
index 8574119..a16de77 100755 (executable)
--- a/wgeneration.py
+++ b/testing/create_pseudo_random_files.py
@@ -1,4 +1,5 @@
-#!/usr/bin/python
+#!/usr/bin/env python3
+
 import argparse
 import os
 import random
@@ -43,10 +44,10 @@ def create_rand_cad(size=1024):
         Return: random name.
         Rtype: str.
     """
-    cads = [hashfunc(create_rand_name()).hexdigest()]
+    cads = [hashfunc(create_rand_name().encode('utf-8')).hexdigest()]
     last = cads[0]
-    for i in range(size / 128):
-        last = hashfunc(last[:8]).hexdigest()
+    for i in range(int(size / 128)):
+        last = hashfunc(last[:8].encode('utf-8')).hexdigest()
         cads.append(last)
     return ''.join(cads)[:size]
 
@@ -81,7 +82,7 @@ def generate_list_sizes(nfile, size, distribute_size):
     list_sizes = []
     aux_size = size
     normal_size = int(size / nfile)
-    var = int(normal_size - normal_size * distribute_size / 100)
+    var = max(1, int(normal_size - normal_size * distribute_size / 100))
     for s in range(nfile):
         if aux_size <= 0:
             list_sizes.append(0)
@@ -116,7 +117,7 @@ def get_files_per_folder(nfile, ndir, distribute_files):
             continue
         files = 0
         if (f_per_dir > 0):
-            var = int(f_per_dir - f_per_dir * distribute_files / 100)
+            var = max(1, int(f_per_dir - f_per_dir * distribute_files / 100))
             files += random.randint(f_per_dir - var, f_per_dir + var)
         var = f_remainder - f_remainder * distribute_files / 100
         files += random.randint(f_remainder - var, f_remainder + var)

diff --git a/testing/run_benchmark.py b/testing/run_benchmark.py
new file mode 100755 (executable)
index 0000000..48daf3d
--- /dev/null
+++ b/testing/run_benchmark.py
@@ -0,0 +1,103 @@
+#!/usr/bin/env python3
+
+# Copyright (C) 2014 Intra2net AG
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published
+# by the Free Software Foundation; either version 3 of the License, or
+# (at your option) any later version.
+#
+# 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 Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see
+# <http://www.gnu.org/licenses/lgpl-3.0.html>
+
+# Authors: Victor Ramirez de la Corte <victor@wadobo.com>
+#          Eduardo Robles Elvira <edulix@wadobo.com>
+
+import argparse
+import os
+import zlib
+import fnmatch
+import cProfile
+import io
+import pstats
+
+
+def main():
+    '''
+    Main function, parses the command line arguments and launches the appropiate
+    benchmark test.
+    '''
+    parser = argparse.ArgumentParser(description='Profiling test options. ')
+    parser.add_argument('-t', '--test', choices=['delta-tarfile', 'tarfile'],
+                        help='Select option for testing. ')
+    parser.add_argument('-l', '--compression-level', type=int, default=9,
+                        choices=[0, 1, 2, 3, 4, 5, 6, 7, 8, 9],
+                        help='Select level of compression for zlib. ')
+    parser.add_argument('-p', '--path',
+                        help='path to the file/dir to compress.')
+    parser.add_argument('-P', '--profile', action='store_true',
+                        help='Enable profile')
+    parser.add_argument('-m', '--tarmode',  default="w:gz",
+                        help='Enable profile')
+    parser.add_argument(
+        '-s', '--sort',
+        help='Sort output profile',
+        choices=[ 'calls', 'cumulative', 'cumtime', 'file', 'path', 'module',
+            'ncalls', 'pcalls', 'line', 'name', 'nfl', 'stdname', 'time',
+            'tottime'],
+        default="cumulative")
+
+    pargs = parser.parse_args()
+    compression_level = pargs.compression_level
+    path = pargs.path
+
+    # start profiling
+    if pargs.profile:
+        pr = cProfile.Profile()
+        pr.enable()
+
+    if pargs.test in ['delta-tarfile', 'tarfile']:
+        test_tarfile(pargs.test, compression_level, path, pargs.tarmode)
+    else:
+        parser.print_help()
+
+    # end profiling
+    if pargs.profile:
+        pr.disable()
+        print_profile(pr, pargs.sort)
+
+def test_tarfile(res, compression_level=9, path='source_dir', tarmode="w:gz"):
+    '''
+    Test that creates a tarfile called test_tarfile.tar.gz
+    '''
+    if res == 'delta-tarfile':
+        deltatar = os.path.abspath("../deltatar")
+        import sys
+        sys.path.append("..")
+        from deltatar import tarfile as TarFile
+    elif res == 'tarfile':
+        import tarfile as TarFile
+
+    print("creating a tarfile with mode = '%s'" % tarmode)
+    with open('test_tarfile.tar.gz', 'wb') as fo:
+        tar = TarFile.open(mode=tarmode, fileobj=fo,
+                           compresslevel=compression_level)
+        tar.add(path)
+
+def print_profile(pr, sort):
+    s = io.StringIO()
+    if not sort:
+        sort = 'cumulative'
+    ps = pstats.Stats(pr, stream=s).sort_stats(sort)
+    ps.print_stats(20)
+    print(s.getvalue())
+
+
+if __name__ == '__main__':
+    main()