MySqlSchemaManagerTest::getColumnDefinition() - Code Metrics - Inspection of "Fix for Mariadb 10.2.7 default column value and nu..." - doctrine/dbal - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#2825)

by Sébastien

created 2017-08-26 23:16 UTC

MySqlSchemaManagerTest::getColumnDefinition() A

↳ Parent: MySqlSchemaManagerTest

Complexity

Conditions	1
Paths	1

Size

Total Lines	64
Code Lines	47

Duplication

Lines	0
Ratio	0 %

Importance

Changes	2
Bugs	0	Features	0

Metric	Value
c	2
b	0
f	0
dl	0
loc	64
rs	9.3956
cc	1
eloc	47
nc	1
nop	0

How to fix Long Method

<?php

namespace Doctrine\Tests\DBAL\Schema;

use Doctrine\Common\EventManager;
use Doctrine\DBAL\Configuration;
use Doctrine\DBAL\Schema\MySqlSchemaManager;

class MySqlSchemaManagerTest extends \PHPUnit_Framework_TestCase
{
    /**
     *
     * @var \Doctrine\DBAL\Schema\AbstractSchemaManager
     */
    private $manager;

    protected function setUp()
    {
        $eventManager = new EventManager();
        $driverMock = $this->createMock('Doctrine\DBAL\Driver');
        $platform = $this->createMock('Doctrine\DBAL\Platforms\MySqlPlatform');
        $this->conn = $this->getMockBuilder('Doctrine\DBAL\Connection')
class MyClass { }

$x = new MyClass();
$x->foo = true;
            ->setMethods(array('fetchAll'))
            ->setConstructorArgs(array(array('platform' => $platform), $driverMock, new Configuration(), $eventManager))
            ->getMock();
        $this->manager = new MySqlSchemaManager($this->conn);
    }

    public function testCompositeForeignKeys()
    {
        $this->conn->expects($this->once())->method('fetchAll')->will($this->returnValue($this->getFKDefinition()));
        $fkeys = $this->manager->listTableForeignKeys('dummy');
        $this->assertEquals(1, count($fkeys), "Table has to have one foreign key.");

        $this->assertInstanceOf('Doctrine\DBAL\Schema\ForeignKeyConstraint', $fkeys[0]);
        $this->assertEquals(array('column_1', 'column_2', 'column_3'), array_map('strtolower', $fkeys[0]->getLocalColumns()));
        $this->assertEquals(array('column_1', 'column_2', 'column_3'), array_map('strtolower', $fkeys[0]->getForeignColumns()));
    }

    public function testPortableTableColumnDefinition()
    {
        $eventManager = new EventManager();
        $driverMock = $this->createMock('Doctrine\DBAL\Driver');
        $platform = new \Doctrine\DBAL\Platforms\MySqlPlatform();
        $conn = $this->getMockBuilder('Doctrine\DBAL\Connection')
            ->setMethods(array('fetchAll'))
            ->setConstructorArgs(array(array('platform' => $platform), $driverMock, new Configuration(), $eventManager))
            ->getMock();
        $this->manager = new MySqlSchemaManager($conn);


        $conn->expects($this->once())->method('fetchAll')->will($this->returnValue($this->getColumnDefinition()));
        $columns = $this->manager->listTableColumns('dummy');
        $this->assertEquals(count($this->getColumnDefinition()), count($columns));
        $this->assertTrue($columns['id']->getNotnull());
        $this->assertNull($columns['id']->getDefault());
        $this->assertFalse($columns['updated_at']->getNotnull());
        $this->assertNull($columns['updated_at']->getDefault());
        $this->assertFalse($columns['created_by']->getNotnull());
        $this->assertNull($columns['created_by']->getDefault());
        $this->assertEquals(null, $columns['text_2']->getDefault());
        $this->assertEquals("'NULL'", $columns['text_1']->getDefault());

    }

