Deadline: webservice password

client/ayon_core/modules/deadline/abstract_submit_deadline.py

@@ -460,7 +460,9 @@ def process(self, instance):
  self.plugin_info = self.get_plugin_info()
  self.aux_files = self.get_aux_files()
 
- job_id = self.process_submission()
+ auth = context.data.get("deadline_auth")
+ self.log.info(f"auth::{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 +475,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 +489,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 +579,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 +597,11 @@ def submit(self, payload):
 
  """
  url = "{}/api/jobs".format(self._deadline_url)
- response = requests_post(url, json=payload)
+ kwargs = {}
+ if auth:
+ kwargs["auth"] = auth
+ response = requests_post(url, json=payload,
+ **kwargs)
  if not response.ok:
  self.log.error("Submission failed!")
  self.log.error(response.status_code)

client/ayon_core/modules/deadline/deadline_module.py

@@ -45,7 +45,7 @@ def get_plugin_paths(self):
  }
 
  @staticmethod
- def get_deadline_pools(webservice, log=None):
+ def get_deadline_pools(webservice, auth=None, log=None):
  # type: (str) -> list
  """Get pools from Deadline.
  Args:
@@ -64,7 +64,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_user_credentials.py

@@ -0,0 +1,34 @@
+# -*- coding: utf-8 -*-
+"""Collect user credentials
+
+Requires:
+ context -> project_settings
+
+Provides:
+ context -> deadline_require_authentication (bool)
+ context -> deadline_auth (tuple (str, str)) - (username, password) or None
+"""
+import pyblish.api
+
+
+class CollectUserCredentials(pyblish.api.ContextPlugin):
+ """Collects user name and password for artist if DL requires authentication
+ """
+
+ # Run before collect_deadline_server_instance.
+ order = pyblish.api.CollectorOrder
+ label = "Collect Deadline User Credentials"
+
+ def process(self, context):
+ deadline_settings = context.data["project_settings"]["deadline"]
+
+ context.data["deadline_require_authentication"] = (
+ deadline_settings)["require_authentication"]
+ context.data["deadline_auth"] = None
+
+ if not context.data["deadline_require_authentication"]:
+ return
+
+ local_settings = deadline_settings["local_settings"]
+ context.data["deadline_auth"] = (local_settings["username"],
+ local_settings["password"])

client/ayon_core/modules/deadline/plugins/publish/help/validate_deadline_connection.xml

@@ -0,0 +1,17 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<root>
+ <error id="main">
+ <title>Deadline Authentication</title>
+ <description>
+## Deadline authenticatin is required
+
+This project has set in Settings that Deadline requires authentication.
+
+### How to repair?
+
+Please go to Ayon Server Site settings and provide your Deadline username and
+ most likely password too. (Deadline could run in configuration that empty passwords are allowed. Ask your administrator for details.)
+
+ </description>
+ </error>
+</root>

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

@@ -2,9 +2,10 @@
 import re
 import json
 import getpass
-import requests
 import pyblish.api
 
+from openpype_modules.deadline.abstract_submit_deadline import requests_post
+
 
 class CelactionSubmitDeadline(pyblish.api.InstancePlugin):
  """Submit CelAction2D scene to Deadline
@@ -193,7 +194,10 @@ def payload_submit(self,
  self.log.debug("__ expectedFiles: `{}`".format(
  instance.data["expectedFiles"]))
 
- response = requests.post(self.deadline_url, json=payload)
+ kwargs = {}
+ if instance.context.data["deadline_auth"]:
+ kwargs["auth"] = instance.context.data["deadline_auth"]
+ response = requests_post(self.deadline_url, json=payload, **kwargs)
 
  if not response.ok:
  self.log.error(

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

@@ -2,10 +2,9 @@
 import json
 import getpass
 
-import requests
-
 import pyblish.api
 
+from openpype_modules.deadline.abstract_submit_deadline import requests_post
 from ayon_core.pipeline.publish import (
  AYONPyblishPluginMixin
 )
@@ -251,7 +250,10 @@ def process(self, instance):
 
  # E.g. http://192.168.0.1:8082/api/jobs
  url = "{}/api/jobs".format(deadline_url)
- response = requests.post(url, json=payload)
+ kwargs = {}
+ if instance.context.data["deadline_auth"]:
+ kwargs["auth"] = instance.context.data["deadline_auth"]
+ response = requests_post(url, json=payload, **kwargs)
  if not response.ok:
  raise Exception(response.text)
 

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

@@ -290,7 +290,7 @@ def get_plugin_info(self):
 
  return plugin_payload
 
- def process_submission(self):
+ def process_submission(self, auth=None):
  from maya import cmds
  instance = self._instance
 
@@ -330,7 +330,8 @@ def process_submission(self):
  if "vrayscene" in instance.data["families"]:
  self.log.debug("Submitting V-Ray scene render..")
  vray_export_payload = self._get_vray_export_payload(payload_data)
- export_job = self.submit(vray_export_payload)
+ export_job = self.submit(vray_export_payload,
+ instance.context.data["deadline_auth"])
 
  payload = self._get_vray_render_payload(payload_data)
 
@@ -349,7 +350,8 @@ def process_submission(self):
  else:
  # Submit main render job
  job_info, plugin_info = payload
- self.submit(self.assemble_payload(job_info, plugin_info))
+ self.submit(self.assemble_payload(job_info, plugin_info),
+ instance.context.data["deadline_auth"])
 
  def _tile_render(self, payload):
  """Submit as tile render per frame with dependent assembly jobs."""
@@ -449,7 +451,8 @@ def _tile_render(self, payload):
  # Submit frame tile jobs
  frame_tile_job_id = {}
  for frame, tile_job_payload in frame_payloads.items():
- job_id = self.submit(tile_job_payload)
+ job_id = self.submit(tile_job_payload,
+ instance.context.data["deadline_auth"])
  frame_tile_job_id[frame] = job_id
 
  # Define assembly payloads
@@ -557,7 +560,8 @@ def _tile_render(self, payload):
  "submitting assembly job {} of {}".format(i + 1,
  num_assemblies)
  )
- assembly_job_id = self.submit(payload)
+ assembly_job_id = self.submit(payload,
+ instance.context.data["deadline_auth"])
  assembly_job_ids.append(assembly_job_id)
 
  instance.data["assemblySubmissionJobs"] = assembly_job_ids

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

@@ -4,9 +4,9 @@
 import getpass
 from datetime import datetime
 
-import requests
 import pyblish.api
 
+from openpype_modules.deadline.abstract_submit_deadline import requests_post
 from ayon_core.pipeline.publish import (
  AYONPyblishPluginMixin
 )
@@ -434,7 +434,11 @@ def payload_submit(
 
  self.log.debug("__ expectedFiles: `{}`".format(
  instance.data["expectedFiles"]))
- response = requests.post(self.deadline_url, json=payload, timeout=10)
+ kwargs = {}
+ if instance.context.data["deadline_auth"]:
+ kwargs["auth"] = instance.context.data["deadline_auth"]
+ response = requests_post(self.deadline_url, json=payload, timeout=10,
+ **kwargs)
 
  if not response.ok:
  raise Exception(response.text)

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

@@ -5,10 +5,10 @@
 import re
 from copy import deepcopy
 
-import requests
 import ayon_api
 import pyblish.api
 
+from openpype_modules.deadline.abstract_submit_deadline import requests_post
 from ayon_core.pipeline import publish
 from ayon_core.lib import EnumDef, is_in_tests
 from ayon_core.pipeline.version_start import get_versioning_start
@@ -209,7 +209,11 @@ def _submit_deadline_post_job(self, instance, job):
  self.log.debug("Submitting Deadline publish job ...")
 
  url = "{}/api/jobs".format(self.deadline_url)
- response = requests.post(url, json=payload, timeout=10)
+ kwargs = {}
+ if instance.context.data["deadline_auth"]:
+ kwargs["auth"] = instance.context.data["deadline_auth"]
+ response = requests_post(url, json=payload, timeout=10,
+ **kwargs)
  if not response.ok:
  raise Exception(response.text)
 

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

@@ -5,11 +5,11 @@
 import re
 from copy import deepcopy
 
-import requests
 import clique
 import ayon_api
 import pyblish.api
 
+from openpype_modules.deadline.abstract_submit_deadline import requests_post
 from ayon_core.pipeline import publish
 from ayon_core.lib import EnumDef, is_in_tests
 from ayon_core.pipeline.version_start import get_versioning_start
@@ -303,7 +303,11 @@ def _submit_deadline_post_job(self, instance, job, instances):
  self.log.debug("Submitting Deadline publish job ...")
 
  url = "{}/api/jobs".format(self.deadline_url)
- response = requests.post(url, json=payload, timeout=10)
+ kwargs = {}
+ if instance.context.data["deadline_auth"]:
+ kwargs["auth"] = instance.context.data["deadline_auth"]
+ response = requests_post(url, json=payload, timeout=10,
+ **kwargs)
  if not response.ok:
  raise Exception(response.text)
 

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

@@ -1,5 +1,7 @@
 import pyblish.api
 
+from ayon_core.pipeline import PublishXmlValidationError
+
 from openpype_modules.deadline.abstract_submit_deadline import requests_get
 
 
@@ -15,8 +17,9 @@ class ValidateDeadlineConnection(pyblish.api.InstancePlugin):
  responses = {}
 
  def process(self, instance):
+ context = instance.context
  # get default deadline webservice url from deadline module
- deadline_url = instance.context.data["defaultDeadline"]
+ deadline_url = context.data["defaultDeadline"]
  # if custom one is set in instance, use that
  if instance.data.get("deadlineUrl"):
  deadline_url = instance.data.get("deadlineUrl")
@@ -25,10 +28,27 @@ def process(self, instance):
  )
  assert deadline_url, "Requires Deadline Webservice URL"
 
+ kwargs = {}
+ if context.data["deadline_require_authentication"]:
+ kwargs["auth"] = context.data["deadline_auth"]
+
+ if not context.data["deadline_auth"][0]:
+ raise PublishXmlValidationError(
+ self,
+ "Deadline requires authentication. "
+ "At least username is required to be set in "
+ "Site Settings.")
+
  if deadline_url not in self.responses:
- self.responses[deadline_url] = requests_get(deadline_url)
+ self.responses[deadline_url] = requests_get(deadline_url, **kwargs)
 
  response = self.responses[deadline_url]
+ if response.status_code == 401:
+ raise PublishXmlValidationError(
+ self,
+ "Deadline requires authentication. "
+ "Provided credentials are not working. "
+ "Please change them in Site Settings")
  assert response.ok, "Response must be ok"
  assert response.text.startswith("Deadline Web Service "), (
  "Web service did not respond with 'Deadline Web Service'"

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

@@ -38,7 +38,8 @@ def process(self, instance):
  return
 
  deadline_url = self.get_deadline_url(instance)
- pools = self.get_pools(deadline_url)
+ pools = self.get_pools(deadline_url,
+ instance.context.data["deadline_auth"])
 
  invalid_pools = {}
  primary_pool = instance.data.get("primaryPool")
@@ -69,13 +70,14 @@ def get_deadline_url(self, instance):
  deadline_url = instance.data.get("deadlineUrl")
  return deadline_url
 
- def get_pools(self, deadline_url):
+ def get_pools(self, deadline_url, auth):
  if deadline_url not in self.pools_per_url:
  self.log.debug(
  "Querying available pools for Deadline url: {}".format(
  deadline_url)
  )
  pools = DeadlineModule.get_deadline_pools(deadline_url,
+ auth=auth,
  log=self.log)
  self.log.info("Available pools: {}".format(pools))
  self.pools_per_url[deadline_url] = pools

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

@@ -208,7 +208,10 @@ def _get_job_info(self, instance, job_id):
 
  url = "{}/api/jobs?JobID={}".format(deadline_url, job_id)
  try:
- response = requests_get(url)
+ kwargs = {}
+ if instance.context.data["deadline_auth"]:
+ kwargs["auth"] = instance.context.data["deadline_auth"]
+ response = requests_get(url, **kwargs)
  except requests.exceptions.ConnectionError:
  self.log.error("Deadline is not accessible at "
  "{}".format(deadline_url))