-"""Management utilities."""
+""" Karmaworld Fabric management script
+ Finals Club (c) 2013"""
-from fabric.contrib.console import confirm
-from fabric.api import abort, env, local, settings, task
+import os
+import ConfigParser
+from fabric.api import cd, env, lcd, prefix, run, sudo, task, local, settings
+from fabric.contrib import files
-########## GLOBALS
-env.run = 'heroku run python manage.py'
-HEROKU_ADDONS = (
- 'cloudamqp:lemur',
- 'heroku-postgresql:dev',
- 'scheduler:standard',
- 'memcache:5mb',
- 'newrelic:standard',
- 'pgbackups:auto-month',
- 'sentry:developer',
-)
-HEROKU_CONFIGS = (
- 'DJANGO_SETTINGS_MODULE=karmaworld.settings.prod',
- 'SECRET_KEY=(s1k!&^7l28k&nrm2ek(qqo&19%y(zn#=^zq_*ur2@irjun0x4'
- 'AWS_ACCESS_KEY_ID=xxx',
- 'AWS_SECRET_ACCESS_KEY=xxx',
- 'AWS_STORAGE_BUCKET_NAME=xxx',
-)
-########## END GLOBALS
+######### GLOBAL
+env.group = 'www-data'
+env.proj_repo = 'git@github.com:FinalsClub/karmaworld.git'
+env.repo_root = '~/karmaworld' # transient setting for VMs only
+env.proj_root = '/var/www/karmaworld'
+env.branch = 'prod' # only used for supervisor conf two lines below. cleanup?
+env.code_root = env.proj_root
+env.supervisor_conf = '{0}/confs/{1}/supervisord.conf'.format(env.code_root, env.branch)
+env.usde_csv = '{0}/confs/acceditation.csv'.format(env.code_root)
+env.use_ssh_config = True
-########## HELPERS
-def cont(cmd, message):
- """Given a command, ``cmd``, and a message, ``message``, allow a user to
- either continue or break execution if errors occur while executing ``cmd``.
+######## Run Commands in Virtual Environment
+def virtenv_path():
+ """
+ Find and memoize the virtualenv for use internally.
+ """
+ default_venv = env.proj_root + '/venv/bin/activate'
- :param str cmd: The command to execute on the local system.
- :param str message: The message to display to the user on failure.
+ # Return environment root if its been memoized
+ if 'env_root' in env and env['env_root']:
+ return env['env_root']
- .. note::
- ``message`` should be phrased in the form of a question, as if ``cmd``'s
- execution fails, we'll ask the user to press 'y' or 'n' to continue or
- cancel exeuction, respectively.
+ # Not memoized. Try to find a single unique virtual environment.
+ with settings(warn_only=True):
+ outp = run("find -L {0} -path '*/bin/activate' | grep -v '/local/'".format(env.proj_root))
+ if not len(outp) or len(outp.splitlines()) != 1:
+ # Cannot find any virtualenv or found multiple virtualenvs.
+ if len(outp) and default_venv not in outp:
+ # Multiple venvs and the default is not present.
+ raise Exception('Cannot determine the appropriate virtualenv.')
+ # If there are no virtualenvs, then use the default (this will create
+ # one if being called by make_virtualenv, otherwise it will cause an
+ # error).
+ # If there are multiple virtualenvs and the default is in their midst,
+ # use the default.
+ outp = default_venv
+ # Pop off the /bin/activate from /venv/bin/activate
+ outp = os.path.sep.join(outp.split(os.path.sep)[:-2])
+ env['env_root'] = outp
+ return outp
- Usage::
+def virtenv_exec(command):
+ """
+ Execute command in Virtualenv
+ """
+ with prefix('source {0}/bin/activate'.format(virtenv_path())):
+ run(command)
- cont('heroku run ...', "Couldn't complete %s. Continue anyway?" % cmd)
+######## Sync database
+@task
+def syncdb():
"""
- with settings(warn_only=True):
- result = local(cmd, capture=True)
+ Sync Database
+ """
+ virtenv_exec('{0}/manage.py syncdb --migrate --noinput'.format(env.code_root))
- if message and result.failed and not confirm(message):
- abort('Stopped execution per user request.')
-########## END HELPERS
+####### Collect Static Files
+@task
+def collect_static():
+ """
+ Collect static files (if AWS config. present, push to S3)
+ """
+
+ virtenv_exec('{0}/manage.py collectstatic --noinput'.format(env.code_root))
-########## DATABASE MANAGEMENT
+####### Run Dev Server
@task
-def syncdb():
- """Run a syncdb."""
- local('%(run)s syncdb --noinput' % env)
+def dev_server():
+ """
+ Runs the built-in django webserver
+ """
+
+ virtenv_exec('{0}/manage.py runserver'.format(env.code_root))
+####### Create Virtual Environment
@task
-def migrate(app=None):
- """Apply one (or more) migrations. If no app is specified, fabric will
- attempt to run a site-wide migration.
+def link_code():
+ """
+ Link the karmaworld repo into the appropriate production location
+ """
+ if not files.exists(env.code_root):
+ run('ln -s {0} {1}'.format(env.repo_root, env.code_root))
- :param str app: Django app name to migrate.
+@task
+def make_virtualenv():
+ """
+ Create our Virtualenv
"""
- if app:
- local('%s migrate %s --noinput' % (env.run, app))
- else:
- local('%(run)s migrate --noinput' % env)
-########## END DATABASE MANAGEMENT
+ run('virtualenv {0}'.format(virtenv_path()))
+
+@task
+def start_supervisord():
+ """
+ Starts supervisord
+ """
+ virtenv_exec('supervisord -c {0}'.format(env.supervisor_conf))
-########## FILE MANAGEMENT
@task
-def collectstatic():
- """Collect all static files, and copy them to S3 for production usage."""
- local('%(run)s collectstatic --noinput' % env)
-########## END FILE MANAGEMENT
+def stop_supervisord():
+ """
+ Restarts supervisord
+ """
+ virtenv_exec('supervisorctl -c {0} shutdown'.format(env.supervisor_conf))
-########## HEROKU MANAGEMENT
@task
-def bootstrap():
- """Bootstrap your new application with Heroku, preparing it for a production
- deployment. This will:
+def restart_supervisord():
+ """
+ Restarts supervisord, also making sure to load in new config data.
+ """
+ virtenv_exec('supervisorctl -c {0} update; supervisorctl -c {0} restart all'.format(env.supervisor_conf))
- - Create a new Heroku application.
- - Install all ``HEROKU_ADDONS``.
- - Sync the database.
- - Apply all database migrations.
- - Initialize New Relic's monitoring add-on.
+
+def supervisorctl(action, process):
+ """
+ Takes as arguments the name of the process as is
+ defined in supervisord.conf and the action that should
+ be performed on it: start|stop|restart.
"""
- cont('heroku create', "Couldn't create the Heroku app, continue anyway?")
+ virtenv_exec('supervisorctl -c {0} {1} {2}'.format(env.supervisor_conf, action, process))
- for addon in HEROKU_ADDONS:
- cont('heroku addons:add %s' % addon,
- "Couldn't add %s to your Heroku app, continue anyway?" % addon)
- for config in HEROKU_CONFIGS:
- cont('heroku config:add %s' % config,
- "Couldn't add %s to your Heroku app, continue anyway?" % config)
+@task
+def start_celery():
+ """
+ Starts the celeryd process
+ """
+ supervisorctl('start', 'celeryd')
- cont('git push heroku master',
- "Couldn't push your application to Heroku, continue anyway?")
- syncdb()
- migrate()
+@task
+def stop_celery():
+ """
+ Stops the celeryd process
+ """
+ supervisorctl('stop', 'celeryd')
+
- cont('%(run)s newrelic-admin validate-config - stdout' % env,
- "Couldn't initialize New Relic, continue anyway?")
+@task
+def restart_celery():
+ """
+ Restarts the celeryd process
+ """
+ supervisorctl('restart', 'celeryd')
@task
-def destroy():
- """Destroy this Heroku application. Wipe it from existance.
+def start_gunicorn():
+ """
+ Starts the gunicorn process
+ """
+ supervisorctl('start', 'gunicorn')
+
- .. note::
- This really will completely destroy your application. Think twice.
+@task
+def stop_gunicorn():
+ """
+ Stops the gunicorn process
"""
- local('heroku apps:destroy')
-########## END HEROKU MANAGEMENT
+ supervisorctl('stop', 'gunicorn')
+
+
+@task
+def restart_gunicorn():
+ """
+ Restarts the gunicorn process
+ """
+ supervisorctl('restart', 'gunicorn')
+
+
+####### Update Requirements
+@task
+def update_reqs():
+ virtenv_exec('pip install --upgrade -r {0}/reqs/prod.txt'.format(env.code_root))
+
+####### Pull new code
+@task
+def update_code():
+ virtenv_exec('cd {0}; git pull'.format(env.code_root))
+
+def backup():
+ """
+ Create backup using bup
+ """
+ pass
+
+@task
+def file_setup():
+ """
+ Deploy expected files and directories from non-apt system services.
+ """
+ ini_parser = ConfigParser.SafeConfigParser()
+ if not ini_parser.read(env.supervisor_conf):
+ raise Exception("Could not parse INI file {0}".format(env.supervisor_conf))
+ for section, option in (('supervisord','logfile'),
+ ('supervisord','pidfile'),
+ ('unix_http_server','file'),
+ ('program:celeryd','stdout_logfile')):
+ filepath = ini_parser.get(section, option)
+ # generate file's directory structure if needed
+ run('mkdir -p {0}'.format(os.path.split(filepath)[0]))
+ # touch a file and change ownership if needed
+ if 'log' in option and not files.exists(filepath):
+ sudo('touch {0}'.format(filepath))
+ sudo('chown {0}:{1} {2}'.format(env.local_user, env.group, filepath))
+
+@task
+def check_secrets():
+ """
+ Ensure secret files exist for syncdb to run.
+ """
+
+ secrets_path = env.code_root + '/karmaworld/secret'
+ secrets_files = ('filepicker.py', 'static_s3.py', 'db_settings.py', 'drive.py', 'client_secrets.json', 'drive.p12')
+
+ errors = []
+ for sfile in secrets_files:
+ ffile = os.path.sep.join((secrets_path,sfile))
+ if not files.exists(ffile):
+ errors.append('{0} missing. Please add and try again.'.format(ffile))
+ if errors:
+ raise Exception('\n'.join(errors))
+
+@task
+def fetch_usde():
+ """
+ Download USDE accreditation school CSV.
+ """
+ virtenv_exec('{0}/manage.py fetch_usde_csv {1}'.format(env.code_root, env.usde_csv))
+
+@task
+def import_usde():
+ """
+ Import accreditation school CSV into the database and scrub it.
+ """
+ virtenv_exec('{0}/manage.py import_usde_csv {1}'.format(env.code_root, env.usde_csv))
+ virtenv_exec('{0}/manage.py sanitize_usde_schools'.format(env.code_root))
+
+@task
+def first_deploy():
+ """
+ Sets up and deploys the project for the first time.
+ """
+ link_code()
+ make_virtualenv()
+ file_setup()
+ check_secrets()
+ update_reqs()
+ syncdb()
+ collect_static()
+ fetch_usde()
+ import_usde()
+ start_supervisord()
+ print "You should run `manage.py createsuperuser` in the virtual environment"
+
+
+@task
+def deploy():
+ """
+ Deploys the latest changes
+ """
+ update_code()
+ update_reqs()
+ syncdb()
+ collect_static()
+ restart_supervisord()
+########## END COMMANDS
projects / oweals / karmaworld.git / blobdiff