.\" Automatically generated by Pod::Man 4.07 (Pod::Simple 3.32)
.\"
.\" 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
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    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
..
.if !\nF .nr F 0
.if \nF>0 \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    if !\nF==2 \{\
.        nr % 0
.        nr F 2
.    \}
.\}
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Test::Lintian::Harness 3"
.TH Test::Lintian::Harness 3 "2018-12-21" "Lintian v2.5.117~bpo9+1" "Debian Package Checker"
.\" 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"
Test::Lintian::Harness \-\- Helper tools for t/runtests
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 4
\&  use Test::Lintian::Harness qw(up_to_date);
\&  if (not up_to_date(\*(Aqsome/build\-stamp\*(Aq, \*(Aqsome/dir\*(Aq)) {
\&    # do rebuild
\&  }
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Helper functions for t/runtests.
.SH "FUNCTIONS"
.IX Header "FUNCTIONS"
.IP "skip_reaon(\s-1SKIP_FILE\s0)" 4
.IX Item "skip_reaon(SKIP_FILE)"
Return the (human-readable) reason for skipping a test by reading the
\&\s-1SKIP_FILE.\s0
.IP "runsystem(\s-1CMD...\s0)" 4
.IX Item "runsystem(CMD...)"
Run \s-1CMD\s0 via system, but throw an error if \s-1CMD\s0 does not return 0.
.IP "runsystem_ok(\s-1CMD...\s0)" 4
.IX Item "runsystem_ok(CMD...)"
Run \s-1CMD\s0 via system, but throw an error if \s-1CMD\s0 does not return 0 or 1.
.Sp
Returns 1 if \s-1CMD\s0 returned successfully (i.e. 0), otherwise 0.
.Sp
This is mostly useful for running Lintian, which may return 0 or 1 on
\&\*(L"success\*(R".
.IP "up_to_date(\s-1STAMPFILE,\s0 DIR[, \s-1RUNNER_TS\s0])" 4
.IX Item "up_to_date(STAMPFILE, DIR[, RUNNER_TS])"
Returns true if the mtime of \s-1STAMPFILE\s0 is greater than or equal to the
mtime of all files in \s-1DIR. \s0 If \s-1RUNNER_TS\s0 is given, then the mtime of
\&\s-1STAMPFILE\s0 must also be greater than or equal to the value of
\&\s-1RUNNER_TS.\s0
.Sp
If \s-1STAMPFILE\s0 does not exist, this function returns false
unconditionally.
.IP "check_test_depends(\s-1TESTDATA\s0)" 4
.IX Item "check_test_depends(TESTDATA)"
Given a \s-1TESTDATA\s0 with a dependency requirement, check whether the
dependency requirement is satisfied.  If satisfied, return \f(CW\*(C`undef\*(C'\fR,
otherwise return a (human-readable) string containing the missing
dependencies.
.IP "read_test_desc(\s-1FILENAME\s0)" 4
.IX Item "read_test_desc(FILENAME)"
Parse \s-1FILENAME\s0 as a test description file, do a quick validation of
its contents and return it in a hashref.  This is similar
get_dsc_control (\s-1DSCFILE\s0)
except for the extra validation.
.IP "chdir_runcmd(\s-1DIR,\s0 CMD_REF[, \s-1LOG_FILE\s0])" 4
.IX Item "chdir_runcmd(DIR, CMD_REF[, LOG_FILE])"
Fork, chdir to \s-1DIR\s0 and exec the command (plus arguments) contained in
\&\s-1CMD_REF. \s0 The child process's \s-1STDERR\s0 is merged into its \s-1STDOUT. \s0 The
\&\s-1STDOUT\s0 stream of the child process is either directed to the path
denoted by \s-1LOG_FILE \s0(if given and not \f(CW\*(C`undef\*(C'\fR) or to \fI/dev/null\fR.
.Sp
Returns 0 on success and non-zero otherwise.
.IP "is_tag_in_file(\s-1TAGNAME, FILENAME\s0)" 4
.IX Item "is_tag_in_file(TAGNAME, FILENAME)"
Returns true if \s-1FILENAME\s0 appears to be output from Lintian, which
emitted \s-1TAGNAME\s0 from that run.
.IP "find_tests_for_tag(\s-1TAGNAME, GLOB_EXPR\s0)" 4
.IX Item "find_tests_for_tag(TAGNAME, GLOB_EXPR)"
Find checks for the Lintian tag denoted by \s-1TAGNAME\s0 that match the
\&\s-1GLOB_EXPR.\s0 Note that \s-1GLOB_EXPR\s0 must match only the \*(L"desc\*(R" file of the
tests.
.Sp
This function returns a list of the test-data for each of these tests.
.IP "generic_find_test_for_tag(\s-1TAGNAME,\s0 GLOB_EXPR[, \s-1TCODE\s0])" 4
.IX Item "generic_find_test_for_tag(TAGNAME, GLOB_EXPR[, TCODE])"
Looks for \s-1TAGNAME\s0 in all files returned by using glob on \s-1GLOB_EXPR.
TCODE\s0 is called for each file with \s-1TAGNAME\s0 as first argument and the
filename as second argument.  \s-1TCODE\s0 is expected to return a truth
value that if the test should be run.  If \s-1TCODE\s0 returns something
that is not just a raw truth value (e.g. a hash ref), this will be
taken as the \*(L"test\*(R", otherwise this sub will attempt to guess the test
name from the file.
.Sp
If \s-1TCODE\s0 is omitted, \*(L"is_tag_in_file(\s-1TAGNAME, FILENAME\s0)\*(R" will be
used.
.Sp
Returns a list of values returned by \s-1TCODE\s0 or guessed test names (as
per above)