Skip to content

Feature/get states custom flag(AST-123836) #1371

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.

Sign up for GitHub

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

Open
cx-hitesh-madgulkar wants to merge 8 commits into
base: main
Choose a base branch
from
Open

Feature/get states custom flag(AST-123836) #1371

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
7a6e70f
added-falgs-check
cx-hitesh-madgulkar Dec 4, 2025
a8a031d
sca-flag-name-corrected
cx-hitesh-madgulkar Dec 5, 2025
f1b82b8
Merge branch 'main' of https://github.com/Checkmarx/ast-cli into feat…
cx-hitesh-madgulkar Dec 8, 2025
af93a78
added-ut
cx-hitesh-madgulkar Dec 8, 2025
266e4d9
removed-condition
cx-hitesh-madgulkar Dec 9, 2025
2c0fdac
Merge branch 'main' of https://github.com/Checkmarx/ast-cli into feat…
cx-hitesh-madgulkar Dec 10, 2025
75760ca
Merge branch 'main' into feature/get-states-custom-flag
cx-rahul-pidde Dec 13, 2025
05d097c
Merge branch 'main' into feature/get-states-custom-flag
cx-hitesh-madgulkar Dec 18, 2025
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
22 changes: 21 additions & 1 deletion internal/commands/predicates.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,16 +59,36 @@ func triageGetStatesSubCommand(customStatesWrapper wrappers.CustomStatesWrapper,
}

triageGetStatesCmd.PersistentFlags().Bool(params.AllStatesFlag, false, "Show all custom states, including the ones that have been deleted")

triageGetStatesCmd.PersistentFlags().String(params.ScanTypeFlag, "sast", "Scan Type")
return triageGetStatesCmd
}

