Merge lp:~danilo/linaro-license-protection/django-refactor-deployment into lp:~linaro-automation/linaro-license-protection/trunk

[Данило Шеган]

Add deployment script.

Split out from https://code.launchpad.net/~linaro-infrastructure/linaro-license-protection/merge-django-into-trunk/+merge/114203

[lp:~danilo/linaro-license-protection/django-refactor-deployment]

91. By Данило Шеган on 2012-07-11

Merge latest django-refactor.

[Данило Шеган (danilo)]

I'd rather see apache conf integrated into the documentation, and everything deployed in a standard django-manner.

review: Disapprove

Unmerged revisions

91. By Данило Шеган on 2012-07-11

Merge latest django-refactor.

90. By Данило Шеган on 2012-07-11

Re-add deployment scripts.

=== added file 'deploy.py'
--- deploy.py	1970-01-01 00:00:00 +0000
+++ deploy.py	2012-07-11 12:58:19 +0000
@@ -0,0 +1,147 @@
+#!/usr/bin/python
+import os
+import re
+from subprocess import check_call, call
+import sys
+
+# This script takes care of downloading the linaro-license-protection code and
+# installing it onto a server using the configuration dictionary below for
+# commonly changed settings.
+
+config = {
+    # Where to check the django app out to
+    "django_root": "/home/dooferlad/linaro-license-protection",
+
+    # Used in apache configuration...
+    "virtual_host_ip_address_and_port": "_default_",
+    "server_admin_email_address": "[e-mail]",
+
+    # Base path that will get searched for files to serve
+    # In theory there can be more than one XSendFilePath in an apache
+    # config and mod_xsendfile will search all of them. This isn't something
+    # that has been tested, but in theory will work and should allow serving
+    # files from an expanding number of mount points as disk space requirements
+    # grow.
+    "x_send_file_path": "/home/dooferlad/linaro-license-protection/android",
+
+    # Apache config file name
+    "apache2_site_config":
+        "/etc/apache2/sites-available/linaro-license-protection",
+
+    # Postgresql database name
+    "database_name": "linaro-license-protection-2",
+}
+
+# Derived variables
+config["deploy_root"] = os.path.dirname(config["django_root"])
+config["django_directory_name"] = os.path.basename(config["django_root"])
+config["a2_site_name"] = os.path.basename(config["apache2_site_config"])
+
+def main():
+    print "Installing Bazaar"
+    run("sudo apt-get -y install bzr")
+
+    print "Fetching linaro-license-protection code from bzr"
+    if os.path.isdir(config["django_root"]):
+        os.chdir(config["django_root"])
+        run("bzr update")
+    else:
+        run("bzr branch lp:~linaro-infrastructure/linaro-license-protection/"
+            "merge-django-into-trunk " + config["django_root"])
+
+    print "Installing python modules"
+    run("sudo apt-get -y install python-django python-django-openid-auth"
+        " python-mock python-psycopg2 testrepository")
+
+    print "Running unit tests (sqlite database)"
+    os.chdir(config["django_root"])
+    run("python manage.py test")
+
+    print "Installing required apache modules"
+    run("sudo apt-get -y install apache2 libapache2-mod-xsendfile"
+        " libapache2-mod-wsgi")
+
+    print "Installing database"
+    run("sudo apt-get -y install postgresql")
+    run_allow_fail("sudo -u postgres createuser -dSR linaro")
+    run_allow_fail("sudo -u postgres createdb " + config["database_name"])
+
+    print "Creating configuration files..."
+    generated_apache_config = os.path.join(
+        config["django_root"], "deployment_templates",
+        "linaro-license-protection.apache2.conf.gen")
+
+    create_config_file(os.path.join(
+        config["django_root"], "deployment_templates",
+        "linaro-license-protection.apache2.conf"),
+        generated_apache_config)
+
+    run("sudo mv " + generated_apache_config + " " +
+        config["apache2_site_config"])
+
+    create_config_file(os.path.join(config["django_root"],
+                                    "deployment_templates",
+                                    "wsgi.py"),
+                       os.path.join(config["django_root"],
+                                    "license_protected_downloads",
+                                    "wsgi.py"))
+
+    create_config_file(os.path.join(config["django_root"],
+                                    "deployment_templates",
+                                    "settings.py"),
+                       os.path.join(config["django_root"],
+                                    "settings.py"))
+
+    print "Deploying files to static root for serving"
+    run("python manage.py collectstatic --noinput")
+
+    print "Reloading Apache"
+    run("sudo service apache2 reload")
+
+    print "Set up database"
+    os.chdir(config["django_root"])
+    run("python manage.py syncdb --noinput")
+
+    print "Running unit tests (django database)"
+    os.chdir(config["django_root"])
+    run("python manage.py test")
+
+    print "Enabling new site"
+    run("sudo a2ensite " + config["a2_site_name"])
+    run("sudo service apache2 reload")
+
+    # Note, we don't run these because they have hard links to sites in.
+    # May be useful during a production deployment though...
+    if False:
+        print "Running deployment tests"
+        os.chdir(config["django_root"])
+        run("testr run testplans.test_suite")
+
+def run(cmd):
+    print "-" * 80
+    print cmd
+    check_call(cmd, shell=True)
+
+def run_allow_fail(cmd):
+    print "-" * 80
+    print cmd
+    call(cmd, shell=True)
+
+def template_lookup(match):
+    if match.group(1) in config:
+        return config[match.group(1)]
+    else:
+        print >> sys.stderr, ("Template used undefined variable %s" %
+                              match.group(1))
+        exit(1)
+
+def create_config_file(in_file_name, out_file_name):
+    print "Processing %s to create %s" % (in_file_name, out_file_name)
+    with open(in_file_name) as in_file:
+        with open(out_file_name, "w") as out_file:
+            for line in in_file:
+                line = re.sub(r"\{% (\w+) %\}", template_lookup, line)
+                out_file.write(line)
+
+if __name__ == "__main__":
+    main()

