Skip to content

Throw exception when specified ldif file does not exist #8434

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 18 commits into from
Closed

Throw exception when specified ldif file does not exist #8434

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
753a927
Added file Test that I understand is needed - this is is for understa…
Apr 25, 2020
4a6b497
Following inputs I have done the followings:
May 2, 2020
ab67520
adding formating
May 4, 2020
075458b
Merge branch 'master' of https://github.com/spring-projects/spring-se…
May 5, 2020
921fbab
Adding ldap fix to UnboundIdContainer class and adding tests to Unbou…
May 6, 2020
10d3492
adding some test and fix missing context on destory
May 11, 2020
8db1207
Merge branch 'master' of https://github.com/spring-projects/spring-se…
May 11, 2020
2a8c5dd
Fixing the tests
May 17, 2020
c99b252
Fix test
May 18, 2020
9fac54f
fixing ldif loading issue
May 27, 2020
7429f9e
Merge branch 'master' of https://github.com/spring-projects/spring-se…
May 28, 2020
bc8e099
Adding more tests and better validation
Jun 1, 2020
23ac382
attempt to fix the issue + add to git ignore /lib/ and .hprof files
Jun 8, 2020
179a466
attempt to resolve issue
Jun 16, 2020
e4c9d81
Merge branch 'master' of https://github.com/spring-projects/spring-se…
Jun 16, 2020
0efb886
attempt fix 1
Jun 20, 2020
1fa8a4b
handle requested rejects
Jul 14, 2020
479d2bc
Merge branch 'master' of https://github.com/spring-projects/spring-se…
Jul 14, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
96 changes: 87 additions & 9 deletions ...tegration-test/java/org/springframework/security/ldap/server/UnboundIdContainerTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,43 +15,76 @@
*/
package org.springframework.security.ldap.server;

import com.unboundid.ldap.sdk.LDAPException;
import java.io.IOException;
import java.net.ServerSocket;
import java.util.ArrayList;
import java.util.List;

import org.junit.Test;

import org.springframework.context.support.GenericApplicationContext;

import static org.assertj.core.api.Assertions.assertThat;
import static org.assertj.core.api.Assertions.failBecauseExceptionWasNotThrown;

