Engine api hands on exercise-anjali (AST-92867)

.pre-commit-config.yaml

@@ -0,0 +1,3 @@
+repos:
+- repo: local
+  hooks: []

Dockerfile

@@ -3,6 +3,7 @@ USER nonroot
 
 COPY cx /app/bin/cx
 
+
 ENTRYPOINT ["/app/bin/cx"]
 
 HEALTHCHECK NONE

cmd/main.go

@@ -56,7 +56,7 @@ func main() {
 	sastMetadataPath := viper.GetString(params.SastMetadataPathKey)
 	accessManagementPath := viper.GetString(params.AccessManagementPathKey)
 	byorPath := viper.GetString(params.ByorPathKey)
-
+	enginePath := viper.GetString(params.EnginePathKey)
 	customStatesWrapper := wrappers.NewCustomStatesHTTPWrapper()
 	scansWrapper := wrappers.NewHTTPScansWrapper(scans)
 	resultsPdfReportsWrapper := wrappers.NewResultsPdfReportsHTTPWrapper(resultsPdfPath)
@@ -91,6 +91,7 @@ func main() {
 	accessManagementWrapper := wrappers.NewAccessManagementHTTPWrapper(accessManagementPath)
 	byorWrapper := wrappers.NewByorHTTPWrapper(byorPath)
 	containerResolverWrapper := wrappers.NewContainerResolverWrapper()
+	engineWrapper := wrappers.NewHTTPEngineWrapper(enginePath)
 
 	astCli := commands.NewAstCLI(
 		applicationsWrapper,
@@ -127,6 +128,7 @@ func main() {
 		accessManagementWrapper,
 		byorWrapper,
 		containerResolverWrapper,
+		engineWrapper,
 	)
 	exitListener()
 	err = astCli.Execute()

internal/commands/engine.go

@@ -0,0 +1,94 @@
+package commands
+
+import (
+	"github.com/MakeNowJust/heredoc"
+	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"
+)
+
+type EngineView struct {
+	EngineID    string `format:"name:Engine ID"`
+	EngineName  string `format:"name:Engine Name"`
+	ApiName     string `format:"name:Api Name"`
+	ApiURL      string `format:"name:Api URL"`
+	Description string `format:"name:Description"`
+}
+
+// engine command implementation
+func EngineCommand(engineWrapper wrappers.EngineWrapper) *cobra.Command {
+	EngineCmd := &cobra.Command{
+		Use:   "engine",
+		Short: "manages the engine ",
+		Long:  "The scan command enables the ability to manage engine in Checkmarx One.",
+	}
+	listScanCmd := listEngineSubCmd(engineWrapper)
+	EngineCmd.AddCommand(listScanCmd)
+	return EngineCmd
+}
+
+// list Api of engines implementation
+func listEngineSubCmd(engineWrapper wrappers.EngineWrapper) *cobra.Command {
+	enginelistCmd := &cobra.Command{
+		Use:   "list-api",
+		Short: "lists all APIs of CXOne engines",
+		Long:  "The list command provides a list of all  APIs of the engines in Checkmarx One.",
+		Example: heredoc.Doc(
+			`$cx engine list-api
+            `,
+		),
+		RunE: runListEnginesCommand(engineWrapper),
+	}
+	enginelistCmd.PersistentFlags().String(commonParams.EngineName, "", "Name of the engine")
+	enginelistCmd.PersistentFlags().String(commonParams.EngineOutputFormat, "table", "Name of format")
+	return enginelistCmd
+}
+
+// This will call the get method to list the APIs of the engine/engines
+
+func runListEnginesCommand(engineWrapper wrappers.EngineWrapper) func(cmd *cobra.Command, args []string) error {
+	return func(cmd *cobra.Command, args []string) error {
+		var allEngineModel *wrappers.EnginesCollectionResponseModel
+		var errorModel *wrappers.ErrorModel
+		engineName, _ := cmd.Flags().GetString(commonParams.EngineName)
+		var err error
+		allEngineModel, err = engineWrapper.Get(engineName)
+		if err != nil {
+			return errors.Wrapf(err, "%s", "failed getting")
+		}
+		if errorModel != nil {
+			return errors.Errorf(services.ErrorCodeFormat, failedGettingAll, errorModel.Code, errorModel.Message)
+		} else if allEngineModel != nil {
+			views, err := toEngineView(allEngineModel.Engines)
+			if err != nil {
+				return err
+			}
+			err = printByOutputFormat(cmd, views)
+			if err != nil {
+				return err
+			}
+		}
+		return nil
+	}
+}
+
+// Converting the values of EngineResponseModel (returned from API) proper view which can be presented by format
+func toEngineView(engines []wrappers.EngineResponseModel) ([]*EngineView, error) {
+
+	views := make([]*EngineView, 0)
+	for i := 0; i < len(engines); i++ {
+		for j := 0; j < len(engines[i].Apis); j++ {
+			views = append(views, &EngineView{
+				EngineID:    engines[i].EngineID,
+				EngineName:  engines[i].EngineName,
+				ApiName:     engines[i].Apis[j].ApiName,
+				ApiURL:      engines[i].Apis[j].ApiURL,
+				Description: engines[i].Apis[j].Description,
+			})
+		}
+	}
+
+	return views, nil
+}

internal/commands/engine_test.go

@@ -0,0 +1,37 @@
+//go:build !integration
+
+package commands
+
+import (
+	"gotest.tools/assert"
+	"testing"
+)
+
+const (
+	unknownEngineFlag = "unknown flag: --chibutero"
+)
+
+func TestEngineNoSub(t *testing.T) {
+	execCmdNilAssertion(t, "engine")
+}
+
+func TestGetAllEnginesAPI(t *testing.T) {
+	execCmdNilAssertion(t, "engine", "list-api")
+}
+
+func TestRunGetAllEngineAPIFlagNonExist(t *testing.T) {
+	err := execCmdNotNilAssertion(t, "engine", "list-api", "--chibutero")
+	assert.Assert(t, err.Error() == unknownEngineFlag)
+}
+
+func TestGetSASTEnginesAPI(t *testing.T) {
+	execCmdNilAssertion(t, "engine", "list-api", "--engine-name", "sast")
+}
+
+func TestGetSCAEngineAPI(t *testing.T) {
+	execCmdNilAssertion(t, "engine", "list-api", "--engine-name", "sca")
+}
+
+func TestGetDASTEngineAPI(t *testing.T) {
+	execCmdNilAssertion(t, "engine", "list-api", "--engine-name", "dast")
+}

internal/commands/root.go

@@ -55,6 +55,7 @@ func NewAstCLI(
 	accessManagementWrapper wrappers.AccessManagementWrapper,
 	byorWrapper wrappers.ByorWrapper,
 	containerResolverWrapper wrappers.ContainerResolverWrapper,
+	engineWrapper wrappers.EngineWrapper,
 ) *cobra.Command {
 	// Create the root
 	rootCmd := &cobra.Command{
@@ -173,7 +174,7 @@ func NewAstCLI(
 		policyWrapper,
 		featureFlagsWrapper,
 	)
-
+	enginesCmd := EngineCommand(engineWrapper)
 	versionCmd := util.NewVersionCommand()
 	authCmd := NewAuthCommand(authWrapper)
 	utilsCmd := util.NewUtilsCommand(
@@ -209,6 +210,7 @@ func NewAstCLI(
 		resultsCmd,
 		triageCmd,
 		versionCmd,
+		enginesCmd,
 		authCmd,
 		utilsCmd,
 		configCmd,
@@ -319,7 +321,15 @@ func printByFormat(cmd *cobra.Command, view interface{}) error {
 	f, _ := cmd.Flags().GetString(params.FormatFlag)
 	return printer.Print(cmd.OutOrStdout(), view, f)
 }
+
 func printByScanInfoFormat(cmd *cobra.Command, view interface{}) error {
 	f, _ := cmd.Flags().GetString(params.ScanInfoFormatFlag)
 	return printer.Print(cmd.OutOrStdout(), view, f)
 }
+
+// print by --output-format flag
+
+func printByOutputFormat(cmd *cobra.Command, view interface{}) error {
+	f, _ := cmd.Flags().GetString(params.EngineOutputFormat)
+	return printer.Print(cmd.OutOrStdout(), view, f)
+}

internal/commands/root_test.go

@@ -68,6 +68,8 @@ func createASTTestCommand() *cobra.Command {
 	byorWrapper := &mock.ByorMockWrapper{}
 	containerResolverMockWrapper := &mock.ContainerResolverMockWrapper{}
 	customStatesMockWrapper := &mock.CustomStatesMockWrapper{}
+	// Using the same wrapper as it as mocked response
+	engineMockWrapper := &wrappers.EngineHTTPWrapper{}
 	return NewAstCLI(
 		applicationWrapper,
 		scansMockWrapper,
@@ -103,6 +105,7 @@ func createASTTestCommand() *cobra.Command {
 		accessManagementWrapper,
 		byorWrapper,
 		containerResolverMockWrapper,
+		engineMockWrapper,
 	)
 }
 

internal/constants/errors/errors.go

@@ -23,6 +23,9 @@ const (
 	FailedUploadFileMsgWithDomain          = "Unable to upload the file to the pre-signed URL. Try adding the domain: %s to your allow list."
 	FailedUploadFileMsgWithURL             = "Unable to upload the file to the pre-signed URL. Try adding the URL: %s to your allow list."
 
+	// engine
+	EngineDoesNotExist = "Engine does not exits or user has no permission to the engine "
+
 	// asca Engine
 	FileExtensionIsRequired = "file must have an extension"
 )

internal/params/binds.go

@@ -73,6 +73,7 @@ var EnvVarsBinds = []struct {
 	{AiProxyCheckmarxAiRouteKey, AiProxyCheckmarxAiRouteEnv, "api/ai-proxy/redirect/azure"},
 	{ASCAPortKey, ASCAPortEnv, ""},
 	{ScsRepoTokenKey, ScsRepoTokenEnv, ""},
-	{RiskManagementPathKey, RiskManagementPathEnv, "api/risk-management/projects/%s/results?scanID=%s"},
+	{RiskManagementPathKey, RiskManagementPathEnv, "api/risk-management/projects/%s/results"},
+	{EnginePathKey, EnginePathEnv, "api/engines"},
 	{ConfigFilePathKey, ConfigFilePathEnv, ""},
 }

internal/params/envs.go

@@ -73,5 +73,6 @@ const (
 	ASCAPortEnv                         = "CX_ASCA_PORT"
 	ScsRepoTokenEnv                     = "SCS_REPO_TOKEN"
 	RiskManagementPathEnv               = "CX_RISK_MANAGEMENT_PATH"
+	EnginePathEnv                       = "CX_ENGINE_PATH"
 	ConfigFilePathEnv                   = "CX_CONFIG_FILE_PATH"
 )

internal/params/flags.go

@@ -217,6 +217,10 @@ const (
 	ContainersImageTagFilterFlag        = "containers-image-tag-filter"
 	ContainersPackageFilterFlag         = "containers-package-filter"
 	ContainersExcludeNonFinalStagesFlag = "containers-exclude-non-final-stages"
+
+	//Engines
+	EngineName         = "engine-name"
+	EngineOutputFormat = "output-format"
 )
 
 // Parameter values

internal/params/keys.go

@@ -74,4 +74,5 @@ var (
 	ScsRepoTokenKey                     = strings.ToLower(ScsRepoTokenEnv)
 	RiskManagementPathKey               = strings.ToLower(RiskManagementPathEnv)
 	ConfigFilePathKey                   = strings.ToLower(ConfigFilePathEnv)
+	EnginePathKey                       = strings.ToLower(ResultsPathKey)
 )