feat: Move alembic config into mealie package for easier distribution (…

…#4329)
mealie-recipes · Dec 4, 2024 · a6cbf13 · a6cbf13
1 parent f1e9615
commit a6cbf13
Show file tree

Hide file tree

Showing 48 changed files with 24 additions and 37 deletions.
diff --git a/Taskfile.yml b/Taskfile.yml
@@ -151,7 +151,7 @@ tasks:
   py:migrate:
     desc: generates a new database migration file e.g. task py:migrate -- "add new column"
     cmds:
-      - poetry run alembic revision --autogenerate -m "{{ .CLI_ARGS }}"
+      - poetry run alembic --config mealie/alembic/alembic.ini revision --autogenerate -m "{{ .CLI_ARGS }}"
       - task: py:format
 
   ui:build:

diff --git a/docker/Dockerfile b/docker/Dockerfile
@@ -109,10 +109,6 @@ COPY --from=crfpp /usr/local/bin/crf_test /usr/local/bin/crf_test
 COPY ./mealie $MEALIE_HOME/mealie
 COPY ./poetry.lock ./pyproject.toml $MEALIE_HOME/
 
-# Alembic
-COPY ./alembic $MEALIE_HOME/alembic
-COPY ./alembic.ini $MEALIE_HOME/
-
 # venv already has runtime deps installed we get a quicker install
 WORKDIR $MEALIE_HOME
 RUN . $VENV_PATH/bin/activate && poetry install -E pgsql --only main

diff --git a/alembic/README → mealie/alembic/README b/alembic/README → mealie/alembic/README
diff --git a/alembic.ini → mealie/alembic/alembic.ini b/alembic.ini → mealie/alembic/alembic.ini
@@ -2,7 +2,7 @@
 
 [alembic]
 # path to migration scripts
-script_location = alembic
+script_location = %(here)s
 
 # template used to generate migration files
 file_template = %%(year)d-%%(month).2d-%%(day).2d-%%(hour).2d.%%(minute).2d.%%(second).2d_%%(rev)s_%%(slug)s

diff --git a/alembic/env.py → mealie/alembic/env.py b/alembic/env.py → mealie/alembic/env.py
@@ -1,9 +1,9 @@
 from typing import Any
 
 import sqlalchemy as sa
+from alembic import context
 
 import mealie.db.models._all_models  # noqa: F401
-from alembic import context
 from mealie.core.config import get_app_settings
 from mealie.db.models._model_base import SqlAlchemyBase
 

diff --git a/alembic/script.py.mako → mealie/alembic/script.py.mako b/alembic/script.py.mako → mealie/alembic/script.py.mako
@@ -6,9 +6,9 @@ Create Date: ${create_date}
 
 """
 import sqlalchemy as sa
+from alembic import op
 
 import mealie.db.migration_types
-from alembic import op
 % if imports:
 ${imports}
 % endif

diff --git a/...1-19.56.24_6b0f5f32d602_initial_tables.py → ...1-19.56.24_6b0f5f32d602_initial_tables.py b/...1-19.56.24_6b0f5f32d602_initial_tables.py → ...1-19.56.24_6b0f5f32d602_initial_tables.py
diff --git a/...convert_quantity_from_integer_to_float.py → ...convert_quantity_from_integer_to_float.py b/...convert_quantity_from_integer_to_float.py → ...convert_quantity_from_integer_to_float.py
diff --git a/...9_add_original_text_column_to_recipes_.py → ...9_add_original_text_column_to_recipes_.py b/...9_add_original_text_column_to_recipes_.py → ...9_add_original_text_column_to_recipes_.py
diff --git a/....55_59eb59135381_add_tags_to_cookbooks.py → ....55_59eb59135381_add_tags_to_cookbooks.py b/....55_59eb59135381_add_tags_to_cookbooks.py → ....55_59eb59135381_add_tags_to_cookbooks.py
diff --git a/...2_add_require_all_for_cookbook_filters.py → ...2_add_require_all_for_cookbook_filters.py b/...2_add_require_all_for_cookbook_filters.py → ...2_add_require_all_for_cookbook_filters.py
diff --git a/...02578f_add_use_abbreviation_column_to_.py → ...02578f_add_use_abbreviation_column_to_.py b/...02578f_add_use_abbreviation_column_to_.py → ...02578f_add_use_abbreviation_column_to_.py
diff --git a/...34_f30cf048c228_add_new_webhook_fields.py → ...34_f30cf048c228_add_new_webhook_fields.py b/...34_f30cf048c228_add_new_webhook_fields.py → ...34_f30cf048c228_add_new_webhook_fields.py
diff --git a/...add_login_attemps_and_locked_at_field_.py → ...add_login_attemps_and_locked_at_field_.py b/...add_login_attemps_and_locked_at_field_.py → ...add_login_attemps_and_locked_at_field_.py
diff --git a/...ed_add_is_ocr_recipe_column_to_recipes.py → ...ed_add_is_ocr_recipe_column_to_recipes.py b/...ed_add_is_ocr_recipe_column_to_recipes.py → ...ed_add_is_ocr_recipe_column_to_recipes.py
diff --git a/...d_extras_to_shopping_lists_list_items_.py → ...d_extras_to_shopping_lists_list_items_.py b/...d_extras_to_shopping_lists_list_items_.py → ...d_extras_to_shopping_lists_list_items_.py
diff --git a/...7915c_add_recipe_timeline_events_table.py → ...7915c_add_recipe_timeline_events_table.py b/...7915c_add_recipe_timeline_events_table.py → ...7915c_add_recipe_timeline_events_table.py
diff --git a/...ad_renamed_timeline_event_message_and_.py → ...ad_renamed_timeline_event_message_and_.py b/...ad_renamed_timeline_event_message_and_.py → ...ad_renamed_timeline_event_message_and_.py
diff --git a/...dd_recipe_scale_to_shopping_list_item_.py → ...dd_recipe_scale_to_shopping_list_item_.py b/...dd_recipe_scale_to_shopping_list_item_.py → ...dd_recipe_scale_to_shopping_list_item_.py
diff --git a/...d943c64ee_add_related_user_to_mealplan.py → ...d943c64ee_add_related_user_to_mealplan.py b/...d943c64ee_add_related_user_to_mealplan.py → ...d943c64ee_add_related_user_to_mealplan.py
diff --git a/...a7a_add_missing_foreign_key_and_order_.py → ...a7a_add_missing_foreign_key_and_order_.py b/...a7a_add_missing_foreign_key_and_order_.py → ...a7a_add_missing_foreign_key_and_order_.py
diff --git a/..._add_more_indices_necessary_for_search.py → ..._add_more_indices_necessary_for_search.py b/..._add_more_indices_necessary_for_search.py → ..._add_more_indices_necessary_for_search.py
diff --git a/...474eb_add_normalized_search_properties.py → ...474eb_add_normalized_search_properties.py b/...474eb_add_normalized_search_properties.py → ...474eb_add_normalized_search_properties.py
diff --git a/...108_added_shopping_list_label_settings.py → ...108_added_shopping_list_label_settings.py b/...108_added_shopping_list_label_settings.py → ...108_added_shopping_list_label_settings.py
diff --git a/...4b39a824_add_auth_method_to_user_table.py → ...4b39a824_add_auth_method_to_user_table.py b/...4b39a824_add_auth_method_to_user_table.py → ...4b39a824_add_auth_method_to_user_table.py
diff --git a/....04_b3dbb554ba53_postgres_fuzzy_search.py → ....04_b3dbb554ba53_postgres_fuzzy_search.py b/....04_b3dbb554ba53_postgres_fuzzy_search.py → ....04_b3dbb554ba53_postgres_fuzzy_search.py
diff --git a/...21.00.34_04ac51cbe9a4_added_group_slug.py → ...21.00.34_04ac51cbe9a4_added_group_slug.py b/...21.00.34_04ac51cbe9a4_added_group_slug.py → ...21.00.34_04ac51cbe9a4_added_group_slug.py
diff --git a/...03_added_recipe_note_to_shopping_list_.py → ...03_added_recipe_note_to_shopping_list_.py b/...03_added_recipe_note_to_shopping_list_.py → ...03_added_recipe_note_to_shopping_list_.py
diff --git a/...7355_remove_tool_name_and_slug_unique_.py → ...7355_remove_tool_name_and_slug_unique_.py b/...7355_remove_tool_name_and_slug_unique_.py → ...7355_remove_tool_name_and_slug_unique_.py
diff --git a/...a_added_normalized_unit_and_food_names.py → ...a_added_normalized_unit_and_food_names.py b/...a_added_normalized_unit_and_food_names.py → ...a_added_normalized_unit_and_food_names.py
diff --git a/..._dded3119c1fe_added_unique_constraints.py → ..._dded3119c1fe_added_unique_constraints.py b/..._dded3119c1fe_added_unique_constraints.py → ..._dded3119c1fe_added_unique_constraints.py
diff --git a/...ded_plural_names_and_alias_tables_for_.py → ...ded_plural_names_and_alias_tables_for_.py b/...ded_plural_names_and_alias_tables_for_.py → ...ded_plural_names_and_alias_tables_for_.py
diff --git a/...98bb460ffd_added_user_to_shopping_list.py → ...98bb460ffd_added_user_to_shopping_list.py b/...98bb460ffd_added_user_to_shopping_list.py → ...98bb460ffd_added_user_to_shopping_list.py
@@ -9,10 +9,10 @@
 from uuid import UUID
 
 import sqlalchemy as sa
+from alembic import op
 from sqlalchemy import orm
 
 import mealie.db.migration_types
-from alembic import op
 from mealie.core.root_logger import get_logger
 
 logger = get_logger()

diff --git a/...8.32_09aba125b57a_add_oidc_auth_method.py → ...8.32_09aba125b57a_add_oidc_auth_method.py b/...8.32_09aba125b57a_add_oidc_auth_method.py → ...8.32_09aba125b57a_add_oidc_auth_method.py
diff --git a/...migrate_favorites_and_ratings_to_user_.py → ...migrate_favorites_and_ratings_to_user_.py b/...migrate_favorites_and_ratings_to_user_.py → ...migrate_favorites_and_ratings_to_user_.py
@@ -12,10 +12,10 @@
 from uuid import uuid4
 
 import sqlalchemy as sa
+from alembic import op
 from sqlalchemy import orm
 
 import mealie.db.migration_types
-from alembic import op
 
 # revision identifiers, used by Alembic.
 revision = "d7c6efd2de42"

diff --git a/..._7788478a0338_add_group_recipe_actions.py → ..._7788478a0338_add_group_recipe_actions.py b/..._7788478a0338_add_group_recipe_actions.py → ..._7788478a0338_add_group_recipe_actions.py
@@ -7,9 +7,9 @@
 """
 
 import sqlalchemy as sa
+from alembic import op
 
 import mealie.db.migration_types
-from alembic import op
 
 # revision identifiers, used by Alembic.
 revision = "7788478a0338"

diff --git a/..._32d69327997b_add_staple_flag_to_foods.py → ..._32d69327997b_add_staple_flag_to_foods.py b/..._32d69327997b_add_staple_flag_to_foods.py → ..._32d69327997b_add_staple_flag_to_foods.py
@@ -7,9 +7,8 @@
 """
 
 import sqlalchemy as sa
-from sqlalchemy import orm
-
 from alembic import op
+from sqlalchemy import orm
 
 # revision identifiers, used by Alembic.
 revision = "32d69327997b"

diff --git a/...2-16.16.29_feecc8ffb956_add_households.py → ...2-16.16.29_feecc8ffb956_add_households.py b/...2-16.16.29_feecc8ffb956_add_households.py → ...2-16.16.29_feecc8ffb956_add_households.py
@@ -12,11 +12,11 @@
 from uuid import uuid4
 
 import sqlalchemy as sa
+from alembic import op
 from slugify import slugify
 from sqlalchemy import orm
 
 import mealie.db.migration_types
-from alembic import op
 from mealie.core.config import get_app_settings
 
 # revision identifiers, used by Alembic.

diff --git a/...ded_household_recipe_lock_setting_and_.py → ...ded_household_recipe_lock_setting_and_.py b/...ded_household_recipe_lock_setting_and_.py → ...ded_household_recipe_lock_setting_and_.py
@@ -9,7 +9,6 @@
 from textwrap import dedent
 
 import sqlalchemy as sa
-
 from alembic import op
 
 # revision identifiers, used by Alembic.

diff --git a/...c8_add_households_filter_to_meal_plans.py → ...c8_add_households_filter_to_meal_plans.py b/...c8_add_households_filter_to_meal_plans.py → ...c8_add_households_filter_to_meal_plans.py
@@ -7,9 +7,9 @@
 """
 
 import sqlalchemy as sa
+from alembic import op
 
 import mealie.db.migration_types
-from alembic import op
 
 # revision identifiers, used by Alembic.
 revision = "1fe4bd37ccc8"

diff --git a/...e1013e_add_the_rest_of_the_schema_org_.py → ...e1013e_add_the_rest_of_the_schema_org_.py b/...e1013e_add_the_rest_of_the_schema_org_.py → ...e1013e_add_the_rest_of_the_schema_org_.py
@@ -7,7 +7,6 @@
 """
 
 import sqlalchemy as sa
-
 from alembic import op
 
 # revision identifiers, used by Alembic.

diff --git a/...added_query_filter_string_to_cookbook_.py → ...added_query_filter_string_to_cookbook_.py b/...added_query_filter_string_to_cookbook_.py → ...added_query_filter_string_to_cookbook_.py
@@ -7,9 +7,9 @@
 """
 
 import sqlalchemy as sa
+from alembic import op
 from sqlalchemy import orm
 
-from alembic import op
 from mealie.db.models._model_utils import guid
 
 # revision identifiers, used by Alembic.

diff --git a/...631_add_summary_to_recipe_instructions.py → ...631_add_summary_to_recipe_instructions.py b/...631_add_summary_to_recipe_instructions.py → ...631_add_summary_to_recipe_instructions.py
@@ -7,7 +7,6 @@
 """
 
 import sqlalchemy as sa
-
 from alembic import op
 
 # revision identifiers, used by Alembic.

diff --git a/...b1020f328e98_add_recipe_yield_quantity.py → ...b1020f328e98_add_recipe_yield_quantity.py b/...b1020f328e98_add_recipe_yield_quantity.py → ...b1020f328e98_add_recipe_yield_quantity.py
@@ -7,9 +7,9 @@
 """
 
 import sqlalchemy as sa
+from alembic import op
 from sqlalchemy import orm
 
-from alembic import op
 from mealie.db.models._model_utils.guid import GUID
 from mealie.services.scraper.cleaner import clean_yield
 

diff --git a/mealie/db/init_db.py b/mealie/db/init_db.py
@@ -3,11 +3,11 @@
 from pathlib import Path
 from time import sleep
 
-from sqlalchemy import engine, orm, text
-
 from alembic import command, config, script
 from alembic.config import Config
 from alembic.runtime import migration
+from sqlalchemy import engine, orm, text
+
 from mealie.core import root_logger
 from mealie.core.config import get_app_settings
 from mealie.db.db_setup import session_context
@@ -22,7 +22,7 @@
 from mealie.services.group_services.group_service import GroupService
 from mealie.services.household_services.household_service import HouseholdService
 
-PROJECT_DIR = Path(__file__).parent.parent.parent
+ALEMBIC_DIR = Path(__file__).parent.parent / "alembic"
 
 logger = root_logger.get_logger()
 
@@ -101,7 +101,7 @@ def main():
             if max_retry == 0:
                 raise ConnectionError("Database connection failed - exiting application.")
 
-        alembic_cfg_path = os.getenv("ALEMBIC_CONFIG_FILE", default=str(PROJECT_DIR / "alembic.ini"))
+        alembic_cfg_path = os.getenv("ALEMBIC_CONFIG_FILE", default=str(ALEMBIC_DIR / "alembic.ini"))
 
         if not os.path.isfile(alembic_cfg_path):
             raise Exception("Provided alembic config path doesn't exist")

diff --git a/mealie/services/backups_v2/alchemy_exporter.py b/mealie/services/backups_v2/alchemy_exporter.py
@@ -3,25 +3,23 @@
 import uuid
 from logging import Logger
 from os import path
-from pathlib import Path
 from textwrap import dedent
 from typing import Any
 
+from alembic import command
+from alembic.config import Config
 from fastapi.encoders import jsonable_encoder
 from pydantic import BaseModel
 from sqlalchemy import Connection, ForeignKey, ForeignKeyConstraint, MetaData, Table, create_engine, insert, text
 from sqlalchemy.engine import base
 from sqlalchemy.orm import sessionmaker
 
-from alembic import command
-from alembic.config import Config
 from mealie.db import init_db
 from mealie.db.fixes.fix_migration_data import fix_migration_data
+from mealie.db.init_db import ALEMBIC_DIR
 from mealie.db.models._model_utils.guid import GUID
 from mealie.services._base_service import BaseService
 
-PROJECT_DIR = Path(__file__).parent.parent.parent.parent
-
 
 class ForeignKeyDisabler:
     def __init__(self, connection: Connection, dialect_name: str, *, logger: Logger | None = None):
@@ -193,15 +191,12 @@ def restore(self, db_dump: dict) -> None:
         alembic_data = db_dump["alembic_version"]
         alembic_version = alembic_data[0]["version_num"]
 
-        alembic_cfg_path = os.getenv("ALEMBIC_CONFIG_FILE", default=str(PROJECT_DIR / "alembic.ini"))
+        alembic_cfg_path = os.getenv("ALEMBIC_CONFIG_FILE", default=str(ALEMBIC_DIR / "alembic.ini"))
 
         if not path.isfile(alembic_cfg_path):
             raise Exception("Provided alembic config path doesn't exist")
 
         alembic_cfg = Config(alembic_cfg_path)
-        # alembic's file resolver wants to use the "mealie" subdirectory when called from within the server package
-        # Just override this to use the correct migrations path
-        alembic_cfg.set_main_option("script_location", path.join(PROJECT_DIR, "alembic"))
         command.upgrade(alembic_cfg, alembic_version)
 
         del db_dump["alembic_version"]

diff --git a/pyproject.toml b/pyproject.toml
@@ -158,8 +158,8 @@ select = [
 
 [tool.ruff.lint.per-file-ignores]
 "__init__.py" = ["E402", "E501"]
-"alembic/versions/2022*" = ["E501"]
-"alembic/versions/2023*" = ["E501"]
+"mealie/alembic/versions/2022*" = ["E501", "I001"]
+"mealie/alembic/versions/2023*" = ["E501", "I001"]
 "dev/scripts/all_recipes_stress_test.py" = ["E501"]
 "ldap_provider.py" = ["UP032"]
 "tests/conftest.py" = ["E402"]

diff --git a/tests/utils/alembic_reader.py b/tests/utils/alembic_reader.py
@@ -2,9 +2,9 @@
 import pathlib
 from functools import lru_cache
 
-from mealie.db.init_db import PROJECT_DIR
+from mealie.db.init_db import ALEMBIC_DIR
 
-ALEMBIC_MIGRATIONS = PROJECT_DIR / "alembic" / "versions"
+ALEMBIC_MIGRATIONS = ALEMBIC_DIR / "versions"
 
 
 def import_file(module_name: str, file_path: pathlib.Path):
-Original file line number
+Diff line change
@@ Expand Up / @@ -7,7 +7,6 @@ @@
     """
     import sqlalchemy as sa
     from alembic import op
     # revision identifiers, used by Alembic.
@@ Expand Down @@