LDAPAccountManager/lam/tests/lib/LAMConfigTest.php

<?php
/*
 $Id$

 This code is part of LDAP Account Manager (http://www.ldap-account-manager.org/)
 Copyright (C) 2016  Roland Gruber

 This program 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; either version 2 of the License, or
 (at your option) any later version.

 This program 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, write to the Free Software
 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

 */

include_once (dirname ( __FILE__ ) . '/../utils/configuration.inc');

/**
 * LAMConfig test case.
 */
class LAMConfigTest extends PHPUnit_Framework_TestCase {

	/**
	 *
	 * @var LAMConfig
	 */
	private $lAMConfig;

	const FILE_NAME = 'phpunit';

	/**
	 * Prepares the environment before running a test.
	 */
	protected function setUp() {
		parent::setUp();
		testCreateDefaultConfig();
		$profiles = getConfigProfiles();
		if (in_array(LAMConfigTest::FILE_NAME, $profiles)) {
			deleteConfigProfile(LAMConfigTest::FILE_NAME);
		}
		createConfigProfile(LAMConfigTest::FILE_NAME, LAMConfigTest::FILE_NAME, 'unix.conf.sample');
		$this->lAMConfig = new LAMConfig(LAMConfigTest::FILE_NAME);
		$profiles = getConfigProfiles();
		$this->assertTrue(in_array(LAMConfigTest::FILE_NAME, $profiles));
	}

	/**
	 * Cleans up the environment after running a test.
	 */
	protected function tearDown() {
		$this->lAMConfig = null;
		deleteConfigProfile(LAMConfigTest::FILE_NAME);
		$profiles = getConfigProfiles();
		$this->assertTrue(!in_array(LAMConfigTest::FILE_NAME, $profiles));
		parent::tearDown();
	}

	/**
	 * Tests LAMConfig->getName()
	 */
	public function testGetName() {
		$this->assertEquals(LAMConfigTest::FILE_NAME, $this->lAMConfig->getName());
	}

	/**
	 * Tests LAMConfig->isWritable()
	 */
	public function testIsWritable() {
		$this->assertTrue($this->lAMConfig->isWritable());
	}

	/**
	 * Tests LAMConfig->getPath()
	 */
	public function testGetPath() {
		$this->assertEquals(dirname(dirname(dirname(__FILE__))) . '/config/phpunit.conf', $this->lAMConfig->getPath());
	}

	/**
	 * Tests LAMConfig->get_ServerURL() and LAMConfig->set_ServerURL().
	 */
	public function testServerURL() {
		$url = 'ldap://localhost:123';
		$this->lAMConfig->set_ServerURL($url);
		$this->assertEquals($url, $this->lAMConfig->get_ServerURL());
		$this->doSave();
		$this->assertEquals($url, $this->lAMConfig->get_ServerURL());
	}

	/**
	 * Tests LAMConfig->getUseTLS() and LAMConfig->setUseTLS()
	 */
	public function testUseTLS() {
		$this->assertFalse($this->lAMConfig->setUseTLS('123'));
		$val = 'yes';
		$this->lAMConfig->setUseTLS($val);
		$this->assertEquals($val, $this->lAMConfig->getUseTLS());
		$this->doSave();
		$this->assertEquals($val, $this->lAMConfig->getUseTLS());
	}

	/**
	 * Tests LAMConfig->getFollowReferrals() and LAMConfig->setFollowReferrals()
	 */
	public function testGetFollowReferrals() {
		$val = 'yes';
		$this->lAMConfig->setFollowReferrals($val);
		$this->assertEquals($val, $this->lAMConfig->getFollowReferrals());
		$this->doSave();
		$this->assertEquals($val, $this->lAMConfig->getFollowReferrals());
	}

	/**
	 * Tests LAMConfig->getPagedResults() and LAMConfig->setPagedResults()
	 */
	public function testPagedResults() {
		$val = 'yes';
		$this->lAMConfig->setPagedResults($val);
		$this->assertEquals($val, $this->lAMConfig->getPagedResults());
		$this->doSave();
		$this->assertEquals($val, $this->lAMConfig->getPagedResults());
	}

