Deadline: webservice password

client/ayon_core/hosts/aftereffects/plugins/publish/collect_render.py

@@ -143,6 +143,7 @@ def get_instances(self, context):
  if "review" in instance.families:
  # to skip ExtractReview locally
  instance.families.remove("review")
+ instance.deadline = inst.data.get("deadline")
 
  instances.append(instance)
  instances_to_remove.append(inst)

client/ayon_core/hosts/fusion/plugins/publish/collect_render.py

@@ -113,6 +113,7 @@ def get_instances(self, context):
  if "review" in instance.families:
  # to skip ExtractReview locally
  instance.families.remove("review")
+ instance.deadline = inst.data.get("deadline")
 
  # add new instance to the list and remove the original
  # instance since it is not needed anymore

client/ayon_core/hosts/harmony/plugins/publish/collect_farm_render.py

@@ -177,7 +177,10 @@ def get_instances(self, context):
  outputFormat=info[1],
  outputStartFrame=info[3],
  leadingZeros=info[2],
- ignoreFrameHandleCheck=True
+ ignoreFrameHandleCheck=True,
+ #todo: inst is not available, must be determined, fix when
+ #reworking to Publisher
+ # deadline=inst.data.get("deadline")
 
  )
  render_instance.context = context

client/ayon_core/modules/deadline/__init__.py

@@ -1,6 +1,8 @@
 from .deadline_module import DeadlineModule
+from .version import __version__
 
 
 __all__ = (
  "DeadlineModule",
+ "__version__"
 )

client/ayon_core/modules/deadline/abstract_submit_deadline.py

@@ -49,6 +49,10 @@ def requests_post(*args, **kwargs):
  if 'verify' not in kwargs:
  kwargs['verify'] = False if os.getenv("OPENPYPE_DONT_VERIFY_SSL",
  True) else True # noqa
+
+ auth = kwargs.get("auth")
+ if auth:
+ kwargs["auth"] = tuple(auth) # explicit cast to tuple
  # add 10sec timeout before bailing out
  kwargs['timeout'] = 10
  return requests.post(*args, **kwargs)
@@ -70,6 +74,9 @@ def requests_get(*args, **kwargs):
  if 'verify' not in kwargs:
  kwargs['verify'] = False if os.getenv("OPENPYPE_DONT_VERIFY_SSL",
  True) else True # noqa
+ auth = kwargs.get("auth")
+ if auth:
+ kwargs["auth"] = tuple(auth)
  # add 10sec timeout before bailing out
  kwargs['timeout'] = 10
  return requests.get(*args, **kwargs)
@@ -434,9 +441,7 @@ def process(self, instance):
  """Plugin entry point."""
  self._instance = instance
  context = instance.context
- self._deadline_url = context.data.get("defaultDeadline")
- self._deadline_url = instance.data.get(
- "deadlineUrl", self._deadline_url)
+ self._deadline_url = instance.data["deadline"]["url"]
 
  assert self._deadline_url, "Requires Deadline Webservice URL"
 
@@ -460,7 +465,8 @@ def process(self, instance):
  self.plugin_info = self.get_plugin_info()
  self.aux_files = self.get_aux_files()
 
- job_id = self.process_submission()
+ auth = instance.data["deadline"]["auth"]
+ job_id = self.process_submission(auth)
  self.log.info("Submitted job to Deadline: {}.".format(job_id))
 
  # TODO: Find a way that's more generic and not render type specific
@@ -473,10 +479,10 @@ def process(self, instance):
  job_info=render_job_info,
  plugin_info=render_plugin_info
  )
- render_job_id = self.submit(payload)
+ render_job_id = self.submit(payload, auth)
  self.log.info("Render job id: %s", render_job_id)
 
- def process_submission(self):
+ def process_submission(self, auth=None):
  """Process data for submission.
 
  This takes Deadline JobInfo, PluginInfo, AuxFile, creates payload
@@ -487,7 +493,7 @@ def process_submission(self):
 
  """
  payload = self.assemble_payload()
- return self.submit(payload)
+ return self.submit(payload, auth)
 
  @abstractmethod
  def get_job_info(self):
@@ -577,14 +583,15 @@ def assemble_payload(
  "AuxFiles": aux_files or self.aux_files
  }
 
- def submit(self, payload):
+ def submit(self, payload, auth):
  """Submit payload to Deadline API end-point.
 
  This takes payload in the form of JSON file and POST it to
  Deadline jobs end-point.
 
  Args:
  payload (dict): dict to become json in deadline submission.
+ auth (tuple): (username, password)
 
  Returns:
  str: resulting Deadline job id.
@@ -594,7 +601,8 @@ def submit(self, payload):
 
  """
  url = "{}/api/jobs".format(self._deadline_url)
