Fix bug and failing tests

SOHELAHMED7 · SOHELAHMED7 · commit d0415fbe03c6 · 2024-09-30T18:53:35.000+05:30
diff --git a/src/lib/migrations/PostgresMigrationBuilder.php b/src/lib/migrations/PostgresMigrationBuilder.php
@@ -266,10 +266,6 @@ public function handleCommentsMigration()
             if ($column->comment) {
                 $this->migration
                     ->addUpCode($this->recordBuilder->addCommentOnColumn($tableAlias, $column->name, $column->comment));
-            } else {
-                $this->migration
-                    ->addUpCode($this->recordBuilder->dropCommentOnColumn($tableAlias, $column->name))
-                ;
             }
         }
     }
diff --git a/tests/specs/blog/migrations_pgsql_db/m200000_000002_create_table_blog_posts.php b/tests/specs/blog/migrations_pgsql_db/m200000_000002_create_table_blog_posts.php
@@ -21,6 +21,8 @@ public function safeUp()
         $this->createIndex('blog_posts_slug_key', '{{%blog_posts}}', 'slug', true);
         $this->addForeignKey('fk_blog_posts_category_id_categories_id', '{{%blog_posts}}', 'category_id', '{{%categories}}', 'id');
         $this->addForeignKey('fk_blog_posts_created_by_id_users_id', '{{%blog_posts}}', 'created_by_id', '{{%users}}', 'id');
+        $this->addCommentOnColumn('{{%blog_posts}}', 'category_id', 'Category of posts');
+        $this->addCommentOnColumn('{{%blog_posts}}', 'created_by_id', 'The User');
     }
 
     public function safeDown()
diff --git a/tests/specs/blog/migrations_pgsql_db/m200000_000004_create_table_post_comments.php b/tests/specs/blog/migrations_pgsql_db/m200000_000004_create_table_post_comments.php
@@ -17,6 +17,8 @@ public function safeUp()
         ]);
         $this->addForeignKey('fk_post_comments_post_id_blog_posts_uid', '{{%post_comments}}', 'post_id', '{{%blog_posts}}', 'uid');
         $this->addForeignKey('fk_post_comments_author_id_users_id', '{{%post_comments}}', 'author_id', '{{%users}}', 'id');
+        $this->addCommentOnColumn('{{%post_comments}}', 'post_id', 'A blog post (uid used as pk for test purposes)');
+        $this->addCommentOnColumn('{{%post_comments}}', 'author_id', 'The User');
     }
 
     public function safeDown()
diff --git a/tests/specs/blog_v2/migrations_maria_db/m200000_000000_change_table_v2_posts.php b/tests/specs/blog_v2/migrations_maria_db/m200000_000000_change_table_v2_posts.php
@@ -10,9 +10,9 @@ public function up()
         $this->addColumn('{{%v2_posts}}', 'id', $this->bigPrimaryKey());
         $this->addColumn('{{%v2_posts}}', 'lang', 'enum("ru", "eng") NULL DEFAULT \'ru\' AFTER slug');
         $this->dropColumn('{{%v2_posts}}', 'uid');
-        $this->alterColumn('{{%v2_posts}}', 'category_id', $this->bigInteger()->notNull());
+        $this->alterColumn('{{%v2_posts}}', 'category_id', $this->bigInteger()->notNull()->comment('Category of posts'));
         $this->alterColumn('{{%v2_posts}}', 'active', $this->tinyInteger(1)->notNull());
-        $this->alterColumn('{{%v2_posts}}', 'created_by_id', $this->bigInteger()->null()->defaultValue(null));
+        $this->alterColumn('{{%v2_posts}}', 'created_by_id', $this->bigInteger()->null()->defaultValue(null)->comment('The User'));
         $this->dropIndex('v2_posts_slug_key', '{{%v2_posts}}');
     }
 
