quinode / fabtools

Tools for writing awesome Fabric files

Introduction

fabtools includes useful functions to help you write your Fabric files.

fabtools makes it easier to manage system users, packages, databases, etc.

fabtools includes a number of low-level actions, as well as a higher level interface called icanhaz.

Using icanhaz allows you to use a more declarative style, similar to Chef or Puppet.

Example

Here is an example fabfile using fabtools.

from fabric.api import *
from fabtools import icanhaz
import fabtools

@task
def setup():

    # Ensure those Debian/Ubuntu packages are installed
    icanhaz.deb.packages([
        'build-essential',
        'python-dev',
        'supervisor',
    ])

    # Ensure those Python packages are installed
    icanhaz.python.package('virtualenv')

    # Ensure we have an email server
    icanhaz.postfix.server('example.com')

    # Ensure we have a PostgreSQL server
    icanhaz.postgres.server()
    icanhaz.postgres.user('myuser', 's3cr3tp4ssw0rd)
    icanhaz.postgres.database('myappsdb', 'myuser')

    # Ensure we have a supervisor process for our app
    icanhaz.supervisor.process('myapp', {
        'command': '/home/myuser/env/bin/gunicorn_paster',
        'config': '/home/myuser/env/myapp/production.ini',
        'directory': '/home/myuser/env/myapp',
        'user': 'myuser',
    })

    # Ensure we have an nginx server proxying to our app
    icanhaz.nginx.server()
    icanhaz.nginx.site('example.com', {
        'aliases': 'www.example.com www2.example.com',
        'docroot': '/home/myuser/env/myapp/myapp/public',
        'proxy_url': 'http://127.0.0.1:8888',
    })

    # Ensure we have a cron task running daily
    fabtools.cron.add_daily('maintenance', 'myuser', 'my_script.py')

Tests

The tests use Vagrant to launch a virtual machine, against which all the tests will be run.

Launch the tests using the nose test runner:

$ nosetests