[JENKINS-42849] add BranchProperty to assign ownership to branch jobs

pom.xml

@@ -76,7 +76,7 @@
         <dependency>
             <groupId>org.jenkins-ci.plugins</groupId>
             <artifactId>cloudbees-folder</artifactId>
-            <version>5.1</version>
+            <version>6.0.1</version>
             <optional>true</optional>
         </dependency>
         <dependency>
@@ -117,6 +117,12 @@
             <version>4.3.4</version>
             <type>jar</type>
         </dependency>
+        <dependency>
+            <groupId>org.jenkins-ci.plugins</groupId>
+            <artifactId>branch-api</artifactId>
+            <version>2.0.8</version>
+            <type>jar</type>
+        </dependency>
         <dependency>
             <groupId>org.jenkins-ci.plugins.workflow</groupId>
             <artifactId>workflow-cps</artifactId>

src/main/java/org/jenkinsci/plugins/ownership/model/branches/BranchNameOwnershipStrategy.java

@@ -0,0 +1,77 @@
+package org.jenkinsci.plugins.ownership.model.branches;
+
+import hudson.Extension;
+import hudson.Util;
+import hudson.model.User;
+import hudson.util.FormValidation;
+import jenkins.branch.Branch;
+import org.kohsuke.stapler.DataBoundConstructor;
+import org.kohsuke.stapler.QueryParameter;
+
+import javax.annotation.Nonnull;
+import javax.annotation.Nullable;
+import javax.annotation.RegEx;
+import java.util.Collections;
+import java.util.regex.Matcher;
+import java.util.regex.Pattern;
+import java.util.regex.PatternSyntaxException;
+
+public class BranchNameOwnershipStrategy extends BranchOwnershipStrategy {
+
+    private Pattern pattern;
+    private String ownerExpression;
+
+    @DataBoundConstructor
+    public BranchNameOwnershipStrategy(@RegEx String pattern, @Nonnull String ownerExpression) {
+        this.pattern = Pattern.compile(pattern);
+        this.ownerExpression = ownerExpression;
+    }
+
+    public String getPattern() {
+        return pattern.pattern();
+    }
+
+    public String getOwnerExpression() {
+        return ownerExpression;
+    }
+
+    @Override
+    @Nullable
+    public String determineOwner(Branch branch) {
+        Matcher matcher = pattern.matcher(branch.getName());
+
+        if (matcher.matches()) {
+            String prospectiveOwner = matcher.replaceAll(ownerExpression);
+
+            if (User.get(prospectiveOwner, false, Collections.emptyMap()) != null) {
+                return prospectiveOwner;
+            }
+        }
+
+        return null;
+    }
+
+    @Extension
+    public static class DescriptorImpl extends BranchOwnershipStrategy.BranchOwnershipStrategyDescriptor {
+
+        @Override
+        @Nonnull
+        public String getDisplayName() {
+            return "By branch name";
+        }
+
+        public FormValidation doCheckPattern(@QueryParameter String value) {
+            try {
+                Pattern.compile(value);
+            } catch (PatternSyntaxException ex) {
+                return FormValidation.error("Invalid regex: %s", ex.getMessage());
+            }
+
+            return FormValidation.ok();
+        }
+
+        public FormValidation doCheckOwnerExpression(@QueryParameter String value) {
+            return Util.fixEmptyAndTrim(value) != null ? FormValidation.ok() : FormValidation.warning("Ownership will be disabled");
+        }
+    }
+}

src/main/java/org/jenkinsci/plugins/ownership/model/branches/BranchOwnershipStrategy.java

@@ -0,0 +1,31 @@
+package org.jenkinsci.plugins.ownership.model.branches;
+
+import hudson.ExtensionPoint;
+import hudson.model.AbstractDescribableImpl;
+import hudson.model.Descriptor;
+import jenkins.branch.Branch;
+
+import javax.annotation.Nonnull;
+import javax.annotation.Nullable;
+
+public abstract class BranchOwnershipStrategy extends AbstractDescribableImpl<BranchOwnershipStrategy> implements ExtensionPoint {
+
+    /**
+     * Determine the owner for the given branch using the implemented strategy.
+     *
+     * @param branch The branch
+     * @return The prospective owner's user ID or full name. {@code null} if the owner cannot be determined.
+     */
+    @Nullable
+    public abstract String determineOwner(Branch branch);
+
+    @Nonnull
+    @SuppressWarnings("unchecked")
+    public BranchOwnershipStrategyDescriptor getDescriptor() {
+        return (BranchOwnershipStrategyDescriptor) super.getDescriptor();
+    }
+
+    static abstract class BranchOwnershipStrategyDescriptor extends Descriptor<BranchOwnershipStrategy> {
+
+    }
+}

src/main/java/org/jenkinsci/plugins/ownership/model/branches/FromScmOwnershipStrategy.java

@@ -0,0 +1,29 @@
+package org.jenkinsci.plugins.ownership.model.branches;
+
+
+import hudson.Extension;
+import jenkins.branch.Branch;
+import jenkins.scm.api.metadata.ContributorMetadataAction;
+
+import javax.annotation.Nonnull;
+import javax.annotation.Nullable;
+
+public class FromScmOwnershipStrategy extends BranchOwnershipStrategy {
+
+
+    @Nullable
+    @Override
+    public String determineOwner(Branch branch) {
+        ContributorMetadataAction contributorMetadataAction = branch.getAction(ContributorMetadataAction.class);
+        return contributorMetadataAction != null ? contributorMetadataAction.getContributor() : null;
+    }
+
+    @Extension
+    public static class DescriptorImpl extends BranchOwnershipStrategy.BranchOwnershipStrategyDescriptor {
+        @Override
+        @Nonnull
+        public String getDisplayName() {
+            return "From scm";
+        }
+    }
+}

