Enable CA1816: Dispose methods should call SuppressFinalize (#14074)

xtqqczze · web-flow · commit 358db744799d · 2020-11-24T09:29:15.000+05:00
https://docs.microsoft.com/dotnet/fundamentals/code-analysis/quality-rules/ca1816
diff --git a/.globalconfig b/.globalconfig
@@ -268,7 +268,7 @@ dotnet_diagnostic.CA1814.severity = none
 dotnet_diagnostic.CA1815.severity = none
 
 # CA1816: Dispose methods should call SuppressFinalize
-dotnet_diagnostic.CA1816.severity = suggestion
+dotnet_diagnostic.CA1816.severity = warning
 
 # CA1819: Properties should not return arrays
 dotnet_diagnostic.CA1819.severity = none
diff --git a/src/Microsoft.PowerShell.Commands.Management/commands/management/ComputerUnix.cs b/src/Microsoft.PowerShell.Commands.Management/commands/management/ComputerUnix.cs
@@ -101,11 +101,28 @@ public class CommandLineCmdletBase : PSCmdlet, IDisposable
 #region "IDisposable Members"
 
         /// <summary>
-        /// Dispose Method.
+        /// Releases all resources used by the <see cref="CommandLineCmdletBase"/>.
         /// </summary>
         public void Dispose()
         {
-            _process?.Dispose();
+            Dispose(true);
+            GC.SuppressFinalize(this);
+        }
+
+        /// <summary>
+        /// Releases the unmanaged resources used by the <see cref="CommandLineCmdletBase"/>
+        /// and optionally releases the managed resources.
+        /// </summary>
+        /// <param name="disposing">
+        /// <see langword="true"/> to release both managed and unmanaged resources;
+        /// <see langword="false"/> to release only unmanaged resources.
+        /// </param>
+        protected virtual void Dispose(bool disposing)
+        {
+            if (disposing)
+            {
+                _process?.Dispose();
+            }
         }
 
 #endregion "IDisposable Members"
diff --git a/test/xUnit/csharp/test_FileSystemProvider.cs b/test/xUnit/csharp/test_FileSystemProvider.cs
@@ -39,9 +39,18 @@ public FileSystemProviderTests()
             File.AppendAllText(testPath, testContent);
         }
 
-        void IDisposable.Dispose()
+        public void Dispose()
         {
-            File.Delete(testPath);
+            Dispose(true);
+            GC.SuppressFinalize(this);
+        }        
+
+        protected virtual void Dispose(bool disposing)
+        {
+            if (disposing)
+            {
+                File.Delete(testPath);
+            }
         }
 
         private ExecutionContext GetExecutionContext()
diff --git a/test/xUnit/csharp/test_PSConfiguration.cs b/test/xUnit/csharp/test_PSConfiguration.cs
@@ -97,18 +97,27 @@ public PowerShellPolicyFixture()
 
         public void Dispose()
         {
-            CleanupConfigFiles();
-            if (systemWideConfigBackupFile != null)
-            {
-                File.Move(systemWideConfigBackupFile, systemWideConfigFile);
-            }
+            Dispose(true);
+            GC.SuppressFinalize(this);
+        }        
 
-            if (currentUserConfigBackupFile != null)
+        protected virtual void Dispose(bool disposing)
+        {
+            if (disposing)
             {
-                File.Move(currentUserConfigBackupFile, currentUserConfigFile);
-            }
+                CleanupConfigFiles();
+                if (systemWideConfigBackupFile != null)
+                {
+                    File.Move(systemWideConfigBackupFile, systemWideConfigFile);
+                }
 
-            InternalTestHooks.BypassGroupPolicyCaching = originalTestHookValue;
+                if (currentUserConfigBackupFile != null)
+                {
+                    File.Move(currentUserConfigBackupFile, currentUserConfigFile);
+                }
+
+                InternalTestHooks.BypassGroupPolicyCaching = originalTestHookValue;
+            }
         }
 
         internal PowerShellPolicies SystemWidePolicies

Original file line number	Diff line number	Diff line change
`@@ -39,9 +39,18 @@ public FileSystemProviderTests()`
`39`	`39`	`File.AppendAllText(testPath, testContent);`
`40`	`40`	`}`
`41`	`41`
`42`		`- void IDisposable.Dispose()`
	`42`	`+ public void Dispose()`
`43`	`43`	`{`
`44`		`- File.Delete(testPath);`
	`44`	`+ Dispose(true);`
	`45`	`+ GC.SuppressFinalize(this);`
	`46`	`+ }`
	`47`	`+`
	`48`	`+ protected virtual void Dispose(bool disposing)`
	`49`	`+ {`
	`50`	`+ if (disposing)`
	`51`	`+ {`
	`52`	`+ File.Delete(testPath);`
	`53`	`+ }`
`45`	`54`	`}`
`46`	`55`
`47`	`56`	`private ExecutionContext GetExecutionContext()`