feat: state rm

[krrrr38]

what

• comment_parser can parse subcommand
  • command handles command args, so add arg count limitation by command
• add atlantis state rm ADDRESS... command
• add state_rm stage which do init and state_rm steps
  • state_rm step do terraform state rm and discard a planfile.
• not implemented in this PR
  • state_requirements like apply_requirements

why

terraform state rm is required manually. If Atlantis provides this feature, we do it on GitHub PR and so on.

references

• Closes Support atlantis state rm subcommand #273

[nitrocode]

Should there be another flag like atlantis terraform state rm ADDRESS --auto-plan-on-success ?

We spoke about it in another comment for atlantis terraform import.

[krrrr38]

Yeah, it might be helpful. In this case, we can do atlantis plan manually, so this is not a required parameter.

[nitrocode]

Thanks again for this contribution. Looks very promising!

[krrrr38]

• atlantis state rm needs NewWorkspaceStepRunnerDelegate too.

[jamengual]

We should document this in the .md docs

[krrrr38]

docs is written in https://deploy-preview-2880--runatlantis.netlify.app/docs/using-atlantis.html#atlantis-state-rm, like This command discards the terraform plan result. After run state rm and before an apply, another atlantis plan must be run again.

In addition, I added vcs comment about discarding like notify import/state rm discard plan file

---

revert to 🔁 use repeat instead warning for re-plan

[nitrocode]

This probably came up before, but why not just pass the whole cmd instead of select SubName, Flags, and Verbose like we do with buildProjectCommand and buildProjectApplyCommand ?

[krrrr38]

BuildAutoplanCommands doesn't have cmd *CommentCommand. We can do like following, but I think this should not be introduced. Because cmd := CommentCommand{Name: command.Plan} might be cause nil pointer panic or invalid implementations by contributers who want to change buildAllCommandsByCfg and don't know passed lacked CommentCommand.

>  gd
diff --git a/server/events/project_command_builder.go b/server/events/project_command_builder.go
index d1068da2..08928d88 100644
--- a/server/events/project_command_builder.go
+++ b/server/events/project_command_builder.go
@@ -207,7 +207,8 @@ type DefaultProjectCommandBuilder struct {

 // See ProjectCommandBuilder.BuildAutoplanCommands.
 func (p *DefaultProjectCommandBuilder) BuildAutoplanCommands(ctx *command.Context) ([]command.ProjectContext, error) {
-       projCtxs, err := p.buildAllCommandsByCfg(ctx, command.Plan, "", nil, false)
+       cmd := CommentCommand{Name: command.Plan}
+       projCtxs, err := p.buildAllCommandsByCfg(ctx, cmd)
        if err != nil {
                return nil, err
        }
@@ -225,7 +226,7 @@ func (p *DefaultProjectCommandBuilder) BuildAutoplanCommands(ctx *command.Contex
 // See ProjectCommandBuilder.BuildPlanCommands.
 func (p *DefaultProjectCommandBuilder) BuildPlanCommands(ctx *command.Context, cmd *CommentCommand) ([]command.ProjectContext, error) {
        if !cmd.IsForSpecificProject() {
-               return p.buildAllCommandsByCfg(ctx, cmd.CommandName(), cmd.SubName, cmd.Flags, cmd.Verbose)
+               return p.buildAllCommandsByCfg(ctx, cmd)
        }

[nitrocode]

This seems like more of a summary statement. Generally we put summary statements on its own line between the triple backticks and the * :repeat:

[krrrr38]

like this? perl -pi -e 's!* 🔁 plan file was discarded. to!🚮 A plan file was dis…

your Terraform state and will henceforth be managed by Terraform.
```

:put_litter_in_its_place: A plan file was discarded. Re-plan would be required before applying.

* :repeat: To **plan** this project again, comment:
  * `atlantis plan`

[nitrocode]

@krrrr38 is this ready to be merged?

[krrrr38]

yes

[nitrocode]

Thanks @krrrr38 ! Can't wait to try out this feature.

[gmaghera]

Can the remove behavior be overridden via custom workflows?

Those of us who use Terragrunt would love to get this feature too.

[krrrr38]

@gmaghera you can customize state rm workflow by overriing state_rm using run step`
https://www.runatlantis.io/docs/custom-workflows.html#workflow-1

In run step, you can use COMMENT_ARGS to pass args. But it has a problem which is separated by comma and so on. So now you need to do workaround like this.
Improvement is suggested in opened issue #3094.