Merge lp:~marcoceppi/charm-tools/unit-parsing into lp:~charmers/charm-tools/trunk

[Marco Ceppi]

I've added a few basic tools for unit/service name parsing. I've noticed that peer.sh has unit-based name stuff. This merge is more a review if these kinds of tools (ch_get_my_id, ch_get_unit_id) from peer.sh and the new ones in unit.sh should be a part of charm-helpers.

I'm also uncertain of how to carry copyright over, as such I've moved the code and placed both Canonical and myself as the Copyright holder.

[Juan L. Negron (negronjl)]

Hi Marco:

Thanks for the updates....

This will help in my hacking :)

It looks good to me.

-Juan

review: Approve

[lp:~marcoceppi/charm-tools/unit-parsing]

135. By Marco Ceppi on 2012-05-07

Fixed hardcoded paths

136. By Marco Ceppi on 2012-05-07

Fixed hardcoded paths

137. By Marco Ceppi on 2012-05-07

Added unit test

[Clint Byrum (clint-fewbar)]

Marco this looks great. However, can you explain why there is a ch_unit_name and ch_service_name ? ch_unit_name seems misleading.

review: Needs Information

[Marco Ceppi (marcoceppi)]

Thanks Clint,

ch_unit_name and ch_service_name are the same command, ch_unit_name exists to follow the same pattern as `ch_unit_id` which existed prior to this unit.sh. ch_service_name exists as it's a better name. I guess the goal was to have a naming sequence that followed what existed previously and one that makes more sense. If it's too redundant I can easily remove the ch_unit_name as it's less logical sounding than ch_service_name.

Thanks!
Marco

=== modified file 'helpers/sh/peer.sh'
--- helpers/sh/peer.sh	2012-01-18 23:53:48 +0000
+++ helpers/sh/peer.sh	2012-05-07 16:45:21 +0000
@@ -18,6 +18,8 @@
 echo WARNING: peer functions are untested, and may provide unreliable
 echo services. Their use is experimental.
 
+. "${HELPERS_HOME:-/usr/share/charm-helper/sh}/unit.sh"
+
 ##
 # ch_peer_i_am_leader
 # Returns 1 if the current unit is the leader
@@ -76,30 +78,6 @@
     fi
 }
 
-##
-# ch_unit_id <unit-name>
-# Returns the unit id
-#
-# Param <unit-name> is the name of the unit
-#
-# returns <unit-d> | FALSE
-ch_unit_id()
-{
-    echo "${1##*/}"
-}
-
-##
-# ch_my_unit_id
-# Returns the unit id of the current unit
-#
-# param none
-#
-# returns <unit-id> | FALSE
-ch_my_unit_id()
-{
-    echo "`ch_unit_id $JUJU_UNIT_NAME`"
-}
-
 
 ##
 # ch_peer_copy [-r|--rsync][-p <port>][-o "<opt>"] sourcepath1 destpath1 [... sourcepathN destpathN]

=== added file 'helpers/sh/unit.sh'
--- helpers/sh/unit.sh	1970-01-01 00:00:00 +0000
+++ helpers/sh/unit.sh	2012-05-07 16:45:21 +0000
@@ -0,0 +1,67 @@
+#!/bin/sh
+
+##
+# Copyright: 2012 Marco Ceppi <[e-mail]>
+# Copyright: Copyright 2011, Canonical Ltd., All Rights Reserved.
+#
+# This file is part of Charm Helpers.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+##
+
+##
+# ch_unit_name <unit>
+# Returns the unit (service) name
+#
+# Param <unit> is the name of the unit
+#
+# returns <service> | FALSE
+ch_unit_name()
+{
+	echo "${1%%/*}"
+}
+
+##
+# ch_service_name <unit>
+# Alias of ch_unit_name
+#
+# returns <service> | FALSE
+ch_service_name()
+{
+	echo "`ch_unit_name $1`"
+}
+
+##
+# ch_unit_id <unit-name>
+# Returns the unit id
+#
+# Param <unit-name> is the name of the unit
+#
+# returns <unit-d> | FALSE
+ch_unit_id()
+{
+    echo "${1##*/}"
+}
+
+##
+# ch_my_unit_id
+# Returns the unit id of the current unit
+#
+# param none
+#
+# returns <unit-id> | FALSE
+ch_my_unit_id()
+{
+    echo "`ch_unit_id $JUJU_UNIT_NAME`"
+}

=== added file 'tests/helpers/test_unit.sh'
--- tests/helpers/test_unit.sh	1970-01-01 00:00:00 +0000
+++ tests/helpers/test_unit.sh	2012-05-07 16:45:21 +0000
@@ -0,0 +1,27 @@
+#!/bin/sh
+
+if [ -z "$test_home" ] ; then
+    test_home=`dirname $0`
+    test_home=`readlink -f $test_home`
+fi
+
+[ "$LIB_SOURCED" = "1" ] || . $test_home/lib.sh
+
+set -ue
+
+JUJU_UNIT_NAME="test/9001"
+
+. $HELPERS_HOME/unit.sh
+
+start_test ch_unit_name...
+[ "`ch_unit_name $JUJU_UNIT_NAME`" = "test" ]
+[ "`ch_service_name $JUJU_UNIT_NAME`" = "test" ]
+echo PASS
+
+start_test ch_unit_id...
+[ "`ch_unit_id $JUJU_UNIT_NAME`" = "9001" ]
+echo PASS
+
+start_test ch_my_unit_id...
+[ "`ch_my_unit_id`" = "9001" ]
+echo PASS