	/**
	 * Tests LAMConfig->get_Admins()
	 */
	public function testGet_Admins() {
		$val = 'cn=admin,dc=test;cn=admin2,dc=test';
		$valInvalid = 'admin;';
		$this->assertFalse($this->lAMConfig->set_Adminstring($valInvalid));
		$this->lAMConfig->set_Adminstring($val);
		$this->assertEquals(array('cn=admin,dc=test', 'cn=admin2,dc=test'), $this->lAMConfig->get_Admins());
		$this->doSave();
		$this->assertEquals(array('cn=admin,dc=test', 'cn=admin2,dc=test'), $this->lAMConfig->get_Admins());
	}

	/**
	 * Tests LAMConfig->get_Adminstring() and LAMConfig->set_Adminstring()
	 */
	public function testGet_Adminstring() {
		$val = 'cn=admin,dc=test;cn=admin2,dc=test';
		$this->lAMConfig->set_Adminstring($val);
		$this->assertEquals($val, $this->lAMConfig->get_Adminstring());
		$this->doSave();
		$this->assertEquals($val, $this->lAMConfig->get_Adminstring());
	}

	/**
	 * Tests LAMConfig->check_Passwd()
	 */
	public function testCheck_Passwd() {
		$val = '12345';
		$this->lAMConfig->set_Passwd($val);
		$this->assertTrue($this->lAMConfig->check_Passwd($val));
		$this->doSave();
		$this->assertTrue($this->lAMConfig->check_Passwd($val));
	}

	/**
	 * Tests LAMConfig->get_Suffix() and LAMConfig->set_Suffix()
	 */
	public function testSuffix() {
		$val = 'ou=test,dc=test';
		$this->lAMConfig->set_Suffix('tree', $val);
		$this->assertEquals($val, $this->lAMConfig->get_Suffix('tree'));
		$this->doSave();
		$this->assertEquals($val, $this->lAMConfig->get_Suffix('tree'));

		$val = 'ou=test1,dc=test';
		$this->lAMConfig->set_Suffix('user', $val);
		$this->assertEquals($val, $this->lAMConfig->get_Suffix('user'));
		$this->doSave();
		$this->assertEquals($val, $this->lAMConfig->get_Suffix('user'));
	}

	/**
	 * Tests LAMConfig->get_listAttributes() and LAMConfig->set_listAttributes()
	 */
	public function testlistAttributes() {
		$this->assertFalse($this->lAMConfig->set_listAttributes('12=3,1=23', 'user'));
		$val = '#uid;gidNumber:number';
		$this->lAMConfig->set_listAttributes($val, 'user');
		$this->assertEquals($val, $this->lAMConfig->get_listAttributes('user'));
		$this->doSave();
		$this->assertEquals($val, $this->lAMConfig->get_listAttributes('user'));
	}

	/**
	 * Tests LAMConfig->get_defaultLanguage() and LAMConfig->set_defaultLanguage()
	 */
	public function testdefaultLanguage() {
		$this->assertFalse($this->lAMConfig->set_defaultLanguage(true));
		$val = 'en_GB';
		$this->lAMConfig->set_defaultLanguage($val);
		$this->assertEquals($val, $this->lAMConfig->get_defaultLanguage());
		$this->doSave();
		$this->assertEquals($val, $this->lAMConfig->get_defaultLanguage());
	}

	/**
	 * Tests LAMConfig->getTimeZone() and LAMConfig->setTimeZone()
	 */
	public function testTimeZone() {
		$this->assertFalse($this->lAMConfig->setTimeZone(true));
		$val = 'Europe/Berlin';
		$this->lAMConfig->setTimeZone($val);
		$this->assertEquals($val, $this->lAMConfig->getTimeZone());
		$this->doSave();
		$this->assertEquals($val, $this->lAMConfig->getTimeZone());
	}

