Merge lp:~james-page/charms/oneiric/etherpad-lite/rocks into lp:charms/oneiric/etherpad-lite

[James Page]

This update is a major refresh of the etherpad-lite charm.

Fixes in this:

1) Make it work - it was broken and ep-lite would not start
   The charm now uses a know good upstream commit inconjunction
   with Chris Lea's nodejs and npm PPA
2) Make mysql work - not sure how that ever worked but it does now

Improvements

1) Move to -common model with symlinks - I much prefer this style
2) README!
3) Config - you can now choose a commit, branch or tag from upstream github to use

[Mark Mims (mark-mims)]

review: Approve

=== added file 'README.rst'
--- README.rst	1970-01-01 00:00:00 +0000
+++ README.rst	2012-03-30 17:15:34 +0000
@@ -0,0 +1,60 @@
+====================
+Etherpad Lite Rocks!
+====================
+
+Overview
+--------
+
+Etherpad lite is a really-real time collaborative editor spawned from the
+Hell fire of Etherpad. It reuses the well tested Etherpad easysync library
+to make it really realtime.
+
+Etherpad Lite is based on node.js ergo is much lighter and more stable than
+the original Etherpad. Our hope is that this will encourage more users to
+use and install a realtime collaborative editor.
+
+A smaller, manageable and well documented codebase makes it easier for
+developers to improve the code and contribute towards the project.
+
+Etherpad Lite is optimized to be eddasy embeddable. It provides a HTTP API
+that allows your web application to manage pads, users and groups. There
+are several clients in for this API:
+
+ * PHP, thx to TomNomNom
+ * .Net, thx to ja-jo
+ * Node.js, thx to tomassedovic
+ * Ruby, thx to jhollinger
+ * Python, thx to devjones
+
+There is also a jQuery plugin that helps you to embed Pads into your website
+
+For more information see https://github.com/Pita/etherpad-lite.
+
+Usage
+-----
+
+Etherpad will happily sit on single server::
+
+   juju deploy etherpad-lite
+
+but it can also be backed by mysql::
+
+   juju deploy mysql
+   juju add-relation etherpad-lite mysql
+
+Note that if you switch an existing etherpad-lite instance to use mysql you will
+lose all of the pads within your standalone deployment - same applies
+vica-versa.
+
+You can change the upstream commit tag for etherpad-lite by using charm config
+either in a yaml file::
+
+    etherpad-lite:
+        commit: 1.0
+
+or::
+
+    juju set etherpad-lite commit=cfb58a80a30486156a15515164c9c0f4647f165b
+
+This can be changed for an existing service as well - allowing you to upgrade to
+a newer (potentially broken!) version.

=== added file 'config.yaml'
--- config.yaml	1970-01-01 00:00:00 +0000
+++ config.yaml	2012-03-30 17:15:34 +0000
@@ -0,0 +1,9 @@
+options:
+  commit:
+    default: cfb58a80a30486156a15515164c9c0f4647f165b
+    type: string
+    description: |
+      Commit from http://github.com/Pita/etherpad-lite to use.  This
+      could also refer to a branch (master) or a tag (1.1).
+      .
+      Default is one that is know to work with this charm.

=== removed file 'hooks/config'
--- hooks/config	2011-07-28 14:49:19 +0000
+++ hooks/config	1970-01-01 00:00:00 +0000
@@ -1,7 +0,0 @@
-# Common configuration for all scripts
-app_name="etherpad-lite"
-app_dir="/opt/${app_name}"
-app_user="ubuntu"
-app_scm="git"
-app_url="https://github.com/Pita/etherpad-lite.git"
-app_branch="master"

=== added symlink 'hooks/config-changed'
=== target is u'ep-common'
=== renamed file 'hooks/mysqldb-relation-broken' => 'hooks/db-relation-broken'
--- hooks/mysqldb-relation-broken	2011-09-28 12:53:35 +0000
+++ hooks/db-relation-broken	1970-01-01 00:00:00 +0000
@@ -1,14 +0,0 @@
-#!/bin/bash
-
-set -eu # -x for verbose logging to juju debug-log
-
-[[ -f "$(dirname $0)/config" ]] && source "$(dirname $0)/config"
-
-juju-log "configuring ${app_name} to work with dirty"
-
-config_file_path=$app_dir/settings.json
-
-cp $(dirname $0)/ep-config/settings.json.dirty $config_file_path
-
-juju-log "(Re)starting app ${app_name}"
-restart ${app_name} || start ${app_namxme}

