Debian Codegraph @

upstream/debian-unstable/man3/Test2::Manual::Tooling.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::Manual::Tooling 3perl"
58 .TH Test2::Manual::Tooling 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::Manual::Tooling \- Manual page for tool authors.
65 .SH DESCRIPTION
66 .IX Header "DESCRIPTION"
67 This section covers writing new tools, plugins, and other Test2 components.
68 .SH "TOOL TUTORIALS"
69 .IX Header "TOOL TUTORIALS"
70 .SS "FIRST TOOL"
71 .IX Subsection "FIRST TOOL"
72 Test2::Manual::Tooling::FirstTool \- Introduction to writing tools by cloning
73 \&\fBok()\fR.
74 .SS "MOVING FROM Test::Builder"
75 .IX Subsection "MOVING FROM Test::Builder"
76 Test2::Manual::Tooling::TestBuilder \- This section maps Test::Builder
77 methods to Test2 concepts.
78 .SS "NESTING TOOLS"
79 .IX Subsection "NESTING TOOLS"
80 Test2::Manual::Tooling::Nesting \- How to call other tools from your tool.
81 .SS "TOOLS WITH SUBTESTS"
82 .IX Subsection "TOOLS WITH SUBTESTS"
83 Test2::Manual::Tooling::Subtest \- How write tools that make use of subtests.
84 .SS "TESTING YOUR TEST TOOLS"
85 .IX Subsection "TESTING YOUR TEST TOOLS"
86 Test2::Manual::Tooling::Testing \- How to write tests for your test tools.
87 .SH "PLUGIN TUTORIALS"
88 .IX Header "PLUGIN TUTORIALS"
89 .SS "TAKING ACTION WHEN A NEW TOOL STARTS"
90 .IX Subsection "TAKING ACTION WHEN A NEW TOOL STARTS"
91 Test2::Manual::Tooling::Plugin::ToolStarts \- How to add behaviors that occur
92 when a tool starts work.
93 .SS "TAKING ACTION AFTER A TOOL IS DONE"
94 .IX Subsection "TAKING ACTION AFTER A TOOL IS DONE"
95 Test2::Manual::Tooling::Plugin::ToolCompletes \- How to add behaviors that
96 occur when a tool completes work.
97 .SS "TAKING ACTION AT THE END OF TESTING"
98 .IX Subsection "TAKING ACTION AT THE END OF TESTING"
99 Test2::Manual::Tooling::Plugin::TestingDone \- How to add behaviors that
100 occur when testing is complete (IE done_testing, or end of test).
101 .SS "TAKING ACTION JUST BEFORE EXIT"
102 .IX Subsection "TAKING ACTION JUST BEFORE EXIT"
103 Test2::Manual::Tooling::Plugin::TestExit \- How to safely add pre-exit
104 behaviors.
105 .SH "WRITING A SIMPLE JSONL FORMATTER"
106 .IX Header "WRITING A SIMPLE JSONL FORMATTER"
107 Test2::Manual::Tooling::Formatter \- How to write a custom formatter, in our
108 case a JSONL formatter.
109 .SH "WHERE TO FIND HOOKS AND APIS"
110 .IX Header "WHERE TO FIND HOOKS AND APIS"
111 .IP "global API" 4
112 .IX Item "global API"
113 Test2::API is the global API. This is primarily used by plugins that provide
114 global behavior.
115 .IP "In hubs" 4
116 .IX Item "In hubs"
117 Test2::Hub is the base class for all hubs. This is where hooks for
118 manipulating events, or running things at the end of testing live.
119 .SH "SEE ALSO"
120 .IX Header "SEE ALSO"
121 Test2::Manual \- Primary index of the manual.
122 .SH SOURCE
123 .IX Header "SOURCE"
124 The source code repository for Test2\-Manual can be found at
125 \&\fIhttps://github.com/Test\-More/Test2\-Suite/\fR.
126 .SH MAINTAINERS
127 .IX Header "MAINTAINERS"
128 .IP "Chad Granum <[email protected]>" 4
129 .IX Item "Chad Granum <[email protected]>"
130 .SH AUTHORS
131 .IX Header "AUTHORS"
132 .PD 0
133 .IP "Chad Granum <[email protected]>" 4
134 .IX Item "Chad Granum <[email protected]>"
135 .PD
136 .SH COPYRIGHT
137 .IX Header "COPYRIGHT"
138 Copyright 2018 Chad Granum <[email protected]>.
139 .PP
140 This program is free software; you can redistribute it and/or
141 modify it under the same terms as Perl itself.
142 .PP
143 See \fIhttp://dev.perl.org/licenses/\fR