	/**
	 * Tests LAMConfig->get_scriptPath() and LAMConfig->set_scriptPath()
	 */
	public function testscriptPath() {
		$this->assertFalse($this->lAMConfig->set_scriptPath('script'));
		$val = '/some/script';
		$this->lAMConfig->set_scriptPath($val);
		$this->assertEquals($val, $this->lAMConfig->get_scriptPath());
		$this->doSave();
		$this->assertEquals($val, $this->lAMConfig->get_scriptPath());
	}

	/**
	 * Tests LAMConfig->get_scriptServers() and LAMConfig->set_scriptServers()
	 */
	public function testscriptServers() {
		$this->assertFalse($this->lAMConfig->set_scriptServers(';;..'));
		$val = 'server;server';
		$this->lAMConfig->set_scriptServers($val);
		$this->assertEquals($val, $this->lAMConfig->get_scriptServers());
		$this->doSave();
		$this->assertEquals($val, $this->lAMConfig->get_scriptServers());
	}

	/**
	 * Tests LAMConfig->get_scriptRights() and LAMConfig->set_scriptRights()
	 */
	public function testscriptRights() {
		$this->assertFalse($this->lAMConfig->set_scriptRights('12345'));
		$val = '755';
		$this->lAMConfig->set_scriptRights($val);
		$this->assertEquals($val, $this->lAMConfig->get_scriptRights());
		$this->doSave();
		$this->assertEquals($val, $this->lAMConfig->get_scriptRights());
	}

	/**
	 * Tests LAMConfig->set_cacheTimeout(), LAMConfig->get_cacheTimeout() and LAMConfig->get_cacheTimeoutSec()
	 */
	public function testcacheTimeout() {
		$this->assertFalse($this->lAMConfig->set_cacheTimeout('abc'));
		$val = '5';
		$this->lAMConfig->set_cacheTimeout($val);
		$this->assertEquals($val, $this->lAMConfig->get_cacheTimeout());
		$this->assertEquals(300, $this->lAMConfig->get_cacheTimeoutSec());
		$this->doSave();
		$this->assertEquals($val, $this->lAMConfig->get_cacheTimeout());
		$this->assertEquals(300, $this->lAMConfig->get_cacheTimeoutSec());
	}

	/**
	 * Tests LAMConfig->get_searchLimit() and LAMConfig->set_searchLimit()
	 */
	public function testsearchLimit() {
		$this->assertFalse($this->lAMConfig->set_searchLimit('abc'));
		$val = '1024';
		$this->lAMConfig->set_searchLimit($val);
		$this->assertEquals($val, $this->lAMConfig->get_searchLimit());
		$this->doSave();
		$this->assertEquals($val, $this->lAMConfig->get_searchLimit());
	}

	/**
	 * Tests LAMConfig->get_AccountModules() and LAMConfig->set_AccountModules()
	 */
	public function testAccountModules() {
		$scope = 'user';
		$this->assertFalse($this->lAMConfig->set_AccountModules('abc', $scope));
		$val = array('posixAccount', 'shadowAccount');
		$this->lAMConfig->set_AccountModules($val, $scope);
		$this->assertEquals($val, $this->lAMConfig->get_AccountModules($scope));
		$this->doSave();
		$this->assertEquals($val, $this->lAMConfig->get_AccountModules($scope));
	}

	/**
	 * Tests LAMConfig->set_moduleSettings() and LAMConfig->get_moduleSettings()
	 */
	public function testmoduleSettings() {
		$this->assertFalse($this->lAMConfig->set_moduleSettings('abc'));
		$val = array('posixAccount_123' => array('123'), 'shadowAccount_123' => array('123'));
		$this->lAMConfig->set_moduleSettings($val);
		$this->assertTrue(array_key_exists('posixAccount_123', $this->lAMConfig->get_moduleSettings()));
		$this->assertTrue(array_key_exists('shadowAccount_123', $this->lAMConfig->get_moduleSettings()));
		$this->doSave();
		$this->assertTrue(array_key_exists('posixAccount_123', $this->lAMConfig->get_moduleSettings()));
		$this->assertTrue(array_key_exists('shadowAccount_123', $this->lAMConfig->get_moduleSettings()));
	}

