Merge lp:~johnsca/charms/precise/chamilo/services-framework into lp:charms/chamilo

[Cory Johns]

Converted charm to python, charmhelpers, and the services framework.

This charm was a great candidate for showing what a good charm looks like before and after using the new framework. This should both improve the readability of the charm and give a good showcase of the benefits of the framework.

Main points:

* Remove manual management of dot-files for tracking partial progress
* Explicit, declarative code describing the mandatory requirements (config, relations, etc)
* Encourages splitting steps / actions into discrete, testable chunks
* Encourages using templates instead of hard-to-read sed commands

[Review Queue (review-queue)]

This items has failed automated testing! Results available here http://reports.vapour.ws/charm-tests/charm-bundle-test-1258-results

review: Needs Fixing (automated testing)

[lp:~johnsca/charms/precise/chamilo/services-framework]

17. By Cory Johns on 2014-11-11

Fixed lint errors

[Review Queue (review-queue)]

The results (PASS) are in and available here: http://reports.vapour.ws/charm-tests/charm-bundle-test-10351-results

review: Approve (automated testing)

[Charles Butler (lazypower)]

Great re-imagining of the chamilo charm with the services framework Cory. Thank you for the great submission. I've gone ahead an approved this and pushed to the store. This will be available in the next 20 to 30 minutes.

Thanks again!

review: Approve

=== added file '.bzrignore'
--- .bzrignore	1970-01-01 00:00:00 +0000
+++ .bzrignore	2014-11-11 14:52:49 +0000
@@ -0,0 +1,3 @@
+venv
+*.pyc
+.coverage

=== added file 'Makefile'
--- Makefile	1970-01-01 00:00:00 +0000
+++ Makefile	2014-11-11 14:52:49 +0000
@@ -0,0 +1,60 @@
+PY := venv/bin/python
+# If the bin version does not exist look in venv/local/bin
+ifeq ($(wildcard venv/bin/pip),)
+  PIP = venv/local/bin/pip
+else
+  PIP = venv/bin/pip
+endif
+# If the bin version does not exist look in venv/local/bin
+NOSE = venv/bin/nosetests
+# ###########
+# Build
+# ###########
+
+.PHONY: install
+install: venv test_deps
+
+venv: $(PY)
+$(PY):
+	virtualenv venv
+
+test_deps: $(PY)
+	$(PIP) install nose coverage mock pyyaml -e bzr+lp:~johnsca/charm-helpers/contexts#egg=charmhelpers
+
+.PHONY: clean_all
+clean_all: clean clean_venv clean_db
+
+.PHONY: clean_venv
+clean_venv:
+	rm -rf venv
+
+.PHONY: clean
+clean:
+	find . -name '*.pyc' -delete
+	find . -name '*.bak' -delete
+	rm -f .coverage
+
+.PHONY: sysdeps
+sysdeps:
+	sudo apt-get $(shell tty -s || echo -y) install python3-dev virtualenv
+
+.PHONY: test
+test: unit_test
+
+unit_test: $(NOSE)
+	@$(NOSE) --nologcapture
+
+.PHONY: coverage
+coverage: $(NOSE)
+	@echo Testing with coverage...
+	@$(NOSE) --nologcapture --with-coverage --cover-package=hooks
+
+.PHONY: lint
+lint:
+	@find $(sources) -type f \( -iname '*.py' ! -iname '__init__.py' ! -iwholename '*venv/*' \) -print0 | xargs -r0 flake8
+
+.PHONY: check
+check: test lint
+
+.PHONY: all
+all: clean venv coverage lint

=== added file 'hooks/__init__.py'
=== added file 'hooks/actions.py'
--- hooks/actions.py	1970-01-01 00:00:00 +0000
+++ hooks/actions.py	2014-11-11 14:52:49 +0000
@@ -0,0 +1,56 @@
+import subprocess
+
+from charmhelpers.core import hookenv
+from charmhelpers.core.services import helpers
+
+
+def init_database(service_name):
+    """
+    Load SQL file to set up all of the database tables.
+    """
+    config = hookenv.config()
+    if config.previous('db_initialized'):
+        return
+
+    hookenv.log('Initializing database')
+    mysql = helpers.MysqlRelation()['db'][0]
+    with open('data/chamilo-default-db.sql') as sql:
+        exec_sql(sql, mysql)
+    config['db_initialized'] = True
+    config.save()
+
+
+def update_admin_account(service_name):
+    """
+    Update the admin username and password in the database directly.
+    """
+    config = hookenv.config()
+    mysql = helpers.MysqlRelation()['db'][0]
+
+    hookenv.log('Updating admin username')
+    exec_sql("UPDATE user SET username = '%s' "
+             "WHERE user_id = 1;".format(config['user']), mysql)
+
+    hookenv.log('Updating admin password')
+    exec_sql("UPDATE user SET password = SHA1('{}') "
+             "WHERE user_id = 1;".format(config['pass']), mysql)
+
+
+def exec_sql(sql, mysql_cfg):
+    """
+    Execute SQL against a MySQL instance
+    """
+    sql_cmd = [
+        'mysql',
+        '-u{}'.format(mysql_cfg['user']),
+        '-p{}'.format(mysql_cfg['password']),
+        '-h', mysql_cfg['host'],
+        mysql_cfg['database'],
+    ]
+
+    if not hasattr(sql, 'read'):
+        sql_cmd.extend(['-e', sql])
+        stdin = None
+    else:
+        stdin = sql
+    subprocess.check_call(sql_cmd, stdin=stdin)

