ansible/library/web_infrastructure/django_manage

280 lines
10 KiB
Text
Raw Normal View History

2013-02-24 19:33:25 +01:00
#!/usr/bin/python
# -*- coding: utf-8 -*-
# (c) 2013, Scott Anderson <scottanderson42@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/>.
#
DOCUMENTATION = '''
---
2013-02-28 21:57:27 +01:00
module: django_manage
2013-02-24 19:33:25 +01:00
short_description: Manages a Django application.
description:
- Manages a Django application using the I(manage.py) application frontend to I(django-admin). With the I(virtualenv) parameter, all management commands will be executed by the given I(virtualenv) installation.
2013-02-24 19:33:25 +01:00
version_added: "1.1"
options:
command:
choices: [ 'cleanup', 'flush', 'loaddata', 'runfcgi', 'syncdb', 'test', 'validate', 'migrate', 'collectstatic' ]
2013-02-24 19:33:25 +01:00
description:
- The name of the Django management command to run. Allowed commands are cleanup, createcachetable, flush, loaddata, syncdb, test, validate.
2013-02-24 19:33:25 +01:00
required: true
app_path:
description:
- The path to the root of the Django application where B(manage.py) lives.
2013-02-24 19:33:25 +01:00
required: true
settings:
description:
- The Python path to the application's settings module, such as 'myapp.settings'.
2013-02-24 19:33:25 +01:00
required: false
pythonpath:
description:
- A directory to add to the Python path. Typically used to include the settings module if it is located external to the application directory.
2013-02-24 19:33:25 +01:00
required: false
virtualenv:
description:
- An optional path to a I(virtualenv) installation to use while running the manage application.
2013-02-24 19:33:25 +01:00
required: false
apps:
description:
- A list of space-delimited apps to target. Used by the 'test' command.
2013-02-24 19:33:25 +01:00
required: false
cache_table:
2013-02-24 19:33:25 +01:00
description:
- The name of the table used for database-backed caching. Used by the 'createcachetable' command.
2013-02-24 19:33:25 +01:00
required: false
database:
2013-02-24 19:33:25 +01:00
description:
- The database to target. Used by the 'createcachetable', 'flush', 'loaddata', and 'syncdb' commands.
2013-02-24 19:33:25 +01:00
required: false
failfast:
description:
- Fail the command immediately if a test fails. Used by the 'test' command.
2013-02-24 19:33:25 +01:00
required: false
default: "no"
choices: [ "yes", "no" ]
2013-02-24 19:33:25 +01:00
fixtures:
description:
- A space-delimited list of fixture file names to load in the database. B(Required) by the 'loaddata' command.
2013-02-24 19:33:25 +01:00
required: false
skip:
description:
- Will skip over out-of-order missing migrations, you can only use this parameter with I(migrate)
required: false
merge:
description:
- Will run out-of-order or missing migrations as they are not rollback migrations, you can only use this parameter with 'migrate' command
required: false
link:
description:
- Will create links to the files instead of copying them, you can only use this parameter with 'collectstatic' command
required: false
2013-02-24 19:33:25 +01:00
notes:
2013-06-13 20:01:32 +02:00
- I(virtualenv) (U(http://www.virtualenv.org)) must be installed on the remote host if the virtualenv parameter is specified.
2013-02-27 16:01:12 +01:00
- This module will create a virtualenv if the virtualenv parameter is specified and a virtualenv does not already exist at the given location.
- This module assumes English error messages for the 'createcachetable' command to detect table existence, unfortunately.
- To be able to use the migrate command, you must have south installed and added as an app in your settings
- To be able to use the collectstatic command, you must have enabled staticfiles in your settings
requirements: [ "virtualenv", "django" ]
2013-02-24 19:33:25 +01:00
author: Scott Anderson
'''
EXAMPLES = """
# Run cleanup on the application installed in 'django_dir'.
- django_manage: command=cleanup app_path={{ django_dir }}
# Load the initial_data fixture into the application
- django_manage: command=loaddata app_path={{ django_dir }} fixtures={{ initial_data }}
#Run syncdb on the application
- django_manage: >
command=syncdb
app_path={{ django_dir }}
settings={{ settings_app_name }}
pythonpath={{ settings_dir }}
virtualenv={{ virtualenv_dir }}
#Run the SmokeTest test case from the main app. Useful for testing deploys.
- django_manage: command=test app_path=django_dir apps=main.SmokeTest
"""
2013-02-24 19:33:25 +01:00
import os
def _fail(module, cmd, out, err, **kwargs):
msg = ''
if out:
msg += "stdout: %s" % (out, )
if err:
msg += "\n:stderr: %s" % (err, )
module.fail_json(cmd=cmd, msg=msg, **kwargs)
def _ensure_virtualenv(module):
2013-02-24 19:33:25 +01:00
venv_param = module.params['virtualenv']
if venv_param is None:
return
2013-02-24 19:33:25 +01:00
virtualenv = module.get_bin_path('virtualenv', True)
vbin = os.path.join(os.path.expanduser(venv_param), 'bin')
2013-02-24 19:33:25 +01:00
activate = os.path.join(vbin, 'activate')
if not os.path.exists(activate):
vcmd = '%s %s' % (virtualenv, venv_param)
vcmd = [virtualenv, venv_param]
rc, out_venv, err_venv = module.run_command(vcmd)
if rc != 0:
_fail(module, vcmd, out_venv, err_venv)
os.environ["PATH"] = "%s:%s" % (vbin, os.environ["PATH"])
def createcachetable_filter_output(line):
return "Already exists" not in line
2013-02-24 19:33:25 +01:00
def flush_filter_output(line):
return "Installed" in line and "Installed 0 object" not in line
def loaddata_filter_output(line):
return "Installed" in line and "Installed 0 object" not in line
def syncdb_filter_output(line):
return ("Creating table " in line) or ("Installed" in line and "Installed 0 object" not in line)
def migrate_filter_output(line):
return ("Migrating forwards " in line) or ("Installed" in line and "Installed 0 object" not in line)
2013-02-24 19:33:25 +01:00
def main():
command_allowed_param_map = dict(
cleanup=(),
createcachetable=('cache_table', 'database', ),
2013-02-24 19:33:25 +01:00
flush=('database', ),
loaddata=('database', 'fixtures', ),
syncdb=('database', ),
test=('failfast', 'testrunner', 'liveserver', 'apps', ),
validate=(),
2013-10-09 15:57:01 +02:00
migrate=('apps', 'skip', 'merge'),
collectstatic=('link', ),
2013-02-24 19:33:25 +01:00
)
command_required_param_map = dict(
loaddata=('fixtures', ),
createcachetable=('cache_table', ),
2013-02-24 19:33:25 +01:00
)
# forces --noinput on every command that needs it
noinput_commands = (
'flush',
'syncdb',
'migrate',
2013-02-24 19:33:25 +01:00
'test',
'collectstatic',
2013-02-24 19:33:25 +01:00
)
# These params are allowed for certain commands only
2013-07-01 00:52:57 +02:00
specific_params = ('apps', 'database', 'failfast', 'fixtures', 'liveserver', 'testrunner')
2013-02-24 19:33:25 +01:00
# These params are automatically added to the command if present
general_params = ('settings', 'pythonpath', 'database',)
2013-07-01 00:52:57 +02:00
specific_boolean_params = ('failfast', 'skip', 'merge', 'link')
end_of_command_params = ('apps', 'cache_table', 'fixtures')
2013-02-24 19:33:25 +01:00
module = AnsibleModule(
argument_spec=dict(
command = dict(default=None, required=True),
app_path = dict(default=None, required=True),
settings = dict(default=None, required=False),
pythonpath = dict(default=None, required=False, aliases=['python_path']),
virtualenv = dict(default=None, required=False, aliases=['virtual_env']),
apps = dict(default=None, required=False),
cache_table = dict(default=None, required=False),
database = dict(default=None, required=False),
failfast = dict(default='no', required=False, choices=BOOLEANS, aliases=['fail_fast']),
fixtures = dict(default=None, required=False),
liveserver = dict(default=None, required=False, aliases=['live_server']),
testrunner = dict(default=None, required=False, aliases=['test_runner']),
skip = dict(default=None, required=False, choices=BOOLEANS),
merge = dict(default=None, required=False, choices=BOOLEANS),
link = dict(default=None, required=False, choices=BOOLEANS),
2013-02-24 19:33:25 +01:00
),
)
command = module.params['command']
app_path = module.params['app_path']
virtualenv = module.params['virtualenv']
for param in specific_params:
value = module.params[param]
if param in specific_boolean_params:
value = module.boolean(value)
if value and param not in command_allowed_param_map[command]:
module.fail_json(msg='%s param is incompatible with command=%s' % (param, command))
for param in command_required_param_map.get(command, ()):
if not module.params[param]:
module.fail_json(msg='%s param is required for command=%s' % (param, command))
2013-02-24 19:33:25 +01:00
venv = module.params['virtualenv']
_ensure_virtualenv(module)
os.chdir(app_path)
cmd = "python manage.py %s" % (command, )
if command in noinput_commands:
cmd = '%s --noinput' % cmd
for param in general_params:
if module.params[param]:
cmd = '%s --%s=%s' % (cmd, param, module.params[param])
for param in specific_boolean_params:
if module.boolean(module.params[param]):
cmd = '%s --%s' % (cmd, param)
# these params always get tacked on the end of the command
for param in end_of_command_params:
if module.params[param]:
cmd = '%s %s' % (cmd, module.params[param])
rc, out, err = module.run_command(cmd)
if rc != 0:
if command == 'createcachetable' and 'table' in err and 'already exists' in err:
out = 'Already exists.'
else:
if "Unknown command:" in err:
_fail(module, cmd, err, "Unknown django command: %s" % command)
_fail(module, cmd, out, err, path=os.environ["PATH"], syspath=sys.path)
2013-02-24 19:33:25 +01:00
changed = False
lines = out.split('\n')
filt = globals().get(command + "_filter_output", None)
if filt:
filtered_output = filter(filt, out.split('\n'))
if len(filtered_output):
changed = filtered_output
module.exit_json(changed=changed, out=out, cmd=cmd, app_path=app_path, virtualenv=virtualenv,
settings=module.params['settings'], pythonpath=module.params['pythonpath'])
# this is magic, see lib/ansible/module_common.py
#<<INCLUDE_ANSIBLE_MODULE_COMMON>>
main()