sln-add: Support for slnx #44570

edvilme · 2024-10-31T22:28:36Z

Contributes to #40913

The dotnet CLI should support the new slnx format for building and in the existing solution management commands. It should also help interested users migrate to the new format.

This adds dotnet sln add support for .slnx files

src/Cli/dotnet/commands/dotnet-sln/add/Program.cs

Refactor code Refactor code Add translations Fix typo Fix issues with --solution-folders Standarize error messages and tests Fix solution folder formatting Nit: Address pr comments

src/Cli/dotnet/commands/dotnet-sln/LocalizableStrings.resx

src/Cli/dotnet/commands/dotnet-sln/add/Program.cs

kasperk81 · 2024-11-06T21:36:19Z

@edvilme checkout the complete feedback. using solution.FindProject makes the regex usage irrelevant

src/Cli/dotnet/commands/dotnet-sln/add/Program.cs

test/dotnet-sln.Tests/GivenDotnetSlnList.cs

kasperk81 · 2024-11-22T22:49:19Z

that will hopefully fix errors like
System.Exception : Test dir /private/tmp/helix/working/BD4A0AC6/w/9AEF084D/e/testExecutionDirectory/WhenInvalidSo---41AFE22E_2 already exists

edvilme · 2024-11-26T01:13:25Z

test/dotnet-sln.Tests/GivenDotnetSlnAdd.cs

Here, const strings for expected sln results were moved to a folder under TestAssets, with their .slnx counterparts generated by dotnet sln migrate.
Additional test cases were created for sln.
SlnFile was removed from these tests as well

kasperk81 · 2024-11-26T16:41:37Z

the identifier doesn't help because testmanager's GetTestDestinationDirectoryPath shortens the directory name to 24 characters and we end up having the same errors.

short-term solution is #45130 which goes beyond _2 in the ci.

long-term solution is to make GetTestDestinationDirectoryPath stateless and use Path.GetTempFileName without any hashing or ci specific complexity; right now there are tests like GivenThatWeWantToVerifyNuGetReferenceCompat.Nuget_reference_compat which end up calling GetTestDestinationDirectoryPath multiple times during a single test run and expects names to be deterministic. it is fragile as is because in ci case, it also checks if the directory exists and start using _1 and _2 suffix so the second time it will be called it will get one of those suffixes. so it's at the verge of breakage as we can see in this pr. making sure that name is generated no more than once per test and using that name will make it stateless.

edvilme · 2024-11-26T16:46:25Z

the identifier doesn't help because testmanager's GetTestDestinationDirectoryPath shortens the directory name to 24 characters and we end up having the same errors.

Yes, it pushed before I was able to see your pr, bit of a sync issue there... I like the idea on your PR as it allows us to have a greater variety of different names for different cases (of which there are many on this pr)

kasperk81 · 2024-11-27T02:59:57Z

getting closer! 👍

these tests are failing:

sdk/test/dotnet-new.Tests/PostActionTests.cs

Line 782 in e524077

public void AddProjectToSolution_BasicInSolutionRoot()

sdk/test/dotnet-new.Tests/PostActionTests.cs

Line 818 in e524077

public void AddProjectToSolution_WithOutputAbsolutePath()

sdk/test/dotnet-new.Tests/PostActionTests.cs

Line 854 in e524077

public void AddProjectToSolution_WithOutputRelativePath()

Expected command to not output to stderr but it was not:  
File Name: /Users/runner/work/1/s/artifacts/bin/redist/Release/dotnet/dotnet  
Arguments: new TestAssets.PostActions.AddProjectToSolution.Basic -n MyProject -o output --debug:custom-hive /Users/runner/work/1/s/artifacts/tmp/Release/dotnet-new.IntegrationTests/AddProjectToSolution_WithOutputRelativePath/Home/20241126201252329  
Exit Code: 0  
StdOut:  
The template "TestAssets.PostActions.AddProjectToSolution.Basic" was created successfully.  

Processing post-creation actions...  
Adding  
    project(s): /Users/runner/work/1/s/artifacts/tmp/Release/dotnet-new.IntegrationTests/AddProjectToSolution_WithOutputRelativePath/20241126201252329/output/MyProject.csproj  
    to solution file: /Users/runner/work/1/s/artifacts/tmp/Release/dotnet-new.IntegrationTests/AddProjectToSolution_WithOutputRelativePath/20241126201252329/output/MySolution.sln  
    solution folder: src  
Successfully added project(s) to a solution file.  

