Adding import/export awx kit features

Changed library structure

Origional TowerModule becomes TowerLegacyModule

TowerModule from tower_api becomes TowerAPIModule

A real base TowerModule is created in tower_module.py

A new TowerAWXKitModule is created in tower_awxkit

TowerAWXKitModule and TowerAPIModule are child classes of TowerModule

awx_collection/plugins/modules/tower_credential.py

@@ -269,7 +269,7 @@ EXAMPLES = '''
 
 '''
 
-from ..module_utils.tower_api import TowerModule
+from ..module_utils.tower_api import TowerAPIModule
 
 KIND_CHOICES = {
     'ssh': 'Machine',
@@ -336,7 +336,7 @@ def main():
     )
 
     # Create a module for ourselves
-    module = TowerModule(argument_spec=argument_spec, required_one_of=[['kind', 'credential_type']])
+    module = TowerAPIModule(argument_spec=argument_spec, required_one_of=[['kind', 'credential_type']])
 
     # Extract our parameters
     name = module.params.get('name')

awx_collection/plugins/modules/tower_credential_input_source.py

@@ -70,7 +70,7 @@ EXAMPLES = '''
 
 '''
 
-from ..module_utils.tower_api import TowerModule
+from ..module_utils.tower_api import TowerAPIModule
 
 
 def main():
@@ -85,7 +85,7 @@ def main():
     )
 
     # Create a module for ourselves
-    module = TowerModule(argument_spec=argument_spec)
+    module = TowerAPIModule(argument_spec=argument_spec)
 
     # Extract our parameters
     description = module.params.get('description')

awx_collection/plugins/modules/tower_credential_type.py

@@ -81,7 +81,7 @@ EXAMPLES = '''
 RETURN = ''' # '''
 
 
-from ..module_utils.tower_api import TowerModule
+from ..module_utils.tower_api import TowerAPIModule
 
 KIND_CHOICES = {
     'ssh': 'Machine',
@@ -105,7 +105,7 @@ def main():
     )
 
     # Create a module for ourselves
-    module = TowerModule(argument_spec=argument_spec)
+    module = TowerAPIModule(argument_spec=argument_spec)
 
     # Extract our parameters
     name = module.params.get('name')

awx_collection/plugins/modules/tower_export.py

