Source

fabulator / src / fabfile.py

Full commit
# -*- coding: utf-8 -
"""
    Une documentation de ce fabfile s'impose.

    fabric est une solution de deploiment
    -> http://docs.fabfile.org/0.9.0/

    ce fichier définit des rules pour:

    -> restarter les services (nginx, gunicorn, memcached)
    -> mettre a jour le code (via mercurial)

    chaque path est configurable via le fichier conf.yaml.

    notez que:
        - c'est super dépendant du path et du repository qui sont 
        toujours organisés de la sorte chez moi:

        repos/
            src/
                <project_django>/   # le dossier du projet django
            sandbox/                # le virtualenv
            deploy/                 # le dossier ou se trouve le fabfile
            doc/                    # ce dossier est voué a etre vide

    généralement, il me suffit de faire:
    fab {pre,}prod install

    todo: 
        - ajouter south
"""
import os
import datetime
from fabric.api import *
from fabric.contrib.files import exists, sed
from fabulator.decorators import Permissions, ConfChecker
from fabulator.core import south, haystack
from fabulator.core.db import mysql

from fabulator.core.db import database_factory
from fabulator.core.vc import vc_factory
from fabulator.core.http import http_factory

from fabulator.core.virtualenv import VirtualEnv

import yaml
import time

def load_yaml(env_type, conf):
    # sure we can do more there
    env.yaml = yaml.load(file(conf).read()).get(env_type)


def build(conf):
    """instanciate the backend"""
    # we can be more magic here
    if "vc" in conf:
        env.vc = vc_factory(conf["vc"].get("type"), conf.get("vc"), env)
    if "database" in conf:
        env.db = database_factory(conf["database"].get("type"), conf.get("database"), env)
    if "httpd" in conf:
        env.httpd = http_factory(conf["httpd"].get("type"), conf.get("httpd"), env)
    if "virtualenv" in conf:
        env.virtualenv = VirtualEnv(conf.get("virtualenv"), env)

def preprod(conf="conf.yaml"):
    """Preprod tasks"""
    load_yaml('preprod', conf)
    env.project_name = env.yaml.get('project').get('name')
    env.type = 'preprod'
    env.hosts = env.yaml.get('hosts').get('web')
    env.user = env.yaml.get('project').get('sudo_user')
    env.path = env.yaml.get('project').get('root_dir')
    env.virtualhost_path = env.path
    build(env.yaml)

def prod(conf="conf.yaml"):
    """Prod tasks"""
    load_yaml('prod', conf)
    env.project_name = env.yaml.get('project').get('name')
    env.type = 'prod'
    env.hosts = env.yaml.get('hosts').get('web')
    env.user = env.yaml.get('project').get('sudo_user')
    env.path = env.yaml.get('project').get('root_dir')
    env.virtualhost_path = env.path
    build(env.yaml)


@Permissions("normal_user", env)
@ConfChecker("httpd", env)
def install_httpd_vhost():
    """Install the vhost for your favorite httpd"""
    proj = env.yaml.get('project')
    with cd(proj.get('doc_root')):
        conf = env.yaml.get("httpd")
        fname = "%s/deploy/vhost-%s-%s" % (proj.get('doc_root'), env.type, env.project_name)
#        if not exists(env.path + "/logs"):
#            run("mkdir -p %s/logs/" % env.path)
        sed(fname, "DOCUMENT_ROOT", "%s" % env.path)
        sed(fname, "PROJECT_NAME", "%s" % proj.get('name'))
        copy_vhost()

@Permissions("sudo_user", env)
@ConfChecker("httpd", env)
def copy_vhost():
    proj = env.yaml.get('project')
    conf = env.yaml.get("httpd")
    fname = "%s/deploy/vhost-%s-%s" % (proj.get('doc_root'), env.type, env.project_name)
    sudo("cp %s %s/%s" % (fname, conf.get("av"), env.project_name))
    sudo("ln -sFf %s/%s %s" % (conf.get("av"), env.project_name, conf.get("en")))


@Permissions("normal_user", env)
@ConfChecker("django", env)
def django_settings():
    """Copies your django settings"""
    conf = env.yaml.get('django')
    with cd("%(doc_root)s" % conf):
        run("cp deploy/%s-settings.py %s/settings_local.py" % (env.type, conf.get('src_dir')))
        sed("%s/settings_local.py" % conf.get('src_dir'), "DOCUMENT_ROOT", "%s" % conf.get('src_dir'))



