local-lib5/man/man3/Test::SubCalls.3pm

   1 .\" Automatically generated by Pod::Man 2.22 (Pod::Simple 3.10)
   2 .\"
   3 .\" Standard preamble:
   4 .\" ========================================================================
   5 .de Sp \" Vertical space (when we can't use .PP)
   6 .if t .sp .5v
   7 .if n .sp
   8 ..
   9 .de Vb \" Begin verbatim text
  10 .ft CW
  11 .nf
  12 .ne \\$1
  13 ..
  14 .de Ve \" End verbatim text
  15 .ft R
  16 .fi
  17 ..
  18 .\" Set up some character translations and predefined strings.  \*(-- will
  19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  20 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
  21 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
  22 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
  23 .\" nothing in troff, for use with C<>.
  24 .tr \(*W-
  25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  26 .ie n \{\
  27 .    ds -- \(*W-
  28 .    ds PI pi
  29 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  30 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  31 .    ds L" ""
  32 .    ds R" ""
  33 .    ds C` ""
  34 .    ds C' ""
  35 'br\}
  36 .el\{\
  37 .    ds -- \|\(em\|
  38 .    ds PI \(*p
  39 .    ds L" ``
  40 .    ds R" ''
  41 'br\}
  42 .\"
  43 .\" Escape single quotes in literal strings from groff's Unicode transform.
  44 .ie \n(.g .ds Aq \(aq
  45 .el       .ds Aq '
  46 .\"
  47 .\" If the F register is turned on, we'll generate index entries on stderr for
  48 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
  49 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  50 .\" output yourself in some meaningful fashion.
  51 .ie \nF \{\
  52 .    de IX
  53 .    tm Index:\\$1\t\\n%\t"\\$2"
  54 ..
  55 .    nr % 0
  56 .    rr F
  57 .\}
  58 .el \{\
  59 .    de IX
  60 ..
  61 .\}
  62 .\"
  63 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  64 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  65 .    \" fudge factors for nroff and troff
  66 .if n \{\
  67 .    ds #H 0
  68 .    ds #V .8m
  69 .    ds #F .3m
  70 .    ds #[ \f1
  71 .    ds #] \fP
  72 .\}
  73 .if t \{\
  74 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  75 .    ds #V .6m
  76 .    ds #F 0
  77 .    ds #[ \&
  78 .    ds #] \&
  79 .\}
  80 .    \" simple accents for nroff and troff
  81 .if n \{\
  82 .    ds ' \&
  83 .    ds ` \&
  84 .    ds ^ \&
  85 .    ds , \&
  86 .    ds ~ ~
  87 .    ds /
  88 .\}
  89 .if t \{\
  90 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
  91 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
  92 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
  93 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
  94 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
  95 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
  96 .\}
  97 .    \" troff and (daisy-wheel) nroff accents
  98 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
  99 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 100 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 101 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 102 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 103 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 104 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 105 .ds ae a\h'-(\w'a'u*4/10)'e
 106 .ds Ae A\h'-(\w'A'u*4/10)'E
 107 .    \" corrections for vroff
 108 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 109 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 110 .    \" for low resolution devices (crt and lpr)
 111 .if \n(.H>23 .if \n(.V>19 \
 112 \{\
 113 .    ds : e
 114 .    ds 8 ss
 115 .    ds o a
 116 .    ds d- d\h'-1'\(ga
 117 .    ds D- D\h'-1'\(hy
 118 .    ds th \o'bp'
 119 .    ds Th \o'LP'
 120 .    ds ae ae
 121 .    ds Ae AE
 122 .\}
 123 .rm #[ #] #H #V #F C
 124 .\" ========================================================================
 125 .\"
 126 .IX Title "Test::SubCalls 3"
 127 .TH Test::SubCalls 3 "2009-04-19" "perl v5.8.7" "User Contributed Perl Documentation"
 128 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 129 .\" way too many mistakes in technical documents.
 130 .if n .ad l
 131 .nh
 132 .SH "NAME"
 133 Test::SubCalls \- Track the number of times subs are called
 134 .SH "SYNOPSIS"
 135 .IX Header "SYNOPSIS"
 136 .Vb 1
 137 \&  use Test::SubCalls;
 138 \&
 139 \&  # Start tracking calls to a named sub
 140 \&  sub_track( \*(AqFoo::foo\*(Aq );
 141 \&
 142 \&  # Run some test code
 143 \&  ...
 144 \&
 145 \&  # Test that some sub deep in the codebase was called
 146 \&  # a specific number of times.
 147 \&  sub_calls( \*(AqFoo::foo\*(Aq, 5 );
 148 \&  sub_calls( \*(AqFoo::foo\*(Aq, 5, \*(AqUse a custom test message\*(Aq );
 149 \&
 150 \&  # Reset the counts for one or all subs
 151 \&  sub_reset( \*(AqFoo::foo\*(Aq );
 152 \&  sub_reset_all();
 153 .Ve
 154 .SH "DESCRIPTION"
 155 .IX Header "DESCRIPTION"
 156 There are a number of different situations (like testing caching code)
 157 where you want to want to do a number of tests, and then verify that
 158 some underlying subroutine deep within the code was called a specific
 159 number of times.
 160 .PP
 161 This module provides a number of functions for doing testing in this way
 162 in association with your normal Test::More (or similar) test scripts.
 163 .SH "FUNCTIONS"
 164 .IX Header "FUNCTIONS"
 165 In the nature of test modules, all functions are exported by default.
 166 .ie n .SS "sub_track $subname"
 167 .el .SS "sub_track \f(CW$subname\fP"
 168 .IX Subsection "sub_track $subname"
 169 The \f(CW\*(C`sub_track\*(C'\fR function creates a new call tracker for a named function.
 170 .PP
 171 The sub to track must be provided by name, references to the function
 172 itself are insufficient.
 173 .PP
 174 Returns true if added, or dies on error.
 175 .ie n .SS "sub_calls $subname, $expected_calls [, $message ]"
 176 .el .SS "sub_calls \f(CW$subname\fP, \f(CW$expected_calls\fP [, \f(CW$message\fP ]"
 177 .IX Subsection "sub_calls $subname, $expected_calls [, $message ]"
 178 The \f(CW\*(C`sub_calls\*(C'\fR function is the primary (and only) testing function
 179 provided by \f(CW\*(C`Test::SubCalls\*(C'\fR. A single call will represent one test in
 180 your plan.
 181 .PP
 182 It takes the subroutine name as originally provided to \f(CW\*(C`sub_track\*(C'\fR,
 183 the expected number of times the subroutine should have been called,
 184 and an optional test message.
 185 .PP
 186 If no message is provided, a default message will be provided for you.
 187 .PP
 188 Test is ok if the number of times the sub has been called matches the
 189 expected number, or not ok if not.
 190 .ie n .SS "sub_reset $subname"
 191 .el .SS "sub_reset \f(CW$subname\fP"
 192 .IX Subsection "sub_reset $subname"
 193 To prevent repeat users from having to take before and after counts when
 194 they start testing from after zero, the \f(CW\*(C`sub_reset\*(C'\fR function has been
 195 provided to reset a sub call counter to zero.
 196 .PP
 197 Returns true or dies if the sub name is invalid or not currently tracked.
 198 .SS "sub_reset_all"
 199 .IX Subsection "sub_reset_all"
 200 Provided mainly as a convenience, the \f(CW\*(C`sub_reset_all\*(C'\fR function will reset
 201 all the counters currently defined.
 202 .PP
 203 Returns true.
 204 .SH "SUPPORT"
 205 .IX Header "SUPPORT"
 206 Bugs should be submitted via the \s-1CPAN\s0 bug tracker, located at
 207 .PP
 208 <http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Test\-SubCalls>
 209 .PP
 210 For other issues, or commercial enhancement or support, contact the author.
 211 .SH "AUTHOR"
 212 .IX Header "AUTHOR"
 213 Adam Kennedy <adamk@cpan.org>
 214 .SH "SEE ALSO"
 215 .IX Header "SEE ALSO"
 216 <http://ali.as/>, Test::Builder, Test::More, Hook::LexWrap
 217 .SH "COPYRIGHT"
 218 .IX Header "COPYRIGHT"
 219 Copyright 2005 \- 2009 Adam Kennedy.
 220 .PP
 221 This program is free software; you can redistribute
 222 it and/or modify it under the same terms as Perl itself.
 223 .PP
 224 The full text of the license can be found in the
 225 \&\s-1LICENSE\s0 file included with this module.