ansible/hacking/test-module

#!/usr/bin/python

# (c) 2012, Michael DeHaan <michael.dehaan@gmail.com>
#
# This file is part of Ansible
#
# Ansible 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.
#
# Ansible 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 Ansible.  If not, see <http://www.gnu.org/licenses/>.
#

# this script is for testing modules without running through the
# entire guts of ansible, and is very helpful for when developing
# modules
#
# example:
#    test-module ../library/command /bin/sleep 3
#    test-module ../library/service name=httpd ensure=restarted

import sys
import os
import subprocess
import traceback
from ansible import utils
from ansible import module_common

try:
    import json
except ImportError:
    import simplejson as json

modfile = None

if len(sys.argv) == 1:
    print >>sys.stderr, "usage: test-module ./library/command [key=value ...]"
    sys.exit(1)

modfile = sys.argv[1]
if len(sys.argv) > 1:
    args = " ".join(sys.argv[2:])
else:
    args = ""

argspath = os.path.expanduser("~/.ansible_test_module_arguments")
argsfile = open(argspath, 'w')
argsfile.write(args)
argsfile.close()

module_fh = open(modfile)
module_data = module_fh.read()
included_boilerplate = module_data.find(module_common.REPLACER) != -1
module_fh.close()

if included_boilerplate:
    module_data = module_data.replace(module_common.REPLACER, module_common.MODULE_COMMON)
    modfile2_path = os.path.expanduser("~/.ansible_module_generated")
    print "* including generated source, if any, saving to: %s" % modfile2_path
    print "* this will offset any line numbers in tracebacks!"
    modfile2 = open(modfile2_path, 'w')
    modfile2.write(module_data)
    modfile2.close()
    modfile = modfile2_path
else:
    print "* module boilerplate substitution not requested in module, tracebacks will be unaltered"

os.system("chmod +x %s" % modfile)
cmd = subprocess.Popen("%s %s" % (modfile, argspath), 
    shell=True,
    stdout=subprocess.PIPE, 
    stderr=subprocess.PIPE)
(out, err) = cmd.communicate()

if err and err != '':
    print "***********************************"
    print "RECIEVED DATA ON STDERR, THIS WILL CRASH YOUR MODULE"
    print err
    sys.exit(1)

try:
    print "***********************************"
    print "RAW OUTPUT"
    print out
    results = utils.parse_json(out)
    
except:
    print "***********************************"
    print "INVALID OUTPUT FORMAT"
    print out
    traceback.print_exc()
    sys.exit(1)

print "***********************************"
print "PARSED OUTPUT"

print utils.jsonify(results,format=True)

sys.exit(0)