Skip to content

The Unified and Autonomous Development Platform

Add html report support for job outcome

Robin Shen346b7a103ea9
diff --git a/core/src/main/java/io/onedev/server/ci/job/DefaultJobScheduler.java b/core/src/main/java/io/onedev/server/ci/job/DefaultJobScheduler.java
index 6618a88b8e..1b23cf9c9e 100644
--- a/core/src/main/java/io/onedev/server/ci/job/DefaultJobScheduler.java
+++ b/core/src/main/java/io/onedev/server/ci/job/DefaultJobScheduler.java
@@ -283,7 +283,7 @@ public class DefaultJobScheduler implements JobScheduler, Runnable {
logger.info("Populating dependencies...");
for (BuildDependence dependence: build.getDependencies()) {
for (DependencyPopulator populator: dependencyPopulators)
- populator.populate(dependence.getDependency(), workspace);
+ populator.populate(dependence.getDependency(), workspace, logger);
}
envVars.put("ONEDEV_PROJECT", build.getProject().getName());
envVars.put("ONEDEV_COMMIT", commitId.name());
@@ -310,7 +310,7 @@ public class DefaultJobScheduler implements JobScheduler, Runnable {
logger.info("Collecting job outcomes...");
Build2 build = buildManager.load(buildId);
for (JobOutcome outcome: job.getOutcomes())
- outcome.process(build, workspace);
+ outcome.process(build, workspace, logger);
}
});
@@ -378,7 +378,6 @@ public class DefaultJobScheduler implements JobScheduler, Runnable {
resubmit(dependence.getDependent());
if (build.isFinished()) {
- logManager.clearLogger(build.getProject().getId(), build.getId());
build.setStatus(Build2.Status.WAITING);
build.setFinishDate(null);
build.setPendingDate(null);
diff --git a/core/src/main/java/io/onedev/server/ci/job/log/DefaultLogManager.java b/core/src/main/java/io/onedev/server/ci/job/log/DefaultLogManager.java
index 1fcf6ebd2a..ff7fe2ed2d 100644
--- a/core/src/main/java/io/onedev/server/ci/job/log/DefaultLogManager.java
+++ b/core/src/main/java/io/onedev/server/ci/job/log/DefaultLogManager.java
@@ -35,7 +35,6 @@ import com.google.common.base.Throwables;
import io.onedev.commons.launcher.loader.Listen;
import io.onedev.commons.utils.ExceptionUtils;
-import io.onedev.commons.utils.FileUtils;
import io.onedev.commons.utils.LockUtils;
import io.onedev.server.event.build2.BuildFinished;
import io.onedev.server.model.Build2;
@@ -75,18 +74,6 @@ public class DefaultLogManager implements LogManager {
return new File(buildDir, LOG_FILE);
}
- @Override
- public void clearLogger(Long projectId, Long buildId) {
- Lock lock = LockUtils.getReadWriteLock(getLockKey(buildId)).writeLock();
- lock.lock();
- try {
- FileUtils.deleteFile(getLogFile(projectId, buildId));
- recentSnippets.remove(buildId);
- } finally {
- lock.unlock();
- }
- }
-
@Override
public Logger getLogger(Long projectId, Long buildId, LogLevel loggerLevel) {
return new JobLogger(loggerLevel) {
diff --git a/core/src/main/java/io/onedev/server/ci/job/log/LogManager.java b/core/src/main/java/io/onedev/server/ci/job/log/LogManager.java
index 1c171dd3ac..f3ba601b38 100644
--- a/core/src/main/java/io/onedev/server/ci/job/log/LogManager.java
+++ b/core/src/main/java/io/onedev/server/ci/job/log/LogManager.java
@@ -9,8 +9,6 @@ import io.onedev.server.model.Build2;
public interface LogManager {
- void clearLogger(Long projectId, Long buildId);
-
Logger getLogger(Long projectId, Long buildId, LogLevel logLevel);
/**
diff --git a/core/src/main/java/io/onedev/server/ci/job/outcome/DependencyPopulator.java b/core/src/main/java/io/onedev/server/ci/job/outcome/DependencyPopulator.java
index 17e8df3bc2..498818246c 100644
--- a/core/src/main/java/io/onedev/server/ci/job/outcome/DependencyPopulator.java
+++ b/core/src/main/java/io/onedev/server/ci/job/outcome/DependencyPopulator.java
@@ -2,10 +2,12 @@ package io.onedev.server.ci.job.outcome;
import java.io.File;
+import org.slf4j.Logger;
+
import io.onedev.server.model.Build2;
public interface DependencyPopulator {
- void populate(Build2 dependency, File workspace);
+ void populate(Build2 dependency, File workspace, Logger logger);
}
diff --git a/core/src/main/java/io/onedev/server/ci/job/outcome/JobOutcome.java b/core/src/main/java/io/onedev/server/ci/job/outcome/JobOutcome.java
index 9076ab4e00..cb33383a04 100644
--- a/core/src/main/java/io/onedev/server/ci/job/outcome/JobOutcome.java
+++ b/core/src/main/java/io/onedev/server/ci/job/outcome/JobOutcome.java
@@ -4,6 +4,7 @@ import java.io.File;
import java.io.Serializable;
import org.hibernate.validator.constraints.NotEmpty;
+import org.slf4j.Logger;
import io.onedev.server.OneDev;
import io.onedev.server.model.Build2;
@@ -38,16 +39,16 @@ public abstract class JobOutcome implements Serializable {
return patternSet;
}
- public abstract void process(Build2 build, File workspace);
+ public abstract void process(Build2 build, File workspace, Logger logger);
- public static String getLockKey(Build2 build, String outcomeName) {
- return "job-outcome:" + build.getId() + ":" + outcomeName;
+ public static String getLockKey(Build2 build, String outcomeDir) {
+ return "job-outcome:" + build.getId() + ":" + outcomeDir;
}
- public static File getOutcomeDir(Build2 build, String outcomeName) {
+ public static File getOutcomeDir(Build2 build, String outcomeDir) {
File buildDir = OneDev.getInstance(StorageManager.class)
.getBuildDir(build.getProject().getId(), build.getId());
- return new File(buildDir, outcomeName);
+ return new File(buildDir, outcomeDir);
}
}
diff --git a/core/src/main/java/io/onedev/server/ci/job/outcome/ArtifactsPopulator.java b/core/src/main/java/io/onedev/server/ci/job/outcome/artifact/ArtifactsPopulator.java
similarity index 62%
rename from core/src/main/java/io/onedev/server/ci/job/outcome/ArtifactsPopulator.java
rename to core/src/main/java/io/onedev/server/ci/job/outcome/artifact/ArtifactsPopulator.java
index e2e37d6b12..68ddda7d9e 100644
--- a/core/src/main/java/io/onedev/server/ci/job/outcome/ArtifactsPopulator.java
+++ b/core/src/main/java/io/onedev/server/ci/job/outcome/artifact/ArtifactsPopulator.java
@@ -1,19 +1,22 @@
-package io.onedev.server.ci.job.outcome;
+package io.onedev.server.ci.job.outcome.artifact;
import java.io.File;
import java.util.concurrent.Callable;
import org.apache.commons.io.FileUtils;
+import org.slf4j.Logger;
import io.onedev.commons.utils.LockUtils;
+import io.onedev.server.ci.job.outcome.DependencyPopulator;
+import io.onedev.server.ci.job.outcome.JobOutcome;
import io.onedev.server.model.Build2;
public class ArtifactsPopulator implements DependencyPopulator {
@Override
- public void populate(Build2 dependency, File workspace) {
- File outcomeDir = JobOutcome.getOutcomeDir(dependency, JobArtifacts.NAME);
- LockUtils.read(JobOutcome.getLockKey(dependency, JobArtifacts.NAME), new Callable<Void>() {
+ public void populate(Build2 dependency, File workspace, Logger logger) {
+ File outcomeDir = JobOutcome.getOutcomeDir(dependency, JobArtifacts.DIR);
+ LockUtils.read(JobOutcome.getLockKey(dependency, JobArtifacts.DIR), new Callable<Void>() {
@Override
public Void call() throws Exception {
diff --git a/core/src/main/java/io/onedev/server/ci/job/outcome/JobArtifacts.java b/core/src/main/java/io/onedev/server/ci/job/outcome/artifact/JobArtifacts.java
similarity index 68%
rename from core/src/main/java/io/onedev/server/ci/job/outcome/JobArtifacts.java
rename to core/src/main/java/io/onedev/server/ci/job/outcome/artifact/JobArtifacts.java
index 1c8d4ccefa..77e605212f 100644
--- a/core/src/main/java/io/onedev/server/ci/job/outcome/JobArtifacts.java
+++ b/core/src/main/java/io/onedev/server/ci/job/outcome/artifact/JobArtifacts.java
@@ -1,11 +1,14 @@
-package io.onedev.server.ci.job.outcome;
+package io.onedev.server.ci.job.outcome.artifact;
import java.io.File;
import java.io.IOException;
import java.util.concurrent.Callable;
+import org.slf4j.Logger;
+
import io.onedev.commons.utils.FileUtils;
import io.onedev.commons.utils.LockUtils;
+import io.onedev.server.ci.job.outcome.JobOutcome;
import io.onedev.server.model.Build2;
import io.onedev.server.web.editable.annotation.Editable;
@@ -14,14 +17,14 @@ public class JobArtifacts extends JobOutcome {
private static final long serialVersionUID = 1L;
- public static final String NAME = "artifacts";
+ public static final String DIR = "artifacts";
@Override
- public void process(Build2 build, File workspace) {
- File outcomeDir = getOutcomeDir(build, NAME);
+ public void process(Build2 build, File workspace, Logger logger) {
+ File outcomeDir = getOutcomeDir(build, DIR);
FileUtils.createDir(outcomeDir);
- LockUtils.write(getLockKey(build, NAME), new Callable<Void>() {
+ LockUtils.write(getLockKey(build, DIR), new Callable<Void>() {
@Override
public Void call() throws Exception {
diff --git a/core/src/main/java/io/onedev/server/ci/job/outcome/htmlreport/HtmlReportInfo.java b/core/src/main/java/io/onedev/server/ci/job/outcome/htmlreport/HtmlReportInfo.java
new file mode 100644
index 0000000000..5937891490
--- /dev/null
+++ b/core/src/main/java/io/onedev/server/ci/job/outcome/htmlreport/HtmlReportInfo.java
@@ -0,0 +1,26 @@
+package io.onedev.server.ci.job.outcome.htmlreport;
+
+import java.io.Serializable;
+
+public class HtmlReportInfo implements Serializable {
+
+ private static final long serialVersionUID = 1L;
+
+ private final String reportName;
+
+ private final String startPage;
+
+ public HtmlReportInfo(String reportName, String startPage) {
+ this.reportName = reportName;
+ this.startPage = startPage;
+ }
+
+ public String getReportName() {
+ return reportName;
+ }
+
+ public String getStartPage() {
+ return startPage;
+ }
+
+}
\ No newline at end of file
diff --git a/core/src/main/java/io/onedev/server/ci/job/outcome/htmlreport/JobHtmlReport.java b/core/src/main/java/io/onedev/server/ci/job/outcome/htmlreport/JobHtmlReport.java
new file mode 100644
index 0000000000..a31168d433
--- /dev/null
+++ b/core/src/main/java/io/onedev/server/ci/job/outcome/htmlreport/JobHtmlReport.java
@@ -0,0 +1,87 @@
+package io.onedev.server.ci.job.outcome.htmlreport;
+
+import java.io.File;
+import java.io.IOException;
+import java.util.ArrayList;
+import java.util.concurrent.Callable;
+
+import org.apache.commons.lang3.SerializationUtils;
+import org.hibernate.validator.constraints.NotEmpty;
+import org.slf4j.Logger;
+
+import io.onedev.commons.utils.FileUtils;
+import io.onedev.commons.utils.LockUtils;
+import io.onedev.server.ci.job.outcome.JobOutcome;
+import io.onedev.server.model.Build2;
+import io.onedev.server.web.editable.annotation.Editable;
+
+@Editable(name="Html Report")
+public class JobHtmlReport extends JobOutcome {
+
+ private static final long serialVersionUID = 1L;
+
+ public static final String DIR = "html";
+
+ public static final String INFO = "$onedev-htmlreport-info$";
+
+ private String reportName;
+
+ private String startPage;
+
+ @Editable(order=1000)
+ @NotEmpty
+ public String getReportName() {
+ return reportName;
+ }
+
+ public void setReportName(String reportName) {
+ this.reportName = reportName;
+ }
+
+ @Editable(order=1100, description="Specify start page of the report relative to workspace, for instance: api/index.html")
+ @NotEmpty
+ public String getStartPage() {
+ return startPage;
+ }
+
+ public void setStartPage(String startPage) {
+ this.startPage = startPage;
+ }
+
+ @Override
+ public void process(Build2 build, File workspace, Logger logger) {
+ File outcomeDir = getOutcomeDir(build, DIR);
+ FileUtils.createDir(outcomeDir);
+
+ LockUtils.write(getLockKey(build, DIR), new Callable<Void>() {
+
+ @Override
+ public Void call() throws Exception {
+ File startPage = new File(workspace, getStartPage());
+ if (startPage.exists()) {
+ ArrayList<HtmlReportInfo> infos;
+ File infoFile = new File(outcomeDir, INFO);
+ if (infoFile.exists())
+ infos = SerializationUtils.deserialize(FileUtils.readFileToByteArray(infoFile));
+ else
+ infos = new ArrayList<>();
+ infos.add(new HtmlReportInfo(getReportName(), getStartPage()));
+ FileUtils.writeByteArrayToFile(infoFile, SerializationUtils.serialize(infos));
+
+ int baseLen = workspace.getAbsolutePath().length() + 1;
+ for (File file: getPatternSet().listFiles(workspace)) {
+ try {
+ FileUtils.copyFile(file, new File(outcomeDir, file.getAbsolutePath().substring(baseLen)));
+ } catch (IOException e) {
+ throw new RuntimeException(e);
+ }
+ }
+ } else {
+ logger.warn("Html report start page not found: " + startPage.getAbsolutePath());
+ }
+ return null;
+ }
+
+ });
+ }
+}
diff --git a/core/src/main/java/io/onedev/server/entitymanager/impl/DefaultBuild2Manager.java b/core/src/main/java/io/onedev/server/entitymanager/impl/DefaultBuild2Manager.java
index 0e0c367b49..c394a81df0 100644
--- a/core/src/main/java/io/onedev/server/entitymanager/impl/DefaultBuild2Manager.java
+++ b/core/src/main/java/io/onedev/server/entitymanager/impl/DefaultBuild2Manager.java
@@ -18,6 +18,7 @@ import org.hibernate.query.Query;
import com.google.common.base.Preconditions;
+import io.onedev.commons.utils.FileUtils;
import io.onedev.server.entitymanager.Build2Manager;
import io.onedev.server.entitymanager.BuildDependenceManager;
import io.onedev.server.entitymanager.BuildParamManager;
@@ -31,6 +32,7 @@ import io.onedev.server.persistence.annotation.Transactional;
import io.onedev.server.persistence.dao.AbstractEntityManager;
import io.onedev.server.persistence.dao.Dao;
import io.onedev.server.persistence.dao.EntityCriteria;
+import io.onedev.server.storage.StorageManager;
@Singleton
public class DefaultBuild2Manager extends AbstractEntityManager<Build2> implements Build2Manager {
@@ -39,11 +41,15 @@ public class DefaultBuild2Manager extends AbstractEntityManager<Build2> implemen
private final BuildDependenceManager buildDependenceManager;
+ private final StorageManager storageManager;
+
@Inject
- public DefaultBuild2Manager(Dao dao, BuildParamManager buildParamManager, BuildDependenceManager buildDependenceManager) {
+ public DefaultBuild2Manager(Dao dao, BuildParamManager buildParamManager,
+ BuildDependenceManager buildDependenceManager, StorageManager storageManager) {
super(dao);
this.buildParamManager = buildParamManager;
this.buildDependenceManager = buildDependenceManager;
+ this.storageManager = storageManager;
}
@Sessional
@@ -109,6 +115,8 @@ public class DefaultBuild2Manager extends AbstractEntityManager<Build2> implemen
buildParamManager.save(param);
for (BuildDependence dependence: build.getDependencies())
buildDependenceManager.save(dependence);
+
+ FileUtils.deleteDir(storageManager.getBuildDir(build.getProject().getId(), build.getId()));
}
}
diff --git a/core/src/main/java/io/onedev/server/util/validation/PathSegmentValidator.java b/core/src/main/java/io/onedev/server/util/validation/PathSegmentValidator.java
new file mode 100644
index 0000000000..330d9a3e85
--- /dev/null
+++ b/core/src/main/java/io/onedev/server/util/validation/PathSegmentValidator.java
@@ -0,0 +1,40 @@
+package io.onedev.server.util.validation;
+
+import java.nio.file.Paths;
+
+import javax.validation.ConstraintValidator;
+import javax.validation.ConstraintValidatorContext;
+
+import io.onedev.server.util.validation.annotation.PathSegment;
+
+public class PathSegmentValidator implements ConstraintValidator<PathSegment, String> {
+
+ @Override
+ public void initialize(PathSegment constaintAnnotation) {
+ }
+
+ @Override
+ public boolean isValid(String value, ConstraintValidatorContext constraintContext) {
+ if (value == null)
+ return true;
+
+ String errorMessage = null;
+ if (value.contains("/") || value.contains("\\")) {
+ errorMessage = "Slash and back slash characters are not allowed";
+ } else {
+ try {
+ Paths.get(value);
+ } catch (Exception e) {
+ errorMessage = e.getMessage();
+ }
+ }
+
+ if (errorMessage != null) {
+ constraintContext.disableDefaultConstraintViolation();
+ constraintContext.buildConstraintViolationWithTemplate(errorMessage).addConstraintViolation();
+ return false;
+ }
+
+ return true;
+ }
+}
diff --git a/core/src/main/java/io/onedev/server/util/validation/annotation/PathSegment.java b/core/src/main/java/io/onedev/server/util/validation/annotation/PathSegment.java
new file mode 100644
index 0000000000..4d15282ab1
--- /dev/null
+++ b/core/src/main/java/io/onedev/server/util/validation/annotation/PathSegment.java
@@ -0,0 +1,26 @@
+package io.onedev.server.util.validation.annotation;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+import javax.validation.Constraint;
+import javax.validation.Payload;
+
+import io.onedev.server.util.validation.PathSegmentValidator;
+
+/**
+ * @author robin
+ */
+@Target({ElementType.METHOD, ElementType.FIELD, ElementType.ANNOTATION_TYPE})
+@Retention(RetentionPolicy.RUNTIME)
+@Constraint(validatedBy=PathSegmentValidator.class)
+public @interface PathSegment {
+
+ String message() default "Invalid path segment";
+
+ Class<?>[] groups() default {};
+
+ Class<? extends Payload>[] payload() default {};
+}