From b1b9cc145411924927ec78224dada9ab345f7925 Mon Sep 17 00:00:00 2001 From: KDH Date: Tue, 12 Oct 2021 11:23:09 +0900 Subject: [PATCH 1/5] Fix M2M table template --- aerich/ddl/__init__.py | 7 ++++++- aerich/ddl/mysql/__init__.py | 7 ++++++- tests/test_migrate.py | 4 ++-- 3 files changed, 14 insertions(+), 4 deletions(-) diff --git a/aerich/ddl/__init__.py b/aerich/ddl/__init__.py index 2818955..f4686ec 100644 --- a/aerich/ddl/__init__.py +++ b/aerich/ddl/__init__.py @@ -23,7 +23,12 @@ class BaseDDL: _DROP_INDEX_TEMPLATE = 'ALTER TABLE "{table_name}" DROP INDEX "{index_name}"' _ADD_FK_TEMPLATE = 'ALTER TABLE "{table_name}" ADD CONSTRAINT "{fk_name}" FOREIGN KEY ("{db_column}") REFERENCES "{table}" ("{field}") ON DELETE {on_delete}' _DROP_FK_TEMPLATE = 'ALTER TABLE "{table_name}" DROP FOREIGN KEY "{fk_name}"' - _M2M_TABLE_TEMPLATE = 'CREATE TABLE "{table_name}" ("{backward_key}" {backward_type} NOT NULL REFERENCES "{backward_table}" ("{backward_field}") ON DELETE CASCADE,"{forward_key}" {forward_type} NOT NULL REFERENCES "{forward_table}" ("{forward_field}") ON DELETE {on_delete}){extra}{comment}' + _M2M_TABLE_TEMPLATE = ( + 'CREATE TABLE "{table_name}" (' + ' "{backward_key}" {backward_type} NOT NULL REFERENCES "{backward_table}" ("{backward_field}") ON DELETE CASCADE,\n' + ' "{forward_key}" {forward_type} NOT NULL REFERENCES "{forward_table}" ("{forward_field}") ON DELETE {on_delete}\n' + "){extra}{comment}" + ) _MODIFY_COLUMN_TEMPLATE = 'ALTER TABLE "{table_name}" MODIFY COLUMN {column}' _CHANGE_COLUMN_TEMPLATE = ( 'ALTER TABLE "{table_name}" CHANGE {old_column_name} {new_column_name} {new_column_type}' diff --git a/aerich/ddl/mysql/__init__.py b/aerich/ddl/mysql/__init__.py index 0cce776..0c603ec 100644 --- a/aerich/ddl/mysql/__init__.py +++ b/aerich/ddl/mysql/__init__.py @@ -22,6 +22,11 @@ class MysqlDDL(BaseDDL): _DROP_INDEX_TEMPLATE = "ALTER TABLE `{table_name}` DROP INDEX `{index_name}`" _ADD_FK_TEMPLATE = "ALTER TABLE `{table_name}` ADD CONSTRAINT `{fk_name}` FOREIGN KEY (`{db_column}`) REFERENCES `{table}` (`{field}`) ON DELETE {on_delete}" _DROP_FK_TEMPLATE = "ALTER TABLE `{table_name}` DROP FOREIGN KEY `{fk_name}`" - _M2M_TABLE_TEMPLATE = "CREATE TABLE `{table_name}` (`{backward_key}` {backward_type} NOT NULL REFERENCES `{backward_table}` (`{backward_field}`) ON DELETE CASCADE,`{forward_key}` {forward_type} NOT NULL REFERENCES `{forward_table}` (`{forward_field}`) ON DELETE CASCADE){extra}{comment}" + _M2M_TABLE_TEMPLATE = ( + "CREATE TABLE `{table_name}` (\n" + " `{backward_key}` {backward_type} NOT NULL REFERENCES `{backward_table}` (`{backward_field}`) ON DELETE CASCADE,\n" + " `{forward_key}` {forward_type} NOT NULL REFERENCES `{forward_table}` (`{forward_field}`) ON DELETE CASCADE\n" + "){extra}{comment}" + ) _MODIFY_COLUMN_TEMPLATE = "ALTER TABLE `{table_name}` MODIFY COLUMN {column}" _RENAME_TABLE_TEMPLATE = "ALTER TABLE `{old_table_name}` RENAME TO `{new_table_name}`" diff --git a/tests/test_migrate.py b/tests/test_migrate.py index 76b7c3e..c666eae 100644 --- a/tests/test_migrate.py +++ b/tests/test_migrate.py @@ -807,7 +807,7 @@ def test_migrate(mocker: MockerFixture): "ALTER TABLE `user` MODIFY COLUMN `password` VARCHAR(100) NOT NULL", "CREATE TABLE IF NOT EXISTS `newmodel` (\n `id` INT NOT NULL PRIMARY KEY AUTO_INCREMENT,\n `name` VARCHAR(50) NOT NULL\n) CHARACTER SET utf8mb4;", "ALTER TABLE `user` ADD UNIQUE INDEX `uid_user_usernam_9987ab` (`username`)", - "CREATE TABLE `email_user` (`email_id` INT NOT NULL REFERENCES `email` (`email_id`) ON DELETE CASCADE,`user_id` INT NOT NULL REFERENCES `user` (`id`) ON DELETE CASCADE) CHARACTER SET utf8mb4", + "CREATE TABLE `email_user` (\n `email_id` INT NOT NULL REFERENCES `email` (`email_id`) ON DELETE CASCADE,\n `user_id` INT NOT NULL REFERENCES `user` (`id`) ON DELETE CASCADE\n) CHARACTER SET utf8mb4", ] ) @@ -853,7 +853,7 @@ def test_migrate(mocker: MockerFixture): 'ALTER TABLE "user" DROP COLUMN "avatar"', 'CREATE INDEX "idx_product_name_869427" ON "product" ("name", "type_db_alias")', 'CREATE INDEX "idx_email_email_4a1a33" ON "email" ("email")', - 'CREATE TABLE "email_user" ("email_id" INT NOT NULL REFERENCES "email" ("email_id") ON DELETE CASCADE,"user_id" INT NOT NULL REFERENCES "user" ("id") ON DELETE CASCADE)', + 'CREATE TABLE "email_user" (\n "email_id" INT NOT NULL REFERENCES "email" ("email_id") ON DELETE CASCADE,\n "user_id" INT NOT NULL REFERENCES "user" ("id") ON DELETE CASCADE\n)', 'CREATE TABLE IF NOT EXISTS "newmodel" (\n "id" SERIAL NOT NULL PRIMARY KEY,\n "name" VARCHAR(50) NOT NULL\n);\nCOMMENT ON COLUMN "config"."user_id" IS \'User\';', 'CREATE UNIQUE INDEX "uid_product_name_869427" ON "product" ("name", "type_db_alias")', 'CREATE UNIQUE INDEX "uid_user_usernam_9987ab" ON "user" ("username")', From 7a826df43fa887cdfdbe0092c03da2e1d15220c5 Mon Sep 17 00:00:00 2001 From: KDH Date: Tue, 12 Oct 2021 11:23:53 +0900 Subject: [PATCH 2/5] Fix duplicated semicolon in table creation DDL --- aerich/utils.py | 35 ++++++++++++++++------------------- tests/test_utils.py | 34 ++++++++++++++++++++++++++++++++++ 2 files changed, 50 insertions(+), 19 deletions(-) create mode 100644 tests/test_utils.py diff --git a/aerich/utils.py b/aerich/utils.py index c8bffdc..4e26719 100644 --- a/aerich/utils.py +++ b/aerich/utils.py @@ -110,25 +110,22 @@ def write_version_file(version_file: Path, content: Dict): :param content: :return: """ - with open(version_file, "w", encoding="utf-8") as f: - f.write(_UPGRADE) - upgrade = content.get("upgrade") - if len(upgrade) > 1: - f.write(";\n".join(upgrade)) - if not upgrade[-1].endswith(";"): - f.write(";\n") - else: - f.write(f"{upgrade[0]}") - if not upgrade[0].endswith(";"): - f.write(";") - f.write("\n") - downgrade = content.get("downgrade") - if downgrade: - f.write(_DOWNGRADE) - if len(downgrade) > 1: - f.write(";\n".join(downgrade) + ";\n") - else: - f.write(f"{downgrade[0]};\n") + + def append_ddl(ddl: str): + if not ddl.endswith(";"): + ddl += ";" + ddl += "\n" + data.append(ddl) + + data = [_UPGRADE] + for upgrade_ddl in content.get("upgrade"): + append_ddl(upgrade_ddl) + downgrade = content.get("downgrade") + if downgrade: + data.append(_DOWNGRADE) + for downgrade_ddl in downgrade: + append_ddl(downgrade_ddl) + version_file.write_text("".join(data)) def get_models_describe(app: str) -> Dict: diff --git a/tests/test_utils.py b/tests/test_utils.py new file mode 100644 index 0000000..fa1f02f --- /dev/null +++ b/tests/test_utils.py @@ -0,0 +1,34 @@ +import tempfile +from pathlib import Path + +from aerich.utils import write_version_file + + +def test_write_version_file(): + content = { + "upgrade": [ + "CREATE TABLE IF NOT EXISTS `newmodel` (\n `id` INT NOT NULL PRIMARY KEY AUTO_INCREMENT,\n `name` VARCHAR(50) NOT NULL\n) CHARACTER SET utf8mb4;", + "CREATE TABLE `email_user` (\n `email_id` INT NOT NULL REFERENCES `email` (`email_id`) ON DELETE CASCADE,\n `user_id` INT NOT NULL REFERENCES `user` (`id`) ON DELETE CASCADE\n) CHARACTER SET utf8mb4", + ], + "downgrade": [ + "DROP TABLE IF EXISTS `email_user`", + "DROP TABLE IF EXISTS `newmodel`", + ], + } + with tempfile.NamedTemporaryFile(mode="r", delete=True) as f: + write_version_file(Path(f.name), content) + result = f.read() + assert result == ( + "-- upgrade --\n" + "CREATE TABLE IF NOT EXISTS `newmodel` (\n" + " `id` INT NOT NULL PRIMARY KEY AUTO_INCREMENT,\n" + " `name` VARCHAR(50) NOT NULL\n" + ") CHARACTER SET utf8mb4;\n" + "CREATE TABLE `email_user` (\n" + " `email_id` INT NOT NULL REFERENCES `email` (`email_id`) ON DELETE CASCADE,\n" + " `user_id` INT NOT NULL REFERENCES `user` (`id`) ON DELETE CASCADE\n" + ") CHARACTER SET utf8mb4;\n" + "-- downgrade --\n" + "DROP TABLE IF EXISTS `email_user`;\n" + "DROP TABLE IF EXISTS `newmodel`;\n" + ) From 1f0a6dfb50c92cf1adf9fd73533347dc61396365 Mon Sep 17 00:00:00 2001 From: KDH Date: Fri, 16 Sep 2022 09:58:04 +0900 Subject: [PATCH 3/5] Fix typo --- tests/test_migrate.py | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/tests/test_migrate.py b/tests/test_migrate.py index 9a92271..a87663c 100644 --- a/tests/test_migrate.py +++ b/tests/test_migrate.py @@ -802,7 +802,7 @@ def test_migrate(mocker: MockerFixture): Migrate.diff_models(models_describe, old_models_describe, False) Migrate._merge_operators() if isinstance(Migrate.ddl, MysqlDDL): - expected_upgrade_operators = set( + expected_upgrade_operators = { "ALTER TABLE `category` MODIFY COLUMN `name` VARCHAR(200)", "ALTER TABLE `category` MODIFY COLUMN `slug` VARCHAR(100) NOT NULL", "ALTER TABLE `config` ADD `user_id` INT NOT NULL COMMENT 'User'", @@ -834,8 +834,8 @@ def test_migrate(mocker: MockerFixture): "ALTER TABLE `category` MODIFY COLUMN `created_at` DATETIME(6) NOT NULL DEFAULT CURRENT_TIMESTAMP(6)", "ALTER TABLE `product` MODIFY COLUMN `body` LONGTEXT NOT NULL", "ALTER TABLE `email` MODIFY COLUMN `is_primary` BOOL NOT NULL DEFAULT 0", - ) - expected_downgrade_operators = set( + } + expected_downgrade_operators = { "ALTER TABLE `category` MODIFY COLUMN `name` VARCHAR(200) NOT NULL", "ALTER TABLE `category` MODIFY COLUMN `slug` VARCHAR(200) NOT NULL", "ALTER TABLE `config` DROP COLUMN `user_id`", @@ -866,7 +866,7 @@ def test_migrate(mocker: MockerFixture): "ALTER TABLE `user` MODIFY COLUMN `longitude` DECIMAL(12,9) NOT NULL", "ALTER TABLE `product` MODIFY COLUMN `body` LONGTEXT NOT NULL", "ALTER TABLE `email` MODIFY COLUMN `is_primary` BOOL NOT NULL DEFAULT 0", - ) + } assert not set(Migrate.upgrade_operators).symmetric_difference(expected_upgrade_operators) assert not set(Migrate.downgrade_operators).symmetric_difference( @@ -874,7 +874,7 @@ def test_migrate(mocker: MockerFixture): ) elif isinstance(Migrate.ddl, PostgresDDL): - expected_upgrade_operators = set( + expected_upgrade_operators = { 'ALTER TABLE "category" ALTER COLUMN "name" DROP NOT NULL', 'ALTER TABLE "category" ALTER COLUMN "slug" TYPE VARCHAR(100) USING "slug"::VARCHAR(100)', 'ALTER TABLE "category" ALTER COLUMN "created_at" TYPE TIMESTAMPTZ USING "created_at"::TIMESTAMPTZ', @@ -905,8 +905,8 @@ def test_migrate(mocker: MockerFixture): 'CREATE TABLE IF NOT EXISTS "newmodel" (\n "id" SERIAL NOT NULL PRIMARY KEY,\n "name" VARCHAR(50) NOT NULL\n);\nCOMMENT ON COLUMN "config"."user_id" IS \'User\';', 'CREATE UNIQUE INDEX "uid_product_name_869427" ON "product" ("name", "type_db_alias")', 'CREATE UNIQUE INDEX "uid_user_usernam_9987ab" ON "user" ("username")', - ) - expected_downgrade_operators = set( + } + expected_downgrade_operators = { 'ALTER TABLE "category" ALTER COLUMN "name" SET NOT NULL', 'ALTER TABLE "category" ALTER COLUMN "slug" TYPE VARCHAR(200) USING "slug"::VARCHAR(200)', 'ALTER TABLE "category" ALTER COLUMN "created_at" TYPE TIMESTAMPTZ USING "created_at"::TIMESTAMPTZ', @@ -937,7 +937,7 @@ def test_migrate(mocker: MockerFixture): 'DROP INDEX "uid_product_name_869427"', 'DROP TABLE IF EXISTS "email_user"', 'DROP TABLE IF EXISTS "newmodel"', - ) + } assert not set(Migrate.upgrade_operators).symmetric_difference(expected_upgrade_operators) assert not set(Migrate.downgrade_operators).symmetric_difference( expected_downgrade_operators From 7b472d7a8442dec3fc0e9ed5362baf5d73a11fd1 Mon Sep 17 00:00:00 2001 From: KDH Date: Fri, 16 Sep 2022 10:08:34 +0900 Subject: [PATCH 4/5] Fix testcase --- tests/test_migrate.py | 1 - 1 file changed, 1 deletion(-) diff --git a/tests/test_migrate.py b/tests/test_migrate.py index a87663c..a3ccbb8 100644 --- a/tests/test_migrate.py +++ b/tests/test_migrate.py @@ -811,7 +811,6 @@ def test_migrate(mocker: MockerFixture): "ALTER TABLE `config` MODIFY COLUMN `value` JSON NOT NULL", "ALTER TABLE `email` ADD `address` VARCHAR(200) NOT NULL", "ALTER TABLE `email` DROP COLUMN `user_id`", - "CREATE TABLE `email_user` (`email_id` INT NOT NULL REFERENCES `email` (`email_id`) ON DELETE CASCADE,`user_id` INT NOT NULL REFERENCES `user` (`id`) ON DELETE CASCADE) CHARACTER SET utf8mb4", "ALTER TABLE `configs` RENAME TO `config`", "ALTER TABLE `product` RENAME COLUMN `image` TO `pic`", "ALTER TABLE `email` RENAME COLUMN `id` TO `email_id`", From bef45941f2f2a0001c4858633062260e0de6c86d Mon Sep 17 00:00:00 2001 From: KDH Date: Fri, 16 Sep 2022 10:26:21 +0900 Subject: [PATCH 5/5] Fix testcase --- aerich/ddl/__init__.py | 6 +++--- aerich/ddl/mysql/__init__.py | 4 ++-- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/aerich/ddl/__init__.py b/aerich/ddl/__init__.py index 7767c31..d8a1595 100644 --- a/aerich/ddl/__init__.py +++ b/aerich/ddl/__init__.py @@ -24,9 +24,9 @@ class BaseDDL: _ADD_FK_TEMPLATE = 'ALTER TABLE "{table_name}" ADD CONSTRAINT "{fk_name}" FOREIGN KEY ("{db_column}") REFERENCES "{table}" ("{field}") ON DELETE {on_delete}' _DROP_FK_TEMPLATE = 'ALTER TABLE "{table_name}" DROP FOREIGN KEY "{fk_name}"' _M2M_TABLE_TEMPLATE = ( - 'CREATE TABLE "{table_name}" (' - ' "{backward_key}" {backward_type} NOT NULL REFERENCES "{backward_table}" ("{backward_field}") ON DELETE CASCADE,\n' - ' "{forward_key}" {forward_type} NOT NULL REFERENCES "{forward_table}" ("{forward_field}") ON DELETE {on_delete}\n' + 'CREATE TABLE "{table_name}" (\n' + ' "{backward_key}" {backward_type} NOT NULL REFERENCES "{backward_table}" ("{backward_field}") ON DELETE CASCADE,\n' + ' "{forward_key}" {forward_type} NOT NULL REFERENCES "{forward_table}" ("{forward_field}") ON DELETE {on_delete}\n' "){extra}{comment}" ) _MODIFY_COLUMN_TEMPLATE = 'ALTER TABLE "{table_name}" MODIFY COLUMN {column}' diff --git a/aerich/ddl/mysql/__init__.py b/aerich/ddl/mysql/__init__.py index 0c603ec..2eea288 100644 --- a/aerich/ddl/mysql/__init__.py +++ b/aerich/ddl/mysql/__init__.py @@ -24,8 +24,8 @@ class MysqlDDL(BaseDDL): _DROP_FK_TEMPLATE = "ALTER TABLE `{table_name}` DROP FOREIGN KEY `{fk_name}`" _M2M_TABLE_TEMPLATE = ( "CREATE TABLE `{table_name}` (\n" - " `{backward_key}` {backward_type} NOT NULL REFERENCES `{backward_table}` (`{backward_field}`) ON DELETE CASCADE,\n" - " `{forward_key}` {forward_type} NOT NULL REFERENCES `{forward_table}` (`{forward_field}`) ON DELETE CASCADE\n" + " `{backward_key}` {backward_type} NOT NULL REFERENCES `{backward_table}` (`{backward_field}`) ON DELETE CASCADE,\n" + " `{forward_key}` {forward_type} NOT NULL REFERENCES `{forward_table}` (`{forward_field}`) ON DELETE CASCADE\n" "){extra}{comment}" ) _MODIFY_COLUMN_TEMPLATE = "ALTER TABLE `{table_name}` MODIFY COLUMN {column}"