Debian Codegraph @

upstream/mageia-cauldron/man3pm/Test2::Tools::Defer.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::Tools::Defer 3pm"
61 .TH Test2::Tools::Defer 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::Tools::Defer \- Write tests that get executed at a later time
68 .SH DESCRIPTION
69 .IX Header "DESCRIPTION"
70 Sometimes you need to test things BEFORE loading the necessary functions. This
71 module lets you do that. You can write tests, and then have them run later,
72 after \f(CW\*(C`Test2\*(C'\fR is loaded. You tell it what test function to run, and what
73 arguments to give it. The function name and arguments will be stored to be
74 executed later. When ready, run \f(CWdo_def()\fR to kick them off once the functions
75 are defined.
76 .SH SYNOPSIS
77 .IX Header "SYNOPSIS"
78 .Vb 2
79 \& use strict;
80 \& use warnings;
81 \&
82 \& use Test2::Tools::Defer;
83 \&
84 \& BEGIN {
85 \& def ok => (1, \*(Aqpass\*(Aq);
86 \& def is => (\*(Aqfoo\*(Aq, \*(Aqfoo\*(Aq, \*(Aqruns is\*(Aq);
87 \& ...
88 \& }
89 \&
90 \& use Test2::Tools::Basic;
91 \&
92 \& do_def(); # Run the tests
93 \&
94 \& # Declare some more tests to run later:
95 \& def ok => (1, "another pass");
96 \& ...
97 \&
98 \& do_def(); # run the new tests
99 \&
100 \& done_testing;
101 .Ve
102 .SH EXPORTS
103 .IX Header "EXPORTS"
104 .ie n .IP "def function => @args;" 4
105 .el .IP "def function => \f(CW@args\fR;" 4
106 .IX Item "def function => @args;"
107 This will store the function name, and the arguments to be run later. Note that
108 each package has a separate store of tests to run.
109 .IP \fBdo_def()\fR 4
110 .IX Item "do_def()"
111 This will run all the stored tests. It will also reset the list to be empty so
112 you can add more tests to run even later.
113 .SH SOURCE
114 .IX Header "SOURCE"
115 The source code repository for Test2\-Suite can be found at
116 \&\fIhttps://github.com/Test\-More/test\-more/\fR.
117 .SH MAINTAINERS
118 .IX Header "MAINTAINERS"
119 .IP "Chad Granum <[email protected]>" 4
120 .IX Item "Chad Granum <[email protected]>"
121 .SH AUTHORS
122 .IX Header "AUTHORS"
123 .IP "Chad Granum <[email protected]>" 4
124 .IX Item "Chad Granum <[email protected]>"
125 .SH COPYRIGHT
126 .IX Header "COPYRIGHT"
127 Copyright Chad Granum <[email protected]>.
128 .PP
129 This program is free software; you can redistribute it and/or
130 modify it under the same terms as Perl itself.
131 .PP
132 See \fIhttp://dev.perl.org/licenses/\fR