Debian Codegraph @

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