Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
Merge pull request #18 from conan-z/ldapNoDockerTest
[FIXED JENKINS-25576] A Ldap plugin test that runs with LDAP server is added.
  • Loading branch information
olivergondza committed Nov 18, 2014
2 parents 0fb931e + 3d8e0bd commit a651ba8
Show file tree
Hide file tree
Showing 5 changed files with 369 additions and 15 deletions.
181 changes: 181 additions & 0 deletions src/main/java/org/jenkinsci/test/acceptance/plugins/ldap/LdapEnv.java
@@ -0,0 +1,181 @@
/*
* The MIT License
*
* Copyright (c) 2014 Ericsson
*
* 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 org.jenkinsci.test.acceptance.plugins.ldap;

import static org.junit.Assume.assumeNotNull;

/**
* Thread-unsafe singleton serving ldap-prefixed test env args.
*
* @author Bowen.Cheng@ericsson.com
*/
public class LdapEnv {

private static final int DEFAULT_LDAP_PORT = 3268;
private static final String TRUE = "true";
private static final String FALSE = "false";
private static final String PARSE_USER_ATTRIBUTE_STRATEGY = "ParseUserAttribute";
private static final String SEARCH_FOR_GROUPS_STRATEGY = "SearchForGroups";

private static LdapDetails ldapDetails = null;
private static LdapEnv ldapEnv = null;

private String user;
private String password;
private String group;

private LdapEnv() {
user = System.getenv("ldapUser");
password = System.getenv("ldapPassword");
group = System.getenv("ldapGroup");
}

/**
* @return Existing ldapEnv object or a newly constructed one with given environment variables
*/
public static LdapEnv getLdapEnv() {
if(ldapEnv == null) {
ldapEnv = new LdapEnv();
}
return ldapEnv;
}

/**
* @return Existing ldapDetails object or a newly constructed one with given environment variables
*/
public static LdapDetails getLdapDetails() {
if(ldapDetails == null) {
ldapDetails = new LdapEnv().constructLdapDetails();
}
return ldapDetails;
}

/**
* @return user name by "-ldapUser" attribute
*/
public String getUser() {
assumeNotNull(user);
return user;
}

/**
* @return password used for logging in by "-ldapPassword" attribute
*/
public String getPassword() {
assumeNotNull(password);
return password;
}

/**
* @return user group by "-ldapGroup" attribute
*/
public String getGroup() {
assumeNotNull(group);
return group;
}

private LdapDetails constructLdapDetails() {
String host = System.getenv("ldapHost");
int port = parseInteger(System.getenv("ldapPort"), DEFAULT_LDAP_PORT);

LdapDetails ldapDetails = new LdapDetails(
host, port,
System.getenv("ldapManagerDn"),
System.getenv("ldapManagerPassword"),
System.getenv("ldapRootDn")
);
ldapDetails.setHostWithPort(host + ":" + port);
ldapDetails.setUserSearchBase(System.getenv("ldapUserSearchBase"));
ldapDetails.setUserSearchFilter(System.getenv("ldapUserSearchFilter"));
ldapDetails.setGroupSearchBase(System.getenv("ldapGroupSearchBase"));
ldapDetails.setGroupSearchFilter(System.getenv("ldapGroupSearchFilter"));
ldapDetails.setGroupMembershipStrategy(parseGroupMembershipStrategy(System.getenv("ldapGroupMembershipStrategy")));
ldapDetails.setGroupMembershipStrategyParam(System.getenv("ldapGroupMembershipStrategyParam"));
ldapDetails.setGroupMembershipFilter(System.getenv("ldapGroupMembershipFilter"));
ldapDetails.setDisplayNameAttributeName(System.getenv("ldapDisplayNameAttributeName"));
ldapDetails.setMailAddressAttributeName(System.getenv("ldapMailAddressAttributeName"));
ldapDetails.setDisableLdapEmailResolver(parseBoolean(System.getenv("ldapDisableLdapEmailResolver"), false));
ldapDetails.setEnableCache(parseBoolean(System.getenv("ldapEnableCache"), false));
ldapDetails.setCacheSize(parseInteger(System.getenv("ldapCacheSize"), 20));
ldapDetails.setCacheTTL(parseInteger(System.getenv("ldapCacheTTL"), 300));

return ldapDetails;
}

private Class parseGroupMembershipStrategy(String strategy) {
Class<? extends LdapGroupMembershipStrategy> strategyClass = null;

if (isEmptyOrNullString(strategy)) {
return strategyClass;
}

if (strategy.compareToIgnoreCase(PARSE_USER_ATTRIBUTE_STRATEGY) == 0) {
strategyClass = ParseUserAttributeLdapGroupMembershipStrategy.class;
} else if (strategy.compareToIgnoreCase(SEARCH_FOR_GROUPS_STRATEGY) == 0) {
strategyClass = SearchForGroupsLdapGroupMembershipStrategy.class;
}

return strategyClass;
}

/**
* Parse string representation of a boolean
*
* @param booleanString string representation of a boolean to be parsed
* @param defaultValue the value to be returned if there is any parse exception
* @return boolean value parsed
*/
private boolean parseBoolean(String booleanString, boolean defaultValue) {
boolean result = defaultValue;

if(isEmptyOrNullString(booleanString)) {
return result;
}
if(booleanString.compareToIgnoreCase(TRUE) == 0 || booleanString.compareToIgnoreCase(FALSE) == 0) {
result = Boolean.parseBoolean(booleanString);
}
return result;
}

/**
* Parse string representation of a integer
*
* @param intString string representation of a integer to be parsed
* @param defaultValue the value to be returned if there is any parse exception
* @return integer value after parsed
*/
private int parseInteger(String intString, int defaultValue) {
int result;
try {
result = Integer.parseInt(intString);
} catch (NumberFormatException e) {
result = defaultValue;
}
return result;
}

private boolean isEmptyOrNullString(String target) {
return target == null || target.isEmpty();
}
}
Expand Up @@ -11,4 +11,19 @@ public class ProjectBasedMatrixAuthorizationStrategy extends MatrixAuthorization
public ProjectBasedMatrixAuthorizationStrategy(GlobalSecurityConfig context, String path) {
super(context, path);
}

