Rework some of our package tooling

awx_collection/tools/roles/generate/tasks/main.yml

@@ -0,0 +1,63 @@
+    - name: Get date time data
+      setup:
+        gather_subset: min
+
+    - name: Create module directory
+      file:
+        state: directory
+        name: "modules"
+
+    - name: Load api/v2
+      uri:
+        method: GET
+        url: "{{ api_url }}/api/v2/"
+      register: endpoints
+
+    - name: Load endpoint options
+      uri:
+        method: "OPTIONS"
+        url: "{{ api_url }}{{ item.value }}"
+      loop: "{{ endpoints['json'] | dict2items }}"
+      loop_control:
+        label: "{{ item.key }}"
+      register: end_point_options
+      when: "generate_for is not defined or item.key in generate_for"
+
+    - name: Scan POST options for different things
+      set_fact:
+        all_options: "{{ all_options | default({}) | combine(options[0]) }}"
+      loop: "{{ end_point_options.results }}"
+      vars:
+        options: "{{ item | json_query('json.actions.POST.[*]') }}"
+      loop_control:
+        label: "{{ item['item']['key'] }}"
+      when:
+        - item is not skipped
+        - options is defined
+
+    - name: Process endpoint
+      template:
+        src: "templates/tower_module.j2"
+        dest: "{{ playbook_dir | dirname }}/plugins/modules/{{ file_name }}"
+      loop: "{{ end_point_options['results'] }}"
+      loop_control:
+        label: "{{ item['item']['key'] }}"
+      when: "'json' in item and 'actions' in item['json'] and 'POST' in item['json']['actions']"
+      vars:
+        item_type: "{{ item['item']['key'] }}"
+        human_readable: "{{ item_type | replace('_', ' ') }}"
+        singular_item_type: "{{ item['item']['key'] | regex_replace('ies$', 'y') | regex_replace('s$', '') }}"
+        file_name: "tower_{% if item['item']['key'] in ['settings'] %}{{ item['item']['key'] }}{% else %}{{ singular_item_type }}{% endif %}.py"
+        type_map:
+          bool: 'bool'
+          boolean: 'bool'
+          choice: 'str'
+          datetime: 'str'
+          id: 'str'
+          int: 'int'
+          integer: 'int'
+          json: 'dict'
+          list: 'list'
+          object: 'dict'
+          password: 'str'
+          string: 'str'

awx_collection/tools/roles/generate/templates/tower_module.j2

