ansiblegate: take care of failed, skipped and unreachable tasks and propagate "retcode"

[meaksh]

What does this PR do?

This PR fixes few issues on the ansiblegate execution and state modules when running playbooks:

• Take care of "failed", "skipped" and "unreachable" tasks during playbook execution.
• Propagate "retcode" from "ansible-playbook" CLI execution when calling ansible.playbooks to allow proper success/failed detection.
• Only execute ansible-playbook --check in test mode (test=True) to allow running playbooks that are using modules which does not allow --check.
• Add new unit tests for execution and state modules.
• Add changes suggested by "pre-commit".

What issues does this PR fix or reference?

Fixes: #57854
Fixes: #57855

Merge requirements satisfied?

[NOTICE] Bug fixes or features added to Salt require tests.

• Docs
• Changelog - https://docs.saltstack.com/en/master/topics/development/changelog.html
• Tests written/updated

Commits signed with GPG?

Yes

Please review Salt's Contributing Guide for best practices.

See GitHub's page on GPG signing for more information about signing commits with GPG.

[DmitryKuzmenko]

Just cosmetic request to drop the redundant NO_PYTEST constant. Other tests are using pytest directly in skipIf

@skipIf(pytest is None, "PyTest is missing")

[meaksh]

👍

[DmitryKuzmenko]

@meaksh thank you for contribution. Could you please follow up just one cosmetic change request?

[meaksh]

@DmitryKuzmenko I've pushed the changes you requested. Thanks for reviewing! 👍

[DmitryKuzmenko]

Could you please move this mock object into the function level scope. Having mocks in the module level scope could produce issues.

[meaksh]

Ok, good to know, thanks! I've pushed the requested changes 👍

[meaksh]

Oh wait, I missed few of them. 1 sec.

[meaksh]

Ok, it should be ready now.

[DmitryKuzmenko]

Looks good now. Thank you for update.
Let's wait for CI results.

[denis-khalturin-incountry]

@meaksh why are you marking all skipped tasks as outstanding? this behavior terminates the application of the state with an error

[meaksh]

Hey @denis-khalturin-incountry, I don't really get what you mean. Could you please elaborate that and provide some examples?

Thanks in advance!

[denis-khalturin-incountry]

@meaksh yes of course.

i am applying playbook:

ansible-playbook playbooks/test.yml --diff --extra-vars='{"ansible_connection": "local", "inventory_hostname": "_my_host_"}' --inventory=inventory --forks = 5

One of the tasks is skipped according to the conditions:

PLAY RECAP *********************************************** ************************************************* ************************************************* ************************************************* *************************
_my_host_: ok = 7 changed = 0 unreachable = 0 failed = 0 skipped = 1 rescued = 0 ignored = 0

But if I start playbook by applying state, I get an error when executing playbook:

salt-call -l debug state.apply
....
[INFO    ] Executing command 'ansible-playbook playbooks/test.yml --diff --extra-vars='{"ansible_connection": "local", "inventory_hostname": "_my_host_"}' --inventory=inventory --forks=5' in directory 'ansible'
....
[ERROR   ] {'all:!without_hardening': {'_my_role_ : _task_that_is_skipped_':
....
[INFO    ] Completed state [playbooks/test.yml] at time 11:51:25.176235 (duration_in_ms=6288.308)
....
----------
          ID: ansible playbook
    Function: ansible.playbooks
        Name: playbooks/test.yml
      Result: False
     Comment: There were some issues running the playbook playbooks/test.yml
     Started: 11:51:18.887927
    Duration: 6288.308 ms
     Changes:
....
Succeeded: 6 (changed=2)
Failed:    1

I think this is the wrong handling of skipped tasks

[meaksh]

Thanks for clarifying @denis-khalturin-incountry ! You're totally right 👍

I did some checks here and can confirm that ansible-playbook CLI does not set "retcode != 0" when there are skipped tasks. Therefore we should not force the Salt state to fail in such cases.

Could you please create a new issue so we can hopefully produce a fix soon?

Thanks in advance!

[denis-khalturin-incountry]

Yes, I will create an issue. Thanks