=== target is u'ep-common'
=== renamed file 'hooks/mysqldb-relation-changed' => 'hooks/db-relation-changed'
--- hooks/mysqldb-relation-changed	2011-09-26 16:32:02 +0000
+++ hooks/db-relation-changed	1970-01-01 00:00:00 +0000
@@ -1,33 +0,0 @@
-#!/bin/bash
-
-set -eu # -x for verbose logging to juju debug-log
-
-[[ -f "$(dirname $0)/config" ]] && source "$(dirname $0)/config"
-
-# Get the database settings; if not set, wait for this hook to be
-# invoked again
-host=`relation-get host`
-if [ -z "$host" ] ; then
-    exit 0 # wait for future handshake from database service unit
-fi
-
-# Get rest of mysql setup
-user=`relation-get user`
-password=`relation-get password`
-database=`relation-get database`
-
-juju-log "configuring ${app_name} to work with the mysql service"
-
-config_file_path=$app_dir/settings.json
-
-cp $(dirname $0)/ep-config/settings.json.mysql $config_file_path
-if [ -f $config_file_path ]; then
-  juju-log "Writing $app_name config file $config_file_path"
-  sed -i "s/DB_USER/${user}/g" $config_file_path
-  sed -i "s/DB_HOST/${host}/g" $config_file_path
-  sed -i "s/DB_PASS/${password}/g" $config_file_path
-  sed -i "s/DB_NAME/${database}/g" $config_file_path
-fi
-
-juju-log "(Re)starting app ${app_name}"
-restart ${app_name} || start ${app_namxme}

=== target is u'ep-common'
=== added symlink 'hooks/db-relation-joined'
=== target is u'ep-common'
=== added file 'hooks/ep-common'
--- hooks/ep-common	1970-01-01 00:00:00 +0000
+++ hooks/ep-common	2012-03-30 17:15:34 +0000
@@ -0,0 +1,165 @@
+#!/bin/bash
+
+set -e
+
+# Common configuration for all scripts
+app_name="etherpad-lite"
+app_dir="/opt/${app_name}"
+app_user="ubuntu"
+app_scm="git"
+app_url="https://github.com/Pita/etherpad-lite.git"
+app_branch="master"
+
+umask 002
+
+start_ep () {
+    start ${app_name} || :
+}
+
+stop_ep () {
+    stop ${app_name} || :
+}
+
+restart_ep () {
+    restart ${app_name} || start ${app_name}
+}
+
+install_node () {
+    juju-log "Installing node..."
+    add-apt-repository ppa:chris-lea/node.js
+    apt-get update
+    apt-get -y install -qq nodejs nodejs-dev build-essential npm curl
+}
+
+install_ep () {
+    juju-log "Installing ${app_name}..."
+    apt-get -y install -qq git-core daemon gzip abiword
+    if [ ! -d ${app_dir} ]; then
+        git clone ${app_url} ${app_dir} -b ${app_branch}
+    fi
+}
+
+update_ep () {
+    juju-log "Updating ${app_nane}..."
+    if [ -d ${app_dir} ]; then
+    (
+        cd ${app_dir}
+        git checkout master
+        git pull
+        git checkout $(config-get commit)
+        npm install
+    )
+    fi
+
+    # Modifiy the app so $app_user can write to it 
+    # needed as starts up with a dirty database
+    chown -Rf ${app_user}.${app_user} ${app_dir}
+}
+
+install_upstart_config () {
+    juju-log "Installing upstart configuration for etherpad-lite"
+    cat > /etc/init/${app_name}.conf <<EOS
+description "${app_name} server"
+ 
+start on runlevel [2345]
+stop on runlevel [!2345]
+
+limit nofile 8192 8192
+
+pre-start script
+  touch /var/log/${app_name}.log || true
+  chown ${app_user}:${app_user} /var/log/${app_name}.log || true
+end script
+
+script
+  exec daemon --name=${app_name} --inherit --user=${app_user} --output=/var/log/${app_name}.log \
+    -- ${app_dir}/bin/run.sh 
+end script
+EOS
+}
+
+configure_dirty_ep () {
+    juju-log "Configurating ${app_name} with default dirty database..."
+    cp templates/settings.json.dirty /opt/${app_name}/settings.json
+}
+
+configure_mysql_ep () {
+    # Get the database settings; if not set, wait for this hook to be
+    # invoked again
+    host=`relation-get host`
+    if [ -z "$host" ] ; then
+        exit 0 # wait for future handshake from database service unit
+    fi
+
+    # Get rest of mysql setup
+    user=`relation-get user`
+    password=`relation-get password`
+    database=`relation-get database`
+
+    juju-log "configuring ${app_name} to work with the mysql service"
+
+    config_file_path=$app_dir/settings.json
+
+    cp templates/settings.json.mysql $config_file_path
+    if [ -f $config_file_path ]; then
+      juju-log "Writing $app_name config file $config_file_path"
+      sed -i "s/DB_USER/${user}/g" $config_file_path
+      sed -i "s/DB_HOST/${host}/g" $config_file_path
+      sed -i "s/DB_PASS/${password}/g" $config_file_path
+      sed -i "s/DB_NAME/${database}/g" $config_file_path
+    fi
+}
+
+configure_website () {
+    juju-log "Setting relation parameters for website..."
+    relation-set port="9001" hostname=`unit-get private-address`
+}
+
+open_ports () {
+    juju-log "Opening ports for access to ${app_name}"
+    open-port 9001
+}
+
+COMMAND=`basename $0`
+
+
+case $COMMAND in
+    install)
+        install_node
+        install_ep
+        update_ep
+        install_upstart_config
+        configure_dirty_ep
+        ;;
+    start)
+        start_ep
+        open_ports
+        ;;
+    stop)
+        stop_ep
+        ;;
+    upgrade-charm)
+        install_node
+        update_ep
+        install_upstart_config
+        restart_ep
+        ;;
+    config-changed)
+        update_ep
+        restart_ep
+        ;;
+    website-relation-joined)
+        configure_website
+        ;;
+    db-relation-joined|db-relation-changed)
+        configure_mysql_ep 
+        restart_ep
+        ;;
+    db-relation-broken)
+        configure_dirty_ep
+        restart_ep
+        ;; 
+    *)
+        juju-log "Command not recognised"
+        ;;
+esac

