Improve test fixtures and related code

[Nirmal4G]

Bug

Fixes: NuGet/Home#9996
Regression: No

Fix

Details: These are some of the improvements separated from the PR #3270

• Consolidate Restore/Build/Pack methods in Tests
  • Test Fixture now has similar API surface across Restore/Build/Pack commands
• Fix 'dotnet pack' tests when testing under VS IDE
  • The NuGet Pack artifacts aren't being copied to the test SDK layout, when building/testing under VS IDE locally and not on CI/CLI.
• Rename 'OutputPath' to 'ProjectExtensionsPath' in 'SimpleTestProjectContext'
  • The 'OutputPath' property under 'SimpleTestProjectContext' is an alias of 'MSBuildProjectExtensionsPath', but there is an 'OutputPath' property already in MSBuild project system.
• Refactor 'CreateDotnetToolProject' method & calls in 'DotNetToolTests'
  • Rename 'source' param to 'packageSource'
  • Make 'packageSource' param to accept null
  • Fix template's 'MSBuildProjectExtensionsPath' with explicit Sdk import
  • Remove redundant parameter labels on 'CreateDotnetToolProject' in 'DotNetToolTests'
• Miscellaneous refactoring and whitespace fixes

Testing/Validation

Tests Added: No
Reason for not adding tests: These are tests themselves
Validation: As long as CI succeeds

[zivkan]

just making sure no one accidentally merges this before an issue is linked.

[zivkan]

The test that failed is Dotnet.Integration.Test.PackCommandTests.PackCommand_PackConsoleAppWithRID_NupkgValid, with the error message:

The output .nupkg is not in the default place
Expected: True
Actual:   False

and stack trace

at Dotnet.Integration.Test.PackCommandTests.PackCommand_PackConsoleAppWithRID_NupkgValid(Boolean includeSymbols) in C:\A\1\106\s\test\NuGet.Core.FuncTests\Dotnet.Integration.Test\PackCommandTests.cs:line 194

I see you modified this test in your PR, plus I ran the CI build twice and it failed both times, so I think it's unlikely to be flaky.

Dotnet.Integration.Tests should be runnable from Visual Studio's Test Explorer (or I guess from the command line, although I've never tried debugging a test in VSCode or anything other than full VS). So, I think you should be able to repro the test failure locally.

[Nirmal4G]

I see you modified this test in your PR

It was a rebase error, I put a wrong patch on the wrong branch! My bad!! Sorry.

Dotnet.Integration.Tests should be runnable from Visual Studio's Test Explorer

This is how I'm testing the code. I tried VSCode at first, not a good experience. C# Extension (Omnisharp) fails to load some projects everytime and everytime those failed projects are different which makes it hard to pinpoint the source of the issue. So, I gave up and went back to VS IDE!

[nkolev92]

Consolidate Restore/Build/Pack methods in Tests
Test Fixture now has similar API surface across Restore/Build/Pack commands

That's reasonable, thanks.

Fix 'dotnet pack' tests when testing under VS IDE
The NuGet Pack artifacts aren't being copied to the test SDK layout, when building/testing under VS IDE locally and not on CI/CLI.

I'm not sure what doesn't work in this situation. I did a quick test locally and we do copy the assets. We even have an optimization to determine whether we need to copy the ilmerged or non-ilmerged pack dll.

Rename 'OutputPath' to 'ProjectExtensionsPath' in 'SimpleTestProjectContext'
The 'OutputPath' property under 'SimpleTestProjectContext' is an alias of 'MSBuildProjectExtensionsPath', but there is an 'OutputPath' property already in MSBuild project system.

These changes are in a different PR, so I think that's ok, just update the description :)

Refactor 'CreateDotnetToolProject' method & calls in 'DotNetToolTests'
Rename 'source' param to 'packageSource'
Make 'packageSource' param to accept null
Fix template's 'MSBuildProjectExtensionsPath' with explicit Sdk import
Remove redundant parameter labels on 'CreateDotnetToolProject' in 'DotNetToolTests'

Same here, not sure I see these changes.

[nkolev92]

Hey @Nirmal4G Is it ready for review again?

[Nirmal4G]

Yes, go ahead. 👍

[nkolev92]

LGTM

[zivkan]

@Nirmal4G thanks again for the reminder, and sorry for again being slow. Another deadline has passed, so pressure to finish high priority work is over and I want to spend more time making sure community contributions such as yours get through.