LdapRealTestHelper.java

/////////////////////////////////////////////////////////////////////////////
//
// Project ProjectForge Community Edition
//         www.projectforge.org
//
// Copyright (C) 2001-2014 Kai Reinhard (k.reinhard@micromata.de)
//
// ProjectForge is dual-licensed.
//
// This community edition is free software; you can redistribute it and/or
// modify it under the terms of the GNU General Public License as published
// by the Free Software Foundation; version 3 of the License.
//
// This community edition 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 General
// Public License for more details.
//
// You should have received a copy of the GNU General Public License along
// with this program; if not, see http://www.gnu.org/licenses/.
//
/////////////////////////////////////////////////////////////////////////////

package org.projectforge.ldap;

import java.io.File;
import java.io.IOException;

import org.apache.commons.io.FileUtils;
import org.apache.commons.lang.StringUtils;
import org.projectforge.core.ConfigXml;
import org.projectforge.core.ConfigXmlTest;
import org.projectforge.fibu.kost.AccountingConfig;
import org.projectforge.xml.stream.AliasMap;
import org.projectforge.xml.stream.XmlObjectReader;

/**
 * Test helper class for do some tests with a real LDAP test system. The LDAP system settings have to be set in
 * $USER.HOME/rojectForge/testldapConfig.xml:
 * 
 * <pre>
 * <?xml version="1.0" encoding="UTF-8" ?>
 * <ldapConfig>
 *     <server>ldaps://192.168.76.177</server>
 *     <port>636</port>
 *     <userBase>ou=pf-test-users</userBase>
 *     <baseDN>dc=projectforge,dc=org</baseDN>
 *     <authentication>simple</authentication>
 *     <managerUser>cn=testuser</managerUser>
 *     <managerPassword>secret</managerPassword>
 *     <sslCertificateFile>/Users/kai/ProjectForge/testldap.cert</sslCertificateFile>
 * </ldapConfig>
 * </pre>
 * 
 * @author Kai Reinhard (k.reinhard@micromata.de)
 * 
 */
public class LdapRealTestHelper
{
  private static final org.apache.log4j.Logger log = org.apache.log4j.Logger.getLogger(LdapRealTestHelper.class);

  private static final String CONFIG_FILE = System.getProperty("user.home") + "/ProjectForge/testldapConfig.xml";

  LdapConfig ldapConfig;

  LdapConnector ldapConnector;

  LdapUserDao ldapUserDao;

  LdapPersonDao ldapPersonDao;

  LdapGroupDao ldapGroupDao;

  LdapOrganizationalUnitDao ldapOrganizationalUnitDao;

  private String userPath, groupPath;

  public LdapRealTestHelper setup()
  {
    if (isAvailable() == true) {
      if (ldapOrganizationalUnitDao == null) {
        ConfigXmlTest.createTestConfiguration();
        ConfigXml.getInstance().setLdapConfig(ldapConfig);
        ldapPersonDao = new LdapPersonDao();
        ldapPersonDao.setLdapConnector(ldapConnector);
        ldapUserDao = new LdapUserDao();
        ldapUserDao.setLdapConnector(ldapConnector);
        ldapUserDao.setLdapPersonDao(ldapPersonDao);
        ldapOrganizationalUnitDao = new LdapOrganizationalUnitDao();
        ldapOrganizationalUnitDao.setLdapConnector(ldapConnector);
        ldapGroupDao = new LdapGroupDao();
        ldapGroupDao.setLdapConnector(ldapConnector);

        ldapOrganizationalUnitDao.createIfNotExist(getUserPath(), "Test area for tests of ProjectForge.");
        ldapOrganizationalUnitDao.createIfNotExist(LdapUserDao.DEACTIVATED_SUB_CONTEXT, "for deactivated users.", getUserPath());
        ldapOrganizationalUnitDao.createIfNotExist(LdapUserDao.RESTRICTED_USER_SUB_CONTEXT, "for restricted users.", getUserPath());
        ldapOrganizationalUnitDao.createIfNotExist(getGroupPath(), "Test area for tests of ProjectForge.");
      }
    }
    return this;
  }

  public void tearDown()
  {
    if (isAvailable() == true) {
      ldapOrganizationalUnitDao.deleteIfExists(LdapUserDao.DEACTIVATED_SUB_CONTEXT, getUserPath());
      ldapOrganizationalUnitDao.deleteIfExists(LdapUserDao.RESTRICTED_USER_SUB_CONTEXT, getUserPath());
      ldapOrganizationalUnitDao.deleteIfExists(getUserPath());
      ldapOrganizationalUnitDao.deleteIfExists(getGroupPath());
    }
  }

  String getUserPath()
  {
    if (userPath == null) {
      userPath = LdapUtils.getOrganizationalUnit(ldapConfig.getUserBase());
    }
    return userPath;
  }

  String getGroupPath()
  {
    if (groupPath == null) {
      groupPath = LdapUtils.getOrganizationalUnit(ldapConfig.getGroupBase());
    }
    return groupPath;
  }

  LdapRealTestHelper()
  {
    ldapConfig = readConfig();
    ldapConnector = new LdapConnector(ldapConfig);
  }

  /**
   * @return true if the LDAP test system is available for tests, otherwise false.
   */
  boolean isAvailable()
  {
    return ldapConfig != null;
  }

  private LdapConfig readConfig()
  {
    final File configFile = new File(CONFIG_FILE);
    if (configFile.canRead() == false) {
      return null;
    }
    log.info("Reading LDAP configuration file for test cases: " + configFile.getPath());
    final XmlObjectReader reader = new XmlObjectReader();
    final AliasMap aliasMap = new AliasMap();
    aliasMap.put(LdapConfig.class, "ldapConfig");
    reader.setAliasMap(aliasMap);
    AccountingConfig.registerXmlObjects(reader, aliasMap);
    String xml = null;
    try {
      xml = FileUtils.readFileToString(configFile, "UTF-8");
    } catch (final IOException ex) {
      log.error(ex.getMessage(), ex);
      throw new IllegalArgumentException("Cannot read config file '" + CONFIG_FILE + "' properly : " + ex.getMessage(), ex);
    }
    if (xml == null) {
      throw new IllegalArgumentException("Cannot read from config file: '" + CONFIG_FILE + "'.");
    }
    try {
      final LdapConfig cfg = (LdapConfig) reader.read(xml);
      final String warnings = reader.getWarnings();
      if (StringUtils.isNotBlank(warnings) == true) {
        log.error(warnings);
      }
      return cfg;
    } catch (final Throwable ex) {
      throw new IllegalArgumentException("Cannot read config file '" + CONFIG_FILE + "' properly : " + ex.getMessage(), ex);
    }
  }

}