- response = requests_post(url, json=payload)
+ response = requests_post(url, json=payload,
+ auth=auth)
  if not response.ok:
  self.log.error("Submission failed!")
  self.log.error(response.status_code)

client/ayon_core/modules/deadline/deadline_module.py

@@ -19,23 +19,23 @@ class DeadlineModule(AYONAddon, IPluginPaths):
 
  def initialize(self, studio_settings):
  # This module is always enabled
- deadline_urls = {}
+ deadline_servers_info = {}
  enabled = self.name in studio_settings
  if enabled:
  deadline_settings = studio_settings[self.name]
- deadline_urls = {
- url_item["name"]: url_item["value"]
+ deadline_servers_info = {
+ url_item["name"]: url_item
  for url_item in deadline_settings["deadline_urls"]
  }
 
- if enabled and not deadline_urls:
+ if enabled and not deadline_servers_info:
  enabled = False
  self.log.warning((
  "Deadline Webservice URLs are not specified. Disabling addon."
  ))
 
  self.enabled = enabled
- self.deadline_urls = deadline_urls
+ self.deadline_servers_info = deadline_servers_info
 
  def get_plugin_paths(self):
  """Deadline plugin paths."""
@@ -45,13 +45,15 @@ def get_plugin_paths(self):
  }
 
  @staticmethod
- def get_deadline_pools(webservice, log=None):
+ def get_deadline_pools(webservice, auth=None, log=None):
  """Get pools from Deadline.
  Args:
  webservice (str): Server url.
- log (Logger)
+ auth (Optional[Tuple[str, str]]): Tuple containing username,
+ password
+ log (Optional[Logger]): Logger to log errors to, if provided.
  Returns:
- list: Pools.
+ List[str]: Pools.
  Throws:
  RuntimeError: If deadline webservice is unreachable.
 
@@ -63,7 +65,10 @@ def get_deadline_pools(webservice, log=None):
 
  argument = "{}/api/pools?NamesOnly=true".format(webservice)
  try:
- response = requests_get(argument)
+ kwargs = {}
+ if auth:
+ kwargs["auth"] = auth
+ response = requests_get(argument, **kwargs)
  except requests.exceptions.ConnectionError as exc:
  msg = 'Cannot connect to DL web service {}'.format(webservice)
  log.error(msg)

client/ayon_core/modules/deadline/plugins/publish/collect_deadline_server_from_instance.py

@@ -7,6 +7,7 @@
 """
 import pyblish.api
 from ayon_core.pipeline.publish import KnownPublishError
+from ayon_core.pipeline.context_tools import get_current_host_name
 
 
 class CollectDeadlineServerFromInstance(pyblish.api.InstancePlugin):
@@ -15,15 +16,39 @@ class CollectDeadlineServerFromInstance(pyblish.api.InstancePlugin):
  # Run before collect_render.
  order = pyblish.api.CollectorOrder + 0.005
  label = "Deadline Webservice from the Instance"
- families = ["rendering", "renderlayer"]
- hosts = ["maya"]
+ targets = ["local"]
+ families = ["render",
+ "rendering",
+ "render.farm",
+ "renderFarm",
+ "renderlayer",
+ "maxrender",
+ "usdrender",
+ "redshift_rop",
+ "arnold_rop",
+ "mantra_rop",
+ "karma_rop",
+ "vray_rop",
+ "publish.hou",
+ "image"] # for Fusion
 
  def process(self, instance):
- instance.data["deadlineUrl"] = self._collect_deadline_url(instance)
- instance.data["deadlineUrl"] = \
- instance.data["deadlineUrl"].strip().rstrip("/")
+ if not "deadline" in instance.data:
+ instance.data["deadline"] = {}
+
+ # todo: separate logic should be removed, all hosts should have same
+ host_name = get_current_host_name()
+ if host_name == "maya":
+ deadline_url = self._collect_deadline_url(instance)
+ else:
+ deadline_url = (instance.data.get("deadlineUrl") or # backwards
+ instance.data.get("deadline", {}).get("url"))
+ if deadline_url:
+ instance.data["deadline"]["url"] = deadline_url.strip().rstrip("/")
+ else:
+ instance.data["deadline"]["url"] = instance.context.data["deadline"]["defaultDeadline"] # noqa
  self.log.debug(
- "Using {} for submission.".format(instance.data["deadlineUrl"]))
+ "Using {} for submission".format(instance.data["deadline"]["url"]))
 
  def _collect_deadline_url(self, render_instance):
  # type: (pyblish.api.Instance) -> str
@@ -49,8 +74,8 @@ def _collect_deadline_url(self, render_instance):
  ["project_settings"]
  ["deadline"]
  )
-
- default_server = render_instance.context.data["defaultDeadline"]
+ default_server = (render_instance.context.data["deadline"]
+  ["defaultDeadline"])
  # QUESTION How and where is this is set? Should be removed?
  instance_server = render_instance.data.get("deadlineServers")
  if not instance_server:
