[zos_lineinfile]Robust JSON Parsing and Cmd Cleanup (#2080)

* fixed bugs

* added fragments

* fixed sanity

* Suggested fragment

* found deafult set to 0

* thrown the actual errorwhile parsing command output

* added test cases

* added fragments for adding test case

* suggested fragments added

* Update 2080-zos_lineinfile-fixed-json-parsing.yml

* added assertion

* CHANGED CODE LOGIC TO MAINTAIN STANDARD

* REMOVED UNWANTED IMPORT RE

---------

Co-authored-by: surendrababuravella <[email protected]>
Co-authored-by: Fernando Flores <[email protected]>

Author: 3 people

changelogs/fragments/2080-zos_lineinfile-fixed-json-parsing.yml

@@ -0,0 +1,7 @@
+bugfixes:
+  - zos_lineinfile - The module would report a false negative when certain special characters 
+    where present in the `line` option. Fix now reports the successful operation.
+    (https://github.com/ansible-collections/ibm_zos_core/pull/2080).
+trivial:
+  - test_zos_lineinfile_func - added test case to verify insertbefore functionality with regex pattern before Ansible block line.
+    (https://github.com/ansible-collections/ibm_zos_core/pull/2080).

plugins/modules/zos_lineinfile.py

@@ -757,16 +757,39 @@ def main():
         if ins_bef:
             stdout = stdout.replace(ins_bef, quotedString(ins_bef))
         try:
+            # Attempt to parse stdout content directly as JSON
             ret = json.loads(stdout)
-        except Exception:
-            messageDict = dict(msg="dsed return content is NOT in json format", stdout=str(stdout), stderr=str(stderr), rc=rc)
-            if result.get('backup_name'):
-                messageDict['backup_name'] = result['backup_name']
-            module.fail_json(**messageDict)
-
-        result['cmd'] = ret['cmd']
-        result['changed'] = ret['changed']
-        result['found'] = ret['found']
+        except json.JSONDecodeError:
+            try:
+                # If parsing fails, clean up possible wrapping quotes
+                if (stdout.startswith("'") and stdout.endswith("'")) or (stdout.startswith('"') and stdout.endswith('"')):
+                    cleaned_stdout = stdout[1:-1]
+                else:
+                    cleaned_stdout = stdout
+                # Replace escaped backslashes with single backslashes
+                cleaned_stdout = cleaned_stdout.replace('\\\\', '\\')
+                # Further clean up: escape any single backslashes not followed by a valid JSON escape character
+                import re
+                cleaned_stdout = re.sub(r'\\([^"\\/bfnrtu])', r'\\\\\1', cleaned_stdout)
+                # Try parsing the cleaned string as JSON
+                ret = json.loads(cleaned_stdout)
+            except Exception as e:
+                # If still failing, report failure with useful debug info
+                messageDict = dict(
+                    msg=f"Failed while parsing command output {str(e)} ",
+                    stdout=str(stdout),
+                    stderr=str(stderr),
+                    rc=rc
+                )
+                if result.get('backup_name'):
+                    messageDict['backup_name'] = result['backup_name']
+                module.fail_json(**messageDict)
+        # If the parsed JSON has a 'cmd' key, clean its string for safe use
+        if 'cmd' in ret:
+            ret['cmd'] = ret['cmd'].replace('\\"', '"').replace('\\\\', '\\')
+            result['cmd'] = ret['cmd']
+        result['changed'] = ret.get('changed', False)
+        result['found'] = ret.get('found', 0)
     # Only return 'rc' if stderr is not empty to not fail the playbook run in a nomatch case
     # That information will be given with 'changed' and 'found'
     if len(stderr):

tests/functional/modules/test_zos_lineinfile_func.py

@@ -61,6 +61,31 @@
 export ZOAU_ROOT
 export _BPXK_AUTOCVT"""
 
+TEST_PARSING_CONTENT = """if [ -z STEPLIB ] && tty -s;
+then
+    export STEPLIB=none
+    exec -a 0 SHELL
+fi
+PATH=/usr/lpp/zoautil/v100/bin:/usr/lpp/rsusr/ported/bin:/bin:/var/bin
+export PATH
+ZOAU_ROOT=/usr/lpp/zoautil/v100
+export ZOAU_ROOT
+export _BPXK_AUTOCVT
+/*  End Ansible Block Insert */"""
+
+EXPECTED_TEST_PARSING_CONTENT = """if [ -z STEPLIB ] && tty -s;
+then
+    export STEPLIB=none
+    exec -a 0 SHELL
+fi
+PATH=/usr/lpp/zoautil/v100/bin:/usr/lpp/rsusr/ported/bin:/bin:/var/bin
+export PATH
+ZOAU_ROOT=/usr/lpp/zoautil/v100
+export ZOAU_ROOT
+export _BPXK_AUTOCVT
+SYMDEF(&IPVSRV1='IPL')
+/*  End Ansible Block Insert */"""
+
 TEST_CONTENT_ADVANCED_REGULAR_EXPRESSION="""if [ -z STEPLIB ] && tty -s;
 then
     D160882
@@ -681,6 +706,34 @@ def test_ds_line_insertafter_regex(ansible_zos_module, dstype):
     finally:
         remove_ds_environment(ansible_zos_module, ds_name)
 
+@pytest.mark.ds
+@pytest.mark.parametrize("dstype", ds_type)
+def test_ds_line_insert_before_ansible_block(ansible_zos_module, dstype):
+    hosts = ansible_zos_module
+    ds_type = dstype
+
+    params = {
+        "insertbefore": "/\*  End Ansible Block Insert \*/",
+        "line": "SYMDEF(&IPVSRV1='IPL')",
+        "state": "present"
+    }
+
+    ds_name = get_tmp_ds_name()
+    temp_file = get_random_file_name(dir=TMP_DIRECTORY)
+    content = TEST_PARSING_CONTENT
+
+    try:
+        ds_full_name = set_ds_environment(ansible_zos_module, temp_file, ds_name, ds_type, content)
+        params["path"] = ds_full_name
+
+        results = hosts.all.zos_lineinfile(**params)
+        for result in results.contacted.values():
+            assert result.get("changed") == 1
+        results = hosts.all.shell(cmd="cat \"//'{0}'\" ".format(params["path"]))
+        for result in results.contacted.values():
+            assert result.get("stdout") == EXPECTED_TEST_PARSING_CONTENT
+    finally:
+        remove_ds_environment(ansible_zos_module, ds_name)
 
 @pytest.mark.ds
 @pytest.mark.parametrize("dstype", ds_type)