thecodingmachine / tdbm

declare(strict_types=1);

/*

 Copyright (C) 2006-2018 David Négrier - THE CODING MACHINE

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 St, Fifth Floor, Boston, MA  02110-1301  USA

*/

namespace TheCodingMachine\TDBM;

use Doctrine\Common\Cache\ArrayCache;

use Doctrine\DBAL\Exception\ForeignKeyConstraintViolationException;

use Doctrine\DBAL\Exception\UniqueConstraintViolationException;

use Doctrine\DBAL\Platforms\MySQLPlatform;

use Doctrine\DBAL\Platforms\OraclePlatform;

use Mouf\Database\SchemaAnalyzer\SchemaAnalyzer;

use Ramsey\Uuid\Uuid;

use ReflectionClass;

use ReflectionMethod;

use ReflectionNamedType;

use TheCodingMachine\TDBM\Dao\TestAlbumDao;

use TheCodingMachine\TDBM\Dao\TestArticleDao;

use TheCodingMachine\TDBM\Dao\TestArticleSubQueryDao;

use TheCodingMachine\TDBM\Dao\TestCountryDao;

use TheCodingMachine\TDBM\Dao\TestPersonDao;

use TheCodingMachine\TDBM\Dao\TestRoleDao;

use Symfony\Component\Process\Process;

class TDBMDaoGeneratorTest extends TDBMAbstractServiceTest

{

    /** @var TDBMDaoGenerator $tdbmDaoGenerator */

    protected $tdbmDaoGenerator;

    private $rootPath;

    protected function setUp(): void

    {

    }

    public function testGetSchemaCrashWithoutLock()

