Debian Codegraph @

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