Using Capture::Tiny

[bschmalhofer]

Discussed in #1042

^{Originally posted by bschmalhofer May 29, 2021}
The issue https://github.com/RotherOSS/CodePolicy/issues/58 proposes that the CodePoliy should not complain about reopening STDOUT and STDERR. But maybe there is a better way.

This is current code:

sub _ITSM_ChangeDefinition {
    my ( $Self, %Param ) = @_;

    my $CommandObject = $Kernel::OM->Get('Kernel::System::Console::Command::Maint::ITSM::Configitem::DefinitionPerl2YAML');
    my $Success       = 0;

    my ( $Result, $ExitCode );

    {
        local *STDOUT;
        open STDOUT, '>:utf8', \$Result;    ## no critic qw(OTOBO::ProhibitOpen InputOutput::RequireEncodingWithUTF8Layer)
        $ExitCode = $CommandObject->Execute();
    }

    $Success = 1 if !$ExitCode;

    return $Success;
}

This code is fine, but kind of cryptic. An alternative is to use Capture::Tiny.

use Capture::Tiny qw(capture_stdout); 

sub _ITSM_ChangeDefinition {
    my ( $Self, %Param ) = @_;

    my $CommandObject = $Kernel::OM->Get('Kernel::System::Console::Command::Maint::ITSM::Configitem::DefinitionPerl2YAML');
    my $Success       = 0;

    my $ExitCode;
    binmode STDOUT, ':utf8'; # permanently
    my $Result = capture_stdout {
        $ExitCode = $CommandObject->Execute();
    };

    $Success = 1 if !$ExitCode;

    return $Success;
}

But permanently changing STDOUT is not nice. Is using Capture::Tiny really a good idea?

[bschmalhofer]

Capture::Tiny is now required and scripts/test/Console/Command/Help.t serves as an example of how to use the module. Thus Capture::Tiny can be used in future development.