@@ -66,7 +91,7 @@ def _collect_deadline_url(self, render_instance):
 
  default_servers = {
  url_item["name"]: url_item["value"]
- for url_item in deadline_settings["deadline_urls"]
+ for url_item in deadline_settings["deadline_servers_info"]
  }
  project_servers = (
  render_instance.context.data

client/ayon_core/modules/deadline/plugins/publish/collect_default_deadline_server.py

@@ -20,8 +20,7 @@ class CollectDefaultDeadlineServer(pyblish.api.ContextPlugin):
  # Run before collect_deadline_server_instance.
  order = pyblish.api.CollectorOrder + 0.0025
  label = "Default Deadline Webservice"
-
- pass_mongo_url = False
+ targets = ["local"]
 
  def process(self, context):
  try:
@@ -33,15 +32,17 @@ def process(self, context):
  deadline_settings = context.data["project_settings"]["deadline"]
  deadline_server_name = deadline_settings["deadline_server"]
 
- deadline_webservice = None
+ dl_server_info = None
  if deadline_server_name:
- deadline_webservice = deadline_module.deadline_urls.get(
+ dl_server_info = deadline_module.deadline_servers_info.get(
  deadline_server_name)
 
- default_deadline_webservice = deadline_module.deadline_urls["default"]
- deadline_webservice = (
-  deadline_webservice
- or default_deadline_webservice
- )
+ if dl_server_info:
+  deadline_url = dl_server_info["value"]
+ else:
+ default_dl_server_info = deadline_module.deadline_servers_info[0]
+  deadline_url = default_dl_server_info["value"]
 
- context.data["defaultDeadline"] = deadline_webservice.strip().rstrip("/") # noqa
+ context.data["deadline"] = {}
+ context.data["deadline"]["defaultDeadline"] = (
+ deadline_url.strip().rstrip("/"))

client/ayon_core/modules/deadline/plugins/publish/collect_user_credentials.py

@@ -0,0 +1,83 @@
+# -*- coding: utf-8 -*-
+"""Collect user credentials
+
+Requires:
+ context -> project_settings
+ instance.data["deadline"]["url"]
+
+Provides:
+ instance.data["deadline"] -> require_authentication (bool)
+ instance.data["deadline"] -> auth (tuple (str, str)) -
+ (username, password) or None
+"""
+import pyblish.api
+
+from ayon_api import get_server_api_connection
+from ayon_core.modules.deadline.deadline_module import DeadlineModule
+from ayon_core.modules.deadline import __version__
+
+
+class CollectDeadlineUserCredentials(pyblish.api.InstancePlugin):
+ """Collects user name and password for artist if DL requires authentication
+ """
+ order = pyblish.api.CollectorOrder + 0.200
+ label = "Collect Deadline User Credentials"
+
+ targets = ["local"]
+ hosts = ["aftereffects",
+ "fusion",
+ "harmony",
+ "nuke",
+ "maya",
+ "max",
+ "houdini"]
+
+ families = ["render",
+ "rendering",
+ "render.farm",
+ "renderFarm",
+ "renderlayer",
+ "maxrender",
+ "usdrender",
+ "redshift_rop",
+ "arnold_rop",
+ "mantra_rop",
+ "karma_rop",
+ "vray_rop",
+ "publish.hou"]
+
+ def process(self, instance):
+ collected_deadline_url = instance.data["deadline"]["url"]
+ if not collected_deadline_url:
+ raise ValueError("Instance doesn't have '[deadline][url]'.")
+ context_data = instance.context.data
+ deadline_settings = context_data["project_settings"]["deadline"]
+
+ deadline_server_name = None
+ # deadline url might be set directly from instance, need to find
+ # metadata for it
+ for deadline_info in deadline_settings["deadline_urls"]:
+ dl_settings_url = deadline_info["value"].strip().rstrip("/")
+ if dl_settings_url == collected_deadline_url:
+ deadline_server_name = deadline_info["name"]
+ break
+
+ if not deadline_server_name:
+ raise ValueError(f"Collected {collected_deadline_url} doesn't " 
+ "match any site configured in Studio Settings")
+
+ instance.data["deadline"]["require_authentication"] = (
+ deadline_info["require_authentication"]
+ )
+ instance.data["deadline"]["auth"] = None
+
+ if not deadline_info["require_authentication"]:
+ return
+
+ local_settings = get_server_api_connection().get_addon_site_settings(
+ DeadlineModule.name, __version__)
+ local_settings = local_settings["local_settings"]
+ for server_info in local_settings:
+ if deadline_server_name == server_info["server_name"]:
+ instance.data["deadline"]["auth"] = (server_info["username"],
+ server_info["password"])