=== added directory 'deployment_templates'
=== added file 'deployment_templates/linaro-license-protection.apache2.conf'
--- deployment_templates/linaro-license-protection.apache2.conf	1970-01-01 00:00:00 +0000
+++ deployment_templates/linaro-license-protection.apache2.conf	2012-07-11 12:58:19 +0000
@@ -0,0 +1,41 @@
+NameVirtualHost {% virtual_host_ip_address_and_port %}
+
+<VirtualHost {% virtual_host_ip_address_and_port %}>
+    Alias /static/ {% django_root %}/static/
+
+    <Directory {% django_root %}/static>
+    Order deny,allow
+    Allow from all
+    </Directory>
+
+	ServerAdmin {% server_admin_email_address %}
+
+	XSendFile on
+    XSendFilePath {% x_send_file_path %}
+
+    WSGIScriptAlias / {% django_root %}/license_protected_downloads/wsgi.py
+    WSGIDaemonProcess linaro-license-protection
+
+    <Directory {% django_root %}/license_protected_downloads>
+        <Files wsgi.py>
+            Order deny,allow
+            Allow from all
+        </Files>
+    </Directory>
+
+    <Directory />
+            Options FollowSymLinks
+            AllowOverride None
+        </Directory>
+    <Directory />
+        Options FollowSymLinks
+        AllowOverride None
+    </Directory>
+    <Directory /var/www/>
+        Options Indexes FollowSymLinks MultiViews
+        AllowOverride None
+        Order allow,deny
+        allow from all
+    </Directory>
+
+</VirtualHost>

