Test::AutoBuild::Stage::Group(3pm)

1Test::AutoBuild::Stage:U:sGerrouCpo(n3t)ributed Perl DocTuemsetn:t:aAtuitoonBuild::Stage::Group(3)
2
3
4

NAME

6       Test::AutoBuild::Stage::Group - Groups several stages together
7

SYNOPSIS

9         use Test::AutoBuild::Stage::Group
10

DESCRIPTION

12       This stage groups a number of stages together into a single logical
13       stage. The primary reason for such a setup is to allow one or more of
14       the sub-stages to fail, without terminating the entire build process.
15       For example, by grouping the Build and ISOGenerator stages together it
16       is possible to have the ISOGenerator stage skipped whenever the Build
17       stage fails, but still have all the post-build output stages run to
18       generate status pages, etc.
19

CONFIGURATION

21       In addition to the standard parameters defined by the
22       Test::AutoBuild::Stage module, this module also handles the optional
23       "stages" parameter to specify a list of sub-stages. Sub-stages are
24       listed in the same format as top level stages, ie an array of hashes.
25
26   EXAMPLE
27         {
28           name = build
29           label = Build group
30           module = Test::AutoBuild::Stage::Group
31           # Don't abort entire cycle if the module build fails
32           critical = 0
33           stages = (
34             # Basic build
35             {
36               name = build
37               label = Build
38               module = Test::AutoBuild::Stage::Build
39               options = {
40                 ...snip build options...
41               }
42             }
43             # Generate isos
44             {
45               name = iso
46               label = ISO image generator
47               module = Test::AutoBuild::Stage::ISOGenetator
48               options = {
49                 ...snip options...
50               }
51             }
52           )
53         }
54

METHODS

56       $stage->init(%params);
57           Overrides the super-class to add in handling of the optional
58           "stages" parameter for defining sub-stages. It is not neccessary to
59           call this method, since it is called by the "new" method
60           automatically.
61
62       my @stages = $stage->stages();
63           Retrieves the list of sub-stages that belong to this group. The
64           elements in the array are instances of Test::AutoBuild::Stage
65           module.
66
67       $stage->process($runtime);
68           Runs all sub-stages returned by the "stages" method. If any sub-
69           stages fails & that stage is marked as critical, this stage will be
70           marked as failing and return control immediately. If the sub-stage
71           is non-critical, then the processing will continue onto the next
72           sub-stage.
73

AUTHORS

75       Daniel Berrange <dan@berrange.com> Dennis Gregorovic
76       <dgregorovic@alum.mit.edu>
77

COPYRIGHT

79       Copyright (C) 2004 Red Hat, Inc.
80