[Bug][zos_apf] Ensure idempotency in zos_apf when a library is added or removed

[Rohitcodes28]

SUMMARY

Added ignore error in the apf add and delete

Fixes #1662

ISSUE TYPE

• Bugfix Pull Request

COMPONENT NAME

zos_apf

ADDITIONAL INFORMATION

add to the apf list with rc code 0 
ok: [zos_host] => {
    "apf_result": {
        "changed": true,
        "failed": false,
        "rc": 0,
        "stderr": "BGYSC4710E Add error: Dataset OMVSADM.TEST.TOUCH2 on volume 333333 is already present in APF list.\n",
        "stderr_lines": [
            "BGYSC4710E Add error: Dataset OMVSADM.TEST.TOUCH2 on volume 333333 is already present in APF list."
        ],
        "stdout": "",
        "stdout_lines": []
    }
}
 delete from the apf list with rc code0 

ok: [zos_host] => {
    "apf_delete": {
        "changed": true,
        "failed": false,
        "rc": 0,
        "stderr": "",
        "stderr_lines": [],
        "stdout": "EC01248A   2025022  21:45:54.00             ISF031I CONSOLE OMVS0000 ACTIVATED\nEC01248A   2025022  21:45:54.00            -SETPROG APF,DELETE,DSNAME=OMVSADM.TEST.TOUCH2,VOLUME=333333 \nEC01248A   2025022  21:45:54.00             CSV410I DATA SET OMVSADM.TEST.TOUCH2 ON VOLUME 333333 DELETED FROM APF LIST\n",
        "stdout_lines": [
            "EC01248A   2025022  21:45:54.00             ISF031I CONSOLE OMVS0000 ACTIVATED",
            "EC01248A   2025022  21:45:54.00            -SETPROG APF,DELETE,DSNAME=OMVSADM.TEST.TOUCH2,VOLUME=333333 ",
            "EC01248A   2025022  21:45:54.00             CSV410I DATA SET OMVSADM.TEST.TOUCH2 ON VOLUME 333333 DELETED FROM APF LIST"
        ]
    }
}

[fernandofloresg]

Just a couple of comments.

[fernandofloresg]

We try to (mostly) stick to the ansible development lifecycle guidelines. https://docs.ansible.com/ansible/latest/community/development_process.html, for bugfixes recommendation is to Use past tense to describe the problem and present tense to describe the fix..

When trying to add a library into the APF list that was already added the module would fail. Fix now won't fail the module and inform the user that the library was already in the APF list.

[Rohitcodes28]

Added the change logs as per the instructions

[richp405]

I would suggest getting rid of the contraction: ...'Fix now will not fail the module, and will inform the user that the library is alread on the APF list."

[fernandofloresg]

Thank you @richp405 That sounds better. @Rohitcodes28 Can you update it ?

[Rohitcodes28]

Sure @fernandofloresg updated as per the suggestion.

[Rohitcodes28]

It is also tested for delete as the -i option is described as " Ignore errors if dataset is already present during add operation or missing during delete operation. "
test_del_not_present test case output is attached below

[richp405]

Nice start! There are suggestions for the changelog fragment and a code recommendation for zos_apf.py. Glad to see you starting to do code already.

[fernandofloresg]

Thanks for updating this just have another request, in this case when is added and is already present changed should be false.

 {
    "apf_result": {
        "changed": true,
        "failed": false,
        "rc": 0,
        "stderr": "BGYSC4710E Add error: Dataset OMVSADM.TEST.TOUCH2 on volume 333333 is already present in APF list.\n",
        "stderr_lines": [
            "BGYSC4710E Add error: Dataset OMVSADM.TEST.TOUCH2 on volume 333333 is already present in APF list."
        ],
        "stdout": "",
        "stdout_lines": []
    }
}

For the negative case, it should be the same case, when you try to remove it from the APF list and is not present, show changed false.

Sorry did not notice this before.

[Rohitcodes28]

It is tested that chaged False is coming if the file is already present while addition and same if file not present while deletion.

[fernandofloresg]

Just requested one change to the test case, overall is looking good. Please run the test cases in the ansible core pipeline. As an advice, zos_apf can fail in some volumes, so use the same EC you are using to test locally.

[fernandofloresg]

Could you do these checks by zoau version? Like if version 1.3.4 assert rc == 0 if lower rc == 16 or 8 .

[Rohitcodes28]

Version check is added along with testing the pipeline on the latest commits to the branch. both are successful

[fernandofloresg]

LGTM!

[fernandofloresg]

Thanks for addressing the requested changes.

[richp405]

One spelling issue in the changelog file. Code looks fine.