Merge lp:~nijaba/charms/oneiric/limesurvey/trunk into lp:charms/oneiric/limesurvey

[Nick Barcet]

* add a few site specific configuration parameters, including mysql table type.
* implement config-changed hook
* merge with trunk done

[Clint Byrum (clint-fewbar)]

Hi Nick. It would seem that there are some conflicts between these changes (which all look great) and the ones I did to make db-relation-changed idempotent.

Once those conflicts are resolved I'll merge it into the main charm.

review: Needs Fixing

[Nick Barcet (nijaba)]

Merge done.

=== added file 'config.yaml'
--- config.yaml	1970-01-01 00:00:00 +0000
+++ config.yaml	2011-12-07 00:02:26 +0000
@@ -0,0 +1,53 @@
+options:
+  mysql-tabletype:
+    default: myISAM
+    type: string
+    description: Storage engine mysql should use when creating survey results tables and token tables. Default is myISAM, but InnoDB should be much faster with concurent access. This setting cannot be changed after initial deployment.
+  db-persistent:
+    default: false
+    type: string
+    description: If you want to enable persistent database connections set this to 'true' - this might be faster for some database drivers. This setting cannot be changed after initial deployment.
+  site-name:
+    default: Limesurvey
+    type: string
+    description: The official name of the site (appears in the Window title)
+  default-admin-pass:
+    default: password
+    type: string
+    description: Default password for the admin user. This setting cannot be changed after initial deployment.
+  default-lang:
+    default: en
+    type: string
+    description: The default language to use - the available languages are the directory names in the /locale dir - for example de = German
+  admin-email:
+    default: [e-mail]
+    type: string
+    description: The default email address of the site administrator (displayed on the front page).
+  admin-bounce:
+    default: [e-mail]
+    type: string
+    description: The default email address used for error notification of sent messages for the site administrator (Return-Path).
+  admin-name:
+    default: MyName
+    type: string
+    description: Name of the site admin
+  mail-method:
+    default: mail
+    type: string
+    description: Mailer type to use. Value can be 'mail' (internal phpmailer), 'sendmail', 'qmail', 'smtp'
+  mail-smtp-host:
+    default: smtphost.address:25
+    type: string
+    description: Address of the SMTP host and optional port.
+  mail-smtp-user:
+    default: ""
+    type: string
+    description: SMTP authorisation username - only set this if your server requires authorization - if you set it you HAVE to set a password too
+  mail-smtp-password:
+    default: ""
+    type: string
+    description: SMTP authorisation password - empty password is not allowed
+  mail-smtp-ssl:
+    default: ""
+    type: string
+    description: Set this to 'ssl' or 'tls' to use SSL/TLS for SMTP connection

=== added file 'hooks/config-changed'
--- hooks/config-changed	1970-01-01 00:00:00 +0000
+++ hooks/config-changed	2011-12-07 00:02:26 +0000
@@ -0,0 +1,13 @@
+#!/bin/bash
+
+set -eu # -x for verbose logging to juju debug-log
+
+FORMULA_DIR=$(dirname $0)
+if [[ -e $FORMULA_DIR/limesurvey-common ]] ; then
+    . $FORMULA_DIR/limesurvey-common
+else
+    echo "ERROR: Could not load limesurvey-common from $FORMULA_DIR"
+fi
+
+# Write the limesurvey config
+set-config

=== modified file 'hooks/db-relation-changed'
--- hooks/db-relation-changed	2011-12-06 21:49:38 +0000
+++ hooks/db-relation-changed	2011-12-07 00:02:26 +0000
@@ -2,25 +2,13 @@
 
 set -eu # -x for verbose logging to juju debug-log
 
-LPATH="/var/opt/limesurvey/"
-
-hostname=`unit-get public-address`
-juju-log "Retrieved hostname: $hostname"
-
-# Get the database settings; if not set, wait for this hook to be
-# invoked again
-database=`relation-get database`
-if [ -z "$database" ] ; then
-    exit 0 # wait for future handshake from database service unit
+FORMULA_DIR=$(dirname $0)
+if [[ -e $FORMULA_DIR/limesurvey-common ]] ; then
+    . $FORMULA_DIR/limesurvey-common
+else
+    echo "ERROR: Could not load limesurvey-common from $FORMULA_DIR"
 fi
 
-# Our protocol on this interface ensures that all or none of the
-# settings are set. But we can verify the setting or the values if
-# more error checking if desired.
-user=`relation-get user`
-password=`relation-get password`
-host=`relation-get private-address`
-
 juju-log "Creating appropriate upload paths and directories"
 # Setup appropriate upload paths and directories
 ln -sf $LPATH "/var/www/$hostname"
@@ -30,26 +18,11 @@
 chmod 0770 -R "$LPATH/tmp"
 chmod 0770 -R "$LPATH/upload"
 
-juju-log "Writing limesurvey config file $config_file_path"
-# Write the wordpress config
-cat > $config_file_path <<EOF
-<?php
-\$databasetype       =   'mysql';
-\$databaselocation   =   '$host';
-\$databasename       =   '$database';
-\$databaseuser       =   '$user';
-\$databasepass       =   '$password';
-\$dbprefix           =   'lime_';
-\$rooturl            =   "http://{\$_SERVER['HTTP_HOST']}";
-\$rootdir            =   dirname(__FILE__);
-\$defaultuser        =   'admin';
-\$defaultpass        =   'password';
-\$debug              =   0;
-\$sessionhandler     =  'db';
-?>
-EOF
-chmod 0644 $config_file_path
-chown root:www-data $config_file_path
+# write the invariant part of the config file
+set-invariant-config
+
+# Write the limesurvey config
+set-config
 
 juju-log "Starting limesurvey install"
 pushd /var/opt/limesurvey

