Merge "Cleanup inspection module location"

playbooks/library/os_ironic_inspect.py

@@ -1,138 +0,0 @@
-#!/usr/bin/env python
-# coding: utf-8 -*-
-
-# (c) 2015, Hewlett-Packard Development Company, L.P.
-#
-# This module is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# This software is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with this software.  If not, see <http://www.gnu.org/licenses/>.
-
-try:
-    import shade
-    HAS_SHADE = True
-except ImportError:
-    HAS_SHADE = False
-
-DOCUMENTATION = '''
----
-module: os_ironic_inspect
-short_description: Explicitly triggers node introspection in ironic.
-extends_documentation_fragment: openstack
-description:
-    - Reqeusts Ironic to set a node into inspect state in order to collect
-      metadata regarding the node. This command may be out of band, or in-band
-      depending on the Ironic driver configuration.  This is only possible on
-      nodes in 'manageable' and 'available' state.
-options:
-    mac:
-      description:
-        - unique mac address that is used to attempt to identify the host.
-      required: false
-      default: None
-    uuid:
-      description:
-        - globally unique identifier (UUID) to identify the host.
-      required: false
-      default: None
-    name:
-      description:
-        - unique name identifier to identify the host in Ironic.
-      required: false
-      default: None
-    ironic_url:
-      description:
-        - If noauth mode is utilized, this is required to be set to the
-          endpoint URL for the Ironic API.  Use with "auth" and "auth_type"
-          settings set to None.
-      required: false
-      default: None
-    timeout:
-      description:
-        - A timeout in seconds to tell the role to wait for the node to
-          complete introspection if wait is set to True.
-      required: false
-      default: 1200
-
-requirements: ["shade"]
-'''
-
-EXAMPLES = '''
-# Invoke node inspection
-- os_ironic_inspect:
-    name: "testnode1"
-'''
-
-
-def _choose_id_value(module):
-    if module.params['uuid']:
-        return module.params['uuid']
-    if module.params['name']:
-        return module.params['name']
-    return None
-
-
-def main():
-    argument_spec = openstack_full_argument_spec(
-        auth_type=dict(required=False),
-        uuid=dict(required=False),
-        name=dict(required=False),
-        mac=dict(required=False),
-        ironic_url=dict(required=False),
-        timeout=dict(default=1200, required=False),
-    )
-    module_kwargs = openstack_module_kwargs()
-    module = AnsibleModule(argument_spec, **module_kwargs)
-
-    if not HAS_SHADE:
-        module.fail_json(msg='shade is required for this module')
-    if (module.params['auth_type'] in [None, 'None'] and
-            module.params['ironic_url'] is None):
-        module.fail_json(msg="Authentication appears to be disabled, "
-                             "Please define an ironic_url parameter")
-
-    if (module.params['ironic_url'] and
-            module.params['auth_type'] in [None, 'None']):
-        module.params['auth'] = dict(
-            endpoint=module.params['ironic_url']
-        )
-
-    try:
-        cloud = shade.operator_cloud(**module.params)
-
-        if module.params['name'] or module.params['uuid']:
-            server = cloud.get_machine(_choose_id_value(module))
-        elif module.params['mac']:
-            server = cloud.get_machine_by_mac(module.params['mac'])
-        else:
-            module.fail_json(msg="The worlds did not align, "
-                                 "the host was not found as "
-                                 "no name, uuid, or mac was "
-                                 "defined.")
-        if server:
-            cloud.inspect_machine(server['uuid'], module.params['wait'])
-            # TODO(TheJulia): diff properties, ?and ports? and determine
-            # if a change occured.  In theory, the node is always changed
-            # if introspection is able to update the record.
-            module.exit_json(changed=True,
-                             ansible_facts=server['properties'])
-
-        else:
-            module.fail_json(msg="node not found.")
-
-    except shade.OpenStackCloudException as e:
-        module.fail_json(msg=e.message)
-
-
-# this is magic, see lib/ansible/module_common.py
-from ansible.module_utils.basic import *
-from ansible.module_utils.openstack import *
-main()

scripts/env-setup.sh

@@ -133,6 +133,12 @@ check_get_module `pwd`/lib/ansible/modules/core/cloud/openstack/os_ironic.py \
 check_get_module `pwd`/lib/ansible/modules/core/cloud/openstack/os_ironic_node.py \
     https://raw.githubusercontent.com/ansible/ansible-modules-core/stable-2.0/cloud/openstack/os_ironic_node.py
 
+# Note(TheJulia): Proposed, however not yet accepted. Once the pull request
+# https://github.com/ansible/ansible-modules-extras/pull/1681 has merged, this
+# URL should be changed.
+check_get_module `pwd`/lib/ansible/modules/extras/cloud/openstack/os_ironic_inspect.py \
+    https://raw.githubusercontent.com/juliakreger/ansible-modules-extras/feature/os-ironic-inspect/cloud/openstack/os_ironic_inspect.py
+
 if [ -n "${VENV-}" ]; then
     sudo -H -E ${PIP} install --upgrade /opt/stack/ansible
     echo