Debian Codegraph @

upstream/mageia-cauldron/man3pm/Test2::Plugin::SRand.3pm

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man v6.0.2 (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 .\" Required to disable full justification in groff 1.23.0.
57 .if n .ds AD l
58 .\" ========================================================================
59 .\"
60 .IX Title "Test2::Plugin::SRand 3pm"
61 .TH Test2::Plugin::SRand 3pm 2025-06-24 "perl v5.42.0" "Perl Programmers Reference Guide"
62 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
63 .\" way too many mistakes in technical documents.
64 .if n .ad l
65 .nh
66 .SH NAME
67 Test2::Plugin::SRand \- Control the random seed for more controlled test
68 environments.
69 .SH DESCRIPTION
70 .IX Header "DESCRIPTION"
71 This module gives you control over the random seed used for your unit tests. In
72 some testing environments the random seed can play a major role in results.
73 .PP
74 The default configuration for this module will seed srand with the local date.
75 Using the date as the seed means that on any given day the random seed will
76 always be the same, this means behavior will not change from run to run on a
77 given day. However the seed is different on different days allowing you to be
78 sure the code still works with actual randomness.
79 .PP
80 The seed is printed for you on failure, or when the harness is verbose. You can
81 use the \f(CW\*(C`T2_RAND_SEED\*(C'\fR environment variable to specify the seed. You can also
82 provide a specific seed as a load\-time argument to the plugin.
83 .SH SYNOPSIS
84 .IX Header "SYNOPSIS"
85 Loading the plugin is easy, and the defaults are sane:
86 .PP
87 .Vb 1
88 \& use Test2::Plugin::SRand;
89 .Ve
90 .PP
91 Custom seed:
92 .PP
93 .Vb 1
94 \& use Test2::Plugin::SRand seed => 42;
95 .Ve
96 .SH "NOTE ON LOAD ORDER"
97 .IX Header "NOTE ON LOAD ORDER"
98 If you use this plugin you probably want to use it as the first, or near\-first
99 plugin. \f(CW\*(C`srand\*(C'\fR is not called until the plugin is loaded, so other plugins
100 loaded first may already be making use of random numbers before your seed
101 takes effect.
102 .SH CAVEATS
103 .IX Header "CAVEATS"
104 When srand is on (default) it can cause problems with things like File::Temp
105 which will end up attempting the same "random" filenames for every test process
106 started on a given day (or sharing the same seed).
107 .SH SOURCE
108 .IX Header "SOURCE"
109 The source code repository for Test2\-Suite can be found at
110 \&\fIhttps://github.com/Test\-More/test\-more/\fR.
111 .SH MAINTAINERS
112 .IX Header "MAINTAINERS"
113 .IP "Chad Granum <[email protected]>" 4
114 .IX Item "Chad Granum <[email protected]>"
115 .SH AUTHORS
116 .IX Header "AUTHORS"
117 .IP "Chad Granum <[email protected]>" 4
118 .IX Item "Chad Granum <[email protected]>"
119 .SH COPYRIGHT
120 .IX Header "COPYRIGHT"
121 Copyright Chad Granum <[email protected]>.
122 .PP
123 This program is free software; you can redistribute it and/or
124 modify it under the same terms as Perl itself.
125 .PP
126 See \fIhttp://dev.perl.org/licenses/\fR