alembic-verify 0.1.4__tar.gz → 1.0.1__tar.gz

alembic_verify-1.0.1/LICENSE

@@ -0,0 +1,203 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 Fabrizio Romano, Mark McArdle
+
+   Originally developed for Student.com
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

alembic_verify-1.0.1/PKG-INFO

@@ -0,0 +1,491 @@
+Metadata-Version: 2.4
+Name: alembic-verify
+Version: 1.0.1
+Summary: A library to verify alembic migrations.
+Keywords: alembic,migration,verify,sqlalchemy
+Author-Email: Fabrizio Romano <gianchub@gmail.com>, Mark McArdle <m.mc4rdle@gmail.com>
+License-File: LICENSE
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Topic :: Database
+Classifier: Operating System :: OS Independent
+Project-URL: Homepage, https://github.com/gianchub/alembic-verify
+Project-URL: Issues, https://github.com/gianchub/alembic-verify/issues
+Project-URL: License, https://github.com/gianchub/alembic-verify/blob/master/LICENSE
+Requires-Python: >=3.10
+Requires-Dist: pytest>=7.0
+Requires-Dist: alembic>=1.8
+Requires-Dist: sqlalchemy<3,>=1.4
+Requires-Dist: sqlalchemy-utils>=0.40.0
+Provides-Extra: dev
+Requires-Dist: pdbpp; extra == "dev"
+Requires-Dist: ty; extra == "dev"
+Provides-Extra: lint
+Requires-Dist: ruff~=0.14.13; extra == "lint"
+Provides-Extra: test
+Requires-Dist: pytest-cov; extra == "test"
+Requires-Dist: psycopg2-binary; extra == "test"
+Provides-Extra: all
+Requires-Dist: alembic-verify[dev,lint,test]; extra == "all"
+Description-Content-Type: text/markdown
+
+# Alembic Verify
+
+
+## Description
+
+Alembic Verify is a library that provides utilities and pytest fixtures to verify that migrations
+produce the expected database schema and to prepare the database schema from migrations.
+
+
+## Table of Contents
+
+- [Alembic Verify](#alembic-verify)
+  - [Description](#description)
+  - [Table of Contents](#table-of-contents)
+  - [Notable changes in version 1.\*](#notable-changes-in-version-1)
+  - [Requirements](#requirements)
+  - [Installation](#installation)
+  - [Usage](#usage)
+    - [Quick Start](#quick-start)
+    - [A quick test example](#a-quick-test-example)
+    - [Fixtures Provided](#fixtures-provided)
+      - [`alembic_new_db`](#alembic_new_db)
+      - [`alembic_config`](#alembic_config)
+    - [Utility Functions](#utility-functions)
+      - [`prepare_schema_from_migrations(uri, config, revision="head")`](#prepare_schema_from_migrationsuri-config-revisionhead)
+      - [`get_current_revision(config, engine, script)`](#get_current_revisionconfig-engine-script)
+      - [`get_head_revision(config, engine, script)`](#get_head_revisionconfig-engine-script)
+    - [Testing Upgrade/Downgrade Cycles](#testing-upgradedowngrade-cycles)
+    - [Branched Migrations](#branched-migrations)
+    - [Session for Engine](#session-for-engine)
+    - [Deprecated Fixtures](#deprecated-fixtures)
+    - [Fixtures that are no longer needed](#fixtures-that-are-no-longer-needed)
+    - [Creating custom fixtures](#creating-custom-fixtures)
+  - [Development](#development)
+    - [Setup](#setup)
+    - [Running Tests](#running-tests)
+    - [Linting and Formatting](#linting-and-formatting)
+    - [Using Tox](#using-tox)
+  - [Compatibility](#compatibility)
+  - [License](#license)
+  - [Contributing](#contributing)
+
+
+## Notable changes in version 1.*
+
+In this version, the library has been rewritten to be completely untied from the [sqlalchemy-diff](https://github.com/gianchub/sqlalchemy-diff) project.
+
+We have renamed the fixtures to be more consistent and easier to understand. The reason why this work was needed is because the library was born as part of the sqlalchemy-diff project, but then published as a separate project. As a consequence, the naming of the fixtures of the editions prior to 1.* was consistent with the needs of the [sqlalchemy-diff](https://github.com/gianchub/sqlalchemy-diff) project, which is now a totally separate library, to which alembic-verify is no longer related.
+
+
+## Requirements
+
+- Python 3.10, 3.11, 3.12, 3.13, or 3.14
+- SQLAlchemy 1.4.* or 2.0+
+- Alembic >= 1.8.0
+
+
+## Installation
+
+Install using pip:
+
+```bash
+$ pip install alembic-verify
+```
+
+Or using uv:
+
+```bash
+$ uv pip install alembic-verify
+```
+
+## Usage
+
+The library supports any database supported by both [SQLAlchemy](https://www.sqlalchemy.org/) and [sqlalchemy-utils](https://sqlalchemy-utils.readthedocs.io/en/latest/).
+
+### Quick Start
+
+You need to provide two fixtures, which can either live in your test modules, or in the `conftest.py` file of your project, according to your needs.
+
+```python
+from uuid import uuid4
+import pytest
+
+
+@pytest.fixture(scope="module")
+def alembic_ini_location():
+    """Path to your alembic.ini file."""
+    return str("path/to/alembic.ini")
+
+
+@pytest.fixture
+def alembic_db_uri():
+    """Database URI. Normally in tests you will want a unique temporary database name."""
+    base_uri = "postgresql://postgres:postgres@localhost:5432/"
+    return f"{base_uri}test_{uuid4().hex}"
+```
+
+Once the fixtures are defined, you can proceed to write your migration tests.
+
+
+### A quick test example
+
+```python
+import pytest
+from alembicverify.util import prepare_schema_from_migrations
+
+
+@pytest.mark.usefixtures("alembic_new_db")
+def test_migrations(alembic_config, alembic_db_uri):
+    with prepare_schema_from_migrations(
+        alembic_db_uri, alembic_config, revision="head"
+    ) as (engine, script):
+        # All migrations applied successfully
+        with engine.connect() as conn:
+            # Query your tables, verify schema, etc.
+            pass
+```
+
+You can also specify a specific revision to apply:
+
+```python
+with prepare_schema_from_migrations(
+    alembic_db_uri, alembic_config, revision="some_revision"
+) as (engine, script):
+    # All migrations applied successfully
+    pass
+```
+
+
+### Fixtures Provided
+
+The library provides two pytest fixtures:
+
+
+#### `alembic_new_db`
+
+Creates a temporary database before the test and drops it after. Depends on the `alembic_db_uri` fixture. Use it as a marker:
+
+```python
+@pytest.mark.usefixtures("alembic_new_db")
+def test_migrations(alembic_config, alembic_db_uri):
+    ...
+```
+
+This fixture depends on the `alembic_db_uri` fixture.
+
+
+#### `alembic_config`
+
+Returns a configured `alembic.config.Config` object with:
+- Database URL set from your `alembic_db_uri` fixture
+- Script location loaded from your `alembic_ini_location` fixture
+
+This fixture depends on both the `alembic_db_uri` and `alembic_ini_location` fixtures.
+
+
+### Utility Functions
+
+
+#### `prepare_schema_from_migrations(uri, config, revision="head")`
+
+Applies migrations to the database and returns an engine and script directory.
+
+**Context manager usage** (recommended - automatically disposes the engine):
+
+```python
+import pytest
+from alembicverify.util import prepare_schema_from_migrations
+
+@pytest.mark.usefixtures("alembic_new_db")
+def test_migrations(alembic_config, alembic_db_uri):
+    with prepare_schema_from_migrations(
+        alembic_db_uri, alembic_config, revision="head"
+    ) as (engine, script):
+        # `engine` will be automatically disposed after the context manager exits
+        pass
+```
+
+**Regular function-style usage** (requires manual disposal of the engine):
+
+```python
+import pytest
+from alembicverify.util import prepare_schema_from_migrations
+
+@pytest.mark.usefixtures("alembic_new_db")
+def test_migration_upgrade_and_downgrade(alembic_config, alembic_db_uri):
+    engine, script = prepare_schema_from_migrations(
+        alembic_db_uri, alembic_config, revision="head"
+    )
+    try:
+        # Use engine and script
+        pass
+    finally:
+        engine.dispose()  # Must dispose engine manually
+```
+
+
+#### `get_current_revision(config, engine, script)`
+
+Returns the current applied revision from the database:
+
+```python
+import pytest
+from alembicverify.util import get_current_revision, prepare_schema_from_migrations
+
+@pytest.mark.usefixtures("alembic_new_db")
+def test_migrations(alembic_config, alembic_db_uri):
+    with prepare_schema_from_migrations(
+        alembic_db_uri, alembic_config, revision="head"
+    ) as (engine, script):
+        current = get_current_revision(alembic_config, engine, script)
+        assert current == "abc123def456"
+```
+
+#### `get_head_revision(config, engine, script)`
+
+Returns the latest (head) revision from the migration chain:
+
+```python
+import pytest
+from alembicverify.util import get_head_revision, prepare_schema_from_migrations
+
+@pytest.mark.usefixtures("alembic_new_db")
+def test_migrations(alembic_config, alembic_db_uri):
+    with prepare_schema_from_migrations(
+        alembic_db_uri, alembic_config, revision="head"
+    ) as (engine, script):
+        head = get_head_revision(alembic_config, engine, script)
+        assert head == "abc123def456"
+```
+
+### Testing Upgrade/Downgrade Cycles
+
+You can test that migrations can be applied and rolled back:
+
+```python
+import pytest
+from alembic import command
+from alembicverify.util import prepare_schema_from_migrations, get_current_revision
+
+
+@pytest.mark.usefixtures("alembic_new_db")
+def test_migration_upgrade_and_downgrade(alembic_config, alembic_db_uri):
+    with prepare_schema_from_migrations(
+        alembic_db_uri, alembic_config, revision="head"
+    ) as (engine, script):
+        # Collect all revisions by downgrading one at a time
+        revisions = []
+        while True:
+            rev = get_current_revision(alembic_config, engine, script)
+            if rev is None:
+                break
+            command.downgrade(alembic_config, "-1")
+            revisions.append(rev)
+
+        # Verify the expected revision chain
+        assert revisions == [
+            "latest_revision",
+            "previous_revision",
+            "initial_revision",
+        ]
+```
+
+### Branched Migrations
+
+If your migration history has branches, you can target a specific branch using the `revision@head` syntax:
+
+```python
+with prepare_schema_from_migrations(
+    alembic_db_uri, alembic_config, revision="branch_revision@head"
+) as (engine, script):
+    # Migrations applied up to head of the specified branch
+    pass
+```
+
+### Session for Engine
+
+The library provides a utility function to create a session for an engine. This is useful for testing, for example to verify the application of a migration in detail. You might need to get two different session instances to use before and after the application of a migration.
+
+Here's a full example:
+
+```python
+import pytest
+from alembic import command
+from alembicverify.util import prepare_schema_from_migrations, session_for_engine
+
+down_revision = "44352f0a4052"
+
+
+@pytest.mark.usefixtures("alembic_new_db")
+def test_upgrade(alembic_config, alembic_db_uri):
+    with prepare_schema_from_migrations(alembic_db_uri, alembic_config, revision=down_revision) as (
+        engine,
+        _,
+    ):
+        with session_for_engine(engine) as session:
+            # populate the database, inspect the schema, etc.
+            ...
+
+        # then apply the desired migration
+        command.upgrade(alembic_config, "+1")
+
+        with session_for_engine(engine) as session:
+            # after the migration, verify the schema, its data, etc.
+            ...
+```
+
+### Deprecated Fixtures
+
+The library provides four deprecated fixtures:
+
+- `new_db_left`: Deprecated in favor of `alembic_new_db`
+  - Depends on the `uri_left` fixture
+- `new_db_right`: Deprecated in favor of `alembic_new_db`
+  - Depends on the `uri_right` fixture
+- `alembic_config_left`: Deprecated in favor of `alembic_config`
+  - Depends on the `uri_left` fixture and the `alembic_ini_location` fixture
+- `alembic_config_right`: Deprecated in favor of `alembic_config`
+  - Depends on the `uri_right` fixture and the `alembic_ini_location` fixture
+
+These fixtures are still available for backwards compatibility, but will issue a deprecation warning.
+
+**Note**: The `uri_left` and `uri_right` fixtures are no longer needed when using the library in the new way, they have been replaced by the `alembic_db_uri` fixture.
+
+
+### Fixtures that are no longer needed
+
+The library no longer uses the `alembic_root` fixture, so you don't need to provide it.
+
+
+### Creating custom fixtures
+
+In some situations, you may want to spawn more than one random database for your tests.
+For example, if you are using `alembic-verify` in combination with `sqlalchemy-diff`, you will
+need to spawn two random databases.
+
+You can create custom fixtures by using the factory functions, like in the following example:
+
+
+```python
+from uuid import uuid4
+import pytest
+
+from alembicverify import alembic_config_factory, new_db_factory
+from alembicverify.util import prepare_schema_from_migrations
+from test.integration.conftest import get_temporary_uri
+
+
+@pytest.fixture
+def alembic_db_uri_custom():
+    base_uri = "postgresql://postgres:postgres@localhost:5432/"
+    return f"{base_uri}test_{uuid4().hex}"
+
+
+alembic_config_custom = alembic_config_factory(
+    alembic_db_uri_fixture_name="alembic_db_uri_custom",
+    alembic_ini_location_fixture_name="alembic_ini_location",
+    name="alembic_config_custom",
+)
+
+alembic_new_db_custom = new_db_factory(
+    alembic_db_uri_fixture_name="alembic_db_uri_custom",
+    name="alembic_new_db_custom",
+)
+
+
+@pytest.mark.usefixtures("alembic_new_db_custom")
+def test_migration_upgrade_and_downgrade_context_manager(
+    alembic_config_custom, alembic_db_uri_custom
+):
+    with prepare_schema_from_migrations(
+        alembic_db_uri_custom, alembic_config_custom, revision="head"
+    ) as (
+        engine,
+        script,
+    ):
+        # use engine and script
+```
+
+
+## Development
+
+
+### Setup
+
+1. Clone the repository:
+   ```bash
+   $ git clone https://github.com/gianchub/alembic-verify.git
+   $ cd alembic-verify
+   ```
+
+2. Install development dependencies:
+   ```bash
+   $ uv pip install -e .[all]
+   ```
+
+
+### Running Tests
+
+Use the Makefile:
+
+```bash
+$ make test
+```
+
+
+### Linting and Formatting
+
+The project uses [Ruff](https://github.com/astral-sh/ruff) for linting and formatting.
+
+```bash
+$ make format
+$ make lint
+```
+
+
+### Using Tox
+
+Test across multiple Python and SQLAlchemy versions:
+
+```bash
+# Install tox with uv
+$ make install-tox-uv
+
+# Run all test environments
+$ make tox
+
+# Run specific environment
+$ tox -e py314-test-sa14
+$ tox -e py314-test-sa20
+```
+
+
+## Compatibility
+
+See the [pyproject.toml](pyproject.toml) file for the requirements.
+
+
+## License
+
+Apache 2.0. See [LICENSE](LICENSE) for details.
+
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+Before submitting a pull request, please ensure that:
+
+- You have added any tests needed to cover the changes you have made
+- All tests pass
+- The code is formatted correctly
+- The documentation (including docstrings and README.md) is up to date