Expect-Simple-0.04/0000755000040700000360000000000011010165612012157 5ustar djheadExpect-Simple-0.04/Makefile.PL0000644000040700000360000000125711010150571014134 0ustar djheaduse ExtUtils::MakeMaker; my $EUMM_VERSION = eval $ExtUtils::MakeMaker::VERSION; # See lib/ExtUtils/MakeMaker.pm for details of how to influence # the contents of the Makefile that is written. WriteMakefile( NAME => 'Expect::Simple', VERSION_FROM => 'lib/Expect/Simple.pm', # finds $VERSION PREREQ_PM => { Expect => 0, Test::More => 0, }, ($] >= 5.005 ? ## Add these new keywords supported since 5.005 (ABSTRACT_FROM => 'lib/Expect/Simple.pm', # retrieve abstract from module AUTHOR => 'Diab Jerius ') : ()), ( $EUMM_VERSION >= 6.31 ? ( LICENSE => 'gpl', ) : ()), ); Expect-Simple-0.04/MANIFEST.SKIP0000644000040700000360000000012511010164027014052 0ustar djhead^.hg .old$ .bak$ Makefile$ blib/ ~$ pm_to_blib t/.*.stdout t/.*.stderr blibdirs .gz$ Expect-Simple-0.04/README0000644000040700000360000000244211010150571013037 0ustar djhead Expect::Simple NAME Expect::Simple - wrapper around the Expect module DESCRIPTION Expect::Simple is a wrapper around the Expect module which should suffice for simple applications. It hides most of the Expect machinery; the Expect object is available for tweaking if need be. DEPENDENCIES Expect INSTALLATION To compile, test and install Expect::Simple perl Makefile.PL make make test make install COPYRIGHT (C) 2000-2007 Smithsonian Astrophysical Observatory. All rights reserved. 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 2 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, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA AUTHOR Diab Jerius (djerius@cpan.org) Expect-Simple-0.04/META.yml0000644000040700000360000000072311010165612013432 0ustar djhead--- #YAML:1.0 name: Expect-Simple version: 0.04 abstract: wrapper around the Expect module license: gpl generated_by: ExtUtils::MakeMaker version 6.36 distribution_type: module requires: Expect: 0 Test::More: 0 meta-spec: url: http://module-build.sourceforge.net/META-spec-v1.2.html version: 1.2 author: - Diab Jerius Expect-Simple-0.04/Changes0000644000040700000360000000103111010163730013444 0ustar djheadRevision history for Perl extension Expect::Simple. 0.04 Tue May 6 19:19:29 EDT 2008 - prevent deadlocks when spawn fails or command has exited prematurely - improve error output 0.03 Thu Aug 16 17:25:29 EDT 2007 - release 0.03_02 Tue Aug 7 18:05:46 EDT 2007 - added LICENSE to Makefile.PL 0.03_01 Tue Jul 31 17:37:27 EDT 2007 - Modernized layout - Cmd attribute can now take arrays [Adriano Ferreira ] - Added RawPty attribute - tests! 0.02 Aug 13 2002 - First public release Expect-Simple-0.04/MANIFEST0000644000040700000360000000033211010165612013306 0ustar djheadChangeLog Changes lib/Expect/Simple.pm LICENSE Makefile.PL MANIFEST This list of files MANIFEST.SKIP README t/Expect-Simple.t t/testprog META.yml Module meta-data (added by MakeMaker) Expect-Simple-0.04/t/0000755000040700000360000000000011010165612012422 5ustar djheadExpect-Simple-0.04/t/testprog0000644000040700000360000000030211010150571014205 0ustar djhead use strict; use warnings; my $p = 'tpt %d> '; printf( $p, 0); while( <> ) { do { print "byebye\n"; last } if /quit/; print uc( $_ ); printf( $p, $.); } print "quit> \n"; Expect-Simple-0.04/t/Expect-Simple.t0000644000040700000360000000172211010150571015266 0ustar djheaduse Test::More tests => 6; BEGIN { use_ok('Expect::Simple') }; ######################### my %attr = ( Prompt => 'tpt> ', DisconnectCmd => 'quit', Prompt => [ -re => 'tpt\s\d+> ', 'quit> ' ], RawPty => 1, ); # test scalar Cmd argument { my $res; my $obj = Expect::Simple->new( { %attr, Cmd => "$^X t/testprog", }); $obj->send( 'a' ); chomp( $res = $obj->before ); is( $res, 'A', 'Cmd string a' ); $obj->send( 'b' ); chomp( $res = $obj->before ); is( $res, 'B', 'Cmd string b' ); $obj->send( 'quit' ); chomp( $res = $obj->before ); is( $res, 'byebye', 'Cmd string quit' ); is ( $obj->match_str, 'quit> ', 'Cmd string quit prompt' ); } # test array Cmd argument { my $res; my $obj = Expect::Simple->new( { %attr, Cmd => [ $^X, 't/testprog'], }); $obj->send( 'quit' ); chomp( $res = $obj->before ); is( $res, 'byebye', 'Cmd array quit' ); } Expect-Simple-0.04/LICENSE0000644000040700000360000004313111010150571013164 0ustar djhead GNU GENERAL PUBLIC LICENSE Version 2, June 1991 Copyright (C) 1989, 1991 Free Software Foundation, Inc. 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. Preamble The licenses for most software are designed to take away your freedom to share and change it. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change free software--to make sure the software is free for all its users. This General Public License applies to most of the Free Software Foundation's software and to any other program whose authors commit to using it. (Some other Free Software Foundation software is covered by the GNU Library General Public License instead.) You can apply it to your programs, too. When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for this service if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs; and that you know you can do these things. To protect your rights, we need to make restrictions that forbid anyone to deny you these rights or to ask you to surrender the rights. These restrictions translate to certain responsibilities for you if you distribute copies of the software, or if you modify it. For example, if you distribute copies of such a program, whether gratis or for a fee, you must give the recipients all the rights that you have. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights. We protect your rights with two steps: (1) copyright the software, and (2) offer you this license which gives you legal permission to copy, distribute and/or modify the software. Also, for each author's protection and ours, we want to make certain that everyone understands that there is no warranty for this free software. If the software is modified by someone else and passed on, we want its recipients to know that what they have is not the original, so that any problems introduced by others will not reflect on the original authors' reputations. Finally, any free program is threatened constantly by software patents. We wish to avoid the danger that redistributors of a free program will individually obtain patent licenses, in effect making the program proprietary. To prevent this, we have made it clear that any patent must be licensed for everyone's free use or not licensed at all. The precise terms and conditions for copying, distribution and modification follow. GNU GENERAL PUBLIC LICENSE TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 0. This License applies to any program or other work which contains a notice placed by the copyright holder saying it may be distributed under the terms of this General Public License. The "Program", below, refers to any such program or work, and a "work based on the Program" means either the Program or any derivative work under copyright law: that is to say, a work containing the Program or a portion of it, either verbatim or with modifications and/or translated into another language. (Hereinafter, translation is included without limitation in the term "modification".) Each licensee is addressed as "you". Activities other than copying, distribution and modification are not covered by this License; they are outside its scope. The act of running the Program is not restricted, and the output from the Program is covered only if its contents constitute a work based on the Program (independent of having been made by running the Program). Whether that is true depends on what the Program does. 1. You may copy and distribute verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice and disclaimer of warranty; keep intact all the notices that refer to this License and to the absence of any warranty; and give any other recipients of the Program a copy of this License along with the Program. You may charge a fee for the physical act of transferring a copy, and you may at your option offer warranty protection in exchange for a fee. 2. You may modify your copy or copies of the Program or any portion of it, thus forming a work based on the Program, and copy and distribute such modifications or work under the terms of Section 1 above, provided that you also meet all of these conditions: a) You must cause the modified files to carry prominent notices stating that you changed the files and the date of any change. b) You must cause any work that you distribute or publish, that in whole or in part contains or is derived from the Program or any part thereof, to be licensed as a whole at no charge to all third parties under the terms of this License. c) If the modified program normally reads commands interactively when run, you must cause it, when started running for such interactive use in the most ordinary way, to print or display an announcement including an appropriate copyright notice and a notice that there is no warranty (or else, saying that you provide a warranty) and that users may redistribute the program under these conditions, and telling the user how to view a copy of this License. (Exception: if the Program itself is interactive but does not normally print such an announcement, your work based on the Program is not required to print an announcement.) These requirements apply to the modified work as a whole. If identifiable sections of that work are not derived from the Program, and can be reasonably considered independent and separate works in themselves, then this License, and its terms, do not apply to those sections when you distribute them as separate works. But when you distribute the same sections as part of a whole which is a work based on the Program, the distribution of the whole must be on the terms of this License, whose permissions for other licensees extend to the entire whole, and thus to each and every part regardless of who wrote it. Thus, it is not the intent of this section to claim rights or contest your rights to work written entirely by you; rather, the intent is to exercise the right to control the distribution of derivative or collective works based on the Program. In addition, mere aggregation of another work not based on the Program with the Program (or with a work based on the Program) on a volume of a storage or distribution medium does not bring the other work under the scope of this License. 3. You may copy and distribute the Program (or a work based on it, under Section 2) in object code or executable form under the terms of Sections 1 and 2 above provided that you also do one of the following: a) Accompany it with the complete corresponding machine-readable source code, which must be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange; or, b) Accompany it with a written offer, valid for at least three years, to give any third party, for a charge no more than your cost of physically performing source distribution, a complete machine-readable copy of the corresponding source code, to be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange; or, c) Accompany it with the information you received as to the offer to distribute corresponding source code. (This alternative is allowed only for noncommercial distribution and only if you received the program in object code or executable form with such an offer, in accord with Subsection b above.) The source code for a work means the preferred form of the work for making modifications to it. For an executable work, complete source code means all the source code for all modules it contains, plus any associated interface definition files, plus the scripts used to control compilation and installation of the executable. However, as a special exception, the source code distributed need not include anything that is normally distributed (in either source or binary form) with the major components (compiler, kernel, and so on) of the operating system on which the executable runs, unless that component itself accompanies the executable. If distribution of executable or object code is made by offering access to copy from a designated place, then offering equivalent access to copy the source code from the same place counts as distribution of the source code, even though third parties are not compelled to copy the source along with the object code. 4. You may not copy, modify, sublicense, or distribute the Program except as expressly provided under this License. Any attempt otherwise to copy, modify, sublicense or distribute the Program is void, and will automatically terminate your rights under this License. However, parties who have received copies, or rights, from you under this License will not have their licenses terminated so long as such parties remain in full compliance. 5. You are not required to accept this License, since you have not signed it. However, nothing else grants you permission to modify or distribute the Program or its derivative works. These actions are prohibited by law if you do not accept this License. Therefore, by modifying or distributing the Program (or any work based on the Program), you indicate your acceptance of this License to do so, and all its terms and conditions for copying, distributing or modifying the Program or works based on it. 6. Each time you redistribute the Program (or any work based on the Program), the recipient automatically receives a license from the original licensor to copy, distribute or modify the Program subject to these terms and conditions. You may not impose any further restrictions on the recipients' exercise of the rights granted herein. You are not responsible for enforcing compliance by third parties to this License. 7. If, as a consequence of a court judgment or allegation of patent infringement or for any other reason (not limited to patent issues), conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot distribute so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not distribute the Program at all. For example, if a patent license would not permit royalty-free redistribution of the Program by all those who receive copies directly or indirectly through you, then the only way you could satisfy both it and this License would be to refrain entirely from distribution of the Program. If any portion of this section is held invalid or unenforceable under any particular circumstance, the balance of the section is intended to apply and the section as a whole is intended to apply in other circumstances. It is not the purpose of this section to induce you to infringe any patents or other property right claims or to contest validity of any such claims; this section has the sole purpose of protecting the integrity of the free software distribution system, which is implemented by public license practices. Many people have made generous contributions to the wide range of software distributed through that system in reliance on consistent application of that system; it is up to the author/donor to decide if he or she is willing to distribute software through any other system and a licensee cannot impose that choice. This section is intended to make thoroughly clear what is believed to be a consequence of the rest of this License. 8. If the distribution and/or use of the Program is restricted in certain countries either by patents or by copyrighted interfaces, the original copyright holder who places the Program under this License may add an explicit geographical distribution limitation excluding those countries, so that distribution is permitted only in or among countries not thus excluded. In such case, this License incorporates the limitation as if written in the body of this License. 9. The Free Software Foundation may publish revised and/or new versions of the General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. Each version is given a distinguishing version number. If the Program specifies a version number of this License which applies to it and "any later version", you have the option of following the terms and conditions either of that version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of this License, you may choose any version ever published by the Free Software Foundation. 10. If you wish to incorporate parts of the Program into other free programs whose distribution conditions are different, write to the author to ask for permission. For software which is copyrighted by the Free Software Foundation, write to the Free Software Foundation; we sometimes make exceptions for this. Our decision will be guided by the two goals of preserving the free status of all derivatives of our free software and of promoting the sharing and reuse of software generally. NO WARRANTY 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. END OF TERMS AND CONDITIONS How to Apply These Terms to Your New Programs If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms. To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively convey the exclusion of warranty; and each file should have at least the "copyright" line and a pointer to where the full notice is found. Copyright (C) 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 2 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, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA Also add information on how to contact you by electronic and paper mail. If the program is interactive, make it output a short notice like this when it starts in an interactive mode: Gnomovision version 69, Copyright (C) year name of author Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. This is free software, and you are welcome to redistribute it under certain conditions; type `show c' for details. The hypothetical commands `show w' and `show c' should show the appropriate parts of the General Public License. Of course, the commands you use may be called something other than `show w' and `show c'; they could even be mouse-clicks or menu items--whatever suits your program. You should also get your employer (if you work as a programmer) or your school, if any, to sign a "copyright disclaimer" for the program, if necessary. Here is a sample; alter the names: Yoyodyne, Inc., hereby disclaims all copyright interest in the program `Gnomovision' (which makes passes at compilers) written by James Hacker. , 1 April 1989 Ty Coon, President of Vice This General Public License does not permit incorporating your program into proprietary programs. If your program is a subroutine library, you may consider it more useful to permit linking proprietary applications with the library. If this is what you want to do, use the GNU Library General Public License instead of this License. Expect-Simple-0.04/lib/0000755000040700000360000000000011010165612012725 5ustar djheadExpect-Simple-0.04/lib/Expect/0000755000040700000360000000000011010165612014155 5ustar djheadExpect-Simple-0.04/lib/Expect/Simple.pm0000644000040700000360000002327211010163422015747 0ustar djheadpackage Expect::Simple; use strict; use warnings; use Carp; use Expect; our $VERSION = '0.04'; sub new { my $proto = shift; my $class = ref($proto) || $proto; my $obj = { Timeout => 1000, Debug => 0, Verbose => 0, Prompt => undef, DisconnectCmd => undef, Cmd => undef, RawPty => 0, }; bless ($obj, $class); my $attr = shift or croak( __PACKAGE__, ': must specify some attributes!' ); while( my ( $attr, $val ) = each %{$attr} ) { croak( __PACKAGE__, ": attribute error : `$attr' is not recognized" ) unless exists $obj->{$attr}; $obj->{$attr} = $val; } # ensure all the attribures are set foreach ( keys %$obj ) { croak( __PACKAGE__, ": must specify attribute `$_'" ) unless defined $obj->{$_}; } # rework prompt $obj->{Prompt} = [ 'ARRAY' eq ref $obj->{Prompt} ? @{$obj->{Prompt}} : $obj->{Prompt} ]; eval { $obj->_connect; }; if ( $@ ) { chomp $@; croak (__PACKAGE__, ': ', $@); } return $obj; } # _connect - start up the cmd # # creates an Expect object which talks to the specified command. It dies with # an appropriate message upon error. sub _connect { my $obj = shift; print STDERR "Running command..." if $obj->{Verbose}; # don't store the connection in the object until we're sure it's # up. otherwise DESTROY will try to disconnect, which won't work... delete $obj->{_conn}; my $conn = Expect->new(); $conn->raw_pty(1) if $obj->{RawPty}; # Expect docs say that upon failure of spawn, one can get the error # from the next call to expect(). Unfortunately, that message is # generated by a die in the forked child process, which means it has # propagated up through the eval in Expect::Simple::new and # had lots of cruft slapped onto it, front and back. # # instead, I use a horrible hack to grab the (undocumented) warning # emitted by Expect if $^W is turned on. { my $error; local $^W = 1; local $SIG{__WARN__} = sub { chomp( $error = $_[0]); return; }; my $success = $conn->spawn( 'ARRAY' eq ref($obj->{Cmd}) ? @{$obj->{Cmd}} : $obj->{Cmd} ); if ( ! $success ) { chomp $error; die( "error spawning command: $error\n" ); } } print STDERR "done.\n" if $obj->{Verbose}; $conn->debug( $obj->{Debug} ); $conn->log_stdout( $obj->{Verbose} > 3 ? 1 : 0 ); $obj->{_conn} = $conn; $obj->_expect( @{$obj->{Prompt}} ) or die( __PACKAGE__, ": couldn't find prompt\n"); } sub _disconnect { my $obj = shift; return unless $obj->{_conn} && !defined $obj->{_conn}->exitstatus; print STDERR "Disconnecting.\n" if $obj->{Verbose}; $obj->{_conn}->print( $obj->{DisconnectCmd}, "\n" ); $obj->_expect( 'the unexpected' ); croak( __PACKAGE__, ": disconnection error" ) unless $obj->{_conn}->exp_error =~ /^(2|3)/; $obj->{_conn} = undef; } # send( @commands ) # # send commands to the server. each command is sent independently. # it waits for the prompt to indicate success. # # it croaks if there was an error. $obj->error returns # the results of the communication to # the server which caused the error. sub send { my $obj = shift; foreach ( @_ ) { print STDERR "Sending `$_'\n" if $obj->{Verbose} && ! $obj->{_conn}->log_stdout; $obj->{_conn}->print( $_, "\n"); $obj->_expect( @{$obj->{Prompt}} ) || croak( __PACKAGE__, ": couldn't find prompt after send"); } } # _expect( @match_patterns ) # # match output of the server.The error message is massaged to # make it more obvious. # # it returns 1 upon success, undef if there was an error. sub _expect { my $obj = shift; my $match = $obj->{_conn}->expect( $obj->{Timeout}, @_ ); $obj->{_error} = undef; unless ( defined $match ) { local $_ = $obj->{_conn}->exp_error; if ( /^1/ ) { $obj->{_error} = 'connection timed out'; } elsif ( /^(2|3)/ ) { $obj->{_error} = 'connection unexpectedly terminated'; } else { my ( $errno, $errmsg) = /(\d):(.*)/; $obj->{_error} = "error in communications: $errmsg"; } return undef; } 1; } sub error { shift()->{_error} } sub error_expect { shift()->{_conn}->exp_error } sub match_idx { shift()->{_conn}->exp_match_number } sub match_str { shift()->{_conn}->exp_match } sub before { shift()->{_conn}->exp_before } sub after { shift()->{_conn}->exp_after } sub expect_handle{ shift()->{_conn} } sub DESTROY { shift()->_disconnect } # Autoload methods go after =cut, and are processed by the autosplit program. 1; __END__ =head1 NAME Expect::Simple - wrapper around the Expect module =head1 SYNOPSIS use Expect::Simple; my $obj = new Expect::Simple { Cmd => [ dmcoords => 'verbose=1', "infile=$infile"], Prompt => [ -re => 'dmcoords>:\s+' ], DisconnectCmd => 'q', Verbose => 0, Debug => 0, Timeout => 100 }; $obj->send( $cmd ); print $obj->before; print $obj->after; print $obj->match_str, "\n"; print $obj->match_idx, "\n"; print $obj->error_expect; print $obj->error; $expect_object = $obj->expect_handle; =head1 DESCRIPTION C is a wrapper around the C module which should suffice for simple applications. It hides most of the C machinery; the C object is available for tweaking if need be. Generally, one starts by creating an B object using B. This will start up the target program, and will wait until one of the specified prompts is output by the target. At that point the caller should B commands to the program; the results are available via the B, B, B, and B methods. Since B simulates a terminal, there will be extra C<\r> characters at the end of each line in the result (on UNIX at least). This is easily fixed: ($res = $obj->before) =~ tr/\r//d; @lines = split( "\n", $res ); This is B done automatically. Exceptions will be thrown on error (match with C). Errors from B are available via the B method. More human readable errors are available via the B method. The connection is automatically broken (by sending the specified disconnect command to the target) when the B object is destroyed. =head2 Methods =over 8 =item new $obj = Expect::Simple->new( \%attr ); This creates a new object, starting up the program with which to communicate (using the B B method) and waiting for a prompt. The passed hash reference must contain at least the B, B, and B elements. The available attributes are: =over 8 =item Cmd Cmd => $command, Cmd => [ $command, $arg1, $arg2, ... ], The command to which to connect. The passed command may either be a scalar or an array. =item Prompt This specifies one or more prompts to scan for. For a single prompt, the value may be a scalar; for more, or for matching of regular expressions, it should be an array reference. For example, Prompt => 'prompt1> ', Prompt => [ 'prompt1> ', 'prompt2> ', -re => 'prompt\d+>\s+' ] All prompts are taken literally, unless immediately preceded by a C<-re> flag, in which case they are regular expressions. =item DisconnectCmd This is the command to be sent to the target program which will cause it to exit. =item RawPty If set, then underlying B object's pty mode is set to raw mode (see B). =item Timeout The time in seconds to wait until giving up on the target program responding. This is used during program startup and when any commands are sent to the program. It defaults to 1000 seconds. =item Debug The value is passed to B via its B method. =item Verbose This results in various messages printed to the STDERR stream. If greater than 3, it turns on B's logging to STDOUT (via the B B method. =back =item send $obj->send( $cmd ); $obj->send( @cmds ); Send one or more commands to the target. After each command is sent, it waits for a prompt from the target. Only the output resulting from the last command is available via the B, B, etc. methods. =item match_idx This returns a unary based index indicating which prompt (in the list of prompts specified via the C attribute to the B method) was received after the last command was sent. It will be undef if none was returned. =item match_str This returns the prompt which was matched after the last command was sent. =item before This returns the string received before the prompt. If no prompt was seen, it returns all output accumulated. This is usually what the caller wants to parse. Note that the first line will (usually) be the command that was sent to the target, because of echoing. Check this out to be sure! =item after This returns the 'after' string. Please read the B docs for more enlightenment. =item error This returns a cleaned up, more humanly readable version of the errors from B. It'll be undef if there was no error. =item error_expect This returns the original B error. =item expect_handle This returns the B object, in case further tweaking is necessary. =back =head1 BUGS If the command to be run does not exist (or not in the current execution path), it's quite possible that the B method will not throw an exception. It's up to the caller to make sure that the command will run! There's no known workaround for this. =head1 LICENSE This software is released under the GNU General Public License. You may find a copy at http://www.fsf.org/copyleft/gpl.html =head1 AUTHOR Diab Jerius (djerius@cpan.org) =cut Expect-Simple-0.04/ChangeLog0000644000040700000360000000774211010163451013742 0ustar djhead2008-05-06 19:17 -0400 djerius (e7ce8260d2e9 [tip]) * lib/Expect/Simple.pm: don't expose exitstatus routine 2008-05-06 19:14 -0400 djerius (427807ef1d7e) * lib/Expect/Simple.pm: propagate error from failed spawn 2008-05-06 19:12 -0400 djerius (a05c30ff584e) * lib/Expect/Simple.pm: switch internal croaks to dies. clean up exception string new lines 2008-05-06 17:51 -0400 djerius (385aee63462b) * lib/Expect/Simple.pm: no longer attempt to disconnect on failed spawn. don't try to disconnect if the spawned process has already exited. the connection object was stashed in the Expect::Simple object before a connection was attempted, leading _disconnect to try and disconnect if the spawn failed when the object was getting automatically destroyed. 2007-08-16 17:30 -0400 djerius (509bddd42cfd) * .hgtags: Added tag 0.03 for changeset 597143fc8e7b 2007-08-16 17:30 -0400 djerius (597143fc8e7b [0.03]) * ChangeLog, Changes, MANIFEST, lib/Expect/Simple.pm: update for release 2007-08-16 17:27 -0400 djerius (762f5212fa09) * Makefile.PL: fix typo 2007-08-07 18:07 -0400 djerius (c783a36b3863) * .hgtags: Added tag 0.03_02 for changeset 5fadc78bc572 2007-08-07 18:07 -0400 djerius (5fadc78bc572 [0.03_02]) * ChangeLog, Changes: update for release 2007-08-07 18:06 -0400 djerius (8d96ed7a5297) * lib/Expect/Simple.pm: update version for release 2007-08-07 18:05 -0400 djerius (406422c879e7) * Makefile.PL: added LICENSE to Makefile.PL 2007-07-31 18:15 -0400 djerius (a2d0a3a6de39) * .hgtags: Added tag 0.03_01 for changeset 9a57ce45c4e5 2007-07-31 18:15 -0400 djerius (9a57ce45c4e5 [0.03_01]) * ChangeLog: update for release 2007-07-31 18:04 -0400 djerius (d5b8c528e728) * lib/Expect/Simple.pm: minor code cleanup 2007-07-31 18:00 -0400 djerius (b3256c687aee) * Changes, lib/Expect/Simple.pm, t/Expect-Simple.t, t/testprog: new file. * GNUmakefile, INSTALL, Simple.pm: deleted file. * Changes, GNUmakefile, INSTALL, MANIFEST, Makefile.PL, README, Simple.pm, lib/Expect/Simple.pm, t/Expect-Simple.t, t/testprog: Modernized layout, new tests, Cmd takes arrays, new RawPty attribute - Modernized layout - Cmd attribute can now take arrays [Adriano Ferreira ] - Added RawPty attribute - tests! 2007-07-31 13:54 -0400 djerius (138b0db0cd1d) * ChangeLog, MANIFEST, README: update for release 2007-07-31 13:53 -0400 djerius (72ff04de2b51) * Simple.pm: use __PACKAGE__ instad of constant CLASS 2007-07-31 17:33 +0000 dj (43e15f71bf82) * ChangeLog: new file. * ChangeLog: 2007-07-31 17:33:58 by dj added ChangeLog 2007-07-31 13:34 -0400 djerius (4c6ebb75d8fe) * .hgtags: Added tag V0_01 for changeset 19960ade3b9a 2002-04-12 21:04 +0000 dj (19960ade3b9a [V0_01]) * LICENSE, README: new file. * LICENSE, README, Simple.pm: 2002-04-12 21:04:33 by dj added license info 2007-07-31 13:34 -0400 djerius (b82227a5764b) * .hgtags: new file. * .hgtags: Added tag initial for changeset 8ade7f132b43 2000-08-31 18:23 +0000 dj (8ade7f132b43 [initial]) * GNUmakefile, INSTALL, MANIFEST: new file. * GNUmakefile, INSTALL, MANIFEST: 2000-08-31 18:23:47 by dj 2000-08-31 18:23 +0000 dj (0c0b74076926) * Makefile.PL, Simple.pm: new file. * Makefile.PL, Simple.pm: 2000-08-31 18:23:46 by dj Initial revision 2007-07-31 13:34 -0400 djerius (22a363e7238c) * .hgignore: new file. * .hgignore: Tailor preparing to convert repo by adding .hgignore