Skip to content

The Unified and Autonomous Development Platform

Add TriggerJobResource

Robin Shen78287d34b16c
diff --git a/server-core/src/main/java/io/onedev/server/buildspec/step/PullRepository.java b/server-core/src/main/java/io/onedev/server/buildspec/step/PullRepository.java
index e14020337d..b8700a6074 100644
--- a/server-core/src/main/java/io/onedev/server/buildspec/step/PullRepository.java
+++ b/server-core/src/main/java/io/onedev/server/buildspec/step/PullRepository.java
@@ -42,7 +42,7 @@ public class PullRepository extends MirrorRepository {
private String refs = "refs/heads/* refs/tags/*";
@Editable(order=410, description="Specify space separated refs to pull from remote. '*' can be used in ref "
- + "name for wildcard match"
+ + "name for wildcard match<br>"
+ "<b class='text-danger'>NOTE:</b> branch/tag protection rule will be ignored when update "
+ "branches/tags via this step")
@NotEmpty
@@ -60,6 +60,8 @@ public class PullRepository extends MirrorRepository {
if (!project.isCommitOnBranches(build.getCommitId(), project.getDefaultBranch()))
throw new ExplicitException("For security reason, this step is only allowed to run from default branch");
+ String remoteUrl = getRemoteUrlWithCredential(build);
+
Commandline git = newGit(project);
String defaultBranch = project.getDefaultBranch();
@@ -69,7 +71,7 @@ public class PullRepository extends MirrorRepository {
git.addArgs("fetch");
- git.addArgs(getRemoteUrlWithCredential(build));
+ git.addArgs(remoteUrl);
if (isForce())
git.addArgs("--force");
@@ -122,7 +124,7 @@ public class PullRepository extends MirrorRepository {
for (List<ObjectId> batch: Lists.partition(lfsFetchCommitIds, LFS_FETCH_BATCH)) {
git.clearArgs();
- git.addArgs("lfs", "fetch", getRemoteUrlWithCredential(build));
+ git.addArgs("lfs", "fetch", remoteUrl);
for (ObjectId commitId: batch)
git.addArgs(commitId.name());
git.execute(new LineConsumer() {
diff --git a/server-core/src/main/java/io/onedev/server/rest/TriggerJobResource.java b/server-core/src/main/java/io/onedev/server/rest/TriggerJobResource.java
new file mode 100644
index 0000000000..851850781f
--- /dev/null
+++ b/server-core/src/main/java/io/onedev/server/rest/TriggerJobResource.java
@@ -0,0 +1,165 @@
+package io.onedev.server.rest;
+
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+import java.util.UUID;
+
+import javax.inject.Inject;
+import javax.inject.Singleton;
+import javax.ws.rs.Consumes;
+import javax.ws.rs.GET;
+import javax.ws.rs.POST;
+import javax.ws.rs.Path;
+import javax.ws.rs.Produces;
+import javax.ws.rs.QueryParam;
+import javax.ws.rs.core.Context;
+import javax.ws.rs.core.MediaType;
+import javax.ws.rs.core.UriInfo;
+
+import org.apache.shiro.authz.UnauthorizedException;
+import org.apache.shiro.util.ThreadContext;
+import org.eclipse.jgit.revwalk.RevCommit;
+import org.hibernate.validator.constraints.NotEmpty;
+
+import io.onedev.commons.utils.StringUtils;
+import io.onedev.server.buildspec.job.JobManager;
+import io.onedev.server.buildspec.job.SubmitReason;
+import io.onedev.server.entitymanager.ProjectManager;
+import io.onedev.server.entitymanager.UserManager;
+import io.onedev.server.git.GitUtils;
+import io.onedev.server.model.Project;
+import io.onedev.server.model.PullRequest;
+import io.onedev.server.model.User;
+import io.onedev.server.rest.annotation.Api;
+import io.onedev.server.rest.exception.InvalidParamException;
+import io.onedev.server.security.SecurityUtils;
+
+@Api(order=3510, description="This resource provides an alternative way to run job by passing all parameters via url")
+@Path("/trigger-job")
+@Consumes(MediaType.WILDCARD)
+@Produces(MediaType.APPLICATION_JSON)
+@Singleton
+public class TriggerJobResource {
+
+ private static final String PARAM_PROJECT = "project";
+
+ private static final String PARAM_BRANCH = "branch";
+
+ private static final String PARAM_TAG = "tag";
+
+ private static final String PARAM_JOB = "job";
+
+ private static final String PARAM_ACCESS_TOKEN = "access-token";
+
+ private static final String DESCRIPTION = "Trigger specified job. Query parameters other than below will be "
+ + "interpreted as job params";
+
+ private static final String REF_DESCRIPTION = "Either branch or tag should be specified, but not both";
+
+ private static final String ACCESS_TOKEN_DESCRIPTION = "OneDev access token with permission to trigger the job";
+
+ private final JobManager jobManager;
+
+ private final ProjectManager projectManager;
+
+ private final UserManager userManager;
+
+ @Inject
+ public TriggerJobResource(JobManager jobManager, ProjectManager projectManager, UserManager userManager) {
+ this.jobManager = jobManager;
+ this.projectManager = projectManager;
+ this.userManager = userManager;
+ }
+
+ @Api(order=100, description=DESCRIPTION)
+ @GET
+ public Long triggerJobViaGet(
+ @Api(description="Path of the project") @QueryParam(PARAM_PROJECT) @NotEmpty String projectPath,
+ @Api(description=REF_DESCRIPTION) @QueryParam(PARAM_BRANCH) String branch,
+ @Api(description=REF_DESCRIPTION) @QueryParam(PARAM_TAG) String tag,
+ @QueryParam(PARAM_JOB) @NotEmpty String job,
+ @Api(description=ACCESS_TOKEN_DESCRIPTION) @QueryParam(PARAM_ACCESS_TOKEN) @NotEmpty String accessToken,
+ @Context UriInfo uriInfo) {
+ return triggerJob(projectPath, branch, tag, job, accessToken, uriInfo);
+ }
+
+ @Api(order=100, description=DESCRIPTION)
+ @POST
+ public Long triggerJobViaPost(
+ @Api(description="Path of the project") @QueryParam(PARAM_PROJECT) @NotEmpty String projectPath,
+ @Api(description=REF_DESCRIPTION) @QueryParam(PARAM_BRANCH) String branch,
+ @Api(description=REF_DESCRIPTION) @QueryParam(PARAM_TAG) String tag,
+ @QueryParam(PARAM_JOB) @NotEmpty String job,
+ @Api(description=ACCESS_TOKEN_DESCRIPTION) @QueryParam(PARAM_ACCESS_TOKEN) @NotEmpty String accessToken,
+ @Context UriInfo uriInfo) {
+ return triggerJob(projectPath, branch, tag, job, accessToken, uriInfo);
+ }
+
+ private Long triggerJob(String projectPath, String branch, String tag, String job,
+ String accessToken, UriInfo uriInfo) {
+ Project project = projectManager.findByPath(projectPath);
+ if (project == null)
+ throw new InvalidParamException("Project not found: " + projectPath);
+
+ User user = userManager.findByAccessToken(accessToken);
+ if (user == null)
+ throw new InvalidParamException("Invalid access token");
+
+ ThreadContext.bind(user.asSubject());
+ try {
+ if (!SecurityUtils.canRunJob(project, job))
+ throw new UnauthorizedException();
+
+ if (StringUtils.isBlank(branch) && StringUtils.isBlank(tag))
+ throw new InvalidParamException("Either branch or tag should be specified");
+
+ if (StringUtils.isNotBlank(branch) && StringUtils.isNotBlank(tag))
+ throw new InvalidParamException("Either branch or tag should be specified, but not both");
+
+ String refName;
+ if (branch != null)
+ refName = GitUtils.branch2ref(branch);
+ else
+ refName = GitUtils.tag2ref(tag);
+
+ RevCommit commit = project.getRevCommit(refName, false);
+ if (commit == null)
+ throw new InvalidParamException("Ref not found: " + refName);
+
+ Map<String, List<String>> jobParams = new HashMap<>();
+ for (Map.Entry<String, List<String>> entry: uriInfo.getQueryParameters().entrySet()) {
+ if (!entry.getKey().equals(PARAM_PROJECT) && !entry.getKey().equals(PARAM_BRANCH)
+ && !entry.getKey().equals(PARAM_TAG) && !entry.getKey().equals(PARAM_JOB)
+ && !entry.getKey().equals(PARAM_ACCESS_TOKEN)) {
+ jobParams.put(entry.getKey(), entry.getValue());
+ }
+ }
+
+ SubmitReason reason = new SubmitReason() {
+
+ @Override
+ public String getRefName() {
+ return refName;
+ }
+
+ @Override
+ public PullRequest getPullRequest() {
+ return null;
+ }
+
+ @Override
+ public String getDescription() {
+ return "Triggered via restful api";
+ }
+
+ };
+
+ return jobManager.submit(project, commit.copy(), job,
+ jobParams, UUID.randomUUID().toString(), reason).getId();
+ } finally {
+ ThreadContext.unbindSubject();
+ }
+ }
+
+}
diff --git a/server-core/src/main/java/io/onedev/server/rest/jersey/AnonymousCheckFilter.java b/server-core/src/main/java/io/onedev/server/rest/jersey/AnonymousCheckFilter.java
index b5d107c154..6bcb53590c 100644
--- a/server-core/src/main/java/io/onedev/server/rest/jersey/AnonymousCheckFilter.java
+++ b/server-core/src/main/java/io/onedev/server/rest/jersey/AnonymousCheckFilter.java
@@ -13,6 +13,7 @@ import javax.ws.rs.ext.Provider;
import org.apache.shiro.authz.UnauthenticatedException;
import io.onedev.server.entitymanager.SettingManager;
+import io.onedev.server.rest.TriggerJobResource;
import io.onedev.server.rest.annotation.Api;
import io.onedev.server.security.SecurityUtils;
@@ -35,7 +36,8 @@ public class AnonymousCheckFilter implements ContainerRequestFilter {
@Override
public void filter(ContainerRequestContext requestContext) throws IOException {
Api api = resourceInfo.getResourceClass().getAnnotation(Api.class);
- if ((api == null || !api.internal()) && SecurityUtils.getUser() == null) {
+ if ((api == null || !api.internal()) && SecurityUtils.getUser() == null
+ && resourceInfo.getResourceClass() != TriggerJobResource.class) {
String method = request.getMethod();
if (method.equals("POST") || method.equals("DELETE") || method.equals("PUT")
|| !settingManager.getSecuritySetting().isEnableAnonymousAccess()) {
diff --git a/server-core/src/main/java/io/onedev/server/rest/jersey/JerseyApplication.java b/server-core/src/main/java/io/onedev/server/rest/jersey/JerseyApplication.java
index dfd66a553a..10649b1e91 100644
--- a/server-core/src/main/java/io/onedev/server/rest/jersey/JerseyApplication.java
+++ b/server-core/src/main/java/io/onedev/server/rest/jersey/JerseyApplication.java
@@ -34,7 +34,7 @@ public class JerseyApplication extends ResourceConfig {
// add the default Jackson exception mappers
register(JacksonFeature.class);
- packages(JerseyApplication.class.getPackage().getName(), "io.swagger.v3.jaxrs2.integration.resources");
+ packages(JerseyApplication.class.getPackage().getName());
for (JerseyConfigurator configurator: AppLoader.getExtensions(JerseyConfigurator.class)) {
configurator.configure(this);
diff --git a/server-core/src/main/java/io/onedev/server/rest/jersey/ParamCheckFilter.java b/server-core/src/main/java/io/onedev/server/rest/jersey/ParamCheckFilter.java
index 0a5ebb272a..16d1817ddd 100644
--- a/server-core/src/main/java/io/onedev/server/rest/jersey/ParamCheckFilter.java
+++ b/server-core/src/main/java/io/onedev/server/rest/jersey/ParamCheckFilter.java
@@ -17,6 +17,7 @@ import javax.ws.rs.ext.Provider;
import org.hibernate.validator.constraints.NotEmpty;
+import io.onedev.server.rest.TriggerJobResource;
import io.onedev.server.rest.exception.InvalidParamException;
@Provider
@@ -41,10 +42,12 @@ public class ParamCheckFilter implements ContainerRequestFilter {
}
}
- Set<String> suppliedQueryParams = new HashSet<>(uriInfo.getQueryParameters().keySet());
- suppliedQueryParams.removeAll(definedQueryParams);
- if (!suppliedQueryParams.isEmpty())
- throw new InvalidParamException("Unexpected query params: " + suppliedQueryParams);
+ if (resourceInfo.getResourceClass() != TriggerJobResource.class) {
+ Set<String> suppliedQueryParams = new HashSet<>(uriInfo.getQueryParameters().keySet());
+ suppliedQueryParams.removeAll(definedQueryParams);
+ if (!suppliedQueryParams.isEmpty())
+ throw new InvalidParamException("Unexpected query params: " + suppliedQueryParams);
+ }
requiredQueryParams.removeAll(uriInfo.getQueryParameters().keySet());
if (!requiredQueryParams.isEmpty())
@@ -57,4 +60,5 @@ public class ParamCheckFilter implements ContainerRequestFilter {
|| param.getAnnotation(NotEmpty.class) != null
|| param.getAnnotation(Size.class)!=null && param.getAnnotation(Size.class).min()>0;
}
+
}
diff --git a/server-core/src/main/java/io/onedev/server/web/page/help/ApiHelpUtils.java b/server-core/src/main/java/io/onedev/server/web/page/help/ApiHelpUtils.java
index 1e2c0974a2..99035c6210 100644
--- a/server-core/src/main/java/io/onedev/server/web/page/help/ApiHelpUtils.java
+++ b/server-core/src/main/java/io/onedev/server/web/page/help/ApiHelpUtils.java
@@ -35,9 +35,9 @@ import io.onedev.server.model.AbstractEntity;
import io.onedev.server.rest.annotation.Api;
import io.onedev.server.util.BeanUtils;
import io.onedev.server.util.ReflectionUtils;
-import io.onedev.server.web.page.layout.ContributedAdministrationSetting;
import io.onedev.server.web.page.help.ValueInfo.Origin;
import io.onedev.server.web.page.layout.AdministrationSettingContribution;
+import io.onedev.server.web.page.layout.ContributedAdministrationSetting;
import io.onedev.server.web.page.project.setting.ContributedProjectSetting;
import io.onedev.server.web.page.project.setting.ProjectSettingContribution;
diff --git a/server-core/src/main/java/io/onedev/server/web/page/help/MethodDetailPage.java b/server-core/src/main/java/io/onedev/server/web/page/help/MethodDetailPage.java
index d43427a38f..7b8d187f1b 100644
--- a/server-core/src/main/java/io/onedev/server/web/page/help/MethodDetailPage.java
+++ b/server-core/src/main/java/io/onedev/server/web/page/help/MethodDetailPage.java
@@ -12,6 +12,7 @@ import javax.annotation.Nullable;
import javax.ws.rs.Path;
import javax.ws.rs.PathParam;
import javax.ws.rs.QueryParam;
+import javax.ws.rs.core.Context;
import javax.ws.rs.core.Response;
import org.apache.wicket.Component;
@@ -32,6 +33,7 @@ import io.onedev.commons.utils.StringUtils;
import io.onedev.commons.utils.WordUtils;
import io.onedev.server.OneDev;
import io.onedev.server.entitymanager.SettingManager;
+import io.onedev.server.rest.TriggerJobResource;
import io.onedev.server.rest.annotation.Api;
import io.onedev.server.rest.jersey.ParamCheckFilter;
import io.onedev.server.web.component.link.ViewStateAwarePageLink;
@@ -89,8 +91,11 @@ public class MethodDetailPage extends ApiHelpPage {
@Nullable
private Parameter getRequestBodyParam() {
for (Parameter param: getResourceMethod().getParameters()) {
- if (param.getAnnotation(PathParam.class) == null && param.getAnnotation(QueryParam.class) == null)
+ if (param.getAnnotation(PathParam.class) == null
+ && param.getAnnotation(QueryParam.class) == null
+ && param.getAnnotation(Context.class) == null) {
return param;
+ }
}
return null;
}
@@ -349,9 +354,11 @@ public class MethodDetailPage extends ApiHelpPage {
}
}
- StringBuilder curlExample = new StringBuilder();
+ StringBuilder curlExample = new StringBuilder("$ curl ");
- curlExample.append("$ curl -u <login name>:<password or access token> ");
+ if (resourceClass != TriggerJobResource.class)
+ curlExample.append("-u <login name>:<password or access token> ");
+
if (!queryParams.isEmpty())
curlExample.append("-G ");
diff --git a/server-product/system/conf/logback.xml b/server-product/system/conf/logback.xml
index cb725a9fb2..fccc2363c9 100644
--- a/server-product/system/conf/logback.xml
+++ b/server-product/system/conf/logback.xml
@@ -21,6 +21,7 @@
</triggeringPolicy>
</appender>
+ <logger name="org.glassfish.jersey.servlet.WebComponent" level="ERROR"/>
<logger name="org.apache.wicket" level="WARN"/>
<logger name="org.apache.wicket.request.cycle.RequestCycle" level="OFF"/>
<logger name="RequestCycleExtra" level="OFF"/>