Updated the drpmachines.py script

General pep8 cleanups
Added debug logging
Updated docs to reflect the new debug option

Signed-off-by: Michael Rice <[email protected]>

Author: michaelrice

doc/integrations/ansible.rst

@@ -60,10 +60,13 @@ Download the `drpmachines.py` inventory script to the local system to a convenie
 
   ::
 
-    curl -s https://raw.githubusercontent.com/digitalrebar/provision/master/integrations/ansible/drpmachines.py -o drpmachines.py
+    curl -s https://raw.githubusercontent.com/digitalrebar/provision/v4/integrations/ansible/drpmachines.py -o drpmachines.py
     chmod +x drpmachines.py
     ./drpmachines.py | jq
 
+.. note:: If you run into problems using the drpmachines.py script try enabling the --debug flag for verbose logging.
+
+
 In order to test the Ansible integration, use the ping command.  If everything is working, all the machines in the system should receive and respond to the ping command.
 
   ::

integrations/ansible/drpmachines.py

@@ -1,4 +1,4 @@
-#! /usr/bin/env python
+#!/usr/bin/env python
 # Copyright 2019, RackN
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -14,44 +14,81 @@
 # limitations under the License.
 
 # pip install requests
-import requests, argparse, json, urllib3, os
+import argparse
+import json
+import logging
+import os
+
+try:
+    import requests
+    import urllib3
+except ImportError:
+    print("Missing requests. pip install requests")
+    raise SystemExit
 
 '''
-Usage: https://github.com/digitalrebar/provision/v4/tree/master/integration/ansible
+Usage: https://github.com/digitalrebar/provision/tree/v4/integrations/ansible
 
 example: ansible -i drpmachines.py all -a "uname -a"
 '''
 
-def main():
+urllib3.disable_warnings()
+
+
+def setup_logging():
+    fmat = '%(asctime)-15s %(name)s %(message)s'
+    logging.basicConfig(format=fmat, level=logging.DEBUG)
+
+
+def setup_parser():
+    parser = argparse.ArgumentParser(
+        description="Ansible dynamic inventory via DigitalRebar"
+    )
+    parser.add_argument(
+        "--list",
+        help="Ansible inventory of all of the deployments",
+        action="store_true",
+        dest="list_inventory"
+    )
+    parser.add_argument(
+        "--host",
+        help="Ansible inventory of a particular host",
+        action="store",
+        dest="ansible_host",
+        type=str
+    )
+    parser.add_argument(
+        "--debug",
+        action="store_true",
+        help="Enable debug logging."
+    )
+    return parser.parse_args()
 
-    inventory = { "_meta": { "hostvars": {} } }
 
+def main():
+    cli_args = setup_parser()
+    if cli_args.debug:
+        setup_logging()
+    inventory = {"_meta": {"hostvars": {}}}
     # change these values to match your DigitalRebar installation
     addr = os.getenv('RS_ENDPOINT', "https://127.0.0.1:8092")
+    logging.debug("RS_ENDPOINT: {0}".format(addr))
     ups = os.getenv('RS_KEY', "rocketskates:r0cketsk8ts")
+    logging.debug("RS_KEY: {0}".format(ups))
     profile = os.getenv('RS_ANSIBLE', "all_machines")
+    logging.debug("RS_ANSIBLE: {0}".format(profile))
     host_address = os.getenv('RS_HOST_ADDRESS', "internal")
+    logging.debug("RS_HOST_ADDRESS: {0}".format(host_address))
     ansible_user = os.getenv('RS_ANSIBLE_USER', "root")
+    logging.debug("RS_ANSIBLE_USER: {0}".format(ansible_user))
     parent_key = os.getenv('RS_ANSIBLE_PARENT', "ansible/children")
-    arr = ups.split(":")
-    user = arr[0]
-    password = arr[1]
-
-    # Argument parsing 
-    parser = argparse.ArgumentParser(description="Ansible dynamic inventory via DigitalRebar")
-    parser.add_argument("--list", help="Ansible inventory of all of the deployments", 
-        action="store_true", dest="list_inventory")
-    parser.add_argument("--host",
-        help="Ansible inventory of a particular host", action="store",
-        dest="ansible_host", type=str)
-
-    cli_args = parser.parse_args()
+    logging.debug("RS_ANSIBLE_PARENT: {0}".format(parent_key))
+    user, password = ups.split(":")
+
     list_inventory = cli_args.list_inventory
     ansible_host = cli_args.ansible_host