	/**
	 * Tests LAMConfig->get_ActiveTypes() and LAMConfig->set_ActiveTypes()
	 */
	public function testActiveTypes() {
		$val = array('user', 'group');
		$this->lAMConfig->set_ActiveTypes($val);
		$this->assertEquals($val, $this->lAMConfig->get_ActiveTypes());
		$this->doSave();
		$this->assertEquals($val, $this->lAMConfig->get_ActiveTypes());
	}

	/**
	 * Tests LAMConfig->set_typeSettings() and LAMConfig->get_typeSettings()
	 */
	public function testtypeSettings() {
		$this->assertFalse($this->lAMConfig->set_typeSettings('abc'));
		$val = array('posixAccount_123' => '123', 'shadowAccount_123' => '123');
		$this->lAMConfig->set_typeSettings($val);
		$this->assertTrue(array_key_exists('posixAccount_123', $this->lAMConfig->get_typeSettings()));
		$this->assertTrue(array_key_exists('shadowAccount_123', $this->lAMConfig->get_typeSettings()));
		$this->doSave();
		$this->assertTrue(array_key_exists('posixAccount_123', $this->lAMConfig->get_typeSettings()));
		$this->assertTrue(array_key_exists('shadowAccount_123', $this->lAMConfig->get_typeSettings()));
	}

	/**
	 * Tests LAMConfig->getToolSettings() and LAMConfig->setToolSettings()
	 */
	public function testGetToolSettings() {
		$this->assertFalse($this->lAMConfig->setToolSettings('abc'));
		$val = array('user_123' => '123', 'group_123' => '123');
		$this->lAMConfig->setToolSettings($val);
		$this->assertTrue(array_key_exists('user_123', $this->lAMConfig->getToolSettings()));
		$this->assertTrue(array_key_exists('group_123', $this->lAMConfig->getToolSettings()));
		$this->doSave();
		$this->assertTrue(array_key_exists('user_123', $this->lAMConfig->getToolSettings()));
		$this->assertTrue(array_key_exists('group_123', $this->lAMConfig->getToolSettings()));
	}

	/**
	 * Tests LAMConfig->getAccessLevel() and LAMConfig->setAccessLevel()
	 */
	public function testAccessLevel() {
		$val = 100;
		$this->lAMConfig->setAccessLevel($val);
		$this->assertEquals($val, $this->lAMConfig->getAccessLevel());
		$this->doSave();
		$this->assertEquals($val, $this->lAMConfig->getAccessLevel());
	}

	/**
	 * Tests LAMConfig->getLoginMethod() and LAMConfig->setLoginMethod()
	 */
	public function testLoginMethod() {
		$val = 'search';
		$this->lAMConfig->setLoginMethod($val);
		$this->assertEquals($val, $this->lAMConfig->getLoginMethod());
		$this->doSave();
		$this->assertEquals($val, $this->lAMConfig->getLoginMethod());
	}

	/**
	 * Tests LAMConfig->getLoginSearchFilter() and LAMConfig->setLoginSearchFilter()
	 */
	public function testLoginSearchFilter() {
		$val = '(uid=%USER%)';
		$this->lAMConfig->setLoginSearchFilter($val);
		$this->assertEquals($val, $this->lAMConfig->getLoginSearchFilter());
		$this->doSave();
		$this->assertEquals($val, $this->lAMConfig->getLoginSearchFilter());
	}

	/**
	 * Tests LAMConfig->getLoginSearchSuffix() and LAMConfig->setLoginSearchSuffix()
	 */
	public function testLoginSearchSuffix() {
		$val = 'ou=people,dc=test';
		$this->lAMConfig->setLoginSearchSuffix($val);
		$this->assertEquals($val, $this->lAMConfig->getLoginSearchSuffix());
		$this->doSave();
		$this->assertEquals($val, $this->lAMConfig->getLoginSearchSuffix());
	}

	/**
	 * Tests LAMConfig->setLoginSearchDN() and LAMConfig->getLoginSearchDN()
	 */
	public function testLoginSearchDN() {
		$val = 'cn=admin,ou=people,dc=test';
		$this->lAMConfig->setLoginSearchDN($val);
		$this->assertEquals($val, $this->lAMConfig->getLoginSearchDN());
		$this->doSave();
		$this->assertEquals($val, $this->lAMConfig->getLoginSearchDN());
	}