    {

        //let's delete the lock file

        $schemaFilePath = Configuration::getDefaultLockFilePath();

        if (file_exists($schemaFilePath)) {

    {

        // Remove all previously generated files.

        $this->recursiveDelete($this->rootPath . 'src/Test/Dao/');

        mkdir($this->rootPath . 'src/Test/Dao/Generated', 0755, true);

        // Let's generate a dummy file to see it is indeed removed.

        $dummyFile = $this->rootPath . 'src/Test/Dao/Generated/foobar.php';

        touch($dummyFile);

        $this->assertFileExists($dummyFile);

        //let's delete the lock file

        $schemaFilePath = Configuration::getDefaultLockFilePath();

        if (file_exists($schemaFilePath)) {

            unlink($schemaFilePath);

        }

        $this->tdbmDaoGenerator->generateAllDaosAndBeans();

        $this->assertFileDoesNotExist($dummyFile);

        //Check that the lock file was generated

        $this->assertFileExists($schemaFilePath);

        // Let's require all files to check they are valid PHP!

        // Test the daoFactory

        require_once $this->rootPath . 'src/Test/Dao/Generated/DaoFactory.php';

        // Test the others

        $beanDescriptors = $this->getDummyGeneratorListener()->getBeanDescriptors();

        foreach ($beanDescriptors as $beanDescriptor) {

            $daoName = $beanDescriptor->getDaoClassName();

            $daoBaseName = $beanDescriptor->getBaseDaoClassName();

            $beanName = $beanDescriptor->getBeanClassName();

            $baseBeanName = $beanDescriptor->getBaseBeanClassName();

            require_once $this->rootPath . 'src/Test/Dao/Bean/Generated/' . $baseBeanName . '.php';

            require_once $this->rootPath . 'src/Test/Dao/Bean/' . $beanName . '.php';

            require_once $this->rootPath . 'src/Test/Dao/Generated/' . $daoBaseName . '.php';

            require_once $this->rootPath . 'src/Test/Dao/' . $daoName . '.php';

        }

        // Check that pivot tables do not generate DAOs or beans.

        $this->assertFalse(class_exists('TheCodingMachine\\TDBM\\Test\\Dao\\RolesRightDao'));

    }

    public function testGenerationException(): void

    {

        $configuration = new Configuration('UnknownVendor\\Dao', 'UnknownVendor\\Bean', self::getConnection(), $this->getNamingStrategy());

        $this->expectException(NoPathFoundException::class);

        $tdbmDaoGenerator->generateAllDaosAndBeans();

    }

    /**

     * Delete a file or recursively delete a directory.

     *

     * @param string $str Path to file or directory

     * @return bool

     */

    private function recursiveDelete(string $str): bool

    {

        if (is_file($str)) {

            return @unlink($str);

        } elseif (is_dir($str)) {

            $scan = glob(rtrim($str, '/') . '/*');

            foreach ($scan as $index => $path) {

                $this->recursiveDelete($path);

            }

            return @rmdir($str);

        }

        return false;

    }

    /**

     * @depends testDaoGeneration

     */

    public function testGetBeanClassName(): void

    {

        $this->assertEquals(UserBean::class, $this->tdbmService->getBeanClassName('users'));

        // Let's create another TDBMService to test the cache.

        $configuration = new Configuration('TheCodingMachine\\TDBM\\Test\\Dao\\Bean', 'TheCodingMachine\\TDBM\\Test\\Dao', self::getConnection(), $this->getNamingStrategy(), $this->getCache(), null, null, [$this->getDummyGeneratorListener()]);

        $configuration->setPathFinder(new PathFinder(null, dirname(__DIR__, 4)));

        $newTdbmService = new TDBMService($configuration);

        $this->assertEquals(UserBean::class, $newTdbmService->getBeanClassName('users'));

    }

    /**

     * @depends testDaoGeneration

     */

    public function testGeneratedGetById(): void

    {

        $contactDao = new ContactDao($this->tdbmService);

        $contactBean = $contactDao->getById(1);

        $this->assertEquals(1, $contactBean->getId());

        $this->assertInstanceOf('\\DateTimeInterface', $contactBean->getCreatedAt());

        // FIXME: Question: que faire du paramètre stockage "UTC"????

    }

    /**

     * @depends testDaoGeneration

     */

    public function testGeneratedGetByIdLazyLoaded(): void

    {

        $roleDao = new RoleDao($this->tdbmService);

        $roleBean = $roleDao->getById(1, true);

        $this->assertEquals(1, $roleBean->getId());

        $this->assertInstanceOf('\\DateTimeInterface', $roleBean->getCreatedAt());

        $roleBean2 = $roleDao->getById(1, true);

        $this->assertTrue($roleBean === $roleBean2);

    }

    /**

     * @depends testDaoGeneration

     */

    public function testDefaultValueOnNewBean(): void

    {

        $roleBean = new RoleBean('my_role');

        $this->assertEquals(1, $roleBean->getStatus());

    }

    /**

     * @depends testDaoGeneration

     */

    public function testForeignKeyInBean(): void

    {

        $userDao = new UserDao($this->tdbmService);

        $userBean = $userDao->getById(1);

        $country = $userBean->getCountry();

        $this->assertEquals('uk', $country->getLabel());

        $userBean2 = $userDao->getById(1);

        $this->assertTrue($userBean === $userBean2);

        $contactDao = new ContactDao($this->tdbmService);

        $contactBean = $contactDao->getById(1);

        $this->assertTrue($userBean === $contactBean);

    }

    /**

     * @depends testDaoGeneration

     */

    public function testNewBeans(): void

    {

        $countryDao = new CountryDao($this->tdbmService);

        $userDao = new UserDao($this->tdbmService);

        $userBean = new UserBean('John Doe', '[email protected]', $countryDao->getById(2), 'john.doe');

        $userBean->setOrder(1); // Let's set a "protected keyword" column.

        $userDao->save($userBean);

        $this->assertNull($userBean->getManager());

    }

    /**

     * @depends testDaoGeneration

     */

    public function testDateTimeImmutableGetter(): void

    {

        $userDao = new UserDao($this->tdbmService);

        $user = $userDao->getById(1);

        $this->assertInstanceOf('\DateTimeImmutable', $user->getCreatedAt());

    }

    /**

     * @depends testDaoGeneration

     */

    public function testAssigningNewBeans(): void

    {

        $userDao = new UserDao($this->tdbmService);

        $countryBean = new CountryBean('Mexico');

        $userBean = new UserBean('Speedy Gonzalez', '[email protected]', $countryBean, 'speedy.gonzalez');

        $this->assertEquals($countryBean, $userBean->getCountry());

        $userDao->save($userBean);

    }

    /**

     * @depends testAssigningNewBeans

     */

    public function testUpdatingProtectedColumn(): void

    {

        $userDao = new UserDao($this->tdbmService);

        $userBean = $userDao->findOneByLogin('speedy.gonzalez');

        $userBean->setOrder(2);

        $userDao->save($userBean);

        $this->assertSame(2, $userBean->getOrder());

    }

    /**

     * @depends testDaoGeneration

     */

    public function testAssigningExistingRelationship(): void

    {

        $userDao = new UserDao($this->tdbmService);

        $user = $userDao->getById(1);

        $countryDao = new CountryDao($this->tdbmService);

        $country = $countryDao->getById(2);

        $user->setCountry($country);

        $this->assertEquals(TDBMObjectStateEnum::STATE_DIRTY, $user->_getStatus());

    }

    /**

     * @depends testDaoGeneration

     */

    public function testDirectReversedRelationship(): void

    {

        $countryDao = new CountryDao($this->tdbmService);

        $country = $countryDao->getById(1);

        $users = $country->getUsers();

        $arr = $users->toArray();

        $this->assertCount(1, $arr);

        $this->assertCount(2, $arr);

        $this->assertInstanceOf('TheCodingMachine\\TDBM\\Test\\Dao\\Bean\\UserBean', $arr[1]);

        $this->assertEquals('speedy.gonzalez', $arr[1]->getLogin());

    }

    /**

     * @depends testDaoGeneration

     */

    public function testDeleteInDirectReversedRelationship(): void

    {

        $countryDao = new CountryDao($this->tdbmService);

        $country = $countryDao->getById(1);

        $userDao = new UserDao($this->tdbmService);

        $newUser = new UserBean('John Snow', '[email protected]', $country, 'john.snow');

        $userDao->save($newUser);

        $users = $country->getUsers();

        $arr = $users->toArray();

        $this->assertCount(2, $arr);

        $userDao->delete($arr[1]);

        $users = $country->getUsers();

        $arr = $users->toArray();

        $this->assertCount(1, $arr);

    }

    /**

     * @depends testDaoGeneration

     */

    public function testJointureGetters(): void

    {

        $roleDao = new RoleDao($this->tdbmService);

        $role = $roleDao->getById(1);

        $users = $role->getUsers();

        $this->assertCount(2, $users);

        $this->assertInstanceOf('TheCodingMachine\\TDBM\\Test\\Dao\\Bean\\UserBean', $users[0]);

        $rights = $role->getRights();

        $this->assertCount(2, $rights);

        $this->assertInstanceOf('TheCodingMachine\\TDBM\\Test\\Dao\\Bean\\RightBean', $rights[0]);

    }

    /**

     * @depends testDaoGeneration

     */

    public function testNestedIterationOnAlterableResultIterator(): void

    {

        $countryDao = new CountryDao($this->tdbmService);

        $country = $countryDao->getById(2);

        $count = 0;

        // Let's perform 2 nested calls to check that iterators do not melt.

        foreach ($country->getUsers() as $user) {

            foreach ($country->getUsers() as $user2) {

                $count++;

            }

        }

        // There are 3 users linked to country 2.

        $this->assertSame(9, $count);

    }

    /**

     * @depends testDaoGeneration

     */

    public function testNewBeanConstructor(): void

    {

        $role = new RoleBean('Newrole');

        $this->assertEquals(TDBMObjectStateEnum::STATE_DETACHED, $role->_getStatus());

    }

    /**

     * @depends testDaoGeneration

     */

    public function testJointureAdderOnNewBean(): void

    {

        $countryDao = new CountryDao($this->tdbmService);

        $country = $countryDao->getById(1);

        $user = new UserBean('Speedy Gonzalez', '[email protected]', $country, 'speedy.gonzalez');

        $role = new RoleBean('Mouse');

        $user->addRole($role);

        $roles = $user->getRoles();

        $this->assertCount(1, $roles);

        $role = $roles[0];

        $this->assertInstanceOf('TheCodingMachine\\TDBM\\Test\\Dao\\Bean\\RoleBean', $role);

        $users = $role->getUsers();

        $this->assertCount(1, $users);

        $this->assertEquals($user, $users[0]);

        $role->removeUser($user);

        $this->assertCount(0, $role->getUsers());

        $this->assertCount(0, $user->getRoles());

    }

    /**

     * @depends testDaoGeneration

     */

    public function testJointureDeleteBeforeGetters(): void

    {

        $roleDao = new RoleDao($this->tdbmService);

        $userDao = new UserDao($this->tdbmService);

        $role = $roleDao->getById(1);

        $user = $userDao->getById(1);

        // We call removeUser BEFORE calling getUsers

        // This should work as expected.

        $role->removeUser($user);

        $users = $role->getUsers();

        $this->assertCount(1, $users);

    }

    /**

     * @depends testDaoGeneration

     */

    public function testJointureMultiAdd(): void

    {

        $countryDao = new CountryDao($this->tdbmService);

        $country = $countryDao->getById(1);

        $user = new UserBean('Speedy Gonzalez', '[email protected]', $country, 'speedy.gonzalez');

        $role = new RoleBean('Mouse');

        $user->addRole($role);

        $role->addUser($user);

        $user->addRole($role);

        $this->assertCount(1, $user->getRoles());

    }

    /**

     * Step 1: we remove the role 1 from user 1 but save role 1.

     * Expected result: no save done.

     *

     * @depends testDaoGeneration

     */

    public function testJointureSave1(): void

    {

        $roleDao = new RoleDao($this->tdbmService);

        $role = $roleDao->getById(1);

        $userDao = new UserDao($this->tdbmService);

        $user = $userDao->getById(1);

        $this->assertTrue($user->hasRole($role));

        $this->assertTrue($role->hasUser($user));

        $user->removeRole($role);

        $this->assertFalse($user->hasRole($role));

        $this->assertFalse($role->hasUser($user));

        $roleDao->save($role);

        $this->assertEquals(TDBMObjectStateEnum::STATE_DIRTY, $user->_getStatus());

        $this->assertEquals(TDBMObjectStateEnum::STATE_LOADED, $role->_getStatus());

    }

    /**

     * Step 2: we check that nothing was saved

     * Expected result: no save done.

     *

     * @depends testJointureSave1

     */

    public function testJointureSave2(): void

    {

        $roleDao = new RoleDao($this->tdbmService);

        $role = $roleDao->getById(1);

        $this->assertCount(2, $role->getUsers());

    }

    /**

     * Step 3: we remove the role 1 from user 1 and save user 1.

     * Expected result: save done.

     *

     * @depends testJointureSave2

     */

    public function testJointureSave3(): void

    {

        $roleDao = new RoleDao($this->tdbmService);

        $role = $roleDao->getById(1);

        $userDao = new UserDao($this->tdbmService);

        $user = $userDao->getById(1);

        $this->assertCount(1, $user->getRoles());

        $user->removeRole($role);

        $this->assertCount(0, $user->getRoles());

        $userDao->save($user);