HTTP::WebTest::Plugin - Base class for HTTP::WebTest plugins.
Not applicable.
HTTP::WebTest plugin classes can inherit from this class. It provides some useful helper methods.
Constructor.
A new plugin object that will be used by HTTP::WebTest object $webtest.
$webtest
An HTTP::WebTest object that uses this plugin.
If global test parameter $param is not defined, returns $optional_default or undef if there is no default.
$param
$optional_default
undef
If the global test parameter $param is defined, returns it's value.
If latest test parameter $param is not defined, returns $optional_default or undef if there is no default.
If latest test parameter $param is defined returns it's value.
If the global test parameter $param is not defined, returns $optional_default or false if no default exists.
If the global test parameter $param is defined, returns true if latest test parameter $param is yes, false otherwise.
yes
If latest test parameter $param is not defined returns $optional_default or false if it is not defined also.
If latest test parameter $param is defined returns true if latest test parameter $param is yes. False otherwise.
Factory method that creates test result object.
A HTTP::WebTest::TestResult object.
Checks test parameters in @params. Throws exception if any of them are invalid.
@params
Checks global test parameters in @params. Throws exception if any of them are invalid.
Checks if $value of test parameter $param has type <$type>.
$value
Dies if check is not successful.
This method should be redefined in the subclasses. Returns information about test parameters that are supported by plugin. Used to validate tests.
A string that looks like:
'param1 type1 param2 type2 param3 type3(optional,args) param4 type4'
Method that checks whether test parameter value is of anything type.
anything
This is NOOP operation. It always succeed.
Method that checks whether test parameter value is of list type. That is it is a reference on an array.
list
Optional list @optional_spec can define specification on allowed elements of list. It can be either
@optional_spec
('TYPE_1', 'TYPE_2', ..., 'TYPE_N')
or
('TYPE_1', 'TYPE_2', ..., 'TYPE_M', '...')
First specification requires list value of test parameter to contain N elements. First element of list should be of should TYPE_1 type, second element of list should of TYPE_2 type, ..., N-th element of list should be of TYPE_N type.
N
TYPE_1
TYPE_2
TYPE_N
Second specification requires list value of test parameter to contain at least N elements. First element of list should be of should TYPE_1 type, second element of list should of TYPE_2 type, ..., M-th element of list should be of TYPE_M type, all following elements should be of TYPE_M type.
TYPE_M
Dies if checks is not successful.
Method that checks whether test parameter value is of scalar type (that is it is usual Perl scalar and is not a reference).
scalar
If $optional_regexp is specified also checks value of parameter using this regual expression.
$optional_regexp
Method that checks whether test parameter value is of stringref type (that is it is a reference on scalar).
stringref
Method that checks whether test parameter value is of uri type (that is it either scalar or URI object).
uri
Method that checks whether test parameter value is of hashlist type (that is it is either a hash reference or an array reference that points to array containing even number of elements).
hashlist
Same as
check_scalar($param, $value, '^(?:yes|no)$');
Copyright (c) 2001-2003 Ilya Martynov. All rights reserved.
This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
HTTP::WebTest
HTTP::WebTest::API
HTTP::WebTest::Plugins
HTTP::WebTest::ReportPlugin
To install HTTP::WebTest, copy and paste the appropriate command in to your terminal.
cpanm
cpanm HTTP::WebTest
CPAN shell
perl -MCPAN -e shell install HTTP::WebTest
For more information on module installation, please visit the detailed CPAN module installation guide.