Skip to content

gplazma2-ldap: drop dependency on ldap4testing #8176

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

Open
kofemann wants to merge 1 commit into
base: 10.2
Choose a base branch
from
Open

gplazma2-ldap: drop dependency on ldap4testing #8176

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
18 changes: 13 additions & 5 deletions modules/gplazma2-ldap/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,19 @@
<name>gPlazma 2 LDAP plugin</name>

<dependencies>

<dependency>
<groupId>org.openidentityplatform.opendj</groupId>
<artifactId>opendj-core</artifactId>
<scope>test</scope>
</dependency>

<dependency>
<groupId>org.openidentityplatform.opendj</groupId>
<artifactId>opendj-grizzly</artifactId>
<scope>test</scope>
</dependency>

<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-api</artifactId>
Expand All @@ -29,11 +42,6 @@
<artifactId>gplazma2</artifactId>
<version>${project.version}</version>
</dependency>
<dependency>
<groupId>org.dcache</groupId>
<artifactId>ldap4testing</artifactId>
<scope>test</scope>
</dependency>

</dependencies>
</project>
133 changes: 131 additions & 2 deletions modules/gplazma2-ldap/src/test/java/org/dcache/gplazma/plugins/LdapTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright (c) 2017 - 2020 Deutsches Elektronen-Synchroton,
* Copyright (c) 2017 - 2026 Deutsches Elektronen-Synchroton,
* Member of the Helmholtz Association, (DESY), HAMBURG, GERMANY
*
* This library is free software; you can redistribute it and/or modify
Expand Down Expand Up @@ -31,23 +31,33 @@
import static org.dcache.gplazma.plugins.Ldap.LDAP_USER_FILTER;
import static org.dcache.gplazma.plugins.Ldap.LDAP_USER_HOME;
import static org.dcache.gplazma.plugins.Ldap.LDAP_USER_ROOT;
import static org.forgerock.opendj.ldap.CommonLDAPOptions.LDAP_DECODE_OPTIONS;
import static org.forgerock.opendj.ldap.LDAPListener.CONNECT_MAX_BACKLOG;
import static org.hamcrest.MatcherAssert.assertThat;
import static org.hamcrest.Matchers.hasItem;
import static org.hamcrest.Matchers.hasSize;
import static org.hamcrest.Matchers.instanceOf;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertFalse;

import com.forgerock.reactive.ServerConnectionFactoryAdapter;
import com.google.common.base.Throwables;
import com.google.common.collect.Sets;
import com.google.common.util.concurrent.AbstractService;
import java.io.IOException;
import java.io.InputStream;
import java.io.Serializable;
import java.net.InetSocketAddress;
import java.security.Principal;
import java.util.Collections;
import java.util.HashSet;
import java.util.Map;
import java.util.Properties;
import java.util.Set;
import javax.naming.Context;
import javax.naming.NamingException;
import javax.naming.directory.InitialDirContext;
import javax.naming.ldap.InitialLdapContext;
import org.dcache.auth.GidPrincipal;
import org.dcache.auth.GroupNamePrincipal;
import org.dcache.auth.PasswordCredential;
Expand All @@ -57,10 +67,20 @@
import org.dcache.auth.attributes.RootDirectory;
import org.dcache.gplazma.AuthenticationException;
import org.dcache.gplazma.NoSuchPrincipalException;
import org.dcache.ldap4testing.EmbeddedServer;
import org.forgerock.opendj.ldap.Connections;
import org.forgerock.opendj.ldap.LDAPClientContext;
import org.forgerock.opendj.ldap.LDAPListener;
import org.forgerock.opendj.ldap.MemoryBackend;
import org.forgerock.opendj.ldap.RequestContext;
import org.forgerock.opendj.ldap.RequestHandler;
import org.forgerock.opendj.ldap.ServerConnectionFactory;
import org.forgerock.opendj.ldif.LDIFEntryReader;
import org.forgerock.util.Options;
import org.junit.After;
import org.junit.Before;
import org.junit.Test;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
*
Expand Down Expand Up @@ -263,4 +283,113 @@ public void shouldNotGrowNumberOfThreadMoreThanOne()
public void tearDown() {
ldapServer.stop();
}


