Add "--check-heads" option to "current" command by sscherfke · Pull Request #1739 · sqlalchemy/alembic

sscherfke · 2025-10-26T13:16:44Z

Add --check-heads option to current commad to check if all head revisions are applied to the database.

Description

Fixes: #1705

Checklist

This pull request is:

A documentation / typographical error fix
- Good to go, no issue or tests are needed
A short code fix
- please include the issue number, and create an issue if none exists, which
  must include a complete example of the issue. one line code fixes without an
  issue and demonstration will not be accepted.
- Please include: Fixes: #<issue number> in the commit message
- please include tests. one line code fixes without tests will not be accepted.
A new feature implementation
- please include the issue number, and create an issue if none exists, which must
  include a complete example of how the feature would look.
- Please include: Fixes: #<issue number> in the commit message
- please include tests.

Have a nice day!

Fixes: sqlalchemy#1705

sscherfke · 2025-10-26T13:17:45Z

One test started to fail when I added additional tests. I don't know why and I don't think tests should be able to influence other tests in this way. I probably did something wrong, but don't know what. 🙈

sscherfke · 2025-10-26T13:19:05Z

I was also considering to add a --check-loop SECONDS option which would indefinitely repeat the check every SECONDS seconds until it succeeds. What do you think of this?

zzzeek · 2025-10-27T14:05:29Z

I was also considering to add a --check-loop SECONDS option which would indefinitely repeat the check every SECONDS seconds until it succeeds. What do you think of this?

im not a huge fan of digging in that level of richness here, the idiomatic way to do that kind of thing would be:

until alembic current --check-heads; do echo "checking heads..."; sleep 5; done

why re-implement all that in some less full featured way

zzzeek

thanks for the PR! minor changes

sqla-tester

OK, this is sqla-tester setting up my work on behalf of zzzeek to try to get revision f8c9a1f of this pull request into gerrit so we can run tests and reviews and stuff

sqla-tester · 2025-10-27T15:09:25Z

New Gerrit review created for change f8c9a1f: https://gerrit.sqlalchemy.org/c/sqlalchemy/alembic/+/6265

sqla-tester

OK, this is sqla-tester setting up my work on behalf of zzzeek to try to get revision 955f9b7 of this pull request into gerrit so we can run tests and reviews and stuff

sqla-tester · 2025-10-28T12:06:32Z

Patchset 955f9b7 added to existing Gerrit review https://gerrit.sqlalchemy.org/c/sqlalchemy/alembic/+/6265

sqla-tester

Michael Bayer (zzzeek) wrote:

OK great, I've applied some last minute changes on this end.

View this in Gerrit at https://gerrit.sqlalchemy.org/c/sqlalchemy/alembic/+/6265

sqla-tester · 2025-10-28T12:49:08Z

    :param config: a :class:`.Config` instance.

+    :param check_heads: Check if all head revisions are applied to the
+        database.  Exit with an error if this is not the case.


Michael Bayer (zzzeek) wrote:

.. versionadded:: 1.17.1

View this in Gerrit at https://gerrit.sqlalchemy.org/c/sqlalchemy/alembic/+/6265

sqla-tester · 2025-10-28T12:49:08Z

+        if check_heads and (
+            set(context.get_current_heads()) != set(script.get_heads())
+        ):
+            raise util.CommandError("Database is not on all head revisions")


Michael Bayer (zzzeek) wrote:

like alembic check, will add a subclass here

View this in Gerrit at https://gerrit.sqlalchemy.org/c/sqlalchemy/alembic/+/6265

sqla-tester · 2025-10-28T12:49:08Z

+   :tickets: 1705
+
+   Added ``--check-heads`` option to ``current`` command which
+   checks if all head revisions are applied to the database.


Michael Bayer (zzzeek) wrote:

will mention the cookbook recipe here

View this in Gerrit at https://gerrit.sqlalchemy.org/c/sqlalchemy/alembic/+/6265

sqla-tester · 2025-10-28T12:49:08Z

+
+   Added ``--check-heads`` option to ``current`` command which
+   checks if all head revisions are applied to the database.
+   The command exists with a non-zero exit code if this is not the


Michael Bayer (zzzeek) wrote:

typo exists

View this in Gerrit at https://gerrit.sqlalchemy.org/c/sqlalchemy/alembic/+/6265

sqla-tester · 2025-10-28T12:49:08Z

+   Added ``--check-heads`` option to ``current`` command which
+   checks if all head revisions are applied to the database.
+   The command exists with a non-zero exit code if this is not the
+   case.


Michael Bayer (zzzeek) wrote:

pull request courtesy Stefan Scherfke

View this in Gerrit at https://gerrit.sqlalchemy.org/c/sqlalchemy/alembic/+/6265

sqla-tester · 2025-10-28T12:49:08Z

+        ["a3", "b2"],
+        argnames="revs",
+    )
+    def test_check_heads_fail(self, revs):


Michael Bayer (zzzeek) wrote:

nice job

View this in Gerrit at https://gerrit.sqlalchemy.org/c/sqlalchemy/alembic/+/6265

sqla-tester · 2025-10-28T12:49:08Z

