test(auto_export): added tests for changed parameters tracking & change tracking

* added testing based on timestamps of generated files
 * found a (few ?) bugs in change tracking based on these, fixing next

tools/gltf_auto_export/auto_export/export_gltf.py

@@ -51,7 +51,7 @@ def generate_gltf_export_preferences(addon_prefs):
     standard_gltf_exporter_settings = bpy.data.texts[".gltf_auto_export_gltf_settings"] if ".gltf_auto_export_gltf_settings" in bpy.data.texts else bpy.data.texts.new(".gltf_auto_export_gltf_settings")
     standard_gltf_exporter_settings = json.loads(standard_gltf_exporter_settings.as_string())
     """standard_gltf_exporter_settings = get_standard_exporter_settings()"""
-    print("standard settings", standard_gltf_exporter_settings)
+    #print("standard settings", standard_gltf_exporter_settings)
     
     constant_keys = [
         'use_selection',

tools/gltf_auto_export/auto_export/operators.py

@@ -191,7 +191,6 @@ class AutoExportGLTF(Operator, AutoExportGltfAddonPreferences, ExportHelper):
         return changed
 
     def execute(self, context):    
-          
         # disable change detection while the operator runs
         bpy.context.window_manager.auto_export_tracker.disable_change_detection()
         if self.direct_mode:
@@ -207,6 +206,8 @@ class AutoExportGLTF(Operator, AutoExportGltfAddonPreferences, ExportHelper):
                 params_changed = self.did_export_settings_change()
                 auto_export(changes_per_scene, params_changed, self)
             # cleanup
+            #bpy.context.window_manager.auto_export_tracker.enable_change_detection()
+            # FIXME: wrong logic, this should be called only in an glTF2_post_export_callback
             bpy.app.timers.register(bpy.context.window_manager.auto_export_tracker.enable_change_detection, first_interval=1)
         else: 
             print("auto export disabled, skipping")

tools/gltf_auto_export/auto_export/tracker.py

@@ -90,7 +90,7 @@ class AutoExportTracker(PropertyGroup):
                     if isinstance(obj.id, bpy.types.Object):
                         # get the actual object
                         object = bpy.data.objects[obj.id.name]
-                        # print("changed object", obj.id.name)
+                        #print("changed object", obj.id.name)
                         cls.changed_objects_per_scene[scene.name][obj.id.name] = object
                     elif isinstance(obj.id, bpy.types.Material): # or isinstance(obj.id, bpy.types.ShaderNodeTree):
                         # print("changed material", obj.id, "scene", scene.name,)
@@ -117,7 +117,10 @@ class AutoExportTracker(PropertyGroup):
     def disable_change_detection(self,):
         self.change_detection_enabled = False
         self.__class__.change_detection_enabled = False
+        return None
+    
     def enable_change_detection(self):
         self.change_detection_enabled = True
         self.__class__.change_detection_enabled = True
+        return None
 

tools/gltf_auto_export/tests/test_bevy_integration.py

@@ -45,10 +45,11 @@ def setup_data(request):
 
 
 """
-- removes existing gltf files if needed
 - calls exporter on the testing scene
 - launches bevy app & checks for output
+- checks screenshot, hierarchy & diagnostics files generated on the bevy side against reference files
 - if all worked => test is a-ok
+- removes generated files
 """
 def test_export_complex(setup_data):
     root_path = "../../testing/bevy_example"
@@ -62,7 +63,6 @@ def test_export_complex(setup_data):
     export_props = {
         "main_scene_names" : ['World'],
         "library_scene_names": ['Library'],
-        # "export_format":'GLTF_SEPARATE'
     }
     gltf_settings = {
         "export_animations": True,

tools/gltf_auto_export/tests/test_change_tracking.py

@@ -0,0 +1,208 @@
+import bpy
+import os 
+import json
+import pytest
+import shutil
+
+@pytest.fixture
+def setup_data(request):
+    print("\nSetting up resources...")
+
+    def finalizer():
+        root_path =  "../../testing/bevy_example"
+        assets_root_path = os.path.join(root_path, "assets")
+        models_path =  os.path.join(assets_root_path, "models")
+        materials_path = os.path.join(assets_root_path, "materials")
+        #other_materials_path = os.path.join("../../testing", "other_materials")
+
+        print("\nPerforming teardown...")
+        if os.path.exists(models_path):
+            shutil.rmtree(models_path)
+
+        if os.path.exists(materials_path):
+            shutil.rmtree(materials_path)
+
+        diagnostics_file_path = os.path.join(root_path, "bevy_diagnostics.json")
+        if os.path.exists(diagnostics_file_path):
+            os.remove(diagnostics_file_path)
+        
+        hierarchy_file_path = os.path.join(root_path, "bevy_hierarchy.json")
+        if os.path.exists(hierarchy_file_path):
+            os.remove(hierarchy_file_path)
+
+        screenshot_observed_path = os.path.join(root_path, "screenshot.png")
+        if os.path.exists(screenshot_observed_path):
+            os.remove(screenshot_observed_path)
+
+    request.addfinalizer(finalizer)
+
+    return None
+
+import bpy
+import os 
+import json
+import pytest
+import shutil
+
+@pytest.fixture
+def setup_data(request):
+    print("\nSetting up resources...")
+
+    def finalizer():
+        root_path =  "../../testing/bevy_example"
+        assets_root_path = os.path.join(root_path, "assets")
+        models_path =  os.path.join(assets_root_path, "models")
+        materials_path = os.path.join(assets_root_path, "materials")
+        #other_materials_path = os.path.join("../../testing", "other_materials")
+
+        print("\nPerforming teardown...")
+        if os.path.exists(models_path):
+            shutil.rmtree(models_path)
+
+        if os.path.exists(materials_path):
+            shutil.rmtree(materials_path)
+
+        diagnostics_file_path = os.path.join(root_path, "bevy_diagnostics.json")
+        if os.path.exists(diagnostics_file_path):
+            os.remove(diagnostics_file_path)
+        
+        hierarchy_file_path = os.path.join(root_path, "bevy_hierarchy.json")
+        if os.path.exists(hierarchy_file_path):
+            os.remove(hierarchy_file_path)
+
+        screenshot_observed_path = os.path.join(root_path, "screenshot.png")
+        if os.path.exists(screenshot_observed_path):
+            os.remove(screenshot_observed_path)
+
+    request.addfinalizer(finalizer)
+
+    return None
+
+
+"""
+- setup gltf parameters & auto_export parameters
+- calls exporter on the testing scene
+- saves timestamps of generated files
+- changes things in the main scene and/or library
+- checks if timestamps have changed
+- if all worked => test is a-ok
+- removes generated files
+
+"""
+def test_export_changed_parameters(setup_data):
+    root_path = "../../testing/bevy_example"
+    assets_root_path = os.path.join(root_path, "assets")
+    models_path = os.path.join(assets_root_path, "models")
+    auto_export_operator = bpy.ops.export_scenes.auto_gltf
+
+    # with change detection
+    # first, configure things
+    # we use the global settings for that
+    export_props = {
+        "main_scene_names" : ['World'],
+        "library_scene_names": ['Library'],
+    }
+  
+    # store settings for the auto_export part
+    stored_auto_settings = bpy.data.texts[".gltf_auto_export_settings"] if ".gltf_auto_export_settings" in bpy.data.texts else bpy.data.texts.new(".gltf_auto_export_settings")
+    stored_auto_settings.clear()
+    stored_auto_settings.write(json.dumps(export_props))
+
+    gltf_settings = {
+        "export_animations": False,
+        "export_optimize_animation_size": False
+    }
+    # and store settings for the gltf part
+    stored_gltf_settings = bpy.data.texts[".gltf_auto_export_gltf_settings"] if ".gltf_auto_export_gltf_settings" in bpy.data.texts else bpy.data.texts.new(".gltf_auto_export_gltf_settings")
+    stored_gltf_settings.clear()
+    stored_gltf_settings.write(json.dumps(gltf_settings))
+
+    auto_export_operator(
+        auto_export=True,
+        direct_mode=True,
+        export_output_folder="./models",
+        export_scene_settings=True,
+        export_blueprints=True,
+        export_legacy_mode=False,
+        export_materials_library=False
+    )
+
+    world_file_path = os.path.join(models_path, "World.glb")
+    assert os.path.exists(world_file_path) == True
+
+    models_library_path = os.path.join(models_path, "library")
+    model_library_file_paths = list(map(lambda file_name: os.path.join(models_library_path, file_name), sorted(os.listdir(models_library_path))))
+    modification_times_first = list(map(lambda file_path: os.path.getmtime(file_path), model_library_file_paths + [world_file_path]))
+    print("files", model_library_file_paths)
+    print("mod times", modification_times_first)
+
+    auto_export_operator(
+        auto_export=True,
+        direct_mode=True,
+        export_output_folder="./models",
+        export_scene_settings=True,
+        export_blueprints=True,
+        export_legacy_mode=False,
+        export_materials_library=False
+    )
+
+    modification_times_no_change = list(map(lambda file_path: os.path.getmtime(file_path), model_library_file_paths + [world_file_path]))
+    assert modification_times_no_change == modification_times_first
+
+    # now move the main cube & export again
+    bpy.context.window_manager.auto_export_tracker.enable_change_detection() # FIXME: should not be needed, but ..
+    bpy.data.objects["Cube"].location = [1, 0, 0]
+    
+    auto_export_operator(
+        auto_export=True,
+        direct_mode=True,
+        export_output_folder="./models",
+        export_scene_settings=True,
+        export_blueprints=True,
+        export_legacy_mode=False,
+        export_materials_library=False
+    )
+
+    modification_times = list(map(lambda file_path: os.path.getmtime(file_path), model_library_file_paths + [world_file_path]))
+    assert modification_times != modification_times_first
+    modification_times_first = modification_times
+
+
+    # now same, but move the cube in the library
+    print("library change")
+    bpy.data.objects["Blueprint1_mesh"].location = [1, 2, 1]
+    auto_export_operator(
+        auto_export=True,
+        direct_mode=True,
+        export_output_folder="./models",
+        export_scene_settings=True,
+        export_blueprints=True,
+        export_legacy_mode=False,
+        export_materials_library=False
+    )
+
+    modification_times = list(map(lambda file_path: os.path.getmtime(file_path), model_library_file_paths + [world_file_path]))
+    assert modification_times != modification_times_first
+    modification_times_first = modification_times
+
+    # now same, but using an operator
+    """ bpy.ops.transform.translate(value=(20.0, 0.0, 0.0))
+
+    auto_export_operator(
+        auto_export=True,
+        direct_mode=True,
+        export_output_folder="./models",
+        export_scene_settings=True,
+        export_blueprints=True,
+        export_legacy_mode=False,
+        export_materials_library=False
+    )
+
+    modification_times = list(map(lambda file_path: os.path.getmtime(file_path), model_library_file_paths + [world_file_path]))
+    assert modification_times != modification_times_first
+    modification_times_first = modification_times"""
+
+    
+
+
+   

tools/gltf_auto_export/tests/test_changed_parameters.py

@@ -0,0 +1,209 @@
+import bpy
+import os 
+import json
+import pytest
+import shutil
+
+@pytest.fixture
+def setup_data(request):
+    print("\nSetting up resources...")
+
+    def finalizer():
+        root_path =  "../../testing/bevy_example"
+        assets_root_path = os.path.join(root_path, "assets")
+        models_path =  os.path.join(assets_root_path, "models")
+        materials_path = os.path.join(assets_root_path, "materials")
+        #other_materials_path = os.path.join("../../testing", "other_materials")
+
+        print("\nPerforming teardown...")
+        if os.path.exists(models_path):
+            shutil.rmtree(models_path)
+
+        if os.path.exists(materials_path):
+            shutil.rmtree(materials_path)
+
+        diagnostics_file_path = os.path.join(root_path, "bevy_diagnostics.json")
+        if os.path.exists(diagnostics_file_path):
+            os.remove(diagnostics_file_path)
+        
+        hierarchy_file_path = os.path.join(root_path, "bevy_hierarchy.json")
+        if os.path.exists(hierarchy_file_path):
+            os.remove(hierarchy_file_path)
+
+        screenshot_observed_path = os.path.join(root_path, "screenshot.png")
+        if os.path.exists(screenshot_observed_path):
+            os.remove(screenshot_observed_path)
+
+    request.addfinalizer(finalizer)
+
+    return None
+
+
+"""
+- setup gltf parameters & auto_export parameters
+- calls exporter on the testing scene
+- saves timestamps of generated files
+- changes exporter parameters
+- checks if timestamps have changed
+- if all worked => test is a-ok
+- removes generated files
+
+"""
+def test_export_changed_parameters(setup_data):
+    root_path = "../../testing/bevy_example"
+    assets_root_path = os.path.join(root_path, "assets")
+    models_path = os.path.join(assets_root_path, "models")
+    auto_export_operator = bpy.ops.export_scenes.auto_gltf
+
+    # with change detection
+    # first, configure things
+    # we use the global settings for that
+    export_props = {
+        "main_scene_names" : ['World'],
+        "library_scene_names": ['Library'],
+    }
+  
+    # store settings for the auto_export part
+    stored_auto_settings = bpy.data.texts[".gltf_auto_export_settings"] if ".gltf_auto_export_settings" in bpy.data.texts else bpy.data.texts.new(".gltf_auto_export_settings")
+    stored_auto_settings.clear()
+    stored_auto_settings.write(json.dumps(export_props))
+
+    gltf_settings = {
+        "export_animations": True,
+        "export_optimize_animation_size": False
+    }
+    # and store settings for the gltf part
+    stored_gltf_settings = bpy.data.texts[".gltf_auto_export_gltf_settings"] if ".gltf_auto_export_gltf_settings" in bpy.data.texts else bpy.data.texts.new(".gltf_auto_export_gltf_settings")
+    stored_gltf_settings.clear()
+    stored_gltf_settings.write(json.dumps(gltf_settings))
+
+    # move the main cube
+    bpy.data.objects["Cube"].location = [1, 0, 0]
+    # move the cube in the library
+    bpy.data.objects["Blueprint1_mesh"].location = [1, 2, 1]
+
+    auto_export_operator(
+        auto_export=True,
+        direct_mode=True,
+        export_output_folder="./models",
+        export_scene_settings=True,
+        export_blueprints=True,
+        export_legacy_mode=False,
+        export_materials_library=True
+    )
+
+    world_file_path = os.path.join(models_path, "World.glb")
+    assert os.path.exists(world_file_path) == True
+
+    models_library_path = os.path.join(models_path, "library")
+    model_library_file_paths = list(map(lambda file_name: os.path.join(models_library_path, file_name), sorted(os.listdir(models_library_path))))
+    modification_times_first = list(map(lambda file_path: os.path.getmtime(file_path), model_library_file_paths))
+    print("files", model_library_file_paths)
+    print("mod times", modification_times_first)
+
+
+    # export again, with no param changes: this should NOT export anything again, ie, modification times should be the same
+    print("second export")
+    auto_export_operator(
+        auto_export=True,
+        direct_mode=True,
+        export_output_folder="./models",
+        export_scene_settings=True,
+        export_blueprints=True,
+        export_legacy_mode=False,
+        export_materials_library=True
+    )
+
+    modification_times_no_change = list(map(lambda file_path: os.path.getmtime(file_path), model_library_file_paths))
+    assert modification_times_no_change == modification_times_first
+
+
+
+    # export again, this time changing the gltf settings
+    print("third export, changed gltf parameters")
+
+    gltf_settings = {
+        "export_animations": True,
+        "export_optimize_animation_size": True
+    }
+
+    stored_gltf_settings = bpy.data.texts[".gltf_auto_export_gltf_settings"] if ".gltf_auto_export_gltf_settings" in bpy.data.texts else bpy.data.texts.new(".gltf_auto_export_gltf_settings")
+    stored_gltf_settings.clear()
+    stored_gltf_settings.write(json.dumps(gltf_settings))
+
+    auto_export_operator(
+        auto_export=True,
+        direct_mode=True,
+        export_output_folder="./models",
+        export_scene_settings=True,
+        export_blueprints=True,
+        export_legacy_mode=False,
+        export_materials_library=True
+    )
+
+    modification_times_changed_gltf = list(map(lambda file_path: os.path.getmtime(file_path), model_library_file_paths))
+    assert modification_times_changed_gltf != modification_times_first
+    modification_times_first = modification_times_changed_gltf
+
+    # now run it again, withouth changes, timestamps should be identical
+
+    auto_export_operator(
+        auto_export=True,
+        direct_mode=True,
+        export_output_folder="./models",
+        export_scene_settings=True,
+        export_blueprints=True,
+        export_legacy_mode=False,
+        export_materials_library=True
+    )
+
+    modification_times_changed_gltf = list(map(lambda file_path: os.path.getmtime(file_path), model_library_file_paths))
+    assert modification_times_changed_gltf == modification_times_first
+    modification_times_first = modification_times_changed_gltf
+
+
+    # export again, this time changing the auto_export settings
+    print("fourth export, changed auto parameters")
+
+    export_props = {
+        "main_scene_names" : ['World'],
+        "library_scene_names": ['Library'],
+        "export_materials_library": False # we need to add it here, as the direct settings set on the operator will only be used for the NEXT run
+    }
+  
+    # store settings for the auto_export part
+    stored_auto_settings = bpy.data.texts[".gltf_auto_export_settings"] if ".gltf_auto_export_settings" in bpy.data.texts else bpy.data.texts.new(".gltf_auto_export_settings")
+    stored_auto_settings.clear()
+    stored_auto_settings.write(json.dumps(export_props))
+
+    auto_export_operator(
+        auto_export=True,
+        direct_mode=True,
+        export_output_folder="./models",
+        export_scene_settings=True,
+        export_blueprints=True,
+        export_legacy_mode=False,
+        export_materials_library=False
+    )
+
+    modification_times_changed_auto = list(map(lambda file_path: os.path.getmtime(file_path), model_library_file_paths))
+    assert modification_times_changed_auto != modification_times_first
+    modification_times_first = modification_times_changed_auto
+
+    # now run it again, withouth changes, timestamps should be identical
+
+    auto_export_operator(
+        auto_export=True,
+        direct_mode=True,
+        export_output_folder="./models",
+        export_scene_settings=True,
+        export_blueprints=True,
+        export_legacy_mode=False,
+        export_materials_library=True
+    )
+
+    modification_times_changed_gltf = list(map(lambda file_path: os.path.getmtime(file_path), model_library_file_paths))
+    assert modification_times_changed_gltf == modification_times_first
+    modification_times_first = modification_times_changed_gltf
+
+