diff --git a/tests/specs/blog_v2/migrations_maria_db/m200000_000005_change_table_v2_comments.php b/tests/specs/blog_v2/migrations_maria_db/m200000_000005_change_table_v2_comments.php
@@ -11,6 +11,7 @@ public function up()
         $this->dropForeignKey('fk_v2_comments_author_id_v2_users_id', '{{%v2_comments}}');
         $this->addColumn('{{%v2_comments}}', 'user_id', $this->bigInteger()->null()->defaultValue(null)->after('post_id')->comment('The User'));
         $this->dropColumn('{{%v2_comments}}', 'author_id');
+        $this->alterColumn('{{%v2_comments}}', 'post_id', $this->bigInteger(20)->notNull()->comment('A blog post (uid used as pk for test purposes)'));
         $this->alterColumn('{{%v2_comments}}', 'message', $this->text()->notNull());
         $this->alterColumn('{{%v2_comments}}', 'meta_data', $this->string(300)->null()->defaultValue(''));
         $this->alterColumn('{{%v2_comments}}', 'created_at', $this->timestamp()->notNull());
@@ -25,6 +26,7 @@ public function down()
         $this->alterColumn('{{%v2_comments}}', 'created_at', $this->integer(11)->notNull());
         $this->alterColumn('{{%v2_comments}}', 'meta_data', 'json NOT NULL DEFAULT \'[]\'');
         $this->alterColumn('{{%v2_comments}}', 'message', 'json NOT NULL DEFAULT \'[]\'');
+        $this->alterColumn('{{%v2_comments}}', 'post_id', $this->bigInteger(20)->notNull());
         $this->addColumn('{{%v2_comments}}', 'author_id', $this->integer(11)->notNull());
         $this->dropColumn('{{%v2_comments}}', 'user_id');
         $this->addForeignKey('fk_v2_comments_author_id_v2_users_id', '{{%v2_comments}}', 'id', 'v2_users', 'author_id');
diff --git a/tests/specs/blog_v2/migrations_mysql_db/m200000_000000_change_table_v2_posts.php b/tests/specs/blog_v2/migrations_mysql_db/m200000_000000_change_table_v2_posts.php
@@ -10,9 +10,9 @@ public function up()
         $this->addColumn('{{%v2_posts}}', 'id', $this->bigPrimaryKey());
         $this->addColumn('{{%v2_posts}}', 'lang', 'enum("ru", "eng") NULL DEFAULT \'ru\' AFTER slug');
         $this->dropColumn('{{%v2_posts}}', 'uid');
-        $this->alterColumn('{{%v2_posts}}', 'category_id', $this->bigInteger()->notNull());
+        $this->alterColumn('{{%v2_posts}}', 'category_id', $this->bigInteger()->notNull()->comment('Category of posts'));
         $this->alterColumn('{{%v2_posts}}', 'active', $this->tinyInteger(1)->notNull());
-        $this->alterColumn('{{%v2_posts}}', 'created_by_id', $this->bigInteger()->null()->defaultValue(null));
+        $this->alterColumn('{{%v2_posts}}', 'created_by_id', $this->bigInteger()->null()->defaultValue(null)->comment('The User'));
         $this->dropIndex('v2_posts_slug_key', '{{%v2_posts}}');
     }
 
diff --git a/tests/specs/blog_v2/migrations_mysql_db/m200000_000005_change_table_v2_comments.php b/tests/specs/blog_v2/migrations_mysql_db/m200000_000005_change_table_v2_comments.php
@@ -11,6 +11,7 @@ public function up()
         $this->dropForeignKey('fk_v2_comments_author_id_v2_users_id', '{{%v2_comments}}');
         $this->addColumn('{{%v2_comments}}', 'user_id', $this->bigInteger()->null()->defaultValue(null)->after('post_id')->comment('The User'));
         $this->dropColumn('{{%v2_comments}}', 'author_id');
+        $this->alterColumn('{{%v2_comments}}', 'post_id', $this->bigInteger()->notNull()->comment('A blog post (uid used as pk for test purposes)'));
         $this->alterColumn('{{%v2_comments}}', 'message', $this->text()->notNull());
         $this->alterColumn('{{%v2_comments}}', 'meta_data', $this->string(300)->null()->defaultValue(''));
         $this->alterColumn('{{%v2_comments}}', 'created_at', $this->timestamp()->notNull());
