Skip to content

The Unified and Autonomous Development Platform

feat: Build steps tab to show status of each step with belonging logs

Robin Shen3544bef9010c
diff --git a/pom.xml b/pom.xml
index e583b1020c..ca1d6ee082 100644
--- a/pom.xml
+++ b/pom.xml
@@ -723,8 +723,8 @@
</repository>
</repositories>
<properties>
- <commons.version>4.2.3</commons.version>
- <agent.version>3.3.1</agent.version>
+ <commons.version>4.2.4</commons.version>
+ <agent.version>3.3.2</agent.version>
<slf4j.version>2.0.17</slf4j.version>
<logback.version>1.4.14</logback.version>
<antlr.version>4.13.2</antlr.version>
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 3c58e1aee1..b771599cfa 100644
--- a/server-core/src/main/java/io/onedev/server/CoreModule.java
+++ b/server-core/src/main/java/io/onedev/server/CoreModule.java
@@ -116,6 +116,8 @@ import io.onedev.server.job.DefaultJobService;
import io.onedev.server.job.JobService;
import io.onedev.server.logging.DefaultLogService;
import io.onedev.server.logging.LogService;
+import io.onedev.server.logging.build.BuildLogService;
+import io.onedev.server.logging.build.DefaultBuildLogService;
import io.onedev.server.mail.DefaultMailService;
import io.onedev.server.mail.MailService;
import io.onedev.server.markdown.DefaultMarkdownService;
@@ -513,6 +515,7 @@ public class CoreModule extends AbstractPluginModule {
bind(JobService.class).to(DefaultJobService.class);
bind(RunCacheService.class).to(DefaultRunCacheService.class);
bind(LogService.class).to(DefaultLogService.class);
+ bind(BuildLogService.class).to(DefaultBuildLogService.class);
bind(MailService.class).to(DefaultMailService.class);
bind(IssueService.class).to(DefaultIssueService.class);
bind(IssueFieldService.class).to(DefaultIssueFieldService.class);
diff --git a/server-core/src/main/java/io/onedev/server/agent/ServerSocket.java b/server-core/src/main/java/io/onedev/server/agent/ServerSocket.java
index 13b27498d5..f3174c0ad3 100644
--- a/server-core/src/main/java/io/onedev/server/agent/ServerSocket.java
+++ b/server-core/src/main/java/io/onedev/server/agent/ServerSocket.java
@@ -150,7 +150,7 @@ public class ServerSocket {
if (logger != null)
logger.log(logMessage, sessionId);
} catch (Exception e) {
- logger.error("Error processing job log", e);
+ logger.error("Error processing log", e);
}
break;
case REPORT_JOB_WORKDIR:
@@ -219,4 +219,4 @@ public class ServerSocket {
}
}
-}
\ No newline at end of file
+}
diff --git a/server-core/src/main/java/io/onedev/server/buildspec/BuildSpec.java b/server-core/src/main/java/io/onedev/server/buildspec/BuildSpec.java
index 578182a8fb..c58c4d63da 100644
--- a/server-core/src/main/java/io/onedev/server/buildspec/BuildSpec.java
+++ b/server-core/src/main/java/io/onedev/server/buildspec/BuildSpec.java
@@ -2822,4 +2822,24 @@ public class BuildSpec implements Serializable, Validatable {
}
}
+ @SuppressWarnings("unused")
+ private void migrate54(VersionedYamlDoc doc, Stack<Integer> versions) {
+ for (NodeTuple specTuple : doc.getValue()) {
+ if (((ScalarNode) specTuple.getKeyNode()).getValue().equals("jobs")) {
+ SequenceNode jobsNode = (SequenceNode) specTuple.getValueNode();
+ for (Node jobNodeItem : jobsNode.getValue()) {
+ MappingNode jobNode = (MappingNode) jobNodeItem;
+ for (NodeTuple jobTuple : jobNode.getValue()) {
+ ScalarNode keyNode = (ScalarNode) jobTuple.getKeyNode();
+ if (keyNode.getValue().equals("maxRetries")) {
+ keyNode.setValue("maxAttempts");
+ ScalarNode valueNode = (ScalarNode) jobTuple.getValueNode();
+ valueNode.setValue(String.valueOf(Integer.parseInt(valueNode.getValue()) + 1));
+ }
+ }
+ }
+ }
+ }
+ }
+
}
diff --git a/server-core/src/main/java/io/onedev/server/buildspec/job/Job.java b/server-core/src/main/java/io/onedev/server/buildspec/job/Job.java
index b180e60668..29b8eca9f4 100644
--- a/server-core/src/main/java/io/onedev/server/buildspec/job/Job.java
+++ b/server-core/src/main/java/io/onedev/server/buildspec/job/Job.java
@@ -107,7 +107,7 @@ public class Job implements NamedElement, Validatable {
private String retryCondition = "never";
- private int maxRetries = 3;
+ private int maxAttempts = 3;
private int retryDelay = 30;
@@ -283,15 +283,15 @@ public class Job implements NamedElement, Validatable {
this.retryCondition = retryCondition;
}
- @Editable(order=9410, group="More Settings", description="Maximum of retries before giving up")
- @Min(value=1, message="This value should not be less than 1")
+ @Editable(order=9410, group="More Settings", description="Maximum number of attempts including the initial run before giving up")
+ @Min(value=1, message="This value should not be less than 2")
@DependsOn(property="retryCondition", value = "never", inverse = true)
- public int getMaxRetries() {
- return maxRetries;
+ public int getMaxAttempts() {
+ return maxAttempts;
}
- public void setMaxRetries(int maxRetries) {
- this.maxRetries = maxRetries;
+ public void setMaxAttempts(int maxAttempts) {
+ this.maxAttempts = maxAttempts;
}
@Editable(order=9420, group="More Settings", description="Delay for the first retry in seconds. " +
diff --git a/server-core/src/main/java/io/onedev/server/buildspec/job/action/condition/LogCriteria.java b/server-core/src/main/java/io/onedev/server/buildspec/job/action/condition/LogCriteria.java
index 35506f831e..19e29bfef7 100644
--- a/server-core/src/main/java/io/onedev/server/buildspec/job/action/condition/LogCriteria.java
+++ b/server-core/src/main/java/io/onedev/server/buildspec/job/action/condition/LogCriteria.java
@@ -9,7 +9,7 @@ import jakarta.persistence.criteria.From;
import jakarta.persistence.criteria.Predicate;
import io.onedev.server.OneDev;
-import io.onedev.server.logging.LogService;
+import io.onedev.server.logging.build.BuildLogService;
import io.onedev.server.model.Build;
import io.onedev.server.util.ProjectScope;
import io.onedev.server.util.criteria.Criteria;
@@ -32,7 +32,7 @@ public class LogCriteria extends Criteria<Build> {
@Override
public boolean matches(Build build) {
Pattern pattern = Pattern.compile(value);
- return OneDev.getInstance(LogService.class).matches(build.getLoggingSupport(), pattern);
+ return OneDev.getInstance(BuildLogService.class).matches(build.getLogContext(), pattern);
}
@Override
diff --git a/server-core/src/main/java/io/onedev/server/buildspec/job/log/JobLogEntry.java b/server-core/src/main/java/io/onedev/server/buildspec/job/log/JobLogEntry.java
deleted file mode 100644
index d82716a936..0000000000
--- a/server-core/src/main/java/io/onedev/server/buildspec/job/log/JobLogEntry.java
+++ /dev/null
@@ -1,27 +0,0 @@
-package io.onedev.server.buildspec.job.log;
-
-import java.io.Serializable;
-import java.util.Date;
-
-public class JobLogEntry implements Serializable {
-
- private static final long serialVersionUID = 1L;
-
- private final Date date;
-
- private final String message;
-
- public JobLogEntry(Date date, String message) {
- this.date = date;
- this.message = message;
- }
-
- public Date getDate() {
- return date;
- }
-
- public String getMessage() {
- return message;
- }
-
-}
diff --git a/server-core/src/main/java/io/onedev/server/buildspec/job/retrycondition/LogCriteria.java b/server-core/src/main/java/io/onedev/server/buildspec/job/retrycondition/LogCriteria.java
index 0f4c71d12b..4b72867c8a 100644
--- a/server-core/src/main/java/io/onedev/server/buildspec/job/retrycondition/LogCriteria.java
+++ b/server-core/src/main/java/io/onedev/server/buildspec/job/retrycondition/LogCriteria.java
@@ -9,7 +9,7 @@ import jakarta.persistence.criteria.From;
import jakarta.persistence.criteria.Predicate;
import io.onedev.server.OneDev;
-import io.onedev.server.logging.LogService;
+import io.onedev.server.logging.build.BuildLogService;
import io.onedev.server.model.Build;
import io.onedev.server.util.ProjectScope;
import io.onedev.server.util.criteria.Criteria;
@@ -33,7 +33,7 @@ public class LogCriteria extends Criteria<RetryContext> {
public boolean matches(RetryContext context) {
Pattern pattern = Pattern.compile(value);
return context.getErrorMessage() != null && pattern.matcher(context.getErrorMessage()).find()
- || OneDev.getInstance(LogService.class).matches(context.getBuild().getLoggingSupport(), pattern);
+ || OneDev.getInstance(BuildLogService.class).matches(context.getBuild().getLogContext(), pattern);
}
@Override
diff --git a/server-core/src/main/java/io/onedev/server/commandhandler/Translate.java b/server-core/src/main/java/io/onedev/server/commandhandler/Translate.java
index cf88722529..6d37dd8966 100644
--- a/server-core/src/main/java/io/onedev/server/commandhandler/Translate.java
+++ b/server-core/src/main/java/io/onedev/server/commandhandler/Translate.java
@@ -126,112 +126,118 @@ public class Translate extends CommandHandler {
Set<String> scannedTranslationKeys = new TreeSet<>();
- Files.walk(projectDir.toPath())
- .filter(it -> it.toString().endsWith(".class"))
- .forEach(it -> {
- var classPath = it;
- String relative = null;
- var parentPath = classPath.getParent();
- while (!parentPath.equals(projectDir.toPath())) {
- if (parentPath.getFileName().toString().equals("classes")) {
- relative = parentPath.relativize(classPath).toString();
- break;
+ try (var paths = Files.walk(projectDir.toPath())) {
+ paths
+ .filter(it -> it.toString().endsWith(".class"))
+ .forEach(it -> {
+ var classPath = it;
+ String relative = null;
+ var parentPath = classPath.getParent();
+ while (!parentPath.equals(projectDir.toPath())) {
+ if (parentPath.getFileName().toString().equals("classes")) {
+ relative = parentPath.relativize(classPath).toString();
+ break;
+ }
+ parentPath = parentPath.getParent();
}
- parentPath = parentPath.getParent();
- }
- if (relative != null && relative.startsWith("io/onedev/server/")) {
- var className = StringUtils.substringBeforeLast(relative, ".").replace("/", ".");
- if (!className.endsWith("Panel") && !className.endsWith("Page")
- && !className.endsWith("Behavior")) {
- try {
- var clazz = Class.forName(className);
- var editable = clazz.getAnnotation(Editable.class);
- if (editable != null) {
- scannedTranslationKeys.add(EditableUtils.getDisplayName(clazz));
- var group = EditableUtils.getGroup(clazz);
- if (group != null)
- scannedTranslationKeys.add(group);
- var description = editable.description();
- if (description.length() != 0) {
- scannedTranslationKeys.add(description);
- }
- }
- for (var method : clazz.getDeclaredMethods()) {
- editable = method.getAnnotation(Editable.class);
+ if (relative != null && relative.startsWith("io/onedev/server/")) {
+ var className = StringUtils.substringBeforeLast(relative, ".").replace("/", ".");
+ if (!className.endsWith("Panel") && !className.endsWith("Page")
+ && !className.endsWith("Behavior")) {
+ try {
+ var clazz = Class.forName(className);
+ var editable = clazz.getAnnotation(Editable.class);
if (editable != null) {
- scannedTranslationKeys.add(EditableUtils.getDisplayName(method));
- var group = EditableUtils.getGroup(method);
+ scannedTranslationKeys.add(EditableUtils.getDisplayName(clazz));
+ var group = EditableUtils.getGroup(clazz);
if (group != null)
scannedTranslationKeys.add(group);
var description = editable.description();
if (description.length() != 0) {
scannedTranslationKeys.add(description);
}
- var placeholder = editable.placeholder();
- if (placeholder.length() != 0) {
- scannedTranslationKeys.add(placeholder);
+ }
+ for (var method : clazz.getDeclaredMethods()) {
+ editable = method.getAnnotation(Editable.class);
+ if (editable != null) {
+ scannedTranslationKeys.add(EditableUtils.getDisplayName(method));
+ var group = EditableUtils.getGroup(method);
+ if (group != null)
+ scannedTranslationKeys.add(group);
+ var description = editable.description();
+ if (description.length() != 0) {
+ scannedTranslationKeys.add(description);
+ }
+ var placeholder = editable.placeholder();
+ if (placeholder.length() != 0) {
+ scannedTranslationKeys.add(placeholder);
+ }
+ var rootPlaceholder = editable.rootPlaceholder();
+ if (rootPlaceholder.length() != 0) {
+ scannedTranslationKeys.add(rootPlaceholder);
+ }
}
- var rootPlaceholder = editable.rootPlaceholder();
- if (rootPlaceholder.length() != 0) {
- scannedTranslationKeys.add(rootPlaceholder);
+ var notEmpty = method.getAnnotation(NotEmpty.class);
+ if (notEmpty != null && notEmpty.message().length() != 0) {
+ scannedTranslationKeys.add(notEmpty.message());
+ }
+ var notNull = method.getAnnotation(NotNull.class);
+ if (notNull != null && notNull.message().length() != 0) {
+ scannedTranslationKeys.add(notNull.message());
+ }
+ var size = method.getAnnotation(Size.class);
+ if (size != null && size.message().length() != 0) {
+ scannedTranslationKeys.add(size.message());
+ }
+ var metricIndicator = method.getAnnotation(MetricIndicator.class);
+ if (metricIndicator != null) {
+ if (metricIndicator.name().length() != 0)
+ scannedTranslationKeys.add(metricIndicator.name());
+ if (metricIndicator.group().length() != 0)
+ scannedTranslationKeys.add(metricIndicator.group());
}
}
- var notEmpty = method.getAnnotation(NotEmpty.class);
- if (notEmpty != null && notEmpty.message().length() != 0) {
- scannedTranslationKeys.add(notEmpty.message());
- }
- var notNull = method.getAnnotation(NotNull.class);
- if (notNull != null && notNull.message().length() != 0) {
- scannedTranslationKeys.add(notNull.message());
- }
- var size = method.getAnnotation(Size.class);
- if (size != null && size.message().length() != 0) {
- scannedTranslationKeys.add(size.message());
- }
- var metricIndicator = method.getAnnotation(MetricIndicator.class);
- if (metricIndicator != null) {
- if (metricIndicator.name().length() != 0)
- scannedTranslationKeys.add(metricIndicator.name());
- if (metricIndicator.group().length() != 0)
- scannedTranslationKeys.add(metricIndicator.group());
- }
- }
- if (clazz.isEnum()) {
- for (var constant : clazz.getEnumConstants()) {
- scannedTranslationKeys.add(TextUtils.getDisplayValue((Enum<?>) constant));
+ if (clazz.isEnum()) {
+ for (var constant : clazz.getEnumConstants()) {
+ scannedTranslationKeys.add(TextUtils.getDisplayValue((Enum<?>) constant));
+ }
}
+ } catch (ClassNotFoundException e) {
+ throw new RuntimeException(e);
}
- } catch (ClassNotFoundException e) {
- throw new RuntimeException(e);
}
}
- }
- });
-
- Files.walk(projectDir.toPath())
- .filter(it -> it.toString().contains("src/main/java/io/onedev/server"))
- .filter(it -> it.toString().endsWith(".java"))
- .forEach(it -> {
- try {
- scannedTranslationKeys.addAll(scanJavaMethods(Files.readString(it)));
- } catch (IOException e) {
- throw new RuntimeException(e);
- }
- });
-
- Files.walk(projectDir.toPath())
- .filter(it -> it.toString().contains("src/main/java/io/onedev/server"))
- .filter(it -> it.toString().endsWith(".html"))
- .forEach(it -> {
- try {
- var content = Files.readString(it);
- scannedTranslationKeys.addAll(scanHtmlTags(content));
- scannedTranslationKeys.addAll(scanHtmlAttributes(content));
- } catch (IOException e) {
- throw new RuntimeException(e);
- }
- });
+ });
+ }
+
+ try (var paths = Files.walk(projectDir.toPath())) {
+ paths
+ .filter(it -> it.toString().contains("src/main/java/io/onedev/server"))
+ .filter(it -> it.toString().endsWith(".java"))
+ .forEach(it -> {
+ try {
+ scannedTranslationKeys.addAll(scanJavaMethods(Files.readString(it)));
+ } catch (IOException e) {
+ throw new RuntimeException(e);
+ }
+ });
+ }
+
+ try (var paths = Files.walk(projectDir.toPath())) {
+ paths
+ .filter(it -> it.toString().contains("src/main/java/io/onedev/server"))
+ .filter(it -> it.toString().endsWith(".html"))
+ .forEach(it -> {
+ try {
+ var content = Files.readString(it);
+ scannedTranslationKeys.addAll(scanHtmlTags(content));
+ scannedTranslationKeys.addAll(scanHtmlAttributes(content));
+ } catch (IOException e) {
+ throw new RuntimeException(e);
+ }
+ });
+ }
var model = OpenAiChatModel.builder()
.apiKey(apiKey)
diff --git a/server-core/src/main/java/io/onedev/server/data/migration/DataMigrator.java b/server-core/src/main/java/io/onedev/server/data/migration/DataMigrator.java
index 5b3b203742..2c46f9afd9 100644
--- a/server-core/src/main/java/io/onedev/server/data/migration/DataMigrator.java
+++ b/server-core/src/main/java/io/onedev/server/data/migration/DataMigrator.java
@@ -9499,4 +9499,17 @@ public class DataMigrator {
counters.writeToFile(new File(dataDir, "EntityIdCounters.xml"), false);
}
+ private void migrate246(File dataDir, Stack<Integer> versions) {
+ for (File file : dataDir.listFiles()) {
+ if (file.getName().startsWith("Builds.xml")) {
+ var dom = VersionedXmlDoc.fromFile(file);
+ for (Element element : dom.getRootElement().elements()) {
+ element.addElement("finalization").setText("false");
+ element.addElement("stepExecutions");
+ }
+ dom.writeToFile(file, false);
+ }
+ }
+ }
+
}
diff --git a/server-core/src/main/java/io/onedev/server/git/LfsObject.java b/server-core/src/main/java/io/onedev/server/git/LfsObject.java
index 1cb4692120..7069f4f984 100644
--- a/server-core/src/main/java/io/onedev/server/git/LfsObject.java
+++ b/server-core/src/main/java/io/onedev/server/git/LfsObject.java
@@ -114,8 +114,11 @@ public class LfsObject implements Serializable {
@Override
public void close() throws IOException {
- super.close();
- readLock.unlock();
+ try {
+ super.close();
+ } finally {
+ readLock.unlock();
+ }
}
};
@@ -137,8 +140,11 @@ public class LfsObject implements Serializable {
@Override
public void close() throws IOException {
- super.close();
- writeLock.unlock();
+ try {
+ super.close();
+ } finally {
+ writeLock.unlock();
+ }
}
};
diff --git a/server-core/src/main/java/io/onedev/server/job/DefaultJobService.java b/server-core/src/main/java/io/onedev/server/job/DefaultJobService.java
index 9c9732425b..40f80155ca 100644
--- a/server-core/src/main/java/io/onedev/server/job/DefaultJobService.java
+++ b/server-core/src/main/java/io/onedev/server/job/DefaultJobService.java
@@ -34,19 +34,6 @@ import java.util.concurrent.TimeoutException;
import java.util.concurrent.atomic.AtomicReference;
import java.util.concurrent.locks.Lock;
-import jakarta.inject.Inject;
-import jakarta.inject.Singleton;
-import jakarta.servlet.http.HttpServletRequest;
-import jakarta.validation.ConstraintViolation;
-import jakarta.validation.ValidationException;
-import jakarta.validation.Validator;
-import jakarta.ws.rs.client.Client;
-import jakarta.ws.rs.client.ClientBuilder;
-import jakarta.ws.rs.client.Invocation;
-import jakarta.ws.rs.client.WebTarget;
-import jakarta.ws.rs.core.HttpHeaders;
-import jakarta.ws.rs.core.Response;
-
import org.apache.shiro.subject.Subject;
import org.eclipse.jgit.lib.ObjectId;
import org.joda.time.DateTime;
@@ -61,6 +48,7 @@ import com.google.common.base.Throwables;
import com.google.common.collect.Lists;
import com.hazelcast.map.IMap;
+import io.onedev.agent.job.JobUtils;
import io.onedev.commons.loader.ManagedSerializedForm;
import io.onedev.commons.utils.ExceptionUtils;
import io.onedev.commons.utils.ExplicitException;
@@ -122,8 +110,8 @@ import io.onedev.server.exception.ServerNotFoundException;
import io.onedev.server.git.GitUtils;
import io.onedev.server.git.service.GitService;
import io.onedev.server.job.match.JobMatchContext;
-import io.onedev.server.logging.LogService;
import io.onedev.server.logging.ServerLogger;
+import io.onedev.server.logging.build.BuildLogService;
import io.onedev.server.model.Build;
import io.onedev.server.model.Build.Status;
import io.onedev.server.model.BuildDependence;
@@ -134,6 +122,7 @@ import io.onedev.server.model.PullRequest;
import io.onedev.server.model.User;
import io.onedev.server.model.support.administration.DockerAware;
import io.onedev.server.model.support.administration.jobexecutor.JobExecutor;
+import io.onedev.server.model.support.build.StepExecution;
import io.onedev.server.persistence.SessionService;
import io.onedev.server.persistence.TransactionService;
import io.onedev.server.persistence.annotation.Sessional;
@@ -161,6 +150,18 @@ import io.onedev.server.util.interpolative.JobVariableInterpolator;
import io.onedev.server.util.patternset.PatternSet;
import io.onedev.server.web.editable.EditableStringTransformer;
import io.onedev.server.web.editable.EditableUtils;
+import jakarta.inject.Inject;
+import jakarta.inject.Singleton;
+import jakarta.servlet.http.HttpServletRequest;
+import jakarta.validation.ConstraintViolation;
+import jakarta.validation.ValidationException;
+import jakarta.validation.Validator;
+import jakarta.ws.rs.client.Client;
+import jakarta.ws.rs.client.ClientBuilder;
+import jakarta.ws.rs.client.Invocation;
+import jakarta.ws.rs.client.WebTarget;
+import jakarta.ws.rs.core.HttpHeaders;
+import jakarta.ws.rs.core.Response;
import nl.altindag.ssl.SSLFactory;
@Singleton
@@ -211,7 +212,7 @@ public class DefaultJobService implements JobService, Runnable, CodePullAuthoriz
private SessionService sessionService;
@Inject
- private LogService logService;
+ private BuildLogService buildLogService;
@Inject
private UserService userService;
@@ -557,11 +558,23 @@ public class DefaultJobService implements JobService, Runnable, CodePullAuthoriz
}
}
+ private void resetLog(Build build) {
+ buildLogService.clear(build.getLogContext());
+ resetStepExecutions(build);
+ }
+
+ private void resetStepExecutions(Build build) {
+ build.getStepExecutions().clear();
+ build.setFinalization(false);
+ }
+
private Future<Boolean> execute(Build build) {
+ // Recovery after a server restart can reuse a build with already-flushed stage logs.
+ resetLog(build);
String jobToken = build.getToken();
JobVariableInterpolator interpolator = new JobVariableInterpolator(build, build.getParamCombination());
- TaskLogger jobLogger = logService.newLogger(build.getLoggingSupport());
+ TaskLogger jobLogger = buildLogService.newLogger(build);
String jobExecutorName = interpolator.interpolate(build.getJob().getJobExecutor());
JobExecutor jobExecutor = interpolator.interpolateProperties(getJobExecutor(build, jobExecutorName, jobLogger));
String sequentialGroup = interpolator.interpolate(build.getJob().getSequentialGroup());
@@ -613,6 +626,9 @@ public class DefaultJobService implements JobService, Runnable, CodePullAuthoriz
return executorService.submit(() -> {
int retried = 0;
while (true) {
+ jobLogger.log(JobUtils.buildPhaseMessage(JobHelper.INITIALIZATION));
+ if (retried > 0)
+ jobLogger.notice(String.format("Retrying job (attempt %d of %d)...", retried + 1, job.getMaxAttempts()));
if (sequentialKey != null) {
jobLogger.log("Locking sequential group...");
while (true) {
@@ -625,7 +641,7 @@ public class DefaultJobService implements JobService, Runnable, CodePullAuthoriz
// Store original job actions as the copy in job context will be fetched from cluster and
// some transient fields (such as step object in ServerSideFacade) will not be preserved
jobActions.put(jobToken, actions);
- logService.addLogger(jobToken, jobLogger);
+ buildLogService.addLogger(jobToken, jobLogger);
serverStepThreads.put(jobToken, new ArrayList<>());
Throwable throwable = null;
try {
@@ -671,7 +687,7 @@ public class DefaultJobService implements JobService, Runnable, CodePullAuthoriz
for (Thread thread : threads)
thread.interrupt();
}
- logService.removeLogger(jobToken);
+ buildLogService.removeLogger(jobToken);
jobActions.remove(jobToken);
if (sequentialKey != null)
@@ -693,7 +709,7 @@ public class DefaultJobService implements JobService, Runnable, CodePullAuthoriz
private boolean checkRetry(Job job, JobContext jobContext, TaskLogger jobLogger,
@Nullable Throwable throwable, int retried) {
- if (retried < job.getMaxRetries() && sessionService.call(() -> {
+ if (retried + 1 < job.getMaxAttempts() && sessionService.call(() -> {
RetryCondition retryCondition = RetryCondition.parse(job, job.getRetryCondition());
AtomicReference<String> errorMessage = new AtomicReference<>(null);
if (throwable != null) {
@@ -719,6 +735,7 @@ public class DefaultJobService implements JobService, Runnable, CodePullAuthoriz
}
transactionService.run(() -> {
Build innerBuild = buildService.load(jobContext.getBuildId());
+ buildLogService.clear(innerBuild.getLogContext());
innerBuild.setRunningDate(null);
innerBuild.setPendingDate(new Date());
innerBuild.setRetryDate(new Date());
@@ -762,7 +779,7 @@ public class DefaultJobService implements JobService, Runnable, CodePullAuthoriz
private void markBuildError(Build build, String errorMessage) {
build.setStatus(Build.Status.FAILED);
- logService.newLogger(build.getLoggingSupport()).error(errorMessage);
+ buildLogService.newLogger(build).error(errorMessage);
build.setFinishDate(new Date());
buildService.update(build);
listenerRegistry.post(new BuildFinished(build));
@@ -906,6 +923,7 @@ public class DefaultJobService implements JobService, Runnable, CodePullAuthoriz
build.setCanceller(null);
build.setAgent(null);
build.getCheckoutPaths().clear();
+ resetStepExecutions(build);
buildService.update(build);
buildSubmitted(build);
@@ -1058,7 +1076,7 @@ public class DefaultJobService implements JobService, Runnable, CodePullAuthoriz
var projectId = build.getProject().getId();
var buildId = build.getId();
var userId = User.idOf(SecurityUtils.getUser());
- projectService.runOnActiveServer(projectId, () -> {
+ projectService.submitToActiveServer(projectId, () -> {
var future = jobFutures.get(buildId);
if (future != null) {
future.cancel(true);
@@ -1345,7 +1363,7 @@ public class DefaultJobService implements JobService, Runnable, CodePullAuthoriz
future.cancel(true);
} else if (future.isDone()) {
it.remove();
- var jobLogger = logService.newLogger(build.getLoggingSupport());
+ var jobLogger = buildLogService.newLogger(build);
try {
if (future.get())
build.setStatus(Status.SUCCESSFUL);
@@ -1385,6 +1403,14 @@ public class DefaultJobService implements JobService, Runnable, CodePullAuthoriz
@Listen
public void on(BuildFinished event) {
Build build = event.getBuild();
+
+ var stepExecutionStatus = build.getStatus() == Build.Status.CANCELLED
+ ? StepExecution.Status.CANCELLED
+ : build.isSuccessful() ? StepExecution.Status.SUCCESSFUL
+ : StepExecution.Status.FAILED;
+ build.getStepExecutions().values().forEach(stepExecution -> stepExecution.complete(stepExecutionStatus));
+ buildLogService.finish(build);
+
JobAuthorizationContext.push(build.getJobAuthorizationContext());
Build.push(build);
try {
@@ -1458,18 +1484,18 @@ public class DefaultJobService implements JobService, Runnable, CodePullAuthoriz
jobContexts.put(jobToken, jobContext);
jobRunnables.put(jobToken, runnable);
try {
- TaskLogger jobLogger = logService.getLogger(jobToken);
- if (jobLogger == null) {
+ TaskLogger jobLogger = buildLogService.getLogger(jobToken);
+ boolean forwarding = jobLogger == null;
+ if (forwarding) {
var activeServer = projectService.getActiveServer(jobContext.getProjectId(), true);
jobLogger = new ServerLogger(activeServer, jobContext.getJobToken());
- logService.addLogger(jobToken, jobLogger);
- try {
- return runnable.run(jobLogger);
- } finally {
- logService.removeLogger(jobToken);
- }
- } else {
+ buildLogService.addLogger(jobToken, jobLogger);
+ }
+ try {
return runnable.run(jobLogger);
+ } finally {
+ if (forwarding)
+ buildLogService.removeLogger(jobToken);
}
} finally {
jobRunnables.remove(jobToken);
diff --git a/server-core/src/main/java/io/onedev/server/logging/BuildLoggingIdentity.java b/server-core/src/main/java/io/onedev/server/logging/BuildLoggingIdentity.java
deleted file mode 100644
index eebe32ed38..0000000000
--- a/server-core/src/main/java/io/onedev/server/logging/BuildLoggingIdentity.java
+++ /dev/null
@@ -1,43 +0,0 @@
-package io.onedev.server.logging;
-
-import java.io.File;
-
-import io.onedev.server.model.Build;
-
-public class BuildLoggingIdentity implements LoggingIdentity {
-
- private static final long serialVersionUID = 1L;
-
- private final Long projectId;
-
- private final Long buildNumber;
-
- public BuildLoggingIdentity(Long projectId, Long buildNumber) {
- this.projectId = projectId;
- this.buildNumber = buildNumber;
- }
-
- public Long getProjectId() {
- return projectId;
- }
-
- public Long getBuildNumber() {
- return buildNumber;
- }
-
- @Override
- public File getFile() {
- return Build.getLogFile(projectId, buildNumber);
- }
-
- @Override
- public String getLockName() {
- return Build.getLogLockName(projectId, buildNumber);
- }
-
- @Override
- public String getCacheKey() {
- return "build-log:" + projectId + ":" + buildNumber;
- }
-
-}
\ No newline at end of file
diff --git a/server-core/src/main/java/io/onedev/server/logging/DefaultLogService.java b/server-core/src/main/java/io/onedev/server/logging/DefaultLogService.java
index 92f2d3dbd2..6ee6c5b0be 100644
--- a/server-core/src/main/java/io/onedev/server/logging/DefaultLogService.java
+++ b/server-core/src/main/java/io/onedev/server/logging/DefaultLogService.java
@@ -1,15 +1,14 @@
package io.onedev.server.logging;
-import static io.onedev.commons.utils.LockUtils.getReadWriteLock;
import static io.onedev.commons.utils.LockUtils.read;
import static io.onedev.commons.utils.LockUtils.write;
+import static io.onedev.server.logging.LogEntryReader.newInputStream;
+import static io.onedev.server.logging.LogEntryReader.readLogEntry;
import static io.onedev.server.util.IOUtils.BUFFER_SIZE;
-import java.io.BufferedInputStream;
import java.io.BufferedOutputStream;
import java.io.EOFException;
import java.io.File;
-import java.io.FileInputStream;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStream;
@@ -17,42 +16,38 @@ import java.io.ObjectInputStream;
import java.io.ObjectOutputStream;
import java.io.ObjectStreamException;
import java.io.Serializable;
-import java.nio.charset.StandardCharsets;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.concurrent.ConcurrentHashMap;
-import java.util.concurrent.atomic.AtomicReference;
-import java.util.concurrent.locks.Lock;
import java.util.concurrent.locks.ReadWriteLock;
import java.util.concurrent.locks.ReentrantReadWriteLock;
import java.util.regex.Pattern;
-
-import jakarta.inject.Inject;
-import jakarta.inject.Singleton;
-
+import java.util.function.BooleanSupplier;
import org.antlr.v4.runtime.tree.TerminalNode;
+import org.apache.commons.lang3.StringUtils;
import org.apache.commons.lang3.Strings;
+
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import io.onedev.commons.loader.ManagedSerializedForm;
-import io.onedev.commons.utils.ExceptionUtils;
+import io.onedev.commons.utils.FileUtils;
import io.onedev.commons.utils.TaskLogger;
-import io.onedev.server.OneDev;
-import io.onedev.server.buildspec.job.log.JobLogEntry;
-import io.onedev.server.buildspec.job.log.JobLogEntryEx;
-import io.onedev.server.buildspec.job.log.instruction.LogInstruction;
-import io.onedev.server.buildspec.job.log.instruction.LogInstructionParser.InstructionContext;
-import io.onedev.server.buildspec.job.log.instruction.LogInstructionParser.ParamContext;
import io.onedev.server.buildspecmodel.inputspec.SecretInput;
import io.onedev.server.cluster.ClusterService;
import io.onedev.server.cluster.ClusterTask;
+import io.onedev.server.logging.instruction.LogInstruction;
+import io.onedev.server.logging.instruction.LogInstructionParser.InstructionContext;
+import io.onedev.server.logging.instruction.LogInstructionParser.ParamContext;
import io.onedev.server.model.Project;
import io.onedev.server.persistence.SessionService;
import io.onedev.server.persistence.TransactionService;
+import io.onedev.server.util.IOUtils;
import io.onedev.server.web.websocket.WebSocketService;
+import jakarta.inject.Inject;
+import jakarta.inject.Singleton;
@Singleton
public class DefaultLogService implements LogService, Serializable {
@@ -62,6 +57,8 @@ public class DefaultLogService implements LogService, Serializable {
private static final int MIN_CACHE_ENTRIES = 5000;
private static final int MAX_CACHE_ENTRIES = 10000;
+
+ private static final int MAX_ENTRY_LENGTH = 4096;
@Inject
private WebSocketService webSocketService;
@@ -71,8 +68,11 @@ public class DefaultLogService implements LogService, Serializable {
@Inject
private TransactionService transactionService;
+
+ @Inject
+ private SessionService sessionService;
- private final Map<String, LogSnippet> recentSnippets = new ConcurrentHashMap<>();
+ private final Map<File, LogSnippet> recentSnippets = new ConcurrentHashMap<>();
private final Map<String, TaskLogger> loggers = new ConcurrentHashMap<>();
@@ -84,14 +84,14 @@ public class DefaultLogService implements LogService, Serializable {
return new ManagedSerializedForm(LogService.class);
}
- private void notifyListeners(LoggingSupport loggingSupport) {
+ private void notifyListeners(LoggingSupport support) {
clusterService.submitToAllServers(() -> {
try {
var lock = logListenersLock.readLock();
lock.lock();
try {
for (var logListener: logListeners)
- logListener.logged(loggingSupport);
+ logListener.logged(support);
} finally {
lock.unlock();
}
@@ -104,57 +104,57 @@ public class DefaultLogService implements LogService, Serializable {
@Override
public TaskLogger newLogger(LoggingSupport loggingSupport) {
+ return newLogger(loggingSupport, () -> true);
+ }
+
+ @Override
+ public TaskLogger newLogger(LoggingSupport loggingSupport, BooleanSupplier acceptingEntries) {
return new TaskLogger() {
private final Map<String, StyleBuilder> styleBuilders = new ConcurrentHashMap<>();
private void doLog(String message, StyleBuilder styleBuilder) {
message = Project.decodeFullRepoNameAsPath(message);
- for (String maskSecret: loggingSupport.getMaskSecrets())
- message = Strings.CS.replace(message, maskSecret, SecretInput.MASK);
-
- String maskedMessage = message;
- write(loggingSupport.getIdentity().getLockName(), () -> {
- String logKey = loggingSupport.getIdentity().getCacheKey();
- LogSnippet snippet = recentSnippets.get(logKey);
+ for (String secret : loggingSupport.getMaskSecrets())
+ message = Strings.CS.replace(message, secret, SecretInput.MASK);
+ // Mask first so truncation cannot expose part of a secret at the boundary.
+ var maskedMessage = StringUtils.abbreviate(message, MAX_ENTRY_LENGTH);
+ var appended = write(loggingSupport.getIdentity().getLockName(), () -> {
+ if (!acceptingEntries.getAsBoolean())
+ return false;
+ var file = loggingSupport.getIdentity().getFile();
+ var snippet = recentSnippets.get(file);
if (snippet == null) {
- File logFile = loggingSupport.getIdentity().getFile();
- if (!logFile.exists() || logFile.length() == 0) {
- snippet = new LogSnippet();
- recentSnippets.put(logKey, snippet);
- }
+ // Ignore late messages after the log has been flushed.
+ if (file.length() != 0)
+ return false;
+ snippet = new LogSnippet();
+ recentSnippets.put(file, snippet);
}
- if (snippet != null) {
- boolean entryAdded = false;
- try {
- snippet.entries.add(JobLogEntryEx.parse(maskedMessage, styleBuilder));
- entryAdded = true;
- } catch (Exception e) {
- logger.error("Failed to parse log message: " + maskedMessage, e);
- }
- if (entryAdded) {
- if (snippet.entries.size() > MAX_CACHE_ENTRIES) {
- File logFile = loggingSupport.getIdentity().getFile();
- try (ObjectOutputStream oos = newOutputStream(logFile)) {
- while (snippet.entries.size() > MIN_CACHE_ENTRIES) {
- writeLogEntry(oos, snippet.entries.remove(0));
- snippet.offset++;
- }
- } catch (IOException e) {
- throw new RuntimeException(e);
- }
+ snippet.entries.add(LogEntry.parse(maskedMessage, styleBuilder));
+ if (snippet.entries.size() > MAX_CACHE_ENTRIES) {
+ try (ObjectOutputStream oos = newOutputStream(file)) {
+ while (snippet.entries.size() > MIN_CACHE_ENTRIES) {
+ oos.writeObject(snippet.entries.remove(0));
+ snippet.offset++;
}
- webSocketService.notifyObservableChange(loggingSupport.getChangeObservable(), null);
- notifyListeners(loggingSupport);
+ } catch (IOException e) {
+ throw new RuntimeException(e);
}
}
- return null;
+ return true;
});
+ if (appended)
+ notifyLogged(loggingSupport);
}
@Override
public void log(String message, String sessionId) {
+ if (!acceptingEntries.getAsBoolean())
+ return;
try {
+ if (executeInstruction(loggingSupport, message))
+ return;
StyleBuilder styleBuilder;
if (sessionId != null) {
styleBuilder = styleBuilders.get(sessionId);
@@ -172,33 +172,7 @@ public class DefaultLogService implements LogService, Serializable {
InstructionContext instructionContext = LogInstruction.parse(normalizedMessage);
String name = instructionContext.Identifier().getText();
- AtomicReference<LogInstruction> instructionRef = new AtomicReference<>(null);
- for (LogInstruction instruction: loggingSupport.getInstructions()) {
- if (instruction.getName().equals(name)) {
- instructionRef.set(instruction);
- break;
- }
- }
-
- if (instructionRef.get() != null) {
- Map<String, List<String>> params = new HashMap<>();
- for (ParamContext paramContext: instructionContext.param()) {
- String paramName;
- if (paramContext.Identifier() != null)
- paramName = paramContext.Identifier().getText();
- else
- paramName = "";
- List<String> paramValues = new ArrayList<>();
- for (TerminalNode terminalNode: paramContext.Value())
- paramValues.add(LogInstruction.getValue(terminalNode));
- params.put(paramName, paramValues);
- }
- OneDev.getInstance(SessionService.class).run(() -> {
- instructionRef.get().execute(params);
- });
- } else {
- doLog("Unsupported log instruction: " + name, new StyleBuilder());
- }
+ doLog("Unsupported log instruction: " + name, new StyleBuilder());
} else {
doLog(message, styleBuilder);
}
@@ -213,27 +187,61 @@ public class DefaultLogService implements LogService, Serializable {
};
}
+ private void notifyLogged(LoggingSupport support) {
+ webSocketService.notifyObservableChange(support.getChangeObservable(), null);
+ notifyListeners(support);
+ }
+
+ private boolean executeInstruction(LoggingSupport support, String message) {
+ if (!message.contains(LogInstruction.PREFIX))
+ return false;
+ var normalized = message.replaceAll("\u001B\\[[;\\d]*m", "");
+ if (!normalized.startsWith(LogInstruction.PREFIX))
+ return false;
+ try {
+ var context = LogInstruction.parse(normalized);
+ var name = context.Identifier().getText();
+ for (var instruction : support.getInstructions()) {
+ if (instruction.getName().equals(name)) {
+ Map<String, List<String>> params = new HashMap<>();
+ for (ParamContext param : context.param()) {
+ var paramName = param.Identifier() != null ? param.Identifier().getText() : "";
+ List<String> values = new ArrayList<>();
+ for (TerminalNode value : param.Value())
+ values.add(LogInstruction.getValue(value));
+ params.put(paramName, values);
+ }
+ sessionService.run(() -> instruction.execute(params));
+ return true;
+ }
+ }
+ return false;
+ } catch (Exception e) {
+ logger.error("Error logging", e);
+ return true;
+ }
+ }
+
@Override
public boolean matches(LoggingSupport loggingSupport, Pattern pattern) {
- String key = loggingSupport.getIdentity().getCacheKey();
+ File logFile = loggingSupport.getIdentity().getFile();
+ var effectiveDate = loggingSupport.getEffectiveDate();
return read(loggingSupport.getIdentity().getLockName(), () -> {
- LogSnippet snippet = recentSnippets.get(key);
+ LogSnippet snippet = recentSnippets.get(logFile);
if (snippet != null) {
- for (JobLogEntryEx entry: snippet.entries) {
- if ((loggingSupport.getEffectiveDate() == null || !entry.getDate().before(loggingSupport.getEffectiveDate()))
+ for (LogEntry entry: snippet.entries) {
+ if ((effectiveDate == null || !entry.getDate().before(effectiveDate))
&& pattern.matcher(entry.getMessageText()).find()) {
return true;
}
}
}
-
- File logFile = loggingSupport.getIdentity().getFile();
-
+
if (logFile.exists() && logFile.length() != 0) {
- try (ObjectInputStream ois = new ObjectInputStream(new BufferedInputStream(new FileInputStream(logFile)))) {
+ try (ObjectInputStream ois = newInputStream(logFile)) {
while (true) {
- JobLogEntryEx entry = readLogEntry(ois);
- if ((loggingSupport.getEffectiveDate() == null || !entry.getDate().before(loggingSupport.getEffectiveDate()))
+ LogEntry entry = readLogEntry(ois);
+ if ((effectiveDate == null || !entry.getDate().before(effectiveDate))
&& pattern.matcher(entry.getMessageText()).find()) {
return true;
}
@@ -247,10 +255,10 @@ public class DefaultLogService implements LogService, Serializable {
});
}
- private List<JobLogEntryEx> readLogEntries(File logFile, int from, int count) {
- List<JobLogEntryEx> entries = new ArrayList<>();
+ private List<LogEntry> readLogEntries(File logFile, int from, int count) {
+ List<LogEntry> entries = new ArrayList<>();
if (logFile.exists() && logFile.length() != 0) {
- try (ObjectInputStream ois = new ObjectInputStream(new BufferedInputStream(new FileInputStream(logFile)))) {
+ try (ObjectInputStream ois = newInputStream(logFile)) {
int numOfReadEntries = 0;
while (numOfReadEntries < from) {
ois.readObject();
@@ -268,26 +276,10 @@ public class DefaultLogService implements LogService, Serializable {
return entries;
}
- private JobLogEntryEx readLogEntry(ObjectInputStream ois) throws ClassNotFoundException, IOException {
- Object obj = ois.readObject();
- if (obj instanceof JobLogEntry)
- return new JobLogEntryEx((JobLogEntry) obj);
- else
- return (JobLogEntryEx) obj;
- }
-
- private void writeLogEntry(ObjectOutputStream oos, JobLogEntryEx logEntry) throws IOException {
- JobLogEntry spaceEfficientVersion = logEntry.getSpaceEfficientVersion();
- if (spaceEfficientVersion != null)
- oos.writeObject(spaceEfficientVersion);
- else
- oos.writeObject(logEntry);
- }
-
private LogSnippet readLogSnippetReversely(File logFile, int count) {
var snippet = new LogSnippet();
if (logFile.exists() && logFile.length() != 0) {
- try (ObjectInputStream ois = new ObjectInputStream(new BufferedInputStream(new FileInputStream(logFile)))) {
+ try (ObjectInputStream ois = newInputStream(logFile)) {
while (true) {
snippet.entries.add(readLogEntry(ois));
if (snippet.entries.size() > count) {
@@ -303,7 +295,7 @@ public class DefaultLogService implements LogService, Serializable {
return snippet;
}
- private List<JobLogEntryEx> readLogEntries(List<JobLogEntryEx> cachedEntries, int from, int count) {
+ private List<LogEntry> readLogEntries(List<LogEntry> cachedEntries, int from, int count) {
if (from < cachedEntries.size()) {
int to = from + count;
if (to == from || to > cachedEntries.size())
@@ -315,36 +307,63 @@ public class DefaultLogService implements LogService, Serializable {
}
@Override
- public List<JobLogEntryEx> readLogEntries(LoggingSupport loggingSupport, int from, int count) {
+ public List<LogEntry> readLogEntries(LoggingIdentity identity, int from, int count) {
+ return read(identity.getLockName(), () -> {
+ File logFile = identity.getFile();
+ LogSnippet snippet = recentSnippets.get(logFile);
+ if (snippet != null) {
+ if (from >= snippet.offset) {
+ return readLogEntries(snippet.entries, from - snippet.offset, count);
+ } else {
+ List<LogEntry> entries = new ArrayList<>(readLogEntries(logFile, from, count));
+ if (count == 0)
+ entries.addAll(snippet.entries);
+ else if (entries.size() < count)
+ entries.addAll(readLogEntries(snippet.entries, 0, count - entries.size()));
+ return entries;
+ }
+ } else {
+ return readLogEntries(logFile, from, count);
+ }
+ });
+ }
+
+ @Override
+ public List<LogEntry> readLogEntries(LoggingSupport loggingSupport, int from, int count) {
return loggingSupport.runOnActiveServer(new ClusterTask<>() {
private static final long serialVersionUID = 1L;
@Override
- public List<JobLogEntryEx> call() {
- return read(loggingSupport.getIdentity().getLockName(), () -> {
- File logFile = loggingSupport.getIdentity().getFile();
- LogSnippet snippet = recentSnippets.get(loggingSupport.getIdentity().getCacheKey());
- if (snippet != null) {
- if (from >= snippet.offset) {
- return readLogEntries(snippet.entries, from - snippet.offset, count);
- } else {
- List<JobLogEntryEx> entries = new ArrayList<>(readLogEntries(logFile, from, count));
- if (count == 0)
- entries.addAll(snippet.entries);
- else if (entries.size() < count)
- entries.addAll(readLogEntries(snippet.entries, 0, count - entries.size()));
- return entries;
- }
- } else {
- return readLogEntries(logFile, from, count);
- }
- });
+ public List<LogEntry> call() {
+ return readLogEntries(loggingSupport.getIdentity(), from, count);
}
});
}
+ @Override
+ public LogSnippet readLogSnippetReversely(LoggingIdentity identity, int count) {
+ return read(identity.getLockName(), () -> {
+ File logFile = identity.getFile();
+ LogSnippet recentSnippet = recentSnippets.get(logFile);
+ if (recentSnippet != null) {
+ var snippet = new LogSnippet();
+ if (count <= recentSnippet.entries.size()) {
+ snippet.entries.addAll(recentSnippet.entries.subList(
+ recentSnippet.entries.size() - count, recentSnippet.entries.size()));
+ } else {
+ snippet.entries.addAll(readLogSnippetReversely(logFile, count - recentSnippet.entries.size()).entries);
+ snippet.entries.addAll(recentSnippet.entries);
+ }
+ snippet.offset = recentSnippet.entries.size() + recentSnippet.offset - snippet.entries.size();
+ return snippet;
+ } else {
+ return readLogSnippetReversely(logFile, count);
+ }
+ });
+ }
+
@Override
public LogSnippet readLogSnippetReversely(LoggingSupport loggingSupport, int count) {
return loggingSupport.runOnActiveServer(new ClusterTask<>() {
@@ -353,147 +372,78 @@ public class DefaultLogService implements LogService, Serializable {
@Override
public LogSnippet call() {
- return read(loggingSupport.getIdentity().getLockName(), () -> {
- File logFile = loggingSupport.getIdentity().getFile();
- LogSnippet recentSnippet = recentSnippets.get(loggingSupport.getIdentity().getCacheKey());
- if (recentSnippet != null) {
- var snippet = new LogSnippet();
- if (count <= recentSnippet.entries.size()) {
- snippet.entries.addAll(recentSnippet.entries.subList(
- recentSnippet.entries.size() - count, recentSnippet.entries.size()));
- } else {
- snippet.entries.addAll(readLogSnippetReversely(logFile, count - recentSnippet.entries.size()).entries);
- snippet.entries.addAll(recentSnippet.entries);
- }
- snippet.offset = recentSnippet.entries.size() + recentSnippet.offset - snippet.entries.size();
- return snippet;
- } else {
- return readLogSnippetReversely(logFile, count);
- }
- });
+ return readLogSnippetReversely(loggingSupport.getIdentity(), count);
}
});
}
-
+
private ObjectOutputStream newOutputStream(File logFile) {
+ FileUtils.createDir(logFile.getParentFile());
try {
- if (logFile.exists() && logFile.length() != 0) {
- return new ObjectOutputStream(new BufferedOutputStream(new FileOutputStream(logFile, true), BUFFER_SIZE)) {
+ var append = logFile.exists() && logFile.length() != 0;
+ var output = new BufferedOutputStream(new FileOutputStream(logFile, append), BUFFER_SIZE);
+ try {
+ if (append) {
+ return new ObjectOutputStream(output) {
- @Override
- protected void writeStreamHeader() throws IOException {
- reset();
- }
-
- };
- } else {
- return new ObjectOutputStream(new BufferedOutputStream(new FileOutputStream(logFile), BUFFER_SIZE));
+ @Override
+ protected void writeStreamHeader() throws IOException {
+ reset();
+ }
+
+ };
+ } else {
+ return new ObjectOutputStream(output);
+ }
+ } catch (Throwable e) {
+ IOUtils.closeQuietly(output);
+ throw e;
}
} catch (IOException e) {
throw new RuntimeException(e);
}
}
+ @Override
+ public void clear(LoggingSupport loggingSupport) {
+ var identity = loggingSupport.getIdentity();
+ write(identity.getLockName(), () -> {
+ FileUtils.deleteFile(identity.getFile());
+ recentSnippets.remove(identity.getFile());
+ return null;
+ });
+ loggingSupport.fileModified();
+ }
+
@Override
public void flush(LoggingSupport loggingSupport) {
- write(loggingSupport.getIdentity().getLockName(), () -> {
- LogSnippet snippet = recentSnippets.remove(loggingSupport.getIdentity().getCacheKey());
+ var identity = loggingSupport.getIdentity();
+ var modified = write(identity.getLockName(), () -> {
+ var file = identity.getFile();
+ var snippet = recentSnippets.get(file);
if (snippet != null) {
- File logFile = loggingSupport.getIdentity().getFile();
- try (ObjectOutputStream oos = newOutputStream(logFile)) {
- for (JobLogEntryEx entry: snippet.entries)
- writeLogEntry(oos, entry);
+ try (ObjectOutputStream oos = newOutputStream(file)) {
+ if (snippet != null) {
+ for (LogEntry entry: snippet.entries)
+ oos.writeObject(entry);
+ }
} catch (IOException e) {
throw new RuntimeException(e);
- }
- loggingSupport.fileModified();
+ }
+ recentSnippets.remove(file);
+ return true;
}
- return null;
+ return false;
});
+ if (modified)
+ loggingSupport.fileModified();
transactionService.runAfterCommit(() -> notifyListeners(loggingSupport));
}
-
+
@Override
public InputStream openLogStream(LoggingIdentity loggingIdentity) {
- return new LogStream(loggingIdentity);
- }
-
- class LogStream extends InputStream {
-
- private ObjectInputStream ois;
-
- private final Lock lock;
-
- private byte[] buffer = new byte[0];
-
- private byte[] recentBuffer;
-
- private int pos = 0;
-
- public LogStream(LoggingIdentity loggingIdentity) {
- lock = getReadWriteLock(loggingIdentity.getLockName()).readLock();
- lock.lock();
- try {
- File logFile = loggingIdentity.getFile();
-
- if (logFile.exists() && logFile.length() != 0)
- ois = new ObjectInputStream(new BufferedInputStream(new FileInputStream(logFile)));
-
- LogSnippet snippet = recentSnippets.get(loggingIdentity.getCacheKey());
- if (snippet != null) {
- StringBuilder builder = new StringBuilder();
- for (JobLogEntryEx entry: snippet.entries)
- builder.append(entry.render() + "\n");
- recentBuffer = builder.toString().getBytes(StandardCharsets.UTF_8);
- }
- } catch (Exception e) {
- lock.unlock();
- throw ExceptionUtils.unchecked(e);
- }
- }
-
- @Override
- public int read() throws IOException {
- if (pos == buffer.length) {
- if (ois != null) {
- try {
- buffer = (readLogEntry(ois).render() + "\n").getBytes(StandardCharsets.UTF_8);
- } catch (EOFException e) {
- ois.close();
- ois = null;
- if (recentBuffer != null) {
- buffer = recentBuffer;
- recentBuffer = null;
- } else {
- return -1;
- }
- } catch (ClassNotFoundException e) {
- throw new RuntimeException(e);
- }
- } else if (recentBuffer != null) {
- buffer = recentBuffer;
- recentBuffer = null;
- } else {
- return -1;
- }
- pos = 1;
- return buffer[0];
- } else {
- return buffer[pos++];
- }
- }
-
- @Override
- public void close() throws IOException {
- try {
- if (ois != null)
- ois.close();
- } finally {
- lock.unlock();
- }
- }
-
+ return new LogStream(loggingIdentity, recentSnippets);
}
@Override
diff --git a/server-core/src/main/java/io/onedev/server/buildspec/job/log/JobLogEntryEx.java b/server-core/src/main/java/io/onedev/server/logging/LogEntry.java
similarity index 87%
rename from server-core/src/main/java/io/onedev/server/buildspec/job/log/JobLogEntryEx.java
rename to server-core/src/main/java/io/onedev/server/logging/LogEntry.java
index 10efc3b2b8..d6292da6bc 100644
--- a/server-core/src/main/java/io/onedev/server/buildspec/job/log/JobLogEntryEx.java
+++ b/server-core/src/main/java/io/onedev/server/logging/LogEntry.java
@@ -1,5 +1,8 @@
-package io.onedev.server.buildspec.job.log;
+package io.onedev.server.logging;
+import java.io.IOException;
+import java.io.ObjectInputStream;
+import java.io.ObjectOutputStream;
import java.io.Serializable;
import java.util.ArrayList;
import java.util.Date;
@@ -12,45 +15,41 @@ import java.time.ZoneId;
import java.time.format.DateTimeFormatter;
import java.util.regex.Pattern;
-import org.jspecify.annotations.Nullable;
-
import com.google.common.base.Splitter;
-import com.google.common.collect.Lists;
-import io.onedev.server.logging.StyleBuilder;
import io.onedev.server.web.asset.emoji.Emojis;
-public class JobLogEntryEx implements Serializable {
+public class LogEntry implements Serializable {
- private static final long serialVersionUID = 1L;
+ private static final long serialVersionUID = 2L;
private static final DateTimeFormatter DATE_FORMATTER = DateTimeFormatter.ofPattern("HH:mm:ss");
private static final Pattern EOL_PATTERN = Pattern.compile("\r?\n");
- private final Date date;
+ private Date date;
- private final List<Message> messages;
+ private List<Message> messages;
- public JobLogEntryEx(Date date, List<Message> messages) {
+ LogEntry(Date date, List<Message> messages) {
this.date = date;
this.messages = messages;
}
- public JobLogEntryEx(JobLogEntry entry) {
- this(entry.getDate(), Lists.newArrayList(new Message(new StyleBuilder().build(), entry.getMessage())));
+ public LogEntry(Date date, String message) {
+ this(date, new ArrayList<>(List.of(new Message(new StyleBuilder().build(), message))));
}
- public JobLogEntryEx transformEmojis() {
+ public LogEntry transformEmojis() {
Emojis emojis = Emojis.getInstance();
List<Message> messages = new ArrayList<>();
for (Message message: getMessages())
messages.add(new Message(message.getStyle(), emojis.apply(message.getText())));
- return new JobLogEntryEx(getDate(), messages);
+ return new LogEntry(getDate(), messages);
}
// Handle ANSI escape codes according to https://en.wikipedia.org/wiki/ANSI_escape_code
- public static JobLogEntryEx parse(String text, StyleBuilder styleBuilder) {
+ public static LogEntry parse(String text, StyleBuilder styleBuilder) {
text = text.replace("\r\n", "\n");
AtomicInteger cursor = new AtomicInteger(0);
@@ -280,14 +279,14 @@ public class JobLogEntryEx implements Serializable {
if (currentTextBuilder.length() != 0)
textAppender.apply(currentTextBuilder.toString());
- return new JobLogEntryEx(new Date(), new ArrayList<>(messages));
+ return new LogEntry(new Date(), new ArrayList<>(messages));
}
public Date getDate() {
return date;
}
- public List<Message> getMessages() {
+ List<Message> getMessages() {
return messages;
}
@@ -315,16 +314,27 @@ public class JobLogEntryEx implements Serializable {
return builder.toString();
}
- @Nullable
- public JobLogEntry getSpaceEfficientVersion() {
- StringBuilder builder = new StringBuilder();
+ private void writeObject(ObjectOutputStream output) throws IOException {
+ StringBuilder plainMessage = new StringBuilder();
for (Message message: messages) {
- if (message.getStyle().isDefault())
- builder.append(message.getText());
- else
- return null;
+ if (!message.getStyle().isDefault()) {
+ plainMessage = null;
+ break;
+ }
+ plainMessage.append(message.getText());
}
- return new JobLogEntry(date, builder.toString());
+ output.writeLong(date.getTime());
+ output.writeObject(plainMessage != null ? plainMessage.toString() : messages);
+ }
+
+ @SuppressWarnings("unchecked")
+ private void readObject(ObjectInputStream input) throws IOException, ClassNotFoundException {
+ date = new Date(input.readLong());
+ Object content = input.readObject();
+ if (content instanceof String)
+ messages = new ArrayList<>(List.of(new Message(new StyleBuilder().build(), (String) content)));
+ else
+ messages = (List<Message>) content;
}
}
diff --git a/server-core/src/main/java/io/onedev/server/logging/LogEntryReader.java b/server-core/src/main/java/io/onedev/server/logging/LogEntryReader.java
new file mode 100644
index 0000000000..93fb8e2716
--- /dev/null
+++ b/server-core/src/main/java/io/onedev/server/logging/LogEntryReader.java
@@ -0,0 +1,85 @@
+package io.onedev.server.logging;
+
+import java.io.BufferedInputStream;
+import java.io.EOFException;
+import java.io.File;
+import java.io.FileInputStream;
+import java.io.IOException;
+import java.io.ObjectInputStream;
+import java.util.Iterator;
+import java.util.List;
+import java.util.Map;
+
+import io.onedev.server.util.IOUtils;
+
+/** Reads persisted entries followed by the in-memory tail. The caller must hold the log's read lock. */
+class LogEntryReader implements AutoCloseable {
+ private ObjectInputStream input;
+ private final File file;
+ private Iterator<LogEntry> recent = List.<LogEntry>of().iterator();
+ private LogEntry next;
+ private boolean initialized;
+ private boolean closed;
+
+ LogEntryReader(LoggingIdentity identity, Map<File, LogSnippet> recentSnippets) {
+ file = identity.getFile();
+ var snippet = recentSnippets.get(file);
+ if (snippet != null)
+ recent = snippet.entries.iterator();
+ }
+
+ void advance() throws IOException, ClassNotFoundException {
+ if (!initialized) {
+ initialized = true;
+ if (file.exists() && file.length() != 0)
+ input = newInputStream(file);
+ }
+ if (input != null) {
+ try {
+ next = readLogEntry(input);
+ return;
+ } catch (EOFException ignored) {
+ input.close();
+ input = null;
+ }
+ }
+ next = recent.hasNext() ? recent.next() : null;
+ if (next == null)
+ close();
+ }
+
+ @Override
+ public void close() throws IOException {
+ if (!closed) {
+ closed = true;
+ try {
+ if (input != null)
+ input.close();
+ } finally {
+ input = null;
+ recent = List.<LogEntry>of().iterator();
+ }
+ }
+ }
+
+ LogEntry getNext() throws IOException, ClassNotFoundException {
+ if (!initialized)
+ advance();
+ return next;
+ }
+
+ static ObjectInputStream newInputStream(File file) throws IOException {
+ var input = new BufferedInputStream(new FileInputStream(file));
+ try {
+ return new ObjectInputStream(input);
+ } catch (Throwable e) {
+ IOUtils.closeQuietly(input);
+ throw e;
+ }
+ }
+
+ static LogEntry readLogEntry(ObjectInputStream ois) throws ClassNotFoundException, IOException {
+ return (LogEntry) ois.readObject();
+ }
+
+}
diff --git a/server-core/src/main/java/io/onedev/server/logging/LogListener.java b/server-core/src/main/java/io/onedev/server/logging/LogListener.java
index 59bfb041aa..e7642ebc77 100644
--- a/server-core/src/main/java/io/onedev/server/logging/LogListener.java
+++ b/server-core/src/main/java/io/onedev/server/logging/LogListener.java
@@ -2,6 +2,6 @@ package io.onedev.server.logging;
public interface LogListener {
- void logged(LoggingSupport loggingSupport);
+ void logged(LoggingSupport support);
}
diff --git a/server-core/src/main/java/io/onedev/server/logging/LogService.java b/server-core/src/main/java/io/onedev/server/logging/LogService.java
index cf6b81ba8e..da1241ce46 100644
--- a/server-core/src/main/java/io/onedev/server/logging/LogService.java
+++ b/server-core/src/main/java/io/onedev/server/logging/LogService.java
@@ -2,16 +2,19 @@ package io.onedev.server.logging;
import java.io.InputStream;
import java.util.List;
+import java.util.function.BooleanSupplier;
import java.util.regex.Pattern;
import org.jspecify.annotations.Nullable;
import io.onedev.commons.utils.TaskLogger;
-import io.onedev.server.buildspec.job.log.JobLogEntryEx;
public interface LogService {
TaskLogger newLogger(LoggingSupport loggingSupport);
+
+ /** The acceptance check runs under the log write lock and must not access the database. */
+ TaskLogger newLogger(LoggingSupport loggingSupport, BooleanSupplier acceptingEntries);
/**
* Read specified number of log entries from specified index
@@ -25,7 +28,10 @@ public interface LogService {
* log entries. Number of entries may be less than required count if there is no
* enough log entries
*/
- List<JobLogEntryEx> readLogEntries(LoggingSupport loggingSupport, int offset, int count);
+ List<LogEntry> readLogEntries(LoggingSupport loggingSupport, int offset, int count);
+
+ /** Read entries locally, without dispatching to the active server. */
+ List<LogEntry> readLogEntries(LoggingIdentity identity, int offset, int count);
void registerListener(LogListener listener);
@@ -33,8 +39,12 @@ public interface LogService {
boolean matches(LoggingSupport loggingSupport, Pattern pattern);
+ /** Finish the identified log file locally. */
void flush(LoggingSupport loggingSupport);
+ /** Clear the identified log file and cached entries locally. */
+ void clear(LoggingSupport loggingSupport);
+
/**
* Read specified number of log entries starting from end of the log
*
@@ -43,9 +53,12 @@ public interface LogService {
* if there is no enough log entries
*/
LogSnippet readLogSnippetReversely(LoggingSupport loggingSupport, int count);
+
+ /** Read a tail locally, without dispatching to the active server. */
+ LogSnippet readLogSnippetReversely(LoggingIdentity identity, int count);
InputStream openLogStream(LoggingIdentity loggingIdentity);
-
+
@Nullable
TaskLogger getLogger(String token);
diff --git a/server-core/src/main/java/io/onedev/server/logging/LogSnippet.java b/server-core/src/main/java/io/onedev/server/logging/LogSnippet.java
index bb01df837f..41a7de4264 100644
--- a/server-core/src/main/java/io/onedev/server/logging/LogSnippet.java
+++ b/server-core/src/main/java/io/onedev/server/logging/LogSnippet.java
@@ -4,13 +4,11 @@ import java.io.Serializable;
import java.util.LinkedList;
import java.util.List;
-import io.onedev.server.buildspec.job.log.JobLogEntryEx;
-
public class LogSnippet implements Serializable {
private static final long serialVersionUID = 1L;
- public List<JobLogEntryEx> entries = new LinkedList<>();
+ public List<LogEntry> entries = new LinkedList<>();
/**
* offset of first log entry in the snippet
diff --git a/server-core/src/main/java/io/onedev/server/logging/LogStream.java b/server-core/src/main/java/io/onedev/server/logging/LogStream.java
new file mode 100644
index 0000000000..99fda013e5
--- /dev/null
+++ b/server-core/src/main/java/io/onedev/server/logging/LogStream.java
@@ -0,0 +1,118 @@
+package io.onedev.server.logging;
+
+import static io.onedev.commons.utils.LockUtils.getReadWriteLock;
+
+import java.io.File;
+import java.io.IOException;
+import java.io.InputStream;
+import java.nio.charset.StandardCharsets;
+import java.util.Map;
+import java.util.Objects;
+import java.util.concurrent.locks.ReadWriteLock;
+
+import io.onedev.commons.utils.ExceptionUtils;
+
+/** Streams one log file and its cached tail. Read and close on the opening thread. */
+class LogStream extends InputStream {
+ private LogEntryReader reader;
+ private byte[] buffer = new byte[0];
+ private int pos;
+ private boolean closed;
+ private IOException pendingFailure;
+ // Keep the lock itself alive: LockUtils caches read/write locks with weak references.
+ private ReadWriteLock lock;
+
+ LogStream(LoggingIdentity identity, Map<File, LogSnippet> recentSnippets) {
+ lock = getReadWriteLock(identity.getLockName());
+ lock.readLock().lock();
+ try {
+ reader = new LogEntryReader(identity, recentSnippets);
+ if (reader.getNext() == null)
+ releaseLock();
+ } catch (Exception | Error e) {
+ try {
+ close();
+ } catch (IOException closeError) {
+ e.addSuppressed(closeError);
+ }
+ throw ExceptionUtils.unchecked(e);
+ }
+ }
+
+ private void releaseLock() {
+ if (lock != null) {
+ lock.readLock().unlock();
+ lock = null;
+ }
+ }
+
+ private boolean fill() throws IOException {
+ if (pendingFailure != null)
+ throw pendingFailure;
+ if (closed)
+ throw new IOException("Log stream is closed");
+ if (pos < buffer.length)
+ return true;
+ try {
+ if (reader.getNext() == null)
+ return false;
+ buffer = (reader.getNext().render() + "\n").getBytes(StandardCharsets.UTF_8);
+ pos = 0;
+ reader.advance();
+ if (reader.getNext() == null)
+ releaseLock();
+ return true;
+ } catch (IOException | ClassNotFoundException | RuntimeException | Error e) {
+ try {
+ close();
+ } catch (IOException closeError) {
+ e.addSuppressed(closeError);
+ }
+ if (e instanceof ClassNotFoundException)
+ throw new IOException(e);
+ if (e instanceof IOException)
+ throw (IOException) e;
+ throw ExceptionUtils.unchecked(e);
+ }
+ }
+
+ @Override
+ public int read() throws IOException {
+ return fill() ? buffer[pos++] & 0xff : -1;
+ }
+
+ @Override
+ public int read(byte[] bytes, int offset, int length) throws IOException {
+ Objects.checkFromIndexSize(offset, length, bytes.length);
+ if (length == 0)
+ return 0;
+ int total = 0;
+ try {
+ while (total < length && fill()) {
+ int count = Math.min(length - total, buffer.length - pos);
+ System.arraycopy(buffer, pos, bytes, offset + total, count);
+ pos += count;
+ total += count;
+ }
+ } catch (IOException e) {
+ if (total == 0)
+ throw e;
+ // Return the partial data now and report the original failure on the next read.
+ pendingFailure = e;
+ }
+ return total != 0 ? total : -1;
+ }
+
+ @Override
+ public void close() throws IOException {
+ if (!closed) {
+ closed = true;
+ try {
+ if (reader != null)
+ reader.close();
+ } finally {
+ releaseLock();
+ }
+ }
+ }
+}
diff --git a/server-core/src/main/java/io/onedev/server/logging/LogTask.java b/server-core/src/main/java/io/onedev/server/logging/LogTask.java
index 8960bd8e6b..4f95694c4f 100644
--- a/server-core/src/main/java/io/onedev/server/logging/LogTask.java
+++ b/server-core/src/main/java/io/onedev/server/logging/LogTask.java
@@ -6,7 +6,7 @@ import io.onedev.commons.utils.TaskLogger;
import io.onedev.server.OneDev;
import io.onedev.server.cluster.ClusterTask;
-public class LogTask implements ClusterTask<Void> {
+class LogTask implements ClusterTask<Void> {
private static final long serialVersionUID = 1L;
@@ -16,7 +16,7 @@ public class LogTask implements ClusterTask<Void> {
private final String sessionId;
- public LogTask(String token, String message, @Nullable String sessionId) {
+ LogTask(String token, String message, @Nullable String sessionId) {
this.token = token;
this.message = message;
this.sessionId = sessionId;
@@ -30,4 +30,4 @@ public class LogTask implements ClusterTask<Void> {
return null;
}
-}
\ No newline at end of file
+}
diff --git a/server-core/src/main/java/io/onedev/server/logging/LoggingIdentity.java b/server-core/src/main/java/io/onedev/server/logging/LoggingIdentity.java
index 3f1bda2d45..c7872fc598 100644
--- a/server-core/src/main/java/io/onedev/server/logging/LoggingIdentity.java
+++ b/server-core/src/main/java/io/onedev/server/logging/LoggingIdentity.java
@@ -7,8 +7,6 @@ public interface LoggingIdentity extends Serializable {
File getFile();
- String getCacheKey();
-
String getLockName();
}
\ No newline at end of file
diff --git a/server-core/src/main/java/io/onedev/server/logging/LoggingSupport.java b/server-core/src/main/java/io/onedev/server/logging/LoggingSupport.java
index 557dc2137a..c3f77b14b7 100644
--- a/server-core/src/main/java/io/onedev/server/logging/LoggingSupport.java
+++ b/server-core/src/main/java/io/onedev/server/logging/LoggingSupport.java
@@ -6,8 +6,8 @@ import java.util.Date;
import org.jspecify.annotations.Nullable;
-import io.onedev.server.buildspec.job.log.instruction.LogInstruction;
import io.onedev.server.cluster.ClusterTask;
+import io.onedev.server.logging.instruction.LogInstruction;
public interface LoggingSupport extends Serializable {
diff --git a/server-core/src/main/java/io/onedev/server/buildspec/job/log/Message.java b/server-core/src/main/java/io/onedev/server/logging/Message.java
similarity index 80%
rename from server-core/src/main/java/io/onedev/server/buildspec/job/log/Message.java
rename to server-core/src/main/java/io/onedev/server/logging/Message.java
index 83b7b4ca40..1d8a6e0de6 100644
--- a/server-core/src/main/java/io/onedev/server/buildspec/job/log/Message.java
+++ b/server-core/src/main/java/io/onedev/server/logging/Message.java
@@ -1,11 +1,11 @@
-package io.onedev.server.buildspec.job.log;
+package io.onedev.server.logging;
import java.io.Serializable;
import org.apache.commons.lang3.builder.EqualsBuilder;
import org.apache.commons.lang3.builder.HashCodeBuilder;
-public class Message implements Serializable {
+class Message implements Serializable {
private static final long serialVersionUID = 1L;
@@ -13,16 +13,16 @@ public class Message implements Serializable {
private final String text;
- public Message(Style style, String text) {
+ Message(Style style, String text) {
this.style = style;
this.text = text;
}
- public Style getStyle() {
+ Style getStyle() {
return style;
}
- public String getText() {
+ String getText() {
return text;
}
diff --git a/server-core/src/main/java/io/onedev/server/logging/ServerLogger.java b/server-core/src/main/java/io/onedev/server/logging/ServerLogger.java
index b9551e8167..7ea41316e9 100644
--- a/server-core/src/main/java/io/onedev/server/logging/ServerLogger.java
+++ b/server-core/src/main/java/io/onedev/server/logging/ServerLogger.java
@@ -5,6 +5,11 @@ import io.onedev.server.OneDev;
import io.onedev.server.cluster.ClusterService;
import org.jetbrains.annotations.Nullable;
+/**
+ * Forwards log messages synchronously to another server. Callers must not hold
+ * database connections: the receiving logger may need database access, which
+ * could otherwise cause a circular wait.
+ */
public class ServerLogger extends TaskLogger {
private final String server;
diff --git a/server-core/src/main/java/io/onedev/server/buildspec/job/log/Style.java b/server-core/src/main/java/io/onedev/server/logging/Style.java
similarity index 72%
rename from server-core/src/main/java/io/onedev/server/buildspec/job/log/Style.java
rename to server-core/src/main/java/io/onedev/server/logging/Style.java
index 7e204de940..7bcb2ef71f 100644
--- a/server-core/src/main/java/io/onedev/server/buildspec/job/log/Style.java
+++ b/server-core/src/main/java/io/onedev/server/logging/Style.java
@@ -1,17 +1,17 @@
-package io.onedev.server.buildspec.job.log;
+package io.onedev.server.logging;
import java.io.Serializable;
import org.apache.commons.lang3.builder.EqualsBuilder;
import org.apache.commons.lang3.builder.HashCodeBuilder;
-public class Style implements Serializable {
+class Style implements Serializable {
private static final long serialVersionUID = 1L;
- public static final String FOREGROUND_COLOR_DEFAULT = "fg-default";
+ static final String FOREGROUND_COLOR_DEFAULT = "fg-default";
- public static final String BACKGROUND_COLOR_DEFAULT = "bg-default";
+ static final String BACKGROUND_COLOR_DEFAULT = "bg-default";
private final String color;
@@ -19,25 +19,25 @@ public class Style implements Serializable {
private final boolean bold;
- public Style(String color, String backgroundColor, boolean bold) {
+ Style(String color, String backgroundColor, boolean bold) {
this.color = color;
this.backgroundColor = backgroundColor;
this.bold = bold;
}
- public String getColor() {
+ String getColor() {
return color;
}
- public String getBackgroundColor() {
+ String getBackgroundColor() {
return backgroundColor;
}
- public boolean isBold() {
+ boolean isBold() {
return bold;
}
- public boolean isDefault() {
+ boolean isDefault() {
return color.equals(FOREGROUND_COLOR_DEFAULT) && backgroundColor.equals(BACKGROUND_COLOR_DEFAULT) && !bold;
}
diff --git a/server-core/src/main/java/io/onedev/server/logging/StyleBuilder.java b/server-core/src/main/java/io/onedev/server/logging/StyleBuilder.java
index 50e9336766..7f074a05f0 100644
--- a/server-core/src/main/java/io/onedev/server/logging/StyleBuilder.java
+++ b/server-core/src/main/java/io/onedev/server/logging/StyleBuilder.java
@@ -2,8 +2,6 @@ package io.onedev.server.logging;
import java.io.Serializable;
-import io.onedev.server.buildspec.job.log.Style;
-
public class StyleBuilder implements Serializable {
private static final long serialVersionUID = 1L;
@@ -14,29 +12,29 @@ public class StyleBuilder implements Serializable {
private boolean bold = false;
- public void setColor(String color) {
+ void setColor(String color) {
this.color = color;
}
- public void setBackgroundColor(String backgroundColor) {
+ void setBackgroundColor(String backgroundColor) {
this.backgroundColor = backgroundColor;
}
- public void setBold(boolean bold) {
+ void setBold(boolean bold) {
this.bold = bold;
}
- public void reset() {
+ void reset() {
color = Style.FOREGROUND_COLOR_DEFAULT;
backgroundColor = Style.BACKGROUND_COLOR_DEFAULT;
bold = false;
}
- public Style build() {
+ Style build() {
return new Style(color, backgroundColor, bold);
}
- public void swapForegroundAndBackGround() {
+ void swapForegroundAndBackGround() {
String temp = color;
color = backgroundColor;
backgroundColor = temp;
diff --git a/server-core/src/main/java/io/onedev/server/logging/build/BuildLogContext.java b/server-core/src/main/java/io/onedev/server/logging/build/BuildLogContext.java
new file mode 100644
index 0000000000..cc4c889032
--- /dev/null
+++ b/server-core/src/main/java/io/onedev/server/logging/build/BuildLogContext.java
@@ -0,0 +1,70 @@
+package io.onedev.server.logging.build;
+
+import java.io.Serializable;
+
+import io.onedev.server.OneDev;
+import io.onedev.server.cluster.ClusterTask;
+import io.onedev.server.model.Build;
+import io.onedev.server.persistence.SessionService;
+import io.onedev.server.service.BuildService;
+import io.onedev.server.service.ProjectService;
+
+/** Context for whole-build log aggregation and lifecycle operations. */
+public class BuildLogContext implements Serializable {
+
+ private static final long serialVersionUID = 1L;
+
+ private final BuildLogStorage storage;
+
+ private final Long buildId;
+
+ private final Long projectId;
+
+ private final Long buildNumber;
+
+ private final String token;
+
+ public BuildLogContext(Build build) {
+ buildId = build.getId();
+ projectId = build.getProject().getId();
+ buildNumber = build.getNumber();
+ token = build.getToken();
+ storage = new BuildLogStorage(projectId, buildNumber);
+ }
+
+ Long getProjectId() {
+ return projectId;
+ }
+
+ Long getBuildNumber() {
+ return buildNumber;
+ }
+
+ String getToken() {
+ return token;
+ }
+
+ public Long getBuildId() {
+ return buildId;
+ }
+
+ public <T> T runOnActiveServer(ClusterTask<T> task) {
+ return OneDev.getInstance(ProjectService.class).runOnActiveServer(projectId, task);
+ }
+
+ public void fileModified() {
+ OneDev.getInstance(ProjectService.class).directoryModified(projectId, storage.getDirectory());
+ }
+
+ String getLogVersion() {
+ return OneDev.getInstance(SessionService.class).call(() -> {
+ var build = OneDev.getInstance(BuildService.class).load(buildId);
+ return build.getToken() + ":" + (build.getRetryDate() != null ? build.getRetryDate().getTime() : 0);
+ });
+ }
+
+ public BuildLogStorage getStorage() {
+ return storage;
+ }
+
+}
diff --git a/server-core/src/main/java/io/onedev/server/logging/build/BuildLogRouter.java b/server-core/src/main/java/io/onedev/server/logging/build/BuildLogRouter.java
new file mode 100644
index 0000000000..bfadac9538
--- /dev/null
+++ b/server-core/src/main/java/io/onedev/server/logging/build/BuildLogRouter.java
@@ -0,0 +1,256 @@
+package io.onedev.server.logging.build;
+
+import static io.onedev.k8shelper.JobHelper.FINALIZATION;
+import static io.onedev.k8shelper.JobHelper.INITIALIZATION;
+
+import java.util.ArrayList;
+import java.util.HashMap;
+import java.util.Locale;
+import java.util.Map;
+import java.util.Objects;
+import java.util.concurrent.atomic.AtomicBoolean;
+
+import org.jspecify.annotations.Nullable;
+
+import io.onedev.agent.job.JobUtils;
+import io.onedev.commons.utils.TaskLogger;
+import io.onedev.k8shelper.CompositeFacade;
+import io.onedev.k8shelper.JobHelper;
+import io.onedev.k8shelper.JobHelper.StepEvent;
+import io.onedev.k8shelper.JobHelper.StepEventKind;
+import io.onedev.server.OneDev;
+import io.onedev.server.event.ListenerRegistry;
+import io.onedev.server.event.project.build.BuildUpdated;
+import io.onedev.server.job.JobService;
+import io.onedev.server.model.Build;
+import io.onedev.server.model.support.build.StepExecution;
+import io.onedev.server.model.support.build.StepExecution.Status;
+import io.onedev.server.persistence.TransactionService;
+import io.onedev.server.service.BuildService;
+
+/**
+ * One router per build token. Executors finish a stage's output before sending the next boundary.
+ * Build metadata and job-context reads precede the monitor. Flushes run during stage changes.
+ * Neither log writers nor callbacks may acquire this monitor while holding the log lock.
+ */
+class BuildLogRouter extends TaskLogger {
+ private final Long buildId;
+ private final String token;
+ private final BuildLogService buildLogService;
+ // Routing state is guarded by this monitor. Never retain a Hibernate entity here.
+ private TaskLogger currentLogger;
+ private AtomicBoolean acceptingEntries;
+ private Map<String, Integer> stepIndices = Map.of();
+ private String stage;
+ private String title;
+ private boolean phaseAnnounced;
+ private volatile long generation;
+ private volatile boolean closed;
+ private volatile BuildLoggingSupport currentSupport;
+
+ BuildLogRouter(Build build, BuildLogService buildLogService) {
+ buildId = build.getId();
+ token = build.getToken();
+ this.buildLogService = buildLogService;
+ // Terminal status can be set before the final diagnostic message is logged.
+ closed = build.getFinishDate() != null;
+ }
+
+ @Nullable
+ private Build loadBuild() {
+ var build = OneDev.getInstance(BuildService.class).get(buildId);
+ if (closed || build == null || build.getFinishDate() != null || !Objects.equals(token, build.getToken())) {
+ close();
+ return null;
+ }
+ return build;
+ }
+
+ private void initializeStage(long expectedGeneration) {
+ if (currentSupport != null || closed)
+ return;
+ OneDev.getInstance(TransactionService.class).run(() -> {
+ var build = loadBuild();
+ if (build == null)
+ return;
+ var support = new BuildLoggingSupport(build, build.getCurrentLogStage());
+ var stageTitle = build.getLogStageName(support.getStage());
+ synchronized (this) {
+ if (!closed && generation == expectedGeneration && currentSupport == null) {
+ selectStage(support, stageTitle);
+ phaseAnnounced = build.isFinalization();
+ }
+ }
+ });
+ }
+
+ private Map<String, Integer> getStepIndices() {
+ synchronized (this) {
+ if (!stepIndices.isEmpty())
+ return stepIndices;
+ }
+ // This synchronous cluster call only reads the job server's in-memory context.
+ var result = new HashMap<String, Integer>();
+ var context = OneDev.getInstance(JobService.class).getJobContext(token, false);
+ if (context != null) {
+ new CompositeFacade(context.getActions()).traverse((facade, position) -> {
+ result.put("step-" + JobHelper.stringifyStepPosition(position), result.size() + 1);
+ return null;
+ }, new ArrayList<>());
+ }
+ return Map.copyOf(result);
+ }
+
+ // Called under the monitor, with fully materialized support and title.
+ private void selectStage(BuildLoggingSupport support, String stageTitle) {
+ stage = support.getStage();
+ title = stageTitle;
+ var accepting = new AtomicBoolean(true);
+ currentLogger = buildLogService.newLogger(support, accepting::get);
+ acceptingEntries = accepting;
+ currentSupport = support;
+ phaseAnnounced = false;
+ }
+
+ private boolean complete(Build build, Status outcome) {
+ var execution = build.getStepExecutions().get(stage);
+ if (execution != null && execution.getStatus() == Status.RUNNING) {
+ execution.complete(outcome);
+ var message = "Step \"" + title + "\" is " + outcome.name().toLowerCase(Locale.ROOT);
+ currentLogger.log(switch (outcome) {
+ case FAILED -> wrapWithAnsiError(message);
+ case SUCCESSFUL -> wrapWithAnsiSuccess(message);
+ default -> wrapWithAnsiNotice(message);
+ });
+ return true;
+ }
+ return false;
+ }
+
+ synchronized void close() {
+ closed = true;
+ if (acceptingEntries != null)
+ acceptingEntries.set(false);
+ }
+
+ void finish() {
+ BuildLoggingSupport support;
+ synchronized (this) {
+ close();
+ support = currentSupport;
+ }
+ if (support != null)
+ buildLogService.flush(support);
+ }
+
+ /** Cleanup runs on the active server; its caller may hold database locks. */
+ synchronized void reset(Runnable cleanup) {
+ generation++;
+ if (acceptingEntries != null)
+ acceptingEntries.set(false);
+ if (currentSupport != null) {
+ // Materialize the cached stage so cleanup also finds it.
+ buildLogService.flush(currentSupport);
+ }
+ cleanup.run();
+ currentSupport = null;
+ currentLogger = null;
+ stage = null;
+ title = null;
+ phaseAnnounced = false;
+ stepIndices = Map.of();
+ }
+
+ @Override
+ public void log(String message, String sessionId) {
+ var expectedGeneration = generation;
+ initializeStage(expectedGeneration);
+ if (closed || generation != expectedGeneration)
+ return;
+ // Consume protocol markers before masking/truncation.
+ var phase = JobUtils.parsePhaseMessage(message);
+ var event = JobHelper.parseStepEventMessage(message);
+ if (phase != null || event != null) {
+ update(phase, event, expectedGeneration);
+ } else {
+ TaskLogger logger;
+ synchronized (this) {
+ logger = closed || generation != expectedGeneration ? null : currentLogger;
+ }
+ if (logger != null)
+ logger.log(message, sessionId);
+ }
+ }
+
+ private void update(String phase, StepEvent event, long expectedGeneration) {
+ var name = phase != null ? phase : event.step();
+ var starting = phase != null || event.kind() == StepEventKind.START || event.kind() == StepEventKind.SKIP;
+ var indices = starting && name.startsWith("step-") ? getStepIndices() : Map.<String, Integer>of();
+ OneDev.getInstance(TransactionService.class).run(() -> {
+ var build = loadBuild();
+ if (build == null)
+ return;
+ // Lazy database reads and possible cluster lookups must precede the monitor.
+ var support = new BuildLoggingSupport(build, name);
+ var stageTitle = build.getLogStageName(name);
+ synchronized (this) {
+ if (closed || generation != expectedGeneration)
+ return;
+ boolean changed;
+ if (starting) {
+ changed = start(build, support, stageTitle, event, indices);
+ } else {
+ // Late or duplicate outcomes must not produce contradictory notices.
+ changed = name.equals(stage) && complete(build, Status.valueOf(event.kind().name()));
+ }
+ if (!changed)
+ return;
+ }
+ OneDev.getInstance(ListenerRegistry.class).post(new BuildUpdated(build));
+ });
+ }
+
+ // All inputs are prepared before acquiring the monitor. Generated notices cannot execute log instructions.
+ private boolean start(Build build, BuildLoggingSupport support, String stageTitle, StepEvent event,
+ Map<String, Integer> indices) {
+ var name = support.getStage();
+ var execution = build.getStepExecutions().get(name);
+ if (event == null && name.equals(stage) && phaseAnnounced)
+ return false;
+ if (event != null && (FINALIZATION.equals(stage) || execution != null
+ && (event.kind() == StepEventKind.START || execution.getStatus() != Status.RUNNING)))
+ return false;
+ if (!name.equals(stage)) {
+ complete(build, name.equals(FINALIZATION) ? Status.SUCCESSFUL : Status.FAILED);
+ // Invalidate before flushing to reject writers already waiting for the log lock.
+ acceptingEntries.set(false);
+ buildLogService.flush(currentSupport);
+ selectStage(support, stageTitle);
+ }
+ if (name.equals(INITIALIZATION)) {
+ build.getStepExecutions().clear();
+ stepIndices = Map.of();
+ }
+ build.setFinalization(name.equals(FINALIZATION));
+ if (event == null) {
+ phaseAnnounced = true;
+ currentLogger.log(wrapWithAnsiNotice(name.equals(INITIALIZATION) ? "Preparing job..." : "Cleaning up job..."));
+ } else {
+ if (execution == null) {
+ execution = new StepExecution();
+ build.getStepExecutions().put(name, execution);
+ }
+ stepIndices = indices;
+ var index = indices.get(name);
+ if (index != null)
+ execution.setStepPosition(index, indices.size());
+ if (event.kind() == StepEventKind.SKIP) {
+ execution.skip();
+ currentLogger.log(wrapWithAnsiNotice("Step \"" + title + "\" is skipped"));
+ } else {
+ currentLogger.log(wrapWithAnsiNotice("Running step \"" + title + "\"..."));
+ }
+ }
+ return true;
+ }
+}
diff --git a/server-core/src/main/java/io/onedev/server/logging/build/BuildLogService.java b/server-core/src/main/java/io/onedev/server/logging/build/BuildLogService.java
new file mode 100644
index 0000000000..79d5ee7709
--- /dev/null
+++ b/server-core/src/main/java/io/onedev/server/logging/build/BuildLogService.java
@@ -0,0 +1,33 @@
+package io.onedev.server.logging.build;
+
+import java.io.InputStream;
+import java.util.List;
+import java.util.regex.Pattern;
+
+import org.jspecify.annotations.Nullable;
+
+import io.onedev.commons.utils.TaskLogger;
+import io.onedev.server.logging.LogService;
+import io.onedev.server.logging.LoggingIdentity;
+import io.onedev.server.model.Build;
+
+/** Build stage routing, aggregation, and retry lifecycle, backed by {@link LogService}. */
+public interface BuildLogService extends LogService {
+
+ TaskLogger newLogger(Build build);
+
+ boolean matches(BuildLogContext context, Pattern pattern);
+
+ /** Stop accepting output and flush the current stage on the build's active server. */
+ void finish(Build build);
+
+ /** Read a combined build tail initially or after a retry, otherwise all new stage entries. */
+ BuildLogSnapshot readSnapshot(BuildLogContext context, @Nullable BuildLogSnapshot previous, int tailCount);
+
+ /** Concatenate stage files locally under their shared lock. Read and close on the opening thread. */
+ InputStream openLogStream(List<? extends LoggingIdentity> stages);
+
+ /** Discard persisted and cached logs of the previous build attempt. */
+ void clear(BuildLogContext context);
+
+}
diff --git a/server-core/src/main/java/io/onedev/server/logging/build/BuildLogSnapshot.java b/server-core/src/main/java/io/onedev/server/logging/build/BuildLogSnapshot.java
new file mode 100644
index 0000000000..3116ebcef6
--- /dev/null
+++ b/server-core/src/main/java/io/onedev/server/logging/build/BuildLogSnapshot.java
@@ -0,0 +1,25 @@
+package io.onedev.server.logging.build;
+
+import java.io.Serializable;
+import java.util.ArrayList;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+
+import io.onedev.server.logging.LogEntry;
+
+/** Combined stream entries and the corresponding positions in the stage files. */
+public class BuildLogSnapshot implements Serializable {
+
+ private static final long serialVersionUID = 1L;
+
+ BuildLogSnapshot() {
+ }
+
+ String logVersion;
+
+ public final List<LogEntry> entries = new ArrayList<>();
+
+ final Map<String, Integer> offsets = new HashMap<>();
+
+}
diff --git a/server-core/src/main/java/io/onedev/server/logging/build/BuildLogStorage.java b/server-core/src/main/java/io/onedev/server/logging/build/BuildLogStorage.java
new file mode 100644
index 0000000000..100f99e0c7
--- /dev/null
+++ b/server-core/src/main/java/io/onedev/server/logging/build/BuildLogStorage.java
@@ -0,0 +1,30 @@
+package io.onedev.server.logging.build;
+
+import java.io.File;
+import java.io.Serializable;
+
+import io.onedev.server.model.Build;
+
+/** Storage directory and shared lock for all stage logs of a build. */
+public class BuildLogStorage implements Serializable {
+
+ private static final long serialVersionUID = 1L;
+
+ private final Long projectId;
+
+ private final Long buildNumber;
+
+ public BuildLogStorage(Long projectId, Long buildNumber) {
+ this.projectId = projectId;
+ this.buildNumber = buildNumber;
+ }
+
+ public File getDirectory() {
+ return Build.getLogDir(projectId, buildNumber);
+ }
+
+ public String getLockName() {
+ return Build.getLogLockName(projectId, buildNumber);
+ }
+
+}
diff --git a/server-core/src/main/java/io/onedev/server/logging/build/BuildLogStream.java b/server-core/src/main/java/io/onedev/server/logging/build/BuildLogStream.java
new file mode 100644
index 0000000000..b39184ec7b
--- /dev/null
+++ b/server-core/src/main/java/io/onedev/server/logging/build/BuildLogStream.java
@@ -0,0 +1,122 @@
+package io.onedev.server.logging.build;
+
+import static io.onedev.commons.utils.LockUtils.getReadWriteLock;
+
+import java.io.IOException;
+import java.io.InputStream;
+import java.util.Iterator;
+import java.util.List;
+import java.util.Objects;
+import java.util.concurrent.locks.ReadWriteLock;
+
+import io.onedev.commons.utils.ExceptionUtils;
+import io.onedev.server.logging.LoggingIdentity;
+
+/** Concatenates stage streams under the build lock. Read and close on the opening thread. */
+class BuildLogStream extends InputStream {
+ private final Iterator<? extends LoggingIdentity> stages;
+ private final BuildLogService buildLogService;
+ private InputStream current;
+ private boolean closed;
+ private IOException pendingFailure;
+ // Keep the lock alive: LockUtils caches locks with weak references.
+ private ReadWriteLock lock;
+
+ BuildLogStream(List<? extends LoggingIdentity> identities, BuildLogService buildLogService) {
+ identities = List.copyOf(identities);
+ stages = identities.iterator();
+ this.buildLogService = buildLogService;
+ if (!identities.isEmpty()) {
+ var lockName = Objects.requireNonNull(identities.get(0).getLockName());
+ for (var identity : identities) {
+ if (!lockName.equals(identity.getLockName()))
+ throw new IllegalArgumentException("All stage logs must share the build lock");
+ }
+ lock = getReadWriteLock(lockName);
+ lock.readLock().lock();
+ }
+ try {
+ openNext();
+ } catch (RuntimeException | Error e) {
+ try {
+ close();
+ } catch (IOException closeError) {
+ e.addSuppressed(closeError);
+ }
+ throw e;
+ }
+ }
+
+ private void openNext() {
+ if (stages.hasNext())
+ current = buildLogService.openLogStream(stages.next());
+ else
+ releaseLock();
+ }
+
+ private void releaseLock() {
+ if (lock != null) {
+ lock.readLock().unlock();
+ lock = null;
+ }
+ }
+
+ @Override
+ public int read() throws IOException {
+ var bytes = new byte[1];
+ return read(bytes, 0, 1) == -1 ? -1 : bytes[0] & 0xff;
+ }
+
+ @Override
+ public int read(byte[] bytes, int offset, int length) throws IOException {
+ Objects.checkFromIndexSize(offset, length, bytes.length);
+ if (length == 0)
+ return 0;
+ if (pendingFailure != null)
+ throw pendingFailure;
+ if (closed)
+ throw new IOException("Build log stream is closed");
+ int total = 0;
+ try {
+ while (current != null && total < length) {
+ int count = current.read(bytes, offset + total, length - total);
+ if (count == -1) {
+ current.close();
+ current = null;
+ openNext();
+ } else {
+ total += count;
+ }
+ }
+ } catch (Exception | Error e) {
+ try {
+ close();
+ } catch (IOException closeError) {
+ e.addSuppressed(closeError);
+ }
+ var cause = e instanceof RuntimeException && e.getCause() instanceof IOException ? e.getCause() : e;
+ if (cause instanceof IOException failure) {
+ pendingFailure = failure;
+ if (total == 0)
+ throw failure;
+ } else {
+ throw ExceptionUtils.unchecked(e);
+ }
+ }
+ return total != 0 ? total : -1;
+ }
+
+ @Override
+ public void close() throws IOException {
+ if (!closed) {
+ closed = true;
+ try {
+ if (current != null)
+ current.close();
+ } finally {
+ current = null;
+ releaseLock();
+ }
+ }
+ }
+}
diff --git a/server-core/src/main/java/io/onedev/server/logging/build/BuildLoggingIdentity.java b/server-core/src/main/java/io/onedev/server/logging/build/BuildLoggingIdentity.java
new file mode 100644
index 0000000000..3c2e685249
--- /dev/null
+++ b/server-core/src/main/java/io/onedev/server/logging/build/BuildLoggingIdentity.java
@@ -0,0 +1,50 @@
+package io.onedev.server.logging.build;
+
+import static io.onedev.k8shelper.JobHelper.FINALIZATION;
+import static io.onedev.k8shelper.JobHelper.INITIALIZATION;
+
+import java.io.File;
+import java.util.Objects;
+
+import io.onedev.k8shelper.JobHelper;
+import io.onedev.server.logging.LoggingIdentity;
+import io.onedev.server.model.Build;
+
+/** Identifies the log file of one named build stage. */
+public class BuildLoggingIdentity implements LoggingIdentity {
+
+ private static final long serialVersionUID = 1L;
+
+ private final Long projectId;
+
+ private final Long buildNumber;
+
+ private final String stage;
+
+ public BuildLoggingIdentity(Long projectId, Long buildNumber, String stage) {
+ this.projectId = projectId;
+ this.buildNumber = buildNumber;
+ this.stage = Objects.requireNonNull(stage);
+ }
+
+ @Override
+ public File getFile() {
+ var directory = Build.getLogDir(projectId, buildNumber);
+ return new File(directory, getFileName(stage));
+ }
+
+ public static String getFileName(String stage) {
+ if (stage.equals(INITIALIZATION) || stage.equals(FINALIZATION))
+ return stage + ".log";
+ if (!JobHelper.STEP_ID_PATTERN.matcher(stage).matches())
+ throw new IllegalArgumentException("Invalid build stage: " + stage);
+ JobHelper.parseStepPosition(stage.substring("step-".length()));
+ return stage + ".log";
+ }
+
+ @Override
+ public String getLockName() {
+ return Build.getLogLockName(projectId, buildNumber);
+ }
+
+}
diff --git a/server-core/src/main/java/io/onedev/server/logging/BuildLoggingSupport.java b/server-core/src/main/java/io/onedev/server/logging/build/BuildLoggingSupport.java
similarity index 64%
rename from server-core/src/main/java/io/onedev/server/logging/BuildLoggingSupport.java
rename to server-core/src/main/java/io/onedev/server/logging/build/BuildLoggingSupport.java
index 357f1d1661..d74a0198c5 100644
--- a/server-core/src/main/java/io/onedev/server/logging/BuildLoggingSupport.java
+++ b/server-core/src/main/java/io/onedev/server/logging/build/BuildLoggingSupport.java
@@ -1,37 +1,64 @@
-package io.onedev.server.logging;
+package io.onedev.server.logging.build;
import java.util.Collection;
import java.util.Date;
import java.util.List;
import java.util.Map;
+import java.util.Objects;
import java.util.Set;
import org.apache.commons.lang3.StringUtils;
import org.jspecify.annotations.Nullable;
import io.onedev.server.OneDev;
-import io.onedev.server.buildspec.job.log.instruction.LogInstruction;
import io.onedev.server.cluster.ClusterTask;
import io.onedev.server.event.ListenerRegistry;
import io.onedev.server.event.project.build.BuildUpdated;
+import io.onedev.server.logging.LoggingSupport;
+import io.onedev.server.logging.LoggingIdentity;
+import io.onedev.server.logging.instruction.LogInstruction;
import io.onedev.server.model.Build;
import io.onedev.server.service.BuildService;
import io.onedev.server.service.ProjectService;
+/** Logging support for one named build stage. */
public class BuildLoggingSupport implements LoggingSupport {
private static final long serialVersionUID = 1L;
- private final BuildLoggingIdentity identity;
+ private final Long projectId;
+
+ private final Long buildNumber;
private final Long buildId;
private final Collection<String> maskSecrets;
- public BuildLoggingSupport(Build build) {
- identity = new BuildLoggingIdentity(build.getProject().getId(), build.getNumber());
- buildId = build.getId();
- maskSecrets = build.getMaskSecrets();
+ private final BuildLoggingIdentity identity;
+
+ private final String stage;
+
+ public BuildLoggingSupport(Build build, String stage) {
+ this(build.getProject().getId(), build.getNumber(), build.getId(), build.getMaskSecrets(), stage);
+ }
+
+ /** Storage-only support, constructed without database access on the active server. */
+ BuildLoggingSupport(BuildLogContext context, String stage) {
+ this(context.getProjectId(), context.getBuildNumber(), context.getBuildId(), List.of(), stage);
+ }
+
+ private BuildLoggingSupport(Long projectId, Long buildNumber, Long buildId,
+ Collection<String> maskSecrets, String stage) {
+ this.projectId = projectId;
+ this.buildNumber = buildNumber;
+ this.buildId = buildId;
+ this.maskSecrets = maskSecrets;
+ this.stage = Objects.requireNonNull(stage);
+ identity = new BuildLoggingIdentity(projectId, buildNumber, stage);
+ }
+
+ String getStage() {
+ return stage;
}
@Override
@@ -107,12 +134,12 @@ public class BuildLoggingSupport implements LoggingSupport {
@Override
public <T> T runOnActiveServer(ClusterTask<T> task) {
- return getProjectService().runOnActiveServer(identity.getProjectId(), task);
+ return getProjectService().runOnActiveServer(projectId, task);
}
@Override
public void fileModified() {
- getProjectService().directoryModified(identity.getProjectId(), identity.getFile().getParentFile());
+ getProjectService().directoryModified(projectId, Build.getLogDir(projectId, buildNumber));
}
@Override
@@ -120,4 +147,4 @@ public class BuildLoggingSupport implements LoggingSupport {
return getBuild().getRetryDate();
}
-}
\ No newline at end of file
+}
diff --git a/server-core/src/main/java/io/onedev/server/logging/build/DefaultBuildLogService.java b/server-core/src/main/java/io/onedev/server/logging/build/DefaultBuildLogService.java
new file mode 100644
index 0000000000..c7109f3af1
--- /dev/null
+++ b/server-core/src/main/java/io/onedev/server/logging/build/DefaultBuildLogService.java
@@ -0,0 +1,268 @@
+package io.onedev.server.logging.build;
+
+import static io.onedev.commons.utils.LockUtils.read;
+import static io.onedev.commons.utils.LockUtils.write;
+
+import java.io.InputStream;
+import java.io.ObjectStreamException;
+import java.io.Serializable;
+import java.util.Comparator;
+import java.util.List;
+import java.util.Objects;
+import java.util.concurrent.ExecutionException;
+import java.util.function.BooleanSupplier;
+import java.util.regex.Pattern;
+
+import org.jspecify.annotations.Nullable;
+
+import com.google.common.cache.Cache;
+import com.google.common.cache.CacheBuilder;
+
+import io.onedev.commons.loader.ManagedSerializedForm;
+import io.onedev.commons.utils.ExceptionUtils;
+import io.onedev.commons.utils.TaskLogger;
+import io.onedev.server.OneDev;
+import io.onedev.server.cluster.ClusterTask;
+import io.onedev.server.logging.LogEntry;
+import io.onedev.server.logging.LogListener;
+import io.onedev.server.logging.LogService;
+import io.onedev.server.logging.LogSnippet;
+import io.onedev.server.logging.LoggingIdentity;
+import io.onedev.server.logging.LoggingSupport;
+import io.onedev.server.model.Build;
+import io.onedev.server.persistence.SessionService;
+import io.onedev.server.service.BuildService;
+import jakarta.inject.Inject;
+import jakarta.inject.Singleton;
+
+@Singleton
+public class DefaultBuildLogService implements BuildLogService, Serializable {
+
+ @Inject
+ private LogService logService;
+
+ @Inject
+ private SessionService sessionService;
+
+ @Inject
+ private BuildService buildService;
+
+ // Retain the current stage until finish; losing a router must not orphan a cached snippet.
+ private final Cache<String, BuildLogRouter> routers = CacheBuilder.newBuilder().build();
+
+ public Object writeReplace() throws ObjectStreamException {
+ return new ManagedSerializedForm(BuildLogService.class);
+ }
+
+ @Override
+ public TaskLogger newLogger(LoggingSupport loggingSupport) {
+ return logService.newLogger(loggingSupport);
+ }
+
+ @Override
+ public TaskLogger newLogger(LoggingSupport loggingSupport, BooleanSupplier acceptingEntries) {
+ return logService.newLogger(loggingSupport, acceptingEntries);
+ }
+
+ @Override
+ public List<LogEntry> readLogEntries(LoggingSupport loggingSupport, int offset, int count) {
+ return logService.readLogEntries(loggingSupport, offset, count);
+ }
+
+ @Override
+ public List<LogEntry> readLogEntries(LoggingIdentity identity, int offset, int count) {
+ return logService.readLogEntries(identity, offset, count);
+ }
+
+ @Override
+ public void registerListener(LogListener listener) {
+ logService.registerListener(listener);
+ }
+
+ @Override
+ public void deregisterListener(LogListener listener) {
+ logService.deregisterListener(listener);
+ }
+
+ @Override
+ public boolean matches(LoggingSupport loggingSupport, Pattern pattern) {
+ return logService.matches(loggingSupport, pattern);
+ }
+
+ @Override
+ public void flush(LoggingSupport loggingSupport) {
+ logService.flush(loggingSupport);
+ }
+
+ @Override
+ public void clear(LoggingSupport loggingSupport) {
+ logService.clear(loggingSupport);
+ }
+
+ @Override
+ public LogSnippet readLogSnippetReversely(LoggingSupport loggingSupport, int count) {
+ return logService.readLogSnippetReversely(loggingSupport, count);
+ }
+
+ @Override
+ public LogSnippet readLogSnippetReversely(LoggingIdentity identity, int count) {
+ return logService.readLogSnippetReversely(identity, count);
+ }
+
+ @Override
+ public InputStream openLogStream(LoggingIdentity loggingIdentity) {
+ return logService.openLogStream(loggingIdentity);
+ }
+
+ @Override
+ public @Nullable TaskLogger getLogger(String token) {
+ return logService.getLogger(token);
+ }
+
+ @Override
+ public void addLogger(String token, TaskLogger logger) {
+ logService.addLogger(token, logger);
+ }
+
+ @Override
+ public void removeLogger(String token) {
+ logService.removeLogger(token);
+ }
+
+ @Override
+ public TaskLogger newLogger(Build build) {
+ return build.getFinishDate() == null ? getRouter(build) : new BuildLogRouter(build, this);
+ }
+
+ private BuildLogRouter getRouter(Build build) {
+ try {
+ return routers.get(build.getToken(), () -> new BuildLogRouter(build, this));
+ } catch (ExecutionException e) {
+ throw ExceptionUtils.unchecked(e);
+ }
+ }
+
+ private List<BuildLoggingSupport> getStageSupports(BuildLogContext context) {
+ return sessionService.call(() -> {
+ var build = buildService.load(context.getBuildId());
+ return build.getLogStages().stream().map(it -> new BuildLoggingSupport(build, it)).toList();
+ });
+ }
+
+ @Override
+ public boolean matches(BuildLogContext context, Pattern pattern) {
+ return getStageSupports(context).stream().anyMatch(it -> logService.matches(it, pattern));
+ }
+
+ @Override
+ public void finish(Build build) {
+ var router = routers.getIfPresent(build.getToken());
+ if (router != null) {
+ router.finish();
+ routers.asMap().remove(build.getToken(), router);
+ }
+ }
+
+ @Override
+ public InputStream openLogStream(List<? extends LoggingIdentity> stages) {
+ return new BuildLogStream(stages, this);
+ }
+
+ private record SnapshotMetadata(String logVersion, List<BuildLoggingSupport> stages) implements Serializable {
+ }
+
+ @Override
+ public BuildLogSnapshot readSnapshot(BuildLogContext context,
+ BuildLogSnapshot previous, int tailCount) {
+ var previousOffsets = previous != null ? previous.offsets : null;
+ var previousVersion = previous != null ? previous.logVersion : null;
+ while (true) {
+ // Read database metadata on the caller, which may already hold database locks.
+ // The active-server task must not wait for those locks while the caller waits for it.
+ var metadata = OneDev.getInstance(SessionService.class).call(() ->
+ new SnapshotMetadata(context.getLogVersion(), getStageSupports(context)));
+ var snapshot = context.runOnActiveServer(new ClusterTask<BuildLogSnapshot>() {
+
+ private static final long serialVersionUID = 1L;
+
+ @Override
+ public BuildLogSnapshot call() {
+ // Keep entries and their offsets together under the shared build lock.
+ return read(context.getStorage().getLockName(), () -> {
+ var result = new BuildLogSnapshot();
+ result.logVersion = metadata.logVersion();
+ var offsets = Objects.equals(previousVersion, result.logVersion) ? previousOffsets : null;
+ for (var stage : metadata.stages()) {
+ if (offsets == null) {
+ var snippet = logService.readLogSnippetReversely(stage.getIdentity(), tailCount);
+ result.offsets.put(stage.getStage(), snippet.offset + snippet.entries.size());
+ result.entries.addAll(snippet.entries);
+ } else {
+ int offset = offsets.getOrDefault(stage.getStage(), 0);
+ var entries = logService.readLogEntries(stage.getIdentity(), offset, 0);
+ result.offsets.put(stage.getStage(), offset + entries.size());
+ result.entries.addAll(entries);
+ }
+ if (offsets == null) {
+ result.entries.sort(Comparator.comparing(LogEntry::getDate));
+ if (result.entries.size() > tailCount)
+ result.entries.subList(0, result.entries.size() - tailCount).clear();
+ }
+ }
+ // Merge concurrent stage output by entry time, retaining stage order for equal timestamps.
+ if (offsets != null)
+ result.entries.sort(Comparator.comparing(LogEntry::getDate));
+ return result;
+ });
+ }
+
+ });
+ // Check for an attempt change on the caller after the task releases the log lock.
+ if (Objects.equals(metadata.logVersion(), context.getLogVersion()))
+ return snapshot;
+ }
+ }
+
+ @Override
+ public void clear(BuildLogContext context) {
+ context.runOnActiveServer(new ClusterTask<Void>() {
+
+ private static final long serialVersionUID = 1L;
+
+ @Override
+ public Void call() {
+ var router = routers.getIfPresent(context.getToken());
+ if (router != null)
+ router.reset(() -> clearStages(context));
+ else
+ clearStages(context);
+ context.fileModified();
+ return null;
+ }
+ });
+ }
+
+ private void clearStages(BuildLogContext context) {
+ write(context.getStorage().getLockName(), () -> {
+ var directory = context.getStorage().getDirectory();
+ var files = directory.listFiles();
+ if (files != null) {
+ for (var file : files) {
+ var name = file.getName();
+ if (file.isFile() && name.endsWith(".log")) {
+ var stage = name.substring(0, name.length() - 4);
+ logService.clear(new BuildLoggingSupport(context, stage) {
+
+ @Override
+ public void fileModified() {
+ }
+
+ });
+ }
+ }
+ }
+ return null;
+ });
+ }
+
+}
diff --git a/server-core/src/main/java/io/onedev/server/buildspec/job/log/instruction/LogInstruction.g4 b/server-core/src/main/java/io/onedev/server/logging/instruction/LogInstruction.g4
similarity index 100%
rename from server-core/src/main/java/io/onedev/server/buildspec/job/log/instruction/LogInstruction.g4
rename to server-core/src/main/java/io/onedev/server/logging/instruction/LogInstruction.g4
diff --git a/server-core/src/main/java/io/onedev/server/buildspec/job/log/instruction/LogInstruction.java b/server-core/src/main/java/io/onedev/server/logging/instruction/LogInstruction.java
similarity index 91%
rename from server-core/src/main/java/io/onedev/server/buildspec/job/log/instruction/LogInstruction.java
rename to server-core/src/main/java/io/onedev/server/logging/instruction/LogInstruction.java
index 86b3e6a50c..bde72c356c 100644
--- a/server-core/src/main/java/io/onedev/server/buildspec/job/log/instruction/LogInstruction.java
+++ b/server-core/src/main/java/io/onedev/server/logging/instruction/LogInstruction.java
@@ -1,4 +1,4 @@
-package io.onedev.server.buildspec.job.log.instruction;
+package io.onedev.server.logging.instruction;
import java.util.List;
import java.util.Map;
@@ -15,7 +15,7 @@ import org.antlr.v4.runtime.tree.TerminalNode;
import io.onedev.commons.codeassist.FenceAware;
import io.onedev.commons.loader.ExtensionPoint;
import io.onedev.commons.utils.StringUtils;
-import io.onedev.server.buildspec.job.log.instruction.LogInstructionParser.InstructionContext;
+import io.onedev.server.logging.instruction.LogInstructionParser.InstructionContext;
@ExtensionPoint
public abstract class LogInstruction {
diff --git a/server-core/src/main/java/io/onedev/server/logging/WorkspaceLoggingIdentity.java b/server-core/src/main/java/io/onedev/server/logging/workspace/WorkspaceLoggingIdentity.java
similarity index 64%
rename from server-core/src/main/java/io/onedev/server/logging/WorkspaceLoggingIdentity.java
rename to server-core/src/main/java/io/onedev/server/logging/workspace/WorkspaceLoggingIdentity.java
index 0ad12ce452..20cc5bc727 100644
--- a/server-core/src/main/java/io/onedev/server/logging/WorkspaceLoggingIdentity.java
+++ b/server-core/src/main/java/io/onedev/server/logging/workspace/WorkspaceLoggingIdentity.java
@@ -1,12 +1,13 @@
-package io.onedev.server.logging;
+package io.onedev.server.logging.workspace;
import java.io.File;
import io.onedev.server.OneDev;
+import io.onedev.server.logging.LoggingIdentity;
import io.onedev.server.model.Workspace;
import io.onedev.server.workspace.WorkspaceService;
-public class WorkspaceLoggingIdentity implements LoggingIdentity {
+class WorkspaceLoggingIdentity implements LoggingIdentity {
private static final long serialVersionUID = 1L;
@@ -14,16 +15,16 @@ public class WorkspaceLoggingIdentity implements LoggingIdentity {
private final Long workspaceNumber;
- public WorkspaceLoggingIdentity(Long projectId, Long workspaceNumber) {
+ WorkspaceLoggingIdentity(Long projectId, Long workspaceNumber) {
this.projectId = projectId;
this.workspaceNumber = workspaceNumber;
}
- public Long getProjectId() {
+ Long getProjectId() {
return projectId;
}
- public Long getWorkspaceNumber() {
+ Long getWorkspaceNumber() {
return workspaceNumber;
}
@@ -37,9 +38,4 @@ public class WorkspaceLoggingIdentity implements LoggingIdentity {
return Workspace.getLogLockName(projectId, workspaceNumber);
}
- @Override
- public String getCacheKey() {
- return "workspace-log:" + projectId + ":" + workspaceNumber;
- }
-
}
diff --git a/server-core/src/main/java/io/onedev/server/logging/WorkspaceLoggingSupport.java b/server-core/src/main/java/io/onedev/server/logging/workspace/WorkspaceLoggingSupport.java
similarity index 87%
rename from server-core/src/main/java/io/onedev/server/logging/WorkspaceLoggingSupport.java
rename to server-core/src/main/java/io/onedev/server/logging/workspace/WorkspaceLoggingSupport.java
index 5d2aeb5989..9ee85a34f5 100644
--- a/server-core/src/main/java/io/onedev/server/logging/WorkspaceLoggingSupport.java
+++ b/server-core/src/main/java/io/onedev/server/logging/workspace/WorkspaceLoggingSupport.java
@@ -1,4 +1,4 @@
-package io.onedev.server.logging;
+package io.onedev.server.logging.workspace;
import java.util.Collection;
import java.util.Date;
@@ -7,8 +7,10 @@ import java.util.Set;
import org.jspecify.annotations.Nullable;
import io.onedev.server.OneDev;
-import io.onedev.server.buildspec.job.log.instruction.LogInstruction;
import io.onedev.server.cluster.ClusterTask;
+import io.onedev.server.logging.LoggingIdentity;
+import io.onedev.server.logging.LoggingSupport;
+import io.onedev.server.logging.instruction.LogInstruction;
import io.onedev.server.model.Workspace;
import io.onedev.server.service.ProjectService;
@@ -33,7 +35,7 @@ public class WorkspaceLoggingSupport implements LoggingSupport {
return identity;
}
- public Long getWorkspaceId() {
+ Long getWorkspaceId() {
return workspaceId;
}
diff --git a/server-core/src/main/java/io/onedev/server/model/Build.java b/server-core/src/main/java/io/onedev/server/model/Build.java
index 286be16d79..cd183710a6 100644
--- a/server-core/src/main/java/io/onedev/server/model/Build.java
+++ b/server-core/src/main/java/io/onedev/server/model/Build.java
@@ -1,5 +1,7 @@
package io.onedev.server.model;
+import static io.onedev.k8shelper.JobHelper.FINALIZATION;
+import static io.onedev.k8shelper.JobHelper.INITIALIZATION;
import static io.onedev.server.model.AbstractEntity.PROP_NUMBER;
import static io.onedev.server.model.Build.PROP_COMMIT_HASH;
import static io.onedev.server.model.Build.PROP_FINISH_DATE;
@@ -68,6 +70,7 @@ import com.google.common.collect.Sets;
import io.onedev.commons.bootstrap.SecretMasker;
import io.onedev.commons.utils.ExplicitException;
+import io.onedev.k8shelper.JobHelper;
import io.onedev.server.OneDev;
import io.onedev.server.annotation.Editable;
import io.onedev.server.annotation.Markdown;
@@ -85,8 +88,8 @@ import io.onedev.server.entityreference.EntityReference;
import io.onedev.server.git.GitUtils;
import io.onedev.server.git.service.GitService;
import io.onedev.server.job.JobAuthorizationContext;
-import io.onedev.server.logging.BuildLoggingSupport;
-import io.onedev.server.logging.LoggingSupport;
+import io.onedev.server.logging.build.BuildLogContext;
+import io.onedev.server.model.support.build.StepExecution;
import io.onedev.server.model.support.BuildMetric;
import io.onedev.server.model.support.LabelSupport;
import io.onedev.server.model.support.ProjectBelonging;
@@ -128,7 +131,7 @@ public class Build extends ProjectBelonging
public static final String ARTIFACTS_DIR = "artifacts";
- public static final String LOG_FILE = "build.log";
+ public static final String LOG_DIR = "log";
public static final int MAX_DESCRIPTION_LEN = 12000;
@@ -244,31 +247,6 @@ public class Build extends ProjectBelonging
private static ThreadLocal<Stack<Build>> stack = ThreadLocal.withInitial(Stack::new);
- public static File getLogFile(Long projectId, Long buildNumber) {
- File buildDir = OneDev.getInstance(BuildService.class).getBuildDir(projectId, buildNumber);
- return new File(buildDir, LOG_FILE);
- }
-
- public static String getProjectRelativeDirPath(Long buildNumber) {
- return BUILDS_DIR + "/" + getRelativeDirPath(buildNumber);
- }
-
- public static String getRelativeDirPath(Long buildNumber) {
- return String.format("s%03d", buildNumber%1000) + "/" + buildNumber;
- }
-
- public File getLogFile() {
- return getLogFile(getProject().getId(), getNumber());
- }
-
- public static String getLogLockName(Long projectId, Long buildNumber) {
- return "build-log: " + projectId + ":" + buildNumber;
- }
-
- public String getLogLockName() {
- return getLogLockName(getProject().getId(), getNumber());
- }
-
public enum Status {
// Most significant status comes first, refer to getOverallStatus
WAITING {
@@ -407,6 +385,11 @@ public class Build extends ProjectBelonging
@Column(nullable=false)
private Status status;
+ @Lob
+ private LinkedHashMap<String, StepExecution> stepExecutions = new LinkedHashMap<>();
+
+ private boolean finalization;
+
private boolean paused;
@Column(nullable=false)
@@ -833,6 +816,67 @@ public class Build extends ProjectBelonging
this.issue = issue;
}
+ public boolean isFinalization() {
+ return finalization;
+ }
+
+ public void setFinalization(boolean finalization) {
+ this.finalization = finalization;
+ }
+
+ public String getCurrentLogStage() {
+ if (finalization)
+ return FINALIZATION;
+ var stage = INITIALIZATION;
+ for (var step : getStepExecutions().keySet())
+ stage = step;
+ return stage;
+ }
+
+ public List<String> getLogStages() {
+ var stages = new ArrayList<String>();
+ stages.add(INITIALIZATION);
+ stages.addAll(getStepExecutions().keySet());
+ if (finalization)
+ stages.add(FINALIZATION);
+ return stages;
+ }
+
+ public Map<String, StepExecution> getStepExecutions() {
+ return stepExecutions;
+ }
+
+ /** Resolve a log stage's title, including step names from this build's recorded spec. */
+ public String getLogStageName(String stage) {
+ if (stage.equals(INITIALIZATION))
+ return "Initialization";
+ if (stage.equals(FINALIZATION))
+ return "Finalization";
+ if (!stage.startsWith("step-") || getJob() == null)
+ return stage;
+ var position = JobHelper.parseStepPosition(stage.substring(5));
+ var steps = getJob().getSteps();
+ var names = new ArrayList<String>();
+ for (int depth = 0; depth < position.size(); depth++) {
+ int index = position.get(depth);
+ if (steps.isEmpty() || index < 0 || (depth == 0 && index >= steps.size()))
+ return stage;
+ // Template parameter combinations repeat the template's action list.
+ var step = steps.get(index % steps.size());
+ int repeat = index / steps.size() + 1;
+ names.add(step.getName() + (repeat > 1 ? " (" + repeat + ")" : ""));
+ if (depth < position.size() - 1) {
+ if (!(step instanceof io.onedev.server.buildspec.step.UseTemplateStep templateStep))
+ return stage;
+ var template = getSpec().getStepTemplateMap().get(templateStep.getTemplateName());
+ if (template == null)
+ return stage;
+ steps = template.getSteps();
+ }
+ }
+ return String.join(" -> ", names);
+ }
+
public Map<String, List<String>> getParamMap() {
if (paramMap == null) {
paramMap = new HashMap<>();
@@ -997,11 +1041,11 @@ public class Build extends ProjectBelonging
return streamPreviousCache.get(status);
}
- private GitService getGitService() {
+ private static GitService getGitService() {
return OneDev.getInstance(GitService.class);
}
- private BuildService getBuildService() {
+ private static BuildService getBuildService() {
return OneDev.getInstance(BuildService.class);
}
@@ -1153,8 +1197,33 @@ public class Build extends ProjectBelonging
return caption;
}
- public LoggingSupport getLoggingSupport() {
- return new BuildLoggingSupport(this);
+ public BuildLogContext getLogContext() {
+ return new BuildLogContext(this);
+ }
+
+ public static File getLogDir(Long projectId, Long buildNumber) {
+ File buildDir = getBuildService().getBuildDir(projectId, buildNumber);
+ return new File(buildDir, LOG_DIR);
+ }
+
+ public static String getProjectRelativeDirPath(Long buildNumber) {
+ return BUILDS_DIR + "/" + getRelativeDirPath(buildNumber);
+ }
+
+ public static String getRelativeDirPath(Long buildNumber) {
+ return String.format("s%03d", buildNumber%1000) + "/" + buildNumber;
+ }
+
+ public File getLogDir() {
+ return getLogDir(getProject().getId(), getNumber());
+ }
+
+ public static String getLogLockName(Long projectId, Long buildNumber) {
+ return "build-log: " + projectId + ":" + buildNumber;
+ }
+
+ public String getLogLockName() {
+ return getLogLockName(getProject().getId(), getNumber());
}
}
diff --git a/server-core/src/main/java/io/onedev/server/model/Workspace.java b/server-core/src/main/java/io/onedev/server/model/Workspace.java
index 0907e65cca..0e419d8142 100644
--- a/server-core/src/main/java/io/onedev/server/model/Workspace.java
+++ b/server-core/src/main/java/io/onedev/server/model/Workspace.java
@@ -35,7 +35,7 @@ import io.onedev.server.OneDev;
import io.onedev.server.cluster.ClusterService;
import io.onedev.server.entityreference.WorkspaceReference;
import io.onedev.server.git.GitUtils;
-import io.onedev.server.logging.WorkspaceLoggingSupport;
+import io.onedev.server.logging.workspace.WorkspaceLoggingSupport;
import io.onedev.server.model.support.workspace.spec.WorkspaceSpec;
import io.onedev.server.search.entity.SortField;
import io.onedev.server.web.util.TextUtils;
diff --git a/server-core/src/main/java/io/onedev/server/model/support/administration/jobexecutor/JobExecutor.java b/server-core/src/main/java/io/onedev/server/model/support/administration/jobexecutor/JobExecutor.java
index 91a282ad46..d27b7f055c 100644
--- a/server-core/src/main/java/io/onedev/server/model/support/administration/jobexecutor/JobExecutor.java
+++ b/server-core/src/main/java/io/onedev/server/model/support/administration/jobexecutor/JobExecutor.java
@@ -78,6 +78,10 @@ public abstract class JobExecutor implements Serializable {
return WicketUtils.isSubscriptionActive();
}
+ /**
+ * Callers must not hold a database connection: execution may wait for tasks
+ * that need database access, which could otherwise cause a circular wait.
+ */
public abstract boolean execute(JobContext jobContext, TaskLogger jobLogger);
public abstract boolean isApplicable(JobMatchContext context);
diff --git a/server-core/src/main/java/io/onedev/server/model/support/build/StepExecution.java b/server-core/src/main/java/io/onedev/server/model/support/build/StepExecution.java
new file mode 100644
index 0000000000..74372cb7cc
--- /dev/null
+++ b/server-core/src/main/java/io/onedev/server/model/support/build/StepExecution.java
@@ -0,0 +1,59 @@
+package io.onedev.server.model.support.build;
+
+import java.io.Serializable;
+
+/** Status and timing of an executed step, excluding initialization and finalization. */
+public class StepExecution implements Serializable {
+ private static final long serialVersionUID = 1L;
+
+ public enum Status {
+ RUNNING, SUCCESSFUL, FAILED, CANCELLED
+ }
+
+ private Status status = Status.RUNNING;
+ private long duration;
+ private long startedAt = System.currentTimeMillis();
+ private boolean skipped;
+ private int stepIndex;
+ private int stepCount;
+
+ public int getStepIndex() {
+ return stepIndex;
+ }
+
+ public int getStepCount() {
+ return stepCount;
+ }
+
+ public void setStepPosition(int stepIndex, int stepCount) {
+ this.stepIndex = stepIndex;
+ this.stepCount = stepCount;
+ }
+
+ public Status getStatus() {
+ return status;
+ }
+
+ public boolean isSkipped() {
+ return skipped;
+ }
+
+ /** Running time in milliseconds for this execution. */
+ public long getDuration() {
+ return duration + (status == Status.RUNNING ? Math.max(0, System.currentTimeMillis() - startedAt) : 0);
+ }
+
+ /** Record the step or build outcome, preserving an already completed execution. */
+ public void complete(Status status) {
+ if (this.status == Status.RUNNING) {
+ duration = getDuration();
+ this.status = status;
+ }
+ }
+
+ public void skip() {
+ complete(Status.CANCELLED);
+ skipped = true;
+ }
+
+}
diff --git a/server-core/src/main/java/io/onedev/server/rest/resource/BuildLogStreamResource.java b/server-core/src/main/java/io/onedev/server/rest/resource/BuildLogStreamResource.java
index 130f71e545..9888c8f0f7 100644
--- a/server-core/src/main/java/io/onedev/server/rest/resource/BuildLogStreamResource.java
+++ b/server-core/src/main/java/io/onedev/server/rest/resource/BuildLogStreamResource.java
@@ -1,31 +1,36 @@
package io.onedev.server.rest.resource;
+import static jakarta.ws.rs.core.MediaType.APPLICATION_OCTET_STREAM;
+import static java.nio.charset.StandardCharsets.UTF_8;
+
+import java.io.IOException;
+import java.io.OutputStream;
+import java.nio.ByteBuffer;
+
+import org.apache.shiro.authz.UnauthorizedException;
+
import com.fasterxml.jackson.databind.ObjectMapper;
-import io.onedev.server.buildspec.job.log.JobLogEntryEx;
-import io.onedev.server.service.BuildService;
-import io.onedev.server.logging.BuildLoggingSupport;
+
+import io.onedev.server.logging.LogEntry;
import io.onedev.server.logging.LogListener;
-import io.onedev.server.logging.LogService;
-import io.onedev.server.logging.LogSnippet;
import io.onedev.server.logging.LoggingSupport;
+import io.onedev.server.logging.build.BuildLogService;
+import io.onedev.server.logging.build.BuildLoggingSupport;
import io.onedev.server.model.Build;
import io.onedev.server.model.Build.Status;
import io.onedev.server.persistence.SessionService;
import io.onedev.server.rest.annotation.Api;
import io.onedev.server.security.SecurityUtils;
-import org.apache.shiro.authz.UnauthorizedException;
-
+import io.onedev.server.service.BuildService;
import jakarta.inject.Inject;
import jakarta.inject.Singleton;
-import jakarta.ws.rs.*;
+import jakarta.ws.rs.Consumes;
+import jakarta.ws.rs.GET;
+import jakarta.ws.rs.Path;
+import jakarta.ws.rs.PathParam;
+import jakarta.ws.rs.Produces;
import jakarta.ws.rs.core.MediaType;
import jakarta.ws.rs.core.StreamingOutput;
-import java.io.IOException;
-import java.io.OutputStream;
-import java.nio.ByteBuffer;
-
-import static java.nio.charset.StandardCharsets.UTF_8;
-import static jakarta.ws.rs.core.MediaType.APPLICATION_OCTET_STREAM;
@Api(description="Build log stream resource is operated with build id, which is different from build number. "
+ "To get build id of a particular build number, use the <a href='/~help/api/io.onedev.server.rest.BuildResource/queryBasicInfo'>Query Basic Info</a> operation with query for "
@@ -40,17 +45,17 @@ public class BuildLogStreamResource {
private final BuildService buildService;
- private final LogService logService;
+ private final BuildLogService buildLogService;
private final ObjectMapper objectMapper;
private final SessionService sessionService;
@Inject
- public BuildLogStreamResource(BuildService buildService, LogService logService,
+ public BuildLogStreamResource(BuildService buildService, BuildLogService buildLogService,
ObjectMapper objectMapper, SessionService sessionService) {
this.buildService = buildService;
- this.logService = logService;
+ this.buildLogService = buildLogService;
this.objectMapper = objectMapper;
this.sessionService = sessionService;
}
@@ -64,7 +69,7 @@ public class BuildLogStreamResource {
if (!SecurityUtils.canAccessLog(build))
throw new UnauthorizedException();
- var loggingSupport = build.getLoggingSupport();
+ var logContext = build.getLogContext();
var buildStatus = build.getStatus();
return os -> {
@@ -72,8 +77,8 @@ public class BuildLogStreamResource {
var logListener = new LogListener() {
@Override
- public void logged(LoggingSupport loggingSupport) {
- if (loggingSupport instanceof BuildLoggingSupport buildLoggingSupport
+ public void logged(LoggingSupport support) {
+ if (support instanceof BuildLoggingSupport buildLoggingSupport
&& buildLoggingSupport.getBuildId().equals(buildId)) {
synchronized (os) {
os.notify();
@@ -82,13 +87,11 @@ public class BuildLogStreamResource {
}
};
- logService.registerListener(logListener);
+ buildLogService.registerListener(logListener);
sessionService.closeSession();
try {
- var nextOffset = 0;
- LogSnippet snippet = logService.readLogSnippetReversely(loggingSupport, MAX_LOG_ENTRIES + 1);
- nextOffset = snippet.offset + snippet.entries.size();
- for (var entry : snippet.entries)
+ var snapshot = buildLogService.readSnapshot(logContext, null, MAX_LOG_ENTRIES + 1);
+ for (var entry : snapshot.entries)
writeEntry(os, entry);
while (true) {
@@ -98,10 +101,9 @@ public class BuildLogStreamResource {
} catch (InterruptedException e) {
throw new RuntimeException(e);
}
- var entries = logService.readLogEntries(loggingSupport, nextOffset, 0);
- if (!entries.isEmpty()) {
- nextOffset += entries.size();
- for (var entry : entries)
+ snapshot = buildLogService.readSnapshot(logContext, snapshot, MAX_LOG_ENTRIES + 1);
+ if (!snapshot.entries.isEmpty()) {
+ for (var entry : snapshot.entries)
writeEntry(os, entry);
} else {
var innerBuildStatus = sessionService.call(() -> buildService.load(buildId).getStatus());
@@ -117,7 +119,7 @@ public class BuildLogStreamResource {
}
} finally {
sessionService.openSession();
- logService.deregisterListener(logListener);
+ buildLogService.deregisterListener(logListener);
}
};
}
@@ -140,7 +142,7 @@ public class BuildLogStreamResource {
}
}
- private void writeEntry(OutputStream os, JobLogEntryEx entry) {
+ private void writeEntry(OutputStream os, LogEntry entry) {
try {
var bytes = objectMapper.writeValueAsBytes(entry.transformEmojis());
writeInt(os, bytes.length);
diff --git a/server-core/src/main/java/io/onedev/server/rest/resource/WorkerResource.java b/server-core/src/main/java/io/onedev/server/rest/resource/WorkerResource.java
index cd1459b2e1..a4fb20204a 100644
--- a/server-core/src/main/java/io/onedev/server/rest/resource/WorkerResource.java
+++ b/server-core/src/main/java/io/onedev/server/rest/resource/WorkerResource.java
@@ -342,6 +342,12 @@ public class WorkerResource {
return Response.ok().build();
}
+ @Path("job-running")
+ @GET
+ public boolean isJobRunning(@QueryParam("token") String token) {
+ return jobService.getJobContext(token, false) != null;
+ }
+
@Path("workspace-active")
@GET
public boolean isWorkspaceActive(@QueryParam("token") String token) {
diff --git a/server-core/src/main/java/io/onedev/server/service/impl/DefaultBuildService.java b/server-core/src/main/java/io/onedev/server/service/impl/DefaultBuildService.java
index 6a973d4538..880b560a5e 100644
--- a/server-core/src/main/java/io/onedev/server/service/impl/DefaultBuildService.java
+++ b/server-core/src/main/java/io/onedev/server/service/impl/DefaultBuildService.java
@@ -6,7 +6,7 @@ import static io.onedev.commons.utils.LockUtils.write;
import static io.onedev.k8shelper.KubernetesHelper.BEARER;
import static io.onedev.k8shelper.KubernetesHelper.checkStatus;
import static io.onedev.server.model.Build.ARTIFACTS_DIR;
-import static io.onedev.server.model.Build.LOG_FILE;
+import static io.onedev.server.model.Build.LOG_DIR;
import static io.onedev.server.model.Build.PROP_FINISH_DATE;
import static io.onedev.server.model.Build.PROP_FINISH_TIME_GROUPS;
import static io.onedev.server.model.Build.PROP_PENDING_DURATION;
@@ -22,9 +22,9 @@ import static io.onedev.server.model.Project.SHARE_TEST_DIR;
import static io.onedev.server.search.entity.EntitySort.Direction.ASCENDING;
import static io.onedev.server.util.IOUtils.BUFFER_SIZE;
import static io.onedev.server.util.SiteSyncUtils.isVersionFile;
+import static jakarta.ws.rs.core.HttpHeaders.AUTHORIZATION;
import static java.lang.Long.valueOf;
import static java.util.Arrays.asList;
-import static jakarta.ws.rs.core.HttpHeaders.AUTHORIZATION;
import java.io.BufferedOutputStream;
import java.io.File;
@@ -50,33 +50,12 @@ import java.util.Set;
import java.util.concurrent.atomic.AtomicInteger;
import java.util.stream.Collectors;
-import jakarta.inject.Inject;
-import jakarta.inject.Singleton;
-import jakarta.persistence.criteria.CriteriaBuilder;
-import jakarta.persistence.criteria.CriteriaQuery;
-import jakarta.persistence.criteria.From;
-import jakarta.persistence.criteria.Path;
-import jakarta.persistence.criteria.Predicate;
-import jakarta.persistence.criteria.Root;
-import jakarta.persistence.criteria.Selection;
-import jakarta.ws.rs.client.Client;
-import jakarta.ws.rs.client.ClientBuilder;
-import jakarta.ws.rs.client.Entity;
-import jakarta.ws.rs.client.Invocation;
-import jakarta.ws.rs.client.WebTarget;
-import jakarta.ws.rs.core.MediaType;
-import jakarta.ws.rs.core.Response;
-import jakarta.ws.rs.core.StreamingOutput;
-
import org.apache.commons.lang3.tuple.ImmutablePair;
import org.apache.commons.lang3.tuple.Pair;
import org.apache.shiro.subject.Subject;
import org.eclipse.jgit.lib.ObjectId;
import org.glassfish.jersey.client.ClientProperties;
import org.hibernate.Session;
-import io.onedev.server.persistence.dao.MatchMode;
-import io.onedev.server.persistence.dao.Order;
-import io.onedev.server.persistence.dao.Restrictions;
import org.hibernate.query.Query;
import org.hibernate.query.sqm.tree.domain.SqmPath;
import org.jspecify.annotations.Nullable;
@@ -99,11 +78,9 @@ import io.onedev.server.data.DataService;
import io.onedev.server.event.Listen;
import io.onedev.server.event.entity.EntityPersisted;
import io.onedev.server.event.entity.EntityRemoved;
-import io.onedev.server.event.project.build.BuildFinished;
import io.onedev.server.event.system.SystemStarting;
import io.onedev.server.event.system.SystemStopping;
import io.onedev.server.git.service.GitService;
-import io.onedev.server.logging.LogService;
import io.onedev.server.model.Agent;
import io.onedev.server.model.Build;
import io.onedev.server.model.Build.Status;
@@ -120,6 +97,9 @@ import io.onedev.server.persistence.TransactionService;
import io.onedev.server.persistence.annotation.Sessional;
import io.onedev.server.persistence.annotation.Transactional;
import io.onedev.server.persistence.dao.EntityCriteria;
+import io.onedev.server.persistence.dao.MatchMode;
+import io.onedev.server.persistence.dao.Order;
+import io.onedev.server.persistence.dao.Restrictions;
import io.onedev.server.replica.BuildStorageSyncer;
import io.onedev.server.search.entity.EntityQuery;
import io.onedev.server.search.entity.EntitySort;
@@ -147,6 +127,23 @@ import io.onedev.server.util.concurrent.Prioritized;
import io.onedev.server.util.criteria.Criteria;
import io.onedev.server.util.facade.BuildFacade;
import io.onedev.server.web.util.StatsGroup;
+import jakarta.inject.Inject;
+import jakarta.inject.Singleton;
+import jakarta.persistence.criteria.CriteriaBuilder;
+import jakarta.persistence.criteria.CriteriaQuery;
+import jakarta.persistence.criteria.From;
+import jakarta.persistence.criteria.Path;
+import jakarta.persistence.criteria.Predicate;
+import jakarta.persistence.criteria.Root;
+import jakarta.persistence.criteria.Selection;
+import jakarta.ws.rs.client.Client;
+import jakarta.ws.rs.client.ClientBuilder;
+import jakarta.ws.rs.client.Entity;
+import jakarta.ws.rs.client.Invocation;
+import jakarta.ws.rs.client.WebTarget;
+import jakarta.ws.rs.core.MediaType;
+import jakarta.ws.rs.core.Response;
+import jakarta.ws.rs.core.StreamingOutput;
@Singleton
public class DefaultBuildService extends BaseEntityService<Build> implements BuildService, SchedulableTask, Serializable {
@@ -176,9 +173,6 @@ public class DefaultBuildService extends BaseEntityService<Build> implements Bui
@Inject
private BuildLabelService labelService;
-
- @Inject
- private LogService logService;
@Inject
private ClusterService clusterService;
@@ -305,11 +299,6 @@ public class DefaultBuildService extends BaseEntityService<Build> implements Bui
}
}
- @Listen
- public void on(BuildFinished event) {
- logService.flush(event.getBuild().getLoggingSupport());
- }
-
@Sessional
@Override
public Collection<Build> query(Project project, ObjectId commitId) {
@@ -1219,7 +1208,7 @@ public class DefaultBuildService extends BaseEntityService<Build> implements Bui
projectService.syncDirectory(projectId, BUILDS_DIR + "/" + suffix, (buildNumberString) -> {
var buildNumber = valueOf(buildNumberString);
var buildPath = getProjectRelativeDirPath(buildNumber);
- projectService.syncFile(projectId, buildPath + "/" + LOG_FILE,
+ projectService.syncDirectory(projectId, buildPath + "/" + LOG_DIR,
getLogLockName(projectId, buildNumber), activeServer);
if (clusterService.runOnServer(activeServer, () -> getArtifactsDir(projectId, buildNumber).exists())) {
var artifactsDir = storageService.initArtifactsDir(projectId, buildNumber);
diff --git a/server-core/src/main/java/io/onedev/server/web/asset/bootstrap/css/bootstrap-custom.css b/server-core/src/main/java/io/onedev/server/web/asset/bootstrap/css/bootstrap-custom.css
index e667856a02..3cfa087f45 100644
--- a/server-core/src/main/java/io/onedev/server/web/asset/bootstrap/css/bootstrap-custom.css
+++ b/server-core/src/main/java/io/onedev/server/web/asset/bootstrap/css/bootstrap-custom.css
@@ -135,18 +135,24 @@ a.link-info:hover, a.link-info:focus {
.dark-mode a.link-info:hover, .dark-mode a.link-info:focus {
color: rgb(176, 142, 255) !important;
}
-.text-secondary, a.link-secondary {
+.text-secondary {
color: var(--gray-dark) !important;
}
-a.link-secondary:hover, a.link-secondary:focus {
+a.link-secondary {
color: var(--gray) !important;
}
-.dark-mode .text-secondary, .dark-mode .text-secondary:hover, .dark-mode a.link-secondary {
+a.link-secondary:hover, a.link-secondary:focus {
+ color: var(--gray-dark) !important;
+}
+.dark-mode .text-secondary, .dark-mode .text-secondary:hover {
color: var(--light-gray) !important;
}
-.dark-mode a.link-secondary:hover, .dark-mode a.link-secondary:focus {
+.dark-mode a.link-secondary {
color: var(--dark-mode-gray) !important;
}
+.dark-mode a.link-secondary:hover, .dark-mode a.link-secondary:focus {
+ color: var(--light-gray) !important;
+}
.text-light, a.link-light {
color: var(--light) !important;
@@ -3318,4 +3324,4 @@ p {
.dark-mode hr {
border-top-color: var(--dark-mode-lighter-dark);
-}
\ No newline at end of file
+}
diff --git a/server-core/src/main/java/io/onedev/server/web/asset/joblogentry/job-log-entry.js b/server-core/src/main/java/io/onedev/server/web/asset/joblogentry/job-log-entry.js
index d45a190386..11c5ee5052 100644
--- a/server-core/src/main/java/io/onedev/server/web/asset/joblogentry/job-log-entry.js
+++ b/server-core/src/main/java/io/onedev/server/web/asset/joblogentry/job-log-entry.js
@@ -1,5 +1,19 @@
onedev.server.jobLogEntry = {
-
+
+ append($log, logEntries, withDate) {
+ for (const logEntry of logEntries) {
+ const replacing = logEntry.messages.length !== 0 && logEntry.messages[0].text.startsWith("\r");
+ if (replacing)
+ logEntry.messages[0].text = logEntry.messages[0].text.substring(1);
+ const $entry = this.render(logEntry, withDate);
+ const $lastEntry = replacing ? $log.children(".log-entry:last") : $();
+ if (replacing && $lastEntry.length !== 0)
+ $lastEntry.replaceWith($entry);
+ else
+ $log.append($entry);
+ }
+ },
+
render(logEntry, withDate) {
var $logEntry = $("<div class='log-entry'></div>");
if (withDate)
diff --git a/server-core/src/main/java/io/onedev/server/web/component/logging/LogPanel.java b/server-core/src/main/java/io/onedev/server/web/component/logging/LogPanel.java
index 1091dde581..13ee28d376 100644
--- a/server-core/src/main/java/io/onedev/server/web/component/logging/LogPanel.java
+++ b/server-core/src/main/java/io/onedev/server/web/component/logging/LogPanel.java
@@ -20,7 +20,7 @@ import com.fasterxml.jackson.databind.ObjectMapper;
import com.google.common.collect.Sets;
import io.onedev.server.OneDev;
-import io.onedev.server.buildspec.job.log.JobLogEntryEx;
+import io.onedev.server.logging.LogEntry;
import io.onedev.server.logging.LogService;
import io.onedev.server.logging.LogSnippet;
import io.onedev.server.logging.LoggingSupport;
@@ -50,7 +50,7 @@ public abstract class LogPanel extends Panel {
add(new ChangeObserver() {
private void appendRecentLogEntries(IPartialPageRequestHandler handler) {
- List<JobLogEntryEx> logEntries = logService.readLogEntries(getLoggingSupport(), nextOffset, 0);
+ List<LogEntry> logEntries = logService.readLogEntries(getLoggingSupport(), nextOffset, 0);
if (!logEntries.isEmpty()) {
nextOffset += logEntries.size();
@@ -108,8 +108,8 @@ public abstract class LogPanel extends Panel {
setOutputMarkupId(true);
}
- private String asJSON(List<JobLogEntryEx> entries) {
- entries = entries.stream().map(JobLogEntryEx::transformEmojis).collect(toList());
+ private String asJSON(List<LogEntry> entries) {
+ entries = entries.stream().map(LogEntry::transformEmojis).collect(toList());
try {
return OneDev.getInstance(ObjectMapper.class).writeValueAsString(entries);
} catch (JsonProcessingException e) {
diff --git a/server-core/src/main/java/io/onedev/server/web/component/logging/log.js b/server-core/src/main/java/io/onedev/server/web/component/logging/log.js
index 47d5c95046..89293d98d4 100644
--- a/server-core/src/main/java/io/onedev/server/web/component/logging/log.js
+++ b/server-core/src/main/java/io/onedev/server/web/component/logging/log.js
@@ -6,23 +6,8 @@ onedev.server.log = {
$(this).data("logScrollLeft", $(this).scrollLeft());
$(this).data("logScrollTop", $(this).scrollTop());
});
- for (var i=0; i<logEntries.length; i++) {
- var logEntry = logEntries[i];
- var replacing = logEntry.messages.length != 0 && logEntry.messages[0].text.charAt(0) == "\r";
- if (replacing)
- logEntry.messages[0].text = logEntry.messages[0].text.substring(1);
- var $logEntry = onedev.server.jobLogEntry.render(logEntry, true);
- if (replacing) {
- var $lastEntry = $log.children(".log-entry:last");
- if ($lastEntry.length != 0)
- $lastEntry.replaceWith($logEntry);
- else
- $log.append($logEntry);
- } else {
- $log.append($logEntry);
- }
- }
-
+ onedev.server.jobLogEntry.append($log, logEntries, true);
+
var $entries = $log.children(".log-entry");
var maxNumOfEntries = $log.data("maxNumOfEntries");
diff --git a/server-core/src/main/java/io/onedev/server/web/component/progress/TimeProgressBar.html b/server-core/src/main/java/io/onedev/server/web/component/progress/TimeProgressBar.html
new file mode 100644
index 0000000000..e850b992ab
--- /dev/null
+++ b/server-core/src/main/java/io/onedev/server/web/component/progress/TimeProgressBar.html
@@ -0,0 +1,3 @@
+<wicket:panel>
+ <div class="time-progress-fill"></div>
+</wicket:panel>
diff --git a/server-core/src/main/java/io/onedev/server/web/component/progress/TimeProgressBar.java b/server-core/src/main/java/io/onedev/server/web/component/progress/TimeProgressBar.java
new file mode 100644
index 0000000000..826f964240
--- /dev/null
+++ b/server-core/src/main/java/io/onedev/server/web/component/progress/TimeProgressBar.java
@@ -0,0 +1,65 @@
+package io.onedev.server.web.component.progress;
+
+import static io.onedev.server.web.translation.Translation._T;
+
+import org.apache.wicket.markup.ComponentTag;
+import org.apache.wicket.markup.head.IHeaderResponse;
+import org.apache.wicket.markup.head.JavaScriptHeaderItem;
+import org.apache.wicket.markup.head.OnDomReadyHeaderItem;
+import org.apache.wicket.markup.html.panel.Panel;
+
+/** A time-based estimate, advanced in the browser every second without polling. */
+public class TimeProgressBar extends Panel {
+
+ private static final long serialVersionUID = 1L;
+
+ private final double estimatedDuration;
+ private double elapsed;
+ private final String color;
+ private final boolean roundCorner;
+
+ /**
+ * @param estimatedDuration estimated duration in seconds; non-positive values hide the bar
+ * @param color CSS color of the fill
+ * @param roundCorner whether to round the track's corners
+ */
+ public TimeProgressBar(String id, double estimatedDuration, String color, boolean roundCorner) {
+ super(id);
+ this.estimatedDuration = estimatedDuration;
+ this.color = color;
+ this.roundCorner = roundCorner;
+ setOutputMarkupId(true);
+ }
+
+ /** Set the elapsed time in seconds for the next render. */
+ public TimeProgressBar setElapsed(double elapsed) {
+ this.elapsed = Math.max(0, elapsed);
+ return this;
+ }
+
+ @Override
+ protected void onComponentTag(ComponentTag tag) {
+ super.onComponentTag(tag);
+ tag.append("class", "time-progress" + (roundCorner ? " time-progress-rounded" : ""), " ");
+ tag.append("style", "--time-progress-color: " + color, ";");
+ tag.put("role", "progressbar");
+ tag.put("aria-valuemin", "0");
+ tag.put("aria-valuemax", "100");
+ tag.put("aria-valuenow", estimatedDuration > 0
+ ? String.valueOf(Math.min(99, Math.round(elapsed * 100 / estimatedDuration))) : "0");
+ if (tag.getAttribute("aria-label") == null)
+ tag.put("aria-label", _T("Estimated progress"));
+ tag.put("data-estimated-duration", String.valueOf(estimatedDuration));
+ tag.put("data-elapsed", String.valueOf(elapsed));
+ if (estimatedDuration <= 0)
+ tag.put("hidden", "hidden");
+ }
+
+ @Override
+ public void renderHead(IHeaderResponse response) {
+ super.renderHead(response);
+ response.render(JavaScriptHeaderItem.forReference(new TimeProgressResourceReference()));
+ response.render(OnDomReadyHeaderItem.forScript(
+ "onedev.server.timeProgress.onDomReady('" + getMarkupId() + "');"));
+ }
+}
diff --git a/server-core/src/main/java/io/onedev/server/web/component/progress/TimeProgressResourceReference.java b/server-core/src/main/java/io/onedev/server/web/component/progress/TimeProgressResourceReference.java
new file mode 100644
index 0000000000..7a2cf6cac9
--- /dev/null
+++ b/server-core/src/main/java/io/onedev/server/web/component/progress/TimeProgressResourceReference.java
@@ -0,0 +1,26 @@
+package io.onedev.server.web.component.progress;
+
+import java.util.List;
+
+import org.apache.wicket.markup.head.CssHeaderItem;
+import org.apache.wicket.markup.head.HeaderItem;
+
+import io.onedev.server.web.page.base.BaseDependentCssResourceReference;
+import io.onedev.server.web.page.base.BaseDependentResourceReference;
+
+public class TimeProgressResourceReference extends BaseDependentResourceReference {
+
+ private static final long serialVersionUID = 1L;
+
+ public TimeProgressResourceReference() {
+ super(TimeProgressResourceReference.class, "time-progress.js");
+ }
+
+ @Override
+ public List<HeaderItem> getDependencies() {
+ var dependencies = super.getDependencies();
+ dependencies.add(CssHeaderItem.forReference(new BaseDependentCssResourceReference(
+ TimeProgressResourceReference.class, "time-progress.css")));
+ return dependencies;
+ }
+}
diff --git a/server-core/src/main/java/io/onedev/server/web/component/progress/time-progress.css b/server-core/src/main/java/io/onedev/server/web/component/progress/time-progress.css
new file mode 100644
index 0000000000..191f16f8ba
--- /dev/null
+++ b/server-core/src/main/java/io/onedev/server/web/component/progress/time-progress.css
@@ -0,0 +1,18 @@
+.time-progress {
+ height: 4px;
+ flex-shrink: 0;
+ overflow: hidden;
+ border-radius: 0;
+ background: var(--secondary);
+}
+.time-progress-rounded { border-radius: 2px; }
+.time-progress-fill {
+ height: 100%;
+ width: 0;
+ background: var(--time-progress-color, var(--primary));
+ transition: width 1s linear;
+}
+.dark-mode .time-progress { background: var(--dark-mode-lighter-dark); }
+@media (prefers-reduced-motion: reduce) {
+ .time-progress-fill { transition: none; }
+}
diff --git a/server-core/src/main/java/io/onedev/server/web/component/progress/time-progress.js b/server-core/src/main/java/io/onedev/server/web/component/progress/time-progress.js
new file mode 100644
index 0000000000..e57263ad6e
--- /dev/null
+++ b/server-core/src/main/java/io/onedev/server/web/component/progress/time-progress.js
@@ -0,0 +1,34 @@
+onedev.server.timeProgress = {
+ onDomReady: function(id) {
+ const element = document.getElementById(id);
+ // A containing page may have already supplied a fresher timing snapshot.
+ if (element && !element.timeProgress)
+ this.update(id, Number(element.dataset.elapsed), Number(element.dataset.estimatedDuration));
+ },
+ update: function(id, elapsed, estimatedDuration) {
+ const element = document.getElementById(id);
+ if (!element) return;
+ const previous = element.timeProgress;
+ if (previous) clearInterval(previous.timer);
+ const state = {elapsed: Math.max(0, elapsed), estimatedDuration: estimatedDuration, updated: performance.now()};
+ element.timeProgress = state;
+ element.hidden = !Number.isFinite(estimatedDuration) || estimatedDuration <= 0;
+ if (element.hidden) return;
+ this.render(element);
+ state.timer = setInterval(() => {
+ if (!element.isConnected) {
+ clearInterval(state.timer);
+ return;
+ }
+ this.render(element);
+ }, 1000);
+ },
+ render: function(element) {
+ const state = element.timeProgress;
+ const elapsed = state.elapsed + (performance.now() - state.updated) / 1000;
+ // A duration estimate cannot establish that the operation is complete.
+ const percent = Math.min(99, Math.max(0, elapsed / state.estimatedDuration * 100));
+ element.querySelector('.time-progress-fill').style.width = percent + '%';
+ element.setAttribute('aria-valuenow', Math.round(percent));
+ }
+};
diff --git a/server-core/src/main/java/io/onedev/server/web/component/taskbutton/TaskButton.java b/server-core/src/main/java/io/onedev/server/web/component/taskbutton/TaskButton.java
index 65cf381438..a3b053fabe 100644
--- a/server-core/src/main/java/io/onedev/server/web/component/taskbutton/TaskButton.java
+++ b/server-core/src/main/java/io/onedev/server/web/component/taskbutton/TaskButton.java
@@ -29,8 +29,7 @@ import io.onedev.commons.utils.ExceptionUtils;
import io.onedev.commons.utils.ExplicitException;
import io.onedev.commons.utils.TaskLogger;
import io.onedev.commons.utils.WordUtils;
-import io.onedev.server.buildspec.job.log.JobLogEntry;
-import io.onedev.server.buildspec.job.log.JobLogEntryEx;
+import io.onedev.server.logging.LogEntry;
import io.onedev.server.logging.StyleBuilder;
import io.onedev.server.web.component.modal.ModalPanel;
import io.onedev.server.web.component.taskbutton.TaskResult.PlainMessage;
@@ -126,8 +125,8 @@ public abstract class TaskButton extends AjaxButton {
protected void submitTask(AjaxRequestTarget target) {
String taskId = getSession().getId() + ":" + getPath();
- List<JobLogEntryEx> messages = new ArrayList<>();
- messages.add(new JobLogEntryEx(new JobLogEntry(new Date(), _T("Please wait..."))));
+ List<LogEntry> messages = new ArrayList<>();
+ messages.add(new LogEntry(new Date(), _T("Please wait...")));
var application = Application.get();
var session = getSession();
TaskFuture prevFuture = taskFutureService.getTaskFutures().put(taskId, new TaskFuture(executorService.submit(new Callable<TaskResult>() {
@@ -151,7 +150,7 @@ public abstract class TaskButton extends AjaxButton {
} else {
styleBuilder = new StyleBuilder();
}
- messages.add(JobLogEntryEx.parse(message, styleBuilder));
+ messages.add(LogEntry.parse(message, styleBuilder));
}
}
@@ -217,7 +216,7 @@ public abstract class TaskButton extends AjaxButton {
}
@Override
- protected List<JobLogEntryEx> getLogEntries() {
+ protected List<LogEntry> getLogEntries() {
TaskFuture future = taskFutureService.getTaskFutures().get(taskId);
if (future != null)
return future.getLogEntries();
diff --git a/server-core/src/main/java/io/onedev/server/web/component/taskbutton/TaskFeedbackPanel.java b/server-core/src/main/java/io/onedev/server/web/component/taskbutton/TaskFeedbackPanel.java
index f8a43fecf8..c16dde35a9 100644
--- a/server-core/src/main/java/io/onedev/server/web/component/taskbutton/TaskFeedbackPanel.java
+++ b/server-core/src/main/java/io/onedev/server/web/component/taskbutton/TaskFeedbackPanel.java
@@ -24,7 +24,7 @@ import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.ObjectMapper;
import io.onedev.server.OneDev;
-import io.onedev.server.buildspec.job.log.JobLogEntryEx;
+import io.onedev.server.logging.LogEntry;
import io.onedev.server.web.behavior.AbstractPostAjaxBehavior;
abstract class TaskFeedbackPanel extends Panel {
@@ -147,7 +147,7 @@ abstract class TaskFeedbackPanel extends Panel {
protected abstract void onClose(AjaxRequestTarget target);
- protected abstract List<JobLogEntryEx> getLogEntries();
+ protected abstract List<LogEntry> getLogEntries();
@Nullable
protected abstract TaskResult getResult();
diff --git a/server-core/src/main/java/io/onedev/server/web/component/taskbutton/TaskFuture.java b/server-core/src/main/java/io/onedev/server/web/component/taskbutton/TaskFuture.java
index da2ac5778c..736cef364a 100644
--- a/server-core/src/main/java/io/onedev/server/web/component/taskbutton/TaskFuture.java
+++ b/server-core/src/main/java/io/onedev/server/web/component/taskbutton/TaskFuture.java
@@ -10,17 +10,17 @@ import java.util.concurrent.TimeoutException;
import org.joda.time.DateTime;
-import io.onedev.server.buildspec.job.log.JobLogEntryEx;
+import io.onedev.server.logging.LogEntry;
class TaskFuture implements Future<TaskResult> {
private final Future<TaskResult> wrapped;
- private final List<JobLogEntryEx> logEntries;
+ private final List<LogEntry> logEntries;
private volatile Date lastActive = new Date();
- public TaskFuture(Future<TaskResult> wrapped, List<JobLogEntryEx> logEntries) {
+ public TaskFuture(Future<TaskResult> wrapped, List<LogEntry> logEntries) {
this.wrapped = wrapped;
this.logEntries = logEntries;
}
@@ -55,10 +55,10 @@ class TaskFuture implements Future<TaskResult> {
return get(timeout, unit);
}
- public List<JobLogEntryEx> getLogEntries() {
+ public List<LogEntry> getLogEntries() {
lastActive = new Date();
synchronized (logEntries) {
- List<JobLogEntryEx> copy = new ArrayList<>(logEntries);
+ List<LogEntry> copy = new ArrayList<>(logEntries);
logEntries.clear();
return copy;
}
diff --git a/server-core/src/main/java/io/onedev/server/web/mapper/BaseUrlMapper.java b/server-core/src/main/java/io/onedev/server/web/mapper/BaseUrlMapper.java
index 3a9cdcf992..9c944040f1 100644
--- a/server-core/src/main/java/io/onedev/server/web/mapper/BaseUrlMapper.java
+++ b/server-core/src/main/java/io/onedev/server/web/mapper/BaseUrlMapper.java
@@ -109,7 +109,7 @@ import io.onedev.server.web.page.project.builds.detail.InvalidBuildPage;
import io.onedev.server.web.page.project.builds.detail.artifacts.BuildArtifactsPage;
import io.onedev.server.web.page.project.builds.detail.changes.BuildChangesPage;
import io.onedev.server.web.page.project.builds.detail.issues.FixedIssuesPage;
-import io.onedev.server.web.page.project.builds.detail.log.BuildLogPage;
+import io.onedev.server.web.page.project.builds.detail.log.BuildStepsPage;
import io.onedev.server.web.page.project.builds.detail.pack.BuildPacksPage;
import io.onedev.server.web.page.project.builds.detail.pipeline.BuildPipelinePage;
import io.onedev.server.web.page.project.codecomments.InvalidCodeCommentPage;
@@ -469,7 +469,7 @@ public class BaseUrlMapper extends CompoundRequestMapper {
add(new ProjectPageMapper("${project}/~builds", ProjectBuildsPage.class));
add(new ProjectPageMapper("${project}/~builds/${build}", BuildDefaultPage.class));
add(new ProjectPageMapper("${project}/~builds/${build}/pipeline", BuildPipelinePage.class));
- add(new ProjectPageMapper("${project}/~builds/${build}/log", BuildLogPage.class));
+ add(new ProjectPageMapper("${project}/~builds/${build}/steps", BuildStepsPage.class));
add(new ProjectPageMapper("${project}/~builds/${build}/changes", BuildChangesPage.class));
add(new ProjectPageMapper("${project}/~builds/${build}/fixed-issues", FixedIssuesPage.class));
add(new ProjectPageMapper("${project}/~builds/${build}/artifacts", BuildArtifactsPage.class));
diff --git a/server-core/src/main/java/io/onedev/server/web/page/base/base.css b/server-core/src/main/java/io/onedev/server/web/page/base/base.css
index a13527b7fe..15081a2c42 100644
--- a/server-core/src/main/java/io/onedev/server/web/page/base/base.css
+++ b/server-core/src/main/java/io/onedev/server/web/page/base/base.css
@@ -728,6 +728,10 @@ html:has(.revision-diff) .sticky-tabs-row {
html:has(.revision-diff) .sticky-tabs-row.is-docked>.more-info-dock {
display: none;
}
+html:not(:has(.revision-diff)) .sticky-tabs-row.is-docked>.nav.nav-tabs.nav-tabs-line :is(.active .nav-link, .nav-link.active),
+html:not(:has(.revision-diff)) .nav.nav-tabs.nav-tabs-line.nav-tabs-sticky.is-docked :is(.active .nav-link, .nav-link.active) {
+ border-bottom-color: transparent;
+}
tr.ui-sortable-helper {
box-shadow: 2px 2px 6px 2px rgba(0, 0, 0, 0.3);
diff --git a/server-core/src/main/java/io/onedev/server/web/page/base/base.js b/server-core/src/main/java/io/onedev/server/web/page/base/base.js
index 6a04f002de..6e88469563 100644
--- a/server-core/src/main/java/io/onedev/server/web/page/base/base.js
+++ b/server-core/src/main/java/io/onedev/server/web/page/base/base.js
@@ -778,6 +778,39 @@ onedev.server = {
doSetup($(document));
},
+ setupStickyTabs: function() {
+ function setup($container) {
+ $container.find(".nav-tabs-sticky").addBack(".nav-tabs-sticky").each(function() {
+ var $tabs = $(this);
+ if ($tabs.data("stickyTabsObserver"))
+ return;
+ var $sentinel = $('<div class="sticky-tabs-sentinel" aria-hidden="true"></div>').insertBefore($tabs);
+ var observer = new IntersectionObserver(function(entries) {
+ var entry = entries[0];
+ var aboveScrollport = entry.rootBounds
+ && entry.boundingClientRect.bottom <= entry.rootBounds.top;
+ $tabs.toggleClass("is-docked", !entry.isIntersecting && aboveScrollport);
+ }, {root: $tabs.closest(".autofit")[0] || null, threshold: 0});
+ observer.observe($sentinel[0]);
+ $tabs.data("stickyTabsObserver", observer).data("stickyTabsSentinel", $sentinel);
+ });
+ }
+ $(document).on("beforeElementReplace", function(event, componentId) {
+ $("#" + componentId).find(".nav-tabs-sticky").addBack(".nav-tabs-sticky").each(function() {
+ var $tabs = $(this);
+ var observer = $tabs.data("stickyTabsObserver");
+ if (observer) {
+ observer.disconnect();
+ $tabs.data("stickyTabsSentinel").remove();
+ }
+ });
+ });
+ $(document).on("afterElementReplace", function(event, componentId) {
+ setup($("#" + componentId));
+ });
+ setup($(document));
+ },
+
setupRadio: function() {
function doSetup($container) {
$container.find(".radio").addBack(".radio").each(function() {
@@ -813,7 +846,7 @@ onedev.server = {
function doSetup(container) {
setTimeout(function() {
if (container === document || document.body.contains(container)) {
- tippy(container.querySelectorAll('[data-tippy-content]'), {
+ tippy($(container).find('[data-tippy-content]').addBack('[data-tippy-content]').toArray(), {
delay: [500, 0],
placement: 'auto'
});
@@ -1004,6 +1037,7 @@ onedev.server = {
onedev.server.setupCheckbox();
onedev.server.setupRadio();
onedev.server.setupSwitch();
+ onedev.server.setupStickyTabs();
onedev.server.setupTable();
onedev.server.setupTippy();
onedev.server.history.init(popStateCallback);
diff --git a/server-core/src/main/java/io/onedev/server/web/page/project/builds/detail/BuildDefaultPage.java b/server-core/src/main/java/io/onedev/server/web/page/project/builds/detail/BuildDefaultPage.java
index 167e2e71ce..d396403630 100644
--- a/server-core/src/main/java/io/onedev/server/web/page/project/builds/detail/BuildDefaultPage.java
+++ b/server-core/src/main/java/io/onedev/server/web/page/project/builds/detail/BuildDefaultPage.java
@@ -8,7 +8,7 @@ import org.apache.wicket.request.mapper.parameter.PageParameters;
import io.onedev.server.security.SecurityUtils;
import io.onedev.server.web.page.project.builds.detail.artifacts.BuildArtifactsPage;
import io.onedev.server.web.page.project.builds.detail.issues.FixedIssuesPage;
-import io.onedev.server.web.page.project.builds.detail.log.BuildLogPage;
+import io.onedev.server.web.page.project.builds.detail.log.BuildStepsPage;
import io.onedev.server.web.page.project.builds.detail.pipeline.BuildPipelinePage;
public class BuildDefaultPage extends BuildDetailPage {
@@ -21,7 +21,7 @@ public class BuildDefaultPage extends BuildDetailPage {
if (getBuild().getRootArtifacts().size() != 0) {
pageProvider = new PageProvider(BuildArtifactsPage.class, BuildArtifactsPage.paramsOf(getBuild()));
} else if (SecurityUtils.canAccessLog(getBuild())) {
- pageProvider = new PageProvider(BuildLogPage.class, BuildLogPage.paramsOf(getBuild()));
+ pageProvider = new PageProvider(BuildStepsPage.class, BuildStepsPage.paramsOf(getBuild()));
} else if (SecurityUtils.canAccessPipeline(getBuild())) {
pageProvider = new PageProvider(BuildPipelinePage.class, BuildPipelinePage.paramsOf(getBuild()));
} else {
diff --git a/server-core/src/main/java/io/onedev/server/web/page/project/builds/detail/BuildDetailPage.java b/server-core/src/main/java/io/onedev/server/web/page/project/builds/detail/BuildDetailPage.java
index 547caa84ea..bbb9002b3f 100644
--- a/server-core/src/main/java/io/onedev/server/web/page/project/builds/detail/BuildDetailPage.java
+++ b/server-core/src/main/java/io/onedev/server/web/page/project/builds/detail/BuildDetailPage.java
@@ -91,7 +91,7 @@ import io.onedev.server.web.page.project.builds.ProjectBuildsPage;
import io.onedev.server.web.page.project.builds.detail.artifacts.BuildArtifactsPage;
import io.onedev.server.web.page.project.builds.detail.changes.BuildChangesPage;
import io.onedev.server.web.page.project.builds.detail.issues.FixedIssuesPage;
-import io.onedev.server.web.page.project.builds.detail.log.BuildLogPage;
+import io.onedev.server.web.page.project.builds.detail.log.BuildStepsPage;
import io.onedev.server.web.page.project.builds.detail.pack.BuildPacksPage;
import io.onedev.server.web.page.project.builds.detail.pipeline.BuildPipelinePage;
import io.onedev.server.web.page.project.overview.ProjectOverviewPage;
@@ -200,7 +200,7 @@ public abstract class BuildDetailPage extends ProjectPage
return new ViewStateAwarePageLink<Void>(componentId, ProjectOverviewPage.class, ProjectOverviewPage.paramsOf(project.getId()));
}
- private ChangeObserver newBuildObserver(Long buildId) {
+ protected ChangeObserver newBuildObserver(Long buildId) {
return new ChangeObserver() {
@Override
@@ -217,6 +217,60 @@ public abstract class BuildDetailPage extends ProjectPage
};
}
+ protected Component newCancelLink(String componentId) {
+ return new AjaxLink<Void>(componentId) {
+
+ @Override
+ protected void updateAjaxAttributes(AjaxRequestAttributes attributes) {
+ super.updateAjaxAttributes(attributes);
+ attributes.getAjaxCallListeners().add(new ConfirmClickListener(_T("Do you really want to cancel this build?")));
+ }
+
+ @Override
+ public void onClick(AjaxRequestTarget target) {
+ jobService.cancel(getBuild());
+ getSession().success(_T("Cancel request submitted"));
+ }
+
+ @Override
+ protected void onConfigure() {
+ super.onConfigure();
+ setVisible(!getBuild().isFinished() && SecurityUtils.canRunJob(getBuild().getProject(), getBuild().getJobName()));
+ }
+
+ }.setOutputMarkupId(true);
+ }
+
+ protected Component newTerminalLink(String componentId) {
+ return new AjaxLink<Void>(componentId) {
+
+ @Override
+ public void onClick(AjaxRequestTarget target) {
+ if (isSubscriptionActive()) {
+ target.appendJavaScript(String.format("onedev.server.buildDetail.openTerminal('%s');",
+ terminalService.getTerminalUrl(getBuild())));
+ } else {
+ new MessageModal(target) {
+
+ @Override
+ protected Component newMessageContent(String componentId) {
+ return new Label(componentId, _T("Interactive web shell access to running jobs is an enterprise feature. <a href='https://onedev.io/pricing' target='_blank'>Try free</a> for 30 days")).setEscapeModelStrings(false);
+ }
+ };
+ }
+ }
+
+ @Override
+ protected void onConfigure() {
+ super.onConfigure();
+
+ JobContext jobContext = jobService.getJobContext(getBuild().getId());
+ setVisible(jobContext!= null && !getBuild().isFinished() && SecurityUtils.canOpenTerminal(getBuild()));
+ }
+
+ }.setOutputMarkupId(true);
+ }
+
@Override
protected void onInitialize() {
super.onInitialize();
@@ -298,55 +352,9 @@ public abstract class BuildDetailPage extends ProjectPage
}.setOutputMarkupId(true));
- add(new AjaxLink<Void>("cancel") {
+ add(newCancelLink("cancel"));
- @Override
- protected void updateAjaxAttributes(AjaxRequestAttributes attributes) {
- super.updateAjaxAttributes(attributes);
- attributes.getAjaxCallListeners().add(new ConfirmClickListener(_T("Do you really want to cancel this build?")));
- }
-
- @Override
- public void onClick(AjaxRequestTarget target) {
- jobService.cancel(getBuild());
- getSession().success(_T("Cancel request submitted"));
- }
-
- @Override
- protected void onConfigure() {
- super.onConfigure();
- setVisible(!getBuild().isFinished() && SecurityUtils.canRunJob(getBuild().getProject(), getBuild().getJobName()));
- }
-
- }.setOutputMarkupId(true));
-
- add(new AjaxLink<Void>("terminal") {
-
- @Override
- public void onClick(AjaxRequestTarget target) {
- if (isSubscriptionActive()) {
- target.appendJavaScript(String.format("onedev.server.buildDetail.openTerminal('%s');",
- terminalService.getTerminalUrl(getBuild())));
- } else {
- new MessageModal(target) {
-
- @Override
- protected Component newMessageContent(String componentId) {
- return new Label(componentId, _T("Interactive web shell access to running jobs is an enterprise feature. <a href='https://onedev.io/pricing' target='_blank'>Try free</a> for 30 days")).setEscapeModelStrings(false);
- }
- };
- }
- }
-
- @Override
- protected void onConfigure() {
- super.onConfigure();
-
- JobContext jobContext = jobService.getJobContext(getBuild().getId());
- setVisible(jobContext!= null && !getBuild().isFinished() && SecurityUtils.canOpenTerminal(getBuild()));
- }
-
- }.setOutputMarkupId(true));
+ add(newTerminalLink("terminal"));
add(new DropdownLink("promotions") {
@@ -543,14 +551,13 @@ public abstract class BuildDetailPage extends ProjectPage
}
if (SecurityUtils.canAccessLog(getBuild())) {
- tabs.add(new BuildTab(Model.of(_T("Log")), BuildLogPage.class, BuildLogPage.paramsOf(getBuild())) {
+ tabs.add(new BuildTab(Model.of("Steps"), BuildStepsPage.class, BuildStepsPage.paramsOf(getBuild())) {
+ private static final long serialVersionUID = 1L;
@Override
protected Component renderOptions(String componentId) {
- BuildLogPage page = (BuildLogPage) getPage();
- return page.renderOptions(componentId);
+ return ((BuildStepsPage) getPage()).renderOptions(componentId);
}
-
});
}
@@ -697,6 +704,7 @@ public abstract class BuildDetailPage extends ProjectPage
@Override
protected void onDetach() {
buildModel.detach();
+ promotionsModel.detach();
super.onDetach();
}
diff --git a/server-core/src/main/java/io/onedev/server/web/page/project/builds/detail/log/BuildLogPage.html b/server-core/src/main/java/io/onedev/server/web/page/project/builds/detail/log/BuildLogPage.html
deleted file mode 100644
index 2a220fc7a9..0000000000
--- a/server-core/src/main/java/io/onedev/server/web/page/project/builds/detail/log/BuildLogPage.html
+++ /dev/null
@@ -1,8 +0,0 @@
-<wicket:extend>
- <div wicket:id="log" class="d-flex flex-grow-1 position-relative"></div>
- <wicket:fragment wicket:id="optionsFrag">
- <div>
- <a wicket:id="download" class="btn btn-light btn-hover-primary btn-icon btn-sm btn-xs" t:data-tippy-content="Download full log"><wicket:svg href="download" class="icon"/></a>
- </div>
- </wicket:fragment>
-</wicket:extend>
\ No newline at end of file
diff --git a/server-core/src/main/java/io/onedev/server/web/page/project/builds/detail/log/BuildLogPage.java b/server-core/src/main/java/io/onedev/server/web/page/project/builds/detail/log/BuildLogPage.java
deleted file mode 100644
index 3b3b6b0a33..0000000000
--- a/server-core/src/main/java/io/onedev/server/web/page/project/builds/detail/log/BuildLogPage.java
+++ /dev/null
@@ -1,83 +0,0 @@
-package io.onedev.server.web.page.project.builds.detail.log;
-
-import jakarta.inject.Inject;
-
-import org.apache.wicket.Component;
-import org.apache.wicket.markup.html.link.ResourceLink;
-import org.apache.wicket.markup.html.panel.Fragment;
-import org.apache.wicket.request.mapper.parameter.PageParameters;
-import org.jspecify.annotations.Nullable;
-
-import io.onedev.server.job.JobService;
-import io.onedev.server.logging.LoggingSupport;
-import io.onedev.server.model.Build;
-import io.onedev.server.security.SecurityUtils;
-import io.onedev.server.web.component.logging.LogPanel;
-import io.onedev.server.web.component.logging.PauseSupport;
-import io.onedev.server.web.page.project.builds.detail.BuildDetailPage;
-import io.onedev.server.web.resource.BuildLogResource;
-import io.onedev.server.web.resource.BuildLogResourceReference;
-
-public class BuildLogPage extends BuildDetailPage {
-
- @Inject
- private JobService jobService;
-
- public BuildLogPage(PageParameters params) {
- super(params);
- }
-
- @Override
- protected void onInitialize() {
- super.onInitialize();
-
- add(new LogPanel("log") {
-
- @Override
- protected LoggingSupport getLoggingSupport() {
- return getBuild().getLoggingSupport();
- }
-
- @Nullable
- @Override
- protected PauseSupport getPauseSupport() {
- return new PauseSupport() {
-
- @Override
- public boolean isPaused() {
- return getBuild().isPaused();
- }
-
- @Override
- public boolean canResume() {
- return SecurityUtils.canRunJob(getBuild().getProject(), getBuild().getJobName());
- }
-
- @Override
- public void resume() {
- jobService.resume(getBuild());
- }
-
- @Override
- public String getStatusChangeObservable() {
- return Build.getDetailChangeObservable(getBuild().getId());
- }
-
- };
- }
-
- });
- }
-
- @Override
- protected boolean isPermitted() {
- return SecurityUtils.canAccessLog(getBuild());
- }
-
- public Component renderOptions(String componentId) {
- Fragment fragment = new Fragment(componentId, "optionsFrag", this);
- fragment.add(new ResourceLink<Void>("download", new BuildLogResourceReference(),
- BuildLogResource.paramsOf(projectModel.getObject().getId(), getBuild().getNumber())));
- return fragment;
- }
-}
diff --git a/server-core/src/main/java/io/onedev/server/web/page/project/builds/detail/log/BuildStepsPage.html b/server-core/src/main/java/io/onedev/server/web/page/project/builds/detail/log/BuildStepsPage.html
new file mode 100644
index 0000000000..990619dd38
--- /dev/null
+++ b/server-core/src/main/java/io/onedev/server/web/page/project/builds/detail/log/BuildStepsPage.html
@@ -0,0 +1,26 @@
+<wicket:extend>
+ <div class="build-steps-layout d-flex flex-grow-1">
+ <div class="build-steps-main d-flex flex-column flex-grow-1">
+ <div wicket:id="progress" class="build-duration-progress" t:aria-label="Estimated build progress"
+ t:data-tippy-content="Estimated progress based on the running time of the last successful build in the same stream"></div>
+ <div wicket:id="steps" class="build-steps flex-grow-1"></div>
+ </div>
+ <div wicket:id="autoUpdateContainer" class="step-update-rail">
+ <button wicket:id="autoUpdate" type="button" class="step-update-control" t:aria-label="Auto-update and auto-scroll steps and logs" aria-pressed="true">
+ <span class="step-update-activity" aria-hidden="true">
+ <span></span><span></span><span></span><span></span>
+ <span></span><span></span><span></span><span></span>
+ </span>
+ </button>
+ </div>
+ </div>
+ <wicket:fragment wicket:id="optionsFrag">
+ <div class="d-flex align-items-center">
+ <span wicket:id="stickyActions" class="build-step-sticky-actions align-items-center">
+ <a wicket:id="cancel" class="btn btn-icon btn-light btn-hover-danger btn-xs mr-2" t:data-tippy-content="Cancel this build" t:aria-label="Cancel this build"><wicket:svg href="cancel" class="icon"/></a>
+ <a wicket:id="terminal" class="subscription-required btn btn-icon btn-light btn-hover-primary btn-xs mr-2" t:data-tippy-content="Open terminal of current running step" t:aria-label="Open terminal of current running step"><wicket:svg href="terminal" class="icon"/></a>
+ </span>
+ <a wicket:id="download" class="btn btn-light btn-hover-primary btn-icon btn-sm btn-xs" t:data-tippy-content="Download full log" t:aria-label="Download full log"><wicket:svg href="download" class="icon"/></a>
+ </div>
+ </wicket:fragment>
+</wicket:extend>
diff --git a/server-core/src/main/java/io/onedev/server/web/page/project/builds/detail/log/BuildStepsPage.java b/server-core/src/main/java/io/onedev/server/web/page/project/builds/detail/log/BuildStepsPage.java
new file mode 100644
index 0000000000..bf293900ec
--- /dev/null
+++ b/server-core/src/main/java/io/onedev/server/web/page/project/builds/detail/log/BuildStepsPage.java
@@ -0,0 +1,318 @@
+package io.onedev.server.web.page.project.builds.detail.log;
+
+import static io.onedev.server.web.translation.Translation._T;
+import static org.unbescape.javascript.JavaScriptEscape.escapeJavaScript;
+
+import java.io.IOException;
+import java.text.MessageFormat;
+import java.util.ArrayList;
+import java.util.Date;
+import java.util.Objects;
+import java.util.List;
+import java.util.Collection;
+import java.util.LinkedHashMap;
+import java.util.Map;
+import java.util.Set;
+
+import jakarta.inject.Inject;
+
+import org.apache.shiro.authz.UnauthorizedException;
+import org.apache.wicket.Component;
+import org.apache.wicket.ajax.AjaxRequestTarget;
+import org.apache.wicket.ajax.markup.html.AjaxLink;
+import org.apache.wicket.ajax.attributes.CallbackParameter;
+import org.apache.wicket.ajax.attributes.AjaxRequestAttributes;
+import org.apache.wicket.ajax.attributes.AjaxCallListener;
+import org.apache.wicket.core.request.handler.IPartialPageRequestHandler;
+import org.apache.wicket.markup.ComponentTag;
+import org.apache.wicket.markup.head.IHeaderResponse;
+import org.apache.wicket.markup.head.JavaScriptHeaderItem;
+import org.apache.wicket.markup.head.OnDomReadyHeaderItem;
+import org.apache.wicket.markup.html.WebMarkupContainer;
+import org.apache.wicket.markup.html.link.ResourceLink;
+import org.apache.wicket.markup.html.panel.Fragment;
+import org.apache.wicket.request.mapper.parameter.PageParameters;
+
+import com.fasterxml.jackson.databind.ObjectMapper;
+
+import io.onedev.server.job.JobService;
+import io.onedev.server.logging.build.BuildLogService;
+import io.onedev.server.logging.build.BuildLoggingSupport;
+import io.onedev.server.model.Build;
+import io.onedev.server.model.support.build.StepExecution;
+import io.onedev.server.security.SecurityUtils;
+import io.onedev.server.web.behavior.AbstractPostAjaxBehavior;
+import io.onedev.server.web.behavior.ChangeObserver;
+import io.onedev.server.web.component.progress.TimeProgressBar;
+import io.onedev.server.web.page.project.builds.detail.BuildDetailPage;
+import io.onedev.server.web.resource.BuildLogResource;
+import io.onedev.server.web.resource.BuildLogResourceReference;
+
+public class BuildStepsPage extends BuildDetailPage {
+ private static final long serialVersionUID = 1L;
+
+ private static final int MAX_ENTRIES = 5000;
+
+ @Inject
+ private BuildLogService buildLogService;
+ @Inject
+ private JobService jobService;
+ @Inject
+ private ObjectMapper objectMapper;
+
+ private WebMarkupContainer steps;
+ private AbstractPostAjaxBehavior refresh;
+ private AbstractPostAjaxBehavior resume;
+ private final Map<String, Integer> nextOffsets = new LinkedHashMap<>();
+ private long submitSequence;
+ private Date retryDate;
+ private boolean buildFinished;
+ private boolean autoUpdate = true;
+
+ public BuildStepsPage(PageParameters params) {
+ super(params);
+ }
+
+ @Override
+ protected void onInitialize() {
+ super.onInitialize();
+ submitSequence = getBuild().getSubmitSequence();
+ buildFinished = getBuild().isFinished();
+ retryDate = getBuild().getRetryDate();
+ steps = new WebMarkupContainer("steps");
+ steps.setOutputMarkupId(true);
+ add(steps);
+ var progressData = getProgressData();
+ add(new TimeProgressBar("progress", progressData != null ? progressData.get("expected") / 1000.0 : 0,
+ "var(--info)", false).setElapsed(progressData != null ? progressData.get("elapsed") / 1000.0 : 0));
+ var autoUpdateContainer = new WebMarkupContainer("autoUpdateContainer") {
+ private static final long serialVersionUID = 1L;
+
+ @Override
+ protected void onConfigure() {
+ super.onConfigure();
+ setVisible(getBuild().getStatus() == Build.Status.RUNNING);
+ }
+ };
+ autoUpdateContainer.setOutputMarkupPlaceholderTag(true);
+ autoUpdateContainer.add(new AjaxLink<Void>("autoUpdate") {
+ private static final long serialVersionUID = 1L;
+
+ @Override
+ protected void onComponentTag(ComponentTag tag) {
+ super.onComponentTag(tag);
+ tag.put("aria-pressed", String.valueOf(autoUpdate));
+ tag.put("data-tippy-content", autoUpdate
+ ? _T("Steps and logs are updating and scrolling automatically. Click to pause.")
+ : _T("Automatic updates and scrolling are paused. Click to resume."));
+ }
+
+ @Override
+ protected void updateAjaxAttributes(AjaxRequestAttributes attributes) {
+ super.updateAjaxAttributes(attributes);
+ attributes.getDynamicExtraParameters().add("return {offsets: onedev.server.buildSteps.getOffsets()};");
+ }
+
+ @Override
+ public void onClick(AjaxRequestTarget target) {
+ changeAutoUpdate(target, !autoUpdate);
+ target.add(this);
+ }
+ }.setOutputMarkupId(true));
+ add(autoUpdateContainer);
+
+ refresh = new AbstractPostAjaxBehavior() {
+ private static final long serialVersionUID = 1L;
+
+ @Override
+ protected void updateAjaxAttributes(AjaxRequestAttributes attributes) {
+ super.updateAjaxAttributes(attributes);
+ attributes.getAjaxCallListeners().add(new AjaxCallListener()
+ .onFailure("onedev.server.buildSteps.busy = false;"));
+ }
+
+ @Override
+ protected void respond(AjaxRequestTarget target) {
+ readOffsets();
+ updateSteps(target, true);
+ }
+ };
+ add(refresh);
+ resume = new AbstractPostAjaxBehavior() {
+ private static final long serialVersionUID = 1L;
+
+ @Override
+ protected void respond(AjaxRequestTarget target) {
+ if (!SecurityUtils.canRunJob(getProject(), getBuild().getJobName()))
+ throw new UnauthorizedException();
+ jobService.resume(getBuild());
+ updateSteps(target, false);
+ }
+ };
+ add(resume);
+ add(new ChangeObserver() {
+ private static final long serialVersionUID = 1L;
+
+ @Override
+ public Collection<String> findObservables() {
+ return Set.of(Build.getLogChangeObservable(getBuild().getId()), Build.getDetailChangeObservable(getBuild().getId()));
+ }
+ @Override
+ public void onObservableChanged(IPartialPageRequestHandler handler, Collection<String> changed) {
+ if (autoUpdateContainer.isVisible() != (getBuild().getStatus() == Build.Status.RUNNING))
+ handler.add(autoUpdateContainer);
+ updateSteps(handler, false);
+ }
+ });
+ }
+
+ private void readOffsets() {
+ try {
+ var offsets = objectMapper.readTree(getRequest().getRequestParameters().getParameterValue("offsets").toString("{}"));
+ nextOffsets.clear();
+ offsets.properties().forEach(it -> nextOffsets.put(it.getKey(), Math.max(0, it.getValue().asInt())));
+ } catch (IOException e) {
+ throw new RuntimeException(e);
+ }
+ }
+
+ @Override
+ public void notifyObservablesChange(IPartialPageRequestHandler handler, Collection<String> observables) {
+ if (!buildFinished && submitSequence == getBuild().getSubmitSequence() && getBuild().isFinished()) {
+ buildFinished = true;
+ handler.appendJavaScript("window.location.reload();");
+ } else {
+ super.notifyObservablesChange(handler, observables);
+ }
+ }
+
+ private void changeAutoUpdate(AjaxRequestTarget target, boolean enabled) {
+ autoUpdate = enabled;
+ target.prependJavaScript("onedev.server.buildSteps.setAutoUpdate(" + enabled + ");");
+ if (enabled) {
+ readOffsets();
+ updateSteps(target, false);
+ }
+ }
+
+ private String stepUpdateScript(boolean requested) {
+ try {
+ return "if (onedev.server.buildSteps && onedev.server.buildSteps.container === document.getElementById('"
+ + steps.getMarkupId() + "')) { onedev.server.buildSteps.setProgress("
+ + objectMapper.writeValueAsString(getProgressData()) + "); onedev.server.buildSteps.update("
+ + objectMapper.writeValueAsString(getStepData())
+ + "," + getBuild().isPaused() + "," + submitSequence + "," + requested + "); }";
+ } catch (IOException e) {
+ throw new RuntimeException(e);
+ }
+ }
+
+ private Map<String, Long> getProgressData() {
+ var build = getBuild();
+ if (build.getStatus() != Build.Status.RUNNING || build.getRunningDate() == null)
+ return null;
+ var previous = build.getStreamPrevious(Build.Status.SUCCESSFUL);
+ if (previous == null)
+ return null;
+ var expected = previous.getRunningDuration();
+ if (expected == null || expected <= 0)
+ return null;
+ return Map.of("elapsed", Math.max(0, System.currentTimeMillis() - build.getRunningDate().getTime()),
+ "expected", expected);
+ }
+
+ private void updateSteps(IPartialPageRequestHandler handler, boolean requested) {
+ // A new submission belongs to a new page, never to this page's step view.
+ if (submitSequence == getBuild().getSubmitSequence()) {
+ if (!Objects.equals(retryDate, getBuild().getRetryDate()))
+ handler.appendJavaScript("window.location.reload();");
+ else if (autoUpdate || requested)
+ handler.appendJavaScript(stepUpdateScript(requested));
+ }
+ }
+
+ private List<Map<String, Object>> getStepData() {
+ var data = new ArrayList<Map<String, Object>>();
+ var build = getBuild();
+ var stepExecutions = build.getStepExecutions();
+ var currentLogStage = build.getCurrentLogStage();
+ int stepIndex = 0;
+ for (var name : build.getLogStages()) {
+ var stepExecution = stepExecutions.get(name);
+ var stage = new LinkedHashMap<String, Object>();
+ stage.put("name", name);
+ stage.put("title", build.getLogStageName(name));
+ boolean active = stepExecution != null ? stepExecution.getStatus() == StepExecution.Status.RUNNING
+ : name.equals(currentLogStage) && !build.isFinished();
+ stage.put("active", active);
+ if (stepExecution != null) {
+ stepIndex++;
+ // Older builds only have the instances recorded in their step logs.
+ stage.put("stepIndex", stepExecution.getStepCount() != 0 ? stepExecution.getStepIndex() : stepIndex);
+ stage.put("stepCount", stepExecution.getStepCount() != 0 ? stepExecution.getStepCount() : stepExecutions.size());
+ stage.put("status", stepExecution.getStatus());
+ stage.put("statusText", stepExecution.isSkipped() ? _T("Skipped") : switch (stepExecution.getStatus()) {
+ case RUNNING -> _T("Running");
+ case SUCCESSFUL -> _T("Successful");
+ case FAILED -> _T("Failed");
+ case CANCELLED -> _T("Cancelled");
+ });
+ stage.put("skipped", stepExecution.isSkipped());
+ stage.put("duration", stepExecution.getDuration());
+ }
+ stage.put("downloadText", _T("Download log"));
+ stage.put("download", urlFor(new BuildLogResourceReference(), BuildLogResource.paramsOf(
+ getProject().getId(), build.getNumber(), name)).toString());
+ appendLogEntries(stage, name, active);
+ data.add(stage);
+ }
+ return data;
+ }
+
+ private void appendLogEntries(Map<String, Object> step, String name, boolean active) {
+ if (autoUpdate && active)
+ nextOffsets.putIfAbsent(name, 0);
+ if (nextOffsets.containsKey(name)) {
+ int from = nextOffsets.get(name);
+ var snippet = buildLogService.readLogSnippetReversely(new BuildLoggingSupport(getBuild(), name), MAX_ENTRIES);
+ step.put("from", from);
+ step.put("offset", Math.max(from, snippet.offset));
+ step.put("next", snippet.offset + snippet.entries.size());
+ nextOffsets.put(name, snippet.offset + snippet.entries.size());
+ step.put("entries", snippet.entries.stream().skip(Math.max(0, from - snippet.offset))
+ .map(it -> it.transformEmojis()).toList());
+ }
+ }
+
+ @Override
+ public void renderHead(IHeaderResponse response) {
+ super.renderHead(response);
+ autoUpdate = true;
+ buildFinished = getBuild().isFinished();
+ retryDate = getBuild().getRetryDate();
+ nextOffsets.clear();
+ response.render(JavaScriptHeaderItem.forReference(new BuildStepsResourceReference()));
+ response.render(OnDomReadyHeaderItem.forScript(String.format(
+ "onedev.server.buildSteps.init('%s', %s, %s, %s, '%s', '%s');", steps.getMarkupId(),
+ refresh.getCallbackFunction(CallbackParameter.explicit("offsets")),
+ SecurityUtils.canRunJob(getProject(), getBuild().getJobName()) ? resume.getCallbackFunction() : "null", MAX_ENTRIES,
+ escapeJavaScript(MessageFormat.format(_T("Showing the latest {0} entries. Download the log for all entries."),
+ String.valueOf(MAX_ENTRIES))), escapeJavaScript(_T("No log entries"))) + stepUpdateScript(false)));
+ }
+
+ @Override
+ protected boolean isPermitted() {
+ return SecurityUtils.canAccessLog(getBuild());
+ }
+
+ public Component renderOptions(String componentId) {
+ var fragment = new Fragment(componentId, "optionsFrag", this);
+ var stickyActions = new WebMarkupContainer("stickyActions");
+ stickyActions.add(newCancelLink("cancel"), newTerminalLink("terminal"));
+ stickyActions.add(newBuildObserver(getBuild().getId()));
+ fragment.add(stickyActions);
+ fragment.add(new ResourceLink<Void>("download", new BuildLogResourceReference(),
+ BuildLogResource.paramsOf(getProject().getId(), getBuild().getNumber(), null)));
+ return fragment;
+ }
+}
diff --git a/server-core/src/main/java/io/onedev/server/web/page/project/builds/detail/log/BuildStepsResourceReference.java b/server-core/src/main/java/io/onedev/server/web/page/project/builds/detail/log/BuildStepsResourceReference.java
new file mode 100644
index 0000000000..622c8298fd
--- /dev/null
+++ b/server-core/src/main/java/io/onedev/server/web/page/project/builds/detail/log/BuildStepsResourceReference.java
@@ -0,0 +1,32 @@
+package io.onedev.server.web.page.project.builds.detail.log;
+
+import java.util.List;
+
+import org.apache.wicket.markup.head.CssHeaderItem;
+import org.apache.wicket.markup.head.HeaderItem;
+import org.apache.wicket.markup.head.JavaScriptHeaderItem;
+
+import io.onedev.server.web.asset.joblogentry.JobLogEntryResourceReference;
+import io.onedev.server.web.component.build.status.BuildStatusCssResourceReference;
+import io.onedev.server.web.component.progress.TimeProgressResourceReference;
+import io.onedev.server.web.page.base.BaseDependentCssResourceReference;
+import io.onedev.server.web.page.base.BaseDependentResourceReference;
+
+public class BuildStepsResourceReference extends BaseDependentResourceReference {
+ private static final long serialVersionUID = 1L;
+
+ public BuildStepsResourceReference() {
+ super(BuildStepsResourceReference.class, "build-steps.js");
+ }
+
+ @Override
+ public List<HeaderItem> getDependencies() {
+ var dependencies = super.getDependencies();
+ dependencies.add(JavaScriptHeaderItem.forReference(new JobLogEntryResourceReference()));
+ dependencies.add(JavaScriptHeaderItem.forReference(new TimeProgressResourceReference()));
+ dependencies.add(CssHeaderItem.forReference(new BuildStatusCssResourceReference()));
+ dependencies.add(CssHeaderItem.forReference(new BaseDependentCssResourceReference(
+ BuildStepsResourceReference.class, "build-steps.css")));
+ return dependencies;
+ }
+}
diff --git a/server-core/src/main/java/io/onedev/server/web/page/project/builds/detail/log/build-steps.css b/server-core/src/main/java/io/onedev/server/web/page/project/builds/detail/log/build-steps.css
new file mode 100644
index 0000000000..92a29dc1f6
--- /dev/null
+++ b/server-core/src/main/java/io/onedev/server/web/page/project/builds/detail/log/build-steps.css
@@ -0,0 +1,151 @@
+.build-steps { min-width: 0; }
+.build-steps-layout { min-width: 0; }
+.build-steps-main { min-width: 0; }
+.build-step-sticky-actions { display: none; }
+.sticky-tabs-row.is-docked .build-step-sticky-actions { display: inline-flex; }
+.build-duration-progress {
+ position: sticky;
+ top: var(--build-progress-sticky-top, 0px);
+ z-index: 3;
+ margin-bottom: .75rem;
+ border-radius: 2px;
+}
+.build-duration-progress.is-docked { border-radius: 0; }
+.step-update-rail {
+ flex: 0 0 14px;
+ /* Dock to the card edge, or to the side panel when it is pinned open. */
+ margin: 0 -2.25rem 0 1rem;
+}
+.step-update-control {
+ position: sticky;
+ top: var(--build-update-sticky-top, 0px);
+ display: flex;
+ flex-direction: column;
+ align-items: center;
+ justify-content: center;
+ width: 14px;
+ height: 72px;
+ padding: 7px 0;
+ border: 1px solid rgba(137, 80, 252, .3);
+ border-radius: 0;
+ color: var(--info);
+ background: var(--light-info);
+ box-shadow: 0 2px 8px rgba(137, 80, 252, .08);
+ cursor: pointer;
+ transition: background .2s, color .2s, box-shadow .2s;
+}
+.step-update-control:hover {
+ background: #e3d4ff;
+ box-shadow: 0 4px 16px rgba(137, 80, 252, .18);
+}
+.step-update-control:focus-visible {
+ outline: 2px solid currentColor;
+ outline-offset: 3px;
+}
+.step-update-activity {
+ position: relative;
+ overflow: hidden;
+ width: 10px;
+ height: 56px;
+}
+.step-update-activity>span {
+ position: absolute;
+ top: 0;
+ left: 2px;
+ width: 6px;
+ height: 1px;
+ background: currentColor;
+ transform: translateY(calc(3px + var(--line-index, 0) * 7px));
+ animation: step-update-scroll 4s linear infinite;
+ animation-delay: calc(var(--line-index, 0) * -.5s);
+}
+.step-update-activity>span:nth-child(2) { --line-index: 1; }
+.step-update-activity>span:nth-child(3) { --line-index: 2; }
+.step-update-activity>span:nth-child(4) { --line-index: 3; }
+.step-update-activity>span:nth-child(5) { --line-index: 4; }
+.step-update-activity>span:nth-child(6) { --line-index: 5; }
+.step-update-activity>span:nth-child(7) { --line-index: 6; }
+.step-update-activity>span:nth-child(8) { --line-index: 7; }
+.step-update-activity>span:nth-child(3n+2) { width: 4px; }
+.step-update-activity>span:nth-child(3n) { width: 5px; }
+.step-update-control[aria-pressed="false"] {
+ color: #805514;
+ background: #fff8e9;
+ border-color: #ebd5ae;
+}
+.step-update-control[aria-pressed="false"]:hover { background: #fff0ce; }
+.step-update-control[aria-pressed="false"] .step-update-activity>span {
+ animation-play-state: paused;
+ opacity: .3;
+}
+.dark-mode .step-update-control {
+ color: rgb(176, 142, 255);
+ background: var(--dark-mode-light-info);
+ border-color: rgba(176, 142, 255, .35);
+}
+.dark-mode .step-update-control:hover { background: #3b3062; }
+.dark-mode .step-update-control[aria-pressed="false"] {
+ color: #e8bf7a;
+ background: #392f28;
+ border-color: #655038;
+}
+.dark-mode .step-update-control[aria-pressed="false"]:hover { background: #493b2c; }
+@keyframes step-update-scroll {
+ from { transform: translateY(60px); }
+ to { transform: translateY(-4px); }
+}
+@media (prefers-reduced-motion: reduce) {
+ .step-update-activity>span { animation: none; }
+ .step-update-control { transition: none; }
+}
+@media (min-width: 1199px) {
+ html:not(.hide-side-info) .side-info-visible .step-update-rail { margin-right: -2rem; }
+}
+.build-step .step-header {
+ position: sticky;
+ top: var(--build-step-sticky-top, 0px);
+ z-index: 2;
+ gap: .25rem;
+ flex-wrap: wrap;
+ /* Join the sticky header's top corners to the section's side borders. */
+ margin-left: -4px;
+ margin-right: -1px;
+ /* Overlap the section's bottom border so rounded corners share one outline. */
+ margin-bottom: -1px;
+ border: 1px solid;
+ border-left-width: 4px;
+ border-color: inherit;
+ border-top-left-radius: inherit;
+ border-top-right-radius: inherit;
+}
+/* Draw the log divider inside the colored side borders, avoiding diagonal border joins. */
+.build-step .step-header::after {
+ content: "";
+ position: absolute;
+ left: 0;
+ right: 0;
+ bottom: -1px;
+ height: 1px;
+ background: var(--light-gray);
+ pointer-events: none;
+}
+.dark-mode .build-step .step-header::after { background: var(--dark-mode-light-dark); }
+.build-step.step-collapsed .step-header::after,
+.build-step.is-docked-bottom .step-header::after { display: none; }
+.build-step.step-collapsed .step-header,
+.build-step.is-docked-bottom .step-header {
+ border-bottom-left-radius: inherit;
+ border-bottom-right-radius: inherit;
+}
+.build-step .step-toggle { overflow-wrap: anywhere; color: inherit; }
+.build-step .step-body { overflow-anchor: none; }
+.build-step .log { white-space: pre-wrap; overflow-wrap: anywhere; }
+.build-step {
+ border-top-width: 0 !important;
+ border-left-width: 4px !important;
+ border-radius: .42rem;
+}
+.build-step.is-docked {
+ border-top-left-radius: 0;
+ border-top-right-radius: 0;
+}
diff --git a/server-core/src/main/java/io/onedev/server/web/page/project/builds/detail/log/build-steps.js b/server-core/src/main/java/io/onedev/server/web/page/project/builds/detail/log/build-steps.js
new file mode 100644
index 0000000000..bc8deabf52
--- /dev/null
+++ b/server-core/src/main/java/io/onedev/server/web/page/project/builds/detail/log/build-steps.js
@@ -0,0 +1,295 @@
+onedev.server.buildSteps = {
+ init: function(id, callback, resume, maxEntries, latestEntriesNotice, noEntriesNotice) {
+ const self = this;
+ if (self.timer) clearInterval(self.timer);
+ self.stopPositioning();
+ if (self.steps) self.steps.forEach(step => {
+ if (step.statusTooltip) step.statusTooltip.destroy();
+ step.downloadTooltip.destroy();
+ });
+ self.container = document.getElementById(id);
+ self.layout = self.container.closest('.build-steps-layout');
+ self.progressElement = self.layout.querySelector('.build-duration-progress');
+ self.positionListener = function() {
+ if (!self.positionFrame)
+ self.positionFrame = requestAnimationFrame(function() {
+ self.positionFrame = undefined;
+ if (self.container.isConnected) self.updateStickyTop();
+ });
+ };
+ window.addEventListener('scroll', self.positionListener, true);
+ window.addEventListener('resize', self.positionListener);
+ self.positionObserver = new ResizeObserver(self.positionListener);
+ self.positionObserver.observe(self.layout);
+ self.positionObserver.observe(self.container);
+ const tabs = $(self.layout).siblings('.sticky-tabs-row')[0];
+ if (tabs) self.positionObserver.observe(tabs);
+ self.callback = callback;
+ self.resume = resume;
+ self.maxEntries = maxEntries;
+ self.latestEntriesNotice = latestEntriesNotice;
+ self.noEntriesNotice = noEntriesNotice;
+ self.steps = new Map();
+ self.sequence = undefined;
+ self.busy = false;
+ self.queued = false;
+ self.autoUpdate = true;
+ self.timer = setInterval(function() {
+ if (!self.container.isConnected) {
+ clearInterval(self.timer);
+ self.stopPositioning();
+ return;
+ }
+ if (self.autoUpdate)
+ self.steps.forEach(step => self.showDuration(step));
+ }, 1000);
+ },
+ stopPositioning: function() {
+ if (this.positionListener) {
+ window.removeEventListener('scroll', this.positionListener, true);
+ window.removeEventListener('resize', this.positionListener);
+ }
+ if (this.positionObserver) this.positionObserver.disconnect();
+ if (this.positionFrame) cancelAnimationFrame(this.positionFrame);
+ this.positionFrame = undefined;
+ },
+ setAutoUpdate: function(enabled) {
+ this.autoUpdate = enabled;
+ this.busy = false;
+ this.queued = false;
+ if (enabled)
+ this.steps.forEach(step => { step.fetch = step.expanded; });
+ },
+ setProgress: function(progress) {
+ if (!this.autoUpdate) return;
+ onedev.server.timeProgress.update(this.progressElement.id,
+ progress ? progress.elapsed / 1000 : 0, progress ? progress.expected / 1000 : 0);
+ this.updateStickyTop();
+ },
+ getOffsets: function() {
+ const offsets = {};
+ this.steps.forEach(step => {
+ if (step.expanded && (this.autoUpdate || step.fetch)) offsets[step.name] = step.next;
+ });
+ return JSON.stringify(offsets);
+ },
+ refresh: function() {
+ if (!this.container || !this.container.isConnected) return;
+ if (!this.autoUpdate && !Array.from(this.steps.values()).some(step => step.expanded && step.fetch)) return;
+ if (this.busy) {
+ this.queued = true;
+ return;
+ }
+ this.busy = true;
+ this.callback(this.getOffsets());
+ },
+ showDuration: function(step) {
+ if (!step.durationLabel) return;
+ const seconds = Math.floor((step.duration + (step.status === 'RUNNING' ? Date.now() - step.updated : 0)) / 1000);
+ step.durationLabel.text(Math.floor(seconds / 60) + 'm ' + (seconds % 60) + 's');
+ },
+ setExpanded: function(step, expanded) {
+ step.expanded = expanded;
+ step.section.toggleClass('step-collapsed', !expanded);
+ step.body.toggle(expanded);
+ step.toggle.attr('aria-expanded', expanded);
+ step.arrow.toggleClass('rotate-90', expanded);
+ if (!expanded) {
+ step.fetch = false;
+ step.log.empty();
+ step.next = 0;
+ step.notice.hide();
+ }
+ },
+ create: function(data) {
+ const self = this;
+ const step = {
+ name: data.name,
+ next: 0,
+ expanded: data.active
+ };
+ step.title = data.title;
+ const section = $('<section class="build-step border mb-3"></section>').appendTo(self.container);
+ step.section = section;
+ const header = $('<div class="step-header bg-white d-flex align-items-center p-3"></div>').appendTo(section);
+ step.header = header;
+ step.toggle = $('<button type="button" class="step-toggle btn btn-link text-left p-0 font-weight-bold d-inline-flex align-items-center"></button>').appendTo(header);
+ step.arrow = $('<svg class="icon icon-sm mr-1"><use xlink:href="' + onedev.server.icons + '#arrow"/></svg>').appendTo(step.toggle);
+ $('<span></span>').text(step.title).appendTo(step.toggle);
+ if (data.stepIndex != null)
+ step.stepPosition = $('<span class="step-position text-muted font-weight-normal text-nowrap ml-2"></span>')
+ .appendTo(step.toggle);
+ if (data.status) {
+ step.statusLabel = $('<span class="step-status ml-2 d-inline-flex" role="img" tabindex="0"></span>').appendTo(header);
+ step.statusIcon = $('<svg aria-hidden="true"><use/></svg>').appendTo(step.statusLabel);
+ step.statusTooltip = tippy(step.statusLabel[0], {
+ content: data.statusText,
+ delay: [500, 0],
+ placement: 'auto'
+ });
+ step.durationLabel = $('<span class="step-duration text-muted ml-2 d-none d-md-inline"></span>').appendTo(header);
+ }
+ const actions = $('<div class="step-actions d-flex align-items-center ml-auto"></div>').appendTo(header);
+ step.download = $('<a class="link-secondary ml-4 d-none d-md-inline"><svg class="icon" aria-hidden="true"><use xlink:href="' + onedev.server.icons + '#download2"/></svg></a>')
+ .attr('aria-label', data.downloadText).appendTo(actions);
+ step.downloadTooltip = tippy(step.download[0], {
+ content: data.downloadText,
+ delay: [500, 0],
+ placement: 'auto'
+ });
+ step.body = $('<div class="step-body"></div>').appendTo(section);
+ step.log = $('<pre class="log text-break font-size-sm p-3 mb-0"></pre>').appendTo(step.body);
+ step.notice = $('<div class="step-notice text-muted px-3 pt-3"></div>').text(self.noEntriesNotice).prependTo(step.body);
+ step.paused = $('<div class="text-warning p-3">Execution paused</div>').appendTo(step.body).hide();
+ if (self.resume) $('<button type="button" class="btn btn-link ml-2 p-0">Resume</button>').appendTo(step.paused).on('click', self.resume);
+ self.setExpanded(step, step.expanded);
+ step.toggle.on('click', function() {
+ self.setExpanded(step, !step.expanded);
+ if (step.expanded)
+ step.fetch = true;
+ self.refresh();
+ });
+ self.steps.set(step.name, step);
+ return step;
+ },
+ update: function(data, paused, sequence, requested) {
+ const self = this;
+ if (!self.autoUpdate && !requested) return;
+ if (self.sequence !== undefined && self.sequence !== sequence) {
+ self.steps.forEach(step => {
+ if (step.statusTooltip) step.statusTooltip.destroy();
+ step.downloadTooltip.destroy();
+ });
+ self.steps.clear();
+ $(self.container).empty();
+ }
+ self.sequence = sequence;
+ if (self.autoUpdate) {
+ const names = new Set(data.map(item => item.name));
+ self.steps.forEach((step, name) => {
+ if (!names.has(name)) {
+ if (step.statusTooltip) step.statusTooltip.destroy();
+ step.downloadTooltip.destroy();
+ step.section.remove();
+ self.steps.delete(name);
+ }
+ });
+ }
+ data.forEach((item, index) => {
+ let step = self.steps.get(item.name);
+ if (!self.autoUpdate) {
+ if (step && step.expanded && step.fetch)
+ self.appendEntries(step, item);
+ return;
+ }
+ if (!step) {
+ step = self.create(item);
+ }
+ self.updateStep(step, item, index, paused);
+ });
+ if (!data.length) $(self.container).text('No step logs available');
+ else $(self.container).contents().filter(function() { return this.nodeType === 3; }).remove();
+ self.updateStickyTop();
+ if (requested) {
+ self.busy = false;
+ if (self.queued) {
+ self.queued = false;
+ self.refresh();
+ }
+ }
+ },
+ updateStep: function(step, item, index, paused) {
+ const self = this;
+ if (step.stepPosition)
+ step.stepPosition.text(item.stepIndex + '/' + item.stepCount);
+ if (step.active && !item.active)
+ self.setExpanded(step, false);
+ if (step.active === false && item.active)
+ self.setExpanded(step, true);
+ step.active = item.active;
+ step.status = item.status;
+ const position = self.container.children[index];
+ if (position !== step.section[0]) self.container.insertBefore(step.section[0], position || null);
+ if (item.status) {
+ const displayStatus = item.skipped ? 'skipped' : item.status.toLowerCase();
+ const borderStyle = {running: 'warning', successful: 'success', failed: 'danger', cancelled: 'danger', skipped: 'secondary'}[displayStatus];
+ step.section.attr('data-status', displayStatus)
+ .removeClass('border-warning border-success border-danger border-secondary').addClass('border-' + borderStyle);
+ step.duration = item.duration;
+ step.updated = Date.now();
+ const statusIcon = {running: 'spin', successful: 'tick', failed: 'times', cancelled: 'cancel', skipped: 'minus'}[displayStatus];
+ step.statusLabel.attr('aria-label', item.statusText);
+ step.statusTooltip.setContent(item.statusText);
+ step.statusIcon.attr('class', 'icon flex-shrink-0 ' + (item.skipped ? 'text-muted' : 'build-status-' + displayStatus)
+ + (displayStatus === 'running' ? ' spin' : ''));
+ step.statusIcon.find('use')[0].setAttributeNS('http://www.w3.org/1999/xlink', 'xlink:href', onedev.server.icons + '#' + statusIcon);
+ } else {
+ step.section.addClass('build-phase border-secondary');
+ }
+ step.download.attr('href', item.download);
+ step.paused.toggle(paused && item.status === 'RUNNING');
+ self.showDuration(step);
+ self.appendEntries(step, item);
+ },
+ appendEntries: function(step, item) {
+ const self = this;
+ if (item.entries && step.expanded && (self.autoUpdate || step.fetch)) {
+ // A response sent before collapse may only contain a delta. Reload the tail instead.
+ if (item.from > step.next) {
+ self.refresh();
+ return;
+ }
+ if (item.offset > step.next) step.log.empty();
+ const newEntries = item.entries.slice(Math.max(0, step.next - item.offset));
+ onedev.server.jobLogEntry.append(step.log, newEntries, true);
+ const entries = step.log.children();
+ if (entries.length > self.maxEntries) entries.slice(0, entries.length - self.maxEntries).remove();
+ step.next = Math.max(step.next, item.next);
+ step.fetch = false;
+ step.notice.text(item.next > self.maxEntries ? self.latestEntriesNotice : self.noEntriesNotice)
+ .toggle(item.next > self.maxEntries || item.next === 0);
+ if (self.autoUpdate && step.active)
+ step.body[0].scrollIntoView({block: 'end'});
+ }
+ },
+ updateStickyTop: function() {
+ const layout = this.layout;
+ const tabs = $(layout).siblings('.sticky-tabs-row');
+ const tabsHeight = tabs.outerHeight() || 0;
+ const progressHeight = this.progressElement.hidden ? 0 : this.progressElement.offsetHeight;
+ layout.style.setProperty('--build-progress-sticky-top', tabsHeight + 'px');
+ layout.style.setProperty('--build-step-sticky-top', (tabsHeight + progressHeight) + 'px');
+ this.progressElement.classList.toggle('is-docked', !this.progressElement.hidden
+ && this.progressElement.getBoundingClientRect().top > this.progressElement.parentElement.getBoundingClientRect().top + .5);
+ this.steps.forEach(step => {
+ const headerBounds = step.header[0].getBoundingClientRect();
+ const sectionBounds = step.section[0].getBoundingClientRect();
+ const docked = headerBounds.top > sectionBounds.top + .5;
+ step.section.toggleClass('is-docked', docked);
+ // Round the header only when it overlaps the section's bottom border.
+ step.section.toggleClass('is-docked-bottom', docked
+ && headerBounds.bottom >= sectionBounds.bottom - .5);
+ });
+ this.updateControlPosition(tabsHeight + progressHeight);
+ },
+ updateControlPosition: function(stepTop) {
+ const control = this.layout.querySelector('.step-update-control');
+ if (!control) return;
+ let scrollParent = this.layout.parentElement;
+ while (scrollParent && !/(auto|scroll|hidden|overlay)/.test(getComputedStyle(scrollParent).overflowY))
+ scrollParent = scrollParent.parentElement;
+ let scrollTop = 0;
+ let visibleTop = 0;
+ let visibleBottom = window.innerHeight;
+ if (scrollParent && scrollParent !== document.body && scrollParent !== document.documentElement) {
+ scrollTop = scrollParent.getBoundingClientRect().top + scrollParent.clientTop;
+ visibleTop = Math.max(visibleTop, scrollTop);
+ visibleBottom = Math.min(visibleBottom, scrollTop + scrollParent.clientHeight);
+ }
+ const bounds = this.container.getBoundingClientRect();
+ visibleTop = Math.max(visibleTop, bounds.top, scrollTop + stepTop);
+ visibleBottom = Math.min(visibleBottom, bounds.bottom);
+ const top = Math.max(visibleTop, (visibleTop + visibleBottom - control.offsetHeight) / 2);
+ this.layout.style.setProperty('--build-update-sticky-top', (top - scrollTop) + 'px');
+ }
+};
diff --git a/server-core/src/main/java/io/onedev/server/web/resource/BuildLogResource.java b/server-core/src/main/java/io/onedev/server/web/resource/BuildLogResource.java
index b3e6c811d8..3606dee98e 100644
--- a/server-core/src/main/java/io/onedev/server/web/resource/BuildLogResource.java
+++ b/server-core/src/main/java/io/onedev/server/web/resource/BuildLogResource.java
@@ -8,6 +8,7 @@ import java.io.OutputStream;
import java.io.UnsupportedEncodingException;
import java.net.URLEncoder;
import java.nio.charset.StandardCharsets;
+import java.util.List;
import jakarta.persistence.EntityNotFoundException;
import jakarta.ws.rs.client.Client;
@@ -27,8 +28,8 @@ import org.apache.wicket.request.resource.AbstractResource;
import io.onedev.k8shelper.KubernetesHelper;
import io.onedev.server.OneDev;
import io.onedev.server.cluster.ClusterService;
-import io.onedev.server.logging.BuildLoggingIdentity;
-import io.onedev.server.logging.LogService;
+import io.onedev.server.logging.build.BuildLogService;
+import io.onedev.server.logging.build.BuildLoggingIdentity;
import io.onedev.server.model.Build;
import io.onedev.server.model.Project;
import io.onedev.server.security.SecurityUtils;
@@ -49,6 +50,8 @@ public class BuildLogResource extends AbstractResource {
PageParameters params = attributes.getParameters();
Long projectId = params.get(PARAM_PROJECT).toLong();
+ String stage = params.get("stage").toOptionalString();
+ String fileName = stage != null ? BuildLoggingIdentity.getFileName(stage) : "build.log";
Long buildNumber = params.get(PARAM_BUILD).toOptionalLong();
if (buildNumber == null)
throw new IllegalArgumentException("build number has to be specified");
@@ -73,7 +76,7 @@ public class BuildLogResource extends AbstractResource {
response.disableCaching();
try {
- response.setFileName(URLEncoder.encode("build-log.txt", StandardCharsets.UTF_8.name()));
+ response.setFileName(URLEncoder.encode(fileName, StandardCharsets.UTF_8.name()));
} catch (UnsupportedEncodingException e) {
throw new RuntimeException(e);
}
@@ -84,9 +87,12 @@ public class BuildLogResource extends AbstractResource {
String activeServer = getProjectService().getActiveServer(projectId, true);
var clusterService = getClusterService();
if (activeServer.equals(clusterService.getLocalServerAddress())) {
- var loggingIdentity = new BuildLoggingIdentity(projectId, buildNumber);
+ var identities = stage != null
+ ? List.of(new BuildLoggingIdentity(projectId, buildNumber, stage))
+ : getBuildService().find(getProjectService().load(projectId), buildNumber).getLogStages()
+ .stream().map(name -> new BuildLoggingIdentity(projectId, buildNumber, name)).toList();
try (
- InputStream is = getLogService().openLogStream(loggingIdentity);
+ InputStream is = getBuildLogService().openLogStream(identities);
OutputStream os = attributes.getResponse().getOutputStream()) {
IOUtils.copy(is, os, BUFFER_SIZE);
}
@@ -95,7 +101,7 @@ public class BuildLogResource extends AbstractResource {
try {
var pathAndQuery = Url.parse(RequestCycle.get().urlFor(
new BuildLogResourceReference(),
- BuildLogResource.paramsOf(projectId, buildNumber)));
+ BuildLogResource.paramsOf(projectId, buildNumber, stage)));
String activeServerUrl = clusterService.getServerUrl(activeServer);
WebTarget target = client.target(activeServerUrl).path(pathAndQuery.getPath());
@@ -132,18 +138,20 @@ public class BuildLogResource extends AbstractResource {
return OneDev.getInstance(ClusterService.class);
}
- private LogService getLogService() {
- return OneDev.getInstance(LogService.class);
+ private BuildLogService getBuildLogService() {
+ return OneDev.getInstance(BuildLogService.class);
}
private BuildService getBuildService() {
return OneDev.getInstance(BuildService.class);
}
- public static PageParameters paramsOf(Long projectId, Long buildNumber) {
+ public static PageParameters paramsOf(Long projectId, Long buildNumber, @org.jspecify.annotations.Nullable String stage) {
PageParameters params = new PageParameters();
params.set(PARAM_PROJECT, projectId);
params.set(PARAM_BUILD, buildNumber);
+ if (stage != null)
+ params.set("stage", stage);
return params;
}
diff --git a/server-core/src/test/java/io/onedev/server/buildspec/job/log/JobLogEntryExTest.java b/server-core/src/test/java/io/onedev/server/buildspec/job/log/JobLogEntryExTest.java
deleted file mode 100644
index d5d30e59be..0000000000
--- a/server-core/src/test/java/io/onedev/server/buildspec/job/log/JobLogEntryExTest.java
+++ /dev/null
@@ -1,76 +0,0 @@
-package io.onedev.server.buildspec.job.log;
-
-import static org.junit.jupiter.api.Assertions.assertEquals;
-
-import org.junit.jupiter.api.Test;
-
-import com.google.common.collect.Lists;
-
-import io.onedev.server.logging.StyleBuilder;
-
-public class JobLogEntryExTest {
-
- @Test
- public void test() {
- JobLogEntryEx entry;
-
- var styleBuilder = new StyleBuilder();
- JobLogEntryEx.parse("\u001B[30;43ma\u001B[39;49m", styleBuilder);
- entry = JobLogEntryEx.parse("\u001B[34mb\u001B[39m", styleBuilder);
- assertEquals(Lists.newArrayList(
- new Message(new Style("34", Style.BACKGROUND_COLOR_DEFAULT, false), "b")
- ), entry.getMessages());
-
- entry = JobLogEntryEx.parse("a\r\nb", new StyleBuilder());
- assertEquals(Lists.newArrayList(
- new Message(new Style(Style.FOREGROUND_COLOR_DEFAULT, Style.BACKGROUND_COLOR_DEFAULT, false), "a\nb")
- ), entry.getMessages());
-
- entry = JobLogEntryEx.parse("a\nb", new StyleBuilder());
- assertEquals(Lists.newArrayList(
- new Message(new Style(Style.FOREGROUND_COLOR_DEFAULT, Style.BACKGROUND_COLOR_DEFAULT, false), "a\nb")
- ), entry.getMessages());
-
- entry = JobLogEntryEx.parse("\u001b]0;This is the window title\u0007hello\u001b]8;link\u001b\\world\u001b]P1888888just\u001b\u0020\u0020\u0030do", new StyleBuilder());
- assertEquals(Lists.newArrayList(
- new Message(new Style(Style.FOREGROUND_COLOR_DEFAULT, Style.BACKGROUND_COLOR_DEFAULT, false), "hellolinkworldjustdo")
- ), entry.getMessages());
-
- entry = JobLogEntryEx.parse("\u001b[31m12345\u001b[0m\u001b[32mabcde\u001b[m\u001b[6D\u001b[1K", new StyleBuilder());
- assertEquals(Lists.newArrayList(
- new Message(new Style("31", Style.BACKGROUND_COLOR_DEFAULT, false), "5"),
- new Message(new Style("32", Style.BACKGROUND_COLOR_DEFAULT, false), "abcde")
- ), entry.getMessages());
-
- entry = JobLogEntryEx.parse("\u001b[31m12345\u001b[0m\u001b[32mabcde\u001b[m\u001b[6D\u001b[K", new StyleBuilder());
- assertEquals(Lists.newArrayList(
- new Message(new Style("31", Style.BACKGROUND_COLOR_DEFAULT, false), "1234")
- ), entry.getMessages());
-
- entry = JobLogEntryEx.parse("\u001b[31m12345\u001b[0m\u001b[32mabcde\u001b[m\u001b[6D\u001b[34mxxxxxxx", new StyleBuilder());
- assertEquals(Lists.newArrayList(
- new Message(new Style("31", Style.BACKGROUND_COLOR_DEFAULT, false), "1234"),
- new Message(new Style("34", Style.BACKGROUND_COLOR_DEFAULT, false), "xxxxxxx")
- ), entry.getMessages());
-
- entry = JobLogEntryEx.parse("\u001b[31m12345\u001b[0m\u001b[32mabcde\u001b[m\u001b[6D\u001b[34mxy", new StyleBuilder());
- assertEquals(Lists.newArrayList(
- new Message(new Style("31", Style.BACKGROUND_COLOR_DEFAULT, false), "1234"),
- new Message(new Style("34", Style.BACKGROUND_COLOR_DEFAULT, false), "xy"),
- new Message(new Style("32", Style.BACKGROUND_COLOR_DEFAULT, false), "bcde")
- ), entry.getMessages());
-
- entry = JobLogEntryEx.parse("\u001b[31m12345\u001b[0m\u001b[32mabcde\u001b[m\u001b[10Dabcde12345", new StyleBuilder());
- assertEquals(Lists.newArrayList(
- new Message(new Style(Style.FOREGROUND_COLOR_DEFAULT, Style.BACKGROUND_COLOR_DEFAULT, false), "abcde12345")
- ), entry.getMessages());
-
- entry = JobLogEntryEx.parse("\u001b[31mRED\u001b[0m and \u001b[32mGREEN\u001b[m", new StyleBuilder());
- assertEquals(Lists.newArrayList(
- new Message(new Style("31", Style.BACKGROUND_COLOR_DEFAULT, false), "RED"),
- new Message(new Style(Style.FOREGROUND_COLOR_DEFAULT, Style.BACKGROUND_COLOR_DEFAULT, false), " and "),
- new Message(new Style("32", Style.BACKGROUND_COLOR_DEFAULT, false), "GREEN")
- ), entry.getMessages());
- }
-
-}
diff --git a/server-core/src/test/java/io/onedev/server/logging/DefaultLogServiceTest.java b/server-core/src/test/java/io/onedev/server/logging/DefaultLogServiceTest.java
new file mode 100644
index 0000000000..9c63285ba5
--- /dev/null
+++ b/server-core/src/test/java/io/onedev/server/logging/DefaultLogServiceTest.java
@@ -0,0 +1,288 @@
+package io.onedev.server.logging;
+
+import static org.junit.jupiter.api.Assertions.*;
+import static org.mockito.ArgumentMatchers.*;
+import static org.mockito.Mockito.*;
+
+import java.nio.file.Path;
+import java.util.List;
+import java.util.regex.Pattern;
+
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.io.TempDir;
+
+import io.onedev.server.cluster.ClusterService;
+import io.onedev.server.cluster.ClusterTask;
+import io.onedev.server.persistence.TransactionService;
+import io.onedev.server.web.websocket.WebSocketService;
+
+class DefaultLogServiceTest {
+ @TempDir Path directory;
+
+ @Test
+ void malformedHeaderClosesUnderlyingFile() throws Exception {
+ var identity = fileIdentity("malformed");
+ java.nio.file.Files.write(identity.getFile().toPath(), new byte[] {0, 0, 0, 0});
+ // Load the reader classes before mocking streams also used by the class loader.
+ assertThrows(RuntimeException.class, () -> new DefaultLogService().openLogStream(identity));
+ try (var files = mockConstruction(java.io.FileInputStream.class, (input, context) -> {
+ when(input.read(any(byte[].class), anyInt(), anyInt())).thenAnswer(invocation -> {
+ byte[] bytes = invocation.getArgument(0);
+ int offset = invocation.getArgument(1);
+ java.util.Arrays.fill(bytes, offset, offset + 4, (byte) 0);
+ return 4;
+ });
+ })) {
+ assertThrows(RuntimeException.class, () -> new DefaultLogService().openLogStream(identity));
+ assertEquals(1, files.constructed().size());
+ verify(files.constructed().get(0)).close();
+ }
+ assertUnlocked(identity);
+ }
+
+
+
+ @Test
+ void completedAndInterruptedDownloadsReleaseLocks() throws Exception {
+ var identity = fileIdentity("download");
+ writeObjects(identity, entry(1, "first"), entry(2, "second"), entry(3, "third"));
+ var service = new DefaultLogService();
+ try (var stream = service.openLogStream(identity)) {
+ stream.readAllBytes();
+ assertUnlocked(identity);
+ }
+ var disconnected = new java.io.OutputStream() {
+ @Override
+ public void write(int value) throws java.io.IOException {
+ throw new java.io.IOException("Client disconnected");
+ }
+ };
+ assertThrows(java.io.IOException.class, () -> {
+ try (var stream = service.openLogStream(identity)) {
+ stream.transferTo(disconnected);
+ }
+ });
+ assertUnlocked(identity);
+ }
+
+
+
+ @Test
+ void flushAndClearTouchOnlyTheSpecifiedFileEvenWhenLogsShareALockAndDirectory() throws Exception {
+ var service = new DefaultLogService();
+ inject(service, "webSocketService", mock(WebSocketService.class));
+ inject(service, "clusterService", mock(ClusterService.class));
+ inject(service, "transactionService", mock(TransactionService.class));
+ var first = fileIdentity("first");
+ var second = fileIdentity("second");
+ doReturn(first.getLockName()).when(second).getLockName();
+ var firstSupport = mock(LoggingSupport.class);
+ var secondSupport = mock(LoggingSupport.class);
+ when(firstSupport.getIdentity()).thenReturn(first);
+ when(secondSupport.getIdentity()).thenReturn(second);
+ service.newLogger(firstSupport).log("first entry");
+ service.newLogger(secondSupport).log("second entry");
+ service.flush(firstSupport);
+ assertTrue(first.getFile().exists());
+ assertFalse(second.getFile().exists(), "Flushing one file must not flush its sibling");
+ service.clear(firstSupport);
+ assertFalse(first.getFile().exists());
+ assertEquals("second entry", service.readLogEntries(second, 0, 0).get(0).getMessageText());
+ service.flush(secondSupport);
+ service.clear(firstSupport);
+ assertTrue(second.getFile().exists(), "Clearing one file must not delete its sibling");
+ assertEquals("second entry", service.readLogEntries(second, 0, 0).get(0).getMessageText());
+ }
+
+ @Test
+ void loggingAndFlushNotifyOutsideTheLogLock() throws Exception {
+ var service = new DefaultLogService();
+ var identity = fileIdentity("notifications");
+ var support = mock(LoggingSupport.class);
+ when(support.getIdentity()).thenReturn(identity);
+ when(support.getMaskSecrets()).thenReturn(List.of("secret"));
+ var lock = (java.util.concurrent.locks.ReentrantReadWriteLock)
+ io.onedev.commons.utils.LockUtils.getReadWriteLock(identity.getLockName());
+ Runnable assertUnlocked = () -> {
+ assertFalse(lock.isWriteLockedByCurrentThread());
+ assertEquals(0, lock.getReadHoldCount());
+ };
+ var websocket = mock(WebSocketService.class);
+ doAnswer(it -> {
+ assertUnlocked.run();
+ return null;
+ }).when(websocket).notifyObservableChange(any(), any());
+ var cluster = mock(ClusterService.class);
+ when(cluster.submitToAllServers(any())).thenAnswer(it -> {
+ assertUnlocked.run();
+ return java.util.Map.of();
+ });
+ var transactions = mock(TransactionService.class);
+ doAnswer(it -> { assertUnlocked.run(); it.getArgument(0, Runnable.class).run(); return null; })
+ .when(transactions).runAfterCommit(any());
+ doAnswer(it -> { assertUnlocked.run(); return null; }).when(support).fileModified();
+ inject(service, "webSocketService", websocket);
+ inject(service, "clusterService", cluster);
+ inject(service, "transactionService", transactions);
+ service.newLogger(support).log("Running step \"secret\"...");
+ verify(websocket).notifyObservableChange(any(), any());
+ verify(cluster).submitToAllServers(any());
+ verify(support, never()).fileModified();
+ service.flush(support);
+ verify(support).fileModified();
+ verify(cluster, times(2)).submitToAllServers(any());
+ assertFalse(service.readLogEntries(identity, 0, 0).get(0).getMessageText().contains("secret"));
+ service.clear(support);
+ verify(support, times(2)).fileModified();
+ }
+
+ private LoggingIdentity fileIdentity(String name) {
+ var identity = mock(LoggingIdentity.class);
+ var file = directory.resolve(name + ".log").toFile();
+ when(identity.getFile()).thenReturn(file);
+ when(identity.getLockName()).thenReturn(file.toString());
+ return identity;
+ }
+
+ private void writeObjects(LoggingIdentity identity, Object... entries) throws Exception {
+ try (var fileOutput = new java.io.FileOutputStream(identity.getFile());
+ var output = new java.io.ObjectOutputStream(fileOutput)) {
+ for (var entry : entries) output.writeObject(entry);
+ }
+ }
+
+ private void assertUnlocked(LoggingIdentity identity) {
+ var lock = io.onedev.commons.utils.LockUtils.getReadWriteLock(identity.getLockName()).writeLock();
+ assertTrue(lock.tryLock(), "Log reader retained its lock");
+ lock.unlock();
+ }
+
+ private io.onedev.server.logging.LogEntry entry(long time, String message) {
+ return new io.onedev.server.logging.LogEntry(
+ new java.util.Date(time), message);
+ }
+
+ @Test
+ void closingWhileAWriterWaitsDoesNotRecreateTheSnippet() throws Exception {
+ var service = new DefaultLogService();
+ inject(service, "webSocketService", mock(WebSocketService.class));
+ inject(service, "clusterService", mock(ClusterService.class));
+ inject(service, "transactionService", mock(TransactionService.class));
+ var identity = fileIdentity("late-uncreated-stage");
+ java.nio.file.Files.createFile(identity.getFile().toPath());
+ var support = mock(LoggingSupport.class);
+ when(support.getIdentity()).thenReturn(identity);
+ var accepting = new java.util.concurrent.atomic.AtomicBoolean(true);
+ var entered = new java.util.concurrent.CountDownLatch(1);
+ var logger = service.newLogger(support, () -> {
+ boolean result = accepting.get();
+ entered.countDown();
+ return result;
+ });
+ var executor = java.util.concurrent.Executors.newSingleThreadExecutor();
+ var lock = io.onedev.commons.utils.LockUtils.getReadWriteLock(identity.getLockName());
+ java.util.concurrent.Future<?> writer;
+ try {
+ lock.writeLock().lock();
+ try {
+ writer = executor.submit(() -> logger.log("late entry"));
+ assertTrue(entered.await(5, java.util.concurrent.TimeUnit.SECONDS));
+ accepting.set(false);
+ service.flush(support);
+ } finally {
+ lock.writeLock().unlock();
+ }
+ writer.get(5, java.util.concurrent.TimeUnit.SECONDS);
+ assertTrue(service.readLogEntries(identity, 0, 0).isEmpty());
+ assertTrue(identity.getFile().length() > 0);
+ var length = identity.getFile().length();
+ service.flush(support);
+ assertEquals(length, identity.getFile().length());
+ verify(support).fileModified();
+ service.newLogger(support).log("late entry without acceptance predicate");
+ assertTrue(service.readLogEntries(identity, 0, 0).isEmpty());
+ var snippets = DefaultLogService.class.getDeclaredField("recentSnippets");
+ snippets.setAccessible(true);
+ assertTrue(((java.util.Map<?, ?>) snippets.get(service)).isEmpty());
+ } finally {
+ executor.shutdownNow();
+ }
+ }
+
+ private void inject(Object target, String name, Object value) throws Exception {
+ var field = target.getClass().getDeclaredField(name);
+ field.setAccessible(true);
+ field.set(target, value);
+ }
+
+ @Test
+ void stageLogTailSurvivesSpillingAndIgnoresMessagesAfterFlush() throws Exception {
+ var service = new DefaultLogService();
+ inject(service, "webSocketService", mock(WebSocketService.class));
+ inject(service, "clusterService", mock(ClusterService.class));
+ var transactions = mock(TransactionService.class);
+ doAnswer(it -> { it.getArgument(0, Runnable.class).run(); return null; }).when(transactions).runAfterCommit(any());
+ inject(service, "transactionService", transactions);
+ var identity = mock(LoggingIdentity.class);
+ when(identity.getFile()).thenReturn(directory.resolve("log/step-74657374.log").toFile());
+ when(identity.getLockName()).thenReturn(directory.toString());
+ var support = mock(LoggingSupport.class);
+ when(support.getIdentity()).thenReturn(identity);
+ when(support.getMaskSecrets()).thenReturn(List.of("secret"));
+ when(support.getInstructions()).thenReturn(List.of());
+ when(support.getChangeObservable()).thenReturn("test");
+ when(support.getEffectiveDate()).thenAnswer(it -> {
+ var lock = (java.util.concurrent.locks.ReentrantReadWriteLock)
+ io.onedev.commons.utils.LockUtils.getReadWriteLock(identity.getLockName());
+ assertEquals(0, lock.getReadHoldCount(), "Read database metadata before taking the log lock");
+ assertFalse(lock.isWriteLockedByCurrentThread());
+ return null;
+ });
+ when(support.runOnActiveServer(any())).thenAnswer(it -> it.getArgument(0, ClusterTask.class).call());
+ var logger = service.newLogger(support);
+ for (int i = 0; i < 12000; i++) logger.log("line " + i);
+ var tail = service.readLogSnippetReversely(support, 5000);
+ assertEquals(7000, tail.offset);
+ assertEquals(5000, tail.entries.size());
+ assertEquals("line 11999", tail.entries.get(4999).getMessageText());
+ // Downloads include both the persisted prefix and the unflushed tail, with no UI limit.
+ try (var stream = service.openLogStream(identity)) {
+ var lines = new String(stream.readAllBytes(), java.nio.charset.StandardCharsets.UTF_8).lines().toList();
+ assertEquals(12000, lines.size());
+ for (int i = 0; i < lines.size(); i++)
+ assertTrue(lines.get(i).endsWith("line " + i), lines.get(i));
+ }
+ service.flush(support);
+ service.newLogger(support).log("late entry");
+ var snippetsField = DefaultLogService.class.getDeclaredField("recentSnippets");
+ snippetsField.setAccessible(true);
+ assertTrue(((java.util.Map<?, ?>) snippetsField.get(service)).isEmpty());
+ service.flush(support);
+ var reopened = service.readLogSnippetReversely(support, 5000);
+ assertEquals(7000, reopened.offset);
+ assertEquals(5000, reopened.entries.size());
+ assertFalse(service.matches(support, Pattern.compile("late entry")));
+ assertFalse(service.matches(support, Pattern.compile("secret")));
+ assertTrue(service.readLogEntries(support, 12000, 0).isEmpty());
+ try (var stream = service.openLogStream(identity)) {
+ var text = new String(stream.readAllBytes(), java.nio.charset.StandardCharsets.UTF_8);
+ assertEquals(12000, text.lines().count());
+ assertTrue(text.contains("line 0"));
+ assertFalse(text.contains("late entry"));
+ assertFalse(text.contains("secret"));
+ }
+ logger.log("unflushed entry");
+ service.clear(support);
+ assertFalse(identity.getFile().exists());
+ assertTrue(service.readLogEntries(support, 0, 0).isEmpty());
+ logger.log("fresh entry");
+ logger.log("测试 secret");
+ var fresh = service.readLogSnippetReversely(support, 10);
+ assertEquals(0, fresh.offset);
+ assertEquals(2, fresh.entries.size());
+ assertEquals("fresh entry", fresh.entries.get(0).getMessageText());
+ assertTrue(service.matches(support, Pattern.compile("测试")));
+ assertFalse(service.matches(support, Pattern.compile("secret")));
+ }
+
+}
diff --git a/server-core/src/test/java/io/onedev/server/logging/LogEntryTest.java b/server-core/src/test/java/io/onedev/server/logging/LogEntryTest.java
new file mode 100644
index 0000000000..82b0df9fc7
--- /dev/null
+++ b/server-core/src/test/java/io/onedev/server/logging/LogEntryTest.java
@@ -0,0 +1,150 @@
+package io.onedev.server.logging;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertFalse;
+import static org.junit.jupiter.api.Assertions.assertTrue;
+
+import java.io.ByteArrayInputStream;
+import java.io.ByteArrayOutputStream;
+import java.io.ObjectInputStream;
+import java.io.ObjectOutputStream;
+import java.nio.charset.StandardCharsets;
+import java.util.ArrayList;
+import java.util.Date;
+import java.util.List;
+import java.util.Set;
+
+import org.junit.jupiter.api.Test;
+
+import com.google.common.collect.Lists;
+
+import io.onedev.server.util.jackson.ObjectMapperProvider;
+
+public class LogEntryTest {
+
+ @Test
+ public void test() {
+ LogEntry entry;
+
+ var styleBuilder = new StyleBuilder();
+ LogEntry.parse("\u001B[30;43ma\u001B[39;49m", styleBuilder);
+ entry = LogEntry.parse("\u001B[34mb\u001B[39m", styleBuilder);
+ assertEquals(Lists.newArrayList(
+ new Message(new Style("34", Style.BACKGROUND_COLOR_DEFAULT, false), "b")
+ ), entry.getMessages());
+
+ entry = LogEntry.parse("a\r\nb", new StyleBuilder());
+ assertEquals(Lists.newArrayList(
+ new Message(new Style(Style.FOREGROUND_COLOR_DEFAULT, Style.BACKGROUND_COLOR_DEFAULT, false), "a\nb")
+ ), entry.getMessages());
+
+ entry = LogEntry.parse("a\nb", new StyleBuilder());
+ assertEquals(Lists.newArrayList(
+ new Message(new Style(Style.FOREGROUND_COLOR_DEFAULT, Style.BACKGROUND_COLOR_DEFAULT, false), "a\nb")
+ ), entry.getMessages());
+
+ entry = LogEntry.parse("\u001b]0;This is the window title\u0007hello\u001b]8;link\u001b\\world\u001b]P1888888just\u001b\u0020\u0020\u0030do", new StyleBuilder());
+ assertEquals(Lists.newArrayList(
+ new Message(new Style(Style.FOREGROUND_COLOR_DEFAULT, Style.BACKGROUND_COLOR_DEFAULT, false), "hellolinkworldjustdo")
+ ), entry.getMessages());
+
+ entry = LogEntry.parse("\u001b[31m12345\u001b[0m\u001b[32mabcde\u001b[m\u001b[6D\u001b[1K", new StyleBuilder());
+ assertEquals(Lists.newArrayList(
+ new Message(new Style("31", Style.BACKGROUND_COLOR_DEFAULT, false), "5"),
+ new Message(new Style("32", Style.BACKGROUND_COLOR_DEFAULT, false), "abcde")
+ ), entry.getMessages());
+
+ entry = LogEntry.parse("\u001b[31m12345\u001b[0m\u001b[32mabcde\u001b[m\u001b[6D\u001b[K", new StyleBuilder());
+ assertEquals(Lists.newArrayList(
+ new Message(new Style("31", Style.BACKGROUND_COLOR_DEFAULT, false), "1234")
+ ), entry.getMessages());
+
+ entry = LogEntry.parse("\u001b[31m12345\u001b[0m\u001b[32mabcde\u001b[m\u001b[6D\u001b[34mxxxxxxx", new StyleBuilder());
+ assertEquals(Lists.newArrayList(
+ new Message(new Style("31", Style.BACKGROUND_COLOR_DEFAULT, false), "1234"),
+ new Message(new Style("34", Style.BACKGROUND_COLOR_DEFAULT, false), "xxxxxxx")
+ ), entry.getMessages());
+
+ entry = LogEntry.parse("\u001b[31m12345\u001b[0m\u001b[32mabcde\u001b[m\u001b[6D\u001b[34mxy", new StyleBuilder());
+ assertEquals(Lists.newArrayList(
+ new Message(new Style("31", Style.BACKGROUND_COLOR_DEFAULT, false), "1234"),
+ new Message(new Style("34", Style.BACKGROUND_COLOR_DEFAULT, false), "xy"),
+ new Message(new Style("32", Style.BACKGROUND_COLOR_DEFAULT, false), "bcde")
+ ), entry.getMessages());
+
+ entry = LogEntry.parse("\u001b[31m12345\u001b[0m\u001b[32mabcde\u001b[m\u001b[10Dabcde12345", new StyleBuilder());
+ assertEquals(Lists.newArrayList(
+ new Message(new Style(Style.FOREGROUND_COLOR_DEFAULT, Style.BACKGROUND_COLOR_DEFAULT, false), "abcde12345")
+ ), entry.getMessages());
+
+ entry = LogEntry.parse("\u001b[31mRED\u001b[0m and \u001b[32mGREEN\u001b[m", new StyleBuilder());
+ assertEquals(Lists.newArrayList(
+ new Message(new Style("31", Style.BACKGROUND_COLOR_DEFAULT, false), "RED"),
+ new Message(new Style(Style.FOREGROUND_COLOR_DEFAULT, Style.BACKGROUND_COLOR_DEFAULT, false), " and "),
+ new Message(new Style("32", Style.BACKGROUND_COLOR_DEFAULT, false), "GREEN")
+ ), entry.getMessages());
+ }
+
+ @Test
+ public void serializationPreservesPlainStyledAndEmptyEntries() throws Exception {
+ var date = new Date(1234);
+ var entries = List.of(
+ new LogEntry(date, "plain 测试\nsecond line"),
+ new LogEntry(date, ""),
+ new LogEntry(date, new ArrayList<>()),
+ new LogEntry(date, List.of(
+ new Message(new StyleBuilder().build(), "first "),
+ new Message(new StyleBuilder().build(), "second"))),
+ new LogEntry(date, List.of(
+ new Message(new Style("31", Style.BACKGROUND_COLOR_DEFAULT, true), "red"),
+ new Message(new StyleBuilder().build(), " plain"))));
+ var bytes = new ByteArrayOutputStream();
+ try (var output = new ObjectOutputStream(bytes)) {
+ for (var entry : entries)
+ output.writeObject(entry);
+ }
+ try (var input = new ObjectInputStream(new ByteArrayInputStream(bytes.toByteArray()))) {
+ for (var entry : entries) {
+ var restored = (LogEntry) input.readObject();
+ assertEquals(entry.getDate(), restored.getDate());
+ assertEquals(entry.getMessageText(), restored.getMessageText());
+ assertEquals(entry.render(), restored.render());
+ if (entry.getMessages().stream().anyMatch(it -> !it.getStyle().isDefault()))
+ assertEquals(entry.getMessages(), restored.getMessages());
+ else
+ assertTrue(restored.getMessages().stream().allMatch(it -> it.getStyle().isDefault()));
+ }
+ }
+ }
+
+ @Test
+ public void plainEntriesUseCompactSerialization() throws Exception {
+ var bytes = new ByteArrayOutputStream();
+ try (var output = new ObjectOutputStream(bytes)) {
+ output.writeObject(new LogEntry(new Date(1234), "plain"));
+ }
+ var serialized = bytes.toString(StandardCharsets.ISO_8859_1);
+ assertFalse(serialized.contains(Message.class.getName()));
+ assertFalse(serialized.contains(Style.class.getName()));
+ assertFalse(serialized.contains(ArrayList.class.getName()));
+ }
+
+ @Test
+ public void uiJsonIncludesEntryTextAndStyle() throws Exception {
+ var mapper = new ObjectMapperProvider(Set.of(), Set.of(), null, Set.of()).get();
+ var entry = new LogEntry(new Date(1234), List.of(
+ new Message(new Style("31", Style.BACKGROUND_COLOR_DEFAULT, true), "red"),
+ new Message(new StyleBuilder().build(), " plain")));
+ var json = mapper.readTree(mapper.writeValueAsBytes(entry));
+ assertTrue(json.hasNonNull("date"));
+ assertEquals(2, json.path("messages").size());
+ assertEquals("red", json.at("/messages/0/text").asText());
+ assertEquals("31", json.at("/messages/0/style/color").asText());
+ assertEquals(Style.BACKGROUND_COLOR_DEFAULT, json.at("/messages/0/style/backgroundColor").asText());
+ assertTrue(json.at("/messages/0/style/bold").asBoolean());
+ assertEquals(" plain", json.at("/messages/1/text").asText());
+ assertEquals(Style.FOREGROUND_COLOR_DEFAULT, json.at("/messages/1/style/color").asText());
+ assertFalse(json.at("/messages/1/style/bold").asBoolean());
+ }
+
+}
diff --git a/server-core/src/test/java/io/onedev/server/logging/build/BuildLogPersistenceTest.java b/server-core/src/test/java/io/onedev/server/logging/build/BuildLogPersistenceTest.java
new file mode 100644
index 0000000000..65a6da89c2
--- /dev/null
+++ b/server-core/src/test/java/io/onedev/server/logging/build/BuildLogPersistenceTest.java
@@ -0,0 +1,157 @@
+package io.onedev.server.logging.build;
+
+import static org.junit.jupiter.api.Assertions.*;
+import static org.mockito.ArgumentMatchers.any;
+import static org.mockito.Mockito.*;
+
+import java.util.Collections;
+import java.util.Date;
+import java.util.IdentityHashMap;
+import java.util.List;
+import java.util.UUID;
+import java.util.concurrent.atomic.AtomicLong;
+
+import org.hibernate.boot.MetadataSources;
+import org.hibernate.boot.registry.StandardServiceRegistryBuilder;
+import org.hibernate.id.IdentifierGenerator;
+import org.hibernate.mapping.SimpleValue;
+import org.junit.jupiter.api.Test;
+
+import io.onedev.agent.job.JobUtils;
+import io.onedev.commons.utils.ClassUtils;
+import io.onedev.commons.utils.TaskLogger;
+import io.onedev.k8shelper.JobHelper;
+import io.onedev.k8shelper.JobHelper.StepEventKind;
+import io.onedev.server.OneDev;
+import io.onedev.server.cluster.ClusterService;
+import io.onedev.server.event.ListenerRegistry;
+import io.onedev.server.job.JobService;
+import io.onedev.server.model.AbstractEntity;
+import io.onedev.server.model.Build;
+import io.onedev.server.model.Project;
+import io.onedev.server.model.ProjectLastActivityDate;
+import io.onedev.server.model.User;
+import io.onedev.server.model.support.build.StepExecution.Status;
+import io.onedev.server.persistence.DefaultSessionService;
+import io.onedev.server.persistence.DefaultTransactionService;
+import io.onedev.server.persistence.IdService;
+import io.onedev.server.persistence.PrefixedNamingStrategy;
+import io.onedev.server.persistence.SessionFactoryService;
+import io.onedev.server.persistence.TransactionService;
+import io.onedev.server.service.BuildService;
+
+class BuildLogPersistenceTest {
+ @Test
+ void stageChangesPersistAcrossIndependentSessionsAndAnEnclosingTransaction() throws Exception {
+ var registry = new StandardServiceRegistryBuilder()
+ .applySetting("hibernate.connection.provider_class", "org.hibernate.hikaricp.internal.HikariCPConnectionProvider")
+ .applySetting("hibernate.connection.url", "jdbc:hsqldb:mem:logging_" + UUID.randomUUID())
+ .applySetting("hibernate.connection.username", "sa")
+ .applySetting("hibernate.hikari.maximumPoolSize", 1)
+ .applySetting("hibernate.cache.use_second_level_cache", false)
+ .applySetting("hibernate.hbm2ddl.auto", "create-drop")
+ .applySetting("jakarta.persistence.validation.mode", "none").build();
+ try {
+ var sources = new MetadataSources(registry);
+ ClassUtils.findImplementations(AbstractEntity.class, AbstractEntity.class).forEach(sources::addAnnotatedClass);
+ var metadata = sources.getMetadataBuilder().applyPhysicalNamingStrategy(new PrefixedNamingStrategy("o_")).build();
+ // Isolate id allocation from the running application's IdService.
+ var ids = new AtomicLong();
+ for (var entity : metadata.getEntityBindings()) {
+ ((SimpleValue) entity.getIdentifier()).setCustomIdGeneratorCreator(context ->
+ (IdentifierGenerator) (session, object) -> ids.incrementAndGet());
+ }
+ try (var factory = metadata.buildSessionFactory(); var services = mockStatic(OneDev.class)) {
+ var build = new Build();
+ try (var session = factory.openSession()) {
+ var tx = session.beginTransaction();
+ var user = new User();
+ user.setName("builder");
+ session.persist(user);
+ var activity = new ProjectLastActivityDate();
+ session.persist(activity);
+ var project = new Project();
+ project.setName("test");
+ project.setPath("test");
+ project.setLastActivityDate(activity);
+ session.persist(project);
+ build.setProject(project);
+ build.setNumberScope(project);
+ build.setSubmitter(user);
+ build.setJobName("test");
+ build.setToken("attempt");
+ build.setRefName("refs/heads/main");
+ build.setCommitHash("0".repeat(40));
+ build.setStatus(Build.Status.RUNNING);
+ build.setSubmitDate(new Date());
+ build.setSubmitReason("test");
+ session.persist(build);
+ tx.commit();
+ }
+ var factories = mock(SessionFactoryService.class);
+ when(factories.getSessionFactory()).thenReturn(factory);
+ var sessions = new DefaultSessionService();
+ var transactions = new DefaultTransactionService();
+ inject(sessions, "sessionFactoryService", factories);
+ inject(sessions, "transactionService", transactions);
+ inject(transactions, "sessionService", sessions);
+ inject(transactions, "idService", mock(IdService.class));
+ var builds = mock(BuildService.class);
+ var seenSessions = Collections.newSetFromMap(new IdentityHashMap<org.hibernate.Session, Boolean>());
+ when(builds.get(build.getId())).thenAnswer(it -> {
+ var session = sessions.getSession();
+ seenSessions.add(session);
+ var loaded = session.find(Build.class, build.getId());
+ // No Git server is needed to resolve the fallback step title.
+ inject(loaded, "spec", java.util.Optional.empty());
+ return loaded;
+ });
+ var cluster = mock(ClusterService.class);
+ when(cluster.getCredential()).thenReturn("cluster-secret");
+ services.when(() -> OneDev.getInstance(ClusterService.class)).thenReturn(cluster);
+ services.when(() -> OneDev.getInstance(TransactionService.class)).thenReturn(transactions);
+ services.when(() -> OneDev.getInstance(BuildService.class)).thenReturn(builds);
+ services.when(() -> OneDev.getInstance(JobService.class)).thenReturn(mock(JobService.class));
+ services.when(() -> OneDev.getInstance(ListenerRegistry.class)).thenReturn(mock(ListenerRegistry.class));
+ var logs = mock(BuildLogService.class);
+ when(logs.newLogger(any(), any())).thenReturn(mock(TaskLogger.class));
+ var router = new BuildLogRouter(build, logs);
+ router.log(JobUtils.buildPhaseMessage(JobHelper.INITIALIZATION));
+ router.log(JobHelper.buildStepStartMessage(List.of(0)));
+ router.log(JobHelper.buildStepEndMessage(List.of(0), StepEventKind.FAILED));
+ router.log(JobHelper.buildStepStartMessage(List.of(1)));
+ router.log(JobHelper.buildStepSkipMessage(List.of(1)));
+ router.log(JobHelper.buildStepStartMessage(List.of(2)));
+ router.log(JobUtils.buildPhaseMessage(JobHelper.FINALIZATION));
+ router.log(JobUtils.buildPhaseMessage(JobHelper.FINALIZATION));
+ assertTrue(seenSessions.size() >= 8);
+ transactions.run(() -> {
+ var loaded = builds.get(build.getId());
+ assertNotSame(build, loaded);
+ assertEquals(Status.FAILED, loaded.getStepExecutions().get("step-0").getStatus());
+ assertTrue(loaded.getStepExecutions().get("step-1").isSkipped());
+ assertEquals(Status.SUCCESSFUL, loaded.getStepExecutions().get("step-2").getStatus());
+ assertTrue(loaded.isFinalization());
+ // The caller already owns the sole connection. Reuse its session when logging.
+ router.reset(() -> {});
+ router.log(JobUtils.buildPhaseMessage(JobHelper.INITIALIZATION));
+ assertTrue(loaded.getStepExecutions().isEmpty());
+ assertFalse(loaded.isFinalization());
+ });
+ try (var session = factory.openSession()) {
+ var loaded = session.find(Build.class, build.getId());
+ assertTrue(loaded.getStepExecutions().isEmpty());
+ assertFalse(loaded.isFinalization());
+ }
+ }
+ } finally {
+ StandardServiceRegistryBuilder.destroy(registry);
+ }
+ }
+
+ private static void inject(Object target, String name, Object value) throws Exception {
+ var field = target.getClass().getDeclaredField(name);
+ field.setAccessible(true);
+ field.set(target, value);
+ }
+}
diff --git a/server-core/src/test/java/io/onedev/server/logging/build/BuildLogRouterTest.java b/server-core/src/test/java/io/onedev/server/logging/build/BuildLogRouterTest.java
new file mode 100644
index 0000000000..7ab407a34d
--- /dev/null
+++ b/server-core/src/test/java/io/onedev/server/logging/build/BuildLogRouterTest.java
@@ -0,0 +1,430 @@
+package io.onedev.server.logging.build;
+
+import static io.onedev.k8shelper.JobHelper.FINALIZATION;
+import static io.onedev.k8shelper.JobHelper.INITIALIZATION;
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertFalse;
+import static org.junit.jupiter.api.Assertions.assertThrows;
+import static org.junit.jupiter.api.Assertions.assertTrue;
+import static org.mockito.ArgumentMatchers.any;
+import static org.mockito.Mockito.CALLS_REAL_METHODS;
+import static org.mockito.Mockito.doAnswer;
+import static org.mockito.Mockito.doReturn;
+import static org.mockito.Mockito.mock;
+import static org.mockito.Mockito.mockStatic;
+import static org.mockito.Mockito.spy;
+import static org.mockito.Mockito.times;
+import static org.mockito.Mockito.verify;
+import static org.mockito.Mockito.when;
+
+import java.util.ArrayList;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+
+import org.junit.jupiter.api.Test;
+import org.mockito.MockedStatic;
+
+import io.onedev.commons.utils.TaskLogger;
+import io.onedev.k8shelper.Action;
+import io.onedev.k8shelper.CompositeFacade;
+import io.onedev.k8shelper.ExecuteCondition;
+import io.onedev.agent.job.JobUtils;
+import io.onedev.k8shelper.JobHelper;
+import io.onedev.k8shelper.LeafFacade;
+import io.onedev.server.OneDev;
+import io.onedev.server.event.ListenerRegistry;
+import io.onedev.server.job.JobContext;
+import io.onedev.server.job.JobService;
+import io.onedev.server.model.Build;
+import io.onedev.server.model.Project;
+import io.onedev.server.model.support.build.StepExecution.Status;
+import io.onedev.server.persistence.TransactionService;
+import io.onedev.server.service.BuildService;
+
+class BuildLogRouterTest {
+ @Test
+ void routesStagesAndPreservesFailedStepsThroughCleanupAndRetry() throws Exception {
+ var build = spy(new Build());
+ build.setId(1L);
+ build.setProject(new Project());
+ build.getProject().setId(2L);
+ build.setNumber(3L);
+ build.setStatus(Build.Status.RUNNING);
+ doReturn(List.of("secret")).when(build).getMaskSecrets();
+ doReturn(null).when(build).getJob();
+ doReturn("test -> 测试").when(build).getLogStageName("step-0-1");
+ var builds = mock(BuildService.class);
+ when(builds.get(1L)).thenReturn(build);
+ var transactions = mock(TransactionService.class);
+ doAnswer(it -> { it.getArgument(0, Runnable.class).run(); return null; }).when(transactions).run(any());
+ var logs = mock(BuildLogService.class);
+ Map<String, List<String>> entries = new HashMap<>();
+ when(logs.newLogger(any(), any())).thenAnswer(it -> {
+ var support = it.getArgument(0, BuildLoggingSupport.class);
+ return new TaskLogger() {
+ public void log(String message, String sessionId) {
+ entries.computeIfAbsent(support.getStage(), key -> new ArrayList<>()).add(message);
+ }
+ };
+ });
+ try (MockedStatic<OneDev> oneDev = mockStatic(OneDev.class)) {
+ oneDev.when(() -> OneDev.getInstance(BuildService.class)).thenReturn(builds);
+ oneDev.when(() -> OneDev.getInstance(TransactionService.class)).thenReturn(transactions);
+ oneDev.when(() -> OneDev.getInstance(ListenerRegistry.class)).thenReturn(mock(ListenerRegistry.class));
+ oneDev.when(() -> OneDev.getInstance(JobService.class)).thenReturn(mock(JobService.class));
+ var logger = new BuildLogRouter(build, logs);
+ logger.log(JobUtils.buildPhaseMessage(INITIALIZATION));
+ try {
+ logger.log("initialization");
+ logger.log(JobHelper.buildStepStartMessage(List.of(0, 1)));
+ logger.log("step");
+ logger.log(JobHelper.buildStepEndMessage(List.of(0, 1), JobHelper.StepEventKind.FAILED));
+ logger.log(JobUtils.buildPhaseMessage(FINALIZATION));
+ logger.log("finalization");
+ } finally {
+ logger.log(JobUtils.buildPhaseMessage(FINALIZATION));
+ }
+ assertEquals(List.of(INITIALIZATION, "step-0-1", FINALIZATION), build.getLogStages());
+ assertEquals(Status.FAILED, build.getStepExecutions().get("step-0-1").getStatus());
+ assertEquals(List.of(TaskLogger.wrapWithAnsiNotice("Running step \"test -> 测试\"..."), "step",
+ TaskLogger.wrapWithAnsiError("Step \"test -> 测试\" is failed")), entries.get("step-0-1"));
+ assertEquals("finalization", entries.get(FINALIZATION).get(1));
+ new BuildLogRouter(build, logs).log("Job finished");
+ assertEquals(List.of("finalization", "Job finished"), entries.get(FINALIZATION).subList(1, 3));
+
+ logger.log(JobUtils.buildPhaseMessage(INITIALIZATION));
+ assertFalse(build.isFinalization());
+ assertTrue(build.getStepExecutions().isEmpty());
+ assertEquals(INITIALIZATION, build.getCurrentLogStage());
+ assertEquals(List.of(INITIALIZATION), build.getLogStages());
+ new BuildLogRouter(build, logs).log("Retry setup before executor startup");
+ assertEquals("Retry setup before executor startup",
+ entries.get(INITIALIZATION).get(entries.get(INITIALIZATION).size() - 1));
+ try {
+ logger.log(JobHelper.buildStepStartMessage(List.of(0, 1)));
+ logger.log(JobHelper.buildStepEndMessage(List.of(0, 1), JobHelper.StepEventKind.FAILED));
+ assertEquals("step-0-1", build.getCurrentLogStage());
+ new BuildLogRouter(build, logs).log("Between steps");
+ assertEquals("Between steps", entries.get("step-0-1").get(entries.get("step-0-1").size() - 1));
+ logger.log(JobHelper.buildStepSkipMessage(List.of(1)));
+ assertEquals("step-1", build.getCurrentLogStage());
+ logger.log(JobHelper.buildStepStartMessage(List.of(2)));
+ // A late outcome from an earlier attempt cannot fail the current step.
+ logger.log(JobHelper.buildStepEndMessage(List.of(0, 1), JobHelper.StepEventKind.FAILED));
+ assertEquals(Status.RUNNING, build.getStepExecutions().get("step-2").getStatus());
+ logger.log(JobHelper.buildStepEndMessage(List.of(2), JobHelper.StepEventKind.SUCCESSFUL));
+ } finally {
+ logger.log(JobUtils.buildPhaseMessage(FINALIZATION));
+ }
+ assertEquals(List.of(INITIALIZATION, "step-0-1", "step-1", "step-2", FINALIZATION), build.getLogStages());
+ assertTrue(build.getStepExecutions().get("step-1").isSkipped());
+
+ logger.log(JobUtils.buildPhaseMessage(INITIALIZATION));
+ assertThrows(java.util.concurrent.CancellationException.class, () -> {
+ try {
+ try {
+ logger.log(JobHelper.buildStepStartMessage(List.of(0)));
+ throw new java.util.concurrent.CancellationException();
+ } catch (Throwable t) {
+ logger.log(JobHelper.buildStepEndMessage(List.of(0), JobUtils.getStepOutcome(t)));
+ throw t;
+ } finally {
+ logger.log(JobUtils.buildPhaseMessage(FINALIZATION));
+ logger.log("Cancellation cleanup");
+ }
+ } finally {
+ logger.log(JobUtils.buildPhaseMessage(FINALIZATION));
+ }
+ });
+ assertEquals(Status.CANCELLED, build.getStepExecutions().get("step-0").getStatus());
+ assertTrue(build.isFinalization());
+ assertEquals(FINALIZATION, build.getCurrentLogStage());
+
+ logger.log(JobUtils.buildPhaseMessage(INITIALIZATION));
+ var stepCount = build.getStepExecutions().size();
+ assertThrows(IllegalStateException.class, () -> {
+ try {
+ throw new IllegalStateException("Startup failed");
+ } finally {
+ logger.log(JobUtils.buildPhaseMessage(FINALIZATION));
+ }
+ });
+ assertTrue(build.isFinalization());
+ assertEquals(FINALIZATION, build.getCurrentLogStage());
+ assertEquals(stepCount, build.getStepExecutions().size());
+
+ logger.log(JobUtils.buildPhaseMessage(INITIALIZATION));
+ assertThrows(IllegalStateException.class, () -> {
+ try {
+ logger.log(JobHelper.buildStepStartMessage(List.of(3)));
+ logger.log(JobHelper.buildStepEndMessage(List.of(3), JobHelper.StepEventKind.SUCCESSFUL));
+ logger.log(JobUtils.buildPhaseMessage(FINALIZATION));
+ throw new IllegalStateException("Cleanup failed");
+ } finally {
+ logger.log(JobUtils.buildPhaseMessage(FINALIZATION));
+ }
+ });
+ assertEquals(Status.SUCCESSFUL, build.getStepExecutions().get("step-3").getStatus());
+ assertFalse(build.getStepExecutions().containsKey(INITIALIZATION));
+ assertFalse(build.getStepExecutions().containsKey(FINALIZATION));
+ assertTrue(entries.values().stream().flatMap(List::stream)
+ .noneMatch(it -> it.contains(JobHelper.STEP_EVENT_PREFIX) || it.contains(JobHelper.PHASE_PREFIX)));
+ }
+ }
+
+ @Test
+ void recordsExpandedStepTotalBeforeTemplateInstancesStart() {
+ var build = spy(new Build());
+ build.setId(1L);
+ build.setProject(new Project());
+ build.getProject().setId(2L);
+ build.setNumber(3L);
+ build.setStatus(Build.Status.RUNNING);
+ doReturn(List.of()).when(build).getMaskSecrets();
+ doReturn(null).when(build).getJob();
+ var builds = mock(BuildService.class);
+ when(builds.get(1L)).thenReturn(build);
+ var transactions = mock(TransactionService.class);
+ doAnswer(it -> { it.getArgument(0, Runnable.class).run(); return null; }).when(transactions).run(any());
+ var logs = mock(BuildLogService.class);
+ when(logs.newLogger(any(), any())).thenReturn(mock(TaskLogger.class));
+ var jobs = mock(JobService.class);
+ var context = mock(JobContext.class);
+ var leaf = mock(LeafFacade.class, CALLS_REAL_METHODS);
+ var command = new Action("build", leaf, ExecuteCondition.ALWAYS, false);
+ when(context.getActions()).thenReturn(List.of(command, new Action("template",
+ new CompositeFacade(List.of(command, new Action("nested template",
+ new CompositeFacade(List.of(command)), ExecuteCondition.ALWAYS, false))),
+ ExecuteCondition.ALWAYS, false)));
+ when(jobs.getJobContext(build.getToken(), false)).thenReturn(context);
+ try (MockedStatic<OneDev> oneDev = mockStatic(OneDev.class)) {
+ oneDev.when(() -> OneDev.getInstance(BuildService.class)).thenReturn(builds);
+ oneDev.when(() -> OneDev.getInstance(TransactionService.class)).thenReturn(transactions);
+ oneDev.when(() -> OneDev.getInstance(ListenerRegistry.class)).thenReturn(mock(ListenerRegistry.class));
+ oneDev.when(() -> OneDev.getInstance(JobService.class)).thenReturn(jobs);
+ var logger = new BuildLogRouter(build, logs);
+ logger.log(JobHelper.buildStepStartMessage(List.of(0)));
+ assertEquals(1, build.getStepExecutions().get("step-0").getStepIndex());
+ assertEquals(3, build.getStepExecutions().get("step-0").getStepCount());
+ assertEquals(1, build.getStepExecutions().size()); // Only step instances have metadata.
+ logger.log(JobHelper.buildStepEndMessage(List.of(0), JobHelper.StepEventKind.SUCCESSFUL));
+ logger.log(JobHelper.buildStepStartMessage(List.of(1, 0)));
+ assertEquals(2, build.getStepExecutions().get("step-1-0").getStepIndex());
+ assertEquals(3, build.getStepExecutions().get("step-1-0").getStepCount());
+ logger.log(JobHelper.buildStepEndMessage(List.of(1, 0), JobHelper.StepEventKind.FAILED));
+ logger.log(JobHelper.buildStepSkipMessage(List.of(1, 1, 0)));
+ var skippedExecution = build.getStepExecutions().get("step-1-1-0");
+ assertEquals(3, skippedExecution.getStepIndex());
+ assertEquals(3, skippedExecution.getStepCount());
+ assertTrue(skippedExecution.isSkipped());
+ verify(jobs, times(1)).getJobContext(build.getToken(), false);
+
+ var restoredExecution = org.apache.commons.lang3.SerializationUtils.clone(skippedExecution);
+ assertEquals(3, restoredExecution.getStepIndex());
+ assertEquals(3, restoredExecution.getStepCount());
+ }
+ }
+
+ @Test
+ void databaseWaitDoesNotBlockOutputOrHoldTheLogLock() throws Exception {
+ checkDatabaseWait("transition");
+ }
+
+ @Test
+ void exhaustedConnectionPoolDoesNotBlockOutputFromTheConnectionOwner() throws Exception {
+ checkDatabaseWait("pool");
+ }
+
+ @Test
+ void retryRejectsATransitionPreparedBeforeReset() throws Exception {
+ checkDatabaseWait("retry");
+ }
+
+ @Test
+ void finishRejectsATransitionWaitingForTheDatabase() throws Exception {
+ checkDatabaseWait("finish");
+ }
+
+ private void checkDatabaseWait(String operation) throws Exception {
+ var config = new com.zaxxer.hikari.HikariConfig();
+ config.setJdbcUrl("jdbc:hsqldb:mem:logging_" + java.util.UUID.randomUUID());
+ config.setUsername("sa");
+ config.setMaximumPoolSize(1);
+ config.setConnectionTimeout(10000);
+ try (var pool = operation.equals("pool") ? new com.zaxxer.hikari.HikariDataSource(config) : null) {
+ var build = spy(new Build());
+ build.setId(1L);
+ build.setProject(new Project());
+ build.getProject().setId(2L);
+ build.setNumber(3L);
+ build.setStatus(Build.Status.RUNNING);
+ var lock = (java.util.concurrent.locks.ReentrantReadWriteLock)
+ io.onedev.commons.utils.LockUtils.getReadWriteLock(Build.getLogLockName(2L, 3L));
+ var logs = mock(BuildLogService.class);
+ var logger = new BuildLogRouter(build, logs);
+ Runnable assertOutsideLock = () -> {
+ assertFalse(lock.isWriteLockedByCurrentThread());
+ assertEquals(0, lock.getReadHoldCount());
+ assertFalse(Thread.holdsLock(logger));
+ };
+ doAnswer(it -> { assertOutsideLock.run(); return List.of(); }).when(build).getMaskSecrets();
+ doAnswer(it -> { assertOutsideLock.run(); return it.getArgument(0); }).when(build).getLogStageName(any());
+ var databaseEntered = new java.util.concurrent.CountDownLatch(1);
+ var databaseReleased = new java.util.concurrent.CountDownLatch(1);
+ var slow = new java.util.concurrent.atomic.AtomicBoolean();
+ var builds = mock(BuildService.class);
+ when(builds.get(1L)).thenAnswer(it -> {
+ assertOutsideLock.run();
+ if (slow.getAndSet(false)) {
+ databaseEntered.countDown();
+ if (pool != null) {
+ try (var connection = pool.getConnection()) {
+ assertTrue(connection.isValid(1));
+ }
+ } else {
+ assertTrue(databaseReleased.await(5, java.util.concurrent.TimeUnit.SECONDS));
+ }
+ }
+ return build;
+ });
+ var transactions = mock(TransactionService.class);
+ doAnswer(it -> {
+ assertOutsideLock.run();
+ it.getArgument(0, Runnable.class).run();
+ assertOutsideLock.run();
+ return null;
+ }).when(transactions).run(any());
+ Map<String, List<String>> entries = new HashMap<>();
+ when(logs.newLogger(any(), any())).thenAnswer(it -> {
+ var support = it.getArgument(0, BuildLoggingSupport.class);
+ return new TaskLogger() {
+ public void log(String message, String sessionId) {
+ if (message.equals(TaskLogger.wrapWithAnsiNotice("Running step \"step-0\"...")))
+ assertTrue(Thread.holdsLock(logger));
+ else
+ assertOutsideLock.run();
+ entries.computeIfAbsent(support.getStage(), key -> new ArrayList<>()).add(message);
+ }
+ };
+ });
+ doAnswer(it -> {
+ assertFalse(lock.isWriteLockedByCurrentThread());
+ assertEquals(0, lock.getReadHoldCount());
+ return null;
+ }).when(logs).flush(any());
+ var listeners = mock(ListenerRegistry.class);
+ doAnswer(it -> { assertOutsideLock.run(); return null; }).when(listeners).post(any());
+ var jobs = mock(JobService.class);
+ when(jobs.getJobContext(any(), org.mockito.ArgumentMatchers.eq(false))).thenAnswer(it -> {
+ assertOutsideLock.run();
+ return null;
+ });
+ java.util.function.Consumer<Runnable> withServices = action -> {
+ try (var oneDev = mockStatic(OneDev.class)) {
+ oneDev.when(() -> OneDev.getInstance(BuildService.class)).thenReturn(builds);
+ oneDev.when(() -> OneDev.getInstance(TransactionService.class)).thenReturn(transactions);
+ oneDev.when(() -> OneDev.getInstance(ListenerRegistry.class)).thenReturn(listeners);
+ oneDev.when(() -> OneDev.getInstance(JobService.class)).thenReturn(jobs);
+ action.run();
+ }
+ };
+ withServices.accept(() -> logger.log("initial"));
+ var heldConnection = new java.util.concurrent.atomic.AtomicReference<java.sql.Connection>(
+ pool != null ? pool.getConnection() : null);
+ var workers = java.util.concurrent.Executors.newFixedThreadPool(2);
+ try {
+ slow.set(true);
+ var transition = workers.submit(() -> withServices.accept(() ->
+ logger.log(JobHelper.buildStepStartMessage(List.of(0)))));
+ assertTrue(databaseEntered.await(5, java.util.concurrent.TimeUnit.SECONDS));
+ workers.submit(() -> logger.log("while database is blocked")).get(5, java.util.concurrent.TimeUnit.SECONDS);
+ if (operation.equals("retry"))
+ logger.reset(() -> {});
+ else if (operation.equals("finish"))
+ logger.finish();
+ var connection = heldConnection.getAndSet(null);
+ if (connection != null)
+ connection.close();
+ databaseReleased.countDown();
+ transition.get(5, java.util.concurrent.TimeUnit.SECONDS);
+ assertEquals(List.of("initial", "while database is blocked"), entries.get(INITIALIZATION));
+ if (operation.equals("retry") || operation.equals("finish")) {
+ assertTrue(build.getStepExecutions().isEmpty());
+ assertFalse(entries.containsKey("step-0"));
+ } else {
+ logger.log("step output");
+ assertEquals(List.of(TaskLogger.wrapWithAnsiNotice("Running step \"step-0\"..."), "step output"),
+ entries.get("step-0"));
+ }
+ } finally {
+ var connection = heldConnection.getAndSet(null);
+ if (connection != null)
+ connection.close();
+ databaseReleased.countDown();
+ workers.shutdownNow();
+ assertTrue(workers.awaitTermination(5, java.util.concurrent.TimeUnit.SECONDS));
+ }
+ }
+ }
+
+ @Test
+ void filenamesUseStepPositionsAndRejectPaths() {
+ assertEquals("initialization.log", BuildLoggingIdentity.getFileName(INITIALIZATION));
+ assertEquals("finalization.log", BuildLoggingIdentity.getFileName(FINALIZATION));
+ assertEquals("step-0.log", BuildLoggingIdentity.getFileName("step-0"));
+ assertEquals("step-1-0.log", BuildLoggingIdentity.getFileName("step-1-0"));
+ for (var stage : List.of("../build.log", "step-../0", "step--1", "step-00", "step-99999999999999"))
+ assertThrows(IllegalArgumentException.class, () -> BuildLoggingIdentity.getFileName(stage));
+ }
+
+ @Test
+ void displayNamesComeFromRecordedSpecIncludingNestedTemplateRepeats() {
+ var build = spy(new Build());
+ var job = new io.onedev.server.buildspec.job.Job();
+ var use = new io.onedev.server.buildspec.step.UseTemplateStep();
+ use.setName("template");
+ use.setTemplateName("shared");
+ job.setSteps(List.of(use));
+ var template = new io.onedev.server.buildspec.step.StepTemplate();
+ template.setName("shared");
+ var first = new io.onedev.server.buildspec.step.CommandStep();
+ first.setName("测试".repeat(100));
+ var second = new io.onedev.server.buildspec.step.CommandStep();
+ second.setName("secret step");
+ template.setSteps(List.of(first, second));
+ var spec = new io.onedev.server.buildspec.BuildSpec();
+ spec.setStepTemplates(List.of(template));
+ doReturn(job).when(build).getJob();
+ doReturn(spec).when(build).getSpec();
+ assertEquals("template", build.getLogStageName("step-0"));
+ assertEquals("template -> " + first.getName(), build.getLogStageName("step-0-0"));
+ assertEquals("template -> " + first.getName() + " (2)", build.getLogStageName("step-0-2"));
+ assertEquals("template -> secret step", build.getLogStageName("step-0-1"));
+ assertEquals("step-1", build.getLogStageName("step-1"));
+ assertEquals("Initialization", build.getLogStageName(INITIALIZATION));
+ assertEquals("Finalization", build.getLogStageName(FINALIZATION));
+ }
+
+ @Test
+ void sharedShellAndDockerStepRunnerReportsExceptionsAndCancellation() {
+ var events = new ArrayList<String>();
+ var logger = new TaskLogger() {
+ @Override
+ public void log(String message, String sessionId) {
+ if (JobHelper.parseStepEventMessage(message) != null)
+ events.add(message.substring(JobHelper.STEP_EVENT_PREFIX.length()));
+ }
+ };
+ assertFalse(JobUtils.runStep(List.of(0), logger, () -> {
+ throw new io.onedev.commons.utils.ExplicitException("failed command");
+ }));
+ assertEquals(List.of("START:step-0", "FAILED:step-0"), events);
+ events.clear();
+ assertThrows(RuntimeException.class, () -> JobUtils.runStep(List.of(0), logger, () -> {
+ throw new InterruptedException();
+ }));
+ assertEquals(List.of("START:step-0", "CANCELLED:step-0"), events);
+ }
+
+}
diff --git a/server-core/src/test/java/io/onedev/server/logging/build/BuildLogStreamTest.java b/server-core/src/test/java/io/onedev/server/logging/build/BuildLogStreamTest.java
new file mode 100644
index 0000000000..cfa85cf9e6
--- /dev/null
+++ b/server-core/src/test/java/io/onedev/server/logging/build/BuildLogStreamTest.java
@@ -0,0 +1,128 @@
+package io.onedev.server.logging.build;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertSame;
+import static org.junit.jupiter.api.Assertions.assertThrows;
+import static org.junit.jupiter.api.Assertions.assertTrue;
+import static org.mockito.Mockito.clearInvocations;
+import static org.mockito.Mockito.doReturn;
+import static org.mockito.Mockito.mock;
+import static org.mockito.Mockito.never;
+import static org.mockito.Mockito.verify;
+import static org.mockito.Mockito.when;
+
+import java.nio.file.Path;
+import java.util.List;
+
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.io.TempDir;
+
+import io.onedev.server.logging.DefaultLogService;
+import io.onedev.server.logging.LoggingIdentity;
+
+class BuildLogStreamTest {
+ @TempDir Path directory;
+
+ @Test
+ void deferredStageOpeningFailureReleasesAllLocks() throws Exception {
+ var first = fileIdentity("first");
+ var broken = fileIdentity("broken");
+ doReturn(first.getLockName()).when(broken).getLockName();
+ writeObjects(first, entry(1, "first"), entry(2, "second"));
+ java.nio.file.Files.write(broken.getFile().toPath(), new byte[] {0, 0, 0, 0});
+ try (var stream = new BuildLogStream(List.of(first, broken), newService())) {
+ assertTrue(stream.read(new byte[1024]) > 0);
+ assertUnlocked(first);
+ assertUnlocked(broken);
+ assertEquals(0, stream.read(new byte[0]));
+ var failure = assertThrows(java.io.StreamCorruptedException.class, stream::readAllBytes);
+ assertSame(failure, assertThrows(java.io.StreamCorruptedException.class, stream::read));
+ }
+ }
+
+ @Test
+ void readFailureClosesAllStagesImmediately() throws Exception {
+ var first = fileIdentity("first");
+ var other = fileIdentity("other");
+ doReturn(first.getLockName()).when(other).getLockName();
+ writeObjects(first, entry(1, "first"), "invalid log entry");
+ writeObjects(other, entry(3, "other"), entry(4, "last"));
+ try (var stream = new BuildLogStream(List.of(first, other), newService())) {
+ assertThrows(ClassCastException.class, stream::read);
+ assertUnlocked(first);
+ assertUnlocked(other);
+ }
+ }
+
+ @Test
+ void stagesShareOneReadLockUntilConsumedOrClosed() throws Exception {
+ var first = fileIdentity("first");
+ var last = fileIdentity("last");
+ doReturn(first.getLockName()).when(last).getLockName();
+ writeObjects(first, entry(1, "first"));
+ writeObjects(last, entry(2, "last"));
+ var lock = (java.util.concurrent.locks.ReentrantReadWriteLock)
+ io.onedev.commons.utils.LockUtils.getReadWriteLock(first.getLockName());
+ var service = newService();
+ try (var stream = new BuildLogStream(List.of(first, last), service)) {
+ assertEquals(2, lock.getReadHoldCount());
+ stream.read();
+ assertEquals(1, lock.getReadHoldCount(), "Keep the snapshot locked across stages");
+ stream.readAllBytes();
+ assertEquals(0, lock.getReadHoldCount());
+ assertEquals(-1, stream.read());
+ }
+ try (var stream = new BuildLogStream(List.of(first, last), service)) {
+ assertEquals(2, lock.getReadHoldCount());
+ }
+ assertEquals(0, lock.getReadHoldCount());
+ }
+
+ @Test
+ void rejectsDifferentLocksBeforeOpeningAnyLog() throws Exception {
+ var first = fileIdentity("first");
+ var other = fileIdentity("other");
+ var service = newService();
+ clearInvocations(first, other);
+ assertThrows(IllegalArgumentException.class, () -> new BuildLogStream(List.of(first, other), service));
+ verify(first, never()).getFile();
+ verify(other, never()).getFile();
+ assertUnlocked(first);
+ assertUnlocked(other);
+ }
+
+ private BuildLogService newService() throws Exception {
+ var service = new DefaultBuildLogService();
+ var field = DefaultBuildLogService.class.getDeclaredField("logService");
+ field.setAccessible(true);
+ field.set(service, new DefaultLogService());
+ return service;
+ }
+
+ private LoggingIdentity fileIdentity(String name) {
+ var identity = mock(LoggingIdentity.class);
+ var file = directory.resolve(name + ".log").toFile();
+ when(identity.getFile()).thenReturn(file);
+ when(identity.getLockName()).thenReturn(file.toString());
+ return identity;
+ }
+
+ private void writeObjects(LoggingIdentity identity, Object... entries) throws Exception {
+ try (var fileOutput = new java.io.FileOutputStream(identity.getFile());
+ var output = new java.io.ObjectOutputStream(fileOutput)) {
+ for (var entry : entries) output.writeObject(entry);
+ }
+ }
+
+ private void assertUnlocked(LoggingIdentity identity) {
+ var lock = io.onedev.commons.utils.LockUtils.getReadWriteLock(identity.getLockName()).writeLock();
+ assertTrue(lock.tryLock(), "Log reader retained its lock");
+ lock.unlock();
+ }
+
+ private io.onedev.server.logging.LogEntry entry(long time, String message) {
+ return new io.onedev.server.logging.LogEntry(
+ new java.util.Date(time), message);
+ }
+
+}
diff --git a/server-core/src/test/java/io/onedev/server/logging/build/DefaultBuildLogServiceTest.java b/server-core/src/test/java/io/onedev/server/logging/build/DefaultBuildLogServiceTest.java
new file mode 100644
index 0000000000..b59df387d1
--- /dev/null
+++ b/server-core/src/test/java/io/onedev/server/logging/build/DefaultBuildLogServiceTest.java
@@ -0,0 +1,633 @@
+package io.onedev.server.logging.build;
+
+import static io.onedev.k8shelper.JobHelper.FINALIZATION;
+import static io.onedev.k8shelper.JobHelper.INITIALIZATION;
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertFalse;
+import static org.junit.jupiter.api.Assertions.assertNotSame;
+import static org.junit.jupiter.api.Assertions.assertSame;
+import static org.junit.jupiter.api.Assertions.assertTrue;
+import static org.mockito.ArgumentMatchers.any;
+import static org.mockito.ArgumentMatchers.eq;
+import static org.mockito.Mockito.mock;
+import static org.mockito.Mockito.mockStatic;
+import static org.mockito.Mockito.verify;
+import static org.mockito.Mockito.when;
+
+import java.nio.file.Path;
+import java.util.List;
+import java.util.concurrent.Callable;
+import java.util.regex.Pattern;
+
+import org.junit.jupiter.api.AfterEach;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.io.TempDir;
+import org.mockito.MockedStatic;
+
+import io.onedev.agent.job.JobUtils;
+import io.onedev.k8shelper.JobHelper;
+import io.onedev.server.OneDev;
+import io.onedev.server.cluster.ClusterService;
+import io.onedev.server.cluster.ClusterTask;
+import io.onedev.server.logging.DefaultLogService;
+import io.onedev.server.logging.LogSnippet;
+import io.onedev.server.logging.LoggingIdentity;
+import io.onedev.server.logging.LoggingSupport;
+import io.onedev.server.model.Build;
+import io.onedev.server.model.Project;
+import io.onedev.server.persistence.SessionService;
+import io.onedev.server.persistence.TransactionService;
+import io.onedev.server.service.BuildService;
+import io.onedev.server.service.ProjectService;
+import io.onedev.server.web.websocket.WebSocketService;
+
+class DefaultBuildLogServiceTest {
+ @TempDir Path directory;
+
+ private Build storedBuild;
+
+ private MockedStatic<OneDev> oneDev;
+
+ @BeforeEach
+ void setUpBuildLookup() throws Exception {
+ storedBuild = mock(Build.class);
+ var project = new Project();
+ project.setId(1L);
+ when(storedBuild.getProject()).thenReturn(project);
+ when(storedBuild.getId()).thenReturn(3L);
+ when(storedBuild.getNumber()).thenReturn(2L);
+ var builds = mock(BuildService.class);
+ when(builds.load(any())).thenReturn(storedBuild);
+ when(builds.getBuildDir(1L, 2L)).thenReturn(directory.toFile());
+ var sessions = mock(SessionService.class);
+ when(sessions.call(any())).thenAnswer(it -> {
+ var lock = (java.util.concurrent.locks.ReentrantReadWriteLock)
+ io.onedev.commons.utils.LockUtils.getReadWriteLock(directory.toString());
+ assertEquals(0, lock.getReadHoldCount(), "Database access must precede the log lock");
+ assertFalse(lock.isWriteLockedByCurrentThread());
+ return it.getArgument(0, Callable.class).call();
+ });
+ var projects = mock(ProjectService.class);
+ when(projects.runOnActiveServer(eq(1L), any()))
+ .thenAnswer(it -> it.getArgument(1, ClusterTask.class).call());
+ oneDev = mockStatic(OneDev.class);
+ oneDev.when(() -> OneDev.getInstance(BuildService.class)).thenReturn(builds);
+ oneDev.when(() -> OneDev.getInstance(SessionService.class)).thenReturn(sessions);
+ oneDev.when(() -> OneDev.getInstance(ProjectService.class)).thenReturn(projects);
+ }
+
+ @AfterEach
+ void closeBuildLookup() {
+ oneDev.close();
+ }
+
+ @Test
+ void allWritersForAnAttemptShareTheStageRouter() throws Exception {
+ var logs = new DefaultLogService();
+ var service = newService(logs);
+ var build = mock(Build.class);
+ var project = storedBuild.getProject();
+ when(build.getProject()).thenReturn(project);
+ when(build.getToken()).thenReturn("attempt");
+ var logger = service.newLogger(build);
+ assertSame(logger, service.newLogger(build));
+ when(build.getToken()).thenReturn("resubmitted-attempt");
+ assertNotSame(logger, service.newLogger(build));
+ }
+
+ @Test
+ void wholeBuildMatchingIncludesPersistedStagesAndCurrentCachedOutput() throws Exception {
+ var logs = new DefaultLogService();
+ inject(logs, "webSocketService", mock(WebSocketService.class));
+ var cluster = mock(ClusterService.class);
+ when(cluster.submitToAllServers(any())).thenAnswer(it -> {
+ it.getArgument(0, ClusterTask.class).call();
+ return java.util.Map.of();
+ });
+ inject(logs, "clusterService", cluster);
+ var transactions = mock(TransactionService.class);
+ org.mockito.Mockito.doAnswer(it -> {
+ it.getArgument(0, Runnable.class).run();
+ return null;
+ }).when(transactions).runAfterCommit(any());
+ inject(logs, "transactionService", transactions);
+ var notifications = new java.util.ArrayList<LoggingSupport>();
+ logs.registerListener(notifications::add);
+ var service = newService(logs);
+ var build = mock(BuildLogContext.class);
+ var storage = mock(BuildLogStorage.class);
+ when(storage.getDirectory()).thenReturn(directory.resolve("log").toFile());
+ when(storage.getLockName()).thenReturn(directory.toString());
+ when(build.getStorage()).thenReturn(storage);
+ var stages = new java.util.ArrayList<BuildLoggingSupport>();
+ for (var name : List.of(INITIALIZATION, "step-0", FINALIZATION)) {
+ var stage = mock(BuildLoggingSupport.class);
+ when(stage.getStage()).thenReturn(name);
+ when(stage.runOnActiveServer(any())).thenAnswer(it -> it.getArgument(0, ClusterTask.class).call());
+ writeStageLog(stage, new LogSnippet(), directory.toString());
+ // Start without a persisted file so this stage buffers its output.
+ java.nio.file.Files.delete(stage.getIdentity().getFile().toPath());
+ logs.newLogger(stage).log(name);
+ assertSame(stage, notifications.get(notifications.size() - 1));
+ stages.add(stage);
+ if (!name.equals(FINALIZATION))
+ logs.flush(stage);
+ }
+ var stageNames = stages.stream().map(BuildLoggingSupport::getStage).toList();
+ when(storedBuild.getLogStages()).thenReturn(stageNames);
+ assertTrue(service.matches(build, Pattern.compile("step-0")));
+ assertFalse(service.matches(build, Pattern.compile("missing")));
+
+ var current = stages.get(stages.size() - 1);
+ logs.flush(current);
+ assertSame(current, notifications.get(notifications.size() - 1));
+ verify(current).fileModified();
+ var reopened = new DefaultLogService();
+ for (var stage : stages) {
+ assertEquals(List.of(stage.getStage()), reopened.readLogEntries(stage, 0, 0).stream()
+ .map(it -> it.getMessageText()).toList());
+ }
+ }
+
+ @Test
+ void combinedStreamHasOneTailAndFollowsNewStagesAndConcurrentEntries() throws Exception {
+ var logs = new DefaultLogService();
+ var service = newService(logs);
+ var build = mock(BuildLogContext.class);
+ var storage = mock(BuildLogStorage.class);
+ when(storage.getLockName()).thenReturn(directory.toString());
+ when(build.getStorage()).thenReturn(storage);
+ when(build.runOnActiveServer(any())).thenAnswer(it -> it.getArgument(0, ClusterTask.class).call());
+ var prepare = mock(BuildLoggingSupport.class);
+ var step = mock(BuildLoggingSupport.class);
+ var cleanup = mock(BuildLoggingSupport.class);
+ when(prepare.getStage()).thenReturn(INITIALIZATION);
+ when(step.getStage()).thenReturn("step-0");
+ when(cleanup.getStage()).thenReturn(FINALIZATION);
+ when(storedBuild.getLogStages()).thenReturn(List.of(INITIALIZATION, "step-0"));
+ var prepareTail = new LogSnippet();
+ prepareTail.offset = 100;
+ prepareTail.entries.addAll(List.of(entry(1, "initialization"), entry(4, "retry prepare")));
+ var stepTail = new LogSnippet();
+ stepTail.offset = 200;
+ stepTail.entries.addAll(List.of(entry(2, "Running step \"test\"..."),
+ entry(3, "Step \"test\" is failed"), entry(5, "Running step \"test\"...")));
+ writeStageLog(prepare, prepareTail, storage.getLockName());
+ writeStageLog(step, stepTail, storage.getLockName());
+ var initial = service.readSnapshot(build, null, 3);
+ assertEquals(List.of("Step \"test\" is failed", "retry prepare", "Running step \"test\"..."),
+ initial.entries.stream().map(it -> it.getMessageText()).toList());
+ assertEquals(java.util.Map.of(INITIALIZATION, 102, "step-0", 203), initial.offsets);
+
+ when(storedBuild.getLogStages()).thenReturn(List.of(INITIALIZATION, "step-0", FINALIZATION));
+ prepareTail.entries.add(entry(8, "another retry"));
+ stepTail.entries.add(entry(6, "Step \"test\" is successful"));
+ var cleanupTail = new LogSnippet();
+ cleanupTail.entries.add(entry(7, "finalization"));
+ writeStageLog(prepare, prepareTail, storage.getLockName());
+ writeStageLog(step, stepTail, storage.getLockName());
+ writeStageLog(cleanup, cleanupTail, storage.getLockName());
+ var next = service.readSnapshot(build, initial, 3);
+ assertEquals(List.of("Step \"test\" is successful", "finalization", "another retry"),
+ next.entries.stream().map(it -> it.getMessageText()).toList());
+ assertEquals(java.util.Map.of(INITIALIZATION, 103, "step-0", 204, FINALIZATION, 1), next.offsets);
+
+ try (var stream = service.openLogStream(List.of(prepare.getIdentity(), step.getIdentity(), cleanup.getIdentity()))) {
+ var combined = new String(stream.readAllBytes(), java.nio.charset.StandardCharsets.UTF_8);
+ assertEquals(308, combined.lines().count());
+ var concatenated = new StringBuilder();
+ for (var stage : List.of(prepare, step, cleanup)) {
+ try (var stageStream = logs.openLogStream(stage.getIdentity())) {
+ concatenated.append(new String(stageStream.readAllBytes(), java.nio.charset.StandardCharsets.UTF_8));
+ }
+ }
+ assertEquals(concatenated.toString(), combined);
+ }
+
+ }
+
+ @Test
+ void clearingBuildLogDiscardsCurrentCacheAndUnlistedFilesWithoutAffectingOtherBuilds() throws Exception {
+ var build = runningBuild();
+ var logs = configuredLogs();
+ var service = newService(logs);
+ var logger = service.newLogger(build);
+ logger.log("old initialization");
+ logger.log(JobHelper.buildStepStartMessage(List.of(0)));
+ logger.log("old cached entry");
+ var identity = new BuildLoggingIdentity(1L, 2L, "step-0");
+ assertFalse(identity.getFile().exists(), "Current stage is buffered only");
+ var logDir = directory.resolve("log");
+ java.nio.file.Files.writeString(logDir.resolve("step-9.log"), "an earlier step no longer in metadata");
+ java.nio.file.Files.writeString(logDir.resolve("obsolete"), "an old file");
+
+ var otherSupport = mock(BuildLoggingSupport.class);
+ var otherIdentity = mock(LoggingIdentity.class);
+ when(otherIdentity.getFile()).thenReturn(directory.resolve("log-other/step-0.log").toFile());
+ when(otherIdentity.getLockName()).thenReturn("other-build");
+ when(otherSupport.getIdentity()).thenReturn(otherIdentity);
+ logs.newLogger(otherSupport).log("other build entry");
+
+ // Cleanup runs remotely while the caller may own database locks: no database access there.
+ var builds = OneDev.getInstance(BuildService.class);
+ org.mockito.Mockito.clearInvocations(builds);
+ service.clear(build.getLogContext());
+ org.mockito.Mockito.verify(builds, org.mockito.Mockito.never()).load(any());
+ org.mockito.Mockito.verify(builds, org.mockito.Mockito.never()).get(any());
+ assertEquals(List.of("obsolete"), java.util.Arrays.asList(logDir.toFile().list()));
+ assertTrue(logs.readLogEntries(identity, 0, 0).isEmpty());
+ assertEquals("other build entry", logs.readLogEntries(otherIdentity, 0, 0).get(0).getMessageText());
+
+ logger.log(JobUtils.buildPhaseMessage(INITIALIZATION));
+ logger.log("new attempt");
+ var fresh = logs.readLogSnippetReversely(new BuildLoggingIdentity(1L, 2L, INITIALIZATION), 10);
+ assertEquals(0, fresh.offset);
+ assertEquals(List.of("Preparing job...", "new attempt"),
+ fresh.entries.stream().map(it -> it.getMessageText()).toList());
+ build.setFinishDate(new java.util.Date());
+ service.finish(build);
+ }
+
+ @Test
+ void streamResetsOffsetsWhenRetryLogIsAlreadyLongerThanPreviousAttempt() throws Exception {
+ var logs = new DefaultLogService();
+ var service = newService(logs);
+ var context = mock(BuildLogContext.class);
+ var storage = mock(BuildLogStorage.class);
+ when(storage.getLockName()).thenReturn(directory.toString());
+ when(context.getStorage()).thenReturn(storage);
+ when(context.runOnActiveServer(any())).thenAnswer(it -> it.getArgument(0, ClusterTask.class).call());
+ when(context.getLogVersion()).thenReturn("attempt-0");
+ var stage = mock(BuildLoggingSupport.class);
+ when(stage.getStage()).thenReturn(INITIALIZATION);
+ when(storedBuild.getLogStages()).thenReturn(List.of(INITIALIZATION));
+ var old = new LogSnippet();
+ old.entries.add(entry(1, "old attempt"));
+ writeStageLog(stage, old, directory.toString());
+ var previous = service.readSnapshot(context, null, 10);
+ var fresh = new LogSnippet();
+ fresh.entries.addAll(List.of(entry(2, "Retry count: 1"), entry(3, "new attempt")));
+ writeStageLog(stage, fresh, directory.toString());
+ when(context.getLogVersion()).thenReturn("attempt-1");
+ var snapshot = service.readSnapshot(context, previous, 10);
+ assertEquals(List.of("Retry count: 1", "new attempt"), snapshot.entries.stream().map(it -> it.getMessageText()).toList());
+ assertTrue(service.readSnapshot(context, snapshot, 10).entries.isEmpty());
+ }
+
+ @Test
+ void snapshotRetriesWhenAttemptChangesWhileReadingWithoutHoldingLockForMetadata() throws Exception {
+ var service = newService(new DefaultLogService());
+ var context = mock(BuildLogContext.class);
+ var storage = mock(BuildLogStorage.class);
+ when(storage.getLockName()).thenReturn(directory.toString());
+ when(context.getStorage()).thenReturn(storage);
+ when(context.runOnActiveServer(any())).thenAnswer(it -> it.getArgument(0, ClusterTask.class).call());
+ when(storedBuild.getLogStages()).thenReturn(List.of(INITIALIZATION));
+ var stage = mock(BuildLoggingSupport.class);
+ when(stage.getStage()).thenReturn(INITIALIZATION);
+ var old = new LogSnippet();
+ old.entries.add(entry(1, "old attempt"));
+ writeStageLog(stage, old, directory.toString());
+ var calls = new java.util.concurrent.atomic.AtomicInteger();
+ when(context.getLogVersion()).thenAnswer(it -> {
+ var lock = (java.util.concurrent.locks.ReentrantReadWriteLock)
+ io.onedev.commons.utils.LockUtils.getReadWriteLock(directory.toString());
+ assertEquals(0, lock.getReadHoldCount());
+ assertFalse(lock.isWriteLockedByCurrentThread());
+ int call = calls.incrementAndGet();
+ if (call == 1)
+ return "old";
+ if (call == 2) {
+ var fresh = new LogSnippet();
+ fresh.entries.add(entry(2, "new attempt"));
+ writeStageLog(stage, fresh, directory.toString());
+ }
+ return "new";
+ });
+ var snapshot = service.readSnapshot(context, null, 10);
+ assertEquals("new", snapshot.logVersion);
+ assertEquals(List.of("new attempt"), snapshot.entries.stream().map(it -> it.getMessageText()).toList());
+ assertEquals(4, calls.get());
+ }
+
+ @Test
+ void activeStagesKeepOutputAndFinishedBuildRejectsLateMessages() throws Exception {
+ var build = org.mockito.Mockito.spy(new Build());
+ build.setId(3L);
+ build.setProject(storedBuild.getProject());
+ build.setNumber(2L);
+ build.setToken("attempt");
+ build.setStatus(Build.Status.RUNNING);
+ org.mockito.Mockito.doReturn(List.of()).when(build).getMaskSecrets();
+ org.mockito.Mockito.doReturn(null).when(build).getJob();
+ org.mockito.Mockito.doReturn("test").when(build).getLogStageName("step-0");
+ when(OneDev.getInstance(BuildService.class).load(3L)).thenReturn(build);
+ when(OneDev.getInstance(BuildService.class).get(3L)).thenReturn(build);
+ var transactions = mock(TransactionService.class);
+ org.mockito.Mockito.doAnswer(it -> {
+ it.getArgument(0, Runnable.class).run();
+ return null;
+ }).when(transactions).run(any());
+ oneDev.when(() -> OneDev.getInstance(TransactionService.class)).thenReturn(transactions);
+ oneDev.when(() -> OneDev.getInstance(io.onedev.server.event.ListenerRegistry.class))
+ .thenReturn(mock(io.onedev.server.event.ListenerRegistry.class));
+ oneDev.when(() -> OneDev.getInstance(io.onedev.server.job.JobService.class))
+ .thenReturn(mock(io.onedev.server.job.JobService.class));
+ var logs = org.mockito.Mockito.spy(new DefaultLogService());
+ inject(logs, "webSocketService", mock(WebSocketService.class));
+ inject(logs, "clusterService", mock(ClusterService.class));
+ inject(logs, "transactionService", transactions);
+ var instructionSessions = mock(SessionService.class);
+ org.mockito.Mockito.doAnswer(it -> {
+ var lock = (java.util.concurrent.locks.ReentrantReadWriteLock)
+ io.onedev.commons.utils.LockUtils.getReadWriteLock(Build.getLogLockName(1L, 2L));
+ assertFalse(lock.isWriteLockedByCurrentThread());
+ assertEquals(0, lock.getReadHoldCount());
+ it.getArgument(0, Runnable.class).run();
+ return null;
+ }).when(instructionSessions).run(any());
+ inject(logs, "sessionService", instructionSessions);
+ var service = newService(logs);
+ var logger = service.newLogger(build);
+ logger.log("before initialization");
+ logger.log(JobUtils.buildPhaseMessage(INITIALIZATION));
+ logger.log("initialization output");
+ logger.log(JobHelper.buildStepStartMessage(List.of(0)));
+ logger.log("##onedev[SetBuildVersion '1.2.3']");
+ assertEquals("1.2.3", build.getVersion());
+ org.mockito.Mockito.verify(instructionSessions, org.mockito.Mockito.times(1)).run(any());
+ logger.log("step output");
+ logger.log(JobHelper.buildStepEndMessage(List.of(0), JobHelper.StepEventKind.SUCCESSFUL));
+ logger.log("between steps");
+ logger.log(JobUtils.buildPhaseMessage(FINALIZATION));
+ logger.log("cleanup output");
+ // Completion diagnostics are emitted after setting status but before setting finishDate.
+ build.setStatus(Build.Status.SUCCESSFUL);
+ logger.log("Job finished");
+ build.setFinishDate(new java.util.Date());
+ org.mockito.Mockito.doAnswer(it -> {
+ var lock = (java.util.concurrent.locks.ReentrantReadWriteLock)
+ io.onedev.commons.utils.LockUtils.getReadWriteLock(Build.getLogLockName(1L, 2L));
+ assertFalse(lock.isWriteLockedByCurrentThread());
+ assertEquals(0, lock.getReadHoldCount());
+ assertFalse(Thread.holdsLock(logger));
+ return it.callRealMethod();
+ }).when(logs).flush(any());
+ service.finish(build);
+ assertEquals(List.of("before initialization", "Preparing job...", "initialization output"),
+ logs.readLogEntries(new BuildLoggingIdentity(1L, 2L, INITIALIZATION), 0, 0).stream()
+ .map(it -> it.getMessageText()).toList());
+ assertEquals(List.of("Running step \"test\"...", "step output", "Step \"test\" is successful", "between steps"),
+ logs.readLogEntries(new BuildLoggingIdentity(1L, 2L, "step-0"), 0, 0).stream()
+ .map(it -> it.getMessageText()).toList());
+ assertEquals(List.of("Cleaning up job...", "cleanup output", "Job finished"),
+ logs.readLogEntries(new BuildLoggingIdentity(1L, 2L, FINALIZATION), 0, 0).stream()
+ .map(it -> it.getMessageText()).toList());
+ logger.log("late output");
+ logger.log(JobHelper.buildStepStartMessage(List.of(10)));
+ // A newly created router after cache eviction/restart must also reject all output.
+ var recreated = newService(logs).newLogger(build);
+ recreated.log(JobUtils.buildPhaseMessage(INITIALIZATION));
+ recreated.log("late recreated output");
+ assertFalse(new BuildLoggingIdentity(1L, 2L, "step-10").getFile().exists());
+ assertEquals(1, build.getStepExecutions().size());
+ assertEquals(3, logs.readLogEntries(new BuildLoggingIdentity(1L, 2L, FINALIZATION), 0, 0).size());
+ var snippets = DefaultLogService.class.getDeclaredField("recentSnippets");
+ snippets.setAccessible(true);
+ assertTrue(((java.util.Map<?, ?>) snippets.get(logs)).isEmpty());
+ }
+
+
+ @Test
+ void stageSwitchRejectsAnInFlightWriterBeforeItCanCreateTheOldSnippet() throws Exception {
+ checkInFlightWriter("switch");
+ }
+
+ @Test
+ void retryRejectsAnInFlightWriterEvenWhenTheSameStageIsReused() throws Exception {
+ checkInFlightWriter("retry");
+ }
+
+ @Test
+ void completionRejectsAnInFlightWriterWithoutTakingTheRouterMonitorUnderTheLogLock() throws Exception {
+ checkInFlightWriter("finish");
+ }
+
+ private void checkInFlightWriter(String operation) throws Exception {
+ var build = runningBuild();
+ var logs = configuredLogs();
+ var router = new java.util.concurrent.atomic.AtomicReference<io.onedev.commons.utils.TaskLogger>();
+ var lock = (java.util.concurrent.locks.ReentrantReadWriteLock)
+ io.onedev.commons.utils.LockUtils.getReadWriteLock(Build.getLogLockName(1L, 2L));
+ var sessions = mock(SessionService.class);
+ org.mockito.Mockito.doAnswer(it -> {
+ assertFalse(Thread.holdsLock(router.get()));
+ assertFalse(lock.isWriteLockedByCurrentThread());
+ assertEquals(0, lock.getReadHoldCount());
+ it.getArgument(0, Runnable.class).run();
+ return null;
+ }).when(sessions).run(any());
+ inject(logs, "sessionService", sessions);
+ var writerEntered = new java.util.concurrent.CountDownLatch(1);
+ var writerReleased = new java.util.concurrent.CountDownLatch(1);
+ var pause = new java.util.concurrent.atomic.AtomicBoolean();
+ var delegated = mock(io.onedev.server.logging.LogService.class, org.mockito.AdditionalAnswers.delegatesTo(logs));
+ org.mockito.Mockito.doAnswer(it -> {
+ var support = it.getArgument(0, io.onedev.server.logging.LoggingSupport.class);
+ var accepting = it.getArgument(1, java.util.function.BooleanSupplier.class);
+ return logs.newLogger(support, () -> {
+ boolean accepted = accepting.getAsBoolean();
+ if (pause.compareAndSet(true, false)) {
+ writerEntered.countDown();
+ try {
+ assertTrue(writerReleased.await(5, java.util.concurrent.TimeUnit.SECONDS));
+ } catch (InterruptedException e) {
+ throw new RuntimeException(e);
+ }
+ }
+ return accepted;
+ });
+ }).when(delegated).newLogger(any(), any());
+ var service = newService(delegated);
+ var logger = service.newLogger(build);
+ router.set(logger);
+ // An instruction initializes the stage without creating a snippet or persisted file.
+ logger.log("##onedev[PauseExecution]");
+ assertTrue(build.isPaused());
+ var oldIdentity = new BuildLoggingIdentity(1L, 2L, INITIALIZATION);
+ assertFalse(oldIdentity.getFile().exists());
+ var workers = java.util.concurrent.Executors.newSingleThreadExecutor();
+ try {
+ pause.set(true);
+ var writer = workers.submit(() -> logger.log("late old output"));
+ assertTrue(writerEntered.await(5, java.util.concurrent.TimeUnit.SECONDS));
+ switch (operation) {
+ case "switch" -> logger.log(JobHelper.buildStepStartMessage(List.of(0)));
+ case "retry" -> {
+ service.clear(build.getLogContext());
+ logger.log(JobUtils.buildPhaseMessage(INITIALIZATION));
+ }
+ case "finish" -> {
+ build.setFinishDate(new java.util.Date());
+ service.finish(build);
+ }
+ default -> throw new AssertionError(operation);
+ }
+ writerReleased.countDown();
+ writer.get(5, java.util.concurrent.TimeUnit.SECONDS);
+ var field = DefaultLogService.class.getDeclaredField("recentSnippets");
+ field.setAccessible(true);
+ var snippets = (java.util.Map<?, ?>) field.get(logs);
+ assertEquals(operation.equals("finish") ? 0 : 1, snippets.size());
+ assertTrue(logs.readLogEntries(oldIdentity, 0, 0).stream()
+ .noneMatch(entry -> entry.getMessageText().contains("late old output")));
+ if (!operation.equals("retry")) {
+ assertTrue(logs.readLogEntries(oldIdentity, 0, 0).isEmpty());
+ assertTrue(oldIdentity.getFile().length() > 0);
+ }
+ } finally {
+ writerReleased.countDown();
+ workers.shutdownNow();
+ assertTrue(workers.awaitTermination(5, java.util.concurrent.TimeUnit.SECONDS));
+ }
+ }
+
+ @Test
+ void snapshotAndClearRunOnAnotherThreadWithoutDatabaseAccessThere() throws Exception {
+ var build = runningBuild();
+ var logs = configuredLogs();
+ var service = newService(logs);
+ var logger = service.newLogger(build);
+ logger.log(JobHelper.buildStepStartMessage(List.of(0)));
+ logger.log("step output");
+ var builds = OneDev.getInstance(BuildService.class);
+ var projects = OneDev.getInstance(ProjectService.class);
+ var owner = Thread.currentThread();
+ org.mockito.Mockito.doAnswer(it -> {
+ assertSame(owner, Thread.currentThread(), "Cluster worker must not borrow a database connection");
+ return build;
+ }).when(builds).load(any());
+ org.mockito.Mockito.doAnswer(it -> {
+ assertSame(owner, Thread.currentThread());
+ return build;
+ }).when(builds).get(any());
+ var worker = java.util.concurrent.Executors.newSingleThreadExecutor();
+ try {
+ when(projects.runOnActiveServer(eq(1L), any())).thenAnswer(it -> {
+ var task = it.getArgument(1, ClusterTask.class);
+ return worker.submit(() -> {
+ try (var remoteServices = mockStatic(OneDev.class)) {
+ remoteServices.when(() -> OneDev.getInstance(BuildService.class)).thenReturn(builds);
+ remoteServices.when(() -> OneDev.getInstance(ProjectService.class)).thenReturn(projects);
+ return task.call();
+ }
+ }).get(5, java.util.concurrent.TimeUnit.SECONDS);
+ });
+ var snapshot = service.readSnapshot(build.getLogContext(), null, 100);
+ assertEquals("step output", snapshot.entries.get(snapshot.entries.size() - 1).getMessageText());
+ service.clear(build.getLogContext());
+ assertTrue(logs.readLogEntries(new BuildLoggingIdentity(1L, 2L, "step-0"), 0, 0).isEmpty());
+ } finally {
+ worker.shutdownNow();
+ assertTrue(worker.awaitTermination(5, java.util.concurrent.TimeUnit.SECONDS));
+ }
+ }
+
+ @Test
+ void routerOwnsFallbackOutcomesAndDeduplicatesFinalizationAndLateOutcomes() throws Exception {
+ var build = runningBuild();
+ var logs = configuredLogs();
+ var service = newService(logs);
+ var logger = service.newLogger(build);
+ logger.log(JobHelper.buildStepStartMessage(List.of(0)));
+ logger.log(JobHelper.buildStepStartMessage(List.of(1)));
+ assertEquals(io.onedev.server.model.support.build.StepExecution.Status.FAILED,
+ build.getStepExecutions().get("step-0").getStatus());
+ logger.log(JobHelper.buildStepSkipMessage(List.of(1)));
+ logger.log(JobHelper.buildStepEndMessage(List.of(1), JobHelper.StepEventKind.FAILED));
+ assertTrue(build.getStepExecutions().get("step-1").isSkipped());
+ logger.log(JobHelper.buildStepStartMessage(List.of(2)));
+ logger.log(JobUtils.buildPhaseMessage(FINALIZATION));
+ logger.log(JobUtils.buildPhaseMessage(FINALIZATION));
+ logger.log(JobHelper.buildStepStartMessage(List.of(3)));
+ assertFalse(build.getStepExecutions().containsKey("step-3"));
+ assertTrue(build.isFinalization());
+ logger.log(JobHelper.buildStepEndMessage(List.of(2), JobHelper.StepEventKind.FAILED));
+ assertEquals(io.onedev.server.model.support.build.StepExecution.Status.SUCCESSFUL,
+ build.getStepExecutions().get("step-2").getStatus());
+ assertEquals(List.of("Running step \"step-0\"...", "Step \"step-0\" is failed"),
+ logs.readLogEntries(new BuildLoggingIdentity(1L, 2L, "step-0"), 0, 0).stream().map(it -> it.getMessageText()).toList());
+ assertEquals(List.of("Running step \"step-1\"...", "Step \"step-1\" is skipped"),
+ logs.readLogEntries(new BuildLoggingIdentity(1L, 2L, "step-1"), 0, 0).stream().map(it -> it.getMessageText()).toList());
+ assertEquals(List.of("Running step \"step-2\"...", "Step \"step-2\" is successful"),
+ logs.readLogEntries(new BuildLoggingIdentity(1L, 2L, "step-2"), 0, 0).stream().map(it -> it.getMessageText()).toList());
+ assertEquals(List.of("Cleaning up job..."),
+ logs.readLogEntries(new BuildLoggingIdentity(1L, 2L, FINALIZATION), 0, 0).stream().map(it -> it.getMessageText()).toList());
+ }
+
+ private Build runningBuild() {
+ var build = org.mockito.Mockito.spy(new Build());
+ build.setId(3L);
+ build.setProject(storedBuild.getProject());
+ build.setNumber(2L);
+ build.setToken("attempt");
+ build.setStatus(Build.Status.RUNNING);
+ org.mockito.Mockito.doReturn(List.of()).when(build).getMaskSecrets();
+ org.mockito.Mockito.doReturn(null).when(build).getJob();
+ when(OneDev.getInstance(BuildService.class).load(3L)).thenReturn(build);
+ when(OneDev.getInstance(BuildService.class).get(3L)).thenReturn(build);
+ var transactions = mock(TransactionService.class);
+ org.mockito.Mockito.doAnswer(it -> {
+ it.getArgument(0, Runnable.class).run();
+ return null;
+ }).when(transactions).run(any());
+ oneDev.when(() -> OneDev.getInstance(TransactionService.class)).thenReturn(transactions);
+ oneDev.when(() -> OneDev.getInstance(io.onedev.server.event.ListenerRegistry.class))
+ .thenReturn(mock(io.onedev.server.event.ListenerRegistry.class));
+ oneDev.when(() -> OneDev.getInstance(io.onedev.server.job.JobService.class))
+ .thenReturn(mock(io.onedev.server.job.JobService.class));
+ return build;
+ }
+
+ private DefaultLogService configuredLogs() throws Exception {
+ var logs = new DefaultLogService();
+ inject(logs, "webSocketService", mock(WebSocketService.class));
+ inject(logs, "clusterService", mock(ClusterService.class));
+ inject(logs, "transactionService", mock(TransactionService.class));
+ return logs;
+ }
+
+ private void writeStageLog(BuildLoggingSupport support, LogSnippet snippet, String lockName) throws Exception {
+ var identity = mock(LoggingIdentity.class);
+ var file = directory.resolve("log").resolve(support.getStage() + ".log").toFile();
+ java.nio.file.Files.createDirectories(file.toPath().getParent());
+ when(identity.getFile()).thenReturn(file);
+ when(identity.getLockName()).thenReturn(lockName);
+ when(support.getIdentity()).thenReturn(identity);
+ try (var fileOutput = new java.io.FileOutputStream(file);
+ var output = new java.io.ObjectOutputStream(fileOutput)) {
+ for (int i = 0; i < snippet.offset; i++) output.writeObject(entry(0, "old"));
+ for (var entry : snippet.entries) output.writeObject(entry);
+ }
+ }
+
+ private io.onedev.server.logging.LogEntry entry(long time, String message) {
+ return new io.onedev.server.logging.LogEntry(
+ new java.util.Date(time), message);
+ }
+
+ private DefaultBuildLogService newService(io.onedev.server.logging.LogService logs) throws Exception {
+ var service = new DefaultBuildLogService();
+ inject(service, "logService", logs);
+ inject(service, "sessionService", OneDev.getInstance(SessionService.class));
+ inject(service, "buildService", OneDev.getInstance(BuildService.class));
+ return service;
+ }
+
+ private void inject(Object target, String name, Object value) throws Exception {
+ var field = target.getClass().getDeclaredField(name);
+ field.setAccessible(true);
+ field.set(target, value);
+ }
+}
diff --git a/server-core/src/test/java/io/onedev/server/persistence/HibernateSchemaTest.java b/server-core/src/test/java/io/onedev/server/persistence/HibernateSchemaTest.java
index 88d4d2baaf..cff6aad8b0 100644
--- a/server-core/src/test/java/io/onedev/server/persistence/HibernateSchemaTest.java
+++ b/server-core/src/test/java/io/onedev/server/persistence/HibernateSchemaTest.java
@@ -187,6 +187,12 @@ public class HibernateSchemaTest {
}
}
}
+ // Build step tracking was added after this historical ORM fixture.
+ // Add those columns while preserving its original enum and BLOB mappings.
+ try (var statement = connection.createStatement()) {
+ statement.execute("alter table o_Build add o_finalization boolean not null");
+ statement.execute("alter table o_Build add o_stepExecutions blob(65535)");
+ }
var legacySnapshot = snapshot(connection);
// ID and project number counters were added after the Hibernate 5 schema fixture.
assertEquals(structure(snapshot.stream()
diff --git a/server-core/src/test/java/io/onedev/server/web/component/progress/TimeProgressBarTest.java b/server-core/src/test/java/io/onedev/server/web/component/progress/TimeProgressBarTest.java
new file mode 100644
index 0000000000..da86833a13
--- /dev/null
+++ b/server-core/src/test/java/io/onedev/server/web/component/progress/TimeProgressBarTest.java
@@ -0,0 +1,78 @@
+package io.onedev.server.web.component.progress;
+
+import static org.junit.jupiter.api.Assertions.*;
+
+import org.apache.wicket.MarkupContainer;
+import org.apache.wicket.markup.IMarkupResourceStreamProvider;
+import org.apache.wicket.markup.html.WebPage;
+import org.apache.wicket.util.resource.IResourceStream;
+import org.apache.wicket.util.resource.StringResourceStream;
+import org.apache.wicket.util.tester.WicketTester;
+import org.jsoup.Jsoup;
+import org.jsoup.nodes.Element;
+import org.junit.jupiter.api.AfterEach;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.params.ParameterizedTest;
+import org.junit.jupiter.params.provider.ValueSource;
+
+class TimeProgressBarTest {
+ private WicketTester tester;
+
+ @BeforeEach
+ void setUp() {
+ tester = new WicketTester();
+ }
+
+ @AfterEach
+ void tearDown() {
+ tester.destroy();
+ }
+
+ @ParameterizedTest
+ @ValueSource(booleans = {true, false})
+ void rendersConstructorOptionsAndInitialElapsedTime(boolean roundCorner) {
+ var progress = new TimeProgressBar("progress", 60, "#123456", roundCorner).setElapsed(30);
+ var element = render(progress);
+ assertTrue(element.hasClass("caller-style"));
+ assertTrue(element.hasClass("time-progress"));
+ assertEquals(roundCorner, element.hasClass("time-progress-rounded"));
+ assertTrue(element.attr("style").contains("--time-progress-color: #123456"));
+ assertEquals("60.0", element.attr("data-estimated-duration"));
+ assertEquals("30.0", element.attr("data-elapsed"));
+ assertEquals("50", element.attr("aria-valuenow"));
+ assertEquals("Custom progress", element.attr("aria-label"));
+ assertFalse(element.hasAttr("hidden"));
+ assertNotNull(element.selectFirst(".time-progress-fill"));
+ assertTrue(tester.getLastResponseAsString().contains("onedev.server.timeProgress.onDomReady("));
+ }
+
+ @Test
+ void hidesMissingEstimateAndCapsOverdueProgress() {
+ var progress = new TimeProgressBar("progress", 0, "var(--primary)", false);
+ assertTrue(render(progress).hasAttr("hidden"));
+ var element = render(new TimeProgressBar("progress", 10, "var(--primary)", false).setElapsed(20));
+ assertFalse(element.hasAttr("hidden"));
+ assertEquals("99", element.attr("aria-valuenow"));
+ }
+
+ private Element render(TimeProgressBar progress) {
+ tester.startPage(progress.getParent() != null ? progress.getPage() : new TestPage(progress));
+ return Jsoup.parse(tester.getLastResponseAsString()).getElementById(progress.getMarkupId());
+ }
+
+ private static class TestPage extends WebPage implements IMarkupResourceStreamProvider {
+ private static final long serialVersionUID = 1L;
+
+ TestPage(TimeProgressBar progress) {
+ add(progress);
+ }
+
+ @Override
+ public IResourceStream getMarkupResourceStream(MarkupContainer container, Class<?> containerClass) {
+ return new StringResourceStream("<html><head></head><body>"
+ + "<div wicket:id='progress' class='caller-style' aria-label='Custom progress'></div>"
+ + "</body></html>");
+ }
+ }
+}
diff --git a/server-core/src/test/java/io/onedev/server/web/page/project/builds/detail/log/BuildStepsPageTest.java b/server-core/src/test/java/io/onedev/server/web/page/project/builds/detail/log/BuildStepsPageTest.java
new file mode 100644
index 0000000000..559a758fcc
--- /dev/null
+++ b/server-core/src/test/java/io/onedev/server/web/page/project/builds/detail/log/BuildStepsPageTest.java
@@ -0,0 +1,293 @@
+package io.onedev.server.web.page.project.builds.detail.log;
+
+import static org.mockito.ArgumentMatchers.*;
+import static org.mockito.Mockito.*;
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertNull;
+import static org.junit.jupiter.api.Assertions.assertTrue;
+
+import java.util.Date;
+import java.util.LinkedHashMap;
+import java.util.List;
+import java.util.Map;
+import java.util.Set;
+
+import org.apache.wicket.ajax.AjaxRequestTarget;
+import org.apache.wicket.core.request.handler.IPartialPageRequestHandler;
+import org.apache.wicket.markup.html.WebMarkupContainer;
+import org.apache.wicket.request.Request;
+import org.apache.wicket.util.string.StringValue;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.params.ParameterizedTest;
+import org.junit.jupiter.params.provider.ValueSource;
+import org.junit.jupiter.params.provider.EnumSource;
+
+import com.fasterxml.jackson.databind.ObjectMapper;
+
+import io.onedev.server.model.Build;
+import io.onedev.server.model.Project;
+import io.onedev.server.web.behavior.ChangeObserver;
+
+class BuildStepsPageTest {
+ @ParameterizedTest
+ @EnumSource(value = Build.Status.class, mode = EnumSource.Mode.EXCLUDE, names = "RUNNING")
+ void hidesProgressForBuildsThatAreNotRunning(Build.Status status) throws Exception {
+ var build = mock(Build.class);
+ when(build.getStatus()).thenReturn(status);
+ assertNull(progressData(build));
+ verify(build, never()).getStreamPrevious(any());
+ }
+
+ @Test
+ void hidesProgressWithoutUsableSuccessfulStreamHistory() throws Exception {
+ var build = mock(Build.class);
+ when(build.getStatus()).thenReturn(Build.Status.RUNNING);
+ when(build.getRunningDate()).thenReturn(new Date());
+ assertNull(progressData(build));
+ var previous = mock(Build.class);
+ when(build.getStreamPrevious(Build.Status.SUCCESSFUL)).thenReturn(previous);
+ when(previous.getRunningDuration()).thenReturn(null, 0L, -1L);
+ assertNull(progressData(build));
+ assertNull(progressData(build));
+ assertNull(progressData(build));
+ }
+
+ @Test
+ void estimatesProgressUsingRunningTimeOfSuccessfulStreamPrevious() throws Exception {
+ var build = mock(Build.class);
+ when(build.getStatus()).thenReturn(Build.Status.RUNNING);
+ var started = System.currentTimeMillis() - 30_000;
+ when(build.getRunningDate()).thenReturn(new Date(started));
+ var previous = mock(Build.class);
+ when(previous.getRunningDuration()).thenReturn(60_000L);
+ when(build.getStreamPrevious(Build.Status.SUCCESSFUL)).thenReturn(previous);
+ var progress = progressData(build);
+ assertEquals(60_000L, progress.get("expected"));
+ assertTrue(progress.get("elapsed") >= 30_000);
+ assertTrue(progress.get("elapsed") <= System.currentTimeMillis() - started);
+ verify(build).getStreamPrevious(Build.Status.SUCCESSFUL);
+ }
+
+ @SuppressWarnings("unchecked")
+ private Map<String, Long> progressData(Build build) throws Exception {
+ var page = mock(BuildStepsPage.class, CALLS_REAL_METHODS);
+ doReturn(build).when(page).getBuild();
+ var method = BuildStepsPage.class.getDeclaredMethod("getProgressData");
+ method.setAccessible(true);
+ return (Map<String, Long>) method.invoke(page);
+ }
+
+ @Test
+ void pushesUpdatesAfterCompletionAndIgnoresNewSubmission() throws Exception {
+ var build = mock(Build.class);
+ when(build.getProject()).thenReturn(new Project());
+ when(build.getSubmitSequence()).thenReturn(1L);
+ when(build.isFinished()).thenReturn(true);
+ when(build.getStepExecutions()).thenReturn(new LinkedHashMap<>());
+ var observer = mock(ChangeObserver.class);
+ var steps = mock(WebMarkupContainer.class);
+ when(steps.getMarkupId()).thenReturn("steps");
+ var page = mock(BuildStepsPage.class, CALLS_REAL_METHODS);
+ doReturn(build).when(page).getBuild();
+ doReturn(page).when(page).remove(observer);
+ set(page, "submitSequence", 1L);
+ set(page, "nextOffsets", new LinkedHashMap<>());
+ set(page, "objectMapper", new ObjectMapper());
+ set(page, "steps", steps);
+ set(page, "autoUpdate", true);
+ var handler = mock(IPartialPageRequestHandler.class);
+ var update = BuildStepsPage.class.getDeclaredMethod("updateSteps", IPartialPageRequestHandler.class, boolean.class);
+ update.setAccessible(true);
+
+ // Keep handling late output after completion, as the original LogPanel did.
+ update.invoke(page, handler, false);
+ verify(page, never()).remove(observer);
+ verify(handler).appendJavaScript(contains("buildSteps.update([],false,1,false)"));
+ verify(handler, never()).appendJavaScript(contains("buildSteps.refresh"));
+
+ update.invoke(page, handler, false);
+ verify(page, never()).remove(observer);
+ verify(handler, times(2)).appendJavaScript(contains("buildSteps.update([],false,1,false)"));
+
+ // A late notification from a rebuild must not repaint the old step view.
+ when(build.getSubmitSequence()).thenReturn(2L);
+ clearInvocations(handler);
+ update.invoke(page, handler, false);
+ verifyNoInteractions(handler);
+ }
+
+ @Test
+ void disablingAutoUpdateKeepsBuildStatusUpdatingButStopsSteps() throws Exception {
+ var build = mock(Build.class);
+ var page = mock(BuildStepsPage.class, CALLS_REAL_METHODS);
+ doReturn(build).when(page).getBuild();
+ var detail = mock(ChangeObserver.class);
+ var logs = mock(ChangeObserver.class);
+ var detailObservable = Build.getDetailChangeObservable(1L);
+ var logObservable = Build.getLogChangeObservable(1L);
+ when(detail.getObservables()).thenReturn(Set.of(detailObservable));
+ when(logs.getObservables()).thenReturn(Set.of(logObservable));
+ doReturn(List.of(detail, logs)).when(page).findBehaviors(ChangeObserver.class);
+ doAnswer(invocation -> {
+ var update = BuildStepsPage.class.getDeclaredMethod("updateSteps", IPartialPageRequestHandler.class, boolean.class);
+ update.setAccessible(true);
+ update.invoke(page, invocation.getArgument(0), false);
+ return null;
+ }).when(logs).onObservableChanged(any(), any());
+ var target = mock(AjaxRequestTarget.class);
+ changeAutoUpdate(page, target, false);
+ verify(target).prependJavaScript("onedev.server.buildSteps.setAutoUpdate(false);");
+ clearInvocations(target);
+
+ page.notifyObservablesChange(target, Set.of(detailObservable, logObservable));
+ verify(detail).onObservableChanged(target, Set.of(detailObservable));
+ verify(logs).onObservableChanged(target, Set.of(logObservable));
+ verifyNoInteractions(target);
+ }
+
+ @ParameterizedTest
+ @ValueSource(booleans = {true, false})
+ void finishingBuildReloadsWholePageRegardlessOfAutoUpdate(boolean autoUpdate) throws Exception {
+ var build = mock(Build.class);
+ when(build.getSubmitSequence()).thenReturn(1L);
+ when(build.isFinished()).thenReturn(true);
+ var page = mock(BuildStepsPage.class, CALLS_REAL_METHODS);
+ doReturn(build).when(page).getBuild();
+ doReturn(List.of()).when(page).findBehaviors(ChangeObserver.class);
+ set(page, "submitSequence", 1L);
+ set(page, "autoUpdate", autoUpdate);
+ var target = mock(AjaxRequestTarget.class);
+
+ page.notifyObservablesChange(target, Set.of(Build.getDetailChangeObservable(1L)));
+ verify(target).appendJavaScript("window.location.reload();");
+ clearInvocations(target);
+
+ // Late log notifications must not repeatedly reload an already finished page.
+ page.notifyObservablesChange(target, Set.of(Build.getLogChangeObservable(1L)));
+ verifyNoInteractions(target);
+ }
+
+ @ParameterizedTest
+ @ValueSource(booleans = {true, false})
+ void reEnablingOnlyCatchesUpStepsWithoutCheckingBuildCompletion(boolean finished) throws Exception {
+ var build = mock(Build.class);
+ when(build.getId()).thenReturn(1L);
+ when(build.getSubmitSequence()).thenReturn(2L);
+ when(build.isFinished()).thenReturn(finished);
+ when(build.getStepExecutions()).thenReturn(new LinkedHashMap<>());
+ var page = mock(BuildStepsPage.class, CALLS_REAL_METHODS);
+ doReturn(build).when(page).getBuild();
+ set(page, "submitSequence", 2L);
+ var steps = mock(WebMarkupContainer.class);
+ when(steps.getMarkupId()).thenReturn("steps");
+ set(page, "steps", steps);
+ var offsets = new LinkedHashMap<String, Integer>(Map.of("old-step", 500));
+ set(page, "nextOffsets", offsets);
+ set(page, "objectMapper", new ObjectMapper());
+ var request = mock(Request.class, RETURNS_DEEP_STUBS);
+ when(request.getRequestParameters().getParameterValue("offsets"))
+ .thenReturn(StringValue.valueOf("{\"running-step\":42,\"expanded-step\":7}"));
+ doReturn(request).when(page).getRequest();
+ var target = mock(AjaxRequestTarget.class);
+
+ changeAutoUpdate(page, target, true);
+ assertEquals(Map.of("running-step", 42, "expanded-step", 7), offsets);
+ verify(target).prependJavaScript("onedev.server.buildSteps.setAutoUpdate(true);");
+ verify(target).appendJavaScript(contains("buildSteps.update([],false,2,false)"));
+ verify(target, never()).appendJavaScript(contains("location.reload"));
+ verify(build, never()).isFinished();
+ verify(page, never()).findBehaviors(ChangeObserver.class);
+ }
+
+ @Test
+ @SuppressWarnings("unchecked")
+ void phasesHaveNoStatusOrDurationWhileStepsKeepTheirMetadata() throws Exception {
+ var build = spy(new Build());
+ var project = new Project();
+ project.setId(1L);
+ build.setProject(project);
+ build.setNumber(2L);
+ build.setStatus(Build.Status.RUNNING);
+ doReturn(null).when(build).getJob();
+ var stepExecution = new io.onedev.server.model.support.build.StepExecution();
+ stepExecution.complete(io.onedev.server.model.support.build.StepExecution.Status.FAILED);
+ build.getStepExecutions().put("step-0", stepExecution);
+ build.setFinalization(true);
+ var page = mock(BuildStepsPage.class, CALLS_REAL_METHODS);
+ doReturn(build).when(page).getBuild();
+ doReturn(project).when(page).getProject();
+ doReturn("/log").when(page).urlFor(any(org.apache.wicket.request.resource.ResourceReference.class),
+ any(org.apache.wicket.request.mapper.parameter.PageParameters.class));
+ set(page, "nextOffsets", new LinkedHashMap<>());
+ var method = BuildStepsPage.class.getDeclaredMethod("getStepData");
+ method.setAccessible(true);
+ var data = (List<Map<String, Object>>) method.invoke(page);
+ assertEquals(List.of("initialization", "step-0", "finalization"),
+ data.stream().map(it -> it.get("name")).toList());
+ for (var phase : List.of(data.get(0), data.get(2))) {
+ assertTrue(!phase.containsKey("status"));
+ assertTrue(!phase.containsKey("duration"));
+ assertTrue(!phase.containsKey("stepIndex"));
+ assertEquals("/log", phase.get("download"));
+ }
+ assertEquals(false, data.get(0).get("active"));
+ assertEquals(true, data.get(2).get("active"));
+ assertEquals(stepExecution.getStatus(), data.get(1).get("status"));
+ assertEquals(stepExecution.getDuration(), data.get(1).get("duration"));
+ assertEquals(1, data.get(1).get("stepIndex"));
+
+ // A retry hides the previous attempt's finalization until cleanup starts again.
+ build.setFinalization(false);
+ build.getStepExecutions().clear();
+ data = (List<Map<String, Object>>) method.invoke(page);
+ assertEquals(List.of("initialization"), data.stream().map(it -> it.get("name")).toList());
+ assertEquals(true, data.get(0).get("active"));
+ build.setStatus(Build.Status.FAILED);
+ data = (List<Map<String, Object>>) method.invoke(page);
+ assertEquals(List.of("initialization"), data.stream().map(it -> it.get("name")).toList());
+ build.setStatus(Build.Status.RUNNING);
+ build.getStepExecutions().put("step-0", new io.onedev.server.model.support.build.StepExecution());
+ data = (List<Map<String, Object>>) method.invoke(page);
+ assertEquals(List.of("initialization", "step-0"), data.stream().map(it -> it.get("name")).toList());
+ assertEquals(false, data.get(0).get("active"));
+ assertEquals(true, data.get(1).get("active"));
+ build.setFinalization(true);
+ data = (List<Map<String, Object>>) method.invoke(page);
+ assertEquals("finalization", data.get(2).get("name"));
+ }
+
+ private void changeAutoUpdate(BuildStepsPage page, AjaxRequestTarget target, boolean enabled) throws Exception {
+ var method = BuildStepsPage.class.getDeclaredMethod("changeAutoUpdate", AjaxRequestTarget.class, boolean.class);
+ method.setAccessible(true);
+ method.invoke(page, target, enabled);
+ }
+
+ private void set(BuildStepsPage page, String name, Object value) throws Exception {
+ var field = BuildStepsPage.class.getDeclaredField(name);
+ field.setAccessible(true);
+ field.set(page, value);
+ }
+
+ @Test
+ void retryReloadsThePageInsteadOfReusingPreviousLogOffsets() throws Exception {
+ var build = mock(Build.class);
+ when(build.getSubmitSequence()).thenReturn(1L);
+ when(build.getRetryDate()).thenReturn(new Date(1000));
+ var page = mock(BuildStepsPage.class, CALLS_REAL_METHODS);
+ doReturn(build).when(page).getBuild();
+ set(page, "submitSequence", 1L);
+ set(page, "autoUpdate", true);
+ var handler = mock(IPartialPageRequestHandler.class);
+ var update = BuildStepsPage.class.getDeclaredMethod("updateSteps", IPartialPageRequestHandler.class, boolean.class);
+ update.setAccessible(true);
+ update.invoke(page, handler, false);
+ verify(handler).appendJavaScript("window.location.reload();");
+ verifyNoMoreInteractions(handler);
+ clearInvocations(handler);
+ set(page, "autoUpdate", false);
+ update.invoke(page, handler, false);
+ verifyNoInteractions(handler);
+ update.invoke(page, handler, true);
+ verify(handler).appendJavaScript("window.location.reload();");
+ }
+}
diff --git a/server-plugin/server-plugin-executor-kubernetes/src/main/java/io/onedev/server/plugin/executor/kubernetes/KubernetesExecutor.java b/server-plugin/server-plugin-executor-kubernetes/src/main/java/io/onedev/server/plugin/executor/kubernetes/KubernetesExecutor.java
index 3146b61c6a..724308aa48 100644
--- a/server-plugin/server-plugin-executor-kubernetes/src/main/java/io/onedev/server/plugin/executor/kubernetes/KubernetesExecutor.java
+++ b/server-plugin/server-plugin-executor-kubernetes/src/main/java/io/onedev/server/plugin/executor/kubernetes/KubernetesExecutor.java
@@ -60,6 +60,7 @@ import com.google.common.base.Preconditions;
import com.google.common.collect.Lists;
import com.google.common.collect.Sets;
+import io.onedev.agent.job.JobUtils;
import io.onedev.commons.utils.ExplicitException;
import io.onedev.commons.utils.StringUtils;
import io.onedev.commons.utils.TaskLogger;
@@ -68,6 +69,7 @@ import io.onedev.commons.utils.command.LineConsumer;
import io.onedev.k8shelper.BuildImageFacade;
import io.onedev.k8shelper.CommandFacade;
import io.onedev.k8shelper.CompositeFacade;
+import io.onedev.k8shelper.JobHelper;
import io.onedev.k8shelper.LeafFacade;
import io.onedev.k8shelper.PruneBuilderCacheFacade;
import io.onedev.k8shelper.RegistryLoginFacade;
@@ -660,7 +662,7 @@ public class KubernetesExecutor extends JobExecutor implements KubernetesAware,
return map;
}
- private boolean doExecute( JobContext jobContext, TaskLogger jobLogger) {
+ private boolean doExecute(JobContext jobContext, TaskLogger jobLogger) {
jobLogger.log("Checking cluster access...");
String jobToken = jobContext.getJobToken();
@@ -686,368 +688,399 @@ public class KubernetesExecutor extends JobExecutor implements KubernetesAware,
if (getClusterRole() != null)
createClusterRoleBinding(namespace, jobLogger);
+ var entryFacade = new CompositeFacade(jobContext.getActions());
+ boolean successful = true;
+ boolean namespaceCreated = false;
+ boolean initializationCompleted = false;
+ boolean stepsFinished = false;
+
try {
Map<Object, Object> namespaceDef = getPrivilegedNamespaceDefinition(namespace);
createResource(this::newKubectl, namespaceDef, Sets.newHashSet(), jobLogger);
+ namespaceCreated = true;
jobLogger.log(String.format("Preparing job (executor: %s, namespace: %s)...",
getName(), namespace));
- try {
- String imagePullSecretName = createImagePullSecret(namespace, jobContext, jobLogger);
- for (var jobService: jobContext.getServices()) {
- jobLogger.log("Starting service (name: " + jobService.getName() + ", image: " + jobService.getImage() + ")...");
- startService(namespace, jobContext, jobService, imagePullSecretName, jobLogger);
- }
-
- var trustCertsConfigMapCreated = createTrustCertsConfigMap(this::newKubectl,
- "trust-certs", namespace, jobLogger);
-
- Map<Object, Object> pvcDef = newLinkedHashMap(
- "apiVersion", "v1",
- "kind", "PersistentVolumeClaim",
- "metadata", newLinkedHashMap(
- "name", "build-dir",
- "namespace", namespace));
- Map<Object, Object> pvcSpecDef = newLinkedHashMap(
- "accessModes", newArrayList("ReadWriteOnce"),
- "resources", newLinkedHashMap(
- "requests", newLinkedHashMap(
- "storage", getStorageSize())));
- if (getStorageClass() != null)
- pvcSpecDef.put("storageClassName", getStorageClass());
- pvcDef.put("spec", pvcSpecDef);
- createResource(this::newKubectl, pvcDef, Sets.newHashSet(), jobLogger);
-
- Map<String, Object> podSpec = new LinkedHashMap<>();
+ String imagePullSecretName = createImagePullSecret(namespace, jobContext, jobLogger);
+ for (var jobService: jobContext.getServices()) {
+ jobLogger.log("Starting service (name: " + jobService.getName() + ", image: " + jobService.getImage() + ")...");
+ startService(namespace, jobContext, jobService, imagePullSecretName, jobLogger);
+ }
- List<Map<Object, Object>> containerSpecs = new ArrayList<>();
-
- var containerBuildDirPath = BUILD_PATH;
- var containerWorkDirPath = containerBuildDirPath + "/work";
- var containerCommandDirPath = containerBuildDirPath + "/command";
- var containerTrustCertsDirPath = containerBuildDirPath + "/trust-certs";
-
- Map<String, String> buildDirMount = newLinkedHashMap(
- "name", "build-dir",
- "mountPath", containerBuildDirPath);
- Map<String, String> trustCertsMount = newLinkedHashMap(
- "name", "trust-certs",
- "mountPath", containerTrustCertsDirPath);
-
- var commonVolumeMounts = newArrayList(buildDirMount);
- if (trustCertsConfigMapCreated)
- commonVolumeMounts.add(trustCertsMount);
-
- CompositeFacade entryFacade = new CompositeFacade(jobContext.getActions());
-
- List<String> containerNames = newArrayList("init");
-
- String helperImage = IMAGE_REPO + ":" + getVersion();
-
- var pulledImages = new HashSet<String>();
- if (isAlwaysPullImage())
- pulledImages.add(helperImage);
-
- ArrayList<Map<Object, Object>> commonEnvs = new ArrayList<>();
- commonEnvs.add(newLinkedHashMap(
- "name", ENV_SERVER_URL,
- "value", getServerUrl()));
- commonEnvs.add(newLinkedHashMap(
- "name", ENV_JOB_TOKEN,
- "value", jobToken));
- commonEnvs.add(newLinkedHashMap(
- "name", "ONEDEV_WORKDIR",
- "value", containerWorkDirPath
- ));
-
- Map<String, String> cacheMounts = new LinkedHashMap<>();
- var cacheConfigIndex = new AtomicInteger(1);
- entryFacade.traverse((facade, position) -> {
- String containerName = getContainerName(position);
- containerNames.add(containerName);
- Map<Object, Object> stepContainerSpec;
- if (facade instanceof CommandFacade) {
- CommandFacade commandFacade = (CommandFacade) facade;
- if (commandFacade.getImage() == null) {
- throw new ExplicitException("This step can only be executed by server shell "
- + "executor or remote shell executor");
- }
-
- stepContainerSpec = newHashMap(
- "name", containerName,
- "image", commandFacade.getImage(),
- "workingDir", containerWorkDirPath);
- setImagePullPolicy(stepContainerSpec, commandFacade.getImage(), pulledImages);
- if (commandFacade.isUseTTY())
- stepContainerSpec.put("tty", true);
- var volumeMounts = buildVolumeMounts(cacheMounts);
- volumeMounts.addAll(commonVolumeMounts);
- stepContainerSpec.put("volumeMounts", SerializationUtils.clone(volumeMounts));
- var envs = SerializationUtils.clone(commonEnvs);
- for (var entry: commandFacade.getEnvMap().entrySet()) {
- envs.add(newLinkedHashMap(
- "name", entry.getKey(),
- "value", entry.getValue()));
- }
- stepContainerSpec.put("env", envs);
- var runAs = commandFacade.getRunAs();
- setupSecurityContext(stepContainerSpec, runAs);
- } else if (facade instanceof BuildImageFacade) {
- throw new ExplicitException("This step can only be executed by server docker executor or " +
- "remote docker executor. Use kaniko step instead to build image in kubernetes cluster");
- } else if (facade instanceof RunContainerFacade || facade instanceof RunImagetoolsFacade
- || facade instanceof PruneBuilderCacheFacade) {
- throw new ExplicitException("This step can only be executed by server docker executor or " +
- "remote docker executor");
- } else {
- if (facade instanceof SetupCacheFacade) {
- var setupCacheFacade = (SetupCacheFacade) facade;
- var cacheProvisioner = new ServerJobCacheProvisioner(
- setupCacheFacade.getCacheConfig(), cacheConfigIndex.getAndIncrement(), jobContext);
- for (var path: setupCacheFacade.getCacheConfig().getPaths()) {
- var absolutePathIndex = cacheProvisioner.getAbsolutePathIndexes().get(path);
- if (absolutePathIndex != null)
- cacheMounts.put(path, cacheProvisioner.getSubPath(absolutePathIndex));
- }
- }
- stepContainerSpec = newHashMap(
- "name", containerName,
- "image", helperImage);
- setImagePullPolicy(stepContainerSpec, helperImage, pulledImages);
- var volumeMounts = buildVolumeMounts(cacheMounts);
- volumeMounts.addAll(commonVolumeMounts);
- stepContainerSpec.put("volumeMounts", SerializationUtils.clone(volumeMounts));
- stepContainerSpec.put("env", SerializationUtils.clone(commonEnvs));
- setupSecurityContext(stepContainerSpec, "0:0");
+ var trustCertsConfigMapCreated = createTrustCertsConfigMap(this::newKubectl,
+ "trust-certs", namespace, jobLogger);
+
+ Map<Object, Object> pvcDef = newLinkedHashMap(
+ "apiVersion", "v1",
+ "kind", "PersistentVolumeClaim",
+ "metadata", newLinkedHashMap(
+ "name", "build-dir",
+ "namespace", namespace));
+ Map<Object, Object> pvcSpecDef = newLinkedHashMap(
+ "accessModes", newArrayList("ReadWriteOnce"),
+ "resources", newLinkedHashMap(
+ "requests", newLinkedHashMap(
+ "storage", getStorageSize())));
+ if (getStorageClass() != null)
+ pvcSpecDef.put("storageClassName", getStorageClass());
+ pvcDef.put("spec", pvcSpecDef);
+ createResource(this::newKubectl, pvcDef, Sets.newHashSet(), jobLogger);
+
+ Map<String, Object> podSpec = new LinkedHashMap<>();
+
+ List<Map<Object, Object>> containerSpecs = new ArrayList<>();
+
+ var containerBuildDirPath = BUILD_PATH;
+ var containerWorkDirPath = containerBuildDirPath + "/work";
+ var containerCommandDirPath = containerBuildDirPath + "/command";
+ var containerTrustCertsDirPath = containerBuildDirPath + "/trust-certs";
+
+ Map<String, String> buildDirMount = newLinkedHashMap(
+ "name", "build-dir",
+ "mountPath", containerBuildDirPath);
+ Map<String, String> trustCertsMount = newLinkedHashMap(
+ "name", "trust-certs",
+ "mountPath", containerTrustCertsDirPath);
+
+ var commonVolumeMounts = newArrayList(buildDirMount);
+ if (trustCertsConfigMapCreated)
+ commonVolumeMounts.add(trustCertsMount);
+
+ List<String> containerNames = newArrayList("init");
+
+ String helperImage = IMAGE_REPO + ":" + getVersion();
+
+ var pulledImages = new HashSet<String>();
+ if (isAlwaysPullImage())
+ pulledImages.add(helperImage);
+
+ ArrayList<Map<Object, Object>> commonEnvs = new ArrayList<>();
+ commonEnvs.add(newLinkedHashMap(
+ "name", ENV_SERVER_URL,
+ "value", getServerUrl()));
+ commonEnvs.add(newLinkedHashMap(
+ "name", ENV_JOB_TOKEN,
+ "value", jobToken));
+ commonEnvs.add(newLinkedHashMap(
+ "name", "ONEDEV_WORKDIR",
+ "value", containerWorkDirPath
+ ));
+
+ Map<String, String> cacheMounts = new LinkedHashMap<>();
+ var cacheConfigIndex = new AtomicInteger(1);
+ entryFacade.traverse((facade, position) -> {
+ String containerName = getContainerName(position);
+ containerNames.add(containerName);
+ Map<Object, Object> stepContainerSpec;
+ if (facade instanceof CommandFacade) {
+ CommandFacade commandFacade = (CommandFacade) facade;
+ if (commandFacade.getImage() == null) {
+ throw new ExplicitException("This step can only be executed by server shell "
+ + "executor or remote shell executor");
}
-
- if (stepContainerSpec != null) {
- String positionStr = stringifyStepPosition(position);
- stepContainerSpec.put("command", newArrayList("sh"));
- stepContainerSpec.put("args", newArrayList(containerCommandDirPath + "/" + positionStr + ".sh"));
-
- Map<Object, Object> requestsSpec = newLinkedHashMap(
- "cpu", "0",
- "memory", "0");
- Map<Object, Object> limitsSpec = new LinkedHashMap<>();
- if (getCpuLimit() != null)
- limitsSpec.put("cpu", getCpuLimit());
- if (getMemoryLimit() != null)
- limitsSpec.put("memory", getMemoryLimit());
- if (!limitsSpec.isEmpty()) {
- stepContainerSpec.put(
- "resources", newLinkedHashMap(
- "limits", limitsSpec,
- "requests", requestsSpec));
- }
- containerSpecs.add(stepContainerSpec);
+ stepContainerSpec = newHashMap(
+ "name", containerName,
+ "image", commandFacade.getImage(),
+ "workingDir", containerWorkDirPath);
+ setImagePullPolicy(stepContainerSpec, commandFacade.getImage(), pulledImages);
+ if (commandFacade.isUseTTY())
+ stepContainerSpec.put("tty", true);
+ var volumeMounts = buildVolumeMounts(cacheMounts);
+ volumeMounts.addAll(commonVolumeMounts);
+ stepContainerSpec.put("volumeMounts", SerializationUtils.clone(volumeMounts));
+ var envs = SerializationUtils.clone(commonEnvs);
+ for (var entry: commandFacade.getEnvMap().entrySet()) {
+ envs.add(newLinkedHashMap(
+ "name", entry.getKey(),
+ "value", entry.getValue()));
}
- return null;
- }, new ArrayList<>());
-
- String k8sHelperClassPath = "/k8s-helper/*";
-
- List<String> sidecarArgs = newArrayList(
- "-classpath", k8sHelperClassPath,
- "io.onedev.k8shelper.JobSideCar");
- List<String> initArgs = newArrayList(
- "-classpath", k8sHelperClassPath,
- "io.onedev.k8shelper.JobInit");
-
- ArrayList<Object> volumeMounts = buildVolumeMounts(cacheMounts);
- volumeMounts.addAll(commonVolumeMounts);
-
- Map<Object, Object> initContainerSpec = newHashMap(
- "name", "init",
- "image", helperImage,
- "command", newArrayList("java"),
- "args", initArgs,
- "env", SerializationUtils.clone(commonEnvs),
- "volumeMounts", SerializationUtils.clone(volumeMounts));
- if (isAlwaysPullImage())
- initContainerSpec.put("imagePullPolicy", "Always");
- setupSecurityContext(initContainerSpec, "0:0");
-
- Map<Object, Object> sidecarContainerSpec = newLinkedHashMap(
- "name", "sidecar",
- "image", helperImage,
- "command", newArrayList("java"),
- "args", sidecarArgs,
- "env", SerializationUtils.clone(commonEnvs),
- "volumeMounts", SerializationUtils.clone(volumeMounts));
- setImagePullPolicy(sidecarContainerSpec, helperImage, pulledImages);
-
- sidecarContainerSpec.put("resources", newLinkedHashMap("requests", newLinkedHashMap(
- "cpu", getCpuRequest(),
- "memory", getMemoryRequest())));
- setupSecurityContext(sidecarContainerSpec, "0:0");
-
- containerSpecs.add(sidecarContainerSpec);
- containerNames.add("sidecar");
+ stepContainerSpec.put("env", envs);
+ var runAs = commandFacade.getRunAs();
+ setupSecurityContext(stepContainerSpec, runAs);
+ } else if (facade instanceof BuildImageFacade) {
+ throw new ExplicitException("This step can only be executed by server docker executor or " +
+ "remote docker executor. Use kaniko step instead to build image in kubernetes cluster");
+ } else if (facade instanceof RunContainerFacade || facade instanceof RunImagetoolsFacade
+ || facade instanceof PruneBuilderCacheFacade) {
+ throw new ExplicitException("This step can only be executed by server docker executor or " +
+ "remote docker executor");
+ } else {
+ if (facade instanceof SetupCacheFacade) {
+ var setupCacheFacade = (SetupCacheFacade) facade;
+ var cacheProvisioner = new ServerJobCacheProvisioner(
+ setupCacheFacade.getCacheConfig(), cacheConfigIndex.getAndIncrement(), jobContext);
+ for (var path: setupCacheFacade.getCacheConfig().getPaths()) {
+ var absolutePathIndex = cacheProvisioner.getAbsolutePathIndexes().get(path);
+ if (absolutePathIndex != null)
+ cacheMounts.put(path, cacheProvisioner.getSubPath(absolutePathIndex));
+ }
+ }
+ stepContainerSpec = newHashMap(
+ "name", containerName,
+ "image", helperImage);
+ setImagePullPolicy(stepContainerSpec, helperImage, pulledImages);
+ var volumeMounts = buildVolumeMounts(cacheMounts);
+ volumeMounts.addAll(commonVolumeMounts);
+ stepContainerSpec.put("volumeMounts", SerializationUtils.clone(volumeMounts));
+ stepContainerSpec.put("env", SerializationUtils.clone(commonEnvs));
+ setupSecurityContext(stepContainerSpec, "0:0");
+ }
- podSpec.put("containers", containerSpecs);
- podSpec.put("initContainers", Lists.<Object>newArrayList(initContainerSpec));
+ if (stepContainerSpec != null) {
+ String positionStr = stringifyStepPosition(position);
+ stepContainerSpec.put("command", newArrayList("sh"));
+ stepContainerSpec.put("args", newArrayList(containerCommandDirPath + "/" + positionStr + ".sh"));
+
+ Map<Object, Object> requestsSpec = newLinkedHashMap(
+ "cpu", "0",
+ "memory", "0");
+ Map<Object, Object> limitsSpec = new LinkedHashMap<>();
+ if (getCpuLimit() != null)
+ limitsSpec.put("cpu", getCpuLimit());
+ if (getMemoryLimit() != null)
+ limitsSpec.put("memory", getMemoryLimit());
+ if (!limitsSpec.isEmpty()) {
+ stepContainerSpec.put(
+ "resources", newLinkedHashMap(
+ "limits", limitsSpec,
+ "requests", requestsSpec));
+ }
- if (imagePullSecretName != null)
- podSpec.put("imagePullSecrets", Lists.<Object>newArrayList(newLinkedHashMap("name", imagePullSecretName)));
- podSpec.put("restartPolicy", "Never");
-
- if (!getNodeSelector().isEmpty())
- podSpec.put("nodeSelector", toMap(getNodeSelector()));
-
- Map<Object, Object> buildDirVolume = newLinkedHashMap(
- "name", "build-dir",
- "persistentVolumeClaim", newLinkedHashMap(
- "claimName", "build-dir"));
- List<Object> volumes = newArrayList(buildDirVolume);
- if (trustCertsConfigMapCreated) {
- volumes.add(newLinkedHashMap(
- "name", "trust-certs",
- "configMap", newLinkedHashMap(
- "name", "trust-certs")));
+ containerSpecs.add(stepContainerSpec);
}
- podSpec.put("volumes", volumes);
+ return null;
+ }, new ArrayList<>());
+
+ String k8sHelperClassPath = "/k8s-helper/*";
+
+ List<String> sidecarArgs = newArrayList(
+ "-classpath", k8sHelperClassPath,
+ "io.onedev.k8shelper.JobSideCar");
+ List<String> initArgs = newArrayList(
+ "-classpath", k8sHelperClassPath,
+ "io.onedev.k8shelper.JobInit");
+
+ ArrayList<Object> volumeMounts = buildVolumeMounts(cacheMounts);
+ volumeMounts.addAll(commonVolumeMounts);
+
+ Map<Object, Object> initContainerSpec = newHashMap(
+ "name", "init",
+ "image", helperImage,
+ "command", newArrayList("java"),
+ "args", initArgs,
+ "env", SerializationUtils.clone(commonEnvs),
+ "volumeMounts", SerializationUtils.clone(volumeMounts));
+ if (isAlwaysPullImage())
+ initContainerSpec.put("imagePullPolicy", "Always");
+ setupSecurityContext(initContainerSpec, "0:0");
+
+ Map<Object, Object> sidecarContainerSpec = newLinkedHashMap(
+ "name", "sidecar",
+ "image", helperImage,
+ "command", newArrayList("java"),
+ "args", sidecarArgs,
+ "env", SerializationUtils.clone(commonEnvs),
+ "volumeMounts", SerializationUtils.clone(volumeMounts));
+ setImagePullPolicy(sidecarContainerSpec, helperImage, pulledImages);
+
+ sidecarContainerSpec.put("resources", newLinkedHashMap("requests", newLinkedHashMap(
+ "cpu", getCpuRequest(),
+ "memory", getMemoryRequest())));
+ setupSecurityContext(sidecarContainerSpec, "0:0");
+
+ containerSpecs.add(sidecarContainerSpec);
+
+ podSpec.put("containers", containerSpecs);
+ podSpec.put("initContainers", Lists.<Object>newArrayList(initContainerSpec));
+
+ if (imagePullSecretName != null)
+ podSpec.put("imagePullSecrets", Lists.<Object>newArrayList(newLinkedHashMap("name", imagePullSecretName)));
+ podSpec.put("restartPolicy", "Never");
+
+ if (!getNodeSelector().isEmpty())
+ podSpec.put("nodeSelector", toMap(getNodeSelector()));
+
+ Map<Object, Object> buildDirVolume = newLinkedHashMap(
+ "name", "build-dir",
+ "persistentVolumeClaim", newLinkedHashMap(
+ "claimName", "build-dir"));
+ List<Object> volumes = newArrayList(buildDirVolume);
+ if (trustCertsConfigMapCreated) {
+ volumes.add(newLinkedHashMap(
+ "name", "trust-certs",
+ "configMap", newLinkedHashMap(
+ "name", "trust-certs")));
+ }
+ podSpec.put("volumes", volumes);
- Map<Object, Object> podDef = newLinkedHashMap(
- "apiVersion", "v1",
- "kind", "Pod",
- "metadata", newLinkedHashMap(
- "name", POD_NAME,
- "namespace", namespace),
- "spec", podSpec);
-
- createResource(this::newKubectl, podDef, Sets.newHashSet(), jobLogger);
-
- String podFQN = namespace + "/" + POD_NAME;
-
- AtomicReference<String> nodeNameRef = new AtomicReference<>(null);
+ Map<Object, Object> podDef = newLinkedHashMap(
+ "apiVersion", "v1",
+ "kind", "Pod",
+ "metadata", newLinkedHashMap(
+ "name", POD_NAME,
+ "namespace", namespace),
+ "spec", podSpec);
+
+ createResource(this::newKubectl, podDef, Sets.newHashSet(), jobLogger);
+
+ AtomicReference<String> nodeNameRef = new AtomicReference<>(null);
+
+ watchPod(this::newKubectl, namespace, POD_NAME, new PodWatchAbortChecker() {
+
+ @Override
+ public PodWatchAbort check(String nodeName, Collection<JsonNode> containerStatusNodes) {
+ if (nodeName != null) {
+ nodeNameRef.set(nodeName);
+ return new PodWatchAbort(null);
+ } else {
+ return null;
+ }
+ }
- watchPod(this::newKubectl, namespace, POD_NAME, new PodWatchAbortChecker() {
+ }, jobLogger);
- @Override
- public PodWatchAbort check(String nodeName, Collection<JsonNode> containerStatusNodes) {
- if (nodeName != null) {
- nodeNameRef.set(nodeName);
- return new PodWatchAbort(null);
+ notifyJobRunning(jobContext.getBuildId(), null);
+
+ String nodeName = Preconditions.checkNotNull(nodeNameRef.get());
+ jobLogger.log("Running job on node " + nodeName + "...");
+
+ jobLogger.log("Starting job containers...");
+
+ for (String containerName: containerNames) {
+ if (containerName.startsWith("step-")) {
+ var position = parseStepPosition(containerName.substring("step-".length()));
+ try {
+ waitForContainer(namespace, containerName, entryFacade, jobLogger);
+ } catch (Throwable t) {
+ // The container may fail before emitting its start event; duplicate starts are ignored.
+ jobLogger.log(JobHelper.buildStepStartMessage(position));
+ jobLogger.log(JobHelper.buildStepEndMessage(position, JobUtils.getStepOutcome(t)));
+ throw t;
+ }
+ } else {
+ waitForContainer(namespace, containerName, entryFacade, jobLogger);
+ initializationCompleted = true;
+ }
+ }
+ stepsFinished = true;
+ } finally {
+ try {
+ if (initializationCompleted)
+ jobLogger.log(JobUtils.buildPhaseMessage(JobHelper.FINALIZATION));
+ if (stepsFinished)
+ successful = waitForContainer(namespace, "sidecar", entryFacade, jobLogger);
+ } finally {
+ try {
+ if (namespaceCreated)
+ deleteNamespace(namespace, jobLogger);
+ } finally {
+ if (getClusterRole() != null)
+ deleteClusterRoleBinding(namespace, jobLogger);
+ }
+ }
+ }
+ return successful;
+ }
+
+ private boolean waitForContainer(String namespace, String containerName, CompositeFacade entryFacade,
+ TaskLogger jobLogger) {
+ String podFQN = namespace + "/" + POD_NAME;
+ var successful = new AtomicBoolean(true);
+ logger.debug("Waiting for start of container (pod: {}, container: {})...",
+ podFQN, containerName);
+
+ watchPod(this::newKubectl, namespace, POD_NAME, new PodWatchAbortChecker() {
+
+ @Override
+ public PodWatchAbort check(String nodeName, Collection<JsonNode> containerStatusNodes) {
+ var error = getContainerErrors(containerStatusNodes).get(containerName);
+ if (error != null) {
+ /*
+ * For non-fatal errors (command exited with non-zero code), we abort the watch
+ * without an exception, and will continue to collect the container log which
+ * might contain error details
+ */
+ if (error instanceof String) {
+ String errorMessage;
+ if (containerName.startsWith("step-")) {
+ List<Integer> position = parseStepPosition(containerName.substring("step-".length()));
+ errorMessage = "Step \"" + entryFacade.getPathAsString(position) + "\": " + error;
} else {
- return null;
+ errorMessage = "Container \"" + containerName + "\": " + error;
}
+ return new PodWatchAbort(errorMessage);
+ } else {
+ return new PodWatchAbort(null);
}
-
- }, jobLogger);
-
- notifyJobRunning(jobContext.getBuildId(), null);
-
- String nodeName = Preconditions.checkNotNull(nodeNameRef.get());
- jobLogger.log("Running job on node " + nodeName + "...");
-
- jobLogger.log("Starting job containers...");
-
- var successful = new AtomicBoolean(true);
- for (String containerName: containerNames) {
- logger.debug("Waiting for start of container (pod: {}, container: {})...",
- podFQN, containerName);
-
- watchPod(this::newKubectl, namespace, POD_NAME, new PodWatchAbortChecker() {
-
- @Override
- public PodWatchAbort check(String nodeName, Collection<JsonNode> containerStatusNodes) {
- var error = getContainerErrors(containerStatusNodes).get(containerName);
- if (error != null) {
- /*
- * For non-fatal errors (command exited with non-zero code), we abort the watch
- * without an exception, and will continue to collect the container log which
- * might contain error details
- */
- if (error instanceof String) {
- String errorMessage;
- if (containerName.startsWith("step-")) {
- List<Integer> position = parseStepPosition(containerName.substring("step-".length()));
- errorMessage = "Step \"" + entryFacade.getPathAsString(position) + "\": " + error;
- } else {
- errorMessage = "Container \"" + containerName + "\": " + error;
- }
- return new PodWatchAbort(errorMessage);
- } else {
- return new PodWatchAbort(null);
- }
- } else if (getStartedContainers(containerStatusNodes).contains(containerName)) {
- return new PodWatchAbort(null);
- } else {
- return null;
- }
- }
-
- }, jobLogger);
-
- KubernetesExecutor.this.containerName = containerName;
- try {
- logger.debug("Collecting log of container (pod: {}, container: {})...",
- podFQN, containerName);
-
- collectContainerLog(this::newKubectl, namespace, POD_NAME, containerName, new SeenMessage(LOG_END_MESSAGE), jobLogger);
-
- logger.debug("Waiting for stop of container (pod: {}, container: {})...",
- podFQN, containerName);
-
- watchPod(this::newKubectl, namespace, POD_NAME, new PodWatchAbortChecker() {
+ } else if (getStartedContainers(containerStatusNodes).contains(containerName)) {
+ return new PodWatchAbort(null);
+ } else {
+ return null;
+ }
+ }
+
+ }, jobLogger);
+
+ KubernetesExecutor.this.containerName = containerName;
+ try {
+ logger.debug("Collecting log of container (pod: {}, container: {})...",
+ podFQN, containerName);
+
+ collectContainerLog(this::newKubectl, namespace, POD_NAME, containerName, new SeenMessage(LOG_END_MESSAGE), jobLogger);
+
+ logger.debug("Waiting for stop of container (pod: {}, container: {})...",
+ podFQN, containerName);
+
+ watchPod(this::newKubectl, namespace, POD_NAME, new PodWatchAbortChecker() {
- @Override
- public PodWatchAbort check(String nodeName, Collection<JsonNode> containerStatusNodes) {
- var error = getContainerErrors(containerStatusNodes).get(containerName);
- if (error != null) {
- // init container error will prevent other containers to start.
- if (containerName.equals("init")) {
- return new PodWatchAbort(error instanceof Integer
- ? "Container '" + containerName + "' exited with code " + error
- : "Container '" + containerName + "': " + error);
- } else if (containerName.startsWith("step-")) {
- /*
- * Step containers may not run command in case of errors and sidecar container
- * will wait indefinitely on the successful/failed mark file in this case, so
- * we just abort with error
- */
- List<Integer> position = parseStepPosition(containerName.substring("step-".length()));
- var stepPath = entryFacade.getPathAsString(position);
- if (error instanceof Integer)
- return new PodWatchAbort("Step \"" + stepPath + "\": Exited with code " + error);
- else
- return new PodWatchAbort("Step \"" + stepPath + "\": " + error);
- } else {
- if (error instanceof Integer) {
- if ((int)error == 1) {
- successful.set(false);
- return new PodWatchAbort(null);
- } else {
- return new PodWatchAbort("Container \"sidecar\": Exited with code " + error);
- }
- } else {
- return new PodWatchAbort("Container \"sidecar\": " + error);
- }
- }
- } else if (getStoppedContainers(containerStatusNodes).contains(containerName)) {
+ @Override
+ public PodWatchAbort check(String nodeName, Collection<JsonNode> containerStatusNodes) {
+ var error = getContainerErrors(containerStatusNodes).get(containerName);
+ if (error != null) {
+ // init container error will prevent other containers to start.
+ if (containerName.equals("init")) {
+ return new PodWatchAbort(error instanceof Integer
+ ? "Container '" + containerName + "' exited with code " + error
+ : "Container '" + containerName + "': " + error);
+ } else if (containerName.startsWith("step-")) {
+ /*
+ * Step containers may not run command in case of errors and sidecar container
+ * will wait indefinitely on the successful/failed mark file in this case, so
+ * we just abort with error
+ */
+ List<Integer> position = parseStepPosition(containerName.substring("step-".length()));
+ var stepPath = entryFacade.getPathAsString(position);
+ if (error instanceof Integer)
+ return new PodWatchAbort("Step \"" + stepPath + "\": Exited with code " + error);
+ else
+ return new PodWatchAbort("Step \"" + stepPath + "\": " + error);
+ } else {
+ if (error instanceof Integer) {
+ if ((int)error == 1) {
+ successful.set(false);
return new PodWatchAbort(null);
} else {
- return null;
+ return new PodWatchAbort("Container \"sidecar\": Exited with code " + error);
}
+ } else {
+ return new PodWatchAbort("Container \"sidecar\": " + error);
}
-
- }, jobLogger);
- } finally {
- KubernetesExecutor.this.containerName = null;
+ }
+ } else if (getStoppedContainers(containerStatusNodes).contains(containerName)) {
+ return new PodWatchAbort(null);
+ } else {
+ return null;
}
}
- return successful.get();
- } finally {
- deleteNamespace(namespace, jobLogger);
- }
+
+ }, jobLogger);
} finally {
- if (getClusterRole() != null)
- deleteClusterRoleBinding(namespace, jobLogger);
+ KubernetesExecutor.this.containerName = null;
}
+ return successful.get();
}
-
+
private ArrayList<Object> buildVolumeMounts(Map<String, String> cacheMounts) {
var volumeMounts = new ArrayList<>();
for (var entry: cacheMounts.entrySet()) {
@@ -1093,4 +1126,4 @@ public class KubernetesExecutor extends JobExecutor implements KubernetesAware,
}
-}
\ No newline at end of file
+}
diff --git a/server-plugin/server-plugin-executor-serverdocker/src/main/java/io/onedev/server/plugin/executor/serverdocker/ServerDockerExecutor.java b/server-plugin/server-plugin-executor-serverdocker/src/main/java/io/onedev/server/plugin/executor/serverdocker/ServerDockerExecutor.java
index cfd2cf69be..a9aefeed77 100644
--- a/server-plugin/server-plugin-executor-serverdocker/src/main/java/io/onedev/server/plugin/executor/serverdocker/ServerDockerExecutor.java
+++ b/server-plugin/server-plugin-executor-serverdocker/src/main/java/io/onedev/server/plugin/executor/serverdocker/ServerDockerExecutor.java
@@ -26,11 +26,6 @@ import java.util.UUID;
import java.util.concurrent.ExecutionException;
import java.util.concurrent.atomic.AtomicInteger;
-import jakarta.validation.ConstraintValidatorContext;
-import jakarta.validation.Valid;
-import jakarta.validation.constraints.Min;
-import jakarta.validation.constraints.NotEmpty;
-
import org.apache.commons.io.FilenameUtils;
import org.apache.commons.lang3.SystemUtils;
import org.jspecify.annotations.Nullable;
@@ -50,6 +45,7 @@ import io.onedev.k8shelper.CheckoutFacade;
import io.onedev.k8shelper.CloneInfo;
import io.onedev.k8shelper.CommandFacade;
import io.onedev.k8shelper.CompositeFacade;
+import io.onedev.k8shelper.JobHelper;
import io.onedev.k8shelper.LeafFacade;
import io.onedev.k8shelper.LeafHandler;
import io.onedev.k8shelper.PruneBuilderCacheFacade;
@@ -83,6 +79,10 @@ import io.onedev.server.terminal.CommandlineShell;
import io.onedev.server.terminal.Shell;
import io.onedev.server.validation.Validatable;
import io.onedev.server.web.util.Testable;
+import jakarta.validation.ConstraintValidatorContext;
+import jakarta.validation.Valid;
+import jakarta.validation.constraints.Min;
+import jakarta.validation.constraints.NotEmpty;
@Editable(order=ServerDockerExecutor.ORDER, name="Server Docker Executor",
description="This executor runs build jobs as docker containers on OneDev server")
@@ -306,295 +306,307 @@ public class ServerDockerExecutor extends JobExecutor implements DockerAware, Te
@Override
public boolean run(TaskLogger jobLogger) {
+ return executeJob(jobLogger);
+ }
+
+ private boolean executeJob(TaskLogger jobLogger) {
notifyJobRunning(jobContext.getBuildId(), null);
checkApplicable();
var buildDir = getBuildDir(Bootstrap.getTempDir(), jobContext.getProjectId(),
jobContext.getBuildNumber(), jobContext.getSubmitSequence());
FileUtils.createDir(buildDir);
+ var cacheProvisioners = new ArrayList<CacheProvisioner>();
+ boolean successful = false;
+ boolean initializationCompleted = false;
+ String network = "build-"+ getName() + "-" + jobContext.getProjectId() + "-"
+ + jobContext.getBuildNumber() + "-" + jobContext.getSubmitSequence();
+ boolean networkCreated = false;
SecretMasker.push(jobContext.getSecretMasker());
try {
- String network = "build-"+ getName() + "-" + jobContext.getProjectId() + "-"
- + jobContext.getBuildNumber() + "-" + jobContext.getSubmitSequence();
-
String localServer = getClusterService().getLocalServerAddress();
jobLogger.log(String.format("Executing job (executor: %s, server: %s, network: %s)...",
getName(), localServer, network));
JobUtils.createNetwork(newDocker(), network, getNetworkOptions(), jobLogger);
- try {
- var jobToken = jobContext.getJobToken();
- for (var jobService : jobContext.getServices()) {
- var docker = newDocker();
- var registryLogins = merge(jobService.getRegistryLogins(), getRegistryLogins(jobToken));
- callWithRegistryLogins(docker, registryLogins, () -> {
- JobUtils.startService(docker, network, jobService, getCpuLimit(), getMemoryLimit(), jobLogger);
- return null;
- });
- }
+ networkCreated = true;
+ var jobToken = jobContext.getJobToken();
+ for (var jobService : jobContext.getServices()) {
+ var docker = newDocker();
+ var registryLogins = merge(jobService.getRegistryLogins(), getRegistryLogins(jobToken));
+ callWithRegistryLogins(docker, registryLogins, () -> {
+ JobUtils.startService(docker, network, jobService, getCpuLimit(), getMemoryLimit(), jobLogger);
+ return null;
+ });
+ }
- File hostWorkDir = new File(buildDir, "work");
- FileUtils.createDir(hostWorkDir);
-
- var cacheProvisioners = new ArrayList<CacheProvisioner>();
-
- jobLogger.log("Copying job dependencies...");
- getJobService().copyDependencies(jobContext, hostWorkDir);
-
- var containerBuildDirPath = BUILD_PATH;
- var containerWorkDirPath = BUILD_PATH + "/work";
- var containerTrustCertsFilePath = BUILD_PATH + "/trust-certs.pem";
-
- var osIds = getOsIds(jobLogger);
- getJobService().reportJobWorkDir(jobContext, containerWorkDirPath);
- CompositeFacade entryFacade = new CompositeFacade(jobContext.getActions());
- var cacheConfigIndex = new AtomicInteger(1);
- var pulledImages = new HashSet<String>();
- var successful = entryFacade.execute(new LeafHandler() {
-
- private int runStepContainer(Commandline docker, String image, String runAs,
- @Nullable String entrypoint, List<String> arguments,
- Map<String, String> environments, @Nullable String workingDir,
- Map<String, String> volumeMounts, List<Integer> position, boolean useTTY) {
- containerName = network + "-step-" + stringifyStepPosition(position);
- try {
- docker.args("run", "--name=" + containerName, "--network=" + network);
- if (isAlwaysPullImage() && pulledImages.add(image))
- docker.addArgs("--pull=always");
-
- docker.addArgs("--user", runAs);
-
- if (getCpuLimit() != null)
- docker.addArgs("--cpus", getCpuLimit());
- if (getMemoryLimit() != null)
- docker.addArgs("--memory", getMemoryLimit());
- if (getRunOptions() != null)
- docker.addArgs(StringUtils.parseQuoteTokens(getRunOptions()));
-
- docker.addArgs("-v", getHostPath(buildDir.getAbsolutePath()) + ":" + containerBuildDirPath);
-
- for (Map.Entry<String, String> entry : volumeMounts.entrySet()) {
- if (entry.getKey().contains(".."))
- throw new ExplicitException("Volume mount source path should not contain '..'");
- String hostPath = getHostPath(new File(hostWorkDir, entry.getKey()).getAbsolutePath());
- docker.addArgs("-v", hostPath + ":" + entry.getValue());
- }
+ File hostWorkDir = new File(buildDir, "work");
+ FileUtils.createDir(hostWorkDir);
+
+ jobLogger.log("Copying job dependencies...");
+ getJobService().copyDependencies(jobContext, hostWorkDir);
+
+ var containerBuildDirPath = BUILD_PATH;
+ var containerWorkDirPath = BUILD_PATH + "/work";
+ var containerTrustCertsFilePath = BUILD_PATH + "/trust-certs.pem";
+
+ var osIds = getOsIds(jobLogger);
+ getJobService().reportJobWorkDir(jobContext, containerWorkDirPath);
+ CompositeFacade entryFacade = new CompositeFacade(jobContext.getActions());
+ var cacheConfigIndex = new AtomicInteger(1);
+ var pulledImages = new HashSet<String>();
+ initializationCompleted = true;
+ successful = entryFacade.execute(new LeafHandler() {
+
+ private int runStepContainer(Commandline docker, String image, String runAs,
+ @Nullable String entrypoint, List<String> arguments,
+ Map<String, String> environments, @Nullable String workingDir,
+ Map<String, String> volumeMounts, List<Integer> position, boolean useTTY) {
+ containerName = network + "-step-" + stringifyStepPosition(position);
+ try {
+ docker.args("run", "--name=" + containerName, "--network=" + network);
+ if (isAlwaysPullImage() && pulledImages.add(image))
+ docker.addArgs("--pull=always");
+
+ docker.addArgs("--user", runAs);
+
+ if (getCpuLimit() != null)
+ docker.addArgs("--cpus", getCpuLimit());
+ if (getMemoryLimit() != null)
+ docker.addArgs("--memory", getMemoryLimit());
+ if (getRunOptions() != null)
+ docker.addArgs(StringUtils.parseQuoteTokens(getRunOptions()));
+
+ docker.addArgs("-v", getHostPath(buildDir.getAbsolutePath()) + ":" + containerBuildDirPath);
+
+ for (Map.Entry<String, String> entry : volumeMounts.entrySet()) {
+ if (entry.getKey().contains(".."))
+ throw new ExplicitException("Volume mount source path should not contain '..'");
+ String hostPath = getHostPath(new File(hostWorkDir, entry.getKey()).getAbsolutePath());
+ docker.addArgs("-v", hostPath + ":" + entry.getValue());
+ }
+
+ if (entrypoint != null)
+ docker.addArgs("-w", containerWorkDirPath);
+ else if (workingDir != null)
+ docker.addArgs("-w", workingDir);
- if (entrypoint != null)
- docker.addArgs("-w", containerWorkDirPath);
- else if (workingDir != null)
- docker.addArgs("-w", workingDir);
-
- for (var cacheProvisioner : cacheProvisioners) {
- for (var path: cacheProvisioner.getConfig().getPaths()) {
- if (FilenameUtils.getPrefixLength(path) > 0) {
- var pathDir = cacheProvisioner.getPathDir(buildDir, path);
- docker.addArgs("-v", getHostPath(pathDir.getAbsolutePath()) + ":" + path);
- }
+ for (var cacheProvisioner : cacheProvisioners) {
+ for (var path: cacheProvisioner.getConfig().getPaths()) {
+ if (FilenameUtils.getPrefixLength(path) > 0) {
+ var pathDir = cacheProvisioner.getPathDir(buildDir, path);
+ docker.addArgs("-v", getHostPath(pathDir.getAbsolutePath()) + ":" + path);
}
}
+ }
- if (isMountDockerSock()) {
- if (getDockerSockPath() != null)
- docker.addArgs("-v", getDockerSockPath() + ":/var/run/docker.sock");
- else
- docker.addArgs("-v", "/var/run/docker.sock:/var/run/docker.sock");
- }
+ if (isMountDockerSock()) {
+ if (getDockerSockPath() != null)
+ docker.addArgs("-v", getDockerSockPath() + ":/var/run/docker.sock");
+ else
+ docker.addArgs("-v", "/var/run/docker.sock:/var/run/docker.sock");
+ }
- for (Map.Entry<String, String> entry : environments.entrySet())
- docker.addArgs("-e", entry.getKey() + "=" + entry.getValue());
+ for (Map.Entry<String, String> entry : environments.entrySet())
+ docker.addArgs("-e", entry.getKey() + "=" + entry.getValue());
- docker.addArgs("-e", "ONEDEV_WORKDIR=" + containerWorkDirPath);
+ docker.addArgs("-e", "ONEDEV_WORKDIR=" + containerWorkDirPath);
- if (useTTY)
- docker.addArgs("-t");
+ if (useTTY)
+ docker.addArgs("-t");
+
+ if (entrypoint != null)
+ docker.addArgs("--entrypoint=" + entrypoint);
+
+ docker.addArgs(image);
+ docker.addArgs(arguments.toArray(new String[0]));
+ docker.processKiller(newDockerKiller(newDocker(), containerName, jobLogger));
+
+ var result = docker.execute(AgentUtils.newInfoLogger(jobLogger),
+ AgentUtils.newWarningLogger(jobLogger), null);
+ return result.getReturnCode();
+ } finally {
+ containerName = null;
+ }
+ }
- if (entrypoint != null)
- docker.addArgs("--entrypoint=" + entrypoint);
-
- docker.addArgs(image);
- docker.addArgs(arguments.toArray(new String[0]));
- docker.processKiller(newDockerKiller(newDocker(), containerName, jobLogger));
-
- var result = docker.execute(AgentUtils.newInfoLogger(jobLogger),
- AgentUtils.newWarningLogger(jobLogger), null);
- return result.getReturnCode();
+ @Override
+ public boolean execute(LeafFacade facade, List<Integer> position) {
+ return JobUtils.runStep(position, jobLogger, () -> {
+ runningStep = facade;
+ try {
+ return doExecute(facade, position);
} finally {
- containerName = null;
+ runningStep = null;
}
- }
-
- @Override
- public boolean execute(LeafFacade facade, List<Integer> position) {
- return JobUtils.runStep(entryFacade, position, jobLogger, () -> {
- runningStep = facade;
- try {
- return doExecute(facade, position);
- } finally {
- runningStep = null;
+ });
+ }
+
+ private boolean doExecute(LeafFacade facade, List<Integer> position) {
+ if (facade instanceof CommandFacade) {
+ CommandFacade commandFacade = ((CommandFacade) facade).replacePlaceholders(buildDir);
+
+ if (commandFacade.getImage() == null) {
+ throw new ExplicitException("This step can only be executed by server shell "
+ + "executor or remote shell executor");
+ }
+ var entrypointArgs = JobUtils.getEntrypointArgs(buildDir, commandFacade, position);
+
+ var docker = newDocker();
+ var registryLogins = merge(commandFacade.getRegistryLogins(), getRegistryLogins(jobToken));
+
+ var runAs = commandFacade.getRunAs();
+ if (SystemUtils.IS_OS_LINUX && !runAs.equals("0:0")) {
+ jobLogger.log("Changing owner of build directory to container user...");
+ changeOwner(docker, runAs, buildDir, osIds, jobLogger);
+ }
+ try {
+ int exitCode = callWithRegistryLogins(docker, registryLogins, () -> {
+ return runStepContainer(docker, commandFacade.getImage(), runAs,
+ "sh", entrypointArgs, commandFacade.getEnvMap(),
+ null, new HashMap<>(), position, commandFacade.isUseTTY());
+ });
+
+ if (exitCode != 0) {
+ jobLogger.error("Command exited with code " + exitCode);
+ return false;
}
- });
- }
-
- private boolean doExecute(LeafFacade facade, List<Integer> position) {
- if (facade instanceof CommandFacade) {
- CommandFacade commandFacade = ((CommandFacade) facade).replacePlaceholders(buildDir);
-
- if (commandFacade.getImage() == null) {
- throw new ExplicitException("This step can only be executed by server shell "
- + "executor or remote shell executor");
+ } finally {
+ if (SystemUtils.IS_OS_LINUX && !osIds.equals("0:0")) {
+ jobLogger.log("Changing owner of build directory to host user...");
+ changeOwner(newDocker(), osIds, buildDir, osIds, jobLogger);
}
- var entrypointArgs = JobUtils.getEntrypointArgs(buildDir, commandFacade, position);
-
- var docker = newDocker();
- var registryLogins = merge(commandFacade.getRegistryLogins(), getRegistryLogins(jobToken));
-
- var runAs = commandFacade.getRunAs();
- if (SystemUtils.IS_OS_LINUX && !runAs.equals("0:0")) {
- jobLogger.log("Changing owner of build directory to container user...");
- changeOwner(docker, runAs, buildDir, osIds, jobLogger);
- }
- try {
- int exitCode = callWithRegistryLogins(docker, registryLogins, () -> {
- return runStepContainer(docker, commandFacade.getImage(), runAs,
- "sh", entrypointArgs, commandFacade.getEnvMap(),
- null, new HashMap<>(), position, commandFacade.isUseTTY());
- });
-
- if (exitCode != 0) {
- jobLogger.error("Command exited with code " + exitCode);
- return false;
- }
- } finally {
- if (SystemUtils.IS_OS_LINUX && !osIds.equals("0:0")) {
- jobLogger.log("Changing owner of build directory to host user...");
- changeOwner(newDocker(), osIds, buildDir, osIds, jobLogger);
- }
- }
- } else if (facade instanceof BuildImageFacade) {
- var buildImageFacade = (BuildImageFacade) facade;
- var docker = newDocker();
- var registryLogins = merge(buildImageFacade.getRegistryLogins(), getRegistryLogins(jobToken));
- callWithRegistryLogins(docker, registryLogins, () -> {
- JobUtils.buildImage(docker, getDockerBuilder(), buildImageFacade, buildDir,
- isAlwaysPullImage(), jobLogger);
- return null;
- });
- } else if (facade instanceof RunImagetoolsFacade) {
- var runImagetoolsFacade = (RunImagetoolsFacade) facade;
- var docker = newDocker();
- var registryLogins = merge(runImagetoolsFacade.getRegistryLogins(), getRegistryLogins(jobToken));
- callWithRegistryLogins(docker, registryLogins, () -> {
- JobUtils.runImagetools(docker, runImagetoolsFacade, buildDir, jobLogger);
- return null;
- });
- } else if (facade instanceof PruneBuilderCacheFacade) {
- var pruneBuilderCacheFacade = (PruneBuilderCacheFacade) facade;
- var docker = newDocker();
- callWithRegistryLogins(docker, new ArrayList<>(), () -> {
- JobUtils.pruneBuilderCache(docker, getDockerBuilder(), pruneBuilderCacheFacade,
- buildDir, jobLogger);
- return null;
+ }
+ } else if (facade instanceof BuildImageFacade) {
+ var buildImageFacade = (BuildImageFacade) facade;
+ var docker = newDocker();
+ var registryLogins = merge(buildImageFacade.getRegistryLogins(), getRegistryLogins(jobToken));
+ callWithRegistryLogins(docker, registryLogins, () -> {
+ JobUtils.buildImage(docker, getDockerBuilder(), buildImageFacade, buildDir,
+ isAlwaysPullImage(), jobLogger);
+ return null;
+ });
+ } else if (facade instanceof RunImagetoolsFacade) {
+ var runImagetoolsFacade = (RunImagetoolsFacade) facade;
+ var docker = newDocker();
+ var registryLogins = merge(runImagetoolsFacade.getRegistryLogins(), getRegistryLogins(jobToken));
+ callWithRegistryLogins(docker, registryLogins, () -> {
+ JobUtils.runImagetools(docker, runImagetoolsFacade, buildDir, jobLogger);
+ return null;
+ });
+ } else if (facade instanceof PruneBuilderCacheFacade) {
+ var pruneBuilderCacheFacade = (PruneBuilderCacheFacade) facade;
+ var docker = newDocker();
+ callWithRegistryLogins(docker, new ArrayList<>(), () -> {
+ JobUtils.pruneBuilderCache(docker, getDockerBuilder(), pruneBuilderCacheFacade,
+ buildDir, jobLogger);
+ return null;
+ });
+ } else if (facade instanceof RunContainerFacade) {
+ RunContainerFacade runContainerFacade = ((RunContainerFacade) facade).replacePlaceholders(buildDir);
+ List<String> arguments = new ArrayList<>();
+ if (runContainerFacade.getArgs() != null)
+ arguments.addAll(Arrays.asList(StringUtils.parseQuoteTokens(runContainerFacade.getArgs())));
+
+ var docker = newDocker();
+ var registryLogins = merge(runContainerFacade.getRegistryLogins(), getRegistryLogins(jobToken));
+
+ var runAs = runContainerFacade.getRunAs();
+ if (SystemUtils.IS_OS_LINUX && !runAs.equals("0:0")) {
+ jobLogger.log("Changing owner of build directory to container user...");
+ changeOwner(docker, runAs, buildDir, osIds, jobLogger);
+ }
+ try {
+ int exitCode = callWithRegistryLogins(docker, registryLogins, () -> {
+ return runStepContainer(docker, runContainerFacade.getImage(), runAs, null,
+ arguments, runContainerFacade.getEnvMap(), runContainerFacade.getWorkingDir(), runContainerFacade.getVolumeMounts(),
+ position, runContainerFacade.isUseTTY());
});
- } else if (facade instanceof RunContainerFacade) {
- RunContainerFacade runContainerFacade = ((RunContainerFacade) facade).replacePlaceholders(buildDir);
- List<String> arguments = new ArrayList<>();
- if (runContainerFacade.getArgs() != null)
- arguments.addAll(Arrays.asList(StringUtils.parseQuoteTokens(runContainerFacade.getArgs())));
-
- var docker = newDocker();
- var registryLogins = merge(runContainerFacade.getRegistryLogins(), getRegistryLogins(jobToken));
-
- var runAs = runContainerFacade.getRunAs();
- if (SystemUtils.IS_OS_LINUX && !runAs.equals("0:0")) {
- jobLogger.log("Changing owner of build directory to container user...");
- changeOwner(docker, runAs, buildDir, osIds, jobLogger);
+ if (exitCode != 0) {
+ jobLogger.error("Container exited with code " + exitCode);
+ return false;
}
- try {
- int exitCode = callWithRegistryLogins(docker, registryLogins, () -> {
- return runStepContainer(docker, runContainerFacade.getImage(), runAs, null,
- arguments, runContainerFacade.getEnvMap(), runContainerFacade.getWorkingDir(), runContainerFacade.getVolumeMounts(),
- position, runContainerFacade.isUseTTY());
- });
- if (exitCode != 0) {
- jobLogger.error("Container exited with code " + exitCode);
- return false;
- }
- } finally {
- if (SystemUtils.IS_OS_LINUX && !osIds.equals("0:0")) {
- jobLogger.log("Changing owner of build directory to host user...");
- changeOwner(newDocker(), osIds, buildDir, osIds, jobLogger);
- }
+ } finally {
+ if (SystemUtils.IS_OS_LINUX && !osIds.equals("0:0")) {
+ jobLogger.log("Changing owner of build directory to host user...");
+ changeOwner(newDocker(), osIds, buildDir, osIds, jobLogger);
}
- } else if (facade instanceof CheckoutFacade) {
- CheckoutFacade checkoutFacade = (CheckoutFacade) facade;
- jobLogger.log("Checking out code...");
-
- var infoLogger = AgentUtils.newInfoLogger(jobLogger);
- var warningLogger = AgentUtils.newWarningLogger(jobLogger);
-
- Commandline git = GitUtils.newGit();
- checkoutFacade.setupWorkingDir(git, hostWorkDir);
-
- initRepository(git, infoLogger, warningLogger);
-
- git.clearArgs();
- setupGitCerts(git, Bootstrap.getTrustCertsDir(),
- new File(buildDir, "trust-certs.pem"),
- containerTrustCertsFilePath, infoLogger, warningLogger);
-
- CloneInfo cloneInfo = checkoutFacade.getCloneInfo();
- cloneInfo.setupGitAuth(git, buildDir, containerBuildDirPath,
- infoLogger, warningLogger);
-
- int cloneDepth = checkoutFacade.getCloneDepth();
-
- var branch = GitUtils.ref2branch(jobContext.getRefName());
- cloneRepository(git, jobContext.getProjectGitDir(), cloneInfo.getCloneUrl(),
- branch, jobContext.getCommitId().name(), checkoutFacade.isWithLfs(),
- checkoutFacade.isWithSubmodules(), cloneDepth, infoLogger, warningLogger);
- } else if (facade instanceof SetupCacheFacade) {
- SetupCacheFacade setupCacheFacade = (SetupCacheFacade) facade;
- var cacheProvisioner = new ServerJobCacheProvisioner(setupCacheFacade.getCacheConfig(), cacheConfigIndex.getAndIncrement(), jobContext);
- cacheProvisioner.download(buildDir, jobLogger);
- cacheProvisioners.add(cacheProvisioner);
- } else if (facade instanceof ServerSideFacade) {
- ServerSideFacade serverSideFacade = (ServerSideFacade) facade;
- return serverSideFacade.execute(buildDir, new ServerSideFacade.Runner() {
-
- @Override
- public ServerStepResult run(File inputDir, Map<String, String> placeholderValues) {
- return getJobService().runServerStep(jobContext, position, inputDir,
- placeholderValues, false, jobLogger);
- }
-
- });
- } else {
- throw new ExplicitException("Unexpected step type: " + facade.getClass());
}
- return true;
- }
+ } else if (facade instanceof CheckoutFacade) {
+ CheckoutFacade checkoutFacade = (CheckoutFacade) facade;
+ jobLogger.log("Checking out code...");
+
+ var infoLogger = AgentUtils.newInfoLogger(jobLogger);
+ var warningLogger = AgentUtils.newWarningLogger(jobLogger);
+
+ Commandline git = GitUtils.newGit();
+ checkoutFacade.setupWorkingDir(git, hostWorkDir);
+
+ initRepository(git, infoLogger, warningLogger);
+
+ git.clearArgs();
+ setupGitCerts(git, Bootstrap.getTrustCertsDir(),
+ new File(buildDir, "trust-certs.pem"),
+ containerTrustCertsFilePath, infoLogger, warningLogger);
+
+ CloneInfo cloneInfo = checkoutFacade.getCloneInfo();
+ cloneInfo.setupGitAuth(git, buildDir, containerBuildDirPath,
+ infoLogger, warningLogger);
+
+ int cloneDepth = checkoutFacade.getCloneDepth();
+
+ var branch = GitUtils.ref2branch(jobContext.getRefName());
+ cloneRepository(git, jobContext.getProjectGitDir(), cloneInfo.getCloneUrl(),
+ branch, jobContext.getCommitId().name(), checkoutFacade.isWithLfs(),
+ checkoutFacade.isWithSubmodules(), cloneDepth, infoLogger, warningLogger);
+ } else if (facade instanceof SetupCacheFacade) {
+ SetupCacheFacade setupCacheFacade = (SetupCacheFacade) facade;
+ var cacheProvisioner = new ServerJobCacheProvisioner(setupCacheFacade.getCacheConfig(), cacheConfigIndex.getAndIncrement(), jobContext);
+ cacheProvisioner.download(buildDir, jobLogger);
+ cacheProvisioners.add(cacheProvisioner);
+ } else if (facade instanceof ServerSideFacade) {
+ ServerSideFacade serverSideFacade = (ServerSideFacade) facade;
+ return serverSideFacade.execute(buildDir, new ServerSideFacade.Runner() {
+
+ @Override
+ public ServerStepResult run(File inputDir, Map<String, String> placeholderValues) {
+ return getJobService().runServerStep(jobContext, position, inputDir,
+ placeholderValues, false, jobLogger);
+ }
- @Override
- public void skip(LeafFacade facade, List<Integer> position) {
- jobLogger.notice("Step \"" + entryFacade.getPathAsString(position) + "\" is skipped");
+ });
+ } else {
+ throw new ExplicitException("Unexpected step type: " + facade.getClass());
}
+ return true;
+ }
+
+ @Override
+ public void skip(LeafFacade facade, List<Integer> position) {
+ jobLogger.log(JobHelper.buildStepSkipMessage(position));
+ }
- }, new ArrayList<>());
+ }, new ArrayList<>());
+ return successful;
+ } finally {
+ try {
+ if (initializationCompleted)
+ jobLogger.log(JobUtils.buildPhaseMessage(JobHelper.FINALIZATION));
if (successful) {
- for (var cacheProvisioner : cacheProvisioners)
+ for (var cacheProvisioner : cacheProvisioners)
cacheProvisioner.upload(buildDir, jobLogger);
}
-
- return successful;
} finally {
- JobUtils.deleteNetwork(newDocker(), network, jobLogger);
- }
- } finally {
- SecretMasker.pop();
- synchronized (buildDir) {
- FileUtils.deleteDir(buildDir, 5);
+ try {
+ if (networkCreated)
+ JobUtils.deleteNetwork(newDocker(), network, jobLogger);
+ } finally {
+ SecretMasker.pop();
+ synchronized (buildDir) {
+ FileUtils.deleteDir(buildDir, 5);
+ }
+ }
}
}
}
@@ -698,4 +710,4 @@ public class ServerDockerExecutor extends JobExecutor implements DockerAware, Te
}
-}
\ No newline at end of file
+}
diff --git a/server-plugin/server-plugin-executor-servershell/src/main/java/io/onedev/server/plugin/executor/servershell/ServerShellExecutor.java b/server-plugin/server-plugin-executor-servershell/src/main/java/io/onedev/server/plugin/executor/servershell/ServerShellExecutor.java
index aefb4e33e4..8f62b632d3 100644
--- a/server-plugin/server-plugin-executor-servershell/src/main/java/io/onedev/server/plugin/executor/servershell/ServerShellExecutor.java
+++ b/server-plugin/server-plugin-executor-servershell/src/main/java/io/onedev/server/plugin/executor/servershell/ServerShellExecutor.java
@@ -9,6 +9,7 @@ import static io.onedev.k8shelper.KubernetesHelper.cloneRepository;
import static io.onedev.k8shelper.KubernetesHelper.initRepository;
import static io.onedev.k8shelper.KubernetesHelper.replacePlaceholders;
import static io.onedev.k8shelper.KubernetesHelper.setupGitCerts;
+import static io.onedev.k8shelper.JobHelper.buildStepSkipMessage;
import java.io.File;
import java.io.IOException;
@@ -34,6 +35,7 @@ import io.onedev.commons.utils.ExplicitException;
import io.onedev.commons.utils.FileUtils;
import io.onedev.commons.utils.TaskLogger;
import io.onedev.commons.utils.command.Commandline;
+import io.onedev.k8shelper.JobHelper;
import io.onedev.k8shelper.BuildImageFacade;
import io.onedev.k8shelper.CacheProvisioner;
import io.onedev.k8shelper.CheckoutFacade;
@@ -138,12 +140,19 @@ public class ServerShellExecutor extends JobExecutor implements Testable<Testabl
@Override
public boolean run(TaskLogger jobLogger) {
+ return executeJob(jobLogger);
+ }
+
+ private boolean executeJob(TaskLogger jobLogger) {
notifyJobRunning(jobContext.getBuildId(), null);
var buildDir = getBuildDir(Bootstrap.getTempDir(), jobContext.getProjectId(),
jobContext.getBuildNumber(), jobContext.getSubmitSequence());
FileUtils.createDir(buildDir);
File workDir = new File(buildDir, "work");
+ var cacheProvisioners = new ArrayList<CacheProvisioner>();
+ boolean successful = false;
+ boolean initializationCompleted = false;
SecretMasker.push(jobContext.getSecretMasker());
try {
String localServer = getClusterService().getLocalServerAddress();
@@ -158,19 +167,18 @@ public class ServerShellExecutor extends JobExecutor implements Testable<Testabl
}
FileUtils.createDir(workDir);
- var cacheProvisioners = new ArrayList<CacheProvisioner>();
-
jobLogger.log("Copying job dependencies...");
getJobService().copyDependencies(jobContext, workDir);
getJobService().reportJobWorkDir(jobContext, workDir.getAbsolutePath());
CompositeFacade entryFacade = new CompositeFacade(jobContext.getActions());
var cacheConfigIndex = new AtomicInteger(1);
- var successful = entryFacade.execute(new LeafHandler() {
+ initializationCompleted = true;
+ successful = entryFacade.execute(new LeafHandler() {
@Override
public boolean execute(LeafFacade facade, List<Integer> position) {
- return JobUtils.runStep(entryFacade, position, jobLogger, () -> {
+ return JobUtils.runStep(position, jobLogger, () -> {
runningStep = facade;
try {
return doExecute(facade, position);
@@ -273,21 +281,25 @@ public class ServerShellExecutor extends JobExecutor implements Testable<Testabl
@Override
public void skip(LeafFacade facade, List<Integer> position) {
- jobLogger.notice("Step \"" + entryFacade.getPathAsString(position) + "\" is skipped");
+ jobLogger.log(buildStepSkipMessage(position));
}
}, new ArrayList<>());
- if (successful) {
- for (var cacheProvisioner : cacheProvisioners)
- cacheProvisioner.upload(buildDir, jobLogger);
- }
-
return successful;
} finally {
- SecretMasker.pop();
- synchronized (buildDir) {
- FileUtils.deleteDir(buildDir, 5);
+ try {
+ if (initializationCompleted)
+ jobLogger.log(JobUtils.buildPhaseMessage(JobHelper.FINALIZATION));
+ if (successful) {
+ for (var cacheProvisioner : cacheProvisioners)
+ cacheProvisioner.upload(buildDir, jobLogger);
+ }
+ } finally {
+ SecretMasker.pop();
+ synchronized (buildDir) {
+ FileUtils.deleteDir(buildDir, 5);
+ }
}
}
}
@@ -356,4 +368,4 @@ public class ServerShellExecutor extends JobExecutor implements Testable<Testabl
}
-}
\ No newline at end of file
+}
diff --git a/server-plugin/server-plugin-sso-discord/src/main/java/io/onedev/server/plugin/sso/discord/oauth2/Request.java b/server-plugin/server-plugin-sso-discord/src/main/java/io/onedev/server/plugin/sso/discord/oauth2/Request.java
index 051a9fb5e1..dfcf846038 100644
--- a/server-plugin/server-plugin-sso-discord/src/main/java/io/onedev/server/plugin/sso/discord/oauth2/Request.java
+++ b/server-plugin/server-plugin-sso-discord/src/main/java/io/onedev/server/plugin/sso/discord/oauth2/Request.java
@@ -93,44 +93,45 @@ public class Request implements Serializable {
}
HttpURLConnection httpConn = (HttpURLConnection)finalURL.openConnection();
- httpConn.setDoOutput(true);
- httpConn.setRequestProperty("User-Agent", USER_AGENT);
-
- if (accessTokenResponse != null && accessTokenResponse.hasValidAccessToken())
- httpConn.setRequestProperty("Authorization", accessTokenResponse.getAuthorizationProperty());
-
- httpConn.setRequestProperty("Accept", ContentType.APPLICATION_JSON.toString());
- httpConn.setRequestMethod(method.name());
-
- if (method.equals(Method.POST)) {
- httpConn.setRequestProperty("Content-Type", ContentType.APPLICATION_FORM_URLENCODED.toString());
-
- if (query != null) {
- OutputStreamWriter writer = new OutputStreamWriter(httpConn.getOutputStream());
- writer.write(query);
- writer.close();
+ try {
+ httpConn.setDoOutput(true);
+ httpConn.setRequestProperty("User-Agent", USER_AGENT);
+
+ if (accessTokenResponse != null && accessTokenResponse.hasValidAccessToken())
+ httpConn.setRequestProperty("Authorization", accessTokenResponse.getAuthorizationProperty());
+
+ httpConn.setRequestProperty("Accept", ContentType.APPLICATION_JSON.toString());
+ httpConn.setRequestMethod(method.name());
+
+ if (method.equals(Method.POST)) {
+ httpConn.setRequestProperty("Content-Type", ContentType.APPLICATION_FORM_URLENCODED.toString());
+
+ if (query != null) {
+ try (var output = httpConn.getOutputStream();
+ var writer = new OutputStreamWriter(output)) {
+ writer.write(query);
+ }
+ }
}
+
+ return httpConn;
+ } catch (IOException | RuntimeException | Error e) {
+ httpConn.disconnect();
+ throw e;
}
-
- return httpConn;
}
private static String readContent(HttpURLConnection httpConn) throws IOException {
- BufferedReader buffer = new BufferedReader(new InputStreamReader(httpConn.getInputStream()));
- StringBuffer response = new StringBuffer();
-
- try {
+ try (var input = httpConn.getInputStream();
+ var buffer = new BufferedReader(new InputStreamReader(input))) {
+ StringBuffer response = new StringBuffer();
String inputLine;
while ((inputLine = buffer.readLine()) != null) {
response.append(inputLine);
}
- buffer.close();
- } catch (IOException e) {
- throw e;
+ return response.toString();
} finally {
httpConn.disconnect();
}
-
- return response.toString();
}
}