Skip to content

The Unified and Autonomous Development Platform

feat: Support external issue ticket system (OD-287)

Robin Shencc1fdd3a0db5
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 d9fa4416b9..96b8771e2e 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
@@ -7843,6 +7843,16 @@ public class DataMigrator {
element.element("day").detach();
}
dom.writeToFile(file, false);
+ } else if (file.getName().startsWith("Settings.xml")) {
+ VersionedXmlDoc dom = VersionedXmlDoc.fromFile(file);
+ for (Element element : dom.getRootElement().elements()) {
+ if (element.elementTextTrim("key").equals("ISSUE")) {
+ Element valueElement = element.element("value");
+ if (valueElement != null)
+ valueElement.addElement("externalIssueTransformers").addElement("entries");
+ }
+ }
+ dom.writeToFile(file, false);
}
}
}
diff --git a/server-core/src/main/java/io/onedev/server/entityreference/ReferenceUtils.java b/server-core/src/main/java/io/onedev/server/entityreference/ReferenceUtils.java
index baf9305727..2796b77677 100644
--- a/server-core/src/main/java/io/onedev/server/entityreference/ReferenceUtils.java
+++ b/server-core/src/main/java/io/onedev/server/entityreference/ReferenceUtils.java
@@ -22,6 +22,7 @@ import com.google.common.collect.ImmutableSet;
import io.onedev.commons.utils.StringUtils;
import io.onedev.server.OneDev;
import io.onedev.server.entitymanager.ProjectManager;
+import io.onedev.server.entitymanager.SettingManager;
import io.onedev.server.model.Project;
import io.onedev.server.util.HtmlUtils;
import io.onedev.server.util.TextNodeVisitor;
@@ -77,6 +78,10 @@ public class ReferenceUtils {
} else {
text = transformer.apply(null, text);
}
+ var issueSetting = OneDev.getInstance(SettingManager.class).getIssueSetting();
+ for (var entry: issueSetting.getExternalIssueTransformers().getEntries()) {
+ text = text.replaceAll(entry.getPattern(), entry.getReplaceWith());
+ }
return text;
}
diff --git a/server-core/src/main/java/io/onedev/server/model/support/administration/GlobalIssueSetting.java b/server-core/src/main/java/io/onedev/server/model/support/administration/GlobalIssueSetting.java
index 15a0b2e863..0e7a062c89 100644
--- a/server-core/src/main/java/io/onedev/server/model/support/administration/GlobalIssueSetting.java
+++ b/server-core/src/main/java/io/onedev/server/model/support/administration/GlobalIssueSetting.java
@@ -1,6 +1,20 @@
package io.onedev.server.model.support.administration;
+import java.io.Serializable;
+import java.util.ArrayList;
+import java.util.Collection;
+import java.util.Comparator;
+import java.util.HashSet;
+import java.util.Iterator;
+import java.util.LinkedHashMap;
+import java.util.List;
+import java.util.Map;
+import java.util.stream.Collectors;
+
+import javax.annotation.Nullable;
+
import com.google.common.collect.Lists;
+
import edu.emory.mathcs.backport.java.util.Collections;
import io.onedev.commons.utils.ExplicitException;
import io.onedev.commons.utils.match.Matcher;
@@ -11,7 +25,13 @@ import io.onedev.server.buildspecmodel.inputspec.choiceinput.choiceprovider.Spec
import io.onedev.server.model.Issue;
import io.onedev.server.model.IssueSchedule;
import io.onedev.server.model.Project;
-import io.onedev.server.model.support.issue.*;
+import io.onedev.server.model.support.issue.BoardSpec;
+import io.onedev.server.model.support.issue.CommitMessageFixPatterns;
+import io.onedev.server.model.support.issue.ExternalIssueTransformers;
+import io.onedev.server.model.support.issue.IssueTemplate;
+import io.onedev.server.model.support.issue.NamedIssueQuery;
+import io.onedev.server.model.support.issue.StateSpec;
+import io.onedev.server.model.support.issue.TimeTrackingSetting;
import io.onedev.server.model.support.issue.field.spec.FieldSpec;
import io.onedev.server.model.support.issue.field.spec.choicefield.ChoiceField;
import io.onedev.server.model.support.issue.field.spec.choicefield.defaultvalueprovider.DefaultValue;
@@ -25,17 +45,18 @@ import io.onedev.server.search.entity.issue.IssueQuery;
import io.onedev.server.search.entity.issue.IssueQueryParseOption;
import io.onedev.server.util.patternset.PatternSet;
import io.onedev.server.util.usage.Usage;
-import io.onedev.server.web.component.issue.workflowreconcile.*;
-
-import javax.annotation.Nullable;
-import java.io.Serializable;
-import java.util.*;
-import java.util.stream.Collectors;
+import io.onedev.server.web.component.issue.workflowreconcile.ReconcileUtils;
+import io.onedev.server.web.component.issue.workflowreconcile.UndefinedFieldResolution;
+import io.onedev.server.web.component.issue.workflowreconcile.UndefinedFieldValue;
+import io.onedev.server.web.component.issue.workflowreconcile.UndefinedFieldValuesResolution;
+import io.onedev.server.web.component.issue.workflowreconcile.UndefinedStateResolution;
@Editable
public class GlobalIssueSetting implements Serializable {
private static final long serialVersionUID = 1L;
+
+ public static final String PROP_EXTERNAL_ISSUE_PATTERN = "externalIssuePattern";
private List<StateSpec> stateSpecs = new ArrayList<>();
@@ -56,6 +77,8 @@ public class GlobalIssueSetting implements Serializable {
private List<IssueTemplate> issueTemplates = new ArrayList<>();
private CommitMessageFixPatterns commitMessageFixPatterns;
+
+ private ExternalIssueTransformers externalIssueTransformers;
private boolean reconciled = true;
@@ -247,6 +270,8 @@ public class GlobalIssueSetting implements Serializable {
commitMessageFixPatterns.getEntries().add(entry);
timeTrackingSetting.setAggregationLink("Sub Issues");
+
+ externalIssueTransformers = new ExternalIssueTransformers();
}
public List<String> sortFieldNames(Collection<String> fieldNames) {
@@ -708,6 +733,14 @@ public class GlobalIssueSetting implements Serializable {
this.commitMessageFixPatterns = commitMessageFixPatterns;
}
+ public ExternalIssueTransformers getExternalIssueTransformers() {
+ return externalIssueTransformers;
+ }
+
+ public void setExternalIssueTransformers(ExternalIssueTransformers externalIssueTransformers) {
+ this.externalIssueTransformers = externalIssueTransformers;
+ }
+
@Nullable
public NamedIssueQuery getNamedQuery(String name) {
for (NamedIssueQuery namedQuery: getNamedQueries()) {
diff --git a/server-core/src/main/java/io/onedev/server/model/support/issue/ExternalIssueTransformers.java b/server-core/src/main/java/io/onedev/server/model/support/issue/ExternalIssueTransformers.java
new file mode 100644
index 0000000000..1983a51895
--- /dev/null
+++ b/server-core/src/main/java/io/onedev/server/model/support/issue/ExternalIssueTransformers.java
@@ -0,0 +1,92 @@
+package io.onedev.server.model.support.issue;
+
+import java.io.Serializable;
+import java.util.ArrayList;
+import java.util.List;
+import java.util.regex.Pattern;
+
+import javax.validation.ConstraintValidatorContext;
+import javax.validation.constraints.NotEmpty;
+
+import io.onedev.server.annotation.ClassValidating;
+import io.onedev.server.annotation.Editable;
+import io.onedev.server.annotation.OmitName;
+import io.onedev.server.validation.Validatable;
+
+@Editable
+@ClassValidating
+public class ExternalIssueTransformers implements Serializable, Validatable {
+ private static final long serialVersionUID = 1L;
+
+ private List<Entry> entries = new ArrayList<>();
+
+ @Editable
+ @OmitName
+ public List<Entry> getEntries() {
+ return entries;
+ }
+
+ public void setEntries(List<Entry> entries) {
+ this.entries = entries;
+ }
+
+ @Override
+ public boolean isValid(ConstraintValidatorContext context) {
+ boolean isValid = true;
+ int index = 0;
+ for (var entry: entries) {
+ if (entry.getPattern() != null) {
+ try {
+ Pattern.compile(entry.getPattern());
+ } catch (Exception e) {
+ isValid = false;
+ var message = e.getMessage();
+ if (message == null)
+ message = "Malformed regular expression";
+ context.buildConstraintViolationWithTemplate(message)
+ .addPropertyNode("entries")
+ .addPropertyNode("pattern")
+ .inIterable()
+ .atIndex(index)
+ .addConstraintViolation();
+ }
+ }
+ index++;
+ }
+ if (!isValid)
+ context.disableDefaultConstraintViolation();
+ return isValid;
+ }
+
+ @Editable
+ public static class Entry implements Serializable {
+
+ private static final long serialVersionUID = 1L;
+
+ private String pattern;
+
+ private String replaceWith;
+
+ @Editable(order = 100, name="Issue Pattern", description = "Specify a <a href='http://docs.oracle.com/javase/6/docs/api/java/util/regex/Pattern.html'>regular expression</a> " +
+ "to match issue references. For instance: <code>(^|\\W)([A-Z][A-Z]+-\\d+)(?=\\W|$)</code>")
+ @NotEmpty
+ public String getPattern() {
+ return pattern;
+ }
+
+ public void setPattern(String pattern) {
+ this.pattern = pattern;
+ }
+
+ @Editable(order = 200, name="Replace With", description = "Specify text to replace matched issue references with, for instance: <code>$1&lt;a href='https://tracker.example.com/issues/$2'&gt;$2&lt;/a&gt;</code>. Here <code>$1</code> and <code>$2</code> represent catpure groups in the issue pattern")
+ @NotEmpty
+ public String getReplaceWith() {
+ return replaceWith;
+ }
+
+ public void setReplaceWith(String replaceWith) {
+ this.replaceWith = replaceWith;
+ }
+
+ }
+}
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 543a51f6cb..2a77b1d115 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
@@ -41,6 +41,7 @@ import io.onedev.server.web.page.admin.groupmanagement.membership.GroupMembershi
import io.onedev.server.web.page.admin.groupmanagement.profile.GroupProfilePage;
import io.onedev.server.web.page.admin.issuesetting.commitmessagefixpatterns.CommitMessageFixPatternsPage;
import io.onedev.server.web.page.admin.issuesetting.defaultboard.DefaultBoardListPage;
+import io.onedev.server.web.page.admin.issuesetting.externalissuepattern.ExternalIssueTransformersPage;
import io.onedev.server.web.page.admin.issuesetting.fieldspec.IssueFieldListPage;
import io.onedev.server.web.page.admin.issuesetting.integritycheck.CheckIssueIntegrityPage;
import io.onedev.server.web.page.admin.issuesetting.issuetemplate.IssueTemplateListPage;
@@ -350,6 +351,7 @@ public class BaseUrlMapper extends CompoundRequestMapper {
add(new BasePageMapper("~administration/settings/time-tracking", TimeTrackingSettingPage.class));
add(new BasePageMapper("~administration/settings/issue-templates", IssueTemplateListPage.class));
add(new BasePageMapper("~administration/settings/commit-message-fix-patterns", CommitMessageFixPatternsPage.class));
+ add(new BasePageMapper("~administration/settings/external-issue-transformers", ExternalIssueTransformersPage.class));
add(new BasePageMapper("~administration/settings/check-issue-integrity", CheckIssueIntegrityPage.class));
add(new BasePageMapper("~administration/settings/branding", BrandingSettingPage.class));
diff --git a/server-core/src/main/java/io/onedev/server/web/page/admin/issuesetting/commitmessagefixpatterns/CommitMessageFixPatternsPage.java b/server-core/src/main/java/io/onedev/server/web/page/admin/issuesetting/commitmessagefixpatterns/CommitMessageFixPatternsPage.java
index 62ee9d03d7..3404bf1807 100644
--- a/server-core/src/main/java/io/onedev/server/web/page/admin/issuesetting/commitmessagefixpatterns/CommitMessageFixPatternsPage.java
+++ b/server-core/src/main/java/io/onedev/server/web/page/admin/issuesetting/commitmessagefixpatterns/CommitMessageFixPatternsPage.java
@@ -22,14 +22,13 @@ public class CommitMessageFixPatternsPage extends IssueSettingPage {
protected void onInitialize() {
super.onInitialize();
- CommitMessageFixPatterns patterns = getSettingManager().getIssueSetting().getCommitMessageFixPatterns();
+ CommitMessageFixPatterns patterns = getSetting().getCommitMessageFixPatterns();
Form<?> form = new Form<Void>("form") {
@Override
protected void onSubmit() {
super.onSubmit();
- var issueSetting = getSettingManager().getIssueSetting();
- issueSetting.setCommitMessageFixPatterns(patterns);
- getSettingManager().saveIssueSetting(issueSetting);
+ getSetting().setCommitMessageFixPatterns(patterns);
+ getSettingManager().saveIssueSetting(getSetting());
Session.get().success("Setting updated");
}
};
diff --git a/server-core/src/main/java/io/onedev/server/web/page/admin/issuesetting/externalissuepattern/ExternalIssueTransformersPage.html b/server-core/src/main/java/io/onedev/server/web/page/admin/issuesetting/externalissuepattern/ExternalIssueTransformersPage.html
new file mode 100644
index 0000000000..cf239c38b3
--- /dev/null
+++ b/server-core/src/main/java/io/onedev/server/web/page/admin/issuesetting/externalissuepattern/ExternalIssueTransformersPage.html
@@ -0,0 +1,13 @@
+<wicket:extend>
+ <div class="text-muted mb-4">
+ <wicket:svg href="bulb" class="icon"/>
+ In case you are using external issue tracker, you can define transformers
+ to transform external issue references into external issue links in various
+ places, such as commit messages and pull request descriptions
+ </div>
+ <form wicket:id="form">
+ <div wicket:id="feedback"></div>
+ <div wicket:id="editor" class="mb-4"></div>
+ <input type="submit" class="btn btn-primary" value="Update">
+ </form>
+</wicket:extend>
\ No newline at end of file
diff --git a/server-core/src/main/java/io/onedev/server/web/page/admin/issuesetting/externalissuepattern/ExternalIssueTransformersPage.java b/server-core/src/main/java/io/onedev/server/web/page/admin/issuesetting/externalissuepattern/ExternalIssueTransformersPage.java
new file mode 100644
index 0000000000..c460cf4910
--- /dev/null
+++ b/server-core/src/main/java/io/onedev/server/web/page/admin/issuesetting/externalissuepattern/ExternalIssueTransformersPage.java
@@ -0,0 +1,52 @@
+package io.onedev.server.web.page.admin.issuesetting.externalissuepattern;
+
+import org.apache.wicket.Component;
+import org.apache.wicket.Session;
+import org.apache.wicket.feedback.FencedFeedbackPanel;
+import org.apache.wicket.markup.html.basic.Label;
+import org.apache.wicket.markup.html.form.Form;
+import org.apache.wicket.request.mapper.parameter.PageParameters;
+
+import io.onedev.server.OneDev;
+import io.onedev.server.entitymanager.SettingManager;
+import io.onedev.server.model.support.issue.ExternalIssueTransformers;
+import io.onedev.server.web.editable.BeanContext;
+import io.onedev.server.web.page.admin.issuesetting.IssueSettingPage;
+
+public class ExternalIssueTransformersPage extends IssueSettingPage {
+
+ private static final long serialVersionUID = 1L;
+
+ public ExternalIssueTransformersPage(PageParameters params) {
+ super(params);
+ }
+
+ @Override
+ protected void onInitialize() {
+ super.onInitialize();
+
+ ExternalIssueTransformers transformers = getSetting().getExternalIssueTransformers();
+ Form<?> form = new Form<Void>("form") {
+ @Override
+ protected void onSubmit() {
+ super.onSubmit();
+ getSetting().setExternalIssueTransformers(transformers);
+ getSettingManager().saveIssueSetting(getSetting());
+ Session.get().success("Setting updated");
+ }
+ };
+ form.add(new FencedFeedbackPanel("feedback", form));
+ form.add(BeanContext.edit("editor", transformers));
+ add(form);
+ }
+
+ private SettingManager getSettingManager() {
+ return OneDev.getInstance(SettingManager.class);
+ }
+
+ @Override
+ protected Component newTopbarTitle(String componentId) {
+ return new Label(componentId, "External Issue Transformers");
+ }
+
+}
\ No newline at end of file
diff --git a/server-core/src/main/java/io/onedev/server/web/page/layout/LayoutPage.java b/server-core/src/main/java/io/onedev/server/web/page/layout/LayoutPage.java
index 81e75551b9..581926f2a3 100644
--- a/server-core/src/main/java/io/onedev/server/web/page/layout/LayoutPage.java
+++ b/server-core/src/main/java/io/onedev/server/web/page/layout/LayoutPage.java
@@ -117,6 +117,7 @@ import io.onedev.server.web.page.admin.groupmanagement.GroupPage;
import io.onedev.server.web.page.admin.groupmanagement.create.NewGroupPage;
import io.onedev.server.web.page.admin.issuesetting.commitmessagefixpatterns.CommitMessageFixPatternsPage;
import io.onedev.server.web.page.admin.issuesetting.defaultboard.DefaultBoardListPage;
+import io.onedev.server.web.page.admin.issuesetting.externalissuepattern.ExternalIssueTransformersPage;
import io.onedev.server.web.page.admin.issuesetting.fieldspec.IssueFieldListPage;
import io.onedev.server.web.page.admin.issuesetting.integritycheck.CheckIssueIntegrityPage;
import io.onedev.server.web.page.admin.issuesetting.issuetemplate.IssueTemplateListPage;
@@ -247,8 +248,7 @@ public abstract class LayoutPage extends BasePage {
administrationMenuItems.add(new SidebarMenuItem.SubMenu(null, keysTitle, keyManagementMenuItems));
List<SidebarMenuItem> issueSettingMenuItems = new ArrayList<>();
- issueSettingMenuItems.add(new SidebarMenuItem.Page(null, "Custom Fields",
- IssueFieldListPage.class, new PageParameters()));
+ issueSettingMenuItems.add(new SidebarMenuItem.Page(null, "Fields", IssueFieldListPage.class, new PageParameters()));
issueSettingMenuItems.add(new SidebarMenuItem.Page(null, "States",
IssueStateListPage.class, new PageParameters()));
issueSettingMenuItems.add(new SidebarMenuItem.Page(null, "State Transitions",
@@ -265,6 +265,7 @@ public abstract class LayoutPage extends BasePage {
IssueTemplateListPage.class, new PageParameters()));
issueSettingMenuItems.add(new SidebarMenuItem.Page(null, "Commit Message Fix Patterns",
CommitMessageFixPatternsPage.class, new PageParameters()));
+ issueSettingMenuItems.add(new SidebarMenuItem.Page(null, "External Issue Transformers", ExternalIssueTransformersPage.class, new PageParameters()));
issueSettingMenuItems.add(new SidebarMenuItem.Page(null, "Check Workflow Integrity",
CheckIssueIntegrityPage.class, new PageParameters()));
diff --git a/server-core/src/test/java/io/onedev/server/entityreference/ReferenceUtilsTest.java b/server-core/src/test/java/io/onedev/server/entityreference/ReferenceUtilsTest.java
index fd76336c62..79102ef625 100644
--- a/server-core/src/test/java/io/onedev/server/entityreference/ReferenceUtilsTest.java
+++ b/server-core/src/test/java/io/onedev/server/entityreference/ReferenceUtilsTest.java
@@ -1,13 +1,5 @@
package io.onedev.server.entityreference;
-import io.onedev.commons.loader.AppLoader;
-import io.onedev.commons.loader.AppLoaderMocker;
-import io.onedev.server.entitymanager.ProjectManager;
-import io.onedev.server.model.Project;
-import org.junit.Test;
-import org.mockito.Mockito;
-import org.unbescape.html.HtmlEscape;
-
import static io.onedev.server.entityreference.ReferenceUtils.extractReferences;
import static io.onedev.server.entityreference.ReferenceUtils.transformReferences;
import static org.junit.Assert.assertEquals;
@@ -15,12 +7,25 @@ import static org.junit.Assert.assertTrue;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.when;
+import org.junit.Test;
+import org.mockito.Mockito;
+import org.unbescape.html.HtmlEscape;
+
+import io.onedev.commons.loader.AppLoader;
+import io.onedev.commons.loader.AppLoaderMocker;
+import io.onedev.server.entitymanager.ProjectManager;
+import io.onedev.server.entitymanager.SettingManager;
+import io.onedev.server.model.Project;
+import io.onedev.server.model.support.administration.GlobalIssueSetting;
+
public class ReferenceUtilsTest extends AppLoaderMocker {
@Test
public void test() {
var projectManager = mock(ProjectManager.class);
- Mockito.when(AppLoader.getInstance(ProjectManager.class)).thenReturn(projectManager);
+ var settingManager = mock(SettingManager.class);
+ Mockito.when(AppLoader.getInstance(ProjectManager.class)).thenReturn(projectManager);
+ Mockito.when(AppLoader.getInstance(SettingManager.class)).thenReturn(settingManager);
var project1 = new Project();
project1.setId(1L);
project1.setKey("ONE");
@@ -35,6 +40,7 @@ public class ReferenceUtilsTest extends AppLoaderMocker {
when(projectManager.load(2L)).thenReturn(project2);
when(projectManager.findByKey("TWO")).thenReturn(project2);
when(projectManager.findByPath("test/project2")).thenReturn(project2);
+ when(settingManager.getIssueSetting()).thenReturn(new GlobalIssueSetting());
assertEquals("<a href='https://example.com'>A test issue</a>", transformReferences("A test issue", project1, ((reference, text) -> {
if (reference != null)