.\" -*- 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 "GEM2DEB-TEST-RUNNER 1"
.TH GEM2DEB-TEST-RUNNER 1 2024-04-08 "" ""
.\" 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
gem2deb\-test\-runner \- runs test suite contained in Debian Ruby packages
.SH SYNOPSIS
.IX Header "SYNOPSIS"
\&\fBgem2deb\-test\-runner\fR [\fBOPTIONS\fR]
.SH DESCRIPTION
.IX Header "DESCRIPTION"
\&\fBgem2deb\-test\-runner\fR runs the tests shipped inside a source Debian Ruby
package. The way the tests are run is configured in one of the three files:
\&\fIdebian/ruby\-test\-files.yaml\fR, \fIdebian/ruby\-tests.rake\fR,
\&\fIdebian/ruby\-tests.rb\fR. See the \fBFILES\fR section in \fBdh_ruby\fR(1) for details.
.PP
If called without argument in the root of the source package after the package
is built and installed under debian/\fIpackage_name\fR, then the tests will be run
using the files of the package installed under debian/\fIpackage_name\fR. This call
is part of the \fBdh_ruby\fR(1) sequence when building a Ruby package with gem2deb.
.PP
If the option \fB\-\-autopkgtest\fR is used, the package needs to be installed on
the system. \fBgem2deb\-test\-runner\fR will not try to load files under debian/ and
will move away temporarily the lib/ and ext/ directory to ensure the test
suite is run against the installed package. This is used in the context of
automatic as-installed package testing, through the autopkgtest framework.
.SH OPTIONS
.IX Header "OPTIONS"
.IP \fB\-\-autopkgtest\fR 4
.IX Item "--autopkgtest"
Run the tests against the installed package for automatic as-installed package
testing. Useful in conjunction with \fBadt-run\fR(1).
.IP "\fB\-c\fR, \fB\-\-check\-dependencies\fR" 4
.IX Item "-c, --check-dependencies"
Before running the tests, checks whether all dependencies of the package, as
declared in the Rubygems metadata, are present. Makes the program exit with a
non-zero status code (i.e. fails) if they aren't.
.IP "\fB\-b\fR, \fB\-\-check\-bundler\fR" 4
.IX Item "-b, --check-bundler"
Check that the package can be correctly loaded by bundler. This tests that the
package can be loaded properly by bundler with the following two types of
Gemfiles. One lists the package as a top-level dependency:
.Sp
.Vb 1
\&  gem "foo"
.Ve
.Sp
This will be tested by calling `\fBruby \-rbundler/setup\fR`.
.Sp
The other type includes the package in a group:
.Sp
.Vb 3
\&  group :test do
\&    gem "foo"
\&  end
.Ve
.Sp
That will be tested by calling `\fBruby \-rbundler \-e 'Bundler.require(:test)'\fR`.
.SH ENVIRONMENT
.IX Header "ENVIRONMENT"
.IP GEM2DEB_TEST_RUNNER 4
.IX Item "GEM2DEB_TEST_RUNNER"
Used to pass options to gem2deb\-test\-runner via the environment. For example,
to make gem2deb\-test\-runner check dependencies during package build, you can
add the following to \fIdebian/rules\fR:
.RS 4
.Sp
.RS 4
export GEM2DEB_TEST_RUNNER = \-\-check\-dependencies
.RE
.RE
.RS 4
.RE
.SH "EXIT STATUS"
.IX Header "EXIT STATUS"
.IP \(bu 4
0 if tests pass.
.IP \(bu 4
1 if tests fail.
.IP \(bu 4
77 if \fB\-\-autopkgtest\fR was passed and \fBgem2deb\-test\-runner\fR cannot determine
how to run the test suite.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBdh_ruby\fR(1), \fBgem2deb\fR(1)