ilDatabaseAtomRunTest.php

Go to the documentation of this file.

<?php
/*
    +-----------------------------------------------------------------------------+
    | ILIAS open source                                                           |
    +-----------------------------------------------------------------------------+
    | Copyright (c) 1998-2009 ILIAS open source, University of Cologne            |
    |                                                                             |
    | 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. |
    +-----------------------------------------------------------------------------+
*/

use PHPUnit\Framework\TestCase;

class ilDatabaseAtomRunTest extends TestCase
{

    protected $backupGlobals = false;
    protected $ilDBInterfaceGalera;
    protected $ilDBInterfaceGaleraSecond;
    protected $ilDBInterfaceInnoDB;
    protected $ilDBInterfaceInnoDBSecond;


    protected function setUp() : void
    {
        ilUnitUtil::performInitialisation();

        global $ilClientIniFile;
        $this->ilDBInterfaceGalera = ilDBWrapperFactory::getWrapper(ilDBConstants::TYPE_GALERA);
        $this->ilDBInterfaceGalera->initFromIniFile($ilClientIniFile);
        $this->ilDBInterfaceGalera->connect();

        $this->ilDBInterfaceGaleraSecond = ilDBWrapperFactory::getWrapper(ilDBConstants::TYPE_GALERA);
        $this->ilDBInterfaceGaleraSecond->initFromIniFile($ilClientIniFile);
        $this->ilDBInterfaceGaleraSecond->connect();

        $this->ilDBInterfaceInnoDB = ilDBWrapperFactory::getWrapper(ilDBConstants::TYPE_PDO_MYSQL_INNODB);
        $this->ilDBInterfaceInnoDB->initFromIniFile($ilClientIniFile);
        $this->ilDBInterfaceInnoDB->connect();

        $this->ilDBInterfaceInnoDBSecond = ilDBWrapperFactory::getWrapper(ilDBConstants::TYPE_PDO_MYSQL_INNODB);
        $this->ilDBInterfaceInnoDBSecond->initFromIniFile($ilClientIniFile);
        $this->ilDBInterfaceInnoDBSecond->connect();

        $this->setupTable();
    }


    public function tearDown() : void
    {
        $this->ilDBInterfaceGalera->dropSequence('il_db_tests_atom');
        $this->ilDBInterfaceGalera->dropTable('il_db_tests_atom');
    }


    public function testConnection()
    {
        $this->assertTrue($this->ilDBInterfaceGalera->connect(true));
        $this->assertTrue($this->ilDBInterfaceGaleraSecond->connect(true));
        $this->assertTrue($this->ilDBInterfaceInnoDB->connect(true));
    }


    public function setupTable()
    {
        if ($this->ilDBInterfaceGalera->sequenceExists('il_db_tests_atom')) {
            $this->ilDBInterfaceGalera->dropSequence('il_db_tests_atom');
        }
        $this->ilDBInterfaceGalera->createTable('il_db_tests_atom', $fields = array(
            'id' => array(
                'type' => 'integer',
                'length' => 4,
                'notnull' => true,
            ),
            'is_online' => array(
                'type' => 'integer',
                'length' => 1,
                'notnull' => false,
            ),
        ), true);
        $this->ilDBInterfaceGalera->addPrimaryKey('il_db_tests_atom', array( 'id' ));
        $this->ilDBInterfaceGalera->createSequence('il_db_tests_atom');
    }


    public function testTableExists()
    {
        $this->assertTrue($this->ilDBInterfaceGalera->tableExists('il_db_tests_atom'));
    }


    public function testWriteWithTransactions()
    {
        $ilAtomQuery = $this->ilDBInterfaceGalera->buildAtomQuery();
        $ilAtomQuery->addTableLock('il_db_tests_atom')->lockSequence(true);
        $ilAtomQuery->addQueryCallable($this->getInsertQueryCallable());

        $ilAtomQuery->run();

        $this->assertEquals($this->getExpectedResult(), $this->getResultFromDB());
    }


    public function testWriteWithLocks()
    {
        $ilAtomQuery = $this->ilDBInterfaceInnoDB->buildAtomQuery();
        $ilAtomQuery->addTableLock('il_db_tests_atom')->lockSequence(true);
        $ilAtomQuery->addQueryCallable($this->getInsertQueryCallable());

        $ilAtomQuery->run();

        $this->assertEquals($this->getExpectedResult(), $this->getResultFromDB());
    }


    public function testWriteWithLocksAndAlias()
    {
        $ilAtomQuery = $this->ilDBInterfaceInnoDB->buildAtomQuery();
        $ilAtomQuery->addTableLock('il_db_tests_atom')->lockSequence(true)->aliasName('my_alias');
        $ilAtomQuery->addQueryCallable($this->getInsertQueryCallable());

        $ilAtomQuery->run();

        $this->assertEquals($this->getExpectedResult(), $this->getResultFromDB());
    }


    public function testWriteWithMultipleLocksAndAlias()
    {
        $ilAtomQuery = $this->ilDBInterfaceInnoDB->buildAtomQuery();
        $ilAtomQuery->addTableLock('il_db_tests_atom')->lockSequence(true)->aliasName('my_alias');
        $ilAtomQuery->addTableLock('il_db_tests_atom')->lockSequence(true)->aliasName('my_second_alias');
        $ilAtomQuery->addQueryCallable($this->getInsertQueryCallable());

        $ilAtomQuery->run();

        $this->assertEquals($this->getExpectedResult(), $this->getResultFromDB());
    }


