Merge lp:~jose/charms/precise/teamspeak3/1297650-fix into lp:charms/teamspeak3

[José Antonio Rey]

Added categories, icon, reformatted README to Markdown

Charmworld reports the following errors:

    err: Charms need a maintainer (See RFC2822) - Name <email>
    warn: Metadata is missing categories.
    warn: No icon.svg file.

Fixed all of them and reformatted the README to Markdown

[Charles Butler (lazypower)]

Thanks for the submission Jose!

While reviewing this merge proposal I have the following notes:

The readme is extremely light on details. There is an opportunity to improve what is here beyond moving the format to markdown. I suggest adding a boilerplate readme via charm-tools 'charm add readme' command and editing the template so you satisfy all the major subsections.

The default admin token to manage the server while grandfathered in also has an opportunity to be changed in default behavior so it's not an open attack vector. If you've got the time to invest in modifying the charm so it is more secure by default that would be a great addition here.

The icon does not conform to charm store guidelines unfortunately and should either be refactored or removed.

barring a few simple modifications, your merge is close to being landed into the charm store. Thanks again for this submission!

I'm going to mark this review as needs fixing, and when you are ready for another review be sure to click the 'request another review' button in the right hand corner.

If you have any questions about this review feel free to contact us in #juju on irc.freenode.net or email the list <email address hidden>

Thanks again!

review: Needs Fixing

[José Antonio Rey (jose)]

Ready for review!

[Charles Butler (lazypower)]

Jose,

Thanks for the quick turn around on this. There's a problem with this MP however. By deleting configuration values, this breaks backwords compatibility. They need to remain in the config.yaml, and be noted that they are deprecated in the description.

Thanks again for the submission. I'm going to change status of this MP to "needs work" and when you're ready for another review please click the "Request another review" button in the upper right hand corner of the commit message.

If you have any questions/comments/concerns about the review contact us in #juju on irc.freenode.net or email the mailing list <email address hidden>

review: Needs Fixing

[José Antonio Rey (jose)]

Fixed!

[Charles Butler (lazypower)]

+1 LGTM

review: Approve

=== removed file 'README'
--- README	2011-11-28 22:33:36 +0000
+++ README	1970-01-01 00:00:00 +0000
@@ -1,5 +0,0 @@
-Please read the TeamSpeak License Agreement file before deploying the charm.
-
-After deployed you can access the new service with the TeamSpeak client downloaded from <http://www.teamspeak.com/?page=downloads>.
-
-The default administration token is "admintoken" (no quote marks), you will be then able to create users and configure your new server.
 
