Merge pull request piccolo-orm#29 from piccolo-orm/improved_migration_exit_codes

modified exit codes when no migrations are left to run / reverse

Author: dantownsend

piccolo/apps/migrations/commands/backwards.py

@@ -40,7 +40,10 @@ async def run(self):
             app_name=self.app_name
         )
         if len(ran_migration_ids) == 0:
-            sys.exit("No migrations to reverse!")
+            # Make sure a status of 0 is returned, as we don't want this
+            # to appear as an error in automated scripts.
+            print("No migrations to reverse!")
+            sys.exit(0)
 
         #######################################################################
 

piccolo/apps/migrations/commands/forwards.py

@@ -38,7 +38,10 @@ async def run_migrations(self, app_config: AppConfig) -> None:
         print(f"Haven't run = {havent_run}")
 
         if len(havent_run) == 0:
-            sys.exit("No migrations left to run!")
+            # Make sure a status of 0 is returned, as we don't want this
+            # to appear as an error in automated scripts.
+            print("No migrations left to run!")
+            sys.exit(0)
 
         if self.migration_id == "all":
             subset = havent_run

tests/apps/migrations/commands/test_forwards_backwards.py

@@ -2,6 +2,7 @@
 
 import typing as t
 from unittest import TestCase
+from unittest.mock import patch, call, MagicMock
 
 from piccolo.apps.migrations.tables import Migration
 from piccolo.apps.migrations.commands.backwards import backwards
@@ -121,7 +122,8 @@ def test_backwards_unknown_migration(self):
             )
         )
 
-    def test_backwards_no_migrations(self):
+    @patch("piccolo.apps.migrations.commands.backwards.print")
+    def test_backwards_no_migrations(self, print_):
         """
         Test running migrations backwards if none have been run previously.
         """
@@ -134,11 +136,13 @@ def test_backwards_no_migrations(self):
                 )
             )
 
-        self.assertEqual(
-            manager.exception.__str__(), "No migrations to reverse!"
+        self.assertEqual(manager.exception.code, 0)
+        self.assertTrue(
+            print_.mock_calls[-1] == call("No migrations to reverse!")
         )
 
-    def test_forwards_no_migrations(self):
+    @patch("piccolo.apps.migrations.commands.forwards.print")
+    def test_forwards_no_migrations(self, print_: MagicMock):
         """
         Test running the migrations if they've already run.
         """
@@ -147,8 +151,9 @@ def test_forwards_no_migrations(self):
         with self.assertRaises(SystemExit) as manager:
             run_sync(forwards(app_name="example_app", migration_id="all"))
 
-        self.assertEqual(
-            manager.exception.__str__(), "No migrations left to run!"
+        self.assertEqual(manager.exception.code, 0)
+        self.assertTrue(
+            print_.mock_calls[-1] == call("No migrations left to run!")
         )
 
     def test_forwards_fake(self):