Bugfix/374/module zos mvs raw errors with long multi line quoted string in content field

changelogs/fragments/1057-module_zos_mvs_raw_errors_with_long_multi_line_quoted_string_in_content_field.yml

@@ -0,0 +1,6 @@
+bugfixes:
+  - zos_mvs_raw - module wasn't able to write a multi-line JCL because it truncated
+    the first one or two characters, resulting in syntactically incorrect JCL.
+    Change now validates the length of lines and allow multi-line declaration with | or |1-9 by adding
+    two spaces to be syntactically correct.
+    (https://github.com/ansible-collections/ibm_zos_core/pull/1057).

plugins/modules/zos_mvs_raw.py

@@ -560,6 +560,9 @@
                 proper literal block style indicator "|".
               - If a list of strings is provided, newlines will be
                 added to each of the lines when used as input.
+              - The maximum length of the line is 80 columns including 2 spaces at the beginning.
+                If the two spaces aren't present, the module will add them to form syntactically
+                correct JCL (more information in the Notes section).
             required: true
             type: raw
           return_content:
@@ -1208,6 +1211,10 @@
     - 2. L(zos_mvs_raw,./zos_mvs_raw.html) module execution fails when invoking DFSRRC00 with parm
       "UPB,PRECOMP", "UPB, POSTCOMP" or "UPB,PRECOMP,POSTCOMP". This issue is
       addressed by APAR PH28089.
+    - 3. For syntactically correct JCL programs see the
+      L(JCL reference,https://www.ibm.com/docs/en/zos-basic-skills?topic=collection-coding-your-own-jcl).
+    - 4. For continuing a line of C(dd_input) see the reference for symbols (+/-) for extended lines
+      L(in the official documentation,https://www.ibm.com/docs/en/abo/2.1?topic=modules-line-continuation).
 seealso:
 - module: zos_data_set
 """
@@ -2166,6 +2173,11 @@ def dd_content(contents, dependencies):
     """
     if contents is None:
         return None
+    if contents is not None:
+        # Empty string can be passed for content but not modify to ensure proper entry
+        if len(contents) > 0:
+            contents = modify_contents(contents)
+        return contents
     if isinstance(contents, list):
         return "\n".join(contents)
     return contents
@@ -3090,6 +3102,42 @@ def get_content(formatted_name, binary=False, from_encoding=None, to_encoding=No
         return stdout
 
 
+def modify_contents(contents):
+    """Return the content of dd_input to a valid form for a JCL program.
+
+    Args:
+        contents (str or list): The string or list with the program.
+
+    Returns:
+        contents: The content in a proper multi line str.
+    """
+    if not isinstance(contents, list):
+        contents = list(contents.split("\n"))
+    contents = prepend_spaces(contents)
+    contents = "\n".join(contents)
+    return contents
+
+
+def prepend_spaces(lines):
+    """Return the array with two spaces at the beggining.
+
+    Args:
+        lines (list): The list with a line of a program.
+
+    Returns:
+        new_lines: The list in a proper two spaces and the code.
+    """
+    module = AnsibleModuleHelper(argument_spec={})
+    for index, line in enumerate(lines):
+        if len(line) > 0:
+            if len(line) > 78:
+                module.fail_json(msg="""Length of line {0} is over 80. The maximum length allowed is 80 columns, including 2 spaces at the beginning.
+                                 If the two spaces are not present, the module will add them to form syntactically correct JCL. """.format(line))
+            if len(line) > 1 and line[0] != " " and line[1] != " ":
+                lines[index] = "  {0}".format(line)
+    return lines
+
+
 class ZOSRawError(Exception):
     def __init__(self, program="", error=""):
         self.msg = "An error occurred during execution of z/OS program {0}. {1}".format(