Studio:Test Script Perl Template

From STRIDE Wiki
Revision as of 17:16, 3 November 2008 by Mikee (talk | contribs)
Jump to navigation Jump to search

The following sample represents a starting point for perl test scripts.

Source
=head1 NAME

[scriptname].pl - [few word summary]

=head1 DESCRIPTION

Here is some description text.  It can have text that is B<bolded>, I<italicized>, and C<$code-formatted>.

=head2 TESTS

=over 4

=item test case 1.

description

=item test case 2 

description

=item etc...

description

=back

=head1 TEST SPECIFICATION

L<http://project-portal.s2technologies.com/index.php/MyTestPlan>.

=head1 COPYRIGHT

Copyright 2008 S2 Technologies <support@s2technologies.com>.

=cut

use strict;
use warnings;
use Carp;
use Win32::TieRegistry(Delimiter=>"/");
use File::Spec;
use Win32::OLE;

Win32::OLE->Option(Warn => 3);
use vars qw( $StrideLibDirectory );
BEGIN {
    my $strideDir = $Registry->{"LMachine/SOFTWARE/S2 Technologies/STRIDE/InstallDir"} || $ENV{'STRIDE_DIR'};
    $StrideLibDirectory = File::Spec->catdir($StrideDirectory, 'lib', 'perl');  
}
use lib $StrideLibDirectory;


This template uses pod for documentation, which is an ubiquitous standard for self-contained docs in perl. The pod is easily displayed by simply calling perldoc for command line/shell output or pod2html for html output. There are also utilities available for generating wiki text from pod,which could provide a convenient way to autopublish the script documentation to the project wiki. The code above produces the following HTML output:

HTML result

NAME

[scriptname].pl - [few word summary]


DESCRIPTION

Here is some description text. It can have text that is bolded, italicized, and $code-formatted.

TESTS

test case 1

description

test case 2

description

etc...

description


TEST SPECIFICATION

<http://project-portal.s2technologies.com/index.php/MyTestPlan>.


COPYRIGHT

Copyright 2008 S2 Technologies <support@s2technologies.com>.