mirror of
https://github.com/hashicorp/terraform.git
synced 2026-03-03 05:50:43 -05:00
2559151d0a
Callers expect to be given an updated set of counts for how many of each action were completed, which we'll achieve by having the terraform.Hook implementation keep track of those and then announce them based on what it collected. We can't use the plan for this directly because terraform.Context.Plan seems to modify the plan it's given during its work, and on success the plan ends up being totally empty.
82 lines
3 KiB
Go
82 lines
3 KiB
Go
// Copyright (c) HashiCorp, Inc.
|
|
// SPDX-License-Identifier: BUSL-1.1
|
|
|
|
package hooks
|
|
|
|
import (
|
|
"github.com/hashicorp/terraform/internal/plans"
|
|
"github.com/hashicorp/terraform/internal/rpcapi/terraform1"
|
|
"github.com/hashicorp/terraform/internal/stacks/stackaddrs"
|
|
)
|
|
|
|
// ComponentInstanceStatus is a UI-focused description of the overall status
|
|
// for a given component instance undergoing a Terraform plan or apply
|
|
// operation. The "pending" and "errored" status are used for both operation
|
|
// types, and the others will be used only for one of plan or apply.
|
|
type ComponentInstanceStatus rune
|
|
|
|
//go:generate go run golang.org/x/tools/cmd/stringer -type=ComponentInstanceStatus component_instance.go
|
|
|
|
const (
|
|
ComponentInstanceStatusInvalid ComponentInstanceStatus = 0
|
|
ComponentInstancePending ComponentInstanceStatus = '.'
|
|
ComponentInstancePlanning ComponentInstanceStatus = 'p'
|
|
ComponentInstancePlanned ComponentInstanceStatus = 'P'
|
|
ComponentInstanceApplying ComponentInstanceStatus = 'a'
|
|
ComponentInstanceApplied ComponentInstanceStatus = 'A'
|
|
ComponentInstanceErrored ComponentInstanceStatus = 'E'
|
|
)
|
|
|
|
// TODO: move this into the rpcapi package somewhere
|
|
func (s ComponentInstanceStatus) ForProtobuf() terraform1.StackChangeProgress_ComponentInstanceStatus_Status {
|
|
switch s {
|
|
case ComponentInstancePending:
|
|
return terraform1.StackChangeProgress_ComponentInstanceStatus_PENDING
|
|
case ComponentInstancePlanning:
|
|
return terraform1.StackChangeProgress_ComponentInstanceStatus_PLANNING
|
|
case ComponentInstancePlanned:
|
|
return terraform1.StackChangeProgress_ComponentInstanceStatus_PLANNED
|
|
case ComponentInstanceApplying:
|
|
return terraform1.StackChangeProgress_ComponentInstanceStatus_APPLYING
|
|
case ComponentInstanceApplied:
|
|
return terraform1.StackChangeProgress_ComponentInstanceStatus_APPLIED
|
|
case ComponentInstanceErrored:
|
|
return terraform1.StackChangeProgress_ComponentInstanceStatus_ERRORED
|
|
default:
|
|
return terraform1.StackChangeProgress_ComponentInstanceStatus_INVALID
|
|
}
|
|
}
|
|
|
|
// ComponentInstanceChange is the argument type for hook callbacks which
|
|
// signal a set of planned or applied changes for a component instance.
|
|
type ComponentInstanceChange struct {
|
|
Addr stackaddrs.AbsComponentInstance
|
|
Add int
|
|
Change int
|
|
Import int
|
|
Remove int
|
|
}
|
|
|
|
// Total sums all of the change counts as a forwards-compatibility measure. If
|
|
// we later add a new change type, older clients will still be able to detect
|
|
// that the component instance has some unknown changes, rather than falsely
|
|
// stating that there are no changes at all.
|
|
func (cic ComponentInstanceChange) Total() int {
|
|
return cic.Add + cic.Change + cic.Import + cic.Remove
|
|
}
|
|
|
|
// CountNewAction increments zero or more of the count fields based on the
|
|
// given action.
|
|
func (cic *ComponentInstanceChange) CountNewAction(action plans.Action) {
|
|
switch action {
|
|
case plans.Create:
|
|
cic.Add++
|
|
case plans.Delete:
|
|
cic.Remove++
|
|
case plans.Update:
|
|
cic.Change++
|
|
case plans.CreateThenDelete, plans.DeleteThenCreate:
|
|
cic.Add++
|
|
cic.Remove++
|
|
}
|
|
}
|