/ 
Ubic-1.60
River stage two • 9 direct dependents • 15 total dependents
/ Ubic::Cmd::Results

NAME

Ubic::Cmd::Results - console results set

VERSION

version 1.60

SYNOPSIS

use Ubic::Cmd::Results;

$results = Ubic::Cmd::Results->new;

$results->print($result);
$results->print($result, 'bad');
$results->print($result, 'good');

$code = $results->finish; # prints final statistics and returns supposed exit code

DESCRIPTION

This class controls the output of service actions.

INTERFACE SUPPORT

This is considered to be a non-public class. Its interface is subject to change without notice.

METHODS

new()

Constructor.

Print given strings in red color if stdout is terminal, and in plain text otherwise.

Print given strings in green color if stdout is terminal, and in plain text otherwise.

print($result)
print($result, $type)

Print given Ubic::Result::Class object.

$type can be "good" or "bad".

If $type is specified, it is taken into consideration, otherwise result is considered good unless it is "broken".

add($result)

Add result without printing.

results()

Get all results.

exit_code()

Get exit code appropriate for results.

It can be detected dynamically based on results content, or set explicitly from Ubic::Cmd, depending on command.

exit_code($code)

Set exit code explicitly.

finish(\@results)

Print error if some of results are bad, and return exit code.

AUTHOR

Vyacheslav Matyukhin <mmcleric@yandex-team.ru>

COPYRIGHT AND LICENSE

This software is copyright (c) 2016 by Yandex LLC.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.