Add CI checks in separate PR #1347
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| @@ -72,6 +72,42 @@ jobs: | |||
| engine.stderr.log | |||
| retention-days: 14 | |||
|
|
|||
| migrations: | |||
There was a problem hiding this comment.
Todo: this should run as part of CI as well. Eventually, I'd like to see these separate jobs go away and run a single CI pipeline. Individual functions should be available as a convenience feature for local dev.
ci/migrate.go
Outdated
Comment on lines
32
to
46
| p.Go(syncFunc(nix. | ||
| WithServiceBinding("postgres", postgresNamed("no-diff")). | ||
| WithExec([]string{"sh", "-c", "nix develop --impure .#dagger -c atlas migrate --env ci diff test"}). | ||
| WithExec([]string{"sh", "-c", "nix develop --impure .#dagger -c sh -c 'if [[ -n $(git status --porcelain ./tools/migrate/migrations) ]]; then echo \"Migrations directory is dirty\"; exit 1; fi' "}), | ||
| )) | ||
| // Always lint last 10 migrations | ||
| p.Go(syncFunc(nix. | ||
| WithServiceBinding("postgres", postgresNamed("last-10")). | ||
| WithExec([]string{"sh", "-c", "nix develop --impure .#dagger -c atlas migrate --env ci lint --latest 10"}), | ||
| )) | ||
| // Validate checksum is intact | ||
| p.Go(syncFunc(nix. | ||
| WithServiceBinding("postgres", postgresNamed("validate")). | ||
| WithExec([]string{"sh", "-c", "nix develop --impure .#dagger -c atlas migrate --env ci validate"}), | ||
| )) |
There was a problem hiding this comment.
I would probably just use this image: https://hub.docker.com/r/arigaio/atlas
ci/migrate.go
Outdated
|
|
||
| // Always validate schema is generated | ||
| p.Go(syncFunc(nix. | ||
| WithExec([]string{"sh", "-c", "nix develop --impure .#dagger -c go generate ./internal/ent/..."}). |
There was a problem hiding this comment.
You could use the go moule to generate the code and then extract the directory using .Container().Directory().
ci/migrate.go
Outdated
| // Always validate schema is generated | ||
| p.Go(syncFunc(nix. | ||
| WithExec([]string{"sh", "-c", "nix develop --impure .#dagger -c go generate ./internal/ent/..."}). | ||
| WithExec([]string{"sh", "-c", "nix develop --impure .#dagger -c sh -c 'if [[ -n $(git status --porcelain ./internal/ent) ]]; then echo \"Ent schema wasnt generated\"; exit 1; fi' "}), |
There was a problem hiding this comment.
You can either use Git here, but you could also try using dagger.Directory.Diff to see if there is a diff between the first and the last version. That would utilize caching more.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Overview
Adds checks to validate the integrity of migrations:
go test ...)internal/ent/dbin sync withinternal/ent/schema)atlas lintfor last 10 migration files checking for migrations being non-destructive and linear (10 is arbitrary)The checks can also be run locally via
make migrate-checkFixes the atlas nix derivation to use platform specific version
Note: it's templated locally, not the ideal solution but I have some skill issues with nix
Follow Up Items
Notes for reviewer
The checks are implemented in dagger, and for dependency management a nix-in-dagger solution was used. This is somewhat questionable, the 2 main drawbacks are:
(this latter is decently mitigated by caching but still)
The benefit form my point of view is that it's an exact replica the local environment by using the same derivation(s)