<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[32770] trunk/tests/phpunit/tests/dbdelta.php: Improve dbDelta unit tests</title>
</head>
<body>

<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt;  }
#msg dl a { font-weight: bold}
#msg dl a:link    { color:#fc3; }
#msg dl a:active  { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff  {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/32770">32770</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/32770","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>jorbin</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2015-06-14 19:22:20 +0000 (Sun, 14 Jun 2015)</dd>
</dl>

<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>Improve dbDelta unit tests

Add new tests for more parts of dbDelta.  This was cleaned up and prepared for commit at #wcphilly contributor day.

Props jdgrimes, tryon, jtsternberg, ebinnion, JPry, avnarun, kevkoeh, jorbin, salcode.
Fixes <a href="https://core.trac.wordpress.org/ticket/29020">#29020</a>.</pre>

<h3>Modified Paths</h3>
<ul>
<li><a href="#trunktestsphpunittestsdbdeltaphp">trunk/tests/phpunit/tests/dbdelta.php</a></li>
</ul>

</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunktestsphpunittestsdbdeltaphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/tests/dbdelta.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/dbdelta.php     2015-06-14 19:20:12 UTC (rev 32769)
+++ trunk/tests/phpunit/tests/dbdelta.php       2015-06-14 19:22:20 UTC (rev 32770)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -8,19 +8,263 @@
</span><span class="cx" style="display: block; padding: 0 10px">  */
</span><span class="cx" style="display: block; padding: 0 10px"> class Tests_dbDelta extends WP_UnitTestCase {
</span><span class="cx" style="display: block; padding: 0 10px"> 
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-        function test_create_new_table() {
-               include_once( ABSPATH . 'wp-admin/includes/upgrade.php');
-               $table_name = 'test_new_table';
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+        * Make sure the upgrade code is loaded before the tests are run.
+        */
+       public static function setUpBeforeClass() {
</ins><span class="cx" style="display: block; padding: 0 10px"> 
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-                $create = "CREATE TABLE $table_name (\n a varchar(255)\n)";
-               $expected = array( $table_name => "Created table $table_name" );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+         parent::setUpBeforeClass();
</ins><span class="cx" style="display: block; padding: 0 10px"> 
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-                $actual = dbDelta( $create, false );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+         require_once( ABSPATH . 'wp-admin/includes/upgrade.php' );
+       }
</ins><span class="cx" style="display: block; padding: 0 10px"> 
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-                $this->assertSame( $expected, $actual );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+        * Create a custom table to be used in each test.
+        */
+       public function setUp() {
+
+               global $wpdb;
+
+               $wpdb->query(
+                       "
+                       CREATE TABLE {$wpdb->prefix}dbdelta_test (
+                               id bigint(20) NOT NULL AUTO_INCREMENT,
+                               column_1 varchar(255) NOT NULL,
+                               PRIMARY KEY  (id),
+                               KEY key_1 (column_1),
+                               KEY compoud_key (id,column_1)
+                       )
+                       "
+               );
+
+               parent::setUp();
</ins><span class="cx" style="display: block; padding: 0 10px">         }
</span><span class="cx" style="display: block; padding: 0 10px"> 
</span><span class="cx" style="display: block; padding: 0 10px">        /**
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+         * Delete the custom table on teardown.
+        */
+       public function tearDown() {
+
+               global $wpdb;
+
+               parent::tearDown();
+
+               $wpdb->query( "DROP TABLE IF EXISTS {$wpdb->prefix}dbdelta_test" );
+       }
+
+       /**
+        * Test table creation.
+        */
+       public function test_creating_a_table() {
+
+               remove_filter( 'query', array( $this, '_create_temporary_tables' ) );
+               remove_filter( 'query', array( $this, '_drop_temporary_tables' ) );
+
+               global $wpdb;
+
+               $updates = dbDelta(
+                       "CREATE TABLE {$wpdb->prefix}dbdelta_create_test (
+                               id bigint(20) NOT NULL AUTO_INCREMENT,
+                               column_1 varchar(255) NOT NULL,
+                               PRIMARY KEY  (id)
+                       );"
+               );
+
+               $expected = array(
+                       "{$wpdb->prefix}dbdelta_create_test" => "Created table {$wpdb->prefix}dbdelta_create_test"
+               );
+
+               $this->assertEquals( $expected, $updates );
+
+               $this->assertEquals(
+                       "{$wpdb->prefix}dbdelta_create_test"
+                       , $wpdb->get_var(
+                               $wpdb->prepare(
+                                       'SHOW TABLES LIKE %s'
+                                       , $wpdb->esc_like( "{$wpdb->prefix}dbdelta_create_test" )
+                               )
+                       )
+               );
+
+               $wpdb->query( "DROP TABLE {$wpdb->prefix}dbdelta_create_test" );
+       }
+
+       /**
+        * Test that it does nothing for an existing table.
+        */
+       public function test_existing_table() {
+
+               global $wpdb;
+
+               $updates = dbDelta(
+                       "
+                       CREATE TABLE {$wpdb->prefix}dbdelta_test (
+                               id bigint(20) NOT NULL AUTO_INCREMENT,
+                               column_1 varchar(255) NOT NULL,
+                               PRIMARY KEY  (id),
+                               KEY key_1 (column_1),
+                               KEY compoud_key (id,column_1)
+                       )
+                       "
+               );
+
+               $this->assertEquals( array(), $updates );
+       }
+
+       /**
+        * Test the column type is updated.
+        */
+       public function test_column_type_change() {
+
+               global $wpdb;
+
+               // id: bigint(20) => int(11)
+               $updates = dbDelta(
+                       "
+                       CREATE TABLE {$wpdb->prefix}dbdelta_test (
+                               id int(11) NOT NULL AUTO_INCREMENT,
+                               column_1 varchar(255) NOT NULL,
+                               PRIMARY KEY  (id),
+                               KEY key_1 (column_1),
+                               KEY compoud_key (id,column_1)
+                       )
+                       "
+               );
+
+               $this->assertEquals(
+                       array(
+                               "{$wpdb->prefix}dbdelta_test.id"
+                                       => "Changed type of {$wpdb->prefix}dbdelta_test.id from bigint(20) to int(11)"
+                       )
+                       , $updates
+               );
+       }
+
+       /**
+        * Test new column added.
+        */
+       public function test_column_added() {
+
+               global $wpdb;
+
+               $updates = dbDelta(
+                       "
+                       CREATE TABLE {$wpdb->prefix}dbdelta_test (
+                               id bigint(20) NOT NULL AUTO_INCREMENT,
+                               column_1 varchar(255) NOT NULL,
+                               extra_col longtext,
+                               PRIMARY KEY  (id),
+                               KEY key_1 (column_1),
+                               KEY compoud_key (id,column_1)
+                       )
+                       "
+               );
+
+               $this->assertEquals(
+                       array(
+                               "{$wpdb->prefix}dbdelta_test.extra_col"
+                                       => "Added column {$wpdb->prefix}dbdelta_test.extra_col"
+                       )
+                       , $updates
+               );
+
+               $this->assertTableHasColumn( 'column_1', $wpdb->prefix . 'dbdelta_test' );
+       }
+
+       /**
+        * Test that it does nothing when a column is removed.
+        *
+        * @ticket 26801
+        */
+       public function test_columns_arent_removed() {
+
+               global $wpdb;
+
+               // No column column_1
+               $updates = dbDelta(
+                       "
+                       CREATE TABLE {$wpdb->prefix}dbdelta_test (
+                               id bigint(20) NOT NULL AUTO_INCREMENT,
+                               PRIMARY KEY  (id),
+                               KEY key_1 (column_1),
+                               KEY compoud_key (id,column_1)
+                       )
+                       "
+               );
+
+               $this->assertEquals( array(), $updates );
+
+               $this->assertTableHasColumn( 'column_1', $wpdb->prefix . 'dbdelta_test' );
+       }
+
+       /**
+        * Test that nothing happens with $execute is false.
+        */
+       public function test_no_execution() {
+
+               global $wpdb;
+
+               // Added column extra_col
+               $updates = dbDelta(
+                       "
+                       CREATE TABLE {$wpdb->prefix}dbdelta_test (
+                               id bigint(20) NOT NULL AUTO_INCREMENT,
+                               column_1 varchar(255) NOT NULL,
+                               extra_col longtext,
+                               PRIMARY KEY  (id),
+                               KEY key_1 (column_1),
+                               KEY compoud_key (id,column_1)
+                       )
+                       "
+                       , false // Don't execute.
+               );
+
+               $this->assertEquals(
+                       array(
+                               "{$wpdb->prefix}dbdelta_test.extra_col"
+                                       => "Added column {$wpdb->prefix}dbdelta_test.extra_col"
+                       )
+                       , $updates
+               );
+
+               $this->assertTableHasNotColumn( 'extra_col', $wpdb->prefix . 'dbdelta_test' );
+       }
+
+       //
+       // Assertions.
+       //
+
+       /**
+        * Assert that a table has a column.
+        *
+        * @param string $column The field name.
+        * @param string $table  The database table name.
+        */
+       protected function assertTableHasColumn( $column, $table ) {
+
+               global $wpdb;
+
+               $table_fields = $wpdb->get_results( "DESCRIBE {$table}" );
+
+               $this->assertCount( 1, wp_list_filter( $table_fields, array( 'Field' => $column ) ) );
+       }
+
+       /**
+        * Assert that a table doesn't have a column.
+        *
+        * @param string $column The field name.
+        * @param string $table  The database table name.
+        */
+       protected function assertTableHasNotColumn( $column, $table ) {
+
+               global $wpdb;
+
+               $table_fields = $wpdb->get_results( "DESCRIBE {$table}" );
+
+               $this->assertCount( 0, wp_list_filter( $table_fields, array( 'Field' => $column ) ) );
+       }
+
+       /**
</ins><span class="cx" style="display: block; padding: 0 10px">          * @ticket 31869
</span><span class="cx" style="display: block; padding: 0 10px">         */
</span><span class="cx" style="display: block; padding: 0 10px">        function test_truncated_index() {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -30,7 +274,6 @@
</span><span class="cx" style="display: block; padding: 0 10px">                        $this->markTestSkipped( 'This test requires utf8mb4 support in MySQL.' );
</span><span class="cx" style="display: block; padding: 0 10px">                }
</span><span class="cx" style="display: block; padding: 0 10px"> 
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-                include_once( ABSPATH . 'wp-admin/includes/upgrade.php');
</del><span class="cx" style="display: block; padding: 0 10px">                 $table_name = 'test_truncated_index';
</span><span class="cx" style="display: block; padding: 0 10px"> 
</span><span class="cx" style="display: block; padding: 0 10px">                $create = "CREATE TABLE $table_name (\n a varchar(255) COLLATE utf8mb4_unicode_ci,\n KEY a (a)\n)";
</span></span></pre>
</div>
</div>

</body>
</html>