.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)
.\"
.\" 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
..
.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 "Arch::Test::Framework 3pm"
.TH Arch::Test::Framework 3pm "2022-06-08" "perl v5.34.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"
Arch::Test::Framework \- A test framework for Arch\-Perl
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&    use Arch::Test::Framework;
\&
\&    my $fw = Arch::Test::Framework\->new;
\&
\&    my $archive = $fw\->make_archive;
\&    my $version = $archive\->make_version();
\&
\&    my $tree = $fw\->make_tree($version);
\&
\&    #
\&    # do something with $tree
\&    #
\&
\&    $tree\->import(\*(Aqinitial import\*(Aq);
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Arch::Test::Framework is a framework to quickly generate testing data
(archives, versions, trees, changesets, etc) for arch-perl unit tests.
.SH "METHODS"
.IX Header "METHODS"
\&\fBnew\fR,
\&\fBarch_uid\fR,
\&\fBhome_dir\fR,
\&\fBlibrary_dir\fR,
\&\fBarchives_dir\fR,
\&\fBtrees_dir\fR,
\&\fBmake_archive\fR,
\&\fBmake_category\fR,
\&\fBmake_branch\fR,
\&\fBmake_version\fR,
\&\fBmake_tree\fR.
.IP "\fBnew\fR [\fI\f(CI%args\fI\fR]" 4
.IX Item "new [%args]"
Create a new arch-perl test environment.
.Sp
Valid keys for \fI\f(CI%args\fI\fR are \fIhome\fR to specify an existing test
environment to reuse, \fIlibrary\fR to specify a different revision
library path, \fIarchives\fR to specify a different archives directory,
and \fItrees\fR to specify a differente project tree directory. The
default values are \f(CW\*(C`$home/library\*(C'\fR, \f(CW\*(C`$home/archives\*(C'\fR, and
\&\f(CW\*(C`$home/trees\*(C'\fR respectively.
.Sp
A different arch user id can be selected with the \fIuserid\fR key, the
default is \f(CW\*(C`Arch Perl Test <arch\-perl\-test@example.com>\*(C'\fR.
.IP "\fBarch_uid\fR" 4
.IX Item "arch_uid"
.PD 0
.IP "\fBhome_dir\fR" 4
.IX Item "home_dir"
.IP "\fBlibrary_dir\fR" 4
.IX Item "library_dir"
.IP "\fBarchives_dir\fR" 4
.IX Item "archives_dir"
.IP "\fBtrees_dir\fR" 4
.IX Item "trees_dir"
.PD
These methods return the environment parameters as initialized by \fBnew\fR.
.IP "\fBmake_archive\fR [\fIarchive_name\fR]" 4
.IX Item "make_archive [archive_name]"
Create a new archive in the archives directory. If \fIarchive_name\fR is
not specified a unique name is generated. The archive name is
returned. Returns an Arch::Test::Archive reference for the archive.
.IP "\fBmake_tree\fR \fIversion\fR [\fIname\fR]" 4
.IX Item "make_tree version [name]"
Create and initialize (\f(CW\*(C`tla init\-tree\*(C'\fR) a new project tree for
\&\fIversion\fR. I \fIname\fR is not specified, a unique identifier will be
generated. Returns an Arch::Test::Tree reference for the project
tree.
.SH "AUTHORS"
.IX Header "AUTHORS"
Mikhael Goikhman (migo@homemail.com\*(--Perl\-GPL/arch\-perl\*(--devel).
.PP
Enno Cramer (uebergeek@web.de\-\-2003/arch\-perl\*(--devel).