@@ -25,6 +26,7 @@ public function down()
         $this->alterColumn('{{%v2_comments}}', 'created_at', $this->integer()->notNull());
         $this->alterColumn('{{%v2_comments}}', 'meta_data', 'json NOT NULL');
         $this->alterColumn('{{%v2_comments}}', 'message', 'json NOT NULL');
+        $this->alterColumn('{{%v2_comments}}', 'post_id', $this->bigInteger()->notNull());
         $this->addColumn('{{%v2_comments}}', 'author_id', $this->integer()->notNull());
         $this->dropColumn('{{%v2_comments}}', 'user_id');
         $this->addForeignKey('fk_v2_comments_author_id_v2_users_id', '{{%v2_comments}}', 'id', 'v2_users', 'author_id');
diff --git a/tests/specs/blog_v2/migrations_pgsql_db/m200000_000000_change_table_v2_posts.php b/tests/specs/blog_v2/migrations_pgsql_db/m200000_000000_change_table_v2_posts.php
@@ -12,15 +12,19 @@ public function safeUp()
         $this->addColumn('{{%v2_posts}}', 'lang', '"enum_itt_v2_posts_lang" NULL DEFAULT \'ru\'');
         $this->dropColumn('{{%v2_posts}}', 'uid');
         $this->alterColumn('{{%v2_posts}}', 'category_id', 'int8 NOT NULL USING "category_id"::int8');
+        $this->addCommentOnColumn('{{%v2_posts}}', 'category_id', 'Category of posts');
         $this->alterColumn('{{%v2_posts}}', 'active', "DROP DEFAULT");
         $this->alterColumn('{{%v2_posts}}', 'created_by_id', 'int8 NULL USING "created_by_id"::int8');
+        $this->addCommentOnColumn('{{%v2_posts}}', 'created_by_id', 'The User');
         $this->dropIndex('v2_posts_slug_key', '{{%v2_posts}}');
     }
 
     public function safeDown()
     {
         $this->createIndex('v2_posts_slug_key', '{{%v2_posts}}', 'slug', true);
+        $this->dropCommentFromColumn('{{%v2_posts}}', 'created_by_id');
         $this->alterColumn('{{%v2_posts}}', 'created_by_id', 'int4 NULL USING "created_by_id"::int4');
+        $this->dropCommentFromColumn('{{%v2_posts}}', 'category_id');
         $this->alterColumn('{{%v2_posts}}', 'category_id', 'int4 NOT NULL USING "category_id"::int4');
         $this->addColumn('{{%v2_posts}}', 'uid', $this->bigInteger()->notNull());
         $this->dropColumn('{{%v2_posts}}', 'lang');
diff --git a/tests/specs/blog_v2/migrations_pgsql_db/m200000_000005_change_table_v2_comments.php b/tests/specs/blog_v2/migrations_pgsql_db/m200000_000005_change_table_v2_comments.php
@@ -11,6 +11,7 @@ public function safeUp()
         $this->dropForeignKey('fk_v2_comments_post_id_v2_posts_uid', '{{%v2_comments}}');
         $this->addColumn('{{%v2_comments}}', 'user_id', $this->bigInteger()->null()->defaultValue(null)->comment('The User'));
         $this->dropColumn('{{%v2_comments}}', 'author_id');
+        $this->addCommentOnColumn('{{%v2_comments}}', 'post_id', 'A blog post (uid used as pk for test purposes)');
         $this->alterColumn('{{%v2_comments}}', 'message', 'text NOT NULL USING "message"::text');
         $this->alterColumn('{{%v2_comments}}', 'message', "DROP DEFAULT");
         $this->alterColumn('{{%v2_comments}}', 'meta_data', 'varchar(300) NULL USING "meta_data"::varchar');
@@ -28,6 +29,7 @@ public function safeDown()
         $this->alterColumn('{{%v2_comments}}', 'created_at', 'int4 NOT NULL USING "created_at"::int4');
         $this->alterColumn('{{%v2_comments}}', 'meta_data', 'jsonb NOT NULL USING "meta_data"::jsonb');
         $this->alterColumn('{{%v2_comments}}', 'message', 'jsonb NOT NULL USING "message"::jsonb');
+        $this->dropCommentFromColumn('{{%v2_comments}}', 'post_id');
         $this->addColumn('{{%v2_comments}}', 'author_id', $this->integer()->notNull());
         $this->dropColumn('{{%v2_comments}}', 'user_id');
         $this->alterColumn('{{%v2_comments}}', 'message', "SET DEFAULT '[]'");
diff --git a/tests/specs/issue_fix/60_description_of_a_property_in_spec_must_correspond_to_db_table_column_comment/pgsql/migrations_pgsql_db/m200000_000001_create_table_fruits.php b/tests/specs/issue_fix/60_description_of_a_property_in_spec_must_correspond_to_db_table_column_comment/pgsql/migrations_pgsql_db/m200000_000001_create_table_fruits.php
@@ -12,7 +12,6 @@ public function safeUp()
             'name' => $this->text()->null()->defaultValue(null)->comment('desc'),
             0 => '"description" double precision NULL DEFAULT NULL',
         ]);
