NET-682 Modify S7133: Add vbnet rspec (#4514)

rules/S7133/csharp/metadata.json

@@ -1,23 +1,2 @@
 {
-  "title": "Locks should be released within the same method",
-  "type": "BUG",
-  "status": "ready",
-  "remediation": {
-    "func": "Constant\/Issue",
-    "constantCost": "5min"
-  },
-  "tags": [
-  ],
-  "defaultSeverity": "Major",
-  "ruleSpecification": "RSPEC-7133",
-  "sqKey": "S7133",
-  "scope": "All",
-  "defaultQualityProfiles": ["Sonar way"],
-  "quickfix": "targeted",
-  "code": {
-    "impacts": {
-      "RELIABILITY": "HIGH"
-    },
-    "attribute": "CONVENTIONAL"
-  }
 }

rules/S7133/csharp/rule.adoc

@@ -1,24 +1,4 @@
-This rule raises if you acquire a lock with one of the following methods, and do not release it within the same method.
-
-* https://learn.microsoft.com/en-us/dotnet/api/system.threading.readerwriterlock.acquirereaderlock[ReaderWriterLock.AcquireReaderLock]
-* https://learn.microsoft.com/en-us/dotnet/api/system.threading.readerwriterlock.acquirewriterlock[ReaderWriterLock.AcquireWriterLock]
-* https://learn.microsoft.com/en-us/dotnet/api/system.threading.readerwriterlockslim.enterreadlock[ReaderWriterLockSlim.EnterReadLock]
-* https://learn.microsoft.com/en-us/dotnet/api/system.threading.readerwriterlockslim.enterupgradeablereadlock[ReaderWriterLockSlim.EnterUpgradeableReadLock]
-* https://learn.microsoft.com/en-us/dotnet/api/system.threading.readerwriterlockslim.tryenterreadlock[ReaderWriterLockSlim.TryEnterReadLock]
-* https://learn.microsoft.com/en-us/dotnet/api/system.threading.readerwriterlockslim.tryenterupgradeablereadlock[ReaderWriterLockSlim.TryEnterUpgradeableReadLock]
-* https://learn.microsoft.com/en-us/dotnet/api/system.threading.readerwriterlockslim.enterwritelock[ReaderWriterLockSlim.EnterWriteLock]
-* https://learn.microsoft.com/en-us/dotnet/api/system.threading.readerwriterlockslim.tryenterwritelock[ReaderWriterLockSlim.TryEnterWriteLock]
-* https://learn.microsoft.com/en-us/dotnet/api/system.threading.spinlock.enter[SpinLock.Enter]
-* https://learn.microsoft.com/en-us/dotnet/api/system.threading.spinlock.tryenter[SpinLock.TryEnter]
-* https://learn.microsoft.com/en-us/dotnet/api/system.threading.monitor.enter[Monitor.Enter]
-* https://learn.microsoft.com/en-us/dotnet/api/system.threading.monitor.tryenter[Monitor.TryEnter]
-
-
-
-== Why is this an issue?
-
-Not releasing a lock in the same method where you acquire it, and releasing in another one, makes the code less clear and harder to maintain. You are also introducing the risk of not releasing a lock at all which can lead to deadlocks or exceptions.
-
+include::../description-dotnet.adoc[]
 
 === Code examples
 
@@ -31,14 +11,14 @@ public class Example
     private static ReaderWriterLock rwLock = new();
 
     public void AcquireWriterLock() =>
-        rwLock.AcquireWriterLock(2000);  // Noncompliant, as the lock release is on the callers responsibilty
+        rwLock.AcquireWriterLock(2000);  // Noncompliant, as the lock release is on the callers responsibility
 
-    public void DoSomething() 
+    public void DoSomething()
     {
         // ...
     }
 
-    public void ReleaseWriterLock() => 
+    public void ReleaseWriterLock() =>
         rwLock.ReleaseWriterLock();
 }
 ----
@@ -58,21 +38,14 @@ public class Example
         {
             // ...
         }
-        finally 
+        finally
         {
             rwLock.ReleaseWriterLock();
         }
     }
 }
 ----
 
-== Resources
-
-=== Documentation
-
-* Microsoft Learn - https://learn.microsoft.com/en-us/dotnet/api/system.threading.readerwriterlock[ReaderWriterLock Class]
-* Microsoft Learn - https://learn.microsoft.com/en-us/dotnet/api/system.threading.readerwriterlockslim[ReaderWriterLockSlim Classs]
-* Microsoft Learn - https://learn.microsoft.com/en-us/dotnet/api/system.threading.spinlock[SpinLock Struct]
-* Microsoft Learn - https://learn.microsoft.com/en-us/dotnet/api/system.threading.monitor[Monitor Classs]
+include::../resources-dotnet.adoc[]
 
 include::../rspecator.adoc[]

rules/S7133/description-dotnet.adoc

