sln-add: Get project DefaultProjectTypeGuid (#47661)

edvilme · web-flow · commit 64c106b0377f · 2025-04-02T16:02:49.000-07:00
Fixes #47638, #522 Description and impact When adding a new project that is not known for the SDK or MSBuild, it should read the DefaultProjectTypeGuid property from the project file. Regression Yes - this worked before 9.0.2xx Risk Low – Currently it errors when adding unknown project types, unless the ProjectTypeGuid is specified on the project itself, or on the solution file. Testing Unit tests on this were ambiguous, so they were renamed to better match their cases. I was also able to reproduce the bug...
diff --git a/src/Cli/dotnet/commands/dotnet-sln/add/Program.cs b/src/Cli/dotnet/commands/dotnet-sln/add/Program.cs
@@ -136,15 +136,16 @@ private void AddProject(SolutionModel solution, string solutionRelativeProjectPa
         {
             // Open project instance to see if it is a valid project
             ProjectRootElement projectRootElement = ProjectRootElement.Open(fullPath);
+            ProjectInstance projectInstance = new ProjectInstance(projectRootElement);
             SolutionProjectModel project;
             try
             {
                 project = solution.AddProject(solutionRelativeProjectPath, null, solutionFolder);
             }
-            catch (SolutionArgumentException ex) when (ex.ParamName == "projectTypeName")
+            catch (SolutionArgumentException ex) when (ex.Type == SolutionErrorType.InvalidProjectTypeReference)
             {
                 // If guid is not identified by vs-solutionpersistence, check in project element itself
-                var guid = projectRootElement.GetProjectTypeGuid();
+                var guid = projectRootElement.GetProjectTypeGuid() ?? projectInstance.GetDefaultProjectTypeGuid();
                 if (string.IsNullOrEmpty(guid))
                 {
                     Reporter.Error.WriteLine(CommonLocalizableStrings.UnsupportedProjectType, fullPath);
@@ -153,7 +154,6 @@ private void AddProject(SolutionModel solution, string solutionRelativeProjectPa
                 project = solution.AddProject(solutionRelativeProjectPath, guid, solutionFolder);
             }
             // Add settings based on existing project instance
-            ProjectInstance projectInstance = new ProjectInstance(projectRootElement);
             string projectInstanceId = projectInstance.GetProjectId();
             if (!string.IsNullOrEmpty(projectInstanceId) && serializer is ISolutionSerializer<SlnV12SerializerSettings>)
             {
diff --git a/test/TestAssets/TestProjects/TestAppWithEmptySln/App.slnx b/test/TestAssets/TestProjects/TestAppWithEmptySln/App.slnx
@@ -1 +1 @@
-<Solution />
+<Solution />
diff --git a/test/TestAssets/TestProjects/TestAppWithSlnAndDefaultProjectType/App.sln b/test/TestAssets/TestProjects/TestAppWithSlnAndDefaultProjectType/App.sln
@@ -0,0 +1,5 @@
+
+Microsoft Visual Studio Solution File, Format Version 12.00
+# Visual Studio 15
+VisualStudioVersion = 15.0.26006.2
+MinimumVisualStudioVersion = 10.0.40219.1
diff --git a/test/TestAssets/TestProjects/TestAppWithSlnAndDefaultProjectType/App.slnx b/test/TestAssets/TestProjects/TestAppWithSlnAndDefaultProjectType/App.slnx
@@ -0,0 +1 @@
+<Solution />
diff --git a/test/TestAssets/TestProjects/TestAppWithSlnAndDefaultProjectType/Unknown.unknownproj b/test/TestAssets/TestProjects/TestAppWithSlnAndDefaultProjectType/Unknown.unknownproj
@@ -0,0 +1,7 @@
+<Project>
+
+  <PropertyGroup>
+    <DefaultProjectTypeGuid>{2F08BC15-189B-4804-B644-653F34C968A8}</DefaultProjectTypeGuid>
+  </PropertyGroup>
+
+</Project>
diff --git a/test/dotnet-sln.Tests/GivenDotnetSlnAdd.cs b/test/dotnet-sln.Tests/GivenDotnetSlnAdd.cs
@@ -18,6 +18,7 @@ public static class ProjectTypeGuids
         public const string VBProjectTypeGuid = "{F184B08F-C81C-45F6-A57F-5ABD9991F28F}";
         public const string SolutionFolderGuid = "{2150E333-8FDC-42A3-9474-1A3956D46DE8}";
         public const string SharedProjectGuid = "{D954291E-2A0B-460D-934E-DC6B0785DB48}";
+        public const string DefaultProjectGuid = "{130159A9-F047-44B3-88CF-0CF7F02ED50F}";
     }
 
     public class GivenDotnetSlnAdd : SdkTest
@@ -749,13 +750,13 @@ public void WhenPassedAnUnknownProjectTypeItFails(string solutionCommand)
         [InlineData("sln", "SlnFileWithNoProjectReferencesAndCSharpProject", "CSharpProject", "CSharpProject.csproj", ProjectTypeGuids.CSharpProjectTypeGuid)]
         [InlineData("sln", "SlnFileWithNoProjectReferencesAndFSharpProject", "FSharpProject", "FSharpProject.fsproj", ProjectTypeGuids.FSharpProjectTypeGuid)]
         [InlineData("sln", "SlnFileWithNoProjectReferencesAndVBProject", "VBProject", "VBProject.vbproj", ProjectTypeGuids.VBProjectTypeGuid)]
-        [InlineData("sln", "SlnFileWithNoProjectReferencesAndUnknownProjectWithSingleProjectTypeGuid", "UnknownProject", "UnknownProject.unknownproj", "{130159A9-F047-44B3-88CF-0CF7F02ED50F}")]
-        [InlineData("sln", "SlnFileWithNoProjectReferencesAndUnknownProjectWithMultipleProjectTypeGuids", "UnknownProject", "UnknownProject.unknownproj", "{130159A9-F047-44B3-88CF-0CF7F02ED50F}")]
+        [InlineData("sln", "SlnFileWithNoProjectReferencesAndUnknownProjectWithSingleProjectTypeGuid", "UnknownProject", "UnknownProject.unknownproj", ProjectTypeGuids.DefaultProjectGuid)]
+        [InlineData("sln", "SlnFileWithNoProjectReferencesAndUnknownProjectWithMultipleProjectTypeGuids", "UnknownProject", "UnknownProject.unknownproj", ProjectTypeGuids.DefaultProjectGuid)]
         [InlineData("solution", "SlnFileWithNoProjectReferencesAndCSharpProject", "CSharpProject", "CSharpProject.csproj", ProjectTypeGuids.CSharpProjectTypeGuid)]
         [InlineData("solution", "SlnFileWithNoProjectReferencesAndFSharpProject", "FSharpProject", "FSharpProject.fsproj", ProjectTypeGuids.FSharpProjectTypeGuid)]
         [InlineData("solution", "SlnFileWithNoProjectReferencesAndVBProject", "VBProject", "VBProject.vbproj", ProjectTypeGuids.VBProjectTypeGuid)]
-        [InlineData("solution", "SlnFileWithNoProjectReferencesAndUnknownProjectWithSingleProjectTypeGuid", "UnknownProject", "UnknownProject.unknownproj", "{130159A9-F047-44B3-88CF-0CF7F02ED50F}")]
-        [InlineData("solution", "SlnFileWithNoProjectReferencesAndUnknownProjectWithMultipleProjectTypeGuids", "UnknownProject", "UnknownProject.unknownproj", "{130159A9-F047-44B3-88CF-0CF7F02ED50F}")]
+        [InlineData("solution", "SlnFileWithNoProjectReferencesAndUnknownProjectWithSingleProjectTypeGuid", "UnknownProject", "UnknownProject.unknownproj", ProjectTypeGuids.DefaultProjectGuid)]
+        [InlineData("solution", "SlnFileWithNoProjectReferencesAndUnknownProjectWithMultipleProjectTypeGuids", "UnknownProject", "UnknownProject.unknownproj", ProjectTypeGuids.DefaultProjectGuid)]
         public async Task WhenPassedAProjectItAddsCorrectProjectTypeGuid(
             string solutionCommand,
             string testAsset,
@@ -788,7 +789,7 @@ public async Task WhenPassedAProjectItAddsCorrectProjectTypeGuid(
         [InlineData("solution", ".sln")]
         [InlineData("sln", ".slnx")]
         [InlineData("solution", ".slnx")]
-        public void WhenPassedAProjectWithoutATypeGuidItErrors(string solutionCommand, string solutionExtension)
+        public void WhenPassedAProjectWithoutATypeGuidNorDefaultTypeGuidItErrors(string solutionCommand, string solutionExtension)
         {
             var solutionDirectory = _testAssetsManager
                 .CopyTestAsset("SlnFileWithNoProjectReferencesAndUnknownProjectType", identifier: $"GivenDotnetSlnAdd-{solutionCommand}{solutionExtension}")
@@ -814,6 +815,26 @@ public void WhenPassedAProjectWithoutATypeGuidItErrors(string solutionCommand, s
                 .BeVisuallyEquivalentTo(contentBefore);
         }
 
+        [Theory]
+        [InlineData("sln", ".sln")]
+        [InlineData("solution", ".sln")]
+        [InlineData("sln", ".slnx")]
+        [InlineData("solution", ".slnx")]
+        public void WhenPassedAProjectWithDefaultProjectGuidItPasses(string solutionCommand, string solutionExtension)
+        {
+            var solutionDirectory = _testAssetsManager
+                .CopyTestAsset("TestAppWithSlnAndDefaultProjectType", identifier: $"GivenDotnetSlnAdd-{solutionCommand}{solutionExtension}")
+                .WithSource()
+                .Path;
+            
+            var cmd = new DotnetCommand(Log)
+                .WithWorkingDirectory(solutionDirectory)
+                .Execute(solutionCommand, $"App{solutionExtension}", "add", "Unknown.unknownproj");
+            
+            cmd.Should().Pass();
+            cmd.StdErr.Should().BeEmpty();
+        }
+
         [Theory]
         [InlineData("sln", ".sln")]
         [InlineData("solution", ".sln")]

Original file line number	Diff line number	Diff line change
`@@ -136,15 +136,16 @@ private void AddProject(SolutionModel solution, string solutionRelativeProjectPa`
`136`	`136`	`{`
`137`	`137`	`// Open project instance to see if it is a valid project`
`138`	`138`	`ProjectRootElement projectRootElement = ProjectRootElement.Open(fullPath);`
	`139`	`+ ProjectInstance projectInstance = new ProjectInstance(projectRootElement);`
`139`	`140`	`SolutionProjectModel project;`
`140`	`141`	`try`
`141`	`142`	`{`
`142`	`143`	`project = solution.AddProject(solutionRelativeProjectPath, null, solutionFolder);`
`143`	`144`	`}`
`144`		`- catch (SolutionArgumentException ex) when (ex.ParamName == "projectTypeName")`
	`145`	`+ catch (SolutionArgumentException ex) when (ex.Type == SolutionErrorType.InvalidProjectTypeReference)`
`145`	`146`	`{`
`146`	`147`	`// If guid is not identified by vs-solutionpersistence, check in project element itself`
`147`		`- var guid = projectRootElement.GetProjectTypeGuid();`
	`148`	`+ var guid = projectRootElement.GetProjectTypeGuid() ?? projectInstance.GetDefaultProjectTypeGuid();`
`148`	`149`	`if (string.IsNullOrEmpty(guid))`
`149`	`150`	`{`
`150`	`151`	`Reporter.Error.WriteLine(CommonLocalizableStrings.UnsupportedProjectType, fullPath);`
`@@ -153,7 +154,6 @@ private void AddProject(SolutionModel solution, string solutionRelativeProjectPa`
`153`	`154`	`project = solution.AddProject(solutionRelativeProjectPath, guid, solutionFolder);`
`154`	`155`	`}`
`155`	`156`	`// Add settings based on existing project instance`
`156`		`- ProjectInstance projectInstance = new ProjectInstance(projectRootElement);`
`157`	`157`	`string projectInstanceId = projectInstance.GetProjectId();`
`158`	`158`	`if (!string.IsNullOrEmpty(projectInstanceId) && serializer is ISolutionSerializer<SlnV12SerializerSettings>)`
`159`	`159`	`{`