suricate-php / framework

tests/DBObjectTest.php

<?php
require_once 'stubs/Category.php';

/**
 * @SuppressWarnings("StaticAccess")
 */
class DBObjectTest extends \PHPUnit\Framework\TestCase
{
    protected $tableName = 'users';
    public function testContructor()
    {
        $classname = '\Suricate\DBObject';

        // Get mock, without the constructor being called
        $mock = $this->getMockBuilder($classname)

The function PHPUnit\Framework\MockObject\MockBuilder::setMethods() has been deprecated: https://github.com/sebastianbergmann/phpunit/pull/3687

            ->disableOriginalConstructor()
            ->setMethods(['setRelations'])
            ->getMockForAbstractClass();

        // set expectations for constructor calls
        $mock->expects($this->once())->method('setRelations');

        // now call the constructor
        $reflectedClass = new ReflectionClass($classname);
        $constructor = $reflectedClass->getConstructor();
        $constructor->invoke($mock);
    }

    public function testGetTableName()
    {
        $testName = 'my_sql_table';

        $testDBO = new \Suricate\DBObject();
        self::mockProperty($testDBO, 'tableName', $testName);
        $this->assertEquals($testName, $testDBO->getTableName());
    }

    public function testStaticTableName()
    {
        $this->assertEquals('categories', Category::tableName());
    }

    public function testGetTableIndex()
    {
        $testIndex = 'id';

        $testDBO = new \Suricate\DBObject();
        self::mockProperty($testDBO, 'tableIndex', $testIndex);
        $this->assertEquals($testIndex, $testDBO->getTableIndex());
    }

    public function testStaticTableIndex()
    {
        $this->assertEquals('id', Category::tableIndex());
    }

    public function testGetDBConfig()
    {
        $testConfigName = 'my_config';

        $testDBO = new \Suricate\DBObject();
        self::mockProperty($testDBO, 'DBConfig', $testConfigName);
        $this->assertEquals($testConfigName, $testDBO->getDBConfig());
    }

    public function testUndefinedGet()
    {
        $testDBO = new \Suricate\DBObject();
        self::mockProperty($testDBO, 'dbVariables', [
            'id',
            'name',
            'last_update'
        ]);
        $this->expectException(\InvalidArgumentException::class);

        $testDBO->undefinedVar;

The property undefinedVar does not exist on Suricate\DBObject. Since you implemented __get, consider adding a @property annotation.

    }

    public function testDBProperty()
    {
        $testDBO = new \Suricate\DBObject();
        $testDBO->regularProperty = 42;

The property regularProperty does not exist on Suricate\DBObject. Since you implemented __set, consider adding a @property annotation.

        self::mockProperty($testDBO, 'dbVariables', [
            'id',
            'name',
            'not_loaded_var'
        ]);
        self::mockProperty($testDBO, 'dbValues', [
            'id' => 1,
            'name' => 'test name'
        ]);
        $this->assertEquals($testDBO->id, 1);

The property id does not exist on Suricate\DBObject. Since you implemented __get, consider adding a @property annotation.

        $this->assertNotEquals($testDBO->name, 'test name edited');

The property name does not exist on Suricate\DBObject. Since you implemented __get, consider adding a @property annotation.

        $this->assertNull($testDBO->not_loaded_var);

The property not_loaded_var does not exist on Suricate\DBObject. Since you implemented __get, consider adding a @property annotation.

        $this->assertTrue($testDBO->isDBVariable('id'));
        $this->assertFalse($testDBO->isDBVariable('regularProperty'));

        $this->assertTrue($testDBO->propertyExists('regularProperty'));
        $this->assertTrue($testDBO->propertyExists('id'));
        $this->assertFalse($testDBO->propertyExists('unknownProperty'));
    }

    public function testIsset()
    {
        $testDBO = new \Suricate\DBObject();
        self::mockProperty($testDBO, 'dbVariables', [
            'id',
            'name',
            'not_loaded_var'
        ]);
        self::mockProperty($testDBO, 'dbValues', [
            'id' => 1,
            'name' => 'test name'
        ]);

        $this->assertTrue(isset($testDBO->id));

The property id does not exist on Suricate\DBObject. Since you implemented __get, consider adding a @property annotation.

        $this->assertFalse(isset($testDBO->undefVar));

The property undefVar does not exist on Suricate\DBObject. Since you implemented __get, consider adding a @property annotation.

    }