=== modified file 'hooks/config-changed'
--- hooks/config-changed	2014-06-25 23:43:23 +0000
+++ hooks/config-changed	2014-11-11 14:52:49 +0000
@@ -1,51 +1,3 @@
-#!/bin/bash
-
-set -eux
-
-DOMAIN=`config-get domain`
-USERNAME=`config-get user`
-PASS=`config-get pass`
-
-if [ -f .dbset ]; then
-    HOST=`cat .host`
-    DB=`cat .db`
-    USER=`cat .user`
-    PASSWORD=`cat .password`
-fi
-
-if [ -z "$DOMAIN" ]; then
-    juju-log "Domain hasn't been set, exiting silently."
-    exit 0
-fi
-
-if [ -f .domainnotset ]; then
-    hooks/db-relation-changed
-    rm .domainnotset
-fi
-
-if [ -z "$PASS" ]; then
-    juju-log "Password hasn't been set, exiting silently."
-    exit 0
-fi
-
-if [ -f .configured ] && [ `cat .domain` != "$DOMAIN" ]; then
-    juju-log "Updating domain"
-    CURDOM=`cat .domain`
-    sed -i "s/$CURDOM/$DOMAIN/" /var/www/main/inc/conf/configuration.php
-    echo "$DOMAIN" > .domain
-fi
-
-if [ -f .dbset ] && [ `cat .username` != "$USERNAME" ]; then
-    juju-log "Updating username"
-    mysql -u $USER -p$PASSWORD -h $HOST $DB -e "UPDATE user SET username = '$USERNAME' WHERE user_id = 1;"
-    echo "$USERNAME" > .username
-fi
-
-if [ -f .dbset ] && [ `cat .pass` != "$PASS" ]; then
-    juju-log "Updating password"
-    mysql -u $USER -p$PASSWORD -h $HOST $DB -e "UPDATE user SET password = SHA1('$PASS') WHERE user_id = 1;"
-    echo "$PASS" > .pass
-fi
-
-juju-log "Restarting server"
-service apache2 restart
+#!/usr/bin/env python
+import services
+services.manage()

