BaseTest: Create class and tests

refs #4608

library/Icinga/Application/DbAdapterFactory.php

@@ -196,14 +196,12 @@ class DbAdapterFactory implements ConfigAwareFactory
     /**
      * Create the Db_Adapter for the given configuration section
      *
-     * @param   mixed       $config         The configuration section containing the
-     *                                        db information
+     * @param   Zend_Config $config         The configuration section containing the db information
      *
-     * @return Zend_Db_Adapter_Abstract    The created Zend_Db_Adapter
-     *
-     * @throws ConfigurationError          When the specified db type is invalid
+     * @return  Zend_Db_Adapter_Abstract    The created Zend_Db_Adapter
+     * @throws  ConfigurationError          When the specified db type is invalid
      */
-    private static function createDbAdapter($config)
+    public static function createDbAdapter(Zend_Config $config)
     {
         if ($config->type !== 'db') {
             $msg = 'Resource type must be "db" but is "' . $config->type . '"';

library/Icinga/Test/BaseTestCase.php

@@ -0,0 +1,367 @@
+<?php
+// {{{ICINGA_LICENSE_HEADER}}}
+/**
+ * This file is part of Icinga 2 Web.
+ *
+ * Icinga 2 Web - Head for multiple monitoring backends.
+ * Copyright (C) 2013 Icinga Development Team
+ *
+ * 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., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+ *
+ * @copyright 2013 Icinga Development Team <info@icinga.org>
+ * @license   http://www.gnu.org/licenses/gpl-2.0.txt GPL, version 2
+ * @author    Icinga Development Team <info@icinga.org>
+ */
+// {{{ICINGA_LICENSE_HEADER}}}
+
+namespace Icinga\Test;
+
+// @codingStandardsIgnoreStart
+require_once 'Zend/Test/PHPUnit/ControllerTestCase.php';
+require_once 'Zend/Db/Adapter/Pdo/Abstract.php';
+require_once 'DbTest.php';
+require_once 'FormTest.php';
+// @codingStandardsIgnoreEnd
+
+use \Exception;
+use \RuntimeException;
+use \Zend_Test_PHPUnit_ControllerTestCase;
+use \Zend_Config;
+use \Zend_Db_Adapter_Pdo_Abstract;
+use \Zend_Db_Adapter_Pdo_Mysql;
+use \Zend_Db_Adapter_Pdo_Pgsql;
+use \Zend_Db_Adapter_Pdo_Oci;
+use \Icinga\Application\DbAdapterFactory;
+use \Icinga\Web\Form;
+
+/**
+ * Class BaseTestCase
+ */
+class BaseTestCase extends Zend_Test_PHPUnit_ControllerTestCase implements DbTest, FormTest
+{
+    /**
+     * Path to application/
+     *
+     * @var string
+     */
+    public static $appDir;
+
+    /**
+     * Path to library/Icinga
+     *
+     * @var string
+     */
+    public static $libDir;
+
+    /**
+     * Path to etc/
+     *
+     * @var
+     */
+    public static $etcDir;
+
+    /**
+     * Path to test/php/
+     *
+     * @var string
+     */
+    public static $testDir;
+
+    /**
+     * Path to share/icinga2-web
+     *
+     * @var string
+     */
+    public static $shareDir;
+
+    /**
+     * Path to modules/
+     *
+     * @var string
+     */
+    public static $moduleDir;
+
+    /**
+     * DbAdapterFactory configuration for different database types
+     *
+     * @var array
+     */
+    private static $dbConfiguration = array(
+        'mysql' => array(
+            'type'      => 'db',
+            'db'        => 'mysql',
+            'host'      => '127.0.0.1',
+            'port'      => 3306,
+            'dbname'    => 'icinga_unittest',
+            'username'  => 'icinga_unittest',
+            'password'  => 'icinga_unittest'
+        ),
+        'pgsql' => array(
+            'type'      => 'db',
+            'db'        => 'pgsql',
+            'host'      => '127.0.0.1',
+            'port'      => 5432,
+            'dbname'    => 'icinga_unittest',
+            'username'  => 'icinga_unittest',
+            'password'  => 'icinga_unittest'
+        ),
+    );
+
+    /**
+     * Setup test path environment
+     *
+     * @throws RuntimeException
+     */
+    public static function setupDirectories()
+    {
+        static $initialized = false;
+
+        if ($initialized === true) {
+            return;
+        }
+
+        $baseDir = realpath(__DIR__. '/../../../');
+
+        if ($baseDir === false) {
+            throw new RuntimeException('Application base dir not found');
+        }
+
+        self::$appDir = $baseDir . '/application';
+        self::$libDir = $baseDir . '/library/Icinga';
+        self::$etcDir = $baseDir . '/etc';
+        self::$testDir = $baseDir . '/test/php';
+        self::$shareDir = $baseDir . '/share/icinga2-web';
+        self::$moduleDir = $baseDir. '/modules';
+
+        $initialized = true;
+    }
+
+
+    /**
+     * Create Zend_Config for database configuration
+     *
+     * @param   string $name
+     *
+     * @return  Zend_Config
+     * @throws  RuntimeException
+     */
+    private function createDbConfigFor($name)
+    {
+        if (array_key_exists($name, self::$dbConfiguration)) {
+            return new Zend_Config(self::$dbConfiguration[$name]);
+        }
+
+        throw new RuntimeException('Configuration for database type not available: ' . $name);
+    }
+
+    /**
+     * Creates an array of Zend Database Adapter
+     *
+     * @param   string $name
+     *
+     * @return  array
+     */
+    private function createDbAdapterFor($name)
+    {
+        $this->requireDbLibraries();
+
+        try {
+            $adapter = DbAdapterFactory::createDbAdapter($this->createDbConfigFor($name));
+        } catch (Exception $e) {
+            $adapter = $e->getMessage();
+        }
+
+        return array(
+            array($adapter)
+        );
+    }
+
+    /**
+     * PHPUnit provider for mysql
+     *
+     * @return Zend_Db_Adapter_Pdo_Mysql
+     */
+    public function mysqlDb()
+    {
+        return $this->createDbAdapterFor('mysql');
+    }
+
+    /**
+     * PHPUnit provider for pgsql
+     *
+     * @return Zend_Db_Adapter_Pdo_Pgsql
+     */
+    public function pgsqlDb()
+    {
+        return $this->createDbAdapterFor('pgsql');
+    }
+
+    /**
+     * PHPUnit provider for oracle
+     *
+     * @return Zend_Db_Adapter_Pdo_Oci
+     */
+    public function oracleDb()
+    {
+        return $this->createDbAdapterFor('oracle');
+    }
+
+    /**
+     * Executes sql file on PDO object
+     *
+     * @param   Zend_Db_Adapter_Pdo_Abstract $resource
+     * @param   string                       $filename
+     *
+     * @return  boolean Operational success flag
+     * @throws RuntimeException
+     */
+    public function loadSql(Zend_Db_Adapter_Pdo_Abstract $resource, $filename)
+    {
+        if (!is_file($filename)) {
+            throw new RuntimeException('Sql file not found: ' . $filename);
+        }
+
+        $sqlData = file_get_contents($filename);
+
+        $resource->exec($sqlData);
+    }
+
+    /**
+     * Setup provider for testcase
+     *
+     * @param   string|Zend_Db_Adapter_PDO_Abstract|null $resource
+     */
+    public function setupDbProvider($resource)
+    {
+        if (!$resource instanceof Zend_Db_Adapter_Pdo_Abstract) {
+            if (is_string($resource)) {
+                $this->markTestSkipped('Could not initialize provider: ' . $resource);
+            } else {
+                $this->markTestSkipped('Could not initialize provider');
+            }
+            return;
+        }
+
+        try {
+            $resource->getConnection();
+        } catch (Exception $e) {
+            $this->markTestSkipped('Could not connect to provider: '. $e->getMessage());
+        }
+
+        $tables = $resource->listTables();
+        foreach ($tables as $table) {
+            $resource->exec('DROP TABLE ' . $table. ';');
+        }
+    }
+
+    /**
+     * Instantiate a new form object
+     *
+     * @param   string $formClass      Form class to instantiate
+     * @param   array  $requestData    Request data for the form
+     *
+     * @return  Form
+     * @throws RuntimeException
+     */
+    public function createForm($formClass, array $requestData = array())
+    {
+        $this->requireFormLibraries();
+
+        $classParts = explode('\\', $formClass);
+        $identifier = array_shift($classParts);
+        array_shift($classParts); // Throw away
+        $fixedPathComponent = '/forms';
+
+        if (strtolower($identifier) == 'icinga') {
+            $startPathComponent = self::$appDir. $fixedPathComponent;
+        } else {
+            $startPathComponent = self::$moduleDir
+                . '/'
+                . strtolower($identifier)
+                . '/application'
+                .$fixedPathComponent;
+        }
+
+        $classFile = $startPathComponent . '/' . implode('/', $classParts) . '.php';
+
+        if (!file_exists($classFile)) {
+            throw new RuntimeException('Class file for form "' . $formClass . '" not found');
+        }
+
+        require_once $classFile;
+        $form = new $formClass();
+
+        $request = $this->getRequest();
+        $request->setMethod('POST');
+        $request->setPost($requestData);
+
+        $form->setRequest($request);
+
+        return $form;
+    }
+
+    /**
+     * Require all libraries to instantiate forms
+     */
+    public function requireFormLibraries()
+    {
+        // @codingStandardsIgnoreStart
+
+        require_once 'Zend/Form/Decorator/Abstract.php';
+        require_once 'Zend/Validate/Abstract.php';
+        require_once 'Zend/Form/Element/Xhtml.php';
+        require_once 'Zend/Form.php';
+
+        require_once self::$libDir . '/Web/Form/InvalidCSRFTokenException.php';
+
+        require_once self::$libDir . '/Web/Form/Element/DateTimePicker.php';
+        require_once self::$libDir . '/Web/Form/Element/Note.php';
+        require_once self::$libDir . '/Web/Form/Element/Number.php';
+
+        require_once self::$libDir . '/Web/Form/Decorator/ConditionalHidden.php';
+        require_once self::$libDir . '/Web/Form/Decorator/HelpText.php';
+
+        require_once self::$libDir . '/Web/Form/Validator/DateFormatValidator.php';
+        require_once self::$libDir . '/Web/Form/Validator/TimeFormatValidator.php';
+        require_once self::$libDir . '/Web/Form/Validator/WritablePathValidator.php';
+
+        require_once self::$libDir . '/Web/Form.php';
+
+        // @codingStandardsIgnoreEnd
+    }
+
+    /**
+     * Require all classes for database adapter creation
+     */
+    public function requireDbLibraries()
+    {
+        // @codingStandardsIgnoreStart
+
+        require_once 'Zend/Config.php';
+        require_once 'Zend/Db.php';
+        require_once 'Zend/Log.php';
+
+        require_once realpath(self::$libDir . '/Exception/ConfigurationError.php');
+        require_once realpath(self::$libDir . '/Util/ConfigAwareFactory.php');
+        require_once realpath(self::$libDir . '/Application/DbAdapterFactory.php');
+        require_once realpath(self::$libDir . '/Application/Logger.php');
+
+        // @codingStandardsIgnoreEnd
+    }
+}
+
+// @codingStandardsIgnoreStart
+BaseTestCase::setupDirectories();
+// @codingStandardsIgnoreEnd

library/Icinga/Test/DbTest.php

@@ -0,0 +1,75 @@
+<?php
+// {{{ICINGA_LICENSE_HEADER}}}
+/**
+ * This file is part of Icinga 2 Web.
+ *
+ * Icinga 2 Web - Head for multiple monitoring backends.
+ * Copyright (C) 2013 Icinga Development Team
+ *
+ * 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., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+ *
+ * @copyright 2013 Icinga Development Team <info@icinga.org>
+ * @license   http://www.gnu.org/licenses/gpl-2.0.txt GPL, version 2
+ * @author    Icinga Development Team <info@icinga.org>
+ */
+// {{{ICINGA_LICENSE_HEADER}}}
+
+namespace Icinga\Test;
+
+use \Zend_Db_Adapter_Pdo_Abstract;
+use \Zend_Db_Adapter_Pdo_Mysql;
+use \Zend_Db_Adapter_Pdo_Pgsql;
+use \Zend_Db_Adapter_Pdo_Oci;
+
+interface DbTest
+{
+    /**
+     * PHPUnit provider for mysql
+     *
+     * @return Zend_Db_Adapter_Pdo_Mysql
+     */
+    public function mysqlDb();
+
+    /**
+     * PHPUnit provider for pgsql
+     *
+     * @return Zend_Db_Adapter_Pdo_Pgsql
+     */
+    public function pgsqlDb();
+
+    /**
+     * PHPUnit provider for oracle
+     *
+     * @return Zend_Db_Adapter_Pdo_Oci
+     */
+    public function oracleDb();
+
+    /**
+     * Executes sql file on PDO object
+     *
+     * @param   Zend_Db_Adapter_PDO_Abstract    $resource
+     * @param   string                          $filename
+     *
+     * @return  boolean Operational success flag
+     */
+    public function loadSql(Zend_Db_Adapter_PDO_Abstract $resource, $filename);
+
+    /**
+     * Setup provider for testcase
+     *
+     * @param   string|Zend_Db_Adapter_PDO_Abstract|null $resource
+     */
+    public function setupDbProvider($resource);
+}

library/Icinga/Test/FormTest.php

@@ -0,0 +1,52 @@
+<?php
+// {{{ICINGA_LICENSE_HEADER}}}
+/**
+ * This file is part of Icinga 2 Web.
+ *
+ * Icinga 2 Web - Head for multiple monitoring backends.
+ * Copyright (C) 2013 Icinga Development Team
+ *
+ * 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., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+ *
+ * @copyright 2013 Icinga Development Team <info@icinga.org>
+ * @license   http://www.gnu.org/licenses/gpl-2.0.txt GPL, version 2
+ * @author    Icinga Development Team <info@icinga.org>
+ */
+// {{{ICINGA_LICENSE_HEADER}}}
+
+namespace Icinga\Test;
+
+use Icinga\Web\Form;
+
+/**
+ * Interface to test form objects
+ */
+interface FormTest
+{
+    /**
+     * Instantiate a new form object
+     *
+     * @param   string    $formClass      Form class to instantiate
+     * @param   array     $requestData    Request data for the form
+     *
+     * @return Form
+     */
+    public function createForm($formClass, array $requestData = array());
+
+    /**
+     * Require all libraries to instantiate forms
+     */
+    public function requireFormLibraries();
+}

test/php/library/Icinga/Test/BaseTestCaseDbTest.php

@@ -0,0 +1,151 @@
+<?php
+// {{{ICINGA_LICENSE_HEADER}}}
+/**
+ * This file is part of Icinga 2 Web.
+ *
+ * Icinga 2 Web - Head for multiple monitoring backends.
+ * Copyright (C) 2013 Icinga Development Team
+ *
+ * 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., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+ *
+ * @copyright 2013 Icinga Development Team <info@icinga.org>
+ * @license   http://www.gnu.org/licenses/gpl-2.0.txt GPL, version 2
+ * @author    Icinga Development Team <info@icinga.org>
+ */
+// {{{ICINGA_LICENSE_HEADER}}}
+
+namespace Tests\Icinga\Test;
+
+require_once 'Zend/Db/Adapter/Pdo/Mysql.php';
+require_once 'Zend/Db/Adapter/Pdo/Pgsql.php';
+require_once realpath(__DIR__ . '/../../../../../library/Icinga/Test/BaseTestCase.php');
+
+use \PDO;
+use Icinga\Test\BaseTestCase;
+
+class BaseTestCaseDbTest extends BaseTestCase
+{
+    public function testExistingTestDirectories()
+    {
+        $this->assertFileExists(self::$appDir);
+        $this->assertFileExists(self::$libDir);
+        $this->assertFileExists(self::$etcDir);
+        $this->assertFileExists(self::$testDir);
+        $this->assertFileExists(self::$moduleDir);
+        // $this->assertFileExists(self::$shareDir);
+    }
+
+    /**
+     * @dataProvider mysqlDb
+     */
+    public function testMySqlProviderAnnotation($resource)
+    {
+        $this->setupDbProvider($resource);
+        $this->assertInstanceOf('Zend_Db_Adapter_Pdo_Mysql', $resource);
+    }
+
+    /**
+     * @dataProvider mysqlDb
+     */
+    public function testMySqlCreateTablePart1($resource)
+    {
+        $this->setupDbProvider($resource);
+        /** @var \Zend_Db_Adapter_Pdo_Abstract $resource **/
+        $resource->exec('CREATE TABLE test(uid INT NOT NULL PRIMARY KEY);');
+
+        $tables = $resource->listTables();
+        $this->assertCount(1, $tables);
+    }
+
+    /**
+     * @dataProvider mysqlDb
+     */
+    public function testMySqlCreateTablePart2($resource)
+    {
+        $this->setupDbProvider($resource);
+        $tables = $resource->listTables();
+        $this->assertCount(0, $tables);
+    }
+
+    private function dbAdapterSqlLoadTable($resource)
+    {
+        /** @var $resource \Zend_Db_Adapter_Pdo_Abstract **/
+        $this->setupDbProvider($resource);
+
+        $sqlContent = array();
+        $sqlContent[] = 'CREATE TABLE dummyData(value VARCHAR(50) NOT NULL PRIMARY KEY);';
+        for ($i=0; $i<20; $i++) {
+            $sqlContent[] = 'INSERT INTO dummyData VALUES(\'' . uniqid(). '\');';
+        }
+
+        $tempFile = tempnam(sys_get_temp_dir(), 'icinga2-web-test-load-sql');
+        file_put_contents($tempFile, implode(chr(10), $sqlContent));
+
+        $this->loadSql($resource, $tempFile);
+
+        $count = (int)$resource->fetchOne('SELECT COUNT(*) as cntX from dummyData;');
+        $this->assertSame(20, $count);
+
+        $this->assertTrue(unlink($tempFile));
+    }
+
+    /**
+     * @dataProvider mysqlDb
+     */
+    public function testMySqlLoadTable($resource)
+    {
+        $this->dbAdapterSqlLoadTable($resource);
+    }
+
+    /**
+     * @dataProvider pgsqlDb
+     */
+    public function testPgSqlProviderAnnotation($resource)
+    {
+        $this->setupDbProvider($resource);
+        $this->assertInstanceOf('Zend_Db_Adapter_Pdo_Pgsql', $resource);
+    }
+
+    /**
+     * @dataProvider pgsqlDb
+     */
+    public function testPgSqlCreateTablePart1($resource)
+    {
+        $this->setupDbProvider($resource);
+        /** @var \Zend_Db_Adapter_Pdo_Abstract $resource **/
+        $resource->exec('CREATE TABLE test(uid INT NOT NULL PRIMARY KEY);');
+
+        $tables = $resource->listTables();
+        $this->assertCount(1, $tables);
+    }
+
+    /**
+     * @dataProvider pgsqlDb
+     */
+    public function testPgSqlCreateTablePart2($resource)
+    {
+        $this->setupDbProvider($resource);
+        $tables = $resource->listTables();
+        $this->assertCount(0, $tables);
+    }
+
+    /**
+     * @dataProvider pgsqlDb
+     */
+    public function testPgSqlLoadTable($resource)
+    {
+        $this->dbAdapterSqlLoadTable($resource);
+    }
+}

test/php/library/Icinga/Test/BaseTestCaseFormTest.php

@@ -0,0 +1,44 @@
+<?php
+// {{{ICINGA_LICENSE_HEADER}}}
+/**
+ * This file is part of Icinga 2 Web.
+ *
+ * Icinga 2 Web - Head for multiple monitoring backends.
+ * Copyright (C) 2013 Icinga Development Team
+ *
+ * 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., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+ *
+ * @copyright 2013 Icinga Development Team <info@icinga.org>
+ * @license   http://www.gnu.org/licenses/gpl-2.0.txt GPL, version 2
+ * @author    Icinga Development Team <info@icinga.org>
+ */
+// {{{ICINGA_LICENSE_HEADER}}}
+
+namespace Tests\Icinga\Test;
+
+require_once realpath(__DIR__ . '/../../../../../library/Icinga/Test/BaseTestCase.php');
+
+use Icinga\Test\BaseTestCase;
+
+class BaseTestCaseFormTest extends BaseTestCase
+{
+    public function testFormCreation()
+    {
+        $form1 = $this->createForm('Icinga\Form\Authentication\LoginForm');
+        $this->assertInstanceOf('Icinga\Web\Form', $form1);
+        $form2 = $this->createForm('Monitoring\Form\Config\ConfirmRemovalForm');
+        $this->assertInstanceOf('Icinga\Web\Form', $form2);
+    }
+}