NAME

VERSION

FEATURES

• Test subroutines to implement unit-tests to time that your code executes before a specified threshold
• Test subroutines to implement unit-tests to time that your code execution exceeds a specified threshold
• Test subroutine to implement unit-tests to time that your code executes within a specified time frame
• Supports measurements in seconds
• Implements configurable alarm signal handler to make sure that your tests do not execute forever

SYNOPSIS

    use Test::Timer;

    time_ok( sub { doYourStuffButBeQuickAboutIt(); }, 1, 'threshold of one second');

    time_atmost( sub { doYourStuffYouHave10Seconds(); }, 10, 'threshold of 10 seconds');

    time_between( sub { doYourStuffYouHave5-10Seconds(); }, 5, 10,
        'lower threshold of 5 seconds and upper threshold of 10 seconds');

    # Will succeed
    time_nok( sub { sleep(2); }, 1, 'threshold of one second');

    time_atleast( sub { sleep(2); }, 2, 'threshold of one second');

    # Will fail after 5 (threshold) + 2 seconds (default alarm)
    time_ok( sub { while(1) { sleep(1); } }, 5, 'threshold of one second');

    $test::Timer::alarm = 6 #default 2 seconds

    # Will fail after 5 (threshold) + 6 seconds (specified alarm)
    time_ok( sub { while(1) { sleep(1); } }, 5, 'threshold of one second');

DESCRIPTION

The key features are subroutines to assert or test the following:

• that a given piece of code does not exceed a specified time limit
• that a given piece of code takes longer than a specified time limit and does not exceed another

EXPORT

• time_ok
• time_nok
• time_atleast
• time_atmost
• time_between

SUBROUTINES/METHODS

    time_nok( sub { sleep(2); }, 1, 'threshold of one second');

    Test ran 2 seconds and exceeded specified threshold of 1 seconds

    time_nok( sub { sleep(1); }, 2, 'threshold of two seconds');

    Test ran 1 seconds and did not exceed specified threshold of 2 seconds

    time_atmost( sub { doYourStuffButBeQuickAboutIt(); }, 1, 'threshold of one second');

    Test ran N seconds and exceeded specified threshold of 1 seconds

    time_atleast( sub { doYourStuffAndTakeYourTimeAboutIt(); }, 1, 'threshold of 1 second');

    Test ran 1 seconds and did not exceed specified threshold of 2 seconds

    $Test::Timer::alarm = $my_alarm_in_seconds;

    time_between( sub { sleep(2); }, 5, 10,
        'lower threshold of 5 seconds and upper threshold of 10 seconds');

    Test ran 2 seconds and did not execute within specified interval 5 - 10 seconds

    Test ran 12 seconds and did not execute within specified interval 5 - 10 seconds

PRIVATE FUNCTIONS

DIAGNOSTICS

• Test did not exceed specified threshold, this message is diagnosis for time_atleast and time_nok tests, which do not exceed their specified threshold
• Test exceeded specified threshold, this message is a diagnostic for time_atmost and time_ok, if the specified threshold is surpassed.

  This is the key point of the module, either your code is too slow and you should address this or your threshold is too low, in which case you can set it a bit higher and run the test again.

• Test did not execute within specified interval, this is the diagnostic from time_between, it is the diagnosis if the execution of the code is not between the specified lower and upper thresholds
• Insufficient parameters, this is the message if a specified test is not provided with the sufficient number of parameters, consult this documentation and correct accordingly
• Execution exceeded threshold and timed out, the exception is thrown if the execution of tested code exceeds even the alarm, which is default 2 seconds, but can be set by the user or is equal to the upper threshold + 2 seconds

  The exception results in a diagnostic for the failing test. This is a fail-safe to avoid that code runs forever. If you get this diagnose either your code is too slow and you should address this or it might be error prone. If this is not the case adjust the alarm setting to suit your situation.

CONFIGURATION AND ENVIRONMENT

