.\" 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::Tree 3pm"
.TH Arch::Test::Tree 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::Tree \- A test framework for Arch\-Perl
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&    use Arch::Test::Framework;
\&
\&    my $fw = Arch::Test::Framework\->new;
\&    my $tree = $fw\->make_tree($dir, $version);
\&
\&    my $dir = $tree\->add_dir;
\&    $tree\->add_file($dir);
\&    $tree\->import;
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Arch::Test::Tree provides methods to quickly build and modify Arch
project trees within the Arch::Test framework.
.SH "METHODS"
.IX Header "METHODS"
\&\fBnew\fR,
\&\fBroot\fR,
\&\fBframework\fR,
\&\fBrun_tla\fR,
\&\fBadd_file\fR,
\&\fBadd_dir\fR,
\&\fBadd_link\fR,
\&\fBmodify_file\fR,
\&\fBrename_file\fR,
\&\fBrename_dir\fR,
\&\fBremove_file\fR,
\&\fBremove_dir\fR,
\&\fBinventory\fR,
\&\fBimport\fR,
\&\fBcommit\fR.
.IP "\fBnew\fR [\fIframework\fR] [\fIpath\fR]" 4
.IX Item "new [framework] [path]"
Create a new Arch::Test::Tree instance for \fIpath\fR. This method should
not be called directly.
.IP "\fBroot\fR" 4
.IX Item "root"
Returns the project trees root directory.
.IP "\fBframework\fR" 4
.IX Item "framework"
Returns the associated Arch::Test::Framework reference.
.IP "\fBrun_tla\fR \fI\f(CI@args\fI\fR" 4
.IX Item "run_tla @args"
Run \f(CW\*(C`tla \f(CI@args\f(CW\*(C'\fR from the tree root.
.IP "\fBadd_file\fR [\fIdir\fR [\fIname\fR [\fIcontent\fR]]]" 4
.IX Item "add_file [dir [name [content]]]"
Add a new file \fIname\fR in directory \fIdir\fR. Fill file with \fIcontent\fR.
.Sp
\&\fIdir\fR defaults to the project root (\f(CW\*(C`.\*(C'\fR). If \fIname\fR is not
specified, a unique filename is generated. A default content is
generated if none is given.
.IP "\fBadd_dir\fR [\fIparent\fR [\fIname\fR]]" 4
.IX Item "add_dir [parent [name]]"
Add a new directory under \fIparent\fR, or \f(CW\*(C`.\*(C'\fR if \fIparent\fR is not
specified. If \fIname\fR is not given, a unique name is generated.
.IP "\fBadd_link\fR [\fIparent\fR [\fIname\fR [\fItarget\fR]]]" 4
.IX Item "add_link [parent [name [target]]]"
Add a new symbolic link under \fIparent\fR, or \f(CW\*(C`.\*(C'\fR if \fIparent\fR is not
specified. If \fIname\fR is not given, a unique name is generated. If
\&\fItarget\fR is omitted, a (probably) non-existing target is generated.
.IP "\fBmodify_file\fR \fIfile\fR [\fIcontent\fR]" 4
.IX Item "modify_file file [content]"
Change \fIfile\fRs content to \fIcontent\fR, or append \f(CW\*(C`Has been modified.\*(C'\fR
if new content is omitted.
.IP "\fBrename_file\fR \fIold\fR \fInew\fR" 4
.IX Item "rename_file old new"
Rename file \fIold\fR to \fInew\fR. Returns \fInew\fR.
.IP "\fBrename_dir\fR \fIold\fR \fInew\fR" 4
.IX Item "rename_dir old new"
Rename directory \fIold\fR to \fInew\fR. Returns \fInew\fR.
.IP "\fBremove_file\fR \fIfile\fR" 4
.IX Item "remove_file file"
Delete \fIfile\fR and its associated arch id.
.IP "\fBremove_dir\fR \fIdir\fR" 4
.IX Item "remove_dir dir"
Recursively delete \fIdir\fR and its content.
.IP "\fBinventory\fR [\fIflags\fR]" 4
.IX Item "inventory [flags]"
Returns the inventory as generated by running \f(CW\*(C`tla inventory
\&\f(CIflags\f(CW\*(C'\fR. \fIflags\fR default to \f(CW\*(C`\-Bs\*(C'\fR if not specified.
.IP "\fBimport\fR [\fIsummary\fR [\fIlog\fR]]" 4
.IX Item "import [summary [log]]"
Create a \f(CW\*(C`base\-0\*(C'\fR revision from tree using the summary line
\&\fIsummary\fR and \fIlog\fR as log text. If \fItree\fR contains a log file,
\&\fIsummary\fR and \fIlog\fR can be omitted.
.IP "\fBcommit\fR [\fIsummary\fR [\fIlog\fR]]" 4
.IX Item "commit [summary [log]]"
Commit a \f(CW\*(C`patch\-n\*(C'\fR revision from tree using the summary line
\&\fIsummary\fR and \fIlog\fR as log text. If \fItree\fR contains a log file,
\&\fIsummary\fR and \fIlog\fR can be omitted.
.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).