-        $this->dropCommentFromColumn('{{%fruits}}', 'id');
         $this->addCommentOnColumn('{{%fruits}}', 'name', 'desc');
         $this->addCommentOnColumn('{{%fruits}}', 'description', 'desc 2');
     }
diff --git a/tests/specs/relations_in_faker/app/migrations_pgsql_db/m200000_000001_create_table_b123s.php b/tests/specs/relations_in_faker/app/migrations_pgsql_db/m200000_000001_create_table_b123s.php
@@ -13,6 +13,7 @@ public function safeUp()
             'c123_id' => $this->integer()->null()->defaultValue(null)->comment('desc'),
         ]);
         $this->addForeignKey('fk_b123s_c123_id_c123s_id', '{{%b123s}}', 'c123_id', '{{%c123s}}', 'id');
+        $this->addCommentOnColumn('{{%b123s}}', 'c123_id', 'desc');
     }
 
     public function safeDown()
diff --git a/tests/specs/relations_in_faker/app/migrations_pgsql_db/m200000_000002_create_table_a123s.php b/tests/specs/relations_in_faker/app/migrations_pgsql_db/m200000_000002_create_table_a123s.php
@@ -13,6 +13,7 @@ public function safeUp()
             'b123_id' => $this->integer()->null()->defaultValue(null)->comment('desc'),
         ]);
         $this->addForeignKey('fk_a123s_b123_id_b123s_id', '{{%a123s}}', 'b123_id', '{{%b123s}}', 'id');
+        $this->addCommentOnColumn('{{%a123s}}', 'b123_id', 'desc');
     }
 
     public function safeDown()
diff --git a/tests/specs/relations_in_faker/app/migrations_pgsql_db/m200000_000003_create_table_accounts.php b/tests/specs/relations_in_faker/app/migrations_pgsql_db/m200000_000003_create_table_accounts.php
@@ -11,6 +11,7 @@ public function safeUp()
             'id' => $this->primaryKey(),
             'name' => $this->string(40)->notNull()->comment('account name'),
         ]);
+        $this->addCommentOnColumn('{{%accounts}}', 'name', 'account name');
     }
 
     public function safeDown()
diff --git a/tests/specs/relations_in_faker/app/migrations_pgsql_db/m200000_000005_create_table_domains.php b/tests/specs/relations_in_faker/app/migrations_pgsql_db/m200000_000005_create_table_domains.php
@@ -14,6 +14,8 @@ public function safeUp()
             0 => '"created_at" timestamp NOT NULL',
         ]);
         $this->addForeignKey('fk_domains_account_id_accounts_id', '{{%domains}}', 'account_id', '{{%accounts}}', 'id');
+        $this->addCommentOnColumn('{{%domains}}', 'name', 'domain or sub-domain name, in DNS syntax, IDN are converted');
+        $this->addCommentOnColumn('{{%domains}}', 'account_id', 'user account');
     }
 
     public function safeDown()
