C#: Add sealed modifier to classes to fix dispose-pattern, remove explicit IDisposable implementations

tamasvajk · tamasvajk · commit e73ced2275fa · 2020-10-13T13:27:46.000+02:00
diff --git a/csharp/extractor/Semmle.Extraction.CIL/Context.cs b/csharp/extractor/Semmle.Extraction.CIL/Context.cs
@@ -12,7 +12,7 @@ namespace Semmle.Extraction.CIL
     /// Adds additional context that is specific for CIL extraction.
     /// One context = one DLL/EXE.
     /// </summary>
-    partial class Context : IDisposable
+    sealed partial class Context : IDisposable
     {
         readonly FileStream stream;
         Entities.Assembly? assemblyNull;
@@ -58,7 +58,7 @@ public Context(Extraction.Context cx, string assemblyPath, bool extractPdbs)
             }
         }
 
-        void IDisposable.Dispose()
+        public void Dispose()
         {
             if (pdb != null)
                 pdb.Dispose();
diff --git a/csharp/extractor/Semmle.Extraction.CIL/Factories.cs b/csharp/extractor/Semmle.Extraction.CIL/Factories.cs
@@ -9,7 +9,7 @@ namespace Semmle.Extraction.CIL
     /// <summary>
     /// Provides methods for creating and caching various entities.
     /// </summary>
-    public partial class Context
+    public sealed partial class Context
     {
         readonly Dictionary<object, Label> ids = new Dictionary<object, Label>();
 
diff --git a/csharp/extractor/Semmle.Extraction.CIL/PDB/MetadataPdbReader.cs b/csharp/extractor/Semmle.Extraction.CIL/PDB/MetadataPdbReader.cs
@@ -13,7 +13,7 @@ namespace Semmle.Extraction.PDB
     ///
     /// PDB information can be in a separate PDB file, or embedded in the DLL.
     /// </summary>
-    class MetadataPdbReader : IPdb
+    sealed class MetadataPdbReader : IPdb
     {
         class SourceFile : ISourceFile
         {
diff --git a/csharp/extractor/Semmle.Extraction.CIL/PDB/NativePdbReader.cs b/csharp/extractor/Semmle.Extraction.CIL/PDB/NativePdbReader.cs
@@ -14,7 +14,7 @@ namespace Semmle.Extraction.PDB
     /// A PDB reader using Microsoft.DiaSymReader.Native.
     /// This is an unmanaged Windows DLL, which therefore only works on Windows.
     /// </summary>
-    class NativePdbReader : IPdb
+    sealed class NativePdbReader : IPdb
     {
         sealed class Document : ISourceFile
         {
diff --git a/csharp/extractor/Semmle.Extraction.CSharp.Standalone/BuildAnalysis.cs b/csharp/extractor/Semmle.Extraction.CSharp.Standalone/BuildAnalysis.cs
@@ -46,7 +46,7 @@ interface IBuildAnalysis
     /// <summary>
     /// Main implementation of the build analysis.
     /// </summary>
-    class BuildAnalysis : IBuildAnalysis, IDisposable
+    sealed class BuildAnalysis : IBuildAnalysis, IDisposable
     {
         private readonly AssemblyCache assemblyCache;
         private readonly IProgressMonitor progressMonitor;
diff --git a/csharp/extractor/Semmle.Extraction.CSharp.Standalone/Program.cs b/csharp/extractor/Semmle.Extraction.CSharp.Standalone/Program.cs
@@ -22,7 +22,7 @@ public Extraction(string directory)
     /// <summary>
     ///     Searches for source/references and creates separate extractions.
     /// </summary>
-    class Analysis : IDisposable
+    sealed class Analysis : IDisposable
     {
         public Analysis(ILogger logger, Options options)
         {
diff --git a/csharp/extractor/Semmle.Extraction.CSharp/Analyser.cs b/csharp/extractor/Semmle.Extraction.CSharp/Analyser.cs
@@ -15,7 +15,7 @@ namespace Semmle.Extraction.CSharp
     /// <summary>
     /// Encapsulates a C# analysis task.
     /// </summary>
-    public class Analyser : IDisposable
+    public sealed class Analyser : IDisposable
     {
         IExtractor extractor;
 
diff --git a/csharp/extractor/Semmle.Extraction.Tests/Layout.cs b/csharp/extractor/Semmle.Extraction.Tests/Layout.cs
@@ -199,7 +199,7 @@ public void InvalidLayout()
                 new Semmle.Extraction.Layout(null, null, "layout.txt"));
         }
 
-        class LoggerMock : ILogger
+        sealed class LoggerMock : ILogger
         {
             public void Dispose() { }
 
diff --git a/csharp/extractor/Semmle.Extraction.Tests/TrapWriter.cs b/csharp/extractor/Semmle.Extraction.Tests/TrapWriter.cs
@@ -42,7 +42,7 @@ public void NestedPaths()
             Assert.Equal(@"C:\Temp\source_archive\diskstation\share\source\def.cs", TrapWriter.NestPaths(logger, @"C:\Temp\source_archive", $@"{root3}{root3}diskstation\share\source\def.cs").Replace('/', '\\'));
         }
 
-        class LoggerMock : ILogger
+        sealed class LoggerMock : ILogger
         {
             public void Dispose() { }
 
diff --git a/csharp/extractor/Semmle.Extraction/Context.cs b/csharp/extractor/Semmle.Extraction/Context.cs
@@ -283,7 +283,7 @@ void ExitScope()
 
         public IDisposable StackGuard => new ScopeGuard(this);
 
-        private class ScopeGuard : IDisposable
+        private sealed class ScopeGuard : IDisposable
         {
             readonly Context cx;
 
diff --git a/csharp/extractor/Semmle.Util.Tests/CanonicalPathCache.cs b/csharp/extractor/Semmle.Util.Tests/CanonicalPathCache.cs
@@ -6,7 +6,7 @@
 
 namespace SemmleTests.Semmle.Util
 {
-    public class CanonicalPathCacheTest : IDisposable
+    public sealed class CanonicalPathCacheTest : IDisposable
     {
         readonly ILogger Logger = new LoggerMock();
         readonly string root;
@@ -24,9 +24,10 @@ public CanonicalPathCacheTest()
             root = Win32.IsWindows() ? @"X:\" : "/";
         }
 
-        void IDisposable.Dispose()
+        public void Dispose()
         {
             File.Delete("abc");
+            Logger.Dispose();
         }
 
         [Fact]
@@ -172,7 +173,7 @@ void RunAllTests()
             CanonicalPathDots();
         }
 
-        class LoggerMock : ILogger
+        sealed class LoggerMock : ILogger
         {
             public void Dispose() { }
 
diff --git a/csharp/extractor/Semmle.Util.Tests/LongPaths.cs b/csharp/extractor/Semmle.Util.Tests/LongPaths.cs
@@ -10,20 +10,20 @@ namespace SemmleTests.Semmle.Util
     /// Ensure that the Extractor works with long paths.
     /// These should be handled by .NET Core.
     /// </summary>
-    public class LongPaths : IDisposable
+    public sealed class LongPaths : IDisposable
     {
         static readonly string tmpDir = Path.GetTempPath();
         static readonly string shortPath = Path.Combine(tmpDir, "test.txt");
         static readonly string longPath = Path.Combine(tmpDir, "aaaaaaaaaaaaaaaaaaaaaaaaaaaa", "bbbbbbbbbbbbbbbbbbbbbbbbbbbbb",
             "ccccccccccccccccccccccccccccccc", "ddddddddddddddddddddddddddddddddddddd", "eeeeeeeeeeeeeeeeeeeeeeeeeeeeeee", "fffffffffffffffffffffffffffffffff",
-            "ggggggggggggggggggggggggggggggggggg","hhhhhhhhhhhhhhhhhhhhhhhhhhhhhh","iiiiiiiiiiiiiiii.txt");
+            "ggggggggggggggggggggggggggggggggggg", "hhhhhhhhhhhhhhhhhhhhhhhhhhhhhh", "iiiiiiiiiiiiiiii.txt");
 
         public LongPaths()
         {
             CleanUp();
         }
 
-        void IDisposable.Dispose()
+        public void Dispose()
         {
             CleanUp();
         }
@@ -34,14 +34,14 @@ static void CleanUp()
             {
                 File.Delete(shortPath);
             }
-            catch(DirectoryNotFoundException)
+            catch (DirectoryNotFoundException)
             {
             }
             try
             {
                 File.Delete(longPath);
             }
-            catch(DirectoryNotFoundException)
+            catch (DirectoryNotFoundException)
             {
             }
         }
diff --git a/csharp/extractor/Semmle.Util/Logger.cs b/csharp/extractor/Semmle.Util/Logger.cs
@@ -55,7 +55,7 @@ public static void Log(this ILogger logger, Severity s, string text, params obje
     /// A logger that outputs to a <code>csharp.log</code>
     /// file.
     /// </summary>
-    public class FileLogger : ILogger
+    public sealed class FileLogger : ILogger
     {
         readonly StreamWriter writer;
         readonly Verbosity verbosity;
@@ -100,7 +100,7 @@ public void Log(Severity s, string text)
     /// <summary>
     /// A logger that outputs to stdout/stderr.
     /// </summary>
-    public class ConsoleLogger : ILogger
+    public sealed class ConsoleLogger : ILogger
     {
         readonly Verbosity verbosity;
 
@@ -143,7 +143,7 @@ public void Log(Severity s, string text)
     /// <summary>
     /// A combined logger.
     /// </summary>
-    public class CombinedLogger : ILogger
+    public sealed class CombinedLogger : ILogger
     {
         readonly ILogger logger1;
         readonly ILogger logger2;

Original file line number	Diff line number	Diff line change
`@@ -12,7 +12,7 @@ namespace Semmle.Extraction.CIL`
`12`	`12`	`/// Adds additional context that is specific for CIL extraction.`
`13`	`13`	`/// One context = one DLL/EXE.`
`14`	`14`	`/// </summary>`
`15`		`- partial class Context : IDisposable`
	`15`	`+ sealed partial class Context : IDisposable`
`16`	`16`	`{`
`17`	`17`	`readonly FileStream stream;`
`18`	`18`	`Entities.Assembly? assemblyNull;`
`@@ -58,7 +58,7 @@ public Context(Extraction.Context cx, string assemblyPath, bool extractPdbs)`
`58`	`58`	`}`
`59`	`59`	`}`
`60`	`60`
`61`		`- void IDisposable.Dispose()`
	`61`	`+ public void Dispose()`
`62`	`62`	`{`
`63`	`63`	`if (pdb != null)`
`64`	`64`	`pdb.Dispose();`
Original file line number	Diff line number	Diff line change
`@@ -9,7 +9,7 @@ namespace Semmle.Extraction.CIL`
`9`	`9`	`/// <summary>`
`10`	`10`	`/// Provides methods for creating and caching various entities.`
`11`	`11`	`/// </summary>`
`12`		`- public partial class Context`
	`12`	`+ public sealed partial class Context`
`13`	`13`	`{`
`14`	`14`	`readonly Dictionary<object, Label> ids = new Dictionary<object, Label>();`
`15`	`15`
Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,7 @@ namespace Semmle.Extraction.PDB`
`13`	`13`	`///`
`14`	`14`	`/// PDB information can be in a separate PDB file, or embedded in the DLL.`
`15`	`15`	`/// </summary>`
`16`		`- class MetadataPdbReader : IPdb`
	`16`	`+ sealed class MetadataPdbReader : IPdb`
`17`	`17`	`{`
`18`	`18`	`class SourceFile : ISourceFile`
`19`	`19`	`{`
Original file line number	Diff line number	Diff line change
`@@ -14,7 +14,7 @@ namespace Semmle.Extraction.PDB`
`14`	`14`	`/// A PDB reader using Microsoft.DiaSymReader.Native.`
`15`	`15`	`/// This is an unmanaged Windows DLL, which therefore only works on Windows.`
`16`	`16`	`/// </summary>`
`17`		`- class NativePdbReader : IPdb`
	`17`	`+ sealed class NativePdbReader : IPdb`
`18`	`18`	`{`
`19`	`19`	`sealed class Document : ISourceFile`
`20`	`20`	`{`
Original file line number	Diff line number	Diff line change
`@@ -46,7 +46,7 @@ interface IBuildAnalysis`
`46`	`46`	`/// <summary>`
`47`	`47`	`/// Main implementation of the build analysis.`
`48`	`48`	`/// </summary>`
`49`		`- class BuildAnalysis : IBuildAnalysis, IDisposable`
	`49`	`+ sealed class BuildAnalysis : IBuildAnalysis, IDisposable`
`50`	`50`	`{`
`51`	`51`	`private readonly AssemblyCache assemblyCache;`
`52`	`52`	`private readonly IProgressMonitor progressMonitor;`
Original file line number	Diff line number	Diff line change
`@@ -22,7 +22,7 @@ public Extraction(string directory)`
`22`	`22`	`/// <summary>`
`23`	`23`	`/// Searches for source/references and creates separate extractions.`
`24`	`24`	`/// </summary>`
`25`		`- class Analysis : IDisposable`
	`25`	`+ sealed class Analysis : IDisposable`
`26`	`26`	`{`
`27`	`27`	`public Analysis(ILogger logger, Options options)`
`28`	`28`	`{`
Original file line number	Diff line number	Diff line change
`@@ -15,7 +15,7 @@ namespace Semmle.Extraction.CSharp`
`15`	`15`	`/// <summary>`
`16`	`16`	`/// Encapsulates a C# analysis task.`
`17`	`17`	`/// </summary>`
`18`		`- public class Analyser : IDisposable`
	`18`	`+ public sealed class Analyser : IDisposable`
`19`	`19`	`{`
`20`	`20`	`IExtractor extractor;`
`21`	`21`
Original file line number	Diff line number	Diff line change
`@@ -199,7 +199,7 @@ public void InvalidLayout()`
`199`	`199`	`new Semmle.Extraction.Layout(null, null, "layout.txt"));`
`200`	`200`	`}`
`201`	`201`
`202`		`- class LoggerMock : ILogger`
	`202`	`+ sealed class LoggerMock : ILogger`
`203`	`203`	`{`
`204`	`204`	`public void Dispose() { }`
`205`	`205`
Original file line number	Diff line number	Diff line change
`@@ -42,7 +42,7 @@ public void NestedPaths()`
`42`	`42`	`Assert.Equal(@"C:\Temp\source_archive\diskstation\share\source\def.cs", TrapWriter.NestPaths(logger, @"C:\Temp\source_archive", $@"{root3}{root3}diskstation\share\source\def.cs").Replace('/', '\\'));`
`43`	`43`	`}`
`44`	`44`
`45`		`- class LoggerMock : ILogger`
	`45`	`+ sealed class LoggerMock : ILogger`
`46`	`46`	`{`
`47`	`47`	`public void Dispose() { }`
`48`	`48`
Original file line number	Diff line number	Diff line change
`@@ -283,7 +283,7 @@ void ExitScope()`
`283`	`283`
`284`	`284`	`public IDisposable StackGuard => new ScopeGuard(this);`
`285`	`285`
`286`		`- private class ScopeGuard : IDisposable`
	`286`	`+ private sealed class ScopeGuard : IDisposable`
`287`	`287`	`{`
`288`	`288`	`readonly Context cx;`
`289`	`289`