=== added file 'README.md'
--- README.md	1970-01-01 00:00:00 +0000
+++ README.md	2014-05-01 15:45:20 +0000
@@ -0,0 +1,32 @@
+# Overview
+
+Please read the TeamSpeak License Agreement file before deploying the charm.
+
+# Usage
+
+In order to deploy TeamSpeak 3, first bootstrap your environment:
+
+    juju bootstrap
+
+Then, deploy TeamSpeak 3:
+
+    juju deploy teamspeak3
+
+Finally, expose your service:
+
+    juju expose teamspeak3
+
+After deployed you can access the new service with the
+[TeamSpeak client](http://www.teamspeak.com/?page=downloads). The public address
+can be found by executing `juju status`.
+
+# Configuration
+
+The only configuration option this charm has is the port the server will be
+running at. By default, this port is 9987.
+
+# Contact Information
+
+## Upstream Project Name
+
+- [TeamSpeak 3 website](http://teamspeak.com/?page=teamspeak3)
 
=== modified file 'config.yaml'
--- config.yaml	2012-01-28 01:11:44 +0000
+++ config.yaml	2014-05-01 15:45:20 +0000
@@ -1,17 +1,17 @@
 options:
+  port:
+    default: 9987
+    type: int
+    description: Port to run server at.
   administrator:
-    default: serveradmin
+    default: ""
     type: string
     description: Username of the administrator of the server.
   administrator-secret:
-    default: serveradmin
+    default: ""
     type: string
     description: Default administrator login password.
-  port:
-    default: 9987
-    type: int
-    description: Port to run server at.
   admin-token:
-    default: admintoken
+    default: ""
     type: string
     description: Token necessary for the initial configuration of the server.
 
=== modified file 'hooks/config-changed'
--- hooks/config-changed	2011-11-29 21:08:14 +0000
+++ hooks/config-changed	2014-05-01 15:45:20 +0000
@@ -1,6 +1,6 @@
 #!/bin/sh
 
-set -ux
+set -eux
 
 LOCAL_DB_FILE="/opt/teamspeak3-server/ts3server.sqlitedb"
 LOCAL_PID_FILE="/opt/teamspeak3-server/ts3server.pid"
@@ -10,9 +10,16 @@
 fi
 
 PORT=`config-get port`
-if [ ! -z "$PORT" ]; then
-	sqlite3 /opt/teamspeak3-server/ts3server.sqlitedb "UPDATE servers SET server_port='$PORT' WHERE server_id='1'"
-	open-port "$PORT"/TCP
+if [ ! -f .port ] && [ "$PORT" != "9987" ]; then
+	sqlite3 /opt/teamspeak3-server/ts3server.sqlitedb "UPDATE servers SET server_port='$PORT' WHERE server_id='1'"
+	open-port "$PORT"/UDP
+    echo "$PORT" > .port
+elif [ -f .port ] && [ "$PORT" != `cat .port` ]; then
+    CURPORT=`cat .port`
+	sqlite3 /opt/teamspeak3-server/ts3server.sqlitedb "UPDATE servers SET server_port='$PORT' WHERE server_id='1'"
+    close-port "$CURPORT"/UDP
+    open-port "$PORT"/UDP
+    echo "$PORT" > .port
 fi
 
 if [ -f "$LOCAL_PID_FILE" ]; then
 
=== modified file 'hooks/install'
--- hooks/install	2011-11-30 19:43:51 +0000
+++ hooks/install	2014-05-01 15:45:20 +0000
@@ -1,27 +1,28 @@
 #!/bin/sh
 
+set -eux
+
 juju-log "Installing dependencies"
 apt-get install -y sqlite3 wget
 
-if [ ! -d "charm-tools" ]; then
-    juju-log "Installing charm-helpers vis charm-tools"
-    bzr branch lp:charm-tools
-fi
+add-apt-repository -y ppa:charmers/charm-helpers
+apt-get update
+apt-get install -y charm-helper-sh
 
-. "charm-tools/helpers/sh/net.sh"
+. /usr/share/charm-helper/sh/net.sh
 
 
 juju-log "Downloading latest teamspeak server..."
 
 TYPE=$(uname -m)
 if [ "$TYPE" = "x86_64" ]; then
-    DOWNLOAD=`ch_get_file "http://teamspeak.gameserver.gamed.de/ts3/releases/3.0.1/teamspeak3-server_linux-amd64-3.0.1.tar.gz" "0253fb6eabbd7e1c83414babb4b145be"`
+    DOWNLOAD=`ch_get_file "http://teamspeak.gameserver.gamed.de/ts3/releases/3.0.10.3/teamspeak3-server_linux-amd64-3.0.10.3.tar.gz" "dbc550a00be56a384f7e5768105cf334"`
     if [ ! -f "$DOWNLOAD" ]; then
         juju-log "Something went terribly wrong while getting the right file, aborting."
 	exit 1
     fi
 else
-    DOWNLOAD=`ch_get_file "http://teamspeak.gameserver.gamed.de/ts3/releases/3.0.1/teamspeak3-server_linux-x86-3.0.1.tar.gz" "a81c79b18185eb2bfa6e1b881a502a2a"`
+    DOWNLOAD=`ch_get_file "http://teamspeak.gameserver.gamed.de/ts3/releases/3.0.10.3/teamspeak3-server_linux-x86-3.0.10.3.tar.gz" "7555abaedb3d398b54d40e75da618871"`
         if [ ! -f "$DOWNLOAD" ]; then
         juju-log "Something went terribly wrong while getting the right file, aborting."
 	exit 1
@@ -38,6 +39,6 @@
 
 juju-log "Configuring server and starting database with default values"
 service teamspeak3 init_db
-open-port 9987/TCP
+open-port 9987/UDP
 
 juju-log "Installation complete!"
 
=== modified file 'metadata.yaml'
--- metadata.yaml	2011-11-28 22:33:36 +0000
+++ metadata.yaml	2014-05-01 15:45:20 +0000
@@ -11,3 +11,8 @@
   small businesses cutting costs on long distance charges, or for
   personal communication with friends and family.  This package contains
   the server daemon.
+categories:
+  - applications
+provides:
+  teamspeak3:
+    interface: teamspeak3