@@ -0,0 +1,20 @@
+This rule raises if you acquire a lock with one of the following methods, and do not release it within the same method.
+
+* https://learn.microsoft.com/en-us/dotnet/api/system.threading.readerwriterlock.acquirereaderlock[ReaderWriterLock.AcquireReaderLock]
+* https://learn.microsoft.com/en-us/dotnet/api/system.threading.readerwriterlock.acquirewriterlock[ReaderWriterLock.AcquireWriterLock]
+* https://learn.microsoft.com/en-us/dotnet/api/system.threading.readerwriterlockslim.enterreadlock[ReaderWriterLockSlim.EnterReadLock]
+* https://learn.microsoft.com/en-us/dotnet/api/system.threading.readerwriterlockslim.enterupgradeablereadlock[ReaderWriterLockSlim.EnterUpgradeableReadLock]
+* https://learn.microsoft.com/en-us/dotnet/api/system.threading.readerwriterlockslim.tryenterreadlock[ReaderWriterLockSlim.TryEnterReadLock]
+* https://learn.microsoft.com/en-us/dotnet/api/system.threading.readerwriterlockslim.tryenterupgradeablereadlock[ReaderWriterLockSlim.TryEnterUpgradeableReadLock]
+* https://learn.microsoft.com/en-us/dotnet/api/system.threading.readerwriterlockslim.enterwritelock[ReaderWriterLockSlim.EnterWriteLock]
+* https://learn.microsoft.com/en-us/dotnet/api/system.threading.readerwriterlockslim.tryenterwritelock[ReaderWriterLockSlim.TryEnterWriteLock]
+* https://learn.microsoft.com/en-us/dotnet/api/system.threading.spinlock.enter[SpinLock.Enter]
+* https://learn.microsoft.com/en-us/dotnet/api/system.threading.spinlock.tryenter[SpinLock.TryEnter]
+* https://learn.microsoft.com/en-us/dotnet/api/system.threading.monitor.enter[Monitor.Enter]
+* https://learn.microsoft.com/en-us/dotnet/api/system.threading.monitor.tryenter[Monitor.TryEnter]
+
+
+
+== Why is this an issue?
+
+Not releasing a lock in the same method where you acquire it, and releasing in another one, makes the code less clear and harder to maintain. You are also introducing the risk of not releasing a lock at all which can lead to deadlocks or exceptions.

rules/S7133/metadata.json

@@ -1,2 +1,23 @@
 {
+  "title": "Locks should be released within the same method",
+  "type": "BUG",
+  "status": "ready",
+  "remediation": {
+    "func": "Constant\/Issue",
+    "constantCost": "5min"
+  },
+  "tags": [
+  ],
+  "defaultSeverity": "Major",
+  "ruleSpecification": "RSPEC-7133",
+  "sqKey": "S7133",
+  "scope": "All",
+  "defaultQualityProfiles": [ "Sonar way" ],
+  "quickfix": "targeted",
+  "code": {
+    "impacts": {
+      "RELIABILITY": "HIGH"
+    },
+    "attribute": "CONVENTIONAL"
+  }
 }

rules/S7133/resources-dotnet.adoc

@@ -0,0 +1,8 @@
+== Resources
+
+=== Documentation
+
+* Microsoft Learn - https://learn.microsoft.com/en-us/dotnet/api/system.threading.readerwriterlock[ReaderWriterLock Class]
+* Microsoft Learn - https://learn.microsoft.com/en-us/dotnet/api/system.threading.readerwriterlockslim[ReaderWriterLockSlim Classs]
+* Microsoft Learn - https://learn.microsoft.com/en-us/dotnet/api/system.threading.spinlock[SpinLock Struct]
+* Microsoft Learn - https://learn.microsoft.com/en-us/dotnet/api/system.threading.monitor[Monitor Classs]

rules/S7133/vbnet/metadata.json

@@ -0,0 +1,2 @@
+{
+}

rules/S7133/vbnet/rule.adoc

@@ -0,0 +1,50 @@
+include::../description-dotnet.adoc[]
+
+=== Code examples
+
+==== Noncompliant code example
+
+[source,vbnet,diff-id=1,diff-type=noncompliant]
+----
+Public Class Example
+
+    Private Shared rwLock As New ReaderWriterLock
+
+    Public Sub AcquireWriterLock()
+        rwLock.AcquireWriterLock(2000)  ' Noncompliant, as the lock release is on the callers responsibility
+    End Sub
+
+    Public Sub DoSomething()
+        ' ...
+    End Sub
+
+    Public Sub ReleaseWriterLock()
+        rwLock.ReleaseWriterLock()
+    End Sub
+
+End Class
+----
+
+==== Compliant solution
+
+[source,vbnet,diff-id=1,diff-type=compliant]
+----
+Public Class Example
+
+    Private Shared rwLock As New ReaderWriterLock
+
+    Public Sub DoSomething()
+        rwLock.AcquireWriterLock(2000)  ' Compliant, locks are released in the same method
+        Try
+            ' ...
+        Finally
+            rwLock.ReleaseWriterLock()
+        End Try
+    End Sub
+
+End Class
+----
+
+include::../resources-dotnet.adoc[]
+
+include::../rspecator.adoc[]