Implement: atmos list values #1036
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,179 @@ | ||
| package cmd | ||
|
|
||
| import ( | ||
| "testing" | ||
|
|
||
| "github.com/spf13/cobra" | ||
| "github.com/stretchr/testify/assert" | ||
|
|
||
| "github.com/cloudposse/atmos/pkg/list/errors" | ||
| ) | ||
|
|
||
| // setupTestCommand creates a test command with the necessary flags. | ||
| func setupTestCommand(use string) *cobra.Command { | ||
| cmd := &cobra.Command{ | ||
| Use: use, | ||
| } | ||
| cmd.PersistentFlags().String("format", "", "Output format") | ||
| cmd.PersistentFlags().String("delimiter", "", "Delimiter for CSV/TSV output") | ||
| cmd.PersistentFlags().String("stack", "", "Stack pattern") | ||
| cmd.PersistentFlags().String("query", "", "JQ query") | ||
| cmd.PersistentFlags().Int("max-columns", 0, "Maximum columns") | ||
| cmd.PersistentFlags().Bool("process-templates", true, "Enable/disable Go template processing") | ||
| cmd.PersistentFlags().Bool("process-functions", true, "Enable/disable YAML functions processing") | ||
| return cmd | ||
| } | ||
|
|
||
| // TestComponentDefinitionNotFoundError tests that the ComponentDefinitionNotFoundError. | ||
| func TestComponentDefinitionNotFoundError(t *testing.T) { | ||
| testCases := []struct { | ||
| name string | ||
| componentName string | ||
| expectedOutput string | ||
| runFunc func(cmd *cobra.Command, args []string) (string, error) | ||
| }{ | ||
| { | ||
| name: "list values - component not found", | ||
| componentName: "nonexistent-component", | ||
| expectedOutput: "component 'nonexistent-component' does not exist", | ||
| runFunc: func(cmd *cobra.Command, args []string) (string, error) { | ||
| return "", &errors.ComponentDefinitionNotFoundError{Component: args[0]} | ||
| }, | ||
| }, | ||
| { | ||
| name: "list settings - component not found", | ||
| componentName: "nonexistent-component", | ||
| expectedOutput: "component 'nonexistent-component' does not exist", | ||
| runFunc: func(cmd *cobra.Command, args []string) (string, error) { | ||
| return "", &errors.ComponentDefinitionNotFoundError{Component: args[0]} | ||
| }, | ||
| }, | ||
| { | ||
| name: "list metadata - component not found", | ||
| componentName: "nonexistent-component", | ||
| expectedOutput: "component 'nonexistent-component' does not exist", | ||
| runFunc: func(cmd *cobra.Command, args []string) (string, error) { | ||
| return "", &errors.ComponentDefinitionNotFoundError{Component: args[0]} | ||
| }, | ||
| }, | ||
| } | ||
|
|
||
| for _, tc := range testCases { | ||
| t.Run(tc.name, func(t *testing.T) { | ||
| // Create test command | ||
| cmd := setupTestCommand(tc.name) | ||
| args := []string{tc.componentName} | ||
|
|
||
| // Mock the listValues/listSettings/listMetadata function | ||
| mockRunFunc := tc.runFunc | ||
|
|
||
| // Run the command with the mocked function | ||
| output, err := mockRunFunc(cmd, args) | ||
| assert.Equal(t, "", output) | ||
| assert.Error(t, err) | ||
|
|
||
| // Check that the error is of the expected type | ||
| var componentNotFoundErr *errors.ComponentDefinitionNotFoundError | ||
| assert.ErrorAs(t, err, &componentNotFoundErr) | ||
| assert.Equal(t, tc.componentName, componentNotFoundErr.Component) | ||
| assert.Contains(t, componentNotFoundErr.Error(), tc.expectedOutput) | ||
|
|
||
| // Verify that the error would be properly returned by the RunE function | ||
| // This simulates what would happen in the actual command execution | ||
| // where errors are returned to main() instead of being logged | ||
| assert.NotNil(t, err, "Error should be returned to be handled by main()") | ||
| }) | ||
| } | ||
| } | ||
|
|
||
| // TestNoValuesFoundError tests that the NoValuesFoundError is properly handled. | ||
| func TestNoValuesFoundError(t *testing.T) { | ||
| testCases := []struct { | ||
| name string | ||
| componentName string | ||
| query string | ||
| expectedOutput string | ||
| runFunc func(cmd *cobra.Command, args []string) (string, error) | ||
| shouldReturnNil bool | ||
| }{ | ||
| { | ||
| name: "list values - no values found", | ||
| componentName: "test-component", | ||
| expectedOutput: "No values found for component 'test-component'", | ||
| runFunc: func(cmd *cobra.Command, args []string) (string, error) { | ||
| return "", &errors.NoValuesFoundError{Component: args[0]} | ||
| }, | ||
| shouldReturnNil: false, | ||
| }, | ||
| { | ||
| name: "list vars - no vars found", | ||
| componentName: "test-component", | ||
| query: ".vars", | ||
| expectedOutput: "No vars found for component 'test-component'", | ||
| runFunc: func(cmd *cobra.Command, args []string) (string, error) { | ||
| cmd.Flags().Set("query", ".vars") | ||
| return "", &errors.NoValuesFoundError{Component: args[0]} | ||
| }, | ||
| shouldReturnNil: true, | ||
| }, | ||
| { | ||
| name: "list settings - no settings found with component", | ||
| componentName: "test-component", | ||
| expectedOutput: "No settings found for component 'test-component'", | ||
| runFunc: func(cmd *cobra.Command, args []string) (string, error) { | ||
| return "", &errors.NoValuesFoundError{Component: args[0]} | ||
| }, | ||
| shouldReturnNil: false, | ||
| }, | ||
| { | ||
| name: "list settings - no settings found without component", | ||
| componentName: "", | ||
| expectedOutput: "No settings found", | ||
| runFunc: func(cmd *cobra.Command, args []string) (string, error) { | ||
| return "", &errors.NoValuesFoundError{} | ||
| }, | ||
| shouldReturnNil: false, | ||
| }, | ||
| { | ||
| name: "list metadata - no metadata found with component", | ||
| componentName: "test-component", | ||
| expectedOutput: "No metadata found for component 'test-component'", | ||
| runFunc: func(cmd *cobra.Command, args []string) (string, error) { | ||
| return "", &errors.NoValuesFoundError{Component: args[0]} | ||
| }, | ||
| shouldReturnNil: false, | ||
| }, | ||
| { | ||
| name: "list metadata - no metadata found without component", | ||
| componentName: "", | ||
| expectedOutput: "No metadata found", | ||
| runFunc: func(cmd *cobra.Command, args []string) (string, error) { | ||
| return "", &errors.NoValuesFoundError{} | ||
| }, | ||
| shouldReturnNil: false, | ||
| }, | ||
| } | ||
|
|
||
| for _, tc := range testCases { | ||
| t.Run(tc.name, func(t *testing.T) { | ||
| cmd := setupTestCommand(tc.name) | ||
| args := []string{} | ||
| if tc.componentName != "" { | ||
| args = append(args, tc.componentName) | ||
| } | ||
|
|
||
| if tc.query != "" { | ||
| cmd.Flags().Set("query", tc.query) | ||
| } | ||
|
|
||
| mockRunFunc := tc.runFunc | ||
|
|
||
| output, err := mockRunFunc(cmd, args) | ||
| assert.Equal(t, "", output) | ||
| assert.Error(t, err) | ||
|
|
||
| var noValuesErr *errors.NoValuesFoundError | ||
| assert.ErrorAs(t, err, &noValuesErr) | ||
| }) | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,169 @@ | ||
| package cmd | ||
|
|
||
| import ( | ||
| "errors" | ||
| "fmt" | ||
|
|
||
| listutils "github.com/cloudposse/atmos/pkg/list/utils" | ||
|
|
||
| log "github.com/charmbracelet/log" | ||
| "github.com/spf13/cobra" | ||
|
|
||
| e "github.com/cloudposse/atmos/internal/exec" | ||
| "github.com/cloudposse/atmos/pkg/config" | ||
| l "github.com/cloudposse/atmos/pkg/list" | ||
| listerrors "github.com/cloudposse/atmos/pkg/list/errors" | ||
| fl "github.com/cloudposse/atmos/pkg/list/flags" | ||
| f "github.com/cloudposse/atmos/pkg/list/format" | ||
| u "github.com/cloudposse/atmos/pkg/list/utils" | ||
| "github.com/cloudposse/atmos/pkg/schema" | ||
| utils "github.com/cloudposse/atmos/pkg/utils" | ||
| ) | ||
|
|
||
| // listMetadataCmd lists metadata across stacks. | ||
| var listMetadataCmd = &cobra.Command{ | ||
| Use: "metadata [component]", | ||
| Short: "List metadata across stacks", | ||
| Long: "List metadata information across all stacks or for a specific component", | ||
| Example: "atmos list metadata\n" + | ||
| "atmos list metadata c1\n" + | ||
| "atmos list metadata --query .component\n" + | ||
| "atmos list metadata --format json\n" + | ||
| "atmos list metadata --stack '*-{dev,staging}-*'\n" + | ||
| "atmos list metadata --stack 'prod-*'", | ||
| RunE: func(cmd *cobra.Command, args []string) error { | ||
| checkAtmosConfig() | ||
| output, err := listMetadata(cmd, args) | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| utils.PrintMessage(output) | ||
| return nil | ||
| }, | ||
Cerebrovinny marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| } | ||
|
|
||
| func init() { | ||
| fl.AddCommonListFlags(listMetadataCmd) | ||
|
|
||
| // Add template and function processing flags | ||
| listMetadataCmd.PersistentFlags().Bool("process-templates", true, "Enable/disable Go template processing in Atmos stack manifests when executing the command") | ||
| listMetadataCmd.PersistentFlags().Bool("process-functions", true, "Enable/disable YAML functions processing in Atmos stack manifests when executing the command") | ||
|
|
||
| AddStackCompletion(listMetadataCmd) | ||
|
|
||
| listCmd.AddCommand(listMetadataCmd) | ||
| } | ||
|
|
||
| // setupMetadataOptions sets up the filter options for metadata listing. | ||
| func setupMetadataOptions(commonFlags fl.CommonFlags, componentFilter string) *l.FilterOptions { | ||
| query := commonFlags.Query | ||
| if query == "" { | ||
| query = ".metadata" | ||
| } | ||
|
|
||
| return &l.FilterOptions{ | ||
| Component: l.KeyMetadata, | ||
| ComponentFilter: componentFilter, | ||
| Query: query, | ||
| IncludeAbstract: false, | ||
| MaxColumns: commonFlags.MaxColumns, | ||
| FormatStr: commonFlags.Format, | ||
| Delimiter: commonFlags.Delimiter, | ||
| StackPattern: commonFlags.Stack, | ||
| } | ||
| } | ||
|
|
||
| // logNoMetadataFoundMessage logs an appropriate message when no metadata is found. | ||
| func logNoMetadataFoundMessage(componentFilter string) { | ||
| if componentFilter != "" { | ||
| log.Info(fmt.Sprintf("No metadata found for component '%s'", componentFilter)) | ||
| } else { | ||
| log.Info("No metadata found") | ||
| } | ||
| } | ||
|
|
||
| // MetadataParams contains the parameters needed for listing metadata. | ||
| type MetadataParams struct { | ||
| CommonFlags *fl.CommonFlags | ||
| ProcessingFlags *fl.ProcessingFlags | ||
| ComponentFilter string | ||
| } | ||
|
|
||
| // initMetadataParams initializes and returns the parameters needed for listing metadata. | ||
| func initMetadataParams(cmd *cobra.Command, args []string) (*MetadataParams, error) { | ||
| commonFlags, err := fl.GetCommonListFlags(cmd) | ||
| if err != nil { | ||
| return nil, &listerrors.QueryError{ | ||
| Query: "common flags", | ||
| Cause: err, | ||
| } | ||
| } | ||
|
|
||
| processingFlags := fl.GetProcessingFlags(cmd) | ||
|
|
||
| if f.Format(commonFlags.Format) == f.FormatCSV && commonFlags.Delimiter == f.DefaultTSVDelimiter { | ||
| commonFlags.Delimiter = f.DefaultCSVDelimiter | ||
| } | ||
|
|
||
| componentFilter := "" | ||
| if len(args) > 0 { | ||
| componentFilter = args[0] | ||
| } | ||
|
|
||
| return &MetadataParams{ | ||
| CommonFlags: commonFlags, | ||
| ProcessingFlags: processingFlags, | ||
| ComponentFilter: componentFilter, | ||
| }, nil | ||
| } | ||
|
|
||
| func listMetadata(cmd *cobra.Command, args []string) (string, error) { | ||
| params, err := initMetadataParams(cmd, args) | ||
| if err != nil { | ||
| return "", err | ||
| } | ||
|
|
||
| // Initialize CLI config | ||
| configAndStacksInfo := schema.ConfigAndStacksInfo{} | ||
| atmosConfig, err := config.InitCliConfig(configAndStacksInfo, true) | ||
| if err != nil { | ||
| return "", &listerrors.InitConfigError{Cause: err} | ||
| } | ||
|
|
||
| if params.ComponentFilter != "" { | ||
| if !listutils.CheckComponentExists(&atmosConfig, params.ComponentFilter) { | ||
| return "", &listerrors.ComponentDefinitionNotFoundError{Component: params.ComponentFilter} | ||
| } | ||
| } | ||
|
|
||
| // Get all stacks | ||
| stacksMap, err := e.ExecuteDescribeStacks(atmosConfig, "", nil, nil, nil, false, | ||
| params.ProcessingFlags.Templates, params.ProcessingFlags.Functions, false, nil) | ||
| if err != nil { | ||
| return "", &listerrors.DescribeStacksError{Cause: err} | ||
| } | ||
|
|
||
| log.Debug("Filtering metadata", | ||
| "component", params.ComponentFilter, "query", params.CommonFlags.Query, | ||
| "maxColumns", params.CommonFlags.MaxColumns, "format", params.CommonFlags.Format, | ||
| "stackPattern", params.CommonFlags.Stack, "templates", params.ProcessingFlags.Templates) | ||
|
|
||
| filterOptions := setupMetadataOptions(*params.CommonFlags, params.ComponentFilter) | ||
| output, err := l.FilterAndListValues(stacksMap, filterOptions) | ||
| if err != nil { | ||
| var noValuesErr *listerrors.NoValuesFoundError | ||
| if errors.As(err, &noValuesErr) { | ||
| logNoMetadataFoundMessage(params.ComponentFilter) | ||
| return "", nil | ||
| } | ||
| return "", err | ||
| } | ||
|
|
||
| if output == "" || u.IsEmptyTable(output) { | ||
| logNoMetadataFoundMessage(params.ComponentFilter) | ||
| return "", nil | ||
| } | ||
|
|
||
| return output, nil | ||
| } | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.