Debian Codegraph @

upstream/debian-unstable/man3/Test2::Plugin::SRand.3perl

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\" ========================================================================
56 .\"
57 .IX Title "Test2::Plugin::SRand 3perl"
58 .TH Test2::Plugin::SRand 3perl 2025-11-16 "perl v5.40.1" "Perl Programmers Reference Guide"
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SH NAME
64 Test2::Plugin::SRand \- Control the random seed for more controlled test
65 environments.
66 .SH DESCRIPTION
67 .IX Header "DESCRIPTION"
68 This module gives you control over the random seed used for your unit tests. In
69 some testing environments the random seed can play a major role in results.
70 .PP
71 The default configuration for this module will seed srand with the local date.
72 Using the date as the seed means that on any given day the random seed will
73 always be the same, this means behavior will not change from run to run on a
74 given day. However the seed is different on different days allowing you to be
75 sure the code still works with actual randomness.
76 .PP
77 The seed is printed for you on failure, or when the harness is verbose. You can
78 use the \f(CW\*(C`T2_RAND_SEED\*(C'\fR environment variable to specify the seed. You can also
79 provide a specific seed as a load-time argument to the plugin.
80 .SH SYNOPSIS
81 .IX Header "SYNOPSIS"
82 Loading the plugin is easy, and the defaults are sane:
83 .PP
84 .Vb 1
85 \& use Test2::Plugin::SRand;
86 .Ve
87 .PP
88 Custom seed:
89 .PP
90 .Vb 1
91 \& use Test2::Plugin::SRand seed => 42;
92 .Ve
93 .SH "NOTE ON LOAD ORDER"
94 .IX Header "NOTE ON LOAD ORDER"
95 If you use this plugin you probably want to use it as the first, or near-first
96 plugin. \f(CW\*(C`srand\*(C'\fR is not called until the plugin is loaded, so other plugins
97 loaded first may already be making use of random numbers before your seed
98 takes effect.
99 .SH CAVEATS
100 .IX Header "CAVEATS"
101 When srand is on (default) it can cause problems with things like File::Temp
102 which will end up attempting the same "random" filenames for every test process
103 started on a given day (or sharing the same seed).
104 .SH SOURCE
105 .IX Header "SOURCE"
106 The source code repository for Test2\-Suite can be found at
107 \&\fIhttps://github.com/Test\-More/Test2\-Suite/\fR.
108 .SH MAINTAINERS
109 .IX Header "MAINTAINERS"
110 .IP "Chad Granum <[email protected]>" 4
111 .IX Item "Chad Granum <[email protected]>"
112 .SH AUTHORS
113 .IX Header "AUTHORS"
114 .PD 0
115 .IP "Chad Granum <[email protected]>" 4
116 .IX Item "Chad Granum <[email protected]>"
117 .PD
118 .SH COPYRIGHT
119 .IX Header "COPYRIGHT"
120 Copyright 2018 Chad Granum <[email protected]>.
121 .PP
122 This program is free software; you can redistribute it and/or
123 modify it under the same terms as Perl itself.
124 .PP
125 See \fIhttp://dev.perl.org/licenses/\fR