opentf/internal/command/views/plan.go

// Copyright (c) The OpenTofu Authors
// SPDX-License-Identifier: MPL-2.0
// Copyright (c) 2023 HashiCorp, Inc.
// SPDX-License-Identifier: MPL-2.0

package views

import (
	"fmt"

	"github.com/opentofu/opentofu/internal/command/arguments"
	"github.com/opentofu/opentofu/internal/tfdiags"
	"github.com/opentofu/opentofu/internal/tofu"
)

// The Plan view is used for the plan command.
type Plan interface {
	Operation() Operation
	Hooks() []tofu.Hook

	Diagnostics(diags tfdiags.Diagnostics)
	HelpPrompt()

	// Backend returns the non-command view that contains methods to provide
	// progress output for the backend operations.
	Backend() Backend
}

// NewPlan returns an initialized Plan implementation for the given ViewType.
func NewPlan(args arguments.ViewOptions, view *View) Plan {
	var plan Plan
	switch args.ViewType {
	case arguments.ViewJSON:
		plan = &PlanJSON{
			view: NewJSONView(view, nil),
		}
	case arguments.ViewHuman:
		plan = &PlanHuman{
			view:         view,
			inAutomation: view.RunningInAutomation(),
		}
	default:
		panic(fmt.Sprintf("unknown view type %v", args.ViewType))
	}

	if args.JSONInto != nil {
		plan = PlanMulti{plan, &PlanJSON{view: NewJSONView(view, args.JSONInto)}}
	}

	return plan
}

type PlanMulti []Plan

var _ Plan = (PlanMulti)(nil)

func (m PlanMulti) Operation() Operation {
	var operation OperationMulti
	for _, plan := range m {
		operation = append(operation, plan.Operation())
	}
	return operation
}

func (m PlanMulti) Hooks() []tofu.Hook {
	var hooks []tofu.Hook
	for _, plan := range m {
		hooks = append(hooks, plan.Hooks()...)
	}
	return hooks
}

func (m PlanMulti) Diagnostics(diags tfdiags.Diagnostics) {
	for _, plan := range m {
		plan.Diagnostics(diags)
	}
}

func (m PlanMulti) HelpPrompt() {
	for _, plan := range m {
		plan.HelpPrompt()
	}
}

func (m PlanMulti) Backend() Backend {
	ret := make([]Backend, len(m))
	for i, v := range m {
		ret[i] = v.Backend()
	}
	return BackendMulti(ret)
}

// The PlanHuman implementation renders human-readable text logs, suitable for
// a scrolling terminal.
type PlanHuman struct {
	view *View

	inAutomation bool
}

var _ Plan = (*PlanHuman)(nil)

func (v *PlanHuman) Operation() Operation {
	return NewOperation(arguments.ViewHuman, v.inAutomation, v.view)
}

func (v *PlanHuman) Hooks() []tofu.Hook {
	return []tofu.Hook{NewUIOptionalHook(v.view)}
}

func (v *PlanHuman) Diagnostics(diags tfdiags.Diagnostics) {
	v.view.Diagnostics(diags)
}

func (v *PlanHuman) HelpPrompt() {
	v.view.HelpPrompt("plan")
}

func (v *PlanHuman) Backend() Backend {
	return &BackendHuman{
		view: v.view,
	}
}

// The PlanJSON implementation renders streaming JSON logs, suitable for
// integrating with other software.
type PlanJSON struct {
	view *JSONView
}

var _ Plan = (*PlanJSON)(nil)

func (v *PlanJSON) Operation() Operation {
	return &OperationJSON{view: v.view}
}

func (v *PlanJSON) Hooks() []tofu.Hook {
	return []tofu.Hook{
		newJSONHook(v.view),
	}
}

func (v *PlanJSON) Diagnostics(diags tfdiags.Diagnostics) {
	v.view.Diagnostics(diags)
}

func (v *PlanJSON) HelpPrompt() {
}

func (v *PlanJSON) Backend() Backend {
	return &BackendJSON{
		view: v.view,
	}
}