Tests are sensitive and be configured using environment and configuration files, please see the section on test and quality.

DEPENDENCIES

• Carp
• Benchmark
• Error
• Test::Builder
• Test::Builder::Module

INCOMPATIBILITIES

BUGS AND LIMITATIONS

The current implementations only use seconds and resolutions should be higher, so the current implementation is limited to seconds as the highest resolution.

On occasion failing tests with CPAN-testers have been observed. This seem to be related to the test-suite being not taking into account that some smoke-testers do not prioritize resources for the test run and that additional processes/jobs are running. The test-suite have been adjusted to accommodate this but these issues might reoccur.

TEST AND QUALITY

    ---------------------------- ------ ------ ------ ------ ------ ------ ------
    File                           stmt   bran   cond    sub    pod   time  total
    ---------------------------- ------ ------ ------ ------ ------ ------ ------
    blib/lib/Test/Timer.pm        100.0  100.0  100.0  100.0  100.0   99.9  100.0
    ...Timer/TimeoutException.pm  100.0    n/a    n/a  100.0  100.0    0.0  100.0
    Total                         100.0  100.0  100.0  100.0  100.0  100.0  100.0
    ---------------------------- ------ ------ ------ ------ ------ ------ ------

The Test::Perl::Critic test runs with severity 5 (gentle) for now, please refer to t/critic.t and t/perlcriticrc.

Set TEST_POD to enable Test::Pod test in t/pod.t and Test::Pod::Coverage test in t/pod-coverage.t.

Set TEST_CRITIC to enable Test::Perl::Critic test in t/critic.t

SEE ALSO

•

Test::Benchmark

ISSUE REPORTING

•

GitHub Issues <https://github.com/jonasbn/perl-test-timer/issues>

SUPPORT

    perldoc Test::Timer

You can also look for information at:

• Homepage <https://jonasbn.github.io/perl-test-timer/>
• MetaCPAN <https://metacpan.org/pod/Test-Timer>
• AnnoCPAN: Annotated CPAN documentation <http://annocpan.org/dist/Test-Timer>
• CPAN Ratings <http://cpanratings.perl.org/d/Test-Timer>

DEVELOPMENT

•

GitHub Repository <https://github.com/jonasbn/perl-test-timer>, please see the guidelines for contributing <https://github.com/jonasbn/perl-test-timer/blob/master/CONTRIBUTING.md>.

AUTHOR

•

Jonas Brømsø (jonasbn) "<jonasbn at cpan.org>"

ACKNOWLEDGEMENTS

• Mohammad S Anwar (MANWAR), POD corrections PRs #23
• Erik Johansen (UNIEJO), suggestion for clearing alarm
• Gregor Herrmann (GREGOA) from the Debian Perl Group, PR #16 fixes to spelling mistakes
• Nigel Horne (NHORNE), issue #15 suggestion for better assertion in time_atleast
• Nigel Horne (NHORNE), issue #10/#12 suggestion for improvement to diagnostics
• p-alik, PR #4 eliminating warnings during test
• Kent Fredric (KENTNL), PR #7 addressing file permissions
• Nick Morrott, PR #5 corrections to POD
• Bartosz Jakubski, reporting issue #3
• Gabor Szabo (SZABGAB), suggestion for specification of interval thresholds even though this was obsoleted by the later introduced time_between
• Paul Leonerd Evans (PEVANS), suggestions for time_atleast and time_atmost and the handling of $SIG{ALRM}. Also bug report for addressing issue with Debian packaging resulting in release 0.10
• brian d foy (BDFOY), for patch to _runtest

LICENSE AND COPYRIGHT

Test::Timer and related modules are released under the Artistic License 2.0

Used distributions are under copyright of there respective authors and designated licenses

Image used on website <https://jonasbn.github.io/perl-test-timer/> is under copyright by Veri Ivanova <https://unsplash.com/photos/p3Pj7jOYvnM>