zendesk_ticket: new module

[elchico2007]

SUMMARY

Creating a new module to interface with the Zendesk ticketing system. With this module you are able to utilize the API from Zendesk to Create, Close and Resolve tickets.

ISSUE TYPE

• New Module/Plugin Pull Request

COMPONENT NAME

zendesk_ticket.py

[felixfontein]

Check out required_one_of in https://docs.ansible.com/ansible/latest/dev_guide/developing_program_flow_modules.html#argument-spec-dependencies.

[russoz]

Since you are using required_one_of, this if block here becomes redundant. Just remove it.

[felixfontein]

I don't see any idempotence checks here, like "is the ticket already closed" before closing it, or "does the ticket already exist" before creating it.

[russoz]

@felixfontein comment still stands - it is not resolved. I believe it could be solved somewhat easily by adding the state as a parameter to check_ticket and verifying whether the ticket state is different.

[felixfontein]

Also please check out the requirements in https://github.com/ansible-collections/community.general/blob/main/CONTRIBUTING.md#creating-new-modules-or-plugins for new modules. You need to add tests, for example.

[elchico2007]

Added the failing mock code, here is the issue i am seeing on my end:

[gw1] [100%] FAILED tests/unit/plugins/modules/test_zendesk_ticket.py::TestZendeskTicket::test_create_ticket_with_mock 

=================================== FAILURES ===================================
________________ TestZendeskTicket.test_create_ticket_with_mock ________________
[gw1] linux -- Python 3.7.17 /usr/bin/python3.7

self = <ansible_collections.community.general.tests.unit.plugins.modules.test_zendesk_ticket.TestZendeskTicket testMethod=test_create_ticket_with_mock>

    def test_create_ticket_with_mock(self):
        set_module_args({
            'url': 'https://your_company.zendesk.com',
            'username': 'user',
            'token': 'test_token',
            'status': 'new',
            'subject': 'Test Ticket',
            'body': 'This is a test ticket body',
            'priority': 'high'
        })
    
        with HTTMock(zendesk_api_mock):
            with self.assertRaises(AnsibleExitJson) as result:
>               self.module.main()

tests/unit/plugins/modules/test_zendesk_ticket.py:107: 
_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ 
plugins/modules/zendesk_ticket.py:296: in main
    module.fail_json(**result)
_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ 

    def fail_json(*args, **kwargs):
        kwargs['failed'] = True
>       raise AnsibleFailJson(kwargs)
E       ansible_collections.community.general.tests.unit.plugins.modules.utils.AnsibleFailJson: {'changed': False, 'msg': '<urlopen error [Errno -3] Temporary failure in name resolution>', 'failed': True}

tests/unit/plugins/modules/utils.py:42: AnsibleFailJson
- generated xml file: /root/ansible_collections/community/general/tests/output/junit/python3.7-modules-units.xml -
=========================== short test summary info ============================
FAILED tests/unit/plugins/modules/test_zendesk_ticket.py::TestZendeskTicket::test_create_ticket_with_mock - ansible_collections.community.general.tests.unit.plugins.modules.utils.Ansi...
========================= 1 failed, 3 passed in 2.91s ==========================
FATAL: Command "pytest -r a -n auto --color yes -p no:cacheprovider -c /root/ansible/test/lib/ansible_test/_data/pytest/config/legacy.ini --junit-xml /root/ansible_collections/community/general/tests/output/junit/python3.7-modules-units.xml --strict-markers --rootdir /root/ansible_collections/community/general --confcutdir /root/ansible_collections/community/general -v tests/unit/plugins/modules/test_zendesk_ticket.py" returned exit status 1.
Run command with stdout: docker exec --user pytest -i ansible-test-controller-KSSkgQIZ sh - ...
Run command with stdin: tar oxzf - -C /home/user/.ansible/collections/ansible_collection ...
FATAL: Command "docker exec --user pytest ansible-test-controller-KSSkgQIZ /usr/bin/env ANSIBLE_TEST_CONTENT_ROOT=/root/ansible_collections/community/general LC_ALL=en_US.UTF-8 /usr/bin/python3.12 /root/ansible/bin/ansible-test units -v tests/unit/plugins/modules/test_zendesk_ticket.py --containers '{}' --requirements-mode skip --truncate 96 --color yes --host-path tests/output/.tmp/host-ktegvo5y --metadata tests/output/.tmp/metadata-nugaecbc.json" returned exit status 1.
Run command: docker stop --time 0 ansible-test-controller-KSSkgQIZ
Run command: docker rm ansible-test-controller-KSSkgQIZ

[elchico2007]

Removed the http mock library, let me know if there are any other improvements or changes i can make to it.

[russoz]

This code is not wrong, however, for the user of this module, information is lost: why has it failed? what was the error message? They will have an error and have little idea about what happened.
This could be an improvement for another PR, no need to hold this one back over this.

[russoz]

This test only proves that the code handles exceptions, it does not test how the code actually works: that was the idea of mocking.
Since the requests library is not being used (to warrant the use of httmock), maybe the answer is a direct mocking of the ansible.module_utils.urls.Request class, or at the very least, of its methods .get(), .patch(), etc...

[felixfontein]

Hmm, I guess we need a better mechanism for this. For open_url and fetch_url in the same module there are some unit test frameworks in https://github.com/ansible-collections/community.internal_test_tools/tree/main/tests/unit/utils, but not (yet) for the Request class...

[russoz]

Removed the http mock library, let me know if there are any other improvements or changes i can make to it.

By the way, sorry for indicating httmock before, I obviously did not know it was specific to requests. My apologies. Hope my snafu has not frustrated you too much. Cheers

[felixfontein]

@russoz does the module look OK enough for you to merge for 9.4.0?

[russoz]

@russoz does the module look OK enough for you to merge for 9.4.0?

I think it needs a bit polishing yet, specially in the tests.