Default source_project to organization for inventory source

[Tompage1994]

SUMMARY

related #10571

Adds the defaulting of the source_project (when given) to be looked up under the organization selected in the same way the inventory is looked up.

ISSUE TYPE

• Bugfix Pull Request

COMPONENT NAME

• awx_collection

AWX VERSION

awx_collection v19.2.2

[softwarefactory-project-zuul]

Build failed.

• awx-api-lint : SUCCESS in 2m 58s
• awx-api : SUCCESS in 7m 07s
• awx-ui : SUCCESS in 13m 43s
• awx-swagger : SUCCESS in 8m 42s
• awx-detect-schema-change : SUCCESS in 7m 44s (non-voting)
• awx-ansible-modules : FAILURE in 4m 45s

[fosterseth]

this can be achieved more generally using our lookup plugin (albeit more verbose)
e.g.

tasks:
  - name: get project in org1
    set_fact:
        proj1: "{{ lookup('awx.awx.controller_api', 'projects', query_params={'name': 'Demo Project', 'organization__name':'org1'}, return_ids=True )}}"

  - name: create INVSOURCE
    inventory_source:
      name: inv1
      source: scm
      source_project: "{{ proj1 }}"
      organization: Default
      inventory: Demo Inventory

[softwarefactory-project-zuul]

Build succeeded.

• awx-api-lint : SUCCESS in 3m 45s
• awx-api : SUCCESS in 8m 10s
• awx-ui : SUCCESS in 15m 00s
• awx-swagger : SUCCESS in 8m 05s
• awx-detect-schema-change : SUCCESS in 8m 37s (non-voting)
• awx-ansible-modules : SUCCESS in 4m 15s

[Tompage1994]

this can be achieved more generally using our lookup plugin (albeit more verbose)
e.g.

tasks:
  - name: get project in org1
    set_fact:
        proj1: "{{ lookup('awx.awx.controller_api', 'projects', query_params={'name': 'Demo Project', 'organization__name':'org1'}, return_ids=True )}}"

  - name: create INVSOURCE
    inventory_source:
      name: inv1
      source: scm
      source_project: "{{ proj1 }}"
      organization: Default
      inventory: Demo Inventory

I agree you can, but I think its much nicer to have it as part of the module as its something that fundamentally breaks at the moment if there are multiple projects under the same name without having to do the second call as you describe (This is also something you have to know to do and isn't necessarily intuitive to work out).

In much the same way as there is an organization field on this module to ensure the lookup of the inventory's org is correct, it surely makes sense to do the same thing for the project too?

[Tompage1994]

Have updated and removed the extra option and made it so we just default the project lookup to the organization

[beeankha]

Hi @Tompage1994 , would you mind adding a task or two to the integration test playbook for the Inventory Source module? The test playbook can be found here: https://github.com/ansible/awx/blob/devel/awx_collection/tests/integration/targets/inventory_source/tasks/main.yml

[john-westcott-iv]

When initially designed the collection was assuming that things would be defined together and that the returned id from one object could be used in the second object. For example:

tasks:
  - name: Create Organization
    tower_organization:
      name: Default
    register: my_default_org

- name: Create inventory
  tower_inventory:
    name: Demo Inventory
    organization: "{{ my_default_org.id }}"

In practice, there are times where things are not all defined at the same time or in the same playbook. So we added the ability to resolve by name but that introduced issues with non-unique instance of an objects. This is why we built the lookup plugin, so that you can resolve an objects name to its ID if the name is non-unique.

The problem with adding a new filed like this is that any object that has a dependency on another object could also require similar fields. For example take job_template, if we added fields like this we would need the following fields:
- credential_organization
- inventory_organization
- project_organization
- credentials_organization (this would somehow have to be in the credentials hash)

If I recall correctly there are one or two objects in Tower where a name and an org may not provide a unique ID as they can be a child of another non-unique object. So while it may be trivial in some modules, adding fields to identify uniqueness of Tower objects can be a very large task.

Also, as an FYI, it can be combined into a single step rather than two:

tasks:
  - name: create INVSOURCE
    inventory_source:
      name: inv1
      source: scm
      source_project: "{{ lookup('awx.awx.controller_api', 'projects', query_params={'name': 'Demo Project', 'organization__name':'org1'}, return_ids=True )}}"
      organization: Default
      inventory: Demo Inventory

[softwarefactory-project-zuul]

Build failed.

• awx-api-lint : SUCCESS in 5m 41s
• awx-api : SUCCESS in 7m 28s
• awx-ui : SUCCESS in 15m 23s
• awx-swagger : SUCCESS in 8m 24s
• awx-detect-schema-change : SUCCESS in 9m 23s (non-voting)
• awx-ansible-modules : FAILURE in 3m 12s

[softwarefactory-project-zuul]

Build failed.

• awx-api-lint : SUCCESS in 4m 23s
• awx-api : SUCCESS in 8m 05s
• awx-ui : SUCCESS in 14m 12s
• awx-swagger : SUCCESS in 8m 20s
• awx-detect-schema-change : SUCCESS in 9m 59s (non-voting)
• awx-ansible-modules : FAILURE in 4m 46s

[softwarefactory-project-zuul]

Build succeeded.

• awx-api-lint : SUCCESS in 2m 56s
• awx-api : SUCCESS in 8m 04s
• awx-ui : SUCCESS in 16m 28s
• awx-swagger : SUCCESS in 7m 30s
• awx-detect-schema-change : SUCCESS in 7m 38s (non-voting)
• awx-ansible-modules : SUCCESS in 2m 59s

[Tompage1994]

@john-westcott-iv I completely take on board what you say here and I do agree entirely.

I've now changed this PR to address the fact that the module does fail if there are two projects of the same name. Now the project org will default to organization in the same way the inventory does. Hopefully this is something more useful. Speaking to @sean-m-sullivan, this functionality exists elsewhere.

I've also added something to the integration tests..