C#: General code tidy.

Author: calumgrant

csharp/extractor/Semmle.Extraction.CSharp.Standalone/BuildAnalysis.cs

@@ -2,11 +2,8 @@
 using System.Collections.Generic;
 using System.IO;
 using System.Linq;
-using System.Runtime.InteropServices;
-using Semmle.Util;
 using Semmle.Extraction.CSharp.Standalone;
 using System.Threading.Tasks;
-using System.Collections.Concurrent;
 
 namespace Semmle.BuildAnalyser
 {
@@ -47,18 +44,18 @@ interface IBuildAnalysis
     /// </summary>
     class BuildAnalysis : IBuildAnalysis
     {
-        readonly AssemblyCache assemblyCache;
-        readonly NugetPackages nuget;
-        readonly IProgressMonitor progressMonitor;
-        HashSet<string> usedReferences = new HashSet<string>();
-        readonly HashSet<string> usedSources = new HashSet<string>();
-        readonly HashSet<string> missingSources = new HashSet<string>();
-        readonly Dictionary<string, string> unresolvedReferences = new Dictionary<string, string>();
-        readonly DirectoryInfo sourceDir;
-        int failedProjects, succeededProjects;
-        readonly string[] allSources;
-        int conflictedReferences = 0;
-        object mutex = new object();
+        private readonly AssemblyCache assemblyCache;
+        private readonly NugetPackages nuget;
+        private readonly IProgressMonitor progressMonitor;
+        private HashSet<string> usedReferences = new HashSet<string>();
+        private readonly HashSet<string> usedSources = new HashSet<string>();
+        private readonly HashSet<string> missingSources = new HashSet<string>();
+        private readonly Dictionary<string, string> unresolvedReferences = new Dictionary<string, string>();
+        private readonly DirectoryInfo sourceDir;
+        private int failedProjects, succeededProjects;
+        private readonly string[] allSources;
+        private int conflictedReferences = 0;
+        private readonly object mutex = new object();
 
         /// <summary>
         /// Performs a C# build analysis.
@@ -80,7 +77,7 @@ public BuildAnalysis(Options options, IProgressMonitor progress)
                 ToArray();
 
             var dllDirNames = options.DllDirs.Select(Path.GetFullPath).ToList();
-            PackageDirectory = TemporaryDirectory.CreateTempDirectory(sourceDir.FullName, progressMonitor);
+            PackageDirectory = TemporaryDirectory.CreateTempDirectory(sourceDir.FullName);
 
             if (options.UseNuGet)
             {
@@ -102,6 +99,7 @@ public BuildAnalysis(Options options, IProgressMonitor progress)
             }
 
             {
+                // These files can sometimes prevent `dotnet restore` from working correctly.
                 using var renamer1 = new FileRenamer(sourceDir.GetFiles("global.json", SearchOption.AllDirectories));
                 using var renamer2 = new FileRenamer(sourceDir.GetFiles("Directory.Build.props", SearchOption.AllDirectories));
 
@@ -118,12 +116,6 @@ public BuildAnalysis(Options options, IProgressMonitor progress)
                 usedReferences = new HashSet<string>(assemblyCache.AllAssemblies.Select(a => a.Filename));
             }
 
-            if (!options.AnalyseCsProjFiles)
-            {
-                usedReferences = new HashSet<string>(assemblyCache.AllAssemblies.Select(a => a.Filename));
-            }
-
-
             ResolveConflicts();
 
             if (options.UseMscorlib)
@@ -150,9 +142,8 @@ public BuildAnalysis(Options options, IProgressMonitor progress)
                 UnresolvedReferences.Count(),
                 conflictedReferences,
                 succeededProjects + failedProjects,
-                failedProjects);
-
-            Console.WriteLine($"Build analysis completed in {DateTime.Now - startTime}");
+                failedProjects,
+                DateTime.Now - startTime);
         }
 
         /// <summary>