@@ -0,0 +1,155 @@
+#!/usr/bin/python
+# coding: utf-8 -*-
+
+# (c) 2017, 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_export
+author: "John Westcott IV (@john-westcott-iv)"
+version_added: "3.7"
+short_description: export resources from Ansible Tower.
+description:
+    - Export assets from Ansible Tower.
+options:
+    all:
+      description:
+        - Export all assets
+      type: bool
+      default: 'False'
+    organizations:
+      description:
+        - organization name to export
+      default: ''
+      type: str
+    user:
+      description:
+        - user name to export
+      default: ''
+      type: str
+    team:
+      description:
+        - team name to export
+      default: ''
+      type: str
+    credential_type:
+      description:
+        - credential type name to export
+      default: ''
+      type: str
+    credential:
+      description:
+        - credential name to export
+      default: ''
+      type: str
+    notification_template:
+      description:
+        - notification template name to export
+      default: ''
+      type: str
+    inventory_script:
+      description:
+        - inventory script name to export
+      default: ''
+      type: str
+    inventory:
+      description:
+        - inventory name to export
+      default: ''
+      type: str
+    project:
+      description:
+        - project name to export
+      default: ''
+      type: str
+    job_template:
+      description:
+        - job template name to export
+      default: ''
+      type: str
+    workflow:
+      description:
+        - workflow name to export
+      default: ''
+      type: str
+requirements:
+  - "awxkit >= 9.3.0"
+notes:
+  - Specifying a name of "all" for any asset type will export all items of that asset type.
+extends_documentation_fragment: awx.awx.auth
+'''
+
+EXAMPLES = '''
+- name: Export all tower assets
+  tower_export:
+    all: True
+- name: Export all inventories
+  tower_export:
+    inventory: 'all'
+- name: Export a job template named "My Template" and all Credentials
+  tower_export:
+    job_template: "My Template"
+    credential: 'all'
+'''
+
+from os import environ
+
+from ..module_utils.tower_awxkit import TowerAWXKitModule
+
+try:
+    from awxkit.api.pages.api import EXPORTABLE_RESOURCES
+    HAS_EXPORTABLE_RESOURCES=True
+except ImportError:
+    HAS_EXPORTABLE_RESOURCES=False
+
+
+def main():
+    argument_spec = dict(
+        all=dict(type='bool', default=False),
+    )
+
+    # We are not going to raise an error here because the __init__ method of TowerAWXKitModule will do that for us
+    if HAS_EXPORTABLE_RESOURCES:
+        for resource in EXPORTABLE_RESOURCES:
+            argument_spec[resource] = dict()
+
+    module = TowerAWXKitModule(argument_spec=argument_spec)
+
+    if not HAS_EXPORTABLE_RESOURCES:
+        module.fail_json(msg="Your version of awxkit does not have import/export")
+
+    # The export process will never change a Tower system
+    module.json_output['changed'] = False
+
+    # The exporter code currently works like the following:
+    #   Empty list == all assets of that type
+    #   string = just one asset of that type (by name)
+    #   None = skip asset type
+    # Here we are going to setup a dict of values to export
+    export_args = {}
+    for resource in EXPORTABLE_RESOURCES:
+        if module.params.get('all') or module.params.get(resource) == 'all':
+            # If we are exporting everything or we got the keyword "all" we pass in an empty list for this asset type
+            export_args[resource] = []
+        else:
+            # Otherwise we take either the string or None (if the parameter was not passed) to get one or no items
+            export_args[resource] = module.params.get(resource)
+
+    # Run the export process
+    module.json_output['assets'] = module.get_api_v2_object().export_assets(**export_args)
+
+    module.exit_json(**module.json_output)
+
+
+if __name__ == '__main__':
+    main()

awx_collection/plugins/modules/tower_group.py

@@ -76,7 +76,7 @@ EXAMPLES = '''
     tower_config_file: "~/tower_cli.cfg"
 '''
 
-from ..module_utils.tower_api import TowerModule
+from ..module_utils.tower_api import TowerAPIModule
 import json
 
 
@@ -94,7 +94,7 @@ def main():
     )
 
     # Create a module for ourselves
-    module = TowerModule(argument_spec=argument_spec)
+    module = TowerAPIModule(argument_spec=argument_spec)
 
     # Extract our parameters
     name = module.params.get('name')

awx_collection/plugins/modules/tower_host.py

@@ -72,7 +72,7 @@ EXAMPLES = '''
 '''
 
 
-from ..module_utils.tower_api import TowerModule
+from ..module_utils.tower_api import TowerAPIModule
 import json
 
 
@@ -89,7 +89,7 @@ def main():
     )
 
     # Create a module for ourselves
-    module = TowerModule(argument_spec=argument_spec)
+    module = TowerAPIModule(argument_spec=argument_spec)
 
     # Extract our parameters
     name = module.params.get('name')

awx_collection/plugins/modules/tower_import.py

@@ -0,0 +1,95 @@
+#!/usr/bin/python
+# coding: utf-8 -*-
+
+# (c) 2017, 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_import
+author: "John Westcott (@john-westcott-iv)"
+version_added: "3.7"
+short_description: import resources into Ansible Tower.
+description:
+    - Import assets into Ansible Tower. See
+      U(https://www.ansible.com/tower) for an overview.
+options:
+    assets:
+      description:
+        - The assets to import.
+        - This can be the output of tower_export or loaded from a file
+      required: True
+      type: dict
+requirements:
+  - "awxkit >= 9.3.0"
+extends_documentation_fragment: awx.awx.auth
+'''
+
+EXAMPLES = '''
+- name: Import all tower assets
+  tower_import:
+    assets: "{{ export_output.assets }}"
+'''
+
+from ..module_utils.tower_awxkit import TowerAWXKitModule
+
+# These two lines are not needed if awxkit changes to do progamatic notifications on issues
+from ansible.module_utils.six.moves import StringIO
+import logging
+
+# In this module we don't use EXPORTABLE_RESOURCES, we just want to validate that our installed awxkit has import/export
+try:
+    from awxkit.api.pages.api import EXPORTABLE_RESOURCES
+    HAS_EXPORTABLE_RESOURCES=True
+except ImportError:
+    HAS_EXPORTABLE_RESOURCES=False
+
+def main():
+    argument_spec = dict(
+        assets=dict(type='dict', required=True)
+    )
+
+    module = TowerAWXKitModule(argument_spec=argument_spec, supports_check_mode=False)
+
+    assets = module.params.get('assets')
+
+    if not HAS_EXPORTABLE_RESOURCES:
+        module.fail_json(msg="Your version of awxkit does not appear to have import/export")
+
+    # Currently the import process does not return anything on error
+    # It simply just logs to pythons logger
+    # Setup a log gobbler to get error messages from import_assets
+    logger = logging.getLogger('awxkit.api.pages.api')
+    logger.setLevel(logging.WARNING)
+    log_capture_string = StringIO()
+    ch = logging.StreamHandler(log_capture_string)
+    ch.setLevel(logging.WARNING)
+    logger.addHandler(ch)
+    log_contents = ''
+
+    # Run the import process
+    try:
+        module.json_output['changed'] = module.get_api_v2_object().import_assets(assets)
+    except Exception as e:
+        module.fail_json(msg="Failed to import assets {0}".format(e))
+    finally:
+        # Finally consume the logs incase there were any errors and die if there were
+        log_contents = log_capture_string.getvalue()
+        log_capture_string.close()
+        if log_contents != '':
+            module.fail_json(msg=log_contents)
+
+    module.exit_json(**module.json_output)
+
+
+if __name__ == '__main__':
+    main()

