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.

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

Add WithExitCondition feature #242

Closed
wants to merge 7 commits into from
Closed
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 40 additions & 0 deletions CliWrap.Tests.Dummy/Commands/RunProcessCommand.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
using System;
using System.Diagnostics;
using System.Threading.Tasks;
using CliFx;
using CliFx.Attributes;
using CliFx.Infrastructure;

namespace CliWrap.Tests.Dummy.Commands;

[Command("run process")]
public class RunProcessCommand : ICommand
{
[CommandOption("path")]
public string FilePath { get; init; } = string.Empty;

[CommandOption("arguments")]
public string Arguments { get; init; } = string.Empty;

public ValueTask ExecuteAsync(IConsole console)
{
var startInfo = new ProcessStartInfo
{
FileName = FilePath,
Arguments = Arguments,
RedirectStandardInput = true,
RedirectStandardOutput = true,
RedirectStandardError = true,
UseShellExecute = false,
CreateNoWindow = true
};

var process = new Process();
process.StartInfo = startInfo;
process.Start();

console.Output.WriteLine(process.Id);

return default;
}
}
73 changes: 73 additions & 0 deletions CliWrap.Tests/ExitConditionSpecs.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
using System;
using System.Diagnostics;
using System.Threading.Tasks;
using FluentAssertions;
using Xunit;

namespace CliWrap.Tests;