func runTriageGetStates(customStatesWrapper wrappers.CustomStatesWrapper, featureFlagsWrapper wrappers.FeatureFlagsWrapper) func(*cobra.Command, []string) error {
return func(cmd *cobra.Command, _ []string) error {
scanType, _ := cmd.Flags().GetString(params.ScanTypeFlag)
scanType = strings.TrimSpace(strings.ToLower(scanType))
flagResponse, _ := wrappers.GetSpecificFeatureFlag(featureFlagsWrapper, wrappers.CustomStatesFeatureFlag)
if !flagResponse.Status {
return printer.Print(cmd.OutOrStdout(), systemStates, printer.FormatJSON)
}

switch scanType {
case params.KicsType:
kicsCustomStates, _ := wrappers.GetSpecificFeatureFlag(featureFlagsWrapper, "KICS_CUSTOM_STATES_ENABLED")
if !kicsCustomStates.Status {
return printer.Print(cmd.OutOrStdout(), systemStates, printer.FormatJSON)
}
case params.ScaType:
scaCustomStates, _ := wrappers.GetSpecificFeatureFlag(featureFlagsWrapper, "SCA_CUSTOM_STATES")
if !scaCustomStates.Status {
return printer.Print(cmd.OutOrStdout(), systemStates, printer.FormatJSON)
}
default:
sastCustomStates, _ := wrappers.GetSpecificFeatureFlag(featureFlagsWrapper, "SAST_CUSTOM_STATES_ENABLED")
if !sastCustomStates.Status {
return printer.Print(cmd.OutOrStdout(), systemStates, printer.FormatJSON)
}
}
includeDeleted, _ := cmd.Flags().GetBool(params.AllStatesFlag)
states, err := customStatesWrapper.GetAllCustomStates(includeDeleted)
if err != nil {
Expand Down
181 changes: 181 additions & 0 deletions internal/commands/predicates_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -213,6 +213,187 @@ func TestRunTriageUpdateWithSystemState(t *testing.T) {
assert.NilError(t, err)
}

func TestRunTriageGetStates_ScanTypeSwitch(t *testing.T) {
tests := []struct {
name string
scanType string
customStatesFeatureFlag wrappers.FeatureFlagResponseModel
scanTypeFeatureFlag wrappers.FeatureFlagResponseModel
expectedError bool
description string
}{
{
name: "KICS scan type with KICS custom states enabled",
scanType: "kics",
customStatesFeatureFlag: wrappers.FeatureFlagResponseModel{Name: wrappers.CustomStatesFeatureFlag, Status: true},
scanTypeFeatureFlag: wrappers.FeatureFlagResponseModel{Name: "KICS_CUSTOM_STATES_ENABLED", Status: true},
expectedError: false,
description: "Should successfully get custom states for KICS when feature flag is enabled",
},
{
name: "KICS scan type with KICS custom states disabled",
scanType: "kics",
customStatesFeatureFlag: wrappers.FeatureFlagResponseModel{Name: wrappers.CustomStatesFeatureFlag, Status: true},
scanTypeFeatureFlag: wrappers.FeatureFlagResponseModel{Name: "KICS_CUSTOM_STATES_ENABLED", Status: false},
expectedError: false,
description: "Should return system states for KICS when feature flag is disabled",
},
{
name: "SCA scan type with SCA custom states enabled",
scanType: "sca",
customStatesFeatureFlag: wrappers.FeatureFlagResponseModel{Name: wrappers.CustomStatesFeatureFlag, Status: true},
scanTypeFeatureFlag: wrappers.FeatureFlagResponseModel{Name: "SCA_CUSTOM_STATES", Status: true},
expectedError: false,
description: "Should successfully get custom states for SCA when feature flag is enabled",
},
{
name: "SCA scan type with SCA custom states disabled",
scanType: "sca",
customStatesFeatureFlag: wrappers.FeatureFlagResponseModel{Name: wrappers.CustomStatesFeatureFlag, Status: true},
scanTypeFeatureFlag: wrappers.FeatureFlagResponseModel{Name: "SCA_CUSTOM_STATES", Status: false},
expectedError: false,
description: "Should return system states for SCA when feature flag is disabled",
},
{
name: "SAST scan type with SAST custom states enabled",
scanType: "sast",
customStatesFeatureFlag: wrappers.FeatureFlagResponseModel{Name: wrappers.CustomStatesFeatureFlag, Status: true},
scanTypeFeatureFlag: wrappers.FeatureFlagResponseModel{Name: "SAST_CUSTOM_STATES_ENABLED", Status: true},
expectedError: false,
description: "Should successfully get custom states for SAST when feature flag is enabled",
},
{
name: "SAST scan type with SAST custom states disabled",
scanType: "sast",
customStatesFeatureFlag: wrappers.FeatureFlagResponseModel{Name: wrappers.CustomStatesFeatureFlag, Status: true},
scanTypeFeatureFlag: wrappers.FeatureFlagResponseModel{Name: "SAST_CUSTOM_STATES_ENABLED", Status: false},
expectedError: false,
description: "Should return system states for SAST when feature flag is disabled",
},
{
name: "Unknown scan type defaults to SAST behavior",
scanType: "unknown",
customStatesFeatureFlag: wrappers.FeatureFlagResponseModel{Name: wrappers.CustomStatesFeatureFlag, Status: true},
scanTypeFeatureFlag: wrappers.FeatureFlagResponseModel{Name: "SAST_CUSTOM_STATES_ENABLED", Status: true},
expectedError: false,
description: "Should default to SAST logic for unknown scan types",
},
{
name: "KICS with uppercase scan type",
scanType: "KICS",
customStatesFeatureFlag: wrappers.FeatureFlagResponseModel{Name: wrappers.CustomStatesFeatureFlag, Status: true},
scanTypeFeatureFlag: wrappers.FeatureFlagResponseModel{Name: "KICS_CUSTOM_STATES_ENABLED", Status: true},
expectedError: false,
description: "Should handle uppercase scan type correctly",
},
{
name: "SCA with mixed case scan type",
scanType: "ScA",
customStatesFeatureFlag: wrappers.FeatureFlagResponseModel{Name: wrappers.CustomStatesFeatureFlag, Status: true},
scanTypeFeatureFlag: wrappers.FeatureFlagResponseModel{Name: "SCA_CUSTOM_STATES", Status: true},
expectedError: false,
description: "Should handle mixed case scan type correctly",
},
}

for _, tt := range tests {
tt := tt
t.Run(tt.name, func(t *testing.T) {
clearFlags()
mockCustomStatesWrapper := &mock.CustomStatesMockWrapper{}
mockFeatureFlagsWrapper := &mock.FeatureFlagsMockWrapper{}

// First, set the custom states feature flag
mock.Flag = tt.customStatesFeatureFlag
cmd := triageGetStatesSubCommand(mockCustomStatesWrapper, mockFeatureFlagsWrapper)

// Then set the scan-type specific feature flag for the actual execution
mock.Flag = tt.scanTypeFeatureFlag
cmd.SetArgs([]string{"--scan-type", tt.scanType})

err := cmd.Execute()

if tt.expectedError {
assert.Assert(t, err != nil, tt.description)
} else {
assert.NilError(t, err, tt.description)
}
})
}
}

func TestRunTriageGetStates_OverallFeatureFlagDisabled(t *testing.T) {
clearFlags()
mockCustomStatesWrapper := &mock.CustomStatesMockWrapper{}
mockFeatureFlagsWrapper := &mock.FeatureFlagsMockWrapper{}

// Set the overall custom states feature flag to disabled
mock.Flag = wrappers.FeatureFlagResponseModel{Name: wrappers.CustomStatesFeatureFlag, Status: false}

cmd := triageGetStatesSubCommand(mockCustomStatesWrapper, mockFeatureFlagsWrapper)
cmd.SetArgs([]string{"--scan-type", "sast"})

err := cmd.Execute()
assert.NilError(t, err, "Should return system states when overall custom states feature flag is disabled")
}

func TestRunTriageGetStates_WithAllFlag(t *testing.T) {
clearFlags()
mockCustomStatesWrapper := &mock.CustomStatesMockWrapper{}
mockFeatureFlagsWrapper := &mock.FeatureFlagsMockWrapper{}

tests := []struct {
name string
scanType string
allFlag bool
}{
{
name: "KICS with all flag true",
scanType: "kics",
allFlag: true,
},
{
name: "SCA with all flag false",
scanType: "sca",
allFlag: false,
},
{
name: "SAST with all flag true",
scanType: "sast",
allFlag: true,
},
}

for _, tt := range tests {
tt := tt
t.Run(tt.name, func(t *testing.T) {
clearFlags()
mock.Flag = wrappers.FeatureFlagResponseModel{Name: wrappers.CustomStatesFeatureFlag, Status: true}

cmd := triageGetStatesSubCommand(mockCustomStatesWrapper, mockFeatureFlagsWrapper)

// Set the scan-type specific feature flag to enabled
switch tt.scanType {
case "kics":
mock.Flag = wrappers.FeatureFlagResponseModel{Name: "KICS_CUSTOM_STATES_ENABLED", Status: true}
case "sca":
mock.Flag = wrappers.FeatureFlagResponseModel{Name: "SCA_CUSTOM_STATES", Status: true}
default:
mock.Flag = wrappers.FeatureFlagResponseModel{Name: "SAST_CUSTOM_STATES_ENABLED", Status: true}
}

args := []string{"--scan-type", tt.scanType}
if tt.allFlag {
args = append(args, "--all")
}
cmd.SetArgs(args)

err := cmd.Execute()
assert.NilError(t, err)
})
}
}

func TestDetermineSystemOrCustomState(t *testing.T) {
tests := []struct {
name string
Expand Down
Loading