Ruff: Preparation for G004 (#13076)

Author: manuel-sommer

dojo/api_v2/serializers.py

@@ -219,7 +219,7 @@ def to_internal_value(self, data):
             except ValueError:
                 self.fail("invalid_json")
 
-        logger.debug(f"data as json: {data}")
+        logger.debug("data as json: %s", data)
 
         if not isinstance(data, list):
             self.fail("not_a_list", input_type=type(data).__name__)
@@ -238,7 +238,7 @@ def to_internal_value(self, data):
                 tag_validator(sub, exception_class=RestFrameworkValidationError)
             data_safe.extend(substrings)
 
-        logger.debug(f"result after rendering tags: {data_safe}")
+        logger.debug("result after rendering tags: %s", data_safe)
         return data_safe
 
     def to_representation(self, value):
@@ -1863,7 +1863,7 @@ class Meta:
 
     # Overriding this to push add Push to JIRA functionality
     def create(self, validated_data):
-        logger.debug(f"Creating finding with validated data: {validated_data}")
+        logger.debug("Creating finding with validated data: %s", validated_data)
         push_to_jira = validated_data.pop("push_to_jira", False)
         notes = validated_data.pop("notes", None)
         found_by = validated_data.pop("found_by", None)

dojo/api_v2/views.py

@@ -2648,7 +2648,7 @@ def perform_create(self, serializer):
             jira_driver = test or (engagement or (product or None))
             if jira_project := (jira_helper.get_jira_project(jira_driver) if jira_driver else None):
                 push_to_jira = push_to_jira or jira_project.push_all_issues
-        logger.debug(f"push_to_jira: {push_to_jira}")
+        logger.debug("push_to_jira: %s", push_to_jira)
         serializer.save(push_to_jira=push_to_jira)
 
 

dojo/finding/views.py

@@ -486,7 +486,7 @@ def get_request_response(self, finding: Finding):
                 burp_request = base64.b64decode(request_response.burpRequestBase64)
                 burp_response = base64.b64decode(request_response.burpResponseBase64)
         except Exception as e:
-            logger.debug(f"unsuspected error: {e}")
+            logger.debug("unsuspected error: %s", e)
 
         return {
             "burp_request": burp_request,
@@ -1597,7 +1597,7 @@ def request_finding_review(request, fid):
             reviewers = Dojo_User.objects.filter(id__in=form.cleaned_data["reviewers"])
             reviewers_string = ", ".join([f"{user} ({user.id})" for user in reviewers])
             reviewers_usernames = [user.username for user in reviewers]
-            logger.debug(f"Asking {reviewers_string} for review")
+            logger.debug("Asking %s for review", reviewers_string)
 
             create_notification(
                 event="review_requested",  # TODO: - if 'review_requested' functionality will be supported by API as well, 'create_notification' needs to be migrated to place where it will be able to cover actions from both interfaces

dojo/importers/endpoint_manager.py

@@ -111,7 +111,7 @@ def clean_unsaved_endpoints(
             try:
                 endpoint.clean()
             except ValidationError as e:
-                logger.warning(f"DefectDojo is storing broken endpoint because cleaning wasn't successful: {e}")
+                logger.warning("DefectDojo is storing broken endpoint because cleaning wasn't successful: %s", e)
 
     def chunk_endpoints_and_reactivate(
         self,

dojo/jira_link/helper.py

@@ -204,7 +204,7 @@ def can_be_pushed_to_jira(obj, form=None):
             return False, f"Finding below the minimum JIRA severity threshold ({System_Settings.objects.get().jira_minimum_severity}).", "error_below_minimum_threshold"
     elif isinstance(obj, Finding_Group):
         finding_group_status = _safely_get_obj_status_for_jira(obj)
-        logger.error(f"Finding group status: {finding_group_status}")
+        logger.error("Finding group status: %s", finding_group_status)
         if "Empty" in finding_group_status:
             return False, f"{to_str_typed(obj)} cannot be pushed to jira as it contains no findings above minimum treshold.", "error_empty"
 

dojo/management/commands/import_all_unittest_scans.py

@@ -120,7 +120,7 @@ def import_scan_with_params(self, filename, scan_type="ZAP Scan", engagement=1,
             return self.import_scan(payload, expected_http_status_code)
 
     def import_all_unittest_scans(self, product_name_prefix=None, tests_per_engagement=10, engagements_per_product=50, products_per_product_type=15, *, include_very_big_scans=False, **kwargs):
-        logger.info(f"product_name_prefix: {product_name_prefix}, tests_per_engagement: {tests_per_engagement}, engagements_per_product: {engagements_per_product}, products_per_product_type: {products_per_product_type}")
+        logger.info("product_name_prefix: %s, tests_per_engagement: %s, engagements_per_product: %s, products_per_product_type: %s", product_name_prefix, tests_per_engagement, engagements_per_product, products_per_product_type)
         product_type_prefix = "Sample scans " + datetime.now().strftime("%Y-%m-%d %H:%M:%S")
         product_type_index = 1
 
@@ -159,7 +159,7 @@ def import_all_unittest_scans(self, product_name_prefix=None, tests_per_engageme
                         for attribute_name in dir(module):
                             attribute = getattr(module, attribute_name)
                             if isclass(attribute) and attribute_name.lower() == module_name.replace("_", "") + "parser":
-                                logger.debug(f"Loading {module_name} parser")
+                                logger.debug("Loading %s parser", module_name)
                                 scan_dir = Path("unittests") / "scans" / module_name
                                 for scan_file in scan_dir.glob("*.json"):
                                     if include_very_big_scans or scan_file.name != "very_many_vulns.json":  # jfrog_xray file is huge and takes too long to import
@@ -183,12 +183,12 @@ def import_all_unittest_scans(self, product_name_prefix=None, tests_per_engageme
                                             error_messages[module_name + "/" + scan_file.name] = result.get("message", str(e))
 
                 except:
-                    logger.exception(f"failed to load {module_name}")
+                    logger.exception("failed to load %s", module_name)
                     raise
 
-        logger.error(f"Error count: {error_count}")
+        logger.error("Error count: %s", error_count)
         for scan, message in error_messages.items():
-            logger.error(f"Error importing scan {scan}: {message}")
+            logger.error("Error importing scan %s: %s", scan, message)
 
     def handle(self, *args, **options):
         logger.info("EXPERIMENTAL: This command may be changed/deprecated/removed without prior notice.")

dojo/management/commands/import_github_languages.py

@@ -43,7 +43,7 @@ def handle(self, *args, **options):
                 try:
                     language_type, created = Language_Type.objects.get_or_create(language=name)
                 except Language_Type.MultipleObjectsReturned:
-                    logger.warning(f"Language_Type {name} exists multiple times")
+                    logger.warning("Language_Type %s exists multiple times", name)
                     continue
 
                 if created:
@@ -52,4 +52,4 @@ def handle(self, *args, **options):
                 language_type.color = element.get("color", 0)
                 language_type.save()
 
-        logger.info(f"Finished importing languages from GitHub, added {new_language_types} Language_Types")
+        logger.info("Finished importing languages from GitHub, added %s Language_Types", new_language_types)

dojo/models.py

@@ -1866,7 +1866,7 @@ def clean(self):
                     action_string = "Postgres does not accept NULL character. Attempting to replace with %00..."
                     for remove_str in null_char_list:
                         self.path = self.path.replace(remove_str, "%00")
-                    logger.error(f'Path "{old_value}" has invalid format - It contains the NULL character. The following action was taken: {action_string}')
+                    logger.error('Path "%s" has invalid format - It contains the NULL character. The following action was taken: %s', old_value, action_string)
             if self.path == "":
                 self.path = None
 
@@ -1879,7 +1879,7 @@ def clean(self):
                     action_string = "Postgres does not accept NULL character. Attempting to replace with %00..."
                     for remove_str in null_char_list:
                         self.query = self.query.replace(remove_str, "%00")
-                    logger.error(f'Query "{old_value}" has invalid format - It contains the NULL character. The following action was taken: {action_string}')
+                    logger.error('Query "%s" has invalid format - It contains the NULL character. The following action was taken: %s', old_value, action_string)
             if self.query == "":
                 self.query = None
 
@@ -1892,7 +1892,7 @@ def clean(self):
                     action_string = "Postgres does not accept NULL character. Attempting to replace with %00..."
                     for remove_str in null_char_list:
                         self.fragment = self.fragment.replace(remove_str, "%00")
-                    logger.error(f'Fragment "{old_value}" has invalid format - It contains the NULL character. The following action was taken: {action_string}')
+                    logger.error('Fragment "%s" has invalid format - It contains the NULL character. The following action was taken: %s', old_value, action_string)
             if self.fragment == "":
                 self.fragment = None
 

dojo/notifications/helper.py

@@ -234,7 +234,7 @@ def send_slack_notification(
             elif self.system_settings.slack_channel is not None:
                 channel = self.system_settings.slack_channel
                 logger.info(
-                    f"Sending system notification to system channel {channel}.",
+                    "Sending system notification to system channel %s.", channel,
                 )
                 self._post_slack_message(event, user, channel, **kwargs)
             else:
@@ -272,11 +272,11 @@ def _get_slack_user_id(self, user_email: str) -> str:
                 if user_email == user["user"]["profile"]["email"]:
                     if "id" in user["user"]:
                         user_id = user["user"]["id"]
-                        logger.debug(f"Slack user ID is {user_id}")
+                        logger.debug("Slack user ID is %s", user_id)
                         slack_user_is_found = True
                 else:
                     logger.warning(
-                        f"A user with email {user_email} could not be found in this Slack workspace.",
+                        "A user with email %s could not be found in this Slack workspace.", user_email,
                     )
 
             if not slack_user_is_found:
@@ -496,7 +496,7 @@ def _get_webhook_endpoints(
         if not endpoints.exists():
             if user:
                 logger.info(
-                    f"URLs for Webhooks not configured for user '{user}': skipping user notification",
+                    "URLs for Webhooks not configured for user '%s': skipping user notification", user,
                 )
             else:
                 logger.info(

dojo/pipeline.py

@@ -99,7 +99,7 @@ def update_azure_groups(backend, uid, user=None, social=None, *args, **kwargs):
                     logger.debug("Skipping group " + group_name + " due to AZUREAD_TENANT_OAUTH2_GROUPS_FILTER " + settings.AZUREAD_TENANT_OAUTH2_GROUPS_FILTER)
                     continue
             except Exception as e:
-                logger.error(f"Could not call microsoft graph API or save groups to member: {e}")
+                logger.error("Could not call microsoft graph API or save groups to member: %s", e)
         if len(group_names) > 0:
             assign_user_to_groups(user, group_names, Dojo_Group.AZURE)
         if settings.AZUREAD_TENANT_OAUTH2_CLEANUP_GROUPS: