Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[JENKINS-24195] Ignoring irrelevant Active Directory groups
Added an option to make Jenkins ignore Active Directory groups that are not being used by the active Authorization Strategy. This can significantly improve performance in environments with a large number of groups but a small number of corresponding rules defined by the Authorization Strategy. Performance tests have been made in an enviroment with Role Based Authorization Strategy, 7000 jobs and 280 AD groups (where only one of the last groups is used by the AuthorizationStrategy). The average loading time of an empty List View went from 6.2 seconds to 0.2 seconds. An sectioned view with 15 sections of text went from 36 seconds to 0.6 seconds. When Matrix Based Authorization was used instead, loading time of the sectioned view went down from 1.2 seconds to 0.1 seconds.
- Loading branch information
1 parent
5679654
commit a256199
Showing
6 changed files
with
214 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
6 changes: 6 additions & 0 deletions
6
...on/plugins/active_directory/ActiveDirectorySecurityRealm/help-removeIrrelevantGroups.html
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| <div> | ||
| Makes Jenkins ignore every user's Active Directory groups that are not being used by the active Authorization Strategy. | ||
| This can significantly improve performance in environments with a large number of groups | ||
| but a small number of corresponding rules defined by the Authorization Strategy. | ||
| The user is required to re-login in order for the changes to take effect. | ||
| </div> |
140 changes: 140 additions & 0 deletions
140
src/test/java/hudson/plugins/active_directory/RemoveIrrelevantGroupsTest.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,140 @@ | ||
| /* | ||
| * The MIT License | ||
| * | ||
| * Copyright (c) 2014 Sony Mobile Communications Inc. All rights reserved. | ||
| * | ||
| * Permission is hereby granted, free of charge, to any person obtaining a copy | ||
| * of this software and associated documentation files (the "Software"), to deal | ||
| * in the Software without restriction, including without limitation the rights | ||
| * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
| * copies of the Software, and to permit persons to whom the Software is | ||
| * furnished to do so, subject to the following conditions: | ||
| * | ||
| * The above copyright notice and this permission notice shall be included in | ||
| * all copies or substantial portions of the Software. | ||
| * | ||
| * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
| * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
| * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
| * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
| * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN | ||
| * THE SOFTWARE. | ||
| */ | ||
|
|
||
| package hudson.plugins.active_directory; | ||
|
|
||
| import hudson.security.AuthorizationStrategy; | ||
| import org.acegisecurity.GrantedAuthority; | ||
| import org.acegisecurity.GrantedAuthorityImpl; | ||
| import org.junit.Before; | ||
| import org.junit.Rule; | ||
| import org.junit.Test; | ||
| import org.junit.runner.RunWith; | ||
| import org.jvnet.hudson.test.JenkinsRule; | ||
| import org.powermock.api.mockito.PowerMockito; | ||
| import org.powermock.core.classloader.annotations.PowerMockIgnore; | ||
| import org.powermock.modules.junit4.PowerMockRunner; | ||
|
|
||
| import java.util.Arrays; | ||
| import java.util.HashSet; | ||
| import java.util.Set; | ||
|
|
||
| import static org.junit.Assert.assertArrayEquals; | ||
| import static org.junit.Assert.assertEquals; | ||
| import static org.powermock.api.mockito.PowerMockito.when; | ||
|
|
||
| /** | ||
| * Tests for the "Remove Irrelevant Groups" feature. | ||
| * | ||
| * @author Fredrik Persson <fredrik6.persson@sonymobile.com> | ||
| */ | ||
| @RunWith(PowerMockRunner.class) | ||
| @PowerMockIgnore("javax.crypto.*") | ||
| public class RemoveIrrelevantGroupsTest { | ||
|
|
||
| @Rule | ||
| public JenkinsRule jenkinsRule = new JenkinsRule(); | ||
|
|
||
| /** | ||
| * Sets up Jenkins with an {@link ActiveDirectorySecurityRealm}. | ||
| */ | ||
| @Before | ||
| public void setUp() { | ||
| ActiveDirectorySecurityRealm securityRealm = new ActiveDirectorySecurityRealm("domain.com", null, null, | ||
| null, null, GroupLookupStrategy.AUTO, true); | ||
| jenkinsRule.getInstance().setSecurityRealm(securityRealm); | ||
| } | ||
|
|
||
| /** | ||
| * Makes Jenkins.getInstance().getAuthorizationStrategy.getGroups() | ||
| * return argument groups. | ||
| */ | ||
| private void setUpJenkinsUsedGroups(String... groups) { | ||
| Set<String> usedGroups = new HashSet<String>(); | ||
| for (String group : groups) { | ||
| usedGroups.add(group); | ||
| } | ||
|
|
||
| AuthorizationStrategy authorizationStrategy = PowerMockito.mock(AuthorizationStrategy.class); | ||
| when(authorizationStrategy.getGroups()).thenReturn(usedGroups); | ||
| jenkinsRule.getInstance().setAuthorizationStrategy(authorizationStrategy); | ||
| } | ||
|
|
||
| /** | ||
| * Verifies that only the relevant user groups are set when calling the | ||
| * constructor for {@link ActiveDirectoryUserDetail} and there are | ||
| * some relevant groups. | ||
| */ | ||
| @Test | ||
| public void testSomeGroupsAreRelevant() { | ||
| setUpJenkinsUsedGroups("UsedGroup-1", "UsedGroup-2"); | ||
|
|
||
| GrantedAuthority[] userGroups = { | ||
| new GrantedAuthorityImpl("UsedGroup-1"), | ||
| new GrantedAuthorityImpl("UsedGroup-2"), | ||
| new GrantedAuthorityImpl("UnusedGroup")}; | ||
|
|
||
| ActiveDirectoryUserDetail user = new ActiveDirectoryUserDetail("Username", null, | ||
| true, true, true, true, userGroups, null, null, null); | ||
|
|
||
| GrantedAuthority[] relevantUserGroups = Arrays.copyOf(userGroups, 2); //The first two are relevant | ||
| assertArrayEquals(relevantUserGroups, user.getAuthorities()); | ||
| } | ||
|
|
||
| /** | ||
| * Verifies that no user groups are set when calling the | ||
| * constructor for {@link ActiveDirectoryUserDetail} and there are no | ||
| * relevant groups. | ||
| */ | ||
| @Test | ||
| public void testNoGroupsAreRelevant() { | ||
| setUpJenkinsUsedGroups("UsedGroup-1", "UsedGroup-2"); | ||
|
|
||
| GrantedAuthority[] userGroups = { | ||
| new GrantedAuthorityImpl("UnusedGroup")}; | ||
|
|
||
| ActiveDirectoryUserDetail user = new ActiveDirectoryUserDetail("Username", null, | ||
| true, true, true, true, userGroups, null, null, null); | ||
|
|
||
| assertEquals(0, user.getAuthorities().length); | ||
| } | ||
|
|
||
| /** | ||
| * Verifies that all argument groups are set when {@link AuthorizationStrategy#getGroups()} | ||
| * returns an empty list. | ||
| */ | ||
| @Test | ||
| public void testNoGroupsAreRegistered() { | ||
| setUpJenkinsUsedGroups(); //No registered groups by the AuthorizationStrategy. | ||
|
|
||
| GrantedAuthority[] userGroups = { | ||
| new GrantedAuthorityImpl("UnusedGroup")}; | ||
|
|
||
| ActiveDirectoryUserDetail user = new ActiveDirectoryUserDetail("Username", null, | ||
| true, true, true, true, userGroups, null, null, null); | ||
|
|
||
| assertArrayEquals(userGroups, user.getAuthorities()); | ||
| } | ||
|
|
||
| } |