Merge branch 'develop' into deature/OP-2839_Basic-event-system

openpype/hosts/harmony/api/pipeline.py

@@ -10,6 +10,7 @@ from avalon.pipeline import AVALON_CONTAINER_ID
 
 from openpype import lib
 from openpype.lib import register_event_callback
+from openpype.pipeline import LegacyCreator
 import openpype.hosts.harmony
 import openpype.hosts.harmony.api as harmony
 
@@ -180,7 +181,7 @@ def install():
     pyblish.api.register_host("harmony")
     pyblish.api.register_plugin_path(PUBLISH_PATH)
     avalon.api.register_plugin_path(avalon.api.Loader, LOAD_PATH)
-    avalon.api.register_plugin_path(avalon.api.Creator, CREATE_PATH)
+    avalon.api.register_plugin_path(LegacyCreator, CREATE_PATH)
     log.info(PUBLISH_PATH)
 
     # Register callbacks.
@@ -194,7 +195,7 @@ def install():
 def uninstall():
     pyblish.api.deregister_plugin_path(PUBLISH_PATH)
     avalon.api.deregister_plugin_path(avalon.api.Loader, LOAD_PATH)
-    avalon.api.deregister_plugin_path(avalon.api.Creator, CREATE_PATH)
+    avalon.api.deregister_plugin_path(LegacyCreator, CREATE_PATH)
 
 
 def on_pyblish_instance_toggled(instance, old_value, new_value):

openpype/hosts/harmony/api/plugin.py

@@ -1,9 +1,8 @@
-import avalon.api
-from openpype.api import PypeCreatorMixin
+from openpype.pipeline import LegacyCreator
 import openpype.hosts.harmony.api as harmony
 
 
-class Creator(PypeCreatorMixin, avalon.api.Creator):
+class Creator(LegacyCreator):
     """Creator plugin to create instances in Harmony.
 
     By default a Composite node is created to support any number of nodes in

openpype/hosts/harmony/plugins/publish/help/validate_audio.xml

@@ -0,0 +1,15 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<root>
+<error id="main">
+<title>Missing audio file</title>
+<description>
+## Cannot locate linked audio file
+
+Audio file at {audio_url} cannot be found.
+
+### How to repair?
+
+Copy audio file to the highlighted location or remove audio link in the workfile.
+</description>
+</error>
+</root>

openpype/hosts/harmony/plugins/publish/help/validate_instances.xml

@@ -0,0 +1,25 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<root>
+<error id="main">
+<title>Subset context</title>
+<description>
+## Invalid subset context
+
+Asset name found '{found}' in subsets, expected '{expected}'.
+
+### How to repair?
+
+You can fix this with `Repair` button on the right. This will use '{expected}' asset name and overwrite '{found}' asset name in scene metadata.
+
+After that restart `Publish` with a `Reload button`.
+
+If this is unwanted, close workfile and open again, that way different asset value would be used for context information.
+</description>
+<detail>
+### __Detailed Info__ (optional)
+
+This might happen if you are reuse old workfile and open it in different context.
+(Eg. you created subset "renderCompositingDefault" from asset "Robot' in "your_project_Robot_compositing.aep", now you opened this workfile in a context "Sloth" but existing subset for "Robot" asset stayed in the workfile.)
+</detail>
+</error>
+</root>

openpype/hosts/harmony/plugins/publish/help/validate_scene_settings.xml

@@ -0,0 +1,35 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<root>
+<error id="main">
+<title>Scene setting</title>
+<description>
+## Invalid scene setting found
+
+One of the settings in a scene doesn't match to asset settings in database.
+
+{invalid_setting_str}
+
+### How to repair?
+
+Change values for {invalid_keys_str} in the scene OR change them in the asset database if they are wrong there.
+</description>
+<detail>
+### __Detailed Info__ (optional)
+
+This error is shown when for example resolution in the scene doesn't match to resolution set on the asset in the database.
+Either value in the database or in the scene is wrong.
+</detail>
+</error>
+<error id="file_not_found">
+<title>Scene file doesn't exist</title>
+<description>
+## Scene file doesn't exist
+
+Collected scene {scene_url} doesn't exist.
+
+### How to repair?
+
+Re-save file, start publish from the beginning again.
+</description>
+</error>
+</root>

openpype/hosts/harmony/plugins/publish/validate_audio.py

@@ -4,6 +4,8 @@ import pyblish.api
 
 import openpype.hosts.harmony.api as harmony
 
+from openpype.pipeline import PublishXmlValidationError
+
 
 class ValidateAudio(pyblish.api.InstancePlugin):
     """Ensures that there is an audio file in the scene.
@@ -42,4 +44,9 @@ class ValidateAudio(pyblish.api.InstancePlugin):
 
         msg = "You are missing audio file:\n{}".format(audio_path)
 
