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

Handle correctly waiting for process exit on Unix systems #3410

Merged
merged 8 commits into from
Feb 24, 2022
Merged

Handle correctly waiting for process exit on Unix systems #3410

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
1d9b0a0
Add failing test
Evangelink Feb 23, 2022
b7bc552
Add exist check for executable path
Evangelink Feb 23, 2022
e1c0d57
Update failing test
Evangelink Feb 23, 2022
464f152
Fix process WaitForExit logic
Evangelink Feb 23, 2022
09639a9
Address review comments
Evangelink Feb 24, 2022
00ddb0b
Update constant name
Evangelink Feb 24, 2022
f87683d
Update invalid version used
Evangelink Feb 24, 2022
f90c45c
Address review feedback + update test output
Evangelink Feb 24, 2022
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
30 changes: 30 additions & 0 deletions test/Microsoft.TestPlatform.AcceptanceTests/ProcessTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT license. See LICENSE file in the project root for full license information.

using System.IO;

using Microsoft.VisualStudio.TestTools.UnitTesting;

namespace Microsoft.TestPlatform.AcceptanceTests;

[TestClass]
public class ProcessTests : AcceptanceTestBase
Copy link
Member Author

Choose a reason for hiding this comment

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

I couldn't really find in which existing type this would fit best so I created this one, feel free to suggest alternative.

Copy link
Contributor

Choose a reason for hiding this comment

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

ProcessesInteractionTests?

