from fabric.api import cd
from fabric.api import env
from fabric.api import get
from fabric.api import local
from fabric.api import settings
from fabric.api import sudo
from fabric.contrib.console import confirm
from fabric.contrib.files import exists
from fabric.contrib.files import upload_template
from fabric.contrib.project import rsync_project
from niteoweb.fabfile import cmd
from niteoweb.fabfile import err
import os
[docs]def upload_nginx_config(shortname=None, nginx_conf=None):
"""Upload Nginx configuration to /etc/nginx/sites-available."""
opts = dict(
shortname=shortname or env.get('shortname'),
nginx_conf=nginx_conf or env.get('nginx_conf') or '%s/etc/nginx.conf' % os.getcwd(),
)
upload_template(
opts['nginx_conf'],
'/etc/nginx/sites-available/%(shortname)s.conf' % env,
use_sudo=True
)
[docs]def enable_nginx_config(shortname=None):
"""Make a link from sites-available/ to sites-enabled/ and reload Nginx."""
opts = dict(
shortname=shortname or env.get('shortname'),
)
sudo('ln -fs /etc/nginx/sites-available/%(shortname)s.conf '
'/etc/nginx/sites-enabled/%(shortname)s.conf' % opts)
sudo('service nginx reload')
[docs]def download_code(shortname=None, prod_user=None, svn_params=None, svn_url=None, svn_repo=None, svn_dir=None):
"""Pull project code from code repository."""
opts = dict(
shortname=shortname or env.get('shortname'),
prod_user=prod_user or env.get('prod_user'),
)
more_opts = dict(
svn_params=svn_params or env.get('svn_params') or '--force --no-auth-cache',
svn_url=svn_url or env.get('svn_url') or 'https://niteoweb.repositoryhosting.com/svn',
svn_repo=svn_repo or env.get('svn_repo') or 'niteoweb_%(shortname)s' % opts,
svn_dir=svn_dir or env.get('svn_dir') or 'niteoweb.%(shortname)s/trunk' % opts,
)
opts.update(more_opts)
with cd('/home/%(prod_user)s/niteoweb.%(shortname)s' % opts):
sudo(
'svn export %(svn_params)s %(svn_url)s/%(svn_repo)s/%(svn_dir)s ./' % opts,
user=opts['prod_user']
)
[docs]def prepare_buildout(prod_user=None, python_version=None, production_cfg=None):
"""Prepare zc.buildout environment so we can use
``bin/buildout -c production.cfg`` to build a production environment.
"""
opts = dict(
prod_user=prod_user or env.get('prod_user'),
python_version=python_version or env.get('python_version') or '2.6',
production_cfg=production_cfg or env.get('production_cfg') or 'production.cfg',
)
with cd('/home/%(prod_user)s/niteoweb.%(shortname)s' % opts):
sudo(
'virtualenv -p python%(python_version)s --no-site-packages ./' % opts,
user=opts['prod_user']
)
sudo('bin/python bootstrap.py -c %(production_cfg)s' % opts, user=opts['prod_user'])
[docs]def run_buildout(prod_user=None, production_cfg=None):
"""Run ``bin/buildout -c production.cfg`` in production user's home folder
on the production server.
"""
opts = dict(
prod_user=prod_user or env.get('prod_user'),
production_cfg=production_cfg or env.get('production_cfg') or 'production.cfg',
)
with cd('/home/%(prod_user)s/niteoweb.%(shortname)s' % opts):
sudo('bin/buildout -c %(production_cfg)s' % opts, user=opts['prod_user'])
# allow everyone in group `projects` to use what you have just put inside
# the egg cache
sudo('chown -R root:projects /etc/buildout/{eggs,downloads,extends}')
sudo('chmod -R 775 /etc/buildout/{eggs,downloads,extends}')
[docs]def upload_data(prod_user=None):
"""Upload Zope's data to the server."""
if not env.get('confirm'):
confirm("This will destroy all current Zope data on the server. " \
"Are you sure you want to continue?")
upload_zodb(prod_user)
upload_blobs(prod_user)
[docs]def upload_zodb(prod_user=None, path=None):
"""Upload ZODB part of Zope's data to the server."""
opts = dict(
prod_user=prod_user or env.get('prod_user'),
path=path or env.get('path') or os.getcwd()
)
# _verify_env(['prod_user', 'path', ])
if not env.get('confirm'):
confirm("This will destroy the current Data.fs file on the server. " \
"Are you sure you want to continue?")
with cd('/home/%(prod_user)s/niteoweb.%(shortname)s/var/filestorage' % opts):
# remove temporary BLOBs from previous uploads
if exists('/tmp/Data.fs'):
sudo('rm -rf /tmp/Data.fs')
# upload Data.fs to server and set production user as it's owner
upload_template(
filename='%(path)s/var/filestorage/Data.fs' % opts,
destination='Data.fs',
use_sudo=True
)
sudo('chown -R %(prod_user)s:%(prod_user)s Data.fs' % opts)
[docs]def upload_blobs(prod_user=None, path=None):
"""Upload BLOB part of Zope's data to the server."""
opts = dict(
prod_user=prod_user or env.get('prod_user'),
path=path or env.get('path') or os.getcwd()
)
if not env.get('confirm'):
confirm("This will destroy all current BLOB files on the server. " \
"Are you sure you want to continue?")
with cd('/home/%(prod_user)s/niteoweb.%(shortname)s/var' % opts):
# backup current BLOBs
if exists('blobstorage'):
sudo('mv blobstorage blobstorage.bak')
# remove temporary BLOBs from previous uploads
if exists('/tmp/blobstorage'):
sudo('rm -rf /tmp/blobstorage')
# upload BLOBs to the server and move them to their place
rsync_project('/tmp', local_dir='%(path)s/var/blobstorage' % opts)
sudo('mv /tmp/blobstorage ./')
sudo('chown -R %(prod_user)s:%(prod_user)s blobstorage' % opts)
sudo('chmod -R 700 blobstorage')
[docs]def start_supervisord(prod_user=None):
"""Start `supervisord` process monitor which in turn starts Zope and
optionally others (Varnish, HAProxy, etc.)."""
opts = dict(
prod_user=prod_user or env.get('prod_user'),
)
with cd('/home/%(prod_user)s/niteoweb.%(shortname)s' % opts):
sudo('bin/supervisord', user=opts['prod_user'])
[docs]def supervisorctl(*cmd):
"""Runs an arbitrary supervisorctl command."""
with cd('/home/%(prod_user)s/niteoweb.%(shortname)s' % env):
sudo('bin/supervisorctl ' + ' '.join(cmd), user=env.prod_user)
[docs]def download_data():
"""Download Zope's Data.fs from the server."""
if not env.get('confirm'):
confirm("This will destroy all current Zope data on your local machine. " \
"Are you sure you want to continue?")
with cd('/home/%(prod_user)s/niteoweb.%(shortname)s/var' % env):
### Downlaod Data.fs ###
# backup current Data.fs
if os.path.exists('filestorage/Data.fs'):
local('mv %(path)s/var/filestorage/Data.fs %(path)s/var/filestorage/Data.fs.bak' % env)
# remove temporary Data.fs file from previous downloads
if exists('/tmp/Data.fs', use_sudo=True):
sudo('rm -rf /tmp/Data.fs')
# downlaod Data.fs from server
sudo('rsync -a filestorage/Data.fs /tmp/Data.fs')
get('/tmp/Data.fs', '%(path)s/var/filestorage/Data.fs' % env)
### Download Blobs ###
# backup current Blobs
if os.path.exists('%(path)s/var/blobstorage' % env):
local('mv %(path)s/var/blobstorage %(path)s/var/blobstorage_bak' % env)
# remove temporary Blobs from previous downloads
if exists('/tmp/blobstorage', use_sudo=True):
sudo('rm -rf /tmp/blobstorage')
# download Blobs from server -> use maintenance user for transfer
sudo('rsync -a blobstorage /tmp/')
sudo('chown -R %(user)s /tmp/blobstorage' % env)
local('rsync -az %(user)s@%(server)s:/tmp/blobstorage %(path)s/var/' % env)
[docs]def upload_sphinx(hq_ip=None, sphinx_dir=None, path=None):
"""Uploads HTML files generated by Sphinx."""
opts = dict(
hq_ip=hq_ip or env.get('hq_ip') or err("env.hq_ip must be set"),
sphinx_dir=sphinx_dir or env.get('sphinx_dir') or 'niteoweb.%(shortname)s' % env,
path=path or env.get('path') or err('env.path must be set'),
)
with settings(host_string='%(hq_ip)s:22' % opts):
with settings(host=opts['hq_ip']): # additional needed for rsync_project
# backup existing docs
if exists('/var/www/sphinx/%(sphinx_dir)s' % opts):
sudo('mv /var/www/sphinx/%(sphinx_dir)s /var/www/sphinx/%(sphinx_dir)s.bak' % opts)
# upload new docs
rsync_project(
local_dir='%(path)s/docs/html/' % opts,
remote_dir='/tmp/%(sphinx_dir)s' % opts,
)
# move them into place
sudo('mv /tmp/%(sphinx_dir)s /var/www/sphinx/%(sphinx_dir)s' % env)