package com.armedia.acm.services.users.dao.ldap;

/*-
 * #%L
 * ACM Service: Users
 * %%
 * Copyright (C) 2014 - 2018 ArkCase LLC
 * %%
 * This file is part of the ArkCase software. 
 * 
 * If the software was purchased under a paid ArkCase license, the terms of 
 * the paid license agreement will prevail.  Otherwise, the software is 
 * provided under the following open source license terms:
 * 
 * ArkCase is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *  
 * ArkCase is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public License
 * along with ArkCase. If not, see <http://www.gnu.org/licenses/>.
 * #L%
 */

import static org.easymock.EasyMock.anyObject;
import static org.easymock.EasyMock.capture;
import static org.easymock.EasyMock.eq;
import static org.easymock.EasyMock.expect;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertTrue;

import com.armedia.acm.services.users.model.ldap.AcmGroupContextMapper;
import com.armedia.acm.services.users.model.ldap.AcmLdapSyncConfig;
import com.armedia.acm.services.users.model.ldap.AcmUserContextMapper;
import com.armedia.acm.services.users.model.ldap.Directory;
import com.armedia.acm.services.users.model.ldap.LdapGroup;
import com.armedia.acm.services.users.model.ldap.LdapUser;

import org.easymock.Capture;
import org.easymock.EasyMockSupport;
import org.junit.Before;
import org.junit.Test;
import org.springframework.ldap.core.LdapTemplate;
import org.springframework.ldap.core.support.AggregateDirContextProcessor;

import javax.naming.directory.SearchControls;

import java.time.ZoneOffset;
import java.time.ZonedDateTime;
import java.util.ArrayList;
import java.util.List;
import java.util.Optional;

public class CustomPagedLdapDaoTest extends EasyMockSupport
{
    private LdapTemplate mockLdapTemplate;

    private AcmLdapSyncConfig syncConfig;

    private CustomPagedLdapDao unit;

    @Before
    public void setUp()
    {
        mockLdapTemplate = createMock(LdapTemplate.class);

        unit = new CustomPagedLdapDao();

        syncConfig = new AcmLdapSyncConfig();
        syncConfig.setUserIdAttributeName("samAccountName");
        syncConfig.setMailAttributeName("mail");
        syncConfig.setBaseDC("dc=dead,dc=net");
        syncConfig.setUserSearchBase("CN=bandMembers");
        syncConfig.setAllUsersFilter("allUsersFilter");
        syncConfig.setAllUsersPageFilter("allUsersPageFilter %s");
        syncConfig.setGroupSearchFilter("groupSearchFilter");
        syncConfig.setGroupSearchPageFilter("groupSearchPageFilter %s");
        syncConfig.setGroupSearchBase("CN=bands");
        syncConfig.setSyncPageSize(100);
        syncConfig.setChangedGroupSearchPageFilter("(&(objectclass=group)(gidNumber>=%s)(modifyTimestamp>=%s))");
        syncConfig.setChangedGroupSearchFilter("(&(objectclass=group)(modifyTimestamp>=%s))");
        syncConfig.setAllChangedUsersPageFilter("(&(objectclass=user)(uidNumber>=%s)(modifyTimestamp>=%s))");
        syncConfig.setAllChangedUsersFilter("(&(objectclass=user)(modifyTimestamp>=%s))");
        syncConfig.setDirectoryType("openldap");
    }