/**
* Add and authorize given user admin role under "Project-based Matrix Authorization Strategy"
*
* @param user user to be added and authorized as admin
* @param security page object
* @return security page object
*/
public static GlobalSecurityConfig authorizeUserAsAdmin(String user, GlobalSecurityConfig security) {
ProjectBasedMatrixAuthorizationStrategy auth;
auth = security.useAuthorizationStrategy(ProjectBasedMatrixAuthorizationStrategy.class);
MatrixRow userAuth = auth.addUser(user);
userAuth.admin();
return security;
}
}
Expand Up @@ -21,20 +21,20 @@
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/
package org.jenkinsci.test.acceptance.plugins.active_directory;
package org.jenkinsci.test.acceptance.utils.pluginTests;

import org.jenkinsci.test.acceptance.po.Control;
import org.jenkinsci.test.acceptance.po.Jenkins;
import org.jenkinsci.test.acceptance.po.PageObject;

/**
* Page Object for AD security (global) configuration page.
* Page Object for security (global) configuration page.
* @author Marco.Miller@ericsson.com
*/
public class ActiveDirectorySecurity extends PageObject {
public class SecurityDisabler extends PageObject {
public final Jenkins jenkins;

public ActiveDirectorySecurity(Jenkins jenkins) {
public SecurityDisabler(Jenkins jenkins) {
super(jenkins.injector,jenkins.url("configureSecurity"));
this.jenkins = jenkins;
}
Expand Down
24 changes: 13 additions & 11 deletions src/test/java/plugins/ActiveDirectoryTest.java
Expand Up @@ -26,9 +26,8 @@
import org.jenkinsci.test.acceptance.junit.AbstractJUnitTest;
import org.jenkinsci.test.acceptance.junit.WithPlugins;
import org.jenkinsci.test.acceptance.plugins.active_directory.ActiveDirectoryEnv;
import org.jenkinsci.test.acceptance.plugins.active_directory.ActiveDirectorySecurity;
import org.jenkinsci.test.acceptance.utils.pluginTests.SecurityDisabler;
import org.jenkinsci.test.acceptance.plugins.active_directory.ActiveDirectorySecurityRealm;
import org.jenkinsci.test.acceptance.plugins.matrix_auth.MatrixRow;
import org.jenkinsci.test.acceptance.plugins.matrix_auth.ProjectBasedMatrixAuthorizationStrategy;
import org.jenkinsci.test.acceptance.po.GlobalSecurityConfig;
import org.junit.After;
Expand Down Expand Up @@ -63,11 +62,11 @@
*/
@WithPlugins("active-directory@1.38")
public class ActiveDirectoryTest extends AbstractJUnitTest {
private ActiveDirectorySecurity adSecurity;
private SecurityDisabler securityDisabler;

@Before
public void setUp() {
adSecurity = new ActiveDirectorySecurity(jenkins);
securityDisabler = new SecurityDisabler(jenkins);
}

/**
Expand Down Expand Up @@ -124,7 +123,7 @@ public void wannabe_cannot_login_to_Jenkins_after_AD_security_configured() {

@After
public void tearDown() {
adSecurity.stopUsingSecurityAndSave();
securityDisabler.stopUsingSecurityAndSave();
}

private void userCanLoginToJenkinsAsAdmin(String userOrGroupToAddAsAdmin) {
Expand All @@ -137,15 +136,18 @@ private void userCanLoginToJenkinsAsAdmin(String userOrGroupToAddAsAdmin) {
assertThat(domain.getAttribute("value"), is(equalTo(ActiveDirectoryEnv.get().getDomain())));
}

private GlobalSecurityConfig saveSecurityConfig(String user) {
private GlobalSecurityConfig saveSecurityConfig(String userOrGroupToAddAsAdmin) {
GlobalSecurityConfig security = new GlobalSecurityConfig(jenkins);
security.configure();//open
security.configure();
security = ProjectBasedMatrixAuthorizationStrategy.authorizeUserAsAdmin(userOrGroupToAddAsAdmin, security);
security = configSecurityRealm(security);
security.save();
return security;
}

private GlobalSecurityConfig configSecurityRealm(GlobalSecurityConfig security) {
ActiveDirectorySecurityRealm realm = security.useRealm(ActiveDirectorySecurityRealm.class);
realm.configure();
ProjectBasedMatrixAuthorizationStrategy auth = security.useAuthorizationStrategy(ProjectBasedMatrixAuthorizationStrategy.class);
MatrixRow userAuth = auth.addUser(user);
userAuth.admin();
security.save();
return security;
}
}

0 comments on commit a651ba8

Please sign in to comment.