prophet::test(3pm) [debian man page]

Prophet::Test(3pm)					User Contributed Perl Documentation					Prophet::Test(3pm)

   set_editor($code)
       Sets the subroutine that Prophet should use instead of "Prophet::CLI::Command::edit_text" (as this routine invokes an interactive editor)
       to $code.

   set_editor_script SCRIPT
       Sets the editor that Proc::InvokeEditor uses.

       This should be a non-interactive script found in t/scripts.

   import_extra($class, $args)
   in_gladiator($code)
       Run the given code using Devel::Gladiator.

   repo_path_for($username)
       Returns a path on disk for where $username's replica is stored.

   repo_uri_for($username)
       Returns a file:// URI for $USERNAME'S replica (with the correct replica type prefix).

   replica_uuid
       Returns the UUID of the test replica.

   database_uuid
       Returns the UUID of the test database.

   replica_last_rev
       Returns the sequence number of the last change in the test replica.

   as_user($username, $coderef)
       Run this code block as $username.  This routine sets up the %ENV hash so that when we go looking for a repository, we get the user's repo.

   replica_uuid_for($username)
       Returns the UUID of the given user's test replica.

   database_uuid_for($username)
       Returns the UUID of the given user's test database.

   ok_added_revisions( { CODE }, $numbers_of_new_revisions, $msg)
       Checks that the given code block adds the given number of changes to the test replica. $msg is optional and will be printed with the test
       if given.

   serialize_conflict($conflict_obj)
       Returns a simple, serialized version of a Prophet::Conflict object suitable for comparison in tests.

       The serialized version is a hash reference containing the following keys:
	   meta => { original_source_uuid => 'source_replica_uuid' }
	   records => { 'record_uuid' =>
			  { change_type => 'type',
			    props => { propchange_name => { source_old => 'old_val',
							    source_new => 'new_val',
							    target_old => 'target_val',
							  }
				     }
			  },
			'another_record_uuid' =>
			  { change_type => 'type',
			    props => { propchange_name => { source_old => 'old_val',
							    source_new => 'new_val',
							    target_old => 'target_val',
							  }
				     }
			  },
		      }

   serialize_changeset($changeset_obj)
       Returns a simple, serialized version of a Prophet::ChangeSet object suitable for comparison in tests (a hash).

   run_command($command, @args)
       Run the given command with (optionally) the given args using a new Prophet::CLI object. Returns the standard output of that command in
       scalar form or, in array context, the STDOUT in scalar form *and* the STDERR in scalar form.

       Examples:

	   run_command('create', '--type=Foo');

   load_record($type, $uuid)
       Loads and returns a record object for the record with the given type and uuid.

   as_alice CODE, as_bob CODE, as_charlie CODE, as_david CODE
       Runs CODE as alice, bob, charlie or david.

perl v5.10.1							    2009-09-02							Prophet::Test(3pm)

Test::Script::Run(3pm)					User Contributed Perl Documentation				    Test::Script::Run(3pm)

NAME

       Test::Script::Run - test the script with run

SYNOPSIS

	   use Test::Script::Run;
	   # customized names of bin dirs, default is qw/bin sbin script ./;
	   @Test::Script::Run::BIN_DIRS = qw/bin/;
	   run_ok( 'app_name', [ app's args ], 'you_app runs ok' );
	   my ( $return, $stdout, $stderr ) = run_script( 'app_name', [ app's args ] );
	   run_output_matches(
	       'app_name', [app's args],
	       [ 'out line 1', 'out line 2' ],
	       [ 'err line 1', 'err line 2' ],
	       'run_output_matches'
	   );
	   run_output_matches_unordered(
	       'app_name', [ app's args ],
	       [ 'out line 2', 'out line 1' ],
	       [ 'err line 2', 'err line 1' ],
	       'run_output_matches_unordered'
	   );

DESCRIPTION

       This module exports some subs to help test and run scripts in your dist's bin/ directory, if the script path is not absolute.

       Nearly all the essential code is stolen from Prophet::Test, we think subs like those should live below "Test::" namespace, that's why we
       packed them and created this module.

FUNCTIONS

   run_script($script, $args, $stdout, $stderr)
       Runs the script $script as a perl script, setting the @INC to the same as our caller.

       $script is the name of the script to be run (such as 'prophet'). $args is a reference to an array of arguments to pass to the script.
       $stdout and $stderr are both optional; if passed in, they will be passed to IPC::Run3's run3 subroutineA as its $stdout and $stderr args.
       Otherwise, this subroutine will create scalar references to pass to run3 instead (which are treated as strings for STDOUT/STDERR to be
       written to).

       Returns run3's return value and, if no $stdout and $stderr were passed in, the STDOUT and STDERR of the script that was run.

   run_ok($script, $args, $msg)
       Runs the script, checking that it didn't error out.

       $script is the name of the script to be run (e.g. 'prophet'). $args is an optional reference to an array of arguments to pass to the script
       when it is run. $msg is an optional message to print with the test. If $args is not specified, you can still pass in a $msg.

       Returns nothing of interest.

   run_not_ok($script, $args, $msg)
       opposite of run_ok

   get_perl_cmd($script, @ARGS)
       Returns a list suitable for passing to "system", "exec", etc. If you pass $script then we will search upwards for it in @BIN_DIRS

   is_script_output($scriptname @args, @stdout_match, @stderr_match, $msg)
       Runs $scriptname, checking to see that its output matches.

       $args is an array reference of args to pass to the script. $stdout_match and $stderr_match are references to arrays of expected lines. $msg
       is a string message to display with the test. $stderr_match and $msg are optional. (As is $stdout_match if for some reason you expect your
       script to have no output at all. But that would be silly, wouldn't it?)

       Allows regex matches as well as string equality (lines in $stdout_match and $stderr_match may be Regexp objects).

   run_output_matches($script, $args, $exp_stdout, $exp_stderr, $msg)
       A wrapper around is_script_output that also checks to make sure the test runs without throwing an exception.

   run_output_matches_unordered($script, $args, $exp_stdout, $exp_stderr, $msg)
       This subroutine has exactly the same functionality as run_output_matches, but doesn't impose a line ordering when comparing the expected
       and received outputs.

   last_script_stdout
       return last script's stdout

   last_script_stderr
       return last script's stderr

   last_script_exit_code
       return last script's exit code

DEPENDENCIES

       Test::More, Test::Exception, IPC::Run3, File::Basename, File::Spec

BUGS AND LIMITATIONS

       No bugs have been reported.

AUTHOR

       sunnavy	"<sunnavy@bestpractical.com>"

LICENCE AND COPYRIGHT

       Copyright 2009 Best Practical Solutions.

       This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

perl v5.10.1							    2011-01-07						    Test::Script::Run(3pm)