=== modified file 'hooks/db-relation-changed'
--- hooks/db-relation-changed	2014-06-23 05:08:55 +0000
+++ hooks/db-relation-changed	2014-11-11 14:52:49 +0000
@@ -1,80 +1,3 @@
-#!/bin/bash
-
-set -eux
-
-if [ -f .domainnotset ]; then
-    HOST=`cat .host`
-    DB=`cat .db`
-    USER=`cat .user`
-    PASSWORD=`cat .password`
-else
-    HOST=`relation-get private-address`
-    DB=`relation-get database`
-    USER=`relation-get user`
-    PASSWORD=`relation-get password`
-fi
-DOMAIN=`config-get domain`
-KEY=`makepasswd`
-VERSION="1.9.8.2"
-USERNAME=`config-get user`
-PASS=`config-get pass`
-
-if [ -z "$DB" ]; then
-    juju-log "Data hasn't been set yet! Exiting silently"
-    exit 0
-fi
-
-echo "$HOST" > .host
-echo "$USER" > .user
-echo "$PASSWORD" > .password
-echo "$DB" > .db
-
-if [ -z "$DOMAIN" ]; then
-    juju-log "Domain hasn't been set! Exiting silently"
-    touch .domainnotset
-    exit 0
-fi
-
-if [ ! -f /var/www/main/inc/conf/configuration.php.bak ]; then
-    juju-log "Making backup of Chamilo config file"
-    cp /var/www/main/inc/conf/configuration.php /var/www/main/inc/conf/configuration.php.bak
-fi
-
-juju-log "Configuring Chamilo"
-sed -i "s/{DATABASE_HOST}/$HOST/" /var/www/main/inc/conf/configuration.php
-sed -i "s/{DATABASE_USER}/$USER/" /var/www/main/inc/conf/configuration.php
-sed -i "s/{DATABASE_PASSWORD}/$PASSWORD/" /var/www/main/inc/conf/configuration.php
-sed -i "s/{COURSE_TABLE_PREFIX}//" /var/www/main/inc/conf/configuration.php
-sed -i "s/{ROOT_WEB}/http:\/\/$DOMAIN\//" /var/www/main/inc/conf/configuration.php
-sed -i "s/{ROOT_SYS}/\/var\/www\//" /var/www/main/inc/conf/configuration.php
-sed -i "s/{DATABASE_MAIN}/$DB/" /var/www/main/inc/conf/configuration.php
-sed -i "s/{DATABASE_STATS}/$DB/" /var/www/main/inc/conf/configuration.php
-sed -i "s/{DATABASE_PERSONAL}/$DB/" /var/www/main/inc/conf/configuration.php
-sed -i "s/{URL_APPEND_PATH}//" /var/www/main/inc/conf/configuration.php
-sed -i "s/{DATABASE_PREFIX}//" /var/www/main/inc/conf/configuration.php
-sed -i "s/{DATABASE_GLUE}/\`.\`/" /var/www/main/inc/conf/configuration.php
-sed -i "s/{ENCRYPT_PASSWORD}/sha1/" /var/www/main/inc/conf/configuration.php
-sed -i "s/{SECURITY_KEY}/$KEY/" /var/www/main/inc/conf/configuration.php
-sed -i "s/{NEW_VERSION}/$VERSION/" /var/www/main/inc/conf/configuration.php
-sed -i "s/TRACKING_ENABLED/true/" /var/www/main/inc/conf/configuration.php
-sed -i "s/SINGLE_DATABASE/false/" /var/www/main/inc/conf/configuration.php
-sed -i "s/SESSION_LIFETIME/360000/" /var/www/main/inc/conf/configuration.php
-touch .configured
-echo "$DOMAIN" > .domain
-
-if [ ! -f .dbset ]; then
-    juju-log "Importing base database"
-    mysql -u $USER -p$PASSWORD -h $HOST $DB < data/chamilo-default-db.sql
-    mysql -u $USER -p$PASSWORD -h $HOST $DB -e "UPDATE user SET username = '$USERNAME', password = SHA1('$PASS') WHERE user_id = 1;"
-    echo "$USERNAME" > .username
-    echo "$PASS" > .pass
-    touch .dbset
-fi
-
-if [ ! -f .started ]; then
-    juju-log "Starting service..."
-    hooks/start
-fi
-
-juju-log "Configuration has been successful."
-
+#!/usr/bin/env python
+import services
+services.manage()

=== modified file 'hooks/db-relation-departed'
--- hooks/db-relation-departed	2014-06-04 00:29:03 +0000
+++ hooks/db-relation-departed	2014-11-11 14:52:49 +0000
@@ -1,23 +1,3 @@
-#!/bin/bash
-
-set -eux
-
-juju-log "Database is departing. Removing all configuration data and info and restoring backup..."
-rm /var/www/main/inc/conf/configuration.php
-cp /var/www/main/inc/conf/configuration.php.bak /var/www/main/inc/conf/configuration.php
-rm .configured
-rm .dbset
-rm .host
-rm .domain
-rm .user
-rm .password
-rm .db
-rm .username
-rm .pass
-
-if [ -f .started ]; then
-    juju-log "Stopping service"
-    hooks/stop
-fi
-
-juju-log "Database relation has been successfully removed. Please relate a database to start using Chamilo again."
+#!/usr/bin/env python
+import services
+services.manage()