    public function getColumnDefinition()
    {
        return [
            [
                'Field'   => 'id',
                'Type'    => 'int(10) unsigned',
                'Null'    => 'NO',
                'Key'     => 'PRI',
                'Default' => null,
                'Extra'   => 'auto_increment',
                'Comment' => '',
                'CharacterSet' => null,
                'Collation' => null
            ],[
                'Field'=> 'created_by',
                'Type'=> 'varchar(40)',
                'Null'=> 'YES',
                'Key'=>  '',
                'Default'=> null, // MySQL 5.1 - 5.7 sends: null
                'Extra' => '',
                'Comment' => 'Creator name',
                'CharacterSet' => 'utf8',
                'Collation'=> 'utf8_unicode_ci'
            ],
            // Mariadb since 10.2.7, see https://jira.mariadb.org/browse/MDEV-13341
            [
                'Field'   => 'updated_at',
                'Type'    => 'datetime',
                'Null'    => 'YES',
                'Key'     => '',
                'Default' => 'NULL', // MariaDB 10.2.7 return 'NULL'

                'Extra'   => '',
                'Comment' => 'Record last update timestamp',
                'CharacterSet' => null,
                'Collation' => null
            ],
            // Mariadb 10.2 test with defaults that could be
            // ambiguous (see text_1 and text_2 Default)
            [
                'Field'   => 'text_1',
                'Type'    => 'varchar(50)',
                'Null'    => 'YES',
                'Key'     => '',
                'Default' => "'NULL'",
                'Extra'   => '',
                'Comment' => '',
                'CharacterSet' => 'utf8',
                'Collation'=> 'utf8_unicode_ci'
            ],[
                'Field'   => 'text_2',
                'Type'    => 'varchar(50)',
                'Null'    => 'YES',
                'Key'     => '',
                'Default' => 'NULL',
                'Extra'   => '',
                'Comment' => '',
                'CharacterSet' => 'utf8',
                'Collation'=> 'utf8_unicode_ci'
            ],


        ];

    }


    public function getFKDefinition()
    {
        return array(
            array(
                "CONSTRAINT_NAME" => "FK_C1B1712387FE737264DE5A5511B8B3E",
                "COLUMN_NAME" => "column_1",
                "REFERENCED_TABLE_NAME" => "dummy",
                "REFERENCED_COLUMN_NAME" => "column_1",
                "update_rule" => "RESTRICT",
                "delete_rule" => "RESTRICT",
            ),
            array(
                "CONSTRAINT_NAME" => "FK_C1B1712387FE737264DE5A5511B8B3E",
                "COLUMN_NAME" => "column_2",
                "REFERENCED_TABLE_NAME" => "dummy",
                "REFERENCED_COLUMN_NAME" => "column_2",
                "update_rule" => "RESTRICT",
                "delete_rule" => "RESTRICT",
            ),
            array(
                "CONSTRAINT_NAME" => "FK_C1B1712387FE737264DE5A5511B8B3E",
                "COLUMN_NAME" => "column_3",
                "REFERENCED_TABLE_NAME" => "dummy",
                "REFERENCED_COLUMN_NAME" => "column_3",
                "update_rule" => "RESTRICT",
                "delete_rule" => "RESTRICT",
            )
        );
    }
}


