get_migration_managers now accepts app_config instead of app_name

This is to make testing easier

Author: dantownsend

piccolo/apps/migrations/commands/base.py

@@ -6,6 +6,7 @@
 import typing as t
 
 from piccolo.conf.apps import (
+    AppConfig,
     MigrationModule,
     Finder,
 )
@@ -73,7 +74,7 @@ def get_migration_ids(
 
     async def get_migration_managers(
         self,
-        app_name: str,
+        app_config: AppConfig,
         max_migration_id: t.Optional[str] = None,
         offset: int = 0,
     ) -> t.List[MigrationManager]:
@@ -88,8 +89,6 @@ async def get_migration_managers(
         """
         migration_managers: t.List[MigrationManager] = []
 
-        app_config = self.get_app_config(app_name=app_name)
-
         migrations_folder = app_config.migrations_folder_path
 
         migration_modules: t.Dict[
@@ -129,8 +128,11 @@ async def get_table_from_snaphot(
         This will generate a SchemaSnapshot up to the given migration ID, and
         will return a DiffableTable class from that snapshot.
         """
+        app_config = self.get_app_config(app_name=app_name)
         migration_managers = await self.get_migration_managers(
-            app_name=app_name, max_migration_id=max_migration_id, offset=offset
+            app_config=app_config,
+            max_migration_id=max_migration_id,
+            offset=offset,
         )
         schema_snapshot = SchemaSnapshot(managers=migration_managers)
 

piccolo/apps/migrations/commands/new.py

@@ -131,7 +131,7 @@ async def get_alter_statements(
         Works out which alter statements are required.
         """
         migration_managers = await self.get_migration_managers(
-            app_name=app_config.app_name
+            app_config=app_config
         )
 
         schema_snapshot = SchemaSnapshot(migration_managers)

tests/apps/migrations/auto/test_migration_manager.py

@@ -1,4 +1,5 @@
 import asyncio
+from piccolo.conf.apps import AppConfig
 from piccolo.columns.column_types import ForeignKey
 from unittest.mock import patch, MagicMock
 
@@ -86,7 +87,8 @@ async def run():
             asyncio.run(manager.run_backwards())
 
     @postgres_only
-    def test_add_table(self):
+    @patch.object(BaseMigrationManager, "get_app_config")
+    def test_add_table(self, get_app_config: MagicMock):
         """
         Test adding a table to a MigrationManager.
         """
@@ -106,6 +108,10 @@ def test_add_table(self):
         self.assertEqual(response, [{"id": 1, "name": "Bob Jones"}])
 
         # Reverse
+
+        get_app_config.return_value = AppConfig(
+            app_name="music", migrations_folder_path=""
+        )
         asyncio.run(manager.run_backwards())
         self.assertEqual(self.table_exists("musician"), False)
         self.run_sync("DROP TABLE IF EXISTS musician;")
@@ -255,7 +261,10 @@ def test_add_non_nullable_column(self):
 
     @postgres_only
     @patch.object(BaseMigrationManager, "get_migration_managers")
-    def test_drop_column(self, get_migration_managers: MagicMock):
+    @patch.object(BaseMigrationManager, "get_app_config")
+    def test_drop_column(
+        self, get_app_config: MagicMock, get_migration_managers: MagicMock
+    ):
         """
         Test dropping a column with MigrationManager.
         """
@@ -284,6 +293,8 @@ def test_drop_column(self, get_migration_managers: MagicMock):
 
         # Reverse
         set_mock_return_value(get_migration_managers, [manager_1])
+        app_config = AppConfig(app_name="music", migrations_folder_path="")
+        get_app_config.return_value = app_config
         asyncio.run(manager_2.run_backwards())
         response = self.run_sync("SELECT * FROM musician;")
         self.assertEqual(response, [{"id": 1, "name": ""}])
@@ -596,7 +607,10 @@ def test_alter_column_set_length(self):
 
     @postgres_only
     @patch.object(BaseMigrationManager, "get_migration_managers")
-    def test_drop_table(self, get_migration_managers: MagicMock):
+    @patch.object(BaseMigrationManager, "get_app_config")
+    def test_drop_table(
+        self, get_app_config: MagicMock, get_migration_managers: MagicMock
+    ):
         self.run_sync("DROP TABLE IF EXISTS musician;")
 
         name_column = Varchar()
@@ -612,14 +626,16 @@ def test_drop_table(self, get_migration_managers: MagicMock):
         manager_2.drop_table(class_name="Musician", tablename="musician")
         asyncio.run(manager_2.run())
 
-        set_mock_return_value(get_migration_managers, [manager_1])
-
         self.assertTrue(not self.table_exists("musician"))
 
+        # Reverse
+        set_mock_return_value(get_migration_managers, [manager_1])
+        app_config = AppConfig(app_name="music", migrations_folder_path="")
+        get_app_config.return_value = app_config
         asyncio.run(manager_2.run_backwards())
 
         get_migration_managers.assert_called_with(
-            app_name="music", max_migration_id="2", offset=-1
+            app_config=app_config, max_migration_id="2", offset=-1
         )
         self.assertTrue(self.table_exists("musician"))
 

tests/apps/migrations/commands/test_base.py

@@ -1,6 +1,6 @@
 import os
 from unittest import TestCase
-from unittest.mock import patch
+from unittest.mock import MagicMock, patch
 
 from piccolo.conf.apps import AppConfig
 from piccolo.apps.migrations.commands.base import (
@@ -21,17 +21,18 @@ def tearDown(self):
 
 
 class TestGetMigrationModules(TestCase):
-    @patch.object(BaseMigrationManager, "get_app_config")
-    def test_get_migration_modules(self, get_app_config):
-        get_app_config.return_value = AppConfig(
+    def test_get_migration_modules(self):
+        app_config = AppConfig(
             app_name="music",
             migrations_folder_path=os.path.join(
                 os.path.dirname(__file__), "test_migrations"
             ),
         )
 
         migration_managers = run_sync(
-            BaseMigrationManager().get_migration_managers(app_name="music")
+            BaseMigrationManager().get_migration_managers(
+                app_config=app_config
+            )
         )
 
         self.assertTrue(len(migration_managers) == 1)
@@ -42,7 +43,7 @@ def test_get_migration_modules(self, get_app_config):
 
 class TestGetTableFromSnapshot(TestCase):
     @patch.object(BaseMigrationManager, "get_app_config")
-    def test_get_table_from_snaphot(self, get_app_config):
+    def test_get_table_from_snaphot(self, get_app_config: MagicMock):
         """
         Test the get_table_from_snaphot method.
         """