@@ -0,0 +1,223 @@
+#!/usr/bin/env python
+# coding: utf-8 -*-
+
+{# The following is set by the generate.yml file:
+ #   item_type: the type of item i.e. 'teams'
+ #   human_readable: the type with _ replaced with spaces i.e. worflow job template
+ #   singular_item_type: the type of an item replace singularized i.e. team
+ #   type_map: a mapping of things like string to str
+ #}
+{% set name_option = 'username' if item_type == 'users' else 'name' %}
+
+# (c) {{ ansible_date_time['year'] }}, John Westcott IV <john.westcott.iv@redhat.com>
+# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
+
+from __future__ import absolute_import, division, print_function
+__metaclass__ = type
+
+
+ANSIBLE_METADATA = {'metadata_version': '1.1',
+                    'status': ['preview'],
+                    'supported_by': 'community'}
+
+DOCUMENTATION = '''
+---
+module: tower_{{ singular_item_type }}
+author: "John Westcott IV (@john-westcott-iv)"
+version_added: "2.3"
+short_description: create, update, or destroy Ansible Tower {{ human_readable }}.
+description:
+    - Create, update, or destroy Ansible Tower {{ human_readable }}. See
+      U(https://www.ansible.com/tower) for an overview.
+options:
+{% for option in item['json']['actions']['POST'] %}
+{# to do: sort documentation options #}
+    {{ option }}:
+      description:
+{% if 'help_text' in item['json']['actions']['POST'][option] %}
+        - {{ item['json']['actions']['POST'][option]['help_text'] }}
+{% else %}
+        - NO DESCRIPTION GIVEN IN THE TOWER API
+{% endif %}
+      required: {{ item['json']['actions']['POST'][option]['required'] }}
+      type: {{ type_map[ item['json']['actions']['POST'][option]['type'] ] }}
+{% if 'default' in item['json']['actions']['POST'][option] %}
+{# for tower_job_template/extra vars, its type is dict but its default is '', so we want to make that {} #}
+{%   if item['json']['actions']['POST'][option]['default'] == '' and type_map[ item['json']['actions']['POST'][option]['type'] ] == 'dict' %}
+      default: {}
+{%   else %}
+      default: '{{ item['json']['actions']['POST'][option]['default'] }}'
+{%   endif %}
+{% endif %}
+{% if 'choices' in item['json']['actions']['POST'][option] %}
+      choices:
+{% for choice in item['json']['actions']['POST'][option]['choices'] %}
+        - '{{ choice[0] }}'
+{% endfor %}
+{%endif %}
+{% if aliases[item_type][option] | default(False) %}
+      aliases:
+{% for alias_name in aliases[item_type][option] %}
+        - {{ alias_name }}
+{% endfor %}
+{% endif %}
+{% if option == name_option %}
+    new_{{ name_option }}:
+      description:
+        - Setting this option will change the existing name (looked up via the {{ name_option }} field.
+      required: True
+      type: str
+{% endif %}
+{% endfor %}
+{% for association in associations[item_type] | default([]) %}
+    {{ association['related_item'] }}:
+      description:
+        - {{ association['description'] }}
+      required: {{ association['required'] }}
+      type: list
+{% endfor %}
+    state:
+      description:
+        - Desired state of the resource.
+      choices: ["present", "absent"]
+      default: "present"
+      type: str
+    tower_oauthtoken:
+      description:
+        - The Tower OAuth token to use.
+      required: False
+      type: str
+      version_added: "3.7"
+extends_documentation_fragment: awx.awx.auth
+'''
+
+EXAMPLES = '''
+{% if examples[item_type] | default(False) %}
+{{ examples[item_type] }}
+{% endif %}
+'''
+
+from ..module_utils.tower_api import TowerModule
+
+
+def main():
+    # Any additional arguments that are not fields of the item can be added here
+    argument_spec = dict(
+{% for option in item['json']['actions']['POST'] %}
+{%   set option_data = [] %}
+{{   option_data.append('required={}'.format(item['json']['actions']['POST'][option]['required'])) -}}
+{{   option_data.append('type=\'{}\''.format(type_map[item['json']['actions']['POST'][option]['type']])) -}}
+{%   if item['json']['actions']['POST'][option]['type'] == 'password' %}
+{{     option_data.append('no_log=True') -}}
+{%   endif %}
+{%   if 'choices' in item['json']['actions']['POST'][option] %}
+{%     set all_choices = [] %}
+{%     for choice in item['json']['actions']['POST'][option]['choices'] %}
+{{       all_choices.append("'{}'".format(choice[0])) -}}
+{%     endfor %}
+{{     option_data.append('choices=[{}]'.format(all_choices | join(', '))) -}}
+{%   endif %}
+{%   if item['json']['actions']['POST'][option].get('default', '') != '' %}
+{%     set default_value = item['json']['actions']['POST'][option]['default'] %}
+{%     if item['json']['actions']['POST'][option]['default'] == '' and type_map[ item['json']['actions']['POST'][option]['type'] ] == 'dict' %}
+{%       set default_value = '{}' %}
+{%     endif %}
+{{     option_data.append("default='{}'".format(default_value)) -}}
+{%   endif %}
+{%   if aliases[item_type][option] | default(False) %}
+{%     set alias_list = [] %}
+{%     for alias_name in aliases[item_type][option] %}
+{{       alias_list.append("'{}'".format(alias_name)) -}}
+{%     endfor %}
+{{     option_data.append('aliases=[{}]'.format(alias_list | join(', '))) -}}
+{%   endif %}
+        {{ option }}=dict({{ option_data | join(', ') }}),
+{% if option == name_option %}
+        new_{{ name_option }}=dict(required=False, type='str'),
+{% endif %}
+{% endfor %}
+{% for association_option in associations[item_type] | default([]) %}
+        {{ association_option['related_item'] }}=dict(required={{ association_option['required'] }}, type="list", default=None),
+{% endfor %}
+        state=dict(choices=['present', 'absent'], default='present'),
+    )
+
+    # Create a module for ourselves
+    module = TowerModule(argument_spec=argument_spec)
+
+    # Extract our parameters
+{% for option in item['json']['actions']['POST'] %}
+    {{ option }} = module.params.get('{{ option }}')
+{% if option == name_option %}
+    new_{{ name_option }} = module.params.get("new_{{ name_option }}")
+{% endif %}
+{% endfor %}
+{% for association_option in associations[item_type] | default([]) %}
+    {{ association_option['related_item'] }} = module.params.get('{{ association_option['related_item'] }}')
+{% endfor %}
+    state = module.params.get('state')
+
+{% if item['json']['actions']['POST'] | length() > 0 %}
+    # Attempt to look up the related items the user specified (these will fail the module if not found)
+{% for option in item['json']['actions']['POST'] %}
+{% if item['json']['actions']['POST'][option]['type'] == 'id' %}
+    {{ option }}_id = None
+    if {{ option }}:
+        {{ option }}_id = module.resolve_name_to_id('{{ name_to_id_endpoint_resolution[option] }}', {{ option }})
+{% endif %}
+{% endfor %}
+{% endif %}
+{% for association in associations[item_type] | default([]) %}
+    {{ association['related_item'] }}_ids = None
+    if {{ association['related_item'] }} is not None:
+        {{ association['related_item'] }}_ids = []
+        for item in {{ association['related_item'] }}:
+            {{ association['related_item'] }}_ids.append( module.resolve_name_to_id('{{ association['related_item'] }}', item) )
+{% endfor %}
+
+    # Attempt to look up an existing item based on the provided data
+    existing_item = module.get_one('{{ item_type }}', **{
+        'data': {
+            '{{ name_option }}': {{ name_option }},
+{% if 'organization' in item['json']['actions']['POST'] and item['json']['actions']['POST']['organization']['type'] == 'id' %}
+            'organization': org_id,
+{% endif %}
+{% if item_type in ['hosts', 'groups', 'inventory_sources'] %}
+            'inventory': inventory_id,
+{% endif %}
+        }
+    })
+
+    if state is 'absent':
+        # If the state was absent we can let the module delete it if needed, the module will handle exiting from this
+        module.delete_if_needed(existing_item)
+
+    # Create the data that gets sent for create and update
+    new_fields = {}
+{% for option in item['json']['actions']['POST'] %}
+{% if option == name_option %}
+    new_fields['{{ name_option }}'] = new_{{ name_option }} if new_{{ name_option }} else {{ name_option }}
+{% else %}
+    if {{ option }} is not None:
+{% if item['json']['actions']['POST'][option]['type'] == 'id' %}
+        new_fields['{{ option }}'] = {{ option }}_id
+{% else %}
+        new_fields['{{ option }}'] = {{ option }}
+{% endif %}
+{% endif %}
+{% endfor %}
+
+    # If the state was present and we can let the module build or update the existing item, this will return on its own
+    module.create_or_update_if_needed(
+        existing_item, new_fields,
+        endpoint='{{ item_type }}', item_type='{{ singular_item_type }}',
+        associations={
+{% for association in associations[item_type] | default([]) %}
+            '{{ association['endpoint'] }}': {{ association['related_item'] }}_ids,
+{% endfor %}
+        }
+    )
+
+
+if __name__ == '__main__':
+    main()

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

@@ -0,0 +1,37 @@
+- name: Set the collection version in the tower_api.py file
+  replace:
+    path: "{{ collection_path }}/plugins/module_utils/tower_api.py"
+    regexp: '^    _COLLECTION_VERSION =.*'
+    replace: '    _COLLECTION_VERSION = "{{ collection_version }}"'
+
+- name: Set the collection type in the tower_api.py file
+  replace:
+    path: "{{ collection_path }}/plugins/module_utils/tower_api.py"
+    regexp: '^    _COLLECTION_TYPE =.*'
+    replace: '    _COLLECTION_TYPE = "{{ collection_namespace }}"'
+
+- name: Do file content replacements for non-default namespace or package name
+  block:
+
+    - name: Change module doc_fragments to support desired namespace and package names
+      replace:
+        path: "{{ item }}"
+        regexp: '^extends_documentation_fragment: awx.awx.auth$'
+        replace: 'extends_documentation_fragment: {{ collection_namespace }}.{{ collection_package }}.auth'
+      with_fileglob: "{{ collection_path }}/plugins/modules/tower_*.py"
+      loop_control:
+        label: "{{ item | basename }}"
+
+    - name: Change inventory file to support desired namespace and package names
+      replace:
+        path: "{{ collection_path }}/plugins/inventory/tower.py"
+        regexp: "^    NAME = 'awx.awx.tower'  # REPLACE$"
+        replace: "    NAME = '{{ collection_namespace }}.{{ collection_package }}.tower'  # REPLACE"
+  when:
+    - (collection_package != 'awx') or (collection_namespace != 'awx')
+
+- name: Template the galaxy.yml file
+  template:
+    src: "{{ collection_path }}/tools/roles/template_galaxy/templates/galaxy.yml.j2"
+    dest: "{{ collection_path }}/galaxy.yml"
+    force: true

awx_collection/tools/roles/template_galaxy/templates/galaxy.yml.j2

@@ -0,0 +1,26 @@
+authors:
+- AWX Project Contributors <awx-project@googlegroups.com>
+dependencies: {}
+description: Ansible content that interacts with the AWX or Ansible Tower API.
+documentation: https://github.com/ansible/awx/blob/devel/awx_collection/README.md
+homepage: https://www.ansible.com/
+issues: https://github.com/ansible/awx/issues?q=is%3Aissue+label%3Acomponent%3Aawx_collection
+license:
+- GPL-3.0-only
+name: {{ collection_package }}
+namespace: {{ collection_namespace }}
+readme: README.md
+repository: https://github.com/ansible/awx
+tags:
+- cloud
+- infrastructure
+- awx
+- ansible
+- automation
+version: {{ collection_version }}
+build_ignore:
+- tools
+- setup.cfg
+- galaxy.yml.j2
+- template_galaxy.yml
+- '*.tar.gz'