Support multiple solution files (#5)

Previously, running `scip-dotnet index` in a codebase with multiple
`.sln` files failed to run. Now, we index all solutions instead.

Indexing all solution files adds unnecessary overhead in some cases
because some solution files don't appear to influence the generated SCIP
index. However, the benefit of this change is that we can automatically
index a repo without manual interaction from the user. If performance is
an issue thne the user can manually specify which solution file to use.

Author: olafurpg

.github/workflows/test.yml

@@ -24,7 +24,6 @@ jobs:
       fail-fast: false
       matrix:
         os: [ubuntu-latest, windows-latest, macos-latest]
-    name: Test
     steps:
       - uses: actions/checkout@v3
       - uses: actions/setup-dotnet@v3

ScipDotnet.Tests/SnapshotTests.cs

@@ -142,20 +142,15 @@ private static string IndexDirectory(string directory)
             {
                 FileName = "dotnet",
                 Arguments = arguments,
-                UseShellExecute = false,
-                RedirectStandardOutput = true,
                 WorkingDirectory = RootDirectory(),
-                RedirectStandardError = true
             }
         };
         process.Start();
         process.WaitForExit();
         if (process.ExitCode != 0)
         {
-            var stdout = process.StandardOutput.ReadToEnd();
-            var stderr = process.StandardError.ReadToEnd();
             Assert.Fail(
-                $"non-zero exit code {process.ExitCode} indexing {directory}\ndotnet {arguments}\n{stdout}{stderr}");
+                $"non-zero exit code {process.ExitCode} indexing {directory}\ndotnet {arguments}");
         }
 
         return Path.Join(directory, "index.scip");

ScipDotnet/IndexCommandHandler.cs

