C#: Minimal update of relevant code to minimize project dependencies and hide some implementation details behind interfaces.

Author: michaelnebel

csharp/extractor/Semmle.Extraction.CSharp.DependencyFetching/AssemblyCache.cs

@@ -1,9 +1,9 @@
-using System.Collections.Generic;
-using System.Linq;
+using System;
+using System.Collections.Generic;
 using System.IO;
-using System;
+using System.Linq;
 
-namespace Semmle.BuildAnalyser
+namespace Semmle.Extraction.CSharp.DependencyFetching
 {
     /// <summary>
     /// Manages the set of assemblies.

csharp/extractor/Semmle.Extraction.CSharp.DependencyFetching/AssemblyInfo.cs

@@ -6,7 +6,7 @@
 using System.Security.Cryptography;
 using System.Text;
 
-namespace Semmle.BuildAnalyser
+namespace Semmle.Extraction.CSharp.DependencyFetching
 {
     /// <summary>
     /// Stores information about an assembly file (DLL).

csharp/extractor/Semmle.Extraction.CSharp.DependencyFetching/AssemblyLoadException.cs

@@ -1,6 +1,6 @@
 using System;
 
-namespace Semmle.BuildAnalyser
+namespace Semmle.Extraction.CSharp.DependencyFetching
 {
     public class AssemblyLoadException : Exception { }
 }

csharp/extractor/Semmle.Extraction.CSharp.DependencyFetching/DependencyManager.cs

@@ -1,20 +1,20 @@
-using Semmle.Util;
-using System;
+using System;
+using System.Collections.Concurrent;
 using System.Collections.Generic;
 using System.IO;
 using System.Linq;
-using Semmle.Extraction.CSharp.Standalone;
-using System.Threading.Tasks;
-using System.Collections.Concurrent;
-using System.Text;
 using System.Security.Cryptography;
+using System.Text;
+using System.Threading.Tasks;
+using Semmle.Util;
+using Semmle.Util.Logging;
 
-namespace Semmle.BuildAnalyser
+namespace Semmle.Extraction.CSharp.DependencyFetching
 {
     /// <summary>
     /// Main implementation of the build analysis.
     /// </summary>
-    internal sealed class BuildAnalysis : IDisposable
+    public sealed class DependencyManager : IDisposable
     {
         private readonly AssemblyCache assemblyCache;
         private readonly ProgressMonitor progressMonitor;
@@ -25,25 +25,25 @@ internal sealed class BuildAnalysis : IDisposable
         private int succeededProjects;
         private readonly string[] allSources;
         private int conflictedReferences = 0;
-        private readonly Options options;
+        private readonly IDependencyOptions options;
         private readonly DirectoryInfo sourceDir;
         private readonly DotNet dotnet;
         private readonly FileContent fileContent;
         private readonly TemporaryDirectory packageDirectory;
 
 
         /// <summary>
-        /// Performs a C# build analysis.
+        /// Performs a C# dependency fetching.
         /// </summary>
-        /// <param name="options">Analysis options from the command line.</param>
-        /// <param name="progressMonitor">Display of analysis progress.</param>
-        public BuildAnalysis(Options options, ProgressMonitor progressMonitor)
+        /// <param name="options">Dependency fetching options</param>
+        /// <param name="logger">Logger for dependency fetching progress.</param>
+        public DependencyManager(string srcDir, IDependencyOptions options, ILogger logger)
         {
             var startTime = DateTime.Now;
 
             this.options = options;
-            this.progressMonitor = progressMonitor;
-            this.sourceDir = new DirectoryInfo(options.SrcDir);
+            this.progressMonitor = new ProgressMonitor(logger);
+            this.sourceDir = new DirectoryInfo(srcDir);
 
             try
             {
@@ -55,7 +55,7 @@ public BuildAnalysis(Options options, ProgressMonitor progressMonitor)
                 throw;
             }
 
-            this.progressMonitor.FindingFiles(options.SrcDir);
+            this.progressMonitor.FindingFiles(srcDir);
 
             packageDirectory = new TemporaryDirectory(ComputeTempDirectory(sourceDir.FullName));
 
@@ -285,7 +285,7 @@ private void AnalyseProject(FileInfo project)
 
             try
             {
-                var csProj = new Extraction.CSharp.CsProjFile(project);
+                var csProj = new CsProjFile(project);
 
                 foreach (var @ref in csProj.References)
                 {
@@ -329,7 +329,6 @@ private void Restore(IEnumerable<string> targets, string? pathToNugetConfig = nu
             }
         }
 
-
         private void DownloadMissingPackages()
         {
             var nugetConfigs = GetFiles("nuget.config", recurseSubdirectories: true).ToArray();

csharp/extractor/Semmle.Extraction.CSharp.DependencyFetching/DependencyOptions.cs

@@ -0,0 +1,73 @@
+using System.Linq;
+using System.Collections.Generic;
+
+namespace Semmle.Extraction.CSharp.DependencyFetching
+{
+    /// <summary>
+    /// Dependency fetching related options.
+    /// </summary>
+    public interface IDependencyOptions
+    {
+        /// <summary>
+        /// Directories to search DLLs in.
+        /// </summary>
+        IList<string> DllDirs { get; }
+
+        /// <summary>
+        /// Files/patterns to exclude.
+        /// </summary>
+        IList<string> Excludes { get; }
+
+        /// <summary>
+        /// Whether to analyse NuGet packages.
+        /// </summary>
+        bool UseNuGet { get; }
+
+        /// <summary>
+        /// The solution file to analyse, or null if not specified.
+        /// </summary>
+        string? SolutionFile { get; }
+
+        /// <summary>
+        /// Whether to use the packaged dotnet runtime.
+        /// </summary>
+        bool UseSelfContainedDotnet { get; }
+
+        /// <summary>
+        /// Whether to search the .Net framework directory.
+        /// </summary>
+        bool ScanNetFrameworkDlls { get; }
+
+        /// <summary>
+        /// Whether to use mscorlib as a reference.
+        /// </summary>
+        bool UseMscorlib { get; }
+
+        /// <summary>
+        /// Determine whether the given path should be excluded.
+        /// </summary>
+        /// <param name="path">The path to query.</param>
+        /// <returns>True iff the path matches an exclusion.</returns>
+        bool ExcludesFile(string path);
+    }
+
+    public class DependencyOptions : IDependencyOptions
+    {
+        public IList<string> DllDirs { get; set; } = new List<string>();
+
+        public IList<string> Excludes { get; set; } = new List<string>();
+
+        public bool UseNuGet { get; set; } = true;
+
+        public string? SolutionFile { get; set; }
+
+        public bool UseSelfContainedDotnet { get; set; } = false;
+
+        public bool ScanNetFrameworkDlls { get; set; } = true;
+
+        public bool UseMscorlib { get; set; } = true;
+
+        public bool ExcludesFile(string path) =>
+            Excludes.Any(path.Contains);
+    }
+}

csharp/extractor/Semmle.Extraction.CSharp.DependencyFetching/DotNet.cs

@@ -3,7 +3,7 @@
 using System.Diagnostics;
 using Semmle.Util;
 
-namespace Semmle.BuildAnalyser
+namespace Semmle.Extraction.CSharp.DependencyFetching
 {
     internal interface IDotNet
     {

csharp/extractor/Semmle.Extraction.CSharp.DependencyFetching/FileContent.cs

@@ -1,11 +1,11 @@
-using Semmle.Util;
 using System;
 using System.Collections.Generic;
 using System.IO;
 using System.Linq;
 using System.Text.RegularExpressions;
+using Semmle.Util;
 
-namespace Semmle.BuildAnalyser
+namespace Semmle.Extraction.CSharp.DependencyFetching
 {
 
     // <summary>
@@ -145,22 +145,22 @@ private void DoInitialize()
         [GeneratedRegex("<(.*\\s)?Project.*\\sSdk=\"(.*?)\".*/?>", RegexOptions.IgnoreCase | RegexOptions.Compiled | RegexOptions.Singleline)]
         private static partial Regex ProjectSdk();
     }
-}
 
-internal interface IUnsafeFileReader
-{
-    IEnumerable<string> ReadLines(string file);
-}
+    internal interface IUnsafeFileReader
+    {
+        IEnumerable<string> ReadLines(string file);
+    }
 
-internal class UnsafeFileReader : IUnsafeFileReader
-{
-    public IEnumerable<string> ReadLines(string file)
+    internal class UnsafeFileReader : IUnsafeFileReader
     {
-        using var sr = new StreamReader(file);
-        string? line;
-        while ((line = sr.ReadLine()) != null)
+        public IEnumerable<string> ReadLines(string file)
         {
-            yield return line;
+            using var sr = new StreamReader(file);
+            string? line;
+            while ((line = sr.ReadLine()) != null)
+            {
+                yield return line;
+            }
         }
     }
 }

csharp/extractor/Semmle.Extraction.CSharp.DependencyFetching/NugetPackages.cs

@@ -1,11 +1,11 @@
-using Semmle.Util;
-using System;
+using System;
 using System.Collections.Generic;
 using System.Diagnostics;
 using System.IO;
 using System.Linq;
+using Semmle.Util;
 
-namespace Semmle.BuildAnalyser
+namespace Semmle.Extraction.CSharp.DependencyFetching
 {
     /// <summary>
     /// Manage the downloading of NuGet packages.

csharp/extractor/Semmle.Extraction.CSharp.DependencyFetching/ProgressMonitor.cs

@@ -1,7 +1,7 @@
-using Semmle.Util.Logging;
-using System;
+using System;
+using Semmle.Util.Logging;
 
-namespace Semmle.BuildAnalyser
+namespace Semmle.Extraction.CSharp.DependencyFetching
 {
     internal class ProgressMonitor
     {

csharp/extractor/Semmle.Extraction.CSharp.DependencyFetching/Properties/AssemblyInfo.cs

@@ -1,4 +1,5 @@
 using System.Reflection;
+using System.Runtime.CompilerServices;
 using System.Runtime.InteropServices;
 
 // General Information about an assembly is controlled through the following
@@ -21,6 +22,9 @@
 // The following GUID is for the ID of the typelib if this project is exposed to COM
 [assembly: Guid("8e902d1e-f639-4f9f-a6d2-71e8ade7c5a3")]
 
+// Expose internals for testing purposes.
+[assembly: InternalsVisibleTo("Semmle.Extraction.Tests")]
+
 // Version information for an assembly consists of the following four values:
 //
 //      Major Version