Update AWX collection to use basic authentication

[ldjebran]

SUMMARY

Update AWX collection to use basic authentication when collection_type is awx,
else try to create a token from gateway and controller when failed todo so use basic authentication instead.

ISSUE TYPE

• New or Enhanced Feature

COMPONENT NAME

• Collection

AWX VERSION

awx: 24.6.2.dev122+g4ce2947dcf

ADDITIONAL INFORMATION

Tested when connected to awx service with _COLLETION_TYPE ="awx"

- name: Test collection with auth
  hosts: localhost
  connection: local
  become: false
  gather_facts: false
  vars:
    controller_host: https://localhost:8043
    source_job_template_name: "Demo Job Template"
    job_template_name: "Demo Job Template 1"
    organization: Default
    controller_username: admin
    controller_password: <hidden-awx-admin-password>
  tasks:
    - name: Create a copy of Demo Job Template
      awx.awx.job_template:
        controller_host: "{{ controller_host }}"
        validate_certs: false
        controller_username: "{{ controller_username }}"
        controller_password: "{{ controller_password }}"
        organization: "{{ organization }}"
        copy_from: "{{ source_job_template_name }}"
        name: "{{ job_template_name }}"
        state: exists
      register: demo_template_copy

    - name: Delete the copy of Demo Job Template
      awx.awx.job_template:
        controller_host: "{{ controller_host }}"
        validate_certs: false
        controller_username: "{{ controller_username }}"
        controller_password: "{{ controller_password }}"
        organization: "{{ organization }}"
        name: "{{ job_template_name }}"
        state: absent

    - name: Try to copy a template with non existent user
      awx.awx.job_template:
        controller_host: "{{ controller_host }}"
        validate_certs: false
        controller_username: does_not_exit
        controller_password: any-password
        organization: "{{ organization }}"
        copy_from: "{{ source_job_template_name }}"
        name: "{{ job_template_name }}"
        state: exists
      register: response
      failed_when: '"Failed to get user info: HTTP Error 401: Unauthorized" not in response.msg'

$ ansible-playbook test_collection_awx.yml
does not match 'all'

PLAY [Test collection with auth] ***********************************************************************

TASK [Create a copy of Demo Job Template] **************************************************************
changed: [localhost]

TASK [Delete the copy of Demo Job Template] ************************************************************
changed: [localhost]

TASK [Try to copy a template with non existent user] ****************************************************
ok: [localhost]

PLAY RECAP *********************************************************************************************
localhost                  : ok=3    changed=2    unreachable=0    failed=0    skipped=0    rescued=0    ignored=0   

Tested when connected to proxy with _COLLETION_TYPE ="tower"

- name: Test controller with proxy gateway
  hosts: localhost
  connection: local
  become: false
  gather_facts: false
  vars:
    controller_host: https://localhost
    source_job_template_name: "Demo Job Template"
    job_template_name: "Demo Job Template 1"
    organization: Default
    controller_username: admin
    controller_password: <hidden-gateway-admin-password>
# same content as first one     

Result

$ ansible-playbook test_collection_proxy.yml 
PLAY [Test controller with proxy gateway] **************************************************************

TASK [Create a copy of Demo Job Template] **************************************************************
changed: [localhost]

TASK [Delete the copy of Demo Job Template] ************************************************************
changed: [localhost]

TASK [Try to copy a template with non existent user] ***************************************************
[WARNING]: url: https://localhost/api/gateway/v1/tokens/ - Failed to get token: HTTP Error 401:
Unauthorized
[WARNING]: url: https://localhost/api/controller/v2/tokens/ - Failed to get token: HTTP Error 401:
Unauthorized
ok: [localhost]

PLAY RECAP *********************************************************************************************
localhost                  : ok=3    changed=2    unreachable=0    failed=0    skipped=0    rescued=0    ignored=0   

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud

[webknjaz]

Pro tip: this can be an interable of strings which typically reads better.

[webknjaz]

In pytest, it's customary to use the built-in monkeypatch fixture or mocker provided by the pytest-mock plugin.

[webknjaz]

this future import is only useful under python 2

[webknjaz]

For conditional CM, there's a from contextlib import nullcontext which can make this more elegant.
Additionally, the builtin fixture can give you a monkeypatch.setenv() w/o needing to import anything or integrate third parties.

[webknjaz]

This looks like a matrix of repeated things. It is possible to produce it using several stacked parametrize decorators.