Collector: collection_args - add tests

This shows that we can use external data inside collector hooks

Author: aoblet

tests/fixtures/config/hooks/api_collector.py

@@ -19,7 +19,7 @@ class BasicSceneCollector(HookBaseClass):
     A basic collector that handles files and general objects.
     """
 
-    def process_current_session(self, settings, parent_item):
+    def process_current_session(self, settings, parent_item, collection_args):
         """
         Analyzes the current scene open in a DCC and parents a subtree of items
         under the parent_item passed in.
@@ -45,3 +45,6 @@ def process_current_session(self, settings, parent_item):
         )
 
         parent_item.local_properties.collector_property = "collector_property"
+
+        if collection_args:
+            parent_item.properties.update(collection_args)

tests/fixtures/config/hooks/collector.py

@@ -19,7 +19,7 @@ class BasicSceneCollector(HookBaseClass):
     A basic collector that handles files and general objects.
     """
 
-    def process_current_session(self, settings, parent_item):
+    def process_current_session(self, settings, parent_item, collection_args):
         """
         Analyzes the current scene open in a DCC and parents a subtree of items
         under the parent_item passed in.

tests/test_manager.py

@@ -154,3 +154,35 @@ def test_nodes():
 
         with self.assertRaisesRegex(Exception, "Test error!"):
             self.manager.publish(test_nodes())
+
+    def test_collection_args(self):
+        """
+        Ensures the collection_args propagation to the collector hook
+        """
+        collection_args = {
+            "flag_1": True,
+            "flag_2": False,
+            "flag_3": 10,
+        }
+        # if collection_args is provided to collect_session
+        # api_collector adds collection_args to root item properties
+        # this is done only for test purposes
+
+        # without collection_args provided,
+        # root_item properties do not contain collection_args
+        self.manager.collect_session()
+        root_item = self.manager.tree.root_item
+        root_item_properties = root_item.properties
+        self.assertEqual('flag_1' not in root_item_properties, True)
+        self.assertEqual('flag_2' not in root_item_properties, True)
+        self.assertEqual('flag_3' not in root_item_properties, True)
+
+        # now we provide collection_args
+        self.manager.collect_session(collection_args)
+
+        # so properties should be filled
+        self.assertEqual(root_item.properties["flag_1"], collection_args["flag_1"])
+        self.assertEqual(root_item.properties["flag_2"], collection_args["flag_2"])
+        self.assertEqual(root_item.properties["flag_3"], collection_args["flag_3"])
+
+