Document OpenSSL::Test and OpenSSL::Test::Simple

[openssl.git] / test / testlib / OpenSSL / Test / Simple.pm

diff --git a/test/testlib/OpenSSL/Test/Simple.pm b/test/testlib/OpenSSL/Test/Simple.pm
index 145778eb27063bdacce8a8fe909ef88cd706d1f7..874a156f4ea3080a6d3d3db5607f881c4f0a3904 100644 (file)
--- a/test/testlib/OpenSSL/Test/Simple.pm
+++ b/test/testlib/OpenSSL/Test/Simple.pm
@@ -5,13 +5,47 @@ use warnings;
 
 use Exporter;
 use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
-$VERSION = "0.1";
+$VERSION = "0.2";
 @ISA = qw(Exporter);
 @EXPORT = qw(simple_test);
 
+=head1 NAME
+
+OpenSSL::Test::Simple - a few very simple test functions
+
+=head1 SYNOPSIS
+
+  use OpenSSL::Test::Simple;
+
+  simple_test("my_test_name", "des", "destest");
+
+=head1 DESCRIPTION
+
+Sometimes, the functions in L<OpenSSL::Test> are quite tedious for some
+repetitive tasks.  This module provides functions to make life easier.
+You could call them hacks if you wish.
+
+=cut
 
 use OpenSSL::Test;
 
+=over 4
+
+=item B<simple_test NAME, PROGRAM, ALGORITHM>
+
+Runs a test named NAME, running the program PROGRAM with no arguments,
+to test the algorithm ALGORITHM.
+
+A complete recipe looks like this:
+
+  use OpenSSL::Test::Simple;
+
+  simple_test("test_bf", "bftest", "bf");
+
+=back
+
+=cut
+
 # args:
 #  name                        (used with setup())
 #  algorithm           (used to check if it's at all supported)
@@ -29,3 +63,16 @@ sub simple_test {
       ok(run(test([$prgr])), "running $prgr");
     }
 }
+
+=head1 SEE ALSO
+
+L<OpenSSL::Test>
+
+=head1 AUTHORS
+
+Richard Levitte E<lt>levitte@openssl.orgE<gt> with inspiration
+from Rich Salz E<lt>rsalz@openssl.org<gt>.
+
+=cut
+
+1;