Merge lp:~jose/charms/precise/tracks/fixes into lp:charms/tracks

[José Antonio Rey]

 * Converted the README to Markdown
 * Added support to change the port number if it's already been configured

[Cory Johns (johnsca)]

Jose,

Thank you very much for your contribution to this charm. Unfortunately, I was unable to deploy the charm, so I was unable to properly test your changes, though the error doesn't seem to be related to your changes here. The error I got was:

    INFO install Errno::ENOENT: No such file or directory - /Users/eweaver/p/configuration/gem_certificates/evan_weaver-original-private_key.pem
    INFO install An error occurred while installing has_many_polymorphs (2.13), and Bundler
    INFO install cannot continue.
    INFO install Make sure that `gem install has_many_polymorphs -v '2.13'` succeeds before
    INFO install bundling.
    ERROR juju.worker.uniter uniter.go:490 hook failed: exit status 5

I tried on two different environments and got the same error. If you were able to deploy the charm, was there anything you did differently to avoid this error?

Regarding your changes, they seem good, though I would suggest that you add indentation for the if blocks in the config-changed and db-relation-changed hooks, to make them more readable.

Again, thank you for this improvement, and if you can assist me getting this deployed, I can test it to give it my +1.

[Cory Johns (johnsca)]

review: Needs Information

[Marco Ceppi (marcoceppi)]

Moved to "work in progress" pending feedback, once ready for another review please move to "Needs Review"

[José Antonio Rey (jose)]

Cory,

