Don't Merge: Intentional Broken formatting

kai/report.py

@@ -1,11 +1,12 @@
-__all__ = ['Report']
+__all__ = ["Report"]
 
 import os
 import shutil
-import yaml 
-
 from io import StringIO
 
+import yaml
+
+
 class Report:
  def __init__(self, path_to_report):
  self.path_to_report = path_to_report
@@ -18,10 +19,10 @@ def __init__(self, path_to_report):
  def get_cleaned_file_path(uri):
  file_path = uri.replace("file:///tmp/source-code/", "")
  return file_path
- 
+
  def get_report(self):
  if self.report is None:
- self.report = self._read_report() 
+ self.report = self._read_report()
  return self.report
 
  def get_impacted_files(self):
@@ -37,27 +38,29 @@ def get_impacted_files(self):
  for ruleset_name in report.keys():
  ruleset = report[ruleset_name]
  # We iterate over each ruleset
- for violation_name in ruleset['violations'].keys():
- violation = ruleset['violations'][violation_name]
- # We look at each violation 
- for incid in violation['incidents']:
- if 'uri' in incid:
+ for violation_name in ruleset["violations"].keys():
+ violation = ruleset["violations"][violation_name]
+ # We look at each violation
+ for incid in violation["incidents"]:
+ if "uri" in incid:
  if not self.should_we_skip_incident(incid):
- file_path = Report.get_cleaned_file_path(incid['uri'])
+ file_path = Report.get_cleaned_file_path(incid["uri"])
  current_entry = {
- 'ruleset_name': ruleset_name,
- 'violation_name': violation_name,
- 'ruleset_description': ruleset.get('description', ''),
- 'violation_description': violation.get('description', ''),
- 'message': incid.get('message', ""),
- 'codeSnip': incid.get('codeSnip', ""),
- 'lineNumber': incid.get('lineNumber', ""),
+ "ruleset_name": ruleset_name,
+ "violation_name": violation_name,
+ "ruleset_description": ruleset.get("description", ""),
+ "violation_description": violation.get(
+ "description", ""
+ ),
+ "message": incid.get("message", ""),
+ "codeSnip": incid.get("codeSnip", ""),
+ "lineNumber": incid.get("lineNumber", ""),
  }
  if impacted_files.get(file_path) is None:
  impacted_files[file_path] = []
- impacted_files[file_path].append(current_entry) 
+ impacted_files[file_path].append(current_entry)
  return impacted_files
- 
+
  def _reformat_report(self, report):
  new_report = {}
  # Reformat from a List to a Dict where the key is the name
@@ -68,50 +71,52 @@ def _reformat_report(self, report):
  new_report[ruleset_name] = item
  # We dropped all rulesests with empty violations
  return new_report
- 
+
  def _read_report(self):
  print(f"Reading report from {self.path_to_report}")
- with open(self.path_to_report, 'r') as f:
+ with open(self.path_to_report, "r") as f:
  report = yaml.safe_load(f)
  report = self._reformat_report(report)
  return report
- 
+
  def _get_ruleset_name(self, item):
  # The 'name' of a ruleset is not guaranteed from what I'm seeing in our
  # rulesets. We need a way to distinguish rulesets if no name is present
  # hence this workaround.
  # See https:/konveyor/rulesets/issues/36 for what motivated
  # this workaround
  name = ""
- if 'name' not in item.keys():
+ if "name" not in item.keys():
  self.workaround_counter_for_missing_ruleset_name += 1
  name = f"mising_ruleset_name_{self.workaround_counter_for_missing_ruleset_name}"
  else:
- name = item['name']
+ name = item["name"]
  return name
 
  def write_markdown(self, output_dir):
- # We will create a single directory per source app 
+ # We will create a single directory per source app
  # Where each ruleset with data is in its own file
  try:
  os.makedirs(output_dir, exist_ok=True)
  except OSError as error:
  print(f"Error creating directory {output_dir}: {error}")
  raise error
  report = self.get_report()
- # Iterate through each Ruleset that has data 
+ # Iterate through each Ruleset that has data
  # Write a separate file per ruleset
  for ruleset_name in report.keys():
  ruleset = report[ruleset_name]