=== added file 'deployment_templates/settings.py'
--- deployment_templates/settings.py	1970-01-01 00:00:00 +0000
+++ deployment_templates/settings.py	2012-07-11 12:58:19 +0000
@@ -0,0 +1,167 @@
+# Django settings for linaro_license_protection_2 project.
+
+import os
+
+DEBUG = False
+
+PROJECT_ROOT = os.path.dirname(os.path.abspath(__file__))
+ROOT_DIR = os.path.split(PROJECT_ROOT)[-1]
+
+ADMINS = (
+    ('Linaro Infrastructure', '[e-mail]'),
+)
+
+MANAGERS = ADMINS
+
+DATABASES = {
+    'default': {
+        'ENGINE': 'django.db.backends.postgresql_psycopg2', # Add 'postgresql_psycopg2', 'postgresql', 'mysql', 'sqlite3' or 'oracle'.
+        'NAME': '{% database_name %}',              # Or path to database file if using sqlite3.
+        'USER': 'linaro',                      # Not used with sqlite3.
+        'PASSWORD': '',                  # Not used with sqlite3.
+        'HOST': '',                      # Set to empty string for localhost. Not used with sqlite3.
+        'PORT': '',                      # Set to empty string for default. Not used with sqlite3.
+    }
+}
+
+# Local time zone for this installation. Choices can be found here:
+# http://en.wikipedia.org/wiki/List_of_tz_zones_by_name
+# although not all choices may be available on all operating systems.
+# On Unix systems, a value of None will cause Django to use the same
+# timezone as the operating system.
+# If running in a Windows environment this must be set to the same as your
+# system time zone.
+TIME_ZONE = 'America/Chicago'
+
+# Language code for this installation. All choices can be found here:
+# http://www.i18nguy.com/unicode/language-identifiers.html
+LANGUAGE_CODE = 'en-us'
+
+SITE_ID = 1
+
+# If you set this to False, Django will make some optimizations so as not
+# to load the internationalization machinery.
+USE_I18N = True
+
+# If you set this to False, Django will not format dates, numbers and
+# calendars according to the current locale
+USE_L10N = True
+
+# Absolute filesystem path to the directory that will hold user-uploaded files.
+# Example: "/home/media/media.lawrence.com/media/"
+MEDIA_ROOT = ''
+
+# URL that handles the media served from MEDIA_ROOT. Make sure to use a
+# trailing slash.
+# Examples: "http://media.lawrence.com/media/", "http://example.com/media/"
+MEDIA_URL = ''
+
+# Absolute path to the directory static files should be collected to.
+# Don't put anything in this directory yourself; store your static files
+# in apps' "static/" subdirectories and in STATICFILES_DIRS.
+# Example: "/home/media/media.lawrence.com/static/"
+STATIC_ROOT = os.path.join(PROJECT_ROOT, "static")
+
+# URL prefix for static files.
+# Example: "http://media.lawrence.com/static/"
+STATIC_URL = '/static/'
+
+# URL prefix for admin static files -- CSS, JavaScript and images.
+# Make sure to use a trailing slash.
+# Examples: "http://foo.com/static/admin/", "/static/admin/".
+ADMIN_MEDIA_PREFIX = '/static/admin/'
+
+# Additional locations of static files
+STATICFILES_DIRS = (
+    # Put strings here, like "/home/html/static" or "C:/www/django/static".
+    # Always use forward slashes, even on Windows.
+    # Don't forget to use absolute paths, not relative paths.
+)
+
+# List of finder classes that know how to find static files in
+# various locations.
+STATICFILES_FINDERS = (
+    'django.contrib.staticfiles.finders.FileSystemFinder',
+    'django.contrib.staticfiles.finders.AppDirectoriesFinder',
+#    'django.contrib.staticfiles.finders.DefaultStorageFinder',
+)
+
+# Make this unique, and don't share it with anybody.
+SECRET_KEY = 'lkye^=q_i(#jies7^cz#anqq(1g0k$luy5^1jr2nk=g#inet(n'
+
+# List of callables that know how to import templates from various sources.
+TEMPLATE_LOADERS = (
+    'django.template.loaders.filesystem.Loader',
+    'django.template.loaders.app_directories.Loader',
+#     'django.template.loaders.eggs.Loader',
+)
+
+MIDDLEWARE_CLASSES = (
+    'django.middleware.common.CommonMiddleware',
+    'django.contrib.sessions.middleware.SessionMiddleware',
+    'django.middleware.csrf.CsrfViewMiddleware',
+    'django.contrib.auth.middleware.AuthenticationMiddleware',
+    'django.contrib.messages.middleware.MessageMiddleware',
+)
+
+ROOT_URLCONF = ROOT_DIR + '.urls'
+
+TEMPLATE_DIRS = (os.path.join(PROJECT_ROOT, "templates" ),)
+
+INSTALLED_APPS = (
+    'django.contrib.auth',
+    'django.contrib.contenttypes',
+    'django.contrib.sessions',
+    'django.contrib.sites',
+    'django.contrib.messages',
+    'django.contrib.staticfiles',
+    # Uncomment the next line to enable the admin:
+    'django.contrib.admin',
+    'django_openid_auth',
+    # Uncomment the next line to enable admin documentation:
+    # 'django.contrib.admindocs',
+    ROOT_DIR + '.license_protected_downloads',
+)
+
+AUTHENTICATION_BACKENDS = (
+    'django_openid_auth.auth.OpenIDBackend',
+    'django.contrib.auth.backends.ModelBackend',
+)
+
+LOGIN_URL = '/openid/login/'
+
+OPENID_CREATE_USERS = True
+OPENID_SSO_SERVER_URL = 'https://login.launchpad.net/'
+OPENID_LAUNCHPAD_TEAMS_MAPPING = {
+    'linaro': 'linaro',
+}
+
+# A sample logging configuration. The only tangible logging
+# performed by this configuration is to send an email to
+# the site admins on every HTTP 500 error.
+# See http://docs.djangoproject.com/en/dev/topics/logging for
+# more details on how to customize your logging configuration.
+LOGGING = {
+    'version': 1,
+    'disable_existing_loggers': False,
+    'handlers': {
+        'mail_admins': {
+            'level': 'ERROR',
+            'class': 'django.utils.log.AdminEmailHandler'
+        }
+    },
+    'loggers': {
+        'django.request': {
+            'handlers': ['mail_admins'],
+            'level': 'ERROR',
+            'propagate': True,
+        },
+    }
+}
+
+SERVED_PATHS = ["{% x_send_file_path %}"]
+
+TEMPLATE_CONTEXT_PROCESSORS = (
+    'django.contrib.messages.context_processors.messages',
+    'django.contrib.auth.context_processors.auth',
+)