awx_collection/plugins/modules/tower_inventory.py

@@ -71,7 +71,7 @@ EXAMPLES = '''
 '''
 
 
-from ..module_utils.tower_api import TowerModule
+from ..module_utils.tower_api import TowerAPIModule
 import json
 
 
@@ -88,7 +88,7 @@ def main():
     )
 
     # Create a module for ourselves
-    module = TowerModule(argument_spec=argument_spec)
+    module = TowerAPIModule(argument_spec=argument_spec)
 
     # Extract our parameters
     name = module.params.get('name')

awx_collection/plugins/modules/tower_inventory_source.py

@@ -144,7 +144,7 @@ EXAMPLES = '''
       private: false
 '''
 
-from ..module_utils.tower_api import TowerModule
+from ..module_utils.tower_api import TowerAPIModule
 from json import dumps
 
 
@@ -184,7 +184,7 @@ def main():
     )
 
     # Create a module for ourselves
-    module = TowerModule(argument_spec=argument_spec)
+    module = TowerAPIModule(argument_spec=argument_spec)
 
     # Extract our parameters
     name = module.params.get('name')

awx_collection/plugins/modules/tower_job_cancel.py

@@ -50,7 +50,7 @@ id:
 '''
 
 
-from ..module_utils.tower_api import TowerModule
+from ..module_utils.tower_api import TowerAPIModule
 
 
 def main():
@@ -61,7 +61,7 @@ def main():
     )
 
     # Create a module for ourselves
-    module = TowerModule(argument_spec=argument_spec)
+    module = TowerAPIModule(argument_spec=argument_spec)
 
     # Extract our parameters
     job_id = module.params.get('job_id')

awx_collection/plugins/modules/tower_job_launch.py

@@ -124,7 +124,7 @@ status:
     sample: pending
 '''
 
-from ..module_utils.tower_api import TowerModule
+from ..module_utils.tower_api import TowerAPIModule
 
 
 def main():
@@ -146,7 +146,7 @@ def main():
     )
 
     # Create a module for ourselves
-    module = TowerModule(argument_spec=argument_spec)
+    module = TowerAPIModule(argument_spec=argument_spec)
 
     optional_args = {}
     # Extract our parameters

awx_collection/plugins/modules/tower_job_list.py

