Skip to content

The Unified and Autonomous Development Platform

Refactor markdown report plugin

Robin Shen4786fa271b9e
diff --git a/server-plugin/server-plugin-report-markdown/src/main/java/io/onedev/server/plugin/report/markdown/MarkdownReportDownloadResource.java b/server-plugin/server-plugin-report-markdown/src/main/java/io/onedev/server/plugin/report/markdown/MarkdownReportDownloadResource.java
index 2f3c1bd76e..3bd2eeffe1 100644
--- a/server-plugin/server-plugin-report-markdown/src/main/java/io/onedev/server/plugin/report/markdown/MarkdownReportDownloadResource.java
+++ b/server-plugin/server-plugin-report-markdown/src/main/java/io/onedev/server/plugin/report/markdown/MarkdownReportDownloadResource.java
@@ -94,7 +94,7 @@ public class MarkdownReportDownloadResource extends AbstractResource {
String markdownPath = Joiner.on("/").join(pathSegments);
File buildDir = OneDev.getInstance(StorageManager.class).getBuildDir(project.getId(), build.getNumber());
- File reportDir = new File(buildDir, MarkdownReportModule.CATEGORY + "/" + reportName);
+ File reportDir = new File(buildDir, PublishMarkdownReportStep.CATEGORY + "/" + reportName);
File markdownFile = new File(reportDir, markdownPath);
if (!markdownFile.exists() || markdownFile.isDirectory()) {
@@ -121,7 +121,7 @@ public class MarkdownReportDownloadResource extends AbstractResource {
@Override
public void writeData(Attributes attributes) throws IOException {
- LockUtils.read(build.getReportCategoryLockKey(MarkdownReportModule.CATEGORY), new Callable<Void>() {
+ LockUtils.read(build.getReportCategoryLockKey(PublishMarkdownReportStep.CATEGORY), new Callable<Void>() {
@Override
public Void call() throws Exception {
diff --git a/server-plugin/server-plugin-report-markdown/src/main/java/io/onedev/server/plugin/report/markdown/MarkdownReportModule.java b/server-plugin/server-plugin-report-markdown/src/main/java/io/onedev/server/plugin/report/markdown/MarkdownReportModule.java
index 5cb47f26c4..fa408b5e1b 100644
--- a/server-plugin/server-plugin-report-markdown/src/main/java/io/onedev/server/plugin/report/markdown/MarkdownReportModule.java
+++ b/server-plugin/server-plugin-report-markdown/src/main/java/io/onedev/server/plugin/report/markdown/MarkdownReportModule.java
@@ -30,10 +30,6 @@ import io.onedev.server.web.page.project.pullrequests.detail.PullRequestSummaryP
*/
public class MarkdownReportModule extends AbstractPluginModule {
- public static final String CATEGORY = "markdown";
-
- public static final String START_PAGE = "$onedev-startpage$";
-
@Override
protected void configure() {
super.configure();
@@ -57,11 +53,11 @@ public class MarkdownReportModule extends AbstractPluginModule {
@Override
public List<BuildTab> getTabs(Build build) {
List<BuildTab> tabs = new ArrayList<>();
- LockUtils.read(build.getReportCategoryLockKey(CATEGORY), new Callable<Void>() {
+ LockUtils.read(build.getReportCategoryLockKey(PublishMarkdownReportStep.CATEGORY), new Callable<Void>() {
@Override
public Void call() throws Exception {
- File categoryDir = build.getReportCategoryDir(CATEGORY);
+ File categoryDir = build.getReportCategoryDir(PublishMarkdownReportStep.CATEGORY);
if (categoryDir.exists()) {
for (File reportDir: categoryDir.listFiles()) {
if (SecurityUtils.canAccessReport(build, reportDir.getName()))
@@ -88,12 +84,12 @@ public class MarkdownReportModule extends AbstractPluginModule {
public List<PullRequestSummaryPart> getParts(PullRequest request) {
List<PullRequestSummaryPart> parts = new ArrayList<>();
for (Build build: request.getCurrentBuilds()) {
- parts.addAll(LockUtils.read(build.getReportCategoryLockKey(CATEGORY), new Callable<List<PullRequestSummaryPart>>() {
+ parts.addAll(LockUtils.read(build.getReportCategoryLockKey(PublishMarkdownReportStep.CATEGORY), new Callable<List<PullRequestSummaryPart>>() {
@Override
public List<PullRequestSummaryPart> call() throws Exception {
List<PullRequestSummaryPart> parts = new ArrayList<>();
- File categoryDir = build.getReportCategoryDir(PublishPullRequestMarkdownReportStep.DIR);
+ File categoryDir = build.getReportCategoryDir(PublishPullRequestMarkdownReportStep.CATEGORY);
if (categoryDir.exists()) {
for (File reportDir: categoryDir.listFiles()) {
if (SecurityUtils.canAccessReport(build, reportDir.getName()))
diff --git a/server-plugin/server-plugin-report-markdown/src/main/java/io/onedev/server/plugin/report/markdown/MarkdownReportPage.java b/server-plugin/server-plugin-report-markdown/src/main/java/io/onedev/server/plugin/report/markdown/MarkdownReportPage.java
index ffc1c7762b..22d921072b 100644
--- a/server-plugin/server-plugin-report-markdown/src/main/java/io/onedev/server/plugin/report/markdown/MarkdownReportPage.java
+++ b/server-plugin/server-plugin-report-markdown/src/main/java/io/onedev/server/plugin/report/markdown/MarkdownReportPage.java
@@ -61,7 +61,7 @@ public class MarkdownReportPage extends BuildDetailPage {
protected void onInitialize() {
super.onInitialize();
- File file = new File(getBuild().getReportCategoryDir(MarkdownReportModule.CATEGORY),
+ File file = new File(getBuild().getReportCategoryDir(PublishMarkdownReportStep.CATEGORY),
reportName + "/" + filePath);
try {
String markdown = FileUtils.readFileToString(file, StandardCharsets.UTF_8);
diff --git a/server-plugin/server-plugin-report-markdown/src/main/java/io/onedev/server/plugin/report/markdown/MarkdownReportTab.java b/server-plugin/server-plugin-report-markdown/src/main/java/io/onedev/server/plugin/report/markdown/MarkdownReportTab.java
index 18a6db6d88..32ed46dd54 100644
--- a/server-plugin/server-plugin-report-markdown/src/main/java/io/onedev/server/plugin/report/markdown/MarkdownReportTab.java
+++ b/server-plugin/server-plugin-report-markdown/src/main/java/io/onedev/server/plugin/report/markdown/MarkdownReportTab.java
@@ -30,12 +30,12 @@ public class MarkdownReportTab extends BuildTab {
@Override
protected Link<?> newLink(String linkId, Class<? extends Page> pageClass) {
BuildDetailPage page = (BuildDetailPage) getPage();
- String startPage = LockUtils.read(page.getBuild().getReportCategoryLockKey(MarkdownReportModule.CATEGORY), new Callable<String>() {
+ String startPage = LockUtils.read(page.getBuild().getReportCategoryLockKey(PublishMarkdownReportStep.CATEGORY), new Callable<String>() {
@Override
public String call() throws Exception {
- File startPageFile = new File(page.getBuild().getReportCategoryDir(MarkdownReportModule.CATEGORY),
- getTitle() + "/" + MarkdownReportModule.START_PAGE);
+ File startPageFile = new File(page.getBuild().getReportCategoryDir(PublishMarkdownReportStep.CATEGORY),
+ getTitle() + "/" + PublishMarkdownReportStep.START_PAGE);
return FileUtils.readFileToString(startPageFile, StandardCharsets.UTF_8);
}
diff --git a/server-plugin/server-plugin-report-markdown/src/main/java/io/onedev/server/plugin/report/markdown/PublishMarkdownReportStep.java b/server-plugin/server-plugin-report-markdown/src/main/java/io/onedev/server/plugin/report/markdown/PublishMarkdownReportStep.java
index 9cf480d4ad..83b903b37e 100644
--- a/server-plugin/server-plugin-report-markdown/src/main/java/io/onedev/server/plugin/report/markdown/PublishMarkdownReportStep.java
+++ b/server-plugin/server-plugin-report-markdown/src/main/java/io/onedev/server/plugin/report/markdown/PublishMarkdownReportStep.java
@@ -23,6 +23,10 @@ public class PublishMarkdownReportStep extends PublishReportStep {
private static final long serialVersionUID = 1L;
+ public static final String CATEGORY = "markdown";
+
+ public static final String START_PAGE = "$onedev-startpage$";
+
private String startPage;
@Editable(order=1100, description="Specify start page of the report relative to <a href='$docRoot/pages/concepts.md#job-workspace'>job workspace</a>, for instance: <tt>manual/index.md</tt>")
@@ -43,16 +47,16 @@ public class PublishMarkdownReportStep extends PublishReportStep {
@Override
public Map<String, byte[]> run(Build build, File inputDir, TaskLogger logger) {
- File reportDir = new File(build.getReportCategoryDir(MarkdownReportModule.CATEGORY), getReportName());
-
- LockUtils.write(build.getReportCategoryLockKey(MarkdownReportModule.CATEGORY), new Callable<Void>() {
+ LockUtils.write(build.getReportCategoryLockKey(CATEGORY), new Callable<Void>() {
@Override
public Void call() throws Exception {
File startPage = new File(inputDir, getStartPage());
if (startPage.exists()) {
+ File reportDir = new File(build.getReportCategoryDir(CATEGORY), getReportName());
+
FileUtils.createDir(reportDir);
- File startPageFile = new File(reportDir, MarkdownReportModule.START_PAGE);
+ File startPageFile = new File(reportDir, START_PAGE);
FileUtils.writeFile(startPageFile, getStartPage());
int baseLen = inputDir.getAbsolutePath().length() + 1;
diff --git a/server-plugin/server-plugin-report-markdown/src/main/java/io/onedev/server/plugin/report/markdown/PublishPullRequestMarkdownReportStep.java b/server-plugin/server-plugin-report-markdown/src/main/java/io/onedev/server/plugin/report/markdown/PublishPullRequestMarkdownReportStep.java
index db39a7b6a2..f49a12c04f 100644
--- a/server-plugin/server-plugin-report-markdown/src/main/java/io/onedev/server/plugin/report/markdown/PublishPullRequestMarkdownReportStep.java
+++ b/server-plugin/server-plugin-report-markdown/src/main/java/io/onedev/server/plugin/report/markdown/PublishPullRequestMarkdownReportStep.java
@@ -24,7 +24,7 @@ public class PublishPullRequestMarkdownReportStep extends PublishReportStep {
private static final long serialVersionUID = 1L;
- public static final String DIR = "pull-request-markdown-reports";
+ public static final String CATEGORY = "pull-request-markdown-reports";
public static final String FILE = "content.md";
@@ -54,14 +54,13 @@ public class PublishPullRequestMarkdownReportStep extends PublishReportStep {
@Override
public Map<String, byte[]> run(Build build, File workspace, TaskLogger logger) {
if (build.getRequest() != null) {
- File reportDir = new File(build.getReportCategoryDir(DIR), getReportName());
-
- LockUtils.write(build.getReportCategoryLockKey(DIR), new Callable<Void>() {
+ LockUtils.write(build.getReportCategoryLockKey(CATEGORY), new Callable<Void>() {
@Override
public Void call() throws Exception {
File file = new File(workspace, getFile());
if (file.exists()) {
+ File reportDir = new File(build.getReportCategoryDir(CATEGORY), getReportName());
String markdown = FileUtils.readFileToString(file, StandardCharsets.UTF_8);
FileUtils.createDir(reportDir);
FileUtils.writeFile(new File(reportDir, FILE), markdown, StandardCharsets.UTF_8.name());