=== added file 'hooks/limesurvey-common'
--- hooks/limesurvey-common	1970-01-01 00:00:00 +0000
+++ hooks/limesurvey-common	2011-12-07 00:02:26 +0000
@@ -0,0 +1,76 @@
+#!/bin/bash
+
+LPATH="/var/opt/limesurvey/"
+config_file_path="${LPATH}config.php"
+config_tmp="$FORMULA_DIR/config.tmp"
+
+hostname=`unit-get public-address`
+juju-log "Retrieved hostname: $hostname"
+
+#Store the invariant part of the config file on disk, so that we can 
+#reuse it outside of a relation-changed hook. This is a workaround until
+#we will be able to do relation-get <relation> <variable>
+function set-invariant-config {
+  # Get the database settings; if not set, wait for this hook to be
+  # invoked again
+  database=`relation-get database`
+  if [ -z "$database" ] ; then
+    exit 0 # wait for future handshake from database service unit
+  fi
+
+  # Our protocol on this interface ensures that all or none of the
+  # settings are set. But we can verify the setting or the values if
+  # more error checking if desired.
+  user=`relation-get user`
+  password=`relation-get password`
+  host=`relation-get private-address`
+
+  juju-log "Writing limesurvey invariant config.tmp"
+  # Write the limesurvey config
+  cat > $config_tmp <<EOF
+<?php
+\$databasetype       =   'mysql';
+\$databaselocation   =   '$host';
+\$databasename       =   '$database';
+\$databaseuser       =   '$user';
+\$databasepass       =   '$password';
+\$dbprefix           =   'lime_';
+\$rooturl            =   "http://{\$_SERVER['HTTP_HOST']}";
+\$rootdir            =   dirname(__FILE__);
+\$defaultuser        =   'admin';
+\$defaultpass        =  '$(config-get default-admin-pass)';
+\$debug              =   0;
+\$sessionhandler     =  'db';
+\$databasetabletype  =  '$(config-get mysql-tabletype)';
+\$databasepersistent =  '$(config-get db-persistent)';
+EOF
+}
+
+#Set the configuration values that can be changed after the relation
+#with the db has been done
+function set-config {
+  if [[ ! -e $config_tmp ]] ; then
+    juju-log "Database relation has not been established yet, can't write the config"
+    exit 0
+  fi
+
+  juju-log "Writing limesurvey config file $config_file_path"
+  # Write the limesurvey config
+  cat $config_tmp > $config_file_path
+  cat >> $config_file_path <<EOF
+\$sitename           =  '$(config-get site-name)';
+\$defaultlang        =  '$(config-get default-lang)';
+\$siteadminemal      =  '$(config-get admin-email)';
+\$siteadminbounce    =  '$(config-get admin-bounce)';
+\$siteadminname      =  '$(config-get admin-name)';
+\$emailmethod        =  '$(config-get mail-method)';
+\$emailsmtphost      =  '$(config-get mail-smtp-host)';
+\$emailsmtpuser      =  '$(config-get mail-smtp-user)';
+\$emailsmtppassword  =  '$(config-get mail-smtp-password)';
+\$emailsmtpssl       =  '$(config-get mail-smtp-ssl)';
+?>
+EOF
+
+  chmod 0644 $config_file_path
+  chown root:www-data $config_file_path
+}

=== added file 'limesurvey.yaml'
--- limesurvey.yaml	1970-01-01 00:00:00 +0000
+++ limesurvey.yaml	2011-12-07 00:02:26 +0000
@@ -0,0 +1,7 @@
+limesurvey:
+  mysql-tabletype: MyISAM
+  site-name: MyLimeSurveySite
+  default-admin-pass: password
+  admin-email: [e-mail]
+  admin-bounce: [e-mail]
+  admin-name: Thisshouldbe Aname

=== modified file 'readme.txt'
--- readme.txt	2011-12-04 09:35:45 +0000
+++ readme.txt	2011-12-07 00:02:26 +0000
@@ -1,13 +1,24 @@
 Juju charm limesurvey
-author: Nick Barcet <[e-mail]>
-
-Example deployment
+author: Nick Barcet <[e-mail]>
+
+Example deployment:
+
+1. Setup your site specific parameters in limesurvey.yaml
+> vi limesurvey.yaml
+a list of all settable parameter with description is available using
+> juju get limesurvey
+
+2. Deployment with mysql and haproxy
 >juju bootstrap
->juju deploy service limesurvey
->juju deploy service mysql
+>juju deploy --config limesurvey.yaml limesurvey
+>juju deploy mysql
+>juju deploy haproxy
 >juju add-relation mysql limesurvey
+>juju add-relation limesurvey haproxy
+>juju expose haproxy
 
-Limesurvey should be ready to go add http://<limesurvey-machine-addr>/.
-The admin interface is at http://<limesurvey-machine-addr>/admin/ with 
-default login (admin) and password (password) that you should change as
-soon as possible.
+3. Accessing you new limesurvey survey site should be ready at 
+http://<haproxy-machine-addr>/.  To find out the public address of haproxy,
+look for it in the output of the 'juju status' command. The admin interface 
+is at http://<limesurvey-machine-addr>/admin/ with default login (admin) and 
+password (password) that you should change as soon as possible.

=== modified file 'revision'
--- revision	2011-12-04 23:58:32 +0000
+++ revision	2011-12-07 00:02:26 +0000
@@ -1,1 +1,1 @@
-8
+13