@@ -80,7 +80,7 @@ results:
 '''
 
 
-from ..module_utils.tower_api import TowerModule
+from ..module_utils.tower_api import TowerAPIModule
 
 
 def main():
@@ -93,7 +93,7 @@ def main():
     )
 
     # Create a module for ourselves
-    module = TowerModule(
+    module = TowerAPIModule(
         argument_spec=argument_spec,
         mutually_exclusive=[
             ('page', 'all_pages'),

awx_collection/plugins/modules/tower_job_template.py

@@ -317,7 +317,7 @@ EXAMPLES = '''
 
 '''
 
-from ..module_utils.tower_api import TowerModule
+from ..module_utils.tower_api import TowerAPIModule
 import json
 
 
@@ -388,7 +388,7 @@ def main():
     )
 
     # Create a module for ourselves
-    module = TowerModule(argument_spec=argument_spec)
+    module = TowerAPIModule(argument_spec=argument_spec)
 
     # Extract our parameters
     name = module.params.get('name')

awx_collection/plugins/modules/tower_job_wait.py

@@ -92,7 +92,7 @@ status:
 '''
 
 
-from ..module_utils.tower_api import TowerModule
+from ..module_utils.tower_api import TowerAPIModule
 import time
 
 
@@ -120,7 +120,7 @@ def main():
     )
 
     # Create a module for ourselves
-    module = TowerModule(argument_spec=argument_spec)
+    module = TowerAPIModule(argument_spec=argument_spec)
 
     # Extract our parameters
     job_id = module.params.get('job_id')

awx_collection/plugins/modules/tower_label.py

@@ -54,7 +54,7 @@ EXAMPLES = '''
     organization: My Organization
 '''
 
-from ..module_utils.tower_api import TowerModule
+from ..module_utils.tower_api import TowerAPIModule
 
 
 def main():
@@ -67,7 +67,7 @@ def main():
     )
 
     # Create a module for ourselves
-    module = TowerModule(argument_spec=argument_spec)
+    module = TowerAPIModule(argument_spec=argument_spec)
 
     # Extract our parameters
     name = module.params.get('name')

awx_collection/plugins/modules/tower_license.py

@@ -43,12 +43,12 @@ EXAMPLES = '''
     eula_accepted: True
 '''
 
-from ..module_utils.tower_api import TowerModule
+from ..module_utils.tower_api import TowerAPIModule
 
 
 def main():
 