    public function testIsLoaded()
    {
        $testIndex = 'id';

        $testDBO = new \Suricate\DBObject();
        self::mockProperty($testDBO, 'tableIndex', $testIndex);
        self::mockProperty($testDBO, 'dbVariables', [
            $testIndex,
            'name',
            'not_loaded_var'
        ]);
        $this->assertFalse($testDBO->isLoaded());

        self::mockProperty($testDBO, 'dbValues', [
            $testIndex => 1,
            'name' => 'test name'
        ]);
        $this->assertFalse($testDBO->isLoaded());

        $this->setupData();
        $dbo = $this->getDBOject();
        $this->assertFalse($dbo->isLoaded());
        $dbo->load(1);
        $this->assertTrue($dbo->isLoaded());
        $dbo->load(999);
        $this->assertFalse($dbo->isLoaded());
    }

    public function testSetLoaded()
    {
        $testIndex = 'id';

        $testDBO = new \Suricate\DBObject();
        self::mockProperty($testDBO, 'tableIndex', $testIndex);
        self::mockProperty($testDBO, 'dbVariables', [
            $testIndex,
            'name',
            'not_loaded_var'
        ]);
        $this->assertFalse($testDBO->isLoaded());
        $testDBO->setLoaded();
        $this->assertTrue($testDBO->isLoaded());
    }

    public function testProtected()
    {
        $testDBO = Category::instanciate([
            'id' => 1,
            'name' => 'test record'
        ]);
        $reflector = new ReflectionClass(Category::class);
        $property = $reflector->getProperty('protectedValues');
        $property->setAccessible(true);
        $this->assertSame([], $property->getValue($testDBO));
        $this->assertNull($testDBO->unloadable);

The property unloadable does not exist on Category. Since you implemented __get, consider adding a @property annotation.

        $reflector = new ReflectionClass(Category::class);
        $property = $reflector->getProperty('protectedValues');
        $property->setAccessible(true);
        $this->assertSame([], $property->getValue($testDBO));

        $reflector = new ReflectionClass(Category::class);
        $property = $reflector->getProperty('loadedProtectedVariables');
        $property->setAccessible(true);
        $this->assertSame([], $property->getValue($testDBO));

        $this->assertSame(42, $testDBO->prot_var);
        $property = $reflector->getProperty('protectedValues');
        $property->setAccessible(true);
        $this->assertSame(['prot_var' => 42], $property->getValue($testDBO));

        $reflector = new ReflectionClass(Category::class);
        $property = $reflector->getProperty('loadedProtectedVariables');
        $property->setAccessible(true);
        $this->assertSame(['prot_var' => true], $property->getValue($testDBO));
    }
    public function testInstanciate()
    {
        $testDBO = Category::instanciate([
            'id' => 1,
            'name' => 'test record'
        ]);

        $reflector = new ReflectionClass(Category::class);
        $property = $reflector->getProperty('dbValues');
        $property->setAccessible(true);
        $this->assertEquals(
            [
                'id' => 1,
                'name' => 'test record'
            ],
            $property->getValue($testDBO)
        );

        $this->assertFalse($testDBO->isLoaded());
    }

    public function testHydrate()
    {
        $testDBO = new \Suricate\DBObject();
        $testDBO->realProperty = '';

The property realProperty does not exist on Suricate\DBObject. Since you implemented __set, consider adding a @property annotation.

        self::mockProperty($testDBO, 'dbVariables', ['id', 'name']);
        $testDBO->hydrate([
            'id' => 1,
            'name' => 'test record',
            'add_column' => 'test value',
            'realProperty' => 'my string'
        ]);

        $this->assertEquals($testDBO->realProperty, 'my string');

The property realProperty does not exist on Suricate\DBObject. Since you implemented __get, consider adding a @property annotation.

        $reflector = new ReflectionClass(get_class($testDBO));
        $property = $reflector->getProperty('dbValues');
        $property->setAccessible(true);
        $this->assertEquals(
            [
                'id' => 1,
                'name' => 'test record'
            ],
            $property->getValue($testDBO)
        );

        $this->assertFalse($testDBO->isLoaded());
    }

