Add minimal POD

[perl/modules/VPIT-TestHelpers.git] / lib / VPIT / TestHelpers.pm

diff --git a/lib/VPIT/TestHelpers.pm b/lib/VPIT/TestHelpers.pm
index 6a3655e9646aa45649087d5e063ecfd42d71a9a5..f00b94df47198bf8656af87751e160fe9af369b5 100644 (file)
--- a/lib/VPIT/TestHelpers.pm
+++ b/lib/VPIT/TestHelpers.pm
@@ -5,6 +5,19 @@ use warnings;
 
 use Config ();
 
+=head1 NAME
+
+VPIT::TestHelpers
+
+=head1 SYNTAX
+
+    use VPIT::TestHelpers (
+     feature1 => \@feature1_args,
+     feature2 => \@feature2_args,
+    );
+
+=cut
+
 sub export_to_pkg {
  my ($subs, $pkg) = @_;
 
@@ -19,14 +32,14 @@ sub export_to_pkg {
 my %default_exports = (
  load_or_skip     => \&load_or_skip,
  load_or_skip_all => \&load_or_skip_all,
- run_perl         => \&run_perl,
  skip_all         => \&skip_all,
 );
 
 my %features = (
- threads => \&init_threads,
- usleep  => \&init_usleep,
- capture => \&init_capture,
+ threads  => \&init_threads,
+ usleep   => \&init_usleep,
+ run_perl => \&init_run_perl,
+ capture  => \&init_capture,
 );
 
 sub import {
@@ -142,6 +155,52 @@ sub load_or_skip_all {
  return $loaded;
 }
 
+=head1 FEATURES
+
+=head2 C<run_perl>
+
+=over 4
+
+=item *
+
+Import :
+
+    use VPIT::TestHelpers run_perl => [ $p ]
+
+where :
+
+=over 8
+
+=item -
+
+C<$p> is prefixed to the constants exported by this feature (defaults to C<''>).
+
+=back
+
+=item *
+
+Dependencies : none
+
+=item *
+
+Exports :
+
+=over 8
+
+=item -
+
+C<run_perl $code>
+
+=item -
+
+C<RUN_PERL_FAILED> (possibly prefixed by C<$p>)
+
+=back
+
+=back
+
+=cut
+
 sub fresh_perl_env (&) {
  my $handler = shift;
 
@@ -165,6 +224,25 @@ sub fresh_perl_env (&) {
  return $handler->($perl, '-T', map("-I$_", @INC));
 }
 
+sub init_run_perl {
+ my $prefix = shift;
+
+ if (defined $prefix) {
+  if (length $prefix and $prefix !~ /_$/) {
+   $prefix .= '_';
+  }
+ } else {
+  $prefix = '';
+ }
+
+ my $p = $prefix;
+
+ return (
+  run_perl              => \&run_perl,
+  "${p}RUN_PERL_FAILED" => sub () { 'Could not execute perl subprocess' },
+ );
+}
+
 sub run_perl {
  my $code = shift;
 
@@ -178,6 +256,56 @@ sub run_perl {
  };
 }
 
+=head2 C<capture>
+
+=over 4
+
+=item *
+
+Import :
+
+    use VPIT::TestHelpers 'capture'
+
+=item *
+
+Dependencies :
+
+=over 8
+
+=item -
+
+Not VMS
+
+=item -
+
+L<IO::Handle>, L<IO::Select>, L<IPC::Open3>
+
+=item -
+
+On MSWin32 : L<Socket>
+
+=back
+
+=item *
+
+Exports :
+
+=over 8
+
+=item -
+
+C<capture @command>
+
+=item -
+
+C<capture_perl $code>
+
+=back
+
+=back
+
+=cut
+
 sub init_capture {
  skip_all 'Cannot capture output on VMS' if $^O eq 'VMS';
 
@@ -344,6 +472,76 @@ sub capture_perl {
  };
 }
 
+=head2 C<threads>
+
+=over 4
+
+=item *
+
+Import :
+
+    use VPIT::TestHelpers threads => [
+     $pkg, $is_threadsafe, $force_var
+    ];
+
+where :
+
+=over 8
+
+=item -
+
+C<$pkg> is the target package name to be used in error messages (defaults to C<'package'>) ;
+
+=item -
+
+C<$is_threadsafe> is a boolean telling whether the target module is thread-safe (not tested if C<undef>) ;
+
+=item -
+
+C<$force_var> is the name of the environment variable that can be used to force the thread tests (defaults to C<PERL_FORCE_TEST_THREADS>).
+
+=back
+
+=item *
+
+Dependencies :
+
+=over 8
+
+=item -
+
+C<perl> 5.13.4
+
+=item -
+
+L<threads> 1.67
+
+=item -
+
+L<threads::shared> 1.14
+
+=item -
+
+L<Test::Leaner>
+
+=back
+
+=item *
+
+Exports :
+
+=over 8
+
+=item -
+
+C<spawn $coderef>
+
+=back
+
+=back
+
+=cut
+
 sub init_threads {
  my ($pkg, $threadsafe, $force_var) = @_;
 
@@ -372,6 +570,48 @@ sub init_threads {
  return spawn => \&spawn;
 }
 
+sub spawn {
+ local $@;
+ my @diag;
+ my $thread = eval {
+  local $SIG{__WARN__} = sub { push @diag, "Thread creation warning: @_" };
+  threads->create(@_);
+ };
+ push @diag, "Thread creation error: $@" if $@;
+ diag @diag;
+ return $thread ? $thread : ();
+}
+
+=head2 C<usleep>
+
+=over 4
+
+=item *
+
+Import :
+
+    use VPIT::TestHelpers 'usleep'
+
+=item *
+
+Dependencies : none
+
+=item *
+
+Exports :
+
+=over 8
+
+=item -
+
+C<usleep $microseconds>
+
+=back
+
+=back
+
+=cut
+
 sub init_usleep {
  my $usleep;
 
@@ -390,17 +630,18 @@ sub init_usleep {
  return usleep => $usleep;
 }
 
-sub spawn {
- local $@;
- my @diag;
- my $thread = eval {
-  local $SIG{__WARN__} = sub { push @diag, "Thread creation warning: @_" };
-  threads->create(@_);
- };
- push @diag, "Thread creation error: $@" if $@;
- diag @diag;
- return $thread ? $thread : ();
-}
+=head1 CLASSES
+
+=head2 C<VPIT::TestHelpers::Guard>
+
+Syntax :
+
+    {
+     my $guard = VPIT::TestHelpers::Guard->new($coderef);
+     ...
+    } # $codref called here
+
+=cut
 
 package VPIT::TestHelpers::Guard;
 
@@ -412,4 +653,16 @@ sub new {
 
 sub DESTROY { $_[0]->{code}->() }
 
+=head1 AUTHOR
+
+Vincent Pit, C<< <perl at profvince.com> >>, L<http://www.profvince.com>.
+
+=head1 COPYRIGHT & LICENSE
+
+Copyright 2012,2013,2014,2015 Vincent Pit, all rights reserved.
+
+This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
+
+=cut
+
 1;