- ruleset_name_display = ruleset_name.replace('/', '_')
- with open(f"{output_dir}/{ruleset_name_display}.md", 'w') as f:
+ ruleset_name_display = ruleset_name.replace("/", "_")
+ with open(f"{output_dir}/{ruleset_name_display}.md", "w") as f:
  # We want to start each run with a clean file
  f.truncate(0)
  buffer = StringIO()
  self._get_markdown_snippet(ruleset_name, buffer)
  buffer.seek(0)
  shutil.copyfileobj(buffer, f)
- print(f"Writing {ruleset_name} to {output_dir}/{ruleset_name_display}.md")
+ print(
+ f"Writing {ruleset_name} to {output_dir}/{ruleset_name_display}.md"
+ )
  buffer.close()
 
  def _get_markdown_snippet(self, ruleset_name, f):
@@ -120,40 +125,42 @@ def _get_markdown_snippet(self, ruleset_name, f):
  f.write(f"# {ruleset_name}\n")
  f.write(f"## Description\n")
  f.write(f"{ruleset.get('description', '')}\n")
- f.write(f"* Source of rules: https:/konveyor/rulesets/tree/main/default/generated\n")
+ f.write(
+ f"* Source of rules: https:/konveyor/rulesets/tree/main/default/generated\n"
+ )
  f.write(f"## Violations\n")
  f.write(f"Number of Violations: {len(ruleset['violations'])}\n")
  counter = 0
- for count, key in enumerate(ruleset['violations']):
- items = ruleset['violations'][key]
+ for count, key in enumerate(ruleset["violations"]):
+ items = ruleset["violations"][key]
  f.write(f"### #{count} - {key}\n")
- # Break out below for violation 
+ # Break out below for violation
  # Then we can weave in an example perhaps?
  # Or should there be a Markdown class that is responsible for blending
  # . - Report
  # . - Per Violation create a prompt/run/example
 
  f.write(f"* Category: {items['category']}\n")
- if 'effort' in items:
+ if "effort" in items:
  f.write(f"* Effort: {items['effort']}\n")
  f.write(f"* Description: {items['description']}\n")
- if 'labels' in items:
+ if "labels" in items:
  f.write(f"* Labels: {', '.join(items['labels'])}\n")
- if 'links' in items:
+ if "links" in items:
  f.write(f"* Links\n")
- for l in items['links']:
+ for l in items["links"]:
  f.write(f" * {l['title']}: {l['url']}\n")
- if 'incidents' in items:
+ if "incidents" in items:
  f.write(f"* Incidents\n")
- for incid in items['incidents']:
- #Possible keys of 'uri', 'message', 'codeSnip'
- if 'uri' in incid:
+ for incid in items["incidents"]:
+ # Possible keys of 'uri', 'message', 'codeSnip'
+ if "uri" in incid:
  f.write(f" * {incid['uri']}\n")
- if 'lineNumber' in incid:
+ if "lineNumber" in incid:
  f.write(f" * Line Number: {incid['lineNumber']}\n")
- if 'message' in incid and incid['message'].strip() != "":
+ if "message" in incid and incid["message"].strip() != "":
  f.write(f" * Message: '{incid['message'].strip()}'\n")
- if 'codeSnip' in incid:
+ if "codeSnip" in incid:
  f.write(f" * Code Snippet:\n")
  f.write(f"```java\n")
  f.write(f"{incid['codeSnip']}\n")
@@ -162,20 +169,20 @@ def _get_markdown_snippet(self, ruleset_name, f):
  def get_violation_snippet(self, ruleset_name, violation_name):
  report = self.get_report()
  ruleset = report[ruleset_name]
- violation = ruleset['violations'][violation_name]
+ violation = ruleset["violations"][violation_name]
  buffer = StringIO()
  buffer.write(f"# {ruleset_name}\n")
  buffer.write(f"## Description\n")
  buffer.write(f"{ruleset['description']}\n")
  buffer.write(f"* Source of rules:")
- 
+
  def should_we_skip_incident(self, incid):
  # Filter out known issues
- file_path = Report.get_cleaned_file_path(incid['uri'])
+ file_path = Report.get_cleaned_file_path(incid["uri"])
  if file_path.startswith("target/"):
  # Skip any incident that begins with 'target/'
  # Related to: https:/konveyor/analyzer-lsp/issues/358
  return True
  if file_path.endswith(".svg"):
  # See https:/konveyor/rulesets/issues/41
- return True
+ return True