+        assert_raises_message(
+            util.CommandError,
+            "Database is not on all head revisions",
+            command.current,


Michael Bayer (zzzeek) wrote:

there might be some test cleanup error occurring, investigating

it looks like test_doesnt_create_alembic_version was relying on test ordering to work, fixed that test separately.

View this in Gerrit at https://gerrit.sqlalchemy.org/c/sqlalchemy/alembic/+/6265

sqla-tester · 2025-10-28T14:06:22Z

Michael Bayer (zzzeek) wrote:

recheck

View this in Gerrit at https://gerrit.sqlalchemy.org/c/sqlalchemy/alembic/+/6265

sqla-tester

Federico Caselli (CaselIT) wrote:

code review left on gerrit

View this in Gerrit at https://gerrit.sqlalchemy.org/c/sqlalchemy/alembic/+/6265

tests/test_command.py (line 1601): not sure if this was intended

sqla-tester

Michael Bayer (zzzeek) wrote:

code review left on gerrit

View this in Gerrit at https://gerrit.sqlalchemy.org/c/sqlalchemy/alembic/+/6265

tests/test_command.py (line 1601): it was, I had a shutil.rmtree() there which was deleting the whole class-level fixture and only passing because of randomness. these new tests started throwing it all off, so i fixed this test to only delete the file that it created.

sqla-tester · 2025-10-29T00:20:55Z

Gerrit review https://gerrit.sqlalchemy.org/c/sqlalchemy/alembic/+/6265 has been merged. Congratulations! :)

sqla-tester

Federico Caselli (CaselIT) wrote:

code review left on gerrit

View this in Gerrit at https://gerrit.sqlalchemy.org/c/sqlalchemy/alembic/+/6265

tests/test_command.py (line 1601): ok!

Added :paramref:`.command.current.check_heads` parameter to :func:`.command.current` command, available from the command line via the ``--check-heads`` option to ``alembic current``. This tests if all head revisions are applied to the database and raises :class:`.DatabaseNotAtHead` (or from the command line, exits with a non-zero exit code) if this is not the case. The parameter operates equvialently to the cookbook recipe :ref:`cookbook_check_heads`. Pull request courtesy Stefan Scherfke. Fixes: sqlalchemy#1705 Closes: sqlalchemy#1739 Pull-request: sqlalchemy#1739 Pull-request-sha: 955f9b7 Change-Id: I1173217ff6a4927226ec9e7b8c7ef67c6431d728

Add "--check-heads" option to "current" command

77f6691

Fixes: sqlalchemy#1705

zzzeek requested changes Oct 27, 2025

View reviewed changes

Comment thread docs/build/changelog.rst Outdated

Comment thread alembic/config.py

Comment thread alembic/command.py

Apply review suggestions

f8c9a1f

zzzeek requested a review from sqla-tester October 27, 2025 15:09

sqla-tester reviewed Oct 27, 2025

View reviewed changes

zzzeek requested changes Oct 27, 2025

View reviewed changes

Comment thread tests/test_command.py Outdated

Comment thread tests/test_command.py Outdated

Comment thread docs/build/changelog.rst Outdated

Use testing.combinations() i/o pytest parametrize

955f9b7

zzzeek requested a review from sqla-tester October 28, 2025 12:06

sqla-tester reviewed Oct 28, 2025

View reviewed changes

sqla-tester reviewed Oct 29, 2025

View reviewed changes

sqlalchemy-bot closed this in 2199213 Oct 29, 2025

sqla-tester reviewed Oct 29, 2025

View reviewed changes

Uh oh!

Conversation

sscherfke commented Oct 26, 2025

Description

Checklist

Uh oh!

sscherfke commented Oct 26, 2025

Uh oh!

sscherfke commented Oct 26, 2025

Uh oh!

zzzeek commented Oct 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

zzzeek left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

sqla-tester left a comment

Choose a reason for hiding this comment

Uh oh!

sqla-tester commented Oct 27, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

sqla-tester left a comment

Choose a reason for hiding this comment

Uh oh!

sqla-tester commented Oct 28, 2025

Uh oh!

sqla-tester left a comment

Choose a reason for hiding this comment

Uh oh!

sqla-tester Oct 28, 2025

Choose a reason for hiding this comment

Uh oh!

sqla-tester Oct 28, 2025

Choose a reason for hiding this comment

Uh oh!

sqla-tester Oct 28, 2025

Choose a reason for hiding this comment

Uh oh!

sqla-tester Oct 28, 2025

Choose a reason for hiding this comment

Uh oh!

sqla-tester Oct 28, 2025

Choose a reason for hiding this comment

Uh oh!

sqla-tester Oct 28, 2025

Choose a reason for hiding this comment

Uh oh!

sqla-tester Oct 28, 2025

Choose a reason for hiding this comment

Uh oh!

sqla-tester commented Oct 28, 2025

Uh oh!

sqla-tester left a comment

Choose a reason for hiding this comment

Uh oh!

sqla-tester left a comment

Choose a reason for hiding this comment

Uh oh!

sqla-tester commented Oct 29, 2025

Uh oh!

sqla-tester left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

zzzeek commented Oct 27, 2025 •

edited

Loading