diff --git a/tests/specs/relations_in_faker/app/migrations_pgsql_db/m200000_000006_create_table_e123s.php b/tests/specs/relations_in_faker/app/migrations_pgsql_db/m200000_000006_create_table_e123s.php
@@ -13,6 +13,7 @@ public function safeUp()
             'b123_id' => $this->integer()->null()->defaultValue(null)->comment('desc'),
         ]);
         $this->addForeignKey('fk_e123s_b123_id_b123s_id', '{{%e123s}}', 'b123_id', '{{%b123s}}', 'id');
+        $this->addCommentOnColumn('{{%e123s}}', 'b123_id', 'desc');
     }
 
     public function safeDown()
diff --git a/tests/specs/relations_in_faker/app/migrations_pgsql_db/m200000_000007_create_table_routings.php b/tests/specs/relations_in_faker/app/migrations_pgsql_db/m200000_000007_create_table_routings.php
@@ -21,6 +21,9 @@ public function safeUp()
         $this->addForeignKey('fk_routings_domain_id_domains_id', '{{%routings}}', 'domain_id', '{{%domains}}', 'id');
         $this->addForeignKey('fk_routings_d123_id_d123s_id', '{{%routings}}', 'd123_id', '{{%d123s}}', 'id');
         $this->addForeignKey('fk_routings_a123_id_a123s_id', '{{%routings}}', 'a123_id', '{{%a123s}}', 'id');
+        $this->addCommentOnColumn('{{%routings}}', 'domain_id', 'domain');
+        $this->addCommentOnColumn('{{%routings}}', 'd123_id', 'desc');
+        $this->addCommentOnColumn('{{%routings}}', 'a123_id', 'desc');
     }
 
     public function safeDown()
diff --git a/tests/specs/x_db_type/edit_column/pgsql/app/migrations_pgsql_db/m200000_000003_create_table_pristines.php b/tests/specs/x_db_type/edit_column/pgsql/app/migrations_pgsql_db/m200000_000003_create_table_pristines.php
@@ -21,6 +21,7 @@ public function safeUp()
             9 => '"col_11" text NULL DEFAULT NULL',
             10 => '"price" decimal(10,2) NULL DEFAULT 0',
         ]);
+        $this->addCommentOnColumn('{{%pristines}}', 'price', 'price in EUR');
     }
 
     public function safeDown()
diff --git a/tests/specs/x_db_type/fresh/pgsql/app/migrations_pgsql_db/m200000_000003_create_table_pristines.php b/tests/specs/x_db_type/fresh/pgsql/app/migrations_pgsql_db/m200000_000003_create_table_pristines.php
@@ -21,6 +21,7 @@ public function safeUp()
             9 => '"col_11" text NULL DEFAULT NULL',
             10 => '"price" decimal(10,2) NULL DEFAULT 0',
         ]);
+        $this->addCommentOnColumn('{{%pristines}}', 'price', 'price in EUR');
     }
 
     public function safeDown()
diff --git a/tests/specs/x_db_type/new_column/pgsql/app/migrations_pgsql_db/m200000_000003_create_table_pristines.php b/tests/specs/x_db_type/new_column/pgsql/app/migrations_pgsql_db/m200000_000003_create_table_pristines.php
@@ -21,6 +21,7 @@ public function safeUp()
             9 => '"col_11" text NULL DEFAULT NULL',
             10 => '"price" decimal(10,2) NULL DEFAULT 0',
         ]);
+        $this->addCommentOnColumn('{{%pristines}}', 'price', 'price in EUR');
     }
 
     public function safeDown()
diff --git a/tests/specs/x_on_x_fk_constraint/app/migrations_pgsql_db/m200000_000001_create_table_postxes.php b/tests/specs/x_on_x_fk_constraint/app/migrations_pgsql_db/m200000_000001_create_table_postxes.php
@@ -19,6 +19,10 @@ public function safeUp()
         $this->addForeignKey('fk_postxes_user_2_id_userxes_id', '{{%postxes}}', 'user_2_id', '{{%userxes}}', 'id', 'SET NULL', 'CASCADE');
         $this->addForeignKey('fk_postxes_user_3_id_userxes_id', '{{%postxes}}', 'user_3_id', '{{%userxes}}', 'id', 'SET NULL');
         $this->addForeignKey('fk_postxes_user_4_id_userxes_id', '{{%postxes}}', 'user_4_id', '{{%userxes}}', 'id');