1			<?php
2
3			namespace Doctrine\Tests\DBAL\Schema;
4
5			use Doctrine\Common\EventManager;
6			use Doctrine\DBAL\Configuration;
7			use Doctrine\DBAL\Schema\MySqlSchemaManager;
8
9			class MySqlSchemaManagerTest extends \PHPUnit_Framework_TestCase
10			{
11			/**
12			*
13			* @var \Doctrine\DBAL\Schema\AbstractSchemaManager
14			*/
15			private $manager;
16
17			protected function setUp()
18			{
19			$eventManager = new EventManager();
20			$driverMock = $this->createMock('Doctrine\DBAL\Driver');
21			$platform = $this->createMock('Doctrine\DBAL\Platforms\MySqlPlatform');
22			$this->conn = $this->getMockBuilder('Doctrine\DBAL\Connection')
			0 ignored issues – show Bug introduced 2017-06-29 19:35 UTC by Report Bug Copy Issue Report The property `conn` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
23			->setMethods(array('fetchAll'))
24			->setConstructorArgs(array(array('platform' => $platform), $driverMock, new Configuration(), $eventManager))
25			->getMock();
26			$this->manager = new MySqlSchemaManager($this->conn);
27			}
28
29			public function testCompositeForeignKeys()
30			{
31			$this->conn->expects($this->once())->method('fetchAll')->will($this->returnValue($this->getFKDefinition()));
32			$fkeys = $this->manager->listTableForeignKeys('dummy');
33			$this->assertEquals(1, count($fkeys), "Table has to have one foreign key.");
34
35			$this->assertInstanceOf('Doctrine\DBAL\Schema\ForeignKeyConstraint', $fkeys[0]);
36			$this->assertEquals(array('column_1', 'column_2', 'column_3'), array_map('strtolower', $fkeys[0]->getLocalColumns()));
37			$this->assertEquals(array('column_1', 'column_2', 'column_3'), array_map('strtolower', $fkeys[0]->getForeignColumns()));
38			}
39
40			public function testPortableTableColumnDefinition()
41			{
42			$eventManager = new EventManager();
43			$driverMock = $this->createMock('Doctrine\DBAL\Driver');
44			$platform = new \Doctrine\DBAL\Platforms\MySqlPlatform();
45			$conn = $this->getMockBuilder('Doctrine\DBAL\Connection')
46			->setMethods(array('fetchAll'))
47			->setConstructorArgs(array(array('platform' => $platform), $driverMock, new Configuration(), $eventManager))
48			->getMock();
49			$this->manager = new MySqlSchemaManager($conn);
50
51
52			$conn->expects($this->once())->method('fetchAll')->will($this->returnValue($this->getColumnDefinition()));
53			$columns = $this->manager->listTableColumns('dummy');
54			$this->assertEquals(count($this->getColumnDefinition()), count($columns));
55			$this->assertTrue($columns['id']->getNotnull());
56			$this->assertNull($columns['id']->getDefault());
57			$this->assertFalse($columns['updated_at']->getNotnull());
58			$this->assertNull($columns['updated_at']->getDefault());
59			$this->assertFalse($columns['created_by']->getNotnull());
60			$this->assertNull($columns['created_by']->getDefault());
61			$this->assertEquals(null, $columns['text_2']->getDefault());
62			$this->assertEquals("'NULL'", $columns['text_1']->getDefault());
63
64			}
65
66			public function getColumnDefinition()
67			{
68			return [
69			[
70			'Field' => 'id',
71			'Type' => 'int(10) unsigned',
72			'Null' => 'NO',
73			'Key' => 'PRI',
74			'Default' => null,
75			'Extra' => 'auto_increment',
76			'Comment' => '',
77			'CharacterSet' => null,
78			'Collation' => null
79			],[
80			'Field'=> 'created_by',
81			'Type'=> 'varchar(40)',
82			'Null'=> 'YES',
83			'Key'=> '',
84			'Default'=> null, // MySQL 5.1 - 5.7 sends: null
85			'Extra' => '',
86			'Comment' => 'Creator name',
87			'CharacterSet' => 'utf8',
88			'Collation'=> 'utf8_unicode_ci'
89			],
90			// Mariadb since 10.2.7, see https://jira.mariadb.org/browse/MDEV-13341
91			[
92			'Field' => 'updated_at',
93			'Type' => 'datetime',
94			'Null' => 'YES',
95			'Key' => '',
96			'Default' => 'NULL', // MariaDB 10.2.7 return 'NULL'
			0 ignored issues – show Unused Code Comprehensibility introduced 2017-08-26 21:43 UTC by Report Bug Copy Issue Report `45%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
97			'Extra' => '',
98			'Comment' => 'Record last update timestamp',
99			'CharacterSet' => null,
100			'Collation' => null
101			],
102			// Mariadb 10.2 test with defaults that could be
103			// ambiguous (see text_1 and text_2 Default)
104			[
105			'Field' => 'text_1',
106			'Type' => 'varchar(50)',
107			'Null' => 'YES',
108			'Key' => '',
109			'Default' => "'NULL'",
110			'Extra' => '',
111			'Comment' => '',
112			'CharacterSet' => 'utf8',
113			'Collation'=> 'utf8_unicode_ci'
114			],[
115			'Field' => 'text_2',
116			'Type' => 'varchar(50)',
117			'Null' => 'YES',
118			'Key' => '',
119			'Default' => 'NULL',
120			'Extra' => '',
121			'Comment' => '',
122			'CharacterSet' => 'utf8',
123			'Collation'=> 'utf8_unicode_ci'
124			],
125
126
127			];
128
129			}
130
131
132			public function getFKDefinition()
133			{
134			return array(
135			array(
136			"CONSTRAINT_NAME" => "FK_C1B1712387FE737264DE5A5511B8B3E",
137			"COLUMN_NAME" => "column_1",
138			"REFERENCED_TABLE_NAME" => "dummy",
139			"REFERENCED_COLUMN_NAME" => "column_1",
140			"update_rule" => "RESTRICT",
141			"delete_rule" => "RESTRICT",
142			),
143			array(
144			"CONSTRAINT_NAME" => "FK_C1B1712387FE737264DE5A5511B8B3E",
145			"COLUMN_NAME" => "column_2",
146			"REFERENCED_TABLE_NAME" => "dummy",
147			"REFERENCED_COLUMN_NAME" => "column_2",
148			"update_rule" => "RESTRICT",
149			"delete_rule" => "RESTRICT",
150			),
151			array(
152			"CONSTRAINT_NAME" => "FK_C1B1712387FE737264DE5A5511B8B3E",
153			"COLUMN_NAME" => "column_3",
154			"REFERENCED_TABLE_NAME" => "dummy",
155			"REFERENCED_COLUMN_NAME" => "column_3",
156			"update_rule" => "RESTRICT",
157			"delete_rule" => "RESTRICT",
158			)
159			);
160			}
161			}
162

doctrine / dbal

Pull Request — master (#2825)

MySqlSchemaManagerTest::getColumnDefinition() A

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like