=== modified file 'hooks/install'
--- hooks/install	2014-06-23 05:08:55 +0000
+++ hooks/install	2014-11-11 14:52:49 +0000
@@ -1,45 +1,53 @@
-#!/bin/bash
-
-set -eux
-
-juju-log "Installing dependencies"
-apt-get install -y apache2 php5 php5-mysqlnd php5-gd makepasswd mysql-client php5-intl php5-curl
-
-juju-log "Downloading Chamilo and verifying integrity"
-wget https://campus.chamilo.org/chamilo-1.9.8.tar.gz
-if [ `sha1sum chamilo-1.9.8.tar.gz` != "2d2e0a5f96f3dcffc9466dda682a2e533eec7cd0  chamilo-1.9.8.tar.gz" ]; then
-    juju-log "There was an error when downloading Chamilo and the tarball is corrupt. Exiting."
-    exit 1
-fi
-
-juju-log "Extracting/copying Chamilo to the right directory and setting necessary permissions"
-tar -zxf chamilo-1.9.8.tar.gz
-rm /var/www/index.html
-cp -al chamilo-1.9.8.2/* /var/www/
-chown -R www-data:www-data /var/www/main/inc/conf/
-chown -R www-data:www-data /var/www/main/upload/users/
-chown -R www-data:www-data /var/www/main/default_course_document/
-chown -R www-data:www-data /var/www/archive/
-chown -R www-data:www-data /var/www/courses/
-chown -R www-data:www-data /var/www/home/
-
-juju-log "Copying boilerplate configuration files and setting permissions"
-cp /var/www/main/install/configuration.dist.php /var/www/main/inc/conf/configuration.php
-rm -r /var/www/main/install/
-cp /var/www/main/inc/conf/add_course.conf.dist.php /var/www/main/inc/conf/add_course.conf.php
-cp /var/www/main/inc/conf/auth.conf.dist.php /var/www/main/inc/conf/auth.conf.php
-cp /var/www/main/inc/conf/course_info.conf.dist.php /var/www/main/inc/conf/course_info.conf.php
-cp /var/www/main/inc/conf/events.conf.dist.php /var/www/main/inc/conf/events.conf.php
-cp /var/www/main/inc/conf/mail.conf.dist.php /var/www/main/inc/conf/mail.conf.php
-cp /var/www/main/inc/conf/portfolio.conf.dist.php /var/www/main/inc/conf/portfolio.conf.php
-cp /var/www/main/inc/conf/profile.conf.dist.php /var/www/main/inc/conf/profile.conf.php
-chmod 777 /var/www/main/inc/conf/
-
-touch .db
-touch .host
-touch .user
-touch .password
-
-service apache2 stop
-
-juju-log "Install successful"
+#!/usr/bin/python
+
+import setup
+setup.pre_install()
+
+import os
+import shutil
+from charmhelpers.core import host
+from charmhelpers.core import hookenv
+from charmhelpers import fetch
+
+
+def install():
+    hookenv.log('Installing chamilo')
+    # install base dependencies
+    fetch.apt_install([
+        'apache2',
+        'php5',
+        'php5-mysqlnd',
+        'php5-gd',
+        'makepasswd',
+        'mysql-client',
+        'php5-intl',
+        'php5-curl',
+    ])
+
+    # install site files
+    fetch.install_remote('https://campus.chamilo.org/chamilo-1.9.8.tar.gz',
+                         dest='/var/www',
+                         checksum='2d2e0a5f96f3dcffc9466dda682a2e533eec7cd0',
+                         hash_type='sha1')
+
+    # ensure site files are owned properly
+    host.chownr('/var/www', owner='www-data', group='www-data')
+
+    # place boilerplate config files
+    # (remaining config will be placed during later hooks)
+    boilerplate_config_files = [
+        'add_course.conf.dist.php',
+        'auth.conf.dist.php',
+        'course_info.conf.dist.php',
+        'events.conf.dist.php',
+        'mail.conf.dist.php',
+        'portfolio.conf.dist.php',
+        'profile.conf.dist.php',
+    ]
+    with host.chdir('/var/www/chamilo-1.9.8.2/main/inc/conf/'):
+        for config_file in boilerplate_config_files:
+            shutil.copy2(config_file, config_file.replace('.dist', ''))
+
+
+if __name__ == "__main__":
+    install()

=== added file 'hooks/services.py'
--- hooks/services.py	1970-01-01 00:00:00 +0000
+++ hooks/services.py	2014-11-11 14:52:49 +0000
@@ -0,0 +1,37 @@
+from charmhelpers.core import host
+from charmhelpers.core.services.base import ServiceManager
+from charmhelpers.core.services import helpers
+
+import actions
+
+
+CHAMILO_VERSION = '1.9.8.2'
+
+
+def manage():
+    manager = ServiceManager([
+        {
+            'service': 'apache2',
+            'ports': [80],
+            'provided_data': [helpers.HttpRelation()],
+            'required_data': [
+                helpers.RequiredConfig('domain', 'pass'),
+                helpers.MysqlRelation(),
+                helpers.StoredContext('chamilo-secret.json', {
+                    'key': host.pwgen(7),
+                    'version': CHAMILO_VERSION,
+                }),
+            ],
+            'data_ready': [
+                helpers.render_template(source='configuration.php.j2',
+                                        target="/var/www/main/inc/conf/"
+                                               "configuration.php"),
+                helpers.render_template(source='apache-site.j2',
+                                        target="/etc/apache2/sites-available/"
+                                               "default"),
+                actions.init_database,
+                actions.update_admin_account,
+            ],
+        },
+    ])
+    manager.manage()

=== added file 'hooks/setup.py'
--- hooks/setup.py	1970-01-01 00:00:00 +0000
+++ hooks/setup.py	2014-11-11 14:52:49 +0000
@@ -0,0 +1,17 @@
+def pre_install():
+    """
+    Do any setup required before the install hook.
+    """
+    install_charmhelpers()
+
+
+def install_charmhelpers():
+    """
+    Install the charmhelpers library, if not present.
+    """
+    try:
+        import charmhelpers  # noqa
+    except ImportError:
+        import subprocess
+        subprocess.check_call(['apt-get', 'install', '-y', 'python-pip'])
+        subprocess.check_call(['pip', 'install', 'charmhelpers'])

=== modified file 'hooks/start'
--- hooks/start	2014-05-03 04:31:38 +0000
+++ hooks/start	2014-11-11 14:52:49 +0000
@@ -1,10 +1,3 @@
-#!/bin/bash
-
-set -eux
-
-if [ -f .configured ]; then
-    service apache2 start
-    open-port 80
-    touch .started
-    juju-log "Woohoo! Chamilo has started!"
-fi
+#!/usr/bin/env python
+import services
+services.manage()

=== modified file 'hooks/stop'
--- hooks/stop	2014-06-03 22:33:59 +0000
+++ hooks/stop	2014-11-11 14:52:49 +0000
@@ -1,10 +1,3 @@
-#!/bin/bash
-
-set -eux
-
-if [ -f .started ]; then
-    service apache2 stop
-    close-port 80
-    rm .started
-    juju-log "Chamilo has stopped."
-fi
+#!/usr/bin/env python
+import services
+services.manage()

=== modified file 'hooks/website-relation-joined'
--- hooks/website-relation-joined	2014-05-03 04:31:38 +0000
+++ hooks/website-relation-joined	2014-11-11 14:52:49 +0000
@@ -1,3 +1,3 @@
-#!/bin/bash
-
-relation-set "port=80"
+#!/usr/bin/env python
+import services
+services.manage()

=== added directory 'templates'
=== added file 'templates/apache-site.j2'
--- templates/apache-site.j2	1970-01-01 00:00:00 +0000
+++ templates/apache-site.j2	2014-11-11 14:52:49 +0000
@@ -0,0 +1,41 @@
+<VirtualHost *:80>
+        ServerAdmin webmaster@localhost
+
+        DocumentRoot /var/www/chamilo-1.9.8.2
+        <Directory />
+                Options FollowSymLinks
+                AllowOverride None
+        </Directory>
+        <Directory /var/www/chmailo-1.9.8.2/>
+                Options Indexes FollowSymLinks MultiViews
+                AllowOverride None
+                Order allow,deny
+                allow from all
+        </Directory>
+
+        ScriptAlias /cgi-bin/ /usr/lib/cgi-bin/
+        <Directory "/usr/lib/cgi-bin">
+                AllowOverride None
+                Options +ExecCGI -MultiViews +SymLinksIfOwnerMatch
+                Order allow,deny
+                Allow from all
+        </Directory>
+
+        ErrorLog ${APACHE_LOG_DIR}/error.log
+
+        # Possible values include: debug, info, notice, warn, error, crit,
+        # alert, emerg.
+        LogLevel warn
+
+        CustomLog ${APACHE_LOG_DIR}/access.log combined
+
+    Alias /doc/ "/usr/share/doc/"
+    <Directory "/usr/share/doc/">
+        Options Indexes MultiViews FollowSymLinks
+        AllowOverride None
+        Order deny,allow
+        Deny from all
+        Allow from 127.0.0.0/255.0.0.0 ::1/128
+    </Directory>
+
+</VirtualHost>

=== added file 'templates/configuration.php.j2'
--- templates/configuration.php.j2	1970-01-01 00:00:00 +0000
+++ templates/configuration.php.j2	2014-11-11 14:52:49 +0000
@@ -0,0 +1,207 @@
+<?php
+// Chamilo version {NEW_VERSION}
+// File generated by /install/index.php script - {DATE_GENERATED}
+/* For licensing terms, see /license.txt */
+/**
+ * Campus configuration
+ *
+ * This file contains a list of variables that can be modified by the campus
+ * site's server administrator. Pay attention when changing these variables,
+ * some changes may cause Chamilo to stop working.
+ * If you changed some settings and want to restore them, please have a look at
+ * configuration.dist.php. That file is an exact copy of the config file at
+ * install time.
+ */
+
+/**
+ * $_configuration define only the bare essential variables
+ * for configuring the platform (paths, database connections, ...).
+ * Changing a $_configuration variable CAN generally break the installation.
+ * Besides the $_configuration, a $_settings array also exists, that
+ * contains variables that can be changed and will not break the platform.
+ * These optional settings are defined in the database, now
+ * (table settings_current).
+ * example: $_configuration['tracking_enabled'] (assuming that the install
+ * script creates the necessary tables anyway).
+ */
+
+/**
+ * MYSQL connection settings
+ */
+// Your MySQL server
+$_configuration['db_host']     = '{{db[0]['host']}}';
+// Your MySQL username
+$_configuration['db_user']     = '{{db[0]['user']}}';
+// Your MySQL password
+$_configuration['db_password'] = '{{db[0]['password']}}';
+
+/**
+ * Database settings
+ */
+// Is tracking enabled?
+$_configuration['tracking_enabled']      = true;
+// Is single database enabled (DO NOT MODIFY THIS)
+$_configuration['single_database']       = false;
+// Prefix for course tables (IF NOT EMPTY, can be replaced by another prefix, else leave empty)
+$_configuration['table_prefix']          = '';
+// Separator between database and table name (DO NOT MODIFY THIS)
+$_configuration['db_glue']               = '`.`';
+// prefix all created bases (for courses) with this string
+$_configuration['db_prefix']             = '';
+// main Chamilo database
+$_configuration['main_database']         = '{{db[0]['db']}}';
+// stats Chamilo database
+$_configuration['statistics_database']   ='{{db[0]['db']}}';
+// User Personal Database (where all the personal stuff of the user is stored
+// (personal agenda items, course sorting)
+$_configuration['user_personal_database']='{{db[0]['db']}}';
+// Enable access to database management for platform admins.
+$_configuration['db_manager_enabled'] = false;
+
+/**
+ * Directory settings
+ */
+// URL to the root of your Chamilo installation, e.g.: http://www.mychamilo.com/
+$_configuration['root_web']       = '{{config['domain']}}';
+
+// Path to the webroot of system, example: /var/www/
+$_configuration['root_sys']       = '/var/www/';
+
+// Path from your WWW-root to the root of your Chamilo installation, example: chamilo (this means chamilo is installed in /var/www/chamilo/
+$_configuration['url_append']     = '';
+
+// Directory of the Chamilo code. You could change this but it is not advised since this has not been tested yet.
+$_configuration['code_append']    = "main/";
+
+// Directory to store all course-related files. You could change this but it is not advised since this has not been tested yet.
+$_configuration['course_folder']  = "courses/";
+
+// URL to your phpMyAdmin installation.
+// If not empty, a link will be available in the Platform Administration
+$_configuration['db_admin_path']  = '';
+
+/**
+ * Login modules settings
+ */
+// CAS IMPLEMENTATION
+// -> Go to your portal Chamilo > Administration > CAS to activate CAS
+// You can leave these lines uncommented even if you don't use CAS authentification
+$extAuthSource["cas"]["login"] = $_configuration['root_sys'].$_configuration['code_append']."auth/cas/login.php";
+$extAuthSource["cas"]["newUser"] = $_configuration['root_sys'].$_configuration['code_append']."auth/cas/newUser.php";
+//
+// NEW LDAP IMPLEMENTATION BASED ON external_login info
+// -> Uncomment the two lines bellow to activate LDAP AND edit main/auth/external_login/ldap.conf.php for configuration
+// $extAuthSource["extldap"]["login"] = $_configuration['root_sys'].$_configuration['code_append']."auth/external_login/login.ldap.php";
+// $extAuthSource["extldap"]["newUser"] = $_configuration['root_sys'].$_configuration['code_append']."auth/external_login/newUser.ldap.php";
+//
+// FACEBOOK IMPLEMENTATION BASED ON external_login info
+// -> Uncomment the line bellow to activate Facebook Auth AND edit main/auth/external_login/ldap.conf.php for configuration
+// $_configuration['facebook_auth'] = 1;
+//
+// OTHER EXTERNAL LOGIN INFORMATION
+// To fetch external login information, uncomment those 2 lines and modify  files auth/external_login/newUser.php and auth/external_login/updateUser.php files
+// $extAuthSource["external_login"]["newUser"] = $_configuration['root_sys'].$_configuration['code_append']."auth/external_login/newUser.php";
+// $extAuthSource["external_login"]["updateUser"] = $_configuration['root_sys'].$_configuration['code_append']."auth/external_login/updateUser.php";
+
+/**
+ *
+ * Hosting settings - Allows you to set limits to the Chamilo portal when
+ * hosting it for a third party. These settings can be overwritten by an
+ * optionally-loaded extension file with only the settings (no comments).
+ * The settings use an index at the first level to represent the ID of the
+ * URL in case you use multi-url (otherwise it will always use 1, which is
+ * the ID of the only URL inside the access_url table).
+ */
+// Set a maximum number of users. Default (0) = no limit
+$_configuration[1]['hosting_limit_users'] = 0;
+// Set a maximum number of teachers. Default (0) = no limit
+$_configuration[1]['hosting_limit_teachers'] = 0;
+// Set a maximum number of courses. Default (0) = no limit
+$_configuration[1]['hosting_limit_courses'] = 0;
+// Set a maximum number of sessions. Default (0) = no limit
+$_configuration[1]['hosting_limit_sessions'] = 0;
+// Set a maximum disk space used, in MB (set to 1024 for 1GB, 5120 for 5GB).
+// Default (0) = no limit
+$_configuration[1]['hosting_limit_disk_space'] = 0;
+
+/**
+ * Content Delivery Network (CDN) settings. Only use if you need a separate
+ * server to serve your static data. If you don't know what a CDN is, you
+ * don't need it. These settings are for simple Origin Pull CDNs and are
+ * experimental. Enable only if you really know what you're doing.
+ * This might conflict with multiple-access urls.
+ */
+// Set the following setting to true to start using the CDN
+$_configuration['cdn_enable'] = false;
+// The following setting will be ignored if the previous one is set to false
+$_configuration['cdn'] = array(
+  //You can define several CDNs and split them by extensions
+  //Replace the following by your full CDN URL, which should point to
+  // your Chamilo's root directory. DO NOT INCLUDE a final slash! (won't work)
+  'http://cdn.chamilo.org' => array('.css','.js','.jpg','.jpeg','.png','.gif','.avi','.flv'),
+  // copy the line above and modify following your needs
+);
+
+/**
+ * Misc. settings
+ */
+// Verbose backup
+$_configuration['verbose_backup']    = false;
+// security word for password recovery
+$_configuration['security_key']      = '{{key}}';
+// Hash function method
+$_configuration['password_encryption']      = 'sha1';
+// You may have to restart your web server if you change this
+$_configuration['session_stored_in_db']     = false;
+// Session lifetime
+$_configuration['session_lifetime']  = 360000;
+// Activation for multi-url access
+//$_configuration['multiple_access_urls']					= true;
+$_configuration['software_name']     = 'Chamilo';
+$_configuration['software_url']	     = 'http://www.chamilo.org/';
+//Deny the elimination of users
+$_configuration['deny_delete_users'] = false;
+// Version settings
+$_configuration['system_version']    = '{{version}}';
+$_configuration['system_stable']     = NEW_VERSION_STABLE;
+
+/**
+ * Settings to be included as settings_current in future versions
+ */
+// Hide the main home section for connected users (to show announcements instead)
+//$_configuration['hide_home_top_when_connected'] = true;
+// Hide the global announcements for non-connected users
+//$_configuration['hide_global_announcements_when_not_connected'] = true;
+// Use this course as template for all new courses (define course real ID as value)
+//$_configuration['course_creation_use_template'] = 14;
+// Uncomment the following to prevent all admins to use the "login as" feature
+//$_configuration['login_as_forbidden_globally'] = true;
+// Add password strength checker
+//$_configuration['allow_strength_pass_checker'] = true;
+// Enable captcha
+//$_configuration['enable_captcha'] = true;
+//$_configuration['allow_captcha'] = true;
+// Prevent account from logging in for a certain amount of time if captcha is wrong for the specified number of times
+//$_configuration['captcha_number_mistakes_to_block_account'] = 5;
+// Prevent account from logging in for the specified number of minutes
+//$_configuration['captcha_time_to_block'] = 5;//minutes
+// Allow DRH role to access all content and users from the sessions he follows
+//$_configuration['drh_can_access_all_session_content'] = true;
+// Display group's forum in general forum tool
+//$_configuration['display_groups_forum_in_general_tool'] = true;
+// Boost query on last connection time
+//$_configuration['save_user_last_login'] = true;
+// Allow course tutors in sessions to add existing students to their session
+//$_configuration['allow_tutors_to_assign_students_to_session'] = 'false';
+// Allow select the return link in the LP view
+//$_configuration['allow_lp_return_link'] = false;
+// If true the export link is blocked.
+//$_configuration['hide_scorm_export_link'] = false;
+// If true the copy link is blocked.
+//$_configuration['hide_scorm_copy_link'] = false;
+// If true the pdf export link is blocked.
+//$_configuration['hide_scorm_pdf_link'] = false;
+// Default session days before coach access
+//$_configuration['session_days_before_coach_access'] = 0;
+// Default session days after coach access
+//$_configuration['session_days_after_coach_access'] = 0;