=== added file 'deployment_templates/wsgi.py'
--- deployment_templates/wsgi.py	1970-01-01 00:00:00 +0000
+++ deployment_templates/wsgi.py	2012-07-11 12:58:19 +0000
@@ -0,0 +1,36 @@
+"""
+WSGI config for license_protected_downloads project.
+
+This module contains the WSGI application used by Django's development server
+and any production WSGI deployments. It should expose a module-level variable
+named ``application``. Django's ``runserver`` and ``runfcgi`` commands discover
+this application via the ``WSGI_APPLICATION`` setting.
+
+Usually you will have the standard Django WSGI application here, but it also
+might make sense to replace the whole Django WSGI application with a custom one
+that later delegates to the Django one. For example, you could introduce WSGI
+middleware here, or combine a Django application with an application of another
+framework.
+
+"""
+import os, sys
+sys.path.append("/usr/lib/python2.7/dist-packages")
+sys.path.append("/usr/lib/pymodules/python2.7")
+sys.path.append("/usr/lib/python2.7")
+sys.path.append("{% django_root %}")
+sys.path.append("{% deploy_root %}")
+
+os.environ.setdefault("DJANGO_SETTINGS_MODULE", "{% django_directory_name %}.settings")
+
+# This application object is used by any WSGI server configured to use this
+# file. This includes Django's development server, if the WSGI_APPLICATION
+# setting points here.
+#from django.core.wsgi import get_wsgi_application
+#application = get_wsgi_application()
+
+import django.core.handlers.wsgi
+application = django.core.handlers.wsgi.WSGIHandler()
+
+# Apply WSGI middleware here.
+# from helloworld.wsgi import HelloWorldApplication
+# application = HelloWorldApplication(application)