steampipe/pkg/control/controldisplay/table.go

package controldisplay

import (
	"strings"

	"github.com/spf13/viper"
	"github.com/turbot/steampipe/pkg/constants"
	"github.com/turbot/steampipe/pkg/control/controlexecute"
)

type TableRenderer struct {
	resultTree *controlexecute.ExecutionTree

	// screen width
	width             int
	maxFailedControls int
	maxTotalControls  int
}

func NewTableRenderer(resultTree *controlexecute.ExecutionTree) *TableRenderer {
	return &TableRenderer{
		resultTree:        resultTree,
		maxFailedControls: resultTree.Root.Summary.Status.FailedCount(),
		maxTotalControls:  resultTree.Root.Summary.Status.TotalCount(),
	}
}

// MinimumWidth is the width we require
// It is determined by the left indent, title, severity, counter and counter graph
func (r TableRenderer) MinimumWidth() int {
	minimumWidthRequired := r.maxIndent() + minimumGroupTitleWidth + severityMaxLen + minimumCounterWidth + counterGraphSegments
	return minimumWidthRequired
}

func (r TableRenderer) maxIndent() int {
	depth := r.groupDepth(r.resultTree.Root, 0)
	// each indent level is "| " or "+ " (2 characters)
	return (depth * 2)
}

func (r TableRenderer) groupDepth(g *controlexecute.ResultGroup, myDepth int) int {
	if len(g.Groups) == 0 {
		return 0
	}
	maxDepth := 0
	for _, subGroup := range g.Groups {
		branchDepth := r.groupDepth(subGroup, myDepth+1)
		if branchDepth > maxDepth {
			maxDepth = branchDepth
		}
	}
	return myDepth + maxDepth
}

func (r TableRenderer) Render(width int) string {
	r.width = width

	// the buffer to put the output data in
	builder := strings.Builder{}

	builder.WriteString(r.renderResult())
	builder.WriteString("\n")
	builder.WriteString(r.renderSummary())

	return builder.String()
}

func (r TableRenderer) renderSummary() string {
	// no need to render the summary when the dry-run flag is set
	if viper.GetBool(constants.ArgDryRun) {
		return ""
	}
	return NewSummaryRenderer(r.resultTree, r.width).Render()
}

func (r TableRenderer) renderResult() string {
	return NewGroupRenderer(r.resultTree.Root, nil, r.maxFailedControls, r.maxTotalControls, r.resultTree, r.width).Render()
}