StdErr:  
Invalid project /Users/runner/work/1/s/artifacts/tmp/Release/dotnet-new.IntegrationTests/AddProjectToSolution_WithOutputRelativePath/20241126201252329/output/MyProject.csproj. The project file could not be loaded. Could not find file '/Users/runner/work/1/s/artifacts/tmp/Release/dotnet-new.IntegrationTests/AddProjectToSolution_WithOutputRelativePath/20241126201252329/MyProject.csproj'.  /Users/runner/work/1/s/artifacts/tmp/Release/dotnet-new.IntegrationTests/AddProjectToSolution_WithOutputRelativePath/20241126201252329/MyProject.csproj.

test is adding 20241126201252329/output/MyProject.csproj to sln and expecting 20241126201252329/MyProject.csproj (without the /output part)

edvilme · 2024-11-27T16:20:56Z

getting closer! 👍

these tests are failing:

Hii, thanks and thanks for your input. Yes, those tests are currently failing on several PRs and should be unrelated to the changes here. When they're fixed, I will update the branch :)

kasperk81 · 2024-11-27T16:54:45Z

those tests are currently failing on several PRs and should be unrelated to the changes here

can you point me to it?
pr:

git checkout edvilme-slnx-add
./build.sh
.dotnet/dotnet test test/dotnet-new.Tests --filter 'AddProjectToSolution_BasicInSolutionRoot|AddProjectToSolution_WithOutputAbsolutePath|AddProjectToSolution_WithOutputRelativePath' 

Test summary: total: 3, failed: 3, succeeded: 0, skipped: 0, duration: 5,1s

main:

git checkout main
./build.sh
.dotnet/dotnet test test/dotnet-new.Tests --filter 'AddProjectToSolution_BasicInSolutionRoot|AddProjectToSolution_WithOutputAbsolutePath|AddProjectToSolution_WithOutputRelativePath' 

Test summary: total: 3, failed: 0, succeeded: 3, skipped: 0, duration: 6,4s

with 5 retries back and forth, those three tests 100% of the times fail with your branch locally and pass with main

edvilme · 2024-11-27T19:07:43Z

You're right. There were some other tests from templating failing, so I got them mixed up. The issue here is when adding projects from a different directory, e.g., dotnet sln subdirectory/App.sln add subdirectory/Project.csproj. I will look into that

… paths correctly

…o edvilme-slnx-add

kasperk81

lgtm (one nit)

Directory.Packages.props

Forgind

Mostly just questions 🙂 Thanks for all your work to enable this!

Forgind · 2024-11-28T01:13:12Z

src/Cli/dotnet/commands/dotnet-sln/add/Program.cs

-            PathUtility.EnsureAllPathsExist(arguments, CommonLocalizableStrings.CouldNotFindProjectOrDirectory, true);
-
-            var fullProjectPaths = _arguments.Select(p =>
+            try


nit: \n before this

(Also just anywhere you have }, I prefer a \n before the next thing with few exceptions)

Forgind · 2024-11-28T01:13:32Z

src/Cli/dotnet/commands/dotnet-sln/add/Program.cs

+                AddProjectsToSolutionAsync(solutionFileFullPath, fullProjectPaths, CancellationToken.None).Wait();
+                return 0;
+            }
+            catch (GracefulException)


The other catch explicitly excludes this case, and this case just throws, so we can skip this block.

Forgind · 2024-11-28T01:19:07Z

src/Cli/dotnet/commands/dotnet-sln/add/Program.cs

-
-            var currentDirString = $".{Path.DirectorySeparatorChar}";
-            if (projectFilePath.StartsWith(currentDirString))
+            ISolutionSerializer serializer = SlnCommandParser.GetSolutionSerializer(solutionFileFullPath);


Is this a new runtime concept? I don't see it in the SDK currently or in this PR, and a quick bing (google) search didn't reveal anything interesting. If so, should we put this behind #ifdefs?

Which part are you refering to here?

Forgind · 2024-11-28T01:19:57Z

src/Cli/dotnet/commands/dotnet-sln/add/Program.cs

+            ISolutionSerializer serializer = SlnCommandParser.GetSolutionSerializer(solutionFileFullPath);
+            SolutionModel solution = await serializer.OpenAsync(solutionFileFullPath, cancellationToken);
+            // set UTF8 BOM encoding for .sln
+            if (serializer is ISolutionSerializer<SlnV12SerializerSettings> v12Serializer)


What's the significance of V12?

https://github.com/microsoft/vs-solutionpersistence/tree/main/src/Microsoft.VisualStudio.SolutionPersistence/Serializer/SlnV12

i think the "v12" format ensures compatibility with Visual Studio 2013 and later versions. previous versions of vs might not understand solution files created in this schema unless explicitly backported. It has enhanced support for modern project types, including new sdk-style projects and multi-targeting and better integration with msbuild, with the solution file acting as a meta-structure over the projects it includes.

