1Test::Type(3) User Contributed Perl Documentation Test::Type(3)
2
6 Test::Type - Functions to validate data types in test files.
7
9 Version 1.3.0
10
12 use Test::Type;
13 # Test strings.
15 ok_string( $variable );
16 ok_string(
17 $variable,
18 name => 'My variable',
19 );
20 # Test arrayrefs.
22 ok_arrayref( $variable );
23 ok_arrayref(
24 $variable,
25 name => 'My variable',
26 );
27 # Test hashrefs.
29 ok_hashref( $variable );
30 ok_hashref(
31 $variable,
32 name => 'Test variable',
33 );
34 # Test coderefs.
36 ok_coderef( $variable );
37 ok_coderef(
38 $variable,
39 name => 'Test variable',
40 );
41 # Test numbers.
43 ok_number( $variable );
44 ok_number(
45 $variable,
46 name => 'Test variable',
47 );
48 # Test instances.
50 ok_instance(
51 $variable,
52 class => $class,
53 );
54 ok_instance(
55 $variable,
56 name => 'Test variable',
57 class => $class,
58 );
59 # Test regular expressions.
61 ok_regex( $variable );
62 ok_regex(
63 $variable,
64 name => 'Test regular expression',
65 );
66
68 ok_string()
69 Test if the variable passed is a string.
70 ok_string(
72 $variable,
73 );
74 ok_string(
76 $variable,
77 name => 'My variable',
78 );
79 ok_string(
81 $variable,
82 name => 'My variable',
83 allow_empty => 1,
84 );
85 Parameters:
87 • name
89 Optional, the name of the variable being tested.
91 • allow_empty
93 Boolean, default 1. Allow the string to be empty or not.
95 ok_arrayref()
97 Test if the variable passed is an arrayref that can be dereferenced
98 into an array.
99 ok_arrayref( $variable );
101 ok_arrayref(
103 $variable,
104 name => 'My variable',
105 );
106 ok_arrayref(
108 $variable,
109 allow_empty => 1,
110 no_blessing => 0,
111 );
112 # Check if the variable is an arrayref of hashrefs.
114 ok_arrayref(
115 $variable,
116 allow_empty => 1,
117 no_blessing => 0,
118 element_validate_type =>
119 sub
120 {
121 return Data::Validate::Type::is_hashref( $_[0] );
122 },
123 );
124 Parameters:
126 • name
128 Optional, the name of the variable being tested.
130 • allow_empty
132 Boolean, default 1. Allow the array to be empty or not.
134 • no_blessing
136 Boolean, default 0. Require that the variable is not blessed.
138 • element_validate_type
140 None by default. Set it to a coderef to validate the elements in
142 the array. The coderef will be passed the element to validate as
143 first parameter, and it must return a boolean indicating whether
144 the element was valid or not.
145 ok_hashref()
147 Test if the variable passed is a hashref that can be dereferenced into
148 a hash.
149 ok_hashref( $variable );
151 ok_hashref(
153 $variable,
154 name => 'Test variable',
155 );
156 ok_hashref(
158 $variable,
159 allow_empty => 1,
160 no_blessing => 0,
161 );
162 Parameters:
164 • name
166 Optional, the name of the variable being tested.
168 • allow_empty
170 Boolean, default 1. Allow the array to be empty or not.
172 • no_blessing
174 Boolean, default 0. Require that the variable is not blessed.
176 ok_coderef()
178 Test if the variable passed is an coderef that can be dereferenced into
179 a block of code.
180 ok_coderef( $variable );
182 ok_coderef(
184 $variable,
185 name => 'Test variable',
186 );
187 Parameters:
189 • name
191 Optional, the name of the variable being tested.
193 ok_number()
195 Test if the variable passed is a number.
196 ok_number( $variable );
198 ok_number(
200 $variable,
201 name => 'Test variable',
202 );
203 ok_number(
205 $variable,
206 positive => 1,
207 );
208 ok_number(
210 $variable,
211 strictly_positive => 1,
212 );
213 Parameters:
215 • name
217 Optional, the name of the variable being tested.
219 • strictly_positive
221 Boolean, default 0. Set to 1 to check for a strictly positive
223 number.
224 • positive
226 Boolean, default 0. Set to 1 to check for a positive number.
228 ok_instance()
230 Test if the variable is an instance of the given class.
231 Note that this handles inheritance properly, so it will succeed if the
233 variable is an instance of a subclass of the class given.
234 ok_instance(
236 $variable,
237 class => $class,
238 );
239 ok_instance(
241 $variable,
242 name => 'Test variable',
243 class => $class,
244 );
245 Parameters:
247 • name
249 Optional, the name of the variable being tested.
251 • class
253 Required, the name of the class to check the variable against.
255 ok_regex()
257 Test if the variable is a regular expression.
258 ok_regex( $variable );
260
262 Please report any bugs or feature requests to
263 "bug-test-dist-versionsync at rt.cpan.org", or through the web
264 interface at
265 <http://rt.cpan.org/NoAuth/ReportBug.html?Queue=test-type>. I will be
266 notified, and then you'll automatically be notified of progress on your
267 bug as I make changes.
268
270 You can find documentation for this module with the perldoc command.
271 perldoc Test::Type
273 You can also look for information at:
275 • GitHub (report bugs there)
277 <https://github.com/guillaumeaubert/Test-Type/issues>
279 • AnnoCPAN: Annotated CPAN documentation
281 <http://annocpan.org/dist/test-type>
283 • CPAN Ratings
285 <http://cpanratings.perl.org/d/test-type>
287 • Search CPAN
289 <https://metacpan.org/release/Test-Type>
291
293 Guillaume Aubert <https://metacpan.org/author/AUBERTG>, "<aubertg at
294 cpan.org>".
295
297 Copyright 2012-2017 Guillaume Aubert.
298 This code is free software; you can redistribute it and/or modify it
300 under the same terms as Perl 5 itself.
301 This program is distributed in the hope that it will be useful, but
303 WITHOUT ANY WARRANTY; without even the implied warranty of
304 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the LICENSE
305 file for more details.
306perl v5.34.0 2021-07-23 Test::Type(3)