cake-build/cake

Tool.Run should make stdout and stderr available on failure

Open

#2,460 opened on Jan 24, 2019

View on GitHubContributor guide
 (4 comments) (2 reactions) (0 assignees)C# (738 forks)batch import
Help wantedImprovementUp-for-grabs

Repository metrics

Stars
 (3,742 stars)
PR merge metrics
 (PR metrics pending)

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

Research direction
Familiarize yourself with the Cake build system. Locate the Tool.Run method in src/Cake.Core/Tooling/Tool.cs. Understand how ProcessExitCode is called and the exception thrown. Design a new CakeProcessException class that captures exit code, stdout, stderr. Modify Tool.Run to capture output using Process.Start with RedirectStandardOutput and RedirectStandardError. Update tests to verify the new behavior.
Tech stack
csharp
Domain
build system
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-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
C#
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70