Skip to content

The Unified and Autonomous Development Platform

chore: Use branch/tag instead of refName in job project dependency definition

Robin Shen0960198ce398
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 1e1b2c0ef9..aca1d7bf5f 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
@@ -15,6 +15,7 @@ import java.util.function.Consumer;
import java.util.function.Function;
import org.apache.commons.lang3.SerializationUtils;
+import org.eclipse.jgit.lib.Constants;
import org.jspecify.annotations.Nullable;
import org.yaml.snakeyaml.DumperOptions.FlowStyle;
import org.yaml.snakeyaml.nodes.MappingNode;
@@ -2855,4 +2856,65 @@ public class BuildSpec implements Serializable, Validatable {
});
}
+ @SuppressWarnings("unused")
+ private void migrate56(VersionedYamlDoc doc, Stack<Integer> versions) {
+ for (var specTuple : doc.getValue()) {
+ if (((ScalarNode) specTuple.getKeyNode()).getValue().equals("jobs")) {
+ for (var jobNode : ((SequenceNode) specTuple.getValueNode()).getValue()) {
+ for (var jobTuple : ((MappingNode) jobNode).getValue()) {
+ if (((ScalarNode) jobTuple.getKeyNode()).getValue().equals("projectDependencies")) {
+ for (var dependencyNode : ((SequenceNode) jobTuple.getValueNode()).getValue()) {
+ for (var dependencyTuple : ((MappingNode) dependencyNode).getValue()) {
+ if (((ScalarNode) dependencyTuple.getKeyNode()).getValue().equals("buildProvider")
+ && dependencyTuple.getValueNode() instanceof MappingNode buildProviderNode) {
+ Node refNameProviderNode = null;
+ for (var it = buildProviderNode.getValue().iterator(); it.hasNext();) {
+ var tuple = it.next();
+ var propertyName = ((ScalarNode) tuple.getKeyNode()).getValue();
+ if (propertyName.equals("type")) {
+ var typeNode = (ScalarNode) tuple.getValueNode();
+ if (typeNode.getValue().equals("LastFinishedBuild"))
+ typeNode.setValue("LatestBuild");
+ } else if (propertyName.equals("refName")) {
+ it.remove();
+ var refNameNode = (ScalarNode) tuple.getValueNode();
+ if (refNameNode.getTag().equals(Tag.NULL))
+ continue;
+ var refName = refNameNode.getValue();
+ String providerType;
+ String patternProperty;
+ String pattern;
+ if (refName.startsWith(Constants.R_HEADS)) {
+ providerType = "BranchProvider";
+ patternProperty = "branchPattern";
+ pattern = refName.substring(Constants.R_HEADS.length());
+ } else if (refName.startsWith(Constants.R_TAGS)) {
+ providerType = "TagProvider";
+ patternProperty = "tagPattern";
+ pattern = refName.substring(Constants.R_TAGS.length());
+ } else {
+ continue;
+ }
+ if (!pattern.isEmpty()) {
+ List<NodeTuple> providerTuples = new ArrayList<>();
+ providerTuples.add(new NodeTuple(new ScalarNode(Tag.STR, "type"), new ScalarNode(Tag.STR, providerType)));
+ providerTuples.add(new NodeTuple(new ScalarNode(Tag.STR, patternProperty), new ScalarNode(Tag.STR, pattern)));
+ refNameProviderNode = new MappingNode(Tag.MAP, providerTuples, FlowStyle.BLOCK);
+ }
+ }
+ }
+ if (refNameProviderNode != null) {
+ buildProviderNode.getValue().add(new NodeTuple(
+ new ScalarNode(Tag.STR, "refNameProvider"), refNameProviderNode));
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+
}
diff --git a/server-core/src/main/java/io/onedev/server/buildspec/job/projectdependency/BranchProvider.java b/server-core/src/main/java/io/onedev/server/buildspec/job/projectdependency/BranchProvider.java
new file mode 100644
index 0000000000..386d05f37e
--- /dev/null
+++ b/server-core/src/main/java/io/onedev/server/buildspec/job/projectdependency/BranchProvider.java
@@ -0,0 +1,30 @@
+package io.onedev.server.buildspec.job.projectdependency;
+
+import org.eclipse.jgit.lib.Constants;
+
+import io.onedev.server.annotation.Editable;
+import jakarta.validation.constraints.NotEmpty;
+
+@Editable(order=100, name="Branch")
+public class BranchProvider implements RefNameProvider {
+
+ private static final long serialVersionUID = 1L;
+
+ private String branchPattern;
+
+ @Editable(description="Specify branch name. Use * for wildcard match")
+ @NotEmpty
+ public String getBranchPattern() {
+ return branchPattern;
+ }
+
+ public void setBranchPattern(String branchPattern) {
+ this.branchPattern = branchPattern;
+ }
+
+ @Override
+ public String getRefName() {
+ return Constants.R_HEADS + branchPattern;
+ }
+
+}
diff --git a/server-core/src/main/java/io/onedev/server/buildspec/job/projectdependency/LatestBuild.java b/server-core/src/main/java/io/onedev/server/buildspec/job/projectdependency/LatestBuild.java
index da4923b766..865b363d39 100644
--- a/server-core/src/main/java/io/onedev/server/buildspec/job/projectdependency/LatestBuild.java
+++ b/server-core/src/main/java/io/onedev/server/buildspec/job/projectdependency/LatestBuild.java
@@ -5,6 +5,8 @@ import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
+import org.jspecify.annotations.Nullable;
+
import jakarta.validation.constraints.NotEmpty;
import io.onedev.server.OneDev;
@@ -23,7 +25,7 @@ public class LatestBuild implements BuildProvider {
private String jobName;
- private String refName;
+ private RefNameProvider refNameProvider;
@Editable(order=100)
@ChoiceProvider(value = "getJobChoices", tagsMode = true)
@@ -36,14 +38,14 @@ public class LatestBuild implements BuildProvider {
this.jobName = jobName;
}
- @Editable(name="Ref Name", order=200, placeholder="Any ref", description="Optionally specify ref of above job, "
- + "for instance <i>refs/heads/main</i>. Use * for wildcard match")
- public String getRefName() {
- return refName;
+ @Editable(name="Branch/Tag", order=200, placeholder="Any branch/tag", description="Optionally restrict above job to a branch or tag")
+ @Nullable
+ public RefNameProvider getRefNameProvider() {
+ return refNameProvider;
}
- public void setRefName(String refName) {
- this.refName = refName;
+ public void setRefNameProvider(@Nullable RefNameProvider refNameProvider) {
+ this.refNameProvider = refNameProvider;
}
@SuppressWarnings("unused")
@@ -59,13 +61,16 @@ public class LatestBuild implements BuildProvider {
@Override
public Build getBuild(Project project) {
- return OneDev.getInstance(BuildService.class).findLatest(project, jobName, refName);
+ return OneDev.getInstance(BuildService.class).findLatest(project, jobName,
+ refNameProvider != null ? refNameProvider.getRefName() : null);
}
@Override
public String getDescription() {
- if (refName != null)
- return "Latest of job '" + jobName + "' on ref '" + refName + "'";
+ if (refNameProvider instanceof BranchProvider branchProvider)
+ return "Latest of job '" + jobName + "' on branch '" + branchProvider.getBranchPattern() + "'";
+ else if (refNameProvider instanceof TagProvider tagProvider)
+ return "Latest of job '" + jobName + "' on tag '" + tagProvider.getTagPattern() + "'";
else
return "Latest of job '" + jobName + "'";
}
diff --git a/server-core/src/main/java/io/onedev/server/buildspec/job/projectdependency/RefNameProvider.java b/server-core/src/main/java/io/onedev/server/buildspec/job/projectdependency/RefNameProvider.java
new file mode 100644
index 0000000000..289f69948d
--- /dev/null
+++ b/server-core/src/main/java/io/onedev/server/buildspec/job/projectdependency/RefNameProvider.java
@@ -0,0 +1,12 @@
+package io.onedev.server.buildspec.job.projectdependency;
+
+import java.io.Serializable;
+
+import io.onedev.server.annotation.Editable;
+
+@Editable
+public interface RefNameProvider extends Serializable {
+
+ String getRefName();
+
+}
diff --git a/server-core/src/main/java/io/onedev/server/buildspec/job/projectdependency/TagProvider.java b/server-core/src/main/java/io/onedev/server/buildspec/job/projectdependency/TagProvider.java
new file mode 100644
index 0000000000..bb03b19633
--- /dev/null
+++ b/server-core/src/main/java/io/onedev/server/buildspec/job/projectdependency/TagProvider.java
@@ -0,0 +1,30 @@
+package io.onedev.server.buildspec.job.projectdependency;
+
+import org.eclipse.jgit.lib.Constants;
+
+import io.onedev.server.annotation.Editable;
+import jakarta.validation.constraints.NotEmpty;
+
+@Editable(order=200, name="Tag")
+public class TagProvider implements RefNameProvider {
+
+ private static final long serialVersionUID = 1L;
+
+ private String tagPattern;
+
+ @Editable(description="Specify tag. Use * for wildcard match")
+ @NotEmpty
+ public String getTagPattern() {
+ return tagPattern;
+ }
+
+ public void setTagPattern(String tagPattern) {
+ this.tagPattern = tagPattern;
+ }
+
+ @Override
+ public String getRefName() {
+ return Constants.R_TAGS + tagPattern;
+ }
+
+}
diff --git a/server-core/src/test/java/io/onedev/server/data/migration/SnakeYamlCustomizationTest.java b/server-core/src/test/java/io/onedev/server/data/migration/SnakeYamlCustomizationTest.java
index ae8a1ec7fa..5dd071edbb 100644
--- a/server-core/src/test/java/io/onedev/server/data/migration/SnakeYamlCustomizationTest.java
+++ b/server-core/src/test/java/io/onedev/server/data/migration/SnakeYamlCustomizationTest.java
@@ -27,6 +27,10 @@ import io.onedev.commons.loader.AppLoaderMocker;
import io.onedev.commons.loader.ImplementationRegistry;
import io.onedev.server.annotation.Editable;
import io.onedev.server.buildspec.BuildSpec;
+import io.onedev.server.buildspec.job.projectdependency.BranchProvider;
+import io.onedev.server.buildspec.job.projectdependency.LatestBuild;
+import io.onedev.server.buildspec.job.projectdependency.SpecifiedBuild;
+import io.onedev.server.buildspec.job.projectdependency.TagProvider;
import io.onedev.server.buildspec.step.CommandStep;
import io.onedev.server.buildspec.step.commandinterpreter.PosixInterpreter;
@@ -38,7 +42,8 @@ public class SnakeYamlCustomizationTest extends AppLoaderMocker {
@Override
public <T> Collection<Class<? extends T>> getImplementations(Class<T> type) {
var implementations = new ArrayList<Class<? extends T>>();
- for (var candidate : List.of(Command.class, CommandStep.class, PosixInterpreter.class)) {
+ for (var candidate : List.of(Command.class, CommandStep.class, PosixInterpreter.class,
+ LatestBuild.class, SpecifiedBuild.class, BranchProvider.class, TagProvider.class)) {
if (type.isAssignableFrom(candidate))
implementations.add(candidate.asSubclass(type));
}