Add environments list API (AST-129883) #1415
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,45 @@ | ||
| package commandutils | ||
|
|
||
| import ( | ||
| "errors" | ||
| "fmt" | ||
| "strings" | ||
|
|
||
| "github.com/checkmarx/ast-cli/internal/commands/util/printer" | ||
| "github.com/checkmarx/ast-cli/internal/params" | ||
| "github.com/spf13/cobra" | ||
| ) | ||
|
|
||
| func AddFormatFlagToMultipleCommands(commands []*cobra.Command, defaultFormat string, otherAvailableFormats ...string) { | ||
| for _, c := range commands { | ||
| AddFormatFlag(c, defaultFormat, otherAvailableFormats...) | ||
| } | ||
| } | ||
|
|
||
| func AddFormatFlag(cmd *cobra.Command, defaultFormat string, otherAvailableFormats ...string) { | ||
| cmd.PersistentFlags().String( | ||
| params.FormatFlag, defaultFormat, | ||
| fmt.Sprintf(params.FormatFlagUsageFormat, append(otherAvailableFormats, defaultFormat)), | ||
| ) | ||
| } | ||
|
|
||
| func PrintByFormat(cmd *cobra.Command, view interface{}) error { | ||
| f, _ := cmd.Flags().GetString(params.FormatFlag) | ||
| return printer.Print(cmd.OutOrStdout(), view, f) | ||
| } | ||
|
|
||
| func GetFilters(cmd *cobra.Command) (map[string]string, error) { | ||
| filters, _ := cmd.Flags().GetStringSlice(params.FilterFlag) | ||
| allFilters := make(map[string]string) | ||
| for _, filter := range filters { | ||
| filterKeyVal := strings.Split(filter, "=") | ||
| if len(filterKeyVal) != params.KeyValuePairSize { | ||
| return nil, errors.New("invalid filters, filters should be in a KEY=VALUE format") | ||
| } | ||
| allFilters[filterKeyVal[0]] = strings.Replace( | ||
| filterKeyVal[1], ";", ",", | ||
| strings.Count(filterKeyVal[1], ";"), | ||
| ) | ||
| } | ||
| return allFilters, nil | ||
| } | ||
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,142 @@ | ||
| package dast | ||
|
|
||
| import ( | ||
| "fmt" | ||
| "strings" | ||
|
|
||
| "github.com/MakeNowJust/heredoc" | ||
| "github.com/checkmarx/ast-cli/internal/commands/commandutils" | ||
| "github.com/checkmarx/ast-cli/internal/commands/util/printer" | ||
| commonParams "github.com/checkmarx/ast-cli/internal/params" | ||
| "github.com/checkmarx/ast-cli/internal/services" | ||
| "github.com/checkmarx/ast-cli/internal/wrappers" | ||
| "github.com/pkg/errors" | ||
| "github.com/spf13/cobra" | ||
| ) | ||
|
|
||
| const ( | ||
| failedGettingDastEnvironments = "Failed getting DAST environments" | ||
| ) | ||
|
|
||
| var ( | ||
| filterDastEnvironmentsListFlagUsage = fmt.Sprintf( | ||
| "Filter the list of DAST environments. Use ';' as the delimiter for arrays. Available filters are: %s", | ||
| strings.Join( | ||
| []string{ | ||
| commonParams.FromQueryParam, | ||
| commonParams.ToQueryParam, | ||
| commonParams.SearchQueryParam, | ||
| commonParams.SortQueryParam, | ||
| }, ",", | ||
| ), | ||
| ) | ||
| ) | ||
|
|
||
| // NewDastEnvironmentsCommand creates the DAST environments command | ||
| func NewDastEnvironmentsCommand(dastEnvironmentsWrapper wrappers.DastEnvironmentsWrapper) *cobra.Command { | ||
| environmentsCmd := &cobra.Command{ | ||
| Use: "dast-environments", | ||
| Short: "Manage DAST environments", | ||
| Long: "The environments command enables the ability to manage DAST environments in Checkmarx One", | ||
| Annotations: map[string]string{ | ||
| "command:doc": heredoc.Doc( | ||
| ` | ||
| https://checkmarx.com/resource/documents/en/todo | ||
| `, | ||
| ), | ||
| }, | ||
| } | ||
|
|
||
| listDastEnvironmentsCmd := &cobra.Command{ | ||
| Use: "list", | ||
| Short: "List all DAST environments in the system", | ||
| Example: heredoc.Doc( | ||
| ` | ||
| $ cx dast-environments list --format list | ||
| $ cx dast-environments list --filter "from=1,to=10" | ||
| $ cx dast-environments list --filter "search=production,sort=created" | ||
| `, | ||
| ), | ||
| Annotations: map[string]string{ | ||
| "command:doc": heredoc.Doc( | ||
| ` | ||
| https://checkmarx.com/resource/documents/en/todo | ||
| `, | ||
| ), | ||
| }, | ||
| RunE: runListDastEnvironmentsCommand(dastEnvironmentsWrapper), | ||
| } | ||
| listDastEnvironmentsCmd.PersistentFlags().StringSlice(commonParams.FilterFlag, []string{}, filterDastEnvironmentsListFlagUsage) | ||
|
|
||
| commandutils.AddFormatFlagToMultipleCommands( | ||
| []*cobra.Command{listDastEnvironmentsCmd}, | ||
| printer.FormatTable, | ||
| printer.FormatJSON, | ||
| printer.FormatList, | ||
| ) | ||
|
|
||
| environmentsCmd.AddCommand(listDastEnvironmentsCmd) | ||
| return environmentsCmd | ||
| } | ||
|
|
||
| func runListDastEnvironmentsCommand(dastEnvironmentsWrapper wrappers.DastEnvironmentsWrapper) func(cmd *cobra.Command, args []string) error { | ||
| return func(cmd *cobra.Command, args []string) error { | ||
| var allEnvironmentsModel *wrappers.DastEnvironmentsCollectionResponseModel | ||
| var errorModel *wrappers.ErrorModel | ||
|
|
||
| params, err := commandutils.GetFilters(cmd) | ||
| if err != nil { | ||
| return errors.Wrapf(err, "%s", failedGettingDastEnvironments) | ||
| } | ||
|
|
||
| // The API expects: from, to, search, sort | ||
| // from and to are pagination parameters (e.g., from=1, to=10 for first page) | ||
| allEnvironmentsModel, errorModel, err = dastEnvironmentsWrapper.Get(params) | ||
| if err != nil { | ||
| return errors.Wrapf(err, "%s\n", failedGettingDastEnvironments) | ||
| } | ||
|
|
||
| // Checking the response | ||
| if errorModel != nil { | ||
| return errors.Errorf(services.ErrorCodeFormat, failedGettingDastEnvironments, errorModel.Code, errorModel.Message) | ||
| } else if allEnvironmentsModel != nil && allEnvironmentsModel.Environments != nil { | ||
| err = commandutils.PrintByFormat(cmd, toEnvironmentViews(allEnvironmentsModel.Environments)) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| } | ||
| return nil | ||
| } | ||
| } | ||
|
|
||
| func toEnvironmentViews(models []wrappers.DastEnvironmentResponseModel) []environmentView { | ||
| result := make([]environmentView, len(models)) | ||
| for i := 0; i < len(models); i++ { | ||
| result[i] = toEnvironmentView(&models[i]) | ||
| } | ||
| return result | ||
| } | ||
|
|
||
| func toEnvironmentView(model *wrappers.DastEnvironmentResponseModel) environmentView { | ||
| return environmentView{ | ||
| EnvironmentID: model.EnvironmentID, | ||
| Domain: model.Domain, | ||
| URL: model.URL, | ||
| ScanType: model.ScanType, | ||
| Created: model.Created, | ||
| RiskRating: model.RiskRating, | ||
| LastScanTime: model.LastScanTime, | ||
| LastStatus: model.LastStatus, | ||
| } | ||
| } | ||
|
|
||
| type environmentView struct { | ||
| EnvironmentID string `format:"name:Environment ID"` | ||
| Domain string | ||
| URL string | ||
| ScanType string `format:"name:Scan Type"` | ||
| Created string | ||
| RiskRating string `format:"name:Risk Rating"` | ||
| LastScanTime string `format:"name:Last Scan Time"` | ||
| LastStatus string `format:"name:Last Status"` | ||
| } |
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,51 @@ | ||
| //go:build !integration | ||
|
|
||
| package dast | ||
|
|
||
| import ( | ||
| "testing" | ||
|
|
||
| "github.com/checkmarx/ast-cli/internal/wrappers/mock" | ||
| "gotest.tools/assert" | ||
| ) | ||
|
|
||
| func createTestCommand(args ...string) error { | ||
| cmd := NewDastEnvironmentsCommand(&mock.DastEnvironmentsMockWrapper{}) | ||
| cmd.SetArgs(args) | ||
| return cmd.Execute() | ||
| } | ||
|
|
||
| func TestDastEnvironmentsHelp(t *testing.T) { | ||
| err := createTestCommand("--help") | ||
| assert.NilError(t, err) | ||
| } | ||
|
|
||
| func TestDastEnvironmentsNoSub(t *testing.T) { | ||
| err := createTestCommand() | ||
| assert.NilError(t, err) | ||
| } | ||
|
|
||
| func TestDastEnvironmentsList(t *testing.T) { | ||
| err := createTestCommand("list") | ||
| assert.NilError(t, err) | ||
| } | ||
|
|
||
| func TestDastEnvironmentsListWithFormat(t *testing.T) { | ||
| err := createTestCommand("list", "--format", "json") | ||
| assert.NilError(t, err) | ||
| } | ||
|
|
||
| func TestDastEnvironmentsListWithFilters(t *testing.T) { | ||
| err := createTestCommand("list", "--filter", "from=1,to=10") | ||
| assert.NilError(t, err) | ||
| } | ||
|
|
||
| func TestDastEnvironmentsListWithSearch(t *testing.T) { | ||
| err := createTestCommand("list", "--filter", "search=test") | ||
| assert.NilError(t, err) | ||
| } | ||
|
|
||
| func TestDastEnvironmentsListWithSort(t *testing.T) { | ||
| err := createTestCommand("list", "--filter", "sort=domain:asc") | ||
| assert.NilError(t, err) | ||
| } |
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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
All these methods are in root.go and mainly used inside command implementations. Do we need this redundant globally available?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The issue I had is that all DAST commands are in the package "dast".
The package "commands" depends on package "dast".
So if DAST commands want to use methods from root.go there will be a dependency cycle.