[gentoo-commits] proj/g-sorcery:master commit in: g_sorcery/, tests/

[Jauhien Piatlicki]

commit:     6faf8d5ab5dc16f193acc1d344bf473e1eaa4808
Author:     Jauhien Piatlicki (jauhien) <piatlicki <AT> gmail <DOT> com>
AuthorDate: Mon Jul  1 20:14:03 2013 +0000
Commit:     Jauhien Piatlicki <piatlicki <AT> gmail <DOT> com>
CommitDate: Mon Jul  1 20:14:03 2013 +0000
URL:        http://git.overlays.gentoo.org/gitweb/?p=proj/g-sorcery.git;a=commit;h=6faf8d5a

g_sorcery/fileutils: file utilities moved to separate module

---
 g_sorcery/fileutils.py   |  72 ++++++++++++++++++++++++++++
 g_sorcery/package_db.py  |  64 ++-----------------------
 tests/test_fileutils.py  | 121 +++++++++++++++++++++++++++++++++++++++++++++++
 tests/test_package_db.py | 100 ---------------------------------------
 4 files changed, 198 insertions(+), 159 deletions(-)

diff --git a/g_sorcery/fileutils.py b/g_sorcery/fileutils.py
new file mode 100644
index 0000000..1920495
--- /dev/null
+++ b/g_sorcery/fileutils.py
@@ -0,0 +1,72 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+
+"""
+    fileutils.py
+    ~~~~~~~~~~~~
+    
+    file utilities
+    
+    :copyright: (c) 2013 by Jauhien Piatlicki
+    :license: GPL-2, see LICENSE for more details.
+"""
+
+import json, os, shutil
+
+from .exceptions import FileJSONError
+
+class FileJSON:
+    def __init__(self, directory, name, mandatories):
+        """
+        Initialize
+
+        mandatories -- list of mandatory keys
+        """
+        self.directory = os.path.abspath(directory)
+        self.name = name
+        self.path = os.path.join(directory, name)
+        self.mandatories = mandatories
+
+    def read(self):
+        if not os.path.exists(self.directory):
+            os.makedirs(self.directory)
+        content = {}
+        if not os.path.isfile(self.path):
+            for key in self.mandatories:
+                content[key] = ""
+            with open(self.path, 'w') as f:
+                json.dump(content, f, indent=2, sort_keys=True)
+        else:
+            with open(self.path, 'r') as f:
+                content = json.load(f)
+            for key in self.mandatories:
+                if not key in content:
+                    raise FileJSONError('lack of mandatory key: ' + key)
+        return content
+
+    def write(self, content):
+        for key in self.mandatories:
+            if not key in content:
+                raise FileJSONError('lack of mandatory key: ' + key)
+        if not os.path.exists(self.directory):
+            os.makedirs(self.directory)
+        with open(self.path, 'w') as f:
+            json.dump(content, f, indent=2, sort_keys=True)
+
+
+def hash_file(name, hasher, blocksize=65536):
+    with open(name, 'rb') as f:
+        buf = f.read(blocksize)
+        while len(buf) > 0:
+            hasher.update(buf)
+            buf = f.read(blocksize)
+    return hasher.hexdigest()
+
+def copy_all(src, dst):
+    for f_name in os.listdir(src):
+        src_name = os.path.join(src, f_name)
+        dst_name = os.path.join(dst, f_name)
+        if os.path.isdir(src_name):
+            shutil.copytree(src_name, dst_name)
+        else:
+            shutil.copy2(src_name, dst_name)

diff --git a/g_sorcery/package_db.py b/g_sorcery/package_db.py
index 561129d..fc59878 100644
--- a/g_sorcery/package_db.py
+++ b/g_sorcery/package_db.py
@@ -11,70 +11,16 @@
     :license: GPL-2, see LICENSE for more details.
 """
 
-from .exceptions import DBStructureError, FileJSONError, IntegrityError, \
+from .exceptions import DBStructureError, IntegrityError, \
      InvalidKeyError, SyncError
 
-import portage
-     
-import collections, glob, hashlib, json, os, shutil, tarfile, tempfile
+from .fileutils import FileJSON, hash_file, copy_all
 
-Package = collections.namedtuple("Package", "category name version")
+import portage
 
-class FileJSON:
-    def __init__(self, directory, name, mandatories):
-        """
-        Initialize
+import collections, glob, hashlib, os, shutil, tarfile, tempfile
 
