/test/integration/InstallerTest.php

<?php



namespace install;



use common\libraries\Filesystem;

use common\libraries\Path;

use common\libraries\Application;

use common\libraries\CoreApplication;

use common\libraries\WebApplication;

use common\libraries\Connection;



class InstallerTest extends \PHPUnit_Framework_TestCase

{

    /** @var install\Installer */

    private $installer;

    /** @var install\InstallerConfig */

    private $installer_config;

    

    /** @var string the config file containing all installation options */

    private $install_configuration_file;

    

    public $EXTRA_DIRECTORIES = array('archive', 'garbage', 'repository', 'temp', 'userpictures', 'scorm', 'logs', 

            'hotpotatoes');

    

    public $CORE_APPS = array('webservice', 'admin', 'help', 'reporting', 'tracking', 'repository', 'user', 'group', 

            'rights', 'home', 'menu', 'migration');



    function __construct()

    {

        parent :: __construct();

        $this->backupGlobals = false; // MDB needs this        
        $this->install_configuration_file = __DIR__ . '/__files/install_config.php';

    }



    public function setUp()

    {

        $this->tune_error_reporting_for_mdb2();

        $this->installer_config = new InstallerConfig();

        $this->installer = new Installer($this->installer_config);

        

        $this->installer_config->load_config_file($this->install_configuration_file);

    

    }



    public function tearDown()

    {

        Filesystem :: remove(Path :: get_common_path() . 'configuration/configuration.php');

        foreach ($this->EXTRA_DIRECTORIES as $directory)

        {

            Filesystem :: remove(Path :: get(SYS_FILE_PATH) . $directory);

        }

        $this->reset_db();

    

    }



    private function reset_db()

    {

        $cx = $this->installer->get_db_connection();

        if (! is_null($cx))

        {

            $db_name = $cx->getDatabase();

            if ($cx->databaseExists($db_name))

            {

                $cx->loadModule('Manager');

                $tables = $cx->manager->listTables();

                foreach ($tables as $table)

                    $cx->manager->dropTable($table);

            }

        }

    }



    private function tune_error_reporting_for_mdb2()

    {

        ini_set('error_reporting', E_ALL);

    }



    public function test_installation_should_create_config_file()

    {

        $this->installer_config->set_db_overwrite(false); // faster
        $this->assertFileNotExists(Path :: get_common_path() . 'configuration/configuration.php');

        $this->installer->perform_install();

        $this->assertFileExists(Path :: get_common_path() . 'configuration/configuration.php');

    }



    public function test_installation_should_create_extra_directories()

    {

        $this->installer_config->set_db_overwrite(false); // faster
        foreach ($this->EXTRA_DIRECTORIES as $directory)

        {

            $this->assertFileNotExists(Path :: get(SYS_FILE_PATH) . $directory);

        }

        $this->installer->perform_install();

        foreach ($this->EXTRA_DIRECTORIES as $directory)

        {

            $this->assertFileExists(Path :: get(SYS_FILE_PATH) . $directory);

        }

    }



    public function test_installation_should_register_all_content_objects()

    {

        //TODO : don't know how to automatic test without creating dependencies
    }



    public function test_installation_should_install_specified_extra_application()

    {

        //TODO : don't know how to automatic test without creating dependencies
    }



    public function test_installation_should_install_all_core_applications()

    {

        $this->installer->perform_install();

        foreach ($this->CORE_APPS as $application_name)

        {

            $this->assertTrue(CoreApplication :: exists($application_name));

            $application = CoreApplication :: factory($application_name);

            $this->assertTrue($application->is_active());

        }

    }



    public function test_installation_should_be_observable()

    {

        $observer1 = new test\DumbObserver();

        $observer2 = new test\DumbObserver();

        $this->installer->add_observer($observer1);

        $this->installer->add_observer($observer2);

        $this->installer->perform_install();

        $this->assertSame($observer1->getEvents(), $observer2->getEvents());

        $expected_array = array('before_install()', 'before_preprod()', 

                'preprod_config_file_written(InstallerTestResult : Success? : 1)', 

                'preprod_db_created(InstallerTestResult : Success? : 1)', 'after_preprod()', 

                'before_content_objects_install()', 'after_content_objects_install()', 

                'before_core_applications_install()', 'before_application_install(admin)', 

                'after_application_install(InstallerTestResult : Success? : 1)', 'before_application_install(tracking)', 

                'after_application_install(InstallerTestResult : Success? : 1)', 

                'before_application_install(repository)', 

                'after_application_install(InstallerTestResult : Success? : 1)', 'before_application_install(user)', 

                'after_application_install(InstallerTestResult : Success? : 1)', 'before_application_install(group)', 

                'after_application_install(InstallerTestResult : Success? : 1)', 'before_application_install(rights)', 

                'after_application_install(InstallerTestResult : Success? : 1)', 'before_application_install(home)', 

                'after_application_install(InstallerTestResult : Success? : 1)', 'before_application_install(menu)', 

                'after_application_install(InstallerTestResult : Success? : 1)', 

                'before_application_install(webservice)', 

                'after_application_install(InstallerTestResult : Success? : 1)', 'before_application_install(reporting)', 

                'after_application_install(InstallerTestResult : Success? : 1)', 

                'before_post_process_for_application(admin)', 

                'after_post_process_for_application(InstallerTestResult : Success? : 1)', 

                'before_post_process_for_application(tracking)', 

                'after_post_process_for_application(InstallerTestResult : Success? : 1)', 

                'before_post_process_for_application(repository)', 

                'after_post_process_for_application(InstallerTestResult : Success? : 1)', 

                'before_post_process_for_application(user)', 

                'after_post_process_for_application(InstallerTestResult : Success? : 1)', 

                'before_post_process_for_application(group)', 

                'after_post_process_for_application(InstallerTestResult : Success? : 1)', 

                'before_post_process_for_application(rights)', 

                'after_post_process_for_application(InstallerTestResult : Success? : 1)', 

                'before_post_process_for_application(home)', 

                'after_post_process_for_application(InstallerTestResult : Success? : 1)', 

                'before_post_process_for_application(menu)', 

                'after_post_process_for_application(InstallerTestResult : Success? : 1)', 

                'before_post_process_for_application(webservice)', 

                'after_post_process_for_application(InstallerTestResult : Success? : 1)', 

                'before_post_process_for_application(reporting)', 

                'after_post_process_for_application(InstallerTestResult : Success? : 1)', 

                'after_core_applications_install()', 'before_optional_applications_install()', 

                'after_optional_applications_install()', 'before_filesystem_prepared()', 

                'after_filesystem_prepared(InstallerTestResult : Success? : 1)', 'after_install()');

        

        $this->assertSame($expected_array, $observer1->getEvents());

    }



