jira: truncate description if max length exceeded (#12732)

* jira: truncate description if max length exceeded

* jira: truncate description if max length exceeded

* jira: truncate description if max length exceeded

* make extra room

* adjust to 2^15-1

Author: valentijnscholten

dojo/jira_link/helper.py

@@ -37,6 +37,7 @@
 from dojo.utils import (
     add_error_message_to_response,
     get_file_images,
+    get_full_url,
     get_system_setting,
     prod_name,
     to_str_typed,
@@ -646,6 +647,12 @@ def jira_description(obj, **kwargs):
         kwargs["finding_group"] = obj
 
     description = render_to_string(template, kwargs)
+    defect_dojo_obj_url = get_full_url(obj.get_absolute_url())
+    max_length = getattr(settings, "JIRA_DESCRIPTION_MAX_LENGTH", 32767)
+    suffix = f"\n\nIssue Description Too Long: See [DefectDojo|{defect_dojo_obj_url}] for full description."
+    if len(description) > max_length:
+        # suffix can be longer after rendering do to urlenocoding, so we take twice the length of the suffix as a buffer
+        description = description[:max_length - (2 * len(suffix))] + suffix
     logger.debug("rendered description: %s", description)
     return description
 

dojo/settings/settings.dist.py

@@ -226,6 +226,7 @@
     DD_MAX_REQRESP_FROM_API=(int, -1),
     DD_MAX_AUTOCOMPLETE_WORDS=(int, 20000),
     DD_JIRA_SSL_VERIFY=(bool, True),
+    DD_JIRA_DESCRIPTION_MAX_LENGTH=(int, 32767),
     # When interacting with jira tickets that attached finding groups, we should no be opening any findings
     # on the DefectDojo side because jira has no way of knowing if a finding really should be reopened or not
     DD_JIRA_WEBHOOK_ALLOW_FINDING_GROUP_REOPEN=(bool, False),
@@ -1643,6 +1644,7 @@ def saml2_attrib_map_format(din):
         JIRA_ISSUE_TYPE_CHOICES_CONFIG += ((extra_type, extra_type),)
 
 JIRA_SSL_VERIFY = env("DD_JIRA_SSL_VERIFY")
+JIRA_DESCRIPTION_MAX_LENGTH = env("DD_JIRA_DESCRIPTION_MAX_LENGTH")
 JIRA_WEBHOOK_ALLOW_FINDING_GROUP_REOPEN = env("DD_JIRA_WEBHOOK_ALLOW_FINDING_GROUP_REOPEN")
 
 # ------------------------------------------------------------------------------