.\" -*- mode: troff; coding: utf-8 -*- .\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. .ie n \{\ . ds C` "" . ds C' "" 'br\} .el\{\ . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" ======================================================================== .\" .IX Title "Perl::Critic::Policy::TestingAndDebugging::RequireTestLabels 3pm" .TH Perl::Critic::Policy::TestingAndDebugging::RequireTestLabels 3pm 2023-07-26 "perl v5.38.0" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH NAME Perl::Critic::Policy::TestingAndDebugging::RequireTestLabels \- Tests should all have labels. .SH AFFILIATION .IX Header "AFFILIATION" This Policy is part of the core Perl::Critic distribution. .SH DESCRIPTION .IX Header "DESCRIPTION" Most Perl modules with regression tests use Test::More as infrastructure for writing and running those tests. It has an easy, procedural syntax for writing comparisons of results to expectations. .PP Most of the Test::More functions allow the programmer to add an optional label that describes what each test is trying to judge. When a test goes wrong, these labels are very useful for quickly determining where the problem originated. .PP This policy enforces that all Test::More functions have labels where applicable. This only applies to code that has a \f(CW\*(C`use Test::More\*(C'\fR or \&\f(CW\*(C`require Test::More\*(C'\fR declaration (see below to add more test modules to the list). .SH CONFIGURATION .IX Header "CONFIGURATION" A list of additional modules to require label parameters be passed to their methods can be specified with the \f(CW\*(C`modules\*(C'\fR option. The list must consist of whitespace-delimited, fully-qualified module names. For example: .PP .Vb 2 \& [TestingAndDebugging::RequireTestLabels] \& modules = My::Test::SubClass Some::Other::Module .Ve .PP The module list always implicitly includes Test::More. .SH AUTHOR .IX Header "AUTHOR" Chris Dolan .SH COPYRIGHT .IX Header "COPYRIGHT" Copyright (c) 2006\-2021 Chris Dolan. .PP This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.