Add "auto approve" flag to "schema apply" command #526
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
masseelch
reviewed
Jan 29, 2022
cmd/action/apply.go
Outdated
| @@ -53,6 +54,7 @@ func init() { | |||
| ApplyCmd.Flags().BoolVarP(&ApplyFlags.DryRun, "dry-run", "", false, "Dry-run. Print SQL plan without prompting for execution") | |||
| ApplyCmd.Flags().StringVarP(&ApplyFlags.Addr, "addr", "", "127.0.0.1:5800", "used with -w, local address to bind the server to") | |||
| ApplyCmd.Flags().StringSliceVarP(&ApplyFlags.Schema, "schema", "s", nil, "Set schema name") | |||
| ApplyCmd.Flags().BoolVarP(&ApplyFlags.AutoApprove, "approve", "", false, "Auto approve. Apply the schema changes without prompting for approval") | |||
There was a problem hiding this comment.
I'd try to be more in line what flags like this are usually called. So I propose for --force / -f or --no-interaction or something similar.
There was a problem hiding this comment.
Tbh I think for the apply command we can stick to the terraform lingo, since users coming from there will feel at home we can do :
There was a problem hiding this comment.
I went with --auto-approve because I felt like --force / -f would conflict with the existing -f argument. Open to other ideas too
cmd/action/apply.go
Outdated
Comment on lines
120
to
126
| if autoApprove { | ||
| schemaCmd.Println("Applying changes (automatically approved with --approve flag)") | ||
| err = d.ApplyChanges(ctx, changes) | ||
| cobra.CheckErr(err) | ||
| return | ||
| } |
There was a problem hiding this comment.
Maybe put the prompt in an extra func and only do this:
if autoApprove || promptUser() {
cobra.CheckErr(d.ApplyChanges(ctx, changes))
}
|
When running the integration tests, some of the tests failed. But the new one I added appeared to pass. Let me know if you'd like me to change anything there. I've included details below for how I ran the tests in case I did something incorrectly And here are the failures I got |
masseelch
approved these changes
Jan 30, 2022
| } | ||
|
|
||
| func applyRun(d *Driver, dsn string, file string, dryRun bool) { | ||
| func applyRun(d *Driver, dsn string, file string, dryRun bool, autoApprove bool) { |
There was a problem hiding this comment.
@rotemtam should we introduce a small config struct here?
There was a problem hiding this comment.
Yes, but can be done in additional PR.
- rename flag to "auto-approve" - refactor user prompt into new function
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.
Closes #519
Summary
--approveboolean flag toschema applycommand. Default: false. When true, applies schema changes to given DSN without prompting user for approval. Useful for CI environmentsNotes
--approveinstead of--applybecause I felt like runningatlas schema apply --applywould feel kind of strange, but I'm totally open to other naming options.Docker Compose config:
Steps
docker-compose run --rm --service-ports go bashdocker-compose exec db bashpsql dev -U postgrescreate table testing (id text, name text); \qcreatedb testing -U postgrescd app && go run ./cmd/atlas schema inspect -d "$DB_URL" > atlas.hclgo run ./cmd/atlas schema apply -d "postgres://postgres:postgres@db:5432/testing?sslmode=disable" -f atlas.hcl --approveTo run the integration tests, I followed the general idea from
.github/workflows/ci.yml: