Add the ability to import a SARIF file (AST-36884, AST-36890)

.golangci.yml

@@ -12,6 +12,7 @@ linters-settings:
           - github.com/spf13/cobra
           - github.com/pkg/errors
           - github.com/google
+          - github.com/MakeNowJust/heredoc
   dupl:
     threshold: 500
   funlen:

cmd/main.go

@@ -51,6 +51,7 @@ func main() {
 	policyEvaluationPath := viper.GetString(params.PolicyEvaluationPathKey)
 	sastMetadataPath := viper.GetString(params.SastMetadataPathKey)
 	accessManagementPath := viper.GetString(params.AccessManagementPathKey)
+	byorPath := viper.GetString(params.ByorPathKey)
 
 	scansWrapper := wrappers.NewHTTPScansWrapper(scans)
 	resultsPdfReportsWrapper := wrappers.NewResultsPdfReportsHTTPWrapper(resultsPdfPath)
@@ -81,6 +82,7 @@ func main() {
 	policyWrapper := wrappers.NewHTTPPolicyWrapper(policyEvaluationPath)
 	sastMetadataWrapper := wrappers.NewSastIncrementalHTTPWrapper(sastMetadataPath)
 	accessManagementWrapper := wrappers.NewAccessManagementHTTPWrapper(accessManagementPath)
+	byorWrapper := wrappers.NewByorHTTPWrapper(byorPath)
 
 	astCli := commands.NewAstCLI(
 		applicationsWrapper,
@@ -112,6 +114,7 @@ func main() {
 		policyWrapper,
 		sastMetadataWrapper,
 		accessManagementWrapper,
+		byorWrapper,
 	)
 	exitListener()
 	err = astCli.Execute()

go.mod

@@ -45,5 +45,4 @@ require (
 	golang.org/x/sys v0.19.0 // indirect
 	gopkg.in/ini.v1 v1.67.0 // indirect
 	gopkg.in/yaml.v3 v3.0.1 // indirect
-
 )

internal/commands/.scripts/integration_up.sh

@@ -14,7 +14,7 @@ go test \
   -tags integration \
   -v \
   -timeout 210m \
-  -coverpkg github.com/checkmarx/ast-cli/internal/commands,github.com/checkmarx/ast-cli/internal/wrappers \
+  -coverpkg github.com/checkmarx/ast-cli/internal/commands,github.com/checkmarx/ast-cli/internal/services,github.com/checkmarx/ast-cli/internal/wrappers \
   -coverprofile cover.out \
   github.com/checkmarx/ast-cli/test/integration
 

internal/commands/groups.go

@@ -2,110 +2,25 @@ package commands
 
 import (
 	"encoding/json"
-	"strings"
 
+	featureFlagsConstants "github.com/checkmarx/ast-cli/internal/constants/feature-flags"
 	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 accessManagementEnabled = "ACCESS_MANAGEMENT_ENABLED" // feature flag
-
-func createGroupsMap(groupsStr string, groupsWrapper wrappers.GroupsWrapper) ([]*wrappers.Group, error) {
-	groups := strings.Split(groupsStr, ",")
-	var groupsMap []*wrappers.Group
-	var groupsNotFound []string
-	for _, group := range groups {
-		if len(group) > 0 {
-			groupsFromEnv, err := groupsWrapper.Get(group)
-			if err != nil {
-				groupsNotFound = append(groupsNotFound, group)
-			} else {
-				findGroup := findGroupByName(groupsFromEnv, group)
-				if findGroup != nil && findGroup.Name != "" {
-					groupsMap = append(groupsMap, findGroup)
-				} else {
-					groupsNotFound = append(groupsNotFound, group)
-				}
-			}
-		}
-	}
-	if len(groupsNotFound) > 0 {
-		return nil, errors.Errorf("%s: %v", failedFindingGroup, groupsNotFound)
-	}
-	return groupsMap, nil
-}
-
-func findGroupByName(groups []wrappers.Group, name string) *wrappers.Group {
-	for i := 0; i < len(groups); i++ {
-		if groups[i].Name == name {
-			return &groups[i]
-		}
-	}
-	return nil
-}
-
 func updateGroupValues(input *[]byte, cmd *cobra.Command, groupsWrapper wrappers.GroupsWrapper) ([]*wrappers.Group, error) {
 	groupListStr, _ := cmd.Flags().GetString(commonParams.GroupList)
-	groups, err := createGroupsMap(groupListStr, groupsWrapper)
+	groups, err := services.CreateGroupsMap(groupListStr, groupsWrapper)
 	if err != nil {
 		return groups, err
 	}
-	if !wrappers.FeatureFlags[accessManagementEnabled] {
+	if !wrappers.FeatureFlags[featureFlagsConstants.AccessManagementEnabled] {
 		var info map[string]interface{}
 		_ = json.Unmarshal(*input, &info)
-		info["groups"] = getGroupIds(groups)
+		info["groups"] = services.GetGroupIds(groups)
 		*input, _ = json.Marshal(info)
 	}
 	return groups, nil
 }
-func getGroupsForRequest(groups []*wrappers.Group) []string {
-	if !wrappers.FeatureFlags[accessManagementEnabled] {
-		return getGroupIds(groups)
-	}
-	return nil
-}
-func getGroupIds(groups []*wrappers.Group) []string {
-	var groupIds []string
-	for _, group := range groups {
-		groupIds = append(groupIds, group.ID)
-	}
-	return groupIds
-}
-
-func assignGroupsToProjectNewAccessManagement(projectID string, projectName string, groups []*wrappers.Group,
-	accessManagement wrappers.AccessManagementWrapper) error {
-	if !wrappers.FeatureFlags[accessManagementEnabled] {
-		return nil
-	}
-	groupsAssignedToTheProject, err := accessManagement.GetGroups(projectID)
-	if err != nil {
-		return err
-	}
-	groupsToAssign := getGroupsToAssign(groups, groupsAssignedToTheProject)
-	if len(groupsToAssign) == 0 {
-		return nil
-	}
-
-	err = accessManagement.CreateGroupsAssignment(projectID, projectName, groupsToAssign)
-	if err != nil {
-		return err
-	}
-	return nil
-}
-
-func getGroupsToAssign(receivedGroups, existingGroups []*wrappers.Group) []*wrappers.Group {
-	var groupsToAssign []*wrappers.Group
-	var groupsMap = make(map[string]bool)
-	for _, existingGroup := range existingGroups {
-		groupsMap[existingGroup.ID] = true
-	}
-	for _, receivedGroup := range receivedGroups {
-		find := groupsMap[receivedGroup.ID]
-		if !find {
-			groupsToAssign = append(groupsToAssign, receivedGroup)
-		}
-	}
-	return groupsToAssign
-}

internal/commands/project.go

@@ -6,13 +6,13 @@ import (
 	"strings"
 	"time"
 
-	applicationErrors "github.com/checkmarx/ast-cli/internal/errors"
-
 	"github.com/MakeNowJust/heredoc"
 	"github.com/checkmarx/ast-cli/internal/commands/util"
 	"github.com/checkmarx/ast-cli/internal/commands/util/printer"
+	errorConstants "github.com/checkmarx/ast-cli/internal/constants/errors"
 	"github.com/checkmarx/ast-cli/internal/logger"
 	commonParams "github.com/checkmarx/ast-cli/internal/params"
+	"github.com/checkmarx/ast-cli/internal/services"
 	"github.com/spf13/viper"
 
 	"github.com/pkg/errors"
@@ -22,18 +22,13 @@ import (
 )
 
 const (
-	failedCreatingProj                  = "Failed creating a project"
-	failedUpdatingProj                  = "Failed updating a project"
-	failedProjectApplicationAssociation = "Failed association project to application"
-	failedGettingProj                   = "Failed getting a project"
-	failedDeletingProj                  = "Failed deleting a project"
-	failedGettingBranches               = "Failed getting branches for project"
-	failedFindingGroup                  = "Failed finding groups"
-	projOriginLevel                     = "Project"
-	repoConfKey                         = "scan.handler.git.repository"
-	sshConfKey                          = "scan.handler.git.sshKey"
-	mandatoryRepoURLError               = "flag --repo-url is mandatory when --ssh-key is provided"
-	invalidRepoURL                      = "provided repository url doesn't need a key. Make sure you are defining the right repository or remove the flag --ssh-key"
+	failedDeletingProj    = "Failed deleting a project"
+	failedGettingBranches = "Failed getting branches for project"
+	projOriginLevel       = "Project"
+	repoConfKey           = "scan.handler.git.repository"
+	sshConfKey            = "scan.handler.git.sshKey"
+	mandatoryRepoURLError = "flag --repo-url is mandatory when --ssh-key is provided"
+	invalidRepoURL        = "provided repository url doesn't need a key. Make sure you are defining the right repository or remove the flag --ssh-key"
 )
 
 var (
@@ -214,11 +209,12 @@ func updateProjectRequestValues(input *[]byte, cmd *cobra.Command) error {
 	projectName, _ := cmd.Flags().GetString(commonParams.ProjectName)
 	mainBranch, _ := cmd.Flags().GetString(commonParams.MainBranchFlag)
 	_ = json.Unmarshal(*input, &info)
-	if projectName != "" {
-		info["name"] = projectName
-	} else {
-		return errors.Errorf("Project name is required")
+	if projectName == "" {
+		return errors.Errorf(errorConstants.ProjectNameIsRequired)
 	}
+
+	info["name"] = projectName
+
 	if mainBranch != "" {
 		info["mainBranch"] = mainBranch
 	}
@@ -233,26 +229,21 @@ func runCreateProjectCommand(
 	accessManagementWrapper wrappers.AccessManagementWrapper,
 ) func(cmd *cobra.Command, args []string) error {
 	return func(cmd *cobra.Command, args []string) error {
-		applicationName, err := cmd.Flags().GetString(commonParams.ApplicationName)
-		if err != nil {
-			return err
-		}
-
+		applicationName, _ := cmd.Flags().GetString(commonParams.ApplicationName)
 		var applicationID []string
-
 		if applicationName != "" {
 			application, getAppErr := getApplication(applicationName, applicationsWrapper)
 			if getAppErr != nil {
 				return getAppErr
 			}
 			if application == nil {
-				return errors.Errorf(applicationErrors.ApplicationDoesntExistOrNoPermission)
+				return errors.Errorf(errorConstants.ApplicationDoesntExistOrNoPermission)
 			}
 			applicationID = []string{application.ID}
 		}
 
 		var input = []byte("{}")
-		err = updateProjectRequestValues(&input, cmd)
+		err := updateProjectRequestValues(&input, cmd)
 		if err != nil {
 			return err
 		}
@@ -272,26 +263,26 @@ func runCreateProjectCommand(
 		// Try to parse to a project model in order to manipulate the request payload
 		err = json.Unmarshal(input, &projModel)
 		if err != nil {
-			return errors.Wrapf(err, "%s: Input in bad format", failedCreatingProj)
+			return errors.Wrapf(err, "%s: Input in bad format", services.FailedCreatingProj)
 		}
 		var payload []byte
 		payload, _ = json.Marshal(projModel)
 		logger.PrintIfVerbose(fmt.Sprintf("Payload to projects service: %s\n", string(payload)))
 		projResponseModel, errorModel, err = projectsWrapper.Create(&projModel)
 		if err != nil {
-			return errors.Wrapf(err, "%s", failedCreatingProj)
+			return errors.Wrapf(err, "%s", services.FailedCreatingProj)
 		}
 
 		// Checking the response
 		if errorModel != nil {
-			return errors.Errorf(ErrorCodeFormat, failedCreatingProj, errorModel.Code, errorModel.Message)
+			return errors.Errorf(services.ErrorCodeFormat, services.FailedCreatingProj, errorModel.Code, errorModel.Message)
 		} else if projResponseModel != nil {
 			err = printByFormat(cmd, toProjectView(*projResponseModel))
 			if err != nil {
-				return errors.Wrapf(err, "%s", failedCreatingProj)
+				return errors.Wrapf(err, "%s", services.FailedCreatingProj)
 			}
 		}
-		err = assignGroupsToProjectNewAccessManagement(projResponseModel.ID, projResponseModel.Name, groups, accessManagementWrapper)
+		err = services.AssignGroupsToProjectNewAccessManagement(projResponseModel.ID, projResponseModel.Name, groups, accessManagementWrapper)
 		if err != nil {
 			return err
 		}
@@ -413,7 +404,7 @@ func runListProjectsCommand(projectsWrapper wrappers.ProjectsWrapper) func(cmd *
 
 		// Checking the response
 		if errorModel != nil {
-			return errors.Errorf(ErrorCodeFormat, failedGettingAll, errorModel.Code, errorModel.Message)
+			return errors.Errorf(services.ErrorCodeFormat, failedGettingAll, errorModel.Code, errorModel.Message)
 		} else if allProjectsModel != nil && allProjectsModel.Projects != nil {
 			err = printByFormat(cmd, toProjectViews(allProjectsModel.Projects))
 			if err != nil {
@@ -431,15 +422,15 @@ func runGetProjectByIDCommand(projectsWrapper wrappers.ProjectsWrapper) func(cmd
 		var err error
 		projectID, _ := cmd.Flags().GetString(commonParams.ProjectIDFlag)
 		if projectID == "" {
-			return errors.Errorf("%s: Please provide a project ID", failedGettingProj)
+			return errors.Errorf("%s: Please provide a project ID", services.FailedGettingProj)
 		}
 		projectResponseModel, errorModel, err = projectsWrapper.GetByID(projectID)
 		if err != nil {
-			return errors.Wrapf(err, "%s", failedGettingProj)
+			return errors.Wrapf(err, "%s", services.FailedGettingProj)
 		}
 		// Checking the response
 		if errorModel != nil {
-			return errors.Errorf("%s: CODE: %d, %s", failedGettingProj, errorModel.Code, errorModel.Message)
+			return errors.Errorf("%s: CODE: %d, %s", services.FailedGettingProj, errorModel.Code, errorModel.Message)
 		} else if projectResponseModel != nil {
 			err = printByFormat(cmd, toProjectView(*projectResponseModel))
 			if err != nil {
@@ -504,7 +495,7 @@ func runDeleteProjectCommand(projectsWrapper wrappers.ProjectsWrapper) func(cmd
 		}
 		// Checking the response
 		if errorModel != nil {
-			return errors.Errorf(ErrorCodeFormat, failedDeletingProj, errorModel.Code, errorModel.Message)
+			return errors.Errorf(services.ErrorCodeFormat, failedDeletingProj, errorModel.Code, errorModel.Message)
 		}
 		return nil
 	}

internal/commands/project_test.go

@@ -5,12 +5,11 @@ package commands
 import (
 	"testing"
 
-	applicationErrors "github.com/checkmarx/ast-cli/internal/errors"
+	errorConstants "github.com/checkmarx/ast-cli/internal/constants/errors"
 	"github.com/checkmarx/ast-cli/internal/wrappers/mock"
+	"github.com/checkmarx/ast-cli/internal/wrappers/utils"
 
 	"gotest.tools/assert"
-
-	"github.com/checkmarx/ast-cli/internal/commands/util"
 )
 
 func TestProjectHelp(t *testing.T) {
@@ -31,22 +30,22 @@ func TestProjectCreate_ExistingApplication_CreateProjectUnderApplicationSuccessf
 
 func TestProjectCreate_ExistingApplicationWithNoPermission_FailToCreateProject(t *testing.T) {
 	err := execCmdNotNilAssertion(t, "project", "create", "--project-name", "test_project", "--application-name", mock.NoPermissionApp)
-	assert.Assert(t, err.Error() == applicationErrors.ApplicationDoesntExistOrNoPermission)
+	assert.Assert(t, err.Error() == errorConstants.ApplicationDoesntExistOrNoPermission)
 }
 
 func TestProjectCreate_OnReceivingHttpBadRequestStatusCode_FailedToCreateScan(t *testing.T) {
-	err := execCmdNotNilAssertion(t, "project", "create", "--project-name", "test_project", "--application-name", mock.FakeHTTPStatusBadRequest)
-	assert.Assert(t, err.Error() == applicationErrors.FailedToGetApplication)
+	err := execCmdNotNilAssertion(t, "project", "create", "--project-name", "test_project", "--application-name", mock.FakeBadRequest400)
+	assert.Assert(t, err.Error() == errorConstants.FailedToGetApplication)
 }
 
 func TestProjectCreate_OnReceivingHttpInternalServerErrorStatusCode_FailedToCreateScan(t *testing.T) {
-	err := execCmdNotNilAssertion(t, "project", "create", "--project-name", "test_project", "--application-name", mock.FakeHTTPStatusInternalServerError)
-	assert.Assert(t, err.Error() == applicationErrors.FailedToGetApplication)
+	err := execCmdNotNilAssertion(t, "project", "create", "--project-name", "test_project", "--application-name", mock.FakeInternalServerError500)
+	assert.Assert(t, err.Error() == errorConstants.FailedToGetApplication)
 }
 
 func TestRunCreateProjectCommandWithNoInput(t *testing.T) {
 	err := execCmdNotNilAssertion(t, "project", "create")
-	assert.Assert(t, err.Error() == "Project name is required")
+	assert.Assert(t, err.Error() == errorConstants.ProjectNameIsRequired)
 }
 
 func TestRunCreateProjectCommandWithInvalidFormat(t *testing.T) {
@@ -178,7 +177,7 @@ func TestCreateProjectWrongSSHKeyPath(t *testing.T) {
 		"open dummy_key: no such file or directory",
 	}
 
-	assert.Assert(t, util.Contains(expectedMessages, err.Error()))
+	assert.Assert(t, utils.Contains(expectedMessages, err.Error()))
 }
 
 func TestCreateProjectWithSSHKey(t *testing.T) {