DotNetToolRunner doesn't support empty space at tool path

[HeikeHofmann]

Prerequisites

• I have written a descriptive issue title
• I have searched issues to ensure it has not already been reported

Cake runner

Cake .NET Tool

Cake version

4.0.0

Operating system

Windows

Operating system architecture

64-Bit

CI Server

Azure DevOps

What are you seeing?

we want to use Cake.Sonar in the own project, where the SonarScanner DotNet Tool is used.
The execution can be found here:
https://github.com/cake-contrib/Cake.Sonar/blob/f1062a4ceeeeaf58bf662af6b6b478ed2d50119a/src/Cake.Sonar/SonarRunner.cs#L56C23-L56C23

But we have now an empty Space in the path and the execution will fail, because the execution will not append with Quotation Markes.
Here is the issue in the Cake.Tool code:

builder.Append(command);

line 63 of https://github.com/cake-build/cake/blob/main/src/Cake.Common/Tools/DotNet/Tool/DotNetToolRunner.cs

This is the error then:

What is expected?

The code should be:

builder.AppendQuoted(command);

Steps to Reproduce

Add Cake.Sonar and use the Plugin.

Any other dotnet tool and empty space should also be failing with Windows Environment.

Output log

No response

[antonysmith-mandogroup]

I came across this issue today using the same package - verbose log output:

begin /k:"test-project" /n:"Test Project" /d:sonar.login="[REDACTED]"
We're launching for CoreCLR with executable C:/tmp/Cake Test/tools/dotnet-sonarscanner.10.3.0/tools/netcoreapp3.1/any/SonarScanner.MSBuild.dll
Resolved tool to path C:/Program Files/dotnet/dotnet.exe
Executing: "C:/Program Files/dotnet/dotnet.exe" C:/tmp/Cake Test/tools/dotnet-sonarscanner.10.3.0/tools/netcoreapp3.1/any/SonarScanner.MSBuild.dll begin /k:"test-project" /n:"Test Project" /d:sonar.login="[REDACTED]"
Could not execute because the specified command or file was not found.
Possible reasons for this include:
  * You misspelled a built-in dotnet command.
  * You intended to execute a .NET program, but dotnet-C:/tmp/Cake does not exist.
  * You intended to run a global tool, but a dotnet-prefixed executable with this name could not be found on the PATH.
An error occurred when executing task 'Sonar-Qube-Start-Analysis'.

I pulled down the repo, made the suggested change, and this now works as expected:

begin /k:"test-project" /n:"Test Project" /d:sonar.login="[REDACTED]"
We're launching for CoreCLR with executable C:/tmp/Cake Test/tools/dotnet-sonarscanner.10.3.0/tools/netcoreapp3.1/any/SonarScanner.MSBuild.dll
Resolved tool to path C:/Program Files/dotnet/dotnet.exe
Executing: "C:/Program Files/dotnet/dotnet.exe" "C:/tmp/Cake Test/tools/dotnet-sonarscanner.10.3.0/tools/netcoreapp3.1/any/SonarScanner.MSBuild.dll" begin /k:"test-project" /n:"Test Project" /d:sonar.login="[REDACTED]"
SonarScanner for MSBuild 10.3
Using the .NET Core version of the Scanner for MSBuild
Pre-processing started.

Following this change, I have verified that all existing tests pass and I have added a new test to verify that the command is quoted. This test failed initially, then passed following the change:

[Fact]
public void Should_Wrap_Command_In_Quotes()
{
	// Given
	var fixture = new DotNetToolFixture();
	fixture.ProjectPath = "./tests/Cake.Common.Tests/";
	fixture.Command = "C:\\example\\path with\\spaces";
	fixture.Settings = new DotNetToolSettings();

	// When
	var result = fixture.Run();

	// Then
	Assert.Equal("\"C:\\example\\path with\\spaces\"", result.Args);
}

I'm happy to raise a PR for this change, but first wanted to ask the maintainers if this test is sufficient and/or if there are any reasons I'm not aware of that this change shouldn't be made? I'm a Windows user, and have tested that invoking quoted .NET CLI commands is fine, but I'm not sure about other platforms. If there's anything else I can do to get a fix for this progressed, please let me know

[antonysmith-mandogroup]

@devlead do you have a view on the above mentioned fix? Apologies for the tag, just conscious that this issue is quite old now and not near the top of the issues list so may otherwise get missed.

Thanks!

[devlead]

Feel free to send a PR, and we'll review.

[antonysmith-mandogroup]

Thanks @devlead, raised in #4537