Googling a bit, this is a problem that has already been reported (see bug #1155358), and looks like some gems that ship with tracks are broken. We will need to figure out if there is some workaround for this first, I'll make sure to take a look into it soon.

[José Antonio Rey (jose)]

Charm now goes in the right track - fixed the errors and it should be good to go.

[lp:~jose/charms/precise/tracks/fixes]

9. By José Antonio Rey on 2014-05-07

Fixed some bugs, still need to fix upstart job

10. By José Antonio Rey on 2014-05-08

Fixed all errors, ready for review

[Cory Johns (johnsca)]

José,

Thanks so much for these improvements! This charm is so much more robust and secure for these changes!

However, I noticed an issue regarding the port handling: if you set the port to a small number initially, a log message indicating that the port is not allowed is recorded, but the upstart script is still created with the low-numbered port. Further, if you set the port to a high-numbered port and then later change the port number, because the .portnotsupported file doesn't exist, the the port check is skipped entirely and the port is not changed.

I think that the .portnotsupported file check can be removed entirely, and the port check in the install script should be moved down to wrap the creation of the upstart conf, with an else clause to remove the conf if it exists. The existing service will also need to be stopped before the upstart conf is changed or removed and restarted after the new conf is in place (though, there's also the database to consider, so there might need to be a .db-configured marker file or something, that is checked before starting the service from hooks/install).

Additionally, to allow this to work with a reverse proxy, as is the intention, I believe the website-relation-joined hook must be added, but I think it can be a simple boiler-plate hook, such as: http://pastebin.ubuntu.com/7412868/

Lastly, I had a question regarding the db-relation-changed hook: do you know if it matters if rake db:migrate is called multiple times? If it does, then that hook isn't idempotent and needs a check, but since the original hook doesn't have that, maybe it doesn't matter if it's called again.

[lp:~jose/charms/precise/tracks/fixes]

11. By José Antonio Rey on 2014-05-08

Fixed some bugs

12. By José Antonio Rey on 2014-05-08

Fixed a problem with ports check

[José Antonio Rey (jose)]

Hey Cory,

Fixed as discussed on IRC.

Thank you!

[lp:~jose/charms/precise/tracks/fixes]

13. By José Antonio Rey on 2014-05-08

Fixed redundancy

14. By José Antonio Rey on 2014-05-08

Fixed problem with brackets and non-executable website-relation-joined hook

15. By José Antonio Rey on 2014-05-08

Fixed port-changing blocker

[Cory Johns (johnsca)]

One small issue remaining: http://pastebin.ubuntu.com/7422057/

Looks like [[ "$PORT" < 1025 ]] should be [[ "$PORT" -lt 1025 ]]

[lp:~jose/charms/precise/tracks/fixes]

16. By José Antonio Rey on 2014-05-12

Changed < for -lt

[Cory Johns (johnsca)]

José,

Thank you very much for working with me to get this charm fixed, since it turned out to be broken upstream. With your changes, not only does the charm work again, but it is more secure (no longer running as root) and robust (using upstart, working with reverse proxy charms, etc). Excellent work!

I definitely give this MP my +1 and it should be merged by a charmer soon.

review: Approve (+1)

[Charles Butler (lazypower)]

Jose, thanks for the submission!

I've reviewed the associated content and everything seems to be in order. +1 and merging.

Keep up the great work!

review: Approve

=== removed file 'README'
--- README	2013-02-21 03:31:54 +0000
+++ README	1970-01-01 00:00:00 +0000
@@ -1,21 +0,0 @@
-Tracks is a Ruby on Rails based web service that helps you to manage to 
-do lists and get things done (GTD). Tracks is based on David Allen's Get
-Things Done (TM) methodology.
-
-To deploy:
-    juju bootstrap
-    juju deploy tracks
-    juju deploy mysql
-    juju add-relation mysql tracks
-    juju expose tracks
-
-    Then do a `juju status` to determine the IP of the service, 
-    and just open it in your browser. On the initial screen you can 
-    create your user, then sign-in and begin using Tracks. This charm
-    offers one configuration option, the port on which to run the web
-    server, default is 80. Tracks uses a built-in webserver, WEBrick.
-
-Links:
-
-- Homepage: http://getontracks.org/
-- Code: https://github.com/TracksApp/tracks

=== added file 'README.md'
--- README.md	1970-01-01 00:00:00 +0000
+++ README.md	2014-05-12 19:08:21 +0000
@@ -0,0 +1,40 @@
+# Overview
+
+Tracks is a Ruby on Rails based web service that helps you to manage to do lists
+and get things done (GTD). Tracks is based on David Allen's Get Things Done (TM)
+methodology.
+
+Please note that this charm uses the brightbox/ruby-ng PPA in order to get a
+newer version of Ruby.
+
+# Usage
+
+To deploy:
+
+     juju bootstrap
+     juju deploy tracks
+     juju deploy mysql
+     juju add-relation mysql tracks
+     juju expose tracks
+
+Then do a `juju status` to determine the IP of the service, and just open it in
+your browser. On the initial screen you can create your user, then sign-in and
+begin using Tracks. It uses a built-in webserver, WEBrick.
+
+## Configuration
+
+This charm offers one configuration option, the port on which to run the web
+server, default is 3000. At this point, it can not be ran in a port minor to
+1025. If you set a port lower or equal to 1024, it will refuse to install
+until you change it. If you want to use port 80, for example, you can add a
+reverse proxy server, such as haproxy (also available in Juju).
+
+# Known Limitations
+
+As mentioned in the configuration part, the charm does not currently allow a
+port number lower than 1025.
+
+# Links
+
+- Homepage: <http://getontracks.org/>
+- Code: <https://github.com/TracksApp/tracks>

=== modified file 'config.yaml'
--- config.yaml	2012-11-27 22:20:45 +0000
+++ config.yaml	2014-05-12 19:08:21 +0000
@@ -1,5 +1,5 @@
 options:
     port:
         type: int
-        default: 80
+        default: 3000
         description: The port number for the tracks webserver

=== added file 'hooks/config-changed'
--- hooks/config-changed	1970-01-01 00:00:00 +0000
+++ hooks/config-changed	2014-05-12 19:08:21 +0000
@@ -0,0 +1,31 @@
+#!/bin/bash
+
+set -eux
+
+PORT=`config-get port`
+
+if [[ "$PORT" -lt 1025 ]]; then
+    juju-log "At this time, ports minor than 1024 are not supported. Please, change your port number."
+    exit 0
+fi
+
+if [[ -f .portnotsupported ]] &&  [[ "$PORT" -lt 1024 ]]; then
+    juju-log "Yay, you've set a valid port now. Installing!"
+    hooks/install
+    rm .portnotsupported
+fi
+
+if [ -f .port ] && [ `cat .port` != "${PORT}" ]; then
+    currentport=`cat .port`
+    juju-log "Switching port to ${PORT}"
+    close-port ${currentport}/tcp
+    open-port ${PORT}/tcp
+    echo "${PORT}" > .port
+    if [ -f .started ]; then
+        stop tracksapp
+    fi
+    sed -i "s/$currentport/$PORT/" /etc/init/tracksapp.conf
+    if [ -f .started ]; then
+        start tracksapp
+    fi
+fi

=== modified file 'hooks/db-relation-changed'
--- hooks/db-relation-changed	2012-11-25 02:33:40 +0000
+++ hooks/db-relation-changed	2014-05-12 19:08:21 +0000
@@ -17,30 +17,44 @@
 juju-log "Retrieved hostname: $hostname"
 
 juju-log "configuring database.yml to use ${database}"
-cat > tracks/config/database.yml << EOF
+cat > /home/tracks/tracks/config/database.yml << EOF
 production:
-  adapter: mysql
+  adapter: mysql2
   database: tracks
   host: ${mysqlhost}
   username: ${user}
   password: ${password}
 EOF
 
-juju-log "stopping old instances"
-# XXX make this grep line more specific
-PID=`ps -ef | grep "ruby script/server" | grep -v grep | awk '{ print $2 }'`
-if [[ ! -z ${PID} ]]; then
-    kill ${PID} || true
+if [ -f .started ]; then
+    juju-log "stopping old instances"
+    stop tracksapp
+    rm .started
 fi
 
 juju-log "db:migrate"
 juju-log `pwd`
-cd tracks
+cd /home/tracks/tracks
 bundle exec rake db:migrate RAILS_ENV=production
 
 PORT=`config-get port`
-juju-log "Opening port ${PORT}"
-open-port ${PORT}/tcp
-
-juju-log "Starting Tracks"
-bundle exec script/server -e production -p 80
+if [ ! -f $CHARM_DIR/.port ]; then
+    juju-log "Opening port ${PORT}"
+    open-port ${PORT}/tcp
+    echo "${PORT}" > $CHARM_DIR/.port
+elif [ -f $CHARM_DIR/.port ] && [ `cat $CHARM_DIR/.port` != "${PORT}" ]; then
+    currentport=`cat $CHARM_DIR/.port`
+    juju-log "Switching port to ${PORT}"
+    close-port ${currentport}/tcp
+    open-port ${PORT}/tcp
+    echo "${PORT}" > $CHARM_DIR/.port
+fi
+
+juju-log "Setting necessary permissions"
+chown -hR tracks /home/tracks/tracks
+
+if [ ! -f .started ]; then
+    juju-log "Starting Tracks"
+    start tracksapp
+    touch $CHARM_DIR/.started
+fi

=== modified file 'hooks/install'
--- hooks/install	2013-02-21 03:31:54 +0000
+++ hooks/install	2014-05-12 19:08:21 +0000
@@ -5,17 +5,29 @@
 
 set -eux
 
+PORT=`config-get port`
+
+juju-log "Checking if port is >1024"
+if [[ "$PORT" -lt 1025 ]]; then
+    juju-log "At this point, the use of ports minor than 1025 are not supported. Please, change your port number."
+    touch .portnotsupported
+    exit 0
+fi
+
+juju-log "creating user tracks"
+useradd -rm tracks
+
 juju-log "installing pre-reqs"
+add-apt-repository ppa:brightbox/ruby-ng -y
 apt-get update
-apt-get install -qqy unzip ruby-full build-essential libmysqlclient-dev \
+apt-get install -qqy unzip ruby2.1 build-essential libmysqlclient-dev \
 libruby sqlite3 libmysql-ruby libmysql-ruby libsqlite3-ruby libsqlite3-dev \
 imagemagick graphicsmagick libgraphicsmagick1-dev librmagick-ruby \
-libxslt-dev libxml2-dev pwgen rubygems mysql-client wget
+libxslt-dev libxml2-dev pwgen rubygems mysql-client wget ruby2.1-dev
 
 juju-log "installing tracks"
-wget -O tracks.zip https://github.com/TracksApp/tracks/zipball/v2.1
-unzip tracks.zip
-mv TracksApp-tracks-* tracks
+cd /home/tracks/
+git clone https://github.com/TracksApp/tracks -b 2.2_branch
 cd tracks
 chmod -R 664 *
 find -type d -exec chmod a+x '{}' \;
@@ -23,8 +35,6 @@
 
 juju-log "installing bundler & rake"
 gem install --source https://rubygems.org/ bundler rake
-juju-log "correcting gemfile source"
-sed -i 's/http:\/\/gems.github.com/https:\/\/rubygems.org/' Gemfile
 juju-log "installing bundles"
 bundle install --without=test
 
@@ -37,3 +47,23 @@
 
 juju-log "fixing htaccess"
 mv public/.htaccess public/dontneedhtaccess
+
+juju-log "fixing error in prod env config"
+sed -i "s/config.assets.compile \= false/config.assets.compile \= true/" config/environments/production.rb
+
+juju-log "creating upstart job"
+cat > /etc/init/tracksapp.conf << EOF
+env FOLDER=/home/tracks/tracks
+env PORT=$PORT
+
+setuid tracks
+
+pre-start script
+chdir \$FOLDER
+end script
+
+script
+chdir \$FOLDER
+bundle exec rails server -e production -p \$PORT
+end script
+EOF

=== modified file 'hooks/stop'
--- hooks/stop	2012-11-25 02:33:40 +0000
+++ hooks/stop	2014-05-12 19:08:21 +0000
@@ -1,8 +1,7 @@
 #!/bin/bash
-juju-log "Stopping Tracks"
-PID=`ps -ef | grep "bundle exec" | grep -v grep | awk '{ print $2 }'`
-if [[ ! -z ${PID} ]]; then
-    kill ${PID} || true
+if [ -f .started ]; then
+    juju-log "Stopping Tracks"
+    stop tracksapp
 fi
 PORT=`config-get port`
 juju-log "Closing port ${PORT}"

=== added file 'hooks/website-relation-joined'
--- hooks/website-relation-joined	1970-01-01 00:00:00 +0000
+++ hooks/website-relation-joined	2014-05-12 19:08:21 +0000
@@ -0,0 +1,2 @@
+#!/bin/bash
+relation-set hostname=`unit-get private-address` port=`config-get port`

=== modified file 'metadata.yaml'
--- metadata.yaml	2012-11-27 22:20:45 +0000
+++ metadata.yaml	2014-05-12 19:08:21 +0000
@@ -6,6 +6,8 @@
 
     This setup uses a mysql instance and the built-in webserver.
 maintainer: Matt Fischer <[e-mail]>
+categories:
+  - applications
 requires:
     db:
         interface: mysql