@@ -11,41 +11,42 @@ namespace ScipDotnet;
 
 public static class IndexCommandHandler
 {
-    public static async Task<int> Process(IHost host, FileInfo? projects, string output, FileInfo workingDirectory,
+    public static async Task<int> Process(IHost host, List<FileInfo> projects, string output, FileInfo workingDirectory,
         List<string> include, List<string> exclude, bool allowGlobalSymbolDefinitions)
     {
         var logger = host.Services.GetRequiredService<ILogger<IndexCommandOptions>>();
         var matcher = new Matcher();
         matcher.AddIncludePatterns(include.Count == 0 ? new[] { "**" } : include);
         matcher.AddExcludePatterns(exclude);
 
-        var projectsFile = projects?.FullName ?? FindSolutionOrProjectFile(workingDirectory, logger);
-        if (projectsFile == null)
+        var projectFiles = projects.Count > 0
+            ? projects
+            : FindSolutionOrProjectFile(workingDirectory, logger);
+        if (!projectFiles.Any())
         {
             return 1;
         }
 
-        var options = new IndexCommandOptions(workingDirectory, OutputFile(workingDirectory, output),
-            new FileInfo(projectsFile), logger, matcher,
-            allowGlobalSymbolDefinitions);
+        var options = new IndexCommandOptions(
+            workingDirectory,
+            OutputFile(workingDirectory, output),
+            projectFiles,
+            logger,
+            matcher,
+            allowGlobalSymbolDefinitions
+        );
         await ScipIndex(host, options);
         return 0;
     }
 
     private static FileInfo OutputFile(FileInfo workingDirectory, string output)
     {
-        if (Path.IsPathRooted(output))
-        {
-            return new FileInfo(output);
-        }
-
-        return new FileInfo(Path.Join(workingDirectory.FullName, output));
+        return Path.IsPathRooted(output) ? new FileInfo(output) : new FileInfo(Path.Join(workingDirectory.FullName, output));
     }
 
     private static async Task ScipIndex(IHost host, IndexCommandOptions options)
     {
         var stopwatch = Stopwatch.StartNew();
-        options.Logger.LogInformation("Solution file {SolutionFileFullName}", options.ProjectsFile.FullName);
         var indexer = host.Services.GetRequiredService<ScipIndexer>();
         var index = new Scip.Index
         {
@@ -72,34 +73,26 @@ private static async Task ScipIndex(IHost host, IndexCommandOptions options)
 
     private static string FixThisProblem(string examplePath)
     {
-        return "To fix this problem, pass the path of a solution (.sln) or project (.csproj) file to the `scip-dotnet index` command. " +
-        $"For example, run: scip-dotnet index {examplePath}";
+        return
+            "To fix this problem, pass the path of a solution (.sln) or project (.csproj) file to the `scip-dotnet index` command. " +
+            $"For example, run: scip-dotnet index {examplePath}";
     }
-    
-    private static string? FindSolutionOrProjectFile(FileInfo workingDirectory, ILogger<IndexCommandOptions> logger)
+
+    private static List<FileInfo> FindSolutionOrProjectFile(FileInfo workingDirectory, ILogger logger)
     {
         var paths = Directory.GetFiles(workingDirectory.FullName).Where(file =>
             string.Equals(Path.GetExtension(file), ".sln", StringComparison.OrdinalIgnoreCase) ||
             string.Equals(Path.GetExtension(file), ".csproj", StringComparison.OrdinalIgnoreCase)
         ).ToList();
 
-        switch (paths.Count)
+        if (paths.Count != 0)
         {
-            case 0:
-                logger.LogError(
-                    "No solution (.sln) or .csproj file detected in the working directory '{WorkingDirectory}'. {FixThis}",
-                    workingDirectory.FullName, FixThisProblem("SOLUTION_FILE"));
-                return null;
-            case 1:
-                return paths.First();
+            return paths.Select(path => new FileInfo(path)).ToList();
         }
 
-        var relativePaths = paths.Select(path => Path.GetRelativePath(workingDirectory.FullName, path)).ToList();
         logger.LogError(
-            "Ambiguous solution files: {Join}. {FixThis}",
-            String.Join(", ", relativePaths),
-            FixThisProblem(relativePaths.First()));
-        return null;
-
+            "No solution (.sln) or .csproj file detected in the working directory '{WorkingDirectory}'. {FixThis}",
+            workingDirectory.FullName, FixThisProblem("SOLUTION_FILE"));
+        return new List<FileInfo>();
     }
 }

ScipDotnet/IndexCommandOptions.cs

@@ -6,7 +6,7 @@ namespace ScipDotnet;
 public record IndexCommandOptions(
     FileInfo WorkingDirectory,
     FileInfo Output,
-    FileInfo ProjectsFile,
+    List<FileInfo> ProjectsFile,
     ILogger<IndexCommandOptions> Logger,
     Matcher Matcher,
     bool AllowGlobalSymbolDefinitions

ScipDotnet/Program.cs

@@ -20,7 +20,7 @@ public static async Task<int> Main(string[] args)
         var indexCommand = new Command("index", "Index a solution file")
         {
             new Argument<FileInfo>("projects", "Path to the .sln (solution) or .csproj file")
-                { Arity = ArgumentArity.ZeroOrOne },
+                { Arity = ArgumentArity.ZeroOrMore },
             new Option<string>("--output", () => "index.scip",
                 "Path to the output SCIP index file"),
             new Option<FileInfo>("--working-directory",

ScipDotnet/ScipCSharpSyntaxWalker.cs

@@ -243,7 +243,8 @@ private ScipSymbol CreateScipPackageSymbol(ISymbol sym)
         }
 
 
-        return ScipSymbol.Package(sym.ContainingAssembly.Identity.Name,
+        return ScipSymbol.Package(
+            sym.ContainingAssembly.Identity.Name,
             sym.ContainingAssembly.Identity.Version.ToString());
     }
 

ScipDotnet/ScipDotnet.csproj

@@ -8,7 +8,7 @@
     <PackageLicenseFile>LICENSE</PackageLicenseFile>
     <PackageReadmeFile>readme.md</PackageReadmeFile>
     <PackageType>DotnetTool</PackageType>
-    <TargetFrameworks>net6.0;net7.0</TargetFrameworks>
+    <TargetFramework>net7.0</TargetFramework>
     <PackAsTool>true</PackAsTool>
     <AssemblyName>scip-dotnet</AssemblyName>
     <RepositoryUrl>https://github.com/sourcegraph/scip-dotnet</RepositoryUrl>

ScipDotnet/ScipIndexer.cs

@@ -20,11 +20,9 @@ public ScipIndexer(ILogger<ScipIndexer> logger)
 
     private ILogger<ScipIndexer> Logger { get; }
 
-    private void Restore(IndexCommandOptions options)
+    private static void Restore(IndexCommandOptions options, FileInfo project)
     {
-        var arguments = options.ProjectsFile.FullName.EndsWith(".sln")
-            ? $"restore {options.ProjectsFile.FullName}"
-            : "restore";
+        var arguments = project.Extension.Equals(".sln") ? $"restore {project.FullName}" : "restore";
         var process = new Process()
         {
             StartInfo = new ProcessStartInfo()
@@ -40,15 +38,28 @@ private void Restore(IndexCommandOptions options)
 
     public async IAsyncEnumerable<Scip.Document> IndexDocuments(IHost host, IndexCommandOptions options)
     {
-        Restore(options);
-        IEnumerable<Project> projects = string.Equals(options.ProjectsFile.Extension, ".csproj")
+        var indexedProjects = new HashSet<ProjectId>();
+        foreach (var project in options.ProjectsFile)
+        {
+            await foreach (var document in IndexProject(host, options, project, indexedProjects))
+            {
+                yield return document;
+            }
+        }
+    }
+
+    private async IAsyncEnumerable<Scip.Document> IndexProject(IHost host, IndexCommandOptions options,
+        FileInfo rootProject, HashSet<ProjectId> indexedProjects)
+    {
+        Restore(options, rootProject);
+        IEnumerable<Project> projects = string.Equals(rootProject.Extension, ".csproj")
             ? new[]
             {
                 await host.Services.GetRequiredService<MSBuildWorkspace>()
-                    .OpenProjectAsync(options.ProjectsFile.FullName)
+                    .OpenProjectAsync(rootProject.FullName)
             }
             : (await host.Services.GetRequiredService<MSBuildWorkspace>()
-                .OpenSolutionAsync(options.ProjectsFile.FullName)).Projects;
+                .OpenSolutionAsync(rootProject.FullName)).Projects;
 
         foreach (var project in projects)
         {
@@ -60,6 +71,13 @@ await host.Services.GetRequiredService<MSBuildWorkspace>()
                 continue;
             }
 
+            if (indexedProjects.Contains(project.Id))
+            {
+                continue;
+            }
+
+            indexedProjects.Add(project.Id);
+
             var globals = new Dictionary<ISymbol, ScipSymbol>(SymbolEqualityComparer.Default);
 
             foreach (var document in project.Documents)

ScipDotnet/ScipSymbol.cs

@@ -26,7 +26,6 @@ public static ScipSymbol Global(ScipSymbol owner, SymbolDescriptor descriptor)
     }
 
 
-
     public static ScipSymbol Local(int counter)
     {
         return new ScipSymbol("local " + counter);
@@ -37,7 +36,12 @@ public static ScipSymbol Local(int counter)
 
     public static ScipSymbol Package(string name, string version)
     {
-        return new ScipSymbol("scip-dotnet nuget " + name + " " + version + " ");
+        return new ScipSymbol(
+            "scip-dotnet nuget " +
+            // SCIP package names and versions should use double-space to escape space characters.
+            name.Replace(" ", "  ") + " " +
+            version.Replace(" ", "  ") + " "
+        );
     }
 
     private static string DescriptorString(SymbolDescriptor desc)
@@ -75,5 +79,4 @@ private static bool IsSimpleIdentifier(string name)
     {
         return Regex.IsMatch(name, @"^[\w$+-]+$", RegexOptions.IgnoreCase);
     }
-
-}
+}

readme.md

@@ -72,7 +72,7 @@ cd scip-dotnet
 Finally, use `dotnet run` to run the indexer locally.
 
 ```shell
-dotnet run --framework net6.0 --project ScipDotnet -- index --working-directory PATH_TO_DIRECTORY_YOU_WANT_TO_INDEX
+dotnet run --project ScipDotnet -- index --working-directory PATH_TO_DIRECTORY_YOU_WANT_TO_INDEX
 ```
 
 Once scip-dotnet has finished indexing the project, there should be an