/usr/share/perl5/Test/MockTime.pod is in libtest-mocktime-perl 0.13-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 | =head1 NAME
Test::MockTime - Replaces actual time with simulated time
=head1 SYNOPSIS
use Test::MockTime qw( :all );
set_relative_time(-600);
# do some tests depending on time increasing from 600 seconds ago
set_absolute_time(0);
# do some more tests depending on time starting from the epoch
# epoch may vary according to platform. see perlport.
set_fixed_time(CORE::time());
# do some more tests depending on time staying at the current actual time
set_absolute_time('1970-01-01T00:00:00Z');
# do some tests depending on time starting at Unix epoch time
set_fixed_time('01/01/1970 00:00:00', '%m/%d/%Y %H:%M:%S');
# do some tests depending on time staying at the Unix epoch time
restore_time();
# resume normal service
=head1 DESCRIPTION
This module was created to enable test suites to test code at specific
points in time. Specifically it overrides localtime, gmtime and time at
compile time and then relies on the user supplying a mock time via
set_relative_time, set_absolute_time or set_fixed_time to alter future
calls to gmtime,time or localtime.
=head1 Functions
=over
=item set_absolute_time
If given a single, numeric argument, the argument is an absolute time (for
example, if 0 is supplied, the absolute time will be the epoch), and
calculates the offset to allow subsequent calls to time, gmtime and localtime
to reflect this.
for example, in the following code
Time::Mock::set_absolute_time(0);
my ($start) = time;
sleep 2;
my ($end) = time;
The $end variable should contain 2 seconds past the epoch;
If given two arguments, the first argument is taken to be an absolute time in
some string format (for example, "01/01/1970 00:00:00"). The second argument
is taken to be a C<strptime> format string (for example, "%m/%d/%Y %H:%M:%S").
If a single argument is given, but that argument is not numeric, a
C<strptime> format string of "%Y-%m-%dT%H:%M:%SZ" is assumed.
for example, in the following code
Time::Mock::set_absolute_time('1970-01-01T00:00:00Z');
my ($start) = time;
sleep 2;
my ($end) = time;
The $end variable should contain 2 seconds past the Unix epoch;
=item set_relative_time($relative)
takes as an argument an relative value from current time (for example, if -10
is supplied, current time be converted to actual machine time - 10 seconds)
and calculates the offset to allow subsequent calls to time,gmtime and localtime
to reflect this.
for example, in the following code
my ($start) = time;
Time::Mock::set_relative_time(-600);
sleep 600;
my ($end) = time;
The $end variable should contain either the same or very similar values to the
$start variable.
=item set_fixed_time
If given a single, numeric argument, the argument is an absolute time (for
example, if 0 is supplied, the absolute time will be the epoch). All
subsequent calls to gmtime, localtime and time will return this value.
for example, in the following code
Time::Mock::set_fixed_time(time)
my ($start) = time;
sleep 3;
my ($end) = time;
the $end variable and the $start variable will contain the same results
If given two arguments, the first argument is taken to be an absolute time in
some string format (for example, "01/01/1970 00:00:00"). The second argument
is taken to be a C<strptime> format string (for example, "%m/%d/%Y %H:%M:%S").
If a single argument is given, but that argument is not numeric, a
C<strptime> format string of "%Y-%m-%dT%H:%M:%SZ" is assumed.
=item restore()
restore the default time handling values. C<restore_time> is an alias. When
exported with the 'all' tag, this subroutine is exported as C<restore_time>.
=back
=head1 AUTHOR
David Dick <ddick@cpan.org>
=head1 PREREQUISITES
Time::Piece 1.08 or greater
=head1 BUGS
Probably.
=head1 COPYRIGHT
This program is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.
=cut
=head1 ACKNOWLEDGEMENTS
Thanks to a use.perl.org journal entry <http://use.perl.org/~geoff/journal/20660> by
Geoffrey Young.
|