    /**
     * AFDP-3185 test case. "LDAP SyncFails on Index out of Bounds"
     *
     * @throws Exception
     */
    @Test
    public void findGroupsPaged_lastGroupFallsOnPageBoundary() throws Exception
    {
        List<LdapGroup> pageOne = new ArrayList<>();

        pageOne.add(buildGroup("grateful dead"));
        pageOne.add(buildGroup("allman brothers"));
        pageOne.add(buildGroup("eagles"));

        // second page starts with the last group from the first page, due the custom paging logic... since we have to
        // start from the last previously found user, to guarantee not to miss anybody
        List<LdapGroup> pageTwo = new ArrayList<>();
        pageTwo.add(buildGroup("eagles"));
        pageTwo.add(buildGroup("fleetwood mac"));
        pageTwo.add(buildGroup("cream"));

        List<LdapGroup> pageThree = new ArrayList<>();
        pageThree.add(buildGroup("cream"));

        syncConfig.setSyncPageSize(3);

        // first search returns a full page
        expect(mockLdapTemplate.search(
                eq(syncConfig.getGroupSearchBase()),
                eq(syncConfig.getGroupSearchFilter()),
                anyObject(SearchControls.class),
                anyObject(AcmGroupContextMapper.class),
                anyObject(AggregateDirContextProcessor.class))).andReturn(pageOne);

        // second search also returns a full page, but also returns the very last user
        expect(mockLdapTemplate.search(
                eq(syncConfig.getGroupSearchBase()),
                eq(String.format(syncConfig.getGroupSearchPageFilter(), pageOne.get(pageOne.size() - 1).getName())),
                anyObject(SearchControls.class),
                anyObject(AcmGroupContextMapper.class),
                anyObject(AggregateDirContextProcessor.class))).andReturn(pageTwo);

        // last search returns an empty list... actually it shouldn't happen, it should always return at least the last
        // entry from the previous search, but let's be defensive.
        expect(mockLdapTemplate.search(
                eq(syncConfig.getGroupSearchBase()),
                eq(String.format(syncConfig.getGroupSearchPageFilter(), pageTwo.get(pageTwo.size() - 1).getName())),
                anyObject(SearchControls.class),
                anyObject(AcmGroupContextMapper.class),
                anyObject(AggregateDirContextProcessor.class))).andReturn(new ArrayList<>());

        replayAll();

        List<LdapGroup> found = unit.findGroupsPaged(mockLdapTemplate, syncConfig, Optional.ofNullable(null));

        verifyAll();

        assertEquals(pageOne.size() + pageTwo.size() - 1, found.size());

        assertTrue(found.stream().anyMatch(u -> u.getName().equals("grateful dead")));
        assertTrue(found.stream().anyMatch(u -> u.getName().equals("allman brothers")));
        assertTrue(found.stream().anyMatch(u -> u.getName().equals("eagles")));
        assertTrue(found.stream().anyMatch(u -> u.getName().equals("fleetwood mac")));
        assertTrue(found.stream().anyMatch(u -> u.getName().equals("cream")));
    }

    /**
     * AFDP-3185 test case. "LDAP SyncFails on Index out of Bounds"
     *
     * @throws Exception
     */
    @Test
    public void findUsersPaged_lastUserFallsOnPageBoundary() throws Exception
    {
        List<LdapUser> pageOne = new ArrayList<>();

        pageOne.add(buildUser("jgarcia"));
        pageOne.add(buildUser("bweir"));
        pageOne.add(buildUser("plesh"));

        // second page starts with the last user from the first page, due the custom paging logic... since we have to
        // start from the last previously found user, to guarantee not to miss anybody
        List<LdapUser> pageTwo = new ArrayList<>();
        pageTwo.add(buildUser("plesh"));
        pageTwo.add(buildUser("bkreutzmann"));
        pageTwo.add(buildUser("rmckernan"));

        syncConfig.setSyncPageSize(3);

        // first search returns a full page
        expect(mockLdapTemplate.search(
                eq(syncConfig.getUserSearchBase()),
                eq(syncConfig.getAllUsersFilter()),
                anyObject(SearchControls.class),
                anyObject(AcmUserContextMapper.class),
                anyObject(AggregateDirContextProcessor.class))).andReturn(pageOne);

        // second search also returns a full page, but also returns the very last user
        expect(mockLdapTemplate.search(
                eq(syncConfig.getUserSearchBase()),
                eq(String.format(syncConfig.getAllUsersPageFilter(), pageOne.get(pageOne.size() - 1).getUserId())),
                anyObject(SearchControls.class),
                anyObject(AcmUserContextMapper.class),
                anyObject(AggregateDirContextProcessor.class))).andReturn(pageTwo);

        // last search returns an empty list.. actually it shouldn't happen, it should always return at least the last
        // entry from the previous search, but let's be defensive.
        expect(mockLdapTemplate.search(
                eq(syncConfig.getUserSearchBase()),
                eq(String.format(syncConfig.getAllUsersPageFilter(), pageTwo.get(pageTwo.size() - 1).getUserId())),
                anyObject(SearchControls.class),
                anyObject(AcmUserContextMapper.class),
                anyObject(AggregateDirContextProcessor.class))).andReturn(new ArrayList<>());

        replayAll();

        List<LdapUser> found = unit.findUsersPaged(mockLdapTemplate, syncConfig, Optional.ofNullable(null));

        verifyAll();

        assertEquals(pageOne.size() + pageTwo.size() - 1, found.size());

        assertTrue(found.stream().anyMatch(u -> u.getUserId().equals("jgarcia")));
        assertTrue(found.stream().anyMatch(u -> u.getUserId().equals("bweir")));
        assertTrue(found.stream().anyMatch(u -> u.getUserId().equals("plesh")));
        assertTrue(found.stream().anyMatch(u -> u.getUserId().equals("bkreutzmann")));
        assertTrue(found.stream().anyMatch(u -> u.getUserId().equals("rmckernan")));
    }

