first working test

Author: Vladimir Kotal

plugins/src/main/java/opengrok/auth/plugin/LdapAttrPlugin.java

@@ -52,11 +52,11 @@ public class LdapAttrPlugin extends AbstractLdapPlugin {
 
     private static final Logger LOGGER = Logger.getLogger(LdapAttrPlugin.class.getName());
 
-    protected static final String ATTR_PARAM = "attribute"; // LDAP attribute name to check
-    protected static final String FILE_PARAM = "file";
-    private static final String INSTANCE = "instance";
+    static final String ATTR_PARAM = "attribute"; // LDAP attribute name to check
+    static final String FILE_PARAM = "file";
+    static final String INSTANCE_PARAM = "instance";
 
-    private static final String SESSION_ALLOWED_PREFIX = "opengrok-attr-plugin-allowed";
+    static final String SESSION_ALLOWED_PREFIX = "opengrok-ldap-attr-plugin-allowed";
     private String sessionAllowed = SESSION_ALLOWED_PREFIX;
 
     /**
@@ -99,7 +99,7 @@ void init(Map<String, Object> parameters) {
             throw new NullPointerException("Missing param [" + FILE_PARAM + "] in the setup");
         }
 
-        String instance = (String) parameters.get(INSTANCE);
+        String instance = (String) parameters.get(INSTANCE_PARAM);
         if (instance != null) {
             ldapUserInstance = Integer.parseInt(instance);
         }
@@ -120,10 +120,14 @@ protected boolean sessionExists(HttpServletRequest req) {
                 && req.getSession().getAttribute(sessionAllowed) != null;
     }
 
-    private String getSessionAttr() {
+    private String getSessionAttrName() {
         return (LdapUserPlugin.SESSION_ATTR + (ldapUserInstance != null ? ldapUserInstance.toString() : ""));
     }
 
+    String getSessionAllowedAttrName() {
+        return sessionAllowed;
+    }
+
     @SuppressWarnings("unchecked")
     @Override
     public void fillSession(HttpServletRequest req, User user) {
@@ -134,7 +138,7 @@ public void fillSession(HttpServletRequest req, User user) {
 
         updateSession(req, false);
 
-        if ((ldapUser = (LdapUser) req.getSession().getAttribute(getSessionAttr())) == null) {
+        if ((ldapUser = (LdapUser) req.getSession().getAttribute(getSessionAttrName())) == null) {
             LOGGER.log(Level.WARNING, "cannot get {0} attribute", LdapUserPlugin.SESSION_ATTR);
             return;
         }

plugins/src/main/java/opengrok/auth/plugin/LdapUserPlugin.java

@@ -208,7 +208,7 @@ protected void updateSession(HttpServletRequest req, LdapUser user) {
         req.getSession().setAttribute(getSessionAttr(), user);
     }
 
-    private String getSessionAttr() {
+    String getSessionAttr() {
         return (SESSION_ATTR + (instance != null ? instance.toString() : ""));
     }
 

plugins/src/test/java/opengrok/auth/plugin/LdapAttrPluginTest.java

@@ -30,14 +30,19 @@
 import java.nio.file.Files;
 import java.util.Arrays;
 import java.util.Collections;
+import java.util.HashMap;
 import java.util.HashSet;
 import java.util.Map;
+import java.util.Set;
 import java.util.TreeMap;
 import java.util.TreeSet;
 import javax.servlet.http.HttpServletRequest;
 import opengrok.auth.entity.LdapUser;
 import opengrok.auth.plugin.entity.User;
+import opengrok.auth.plugin.ldap.AbstractLdapProvider;
 import opengrok.auth.plugin.ldap.FakeLdapFacade;
+import opengrok.auth.plugin.ldap.LdapException;
+import opengrok.auth.plugin.ldap.LdapFacade;
 import opengrok.auth.plugin.util.DummyHttpServletRequestLdap;
 import org.junit.AfterClass;
 import org.junit.Assert;
@@ -47,6 +52,11 @@
 import org.opengrok.indexer.configuration.Group;
 import org.opengrok.indexer.configuration.Project;
 
+import static org.junit.jupiter.api.Assertions.*;
+import static org.mockito.ArgumentMatchers.*;
+import static org.mockito.Mockito.mock;
+import static org.mockito.Mockito.when;
+
 public class LdapAttrPluginTest {
 
     private HttpServletRequest dummyRequest;
@@ -144,4 +154,51 @@ public void testIsAllowed() {
         Assert.assertTrue(plugin.isAllowed(dummyRequest, makeGroup("Group 1")));
         Assert.assertTrue(plugin.isAllowed(dummyRequest, makeGroup("Group 2")));
     }
+
+    /**
+     * Test the interaction between {@code LdapUserPlugin} and {@code LdapAttrPlugin}, namely:
+     * <ul>
+     *     <li>use of DN from the <code>LdapUser</code> object cached in the session by <code>LdapUserPlugin</code></li>
+     *     <li>configuration of the cached session attribute name</li>
+     * </ul>
+     */
+    @Test
+    public void testAttrLookup() throws LdapException {
+        String attr_to_get = "mail";
+        String instance_num = "42";
+        String mail_attr_value = "[email protected]";
+
+        // Create mock LDAP provider, simulating the work of LdapUserPlugin.
+        AbstractLdapProvider mockprovider = mock(LdapFacade.class);
+        Map<String, Set<String>> attrs = new HashMap<>();
+        attrs.put(attr_to_get, Collections.singleton(mail_attr_value));
+        final String dn = "cn=FOO_BAR,L=EMEA,DC=FOO,DC=COM";
+        AbstractLdapProvider.LdapSearchResult<Map<String, Set<String>>> result =
+                new AbstractLdapProvider.LdapSearchResult<>(dn, attrs);
+        assertNotNull(result);
+        // TODO use Mockito Argument captor ?
+        when(mockprovider.lookupLdapContent(anyString(), any(String[].class))).
+                thenReturn(result);
+
+        // Load the LdapAttrPlugin using the mock LDAP provider.
+        LdapAttrPlugin plugin = new LdapAttrPlugin();
+        Map<String, Object> parameters = new TreeMap<>();
+        parameters.put(LdapAttrPlugin.FILE_PARAM, whitelistFile.getAbsolutePath());
+        parameters.put(LdapAttrPlugin.ATTR_PARAM, attr_to_get);
+        parameters.put(LdapAttrPlugin.INSTANCE_PARAM, instance_num);
+        plugin.load(parameters, mockprovider);
+
+        // TODO prepareRequest() ?
+        LdapUser ldapUser = new LdapUser(dn, null);
+        HttpServletRequest request = new DummyHttpServletRequestLdap();
+        request.getSession().setAttribute(LdapUserPlugin.SESSION_ATTR + instance_num, ldapUser);
+
+        // Here it comes all together.
+        User user = new User("[email protected]", "id");
+        plugin.fillSession(request, user);
+
+        // See if LdapAttrPlugin set its own session attribute based on the mocked query.
+        assertTrue((Boolean)request.getSession().getAttribute(plugin.getSessionAllowedAttrName()));
+        assertTrue(ldapUser.getAttribute(attr_to_get).contains(mail_attr_value));
+    }
 }