	/**
	 * Tests LAMConfig->setLoginSearchPassword() and LAMConfig->getLoginSearchPassword()
	 */
	public function testLoginSearchPassword() {
		$val = '123456';
		$this->lAMConfig->setLoginSearchPassword($val);
		$this->assertEquals($val, $this->lAMConfig->getLoginSearchPassword());
		$this->doSave();
		$this->assertEquals($val, $this->lAMConfig->getLoginSearchPassword());
	}

	/**
	 * Tests LAMConfig->getHttpAuthentication() and LAMConfig->setHttpAuthentication()
	 */
	public function testHttpAuthentication() {
		$val = true;
		$this->lAMConfig->setHttpAuthentication($val);
		$this->assertEquals($val, $this->lAMConfig->getHttpAuthentication());
		$this->doSave();
		$this->assertEquals($val, $this->lAMConfig->getHttpAuthentication());
	}

	/**
	 * Tests LAMConfig->getLamProMailFrom() and LAMConfig->setLamProMailFrom()
	 */
	public function testLamProMailFrom() {
		$val = 'nobody@example.com';
		$this->lAMConfig->setLamProMailFrom($val);
		$this->assertEquals($val, $this->lAMConfig->getLamProMailFrom());
		$this->doSave();
		$this->assertEquals($val, $this->lAMConfig->getLamProMailFrom());
	}

	/**
	 * Tests LAMConfig->getLamProMailReplyTo() and LAMConfig->setLamProMailReplyTo()
	 */
	public function testLamProMailReplyTo() {
		$val = 'nobody@example.com';
		$this->lAMConfig->setLamProMailReplyTo($val);
		$this->assertEquals($val, $this->lAMConfig->getLamProMailReplyTo());
		$this->doSave();
		$this->assertEquals($val, $this->lAMConfig->getLamProMailReplyTo());
	}

	/**
	 * Tests LAMConfig->getLamProMailSubject() and LAMConfig->setLamProMailSubject()
	 */
	public function testLamProMailSubject() {
		$val = 'nobody@example.com';
		$this->lAMConfig->setLamProMailSubject($val);
		$this->assertEquals($val, $this->lAMConfig->getLamProMailSubject());
		$this->doSave();
		$this->assertEquals($val, $this->lAMConfig->getLamProMailSubject());
	}

	/**
	 * Tests LAMConfig->getLamProMailIsHTML() and LAMConfig->setLamProMailIsHTML()
	 */
	public function testLamProMailIsHTML() {
		$val = true;
		$this->lAMConfig->setLamProMailIsHTML($val);
		$this->assertEquals($val, $this->lAMConfig->getLamProMailIsHTML());
		$this->doSave();
		$this->assertEquals($val, $this->lAMConfig->getLamProMailIsHTML());
	}

	/**
	 * Tests LAMConfig->getLamProMailAllowAlternateAddress() and LAMConfig->setLamProMailAllowAlternateAddress()
	 */
	public function testLamProMailAllowAlternateAddress() {
		$val = 'none@example.com';
		$this->lAMConfig->setLamProMailAllowAlternateAddress($val);
		$this->assertEquals($val, $this->lAMConfig->getLamProMailAllowAlternateAddress());
		$this->doSave();
		$this->assertEquals($val, $this->lAMConfig->getLamProMailAllowAlternateAddress());
	}

	/**
	 * Tests LAMConfig->getLamProMailText() and LAMConfig->setLamProMailText()
	 */
	public function testLamProMailText() {
		$val = 'some\r\ntext';
		$this->lAMConfig->setLamProMailText($val);
		$this->assertEquals($val, $this->lAMConfig->getLamProMailText());
		$this->doSave();
		$this->assertEquals($val, $this->lAMConfig->getLamProMailText());
	}