    @Test
    public void findChangedGroupsPaged_searchFiltersTest() throws Exception
    {
        List<LdapGroup> pageOne = new ArrayList<>();
        pageOne.add(buildGroup("gnr"));
        pageOne.add(buildGroup("nirvana"));
        pageOne.add(buildGroup("eagles"));

        List<LdapGroup> pageTwo = new ArrayList<>();
        pageTwo.add(buildGroup("eagles"));
        pageTwo.add(buildGroup("fleetwood mac"));
        pageTwo.add(buildGroup("pink floyd"));

        syncConfig.setSyncPageSize(3);

        Capture<String> allChangedGroupsPageFilter1 = Capture.newInstance();
        Capture<String> allChangedGroupsPageFilter2 = Capture.newInstance();
        Capture<String> allChangedGroupsFilter = Capture.newInstance();

        expect(mockLdapTemplate.search(
                eq(syncConfig.getGroupSearchBase()),
                capture(allChangedGroupsFilter),
                anyObject(SearchControls.class),
                anyObject(AcmGroupContextMapper.class),
                anyObject(AggregateDirContextProcessor.class))).andReturn(pageOne);

        expect(mockLdapTemplate.search(
                eq(syncConfig.getGroupSearchBase()),
                capture(allChangedGroupsPageFilter1),
                anyObject(SearchControls.class),
                anyObject(AcmGroupContextMapper.class),
                anyObject(AggregateDirContextProcessor.class))).andReturn(pageTwo);

        expect(mockLdapTemplate.search(
                eq(syncConfig.getGroupSearchBase()),
                capture(allChangedGroupsPageFilter2),
                anyObject(SearchControls.class),
                anyObject(AcmGroupContextMapper.class),
                anyObject(AggregateDirContextProcessor.class))).andReturn(new ArrayList<>());

        replayAll();

        String ldapLastSyncDateTimestamp = ZonedDateTime.now(ZoneOffset.UTC).minusDays(1).toString();
        List<LdapGroup> found = unit.findGroupsPaged(mockLdapTemplate, syncConfig, Optional.of(ldapLastSyncDateTimestamp));

        verifyAll();

        assertEquals(pageOne.size() + pageTwo.size() - 1, found.size());

        String actualChangedGroupsFilter = allChangedGroupsFilter.getValue();
        String actualChangedGroupsPageFilter1 = allChangedGroupsPageFilter1.getValue();
        String actualChangedGroupsPageFilter2 = allChangedGroupsPageFilter2.getValue();

        ldapLastSyncDateTimestamp = Directory.valueOf(syncConfig.getDirectoryType())
                .convertToDirectorySpecificTimestamp(ldapLastSyncDateTimestamp);
        String expectedChangedGroupsFilter = String.format(syncConfig.getChangedGroupSearchFilter(), ldapLastSyncDateTimestamp);
        String expectedChangedGroupsPageFilter1 = String.format(syncConfig.getChangedGroupSearchPageFilter(), "eagles",
                ldapLastSyncDateTimestamp);
        String expectedChangedGroupsPageFilter2 = String.format(syncConfig.getChangedGroupSearchPageFilter(), "pink floyd",
                ldapLastSyncDateTimestamp);

        assertEquals(expectedChangedGroupsFilter, actualChangedGroupsFilter);
        assertEquals(expectedChangedGroupsPageFilter1, actualChangedGroupsPageFilter1);
        assertEquals(expectedChangedGroupsPageFilter2, actualChangedGroupsPageFilter2);
    }

