def git_init_submodules(git_path):
"""
Initialise and update git submodules
"""
check_on_path('git')
puts(info="Initialising git submodules")
with cd(git_path):
run('git submodule update --init')
puts(success="Submodules initialised")
def install_pip_dependencies(requirements_path):
"""
Install dependencies using pip from the specified requirements file
"""
puts(info='Installing dependencies with pip')
with prefix(activate_venv()):
run('pip install -r %s' % requirements_path)
puts(success="Dependencies installed")
def git_init_submodules(git_path):
"""
Initialise and update git submodules
"""
check_on_path('git')
puts(info="Initialising git submodules")
with cd(git_path):
run('git submodule update --init')
puts(success="Submodules initialised")
def install_pip_dependencies(requirements_path):
"""
Install dependencies using pip from the specified requirements file
"""
puts(info='Installing dependencies with pip')
with prefix(activate_venv()):
run('pip install -r %s' % requirements_path)
puts(success="Dependencies installed")
def django_publish_static_content(project_dir):
"""
Collects django's static content and publishes it to the static directory.
"""
puts(info="Collecting static content")
with prefix(activate_venv()):
run(os.path.join(project_dir, 'manage.py') +
' collectstatic --noinput --settings=settings_production')
puts(success="Static content published")
def django_publish_static_content(project_dir):
"""
Collects django's static content and publishes it to the static directory.
"""
puts(info="Collecting static content")
with prefix(activate_venv()):
run(
os.path.join(project_dir, 'manage.py') +
' collectstatic --noinput --settings=settings_production')
puts(success="Static content published")
def roll_site_forward(deployment_dir):
"""
Updates the symlinks to point to a later timestamped version of the
project.
"""
newest_deployment = run('ls -1 %s | grep 2 | tail -n 1' % deployment_dir)
# unlink previous deployment and link the newest one as 'live'
with cd(deployment_dir):
with settings(warn_only=True):
run('unlink live')
run('ln -s %s live' % (newest_deployment))
puts(success="Symlink rolled forward")
def roll_site_forward(deployment_dir):
"""
Updates the symlinks to point to a later timestamped version of the
project.
"""
newest_deployment = run('ls -1 %s | grep 2 | tail -n 1' % deployment_dir)
# unlink previous deployment and link the newest one as 'live'
with cd(deployment_dir):
with settings(warn_only=True):
run('unlink live')
run('ln -s %s live' % (newest_deployment))
puts(success="Symlink rolled forward")
def django_syncdb(project_dir, production=False):
"""
Sets up the database by running django's syncdb command
@param project_dir The directory containing manage.py
@param production Whether to use production settings
"""
puts(info="Running syncdb")
with prefix(activate_venv()):
if production == True:
run(os.path.join(project_dir, 'manage.py') + " syncdb "
"--settings=settings_production")
else:
run(os.path.join(project_dir, 'manage.py') + ' syncdb')
puts(success='Database synced')
def django_migrate_schema(project_dir, production=False):
"""
Migrates the database schema
@param project_dir The directory containing manage.py
@param production Whether to use production settings
"""
puts(info="Applying migrations")
with prefix(activate_venv()):
if production == True:
run(os.path.join(project_dir, 'manage.py') + " migrate --all "
"--settings=settings_production")
else:
run(os.path.join(project_dir, 'manage.py') + ' migrate --all')
puts(success="Migrations applied")
def prune_directory(directory, pattern, max_entries):
"""
Deletes all but the last `max_entries` number of directories (when
sorted in name order) that match `pattern` in `directory`
@param string directory Directory to prune inside
@param string pattern A pattern to pass to grep to restrict the list of
files/directories that will be pruned
@param int max_entries The maximum number of files/directories that
should be retained in `directory`
"""
with settings(warn_only=True):
puts(info="Pruning %s to contain no more than %d files that match %s" %
(directory, max_entries, pattern))
if run('ls -1r %s | grep %s | tail -n +%d | xargs rm -rf --preserve-root'
% (directory, pattern, max_entries)).succeeded:
puts(success="%s pruned" % directory)
def django_syncdb(project_dir, production=False):
"""
Sets up the database by running django's syncdb command
@param project_dir The directory containing manage.py
@param production Whether to use production settings
"""
puts(info="Running syncdb")
with prefix(activate_venv()):
if production == True:
run(
os.path.join(project_dir, 'manage.py') + " syncdb "
"--settings=settings_production")
else:
run(os.path.join(project_dir, 'manage.py') + ' syncdb')
puts(success='Database synced')
def django_migrate_schema(project_dir, production=False):
"""
Migrates the database schema
@param project_dir The directory containing manage.py
@param production Whether to use production settings
"""
puts(info="Applying migrations")
with prefix(activate_venv()):
if production == True:
run(
os.path.join(project_dir, 'manage.py') + " migrate --all "
"--settings=settings_production")
else:
run(os.path.join(project_dir, 'manage.py') + ' migrate --all')
puts(success="Migrations applied")
def prune_directory(directory, pattern, max_entries):
"""
Deletes all but the last `max_entries` number of directories (when
sorted in name order) that match `pattern` in `directory`
@param string directory Directory to prune inside
@param string pattern A pattern to pass to grep to restrict the list of
files/directories that will be pruned
@param int max_entries The maximum number of files/directories that
should be retained in `directory`
"""
with settings(warn_only=True):
puts(info="Pruning %s to contain no more than %d files that match %s" %
(directory, max_entries, pattern))
if run('ls -1r %s | grep %s | tail -n +%d | xargs rm -rf --preserve-root'
% (directory, pattern, max_entries)).succeeded:
puts(success="%s pruned" % directory)
def conditionally_install_and_patch_pil(requirements_file_path, venv_dir,
patch_path):
"""
PIL's setup.py file needs to be patched on centos to enable JPEG and
PNG support.
It will check whether PIL is in the requirements file and if so
install it and patch it outside of pip's automated system.
@param requirements_file_path Path to pip's requirements file
@param venv_dir Path to the virtualenv directory
@param patch_path Path to the patch file to apply
"""
if files.contains(requirements_file_path, 'PIL'):
puts(info="Installing PIL")
pil_version = run('grep PIL %s' % requirements_file_path)
with prefix(activate_venv()):
run('pip install -I %s --no-install' % pil_version)
# patch setup.py
run('patch --unified %s %s' % (os.path.join(venv_dir,
'build', 'PIL', 'setup.py'), patch_path))
run('pip install -I %s --no-download' % pil_version)
puts(success="PIL patched and installed")
else:
puts(info="PIL doesn't need to be installed")
def conditionally_install_and_patch_pil(requirements_file_path, venv_dir,
patch_path):
"""
PIL's setup.py file needs to be patched on centos to enable JPEG and
PNG support.
It will check whether PIL is in the requirements file and if so
install it and patch it outside of pip's automated system.
@param requirements_file_path Path to pip's requirements file
@param venv_dir Path to the virtualenv directory
@param patch_path Path to the patch file to apply
"""
if files.contains(requirements_file_path, 'PIL'):
puts(info="Installing PIL")
pil_version = run('grep PIL %s' % requirements_file_path)
with prefix(activate_venv()):
run('pip install -I %s --no-install' % pil_version)
# patch setup.py
run('patch --unified %s %s' % (os.path.join(
venv_dir, 'build', 'PIL', 'setup.py'), patch_path))
run('pip install -I %s --no-download' % pil_version)
puts(success="PIL patched and installed")
else:
puts(info="PIL doesn't need to be installed")
def git_clone(repo_path, destination, user):
"""
Clone the git repository at repo_path to destination.
If destination doesn't exist, it will be created and owned by user.
"""
check_on_path('git')
puts(info="Cloning git repository %s into %s" % (repo_path, destination))
with settings(warn_only=True):
if run("test -d %s" % destination).failed:
puts(info="Creating destination directory %s" % destination)
create_directories(destination, user)
puts(success="Destination directory created")
run('git clone %s %s' % (repo_path, destination))
puts(success="Repository cloned")
def git_clone(repo_path, destination, user):
"""
Clone the git repository at repo_path to destination.
If destination doesn't exist, it will be created and owned by user.
"""
check_on_path('git')
puts(info="Cloning git repository %s into %s" % (repo_path, destination))
with settings(warn_only=True):
if run("test -d %s" % destination).failed:
puts(info="Creating destination directory %s" % destination)
create_directories(destination, user)
puts(success="Destination directory created")
run('git clone %s %s' % (repo_path, destination))
puts(success="Repository cloned")
def create_virtualenv(venv_path, user, permissions='0750'):
"Creates a virtualenv"
check_on_path('virtualenv')
if not files.exists(os.path.join(venv_path, "bin/activate")):
create_directories(venv_path, user, permissions)
puts(info='Creating virtualenv at %s' % venv_path)
run("virtualenv --no-site-packages %s" % venv_path)
puts(success='virtualenv created')
return 1
else:
puts(info='virtualenv already exists at %s' % venv_path)
def compile_less_css(project_dir):
"""
Compiles less files to css
"""
puts(info="Compiling LESS to css")
if files.exists(os.path.join(project_dir, "plessc.py")):
with cd(project_dir):
with prefix(activate_venv()):
run('./plessc.py')
puts(success="Stylesheets compiled")
else:
puts(info="plessc.py not found - skipping")
def compile_less_css(project_dir):
"""
Compiles less files to css
"""
puts(info="Compiling LESS to css")
if files.exists(os.path.join(project_dir, "plessc.py")):
with cd(project_dir):
with prefix(activate_venv()):
run('./plessc.py')
puts(success="Stylesheets compiled")
else:
puts(info="plessc.py not found - skipping")
def create_virtualenv(venv_path, user, permissions='0750'):
"Creates a virtualenv"
check_on_path('virtualenv')
if not files.exists(os.path.join(venv_path, "bin/activate")):
create_directories(venv_path, user, permissions)
puts(info='Creating virtualenv at %s' % venv_path)
run("virtualenv --no-site-packages %s" % venv_path)
puts(success='virtualenv created')
return 1
else:
puts(info='virtualenv already exists at %s' % venv_path)
def git_pull(destination):
"""
Update the git repository at destination.
"""
check_on_path('git')
puts(info="Updating git repository in %s" % destination)
if run("test -d %s" % destination).succeeded:
with cd(destination):
run('git pull')
puts(success="Repository updated")
else:
puts(error="Unable to pull - destination directory doesn't exist")
abort("Aborting")
def git_pull(destination):
"""
Update the git repository at destination.
"""
check_on_path('git')
puts(info="Updating git repository in %s" % destination)
if run("test -d %s" % destination).succeeded:
with cd(destination):
run('git pull')
puts(success="Repository updated")
else:
puts(error="Unable to pull - destination directory doesn't exist")
abort("Aborting")
def django_load_fixture(project_dir, path):
"""
Load fixtures from a specific location
@param project_dir The directory containing manage.py
@param production The path to the fixture file to load
"""
puts(info="Loading fixture at %s" % path)
full_path = os.path.join(project_dir, path)
if not files.exists(full_path):
puts(error='Fixture file %s not found' % full_path)
with prefix(activate_venv()):
run(os.path.join(project_dir, 'manage.py') + " loaddata " + full_path)
puts(success='Fixture loaded')
def django_load_fixture(project_dir, path):
"""
Load fixtures from a specific location
@param project_dir The directory containing manage.py
@param production The path to the fixture file to load
"""
puts(info="Loading fixture at %s" % path)
full_path = os.path.join(project_dir, path)
if not files.exists(full_path):
puts(error='Fixture file %s not found' % full_path)
with prefix(activate_venv()):
run(os.path.join(project_dir, 'manage.py') + " loaddata "
+ full_path)
puts(success='Fixture loaded')
def pull():
""" Pull from master
"""
if not fabutils.check_virtualenv():
if not confirm(
'It seems you are running outside a virtualenv. '
'Would you like to proceed anyway?'):
fabutils.error('Ok, aborting.')
sys.exit(1)
puts('')
# pull
fabutils.try_local(
'git pull origin master', 'Pulling from origin',
'Unable to pull, aborting.', abort=True)
puts('')
fabutils.try_local(
'git pull heroku master', 'Pulling from heroku',
'Unable to pull, aborting.', abort=True)
puts('')
uninstalled_programs = []
# check if kyoto-cabinet is installed
fabutils.check_program_exists(
'kyoto-cabinet', 'kchashmgr --version', result=uninstalled_programs)
# print uninstalled programs
if uninstalled_programs:
uninstalled_programs = ', '.join(uninstalled_programs)
puts('Aborting... It seems you don\'t have some '
'required programs: {}'.format(uninstalled_programs))
sys.exit(1)
puts('')
# install requirements
fabutils.try_local(
'pip install -r requirements.txt',
'Installing requirements',
'An error occurred when running requirements.', abort=True)
puts('')
# run migrations
fabutils.try_local(
'python manage.py migrate',
'Running migrations',
'Unable to run migrations.', abort=True)
puts('')
# fetch tags
fabutils.try_local(
'git fetch --tags',
'Fetching tags',
'Unable to fetch tags. Proceeding anyway...', capture=True)
fabutils.puts('Current version: {}'.format(colors.green(_get_version())))
def backup_database(project_name, project_dir, destination_dir):
"""
Backs-up the database
"""
dump_file = "%s-prod-%s.sql" % (project_name,
datetime.now().strftime('%Y%m%d_%H%M%S'))
temp_dump_path = os.path.join('/tmp', dump_file)
puts(info="Backing up database")
with prefix(activate_venv()):
with cd(project_dir):
DATABASE_USER = run("python -c 'import settings_production;"
"print settings_production.DATABASES[\"default\"][\"USER\"]'")
DATABASE_PASSWORD = run("python -c 'import settings_production;"
"print settings_production.DATABASES[\"default\"][\"PASSWORD\"]'")
DATABASE_NAME = run("python -c 'import settings_production;"
"print settings_production.DATABASES[\"default\"][\"NAME\"]'")
run('unset HISTFILE && mysqldump -u %s -p%s %s > %s' % (
DATABASE_USER, DATABASE_PASSWORD, DATABASE_NAME, temp_dump_path))
puts(success="Database backed up to %s" % temp_dump_path)
puts(info="Compressing database backup")
run('bzip2 %s' % temp_dump_path)
temp_dump_path += '.bz2'
puts(success="Database backup compressed")
puts(info="Moving backup to %s" % destination_dir)
with settings(warn_only=True):
if sudo("test -d %s" % destination_dir).failed:
puts(info="Creating destination directory %s" % destination_dir)
create_directories(destination_dir, 'root')
puts(success="Destination directory created")
sudo('mv %s %s' % (temp_dump_path, destination_dir))
puts(success="Database moved to %s" % destination_dir)
def backup_database(project_name, project_dir, destination_dir):
"""
Backs-up the database
"""
dump_file = "%s-prod-%s.sql" % (project_name,
datetime.now().strftime('%Y%m%d_%H%M%S'))
temp_dump_path = os.path.join('/tmp', dump_file)
puts(info="Backing up database")
with prefix(activate_venv()):
with cd(project_dir):
DATABASE_USER = run(
"python -c 'import settings_production;"
"print settings_production.DATABASES[\"default\"][\"USER\"]'")
DATABASE_PASSWORD = run(
"python -c 'import settings_production;"
"print settings_production.DATABASES[\"default\"][\"PASSWORD\"]'"
)
DATABASE_NAME = run(
"python -c 'import settings_production;"
"print settings_production.DATABASES[\"default\"][\"NAME\"]'")
run('unset HISTFILE && mysqldump -u %s -p%s %s > %s' %
(DATABASE_USER, DATABASE_PASSWORD, DATABASE_NAME, temp_dump_path))
puts(success="Database backed up to %s" % temp_dump_path)
puts(info="Compressing database backup")
run('bzip2 %s' % temp_dump_path)
temp_dump_path += '.bz2'
puts(success="Database backup compressed")
puts(info="Moving backup to %s" % destination_dir)
with settings(warn_only=True):
if sudo("test -d %s" % destination_dir).failed:
puts(info="Creating destination directory %s" % destination_dir)
create_directories(destination_dir, 'root')
puts(success="Destination directory created")
sudo('mv %s %s' % (temp_dump_path, destination_dir))
puts(success="Database moved to %s" % destination_dir)