/**
* Embedded LDAP server for testing purposes.
*/
private static class EmbeddedServer extends AbstractService {

private static final Logger LOGGER = LoggerFactory.getLogger(LdapTest.class);

/**
* TCP port number to listen.
*/
private final int port;

/**
* LDAP server listener.
*/
private LDAPListener listener;

/**
* Reader which provides initial data in LDIF format.
*/
private final InputStream ldifSource;

public EmbeddedServer(int port, InputStream ldifSource) {
this.port = port;
this.ldifSource = ldifSource;
}

@Override
protected void doStart() {
LOGGER.debug("Starting new embedded LDAP server on port; {}", port);
try {

final Options options = Options.defaultOptions().set(CONNECT_MAX_BACKLOG, 4096);

final LDIFEntryReader entryReader = new LDIFEntryReader(ldifSource);
final RequestHandler<RequestContext> requestHandler = new MemoryBackend(entryReader);
final ServerConnectionFactory<LDAPClientContext, Integer> connectionFactory = Connections.newServerConnectionFactory(requestHandler);

listener = new LDAPListener(port, new ServerConnectionFactoryAdapter(options.get(LDAP_DECODE_OPTIONS), connectionFactory), options);
notifyStarted();
} catch (IOException e) {
notifyFailed(e);
}

}

@Override
protected void doStop() {
LOGGER.debug("Starting new embedded LDAP server.");
listener.close();
notifyStopped();
}

/**
* An implementation of {@link InputStream}, which is always empty.
*/
private static class EmptyStream extends InputStream {

@Override
public void close() throws IOException {
// NOP;
}

@Override
public int read() throws IOException {
return -1;
}
}

public void start() throws IOException {
try {
this.startAsync().awaitRunning();
} catch (IllegalStateException e) {
Throwable t = this.failureCause();
Throwables.throwIfInstanceOf(t, IOException.class);
Throwables.throwIfUnchecked(t);
}
}

public void stop() {
this.stopAsync().awaitTerminated();
}

public InetSocketAddress getSocketAddress() {
return (InetSocketAddress)listener.getSocketAddresses().stream().findFirst().get();
}

/**
* Get {@link InitialDirContext} to connected to this LDAP server
* @param dn LDAP user used to connect to the server
* @param pass user's password
* @return directory context
* @throws NamingException
*/
public InitialDirContext getDirContext(String dn, String pass) throws NamingException {
Properties env = new Properties();
env.put(Context.INITIAL_CONTEXT_FACTORY, "com.sun.jndi.ldap.LdapCtxFactory");
env.put(Context.PROVIDER_URL, String.format("ldap://localhost:%d/",
getSocketAddress().getPort()));
env.put("com.sun.jndi.ldap.connect.pool", "true");
env.put("com.sun.jndi.ldap.connect.pool.maxsize", "10");
env.put(Context.SECURITY_AUTHENTICATION, "simple");
env.put(Context.SECURITY_PRINCIPAL, dn);
env.put(Context.SECURITY_CREDENTIALS, pass);
return new InitialLdapContext(env, null);
}
}
}
15 changes: 12 additions & 3 deletions pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,6 +101,7 @@
<datanucleus.plugin.version>6.0.0-release</datanucleus.plugin.version>
<asm.version>9.5</asm.version>
<asm-tools.version>5.0.3</asm-tools.version>
<opendj.version>5.1.2</opendj.version>
</properties>

<scm>
Expand Down Expand Up @@ -821,11 +822,19 @@
</exclusion>
</exclusions>
</dependency>

<dependency>
<groupId>org.dcache</groupId>
<artifactId>ldap4testing</artifactId>
<version>1.0</version>
<groupId>org.openidentityplatform.opendj</groupId>
<artifactId>opendj-core</artifactId>
<version>${opendj.version}</version>
</dependency>

<dependency>
<groupId>org.openidentityplatform.opendj</groupId>
<artifactId>opendj-grizzly</artifactId>
<version>${opendj.version}</version>
</dependency>

<!-- used by alarms, needs to be deployed -->
<dependency>
<groupId>javax.mail</groupId>
Expand Down