Merge branch 'master' into feature/support-for-file-uploads-8758

This commit is contained in:
Johannes Meyer 2015-07-22 08:47:24 +02:00
commit cecd94be50
26 changed files with 717 additions and 320 deletions

View File

@ -53,7 +53,7 @@ class ConfigController extends Controller
)); ));
$tabs->add('usergroupbackend', array( $tabs->add('usergroupbackend', array(
'title' => $this->translate('Configure how users are associated with groups by Icinga Web 2'), 'title' => $this->translate('Configure how users are associated with groups by Icinga Web 2'),
'label' => $this->translate('Usergroup Backends'), 'label' => $this->translate('User Group Backends'),
'url' => 'usergroupbackend/list' 'url' => 'usergroupbackend/list'
)); ));
return $tabs; return $tabs;

View File

@ -160,7 +160,7 @@ class UsergroupbackendController extends Controller
)); ));
$tabs->add('usergroupbackend', array( $tabs->add('usergroupbackend', array(
'title' => $this->translate('Configure how users are associated with groups by Icinga Web 2'), 'title' => $this->translate('Configure how users are associated with groups by Icinga Web 2'),
'label' => $this->translate('Usergroup Backends'), 'label' => $this->translate('User Group Backends'),
'url' => 'usergroupbackend/list' 'url' => 'usergroupbackend/list'
)); ));
return $tabs; return $tabs;

View File

@ -129,16 +129,13 @@ class DbResourceForm extends Form
*/ */
public static function isValidResource(Form $form) public static function isValidResource(Form $form)
{ {
try { $result = ResourceFactory::createResource(new ConfigObject($form->getValues()))->inspect();
$resource = ResourceFactory::createResource(new ConfigObject($form->getValues())); if ($result->hasError()) {
$resource->getConnection()->getConnection(); $form->addError(sprintf($form->translate('Connectivity validation failed: %s'), $result->getError()));
} catch (Exception $e) {
$form->addError(
$form->translate('Connectivity validation failed, connection to the given resource not possible.')
);
return false;
} }
return true; // TODO: display diagnostics in $result->toArray() to the user
return ! $result->hasError();
} }
} }

View File

@ -154,19 +154,17 @@ class LdapResourceForm extends Form
*/ */
public static function isValidResource(Form $form) public static function isValidResource(Form $form)
{ {
try { $result = ResourceFactory::createResource(new ConfigObject($form->getValues()))->inspect();
$resource = ResourceFactory::createResource(new ConfigObject($form->getValues())); if ($result->hasError()) {
$resource->bind(); $form->addError(sprintf(
} catch (Exception $e) { '%s (%s)',
$msg = $form->translate('Connectivity validation failed, connection to the given resource not possible.'); $form->translate('Connectivity validation failed, connection to the given resource not possible.'),
if (($error = $e->getMessage())) { $result->getError()
$msg .= ' (' . $error . ')'; ));
}
$form->addError($msg);
return false;
} }
return true; // TODO: display diagnostics in $result->toArray() to the user
return ! $result->hasError();
} }
} }

View File

@ -105,18 +105,15 @@ class DbBackendForm extends Form
*/ */
public static function isValidUserBackend(Form $form) public static function isValidUserBackend(Form $form)
{ {
try { $backend = new DbUserBackend(ResourceFactory::createResource($form->getResourceConfig()));
$dbUserBackend = new DbUserBackend(ResourceFactory::createResource($form->getResourceConfig())); $result = $backend->inspect();
if ($dbUserBackend->select()->where('is_active', true)->count() < 1) { if ($result->hasError()) {
$form->addError($form->translate('No active users found under the specified database backend')); $form->addError(sprintf($form->translate('Using the specified backend failed: %s'), $result->getError()));
return false;
}
} catch (Exception $e) {
$form->addError(sprintf($form->translate('Using the specified backend failed: %s'), $e->getMessage()));
return false;
} }
return true; // TODO: display diagnostics in $result->toArray() to the user
return ! $result->hasError();
} }
/** /**

View File

@ -4,6 +4,8 @@
namespace Icinga\Forms\Config\UserBackend; namespace Icinga\Forms\Config\UserBackend;
use Exception; use Exception;
use Icinga\Authentication\User\LdapUserBackend;
use Icinga\Data\Inspection;
use Icinga\Web\Form; use Icinga\Web\Form;
use Icinga\Data\ConfigObject; use Icinga\Data\ConfigObject;
use Icinga\Data\ResourceFactory; use Icinga\Data\ResourceFactory;
@ -184,22 +186,16 @@ class LdapBackendForm extends Form
*/ */
public static function isValidUserBackend(Form $form) public static function isValidUserBackend(Form $form)
{ {
try { /**
$ldapUserBackend = UserBackend::create(null, new ConfigObject($form->getValues())); * @var $result Inspection
$ldapUserBackend->assertAuthenticationPossible(); */
} catch (AuthenticationException $e) { $result = UserBackend::create(null, new ConfigObject($form->getValues()))->inspect();
if (($previous = $e->getPrevious()) !== null) { if ($result->hasError()) {
$form->addError($previous->getMessage()); $form->addError($result->getError());
} else {
$form->addError($e->getMessage());
}
return false;
} catch (Exception $e) {
$form->addError(sprintf($form->translate('Unable to validate authentication: %s'), $e->getMessage()));
return false;
} }
return true; // TODO: display diagnostics in $result->toArray() to the user
return ! $result->hasError();
} }
} }

View File

@ -46,8 +46,6 @@ Requires: %{name}-vendor-HTMLPurifier
Requires: %{name}-vendor-JShrink Requires: %{name}-vendor-JShrink
Requires: %{name}-vendor-lessphp Requires: %{name}-vendor-lessphp
Requires: %{name}-vendor-Parsedown Requires: %{name}-vendor-Parsedown
Requires: %{zend}
Obsoletes: %{name}-vendor-zend
%description %description
@ -84,6 +82,10 @@ Requires: %{php}-gd %{php}-intl
%{?fedora:Requires: php-pecl-imagick} %{?fedora:Requires: php-pecl-imagick}
%{?rhel:Requires: php-pecl-imagick} %{?rhel:Requires: php-pecl-imagick}
%{?suse_version:Requires: %{php}-gettext %{php}-json %{php}-openssl %{php}-posix} %{?suse_version:Requires: %{php}-gettext %{php}-json %{php}-openssl %{php}-posix}
Requires: %{zend}
Obsoletes: %{name}-vendor-zend
Requires: %{zend}-Db-Adapter-Pdo-Mysql
Requires: %{zend}-Db-Adapter-Pdo-Pgsql
%description -n php-Icinga %description -n php-Icinga
Icinga Web 2 PHP library Icinga Web 2 PHP library

View File