-    module = TowerModule(
+    module = TowerAPIModule(
         argument_spec=dict(
             data=dict(type='dict', required=True),
             eula_accepted=dict(type='bool', required=True),

awx_collection/plugins/modules/tower_meta.py

@@ -62,11 +62,11 @@ EXAMPLES = '''
 '''
 
 
-from ..module_utils.tower_api import TowerModule
+from ..module_utils.tower_api import TowerAPIModule
 
 
 def main():
-    module = TowerModule(argument_spec={})
+    module = TowerAPIModule(argument_spec={})
     namespace = {
         'awx': 'awx',
         'tower': 'ansible'

awx_collection/plugins/modules/tower_notification.py

@@ -300,7 +300,7 @@ EXAMPLES = '''
 RETURN = ''' # '''
 
 
-from ..module_utils.tower_api import TowerModule
+from ..module_utils.tower_api import TowerAPIModule
 
 OLD_INPUT_NAMES = (
     'username', 'sender', 'recipients', 'use_tls',
@@ -355,7 +355,7 @@ def main():
     )
 
     # Create a module for ourselves
-    module = TowerModule(argument_spec=argument_spec)
+    module = TowerAPIModule(argument_spec=argument_spec)
 
     # Extract our parameters
     name = module.params.get('name')

awx_collection/plugins/modules/tower_organization.py

@@ -88,7 +88,7 @@ EXAMPLES = '''
     tower_config_file: "~/tower_cli.cfg"
 '''
 
-from ..module_utils.tower_api import TowerModule
+from ..module_utils.tower_api import TowerAPIModule
 
 
 def main():
@@ -106,7 +106,7 @@ def main():
     )
 
     # Create a module for ourselves
-    module = TowerModule(argument_spec=argument_spec)
+    module = TowerAPIModule(argument_spec=argument_spec)
 
     # Extract our parameters
     name = module.params.get('name')

awx_collection/plugins/modules/tower_project.py

@@ -157,7 +157,7 @@ EXAMPLES = '''
 
 import time
 
-from ..module_utils.tower_api import TowerModule
+from ..module_utils.tower_api import TowerAPIModule
 
 
 def wait_for_project_update(module, last_request):
@@ -205,7 +205,7 @@ def main():
     )
 
     # Create a module for ourselves
-    module = TowerModule(argument_spec=argument_spec)
+    module = TowerAPIModule(argument_spec=argument_spec)
 
     # Extract our parameters
     name = module.params.get('name')

awx_collection/plugins/modules/tower_receive.py

@@ -134,7 +134,7 @@ assets:
     sample: [ {}, {} ]
 '''
 
-from ..module_utils.ansible_tower import TowerModule, tower_auth_config, HAS_TOWER_CLI
+from ..module_utils.tower_legacy import TowerLegacyModule, tower_auth_config, HAS_TOWER_CLI
 
 try:
     from tower_cli.cli.transfer.receive import Receiver
@@ -163,7 +163,7 @@ def main():
         workflow=dict(type='list', default=[], elements='str'),
     )
 
-    module = TowerModule(argument_spec=argument_spec, supports_check_mode=False)
+    module = TowerLegacyModule(argument_spec=argument_spec, supports_check_mode=False)
 
     module.deprecate(msg="This module is deprecated and will be replaced by the AWX CLI export command.", version="awx.awx:14.0.0")
 

awx_collection/plugins/modules/tower_role.py

@@ -89,7 +89,7 @@ EXAMPLES = '''
     state: present
 '''
 
-from ..module_utils.tower_api import TowerModule
+from ..module_utils.tower_api import TowerAPIModule
 
 
 def main():
@@ -109,7 +109,7 @@ def main():
         state=dict(choices=['present', 'absent'], default='present'),
     )
 
-    module = TowerModule(argument_spec=argument_spec)
+    module = TowerAPIModule(argument_spec=argument_spec)
 
     role_type = module.params.pop('role')
     role_field = role_type + '_role'

awx_collection/plugins/modules/tower_schedule.py

@@ -136,7 +136,7 @@ EXAMPLES = '''
   register: result
 '''
 
-from ..module_utils.tower_api import TowerModule
+from ..module_utils.tower_api import TowerAPIModule
 
 
 def main():
@@ -161,7 +161,7 @@ def main():
     )
 
     # Create a module for ourselves
-    module = TowerModule(argument_spec=argument_spec)
+    module = TowerAPIModule(argument_spec=argument_spec)
 
     # Extract our parameters
     rrule = module.params.get('rrule')

awx_collection/plugins/modules/tower_send.py

@@ -81,7 +81,7 @@ import os
 import sys
 
 from ansible.module_utils.six.moves import StringIO
-from ..module_utils.ansible_tower import TowerModule, tower_auth_config, HAS_TOWER_CLI
+from ..module_utils.tower_legacy import TowerLegacyModule, tower_auth_config, HAS_TOWER_CLI
 
 from tempfile import mkstemp
 
@@ -103,7 +103,7 @@ def main():
         password_management=dict(default='default', choices=['default', 'random']),
     )
 
-    module = TowerModule(argument_spec=argument_spec, supports_check_mode=False)
+    module = TowerLegacyModule(argument_spec=argument_spec, supports_check_mode=False)
 
     module.deprecate(msg="This module is deprecated and will be replaced by the AWX CLI import command", version="awx.awx:14.0.0")
 

awx_collection/plugins/modules/tower_settings.py

@@ -70,7 +70,7 @@ EXAMPLES = '''
         last_name: "surname"
 '''
 
-from ..module_utils.tower_api import TowerModule
+from ..module_utils.tower_api import TowerAPIModule
 
 try:
     import yaml
@@ -111,7 +111,7 @@ def main():
     )
 
     # Create a module for ourselves