-        assert os.path.isfile(audio_path), msg
+        formatting_data = {
+            "audio_url": audio_path
+        }
+        if os.path.isfile(audio_path):
+            raise PublishXmlValidationError(self, msg,
+                                            formatting_data=formatting_data)

openpype/hosts/harmony/plugins/publish/validate_instances.py

@@ -2,6 +2,7 @@ import os
 
 import pyblish.api
 import openpype.api
+from openpype.pipeline import PublishXmlValidationError
 import openpype.hosts.harmony.api as harmony
 
 
@@ -45,4 +46,11 @@ class ValidateInstance(pyblish.api.InstancePlugin):
             "Instance asset is not the same as current asset:"
             f"\nInstance: {instance_asset}\nCurrent: {current_asset}"
         )
-        assert instance_asset == current_asset, msg
+
+        formatting_data = {
+            "found": instance_asset,
+            "expected": current_asset
+        }
+        if instance_asset != current_asset:
+            raise PublishXmlValidationError(self, msg,
+                                            formatting_data=formatting_data)

openpype/hosts/harmony/plugins/publish/validate_scene_settings.py

@@ -7,7 +7,7 @@ import re
 import pyblish.api
 
 import openpype.hosts.harmony.api as harmony
-import openpype.hosts.harmony
+from openpype.pipeline import PublishXmlValidationError
 
 
 class ValidateSceneSettingsRepair(pyblish.api.Action):
@@ -19,12 +19,12 @@ class ValidateSceneSettingsRepair(pyblish.api.Action):
 
     def process(self, context, plugin):
         """Repair action entry point."""
-        expected = openpype.hosts.harmony.api.get_asset_settings()
+        expected = harmony.get_asset_settings()
         asset_settings = _update_frames(dict.copy(expected))
         asset_settings["frameStart"] = 1
         asset_settings["frameEnd"] = asset_settings["frameEnd"] + \
             asset_settings["handleEnd"]
-        openpype.hosts.harmony.api.set_scene_settings(asset_settings)
+        harmony.set_scene_settings(asset_settings)
         if not os.path.exists(context.data["scenePath"]):
             self.log.info("correcting scene name")
             scene_dir = os.path.dirname(context.data["currentFile"])
@@ -55,7 +55,7 @@ class ValidateSceneSettings(pyblish.api.InstancePlugin):
 
     def process(self, instance):
         """Plugin entry point."""
-        expected_settings = openpype.hosts.harmony.api.get_asset_settings()
+        expected_settings = harmony.get_asset_settings()
         self.log.info("scene settings from DB:".format(expected_settings))
 
         expected_settings = _update_frames(dict.copy(expected_settings))
@@ -102,13 +102,13 @@ class ValidateSceneSettings(pyblish.api.InstancePlugin):
         self.log.debug("current scene settings {}".format(current_settings))
 
         invalid_settings = []
+        invalid_keys = set()
         for key, value in expected_settings.items():
             if value != current_settings[key]:
-                invalid_settings.append({
-                    "name": key,
-                    "expected": value,
-                    "current": current_settings[key]
-                })
+                invalid_settings.append(
+                    "{} expected: {}  found: {}".format(key, value,
+                                                        current_settings[key]))
+                invalid_keys.add(key)
 
         if ((expected_settings["handleStart"]
             or expected_settings["handleEnd"])
@@ -120,10 +120,30 @@ class ValidateSceneSettings(pyblish.api.InstancePlugin):
         msg = "Found invalid settings:\n{}".format(
             json.dumps(invalid_settings, sort_keys=True, indent=4)
         )
-        assert not invalid_settings, msg
-        assert os.path.exists(instance.context.data.get("scenePath")), (
-            "Scene file not found (saved under wrong name)"
-        )
+
+        if invalid_settings:
+            invalid_keys_str = ",".join(invalid_keys)
+            break_str = "<br/>"
+            invalid_setting_str = "<b>Found invalid settings:</b><br/>{}".\
+                format(break_str.join(invalid_settings))
+
+            formatting_data = {
+                "invalid_setting_str": invalid_setting_str,
+                "invalid_keys_str": invalid_keys_str
+            }
+            raise PublishXmlValidationError(self, msg,
+                                            formatting_data=formatting_data)
+
+        scene_url = instance.context.data.get("scenePath")
+        if not os.path.exists(scene_url):
+            msg = "Scene file {} not found (saved under wrong name)".format(
+                scene_url
+            )
+            formatting_data = {
+                "scene_url": scene_url
+            }
+            raise PublishXmlValidationError(self, msg, key="file_not_found",
+                                            formatting_data=formatting_data)
 
 
 def _update_frames(expected_settings):