Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Implement: atmos list values #1036

Draft
wants to merge 4 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
131 changes: 131 additions & 0 deletions cmd/list_values.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,131 @@
package cmd

import (
"fmt"

"github.com/spf13/cobra"

e "github.com/cloudposse/atmos/internal/exec"
"github.com/cloudposse/atmos/pkg/config"
l "github.com/cloudposse/atmos/pkg/list"
"github.com/cloudposse/atmos/pkg/schema"
"github.com/cloudposse/atmos/pkg/ui/theme"
u "github.com/cloudposse/atmos/pkg/utils"
)

// listValuesCmd lists component values across stacks
var listValuesCmd = &cobra.Command{
Use: "values [component]",
Short: "List component values across stacks",
Long: "List values for a component across all stacks where it is used",
Example: "atmos list values vpc\n" +
"atmos list values vpc --query .vars\n" +
"atmos list values vpc --abstract\n" +
"atmos list values vpc --max-columns 5\n" +
"atmos list values vpc --format json\n" +
"atmos list values vpc --format csv",
Args: cobra.ExactArgs(1),
Run: func(cmd *cobra.Command, args []string) {
// Check Atmos configuration
checkAtmosConfig()

flags := cmd.Flags()

queryFlag, err := flags.GetString("query")
if err != nil {
u.PrintMessageInColor(fmt.Sprintf("Error getting the 'query' flag: %v", err), theme.Colors.Error)
return
}

abstractFlag, err := flags.GetBool("abstract")
if err != nil {
u.PrintMessageInColor(fmt.Sprintf("Error getting the 'abstract' flag: %v", err), theme.Colors.Error)
return
}

maxColumnsFlag, err := flags.GetInt("max-columns")
if err != nil {
u.PrintMessageInColor(fmt.Sprintf("Error getting the 'max-columns' flag: %v", err), theme.Colors.Error)
return
}

formatFlag, err := flags.GetString("format")
if err != nil {
u.PrintMessageInColor(fmt.Sprintf("Error getting the 'format' flag: %v", err), theme.Colors.Error)
return
}

delimiterFlag, err := flags.GetString("delimiter")
if err != nil {
u.PrintMessageInColor(fmt.Sprintf("Error getting the 'delimiter' flag: %v", err), theme.Colors.Error)
return
}

// Set appropriate default delimiter based on format
if formatFlag == l.FormatCSV && delimiterFlag == l.DefaultTSVDelimiter {
delimiterFlag = l.DefaultCSVDelimiter
}

component := args[0]
configAndStacksInfo := schema.ConfigAndStacksInfo{}
atmosConfig, err := config.InitCliConfig(configAndStacksInfo, true)
if err != nil {
u.PrintMessageInColor(fmt.Sprintf("Error initializing CLI config: %v", err), theme.Colors.Error)
return
}

// Get all stacks
stacksMap, err := e.ExecuteDescribeStacks(atmosConfig, "", nil, nil, nil, false, false, false, false, nil)
if err != nil {
u.PrintMessageInColor(fmt.Sprintf("Error describing stacks: %v", err), theme.Colors.Error)
return
}

output, err := l.FilterAndListValues(stacksMap, component, queryFlag, abstractFlag, maxColumnsFlag, formatFlag, delimiterFlag)
if err != nil {
u.PrintMessageInColor(fmt.Sprintf("Error: %v"+"\n", err), theme.Colors.Warning)
return
}

u.PrintMessageInColor(output, theme.Colors.Success)
},
}

// listVarsCmd is an alias for 'list values --query .vars'
var listVarsCmd = &cobra.Command{
Use: "vars [component]",
Short: "List component vars across stacks (alias for 'list values --query .vars')",
Long: "List vars for a component across all stacks where it is used",
Example: "atmos list vars vpc\n" +
"atmos list vars vpc --abstract\n" +
"atmos list vars vpc --max-columns 5\n" +
"atmos list vars vpc --format json\n" +
"atmos list vars vpc --format csv",
Args: cobra.ExactArgs(1),
Run: func(cmd *cobra.Command, args []string) {
// Set the query flag to .vars
if err := cmd.Flags().Set("query", ".vars"); err != nil {
u.PrintMessageInColor(fmt.Sprintf("Error setting query flag: %v", err), theme.Colors.Error)
return
}
// Run the values command
listValuesCmd.Run(cmd, args)
},
}

func init() {
// Flags for both commands
commonFlags := func(cmd *cobra.Command) {
cmd.PersistentFlags().String("query", "", "JMESPath query to filter values")
cmd.PersistentFlags().Bool("abstract", false, "Include abstract components")
cmd.PersistentFlags().Int("max-columns", 10, "Maximum number of columns to display")
cmd.PersistentFlags().String("format", "", "Output format (table, json, csv, tsv)")
cmd.PersistentFlags().String("delimiter", "\t", "Delimiter for csv/tsv output (default: tab for tsv, comma for csv)")
}

commonFlags(listValuesCmd)
commonFlags(listVarsCmd)

listCmd.AddCommand(listValuesCmd)
listCmd.AddCommand(listVarsCmd)
}
2 changes: 1 addition & 1 deletion go.mod

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

206 changes: 206 additions & 0 deletions pkg/list/list_values.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,206 @@
package list

import (
"encoding/json"
"fmt"
"sort"
"strings"

"github.com/charmbracelet/lipgloss"
"github.com/charmbracelet/lipgloss/table"
"github.com/cloudposse/atmos/internal/exec"
"github.com/cloudposse/atmos/pkg/ui/theme"
"github.com/cloudposse/atmos/pkg/utils"
"github.com/jmespath/go-jmespath"
)

const (
DefaultCSVDelimiter = ","
DefaultTSVDelimiter = "\t"
)