-    module = TowerModule(
+    module = TowerAPIModule(
         argument_spec=argument_spec,
         required_one_of=[['name', 'settings']],
         mutually_exclusive=[['name', 'settings']],

awx_collection/plugins/modules/tower_team.py

@@ -60,7 +60,7 @@ EXAMPLES = '''
     tower_config_file: "~/tower_cli.cfg"
 '''
 
-from ..module_utils.tower_api import TowerModule
+from ..module_utils.tower_api import TowerAPIModule
 
 
 def main():
@@ -74,7 +74,7 @@ def main():
     )
 
     # Create a module for ourselves
-    module = TowerModule(argument_spec=argument_spec)
+    module = TowerAPIModule(argument_spec=argument_spec)
 
     # Extract our parameters
     name = module.params.get('name')

awx_collection/plugins/modules/tower_token.py

@@ -117,7 +117,7 @@ tower_token:
   returned: on successful create
 '''
 
-from ..module_utils.tower_api import TowerModule
+from ..module_utils.tower_api import TowerAPIModule
 
 
 def return_token(module, last_response):
@@ -143,7 +143,7 @@ def main():
     )
 
     # Create a module for ourselves
-    module = TowerModule(
+    module = TowerAPIModule(
         argument_spec=argument_spec,
         mutually_exclusive=[
             ('existing_token', 'existing_token_id'),

awx_collection/plugins/modules/tower_user.py

@@ -102,7 +102,7 @@ EXAMPLES = '''
     tower_config_file: "~/tower_cli.cfg"
 '''
 
-from ..module_utils.tower_api import TowerModule
+from ..module_utils.tower_api import TowerAPIModule
 
 
 def main():
@@ -119,7 +119,7 @@ def main():
     )
 
     # Create a module for ourselves
-    module = TowerModule(argument_spec=argument_spec)
+    module = TowerAPIModule(argument_spec=argument_spec)
 
     # Extract our parameters
     username = module.params.get('username')

awx_collection/plugins/modules/tower_workflow_job_template.py

@@ -137,7 +137,7 @@ EXAMPLES = '''
     organization: Default
 '''
 
-from ..module_utils.tower_api import TowerModule
+from ..module_utils.tower_api import TowerAPIModule
 
 import json
 
@@ -176,7 +176,7 @@ def main():
     )
 
     # Create a module for ourselves
-    module = TowerModule(argument_spec=argument_spec)
+    module = TowerAPIModule(argument_spec=argument_spec)
 
     # Extract our parameters
     name = module.params.get('name')

awx_collection/plugins/modules/tower_workflow_job_template_node.py

@@ -157,7 +157,7 @@ EXAMPLES = '''
       - my-first-node
 '''
 
-from ..module_utils.tower_api import TowerModule
+from ..module_utils.tower_api import TowerAPIModule
 
 
 def main():
@@ -185,7 +185,7 @@ def main():
     )
 
     # Create a module for ourselves
-    module = TowerModule(argument_spec=argument_spec)
+    module = TowerAPIModule(argument_spec=argument_spec)
 
     # Extract our parameters
     identifier = module.params.get('identifier')

awx_collection/plugins/modules/tower_workflow_launch.py

@@ -91,7 +91,7 @@ EXAMPLES = '''
     wait: False
 '''
 
-from ..module_utils.tower_api import TowerModule
+from ..module_utils.tower_api import TowerAPIModule
 import json
 import time
 
@@ -111,7 +111,7 @@ def main():
     )
 
     # Create a module for ourselves
-    module = TowerModule(argument_spec=argument_spec)
+    module = TowerAPIModule(argument_spec=argument_spec)
 
     optional_args = {}
     # Extract our parameters

awx_collection/plugins/modules/tower_workflow_template.py

@@ -108,8 +108,8 @@ EXAMPLES = '''
 RETURN = ''' # '''
 
 
-from ..module_utils.ansible_tower import (
-    TowerModule,
+from ..module_utils.tower_legacy import (
+    TowerLegacyModule,
     tower_auth_config,
     tower_check_mode
 )
@@ -140,7 +140,7 @@ def main():
         state=dict(choices=['present', 'absent'], default='present'),
     )
 
-    module = TowerModule(
+    module = TowerLegacyModule(
         argument_spec=argument_spec,
         supports_check_mode=False
     )