	/**
	 * Tests LAMConfig->getJobsBindUser() and LAMConfig->setJobsBindUser()
	 */
	public function testJobsBindUser() {
		$val = 'cn=admin,o=test';
		$this->lAMConfig->setJobsBindUser($val);
		$this->assertEquals($val, $this->lAMConfig->getJobsBindUser());
		$this->doSave();
		$this->assertEquals($val, $this->lAMConfig->getJobsBindUser());
	}

	/**
	 * Tests LAMConfig->getJobsBindPassword() and LAMConfig->setJobsBindPassword()
	 */
	public function testJobsBindPassword() {
		$val = '12356';
		$this->lAMConfig->setJobsBindPassword($val);
		$this->assertEquals($val, $this->lAMConfig->getJobsBindPassword());
		$this->doSave();
		$this->assertEquals($val, $this->lAMConfig->getJobsBindPassword());
	}

	/**
	 * Tests LAMConfig->getJobsDatabase() and LAMConfig->setJobsDatabase()
	 */
	public function testJobsDatabase() {
		$val = 'mysql';
		$this->lAMConfig->setJobsDatabase($val);
		$this->assertEquals($val, $this->lAMConfig->getJobsDatabase());
		$this->doSave();
		$this->assertEquals($val, $this->lAMConfig->getJobsDatabase());
	}

	/**
	 * Tests LAMConfig->getJobsDBHost() and LAMConfig->setJobsDBHost()
	 */
	public function testJobsDBHost() {
		$val = 'someserver';
		$this->lAMConfig->setJobsDBHost($val);
		$this->assertEquals($val, $this->lAMConfig->getJobsDBHost());
		$this->doSave();
		$this->assertEquals($val, $this->lAMConfig->getJobsDBHost());
	}

	/**
	 * Tests LAMConfig->getJobsDBPort() and LAMConfig->setJobsDBPort()
	 */
	public function testJobsDBPort() {
		$val = '1010';
		$this->lAMConfig->setJobsDBPort($val);
		$this->assertEquals($val, $this->lAMConfig->getJobsDBPort());
		$this->doSave();
		$this->assertEquals($val, $this->lAMConfig->getJobsDBPort());
	}

	/**
	 * Tests LAMConfig->getJobsDBUser() and LAMConfig->setJobsDBUser()
	 */
	public function testJobsDBUser() {
		$val = 'user';
		$this->lAMConfig->setJobsDBUser($val);
		$this->assertEquals($val, $this->lAMConfig->getJobsDBUser());
		$this->doSave();
		$this->assertEquals($val, $this->lAMConfig->getJobsDBUser());
	}

	/**
	 * Tests LAMConfig->getJobsDBPassword() and LAMConfig->setJobsDBPassword()
	 */
	public function testJobsDBPassword() {
		$val = '123456';
		$this->lAMConfig->setJobsDBPassword($val);
		$this->assertEquals($val, $this->lAMConfig->getJobsDBPassword());
		$this->doSave();
		$this->assertEquals($val, $this->lAMConfig->getJobsDBPassword());
	}

	/**
	 * Tests LAMConfig->getJobsDBName() and LAMConfig->setJobsDBName()
	 */
	public function testJobsDBName() {
		$val = 'name';
		$this->lAMConfig->setJobsDBName($val);
		$this->assertEquals($val, $this->lAMConfig->getJobsDBName());
		$this->doSave();
		$this->assertEquals($val, $this->lAMConfig->getJobsDBName());
	}

	/**
	 * Tests LAMConfig->setJobSettings() and LAMConfig->getJobSettings()
	 */
	public function testJobSettings() {
		$val = array('setting' => array('123'));
		$this->lAMConfig->setJobSettings($val);
		$this->assertEquals($val, $this->lAMConfig->getJobSettings());
		$this->doSave();
		$this->assertEquals($val, $this->lAMConfig->getJobSettings());
	}

	/**
	 * Tests LAMConfig->getJobToken()
	 */
	public function testGetJobToken() {
		$this->assertFalse(empty($this->lAMConfig->getJobToken()));
	}

	/**
	 * Saves the config
	 */
	public function doSave() {
		$this->lAMConfig->save();
		$this->lAMConfig = new LAMConfig(LAMConfigTest::FILE_NAME);
	}

}