migcheck 0.1.2__tar.gz

migcheck-0.1.2/LICENSE

@@ -0,0 +1,201 @@
+                                 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 [yyyy] [name of copyright owner]
+
+   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.

migcheck-0.1.2/MANIFEST.in

@@ -0,0 +1,2 @@
+graft tests
+global-exclude __pycache__ *.py[co]

migcheck-0.1.2/NOTICE

@@ -0,0 +1,4 @@
+migcheck
+Copyright 2026 Cole Michaels
+
+Licensed under the Apache License, Version 2.0. See LICENSE.

migcheck-0.1.2/PKG-INFO

@@ -0,0 +1,343 @@
+Metadata-Version: 2.4
+Name: migcheck
+Version: 0.1.2
+Summary: Checks that a release's database migrations don't break the release running in production.
+Author: Cole Michaels
+License-Expression: Apache-2.0
+Project-URL: Repository, https://github.com/Genetic-Pottery/migcheck
+Project-URL: Changelog, https://github.com/Genetic-Pottery/migcheck/blob/main/CHANGELOG.md
+Project-URL: Issues, https://github.com/Genetic-Pottery/migcheck/issues
+Keywords: database,migrations,schema,postgres,mysql,deployment,rollback,ci
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: POSIX
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: SQL
+Classifier: Topic :: Database
+Classifier: Topic :: Software Development :: Quality Assurance
+Classifier: Topic :: Software Development :: Testing
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: NOTICE
+Dynamic: license-file
+
+<p align="center">
+  <img src="https://raw.githubusercontent.com/Genetic-Pottery/migcheck/main/assets/logo.png" alt="migcheck logo" width="280">
+</p>
+
+<p align="center">
+  <a href="https://github.com/Genetic-Pottery/migcheck/actions/workflows/ci.yml"><img src="https://github.com/Genetic-Pottery/migcheck/actions/workflows/ci.yml/badge.svg?branch=main" alt="CI"></a>
+  <a href="https://github.com/Genetic-Pottery/migcheck/blob/main/LICENSE"><img src="https://img.shields.io/github/license/Genetic-Pottery/migcheck" alt="License"></a>
+  <a href="https://github.com/Genetic-Pottery/migcheck#run-it-in-github-actions"><img src="https://img.shields.io/badge/GitHub_Action-available-2088FF?logo=githubactions&logoColor=white" alt="GitHub Action"></a>
+  <a href="https://github.com/Genetic-Pottery/migcheck/releases/latest"><img src="https://img.shields.io/github/v/release/Genetic-Pottery/migcheck" alt="Release"></a>
+  <img src="https://img.shields.io/badge/python-3.10%2B-3776AB?logo=python&logoColor=white" alt="Python 3.10+">
+</p>
+
+migcheck checks that a release's database migrations don't break the release
+running in production.
+
+During a rolling deploy, the old release keeps serving traffic after the new
+release's migrations run. After a rollback, it runs against the new schema
+indefinitely. A migration that passes review and passes the new release's tests
+can still take down the old release. Migration linters check the SQL. migcheck
+runs the old release's queries against the new schema and tells you which ones
+fail.
+
+For example, this is migcheck's output for the
+[demo](https://github.com/Genetic-Pottery/migcheck#try-the-demo), where release
+`v2-rename` renames a column that `v1` uses:
+
+```
+FAIL: 4 statements from v1 break after v2-rename's migrations.
+
+  [42703] column "name" of relation "users" does not exist
+      2 statements in 1 transactions. Examples:
+      INSERT INTO users (name, email) VALUES ('Ada O''Brien', 'ada@example.com') RETURNING id
+      UPDATE users SET name = 'Ada Lovelace' WHERE id = '1'
+
+  [42703] column "name" does not exist
+      2 statements in 1 transactions. Examples:
+      SELECT id, name, email FROM users WHERE id = '1'
+
+v1 fails during a rolling deploy of v2-rename, and after a rollback to v1.
+```
+
+migcheck supports Postgres and MySQL. It's an early release.
+
+## What it catches
+
+migcheck catches any change that makes the old release's queries fail,
+including the following:
+
+- Renamed or dropped columns and tables.
+- New `NOT NULL` columns without a database default. The old release's inserts
+  don't set them.
+- New constraints that the old release's writes violate.
+- Changed column types that the old release's values don't fit.
+
+The `NOT NULL` case is easy to miss in Django. When a migration adds a field
+with a `default`, Django fills existing rows with it and then drops the default
+from the database. The migration looks safe, but the old release's inserts fail.
+
+In a test against 25 migrations from an open-source Django app's history,
+migcheck caught 6 of the 9 breaking migrations, with no false alarms. It missed
+the other 3 because the app's tests never queried the changed tables.
+
+## Install
+
+migcheck needs Docker, git, and Python 3.10 or later. It has no Python
+dependencies and doesn't need a database client on the host.
+
+```sh
+pipx install git+https://github.com/Genetic-Pottery/migcheck@v0.1.1
+```
+
+## Use it
+
+Run migcheck from your app's repository:
+
+```sh
+migcheck --base <deployed-ref> --head <new-ref> \
+  --migrate "<command that applies migrations>" \
+  --workload "<command that runs your test suite>"
+```
+
+- `--base` is the release running in production, such as its tag.
+- `--head` is the release you're about to deploy.
+- `--migrate` and `--workload` are shell commands. migcheck runs them in a
+  checkout of each ref, with `DATABASE_URL` pointing at a throwaway database.
+- `--db` is the database your app uses: `postgres`, the default, or `mysql`.
+
+Your app must read its database connection from `DATABASE_URL` in the test
+environment. If it reads other variables, wrap the commands in a script that
+sets them.
+
+`DATABASE_URL` starts with `postgresql://` or `mysql://`. If your framework
+expects another scheme, such as `mysql2://` for Rails, rewrite it in the
+command:
+
+```sh
+migcheck --db mysql --base v5.2.0 --head main \
+  --migrate 'DATABASE_URL=mysql2${DATABASE_URL#mysql} bin/rails db:migrate' \
+  --workload 'DATABASE_URL=mysql2${DATABASE_URL#mysql} bin/rails test'
+```
+
+For example, for a Django app:
+
+```sh
+migcheck --base v1.4.0 --head main \
+  --migrate "python manage.py migrate" \
+  --workload "pytest"
+```
+
+migcheck exits with one of the following codes:
+
+| Code | Meaning |
+|---|---|
+| `0` | Every query the old release made still works. |
+| `1` | At least one query breaks. |
+| `2` | migcheck couldn't compare, for example because every query failed on the old schema too. |
+
+### Options
+
+| Flag | Description |
+|---|---|
+| `--base` | Ref of the release running in production. Required. |
+| `--head` | Ref of the release being deployed. Required. |
+| `--migrate` | Shell command that applies migrations to `$DATABASE_URL`. Required. |
+| `--workload` | Shell command that exercises the app against `$DATABASE_URL`, such as its test suite. Required. |
+| `--db` | Database the app uses: `postgres` or `mysql`. Default: `postgres` |
+| `--repo` | Git repository to check. Default: `.` |
+| `--image` | Database Docker image. Use the major version you run in production. Default: `postgres:17-alpine` or `mysql:8.4` |
+| `--head-name` | Name to show for `--head` in the result, such as `this pull request`. |
+| `--markdown` | Also write the result as Markdown to this path, for a pull request comment. |
+
+## See it in action
+
+The [migcheck-example](https://github.com/Genetic-Pottery/migcheck-example)
+repository runs the action on its pull requests. Each pull request adds a
+migration, and migcheck comments with the result:
+
+- [Rename a column](https://github.com/Genetic-Pottery/migcheck-example/pull/1)
+  fails, because the production release still uses the old name.
+- [Add a `NOT NULL` column and drop its default](https://github.com/Genetic-Pottery/migcheck-example/pull/2)
+  fails, because the production release's inserts don't set it.
+- [Add a nullable column](https://github.com/Genetic-Pottery/migcheck-example/pull/3)
+  passes.
+
+## Run it in GitHub Actions
+
+The migcheck action runs the check on each pull request and posts the result
+as a comment. It updates the same comment when the pull request changes.
+
+```yaml
+name: migcheck
+on:
+  pull_request:
+    paths: ["migrations/**"]
+
+permissions:
+  contents: read
+  pull-requests: write
+
+jobs:
+  migcheck:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+        with:
+          fetch-depth: 0
+      # Install your app's dependencies here.
+      - uses: Genetic-Pottery/migcheck@v0
+        with:
+          migrate: python manage.py migrate
+          workload: pytest
+```
+
+The checkout step must use `fetch-depth: 0`, so that migcheck can read the
+base release and its tags.
+
+By default, the base release is the newest tag reachable from the pull
+request's base branch. If you tag releases differently, set `base` to the ref
+running in production.
+
+The action takes the following inputs:
+
+| Input | Description |
+|---|---|
+| `migrate` | Shell command that applies migrations to `$DATABASE_URL`. Required. |
+| `workload` | Shell command that exercises the app against `$DATABASE_URL`. Required. |
+| `base` | Ref of the release running in production. Default: the newest tag reachable from the base branch. |
+| `head` | Ref of the release being deployed. Default: `HEAD` |
+| `db` | `postgres` or `mysql`. Default: `postgres` |
+| `image` | Database Docker image. Default: `postgres:17-alpine` or `mysql:8.4` |
+| `working-directory` | Directory of the repository to check. Default: `.` |
+| `comment` | Whether to post a pull request comment. Default: `true` |
+| `comment-key` | Keeps comments separate when a workflow runs migcheck more than once. Default: `default` |
+
+The action fails the job when a query breaks or migcheck can't compare, and
+sets the `result` output to `pass`, `fail`, or `error`. It also writes the
+result to the job summary.
+
+Pull requests from forks get a read-only token, so the action can't comment
+on them. The result still appears in the job summary.
+
+## Try the demo
+
+The demo builds a small repository with one base release and three candidate
+releases. Two of the candidates break the base release.
+
+```sh
+python3 -m venv /tmp/mc-venv
+/tmp/mc-venv/bin/pip install "psycopg[binary]"
+examples/make-demo.sh /tmp/mc-demo
+
+migcheck --repo /tmp/mc-demo --base v1 --head v2-rename \
+  --migrate "/tmp/mc-venv/bin/python migrate.py" \
+  --workload "/tmp/mc-venv/bin/python test_app.py"
+```
+
+| Tag | Migration | Result |
+|---|---|---|
+| `v2-expand` | Adds `full_name` next to `name` | `PASS` |
+| `v2-rename` | Renames `name` to `full_name` | `FAIL` |
+| `v2-notnull` | Adds `plan text NOT NULL` with no default | `FAIL` |
+
+## How it works
+
+1. migcheck checks out the base and head refs into temporary git worktrees.
+2. It starts a throwaway database container with statement logging on.
+3. It applies the base release's migrations, runs the base release's workload,
+   and records every query the workload makes.
+4. It makes two copies of the base schema and applies the head release's
+   migrations to one of them.
+5. It replays the recorded queries against both copies, with bind parameters
+   inlined.
+6. It reports each query that succeeds on the old schema and fails on the new
+   one.
+
+Replaying against both copies filters out queries that fail for reasons
+unrelated to the migration, such as missing seed data.
+
+Replay follows the workload's transactions. If the workload rolled back a
+transaction, as test runners do after each test, replay rolls back its effects
+too. The report lists the first failure in each transaction as a root cause and
+groups later integrity errors in that transaction separately.
+
+migcheck also accounts for how test runners use the database:
+
+- It records queries from every database the workload touches, because test
+  runners such as Django's create their own.
+- It drops DDL and transaction-control statements, which come from the test
+  runner rather than the app.
+- It replays `TRUNCATE` by emptying whichever listed tables exist, so cleanup
+  between tests doesn't depend on the schema.
+- On Postgres, it records the primary key of each row the workload inserts
+  and gives replayed inserts the same keys, so later statements that
+  reference those rows find them. On MySQL, replay starts from the same
+  auto-increment counters as the workload, so inserts get the same keys when
+  the workload runs one test at a time.
+
+Everything runs locally. The database container listens only on `127.0.0.1`,
+and migcheck removes the container and worktrees when it finishes.
+
+## Limitations
+
+- migcheck checks only the queries the workload makes. If your tests never
+  touch a table, migcheck can't see it break.
+- migcheck applies migrations to an empty database. A migration that fails or
+  locks for a long time on a large production table can pass here.
+- Replay runs one statement at a time. Failures that depend on concurrency
+  don't show up.
+- migcheck checks for errors, not wrong results. A query that returns
+  different rows on the new schema passes.
+- On Postgres, replay ignores `SAVEPOINT` and `ROLLBACK TO SAVEPOINT`.
+- On MySQL, a workload that runs tests in parallel can leave replayed rows
+  with different keys than the workload saw. Statements that reference those
+  keys then fail on both schemas, and migcheck skips them.
+- migcheck supports MySQL 8.0 and later. It doesn't support MariaDB, whose
+  query log has a different format.
+- Postgres words some errors differently for reads and writes, so one missing
+  column can appear as two root causes.
+
+## Run the tests
+
+To run the tests, run the following from the repository root:
+
+```sh
+python3 -m unittest
+```
+
+The replay tests start Postgres and MySQL containers, so they need Docker.
+Without Docker, they're skipped.
+
+The parser tests read logs that were recorded from real servers. To record
+them again, for example after you change the workload in
+`tests/capture_fixtures.py`, run `python3 -m tests.capture_fixtures`.
+
+## Release a version
+
+1. Set `version` in `pyproject.toml` to the new version, such as `0.2.0`.
+1. Add a `## v0.2.0 - YYYY-MM-DD` section to `CHANGELOG.md`.
+1. Commit, then tag and push:
+
+   ```sh
+   git tag -a v0.2.0 -m v0.2.0
+   git push origin main v0.2.0
+   ```
+
+The release workflow checks that the tag matches `pyproject.toml` and that
+`CHANGELOG.md` has a section for it, then runs the tests and builds the
+package. If they pass, it publishes the package to PyPI, creates the GitHub
+release with that section as its notes, and moves the major version tag, such
+as `v0`, to the release. If a check fails before the PyPI upload, nothing is
+released. To retry, delete the tag, fix the problem, and push the tag again.
+PyPI never accepts the same version twice, so after the upload, a fix needs a
+new version.
+
+## License
+
+Apache 2.0. See [LICENSE](https://github.com/Genetic-Pottery/migcheck/blob/main/LICENSE).