Use existing rule S935 instead of S6658 for SpecialMethodReturnTypeCheck (#1528)

Author: anton-haubner-sonarsource

its/ruling/src/test/java/org/sonar/python/it/RulingHelper.java

@@ -92,6 +92,7 @@ static void loadProfile(Orchestrator orchestrator, String profile) throws IOExce
   static List<String> bugRuleKeys() {
     return Arrays.asList(
       "PreIncrementDecrement",
+      "S935",
       "S1045",
       "S1143",
       "S1226",
@@ -144,7 +145,6 @@ static List<String> bugRuleKeys() {
       "S6323",
       "S6328",
       "S6468",
-      "S6658",
       "S6662",
       "S905",
       "S930");

its/ruling/src/test/resources/expected/python-S6658.json renamed to its/ruling/src/test/resources/expected/python-S935.json

@@ -35,7 +35,7 @@
 import org.sonar.python.tree.TreeUtils;
 import org.sonar.python.tree.TupleImpl;
 
-@Rule(key = "S6658")
+@Rule(key = "S935")
 public class SpecialMethodReturnTypeCheck extends PythonSubscriptionCheck {
   /**
    * Stores the return types expected for specific method names as specified here:

its/ruling/src/test/resources/expected_extended/calibre/python-S6658.json renamed to its/ruling/src/test/resources/expected_extended/calibre/python-S935.json

@@ -6,7 +6,7 @@ <h2>Why is this an issue?</h2>
 object.</p>
 <p>The Python interpreter will call these methods when performing the operation they’re associated with. Each special method expects a specific return
 type. Calls to a special method will throw a <code>TypeError</code> if its return type is incorrect.</p>
-<p>An issue will be raised when one of the following method doesn’t return the indicated type:</p>
+<p>An issue will be raised when one of the following methods doesn’t return the indicated type:</p>
 <ul>
   <li> <code>__bool__</code> method should return bool </li>
   <li> <code>__index__</code> method should return integer </li>
@@ -42,6 +42,9 @@ <h4>Compliant solution</h4>
 <h2>Resources</h2>
 <h3>Documentation</h3>
 <ul>
-  <li> Python Documentation - <a href="https://docs.python.org/3/reference/datamodel.html#special-method-names">Special method names</a> </li>
+  <li> Python Data Model Documentation - <a href="https://docs.python.org/3/reference/datamodel.html#special-method-names">Special method names</a>
+  </li>
+  <li> Python Object Serialization Documentation - <a href="https://docs.python.org/3/library/pickle.html#pickling-class-instances">Pickling Class
+  Instances</a> </li>
 </ul>
 

python-checks/src/main/java/org/sonar/python/checks/SpecialMethodReturnTypeCheck.java

@@ -1,5 +1,5 @@
 {
-  "title": "Special methods should have an expected return type",
+  "title": "Functions and methods should only return expected values",
   "type": "BUG",
   "status": "ready",
   "remediation": {
@@ -8,8 +8,13 @@
   },
   "tags": [],
   "defaultSeverity": "Blocker",
-  "ruleSpecification": "RSPEC-S6658",
-  "sqKey": "S6658",
+  "ruleSpecification": "RSPEC-S935",
+  "sqKey": "S935",
   "scope": "All",
+  "securityStandards": {
+    "CWE": [
+      394
+    ]
+  },
   "quickfix": "unknown"
 }

python-checks/src/main/resources/org/sonar/l10n/py/rules/python/S6658.html renamed to python-checks/src/main/resources/org/sonar/l10n/py/rules/python/S935.html

@@ -16,6 +16,7 @@
     "S125",
     "S905",
     "S930",
+    "S935",
     "S1045",
     "S1066",
     "S1110",
@@ -198,7 +199,6 @@
     "S6556",
     "S6559",
     "S6560",
-    "S6658",
     "S6659",
     "S6660",
     "S6662",