    public function testWakeup()
    {
        $mock = $this->getMockBuilder(\Suricate\DBObject::class)

The function PHPUnit\Framework\MockObject\MockBuilder::setMethods() has been deprecated: https://github.com/sebastianbergmann/phpunit/pull/3687

            ->setMethods(['setRelations'])
            ->getMock();

        $mock->expects($this->once())->method('setRelations');

        $mock->__wakeup();
    }

    public function testRelationOneOne()
    {
        $relations = [
            'category' => [
                'type' => \Suricate\DBObject::RELATION_ONE_ONE,
                'source' => 'category_id',
                'target' => 'Category'
            ]
        ];
        // Prepare database
        $this->setupData();
        $mock = $this->getMockBuilder(\Suricate\DBObject::class)

The function PHPUnit\Framework\MockObject\MockBuilder::setMethods() has been deprecated: https://github.com/sebastianbergmann/phpunit/pull/3687

            ->setMethods(['setRelations', 'getRelation'])
            ->getMock();

        // Prepare setup DBObject
        $testDBO = $this->getDBOject();
        $reflector = new ReflectionClass($mock);
        $property = $reflector->getProperty('relations');
        $property->setAccessible(true);
        $property->setValue($testDBO, $relations);

        // get relation values
        $reflector = new ReflectionClass($testDBO);
        $relationValuesRef = $reflector->getProperty('relationValues');
        $relationValuesRef->setAccessible(true);

        $loadedRelationsRef = $reflector->getProperty('loadedRelations');
        $loadedRelationsRef->setAccessible(true);

        // Load
        $testDBO->load(1);
        $relationsValues = $relationValuesRef->getValue($testDBO);
        $loadedRelations = $loadedRelationsRef->getValue($testDBO);

        // No relation values at first
        $this->assertSame([], $relationsValues);
        $this->assertSame([], $loadedRelations);
        $this->assertEquals('Admin', $testDBO->category->name);

The property category does not exist on Suricate\DBObject. Since you implemented __get, consider adding a @property annotation.

        $this->assertInstanceOf('\Suricate\DBObject', $testDBO->category);

        $relationsValues = $relationValuesRef->getValue($testDBO);
        $loadedRelations = $loadedRelationsRef->getValue($testDBO);

        // Check relation cache has been set
        $this->assertArrayHasKey('category', $relationsValues);

        // Check relation loaded flag has been set
        $this->assertArrayHasKey('category', $loadedRelations);

        // Check return type of relation
        $this->assertInstanceOf(
            '\Suricate\DBObject',
            $relationsValues['category']
        );

        // Load new object
        $testDBO = $this->getDBOject();
        $reflector = new ReflectionClass($mock);
        $property = $reflector->getProperty('relations');
        $property->setAccessible(true);
        $property->setValue($testDBO, $relations);
        $testDBO->load(2);
        // get relation values
        $reflector = new ReflectionClass($testDBO);
        $relationValuesRef = $reflector->getProperty('relationValues');
        $relationValuesRef->setAccessible(true);

        $loadedRelationsRef = $reflector->getProperty('loadedRelations');
        $loadedRelationsRef->setAccessible(true);

        $relationsValues = $relationValuesRef->getValue($testDBO);
        $loadedRelations = $loadedRelationsRef->getValue($testDBO);

        // No relation values at first
        $this->assertSame([], $relationsValues);
        $this->assertSame([], $loadedRelations);

        // Isset implicit load relation, check that's been loaded
        $this->assertTrue(isset($testDBO->category));
    }

    public function testLoad()
    {
        // Prepare database
        $this->setupData();

        // Inject database handler
        $testDBO = $this->getDBOject();

        $this->assertFalse($testDBO->isLoaded());
        $retVal = $testDBO->load(1);
        $this->assertTrue($testDBO->isLoaded());
        $this->assertEquals(1, $testDBO->id);

The property id does not exist on Suricate\DBObject. Since you implemented __get, consider adding a @property annotation.

        $this->assertEquals('John', $testDBO->name);

The property name does not exist on Suricate\DBObject. Since you implemented __get, consider adding a @property annotation.

        $this->assertInstanceOf('\Suricate\DBObject', $retVal);
    }

