pycharm refactor rename files and class, linux rename tower_ controller_

awx_collection/plugins/modules/user.py

@@ -0,0 +1,171 @@
+#!/usr/bin/python
+# coding: utf-8 -*-
+
+# (c) 2020, 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_user
+author: "John Westcott IV (@john-westcott-iv)"
+short_description: create, update, or destroy Ansible Tower users.
+description:
+    - Create, update, or destroy Ansible Tower users. See
+      U(https://www.ansible.com/tower) for an overview.
+options:
+    username:
+      description:
+        - Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.
+      required: True
+      type: str
+    first_name:
+      description:
+        - First name of the user.
+      type: str
+    last_name:
+      description:
+        - Last name of the user.
+      type: str
+    email:
+      description:
+        - Email address of the user.
+      type: str
+    is_superuser:
+      description:
+        - Designates that this user has all permissions without explicitly assigning them.
+      type: bool
+      default: False
+      aliases: ['superuser']
+    is_system_auditor:
+      description:
+        - User is a system wide auditor.
+      type: bool
+      default: False
+      aliases: ['auditor']
+    password:
+      description:
+        - Write-only field used to change the password.
+      type: str
+    update_secrets:
+      description:
+        - C(true) will always change password if user specifies password, even if API gives $encrypted$ for password.
+        - C(false) will only set the password if other values change too.
+      type: bool
+      default: true
+    state:
+      description:
+        - Desired state of the resource.
+      choices: ["present", "absent"]
+      default: "present"
+      type: str
+extends_documentation_fragment: awx.awx.auth
+'''
+
+
+EXAMPLES = '''
+- name: Add tower user
+  tower_user:
+    username: jdoe
+    password: foobarbaz
+    email: jdoe@example.org
+    first_name: John
+    last_name: Doe
+    state: present
+    tower_config_file: "~/tower_cli.cfg"
+
+- name: Add tower user as a system administrator
+  tower_user:
+    username: jdoe
+    password: foobarbaz
+    email: jdoe@example.org
+    superuser: yes
+    state: present
+    tower_config_file: "~/tower_cli.cfg"
+
+- name: Add tower user as a system auditor
+  tower_user:
+    username: jdoe
+    password: foobarbaz
+    email: jdoe@example.org
+    auditor: yes
+    state: present
+    tower_config_file: "~/tower_cli.cfg"
+
+- name: Delete tower user
+  tower_user:
+    username: jdoe
+    email: jdoe@example.org
+    state: absent
+    tower_config_file: "~/tower_cli.cfg"
+'''
+
+from ..module_utils.controller_api import ControllerAPIModule
+
+
+def main():
+    # Any additional arguments that are not fields of the item can be added here
+    argument_spec = dict(
+        username=dict(required=True),
+        first_name=dict(),
+        last_name=dict(),
+        email=dict(),
+        is_superuser=dict(type='bool', default=False, aliases=['superuser']),
+        is_system_auditor=dict(type='bool', default=False, aliases=['auditor']),
+        password=dict(no_log=True),
+        update_secrets=dict(type='bool', default=True, no_log=False),
+        state=dict(choices=['present', 'absent'], default='present'),
+    )
+
+    # Create a module for ourselves
+    module = ControllerAPIModule(argument_spec=argument_spec)
+
+    # Extract our parameters
+    username = module.params.get('username')
+    first_name = module.params.get('first_name')
+    last_name = module.params.get('last_name')
+    email = module.params.get('email')
+    is_superuser = module.params.get('is_superuser')
+    is_system_auditor = module.params.get('is_system_auditor')
+    password = module.params.get('password')
+    state = module.params.get('state')
+
+    # Attempt to look up the related items the user specified (these will fail the module if not found)
+
+    # Attempt to look up an existing item based on the provided data
+    existing_item = module.get_one('users', name_or_id=username)
+
+    if state == '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 = {}
+    if username is not None:
+        new_fields['username'] = module.get_item_name(existing_item) if existing_item else username
+    if first_name is not None:
+        new_fields['first_name'] = first_name
+    if last_name is not None:
+        new_fields['last_name'] = last_name
+    if email is not None:
+        new_fields['email'] = email
+    if is_superuser is not None:
+        new_fields['is_superuser'] = is_superuser
+    if is_system_auditor is not None:
+        new_fields['is_system_auditor'] = is_system_auditor
+    if password is not None:
+        new_fields['password'] = password
+
+    # 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='users', item_type='user')
+
+
+if __name__ == '__main__':
+    main()