feat: goose validate command

[mfridman]

Fixes #448

• what about .go files, should they be displayed?

[VojtechVitek]

So this is a sanity check for the SQL migrations, right?

Do the numbers represent count of SQL statements?

Go migrations would be nice to support too, I guess we could print func vs. <nil>. And tx ✔️ based on the func signature.

Thinking of better names:
goose check
or
goose inspect

[mfridman]

Yep, intended to be a command users can run to sanity-check their migration files.

I noticed some users only find out about malformed migration files (especially down migrations) when it's too late. Here's a real-world example, where migration 35 is missing a semicolon.

https://github.com/smartcontractkit/chainlink/blob/develop/core/store/migrate/migrations/0035_create_feeds_managers.sql#L13

And running this proposed command would catch this error:

goose verify: failed to parse down "core/store/migrate/migrations/0035_create_feeds_managers.sql": error: failed to parse migration: state 4, direction: down: unexpected unfinished SQL query: "DROP TABLE feeds_managers": missing semicolon?

A lot of projects don't have a robust set of tests like we have, i.e., up, down, up then drop schema and compare it to the checked-in schema.

Great idea to include the .go migrations!

[mfridman]

wrote a simple parser for .go files using the std lib ast parser packages.

Type  Txn  Up  Down  Name
────  ───  ──  ────  ────
sql   ✔    1   1     00001_create_tables_repos_stargazers.sql
sql   ✔    1   1     00002_update_respos_add_owner_info.sql
sql   ✔    1   1     00003_update_respos_add_owner_type.sql
sql   ✔    1   1     00004_add_seq_id_stargazers.sql
sql   ✘    2   1     00005_add_index_stargazers.sql
sql   ✔    1   1     00006_create_matview_stars_day.sql
sql   ✔    1   1     00007_create_matview_stars_month.sql
sql   ✔    1   1     00008_create_matview_stars_year.sql
go    ✔    1   0     00009_fix_description_emojis.go. <--------- go migration, 1 up and nil down
sql   ✔    1   1     00010_add_mat_view_all.sql

[mfridman]

Still can't think of a good name for this command, cc @VojtechVitek what do you think? Suggestions welcome...

I think goose validate resonates the most.

goose validate
goose check
goose ls-files
goose vet
goose lint
goose verify
goose ...

Other examples

The terraform validate command validates the configuration files in a directory, referring only to the configuration and not accessing any remote services such as remote state, provider APIs, etc.

https://developer.hashicorp.com/terraform/cli/commands/validate

[VojtechVitek]

validate is a pretty good name :)

[mfridman]

It's possible folks might want this functionality exposed in the goose package, if so, we can move this to the top level or create a pkg with helpful utilities unrelated to migration logic per se.

[mfridman]

Pretty happy with how this turned out, been finding this command awfully useful.

Some nice-to-have for the future:

• output as json
• additional Walk implementations (probably taking []*Migration)
• maybe filtering and/or exclusion, although if we support json then that can be left to the caller with jq
• move migrationstats out of ./internal