package com.amazonaws.gurureviewercli.adapter; import java.io.FileOutputStream; import java.io.IOException; import java.io.OutputStreamWriter; import java.nio.charset.StandardCharsets; import java.nio.file.Path; import java.util.Collections; import java.util.List; import java.util.stream.Collectors; import lombok.val; import org.commonmark.node.Node; import org.commonmark.parser.Parser; import org.commonmark.renderer.html.HtmlRenderer; import software.amazon.awssdk.services.codegurureviewer.model.RecommendationSummary; import com.amazonaws.gurureviewercli.model.ScanMetaData; import com.amazonaws.gurureviewercli.util.JsonUtil; import com.amazonaws.gurureviewercli.util.Log; import com.amazonaws.gurureviewercli.util.SarifConverter; /** * Util to save Guru recommendations to disk and convert them to HTML. */ public final class ResultsAdapter { public static void saveResults(final Path outputDir, final List results, final ScanMetaData scanMetaData) throws IOException { val jsonFile = outputDir.resolve("recommendations.json"); JsonUtil.storeRecommendations(results, jsonFile); Log.info("Recommendations in Json format written to:%n%s", jsonFile.normalize().toUri()); val sarifFile = outputDir.resolve("recommendations.sarif.json"); JsonUtil.writeSarif(SarifConverter.createSarifReport(results), sarifFile); Log.info("Recommendations in SARIF format written to:%n%s", sarifFile.normalize().toUri()); createHtmlReport(outputDir, scanMetaData, results); } private static void createHtmlReport(final Path outputDir, final ScanMetaData scanMetaData, final List recommendations) throws IOException { int validFindings = 0; // sort by file name and line number sortByFileName(recommendations); Parser parser = Parser.builder().build(); HtmlRenderer renderer = HtmlRenderer.builder().build(); val htmlFile = outputDir.resolve("codeguru-report.html"); try (OutputStreamWriter writer = new OutputStreamWriter(new FileOutputStream(htmlFile.toFile()), StandardCharsets.UTF_8)) { writer.write("\n\n"); writer.write("\n"); writer.write("

CodeGuru Reviewer Recommendations

\n"); val awsUrlPrfix = "https://console.aws.amazon.com/codeguru/reviewer"; val associationUrl = String.format("%s?region=%s#/ciworkflows/associationdetails/%s", awsUrlPrfix, scanMetaData.getRegion(), scanMetaData.getAssociationArn()); val scanUrl = String.format("%s?region=%s#/codereviews/details/%s", awsUrlPrfix, scanMetaData.getRegion(), scanMetaData.getCodeReviewArn()); writer.write(renderer.render(parser.parse(String.format("**CodeGuru Repository ARN**: [%s](%s)%n", scanMetaData.getAssociationArn(), associationUrl)))); writer.write(renderer.render(parser.parse(String.format("**CodeGuru Scan ARN**: [%s](%s)%n", scanMetaData.getCodeReviewArn(), scanUrl)))); writer.write("\n

\n"); for (val recommendation : recommendations) { val filePath = scanMetaData.getRepositoryRoot().resolve(recommendation.filePath()).toAbsolutePath(); if (filePath == null || !filePath.toFile().isFile()) { if (filePath != null && !(filePath.endsWith(".") || filePath.endsWith("/"))) { Log.warn("Dropping finding because file not found on disk: %s", filePath); } continue; } validFindings++; String lineMsg; if (!recommendation.startLine().equals(recommendation.endLine()) && recommendation.endLine() != null) { lineMsg = String.format("### In: [%s](%s) L%d %n", filePath, filePath.toUri(), recommendation.startLine()); } else { lineMsg = String.format("### In: [%s](%s) L%d - L%d %n", filePath, filePath.toUri(), recommendation.startLine(), recommendation.endLine()); } Node document = parser.parse(String.format("### In: [%s](%s) L%d %n", filePath, filePath.toUri(), recommendation.startLine())); writer.write(renderer.render(document)); document = parser.parse("**Issue:** " + recommendation.description()); writer.write(renderer.render(document)); writer.write(String.format("

Severity: %s

", recommendation.severity())); if (recommendation.ruleMetadata() != null && recommendation.ruleMetadata().ruleId() != null) { val manifest = recommendation.ruleMetadata(); writer.write(String.format("

Rule ID: %s

", manifest.ruleId())); writer.write(String.format("

Rule Name: %s

", manifest.ruleName())); document = parser.parse("**Description:** " + manifest.longDescription()); writer.write(renderer.render(document)); if (manifest.ruleTags() != null && !manifest.ruleTags().isEmpty()) { val mdList = manifest.ruleTags().stream() .map(s -> String.format("- %s%n", s)) .collect(Collectors.joining()); document = parser.parse("**Tags:**\n" + mdList); writer.write(renderer.render(document)); } } writer.write("\n

\n"); } writer.write("\n"); writer.write("\n"); } Log.info("Report with %d recommendations written to:%n%s", validFindings, htmlFile.normalize().toUri()); } private static void sortByFileName(final List recommendations) { Collections.sort(recommendations, (o1, o2) -> { int pathComp = o1.filePath().compareTo(o2.filePath()); if (pathComp == 0) { return o1.startLine().compareTo(o2.startLine()); } return pathComp; }); } private ResultsAdapter() { // do not instantiate } }