    public function testWriteWithMultipleLocksWithAndWithoutAlias()
    {
        $ilAtomQuery = $this->ilDBInterfaceInnoDB->buildAtomQuery();
        $ilAtomQuery->addTableLock('il_db_tests_atom')->lockSequence(true);
        $ilAtomQuery->addTableLock('il_db_tests_atom')->lockSequence(true)->aliasName('my_alias');
        $ilAtomQuery->addQueryCallable($this->getInsertQueryCallable());

        $ilAtomQuery->run();

        $this->assertEquals($this->getExpectedResult(), $this->getResultFromDB());
    }


    public function testNoTables()
    {
        $this->setExpectedException('ilDatabaseException');
        $ilAtomQuery = $this->ilDBInterfaceInnoDB->buildAtomQuery();
        $ilAtomQuery->addQueryCallable($this->getInsertQueryCallable());

        $ilAtomQuery->run();
    }


    public function testNoQueries()
    {
        $this->setExpectedException('ilDatabaseException');
        $ilAtomQuery = $this->ilDBInterfaceInnoDB->buildAtomQuery();
        $ilAtomQuery->addTableLock('il_db_tests_atom');

        $ilAtomQuery->run();
    }


    public function testUpdateDuringTransaction()
    {
        $this->ilDBInterfaceGalera->insert('il_db_tests_atom', array(
            'id' => array( 'integer', $this->ilDBInterfaceGalera->nextId('il_db_tests_atom') ),
            'is_online' => array( 'integer', 1 ),
        ));

        // Start a Transaction with one instance and update the same entry as another instance
        $this->ilDBInterfaceGalera->beginTransaction();
        $this->ilDBInterfaceGalera->update('il_db_tests_atom', array(
            'is_online' => array( 'integer', 5 ),
        ), array( 'id' => array( 'integer', 1 ) ));

        // Update the same entry with another instance (which currently fails due to missing multi-thread in PHP)
        //              $this->ilDBInterfaceGaleraSecond->update('il_db_tests_atom', array(
        //                      'is_online' => array( 'integer', 6 ),
        //              ), array( 'id' => array( 'integer', 1 ) ), true);

        // Commit the other
        $this->ilDBInterfaceGalera->commit();

        // Check
        $query = 'SELECT is_online FROM il_db_tests_atom WHERE id = ' . $this->ilDBInterfaceGalera->quote(1, 'integer');
        $res = $this->ilDBInterfaceGalera->query($query);
        $d = $this->ilDBInterfaceGalera->fetchAssoc($res);

        $this->assertEquals(5, $d['is_online']);
    }


    public function testUpdateDuringLock()
    {
        $this->ilDBInterfaceInnoDB->insert('il_db_tests_atom', array(
            'id' => array( 'integer', $this->ilDBInterfaceInnoDB->nextId('il_db_tests_atom') ),
            'is_online' => array( 'integer', 1 ),
        ));
        // Start a Transaction with one instance and update the same entry as another instance
        $this->ilDBInterfaceInnoDB->lockTables(array( array( 'name' => 'il_db_tests_atom', 'type' => ilAtomQuery::LOCK_WRITE ) ));
        $this->ilDBInterfaceInnoDB->update('il_db_tests_atom', array(
            'is_online' => array( 'integer', 5 ),
        ), array( 'id' => array( 'integer', 1 ) ));

        // Update the same entry with another instance (which currently fails due to missing multi-thread in PHP)
        //              $this->ilDBInterfaceInnoDBSecond->update('il_db_tests_atom', array(
        //                      'is_online' => array( 'integer', 6 ),
        //              ), array( 'id' => array( 'integer', 1 ) ), true);

        // Unlock Tables
        $this->ilDBInterfaceInnoDB->unlockTables();

        // Check
        $query = 'SELECT is_online FROM il_db_tests_atom WHERE id = ' . $this->ilDBInterfaceInnoDB->quote(1, 'integer');
        $res = $this->ilDBInterfaceInnoDB->query($query);
        $d = $this->ilDBInterfaceInnoDB->fetchAssoc($res);

        $this->assertEquals(5, $d['is_online']);
    }



    //
    // HELPERS
    //

    protected function getInsertQueryCallable()
    {
        $query = function (ilDBInterface $ilDB) {
            $ilDB->insert('il_db_tests_atom', array(
                'id' => array( 'integer', $ilDB->nextId('il_db_tests_atom') ),
                'is_online' => array( 'integer', 1 ),
            ));
            $ilDB->insert('il_db_tests_atom', array(
                'id' => array( 'integer', $ilDB->nextId('il_db_tests_atom') ),
                'is_online' => array( 'integer', 0 ),
            ));
        };

        return $query;
    }


    protected function getTableLocksForDbInterface()
    {
        $tables = array(
            array(
                'name' => 'il_db_tests_atom',
                'type' => ilAtomQuery::LOCK_WRITE,
                'sequence' => true,
            ),
        );

        return $tables;
    }


    protected function getResultFromDB()
    {
        $res = $this->ilDBInterfaceGalera->query('SELECT * FROM il_db_tests_atom');
        $results = array();
        while ($d = $this->ilDBInterfaceGalera->fetchAssoc($res)) {
            $results[] = $d;
        }

        return $results;
    }


    protected function getExpectedResult()
    {
        return array(
            0 => array(
                'id' => '1',
                'is_online' => '1',
            ),
            1 => array(
                'id' => '2',
                'is_online' => '0',
            ),
        );
    }
}