    public function testSetInsertIgnore()
    {
        $testDBO = $this->getDBOject();
        $reflectionClass = new \ReflectionClass($testDBO);

        $property = $reflectionClass->getProperty('insertIgnore');
        $property->setAccessible(true);

        $this->assertFalse($property->getValue($testDBO));
        $retVal = $testDBO->setInsertIgnore(true);
        $this->assertInstanceOf('\Suricate\DBObject', $retVal);

        $this->assertTrue($property->getValue($testDBO));
    }

    public function testSaveUpdate()
    {
        // Prepare database
        $this->setupData();

        // Simple save
        $testDBO = $this->getDBOject();
        $testDBO->id = 55;

The property id does not exist on Suricate\DBObject. Since you implemented __set, consider adding a @property annotation.

        $testDBO->name = 'Steve';

The property name does not exist on Suricate\DBObject. Since you implemented __set, consider adding a @property annotation.

        $testDBO->date_added = '2019-01-27';

The property date_added does not exist on Suricate\DBObject. Since you implemented __set, consider adding a @property annotation.

        $testDBO->save();

        $loaded = $this->getDBOject();
        $retVal = $loaded->load(55);
        $this->assertTrue($testDBO->isLoaded());
        $this->assertEquals(55, $loaded->id);

The property id does not exist on Suricate\DBObject. Since you implemented __get, consider adding a @property annotation.

        $this->assertEquals('Steve', $loaded->name);

The property name does not exist on Suricate\DBObject. Since you implemented __get, consider adding a @property annotation.

        $this->assertInstanceOf('\Suricate\DBObject', $retVal);

        // Update
        $loaded->name = 'Tim';
        $loaded->save();
        $loaded = $this->getDBOject();
        $retVal = $loaded->load(55);
        $this->assertTrue($testDBO->isLoaded());
        $this->assertEquals(55, $loaded->id);
        $this->assertEquals('Tim', $loaded->name);
        $this->assertInstanceOf('\Suricate\DBObject', $retVal);
    }

    public function testForceInsert()
    {
        // Prepare database
        $this->setupData();

        // Force insert
        $loadedForce = $this->getDBOject();
        $retVal = $loadedForce->load(1);

The assignment to $retVal is dead and can be removed.

        $loadedForce->id = 56;

The property id does not exist on Suricate\DBObject. Since you implemented __set, consider adding a @property annotation.

        $loadedForce->save(true);

        $loaded = $this->getDBOject();
        $retVal = $loaded->load(56);

        $this->assertEquals(56, $loaded->id);

The property id does not exist on Suricate\DBObject. Since you implemented __get, consider adding a @property annotation.

        $this->assertEquals('John', $loaded->name);

The property name does not exist on Suricate\DBObject. Since you implemented __get, consider adding a @property annotation.

        $this->assertInstanceOf('\Suricate\DBObject', $retVal);
    }

    public function testDelete()
    {
        // Prepare database
        $this->setupData();

        // Simple save
        $testDBO = $this->getDBOject();
        $testDBO->id = 55;

The property id does not exist on Suricate\DBObject. Since you implemented __set, consider adding a @property annotation.

        $testDBO->name = 'Steve';

The property name does not exist on Suricate\DBObject. Since you implemented __set, consider adding a @property annotation.

        $testDBO->date_added = '2019-01-27';

The property date_added does not exist on Suricate\DBObject. Since you implemented __set, consider adding a @property annotation.

        $testDBO->save();

        $testDBO = $this->getDBOject();
        $retVal = $testDBO->loadOrFail(55);
        $this->assertInstanceOf('\Suricate\DBObject', $retVal);

        $testDBO->delete();

        $testDBO = $this->getDBOject();
        $this->expectException(
            \Suricate\Exception\ModelNotFoundException::class
        );
        $testDBO->loadOrFail(55);
    }