@ -4,13 +4,15 @@
namespace Icinga\Authentication\User; namespace Icinga\Authentication\User;
use Exception; use Exception;
use Icinga\Data\Inspectable;
use Icinga\Data\Inspection;
use PDO; use PDO;
use Icinga\Data\Filter\Filter; use Icinga\Data\Filter\Filter;
use Icinga\Exception\AuthenticationException; use Icinga\Exception\AuthenticationException;
use Icinga\Repository\DbRepository; use Icinga\Repository\DbRepository;
use Icinga\User; use Icinga\User;
class DbUserBackend extends DbRepository implements UserBackendInterface class DbUserBackend extends DbRepository implements UserBackendInterface, Inspectable
{ {
/** /**
* The algorithm to use when hashing passwords * The algorithm to use when hashing passwords
@ -246,4 +248,26 @@ class DbUserBackend extends DbRepository implements UserBackendInterface
{ {
return crypt($password, self::HASH_ALGORITHM . ($salt !== null ? $salt : $this->generateSalt())); return crypt($password, self::HASH_ALGORITHM . ($salt !== null ? $salt : $this->generateSalt()));
} }
/**
* Inspect this object to gain extended information about its health
*
* @return Inspection The inspection result
*/
public function inspect()
{
$insp = new Inspection('Db User Backend');
$insp->write($this->ds->inspect());
try {
$users = $this->select()->where('is_active', true)->count();
if ($users > 1) {
$insp->write(sprintf('%s active users', $users));
} else {
return $insp->error('0 active users', $users);
}
} catch (Exception $e) {
$insp->error(sprintf('Query failed: %s', $e->getMessage()));
}
return $insp;
}
} }

View File

@ -5,6 +5,8 @@ namespace Icinga\Authentication\User;
use DateTime; use DateTime;
use Icinga\Data\ConfigObject; use Icinga\Data\ConfigObject;
use Icinga\Data\Inspectable;
use Icinga\Data\Inspection;
use Icinga\Exception\AuthenticationException; use Icinga\Exception\AuthenticationException;
use Icinga\Exception\ProgrammingError; use Icinga\Exception\ProgrammingError;
use Icinga\Repository\LdapRepository; use Icinga\Repository\LdapRepository;
@ -13,7 +15,7 @@ use Icinga\Protocol\Ldap\LdapException;
use Icinga\Protocol\Ldap\Expression; use Icinga\Protocol\Ldap\Expression;
use Icinga\User; use Icinga\User;
class LdapUserBackend extends LdapRepository implements UserBackendInterface class LdapUserBackend extends LdapRepository implements UserBackendInterface, Inspectable
{ {
/** /**
* The base DN to use for a query * The base DN to use for a query
@ -306,41 +308,14 @@ class LdapUserBackend extends LdapRepository implements UserBackendInterface
} }
/** /**
* Probe the backend to test if authentication is possible
* * @param Inspection $info Optional inspection to fill with diagnostic info
* Try to bind to the backend and fetch a single user to check if:
* <ul>
* <li>Connection credentials are correct and the bind is possible</li>
* <li>At least one user exists</li>
* <li>The specified userClass has the property specified by userNameAttribute</li>
* </ul>
* *
* @throws AuthenticationException When authentication is not possible * @throws AuthenticationException When authentication is not possible
*/ */
public function assertAuthenticationPossible() public function assertAuthenticationPossible(Inspection $insp = null)
{ {
try {
$result = $this->select()->fetchRow();
} catch (LdapException $e) {
throw new AuthenticationException('Connection not possible.', $e);
}
if ($result === false) {
throw new AuthenticationException(
'No objects with objectClass "%s" in DN "%s" found. (Filter: %s)',
$this->userClass,
$this->baseDn ?: $this->ds->getDn(),
$this->filter ?: 'None'
);
}
if (! isset($result->user_name)) {
throw new AuthenticationException(
'UserNameAttribute "%s" not existing in objectClass "%s"',
$this->userNameAttribute,
$this->userClass
);
}
} }
/** /**
@ -377,4 +352,58 @@ class LdapUserBackend extends LdapRepository implements UserBackendInterface
); );
} }
} }
/**
* Inspect if this LDAP User Backend is working as expected by probing the backend
* and testing if thea uthentication is possible
*
* Try to bind to the backend and fetch a single user to check if:
* <ul>
* <li>Connection credentials are correct and the bind is possible</li>
* <li>At least one user exists</li>
* <li>The specified userClass has the property specified by userNameAttribute</li>
* </ul>
*
* @return Inspection Inspection result
*/
public function inspect()
{
$result = new Inspection('Ldap User Backend');
// inspect the used connection to get more diagnostic info in case the connection is not working
$result->write($this->ds->inspect());
try {
try {
$res = $this->select()->fetchRow();
} catch (LdapException $e) {
throw new AuthenticationException('Connection not possible', $e);
}
$result->write('Searching for: ' . sprintf(
'objectClass "%s" in DN "%s" (Filter: %s)',
$this->userClass,
$this->baseDn ?: $this->ds->getDn(),
$this->filter ?: 'None'
));
if ($res === false) {
throw new AuthenticationException('Error, no users found in backend');
}
$result->write(sprintf('%d users found in backend', $this->select()->count()));
if (! isset($res->user_name)) {
throw new AuthenticationException(
'UserNameAttribute "%s" not existing in objectClass "%s"',
$this->userNameAttribute,
$this->userClass
);
}
} catch (AuthenticationException $e) {
if (($previous = $e->getPrevious()) !== null) {
$result->error($previous->getMessage());
} else {
$result->error($e->getMessage());
}
} catch (Exception $e) {
$result->error(sprintf('Unable to validate authentication: %s', $e->getMessage()));
}
return $result;
}
} }

View File