@Permissions("normal_user", env)
@ConfChecker("database", env)
def update_database():
    """Updates your database schema using south"""
    conf = env.yaml.get("database")
    # first backup the database
    mysql.backup_database(conf)
    return

    conf = env.yaml.get("database")
    django = env.yaml.get("django")
    venv = env.yaml.get("virtualenv")
    date = datetime.datetime.now()

    with cd(django.get("src_dir")):
        for app in django.get('apps'):
            venv["app"] = app
            run("%(bin_dir)s/python manage.py startmigration %(app)s automigration --auto" % venv)
            del venv["app"]

        run("%(bin_dir)s/python manage.py migrate --all" % venv)

        pass

    #first, create a local change in the database with south
    #apply the change


@Permissions("sudo_user", env)
@ConfChecker("services", env)
def services_reload():
    """Reloads your services"""
    services = env.yaml.get('services').get('reload')
    for service in services:
        sudo("/etc/init.d/%s reload" % service)
    print services

@Permissions("sudo_user", env)
@ConfChecker("services", env)
def services_restart():
    """Restarts your services"""
    services = env.yaml.get('services').get('restart')
    for service in services:
        sudo("/etc/init.d/%s restart" % service)

    

def update():
    """updates the code and everything else"""
    distro_install()

    update_hg()
    
    virtualenv()

    install_httpd_vhost()

    # install django configuration
    django_settings()

    update_database()
 

    # start/restart the wsgi/fcgi process
    wsgi_restart()

    # restart other services
    services_reload()
    services_restart()




def install():
    """for the first install onto the machines"""

    print env.httpd
    print env.db
    print env.vc
    
    env.vc.clone_repository()
    env.virtualenv.create_virtualenv()
    env.virtualenv.install_requirements(False)
    
    env.db.create_database()



#    # install required packages 
#    distro_install()
#
#    # update the hg repos
#    update_hg()
#    
#    # install or update the virtualenv
#    virtualenv()
#
#    # install the vhost required for the django application
#    install_httpd_vhost()
#
#
#    # install django configuration
#    django_settings()
#    
#    # install the database schema
#    install_database()
#
#    # start/restart the wsgi/fcgi process
#    wsgi_restart()
#
#    # restart other services
#    services_reload()
#    services_restart()

@Permissions("sudo_user", env)
def nginx_logs():
    sudo("sudo tail -f /var/log/nginx/*.log")

def reset():
    env.vc.remove_repository()


@Permissions("sudo_user", env)
@ConfChecker("distro", env)
def distro_install():
    """Installs required packages"""
    # install packages specified in the yaml conf
    dist_conf = env.yaml.get('distro')
    if dist_conf.get('name') in ('ubuntu', 'debian'):
        for package in dist_conf.get('packages'):
            sudo("apt-get install %s" % package)

@Permissions("sudo_user", env)
@ConfChecker("distro", env)
def delete_database():
    db = env.yaml.get('database')
    mysql.drop_database(db)

@Permissions("sudo_user", env)
@ConfChecker("distro", env)
def delete_repos():
    conf = env.yaml.get('project')
    run("rm -Rf %(doc_root)s" % conf)




@Permissions("normal_user", env)
@ConfChecker("database", env)
def install_database():
    """Install your database schema"""
    conf = env.yaml.get("database")
    django = env.yaml.get("django")
    venv = env.yaml.get("virtualenv")

    mysql.create_database(conf)
    if django.get('south'):
        south.install_south(env)

    with cd("%(src_dir)s" % django):
        if django.get('south'):
            run("%(bin_dir)s/python manage.py migrate --all" % venv)
        else:
            run("%(bin_dir)s/python manage.py syncdb --noinput" % venv)


@Permissions("normal_user", env)
@ConfChecker("wsgi", env)
def wsgi_restart():
    """Restarts the wsgi process"""
    conf = env.yaml.get("wsgi")
    django = env.yaml.get("django")
    if isinstance(conf.get('port'), list):
        for port in conf.get('port'):
            pidfile = "%s.%d" % (conf.get('pidfile'), port)
            if exists(pidfile):
                run("kill -0 `cat %s`" % pidfile)
                run("kill -HUP `head -1 %s`" % pidfile)
            else:
                with cd(django.get('src_dir')):
                    run("%s/gunicorn_django --workers=%d --bind=127.0.0.1:%d --pid=%s --log-file=%s -D" % \
                            (conf.get('path'), conf.get('workers'),
                             port, pidfile, conf.get('logfile')))