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