-        mandatories -- list of mandatory keys
-        """
-        self.directory = os.path.abspath(directory)
-        self.name = name
-        self.path = os.path.join(directory, name)
-        self.mandatories = mandatories
-
-    def read(self):
-        if not os.path.exists(self.directory):
-            os.makedirs(self.directory)
-        content = {}
-        if not os.path.isfile(self.path):
-            for key in self.mandatories:
-                content[key] = ""
-            with open(self.path, 'w') as f:
-                json.dump(content, f, indent=2, sort_keys=True)
-        else:
-            with open(self.path, 'r') as f:
-                content = json.load(f)
-            for key in self.mandatories:
-                if not key in content:
-                    raise FileJSONError('lack of mandatory key: ' + key)
-        return content
-
-    def write(self, content):
-        for key in self.mandatories:
-            if not key in content:
-                raise FileJSONError('lack of mandatory key: ' + key)
-        if not os.path.exists(self.directory):
-            os.makedirs(self.directory)
-        with open(self.path, 'w') as f:
-            json.dump(content, f, indent=2, sort_keys=True)
-
-
-def hash_file(name, hasher, blocksize=65536):
-    with open(name, 'rb') as f:
-        buf = f.read(blocksize)
-        while len(buf) > 0:
-            hasher.update(buf)
-            buf = f.read(blocksize)
-    return hasher.hexdigest()
-
-def copy_all(src, dst):
-    for f_name in os.listdir(src):
-        src_name = os.path.join(src, f_name)
-        dst_name = os.path.join(dst, f_name)
-        if os.path.isdir(src_name):
-            shutil.copytree(src_name, dst_name)
-        else:
-            shutil.copy2(src_name, dst_name)
+Package = collections.namedtuple("Package", "category name version")
 
 class PackageDB:
     def __init__(self, directory, repo_uri="", db_uri=""):

diff --git a/tests/test_fileutils.py b/tests/test_fileutils.py
new file mode 100644
index 0000000..1760444
--- /dev/null
+++ b/tests/test_fileutils.py
@@ -0,0 +1,121 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+
+"""
+    fileutils.py
+    ~~~~~~~~~~~~
+    
+    file utilities test suite
+    
+    :copyright: (c) 2013 by Jauhien Piatlicki
+    :license: GPL-2, see LICENSE for more details.
+"""
+
+import json, os, shutil, tempfile, unittest
+
+from g_sorcery import exceptions, fileutils
+
+
+class TestFileJSON(unittest.TestCase):
+    
+    def setUp(self):
+        self.tempdir = tempfile.TemporaryDirectory()
+        self.path = os.path.join(self.tempdir.name, 'tst')
+        self.name = 'tst.json'
+
+    def tearDown(self):
+        del self.tempdir
+
+    def do_test_read_ok(self, mandatories, value_suffix=""):
+        f = fileutils.FileJSON(self.path, self.name, mandatories)
+        content = f.read()
+        for key in mandatories:
+            self.assertTrue(key in content)
+            if value_suffix:
+                value = key + value_suffix
+            else:
+                value = ""
+            self.assertEqual(content[key], value)
+        self.assertTrue(os.path.isfile(os.path.join(self.path, self.name)))
+        with open(os.path.join(self.path, self.name), 'r') as f:
+            content_f = json.load(f)
+        self.assertEqual(content, content_f)
+        
+    def test_read_dir_does_not_exist(self):
+        mandatories = ['tst1', 'tst2', 'tst3']
+        self.do_test_read_ok(mandatories)
+
+    def test_read_file_does_not_exist(self):
+        os.makedirs(self.path)
+        mandatories = ['tst1', 'tst2', 'tst3']
+        self.do_test_read_ok(mandatories)
+
+    def test_read_all_keys(self):
+        os.makedirs(self.path)
+        mandatories = ['tst1', 'tst2', 'tst3']
+        content = {}
+        for key in mandatories:
+            content[key] = key + "_v"
+        with open(os.path.join(self.path, self.name), 'w') as f:
+            json.dump(content, f)
+        self.do_test_read_ok(mandatories, "_v")
+
+    def test_read_missing_keys(self):
+        os.makedirs(self.path)
+        mandatories = ['tst1', 'tst2', 'tst3']
+        content = {}
+        for key in mandatories:
+            content[key] = key + "_v"
+        with open(os.path.join(self.path, self.name), 'w') as f:
+            json.dump(content, f)
+        f = fileutils.FileJSON(self.path, self.name, mandatories)
+        mandatories.append("tst4")
+        self.assertRaises(exceptions.FileJSONError, f.read)
+
+    def do_test_write_ok(self):
+        mandatories = ['tst1', 'tst2', 'tst3']
+        content = {}
+        for key in mandatories:
+            content[key] = key + '_v'
+        f = fileutils.FileJSON(self.path, self.name, mandatories)
+        f.write(content)
+        self.assertTrue(os.path.isfile(os.path.join(self.path, self.name)))
+        with open(os.path.join(self.path, self.name), 'r') as f:
+            content_f = json.load(f)
+        self.assertEqual(content, content_f)
+
+    def test_write_missing_keys(self):
+        content = {'tst1' : '', 'tst2' : ''}
+        mandatories = ['tst1', 'tst2', 'tst3']
+        f = fileutils.FileJSON(self.path, self.name, mandatories)
+        self.assertRaises(exceptions.FileJSONError, f.write, content)
+
+    def test_write_dir_does_not_exist(self):
+        self.do_test_write_ok()
+
+    def test_write_file_does_not_exist(self):
+        os.makedirs(self.path)
+        self.do_test_write_ok()
+
+    def test_write_all_keys(self):
+        os.makedirs(self.path)
+        mandatories = ['tst11', 'tst12']
+        content = {}
+        for key in mandatories:
+            content[key] = key + "_v"
+        with open(os.path.join(self.path, self.name), 'w') as f:
+            json.dump(content, f)
+        self.do_test_write_ok()
+
+        
+def suite():
+    suite = unittest.TestSuite()
+    suite.addTest(TestFileJSON('test_read_dir_does_not_exist'))
+    suite.addTest(TestFileJSON('test_read_file_does_not_exist'))
+    suite.addTest(TestFileJSON('test_read_all_keys'))
+    suite.addTest(TestFileJSON('test_read_missing_keys'))
+    suite.addTest(TestFileJSON('test_write_missing_keys'))
+    suite.addTest(TestFileJSON('test_write_dir_does_not_exist'))
+    suite.addTest(TestFileJSON('test_write_file_does_not_exist'))
+    suite.addTest(TestFileJSON('test_write_all_keys'))
+    return suite

diff --git a/tests/test_package_db.py b/tests/test_package_db.py
index c5d7074..2994157 100644
--- a/tests/test_package_db.py
+++ b/tests/test_package_db.py
@@ -30,98 +30,6 @@ class Server(threading.Thread):
         self.httpd.shutdown()
 
 
-class TestFileJSON(unittest.TestCase):
-    
-    def setUp(self):
-        self.tempdir = tempfile.TemporaryDirectory()
-        self.path = os.path.join(self.tempdir.name, 'tst')
-        self.name = 'tst.json'
-
-    def tearDown(self):
-        del self.tempdir
-
-    def do_test_read_ok(self, mandatories, value_suffix=""):
-        f = package_db.FileJSON(self.path, self.name, mandatories)
-        content = f.read()
-        for key in mandatories:
-            self.assertTrue(key in content)
-            if value_suffix:
-                value = key + value_suffix
-            else:
-                value = ""
-            self.assertEqual(content[key], value)
-        self.assertTrue(os.path.isfile(os.path.join(self.path, self.name)))
-        with open(os.path.join(self.path, self.name), 'r') as f:
-            content_f = json.load(f)
-        self.assertEqual(content, content_f)
-        
-    def test_read_dir_does_not_exist(self):
-        mandatories = ['tst1', 'tst2', 'tst3']
-        self.do_test_read_ok(mandatories)
-
-    def test_read_file_does_not_exist(self):
-        os.makedirs(self.path)
-        mandatories = ['tst1', 'tst2', 'tst3']
-        self.do_test_read_ok(mandatories)
-
-    def test_read_all_keys(self):
-        os.makedirs(self.path)
-        mandatories = ['tst1', 'tst2', 'tst3']
-        content = {}
-        for key in mandatories:
-            content[key] = key + "_v"
-        with open(os.path.join(self.path, self.name), 'w') as f:
-            json.dump(content, f)
-        self.do_test_read_ok(mandatories, "_v")
-
-    def test_read_missing_keys(self):
-        os.makedirs(self.path)
-        mandatories = ['tst1', 'tst2', 'tst3']
-        content = {}
-        for key in mandatories:
-            content[key] = key + "_v"
-        with open(os.path.join(self.path, self.name), 'w') as f:
-            json.dump(content, f)
-        f = package_db.FileJSON(self.path, self.name, mandatories)
-        mandatories.append("tst4")
-        self.assertRaises(exceptions.FileJSONError, f.read)
-
-    def do_test_write_ok(self):
-        mandatories = ['tst1', 'tst2', 'tst3']
-        content = {}
-        for key in mandatories:
-            content[key] = key + '_v'
-        f = package_db.FileJSON(self.path, self.name, mandatories)
-        f.write(content)
-        self.assertTrue(os.path.isfile(os.path.join(self.path, self.name)))
-        with open(os.path.join(self.path, self.name), 'r') as f:
-            content_f = json.load(f)
-        self.assertEqual(content, content_f)
-
-    def test_write_missing_keys(self):
-        content = {'tst1' : '', 'tst2' : ''}
-        mandatories = ['tst1', 'tst2', 'tst3']
-        f = package_db.FileJSON(self.path, self.name, mandatories)
-        self.assertRaises(exceptions.FileJSONError, f.write, content)
-
-    def test_write_dir_does_not_exist(self):
-        self.do_test_write_ok()
-
-    def test_write_file_does_not_exist(self):
-        os.makedirs(self.path)
-        self.do_test_write_ok()
-
-    def test_write_all_keys(self):
-        os.makedirs(self.path)
-        mandatories = ['tst11', 'tst12']
-        content = {}
-        for key in mandatories:
-            content[key] = key + "_v"
-        with open(os.path.join(self.path, self.name), 'w') as f:
-            json.dump(content, f)
-        self.do_test_write_ok()
-
-
 class DummyDB(package_db.PackageDB):
     def __init__(self, directory, packages):
         super().__init__(directory)
@@ -227,14 +135,6 @@ class TestDummyDB(unittest.TestCase):
             
 def suite():
     suite = unittest.TestSuite()
-    suite.addTest(TestFileJSON('test_read_dir_does_not_exist'))
-    suite.addTest(TestFileJSON('test_read_file_does_not_exist'))
-    suite.addTest(TestFileJSON('test_read_all_keys'))
-    suite.addTest(TestFileJSON('test_read_missing_keys'))
-    suite.addTest(TestFileJSON('test_write_missing_keys'))
-    suite.addTest(TestFileJSON('test_write_dir_does_not_exist'))
-    suite.addTest(TestFileJSON('test_write_file_does_not_exist'))
-    suite.addTest(TestFileJSON('test_write_all_keys'))
     suite.addTest(TestDummyDB('test_manifest'))
     suite.addTest(TestDummyDB('test_read'))
     suite.addTest(TestDummyDB('test_list_categories'))