Skip to content

The Unified and Autonomous Development Platform

Fix issue #226 - Render line coverage information reported from builds in source view

Robin Shenb5b79bb576cf
diff --git a/server-core/src/main/java/io/onedev/server/CoreModule.java b/server-core/src/main/java/io/onedev/server/CoreModule.java
index 247aa9c008..7bc451b099 100644
--- a/server-core/src/main/java/io/onedev/server/CoreModule.java
+++ b/server-core/src/main/java/io/onedev/server/CoreModule.java
@@ -90,6 +90,8 @@ import io.onedev.server.buildspec.job.JobManager;
import io.onedev.server.buildspec.job.log.DefaultLogManager;
import io.onedev.server.buildspec.job.log.LogManager;
import io.onedev.server.buildspec.job.log.instruction.LogInstruction;
+import io.onedev.server.code.LineCoverage;
+import io.onedev.server.code.LineCoverageContribution;
import io.onedev.server.code.CodeProblem;
import io.onedev.server.code.CodeProblemContribution;
import io.onedev.server.entitymanager.BuildDependenceManager;
@@ -502,6 +504,14 @@ public class CoreModule extends AbstractPluginModule {
});
+ contribute(LineCoverageContribution.class, new LineCoverageContribution() {
+
+ @Override
+ public List<LineCoverage> getLineCoverages(Build build, String blobPath) {
+ return Lists.newArrayList();
+ }
+
+ });
}
private void configureSsh() {
diff --git a/server-core/src/main/java/io/onedev/server/code/LineCoverage.java b/server-core/src/main/java/io/onedev/server/code/LineCoverage.java
new file mode 100644
index 0000000000..1a0c337bfb
--- /dev/null
+++ b/server-core/src/main/java/io/onedev/server/code/LineCoverage.java
@@ -0,0 +1,33 @@
+package io.onedev.server.code;
+
+import java.io.Serializable;
+
+public class LineCoverage implements Serializable {
+
+ private static final long serialVersionUID = 1L;
+
+ private final int fromLine;
+
+ private final int toLine;
+
+ private final int testCount;
+
+ public LineCoverage(int fromLine, int toLine, int testCount) {
+ this.fromLine = fromLine;
+ this.toLine = toLine;
+ this.testCount = testCount;
+ }
+
+ public int getFromLine() {
+ return fromLine;
+ }
+
+ public int getToLine() {
+ return toLine;
+ }
+
+ public int getTestCount() {
+ return testCount;
+ }
+
+}
diff --git a/server-core/src/main/java/io/onedev/server/code/LineCoverageContribution.java b/server-core/src/main/java/io/onedev/server/code/LineCoverageContribution.java
new file mode 100644
index 0000000000..4f1bffc918
--- /dev/null
+++ b/server-core/src/main/java/io/onedev/server/code/LineCoverageContribution.java
@@ -0,0 +1,13 @@
+package io.onedev.server.code;
+
+import java.util.List;
+
+import io.onedev.commons.launcher.loader.ExtensionPoint;
+import io.onedev.server.model.Build;
+
+@ExtensionPoint
+public interface LineCoverageContribution {
+
+ List<LineCoverage> getLineCoverages(Build build, String blobPath);
+
+}
diff --git a/server-core/src/main/java/io/onedev/server/web/asset/codeproblem/code-problem.js b/server-core/src/main/java/io/onedev/server/web/asset/codeproblem/code-problem.js
index 97bb798a8a..b46cd323de 100644
--- a/server-core/src/main/java/io/onedev/server/web/asset/codeproblem/code-problem.js
+++ b/server-core/src/main/java/io/onedev/server/web/asset/codeproblem/code-problem.js
@@ -61,7 +61,7 @@ onedev.server.codeProblem = {
$container.append($content);
$content.text(problem.content);
$content.prepend("<svg class='icon icon-sm mr-2'><use xlink:href='" + onedev.server.icons + "#" + icon + "'/></svg>");
- $content.append("<a title='Add comment' class='add-comment ml-2'><svg class='icon icon-sm mr-2'><use xlink:href='" + onedev.server.icons + "#comment'/></svg></a>");
+ $content.append("<a title='Add comment' class='add-comment link-gray ml-2'><svg class='icon icon-sm mr-2'><use xlink:href='" + onedev.server.icons + "#comment'/></svg></a>");
}
return $container.html();
} else {
@@ -69,7 +69,7 @@ onedev.server.codeProblem = {
var $content = $container.children('.problem-content');
$content.text(problems[0].content);
$content.addClass(onedev.server.codeProblem.getTextClass(problems[0]));
- $content.append("<a title='Add comment' class='add-comment ml-2'><svg class='icon icon-sm mr-2'><use xlink:href='" + onedev.server.icons + "#comment'/></svg></a>");
+ $content.append("<a title='Add comment' class='add-comment link-gray ml-2'><svg class='icon icon-sm mr-2'><use xlink:href='" + onedev.server.icons + "#comment'/></svg></a>");
return $container.html();
}
}
diff --git a/server-core/src/main/java/io/onedev/server/web/page/project/blob/render/renderers/source/SourceViewPanel.java b/server-core/src/main/java/io/onedev/server/web/page/project/blob/render/renderers/source/SourceViewPanel.java
index 2ad177718c..260bd5dac2 100644
--- a/server-core/src/main/java/io/onedev/server/web/page/project/blob/render/renderers/source/SourceViewPanel.java
+++ b/server-core/src/main/java/io/onedev/server/web/page/project/blob/render/renderers/source/SourceViewPanel.java
@@ -64,6 +64,8 @@ import io.onedev.commons.utils.StringUtils;
import io.onedev.server.OneDev;
import io.onedev.server.code.CodeProblem;
import io.onedev.server.code.CodeProblemContribution;
+import io.onedev.server.code.LineCoverage;
+import io.onedev.server.code.LineCoverageContribution;
import io.onedev.server.entitymanager.BuildManager;
import io.onedev.server.entitymanager.CodeCommentManager;
import io.onedev.server.entitymanager.CodeCommentReplyManager;
@@ -192,6 +194,30 @@ public class SourceViewPanel extends BlobViewPanel implements Positionable, Sear
}
};
+
+ private final IModel<Map<Integer, Integer>> coveragesModel = new LoadableDetachableModel<Map<Integer, Integer>>() {
+
+ @Override
+ protected Map<Integer, Integer> load() {
+ Map<Integer, Integer> coverages = new HashMap<>();
+ BuildManager buildManager = OneDev.getInstance(BuildManager.class);
+ for (Build build: buildManager.query(context.getProject(), context.getCommit(), null, null, null, new HashMap<>())) {
+ for (LineCoverageContribution contribution: OneDev.getExtensions(LineCoverageContribution.class)) {
+ for (LineCoverage coverage: contribution.getLineCoverages(build, context.getBlobIdent().path)) {
+ for (int line = coverage.getFromLine(); line <= coverage.getToLine(); line++) {
+ Integer testCount = coverages.get(line);
+ if (testCount != null)
+ coverages.put(line, testCount + coverage.getTestCount());
+ else
+ coverages.put(line, coverage.getTestCount());
+ }
+ }
+ }
+ }
+ return coverages;
+ }
+
+ };
private WebMarkupContainer commentContainer;
@@ -899,6 +925,7 @@ public class SourceViewPanel extends BlobViewPanel implements Positionable, Sear
String jsonOfBlameInfos = getJsonOfBlameInfos(context.getMode() == Mode.BLAME);
String jsonOfCommentInfos = convertToJson(commentsModel.getObject());
String jsonOfProblems = convertToJson(problemsModel.getObject());
+ String jsonOfCoverages = convertToJson(coveragesModel.getObject());
PlanarRange mark = SourceRendererProvider.getRange(context.getPosition());
String jsonOfMark = mark!=null? convertToJson(mark): "undefined";
@@ -908,7 +935,7 @@ public class SourceViewPanel extends BlobViewPanel implements Positionable, Sear
explicit("param3"), explicit("param4"));
String script = String.format("onedev.server.sourceView.onDomReady("
- + "'%s', '%s', %s, %s, '%s', '%s', %s, %s, %s, %s, %s, %s, '%s');",
+ + "'%s', '%s', %s, %s, '%s', '%s', %s, %s, %s, %s, %s, %s, %s, '%s');",
JavaScriptEscape.escapeJavaScript(context.getBlobIdent().path),
JavaScriptEscape.escapeJavaScript(blob.getText().getContent()),
context.getOpenComment()!=null?getJsonOfComment(context.getOpenComment()):"undefined",
@@ -918,6 +945,7 @@ public class SourceViewPanel extends BlobViewPanel implements Positionable, Sear
jsonOfBlameInfos,
jsonOfCommentInfos,
jsonOfProblems,
+ jsonOfCoverages,
callback,
blameMessageBehavior.getCallback(),
sourceFormat.getTabSize(),
@@ -932,6 +960,7 @@ public class SourceViewPanel extends BlobViewPanel implements Positionable, Sear
protected void onDetach() {
commentsModel.detach();
problemsModel.detach();
+ coveragesModel.detach();
super.onDetach();
}
diff --git a/server-core/src/main/java/io/onedev/server/web/page/project/blob/render/renderers/source/source-view.css b/server-core/src/main/java/io/onedev/server/web/page/project/blob/render/renderers/source/source-view.css
index 6e20abcf35..3e626512ed 100644
--- a/server-core/src/main/java/io/onedev/server/web/page/project/blob/render/renderers/source/source-view.css
+++ b/server-core/src/main/java/io/onedev/server/web/page/project/blob/render/renderers/source/source-view.css
@@ -39,6 +39,22 @@
background: #FCF5DA;
}
+.CodeMirror-coverages {
+ width: 4px;
+}
+.CodeMirror-coverage.tested {
+ background: var(--success);
+}
+.CodeMirror-coverage.not-tested {
+ background: var(--warning);
+}
+.CodeMirror-coverage.tested:hover {
+ background: #12827c;
+}
+.CodeMirror-coverage.not-tested:hover {
+ background: #b37600;
+}
+
.CodeMirror-comments, .CodeMirror-problems {
width: 20px;
}
diff --git a/server-core/src/main/java/io/onedev/server/web/page/project/blob/render/renderers/source/source-view.js b/server-core/src/main/java/io/onedev/server/web/page/project/blob/render/renderers/source/source-view.js
index d98f2ecca8..b74465cacc 100644
--- a/server-core/src/main/java/io/onedev/server/web/page/project/blob/render/renderers/source/source-view.js
+++ b/server-core/src/main/java/io/onedev/server/web/page/project/blob/render/renderers/source/source-view.js
@@ -1,6 +1,6 @@
onedev.server.sourceView = {
onDomReady: function(filePath, fileContent, openComment, markRange, symbolTooltipId,
- revision, blameInfos, comments, problems, callback, blameMessageCallback,
+ revision, blameInfos, comments, problems, coverages, callback, blameMessageCallback,
tabSize, lineWrapMode) {
var $sourceView = $(".source-view");
@@ -38,6 +38,8 @@ onedev.server.sourceView = {
if (!onedev.server.util.isObjEmpty(problems))
gutters.splice(0, 0, "CodeMirror-problems");
+ if (!onedev.server.util.isObjEmpty(coverages))
+ gutters.splice(gutters.length-1, 0, "CodeMirror-coverages");
gutters.splice(0, 0, "CodeMirror-comments");
cm.setOption("gutters", gutters);
@@ -51,6 +53,11 @@ onedev.server.sourceView = {
if (problems.hasOwnProperty(line))
onedev.server.sourceView.addProblemGutter(line, problems[line][1]);
}
+
+ for (var line in coverages) {
+ if (coverages.hasOwnProperty(line))
+ onedev.server.sourceView.addCoverageGutter(line, coverages[line]);
+ }
if (blameInfos) {
onedev.server.sourceView.blame(blameInfos);
@@ -216,6 +223,23 @@ onedev.server.sourceView = {
else
onedev.server.codemirror.clearMark(cm);
},
+ addCoverageGutter: function(line, testCount) {
+ let tooltip;
+ if (testCount > 0)
+ tooltip = `Tested ${testCount} times`;
+ else
+ tooltip = "Not tested";
+
+ let $gutter = $(`<a class='CodeMirror-coverage d-block' title='${tooltip}'>&nbsp;</a>`);
+
+ if (testCount > 0)
+ $gutter.addClass("tested");
+ else
+ $gutter.addClass("not-tested");
+
+ let cm = $(".source-view>.code>.CodeMirror")[0].CodeMirror;
+ cm.setGutterMarker(parseInt(line), "CodeMirror-coverages", $gutter[0]);
+ },
addProblemGutter: function(line, problems) {
var cm = $(".source-view>.code>.CodeMirror")[0].CodeMirror;
var callback = $(".source-view").data("callback");
@@ -231,8 +255,8 @@ onedev.server.sourceView = {
var icon = onedev.server.codeProblem.getIcon(problems);
var linkClass = onedev.server.codeProblem.getLinkClass(problems);
- let svg = "<svg class='icon icon-sm'><use xlink:href='" + onedev.server.icons + "#" + icon + "'/></svg>";
- $gutter.append("<a class='problem-trigger " + linkClass + "'>" + svg + "</a>");
+ let svg = `<svg class='icon icon-sm'><use xlink:href='${onedev.server.icons}#${icon}'/></svg>`;
+ $gutter.append(`<a class='problem-trigger ${linkClass}'>${svg}</a>`);
var $trigger = $gutter.children("a");
$trigger.mouseover(function() {
onedev.server.codemirror.mark(cm, markRanges);
diff --git a/server-plugin/server-plugin-report-html/src/main/java/io/onedev/server/plugin/report/html/HtmlReportModule.java b/server-plugin/server-plugin-report-html/src/main/java/io/onedev/server/plugin/report/html/HtmlReportModule.java
index f28c52d9e2..663f3883e5 100644
--- a/server-plugin/server-plugin-report-html/src/main/java/io/onedev/server/plugin/report/html/HtmlReportModule.java
+++ b/server-plugin/server-plugin-report-html/src/main/java/io/onedev/server/plugin/report/html/HtmlReportModule.java
@@ -81,7 +81,7 @@ public class HtmlReportModule extends AbstractPluginModule {
}
});
-
+
/*
contribute(CodeProblemContribution.class, new CodeProblemContribution() {
@@ -96,8 +96,18 @@ public class HtmlReportModule extends AbstractPluginModule {
);
}
+ });
+
+ contribute(LineCoverageContribution.class, new LineCoverageContribution() {
+
+ @Override
+ public List<LineCoverage> getLineCoverages(Build build, String blobPath) {
+ return Lists.newArrayList(new LineCoverage(5, 8, 1), new LineCoverage(12, 15, 0));
+ }
+
});
*/
+
}
}