/**
* @author Eddú Meléndez
* @author Shay Dratler
*/
public class UnboundIdContainerTests {

private final String validLdifClassPath = "classpath:test-server.ldif";
private final String validRootDn = "dc=springframework,dc=org";
private final String validLdifFileClassPathTop = "classpath:test-server-custom-attribute-types.ldif";

@Test
public void startLdapServer() throws Exception {
UnboundIdContainer server = new UnboundIdContainer("dc=springframework,dc=org",
"classpath:test-server.ldif");
server.setApplicationContext(new GenericApplicationContext());
List<Integer> ports = getDefaultPorts(1);
server.setPort(ports.get(0));
UnboundIdContainer server = new UnboundIdContainer(
validRootDn, validLdifClassPath);
createAndRunServer(server);
}


@Test
public void afterPropertiesSetWhenPortIsZeroThenRandomPortIsSelected() throws Exception {
UnboundIdContainer server = new UnboundIdContainer(validRootDn, validLdifClassPath);
server.setApplicationContext(new GenericApplicationContext());
server.setPort(0);
try {
server.afterPropertiesSet();
assertThat(server.getPort()).isEqualTo(ports.get(0));
assertThat(server.getPort()).isNotEqualTo(0);
} finally {
server.destroy();
}
}

@Test
public void afterPropertiesSetWhenPortIsZeroThenRandomPortIsSelected() throws Exception {
UnboundIdContainer server = new UnboundIdContainer("dc=springframework,dc=org", null);
public void startLdapServerWithoutLdif() throws Exception {
UnboundIdContainer server = new UnboundIdContainer(
validRootDn, null);
createAndRunServer(server);
}

@Test
public void startLdapServerMixedLdif() throws Exception {
UnboundIdContainer server = new UnboundIdContainer(
validRootDn, validLdifFileClassPathTop);
server.setApplicationContext(new GenericApplicationContext());
server.setPort(0);
try {
server.afterPropertiesSet();
failBecauseExceptionWasNotThrown(LDAPException.class);
} catch (Exception e) {
assertThat(e.getCause()).isInstanceOf(LDAPException.class);
} finally {
server.destroy();
}
}

@Test
public void missingContextInInit() {
UnboundIdContainer server = new UnboundIdContainer(validRootDn, null);
server.setPort(0);
try {
server.afterPropertiesSet();
assertThat(server.getPort()).isNotEqualTo(0);
Expand All @@ -60,6 +93,38 @@ public void afterPropertiesSetWhenPortIsZeroThenRandomPortIsSelected() throws Ex
}
}

@Test
public void testMissingLdapFile() {
UnboundIdContainer server = new UnboundIdContainer(validRootDn, "classpath:missing-file.ldif");
server.setApplicationContext(new GenericApplicationContext());
server.setPort(0);
try {
server.afterPropertiesSet();
failBecauseExceptionWasNotThrown(IllegalArgumentException.class);
} catch (Exception e) {
assertThat(e.getCause()).isInstanceOf(IllegalArgumentException.class);
assertThat(e.getMessage()).contains("Unable to load LDIF classpath:missing-file.ldif");
} finally {
server.destroy();
}
}


@Test
public void testInvalidLdapFile() {
UnboundIdContainer server = new UnboundIdContainer(validRootDn, "classpath:test-server-malformed.txt");
server.setApplicationContext(new GenericApplicationContext());
server.setPort(0);
try {
server.afterPropertiesSet();
failBecauseExceptionWasNotThrown(LDAPException.class);
} catch (Exception e) {
assertThat(e.getCause()).isInstanceOf(LDAPException.class);
} finally {
server.destroy();
}
}

private List<Integer> getDefaultPorts(int count) throws IOException {
List<ServerSocket> connections = new ArrayList<>();
List<Integer> availablePorts = new ArrayList<>(count);
Expand All @@ -77,4 +142,17 @@ private List<Integer> getDefaultPorts(int count) throws IOException {
}
}

private void createAndRunServer(UnboundIdContainer server) throws IOException {
server.setApplicationContext(new GenericApplicationContext());
List<Integer> ports = getDefaultPorts(1);
server.setPort(ports.get(0));

try {
server.afterPropertiesSet();
assertThat(server.getPort()).isEqualTo(ports.get(0));
} finally {
server.destroy();
}
}

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please add a test for the original issue.
The test should create an UnboundIdContainer with an LDIF that does not exist, and ensure that an exception is thrown.

}
38 changes: 28 additions & 10 deletions ldap/src/main/java/org/springframework/security/ldap/server/UnboundIdContainer.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,16 +15,17 @@
*/
package org.springframework.security.ldap.server;

import java.io.InputStream;
import static org.springframework.util.StringUtils.isEmpty;

import java.io.IOException;
import java.io.InputStream;
import com.unboundid.ldap.listener.InMemoryDirectoryServer;
import com.unboundid.ldap.listener.InMemoryDirectoryServerConfig;
import com.unboundid.ldap.listener.InMemoryListenerConfig;
import com.unboundid.ldap.sdk.DN;
import com.unboundid.ldap.sdk.Entry;
import com.unboundid.ldap.sdk.LDAPException;
import com.unboundid.ldif.LDIFReader;

import org.springframework.beans.BeansException;
import org.springframework.beans.factory.DisposableBean;
import org.springframework.beans.factory.InitializingBean;
Expand All @@ -36,6 +37,7 @@

/**
* @author Eddú Meléndez
* @contributer Shay Dratler
*/
public class UnboundIdContainer implements InitializingBean, DisposableBean, Lifecycle,
ApplicationContextAware {
Expand All @@ -57,6 +59,7 @@ public UnboundIdContainer(String defaultPartitionSuffix, String ldif) {
this.ldif = ldif;
}


public int getPort() {
return this.port;
}
Expand All @@ -67,7 +70,9 @@ public void setPort(int port) {

@Override
public void destroy() {
stop();
if (null != directoryServer) {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's keep this commit focused on throwing an exception with the LDIF file does not exist.
This doesn't seem like it is part of that.

stop();
}
}

@Override
Expand All @@ -85,7 +90,6 @@ public void start() {
if (isRunning()) {
return;
}

try {
InMemoryDirectoryServerConfig config = new InMemoryDirectoryServerConfig(this.defaultPartitionSuffix);
config.addAdditionalBindCredentials("uid=admin,ou=system", "secret");
Expand All @@ -109,22 +113,36 @@ public void start() {
} catch (LDAPException ex) {
throw new RuntimeException("Server startup failed", ex);
}

}

private void importLdif(InMemoryDirectoryServer directoryServer) {
if (StringUtils.hasText(this.ldif)) {
try {
Resource[] resources = this.context.getResources(this.ldif);
if (resources.length > 0 && resources[0].exists()) {
try (InputStream inputStream = resources[0].getInputStream()) {
directoryServer.importFromLDIF(false, new LDIFReader(inputStream));
}
Resource resource = locateResource();
try (InputStream inputStream = resource.getInputStream()) {
directoryServer.importFromLDIF(false, new LDIFReader(inputStream));
}
} catch (Exception ex) {
throw new IllegalStateException("Unable to load LDIF " + this.ldif, ex);
}
}

}

private Resource locateResource() throws IOException, NullPointerException {
Resource[] resources = this.context.getResources(this.ldif);
if (0 == resources.length) {
throw new IllegalArgumentException("requested resource is not found");
}
for (Resource resource : resources) {
if (!isEmpty(resource.getFilename())
&& resource.isFile()
&& resource.exists()
&& resource.isReadable()) {
return resource;
}
}
throw new IllegalArgumentException("Unable to load LDIF :" + this.ldif);
}

@Override
Expand Down