cake-build/cake

Tool.Run should make stdout and stderr available on failure

Open

#2,460 opened on Jan 24, 2019

View on GitHub
 (4 comments) (2 reactions) (0 assignees)C# (3,742 stars) (738 forks)batch import
Help wantedImprovementUp-for-grabs

Description

Tool.Run and related should make stdout and stderr available so that some analysis is possible on failure. Currently it calls ProcessExitCode which throws a simple CakeException.

Ideally, it would capture stdout and stderr and throw a CakeProcessException, or similar, that has additional properties for exit code, stdout and stderr.

Contributor guide

Tech stack
csharp
Domain
build systemtooling
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
C#Cake build system basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
The request is to modify the Tool.Run method in src/Cake.Core/Tooling/Tool.cs to capture stdout and stderr before throwing an exception. Currently, at line 119, ProcessExitCode is called, and at line 139, a simple CakeException is thrown. The improvement is to create a new exception class CakeProcessException that includes exit code, stdout, and stderr. The implementation should capture the standard output/error from the process. A suggested approach is to use ProcessStartInfo.RedirectStandardOutput and RedirectStandardError before starting the process, then read the output streams before checking the exit code. The new exception should be thrown instead of CakeException. This is a well defined change with concrete file references.