Forgind · 2024-11-28T01:20:33Z

src/Cli/dotnet/commands/dotnet-sln/add/Program.cs

-        {
-            if (_inRoot)
+            // Set default configurations and platforms for sln file
+            foreach (var platform in new[]{ "Any CPU", "x64", "x86" })


I thought we supported ARM now? Not relevant here?

yea platform can be arm/arm64 as well

sdk/src/Tasks/Microsoft.NET.Build.Tasks/targets/Microsoft.NET.RuntimeIdentifierInference.targets

Line 146 in 8f63ab4

<When Condition="$(RuntimeIdentifier.EndsWith('-arm64')) or $(RuntimeIdentifier.Contains('-arm64-'))">

(these are applicable to visual studio, msbuild and roslyn)

Yes, platform can be arm64 too, however this was added as to not break existing changes. In one of the comments I suggest maybe making this a constant so we can modify it easily in the future (?)

this is a drop-in replacement for what dotnet sln add generates today. visual studio generates the similar file when you create a project with solution (it has no arm or arm64).

so far there is no issue showing that it has ever been a requirement from users but even if it is requirement it should be added as a new opt-in option on dotnet sln add command so user can decide if they want to add more platforms

src/Cli/dotnet/commands/dotnet-sln/add/Program.cs

Forgind · 2024-11-28T01:35:01Z

src/Cli/dotnet/commands/dotnet-sln/add/Program.cs

+            foreach (var solutionPlatform in solution.Platforms)
+            {
+                var projectPlatform = projectInstancePlatforms.FirstOrDefault(
+                    x => x.Replace(" ", string.Empty) ==  solutionPlatform.Replace(" ", string.Empty), projectInstancePlatforms.FirstOrDefault("Any CPU"));


nit: better name for 'x'?

Forgind · 2024-11-28T01:35:48Z

src/Cli/dotnet/commands/dotnet-sln/add/Program.cs

-        }
+            foreach (var solutionPlatform in solution.Platforms)
+            {
+                var projectPlatform = projectInstancePlatforms.FirstOrDefault(


If there are multiple, we only care about the first?

Yes, we currently have a test that checks if the first match is added

src/Cli/dotnet/commands/dotnet-sln/add/Program.cs

dotnet-issue-labeler bot added Area-Infrastructure untriaged Request triage from a team member labels Oct 31, 2024

build-analysis bot mentioned this pull request Nov 1, 2024

Test failure - AllWebProjectsRestoreAndBuild fails with Unbalanced Condition for F# MVC templates #40073

Open

kasperk81 reviewed Nov 1, 2024

View reviewed changes

src/Cli/dotnet/commands/dotnet-sln/add/Program.cs Outdated Show resolved Hide resolved

edvilme force-pushed the edvilme-slnx-add branch 2 times, most recently from d397257 to b6aa066 Compare November 5, 2024 20:55

edvilme commented Nov 5, 2024

View reviewed changes

src/Cli/dotnet/commands/dotnet-sln/add/Program.cs Outdated Show resolved Hide resolved

edvilme force-pushed the edvilme-slnx-add branch from 9f9f687 to 6e7f552 Compare November 5, 2024 22:28

build-analysis bot mentioned this pull request Nov 6, 2024

error MSB3231: Unable to remove directory #42963

Open

edvilme added 12 commits November 6, 2024 09:57

[IMP] sln-list: Support for slnx

1d1c4b0

Refactor code Refactor code Add translations Fix typo Fix issues with --solution-folders Standarize error messages and tests Fix solution folder formatting Nit: Address pr comments

sln-add: Support for slnx

bdff950

Handle solution folders

01b3031

Fix tests

277a1d7

Fix UTF8 BOM tests

5e6e3ff

Catch errors

b4ac6a4

Fix additional tests

3f967f7

Fix additional tests

3d52972

Fix additional issues

de95e6d

Remove sdk.slnx file

a090ad4

Fix additional tests

c03cad7

Fix additional tests

90f4248

edvilme force-pushed the edvilme-slnx-add branch from bf6d349 to 90f4248 Compare November 6, 2024 17:58

kasperk81 reviewed Nov 6, 2024

View reviewed changes

src/Cli/dotnet/commands/dotnet-sln/LocalizableStrings.resx Outdated Show resolved Hide resolved

kasperk81 reviewed Nov 6, 2024

View reviewed changes

src/Cli/dotnet/commands/dotnet-sln/add/Program.cs Show resolved Hide resolved

kasperk81 reviewed Nov 6, 2024

View reviewed changes

src/Cli/dotnet/commands/dotnet-sln/add/Program.cs Outdated Show resolved Hide resolved

Fix additional tests

4929979

build-analysis bot mentioned this pull request Nov 6, 2024

dotnet-watch tests failing #40006

Open

Fix duplicate project tests

f88c3eb

kasperk81 reviewed Nov 7, 2024

View reviewed changes

src/Cli/dotnet/commands/dotnet-sln/add/Program.cs Outdated Show resolved Hide resolved

edvilme force-pushed the edvilme-slnx-add branch from 24c9885 to a4a9f74 Compare November 22, 2024 16:38

edvilme added 2 commits November 22, 2024 09:42

[TEST] sln-add: Add example slnx files, and parameters

14bac00

[TEST] sln-add: Use vs-solutionpersistence on templates

96274cf

kasperk81 reviewed Nov 22, 2024

View reviewed changes

test/dotnet-sln.Tests/GivenDotnetSlnList.cs Outdated Show resolved Hide resolved

kasperk81 reviewed Nov 22, 2024

View reviewed changes

test/dotnet-sln.Tests/GivenDotnetSlnList.cs Outdated Show resolved Hide resolved

edvilme added 2 commits November 22, 2024 14:56

[TEST] sln-add: Add SolutionFilesTemplates

68f8de2

[TEST] sln-add: Compare slnx templates

f1a735f

kasperk81 mentioned this pull request Nov 23, 2024

Add support for dotnet sln add file and dotnet sln add folder #45072

Open

edvilme added 3 commits November 25, 2024 11:53

[TEST] sln-add: Fix sln-templates tests

9492a03

[TEST] sln-add: Migrate all tests

6f8c166

Fix typo

13c8cd1

edvilme commented Nov 26, 2024

View reviewed changes

kasperk81 mentioned this pull request Nov 26, 2024

randomize GetTestDestinationDirectoryPath #45130

Merged

[TEST] sln-list: Update testAsset identifiers

2dd69b0

edvilme added 2 commits November 26, 2024 09:25

[TEST] restore: Add App.sln to argument list

6e62402

Merge branch 'main' into edvilme-slnx-add

8992fce

build-analysis bot mentioned this pull request Nov 26, 2024

Microsoft.NET.Build.Containers.IntegrationTests are pulling from Docker Hub #42026

Open

Merge branch 'main' into edvilme-slnx-add

12533a5

edvilme added 2 commits November 27, 2024 11:41

sln-add: When working and solution directories are different, resolve…

d8fbc8e

… paths correctly

Merge branch 'edvilme-slnx-add' of https://github.com/edvilme/sdk int…

c3bac1d

…o edvilme-slnx-add

kasperk81 approved these changes Nov 27, 2024

View reviewed changes

Directory.Packages.props Outdated Show resolved Hide resolved

Nit

f7a4fb7

Forgind reviewed Nov 28, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

sln-add: Support for slnx #44570

sln-add: Support for slnx #44570

edvilme commented Oct 31, 2024 •

edited

Loading

kasperk81 commented Nov 6, 2024

kasperk81 commented Nov 22, 2024

edvilme Nov 26, 2024

kasperk81 commented Nov 26, 2024 •

edited

Loading

edvilme commented Nov 26, 2024

kasperk81 commented Nov 27, 2024

edvilme commented Nov 27, 2024

kasperk81 commented Nov 27, 2024

edvilme commented Nov 27, 2024

kasperk81 left a comment

Forgind left a comment

Forgind Nov 28, 2024

Forgind Nov 28, 2024

Forgind Nov 28, 2024

edvilme Nov 28, 2024

Forgind Nov 28, 2024

kasperk81 Nov 28, 2024

Forgind Nov 28, 2024

kasperk81 Nov 28, 2024

edvilme Nov 28, 2024

kasperk81 Nov 28, 2024

Forgind Nov 28, 2024

Forgind Nov 28, 2024

edvilme Nov 28, 2024

sln-add: Support for slnx #44570

Are you sure you want to change the base?

sln-add: Support for slnx #44570

Conversation

edvilme commented Oct 31, 2024 • edited Loading

kasperk81 commented Nov 6, 2024

kasperk81 commented Nov 22, 2024

Choose a reason for hiding this comment

kasperk81 commented Nov 26, 2024 • edited Loading

edvilme commented Nov 26, 2024

kasperk81 commented Nov 27, 2024

edvilme commented Nov 27, 2024

kasperk81 commented Nov 27, 2024

edvilme commented Nov 27, 2024

kasperk81 left a comment

Choose a reason for hiding this comment

Forgind left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

edvilme commented Oct 31, 2024 •

edited

Loading

kasperk81 commented Nov 26, 2024 •

edited

Loading