Added yajl_version & checking + updated unit tests

Author: pykler

tests/test_yajl.py

@@ -124,7 +124,7 @@ def test_ctxIsPassedToAllCallbacks(self):
             % {'ctx': repr(yajl.addressof(ctx))}
         )
 
-    def test_bufSizeLessThanZeroRaisesException(self):
+    def test_bufSizeLessThanOneRaisesException(self):
         for buf_siz in range(-5, 1):
             self.failUnlessRaises(
                 yajl.YajlConfigError,
@@ -140,3 +140,41 @@ def test_raisesExceptionOnInvalidJson(self):
         self.failUnlessRaises(
             yajl.YajlError,
             parser.parse, invalid_json)
+
+    def test_load_yajl_raisesOSErrorIfYajlNotFound(self):
+        self.mock('yajl.cdll.LoadLibrary', raises=OSError('ABCD'))
+        e = None
+        try:
+            yajl.load_yajl()
+        except OSError, e:
+            pass
+        self.failUnless('Yajl shared object cannot be found.' in str(e))
+
+    def test_get_yajl_version_correctlyParsesYajlVersion(self):
+        for major in [0, 1, 3, 7]:
+            for minor in [0, 1, 2, 5]:
+                for micro in [0, 5, 10, 15, 20]:
+                    yajl_version = major * 10000 + minor * 100 + micro
+                    self.mock('yajl.yajl.yajl_version', returns=yajl_version)
+                    self.failUnlessEqual(
+                        '%s.%s.%s' %(major, minor, micro),
+                        yajl.get_yajl_version())
+
+    def test_check_yajl_version_warnsOnlyWhenMismatchedVersions(self):
+        import warnings
+        self.mock('warnings.warn', [locals()])
+        self.mock('yajl.__version__', mock_obj='1.1.1')
+        self.mock('yajl.yajl_version', mock_obj='1.1.1')
+        self.failUnless(yajl.check_yajl_version())
+        self.assertSameTrace('')
+        self.mock('yajl.yajl_version', mock_obj='1.1.0')
+        self.failIf(yajl.check_yajl_version())
+        self.assertSameTrace(
+            "Called warnings.warn("
+                "'Using Yajl-Py v1.1.1 with Yajl v1.1.0. "
+                "It is advised to use the same Yajl-Py and Yajl versions',"
+                "<type 'exceptions.RuntimeWarning'>, stacklevel=3)"
+        )
+
+    def test_checkYajlPyAndYajlHaveSameVersion(self):
+        self.failUnless(yajl.check_yajl_version())

tests/test_yajl_c.py

@@ -40,11 +40,11 @@ def setUp(self):
 
     def assertSameAsGold(self, filename):
         with open('%s.gold' %filename) as f:
-            expected = f.read() #f.readlines()[:-1]
+            expected = f.read()
         # we currently do not test for memory leaks
         expected = expected.replace('memory leaks:\t0\n', '')
         self.out.seek(0)
-        got = self.out.read() #.splitlines(1)
+        got = self.out.read()
         self.failUnlessEqual(expected, got)
 
     def resetOutput(self):
@@ -56,9 +56,9 @@ def test(self):
         kwargs = {}
         if testname.startswith('dc_'):
             kwargs['allow_comments'] = False
-        for buf_siz in range(32):
+        for buf_siz in range(1, 32):
             # try out a range of buffer_sizes to stress stream parsing
-            kwargs['buf_siz'] = buf_siz + 1
+            kwargs['buf_siz'] = buf_siz
             parser = yajl.YajlParser(self.content_handler, **kwargs)
             with open(filename) as f:
                 try:

yajl/__init__.py

@@ -1,8 +1,23 @@
 '''
 Pure Python wrapper to the Yajl C library
 '''
-__version__ = '1.0.10'
 
 from yajl_common import *
 from yajl_parse import *
 from yajl_gen import *
+
+__version__ = '1.0.10'
+yajl_version = get_yajl_version()
+
+def check_yajl_version():
+    if __version__ != yajl_version:
+        import warnings
+        warnings.warn(
+            'Using Yajl-Py v%s with Yajl v%s. '
+            'It is advised to use the same Yajl-Py and Yajl versions' %(
+                __version__, yajl_version),
+            RuntimeWarning, stacklevel=3)
+        return False
+    return True
+
+check_yajl_version()

yajl/yajl_common.py

@@ -1,13 +1,20 @@
 from ctypes import *
 
-for yajlso in 'libyajl.so', 'libyajl.dylib':
-    try:
-        yajl = cdll.LoadLibrary(yajlso)
-    except OSError:
-        pass
+def load_yajl():
+    global yajl
+    for yajlso in 'libyajl.so', 'libyajl.dylib':
+        try:
+            yajl = cdll.LoadLibrary(yajlso)
+        except OSError:
+            pass
+        else:
+            break
     else:
-        break
-else:
-    raise OSError('Yajl shared object cannot be found. '
-        'Please install Yajl and confirm it is on your shared lib path.')
+        raise OSError('Yajl shared object cannot be found. '
+            'Please install Yajl and confirm it is on your shared lib path.')
 
+def get_yajl_version():
+    v = '%0.6d' %yajl.yajl_version()
+    return '%s.%s.%s' %tuple(map(int, [v[:-4], v[-4:-2], v[-2:]]))
+
+load_yajl()