/**
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.apache.hadoop.security;

import static org.mockito.Matchers.anyString;

import static org.mockito.Mockito.any;
import static org.mockito.Mockito.contains;
import static org.mockito.Mockito.eq;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.times;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.when;

import java.io.IOException;
import java.util.Arrays;
import java.util.List;

import javax.naming.NamingException;
import javax.naming.directory.Attribute;
import javax.naming.directory.Attributes;
import javax.naming.directory.SearchControls;
import javax.naming.directory.SearchResult;

import org.apache.hadoop.conf.Configuration;
import org.junit.Assert;
import org.junit.Before;
import org.junit.Test;

@SuppressWarnings("unchecked")
public class TestLdapGroupsMappingWithPosixGroup
  extends TestLdapGroupsMappingBase {

  @Before
  public void setupMocks() throws NamingException {
    SearchResult mockUserResult = mock(SearchResult.class);
    when(mockUserNamingEnum.nextElement()).thenReturn(mockUserResult);

    Attribute mockUidNumberAttr = mock(Attribute.class);
    Attribute mockGidNumberAttr = mock(Attribute.class);
    Attribute mockUidAttr = mock(Attribute.class);
    Attributes mockAttrs = mock(Attributes.class);

    when(mockUidAttr.get()).thenReturn("some_user");
    when(mockUidNumberAttr.get()).thenReturn("700");
    when(mockGidNumberAttr.get()).thenReturn("600");
    when(mockAttrs.get(eq("uid"))).thenReturn(mockUidAttr);
    when(mockAttrs.get(eq("uidNumber"))).thenReturn(mockUidNumberAttr);
    when(mockAttrs.get(eq("gidNumber"))).thenReturn(mockGidNumberAttr);

    when(mockUserResult.getAttributes()).thenReturn(mockAttrs);
  }

  @Test
  public void testGetGroups() throws IOException, NamingException {
    // The search functionality of the mock context is reused, so we will
    // return the user NamingEnumeration first, and then the group
    when(mockContext.search(anyString(), contains("posix"),
        any(Object[].class), any(SearchControls.class)))
        .thenReturn(mockUserNamingEnum, mockGroupNamingEnum);

    doTestGetGroups(Arrays.asList(testGroups), 2);
  }

  private void doTestGetGroups(List<String> expectedGroups, int searchTimes)
      throws IOException, NamingException {
    Configuration conf = new Configuration();
    // Set this, so we don't throw an exception
    conf.set(LdapGroupsMapping.LDAP_URL_KEY, "ldap://test");
    conf.set(LdapGroupsMapping.GROUP_SEARCH_FILTER_KEY,
        "(objectClass=posixGroup)(cn={0})");
    conf.set(LdapGroupsMapping.USER_SEARCH_FILTER_KEY,
        "(objectClass=posixAccount)");
    conf.set(LdapGroupsMapping.GROUP_MEMBERSHIP_ATTR_KEY, "memberUid");
    conf.set(LdapGroupsMapping.POSIX_UID_ATTR_KEY, "uidNumber");
    conf.set(LdapGroupsMapping.POSIX_GID_ATTR_KEY, "gidNumber");
    conf.set(LdapGroupsMapping.GROUP_NAME_ATTR_KEY, "cn");

    mappingSpy.setConf(conf);
    // Username is arbitrary, since the spy is mocked to respond the same,
    // regardless of input
    List<String> groups = mappingSpy.getGroups("some_user");

    Assert.assertEquals(expectedGroups, groups);

    mappingSpy.getConf().set(LdapGroupsMapping.POSIX_UID_ATTR_KEY, "uid");

    Assert.assertEquals(expectedGroups, groups);

    // We should have searched for a user, and then two groups
    verify(mockContext, times(searchTimes)).search(anyString(),
        anyString(),
        any(Object[].class),
        any(SearchControls.class));
  }
}
