generalize sonar urls (#600)

* generalize sonar urls

* use sonar rule for testing

Author: clavedeluna

src/core_codemods/sonar/api.py

@@ -7,7 +7,7 @@
 from codemodder.context import CodemodExecutionContext
 from codemodder.result import ResultSet
 from core_codemods.api.core_codemod import CoreCodemod, SASTCodemod
-from core_codemods.sonar.results import SonarResultSet
+from core_codemods.sonar.results import SonarResultSet, sonar_url_from_id
 
 
 class SonarCodemod(SASTCodemod):
@@ -22,9 +22,9 @@ def from_core_codemod(
         other: CoreCodemod,
         rule_id: str,
         rule_name: str,
-        rule_url: str,
         transformer: BaseTransformerPipeline | None = None,
     ):
+        rule_url = sonar_url_from_id(rule_id)
         return SonarCodemod(
             metadata=Metadata(
                 name=name,

src/core_codemods/sonar/results.py

@@ -11,6 +11,17 @@
 from codemodder.result import LineInfo, Location, ResultSet, SASTResult
 
 
+def sonar_url_from_id(rule_id: str) -> str:
+    # convert "python:SXXX" or "pythonsecurity:SXXX" to XXX
+    try:
+        rule_id = rule_id.split(":")[1][1:]
+    except IndexError:
+        logger.debug("Invalid sonar rule id: %s", rule_id)
+        raise
+
+    return f"https://rules.sonarsource.com/python/RSPEC-{rule_id}/"
+
+
 class SonarLocation(Location):
     @classmethod
     def from_json_location(cls, json_location) -> Self:
@@ -48,7 +59,7 @@ def from_result(cls, result: dict) -> Self:
                 rule=Rule(
                     id=rule_id,
                     name=rule_id,
-                    url=None,
+                    url=sonar_url_from_id(rule_id),
                 ),
             ),
         )

src/core_codemods/sonar/sonar_break_or_continue_out_of_loop.py

@@ -6,5 +6,4 @@
     other=BreakOrContinueOutOfLoop,
     rule_id="python:S1716",
     rule_name='"break" and "continue" should not be used outside a loop',
-    rule_url="https://rules.sonarsource.com/python/RSPEC-1716/",
 )

src/core_codemods/sonar/sonar_disable_graphql_introspection.py

@@ -6,5 +6,4 @@
     other=DisableGraphQLIntrospection,
     rule_id="python:S6786",
     rule_name="GraphQL introspection should be disabled in production",
-    rule_url="https://rules.sonarsource.com/python/RSPEC-6786/",
 )

src/core_codemods/sonar/sonar_django_json_response_type.py

@@ -6,5 +6,4 @@
     other=DjangoJsonResponseType,
     rule_id="pythonsecurity:S5131",
     rule_name="Endpoints should not be vulnerable to reflected XSS attacks (Django)",
-    rule_url="https://rules.sonarsource.com/python/type/Bug/RSPEC-5131/",
 )

src/core_codemods/sonar/sonar_django_model_without_dunder_str.py

@@ -6,5 +6,4 @@
     other=DjangoModelWithoutDunderStr,
     rule_id="python:S6554",
     rule_name='Django models should define a "__str__" method',
-    rule_url="https://rules.sonarsource.com/python/RSPEC-6554/",
 )

src/core_codemods/sonar/sonar_django_receiver_on_top.py

@@ -6,5 +6,4 @@
     other=DjangoReceiverOnTop,
     rule_id="python:S6552",
     rule_name="Django signal handler functions should have the `@receiver` decorator on top of all other decorators",
-    rule_url="https://rules.sonarsource.com/python/type/Bug/RSPEC-6552/",
 )

src/core_codemods/sonar/sonar_enable_jinja2_autoescape.py

@@ -6,5 +6,4 @@
     other=EnableJinja2Autoescape,
     rule_id="python:S5247",
     rule_name="Disabling auto-escaping in template engines is security-sensitive",
-    rule_url="https://rules.sonarsource.com/python/RSPEC-5247/",
 )

src/core_codemods/sonar/sonar_exception_without_raise.py

@@ -6,5 +6,4 @@
     other=ExceptionWithoutRaise,
     rule_id="python:S3984",
     rule_name="Exceptions should not be created without being raised",
-    rule_url="https://rules.sonarsource.com/python/type/Bug/RSPEC-3984/",
 )

src/core_codemods/sonar/sonar_fix_assert_tuple.py

@@ -6,5 +6,4 @@
     other=FixAssertTuple,
     rule_id="python:S5905",
     rule_name="Assert should not be called on a tuple literal",
-    rule_url="https://rules.sonarsource.com/python/type/Bug/RSPEC-5905/",
 )