    public function testLoadFromSQL()
    {
        // Prepare database
        $this->setupData();

        // Inject database handler
        $testDBO = $this->getDBOject();

        $sql = "SELECT * FROM `users` WHERE id=:id";
        $params = ['id' => 1];

        $retVal = $testDBO->loadFromSql($sql, $params);
        $this->assertInstanceOf('\Suricate\DBObject', $retVal);
        $this->assertTrue($testDBO->isLoaded());

        $params = ['id' => 100];
        $retVal = $testDBO->loadFromSql($sql, $params);
        $this->assertFalse($retVal);
        $this->assertFalse($testDBO->isLoaded());
    }

    public function testLoadOrFail()
    {
        // Prepare database
        $this->setupData();

        // Inject database handler
        $testDBO = $this->getDBOject();

        $retVal = $testDBO->loadOrFail(1);
        $this->assertInstanceOf('\Suricate\DBObject', $retVal);

        $this->expectException(
            \Suricate\Exception\ModelNotFoundException::class
        );
        $testDBO->loadOrFail(100);
    }

    public function testLoadOrInstanciate()
    {
        // Prepare database
        $this->setupData();

        $testDBO = Category::loadOrInstanciate(100);

        $comparison = $this->getCategoryDBOject();
        $comparison->load(100);

        $this->assertInstanceOf('\Suricate\DBObject', $testDBO);
        $this->assertInstanceOf('Category', $testDBO);

        $this->assertSame($comparison->id, $testDBO->id);

The property id does not exist on Category. Since you implemented __get, consider adding a @property annotation.

The property id does not exist on Suricate\DBObject. Since you implemented __get, consider adding a @property annotation.

        $this->assertSame($comparison->name, $testDBO->name);

The property name does not exist on Suricate\DBObject. Since you implemented __get, consider adding a @property annotation.

The property name does not exist on Category. Since you implemented __get, consider adding a @property annotation.

        $this->assertTrue($testDBO->isLoaded());

        // non existing
        $testDBO = Category::loadOrInstanciate(102);
        $this->assertFalse($testDBO->isLoaded()); // has been instanciated, not loaded
        $this->assertSame($testDBO->id, "102");
        $this->assertSame($testDBO->name, null);

        $testDBO = Category::loadOrInstanciate([
            'id' => 102,
            'name' => 'test name'
        ]);
        $this->assertFalse($testDBO->isLoaded());
        $this->assertSame($testDBO->id, "102");
        $this->assertSame($testDBO->name, 'test name');

        $testDBO = Category::loadOrInstanciate([
            'id' => 101,
            'name' => 'test name'
        ]);
        $this->assertFalse($testDBO->isLoaded());
        $this->assertSame($testDBO->id, "101");
        $this->assertSame($testDBO->name, 'test name');

        $testDBO = Category::loadOrInstanciate([
            'id' => 101,
            'name' => 'Employee'
        ]);
        $this->assertTrue($testDBO->isLoaded());
        $this->assertSame($testDBO->id, "101");
        $this->assertSame($testDBO->name, 'Employee');
    }

    public function testCreate()
    {
        // Prepare database
        $this->setupData();
        $comparison = $this->getCategoryDBOject();

        $testDBO = Category::create(['id' => 1020]);

        $this->assertInstanceOf('\Suricate\DBObject', $testDBO);
        $this->assertTrue($testDBO->isLoaded());

        $comparison->load(1020);

        $this->assertSame($comparison->id, $testDBO->id);

The property id does not exist on Suricate\DBObject. Since you implemented __get, consider adding a @property annotation.

The property id does not exist on Category. Since you implemented __get, consider adding a @property annotation.

        $this->assertSame($comparison->name, null);

The property name does not exist on Suricate\DBObject. Since you implemented __get, consider adding a @property annotation.

    }

    public function testToArray()
    {
        // Prepare database
        $this->setupData();

        // Inject database handler
        $testDBO = $this->getDBOject();
        $testDBO->load(2);

        $this->assertSame(
            [
                'id' => '2',
                'category_id' => '100',
                'name' => 'Paul',
                'date_added' => '2019-01-11 00:00:00'
            ],
            $testDBO->toArray()
        );

        $testDBO = $this->getDBOject();
        $testDBO->load(2);
        self::mockProperty($testDBO, 'exportedVariables', [
            'id' => 'id',
            'category_id' => 'category_id,type:integer',
            'name' => ',omitempty',
            'date_added' => '-'
        ]);
        $testDBO->name = '';

The property name does not exist on Suricate\DBObject. Since you implemented __set, consider adding a @property annotation.

        $this->assertSame(
            [
                'id' => '2',
                'category_id' => 100
            ],
            $testDBO->toArray()
        );
    }