public class ExitConditionSpecs()
{
[Fact(Timeout = 15000)]
public async Task I_can_execute_a_command_that_creates_child_process_resuing_standard_output_and_finish_after_child_process_exits()
dmilosz marked this conversation as resolved.
Show resolved Hide resolved
{
// Arrange
var cmd = this.PrepareCommand(line => { });

Check failure on line 15 in CliWrap.Tests/ExitConditionSpecs.cs

View workflow job for this annotation

GitHub Actions / main / test (ubuntu-latest)

I can execute a command that creates child process resuing standard output and finish after child process exits

Expected executionFinish.Subtract(executionStart) to be greater than or equal to 3s, but found 382ms and 985.2µs.

Check failure on line 15 in CliWrap.Tests/ExitConditionSpecs.cs

View workflow job for this annotation

GitHub Actions / main / test (macos-latest)

I can execute a command that creates child process resuing standard output and finish after child process exits

Expected executionFinish.Subtract(executionStart) to be greater than or equal to 3s, but found 1s, 356ms and 706.0µs.
dmilosz marked this conversation as resolved.
Show resolved Hide resolved

// Act
var executionStart = DateTime.UtcNow;
var result = await cmd.ExecuteAsync();
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

executionStart/executionFinish is already provided by result

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, but finish time is a different one. CliWrap sets ExitTime when the main process ends. When there are child processes attached to output, ExecuteAsync() is blocked until all children are completed. In this test, we want to measure time when the ExecuteAsync() was blocked for, so that we can verify whether it was waiting for child or not.

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Exit time is set when the child process exits:

_nativeProcess.Exited += (_, _) =>
{
ExitTime = DateTimeOffset.Now;
_exitTcs.TrySetResult(null);
};

It shouldn't be affected by the exit condition you've added, since that only affects whether CliWrap waits for pipes to clear or not.

Because your var executionFinish = ... statement appears right await cmd.ExecuteAsync(), it's essentially the same (slightly later) timestamp as the one provided by ExecutionResult.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

CliWrap's ExitTime is always the same no matter what ExitCondition is set. So this test would basically always pass.

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm confused in that case. Wouldn't ExitCondition.ProcessExit make the command finish earlier, assuming it spawns a grandchild process?

var executionFinish = DateTime.UtcNow;

// Assert
executionFinish
.Subtract(executionStart)
.Should()
.BeGreaterThanOrEqualTo(TimeSpan.FromSeconds(3));
Comment on lines +38 to +41
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Probably a more reliable way to test this would be to read the stdout. The sleep command prints Done. after it finishes, so you can use that to detect whether the grandchild process has finished or not.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Unfortunately it's not possible. The main process is finished almost instantly, and there is nothing we can do to catch the output after that. We can handle the output and wait for for child process to be finished, but then it breaks the whole point of doing this test, where we are interested in specific scenario when parent triggers child and then dies instantly.

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I meant to test the current behavior (PipesClosed), wouldn't Done appear in the output since the command would only complete after the grandchild process exits?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Only if we make main process to wait for the child. In the CliWrap.Tests.Dummy I implemented run process command that doesn't wait for the child, because this is the behavior that can't be handled currrently.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In general it seems difficult to create a single test that works reliably on all environments including .NET framework and Linux. In Linux, we should somehow use nohup and background processing with bash to reproduce the issue, because the dummy app can't reproduce it.
On .NET Framework those tests also fail, but I don't know why yet.

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I thought the issue is that, regardless of whether the child process waits for the grandchild or not, because the output streams are inherited and CliWrap waits for them to close, the command effectively finishes when all grandchildren exit.

}

[Fact(Timeout = 15000)]
public async Task I_can_execute_a_command_that_creates_child_process_resuing_standard_output_and_finish_instantly_after_main_process_exits()
{
// Arrange
int childProcessId = -1;

Check failure on line 33 in CliWrap.Tests/ExitConditionSpecs.cs

View workflow job for this annotation

GitHub Actions / main / test (windows-latest)

I can execute a command that creates child process resuing standard output and finish instantly after main process exits

System.ArgumentException : Process with an Id of 4788 is not running.
var cmd = this.PrepareCommand(line => childProcessId = Convert.ToInt32(line.Trim()))
.WithExitCondition(CommandExitCondition.ProcessExited);

// Act
var executionStart = DateTime.UtcNow;
var result = await cmd.ExecuteAsync();
var executionFinish = DateTime.UtcNow;

var process = Process.GetProcessById(childProcessId);

// Assert
executionFinish.Subtract(executionStart).Should().BeLessThan(TimeSpan.FromSeconds(3));

process.HasExited.Should().BeFalse();
}

/// <summary>
/// Prepares a command that will create a sleeping child process and return its id via standard output.
/// </summary>
private Command PrepareCommand(Action<string> onStandardOutput)
{
var cmd = Cli.Wrap(Dummy.Program.FilePath)
.WithArguments(
[
"run",
"process",
"--path",
Dummy.Program.FilePath,
"--arguments",
"sleep 00:00:03"
]
)
.WithStandardOutputPipe(PipeTarget.ToDelegate(line => onStandardOutput(line)))
.WithStandardErrorPipe(
PipeTarget.ToDelegate(line => Console.WriteLine($"Error: {line}"))
);

return cmd;
}
}
13 changes: 5 additions & 8 deletions CliWrap/CommandExitCondition.cs
Original file line number Diff line number Diff line change
@@ -1,21 +1,18 @@
using System;

namespace CliWrap;
namespace CliWrap;

/// <summary>
/// Strategy used for veryfing the end of command exectuion.
/// Strategy used for identifying the end of command exectuion.
/// </summary>
[Flags]
public enum CommandExitCondition
{
/// <summary>
/// Command is finished when process is finished and all pipes are closed.
/// Command execution is considered finished when the process exits and all standard input and output streams are closed.
/// </summary>
PipesClosed = 0,

/// <summary>
/// Command is finished when the main process exits,
/// even if they are child processes still running, which are reusing the same output/error streams.
/// Command execution is considered finished when the process exits, even if the process's standard input and output streams are still open,
/// for example after being inherited by a grandchild process.
/// </summary>
ProcessExited = 1
}
5 changes: 5 additions & 0 deletions CliWrap/ICommandConfiguration.cs
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,11 @@ public interface ICommandConfiguration
/// </summary>
Credentials Credentials { get; }

/// <summary>
/// Strategy used for veryfing the end of command exectuion.
/// </summary>
public CommandExitCondition CommandExitCondition { get; }

/// <summary>
/// Environment variables set for the underlying process.
/// </summary>
Expand Down
Loading