Test::AutoBuild::Monitor::CommandLine(3pm)

1Test::AutoBuild::MonitoUrs:e:rCoCmomnatnrdiLbiuntee(d3T)Peesrtl::DAouctuomBeunitladt:i:oMnonitor::CommandLine(3)
2
3
4

NAME

6       Test::AutoBuild::Monitor::CommandLine - Monitor progress from 'ps'
7

SYNOPSIS

9         use Test::AutoBuild::Monitor::CommandLine
10
11         my $monitor = Test::AutoBuild::CommandLine->new()
12
13         # Emit some events
14         $monitor->notify("beginStage", "build", time);
15         $monitor->notify("endStage", "build", time, $status);
16

DESCRIPTION

18       This module changes the process command line to reflect the current
19       status. Thus the status can be viewed simply by running the 'ps'
20       command. For example, after a single beginStage event for stage name
21       'build' it will show
22
23          auto-build [running build]
24
25       After a second beginStage for stage name 'isos'
26
27          auto-build [running build->isos]
28
29       After the second finishes
30
31          auto-build [running build]
32
33       If there is a nested beginBuild event for module 'foo':
34
35          auto-build [running build (foo)]
36
37       etc, etc.
38

CONFIGURATION

40       This module merely uses the standard configuration parameters for
41       "Test::AutoBuild::Monitor", no options are neccessary
42
43   EXAMPLE
44         cmd = {
45           label = Command line monitor
46           module = Test::AutoBuild::Monitor::CommandLine
47         }
48

METHODS

50       $monitor->init(%params);
51           This method initializes a new monitor & is called automatically by
52           the "new" method. The %params parameters are passed through from
53           the "new" method.
54
55       $monitor->process($event_name, @args);
56           This method changes the contents of $0 to reflect current build
57           state. It understands the following events (which can be nested):
58           "beginStage", "completeStage", "failStage", "abortStage",
59           "beginBuild", "endBuild". "beginCheckout", "endCheckout". All other
60           events are ignored.
61

AUTHORS

63       Daniel Berrange <dan@berrange.com>
64

COPYRIGHT

66       Copyright (C) 2005 Daniel Berrange <dan@berrange.com>
67