@ -3,6 +3,9 @@
namespace Icinga\Data\Db; namespace Icinga\Data\Db;
use Exception;
use Icinga\Data\Inspectable;
use Icinga\Data\Inspection;
use PDO; use PDO;
use Iterator; use Iterator;
use Zend_Db; use Zend_Db;
@ -23,7 +26,7 @@ use Icinga\Exception\ProgrammingError;
/** /**
* Encapsulate database connections and query creation * Encapsulate database connections and query creation
*/ */
class DbConnection implements Selectable, Extensible, Updatable, Reducible class DbConnection implements Selectable, Extensible, Updatable, Reducible, Inspectable
{ {
/** /**
* Connection config * Connection config
@ -435,4 +438,42 @@ class DbConnection implements Selectable, Extensible, Updatable, Reducible
return $column . ' ' . $sign . ' ' . $this->dbAdapter->quote($value); return $column . ' ' . $sign . ' ' . $this->dbAdapter->quote($value);
} }
} }
public function inspect()
{
$insp = new Inspection('Db Connection');
try {
$this->getDbAdapter()->getConnection();
$config = $this->dbAdapter->getConfig();
$insp->write(sprintf(
'Connection to %s as %s on %s:%s successful',
$config['dbname'],
$config['username'],
$config['host'],
$config['port']
));
switch ($this->dbType) {
case 'mysql':
$rows = $this->dbAdapter->query(
'SHOW VARIABLES WHERE variable_name ' .
'IN (\'version\', \'protocol_version\', \'version_compile_os\');'
)->fetchAll();
$sqlinsp = new Inspection('MySQL');
foreach ($rows as $row) {
$sqlinsp->write($row->variable_name . ': ' . $row->value);
}
$insp->write($sqlinsp);
break;
case 'pgsql':
$row = $this->dbAdapter->query('SELECT version();')->fetchAll();
$sqlinsp = new Inspection('PostgreSQL');
$sqlinsp->write($row[0]->version);
$insp->write($sqlinsp);
break;
}
} catch (Exception $e) {
return $insp->error(sprintf('Connection failed %s', $e->getMessage()));
}
return $insp;
}
} }

View File

@ -3,24 +3,18 @@
namespace Icinga\Data; namespace Icinga\Data;
/** /**
* An object for which the user can retrieve status information * An object for which the user can retrieve status information
*
* This interface is useful for providing summaries or diagnostic information about objects
* to users.
*/ */
interface Inspectable interface Inspectable
{ {
/** /**
* Get information about this objects state * Inspect this object to gain extended information about its health
* *
* @return array An array of strings that describe the state in a human-readable form, each array element * @return Inspection The inspection result
* represents one fact about this object
*/ */
public function getInfo(); public function inspect();
/**
* If this object is working in its current configuration
*
* @return Bool True if the object is working, false if not
*/
public function isHealthy();
} }

View File

@ -0,0 +1,127 @@
<?php
/* Icinga Web 2 | (c) 2013-2015 Icinga Development Team | GPLv2+ */
namespace Icinga\Data;
use Icinga\Application\Logger;
use Icinga\Exception\ProgrammingError;
/**
* Contains information about an object in the form of human-readable log entries and indicates if the object has errors
*/
class Inspection
{
/**
* @var array
*/
protected $log = array();
/**
* @var string
*/
protected $description;
/**
* @var string|Inspection
*/
protected $error;
/**
* @param $description Describes the object that is being inspected
*/
public function __construct($description)
{
$this->description = $description;
}
/**
* Get the name of this Inspection
*
* @return mixed
*/
public function getDescription()
{
return $this->description;
}
/**
* Append the given log entry or nested inspection
*
* @throws ProgrammingError When called after erroring
*
* @param $entry string|Inspection A log entry or nested inspection
*/
public function write($entry)
{
if (isset($this->error)) {
throw new ProgrammingError('Inspection object used after error');
}
if ($entry instanceof Inspection) {
$this->log[$entry->description] = $entry->toArray();
} else {
$this->log[] = $entry;
}
}
/**
* Append the given log entry and fail this inspection with the given error
*
* @param $entry string|Inspection A log entry or nested inspection
*
* @throws ProgrammingError When called multiple times
*
* @return this fluent interface
*/
public function error($entry)
{
if (isset($this->error)) {
throw new ProgrammingError('Inspection object used after error');
}
$this->write($entry);
$this->error = $entry;
return $this;
}
/**
* If the inspection resulted in an error
*
* @return bool
*/
public function hasError()
{
return isset($this->error);
}
/**
* The error that caused the inspection to fail
*
* @return Inspection|string
*/
public function getError()
{
return $this->error;
}
/**
* Convert the inspection to an array
*
* @return array An array of strings that describe the state in a human-readable form, each array element
* represents one log entry about this object.
*/
public function toArray()
{
return $this->log;
}
/**
* Return a text representation of the inspection log entries
*/
public function __toString()
{
return sprintf(
'Inspection: description: "%s" error: "%s"',
$this->description,
$this->error
);
}
}

View File

@ -263,14 +263,15 @@ class LdapCapabilities
* Discover the capabilities of the given LDAP server * Discover the capabilities of the given LDAP server
* *
* @param LdapConnection $connection The ldap connection to use * @param LdapConnection $connection The ldap connection to use
* @param int $ds The link identifier of the current LDAP connection
* *
* @return LdapCapabilities * @return LdapCapabilities
* *
* @throws LdapException In case the capability query has failed * @throws LdapException In case the capability query has failed
*/ */
public static function discoverCapabilities(LdapConnection $connection, $ds) public static function discoverCapabilities(LdapConnection $connection)
{ {
$ds = $connection->getConnection();
$fields = array( $fields = array(
'defaultNamingContext', 'defaultNamingContext',
'namingContexts', 'namingContexts',

View File

@ -10,8 +10,10 @@ use Icinga\Application\Logger;
use Icinga\Application\Platform; use Icinga\Application\Platform;
use Icinga\Data\ConfigObject; use Icinga\Data\ConfigObject;
use Icinga\Data\Inspectable; use Icinga\Data\Inspectable;
use Icinga\Data\Inspection;
use Icinga\Data\Selectable; use Icinga\Data\Selectable;
use Icinga\Data\Sortable; use Icinga\Data\Sortable;
use Icinga\Exception\InspectionException;
use Icinga\Exception\ProgrammingError; use Icinga\Exception\ProgrammingError;
use Icinga\Protocol\Ldap\LdapException; use Icinga\Protocol\Ldap\LdapException;
@ -162,16 +164,6 @@ class LdapConnection implements Selectable, Inspectable
*/ */
protected $encrypted = null; protected $encrypted = null;
/**
* @var array
*/
protected $info = null;
/**
* @var Boolean
*/
protected $healthy = null;
/** /**
* Create a new connection object * Create a new connection object
* *
@ -261,7 +253,7 @@ class LdapConnection implements Selectable, Inspectable
{ {
if ($this->capabilities === null) { if ($this->capabilities === null) {
try { try {
$this->capabilities = $this->discoverCapabilities($this->getConnection()); $this->capabilities = LdapCapabilities::discoverCapabilities($this);
$this->discoverySuccess = true; $this->discoverySuccess = true;
} catch (LdapException $e) { } catch (LdapException $e) {
Logger::debug($e); Logger::debug($e);
@ -711,8 +703,7 @@ class LdapConnection implements Selectable, Inspectable
array_flip($fields) array_flip($fields)
); );
} }
} while ( } while ((! $serverSorting || $limit === 0 || $limit !== count($entries))
(! $serverSorting || $limit === 0 || $limit !== count($entries))
&& ($entry = ldap_next_entry($ds, $entry)) && ($entry = ldap_next_entry($ds, $entry))
); );
@ -953,21 +944,27 @@ class LdapConnection implements Selectable, Inspectable
/** /**
* Prepare and establish a connection with the LDAP server * Prepare and establish a connection with the LDAP server
* *
* @return resource A LDAP link identifier * @param Inspection $info Optional inspection to fill with diagnostic info
* *
* @throws LdapException In case the connection is not possible * @return resource A LDAP link identifier
*
* @throws LdapException In case the connection is not possible
*/ */
protected function prepareNewConnection() protected function prepareNewConnection(Inspection $info = null)
{ {
if (! isset($info)) {
$info = new Inspection('');
}
if ($this->encryption === static::STARTTLS || $this->encryption === static::LDAPS) { if ($this->encryption === static::STARTTLS || $this->encryption === static::LDAPS) {
$this->prepareTlsEnvironment(); $this->prepareTlsEnvironment();
} }
$hostname = $this->hostname; $hostname = $this->hostname;
if ($this->encryption === static::LDAPS) { if ($this->encryption === static::LDAPS) {
$this->logInfo('Connect using LDAPS'); $info->write('Connect using LDAPS');
if (! $this->validateCertificate) { if (! $this->validateCertificate) {
$this->logInfo('Skipping certificate validation'); $info->write('Skip certificate validation');
} }
$hostname = 'ldaps://' . $hostname; $hostname = 'ldaps://' . $hostname;
} }
@ -984,9 +981,9 @@ class LdapConnection implements Selectable, Inspectable
if ($this->encryption === static::STARTTLS) { if ($this->encryption === static::STARTTLS) {
$this->encrypted = true; $this->encrypted = true;
$this->logInfo('Connect using STARTTLS'); $info->write('Connect using STARTTLS');
if (! $this->validateCertificate) { if (! $this->validateCertificate) {
$this->logInfo('Skipping certificate validation'); $info->write('Skip certificate validation');
} }
if (! ldap_start_tls($ds)) { if (! ldap_start_tls($ds)) {
throw new LdapException('LDAP STARTTLS failed: %s', ldap_error($ds)); throw new LdapException('LDAP STARTTLS failed: %s', ldap_error($ds));
@ -994,60 +991,12 @@ class LdapConnection implements Selectable, Inspectable
} elseif ($this->encryption !== static::LDAPS) { } elseif ($this->encryption !== static::LDAPS) {
$this->encrypted = false; $this->encrypted = false;
$this->logInfo('Connect without encryption'); $info->write('Connect without encryption');
} }
return $ds; return $ds;
} }
/**
* Test if needed aspects of the LDAP connection are working as expected
*
* Extended information about the
*
* @throws \Icinga\Protocol\Ldap\LdapException When a critical aspect of the health test fails
*/
public function testConnectionHealth()
{
$this->healthy = false;
$this->info = array();
// Try to connect to the server with the given connection parameters
$ds = $this->prepareNewConnection();
// Try a bind-command with the given user credentials, this must not fail
$success = @ldap_bind($ds, $this->bindDn, $this->bindPw);
$msg = sprintf(
'LDAP bind to %s:%s (%s / %s)',
$this->hostname,
$this->port,
$this->bindDn,
'***' /* $this->bindPw */
);
if (! $success) {
throw new LdapException('%s failed: %s', $msg, ldap_error($ds));
}
$this->logInfo(sprintf($msg . ' successful'));
// Try to execute a schema discovery, this may fail if schema discovery is not supported
try {
$cap = LdapCapabilities::discoverCapabilities($this, $ds);
$infos []= $cap->getVendor();
$version = $cap->getVersion();
if (isset($version)) {
$infos []= $version;
}
$infos []= 'Supports STARTTLS: ' . ($cap->hasStartTls() ? 'True' : 'False');
$infos []= 'Default naming context: ' . $cap->getDefaultNamingContext();
$this->info['Discovery Results:'] = $infos;
} catch (Exception $e) {
$this->logInfo('Schema discovery not possible: ', $e->getMessage());
}
$this->healthy = true;
}
/** /**
* Set up how to handle StartTLS connections * Set up how to handle StartTLS connections
* *
@ -1137,43 +1086,55 @@ class LdapConnection implements Selectable, Inspectable
return $dir; return $dir;
} }
protected function logInfo($message)
{
Logger::debug($message);
if (! isset($this->info)) {
$this->info = array();
}
$this->info[] = $message;
}
/** /**
* Get information about this objects state * Inspect if this LDAP Connection is working as expected
* *
* @return array An array of strings that describe the state in a human-readable form, each array element * Check if connection, bind and encryption is working as expected and get additional
* represents one fact about this object * information about the used
*
* @return Inspection Inspection result
*/ */
public function getInfo() public function inspect()
{ {
if (! isset($this->info)) { $insp = new Inspection('Ldap Connection');
$this->testConnectionHealth();
}
return $this->info;
}
/** // Try to connect to the server with the given connection parameters
* If this object is working in its current configuration try {
* $ds = $this->prepareNewConnection($insp);
* @return Bool True if the object is working, false if not } catch (Exception $e) {
*/ return $insp->error($e->getMessage());
public function isHealthy() }
{
if (! isset($this->healthy)) { // Try a bind-command with the given user credentials, this must not fail
try { $success = @ldap_bind($ds, $this->bindDn, $this->bindPw);
$this->testConnectionHealth(); $msg = sprintf(
} catch (Exception $e) { 'LDAP bind to %s:%s (%s / %s)',
$this->hostname,
$this->port,
$this->bindDn,
'***' /* $this->bindPw */
);
if (! $success) {
return $insp->error(sprintf('%s failed: %s', $msg, ldap_error($ds)));
}
$insp->write(sprintf($msg . ' successful'));
// Try to execute a schema discovery this may fail if schema discovery is not supported
try {
$cap = LdapCapabilities::discoverCapabilities($this);
$discovery = new Inspection('Discovery Results');
$discovery->write($cap->getVendor());
$version = $cap->getVersion();
if (isset($version)) {
$discovery->write($version);
} }
$discovery->write('Supports STARTTLS: ' . ($cap->hasStartTls() ? 'True' : 'False'));
$discovery->write('Default naming context: ' . $cap->getDefaultNamingContext());
$insp->write($discovery);
} catch (Exception $e) {
$insp->write('Schema discovery not possible: ' . $e->getMessage());
} }
return $this->healthy; return $insp;
} }
/** /**

View File

@ -160,6 +160,13 @@ class Form extends Zend_Form
*/ */
protected $notifications; protected $notifications;
/**
* The hints of this form
*
* @var array
*/
protected $hints;
/** /**
* Whether the Autosubmit decorator should be applied to this form * Whether the Autosubmit decorator should be applied to this form
* *
@ -574,6 +581,49 @@ class Form extends Zend_Form
return $this->notifications; return $this->notifications;
} }
/**
* Set the hints for this form
*
* @param array $hints
*
* @return $this
*/
public function setHints(array $hints)
{
$this->hints = $hints;
return $this;
}
/**
* Add a hint for this form
*
* If $hint is an array the second value should be an
* array as well containing additional HTML properties.
*
* @param string|array $hint
*
* @return $this
*/
public function addHint($hint)
{
$this->hints[] = $hint;
return $this;
}
/**
* Return the hints of this form
*
* @return array
*/
public function getHints()
{
if ($this->hints === null) {
return array();
}
return $this->hints;
}
/** /**
* Set whether the Autosubmit decorator should be applied to this form * Set whether the Autosubmit decorator should be applied to this form
* *
@ -1103,10 +1153,11 @@ class Form extends Zend_Form
->addDecorator('HtmlTag', array('tag' => 'div', 'class' => 'header')); ->addDecorator('HtmlTag', array('tag' => 'div', 'class' => 'header'));
} }
$this->addDecorator('FormErrors', array('onlyCustomFormErrors' => true)) $this->addDecorator('FormDescriptions')
->addDecorator('FormNotifications') ->addDecorator('FormNotifications')
->addDecorator('FormDescriptions') ->addDecorator('FormErrors', array('onlyCustomFormErrors' => true))
->addDecorator('FormElements') ->addDecorator('FormElements')
->addDecorator('FormHints')
//->addDecorator('HtmlTag', array('tag' => 'dl', 'class' => 'zend_form')) //->addDecorator('HtmlTag', array('tag' => 'dl', 'class' => 'zend_form'))
->addDecorator('Form'); ->addDecorator('Form');
} }

View File

@ -7,35 +7,10 @@ use Zend_Form_Decorator_Abstract;
use Icinga\Web\Form; use Icinga\Web\Form;
/** /**
* Decorator to add a list of descriptions at the top of a form * Decorator to add a list of descriptions at the top or bottom of a form
*
* The description for required form elements is automatically being handled.
*/ */
class FormDescriptions extends Zend_Form_Decorator_Abstract class FormDescriptions extends Zend_Form_Decorator_Abstract
{ {
/**
* A list of element class names to be ignored when detecting which message to use to describe required elements
*
* @var array
*/
protected $blacklist;
/**
* {@inheritdoc}
*/
public function __construct($options = null)
{
parent::__construct($options);
$this->blacklist = array(
'Zend_Form_Element_Hidden',
'Zend_Form_Element_Submit',
'Zend_Form_Element_Button',
'Icinga\Web\Form\Element\Note',
'Icinga\Web\Form\Element\Button',
'Icinga\Web\Form\Element\CsrfCounterMeasure'
);
}
/** /**
* Render form descriptions * Render form descriptions
* *
@ -55,18 +30,7 @@ class FormDescriptions extends Zend_Form_Decorator_Abstract
return $content; return $content;
} }
$descriptions = $this->recurseForm($form, $entirelyRequired); $descriptions = $this->recurseForm($form);
if ($entirelyRequired) {
$descriptions[] = $form->getView()->translate(
'All fields are required and must be filled in to complete the form.'
);
} elseif ($entirelyRequired === false) {
$descriptions[] = $form->getView()->translate(sprintf(
'Required fields are marked with %s and must be filled in to complete the form.',
$form->getRequiredCue()
));
}
if (empty($descriptions)) { if (empty($descriptions)) {
return $content; return $content;
} }
@ -92,53 +56,15 @@ class FormDescriptions extends Zend_Form_Decorator_Abstract
/** /**
* Recurse the given form and return the descriptions for it and all of its subforms * Recurse the given form and return the descriptions for it and all of its subforms
* *
* @param Form $form The form to recurse * @param Form $form The form to recurse
* @param mixed $entirelyRequired Set by reference, true means all elements in the hierarchy are
* required, false only a partial subset and null none at all
* @param bool $elementsPassed Whether there were any elements passed during the recursion until now
* *
* @return array * @return array
*/ */
protected function recurseForm(Form $form, & $entirelyRequired = null, $elementsPassed = false) protected function recurseForm(Form $form)
{ {
$requiredLabels = array();
if ($form->getRequiredCue() !== null) {
$partiallyRequired = $partiallyOptional = false;
foreach ($form->getElements() as $element) {
if (! in_array($element->getType(), $this->blacklist)) {
if (! $element->isRequired()) {
$partiallyOptional = true;
if ($entirelyRequired) {
$entirelyRequired = false;
}
} else {
$partiallyRequired = true;
if (($label = $element->getDecorator('label')) !== false) {
$requiredLabels[] = $label;
}
}
}
}
if (! $elementsPassed) {
$elementsPassed = $partiallyRequired || $partiallyOptional;
if ($entirelyRequired === null && $partiallyRequired) {
$entirelyRequired = ! $partiallyOptional;
}
} elseif ($entirelyRequired === null && $partiallyRequired) {
$entirelyRequired = false;
}
}
$descriptions = array($form->getDescriptions()); $descriptions = array($form->getDescriptions());
foreach ($form->getSubForms() as $subForm) { foreach ($form->getSubForms() as $subForm) {
$descriptions[] = $this->recurseForm($subForm, $entirelyRequired, $elementsPassed); $descriptions[] = $this->recurseForm($subForm);
}
if ($entirelyRequired) {
foreach ($requiredLabels as $label) {
$label->setRequiredSuffix('');
}
} }
return call_user_func_array('array_merge', $descriptions); return call_user_func_array('array_merge', $descriptions);

View File

@ -0,0 +1,142 @@
<?php
/* Icinga Web 2 | (c) 2013-2015 Icinga Development Team | GPLv2+ */
namespace Icinga\Web\Form\Decorator;
use Zend_Form_Decorator_Abstract;
use Icinga\Web\Form;
/**
* Decorator to add a list of hints at the top or bottom of a form
*
* The hint for required form elements is automatically being handled.
*/
class FormHints extends Zend_Form_Decorator_Abstract
{
/**
* A list of element class names to be ignored when detecting which message to use to describe required elements
*
* @var array
*/
protected $blacklist;
/**
* {@inheritdoc}
*/
public function __construct($options = null)
{
parent::__construct($options);
$this->blacklist = array(
'Zend_Form_Element_Hidden',
'Zend_Form_Element_Submit',
'Zend_Form_Element_Button',
'Icinga\Web\Form\Element\Note',
'Icinga\Web\Form\Element\Button',
'Icinga\Web\Form\Element\CsrfCounterMeasure'
);
}
/**
* Render form hints
*
* @param string $content The html rendered so far
*
* @return string The updated html
*/
public function render($content = '')
{
$form = $this->getElement();
if (! $form instanceof Form) {
return $content;
}
$view = $form->getView();
if ($view === null) {
return $content;
}
$hints = $this->recurseForm($form, $entirelyRequired);
if ($entirelyRequired !== null) {
$hints[] = $form->getView()->translate(sprintf(
'Required fields are marked with %s and must be filled in to complete the form.',
$form->getRequiredCue()
));
}
if (empty($hints)) {
return $content;
}
$html = '<ul class="hints">';
foreach ($hints as $hint) {
if (is_array($hint)) {
list($hint, $properties) = $hint;
$html .= '<li' . $view->propertiesToString($properties) . '>' . $view->escape($hint) . '</li>';
} else {
$html .= '<li>' . $view->escape($hint) . '</li>';
}
}
switch ($this->getPlacement()) {
case self::APPEND:
return $content . $html . '</ul>';
case self::PREPEND:
return $html . '</ul>' . $content;
}
}
/**
* Recurse the given form and return the hints for it and all of its subforms
*
* @param Form $form The form to recurse
* @param mixed $entirelyRequired Set by reference, true means all elements in the hierarchy are
* required, false only a partial subset and null none at all
* @param bool $elementsPassed Whether there were any elements passed during the recursion until now
*
* @return array
*/
protected function recurseForm(Form $form, & $entirelyRequired = null, $elementsPassed = false)
{
$requiredLabels = array();
if ($form->getRequiredCue() !== null) {
$partiallyRequired = $partiallyOptional = false;
foreach ($form->getElements() as $element) {
if (! in_array($element->getType(), $this->blacklist)) {
if (! $element->isRequired()) {
$partiallyOptional = true;
if ($entirelyRequired) {
$entirelyRequired = false;
}
} else {
$partiallyRequired = true;
if (($label = $element->getDecorator('label')) !== false) {
$requiredLabels[] = $label;
}
}
}
}
if (! $elementsPassed) {
$elementsPassed = $partiallyRequired || $partiallyOptional;
if ($entirelyRequired === null && $partiallyRequired) {
$entirelyRequired = ! $partiallyOptional;
}
} elseif ($entirelyRequired === null && $partiallyRequired) {
$entirelyRequired = false;
}
}
$hints = array($form->getHints());
foreach ($form->getSubForms() as $subForm) {
$hints[] = $this->recurseForm($subForm, $entirelyRequired, $elementsPassed);
}
if ($entirelyRequired) {
foreach ($requiredLabels as $label) {
$label->setRequiredSuffix('');
}
}
return call_user_func_array('array_merge', $hints);
}
}

View File

@ -118,7 +118,13 @@ class MenuRenderer extends RecursiveIteratorIterator
try { try {
return $child->getRenderer()->render($child); return $child->getRenderer()->render($child);
} catch (Exception $e) { } catch (Exception $e) {
Logger::error('Could not invoke custom renderer. Exception: '. $e->getMessage()); Logger::error(
'Could not invoke custom menu renderer. %s in %s:%d with message: %s',
get_class($e),
$e->getFile(),
$e->getLine(),
$e->getMessage()
);
} }
} }

View File

@ -3,41 +3,50 @@
namespace Icinga\Module\Monitoring\Web\Menu; namespace Icinga\Module\Monitoring\Web\Menu;
use Icinga\Web\Menu as Menu; use Icinga\Web\Menu;
use Icinga\Module\Monitoring\Backend\MonitoringBackend;
use Icinga\Web\Menu\MenuItemRenderer; use Icinga\Web\Menu\MenuItemRenderer;
use Icinga\Module\Monitoring\Backend\MonitoringBackend;
class BackendAvailabilityMenuItemRenderer extends MenuItemRenderer class BackendAvailabilityMenuItemRenderer extends MenuItemRenderer
{ {
/** /**
* Checks whether the monitoring backend is running or not * Get whether or not the monitoring backend is currently running
* *
* @return mixed * @return bool
*/ */
protected function isCurrentlyRunning() protected function isCurrentlyRunning()
{ {
return MonitoringBackend::instance()->select()->from( $programStatus = MonitoringBackend::instance()
'programstatus', ->select()
array( ->from(
'is_currently_running' 'programstatus',
array('is_currently_running')
) )
)->getQuery()->fetchRow()->is_currently_running; ->fetchRow();
return $programStatus !== false ? (bool) $programStatus : false;
} }
/** /**
* @see MenuItemRenderer::render() * {@inheritdoc}
*/ */
public function render(Menu $menu) public function render(Menu $menu)
{ {
return $this->getBadge() . $this->createLink($menu); return $this->getBadge() . $this->createLink($menu);
} }
/**
* Get the problem badge HTML
*
* @return string
*/
protected function getBadge() protected function getBadge()
{ {
if (! (bool)$this->isCurrentlyRunning()) { if (! $this->isCurrentlyRunning()) {
return sprintf( return sprintf(
'<div title="%s" class="badge-container"><span class="badge badge-critical">%s</span></div>', '<div title="%s" class="badge-container"><span class="badge badge-critical">%d</span></div>',
mt('monitoring', 'monitoring backend is not running'), sprintf(
mt('monitoring', 'Monitoring backend %s is not running'), MonitoringBackend::instance()->getName()
),
1 1
); );
} }
@ -51,10 +60,12 @@ class BackendAvailabilityMenuItemRenderer extends MenuItemRenderer
*/ */
public function getSummary() public function getSummary()
{ {
if (! (bool)$this->isCurrentlyRunning()) { if (! $this->isCurrentlyRunning()) {
return array( return array(
'problems' => 1, 'problems' => 1,
'title' => mt('monitoring', 'monitoring backend is not running') 'title' => sprintf(
mt('monitoring', 'Monitoring backend %s is not running'), MonitoringBackend::instance()->getName()
)
); );
} }
return null; return null;

View File

@ -89,9 +89,6 @@ class AdminAccountPage extends Form
} }
if (count($choices) > 1) { if (count($choices) > 1) {
$this->addDescription($this->translate(
'Below are several options you can choose from for how to define the desired account.'
));
$this->addElement( $this->addElement(
'select', 'select',
'user_type', 'user_type',
@ -99,6 +96,7 @@ class AdminAccountPage extends Form
'required' => true, 'required' => true,
'autosubmit' => true, 'autosubmit' => true,
'label' => $this->translate('Type Of Definition'), 'label' => $this->translate('Type Of Definition'),
'description' => $this->translate('Choose how to define the desired account.'),
'multiOptions' => $choices, 'multiOptions' => $choices,
'value' => $choice 'value' => $choice
) )
@ -124,7 +122,7 @@ class AdminAccountPage extends Form
'label' => $this->translate('Username'), 'label' => $this->translate('Username'),
'description' => $this->translate( 'description' => $this->translate(
'Define the initial administrative account by providing a username that reflects' 'Define the initial administrative account by providing a username that reflects'
. ' a user created later or one that is authenticated using external mechanisms' . ' a user created later or one that is authenticated using external mechanisms.'
) )
) )
); );
@ -139,7 +137,7 @@ class AdminAccountPage extends Form
'label' => $this->translate('Username'), 'label' => $this->translate('Username'),
'description' => sprintf( 'description' => sprintf(
$this->translate( $this->translate(
'Choose a user reported by the %s backend as the initial administrative account', 'Choose a user reported by the %s backend as the initial administrative account.',
'setup.admin' 'setup.admin'
), ),
$this->backendConfig['backend'] === 'db' $this->backendConfig['backend'] === 'db'
@ -159,7 +157,7 @@ class AdminAccountPage extends Form
'required' => true, 'required' => true,
'label' => $this->translate('Username'), 'label' => $this->translate('Username'),
'description' => $this->translate( 'description' => $this->translate(
'Enter the username to be used when creating an initial administrative account' 'Enter the username to be used when creating an initial administrative account.'
) )
) )
); );
@ -170,7 +168,9 @@ class AdminAccountPage extends Form
'required' => true, 'required' => true,
'renderPassword' => true, 'renderPassword' => true,
'label' => $this->translate('Password'), 'label' => $this->translate('Password'),
'description' => $this->translate('Enter the password to assign to the newly created account') 'description' => $this->translate(
'Enter the password to assign to the newly created account.'
)
) )
); );
$this->addElement( $this->addElement(
@ -181,7 +181,7 @@ class AdminAccountPage extends Form
'renderPassword' => true, 'renderPassword' => true,
'label' => $this->translate('Repeat password'), 'label' => $this->translate('Repeat password'),
'description' => $this->translate( 'description' => $this->translate(
'Please repeat the password given above to avoid typing errors' 'Please repeat the password given above to avoid typing errors.'
), ),
'validators' => array( 'validators' => array(
array('identical', false, array('new_user_password')) array('identical', false, array('new_user_password'))

View File

@ -259,3 +259,13 @@ form ul.descriptions {
} }
} }
} }
form ul.hints {
.non-list-like-list;
padding: 0.5em 0.5em 0 0.5em;
li {
font-size: 0.8em;
padding-bottom: 0.5em;
}
}

View File

@ -104,7 +104,7 @@ table.benchmark {
.info-box { .info-box {
padding: 0.5em; padding: 0.5em;
border: 1px solid lightgrey; border: 1px solid lightgrey;
background-color: #fbfcc5; background-color: #f2f4fd;
} }
/* Action table */ /* Action table */

View File

@ -26,7 +26,7 @@ class DbResourceFormTest extends BaseTestCase
public function testValidDbResourceIsValid() public function testValidDbResourceIsValid()
{ {
$this->setUpResourceFactoryMock( $this->setUpResourceFactoryMock(
Mockery::mock()->shouldReceive('getConnection')->atMost()->twice()->andReturn(Mockery::self())->getMock() Mockery::mock()->shouldReceive('inspect')->andReturn(self::createInspector(false))->getMock()
); );
$this->assertTrue( $this->assertTrue(
@ -42,7 +42,7 @@ class DbResourceFormTest extends BaseTestCase
public function testInvalidDbResourceIsNotValid() public function testInvalidDbResourceIsNotValid()
{ {
$this->setUpResourceFactoryMock( $this->setUpResourceFactoryMock(
Mockery::mock()->shouldReceive('getConnection')->once()->andThrow('\Exception')->getMock() Mockery::mock()->shouldReceive('inspect')->andReturn(self::createInspector(true))->getMock()
); );
$this->assertFalse( $this->assertFalse(
@ -58,4 +58,21 @@ class DbResourceFormTest extends BaseTestCase
->with(Mockery::type('Icinga\Data\ConfigObject')) ->with(Mockery::type('Icinga\Data\ConfigObject'))
->andReturn($resourceMock); ->andReturn($resourceMock);
} }
public static function createInspector($error = false, $log = array('log'))
{
if (! $error) {
$calls = array(
'hasError' => false,
'toArray' => $log
);
} else {
$calls = array(
'hasError' => true,
'getError' => 'Error',
'toArray' => $log
);
}
return Mockery::mock('Icinga\Data\Inspection', $calls);
}
} }

View File

@ -26,14 +26,16 @@ class LdapResourceFormTest extends BaseTestCase
public function testValidLdapResourceIsValid() public function testValidLdapResourceIsValid()
{ {
$this->setUpResourceFactoryMock( $this->setUpResourceFactoryMock(
Mockery::mock()->shouldReceive('bind')->once()->getMock() Mockery::mock()->shouldReceive('inspect')->andReturn(self::createInspector(false))->getMock()
); );
// Passing array(null) is required to make Mockery call the constructor... // Passing array(null) is required to make Mockery call the constructor...
$form = Mockery::mock('Icinga\Forms\Config\Resource\LdapResourceForm[getView]', array(null)); $form = Mockery::mock('Icinga\Forms\Config\Resource\LdapResourceForm[getView]', array(null));
$form->shouldReceive('getView->escape') $form->shouldReceive('getView->escape')
->with(Mockery::type('string')) ->with(Mockery::type('string'))
->andReturnUsing(function ($s) { return $s; }); ->andReturnUsing(function ($s) {
return $s;
});
$form->setTokenDisabled(); $form->setTokenDisabled();
$this->assertTrue( $this->assertTrue(
@ -49,14 +51,16 @@ class LdapResourceFormTest extends BaseTestCase
public function testInvalidLdapResourceIsNotValid() public function testInvalidLdapResourceIsNotValid()
{ {
$this->setUpResourceFactoryMock( $this->setUpResourceFactoryMock(
Mockery::mock()->shouldReceive('bind')->andThrow('\Exception')->getMock() Mockery::mock()->shouldReceive('inspect')->andReturn(self::createInspector(true))->getMock()
); );
// Passing array(null) is required to make Mockery call the constructor... // Passing array(null) is required to make Mockery call the constructor...
$form = Mockery::mock('Icinga\Forms\Config\Resource\LdapResourceForm[getView]', array(null)); $form = Mockery::mock('Icinga\Forms\Config\Resource\LdapResourceForm[getView]', array(null));
$form->shouldReceive('getView->escape') $form->shouldReceive('getView->escape')
->with(Mockery::type('string')) ->with(Mockery::type('string'))
->andReturnUsing(function ($s) { return $s; }); ->andReturnUsing(function ($s) {
return $s;
});
$form->setTokenDisabled(); $form->setTokenDisabled();
$this->assertFalse( $this->assertFalse(
@ -72,4 +76,21 @@ class LdapResourceFormTest extends BaseTestCase
->with(Mockery::type('Icinga\Data\ConfigObject')) ->with(Mockery::type('Icinga\Data\ConfigObject'))
->andReturn($resourceMock); ->andReturn($resourceMock);
} }
public static function createInspector($error = false, $log = array('log'))
{
if (! $error) {
$calls = array(
'hasError' => false,
'toArray' => $log
);
} else {
$calls = array(
'hasError' => true,
'getError' => 'Error',
'toArray' => $log
);
}
return Mockery::mock('Icinga\Data\Inspection', $calls);
}
} }

View File

@ -28,14 +28,16 @@ class DbBackendFormTest extends BaseTestCase
{ {
$this->setUpResourceFactoryMock(); $this->setUpResourceFactoryMock();
Mockery::mock('overload:Icinga\Authentication\User\DbUserBackend') Mockery::mock('overload:Icinga\Authentication\User\DbUserBackend')
->shouldReceive('select->where->count') ->shouldReceive('inspect')
->andReturn(2); ->andReturn(self::createInspector(false));
// Passing array(null) is required to make Mockery call the constructor... // Passing array(null) is required to make Mockery call the constructor...
$form = Mockery::mock('Icinga\Forms\Config\UserBackend\DbBackendForm[getView]', array(null)); $form = Mockery::mock('Icinga\Forms\Config\UserBackend\DbBackendForm[getView]', array(null));
$form->shouldReceive('getView->escape') $form->shouldReceive('getView->escape')
->with(Mockery::type('string')) ->with(Mockery::type('string'))
->andReturnUsing(function ($s) { return $s; }); ->andReturnUsing(function ($s) {
return $s;
});
$form->setTokenDisabled(); $form->setTokenDisabled();
$form->setResources(array('test_db_backend')); $form->setResources(array('test_db_backend'));
$form->populate(array('resource' => 'test_db_backend')); $form->populate(array('resource' => 'test_db_backend'));
@ -54,14 +56,16 @@ class DbBackendFormTest extends BaseTestCase
{ {
$this->setUpResourceFactoryMock(); $this->setUpResourceFactoryMock();
Mockery::mock('overload:Icinga\Authentication\User\DbUserBackend') Mockery::mock('overload:Icinga\Authentication\User\DbUserBackend')
->shouldReceive('count') ->shouldReceive('inspect')
->andReturn(0); ->andReturn(self::createInspector(true));
// Passing array(null) is required to make Mockery call the constructor... // Passing array(null) is required to make Mockery call the constructor...
$form = Mockery::mock('Icinga\Forms\Config\UserBackend\DbBackendForm[getView]', array(null)); $form = Mockery::mock('Icinga\Forms\Config\UserBackend\DbBackendForm[getView]', array(null));
$form->shouldReceive('getView->escape') $form->shouldReceive('getView->escape')
->with(Mockery::type('string')) ->with(Mockery::type('string'))
->andReturnUsing(function ($s) { return $s; }); ->andReturnUsing(function ($s) {
return $s;
});
$form->setTokenDisabled(); $form->setTokenDisabled();
$form->setResources(array('test_db_backend')); $form->setResources(array('test_db_backend'));
$form->populate(array('resource' => 'test_db_backend')); $form->populate(array('resource' => 'test_db_backend'));
@ -80,4 +84,21 @@ class DbBackendFormTest extends BaseTestCase
->shouldReceive('getResourceConfig') ->shouldReceive('getResourceConfig')
->andReturn(new ConfigObject()); ->andReturn(new ConfigObject());
} }
public static function createInspector($error = false, $log = array('log'))
{
if (! $error) {
$calls = array(
'hasError' => false,
'toArray' => $log
);
} else {
$calls = array(
'hasError' => true,
'getError' => 'Error',
'toArray' => $log
);
}
return Mockery::mock('Icinga\Data\Inspection', $calls);
}
} }

View File

@ -12,6 +12,7 @@ use Icinga\Data\ConfigObject;
use Icinga\Test\BaseTestCase; use Icinga\Test\BaseTestCase;
use Icinga\Forms\Config\UserBackend\LdapBackendForm; use Icinga\Forms\Config\UserBackend\LdapBackendForm;
use Icinga\Exception\AuthenticationException; use Icinga\Exception\AuthenticationException;
use Tests\Icinga\Forms\Config\Resource\LdapResourceFormTest;
class LdapBackendFormTest extends BaseTestCase class LdapBackendFormTest extends BaseTestCase
{ {
@ -27,15 +28,18 @@ class LdapBackendFormTest extends BaseTestCase
*/ */
public function testValidBackendIsValid() public function testValidBackendIsValid()
{ {
$ldapUserBackendMock = Mockery::mock('overload:Icinga\Authentication\User\LdapUserBackend'); $ldapUserBackendMock = Mockery::mock('overload:Icinga\Authentication\User\LdapUserBackend')
$ldapUserBackendMock->shouldReceive('assertAuthenticationPossible')->andReturnNull(); ->shouldReceive('inspect')
->andReturn(self::createInspector(false))->getMock();
$this->setUpUserBackendMock($ldapUserBackendMock); $this->setUpUserBackendMock($ldapUserBackendMock);
// Passing array(null) is required to make Mockery call the constructor... // Passing array(null) is required to make Mockery call the constructor...
$form = Mockery::mock('Icinga\Forms\Config\UserBackend\LdapBackendForm[getView]', array(null)); $form = Mockery::mock('Icinga\Forms\Config\UserBackend\LdapBackendForm[getView]', array(null));
$form->shouldReceive('getView->escape') $form->shouldReceive('getView->escape')
->with(Mockery::type('string')) ->with(Mockery::type('string'))
->andReturnUsing(function ($s) { return $s; }); ->andReturnUsing(function ($s) {
return $s;
});
$form->setTokenDisabled(); $form->setTokenDisabled();
$form->setResources(array('test_ldap_backend')); $form->setResources(array('test_ldap_backend'));
$form->populate(array('resource' => 'test_ldap_backend')); $form->populate(array('resource' => 'test_ldap_backend'));
@ -52,7 +56,9 @@ class LdapBackendFormTest extends BaseTestCase
*/ */
public function testInvalidBackendIsNotValid() public function testInvalidBackendIsNotValid()
{ {
$ldapUserBackendMock = Mockery::mock('overload:Icinga\Authentication\User\LdapUserBackend'); $ldapUserBackendMock = Mockery::mock('overload:Icinga\Authentication\User\LdapUserBackend')
->shouldReceive('inspect')
->andReturn(self::createInspector(true))->getMock();
$ldapUserBackendMock->shouldReceive('assertAuthenticationPossible')->andThrow(new AuthenticationException); $ldapUserBackendMock->shouldReceive('assertAuthenticationPossible')->andThrow(new AuthenticationException);
$this->setUpUserBackendMock($ldapUserBackendMock); $this->setUpUserBackendMock($ldapUserBackendMock);
@ -60,7 +66,9 @@ class LdapBackendFormTest extends BaseTestCase
$form = Mockery::mock('Icinga\Forms\Config\UserBackend\LdapBackendForm[getView]', array(null)); $form = Mockery::mock('Icinga\Forms\Config\UserBackend\LdapBackendForm[getView]', array(null));
$form->shouldReceive('getView->escape') $form->shouldReceive('getView->escape')
->with(Mockery::type('string')) ->with(Mockery::type('string'))
->andReturnUsing(function ($s) { return $s; }); ->andReturnUsing(function ($s) {
return $s;
});
$form->setTokenDisabled(); $form->setTokenDisabled();
$form->setResources(array('test_ldap_backend')); $form->setResources(array('test_ldap_backend'));
$form->populate(array('resource' => 'test_ldap_backend')); $form->populate(array('resource' => 'test_ldap_backend'));
@ -77,4 +85,21 @@ class LdapBackendFormTest extends BaseTestCase
->shouldReceive('create') ->shouldReceive('create')
->andReturn($ldapUserBackendMock); ->andReturn($ldapUserBackendMock);
} }
public static function createInspector($error = false, $log = array('log'))
{
if (! $error) {
$calls = array(
'hasError' => false,
'toArray' => $log
);
} else {
$calls = array(
'hasError' => true,
'getError' => 'Error',
'toArray' => $log
);
}
return Mockery::mock('Icinga\Data\Inspection', $calls);
}
} }