@@ -285,7 +276,7 @@ void AnalyseProject(FileInfo project)
 
             try
             {
-                var csProj = new CsProjFile(project);
+                IProjectFile csProj = new CsProjFile(project);
 
                 foreach (var @ref in csProj.References)
                 {
@@ -329,8 +320,16 @@ public void Cleanup()
         void Restore(string projectOrSolution)
         {
             int exit = DotNet.RestoreToDirectory(projectOrSolution, PackageDirectory.DirInfo.FullName);
-            if (exit != 0)
-                progressMonitor.CommandFailed("dotnet", $"restore \"{projectOrSolution}\"", exit);
+            switch(exit)
+            {
+                case 0:
+                case 1:
+                    // No errors
+                    break;
+                default:
+                    progressMonitor.CommandFailed("dotnet", $"restore \"{projectOrSolution}\"", exit);
+                    break;
+            }
         }
 
         public void RestoreSolutions(IEnumerable<string> solutions)

csharp/extractor/Semmle.Extraction.CSharp.Standalone/CsProjFile.cs

@@ -5,84 +5,17 @@
 
 namespace Semmle.BuildAnalyser
 {
-    /// <summary>
-    /// A reference to a particular version of a particular package.
-    /// </summary>
-    class PackageReference
-    {
-        public PackageReference(string include, string version) { 
-            Include = include;
-            Version = version;
-        }
-        public string Include, Version;
-
-        public override string ToString() => $"Include={Include}, Version={Version}";
-    }
-
-    enum ProjectFileType
-    {
-        MsBuildProject,
-        DotNetProject,
-        OtherProject
-    }
-
     interface IProjectFile
     {
-        IEnumerable<IProjectFile> ProjectReferences { get; }
-
-        IEnumerable<PackageReference> Packages { get; }
-
         IEnumerable<string> References { get; }
 
-        IEnumerable<FileInfo> Sources { get; }
-
-        IEnumerable<string> TargetFrameworks { get; }
-    }
-
-    class NetCoreProjectFile : IProjectFile
-    {
-        FileInfo path;
-        XmlDocument doc;
-        XmlElement root;
-
-        public NetCoreProjectFile(FileInfo path)
-        {
-            this.path = path;
-            doc = new XmlDocument();
-            doc.Load(path.FullName);
-            root = doc.DocumentElement;
-        }
-
-        public IEnumerable<IProjectFile> ProjectReferences => throw new System.NotImplementedException();
-
-        public IEnumerable<PackageReference> Packages
-        {
-            get
-            {
-                var packages = root.SelectNodes("/Project/ItemGroup/PackageReference");
-                return packages.NodeList().
-                    Select(r =>
-                    new PackageReference(r.Attributes.GetNamedItem("Include").Value, r.Attributes.GetNamedItem("Version").Value));
-            }
-        }
-
-        public IEnumerable<string> References => throw new System.NotImplementedException();
-
-        public IEnumerable<FileInfo> Sources
-        {
-            get
-            {
-                return path.Directory.GetFiles("*.cs", SearchOption.AllDirectories);
-            }
-        }
-
-        public IEnumerable<string> TargetFrameworks => throw new System.NotImplementedException();
+        IEnumerable<string> Sources { get; }
     }
 
     /// <summary>
     /// Represents a .csproj file and reads information from it.
     /// </summary>
-    class CsProjFile
+    class CsProjFile : IProjectFile
     {
         public string Filename { get; }
 
@@ -136,8 +69,6 @@ public void ReadMsBuildProject(FileInfo filename)
                 .ToArray();
         }
 
-        string[] targetFrameworks = new string[0];
-
         /// <summary>
         /// Reads the .csproj file directly as XML.
         /// This doesn't handle variables etc, and should only used as a
@@ -162,8 +93,6 @@ public void ReadProjectFileAsXml(FileInfo filename)
                 var frameworksNode = root.SelectNodes("/Project/PropertyGroup/TargetFrameworks").NodeList().Concat(
                     root.SelectNodes("/Project/PropertyGroup/TargetFramework").NodeList()).Select(node => node.InnerText);
 
-                targetFrameworks = frameworksNode.SelectMany(node => node.Split(";")).ToArray();
-
                 var relativeCsIncludes2 =
                     root.SelectNodes("/Project/ItemGroup/Compile/@Include", mgr).
                     NodeList().
@@ -208,8 +137,6 @@ public void ReadProjectFileAsXml(FileInfo filename)
         /// </summary>
         public IEnumerable<string> References => references;
 
-        public IEnumerable<string> TargetFrameworks => targetFrameworks;
-
         /// <summary>
         /// The list of C# source files in full path format.
         /// </summary>

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

@@ -22,7 +22,7 @@ public static int RestoreToDirectory(string projectOrSolutionFile, string packag
     /// <summary>
     /// Utility to temporarily rename a set of files.
     /// </summary>
-    class FileRenamer : IDisposable
+    sealed class FileRenamer : IDisposable
     {
         string[] files;
         const string suffix = ".codeqlhidden";