[Bf-blender-cvs] [549e9d022f6] temp-usd-export-unittest: USD: added very simple unit test for USD exporting

[Sybren A. Stüvel]

Commit: 549e9d022f67082305c016b5097f0a6fd949bd67
Author: Sybren A. Stüvel
Date:   Thu Apr 9 17:06:49 2020 +0200
Branches: temp-usd-export-unittest
https://developer.blender.org/rB549e9d022f67082305c016b5097f0a6fd949bd67

USD: added very simple unit test for USD exporting

Since we can't import USD yet, this just does some minimal checks of an
exported USDA file:

- Check that USD can find its JSON files, and
- check that the exporter hierarchy is ok, including instancing.

===================================================================

M	tests/python/CMakeLists.txt
A	tests/python/usd_export_test.py

===================================================================

diff --git a/tests/python/CMakeLists.txt b/tests/python/CMakeLists.txt
index db5d5dcf73b..42ab6057c67 100644
--- a/tests/python/CMakeLists.txt
+++ b/tests/python/CMakeLists.txt
@@ -665,6 +665,20 @@ if(WITH_ALEMBIC)
   )
 endif()
 
+if(WITH_USD)
+  find_package_wrapper(USD)
+  if(NOT USD_FOUND)
+    message(FATAL_ERROR "USD is enabled but cannot be found")
+  endif()
+
+  add_python_test(
+    usd_export_test
+    ${CMAKE_CURRENT_LIST_DIR}/usd_export_test.py
+    --blender "${TEST_BLENDER_EXE}"
+    --testdir "${TEST_SRC_DIR}/usd"
+  )
+endif()
+
 if(WITH_CODEC_FFMPEG)
   add_python_test(
     ffmpeg
diff --git a/tests/python/usd_export_test.py b/tests/python/usd_export_test.py
new file mode 100755
index 00000000000..fc5700f6f27
--- /dev/null
+++ b/tests/python/usd_export_test.py
@@ -0,0 +1,121 @@
+#!/usr/bin/env python3
+# ##### BEGIN GPL LICENSE BLOCK #####
+#
+#  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 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.
+#
+# ##### END GPL LICENSE BLOCK #####
+
+# <pep8 compliant>
+
+import argparse
+import collections
+import pathlib
+import sys
+import unittest
+
+from modules.test_utils import (
+    with_tempdir,
+    AbstractBlenderRunnerTest,
+)
+
+class AbstractUSDTest(AbstractBlenderRunnerTest):
+    @classmethod
+    def setUpClass(cls):
+        cls.blender = args.blender
+        cls.testdir = pathlib.Path(args.testdir)
+
+# Defined here at top-level so that the string's contents don't get indented.
+# The opening parentheses on some lines are an indication that these "def"s
+# are referencing another one, i.e. they're instances.
+expected_hierarchy = """
+def Xform "Ground_plane"
+    def Mesh "Plane"
+    def Xform "OutsideDupliGrandParent"
+        def Xform "OutsideDupliParent"
+            def Xform "GEO_Head"
+                def Mesh "Face"
+                def Xform "GEO_Ear_L"
+                    def Mesh "Ear"
+                def Xform "GEO_Ear_R"
+                    def Mesh "Ear"
+                def Xform "GEO_Nose"
+                    def Mesh "Nose"
+def "_materials"
+    def Material "Head"
+        def Shader "previewShader"
+    def Material "Nose"
+        def Shader "previewShader"
+def Xform "Dupli1"
+    def Xform "GEO_Head_0"
+        def Mesh "Face" (
+        def Xform "GEO_Ear_L_1"
+            def Mesh "Ear" (
+        def Xform "GEO_Ear_R_2"
+            def Mesh "Ear" (
+        def Xform "GEO_Nose_3"
+            def Mesh "Nose" (
+def Xform "ParentOfDupli2"
+    def Mesh "Icosphere"
+    def Xform "Dupli2"
+        def Xform "GEO_Head_0"
+            def Mesh "Face" (
+            def Xform "GEO_Ear_L_1"
+                def Mesh "Ear" (
+            def Xform "GEO_Ear_R_2"
+                def Mesh "Ear" (
+            def Xform "GEO_Nose_3"
+                def Mesh "Nose" (
+def Xform "Camera"
+    def Camera "Camera"
+""".strip()
+
+class USDExportTest(AbstractUSDTest):
+    @with_tempdir
+    def test_export(self, tempdir: pathlib.Path):
+        """Very minimal test for USD exports."""
+        usd = tempdir / 'usd_hierarchy_export_test.usda'
+        script = f"import bpy; bpy.ops.wm.usd_export(filepath='{usd.as_posix()}'," \
+            " use_instancing=True)"
+        output = self.run_blender('usd_hierarchy_export_test.blend', script)
+
+        # Do some minimal assertions on the USDA file.
+        self.assertTrue(usd.exists(), f"File {usd} should exist: {output}")
+        usd_contents = usd.read_text(encoding='utf8')
+        self.assertIn('metersPerUnit = 1', usd_contents[:256])
+        self.assertIn('upAxis = "Z"', usd_contents[:256])
+
+        # Uncomment to get a copy of the file that won't be deleted.
+        # import shutil
+        # shutil.copy(usd, "/tmp/usd_hierarchy_export_test.usda")
+
+        # Build a representation based on indent + 'def' keywords
+        hierarchy = []
+        lines = usd_contents.splitlines()
+        for line in lines:
+            unindented = line.lstrip()
+            if not unindented.startswith('def '):
+                continue
+            hierarchy.append(line)
+        self.maxDiff = 2 * len(expected_hierarchy)
+        self.assertEqual(expected_hierarchy, '\n'.join(hierarchy))
+
+
+if __name__ == '__main__':
+    parser = argparse.ArgumentParser()
+    parser.add_argument('--blender', required=True)
+    parser.add_argument('--testdir', required=True)
+    args, remaining = parser.parse_known_args()
+
+    unittest.main(argv=sys.argv[0:1] + remaining)