The Unified and Autonomous Development Platform
chore: Refactoring authorization of job secrets
Robin Shen2566ea5f6bac
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.javaindex 4a0cdf2833..8b398c13e9 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@@ -6456,7 +6456,17 @@ public class DataMigrator {}}for (File file : dataDir.listFiles()) {- if (file.getName().startsWith("Iterations.xml")) {+ if (file.getName().startsWith("Projects.xml")) {+ VersionedXmlDoc dom = VersionedXmlDoc.fromFile(file);+ for (Element element : dom.getRootElement().elements()) {+ var buildSettingElement = element.element("buildSetting");+ for (var secretElement : buildSettingElement.element("jobSecrets").elements()) {+ if (secretElement.element("authorization") == null)+ secretElement.addElement("authorization").setText("on branch(\"**\")");+ }+ }+ dom.writeToFile(file, false);+ } else if (file.getName().startsWith("Iterations.xml")) {VersionedXmlDoc dom = VersionedXmlDoc.fromFile(file);for (Element element : dom.getRootElement().elements())element.setName("io.onedev.server.model.Iteration");@@ -6538,6 +6548,8 @@ public class DataMigrator {"\"Milestone\" is", "\"Iteration\" is");content = StringUtils.replace(content,"\"Milestone\" is", "\"Iteration\" is");+ content = StringUtils.replace(content,+ "non-pull-request commits", "on branch(\"**\")");FileUtils.writeStringToFile(file, content, UTF_8);} catch (IOException e) {throw new RuntimeException(e);diff --git a/server-core/src/main/java/io/onedev/server/entitymanager/impl/DefaultPullRequestManager.java b/server-core/src/main/java/io/onedev/server/entitymanager/impl/DefaultPullRequestManager.javaindex 8ac413f9a0..86d41234ff 100644--- a/server-core/src/main/java/io/onedev/server/entitymanager/impl/DefaultPullRequestManager.java+++ b/server-core/src/main/java/io/onedev/server/entitymanager/impl/DefaultPullRequestManager.java@@ -69,6 +69,7 @@ import java.io.Serializable;import java.util.*;import java.util.stream.Collectors;+import static com.google.common.base.Preconditions.checkNotNull;import static io.onedev.server.model.PullRequest.getSerialLockName;import static io.onedev.server.model.support.pullrequest.MergeStrategy.*;@@ -252,9 +253,8 @@ public class DefaultPullRequestManager extends BaseEntityManager<PullRequest>@Transactional@Overridepublic void merge(PullRequest request, String commitMessage) {- MergePreview mergePreview = Preconditions.checkNotNull(request.checkMergePreview());- ObjectId mergeCommitId = ObjectId.fromString(- Preconditions.checkNotNull(mergePreview.getMergeCommitHash()));+ MergePreview mergePreview = checkNotNull(request.checkMergePreview());+ ObjectId mergeCommitId = ObjectId.fromString(checkNotNull(mergePreview.getMergeCommitHash()));User user = SecurityUtils.getUser();PersonIdent person = user.asPerson();diff --git a/server-core/src/main/java/io/onedev/server/job/DefaultJobManager.java b/server-core/src/main/java/io/onedev/server/job/DefaultJobManager.javaindex e8cfebbceb..66881267de 100644--- a/server-core/src/main/java/io/onedev/server/job/DefaultJobManager.java+++ b/server-core/src/main/java/io/onedev/server/job/DefaultJobManager.java@@ -76,7 +76,6 @@ import io.onedev.server.web.editable.EditableUtils;import nl.altindag.ssl.SSLFactory;import org.apache.shiro.authz.UnauthorizedException;import org.apache.shiro.subject.Subject;-import org.apache.wicket.util.collections.ConcurrentHashSet;import org.eclipse.jgit.lib.ObjectId;import org.joda.time.DateTime;import org.quartz.CronExpression;@@ -106,6 +105,7 @@ import java.util.concurrent.*;import java.util.concurrent.atomic.AtomicReference;import java.util.concurrent.locks.Lock;+import static com.google.common.base.Preconditions.checkNotNull;import static io.onedev.k8shelper.KubernetesHelper.BUILD_VERSION;import static io.onedev.k8shelper.KubernetesHelper.replacePlaceholders;import static io.onedev.server.buildspec.param.ParamUtils.resolveParams;@@ -314,7 +314,7 @@ public class DefaultJobManager implements JobManager, Runnable, CodePullAuthorizif (builds.isEmpty()) {for (Map.Entry<String, List<String>> entry : paramMap.entrySet()) {- ParamSpec paramSpec = Preconditions.checkNotNull(build.getJob().getParamSpecMap().get(entry.getKey()));+ ParamSpec paramSpec = checkNotNull(build.getJob().getParamSpecMap().get(entry.getKey()));if (!entry.getValue().isEmpty()) {for (String string : entry.getValue()) {BuildParam param = new BuildParam();@@ -795,7 +795,7 @@ public class DefaultJobManager implements JobManager, Runnable, CodePullAuthorizbuildParamManager.deleteParams(build);for (Map.Entry<String, List<String>> entry : build.getParamMap().entrySet()) {ParamSpec paramSpec = build.getJob().getParamSpecMap().get(entry.getKey());- Preconditions.checkNotNull(paramSpec);+ checkNotNull(paramSpec);String type = paramSpec.getType();List<String> values = entry.getValue();if (!values.isEmpty()) {diff --git a/server-core/src/main/java/io/onedev/server/job/JobAuthorizationContext.java b/server-core/src/main/java/io/onedev/server/job/JobAuthorizationContext.javaindex 53a9f83a97..f4b4262c6f 100644--- a/server-core/src/main/java/io/onedev/server/job/JobAuthorizationContext.java+++ b/server-core/src/main/java/io/onedev/server/job/JobAuthorizationContext.java@@ -6,7 +6,7 @@ import io.onedev.server.buildspecmodel.inputspec.SecretInput;import io.onedev.server.entitymanager.AccessTokenManager;import io.onedev.server.job.match.JobMatch;import io.onedev.server.job.match.JobMatchContext;-import io.onedev.server.job.match.NonPullRequestCommitsCriteria;+import io.onedev.server.job.match.OnBranchCriteria;import io.onedev.server.model.Project;import io.onedev.server.model.PullRequest;import io.onedev.server.model.User;@@ -82,24 +82,26 @@ public class JobAuthorizationContext {for (JobSecret secret: project.getHierarchyJobSecrets()) {if (secret.getName().equals(secretName)) {String authorization = secret.getAuthorization();- if (authorization == null)- authorization = new NonPullRequestCommitsCriteria().toString();- JobMatch jobMatch = JobMatch.parse(authorization, false, false);- if (request != null) {- if (project.equals(request.getSourceProject())) {- JobMatchContext sourceMatchContext = new JobMatchContext(project, request.getSourceBranch(), null, request.getSubmitter(), null);- JobMatchContext targetMatchContext = new JobMatchContext(project, request.getTargetBranch(), null, request.getSubmitter(), null);- if (jobMatch.matches(sourceMatchContext) && jobMatch.matches(targetMatchContext))- return normalizeSecretValue(secret.getValue());+ if (authorization == null) {+ return normalizeSecretValue(secret.getValue());+ } else {+ JobMatch jobMatch = JobMatch.parse(authorization, false, false);+ if (request != null) {+ if (project.equals(request.getSourceProject())) {+ JobMatchContext sourceMatchContext = new JobMatchContext(project, request.getSourceBranch(), null, request.getSubmitter(), null);+ JobMatchContext targetMatchContext = new JobMatchContext(project, request.getTargetBranch(), null, request.getSubmitter(), null);+ if (jobMatch.matches(sourceMatchContext) && jobMatch.matches(targetMatchContext))+ return normalizeSecretValue(secret.getValue());+ } else {+ JobMatchContext matchContext = new JobMatchContext(project, null, commitId, request.getSubmitter(), null);+ if (jobMatch.matches(matchContext))+ return normalizeSecretValue(secret.getValue());+ }} else {- JobMatchContext matchContext = new JobMatchContext(project, null, null, request.getSubmitter(), null);+ JobMatchContext matchContext = new JobMatchContext(project, null, commitId, user, null);if (jobMatch.matches(matchContext))return normalizeSecretValue(secret.getValue());}- } else {- JobMatchContext matchContext = new JobMatchContext(project, null, commitId, user, null);- if (jobMatch.matches(matchContext))- return normalizeSecretValue(secret.getValue());}}}diff --git a/server-core/src/main/java/io/onedev/server/job/match/JobMatch.g4 b/server-core/src/main/java/io/onedev/server/job/match/JobMatch.g4index 9d6e06bd61..9cfa83b333 100644--- a/server-core/src/main/java/io/onedev/server/job/match/JobMatch.g4+++ b/server-core/src/main/java/io/onedev/server/job/match/JobMatch.g4@@ -5,8 +5,7 @@ jobMatch;criteria- : NonPullRequestCommits #OperatorCriteria- | operator=(OnBranch|SubmittedByUser|SubmittedByGroup) WS+ criteriaValue=Quoted #OperatorValueCriteria+ : operator=(OnBranch|SubmittedByUser|SubmittedByGroup) WS+ criteriaValue=Quoted #OperatorValueCriteria| criteriaField=Quoted WS+ operator=(Is|IsNot) WS+ criteriaValue=Quoted #FieldOperatorValueCriteria| criteria WS+ And WS+ criteria #AndCriteria| criteria WS+ Or WS+ criteria #OrCriteria@@ -14,10 +13,6 @@ criteria| LParens WS* criteria WS* RParens #ParensCriteria;-NonPullRequestCommits- : 'non-pull-request' WS+ 'commits'- ;-OnBranch: 'on' WS+ 'branch';diff --git a/server-core/src/main/java/io/onedev/server/job/match/JobMatch.java b/server-core/src/main/java/io/onedev/server/job/match/JobMatch.javaindex ae8354f4b0..675ff96ddf 100644--- a/server-core/src/main/java/io/onedev/server/job/match/JobMatch.java+++ b/server-core/src/main/java/io/onedev/server/job/match/JobMatch.java@@ -97,11 +97,6 @@ public class JobMatch extends Criteria<JobMatchContext> {throw new ExplicitException("Unexpected operator: " + ctx.operator.getText());}}-- @Override- public Criteria<io.onedev.server.job.match.JobMatchContext> visitOperatorCriteria(JobMatchParser.OperatorCriteriaContext ctx) {- return new NonPullRequestCommitsCriteria();- }@Overridepublic Criteria<io.onedev.server.job.match.JobMatchContext> visitOrCriteria(JobMatchParser.OrCriteriaContext ctx) {diff --git a/server-core/src/main/java/io/onedev/server/job/match/NonPullRequestCommitsCriteria.java b/server-core/src/main/java/io/onedev/server/job/match/NonPullRequestCommitsCriteria.javadeleted file mode 100644index a87c8c354e..0000000000--- a/server-core/src/main/java/io/onedev/server/job/match/NonPullRequestCommitsCriteria.java+++ /dev/null@@ -1,30 +0,0 @@-package io.onedev.server.job.match;--import io.onedev.server.util.criteria.Criteria;--import javax.persistence.criteria.CriteriaBuilder;-import javax.persistence.criteria.CriteriaQuery;-import javax.persistence.criteria.From;-import javax.persistence.criteria.Predicate;--public class NonPullRequestCommitsCriteria extends Criteria<JobMatchContext> {-- private static final long serialVersionUID = 1L;-- @Override- public boolean matches(JobMatchContext context) {- return context.getCommitId() != null;- }-- @Override- public String toStringWithoutParens() {- return "non-pull-request commits";- }-- @Override- public Predicate getPredicate(CriteriaQuery<?> query, From<JobMatchContext, JobMatchContext> from,- CriteriaBuilder builder) {- throw new UnsupportedOperationException();- }--}diff --git a/server-core/src/main/java/io/onedev/server/model/PullRequest.java b/server-core/src/main/java/io/onedev/server/model/PullRequest.javaindex c52372d31a..e125189ce0 100644--- a/server-core/src/main/java/io/onedev/server/model/PullRequest.java+++ b/server-core/src/main/java/io/onedev/server/model/PullRequest.java@@ -34,7 +34,6 @@ import org.apache.commons.lang3.StringUtils;import org.eclipse.jgit.lib.ObjectId;import org.eclipse.jgit.revwalk.RevCommit;import org.hibernate.annotations.DynamicUpdate;-import org.hibernate.annotations.OptimisticLock;import javax.annotation.Nullable;import javax.persistence.*;@@ -173,17 +172,14 @@ public class PullRequest extends ProjectBelonging@Api(order=100)@Column(nullable=false, length=MAX_TITLE_LEN)- @OptimisticLock(excluded=true)private String title;@Column(length=MAX_DESCRIPTION_LEN)- @OptimisticLock(excluded=true)@Api(description = "May be null")private String description;@ManyToOne(fetch=FetchType.LAZY)@JoinColumn(nullable=false)- @OptimisticLock(excluded=true)private User submitter;@ManyToOne(fetch=FetchType.LAZY)@@ -213,7 +209,6 @@ public class PullRequest extends ProjectBelonging// used for title search in markdown editor@Column(nullable=false)@JsonIgnore- @OptimisticLock(excluded=true)private String noSpaceTitle;@JsonIgnore@@ -221,7 +216,6 @@ public class PullRequest extends ProjectBelongingprivate MergePreview mergePreview;@Column(nullable=false)- @OptimisticLock(excluded=true)private Date submitDate = new Date();@Column(nullable=false)@@ -232,7 +226,6 @@ public class PullRequest extends ProjectBelongingprivate long number;- @OptimisticLock(excluded=true)private int commentCount;@Embedded@@ -242,17 +235,8 @@ public class PullRequest extends ProjectBelongingprivate Date codeCommentsUpdateDate;@Column(length=MAX_CHECK_ERROR_LEN)- @OptimisticLock(excluded=true)private String checkError;- /*- * Add version check in order to prevent sending MergePreviewCalculated event- * after pull request is discarded- */- @Version- @JsonIgnore- private int revision;-@OneToMany(mappedBy="request", cascade=CascadeType.REMOVE)private Collection<PullRequestLabel> labels = new ArrayList<>();diff --git a/server-core/src/main/java/io/onedev/server/model/support/build/JobSecret.java b/server-core/src/main/java/io/onedev/server/model/support/build/JobSecret.javaindex 25d758a36f..a28e1f0760 100644--- a/server-core/src/main/java/io/onedev/server/model/support/build/JobSecret.java+++ b/server-core/src/main/java/io/onedev/server/model/support/build/JobSecret.java@@ -4,6 +4,7 @@ import io.onedev.server.annotation.Editable;import io.onedev.server.annotation.JobMatch;import io.onedev.server.annotation.Multiline;import io.onedev.server.annotation.SecretName;+import io.onedev.server.job.match.OnBranchCriteria;import javax.validation.constraints.NotEmpty;import java.io.Serializable;@@ -17,7 +18,7 @@ public class JobSecret implements Serializable {private String value;- private String authorization;+ private String authorization = new OnBranchCriteria("**").toString();private boolean archived;@@ -43,8 +44,9 @@ public class JobSecret implements Serializable {this.value = value;}- @Editable(order=300, placeholder="Non-pull-request commits", description=- "Optionally specify branches/users/groups allowed to access this secret")+ @Editable(order=300, placeholder="Any job", description= "" ++ "Optionally specify branches/users/groups allowed to access this secret. If left empty, " ++ "any job can access this secret, including those triggered via external pull requests")@JobMatchpublic String getAuthorization() {return authorization;diff --git a/server-core/src/main/java/io/onedev/server/web/behavior/JobMatchBehavior.java b/server-core/src/main/java/io/onedev/server/web/behavior/JobMatchBehavior.javaindex f98a9e92e0..99f5d58685 100644--- a/server-core/src/main/java/io/onedev/server/web/behavior/JobMatchBehavior.java+++ b/server-core/src/main/java/io/onedev/server/web/behavior/JobMatchBehavior.java@@ -71,7 +71,7 @@ public class JobMatchBehavior extends ANTLRAssistBehavior {return SuggestionUtils.suggestJobs(Project.get(), matchWith);}} else if (operator == OnBranch) {- if (Project.get() != null)+ if (Project.get() != null && !matchWith.contains("*") && !matchWith.contains("?"))return SuggestionUtils.suggestBranches(Project.get(), matchWith);} else if (operator == SubmittedByUser) {return SuggestionUtils.suggestUsers(matchWith);diff --git a/server-core/src/main/java/io/onedev/server/web/page/project/setting/build/JobSecretsPage.java b/server-core/src/main/java/io/onedev/server/web/page/project/setting/build/JobSecretsPage.javaindex 6743de7d77..3fa35c6af9 100644--- a/server-core/src/main/java/io/onedev/server/web/page/project/setting/build/JobSecretsPage.java+++ b/server-core/src/main/java/io/onedev/server/web/page/project/setting/build/JobSecretsPage.java@@ -173,7 +173,7 @@ public class JobSecretsPage extends ProjectBuildSettingPage {if (rowModel.getObject().getAuthorization() != null)cellItem.add(new Label(componentId, rowModel.getObject().getAuthorization()));else- cellItem.add(new Label(componentId, "<i>non-pull-request commits</i>").setEscapeModelStrings(false));+ cellItem.add(new Label(componentId, "<i>Any job</i>").setEscapeModelStrings(false));}});