Make agentUserName property optional to avoid a breaking change

Author: Brinkop Andre (uib05464)

src/main/java/org/jenkinsci/plugins/GithubAuthorizationStrategy.java

@@ -30,6 +30,7 @@ of this software and associated documentation files (the "Software"), to deal
 import org.jenkinsci.plugins.workflow.job.WorkflowJob;
 import org.jenkinsci.plugins.workflow.multibranch.BranchJobProperty;
 import org.kohsuke.stapler.DataBoundConstructor;
+import org.kohsuke.stapler.DataBoundSetter;
 
 import java.util.Collection;
 import java.util.Collections;
@@ -55,7 +56,6 @@ public class GithubAuthorizationStrategy extends AuthorizationStrategy {
 
     @DataBoundConstructor
     public GithubAuthorizationStrategy(String adminUserNames,
-            String agentUserName,
             boolean authenticatedUserReadPermission,
             boolean useRepositoryPermissions,
             boolean authenticatedUserCreateJobPermission,
@@ -67,7 +67,6 @@ public GithubAuthorizationStrategy(String adminUserNames,
         super();
 
         rootACL = new GithubRequireOrganizationMembershipACL(adminUserNames,
-                agentUserName,
                 organizationNames,
                 authenticatedUserReadPermission,
                 useRepositoryPermissions,
@@ -142,6 +141,15 @@ public String getAdminUserNames() {
         return StringUtils.join(rootACL.getAdminUserNameList().iterator(), ", ");
     }
 
+    /** Set the agent username. We use a setter instead of a constructor to make this an optional field
+     *  to avoid a breaking change.
+     * @see org.jenkinsci.plugins.GithubRequireOrganizationMembershipACL#setAgentUserName(String)
+     */
+    @DataBoundSetter
+    public void setAgentUserName(String agentUserName) {
+        rootACL.setAgentUserName(agentUserName);
+    }
+
     /**
      * @return agentUserName
      * @see GithubRequireOrganizationMembershipACL#getAgentUserName()

src/main/java/org/jenkinsci/plugins/GithubRequireOrganizationMembershipACL.java

@@ -64,7 +64,7 @@ public class GithubRequireOrganizationMembershipACL extends ACL {
 
     private final List<String> organizationNameList;
     private final List<String> adminUserNameList;
-    private final String agentUserName;
+    private String agentUserName;
     private final boolean authenticatedUserReadPermission;
     private final boolean useRepositoryPermissions;
     private final boolean authenticatedUserCreateJobPermission;
@@ -299,7 +299,6 @@ private String getRepositoryName() {
     }
 
     public GithubRequireOrganizationMembershipACL(String adminUserNames,
-            String agentUserName,
             String organizationNames,
             boolean authenticatedUserReadPermission,
             boolean useRepositoryPermissions,
@@ -318,7 +317,6 @@ public GithubRequireOrganizationMembershipACL(String adminUserNames,
         this.allowAnonymousReadPermission         = allowAnonymousReadPermission;
         this.allowAnonymousJobStatusPermission    = allowAnonymousJobStatusPermission;
         this.adminUserNameList                    = new LinkedList<>();
-        this.agentUserName                        = agentUserName;
 
         String[] parts = adminUserNames.split(",");
 
@@ -335,12 +333,12 @@ public GithubRequireOrganizationMembershipACL(String adminUserNames,
         }
 
         this.item = null;
+        this.agentUserName = ""; // Initially blank - populated by a setter since this field is optional
     }
 
     public GithubRequireOrganizationMembershipACL cloneForProject(AbstractItem item) {
-      return new GithubRequireOrganizationMembershipACL(
+        GithubRequireOrganizationMembershipACL acl = new GithubRequireOrganizationMembershipACL(
           this.adminUserNameList,
-          this.agentUserName,
           this.organizationNameList,
           this.authenticatedUserReadPermission,
           this.useRepositoryPermissions,
@@ -350,10 +348,11 @@ public GithubRequireOrganizationMembershipACL cloneForProject(AbstractItem item)
           this.allowAnonymousReadPermission,
           this.allowAnonymousJobStatusPermission,
           item);
+        acl.setAgentUserName(agentUserName);
+        return acl;
     }
 
     public GithubRequireOrganizationMembershipACL(List<String> adminUserNameList,
-            String agentUserName,
             List<String> organizationNameList,
             boolean authenticatedUserReadPermission,
             boolean useRepositoryPermissions,
@@ -366,7 +365,6 @@ public GithubRequireOrganizationMembershipACL(List<String> adminUserNameList,
         super();
 
         this.adminUserNameList                    = adminUserNameList;
-        this.agentUserName                   = agentUserName;
         this.organizationNameList                 = organizationNameList;
         this.authenticatedUserReadPermission      = authenticatedUserReadPermission;
         this.useRepositoryPermissions             = useRepositoryPermissions;
@@ -386,6 +384,9 @@ public List<String> getAdminUserNameList() {
         return adminUserNameList;
     }
 
+    public void setAgentUserName(String agentUserName) {
+        this.agentUserName = agentUserName;
+    }
     public String getAgentUserName() { return agentUserName; }
 
     public boolean isUseRepositoryPermissions() {

src/test/java/org/jenkinsci/plugins/GithubAuthorizationStrategyTest.java

@@ -32,14 +32,14 @@ of this software and associated documentation files (the "Software"), to deal
 public class GithubAuthorizationStrategyTest {
     @Test
     public void testEquals_true() {
-        GithubAuthorizationStrategy a = new GithubAuthorizationStrategy("",  "", false, true, false, "", false, false, false, false);
-        GithubAuthorizationStrategy b = new GithubAuthorizationStrategy("", "", false, true, false, "", false, false, false, false);
+        GithubAuthorizationStrategy a = new GithubAuthorizationStrategy("", false, true, false, "", false, false, false, false);
+        GithubAuthorizationStrategy b = new GithubAuthorizationStrategy("", false, true, false, "", false, false, false, false);
         assertEquals(a, b);
     }
     @Test
     public void testEquals_false() {
-        GithubAuthorizationStrategy a = new GithubAuthorizationStrategy("", "", false, true, false, "", false, false, false, false);
-        GithubAuthorizationStrategy b = new GithubAuthorizationStrategy("", "", false, false, false, "", false, false, false, false);
+        GithubAuthorizationStrategy a = new GithubAuthorizationStrategy("", false, true, false, "", false, false, false, false);
+        GithubAuthorizationStrategy b = new GithubAuthorizationStrategy("", false, false, false, "", false, false, false, false);
         assertNotEquals(a, b);
         assertNotEquals("", a);
     }

src/test/java/org/jenkinsci/plugins/GithubRequireOrganizationMembershipACLTest.java

@@ -131,9 +131,8 @@ private void mockJenkins(MockedStatic<Jenkins> mockedJenkins) {
             new GrantedAuthority[]{new GrantedAuthorityImpl("anonymous")});
 
     private GithubRequireOrganizationMembershipACL createACL() {
-        return new GithubRequireOrganizationMembershipACL(
+        GithubRequireOrganizationMembershipACL acl = new GithubRequireOrganizationMembershipACL(
                 "admin",
-                "agent",
                 "myOrg",
                 authenticatedUserReadPermission,
                 useRepositoryPermissions,
@@ -142,6 +141,8 @@ private GithubRequireOrganizationMembershipACL createACL() {
                 allowAnonymousCCTrayPermission,
                 allowAnonymousReadPermission,
                 allowAnonymousJobStatusPermission);
+        acl.setAgentUserName("agent");
+        return acl;
     }
 
     private GithubRequireOrganizationMembershipACL aclForProject(Project project) {