Django 1.6
[fnpdjango.git] / fnpdjango / deploy / __init__.py
index 70a54b6..0ba4477 100644 (file)
@@ -10,7 +10,13 @@ Then set up some env properties:
     user: remote user name
     app_path: where does the app go
     services: list of tasks to run after deployment
-
+    django_root_path (optional): path to the directory
+        containing django project, relative to the
+        root of the repository (defaults to '.')
+    localsettings_dst_path (optional): path indicating
+        where to copy the localsettings file, relative
+        to django_root_path (defaults to project_name/localsettings.py)
+    skip_collect_static (optional): if True, Django collectstatic command is not called
 """
 from os.path import abspath, dirname, exists, join
 from django.utils.crypto import get_random_string
@@ -32,7 +38,7 @@ def setup():
     if not files.exists(env.app_path):
         run('mkdir -p %(app_path)s' % env, pty=True)
     with cd(env.app_path):
-        for subdir in 'releases', 'packages', 'log':
+        for subdir in 'releases', 'packages', 'log', 'samples':
             if not files.exists(subdir):
                 run('mkdir -p %s' % subdir, pty=True)
     with cd('%(app_path)s/releases' % env):
@@ -45,8 +51,7 @@ def setup():
 
 
 def check_localsettings():
-    if not files.exists('%(app_path)s/localsettings.py' % env):
-        abort('localsettings.py file missing.')
+    return files.exists('%(app_path)s/localsettings.py' % env)
 
 
 @task(default=True)
@@ -62,12 +67,15 @@ def deploy():
     env.release = time.strftime('%Y-%m-%dT%H%M')
 
     setup()
-    check_localsettings()
+    if not check_localsettings():
+        abort('Setup is complete, but\n    %(app_path)s/localsettings.py\n'
+              'is needed for actual deployment.' % env)
     upload_tar_from_git()
     copy_localsettings()
     install_requirements()
     symlink_current_release()
     migrate()
+    pre_collectstatic()
     collectstatic()
     restart()
 
@@ -145,15 +153,29 @@ class Supervisord(Service):
         print '>>> supervisord: restart %s' % self.name
         sudo('supervisorctl restart %s' % self.name, shell=False)
 
+class Command(Task):
+    def __init__(self, commands, working_dir):
+        if not hasattr(commands, '__iter__'):
+            commands = [commands]
+        self.name = 'Command: %s @ %s' % (commands, working_dir)
+        self.commands = commands
+        self.working_dir = working_dir
+
+    def run(self):
+        require('app_path')
+        with cd(join('%(app_path)s/releases/current' % env, self.working_dir)):
+            for command in self.commands:
+                run(command)
+
 def upload_samples():
     upload_localsettings_sample()
     upload_nginx_sample()
     for service in env.services:
         service.upload_sample()
 
-def upload_sample(name):
+def upload_sample(name, where="samples/"):
     require('app_path', 'project_name')
-    upload_path = '%(app_path)s/' % env + name + '.sample'
+    upload_path = '%s/%s%s.sample' % (env['app_path'], where, name)
     if files.exists(upload_path):
         return
     print '>>> upload %s template' % name
@@ -165,7 +187,7 @@ def upload_sample(name):
 def upload_localsettings_sample():
     "Fill out localsettings template and upload as a sample."
     env.secret_key = get_random_string(50)
-    upload_sample('localsettings.py')
+    upload_sample('localsettings.py', where="")
 
 upload_nginx_sample = lambda: upload_sample('nginx')
 
@@ -192,6 +214,7 @@ def install_requirements():
         run('%(virtualenv)s %(app_path)s/ve' % env, pty=True)
     with cd('%(app_path)s/releases/%(release)s' % env):
         run('%(app_path)s/ve/bin/pip install -r requirements.txt' % env, pty=True)
+    with cd(get_django_root_path(env['release'])):
         # Install DB requirement
         database_reqs = {
             'django.db.backends.postgresql_psycopg2': 'psycopg2',
@@ -211,7 +234,8 @@ def copy_localsettings():
     require('app_path', 'project_name')
 
     with settings(warn_only=True):
-        run('cp %(app_path)s/localsettings.py %(app_path)s/releases/%(release)s/%(project_name)s' % env)
+        copy_to = join(get_django_root_path(env['release']), env.get('localsettings_dst_path', env['project_name']))
+        run('cp %(app_path)s/localsettings.py ' % env + copy_to)
 
 def symlink_current_release():
     "Symlink our current release"
@@ -226,13 +250,29 @@ def migrate():
     "Update the database"
     print '>>> migrate'
     require('app_path', 'project_name')
-    with cd('%(app_path)s/releases/current' % env):
+    with cd(get_django_root_path('current')):
         run('%(app_path)s/ve/bin/python manage.py syncdb --noinput' % env, pty=True)
         run('%(app_path)s/ve/bin/python manage.py migrate' % env, pty=True)
 
+def pre_collectstatic():
+    print '>>> pre_collectstatic'
+    for task in env.get('pre_collectstatic', []):
+        execute(task)
+
 def collectstatic():
     """Collect static files"""
     print '>>> collectstatic'
+    if env.get('skip_collect_static', False):
+        print '... skipped'
+        return
     require('app_path', 'project_name')
-    with cd('%(app_path)s/releases/current' % env):
+    with cd(get_django_root_path('current')):
         run('%(app_path)s/ve/bin/python manage.py collectstatic --noinput' % env, pty=True)
+
+
+def get_django_root_path(release):
+    require('app_path')
+    path = '%(app_path)s/releases/%(release)s' % dict(app_path = env['app_path'], release = release)
+    if 'django_root_path' in env:
+        path = join(path, env['django_root_path'])
+    return path