=== added directory 'tests'
=== added file 'tests/test_actions.py'
--- tests/test_actions.py	1970-01-01 00:00:00 +0000
+++ tests/test_actions.py	2014-11-11 14:52:49 +0000
@@ -0,0 +1,102 @@
+import os
+import shutil
+import tempfile
+import unittest
+import StringIO
+import contextlib
+
+from mock import patch, Mock
+from hooks import actions
+
+from charmhelpers.core.hookenv import Config
+
+MYSQL_CFG = {
+    'user': '__user',
+    'password': 'pass',
+    'host': '0.0.0.0',
+    'port': 3306,
+    'database': 'test'
+}
+
+
[e-mail]
+def charm_dir():
+    temp_dir = tempfile.mkdtemp()
+    with patch.dict(os.environ, {'CHARM_DIR': temp_dir}):
+        yield
+    shutil.rmtree(temp_dir)
+
+
+class TestHelpers(unittest.TestCase):
+    @patch('hooks.actions.subprocess.check_call')
+    def test_exec_sql_string(self, mchk):
+        actions.exec_sql('SELECT * FROM Something', MYSQL_CFG)
+        mchk.assert_called_with([
+            'mysql',
+            '-u__user',
+            '-ppass',
+            '-h', '0.0.0.0',
+            'test',
+            '-e', 'SELECT * FROM Something',
+        ], stdin=None)
+
+    @patch('hooks.actions.subprocess.check_call')
+    def test_exec_sql_file(self, mchk):
+        sql_file = StringIO.StringIO('SELECT * FROM Something')
+        actions.exec_sql(sql_file, MYSQL_CFG)
+        mchk.assert_called_with([
+            'mysql',
+            '-u__user',
+            '-ppass',
+            '-h', '0.0.0.0',
+            'test',
+        ], stdin=sql_file)
+
+    @patch('hooks.actions.exec_sql')
+    @patch('hooks.actions.hookenv.config')
+    def test_init_database_initd(self, mcfg, mexc):
+        with charm_dir():
+            config = Config()
+            config._prev_dict = {'db_initialized': True}
+            mcfg.return_value = config
+            actions.init_database('foo')
+            mexc.assert_not_called()
+
+    @patch('hooks.actions.hookenv.log', Mock())
+    @patch('hooks.actions.hookenv.config')
+    @patch('hooks.actions.helpers.MysqlRelation')
+    @patch('hooks.actions.exec_sql')
+    def test_init_database(self, mexc, mrel, mcfg):
+        mrel.return_value = {'db': [MYSQL_CFG]}
+
+        with charm_dir():
+            mcfg.return_value = Config()
+            actions.init_database('foo')
+            self.assertEqual(True, mcfg.return_value['db_initialized'])
+            mexc.assert_called_once()
+
+    @patch('hooks.actions.hookenv.log', Mock())
+    @patch('hooks.actions.hookenv.config')
+    @patch('hooks.actions.helpers.MysqlRelation')
+    @patch('hooks.actions.exec_sql')
+    def test_update_admin_acct(self, mexc, mrel, mcfg):
+        mrel.return_value = {'db': [MYSQL_CFG]}
+
+        with charm_dir():
+            mcfg.return_value = Config({'user': 'what', 'pass': 'going on'})
+            actions.update_admin_account('foo')
+            mexc.assert_not_called()
+
+    @patch('hooks.actions.hookenv.log', Mock())
+    @patch('hooks.actions.hookenv.config')
+    @patch('hooks.actions.helpers.MysqlRelation')
+    @patch('hooks.actions.exec_sql')
+    def test_update_admin_no_change(self, mexc, mrel, mcfg):
+        mrel.return_value = {'db': [MYSQL_CFG]}
+
+        with charm_dir():
+            config = Config({'pass': 'hey', 'user': 'hey'})
+            config._prev_dict = {'pass': 'hey', 'user': 'hey'}
+            mcfg.return_value = config
+            actions.init_database('foo')
+            mexc.assert_called()