|
| 1 | +package list |
| 2 | + |
| 3 | +import ( |
| 4 | + "testing" |
| 5 | + |
| 6 | + "github.com/spf13/cobra" |
| 7 | + "github.com/stretchr/testify/assert" |
| 8 | + |
| 9 | + l "github.com/cloudposse/atmos/pkg/list" |
| 10 | +) |
| 11 | + |
| 12 | +// TestListMetadataFlags tests that the list metadata command has the correct flags. |
| 13 | +func TestListMetadataFlags(t *testing.T) { |
| 14 | + cmd := &cobra.Command{ |
| 15 | + Use: "metadata [component]", |
| 16 | + Short: "List metadata across stacks", |
| 17 | + Long: "List metadata information across all stacks or for a specific component", |
| 18 | + } |
| 19 | + |
| 20 | + cmd.PersistentFlags().String("format", "", "Output format") |
| 21 | + cmd.PersistentFlags().String("delimiter", "", "Delimiter for CSV/TSV output") |
| 22 | + cmd.PersistentFlags().String("stack", "", "Stack pattern") |
| 23 | + cmd.PersistentFlags().String("query", "", "JQ query") |
| 24 | + cmd.PersistentFlags().Int("max-columns", 0, "Maximum columns") |
| 25 | + cmd.PersistentFlags().Bool("process-templates", true, "Enable/disable Go template processing") |
| 26 | + cmd.PersistentFlags().Bool("process-functions", true, "Enable/disable YAML functions processing") |
| 27 | + |
| 28 | + formatFlag := cmd.PersistentFlags().Lookup("format") |
| 29 | + assert.NotNil(t, formatFlag, "Expected format flag to exist") |
| 30 | + assert.Equal(t, "", formatFlag.DefValue) |
| 31 | + |
| 32 | + delimiterFlag := cmd.PersistentFlags().Lookup("delimiter") |
| 33 | + assert.NotNil(t, delimiterFlag, "Expected delimiter flag to exist") |
| 34 | + assert.Equal(t, "", delimiterFlag.DefValue) |
| 35 | + |
| 36 | + stackFlag := cmd.PersistentFlags().Lookup("stack") |
| 37 | + assert.NotNil(t, stackFlag, "Expected stack flag to exist") |
| 38 | + assert.Equal(t, "", stackFlag.DefValue) |
| 39 | + |
| 40 | + queryFlag := cmd.PersistentFlags().Lookup("query") |
| 41 | + assert.NotNil(t, queryFlag, "Expected query flag to exist") |
| 42 | + assert.Equal(t, "", queryFlag.DefValue) |
| 43 | + |
| 44 | + maxColumnsFlag := cmd.PersistentFlags().Lookup("max-columns") |
| 45 | + assert.NotNil(t, maxColumnsFlag, "Expected max-columns flag to exist") |
| 46 | + assert.Equal(t, "0", maxColumnsFlag.DefValue) |
| 47 | + |
| 48 | + processTemplatesFlag := cmd.PersistentFlags().Lookup("process-templates") |
| 49 | + assert.NotNil(t, processTemplatesFlag, "Expected process-templates flag to exist") |
| 50 | + assert.Equal(t, "true", processTemplatesFlag.DefValue) |
| 51 | + |
| 52 | + processFunctionsFlag := cmd.PersistentFlags().Lookup("process-functions") |
| 53 | + assert.NotNil(t, processFunctionsFlag, "Expected process-functions flag to exist") |
| 54 | + assert.Equal(t, "true", processFunctionsFlag.DefValue) |
| 55 | +} |
| 56 | + |
| 57 | +// TestListMetadataCommand tests the metadata command structure. |
| 58 | +func TestListMetadataCommand(t *testing.T) { |
| 59 | + assert.Equal(t, "metadata [component]", metadataCmd.Use) |
| 60 | + assert.Contains(t, metadataCmd.Short, "List metadata across stacks") |
| 61 | + assert.NotNil(t, metadataCmd.RunE) |
| 62 | + assert.NotEmpty(t, metadataCmd.Example) |
| 63 | +} |
| 64 | + |
| 65 | +// TestSetupMetadataOptions tests the setupMetadataOptions function. |
| 66 | +func TestSetupMetadataOptions(t *testing.T) { |
| 67 | + testCases := []struct { |
| 68 | + name string |
| 69 | + opts *MetadataOptions |
| 70 | + componentFilter string |
| 71 | + expectedQuery string |
| 72 | + expectedComp string |
| 73 | + }{ |
| 74 | + { |
| 75 | + name: "with component and custom query", |
| 76 | + opts: &MetadataOptions{ |
| 77 | + Query: ".metadata.component", |
| 78 | + MaxColumns: 10, |
| 79 | + Format: "json", |
| 80 | + Delimiter: ",", |
| 81 | + Stack: "prod-*", |
| 82 | + }, |
| 83 | + componentFilter: "vpc", |
| 84 | + expectedQuery: ".metadata.component", |
| 85 | + expectedComp: l.KeyMetadata, |
| 86 | + }, |
| 87 | + { |
| 88 | + name: "without component and default query", |
| 89 | + opts: &MetadataOptions{ |
| 90 | + Query: "", |
| 91 | + MaxColumns: 5, |
| 92 | + Format: "yaml", |
| 93 | + Delimiter: "\t", |
| 94 | + Stack: "", |
| 95 | + }, |
| 96 | + componentFilter: "", |
| 97 | + expectedQuery: ".metadata", |
| 98 | + expectedComp: l.KeyMetadata, |
| 99 | + }, |
| 100 | + { |
| 101 | + name: "with component but no query", |
| 102 | + opts: &MetadataOptions{ |
| 103 | + Query: "", |
| 104 | + MaxColumns: 0, |
| 105 | + Format: "", |
| 106 | + Delimiter: "", |
| 107 | + Stack: "*-dev-*", |
| 108 | + }, |
| 109 | + componentFilter: "app", |
| 110 | + expectedQuery: ".metadata", |
| 111 | + expectedComp: l.KeyMetadata, |
| 112 | + }, |
| 113 | + } |
| 114 | + |
| 115 | + for _, tc := range testCases { |
| 116 | + t.Run(tc.name, func(t *testing.T) { |
| 117 | + filterOpts := setupMetadataOptions(tc.opts, tc.componentFilter) |
| 118 | + |
| 119 | + assert.Equal(t, tc.expectedComp, filterOpts.Component) |
| 120 | + assert.Equal(t, tc.componentFilter, filterOpts.ComponentFilter) |
| 121 | + assert.Equal(t, tc.expectedQuery, filterOpts.Query) |
| 122 | + assert.False(t, filterOpts.IncludeAbstract) |
| 123 | + assert.Equal(t, tc.opts.MaxColumns, filterOpts.MaxColumns) |
| 124 | + assert.Equal(t, tc.opts.Format, filterOpts.FormatStr) |
| 125 | + assert.Equal(t, tc.opts.Delimiter, filterOpts.Delimiter) |
| 126 | + assert.Equal(t, tc.opts.Stack, filterOpts.StackPattern) |
| 127 | + }) |
| 128 | + } |
| 129 | +} |
| 130 | + |
| 131 | +// TestMetadataOptions tests the MetadataOptions structure. |
| 132 | +func TestMetadataOptions(t *testing.T) { |
| 133 | + opts := &MetadataOptions{ |
| 134 | + Format: "json", |
| 135 | + MaxColumns: 10, |
| 136 | + Delimiter: ",", |
| 137 | + Stack: "prod-*", |
| 138 | + Query: ".metadata.component", |
| 139 | + ProcessTemplates: true, |
| 140 | + ProcessFunctions: false, |
| 141 | + } |
| 142 | + |
| 143 | + assert.Equal(t, "json", opts.Format) |
| 144 | + assert.Equal(t, 10, opts.MaxColumns) |
| 145 | + assert.Equal(t, ",", opts.Delimiter) |
| 146 | + assert.Equal(t, "prod-*", opts.Stack) |
| 147 | + assert.Equal(t, ".metadata.component", opts.Query) |
| 148 | + assert.True(t, opts.ProcessTemplates) |
| 149 | + assert.False(t, opts.ProcessFunctions) |
| 150 | +} |
| 151 | + |
| 152 | +// TestListMetadataWithOptions_DefaultQuery tests that default query is applied. |
| 153 | +func TestListMetadataWithOptions_DefaultQuery(t *testing.T) { |
| 154 | + opts := &MetadataOptions{ |
| 155 | + Query: "", |
| 156 | + } |
| 157 | + |
| 158 | + filterOpts := setupMetadataOptions(opts, "") |
| 159 | + assert.Equal(t, ".metadata", filterOpts.Query, "Should apply default .metadata query") |
| 160 | +} |
| 161 | + |
| 162 | +// TestListMetadataWithOptions_CustomQuery tests that custom query is preserved. |
| 163 | +func TestListMetadataWithOptions_CustomQuery(t *testing.T) { |
| 164 | + opts := &MetadataOptions{ |
| 165 | + Query: ".metadata.custom", |
| 166 | + } |
| 167 | + |
| 168 | + filterOpts := setupMetadataOptions(opts, "") |
| 169 | + assert.Equal(t, ".metadata.custom", filterOpts.Query, "Should preserve custom query") |
| 170 | +} |
0 commit comments