1Test::Timer(3) User Contributed Perl Documentation Test::Timer(3)
2
6 Test::Timer - test module to test/assert response times
7
9 The documentation describes version 2.09 of Test::Timer
10
12 · Test subroutines to implement unit-tests to time that your code
13 executes before a specified threshold
14 · Test subroutines to implement unit-tests to time that your code
16 execution exceeds a specified threshold
17 · Test subroutine to implement unit-tests to time that your code
19 executes within a specified time frame
20 · Supports measurements in seconds
22 · Implements configurable alarm signal handler to make sure that your
24 tests do not execute forever
25
27 use Test::Timer;
28 time_ok( sub { doYourStuffButBeQuickAboutIt(); }, 1, 'threshold of one second');
30 time_atmost( sub { doYourStuffYouHave10Seconds(); }, 10, 'threshold of 10 seconds');
32 time_between( sub { doYourStuffYouHave5-10Seconds(); }, 5, 10,
34 'lower threshold of 5 seconds and upper threshold of 10 seconds');
35 # Will succeed
37 time_nok( sub { sleep(2); }, 1, 'threshold of one second');
38 time_atleast( sub { sleep(2); }, 2, 'threshold of one second');
40 # Will fail after 5 (threshold) + 2 seconds (default alarm)
42 time_ok( sub { while(1) { sleep(1); } }, 5, 'threshold of one second');
43 $test::Timer::alarm = 6 #default 2 seconds
45 # Will fail after 5 (threshold) + 6 seconds (specified alarm)
47 time_ok( sub { while(1) { sleep(1); } }, 5, 'threshold of one second');
48
50 Test::Timer implements a set of test primitives to test and assert test
51 times from bodies of code.
52 The key features are subroutines to assert or test the following:
54 · that a given piece of code does not exceed a specified time limit
56 · that a given piece of code takes longer than a specified time limit
58 and does not exceed another
59
61 Test::Timer exports:
62 · time_ok
64 · time_nok
66 · time_atleast
68 · time_atmost
70 · time_between
72
74 time_ok
75 Takes the following parameters:
76 · a reference to a block of code (anonymous sub)
78 · a threshold specified as a integer indicating a number of seconds
80 · a string specifying a test name
82 time_nok( sub { sleep(2); }, 1, 'threshold of one second');
84 If the execution of the code exceeds the threshold specified the test
86 fail with the following diagnostic message
87 Test ran 2 seconds and exceeded specified threshold of 1 seconds
89 time_nok
91 The is the inverted variant of time_ok, it passes if the threshold is
92 exceeded and fails if the benchmark of the code is within the specified
93 timing threshold.
94 The API is the same as for time_ok.
96 time_nok( sub { sleep(1); }, 2, 'threshold of two seconds');
98 If the execution of the code executes below the threshold specified the
100 test fail with the following diagnostic message
101 Test ran 1 seconds and did not exceed specified threshold of 2 seconds
103 time_atmost
105 This is syntactic sugar for time_ok
106 time_atmost( sub { doYourStuffButBeQuickAboutIt(); }, 1, 'threshold of one second');
108 If the execution of the code exceeds the threshold specified the test
110 fail with the following diagnostic message
111 Test ran N seconds and exceeded specified threshold of 1 seconds
113 N will be the actual measured execution time of the specified code
115 time_atleast
117 time_atleast( sub { doYourStuffAndTakeYourTimeAboutIt(); }, 1, 'threshold of 1 second');
118 The test succeeds if the code takes at least the number of seconds
120 specified by the timing threshold.
121 If the code executes faster, the test fails with the following
123 diagnosic message
124 Test ran 1 seconds and did not exceed specified threshold of 2 seconds
126 Please be aware that Test::Timer, breaks the execution with an alarm
128 specified to trigger after the specified threshold + 2 seconds
129 (default), so if you expect your execution to run longer, set the alarm
130 accordingly.
131 $Test::Timer::alarm = $my_alarm_in_seconds;
133 See also diagnostics.
135 time_between
137 This method is a more extensive variant of time_atmost and time_ok, you
138 can specify a lower and upper threshold, the code has to execute within
139 this interval in order for the test to succeed
140 time_between( sub { sleep(2); }, 5, 10,
142 'lower threshold of 5 seconds and upper threshold of 10 seconds');
143 If the code executes faster than the lower threshold or exceeds the
145 upper threshold, the test fails with the following diagnosic message
146 Test ran 2 seconds and did not execute within specified interval 5 - 10 seconds
148 Or
150 Test ran 12 seconds and did not execute within specified interval 5 - 10 seconds
152
154 _runtest
155 This is a method to handle the result from _benchmark is initiates the
156 benchmark calling benchmark and based on whether it is within the
157 provided interval true (1) is returned and if not false (0).
158 _benchmark
160 This is the method doing the actual benchmark, if a better method is
161 located this is the place to do the handy work.
162 Currently Benchmark is used. An alternative could be Devel::Timer, but
164 I do not know this module very well and Benchmark is core, so this is
165 used for now.
166 The method takes two parameters:
168 · a code block via a code reference
170 · a threshold (the upper threshold, since this is added to the
172 default alarm.
173 _timestring2time
175 This is the method extracts the seconds from benchmarks timestring and
176 returns it as an integer.
177 It takes the timestring from _benchmark (Benchmark) and returns the
179 seconds part.
180 import
182 Test::Builder required import to do some import hokus-pokus for the
183 test methods exported from Test::Timer. Please refer to the
184 documentation in Test::Builder
185
187 All tests either fail or succeed, but a few exceptions are implemented,
188 these are listed below.
189 · Test did not exceed specified threshold, this message is diagnosis
191 for time_atleast and time_nok tests, which do not exceed their
192 specified threshold.
193 · Test exceeded specified threshold, this message is a diagnostic for
195 time_atmost and time_ok, if the specified threshold is surpassed.
196 This is the key point of the module, either your code is too slow
198 and you should address this or your threshold is too low, in which
199 case you can set it a bit higher and run the test again.
200 · Test did not execute within specified interval, this is the
202 diagnostic from time_between, it is the diagnosis if the execution
203 of the code is not between the specified lower and upper
204 thresholds.
205 · Insufficient parameters, this is the message if a specified test is
207 not provided with the sufficient number of parameters, consult this
208 documentation and correct accordingly.
209 · Execution exceeded threshold and timed out, the exception is thrown
211 if the execution of tested code exceeds even the alarm, which is
212 default 2 seconds, but can be set by the user or is equal to the
213 upperthreshold + 2 seconds.
214 The exception results in a diagnostic for the failing test. This is
216 a failsafe to avoid that code runs forever. If you get this
217 diagnose either your code is too slow and you should address this
218 or it might be error prone. If this is not the case adjust the
219 alarm setting to suit your situation.
220
222 This module requires no special configuration or environment.
223 Tests are sensitive and be configured using environment and
225 configuration files, please see the section on test and quality.
226
228 · Carp
229 · Benchmark
231 · Error
233 · Test::Builder
235 · Test::Builder::Module
237
239 This module holds no known incompatibilities.
240
242 This module holds no known bugs.
243 The current implementations only use seconds and resolutions should be
245 higher, so the current implementation is limited to seconds as the
246 highest resolution.
247 On occassion failing tests with CPAN-testers have been observed. This
249 seem to be related to the test-suite being not taking into account that
250 some smoke-testers do not prioritize resources for the test run and
251 that additional processes/jobs are running. The test-suite have been
252 adjusted to accommodate this but these issues might reoccur.
253
255 Coverage report for the release described in this documentation (see
256 VERSION).
257 ---------------------------- ------ ------ ------ ------ ------ ------ ------
259 File stmt bran cond sub pod time total
260 ---------------------------- ------ ------ ------ ------ ------ ------ ------
261 blib/lib/Test/Timer.pm 100.0 95.0 66.6 100.0 100.0 99.9 98.0
262 ...Timer/TimeoutException.pm 100.0 n/a n/a 100.0 100.0 0.0 100.0
263 Total 100.0 95.0 66.6 100.0 100.0 100.0 98.4
264 ---------------------------- ------ ------ ------ ------ ------ ------ ------
265 The Test::Perl::Critic test runs with severity 5 (gentle) for now,
267 please refer to t/critic.t and t/perlcriticrc.
268 Set TEST_POD to enable Test::Pod test in t/pod.t and
270 Test::Pod::Coverage test in t/pod-coverage.t.
271 Set TEST_CRITIC to enable Test::Perl::Critic test in t/critic.t
273 CONTINUOUS INTEGRATION
275 This distribution uses Travis for continuous integration testing, the
276 Travis reports are public available.
277
279 · Test::Benchmark
280
282 Please report any bugs or feature requests using Github
283 · Github Issues <https://github.com/jonasbn/perl-test-timer/issues>
285
287 You can find (this) documentation for this module with the "perldoc"
288 command.
289 perldoc Test::Timer
291 You can also look for information at:
293 · Homepage <https://jonasbn.github.io/perl-test-timer/>
295 · MetaCPAN <https://metacpan.org/pod/Test-Timer>
297 · AnnoCPAN: Annotated CPAN documentation
299 <http://annocpan.org/dist/Test-Timer>
300 · CPAN Ratings <http://cpanratings.perl.org/d/Test-Timer>
302
304 · Github Repository <https://github.com/jonasbn/perl-test-timer>,
305 please see the guidelines for contributing
306 <https://github.com/jonasbn/perl-test-
307 timer/blob/master/CONTRIBUTING.md>.
308
310 · Jonas B. Nielsen (jonasbn) "<jonasbn at cpan.org>"
311
313 · Erik Johansen, suggestion for clearing alarm
314 · Gregor Herrmann, PR #16 fixes to spelling mistakes
316 · Nigel Horne, issue #15 suggestion for better assertion in
318 time_atleast
319 · Nigel Horne, issue #10/#12 suggestion for improvement to
321 diagnostics
322 · p-alik, PR #4 eliminating warnings during test
324 · Kent Fredric, PR #7 addressing file permissions
326 · Nick Morrott, PR #5 corrections to POD
328 · Bartosz Jakubski, reporting issue #3
330 · Gabor Szabo (GZABO), suggestion for specification of interval
332 thresholds even though this was obsoleted by the later introduced
333 time_between
334 · Paul Leonerd Evans (PEVANS), suggestions for time_atleast and
336 time_atmost and the handling of $SIG{ALRM}. Also bug report for
337 addressing issue with Debian packaging resulting in release 0.10
338 · brian d foy (BDFOY), for patch to _run_test
340
342 Test::Timer and related modules are (C) by Jonas B. Nielsen, (jonasbn)
343 2007-2017
344 Test::Timer and related modules are released under the Artistic License
346 2.0
347 Used distributions are under copyright of there respective authors and
349 designated licenses
350 Image used on website <https://jonasbn.github.io/perl-test-timer/> is
352 under copyright by Veri Ivanova
353 <https://unsplash.com/@veri_ivanova?photo=p3Pj7jOYvnM>
354perl v5.28.0 2017-11-24 Test::Timer(3)