-
-    Headers = {'content-type': 'application/json'}
-    urllib3.disable_warnings()
-    inventory = {'all': { 'hosts': [] }, '_meta': { 'hostvars': {}} }
+    headers = {'content-type': 'application/json'}
+    inventory = {'all': {'hosts': []}, '_meta': {'hostvars': {}}}
     inventory["_meta"]["rebar_url"] = addr
     inventory["_meta"]["rebar_user"] = user
     inventory["_meta"]["rebar_profile"] = profile
@@ -61,21 +98,26 @@ def main():
     profiles_vars = {}
     hostvars = {}
 
-    URL = addr + "/api/v3/machines"
+    url = addr + "/api/v3/machines"
     if list_inventory:
         if profile != "all_machines":
-            URL += "?ansible=Eq(" + profile + ")"
+            url += "?ansible=Eq({0})".format(profile)
     else:
         if ansible_host:
-            URL += "?Name=" + ansible_host
+            url += "?Name={0}".format(ansible_host)
         else:
             if profile != "all_machines":
-                URL += "?ansible=Eq(" + profile + ")"
+                url += "?ansible=Eq({0})".format(profile)
 
-    raw = requests.get(URL,headers=Headers,auth=(user,password),verify=False)
+    raw = requests.get(
+        url,
+        headers=headers,
+        auth=(user, password),
+        verify=False
+    )
 
-    IGNORE_PARAMS = ["gohai-inventory","inventory/data","change-stage/map"]
-    if raw.status_code == 200: 
+    ignore_params = ["gohai-inventory", "inventory/data", "change-stage/map"]
+    if raw.status_code == 200:
         for machine in raw.json():
             name = machine[u'Name']
             inventory["all"]["hosts"].extend([name])
@@ -87,21 +129,27 @@ def main():
             myvars["ansible_user"] = ansible_user
             myvars["rebar_uuid"] = machine[u"Uuid"]
             for k in machine[u'Params']:
-                if k not in IGNORE_PARAMS:
+                if k not in ignore_params:
                     myvars[k] = machine[u'Params'][k]
             inventory["_meta"]["hostvars"][name] = myvars
     else:
         raise IOError(raw.text)
 
     if ansible_host is None:
-        groups = requests.get(addr + "/api/v3/profiles",headers=Headers,auth=(user,password),verify=False)
+        groups = requests.get(
+            addr + "/api/v3/profiles",
+            headers=headers,
+            auth=(user, password),
+            verify=False
+        )
         if groups.status_code == 200:
             for group in groups.json():
                 name = group[u'Name']
                 if name != "global" and name != "rackn-license":
-                    inventory[name] = { "hosts": [], "vars": [] }
+                    inventory[name] = {"hosts": [], "vars": []}
                     gvars = hostvars.copy()
-                    if 'Profiles' in group.keys() and len(group[u'Profiles'])>0:
+                    if 'Profiles' in group.keys() \
+                            and len(group[u'Profiles']) > 0:
                         inventory[name]["children"] = group[u'Profiles']
                     for k in group[u'Params']:
                         v = group[u'Params'][k]
@@ -110,7 +158,14 @@ def main():
                         else:
                             gvars[k] = v
                     inventory[name]["vars"] = gvars
-                    hosts = requests.get(addr + "/api/v3/machines?slim=Params&Profiles=In("+name+")",headers=Headers,auth=(user,password),verify=False)
+                    hosts = requests.get(
+                        "{0}/api/v3/machines?slim=Params&Profiles=In({1})".format(
+                            addr, name
+                        ),
+                        headers=headers,
+                        auth=(user, password),
+                        verify=False
+                    )
                     if hosts.status_code == 200:
                         inventory[name]["hosts"] = []
                         for host in hosts.json():
@@ -121,5 +176,6 @@ def main():
 
     print(json.dumps(inventory))
 
+
 if __name__ == "__main__":
     main()