Deploy: Add root manage.py helper script, use fabric.context_managers.settings instea...
[fnpdjango.git] / fnpdjango / deploy / __init__.py
index f0f4837..1fbe57c 100644 (file)
@@ -13,10 +13,16 @@ Then set up some env properties:
     django_root_path (optional): path to the directory
         containing django project, relative to the
         root of the repository (defaults to '.')
     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 subprocess import check_output
 from os.path import abspath, dirname, exists, join
 from django.utils.crypto import get_random_string
 from fabric.api import *
 from os.path import abspath, dirname, exists, join
 from django.utils.crypto import get_random_string
 from fabric.api import *
+from fabric.context_managers import settings
 from fabric.contrib import files
 from fabric.tasks import Task, execute
 
 from fabric.contrib import files
 from fabric.tasks import Task, execute
 
@@ -34,9 +40,13 @@ def setup():
     if not files.exists(env.app_path):
         run('mkdir -p %(app_path)s' % env, pty=True)
     with cd(env.app_path):
     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)
             if not files.exists(subdir):
                 run('mkdir -p %s' % subdir, pty=True)
+        # Install helper manage.py script into root dir.
+        if not files.exists('manage.py'):
+            with settings(full_django_root=get_django_root_path('current')):
+                upload_sample('manage.py', where='', ext='', mode=0755)
     with cd('%(app_path)s/releases' % env):
         if not files.exists('current'):
             run('ln -sfT . current', pty=True)
     with cd('%(app_path)s/releases' % env):
         if not files.exists('current'):
             run('ln -sfT . current', pty=True)
@@ -47,8 +57,7 @@ def setup():
 
 
 def check_localsettings():
 
 
 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)
 
 
 @task(default=True)
@@ -61,15 +70,18 @@ def deploy():
     require('hosts', 'app_path')
 
     import time
     require('hosts', 'app_path')
 
     import time
-    env.release = time.strftime('%Y-%m-%dT%H%M')
+    env.release = '%s_%s' % (time.strftime('%Y-%m-%dT%H%M'), check_output(['git', 'rev-parse', 'HEAD']).strip())
 
     setup()
 
     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()
     upload_tar_from_git()
     copy_localsettings()
     install_requirements()
     symlink_current_release()
     migrate()
+    pre_collectstatic()
     collectstatic()
     restart()
 
     collectstatic()
     restart()
 
@@ -107,8 +119,7 @@ def deploy_version(version):
 
 @task
 def restart():
 
 @task
 def restart():
-    require('services')
-    for service in env.services:
+    for service in env.services or ():
         execute(service)
 
 
         execute(service)
 
 
@@ -130,7 +141,8 @@ class DebianGunicorn(Service):
         sudo('gunicorn-debian restart %s' % self.name, shell=False)
 
     def upload_sample(self):
         sudo('gunicorn-debian restart %s' % self.name, shell=False)
 
     def upload_sample(self):
-        upload_sample('gunicorn')
+        with settings(full_django_root=get_django_root_path('current')):
+            upload_sample('gunicorn')
 
 class Apache(Service):
     def run(self):
 
 class Apache(Service):
     def run(self):
@@ -147,27 +159,41 @@ class Supervisord(Service):
         print '>>> supervisord: restart %s' % self.name
         sudo('supervisorctl restart %s' % self.name, shell=False)
 
         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_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/", ext='.sample', **kwargs):
     require('app_path', 'project_name')
     require('app_path', 'project_name')
-    upload_path = '%(app_path)s/' % env + name + '.sample'
+    upload_path = '%s/%s%s%s' % (env['app_path'], where, name, ext)
     if files.exists(upload_path):
         return
     print '>>> upload %s template' % name
     template = '%(project_name)s/' % env + name + '.template'
     if not exists(template):
         template = join(dirname(abspath(__file__)), 'templates/' + name + '.template')
     if files.exists(upload_path):
         return
     print '>>> upload %s template' % name
     template = '%(project_name)s/' % env + name + '.template'
     if not exists(template):
         template = join(dirname(abspath(__file__)), 'templates/' + name + '.template')
-    files.upload_template(template, upload_path, env)
+    files.upload_template(template, upload_path, env, **kwargs)
 
 def upload_localsettings_sample():
     "Fill out localsettings template and upload as a sample."
     env.secret_key = get_random_string(50)
 
 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')
 
 
 upload_nginx_sample = lambda: upload_sample('nginx')
 
@@ -214,7 +240,7 @@ def copy_localsettings():
     require('app_path', 'project_name')
 
     with settings(warn_only=True):
     require('app_path', 'project_name')
 
     with settings(warn_only=True):
-        copy_to = join(get_django_root_path(env['release']), env['project_name'])
+        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():
         run('cp %(app_path)s/localsettings.py ' % env + copy_to)
 
 def symlink_current_release():
@@ -234,9 +260,17 @@ def migrate():
         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)
 
         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'
 def collectstatic():
     """Collect static files"""
     print '>>> collectstatic'
+    if env.get('skip_collect_static', False):
+        print '... skipped'
+        return
     require('app_path', 'project_name')
     with cd(get_django_root_path('current')):
         run('%(app_path)s/ve/bin/python manage.py collectstatic --noinput' % env, pty=True)
     require('app_path', 'project_name')
     with cd(get_django_root_path('current')):
         run('%(app_path)s/ve/bin/python manage.py collectstatic --noinput' % env, pty=True)
@@ -247,4 +281,4 @@ def get_django_root_path(release):
     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'])
     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
\ No newline at end of file
+    return path