Studio:Test Script Perl Template: Difference between revisions

From STRIDE Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 67: Line 67:
<p>
<p>
</p>
</p>
<h1>NAM</h1>
<h1>NAME</h1>
<p>[scriptname].pl - [few word summary]</p>
<p>[scriptname].pl - [few word summary]</p>


Line 73: Line 73:
</p>
</p>
<hr />
<hr />
<h1>DESCRIPTIO</h1>
<h1>DESCRIPTION</h1>
<p>Here is some description text.  It can have text that is <strong>bolded</strong>, <em>italicized</em>, and <code>$code-formatted</code>.</p>
<p>Here is some description text.  It can have text that is <strong>bolded</strong>, <em>italicized</em>, and <code>$code-formatted</code>.</p>
<p>
<p>
Line 79: Line 79:
<h2>TESTS</h2>
<h2>TESTS</h2>


<dl>
;test case 1:
<dt><strong>test case 1.</strong>
<p>description</p>
 
;test case 2:
<dd>
<p>description</p>
<p>description</p>
</dd>
;etc...:
</li>
<dt><strong>test case 2</strong>
 
<dd>
<p>description</p>
<p>description</p>
</dd>
</li>


<dt><strong>etc...</strong>
<dd>
<p>description</p>
</dd>
</li>
</dl>
<p>
<p>
</p>
</p>

Revision as of 19:24, 29 October 2008

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. The template 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

<[1]>.


<a name="copyright">COPYRIGHT</a>

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

[Category: Document Templates]