Test suit

A nice test suit also works as API example!

Most of the tests came from Bastien Montagne (mont29)

setup.py

@@ -9,5 +9,8 @@ setup(
     author_email='foundation@blender.org',
     license='GNU General Public License v2 or later (GPLv2+)',
     packages=['blender_file'],
+    tests_require=[
+        'pytest',
+    ],
     zip_safe=False,
 )

tests/test_all.py

@@ -0,0 +1,134 @@
+# -*- coding: utf-8 -*-
+"""Unitests for blender_format"""
+
+import os
+import blender_file
+
+# Utils
+
+def get_sample_filepath(filepath):
+    """Return the full path of the sample file"""
+    dir_path = os.path.dirname(os.path.realpath(__file__))
+    return os.path.join(dir_path, 'samples', filepath)
+
+
+def idprop_group_iter(idprops, ):
+    itor = idprops.get_pointer((b'data', b'group', b'first'))
+    while itor is not None:
+        yield itor
+        itor = itor.get_pointer(b'next')
+
+
+def views_iter(scene):
+    """Return an iterator for all views of scene"""
+    view = scene.get_pointer((b'r', b'views', b'first'))
+    while view is not None:
+        yield view
+        view = view.get_pointer(b'next')
+
+
+def query_main_scene(filepath, callbacks):
+    """Return the equivalent to bpy.context.scene"""
+    with blender_file.open_blend(filepath) as blend:
+        # There is no bpy.context.scene, we get it from the main window
+        window_manager = [block for block in blend.blocks if block.code == b'WM'][0]
+        window = window_manager.get_pointer(b'winactive')
+        screen = window.get_pointer(b'screen')
+        scene = screen.get_pointer(b'scene')
+
+        output = []
+        for callback in callbacks:
+            output.append(callback(scene))
+        return output
+
+# Main tests
+
+def test_scene_name():
+    def get_name(scene):
+        return scene.get((b'id', b'name'))
+
+    filepath = get_sample_filepath("monkeys.blend")
+    scene_name, = query_main_scene(filepath, [get_name])
+
+    # 'SC猿のシーン'
+    assert scene_name == u'SC\u733f\u306e\u30b7\u30fc\u30f3'
+
+
+def test_scene_resolution():
+    def get_resolution_x(scene):
+        return scene.get((b'r', b'xsch'))
+
+    def get_resolution_y(scene):
+        return scene.get((b'r', b'ysch'))
+
+    filepath = get_sample_filepath("monkeys.blend")
+    resolution_x, resolution_y = query_main_scene(filepath, [
+        get_resolution_x,
+        get_resolution_y,
+        ])
+
+    assert resolution_x == 1920
+    assert resolution_y == 1080
+
+
+def test_camera():
+    def get_camera_name(scene):
+        camera = scene.get_pointer(b'camera')
+        assert camera
+        return camera.get((b'id', b'name'))
+
+    def get_camera_lens(scene):
+        camera = scene.get_pointer(b'camera')
+        assert camera
+        camera_data = camera.get_pointer(b'data')
+        return camera_data.get(b'lens')
+
+    filepath = get_sample_filepath("monkeys.blend")
+    camera_name, camera_lens = query_main_scene(filepath, [
+        get_camera_name,
+        get_camera_lens,
+        ])
+
+    assert camera_name == 'OBMainCamera'
+    assert "{0:4.2f}".format(camera_lens) == "37.22"
+
+
+def test_views():
+    def get_views_name_status(scene):
+        name_status = []
+        for view in views_iter(scene):
+            name_status.append((
+                view.get(b'name'),
+                view.get(b'viewflag'),
+                ))
+        return name_status
+
+    filepath = get_sample_filepath("monkeys.blend")
+    views_data, = query_main_scene(filepath, [get_views_name_status])
+
+    assert len(views_data) == 4
+    assert views_data[3][0] == "south"
+    assert views_data[2][0] == u'\u5317' # '北'
+    assert (views_data[2][1] & (1 << 0)) != 0
+    assert (views_data[3][1] & (1 << 0)) == 0
+
+
+def test_cycles_samples():
+    def get_samples(scene):
+        # get custom properties
+        properties = scene.get_pointer((b'id', b'properties'))
+
+        if properties is None:
+            return -1
+
+        # iterate through all the property groups
+        for itor in idprop_group_iter(properties):
+            if itor.get(b'name') == "cycles":
+                for itor2 in idprop_group_iter(itor):
+                    if itor2.get(b'name') == "samples":
+                        return itor2.get((b'data', b'val'))
+
+    filepath = get_sample_filepath("monkeys.blend")
+    samples, = query_main_scene(filepath, [get_samples])
+    assert samples == 72
+