Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Demonstrate inconsistent WithExpectedExitCode behavior #4080

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

Demonstrate inconsistent WithExpectedExitCode behavior #4080

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
50 changes: 38 additions & 12 deletions src/Cake.Common.Tests/Unit/Tools/Command/CommandRunnerTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@

using System;
using Cake.Common.Tests.Fixtures.Tools.Command;
using Cake.Core.Tooling;
using Xunit;

namespace Cake.Common.Tests.Unit.Tools.Command
Expand Down Expand Up @@ -136,12 +137,12 @@ public void Should_Return_StandardOutput_ExitCode()
const int expectedExitCode = 1337;

var fixture = new CommandRunnerStandardOutputFixture
{
Settings =
{
HandleExitCode = exitCode => exitCode == expectedExitCode
}
}
{
Settings =
{
HandleExitCode = exitCode => exitCode == expectedExitCode
}
}
.GivenStandardOutput(expectedStandardOutput);

fixture.ProcessRunner.Process.SetExitCode(expectedExitCode);
Expand Down Expand Up @@ -184,12 +185,12 @@ public void Should_Return_StandardError_ExitCode()
const int expectedExitCode = 1337;

var fixture = new CommandRunnerStandardErrorFixture
{
Settings =
{
HandleExitCode = exitCode => exitCode == expectedExitCode
}
}
{
Settings =
{
HandleExitCode = exitCode => exitCode == expectedExitCode
}
}
.GivenStandardError(expectedStandardError)
.GivenStandardOutput(expectedStandardOutput);

Expand All @@ -203,5 +204,30 @@ public void Should_Return_StandardError_ExitCode()
Assert.Equal(expectedStandardError, fixture.StandardError);
Assert.Equal(expectedExitCode, fixture.ExitCode);
}

[Fact]
// This unit test demonstrates the problem reported in GH-4013.
// The command's exit code is zero and the expected exit code is any non-zero value (I used '1234' for demonstration purposes).
// In this scenario, I expect Cake to throw an exception because the exit code does not match the expected value.
// Currently this unit test fails because Cake does not throw the expected exception.
// The reason why Cake currently does not throw an exception is because zero is hard-coded on line 115 in Cake.Core/Tooling.Tol.cs
// Zero is hard coded to mean that the command was successful, and the expected exit code is completely disregarded.
public void Exception_Thrown_when_command_exit_code_is_zero_and_expected_value_is_non_zero()
{
// Given
const int actualExitCode = 0;
const int expectedExitCode = 1234;

var fixture = new CommandRunnerFixture();

fixture.Settings.WithExpectedExitCode(expectedExitCode);
fixture.ProcessRunner.Process.SetExitCode(actualExitCode);

// When
var result = Record.Exception(() => fixture.Run());

// Then
AssertEx.IsCakeException(result, "dotnet: Process returned an error (exit code 0).");
}
}
}