Fix restore when a package is installed with a version specified in CPM

[vernou]

Bug

Fixes: NuGet/Home#13657

Description

When dotnet add package with version specified in Directory.Packages.props, the restored dependency is the last version and no the version specified in Directory.Packages.props.

The modification :
If a CPM version is available for the installed package then uses it.
Else old behavior (last package version)

PR Checklist

• Meaningful title, helpful description and a linked NuGet/Home issue
• Added tests
• Link to an issue or pull request to update docs if this PR changes settings, environment variables, new feature, etc.

[zivkan]

@vernou thanks for the PR. I was hoping it'd be as easy as what this PR currently is.

If you look at the CI build, you'll see there's 2 failing test across multiple platforms: AddPkg_WithCPM_WithPackageReference_WithVersionOverride_WithPackageVersion_NoVersionCLI_NoOps and AddPkg_WithCPM_WhenPackageVersionDoesNotExistAndVersionCLIArgNotPassed_Success

Have a look at what other tests also exist in the same class, and figure out if we need any more test scenarios.

The other tests failing on CI look like they're flakey, so ignore them.

[vernou]

The test AddPkg_WithCPM_WithPackageReference_WithVersionOverride_WithPackageVersion_NoVersionCLI_NoOps expects the command add package fails.
The commande fails because the resolved version range from source hasn't OriginalString, so MSBuild fail to update the project with this error :

error: System.AggregateException: One or more errors occurred. (Parameter "Value" cannot be null.)
error:  ---> System.ArgumentNullException: Parameter "Value" cannot be null.
error:    at Microsoft.Build.Shared.ErrorUtilities.ThrowArgumentNull(String parameterName, String resourceName)
error:    at Microsoft.Build.Construction.ProjectMetadataElement.set_Value(String value)
error:    at NuGet.CommandLine.XPlat.MSBuildAPIUtility.UpdateVersionOverride(Project project, ProjectItem packageReference, String versionCLIArgument) in \NuGet.Client\src\NuGet.Core\NuGet.CommandLine.XPlat\Utility\MSBuildAPIUtility.cs:line 575
error:    at NuGet.CommandLine.XPlat.MSBuildAPIUtility.AddPackageReference(Project project, LibraryDependency libraryDependency, IEnumerable`1 existingPackageReferences, Boolean noVersion, String framework) in \NuGet.Client\src\NuGet.Core\NuGet.CommandLine.XPlat\Utility\MSBuildAPIUtility.cs:line 332
error:    at NuGet.CommandLine.XPlat.MSBuildAPIUtility.AddPackageReference(String projectPath, LibraryDependency libraryDependency, Boolean noVersion) in \NuGet.Client\src\NuGet.Core\NuGet.CommandLine.XPlat\Utility\MSBuildAPIUtility.cs:line 258
error:    at NuGet.CommandLine.XPlat.AddPackageReferenceCommandRunner.ExecuteCommand(PackageReferenceArgs packageReferenceArgs, MSBuildAPIUtility msBuild) in \NuGet.Client\src\NuGet.Core\NuGet.CommandLine.XPlat\Commands\PackageReferenceCommands\AddPackageReferenceCommandRunner.cs:line 242

With the PR fix, the resolved version range from CPM has OriginalString, so MSBuild success to update the project (but do nothing, because CPM is enable) and the command success... and the test fails.

---

I see two possibilities :

• Adapt the test
• Force to set OriginalString to null in the version range retrieved from the CPM

I don't undertand why the command is expected to fail and the reason/error sounds dirty.
So I think the test should be modified.

@zivkan, what do you think?

[vernou]

I implemented the second to see. When the version is resolved from CPM, the resolved version OriginalString is forced to null.
So AddPkg_WithCPM_WithPackageReference_WithVersionOverride_WithPackageVersion_NoVersionCLI_NoOps success.

---

I fixed my code and AddPkg_WithCPM_WhenPackageVersionDoesNotExistAndVersionCLIArgNotPassed_Success success.

[vernou]

After going through the tests to be able to add a test, I think I have a better understanding of how they work.
Finally I decided to keep central version range original string and alter the test AddPkg_WithCPM_WithPackageReference_WithVersionOverride_WithPackageVersion_NoVersionCLI_NoOps.

@zivkan, the PR is ready to review.