    public function test_installation_should_fail_when_cannot_connect_the_db()

    {

        $this->installer_config->set_db_host('nonexistinghost');

        $this->installer_config->set_db_username('nobody');

        $this->installer_config->set_db_password('nothing');

        $this->setExpectedException('Exception');

        $this->installer->perform_install();

    }



    public function test_installation_should_create_db_if_nonexistent()

    {

        $cx = $this->installer->get_or_create_db_connection();

        $db_name = $this->installer_config->get_db_name();

        $dropResult = $cx->dropDatabase($db_name);

        $this->assertIsNotMDB2Error($dropResult);

        $this->installer->perform_install();

        $this->assertTrue($cx->databaseExists($db_name));

    }



    private function assertIsNotMDB2Error($mdb2Result)

    {

        if (\MDB2 :: isError($mdb2Result))

        {

            $this->fail("MDB2 shouldn't have returned an error : {$mdb2Result->getMessage()}");

        }

    }



    public function test_installation_should_overwrite_db_when_specified()

    {

        $this->add_dumb_table_in_db();

        $this->installer_config->set_db_overwrite(true);

        $this->installer->perform_install();

        $table_list = Connection :: get_instance()->get_connection()->listTables();

        $this->assertNotContains("dumb", $table_list);

    }



    private function add_dumb_table_in_db()

    {

        $definition = array('id' => array('type' => 'integer', 'unsigned' => 1, 'notnull' => 1, 'default' => 0), 

                'name' => array('type' => 'text', 'length' => 255), 'datetime' => array('type' => 'timestamp'));

        

        $mdb2->createTable('dumb', $definition);

    }



    public function test_installation_should_keep_db_when_specified()

    {

        $this->add_dumb_table_in_db();

        $this->installer_config->set_db_overwrite(false);

        $this->installer->perform_install();

        $table_list = Connection :: get_instance()->get_connection()->listTables();

        $this->assertContains("dumb", $table_list);

    }



}



namespace install\test;



use install\InstallerObserver;

use install\InstallerStepResult;



class DumbObserver implements InstallerObserver

{

    

    private $events = array();



    public function getEvents()

    {

        return $this->events;

    }



    public function after_application_install(InstallerStepResult $result)

    {

        $this->events[] = __FUNCTION__ . "({$result})";

    }



    public function after_filesystem_prepared(InstallerStepResult $result)

    {

        $this->events[] = __FUNCTION__ . "({$result})";

    }



    public function after_install()

    {

        $this->events[] = __FUNCTION__ . "()";

    }



    public function after_post_process()

    {

        $this->events[] = __FUNCTION__ . "()";

    }



    public function after_post_process_for_application(InstallerStepResult $result)

    {

        $this->events[] = __FUNCTION__ . "({$result})";

    }



    public function after_preprod()

    {

        $this->events[] = __FUNCTION__ . "()";

    }



    public function before_application_install($application)

    {

        $this->events[] = __FUNCTION__ . "({$application})";

    }



    public function before_filesystem_prepared()

    {

        $this->events[] = __FUNCTION__ . "()";

    }



    public function before_install()

    {

        $this->events[] = __FUNCTION__ . "()";

    }



    public function before_post_process()

    {

        $this->events[] = __FUNCTION__ . "()";

    }



    public function before_post_process_for_application($application)

    {

        $this->events[] = __FUNCTION__ . "({$application})";

    }



    public function before_preprod()

    {

        $this->events[] = __FUNCTION__ . "()";

    }



    public function preprod_config_file_written(InstallerStepResult $result)

    {

        $this->events[] = __FUNCTION__ . "({$result})";

    }



    public function preprod_db_created(InstallerStepResult $result)

    {

        $this->events[] = __FUNCTION__ . "({$result})";

    }



    public function after_content_object_install(InstallerStepResult $result)

    {

        $this->events[] = __FUNCTION__ . "({$result})";

    }



    public function after_content_objects_install()

    {

        $this->events[] = __FUNCTION__ . "()";

    }



    public function after_core_applications_install()

    {

        $this->events[] = __FUNCTION__ . "()";

    }



    public function after_optional_applications_install()

    {

        $this->events[] = __FUNCTION__ . "()";

    }



    public function before_content_object_install($content_object)

    {

        $this->events[] = __FUNCTION__ . "({$content_object})";

    }



    public function before_content_objects_install()

    {

        $this->events[] = __FUNCTION__ . "()";

    }



    public function before_core_applications_install()

    {

        $this->events[] = __FUNCTION__ . "()";

    }



    public function before_optional_applications_install()

    {

        $this->events[] = __FUNCTION__ . "()";

    }



}