    @Test
    public void findChangedUsersPaged_searchFiltersTest() throws Exception
    {
        List<LdapUser> pageOne = new ArrayList<>();
        pageOne.add(buildUser("axlrose"));
        pageOne.add(buildUser("kurtcobain"));
        pageOne.add(buildUser("plesh"));

        List<LdapUser> pageTwo = new ArrayList<>();
        pageTwo.add(buildUser("plesh"));
        pageTwo.add(buildUser("bkreutzmann"));
        pageTwo.add(buildUser("davidgilmour"));

        syncConfig.setSyncPageSize(3);

        Capture<String> allChangedUsersPageFilter1 = Capture.newInstance();
        Capture<String> allChangedUsersPageFilter2 = Capture.newInstance();
        Capture<String> allChangedUsersFilter = Capture.newInstance();

        expect(mockLdapTemplate.search(
                eq(syncConfig.getUserSearchBase()),
                capture(allChangedUsersFilter),
                anyObject(SearchControls.class),
                anyObject(AcmUserContextMapper.class),
                anyObject(AggregateDirContextProcessor.class))).andReturn(pageOne);

        expect(mockLdapTemplate.search(
                eq(syncConfig.getUserSearchBase()),
                capture(allChangedUsersPageFilter1),
                anyObject(SearchControls.class),
                anyObject(AcmUserContextMapper.class),
                anyObject(AggregateDirContextProcessor.class))).andReturn(pageTwo);

        expect(mockLdapTemplate.search(
                eq(syncConfig.getUserSearchBase()),
                capture(allChangedUsersPageFilter2),
                anyObject(SearchControls.class),
                anyObject(AcmUserContextMapper.class),
                anyObject(AggregateDirContextProcessor.class))).andReturn(new ArrayList<>());

        replayAll();

        String ldapLastSyncDateTimestamp = ZonedDateTime.now(ZoneOffset.UTC).minusDays(1).toString();
        List<LdapUser> found = unit.findUsersPaged(mockLdapTemplate, syncConfig, Optional.of(ldapLastSyncDateTimestamp));

        verifyAll();

        assertEquals(pageOne.size() + pageTwo.size() - 1, found.size());

        String actualChangedGroupsFilter = allChangedUsersFilter.getValue();
        String actualChangedGroupsPageFilter1 = allChangedUsersPageFilter1.getValue();
        String actualChangedGroupsPageFilter2 = allChangedUsersPageFilter2.getValue();

        ldapLastSyncDateTimestamp = Directory.valueOf(syncConfig.getDirectoryType())
                .convertToDirectorySpecificTimestamp(ldapLastSyncDateTimestamp);
        String expectedChangedGroupsFilter = String.format(syncConfig.getAllChangedUsersFilter(), ldapLastSyncDateTimestamp);
        String expectedChangedGroupsPageFilter1 = String.format(syncConfig.getAllChangedUsersPageFilter(), "plesh",
                ldapLastSyncDateTimestamp);
        String expectedChangedGroupsPageFilter2 = String.format(syncConfig.getAllChangedUsersPageFilter(), "davidgilmour",
                ldapLastSyncDateTimestamp);

        assertEquals(expectedChangedGroupsFilter, actualChangedGroupsFilter);
        assertEquals(expectedChangedGroupsPageFilter1, actualChangedGroupsPageFilter1);
        assertEquals(expectedChangedGroupsPageFilter2, actualChangedGroupsPageFilter2);
    }

    private LdapUser buildUser(String userid)
    {
        LdapUser user = new LdapUser();
        user.setUserId(userid);
        user.setDistinguishedName("dn: " + userid);
        user.setSortableValue(userid);
        return user;
    }

    private LdapGroup buildGroup(String groupName)
    {
        LdapGroup group = new LdapGroup();
        group.setName(groupName);
        group.setSortableValue(groupName);
        return group;
    }
}