=== modified file 'hooks/install'
--- hooks/install	2012-02-09 21:53:32 +0000
+++ hooks/install	1970-01-01 00:00:00 +0000
@@ -1,71 +0,0 @@
-#!/bin/bash
-
-set -eu # -x for verbose logging to juju debug-log
-umask 002
-
-[[ -f "$(dirname $0)/config" ]] && source "$(dirname $0)/config"
-
-install_node() {
-  juju-log "Installing node..."
-  apt-get -y install -qq nodejs nodejs-dev build-essential
-}
-[[ -x /usr/bin/node ]] || install_node
-
-install_npm() {
-  juju-log "Installing npm..."
-  apt-get -y install -qq git-core
-  git clone https://github.com/isaacs/npm /tmp/npm -b 0.2
-  cd /tmp/npm && node cli.js install
-}
-[[ -x /usr/bin/npm ]] || install_npm
-
-install_app() {
-  juju-log "Installing ${app_name}..."
-  apt-get -y install -qq git-core daemon gzip abiword
-  # Grab 1.0 of etherpad
-  git clone ${app_url} ${app_dir} -b ${app_branch}
-  cd ${app_dir} && git checkout 1.0
-
-  if [ -f ${app_dir}/package.json ]; then
-	# Install ep-lite deps
-    cd ${app_dir} && npm install 
-  fi
-
-  # Modifiy the app so $app_user can write to it 
-  # needed as starts up with a dirty database
-  chown -Rf ${app_user}.${app_user} ${app_dir}
-
-  cat > /etc/init/${app_name}.conf <<EOS
-description "${app_name} server"
- 
-start on runlevel [2345]
-stop on runlevel [!2345]
-
-limit nofile 8192 8192
-
-pre-start script
-  touch /var/log/${app_name}.log || true
-  chown ${app_user}:${app_user} /var/log/${app_name}.log || true
-end script
-
-script
-  exec daemon --name=${app_name} --inherit --user=${app_user} --output=/var/log/${app_name}.log \
-    -- ${app_dir}/bin/run.sh 
-end script
-EOS
-}
-[[ -d ${app_dir} ]] || install_app
-
-configure_app() {
-    juju-log "Configurating ${app_name} with default dirty database..."
-    # TODO: add hook to configure default text in this function
-    cp $(dirname $0)/ep-config/settings.json.dirty /opt/${app_name}/settings.json
-}
-
-# always configure application - defaults to node dirty < 1M records
-configure_app
-
-# Open Port for Access to Application - it will run on dirty so if good from the start
-open-port 9001
-
-juju-log "Delaying app external db config (mysqldb might join)" 

=== target is u'ep-common'
=== modified file 'hooks/start'
--- hooks/start	2011-07-28 14:49:19 +0000
+++ hooks/start	1970-01-01 00:00:00 +0000
@@ -1,6 +0,0 @@
-#!/bin/bash
-
-[[ -f "$(dirname $0)/config" ]] && source "$(dirname $0)/config"
-
-start ${app_name}
-

=== target is u'ep-common'
=== modified file 'hooks/stop'
--- hooks/stop	2011-07-28 14:49:19 +0000
+++ hooks/stop	1970-01-01 00:00:00 +0000
@@ -1,6 +0,0 @@
-#!/bin/bash
-
-[[ -f "$(dirname $0)/config" ]] && source "$(dirname $0)/config"
-
-stop ${app_name}
-

=== target is u'ep-common'
=== added symlink 'hooks/upgrade-charm'
=== target is u'ep-common'
=== modified file 'hooks/website-relation-joined'
--- hooks/website-relation-joined	2011-10-12 06:19:57 +0000
+++ hooks/website-relation-joined	1970-01-01 00:00:00 +0000
@@ -1,5 +0,0 @@
-#!/bin/sh
-
-app_port=9001
-
-relation-set port=$app_port hostname=`unit-get private-address`

=== target is u'ep-common'
=== modified file 'metadata.yaml'
--- metadata.yaml	2011-10-12 06:19:57 +0000
+++ metadata.yaml	2012-03-30 17:15:34 +0000
@@ -1,4 +1,3 @@
-ensemble: formula
 name: etherpad-lite
 summary: "Etherpad Lite"
 description: "Collaborative document sharing for the Internet"

=== modified file 'revision'
--- revision	2012-02-09 22:29:36 +0000
+++ revision	2012-03-30 17:15:34 +0000
@@ -1,1 +1,1 @@
-8
+21

=== renamed directory 'hooks/ep-config' => 'templates'