Skip to content

The Unified and Autonomous Development Platform

Fix issue #234 - Cron trigger for build spec job

Robin Shen42b66bcd8f3a
diff --git a/server-core/src/main/java/io/onedev/server/buildspec/job/DefaultJobManager.java b/server-core/src/main/java/io/onedev/server/buildspec/job/DefaultJobManager.java
index 52620e266c..856e9df8e1 100644
--- a/server-core/src/main/java/io/onedev/server/buildspec/job/DefaultJobManager.java
+++ b/server-core/src/main/java/io/onedev/server/buildspec/job/DefaultJobManager.java
@@ -36,6 +36,8 @@ import org.apache.commons.lang3.StringUtils;
import org.apache.shiro.subject.Subject;
import org.apache.shiro.util.ThreadContext;
import org.eclipse.jgit.lib.ObjectId;
+import org.quartz.CronScheduleBuilder;
+import org.quartz.ScheduleBuilder;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
@@ -60,20 +62,27 @@ import io.onedev.server.buildspec.job.paramspec.ParamSpec;
import io.onedev.server.buildspec.job.paramspec.SecretParam;
import io.onedev.server.buildspec.job.paramsupply.ParamSupply;
import io.onedev.server.buildspec.job.retrycondition.RetryCondition;
+import io.onedev.server.buildspec.job.trigger.JobTrigger;
+import io.onedev.server.buildspec.job.trigger.ScheduleTrigger;
import io.onedev.server.entitymanager.BuildManager;
import io.onedev.server.entitymanager.BuildParamManager;
import io.onedev.server.entitymanager.ProjectManager;
import io.onedev.server.entitymanager.SettingManager;
import io.onedev.server.entitymanager.UserManager;
+import io.onedev.server.event.ProjectCreated;
import io.onedev.server.event.ProjectEvent;
+import io.onedev.server.event.RefUpdated;
+import io.onedev.server.event.ScheduledTimeReaches;
import io.onedev.server.event.build.BuildFinished;
import io.onedev.server.event.build.BuildPending;
import io.onedev.server.event.build.BuildRetrying;
import io.onedev.server.event.build.BuildRunning;
import io.onedev.server.event.build.BuildSubmitted;
import io.onedev.server.event.entity.EntityPersisted;
+import io.onedev.server.event.entity.EntityRemoved;
import io.onedev.server.event.system.SystemStarted;
import io.onedev.server.event.system.SystemStopping;
+import io.onedev.server.git.GitUtils;
import io.onedev.server.model.Build;
import io.onedev.server.model.Build.Status;
import io.onedev.server.model.BuildDependence;
@@ -97,6 +106,8 @@ import io.onedev.server.util.CommitAware;
import io.onedev.server.util.MatrixRunner;
import io.onedev.server.util.SimpleLogger;
import io.onedev.server.util.patternset.PatternSet;
+import io.onedev.server.util.schedule.SchedulableTask;
+import io.onedev.server.util.schedule.TaskScheduler;
import io.onedev.server.util.script.identity.JobIdentity;
import io.onedev.server.util.script.identity.ScriptIdentity;
@@ -111,6 +122,8 @@ public class DefaultJobManager implements JobManager, Runnable, CodePullAuthoriz
private final Map<Long, JobExecution> jobExecutions = new ConcurrentHashMap<>();
+ private final Map<Long, Collection<String>> scheduledTasks = new ConcurrentHashMap<>();
+
private final ProjectManager projectManager;
private final BuildManager buildManager;
@@ -131,6 +144,8 @@ public class DefaultJobManager implements JobManager, Runnable, CodePullAuthoriz
private final BuildParamManager buildParamManager;
+ private final TaskScheduler taskScheduler;
+
private final Validator validator;
private volatile List<JobExecutor> jobExecutors;
@@ -141,7 +156,7 @@ public class DefaultJobManager implements JobManager, Runnable, CodePullAuthoriz
public DefaultJobManager(BuildManager buildManager, UserManager userManager, ListenerRegistry listenerRegistry,
SettingManager settingManager, TransactionManager transactionManager, LogManager logManager,
ExecutorService executorService, SessionManager sessionManager, BuildParamManager buildParamManager,
- ProjectManager projectManager, Validator validator) {
+ ProjectManager projectManager, Validator validator, TaskScheduler taskScheduler) {
this.settingManager = settingManager;
this.buildManager = buildManager;
this.userManager = userManager;
@@ -153,6 +168,7 @@ public class DefaultJobManager implements JobManager, Runnable, CodePullAuthoriz
this.buildParamManager = buildParamManager;
this.projectManager = projectManager;
this.validator = validator;
+ this.taskScheduler = taskScheduler;
}
private void validate(Project project, ObjectId commitId) {
@@ -670,7 +686,7 @@ public class DefaultJobManager implements JobManager, Runnable, CodePullAuthoriz
@Transactional
@Override
- public void resubmit(Build build, Map<String, List<String>> paramMap) {
+ public void resubmit(Build build, Map<String, List<String>> paramMap, String resubmitReason) {
if (build.isFinished()) {
validate(build.getProject(), build.getCommitId());
@@ -681,7 +697,7 @@ public class DefaultJobManager implements JobManager, Runnable, CodePullAuthoriz
build.setRunningDate(null);
build.setSubmitDate(new Date());
build.setSubmitter(SecurityUtils.getUser());
- build.setSubmitReason("Resubmitted manually");
+ build.setSubmitReason(resubmitReason);
build.setCanceller(null);
build.setCancellerName(null);
@@ -768,11 +784,137 @@ public class DefaultJobManager implements JobManager, Runnable, CodePullAuthoriz
}
}
+ @Sessional
@Listen
public void on(SystemStarted event) {
jobExecutors = settingManager.getJobExecutors();
thread = new Thread(this);
- thread.start();
+ thread.start();
+
+ for (Project project: projectManager.query())
+ schedule(project);
+ }
+
+ @Transactional
+ @Listen
+ public void on(EntityRemoved event) {
+ if (event.getEntity() instanceof Project) {
+ Long projectId = ((Project) event.getEntity()).getId();
+ transactionManager.runAfterCommit(new Runnable() {
+
+ @Override
+ public void run() {
+ Collection<String> tasksOfProject = scheduledTasks.remove(projectId);
+ if (tasksOfProject != null)
+ tasksOfProject.stream().forEach(it->taskScheduler.unschedule(it));
+ }
+
+ });
+ }
+ }
+
+ @Sessional
+ @Listen
+ public void on(RefUpdated event) {
+ String branch = GitUtils.ref2branch(event.getRefName());
+ Project project = event.getProject();
+ if (branch != null && branch.equals(project.getDefaultBranch()) && !event.getNewCommitId().equals(ObjectId.zeroId()))
+ schedule(project);
+ }
+
+ @Transactional
+ @Listen
+ public void on(ProjectCreated event) {
+ Long projectId = event.getProject().getId();
+ transactionManager.runAfterCommit(new Runnable() {
+
+ @Override
+ public void run() {
+ sessionManager.runAsync(new Runnable() {
+
+ @Override
+ public void run() {
+ Project project = projectManager.load(projectId);
+ schedule(project);
+ }
+
+ });
+ }
+
+ });
+ }
+
+ @Sessional
+ @Override
+ public void schedule(Project project) {
+ Collection<String> tasksOfProject = new HashSet<>();
+ try {
+ String defaultBranch = project.getDefaultBranch();
+ if (defaultBranch != null) {
+ ObjectId commitId = project.getObjectId(defaultBranch, false);
+ if (commitId != null) {
+ BuildSpec buildSpec = project.getBuildSpec(commitId);
+ if (buildSpec != null) {
+ ScheduledTimeReaches event = new ScheduledTimeReaches(project);
+ for (Job job: buildSpec.getJobs()) {
+ for (JobTrigger trigger: job.getTriggers()) {
+ if (trigger instanceof ScheduleTrigger) {
+ ScheduleTrigger scheduledTrigger = (ScheduleTrigger) trigger;
+ SubmitReason reason = trigger.matches(event, job);
+ if (reason != null) {
+ String taskId = taskScheduler.schedule(newSchedulableTask(project, commitId, job, scheduledTrigger, reason));
+ tasksOfProject.add(taskId);
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ } catch (Exception e) {
+ logger.error("Error scheduling project '" + project.getName() + "'", e);
+ } finally {
+ tasksOfProject = scheduledTasks.put(project.getId(), tasksOfProject);
+ if (tasksOfProject != null)
+ tasksOfProject.stream().forEach(it->taskScheduler.unschedule(it));
+ }
+ }
+
+ private SchedulableTask newSchedulableTask(Project project, ObjectId commitId, Job job,
+ ScheduleTrigger trigger, SubmitReason reason) {
+ Long projectId = project.getId();
+ return new SchedulableTask() {
+
+ @Override
+ public void execute() {
+ sessionManager.run(new Runnable() {
+
+ @Override
+ public void run() {
+ ThreadContext.bind(userManager.getSystem().asSubject());
+
+ Project project = projectManager.load(projectId);
+ new MatrixRunner<List<String>>(ParamSupply.getParamMatrix(trigger.getParams(), null)) {
+
+ @Override
+ public void run(Map<String, List<String>> paramMap) {
+ Build build = submit(project, commitId, job.getName(), paramMap, reason);
+ if (build.isFinished())
+ resubmit(build, paramMap, "Resubmitted by schedule");
+ }
+
+ }.run();
+ }
+
+ });
+ }
+
+ @Override
+ public ScheduleBuilder<?> getScheduleBuilder() {
+ return CronScheduleBuilder.cronSchedule(trigger.getCronExpression());
+ }
+
+ };
}
@Listen
@@ -785,6 +927,8 @@ public class DefaultJobManager implements JobManager, Runnable, CodePullAuthoriz
} catch (InterruptedException e) {
}
}
+ scheduledTasks.values().stream().forEach(it1->it1.stream().forEach(it2->taskScheduler.unschedule(it2)));
+ scheduledTasks.clear();
}
@Override
diff --git a/server-core/src/main/java/io/onedev/server/buildspec/job/JobManager.java b/server-core/src/main/java/io/onedev/server/buildspec/job/JobManager.java
index 842352faa4..7226d6f9a8 100644
--- a/server-core/src/main/java/io/onedev/server/buildspec/job/JobManager.java
+++ b/server-core/src/main/java/io/onedev/server/buildspec/job/JobManager.java
@@ -13,10 +13,12 @@ import io.onedev.server.model.Project;
public interface JobManager {
+ void schedule(Project project);
+
Build submit(Project project, ObjectId commitId, String jobName,
Map<String, List<String>> paramMap, SubmitReason reason);
- void resubmit(Build build, Map<String, List<String>> paramMap);
+ void resubmit(Build build, Map<String, List<String>> paramMap, String resubmitReason);
void cancel(Build build);
diff --git a/server-core/src/main/java/io/onedev/server/buildspec/job/trigger/JobTrigger.java b/server-core/src/main/java/io/onedev/server/buildspec/job/trigger/JobTrigger.java
index a477c398aa..5cb5108549 100644
--- a/server-core/src/main/java/io/onedev/server/buildspec/job/trigger/JobTrigger.java
+++ b/server-core/src/main/java/io/onedev/server/buildspec/job/trigger/JobTrigger.java
@@ -101,4 +101,5 @@ public abstract class JobTrigger implements Serializable {
public abstract SubmitReason matchesWithoutProject(ProjectEvent event, Job job);
public abstract String getDescriptionWithoutProject();
+
}
diff --git a/server-core/src/main/java/io/onedev/server/buildspec/job/trigger/ScheduleTrigger.java b/server-core/src/main/java/io/onedev/server/buildspec/job/trigger/ScheduleTrigger.java
new file mode 100644
index 0000000000..38ec753859
--- /dev/null
+++ b/server-core/src/main/java/io/onedev/server/buildspec/job/trigger/ScheduleTrigger.java
@@ -0,0 +1,64 @@
+package io.onedev.server.buildspec.job.trigger;
+
+import org.hibernate.validator.constraints.NotEmpty;
+
+import io.onedev.server.buildspec.job.Job;
+import io.onedev.server.buildspec.job.SubmitReason;
+import io.onedev.server.event.ProjectEvent;
+import io.onedev.server.event.ScheduledTimeReaches;
+import io.onedev.server.git.GitUtils;
+import io.onedev.server.model.PullRequest;
+import io.onedev.server.util.validation.annotation.CronExpression;
+import io.onedev.server.web.editable.annotation.Editable;
+
+@Editable(order=600, name="Cron schedule")
+public class ScheduleTrigger extends JobTrigger {
+
+ private static final long serialVersionUID = 1L;
+
+ private String cronExpression;
+
+ @Editable(order=100, description="Specify a <a target='_blank' href='http://www.quartz-scheduler.org/documentation/quartz-2.3.0/tutorials/crontrigger.html#format'>cron schedule</a> to "
+ + "fire the job automatically. <b>Note:</b> this is only applicable to default branch")
+ @CronExpression
+ @NotEmpty
+ public String getCronExpression() {
+ return cronExpression;
+ }
+
+ public void setCronExpression(String cronExpression) {
+ this.cronExpression = cronExpression;
+ }
+
+ @Override
+ public SubmitReason matchesWithoutProject(ProjectEvent event, Job job) {
+ if (event instanceof ScheduledTimeReaches) {
+ return new SubmitReason() {
+
+ @Override
+ public String getRefName() {
+ return GitUtils.branch2ref(event.getProject().getDefaultBranch());
+ }
+
+ @Override
+ public PullRequest getPullRequest() {
+ return null;
+ }
+
+ @Override
+ public String getDescription() {
+ return "Scheduled time reaches";
+ }
+
+ };
+ } else {
+ return null;
+ }
+ }
+
+ @Override
+ public String getDescriptionWithoutProject() {
+ return "Schedule at " + cronExpression;
+ }
+
+}
diff --git a/server-core/src/main/java/io/onedev/server/entitymanager/impl/DefaultProjectManager.java b/server-core/src/main/java/io/onedev/server/entitymanager/impl/DefaultProjectManager.java
index fcf442079b..072192eff6 100644
--- a/server-core/src/main/java/io/onedev/server/entitymanager/impl/DefaultProjectManager.java
+++ b/server-core/src/main/java/io/onedev/server/entitymanager/impl/DefaultProjectManager.java
@@ -47,6 +47,7 @@ import io.onedev.commons.launcher.loader.ListenerRegistry;
import io.onedev.commons.utils.ExceptionUtils;
import io.onedev.commons.utils.FileUtils;
import io.onedev.commons.utils.StringUtils;
+import io.onedev.server.buildspec.job.JobManager;
import io.onedev.server.entitymanager.BuildManager;
import io.onedev.server.entitymanager.GroupManager;
import io.onedev.server.entitymanager.ProjectManager;
@@ -113,6 +114,8 @@ public class DefaultProjectManager extends BaseEntityManager<Project>
private final TransactionManager transactionManager;
+ private final JobManager jobManager;
+
private final TaskScheduler taskScheduler;
private final ListenerRegistry listenerRegistry;
@@ -135,7 +138,7 @@ public class DefaultProjectManager extends BaseEntityManager<Project>
SettingManager settingManager, TransactionManager transactionManager,
SessionManager sessionManager, ListenerRegistry listenerRegistry,
TaskScheduler taskScheduler, UserAuthorizationManager userAuthorizationManager,
- RoleManager roleManager) {
+ RoleManager roleManager, JobManager jobManager) {
super(dao);
this.commitInfoManager = commitInfoManager;
@@ -149,6 +152,7 @@ public class DefaultProjectManager extends BaseEntityManager<Project>
this.taskScheduler = taskScheduler;
this.userAuthorizationManager = userAuthorizationManager;
this.roleManager = roleManager;
+ this.jobManager = jobManager;
try (InputStream is = getClass().getClassLoader().getResourceAsStream("git-receive-hook")) {
Preconditions.checkNotNull(is);
@@ -193,6 +197,7 @@ public class DefaultProjectManager extends BaseEntityManager<Project>
jobExecutor.onRenameProject(oldName, project.getName());
for (GroovyScript groovyScript: settingManager.getGroovyScripts())
groovyScript.onRenameProject(oldName, project.getName());
+ jobManager.schedule(project);
}
}
diff --git a/server-core/src/main/java/io/onedev/server/event/ScheduledTimeReaches.java b/server-core/src/main/java/io/onedev/server/event/ScheduledTimeReaches.java
new file mode 100644
index 0000000000..745ebced8f
--- /dev/null
+++ b/server-core/src/main/java/io/onedev/server/event/ScheduledTimeReaches.java
@@ -0,0 +1,21 @@
+package io.onedev.server.event;
+
+import java.util.Date;
+
+import io.onedev.server.model.Project;
+
+public class ScheduledTimeReaches extends ProjectEvent {
+
+ public ScheduledTimeReaches(Project project) {
+ super(null, new Date(), project);
+ }
+
+ @Override
+ public String getActivity(boolean withEntity) {
+ String activity = "Scheduled time reaches ";
+ if (withEntity)
+ activity += " in project " + getProject().getName();
+ return activity;
+ }
+
+}
diff --git a/server-core/src/main/java/io/onedev/server/model/Project.java b/server-core/src/main/java/io/onedev/server/model/Project.java
index 2d07c6d912..4ed6ecc67d 100644
--- a/server-core/src/main/java/io/onedev/server/model/Project.java
+++ b/server-core/src/main/java/io/onedev/server/model/Project.java
@@ -72,6 +72,7 @@ import io.onedev.commons.utils.LockUtils;
import io.onedev.commons.utils.StringUtils;
import io.onedev.server.OneDev;
import io.onedev.server.buildspec.BuildSpec;
+import io.onedev.server.buildspec.job.JobManager;
import io.onedev.server.entitymanager.BuildManager;
import io.onedev.server.entitymanager.BuildQuerySettingManager;
import io.onedev.server.entitymanager.CodeCommentQuerySettingManager;
@@ -535,6 +536,8 @@ public class Project extends AbstractEntity {
RefUpdate refUpdate = GitUtils.getRefUpdate(getRepository(), "HEAD");
GitUtils.linkRef(refUpdate, GitUtils.branch2ref(defaultBranchName));
defaultBranchOptional = null;
+
+ OneDev.getInstance(JobManager.class).schedule(this);
}
private Map<BlobIdent, Optional<Blob>> getBlobCache() {
diff --git a/server-core/src/main/java/io/onedev/server/util/validation/CronExpressionValidator.java b/server-core/src/main/java/io/onedev/server/util/validation/CronExpressionValidator.java
new file mode 100644
index 0000000000..5d9dff3721
--- /dev/null
+++ b/server-core/src/main/java/io/onedev/server/util/validation/CronExpressionValidator.java
@@ -0,0 +1,35 @@
+package io.onedev.server.util.validation;
+
+import java.text.ParseException;
+
+import javax.validation.ConstraintValidator;
+import javax.validation.ConstraintValidatorContext;
+
+import io.onedev.server.util.validation.annotation.CronExpression;
+
+public class CronExpressionValidator implements ConstraintValidator<CronExpression, String> {
+
+ private String message;
+
+ @Override
+ public void initialize(CronExpression constaintAnnotation) {
+ message = constaintAnnotation.message();
+ }
+
+ @Override
+ public boolean isValid(String value, ConstraintValidatorContext constraintContext) {
+ if (value != null) {
+ try {
+ new org.quartz.CronExpression(value);
+ return true;
+ } catch (ParseException pe) {
+ constraintContext.disableDefaultConstraintViolation();
+ constraintContext.buildConstraintViolationWithTemplate(message + ": " + pe.getMessage()).addConstraintViolation();
+ return false;
+ }
+ } else {
+ return true;
+ }
+ }
+
+}
diff --git a/server-core/src/main/java/io/onedev/server/util/validation/annotation/CronExpression.java b/server-core/src/main/java/io/onedev/server/util/validation/annotation/CronExpression.java
new file mode 100644
index 0000000000..6e8ab44c0a
--- /dev/null
+++ b/server-core/src/main/java/io/onedev/server/util/validation/annotation/CronExpression.java
@@ -0,0 +1,33 @@
+/*
+ * Copyright OneDev Inc.,
+ * Date: 2008-2-28
+ * All rights reserved.
+ *
+ * Revision: $Id: PathElement.java 1209 2008-07-28 00:16:18Z robin $
+ */
+package io.onedev.server.util.validation.annotation;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+import javax.validation.Constraint;
+import javax.validation.Payload;
+
+import io.onedev.server.util.validation.CronExpressionValidator;
+
+/**
+ * @author robin
+ */
+@Target({ElementType.METHOD})
+@Retention(RetentionPolicy.RUNTIME)
+@Constraint(validatedBy=CronExpressionValidator.class)
+public @interface CronExpression {
+
+ String message() default "Invalid cron expression";
+
+ Class<?>[] groups() default {};
+
+ Class<? extends Payload>[] payload() default {};
+}
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 8c07db1247..534798271e 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
@@ -234,7 +234,7 @@ public abstract class BuildDetailPage extends ProjectPage
private void resubmit(Serializable paramBean) {
Map<String, List<String>> paramMap = ParamSupply.getParamMap(getBuild().getJob(), paramBean,
getBuild().getJob().getParamSpecMap().keySet());
- OneDev.getInstance(JobManager.class).resubmit(getBuild(), paramMap);
+ OneDev.getInstance(JobManager.class).resubmit(getBuild(), paramMap, "Resubmitted manually");
setResponsePage(BuildDashboardPage.class, BuildDashboardPage.paramsOf(getBuild()));
}