{
Copy link
Member Author

Choose a reason for hiding this comment

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

I think that it would be nice to add one more test where we have a specific test adapter (not sure if that's the right "level") that would be hanging so we can prove that the cancellation are correctly done.

If you share the feeling, I'd be happy to be helped to add it.

[TestMethod]
public void MissingFrameworkTextIsCorrectlyDisplayed()
{
// Arrange
var assemblyPath = GetAssetFullPath("SimpleTestProjectMessedUpTargetFramework.dll", Core21TargetFramework);
var runtimeConfigJson = Path.Combine(Path.GetDirectoryName(assemblyPath), "SimpleTestProjectMessedUpTargetFramework.runtimeconfig.json");
var fileContent = File.ReadAllText(runtimeConfigJson);
var updatedContent = fileContent.Replace("\"version\": \"2.1.0\"", "\"version\": \"42\"");
File.WriteAllText(runtimeConfigJson, updatedContent);
Copy link
Contributor

@MarcoRossignoli MarcoRossignoli Feb 24, 2022 •
edited
Loading

Choose a reason for hiding this comment

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

q: this test is modifying the assets right?

Copy link
Member Author

Choose a reason for hiding this comment

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

Yes that's why I created a new test asset. I originally thought that we were doing a local copy of the asset for each test but we don't so I wasn't sure how to best do this.

Given the question, I should probably put a comment in the code to explain what/why.

Thanks for pointing it out!


// Act
InvokeDotnetTest(assemblyPath);

// Assert
ExitCodeEquals(1);
StdErrorContains("The framework 'Microsoft.NETCore.App', version '42' (x64) was not found.");
}
}
5 changes: 5 additions & 0 deletions test/Microsoft.TestPlatform.TestUtilities/IntegrationTestBase.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -599,6 +599,11 @@ protected static void ExecuteApplication(string path, string args, out string st
throw new ArgumentException("Executable path must not be null or whitespace.", nameof(path));
}

if (!File.Exists(path))
Copy link
Member Author

@Evangelink Evangelink Feb 23, 2022 •
edited
Loading

Choose a reason for hiding this comment

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

Unrelated to this PR, but when trying to debug I noticed that without this check we end up with error like System.ComponentModel.Win32Exception: No such file or directory which isn't really helpful.

{
throw new ArgumentException($"Executable path '{path}' could not be found.", nameof(path));
}

var executableName = Path.GetFileName(path);

using var process = new Process();
Expand Down
25 changes: 25 additions & 0 deletions .../SimpleTestProjectMessedUpTargetFramework/SimpleTestProjectMessedUpTargetFramework.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
<Project Sdk="Microsoft.NET.Sdk">

<!-- Imports Common TestAssets props. -->
<Import Project="..\..\..\scripts\build\TestAssets.props" />

<PropertyGroup>
<TargetFrameworks>netcoreapp2.1</TargetFrameworks>
<TargetFrameworks Condition=" '$(DotNetBuildFromSource)' == 'true' ">netcoreapp3.1</TargetFrameworks>
<TestProject>true</TestProject>
<IsTestProject>true</IsTestProject>
</PropertyGroup>

<ItemGroup>
<PackageReference Include="MSTest.TestFramework">
<Version>$(MSTestFrameworkVersion)</Version>
</PackageReference>
<PackageReference Include="MSTest.TestAdapter">
<Version>$(MSTestAdapterVersion)</Version>
</PackageReference>
<PackageReference Include="Microsoft.NET.Test.Sdk">
<Version>$(NETTestSdkVersion)</Version>
</PackageReference>
</ItemGroup>

</Project>
16 changes: 16 additions & 0 deletions test/TestAssets/SimpleTestProjectMessedUpTargetFramework/UnitTest1.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT license. See LICENSE file in the project root for full license information.

using Microsoft.VisualStudio.TestTools.UnitTesting;

namespace SimpleTestProjectMessedUpTargetFramework
{
[TestClass]
public class UnitTest1
{
[TestMethod]
public void TestMethod1()
{
}
}
}
14 changes: 14 additions & 0 deletions test/TestAssets/TestAssets.sln
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,8 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "AttachmentProcessorDataColl
EndProject
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "ArchitectureSwitch", "ArchitectureSwitch\ArchitectureSwitch.csproj", "{452352E1-71CA-436E-8165-F284EE36C924}"
EndProject
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "SimpleTestProjectMessedUpTargetFramework", "SimpleTestProjectMessedUpTargetFramework\SimpleTestProjectMessedUpTargetFramework.csproj", "{08C44607-EB80-4EE5-927D-08C34AA277AF}"
EndProject
Global
GlobalSection(SolutionConfigurationPlatforms) = preSolution
Debug|Any CPU = Debug|Any CPU
Expand Down Expand Up @@ -620,6 +622,18 @@ Global
{452352E1-71CA-436E-8165-F284EE36C924}.Release|x64.Build.0 = Release|Any CPU
{452352E1-71CA-436E-8165-F284EE36C924}.Release|x86.ActiveCfg = Release|Any CPU
{452352E1-71CA-436E-8165-F284EE36C924}.Release|x86.Build.0 = Release|Any CPU
{08C44607-EB80-4EE5-927D-08C34AA277AF}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
{08C44607-EB80-4EE5-927D-08C34AA277AF}.Debug|Any CPU.Build.0 = Debug|Any CPU
{08C44607-EB80-4EE5-927D-08C34AA277AF}.Debug|x64.ActiveCfg = Debug|Any CPU
{08C44607-EB80-4EE5-927D-08C34AA277AF}.Debug|x64.Build.0 = Debug|Any CPU
{08C44607-EB80-4EE5-927D-08C34AA277AF}.Debug|x86.ActiveCfg = Debug|Any CPU
{08C44607-EB80-4EE5-927D-08C34AA277AF}.Debug|x86.Build.0 = Debug|Any CPU
{08C44607-EB80-4EE5-927D-08C34AA277AF}.Release|Any CPU.ActiveCfg = Release|Any CPU
{08C44607-EB80-4EE5-927D-08C34AA277AF}.Release|Any CPU.Build.0 = Release|Any CPU
{08C44607-EB80-4EE5-927D-08C34AA277AF}.Release|x64.ActiveCfg = Release|Any CPU
{08C44607-EB80-4EE5-927D-08C34AA277AF}.Release|x64.Build.0 = Release|Any CPU
{08C44607-EB80-4EE5-927D-08C34AA277AF}.Release|x86.ActiveCfg = Release|Any CPU
{08C44607-EB80-4EE5-927D-08C34AA277AF}.Release|x86.Build.0 = Release|Any CPU
EndGlobalSection
GlobalSection(SolutionProperties) = preSolution
HideSolutionNode = FALSE
Expand Down