// FilterAndListValues filters and lists component values across stacks
func FilterAndListValues(stacksMap map[string]interface{}, component, query string, includeAbstract bool, maxColumns int, format, delimiter string) (string, error) {
if err := ValidateFormat(format); err != nil {
return "", err
}

// Set default delimiters based on format
if format == FormatCSV && delimiter == DefaultTSVDelimiter {
delimiter = DefaultCSVDelimiter
}

// Filter out stacks that don't have the component
filteredStacks := make(map[string]interface{})
for stackName, stackData := range stacksMap {
stack, ok := stackData.(map[string]interface{})
if !ok {
continue
}

components, ok := stack["components"].(map[string]interface{})
if !ok {
continue
}

terraform, ok := components["terraform"].(map[string]interface{})
if !ok {
continue
}

if componentConfig, exists := terraform[component]; exists {
// Skip abstract components if not included
if !includeAbstract {
if config, ok := componentConfig.(map[string]interface{}); ok {
if isAbstract, ok := config["abstract"].(bool); ok && isAbstract {
continue
}
}
}
filteredStacks[stackName] = componentConfig
}
}

if len(filteredStacks) == 0 {
return fmt.Sprintf("No values found for component '%s'", component), nil
}

// Apply JMESPath query if provided
if query != "" {
for stackName, stackData := range filteredStacks {
result, err := jmespath.Search(query, stackData)
if err != nil {
return "", fmt.Errorf("error applying query to stack '%s': %w", stackName, err)
}
filteredStacks[stackName] = result
}
}

// Get all unique keys from all stacks
keys := make(map[string]bool)
for _, stackData := range filteredStacks {
if data, ok := stackData.(map[string]interface{}); ok {
for k := range data {
keys[k] = true
}
}
}

// Convert keys to sorted slice
var sortedKeys []string
for k := range keys {
sortedKeys = append(sortedKeys, k)
}
sort.Strings(sortedKeys)

// Get sorted stack names
var stackNames []string
for stackName := range filteredStacks {
stackNames = append(stackNames, stackName)
}
sort.Strings(stackNames)

// Apply max columns limit
if maxColumns > 0 && len(stackNames) > maxColumns {
stackNames = stackNames[:maxColumns]
}

// Create rows with values
var rows [][]string
for _, key := range sortedKeys {
row := make([]string, len(stackNames)+1)
row[0] = key
for i, stackName := range stackNames {
stackData := filteredStacks[stackName]
if data, ok := stackData.(map[string]interface{}); ok {
if val, exists := data[key]; exists {
// Convert value to string representation
switch v := val.(type) {
case string:
row[i+1] = v
case nil:
row[i+1] = "null"
default:
jsonBytes, err := json.Marshal(v)
if err != nil {
row[i+1] = fmt.Sprintf("%v", v)
} else {
row[i+1] = string(jsonBytes)
}
}
}
}
}
rows = append(rows, row)
}

// Create header row
header := make([]string, len(stackNames)+1)
header[0] = "Key"
copy(header[1:], stackNames)

// Handle different output formats
switch format {
case FormatJSON:
// Create a map of stacks and their values
result := make(map[string]interface{})
for i, stackName := range stackNames {
stackValues := make(map[string]interface{})
for _, row := range rows {
if row[i+1] != "" {
var value interface{}
if err := json.Unmarshal([]byte(row[i+1]), &value); err == nil {
stackValues[row[0]] = value
} else {
stackValues[row[0]] = row[i+1]
}
}
}
result[stackName] = stackValues
}
jsonBytes, err := json.MarshalIndent(result, "", " ")
if err != nil {
return "", fmt.Errorf("error formatting JSON output: %w", err)
}
return string(jsonBytes), nil

case FormatCSV, FormatTSV:
var output strings.Builder
output.WriteString(strings.Join(header, delimiter) + utils.GetLineEnding())
for _, row := range rows {
output.WriteString(strings.Join(row, delimiter) + utils.GetLineEnding())
}
return output.String(), nil

default:
// If format is empty or "table", use table format
if format == "" && exec.CheckTTYSupport() {
// Create a styled table for TTY
t := table.New().
Border(lipgloss.ThickBorder()).
BorderStyle(lipgloss.NewStyle().Foreground(lipgloss.Color(theme.ColorBorder))).
StyleFunc(func(row, col int) lipgloss.Style {
style := lipgloss.NewStyle().PaddingLeft(1).PaddingRight(1)
if row == -1 {
return style.Inherit(theme.Styles.CommandName).Align(lipgloss.Center)
}
if col == 0 {
return style.Inherit(theme.Styles.CommandName)
}
return style.Inherit(theme.Styles.Description)
}).
Headers(header...).
Rows(rows...)

return t.String() + utils.GetLineEnding(), nil
}

// Default to simple tabular format for non-TTY or when format is explicitly "table"
var output strings.Builder
output.WriteString(strings.Join(header, delimiter) + utils.GetLineEnding())
for _, row := range rows {
output.WriteString(strings.Join(row, delimiter) + utils.GetLineEnding())
}
return output.String(), nil
}
}
3 changes: 2 additions & 1 deletion pkg/list/list_workflows.go
Original file line number Diff line number Diff line change
Expand Up @@ -23,14 +23,15 @@ const (
FormatTable = "table"
FormatJSON = "json"
FormatCSV = "csv"
FormatTSV = "tsv"
)

// ValidateFormat checks if the given format is supported
func ValidateFormat(format string) error {
if format == "" {
return nil
}
validFormats := []string{FormatTable, FormatJSON, FormatCSV}
validFormats := []string{FormatTable, FormatJSON, FormatCSV, FormatTSV}
for _, f := range validFormats {
if format == f {
return nil
Expand Down
Loading
Loading