src/main/java/org/jenkinsci/plugins/ownership/model/branches/OwnershipBranchProperty.java

@@ -0,0 +1,73 @@
+package org.jenkinsci.plugins.ownership.model.branches;
+
+import com.synopsys.arc.jenkins.plugins.ownership.OwnershipDescription;
+import com.synopsys.arc.jenkins.plugins.ownership.jobs.JobOwnerHelper;
+import hudson.Extension;
+import hudson.model.*;
+import hudson.util.FormValidation;
+import jenkins.branch.*;
+import org.kohsuke.stapler.DataBoundConstructor;
+import org.kohsuke.stapler.QueryParameter;
+
+import javax.annotation.Nonnull;
+import java.io.IOException;
+import java.util.Collections;
+
+public class OwnershipBranchProperty extends BranchProperty {
+
+    private BranchOwnershipStrategy strategy;
+    private String fallbackOwner;
+
+    @DataBoundConstructor
+    public OwnershipBranchProperty(@Nonnull String fallbackOwner, @Nonnull BranchOwnershipStrategy strategy) {
+        this.strategy = strategy;
+        this.fallbackOwner = fallbackOwner;
+    }
+
+    public BranchOwnershipStrategy getStrategy() {
+        return strategy;
+    }
+
+    public String getFallbackOwner() {
+        return fallbackOwner;
+    }
+
+    @Override
+    @SuppressWarnings("unchecked")
+    public <P extends Job<P, B>, B extends Run<P, B>> JobDecorator<P, B> jobDecorator(final Class<P> clazz) {
+        return new JobDecorator<P, B>() {
+            @Nonnull
+            public P project(@Nonnull P project) {
+                if (project.getParent() instanceof MultiBranchProject && TopLevelItem.class.isAssignableFrom(clazz)) {
+                    MultiBranchProject multiBranchProject = (MultiBranchProject) project.getParent();
+                    Branch branch = multiBranchProject.getProjectFactory().getBranch(project);
+
+                    String prospectiveOwner = strategy.determineOwner(branch);
+                    String owner = prospectiveOwner != null ? prospectiveOwner : fallbackOwner;
+
+                    OwnershipDescription ownershipDescription = new OwnershipDescription(true, owner, null);
+                    try {
+                        JobOwnerHelper.setOwnership(project, ownershipDescription);
+                    } catch (IOException ioe) {
+                        // TODO: handle somehow
+                    }
+                }
+                return project;
+            }
+        };
+    }
+
+    @Extension
+    public static class DescriptorImpl extends BranchPropertyDescriptor {
+        @Nonnull
+        @Override
+        public String getDisplayName() {
+            return "Set branch job ownership";
+        }
+
+        public FormValidation doCheckFallbackOwner(@QueryParameter String value) {
+            User user = User.get(value, false, Collections.emptyMap());
+            return user != null ? FormValidation.ok() : FormValidation.error("User '%s' is not registered in Jenkins", value);
+        }
+    }
+}

src/main/resources/org/jenkinsci/plugins/ownership/model/branches/BranchNameOwnershipStrategy/config.jelly

@@ -0,0 +1,9 @@
+<?jelly escape-by-default='true'?>
+<j:jelly xmlns:j="jelly:core" xmlns:f="/lib/form">
+    <f:entry title="Capture pattern" field="pattern">
+        <f:textbox/>
+    </f:entry>
+    <f:entry title="Owner expression" field="ownerExpression">
+        <f:textbox/>
+    </f:entry>
+</j:jelly>

src/main/resources/org/jenkinsci/plugins/ownership/model/branches/BranchNameOwnershipStrategy/help-ownerExpression.html

@@ -0,0 +1,6 @@
+<div>
+    The expression used to determine the owner.
+    May contain references to capture groups in the capture pattern using <i>$index</i> or <i>$name</i>.
+    See <a target="_blank" href="https://docs.oracle.com/javase/7/docs/api/java/util/regex/Matcher.html#appendReplacement(java.lang.StringBuffer,%20java.lang.String)">
+    java.util.regex.Matcher</a> for details.
+</div>

src/main/resources/org/jenkinsci/plugins/ownership/model/branches/BranchNameOwnershipStrategy/help-pattern.html

@@ -0,0 +1,4 @@
+<div>
+    A regular expression matching the branch name. Capture groups can be included and used in the owner expression.
+    See <a target="_blank" href="https://docs.oracle.com/javase/7/docs/api/java/util/regex/Pattern.html">java.util.regex.Pattern</a> for syntax.
+</div>

src/main/resources/org/jenkinsci/plugins/ownership/model/branches/FromScmOwnershipStrategy/help.html

@@ -0,0 +1,6 @@
+<div>
+    SCM sources can specify the "contributor" of a branch.
+    For example, GitHub and Bitbucket Branch Source plugins specify the user who opened a PR as its contributor.
+
+    This strategy sets this contributor as the owner of the branch job.
+</div>

src/main/resources/org/jenkinsci/plugins/ownership/model/branches/OwnershipBranchProperty/config.jelly

@@ -0,0 +1,8 @@
+<?jelly escape-by-default='true'?>
+<j:jelly xmlns:j="jelly:core" xmlns:f="/lib/form">
+    <f:entry title="Fallback owner" field="fallbackOwner">
+        <f:textbox/>
+    </f:entry>
+
+    <f:dropdownDescriptorSelector field="strategy" title="Strategy" />
+</j:jelly>

src/main/resources/org/jenkinsci/plugins/ownership/model/branches/OwnershipBranchProperty/help-fallbackOwner.html

@@ -0,0 +1,3 @@
+<div>
+    If the chosen strategy cannot determine the owner, the fallback owner will be used.
+</div>