Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

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)

Check Out this Related Man Page

Prophet::CLI::Command(3pm)				User Contributed Perl Documentation				Prophet::CLI::Command(3pm)

   Registering argument translations
       This is the Prophet CLI's way of supporting short forms for arguments, e.g. you want to let '-v' be able to used for the same purpose as
       '--verbose' without dirtying your code checking both or manually setting them if they exist. We want it to be as easy as possible to have
       short commands.

       To use, have your command subclass do:

	   sub ARG_TRANSLATIONS { shift->SUPER::ARG_TRANSLATIONS(),  f => 'file' };

       You can register as many translations at a time as you want.  The arguments will be translated when the command object is instantiated. If
       an arg already exists in the arg translation table, it is overwritten with the new value.

   require_uuid
       Checks to make sure the uuid attribute is set. Prints an error and dies with the command's usage string if it is not set.

   edit_text [text] -> text
       Filters the given text through the user's $EDITOR using Proc::InvokeEditor.

   edit_hash hash => hashref, ordering => arrayref
       Filters the hash through the user's $EDITOR using Proc::InvokeEditor.

       No validation is done on the input or output.

       If the optional ordering argument is specified, hash keys will be presented in that order (with unspecified elements following) for edit.

       If the record class for the current type defines a "immutable_props" routine, those props will not be presented for editing.

       False values are not returned unless a prop is removed from the output.

   edit_props arg => str, defaults => hashref, ordering => arrayref
       Returns a hashref of the command's props mixed in with any default props.  If the "arg" argument is specified, (default "edit", use "undef"
       if you only want default arguments), then "edit_hash" is invoked on the property list.

       If the "ordering" argument is specified, properties will be presented in that order (with unspecified props following) if filtered through
       "edit_hash".

   prompt_choices question
       Asks user the question and returns 0 if answer was the second choice, 1 otherwise. (First choice is the default.)

   prompt_Yn question
       Asks user the question and returns true if answer was positive or false otherwise. Default answer is 'Yes' (returns true).

   print_usage
       Print the command's usage message to STDERR and die. Commands should implement "usage_msg", which returns the usage message.

       If the usage message method needs arguments passed in, use a closure.

   get_cmd_and_subcmd_names [no_type => 1]
       Gets the name of the script that was run and the primary commands that were specified on the command-line. If a true boolean is passed in
       as "no_type", won't add '<record-type>' to the subcmd if no type was passed in via the primary commands.

perl v5.10.1							    2009-08-19						Prophet::CLI::Command(3pm)
Man Page