[Bps-public-commit] r15119 - in sd/trunk: .

[spang at bestpractical.com]

Author: spang
Date: Wed Aug 13 10:39:20 2008
New Revision: 15119

Modified:
   sd/trunk/   (props changed)
   sd/trunk/lib/App/SD/Test.pm

Log:
 r48227 at loki:  spang | 2008-08-13 15:39:10 +0100
 might as well doc App::SD::Test while we're at it


Modified: sd/trunk/lib/App/SD/Test.pm
==============================================================================
--- sd/trunk/lib/App/SD/Test.pm	(original)
+++ sd/trunk/lib/App/SD/Test.pm	Wed Aug 13 10:39:20 2008
@@ -9,6 +9,15 @@
 
 $ENV{'PROPHET_APP_CONFIG'} = "t/prophet_testing.conf";
 
+=head2 create_ticket_ok ARGS
+
+Creates a new ticket, passing ARGS along to the creation command (after the
+props separator).
+
+Returns a list of the luid and uuid of the newly created ticket.
+
+=cut
+
 sub create_ticket_ok {
     my @args = (@_);
     my ( $uuid, $luid );
@@ -20,6 +29,14 @@
     return ( $luid, $uuid );
 }
 
+=head2 create_ticket_ok ARGS
+
+Creates a new ticket comment, passing ARGS along to the creation command.
+
+Returns a list of the luid and uuid of the newly created comment.
+
+=cut
+
 sub create_ticket_comment_ok {
     my @args = (@_);
     my ( $uuid, $luid );
@@ -33,6 +50,13 @@
     return ( $luid, $uuid );
 }
 
+=head2 create_ticket_ok luid
+
+Takes a LUID and returns the corresponding UUID.
+
+Returns undef if none can be found.
+
+=cut
 
 sub get_uuid_for_luid {
         my $luid = shift;
@@ -43,6 +67,13 @@
     return undef;
 }
 
+=head2 get_luid_for_uuid UUID
+
+Takes a UUID and returns the corresponding LUID.
+
+Returns undef if none can be found.
+
+=cut
 
 sub get_luid_for_uuid {
         my $uuid = shift;
@@ -55,9 +86,11 @@
 
 =head2 create_ticket_with_editor_ok
 
-Creates a ticket and comment at the same time using a spawned editor.
-It's expected that C<$ENV{VISUAL}> has been frobbed into something
-non-interactive, or this test will just hang forever.
+Creates a ticket and comment at the same time using a spawned editor.  It's
+expected that C<$ENV{VISUAL}> has been frobbed into something non-interactive,
+or this test will just hang forever.
+
+Returns a list of the ticket luid, ticket uuid, comment luid, and comment uuid.
 
 =cut