Merge pull request #77 from snyk/fix/head-451-teamcity-report-missing

Asaf Agami · web-flow · commit 6e742654cd2c · 2023-07-31T11:29:11.000+03:00
fix: report being downloaded instead of rendered on screen [HEAD-451]
diff --git a/teamcity-snyk-security-plugin-server/src/main/java/io/snyk/plugins/teamcity/server/SnykSecurityReportTab.java b/teamcity-snyk-security-plugin-server/src/main/java/io/snyk/plugins/teamcity/server/SnykSecurityReportTab.java
@@ -1,6 +1,11 @@
 package io.snyk.plugins.teamcity.server;
 
 import javax.servlet.http.HttpServletRequest;
+import java.io.BufferedReader;
+import java.io.IOException;
+import java.io.InputStream;
+import java.io.InputStreamReader;
+import java.nio.charset.StandardCharsets;
 import java.util.Map;
 
 import io.snyk.plugins.teamcity.common.SnykSecurityRunnerConstants;
@@ -13,6 +18,7 @@
 import jetbrains.buildServer.web.openapi.PluginDescriptor;
 import jetbrains.buildServer.web.openapi.PositionConstraint;
 import jetbrains.buildServer.web.openapi.ViewLogTab;
+import org.apache.log4j.Logger;
 import org.jetbrains.annotations.NotNull;
 
 import static io.snyk.plugins.teamcity.common.SnykSecurityRunnerConstants.SNYK_ARTIFACTS_DIR;
@@ -25,16 +31,19 @@ public class SnykSecurityReportTab extends ViewLogTab {
   private static final String TAB_TITLE = "Snyk Security Report";
   private static final String TAB_CODE = "snykSecurityReport";
 
+  private static final Logger LOG = Logger.getLogger(SnykSecurityReportTab.class);
+
   public SnykSecurityReportTab(@NotNull PagePlaces pagePlaces, @NotNull SBuildServer server, @NotNull PluginDescriptor pluginDescriptor) {
     super(TAB_TITLE, TAB_CODE, pagePlaces, server);
 
-    setIncludeUrl("/artifactsViewer.jsp");
+    String path = pluginDescriptor.getPluginResourcesPath("tab/snykReport.jsp");
+    setIncludeUrl(path);
     setPosition(PositionConstraint.after("artifacts"));
   }
 
   @Override
   protected void fillModel(@NotNull Map<String, Object> map, @NotNull HttpServletRequest httpServletRequest, @NotNull SBuild build) {
-    map.put("startPage", getSnykHtmlReport(build));
+    map.put("snykHtmlReportContent", readSnykHtmlReport(build));
   }
 
   @Override
@@ -46,9 +55,30 @@ protected boolean isAvailable(@NotNull HttpServletRequest request, @NotNull SBui
     return buildType.getRunnerTypes().contains(SnykSecurityRunnerConstants.RUNNER_TYPE);
   }
 
-  private String getSnykHtmlReport(SBuild build) {
+  private String readSnykHtmlReport(@NotNull SBuild build) {
     String snykHtmlReportPath = TEAMCITY_ARTIFACTS_DIR + separator + SNYK_ARTIFACTS_DIR + separator + SNYK_REPORT_HTML_FILE;
     BuildArtifact artifact = build.getArtifacts(BuildArtifactsViewMode.VIEW_HIDDEN_ONLY).getArtifact(snykHtmlReportPath);
-    return artifact != null ? artifact.getRelativePath() : SNYK_REPORT_HTML_FILE;
+
+    if (artifact == null) {
+      LOG.error("An error occurred while reading the Snyk HTML report - artifact not found");
+      return generateErrorMessage("Artifact not found");
+    }
+
+    try (InputStream inputStream = artifact.getInputStream();
+         BufferedReader reader = new BufferedReader(new InputStreamReader(inputStream, StandardCharsets.UTF_8))) {
+      StringBuilder content = new StringBuilder();
+      String line;
+      while ((line = reader.readLine()) != null) {
+        content.append(line).append("\n");
+      }
+      return content.toString();
+    } catch (IOException e) {
+      LOG.error("An error occurred while reading the Snyk HTML report.", e);
+      return generateErrorMessage("An error occurred while reading the report");
+    }
+  }
+
+  private String generateErrorMessage(String message) {
+    return "<html><head><title>Error</title></head><body><h1>Snyk report error: " + message + "</h1></body></html>";
   }
 }
diff --git a/teamcity-snyk-security-plugin-server/src/main/resources/buildServerResources/tab/snykReport.jsp b/teamcity-snyk-security-plugin-server/src/main/resources/buildServerResources/tab/snykReport.jsp
@@ -0,0 +1,13 @@
+<%@ page contentType="text/html;charset=UTF-8" language="java" %>
+<%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %>
+<%@ taglib prefix="bs" tagdir="/WEB-INF/tags" %>
+
+<c:if test="${not empty error}">
+  <c:out value="${error}"/>: <b><c:out value="${startPage}"/></b>. <!-- Probably need to replace startPage with something else -->
+</c:if>
+
+<c:if test="${empty error}">
+  <div>
+      ${snykHtmlReportContent}
+  </div>
+</c:if>
