fabfile.py

   1 import os
   2 from fabric.api import env
   3 from fabric.context_managers import cd, settings, hide, lcd
   4 from fabric.contrib.files import exists
   5 from fabric.operations import local, require, prompt
   6
   7 # Required dependencies
   8 #
   9 #    PIP_INSTALL - install packages from pip:  name:version
  10 #
  11 #    GIT_INSTALL - install packages from git:
  12 #
  13 #                    url - git url for checkouts
  14 #                    development - head to checkout for dev.  Defaults to master
  15 #                    production - head to checkout for prod.  defaults to master.
  16 #                    symlink - directory to symlink into project.  uses project
  17 #                              name if blank
  18 # Packages from git are given preference for dev environment. PIP is given
  19 # preference for production environments
  20
  21 PIP_INSTALL = {
  22     'django'                    :'>=1.2',
  23     'django-registration'       :'',
  24     'south'                     :'',
  25     'django-haystack'           :'==1.2.1',
  26     'whoosh'                    :'>=1.8.1',
  27     'django_object_permissions' :'=1.3.1',
  28     'twisted'                   :'>=11.0.0'
  29 }
  30
  31 GIT_INSTALL =  {
  32     'noVNC':{
  33         'url':'git://github.com/kanaka/noVNC.git',
  34         'development':'3859e1d35cf',
  35         'production':'3859e1d35cf',
  36         },
  37     'django_object_permissions':{
  38         'url':'git://git.osuosl.org/gitolite/django/django_object_permissions',
  39         'development':'develop',
  40         'symlink':'object_permissions',
  41         },
  42     'django_object_log':{
  43         'url':'git://git.osuosl.org/gitolite/django/django_object_log',
  44         'development':'develop',
  45         'symlink':'object_log'
  46         },
  47     'django_muddle_users':{
  48         'url':'git://git.osuosl.org/gitolite/django/django_muddle_users',
  49         'development':'develop',
  50         'symlink':'muddle_users'
  51     }
  52 }
  53
  54
  55 # default environment settings - override these in environment methods if you
  56 # wish to have an environment that functions differently
  57 env.doc_root = '.'
  58 env.remote = False
  59
  60
  61 def dev():
  62     """ configure development deployment """
  63     env.environment = 'development'
  64
  65
  66 def prod():
  67     """ configure a production deployment """
  68     env.environment = 'production'
  69
  70
  71 # Files and directories that will be included in tarball when packaged
  72 env.MANIFEST = [
  73     "django_test_tools",
  74     "deprecated",
  75     "ganeti_web",
  76     "i18n",
  77     "locale",
  78     "media",
  79     "templates",
  80     "twisted",
  81     "util",
  82     "__init__.py",
  83     "AUTHORS",
  84     "CHANGELOG",
  85     "COPYING",
  86     "fabfile.py",
  87     "LICENSE",
  88     "manage.py",
  89     "README",
  90     "search_sites.py",
  91     "settings.py.dist",
  92     "UPGRADING",
  93     "urls.py"
  94 ]
  95
  96
  97 def deploy():
  98     """
  99     Install all dependencies from git and pip
 100     """
 101     install_dependencies_pip()
 102     install_dependencies_git()
 103
 104
 105 def _exists(path):
 106     """
 107     helper to see if a path exists.  uses either os.exists or exists depending
 108     on if the environment is remote or local
 109     """
 110     if env.remote:
 111         return exists(path)
 112     else:
 113         return os.path.exists(path)
 114
 115
 116 def create_virtualenv(virtualenv=None, force=False):
 117     """ create a virtualenv for pip installs """
 118     require('environment', provided_by=[dev, prod])
 119     env.virtualenv = virtualenv if virtualenv else env.doc_root
 120
 121     with lcd(env.doc_root):
 122         if not force and _exists('%(virtualenv)s/lib' % env):
 123             print 'virtualenv already created'
 124         else:
 125             local('virtualenv %(virtualenv)s' % env)
 126
 127
 128 def create_env():
 129     """
 130     setup environment for git dependencies
 131     """
 132     require('environment', provided_by=[dev, prod])
 133
 134     with lcd(env.doc_root):
 135         if _exists('dependencies'):
 136             print 'dependencies directory exists already'
 137         else:
 138             local('mkdir dependencies')
 139
 140
 141 def install_dependencies_pip():
 142     """
 143     Install all dependencies available from pip
 144     """
 145     require('environment', provided_by=[dev, prod])
 146     create_virtualenv()
 147
 148     # if this is a development install then filter out anything we have a
 149     # git repo for.
 150     pips_ = PIP_INSTALL.copy()
 151     if env.environment == 'development':
 152         map(pips_.pop, [k for k in GIT_INSTALL if k in PIP_INSTALL])
 153
 154     if not pips_:
 155         print 'No git repos to install'
 156         return
 157
 158     with lcd(env.doc_root):
 159         #XXX create temp requirements file text from list of requirements
 160         #    it will be destroyed after install is complete
 161         requirements = '\n'.join([''.join(p) for p in pips_.items()])
 162         with settings(hide('running')):
 163             local("echo '%s' > requirements.txt" % requirements)
 164
 165         local('pip install -E %(virtualenv)s -r requirements.txt' % env)
 166         local('rm requirements.txt')
 167
 168
 169 def install_dependencies_git():
 170     """ Install all dependencies available from git """
 171     require('environment', provided_by=[dev, prod])
 172
 173     # if this is a production install then install everything that pip that
 174     # can be installed
 175     gits_ = GIT_INSTALL.copy()
 176     if env.environment != 'development':
 177         map(gits_.pop, (k for k in PIP_INSTALL if k in GIT_INSTALL))
 178
 179     if not gits_:
 180         print 'No git repos to install'
 181         return
 182
 183     create_env()
 184
 185     for name, opts in GIT_INSTALL.items():
 186
 187         # check for required values
 188         if 'url' not in opts:
 189             raise Exception('missing required argument "url" for git repo: %s' % name)
 190
 191         # set git head to check out
 192         if env.environment in opts:
 193             opts['head'] = opts[env.environment]
 194         elif env.environment == 'dev' and 'production' in opts:
 195             opts['head'] = opts['production']
 196         else:
 197             opts['head'] = 'master'
 198
 199         # clone repo
 200         with lcd('%(doc_root)s/dependencies' % env):
 201             env.git_repo = name
 202             if not _exists('%(doc_root)s/dependencies/%(git_repo)s' % env):
 203                 local('git clone %(url)s' % opts)
 204
 205             # create branch if not using master
 206             if opts['head'] != 'master':
 207                 with lcd(name):
 208                     local('git fetch')
 209                     local('git checkout %(head)s' % opts)
 210                     with settings(hide('warnings','stderr'), warn_only=True):
 211                             local('git pull')
 212
 213         # configure and create symlink to git repo
 214         with lcd (env.doc_root):
 215             if 'symlink' in opts:
 216                 env.symlink = opts['symlink']
 217                 env.symlink_path = '%(doc_root)s/dependencies/%(git_repo)s/%(symlink)s' % env
 218             else:
 219                 env.symlink = name
 220                 env.symlink_path = '%(doc_root)s/dependencies/%(git_repo)s' % env
 221
 222             with settings(hide('warnings','stderr'), warn_only=True):
 223                 local('ln -sf %(symlink_path)s %(doc_root)s' % env)
 224
 225
 226 def tarball():
 227     """ package a release tarball """
 228     tarball = prompt('tarball name', default='ganeti-webmgr-tar.gz')
 229     files = ['ganeti_webmgr/%s' % file for file in env.MANIFEST]
 230     files = ' '.join(files)
 231
 232     with lcd('..'):
 233         data = dict(
 234             tarball=tarball,
 235             files=files
 236         )
 237         local('tar cfz %(tarball)s %(files)s --exclude=*.pyc' % data)
 238         local('mv %(tarball)s ./ganeti_webmgr/' % data)