puffin (version 0.8.8, 30 April 2002)		index
c:\work\puffin\puffin.py

Welcome to the Puffin Test Framework. The 'puffin' command executes
a test plan. Commandline options allow you to specify a test plan 
file and/or the specific puffin configuration file.
 
If none of these options are set (see below), the following 
defaults are assumed:
- puffin config file: 'puffinConfig.xml' in the local directory
- test plan file:         'test.plan' in the local directory
 
As mentioned above, puffin recognizes the following command
line arguments:
 
[Puffin Config Args]:
--puffin.conf=[puffin config file location]
        The name and location of your puffin configuration file.
        Usage Example: puffin --puffin.config=/usr/conf/puffin.conf
--test.plan=[test plan file(s) location(s)]
        The name and location of your test plan file or files.
        Usage Example: puffin --test.plan=/usr/conf/myTest.plan
                   puffin --test.plan=test1.plan,test2.plan,test3.plan
    (defaults to 'test.plan' in the current folder)
--logging=[DEBUG|INFO|WARN|ERROR|FATAL]
    Puffin uses a log4j-like logging system into which you can plug
    a variety of handlers (file, console, SMTP, etc). Default is WARN. 
    This level allows you to see brief status messages as puffin executes
    your test plan. To make puffin run silently, set logging to ERROR or
    FATAL. NOTE: If logging is set to DEBUG Puffin can be VERY chatty.
 
[Other Args]:
--contributors
        The contributors to puffin.
--help
        This help text. ('-h,' '-help,' and '--help' also work).
--license
        The license file describing the use/distribution of puffin.
--version
        The current version of this puffin installation.
 
See the docs/intro.html file (which should be in the docs folder as
puffin itself) for more in depth information and examples.

 
Modules
            
extensions
puffinlogging
responseanalyzer
resultsprocessor
sys
testplan
time
 
Classes
            
Puffin
 
class Puffin
      The Puffin class provides the framework within which you will execute your test plan.
It uses the puffin config file to initialize the framework and to create a dictionary of all
possible test actions. It then uses a Test Plan Manager object in conjunction with a
report writer to execute the test plan and report on its results.
 
   Methods defined here:
_Puffin__addAutoTokens = __addAutoTokens(self, testActionDictionary, autoTokenList, type)
Add appropriate auto-tokens to each test action in the test action
dictionary if appropriate.
 
Keyword Arguments:
testActionDictionary -- The current dictionary of all possible test actions.
autoTokenList -- The list of all auto inputs or outputs.
type -- The type (INPUT or OUTPUT) of tokens to process.
_Puffin__initTestPlanManager = __initTestPlanManager(self, systemNode, testPlanCmdLineArg, testActionDictionary)
Initialize the test plan manager.
 
Keyword Arguments:
systemNode -- The <system> XML node from the puffin config file.
testPlanCmdLineArg -- The test.plan parameter from the command line, if there was one.
testActionDictionary -- A dictionary containing all possible test actions configured for the system.
_Puffin__initializeFramework = __initializeFramework(self, systemNode)
Initialize the Puffin Framework.
 
Keyword Arguments:
systemNode -- The <system> XML node from the puffin config file.
_Puffin__processIncludedTestActionFiles = __processIncludedTestActionFiles(self, includedTestActionFileNodeList)
Process all test action include files represented by the XML node.
 
Keyword Arguments:
currentTestActionDictionary -- The current dictionary of all possible test actions.
includedTestActionFileNodeList -- The list of <testActionIncludeFile> XML nodes.
__init__(self, testPlanCmdLineArg, testConfigFile)
Initialize the test plan and the test plan execution accessory objects.
runTest(self)
Execute the current test.plan file by executing each test action in the 
order specified in the test.plan file.
Data and non-method functions defined here:
__doc__ = 'The Puffin class provides the framework within ...execute the test plan and report on its results.'
__module__ = 'puffin'
 
Data
             __author__ = 'Keyton Weissinger '
__contributors__ = 'Keyton Weissinger ; Ernie Hershey (demo app) '
__date__ = '30 April 2002'
__file__ = '.\\puffin.py'
__license__ = '\nLICENSE FOR PUFFIN:\n------------------------... IF ADVISED OF THE POSSIBILITY OF \nSUCH DAMAGE.'
__name__ = 'puffin'
__status__ = 'beta'
__version__ = '0.8.8'
 
Author
             Keyton Weissinger <keyton@weissinger.org>