feat: adds --skip-init flag

[Gowiem]

what

• Adds a --skip-init flag which allows skipping terraform init

why

• This can help speed up workflows in the case that the user knows their last command successfully ran terraform init and they do not need to run init again.

references

• atmos terraform commands should have a --skip-init flag #178

[Gowiem]

Hey @aknysh -- this isn't ready because I have an issue that I'd like to get your thoughts on: When passing --skip-init, this works successfully to skip over the terraform init process, but unfortunately atmos then passes the --skip-init flag down to terraform via Arguments and flags: [--skip-init], which we don't want.

To clarify, the following happens:

1. I run the following: /localhost/Workspace/Contracting/cp/atmos/build/atmos terraform plan monitor -s dev --skip-init
2. It skips over terraform init and prints the correct "Skipping over terraform init due to --skip-init being passed." message.
3. It then goes to execute terraform plan and errors with the following:

Executing command:
/usr/bin/terraform plan -var-file dev-monitor.terraform.tfvars.json -out dev-monitor.planfile --skip-init

│ Error: Failed to parse command-line flags
│
│ flag provided but not defined: -skip-init

So couple questions here:

1. How do you deal with this for --dry-run? Is there some other way I should be going about implementing this?
2. Any suggestions on how I could test this functionality?

[aknysh]

@Gowiem thanks for this PR.

See https://github.com/cloudposse/atmos/blob/master/internal/exec/utils.go#L16

commonFlags are a list of flags that atmos understands but not terraform/helmfile etc.
The flags get removed from the arg list after atmos uses it and then passes them down to terraform/helmfile.

You need to add your flag to the list.
And please add a comment for the var to explain what I just explained.

To test it:

From the root of the repo, you can execute any atmos commands like this:

go run github.com/cloudposse/atmos help
go run github.com/cloudposse/atmos describe stacks
go run github.com/cloudposse/atmos terraform plan test-component  -s tenant1-ue2-dev

It uses the component and stacks from the examples/complete.

To test your flag:

go run github.com/cloudposse/atmos terraform plan test/test-component  -s tenant1-ue2-dev --skip-init

Thanks

[Gowiem]

@aknysh Ah good stuff on commonFlags. Thanks for the pointer!

Regarding testing, I was able to build in a client toolbox image and test it out. I'm more interested to know if you'd like unit tests and if you have any suggestions for unit testing it.

[aknysh]

@aknysh Ah good stuff on commonFlags. Thanks for the pointer!

Regarding testing, I was able to build in a client toolbox image and test it out. I'm more interested to know if you'd like unit tests and if you have any suggestions for unit testing it.

not sure about what unit testing would do (please explain), but we have a ton of tests in the repo, we try to add tests for every new feature we introduce. Go runs all of them automatically

[Gowiem]

@aknysh I've added --skip-init to commonFlags, the help docs, and made sure to add a comment to commonFlags so that is more clear in the future. I also tested this locally and it's now working as I would expect. No rush, but I think it's now ready for a review 👍

[aknysh]

thanks @Gowiem