    public function testToJson()
    {
        // Prepare database
        $this->setupData();

        // Inject database handler
        $testDBO = $this->getDBOject();
        $testDBO->load(2);

        $this->assertSame(
            '{"id":"2","category_id":"100","name":"Paul","date_added":"2019-01-11 00:00:00"}',
            $testDBO->toJson()
        );
    }

    public function testValidate()
    {
        $testDBO = $this->getDBOject();
        $this->assertTrue($testDBO->validate());
    }

    public static function mockProperty($object, string $propertyName, $value)
    {
        $reflectionClass = new \ReflectionClass($object);

        $property = $reflectionClass->getProperty($propertyName);
        $property->setAccessible(true);
        $property->setValue($object, $value);
        $property->setAccessible(false);
    }

    protected function setupData()
    {
        $pdo = new PDO('sqlite:/tmp/test.db');
        $pdo->exec("DROP TABLE IF EXISTS `users`");
        $pdo->exec("DROP TABLE IF EXISTS `categories`");
        $pdo->exec(
            "CREATE TABLE `users` (`id` INTEGER PRIMARY KEY,`category_id` INTEGER, `name` varchar(50) DEFAULT NULL,`date_added` datetime NOT NULL)"
        );
        $pdo->exec(
            "CREATE TABLE `categories` (`id` INTEGER PRIMARY KEY, `name` varchar(50) DEFAULT NULL, `parent_id` INTEGER DEFAULT NULL)"
        );

        $stmt = $pdo->prepare(
            "INSERT INTO `users` (name, category_id, date_added) VALUES (:name, :categoryid, :date)"
        );
        $values = [
            ['John', 100, '2019-01-10 00:00:00'],
            ['Paul', 100, '2019-01-11 00:00:00'],
            ['Robert', 101, '2019-01-12 00:00:00']
        ];
        foreach ($values as $value) {
            $stmt->execute([
                'name' => $value[0],
                'categoryid' => $value[1],
                'date' => $value[2]
            ]);
        }

        $stmt = $pdo->prepare(
            "INSERT INTO `categories` (id, name) VALUES (:id, :name)"
        );
        $values = [[100, 'Admin'], [101, 'Employee']];
        foreach ($values as $value) {
            $stmt->execute(['id' => $value[0], 'name' => $value[1]]);
        }
    }

    protected function getDatabase()
    {
        $database = new \Suricate\Database();
        $database->configure([
            'type' => 'sqlite',
            'file' => '/tmp/test.db'
        ]);

        return $database;
    }

    protected function getDBOject()
    {
        $dbLink = $this->getDatabase();
        // Inject database handler
        $testDBO = new \Suricate\DBObject();

        $reflector = new ReflectionClass(get_class($testDBO));
        $property = $reflector->getProperty('dbLink');
        $property->setAccessible(true);
        $property->setValue($testDBO, $dbLink);

        self::mockProperty($testDBO, 'tableName', $this->tableName);
        self::mockProperty($testDBO, 'tableIndex', 'id');
        self::mockProperty($testDBO, 'dbVariables', [
            'id',
            'category_id',
            'name',
            'date_added'
        ]);

        return $testDBO;
    }

    protected function getCategoryDBOject()
    {
        $dbLink = $this->getDatabase();
        // Inject database handler
        $testDBO = new \Suricate\DBObject();

        $reflector = new ReflectionClass(get_class($testDBO));
        $property = $reflector->getProperty('dbLink');
        $property->setAccessible(true);
        $property->setValue($testDBO, $dbLink);

        self::mockProperty($testDBO, 'tableName', 'categories');
        self::mockProperty($testDBO, 'tableIndex', 'id');
        self::mockProperty($testDBO, 'dbVariables', ['id', 'name']);

        return $testDBO;
    }
}