+        $this->addCommentOnColumn('{{%postxes}}', 'user_id', 'x on-x (update|delete) foreign key constraint');
+        $this->addCommentOnColumn('{{%postxes}}', 'user_2_id', 'x on-x (update|delete) foreign key constraint');
+        $this->addCommentOnColumn('{{%postxes}}', 'user_3_id', 'x on-x (update|delete) foreign key constraint');
+        $this->addCommentOnColumn('{{%postxes}}', 'user_4_id', 'x on-x (update|delete) foreign key constraint');
     }
 
     public function safeDown()

Original file line number	Diff line number	Diff line change
`@@ -266,10 +266,6 @@ public function handleCommentsMigration()`
`266`	`266`	`if ($column->comment) {`
`267`	`267`	`$this->migration`
`268`	`268`	`->addUpCode($this->recordBuilder->addCommentOnColumn($tableAlias, $column->name, $column->comment));`
`269`		`- } else {`
`270`		`- $this->migration`
`271`		`- ->addUpCode($this->recordBuilder->dropCommentOnColumn($tableAlias, $column->name))`
`272`		`- ;`
`273`	`269`	`}`
`274`	`270`	`}`
`275`	`271`	`}`
Original file line number	Diff line number	Diff line change
`@@ -21,6 +21,8 @@ public function safeUp()`
`21`	`21`	`$this->createIndex('blog_posts_slug_key', '{{%blog_posts}}', 'slug', true);`
`22`	`22`	`$this->addForeignKey('fk_blog_posts_category_id_categories_id', '{{%blog_posts}}', 'category_id', '{{%categories}}', 'id');`
`23`	`23`	`$this->addForeignKey('fk_blog_posts_created_by_id_users_id', '{{%blog_posts}}', 'created_by_id', '{{%users}}', 'id');`
	`24`	`+ $this->addCommentOnColumn('{{%blog_posts}}', 'category_id', 'Category of posts');`
	`25`	`+ $this->addCommentOnColumn('{{%blog_posts}}', 'created_by_id', 'The User');`
`24`	`26`	`}`
`25`	`27`
`26`	`28`	`public function safeDown()`
Original file line number	Diff line number	Diff line change
`@@ -17,6 +17,8 @@ public function safeUp()`
`17`	`17`	`]);`
`18`	`18`	`$this->addForeignKey('fk_post_comments_post_id_blog_posts_uid', '{{%post_comments}}', 'post_id', '{{%blog_posts}}', 'uid');`
`19`	`19`	`$this->addForeignKey('fk_post_comments_author_id_users_id', '{{%post_comments}}', 'author_id', '{{%users}}', 'id');`
	`20`	`+ $this->addCommentOnColumn('{{%post_comments}}', 'post_id', 'A blog post (uid used as pk for test purposes)');`
	`21`	`+ $this->addCommentOnColumn('{{%post_comments}}', 'author_id', 'The User');`
`20`	`22`	`}`
`21`	`23`
`22`	`24`	`public function safeDown()`
Original file line number	Diff line number	Diff line change
`@@ -12,7 +12,6 @@ public function safeUp()`
`12`	`12`	`'name' => $this->text()->null()->defaultValue(null)->comment('desc'),`
`13`	`13`	`0 => '"description" double precision NULL DEFAULT NULL',`
`14`	`14`	`]);`
`15`		`- $this->dropCommentFromColumn('{{%fruits}}', 'id');`
`16`	`15`	`$this->addCommentOnColumn('{{%fruits}}', 'name', 'desc');`
`17`	`16`	`$this->addCommentOnColumn('{{%fruits}}', 'description', 'desc 2');`
`18`	`17`	`}`