use optional api prefix in collection if set as environ vairable

[Harshith-umesh]

SUMMARY

This change make the collection compatible with OPTIONAL_API_URLPATTERN_PREFIX environment variable.

ISSUE TYPE

• Bug, Docs Fix or other nominal change

COMPONENT NAME

• Collection

ADDITIONAL INFORMATION

Testing:
To test this change I cloned the awx repo, made the change in the controller_api.py file and created a basic ansible playbook which references the updated awx code. The playbook launches a job against the controller. The playbook looks like this:

- hosts: localhost
  gather_facts: false
  environment: 
    CONTROLLER_OPTIONAL_API_URLPATTERN_PREFIX: '/api/controller/'
  tasks: 
    - name: Launch a job on controller
      awx.awx.job_launch:
        job_template: 7
        controller_password: 'SECRET'
        controller_host: 'https://my.controller.com'
        controller_username: 'admin'
      register: job
   
    - name: Wait for controller job
      awx.awx.job_wait:
        job_id: "{{ job.id }}"
        controller_password: 'SECRET'
        controller_host: 'https://my.controller.com'
        controller_username: 'admin'
        timeout: 120

to run the playbook i ran the following command:
ansible-playbook -i localhost, play.yml -e ansible_connection=local

[chadmf]

I like this method as it leaves us open in the future to add other vars. LGTM!

[chadmf]

Also will the API be referenceable as a variable in the collection itself?

[kdelee]

@chadmf not sure what you mean. These changes are to a base class ControllerModule that the other modules build off of. So attributes/functions on this base class are used by them unless overriden

[chadmf]

Ah yeah sorry my brain went straight to the collection

[AlanCoding]

I'm just a little surprised, why would we only respect this only as an environment variable as opposed to treating it as a config variable like all the others (like host, username, verify_ssl, etc.), which can also be given as environment vars.

[Harshith-umesh]

Updated the logic to detect if run using upstream awx or downstream controller. There was a variable called self._COLLECTION_TYPE that is used to determine what the collection type and is set at build time.

awx/awx_collection/tools/roles/template_galaxy/tasks/main.yml

Lines 17 to 21 in 0d4f653

	- name: Set the collection type in the controller_api.py file
	replace:
	path: "{{ collection_path }}/plugins/module_utils/controller_api.py"
	regexp: '^ _COLLECTION_TYPE = "awx"'
	replace: ' _COLLECTION_TYPE = "{{ collection_package }}"'

Tested it out by changing this line

awx/awx_collection/plugins/module_utils/controller_api.py

Line 295 in 0d4f653

_COLLECTION_TYPE = "awx"

and it worked against downstream deployment without having to set the environment variable.
PTAL