opentf/internal/command/views/refresh.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/command/views/json"
	"github.com/opentofu/opentofu/internal/states"
	"github.com/opentofu/opentofu/internal/tfdiags"
	"github.com/opentofu/opentofu/internal/tofu"
)

// The Refresh view is used for the refresh command.
type Refresh interface {
	Outputs(outputValues map[string]*states.OutputValue)

	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
}

// NewRefresh returns an initialized Refresh implementation for the given ViewType.
func NewRefresh(args arguments.ViewOptions, view *View) Refresh {
	var refresh Refresh
	switch args.ViewType {
	case arguments.ViewJSON:
		refresh = &RefreshJSON{
			view: NewJSONView(view, nil),
		}
	case arguments.ViewHuman:
		refresh = &RefreshHuman{
			view:         view,
			inAutomation: view.RunningInAutomation(),
			countHook:    &countHook{},
		}
	default:
		panic(fmt.Sprintf("unknown view type %v", args.ViewType))
	}

	if args.JSONInto != nil {
		refresh = RefreshMulti{refresh, &RefreshJSON{
			view: NewJSONView(view, args.JSONInto),
		}}
	}
	return refresh
}

type RefreshMulti []Refresh

var _ Refresh = (RefreshMulti)(nil)

func (m RefreshMulti) Outputs(outputValues map[string]*states.OutputValue) {
	for _, r := range m {
		r.Outputs(outputValues)
	}
}

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

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

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

func (m RefreshMulti) HelpPrompt() {
	for _, r := range m {
		r.HelpPrompt()
	}
}

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

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

	inAutomation bool

	countHook *countHook
}

var _ Refresh = (*RefreshHuman)(nil)

func (v *RefreshHuman) Outputs(outputValues map[string]*states.OutputValue) {
	if len(outputValues) > 0 {
		v.view.streams.Print(v.view.colorize.Color("[reset][bold][green]\nOutputs:\n\n"))
		NewOutput(arguments.ViewOptions{ViewType: arguments.ViewHuman}, v.view).Output("", outputValues)
	}
}

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

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

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

func (v *RefreshHuman) HelpPrompt() {
	v.view.HelpPrompt("refresh")
}

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

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

var _ Refresh = (*RefreshJSON)(nil)

func (v *RefreshJSON) Outputs(outputValues map[string]*states.OutputValue) {
	outputs, diags := json.OutputsFromMap(outputValues)
	if diags.HasErrors() {
		v.Diagnostics(diags)
	} else {
		v.view.Outputs(outputs)
	}
}

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

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

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

func (v *RefreshJSON) HelpPrompt() {
}

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