Merge pull request #1220 from icsharpcode/issue/1212

First effort to support slnx

Author: GrahamTheCoder

CodeConv/CodeConvProgram.cs

@@ -105,8 +105,10 @@ private async Task ConvertAsync(IProgress<ConversionProgress> progress, Cancella
 
         IProgress<string> strProgress = new Progress<string>(p => progress.Report(new ConversionProgress(p)));
 
-        if (!string.Equals(Path.GetExtension(finalSolutionPath), ".sln", StringComparison.OrdinalIgnoreCase)) {
-            throw new ValidationException("Solution path must end in `.sln`");
+        var ext = Path.GetExtension(finalSolutionPath);
+        if (!string.Equals(ext, ".sln", StringComparison.OrdinalIgnoreCase) &&
+            !string.Equals(ext, ".slnx", StringComparison.OrdinalIgnoreCase)) {
+            throw new ValidationException("Solution path must end in `.sln` or `.slnx`");
         }
 
         string? directoryName = string.IsNullOrWhiteSpace(OutputDirectory) ? Path.GetDirectoryName(finalSolutionPath) : OutputDirectory;

CodeConverter/Common/SolutionConverter.cs

@@ -43,8 +43,10 @@ public static SolutionConverter CreateFor(ILanguageConversion languageConversion
             return (proj.Name, RelativeProjPath: relativeProjPath, ProjContents: projContents);
         });
 
+        // .slnx files have no project GUIDs - skip the GUID lookup by passing empty solution contents
+        var isSlnx = string.Equals(Path.GetExtension(solutionFilePath), ".slnx", StringComparison.OrdinalIgnoreCase);
         var solutionFileTextEditor = new SolutionFileTextEditor();
-        var projectReferenceReplacements = solutionFileTextEditor.GetProjectFileProjectReferenceReplacements(projTuples, sourceSolutionContents);
+        var projectReferenceReplacements = solutionFileTextEditor.GetProjectFileProjectReferenceReplacements(projTuples, isSlnx ? "" : sourceSolutionContents);
 
         return new SolutionConverter(solutionFilePath, sourceSolutionContents, projectsToConvert, projectReferenceReplacements, languageConversion, fileSystem, progress ?? new Progress<ConversionProgress>(), cancellationToken);
     }
