Debian Codegraph @

upstream/debian-unstable/man3/Test2::Require.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::Require 3perl"
58 .TH Test2::Require 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::Require \- Base class and documentation for skip\-unless type test
65 packages.
66 .SH DESCRIPTION
67 .IX Header "DESCRIPTION"
68 Test2::Require::* packages are packages you load to ensure your test file is
69 skipped unless a specific requirement is met. Modules in this namespace may
70 subclass Test2::Require if they wish, but it is not strictly necessary to do
71 so.
72 .SH "HOW DO I WRITE A 'REQUIRE' MODULE?"
73 .IX Header "HOW DO I WRITE A 'REQUIRE' MODULE?"
74 .SS "AS A SUBCLASS"
75 .IX Subsection "AS A SUBCLASS"
76 .Vb 3
77 \& package Test2::Require::Widget;
78 \& use strict;
79 \& use warnings;
80 \&
81 \& use base \*(AqTest2::Require\*(Aq;
82 \&
83 \& sub HAVE_WIDGETS { ... };
84 \&
85 \& sub skip {
86 \& my $class = shift;
87 \& my @import_args = @_;
88 \&
89 \& if (HAVE_WIDGETS()) {
90 \& # We have widgets, do not skip
91 \& return undef;
92 \& }
93 \& else {
94 \& # No widgets, skip the test
95 \& return "Skipped because there are no widgets" unless HAVE_WIDGETS();
96 \& }
97 \& }
98 \&
99 \& 1;
100 .Ve
101 .PP
102 A subclass of Test2::Require simply needs to implement a \f(CWskip()\fR method.
103 This method will receive all import arguments. This method should return undef
104 if the test should run, and should return a reason for skipping if the test
105 should be skipped.
106 .SS STAND-ALONE
107 .IX Subsection "STAND-ALONE"
108 If you do not wish to subclass Test2::Require then you should write an
109 \&\f(CWimport()\fR method:
110 .PP
111 .Vb 3
112 \& package Test2::Require::Widget;
113 \& use strict;
114 \& use warnings;
115 \&
116 \& use Test2::API qw/context/;
117 \&
118 \& sub HAVE_WIDGETS { ... };
119 \&
120 \& sub import {
121 \& my $class = shift;
122 \&
123 \& # Have widgets, should run.
124 \& return if HAVE_WIDGETS();
125 \&
126 \& # Use the context object to create the event
127 \& my $ctx = context();
128 \& $ctx\->plan(0, SKIP => "Skipped because there are no widgets");
129 \& $ctx\->release;
130 \& }
131 \&
132 \& 1;
133 .Ve
134 .SH SOURCE
135 .IX Header "SOURCE"
136 The source code repository for Test2\-Suite can be found at
137 \&\fIhttps://github.com/Test\-More/Test2\-Suite/\fR.
138 .SH MAINTAINERS
139 .IX Header "MAINTAINERS"
140 .IP "Chad Granum <[email protected]>" 4
141 .IX Item "Chad Granum <[email protected]>"
142 .SH AUTHORS
143 .IX Header "AUTHORS"
144 .PD 0
145 .IP "Chad Granum <[email protected]>" 4
146 .IX Item "Chad Granum <[email protected]>"
147 .PD
148 .SH COPYRIGHT
149 .IX Header "COPYRIGHT"
150 Copyright 2018 Chad Granum <[email protected]>.
151 .PP
152 This program is free software; you can redistribute it and/or
153 modify it under the same terms as Perl itself.
154 .PP
155 See \fIhttp://dev.perl.org/licenses/\fR