@@ -108,12 +110,20 @@ private IEnumerable<ConversionResult> UpdateProjectReferences(IEnumerable<Projec
 
     public ConversionResult ConvertSolutionFile()
     {
-        var projectTypeGuidMappings = _languageConversion.GetProjectTypeGuidMappings();
-        var relativeProjPaths = _projectsToConvert.Select(proj =>
-            (proj.Name, RelativeProjPath: PathConverter.GetRelativePath(_solutionFilePath, proj.FilePath)));
-
-        var slnProjectReferenceReplacements = SolutionFileTextEditor.GetSolutionFileProjectReferenceReplacements(relativeProjPaths,
-            _sourceSolutionContents, projectTypeGuidMappings);
+        IEnumerable<(string Find, string Replace, bool FirstOnly)> slnProjectReferenceReplacements;
+
+        if (string.Equals(Path.GetExtension(_solutionFilePath), ".slnx", StringComparison.OrdinalIgnoreCase)) {
+            var relativeProjPaths = _projectsToConvert.Select(proj =>
+                PathConverter.GetRelativePath(_solutionFilePath, proj.FilePath));
+            slnProjectReferenceReplacements = SolutionFileTextEditor.GetSlnxSolutionFileProjectReferenceReplacements(
+                relativeProjPaths, _sourceSolutionContents);
+        } else {
+            var projectTypeGuidMappings = _languageConversion.GetProjectTypeGuidMappings();
+            var relativeProjPaths = _projectsToConvert.Select(proj =>
+                (proj.Name, RelativeProjPath: PathConverter.GetRelativePath(_solutionFilePath, proj.FilePath)));
+            slnProjectReferenceReplacements = SolutionFileTextEditor.GetSolutionFileProjectReferenceReplacements(
+                relativeProjPaths, _sourceSolutionContents, projectTypeGuidMappings);
+        }
 
         var convertedSolutionContents = TextReplacementConverter.Replace(_sourceSolutionContents, slnProjectReferenceReplacements);
         return new ConversionResult(convertedSolutionContents) {

CodeConverter/Common/SolutionFileTextEditor.cs

@@ -4,6 +4,25 @@ namespace ICSharpCode.CodeConverter.Common;
 
 public class SolutionFileTextEditor : ISolutionFileTextEditor
 {
+    /// <summary>
+    /// For .slnx files: simply replaces project path extensions (no GUIDs or project type GUIDs exist in .slnx).
+    /// </summary>
+    public static List<(string Find, string Replace, bool FirstOnly)> GetSlnxSolutionFileProjectReferenceReplacements(
+        IEnumerable<string> relativeProjPaths, string sourceSolutionContents)
+    {
+        if (string.IsNullOrWhiteSpace(sourceSolutionContents)) return new List<(string Find, string Replace, bool FirstOnly)>();
+
+        var projectReferenceReplacements = new List<(string Find, string Replace, bool FirstOnly)>();
+        foreach (var relativeProjPath in relativeProjPaths)
+        {
+            var escapedProjPath = Regex.Escape(relativeProjPath);
+            var newProjPath = PathConverter.TogglePathExtension(relativeProjPath);
+            projectReferenceReplacements.Add((escapedProjPath, newProjPath, false));
+        }
+
+        return projectReferenceReplacements;
+    }
+
     public static List<(string Find, string Replace, bool FirstOnly)> GetSolutionFileProjectReferenceReplacements(
         IEnumerable<(string Name, string RelativeProjPath)> projTuples, string sourceSolutionContents,
         IReadOnlyCollection<(string, string)> projTypeGuidMappings)

Tests/LanguageAgnostic/SolutionFileTextEditorTests.cs

@@ -552,15 +552,15 @@ private static string GetProjectProjectReference(IReadOnlyCollection<string> rel
         return Utils.HomogenizeEol(referenceString);
     }
 
-    private static Solution CreateTestSolution()
+    private static Solution CreateTestSolution(string filePath = SlnFilePath)
     {
         var ws = Task.Run(() => ThreadSafeWorkspaceHelper.CreateAdhocWorkspace.GetValueAsync())
 #pragma warning disable VSTHRD002 // Avoid problematic synchronous waits - the tests don't deadlock
             .GetAwaiter().GetResult();
 #pragma warning restore VSTHRD002 // Avoid problematic synchronous waits
         var solutionId = SolutionId.CreateNewId(SlnName);
         var versionStamp = VersionStamp.Create();
-        var solutionInfo = SolutionInfo.Create(solutionId, versionStamp, SlnFilePath);
+        var solutionInfo = SolutionInfo.Create(solutionId, versionStamp, filePath);
 
         return ws.AddSolution(solutionInfo);
     }
@@ -589,4 +589,54 @@ private static async Task<string> GetConvertedCodeAsync(SolutionConverter slnCon
 
         return conversionResult.ConvertedCode;
     }
+
+    [Fact]
+    public void ConvertSlnxSolutionFile_WhenInSolutionBaseDirThenUpdated()
+    {
+        //Arrange
+        var slnxContents = "<Solution>\r\n  <Project Path=\"VbLibrary.vbproj\" />\r\n</Solution>";
+        var slnxSln = CreateTestSolution(@"C:\MySolution\MySolution.slnx");
+        var projectId = ProjectId.CreateNewId();
+        var projInfo = ProjectInfo.Create(projectId, VersionStamp.Create(), "VbLibrary", "VbLibrary",
+            LanguageNames.VisualBasic, @"C:\MySolution\VbLibrary.vbproj");
+        slnxSln = slnxSln.AddProject(projInfo);
+        var testProject = slnxSln.GetProject(projectId);
+
+        _fsMock.Setup(mock => mock.File.ReadAllText(It.IsAny<string>())).Returns("");
+
+        var slnConverter = SolutionConverter.CreateFor<VBToCSConversion>(new List<Project> { testProject },
+            fileSystem: _fsMock.Object, solutionContents: slnxContents);
+
+        //Act
+        var convertedSlnFile = slnConverter.ConvertSolutionFile().ConvertedCode;
+
+        //Assert
+        var expectedSlnFile = "<Solution>\r\n  <Project Path=\"VbLibrary.csproj\" />\r\n</Solution>";
+        Assert.Equal(expectedSlnFile, Utils.HomogenizeEol(convertedSlnFile));
+    }
+
+    [Fact]
+    public void ConvertSlnxSolutionFile_WhenInProjectFolderThenUpdated()
+    {
+        //Arrange
+        var slnxContents = "<Solution>\r\n  <Project Path=\"VbLibrary\\VbLibrary.vbproj\" />\r\n</Solution>";
+        var slnxSln = CreateTestSolution(@"C:\MySolution\MySolution.slnx");
+        var projectId = ProjectId.CreateNewId();
+        var projInfo = ProjectInfo.Create(projectId, VersionStamp.Create(), "VbLibrary", "VbLibrary",
+            LanguageNames.VisualBasic, @"C:\MySolution\VbLibrary\VbLibrary.vbproj");
+        slnxSln = slnxSln.AddProject(projInfo);
+        var testProject = slnxSln.GetProject(projectId);
+
+        _fsMock.Setup(mock => mock.File.ReadAllText(It.IsAny<string>())).Returns("");
+
+        var slnConverter = SolutionConverter.CreateFor<VBToCSConversion>(new List<Project> { testProject },
+            fileSystem: _fsMock.Object, solutionContents: slnxContents);
+
+        //Act
+        var convertedSlnFile = slnConverter.ConvertSolutionFile().ConvertedCode;
+
+        //Assert
+        var expectedSlnFile = "<Solution>\r\n  <Project Path=\"VbLibrary\\VbLibrary.csproj\" />\r\n</Solution>";
+        Assert.Equal(expectedSlnFile, Utils.HomogenizeEol(convertedSlnFile));
+    }
 }