Merge pull request #53 from CheckmarxDev/feature/default_config

Removed AST description references

Author: Daniel-Amsellem

internal/commands/app.go

@@ -10,25 +10,25 @@ import (
 
 const (
 	deployScriptPath   = "./installation-scripts/ast-install.sh"
-	failedDeployingApp = "Failed deploying AST app"
-	failedShowingApp   = "Failed showing AST app"
+	failedDeployingApp = "Failed deploying app"
+	failedShowingApp   = "Failed showing app"
 )
 
 func NewAppCommand() *cobra.Command {
 	appCmd := &cobra.Command{
 		Use:   "app",
-		Short: "Manage AST resources",
+		Short: "Manage resources",
 	}
 
 	deployAppCmd := &cobra.Command{
 		Use:   "deploy",
-		Short: "Deploy AST into existing cluster",
+		Short: "Deploy into existing cluster",
 		RunE:  runDeployAppCommand(),
 	}
 
 	showAppCmd := &cobra.Command{
 		Use:   "show",
-		Short: "Show AST resources condition",
+		Short: "Show resources state",
 		RunE:  runShowAppCommand(),
 	}
 	appCmd.AddCommand(deployAppCmd, showAppCmd)

internal/commands/cluster.go

@@ -20,7 +20,7 @@ const (
 func NewClusterCommand() *cobra.Command {
 	clusterCmd := &cobra.Command{
 		Use:   "cluster",
-		Short: "Manage AST cluster",
+		Short: "Manage cluster",
 	}
 
 	installClusterCmd := &cobra.Command{
@@ -35,7 +35,7 @@ func NewClusterCommand() *cobra.Command {
 
 	showClusterCmd := &cobra.Command{
 		Use:   "show",
-		Short: "Show AST resources",
+		Short: "Show resources",
 		RunE:  runShowClusterCommand(),
 	}
 	clusterCmd.AddCommand(installClusterCmd, showClusterCmd)

internal/commands/default_config.yml

@@ -13,7 +13,7 @@ log:
 database:
   host:
   port:
-  instance: instance
+  instance: instance_from_default
   username:
   password:
 network:

internal/commands/health.go

@@ -12,7 +12,7 @@ import (
 func NewHealthCheckCommand(healthCheckWrapper wrappers.HealthCheckWrapper) *cobra.Command {
 	return &cobra.Command{
 		Use:   "health-check",
-		Short: "Run AST health check",
+		Short: "Run health check",
 		RunE:  runAllHealthChecks(healthCheckWrapper),
 	}
 }

internal/commands/project.go

@@ -36,7 +36,7 @@ var (
 func NewProjectCommand(projectsWrapper wrappers.ProjectsWrapper) *cobra.Command {
 	projCmd := &cobra.Command{
 		Use:   "project",
-		Short: "Manage AST projects",
+		Short: "Manage projects",
 	}
 
 	createProjCmd := &cobra.Command{

internal/commands/result.go

@@ -34,7 +34,7 @@ var (
 func NewResultCommand(resultsWrapper wrappers.ResultsWrapper) *cobra.Command {
 	resultCmd := &cobra.Command{
 		Use:   "result",
-		Short: "Retrieve AST results",
+		Short: "Retrieve results",
 	}
 
 	listResultsCmd := &cobra.Command{

internal/commands/rm.go

@@ -38,7 +38,7 @@ func NewSastResourcesCommand(rmWrapper wrappers.SastRmWrapper) *cobra.Command {
 	sastrmCmd := &cobra.Command{
 		Use:     "sast-resources",
 		Aliases: []string{"sr"},
-		Short:   "AST sast queue status (short form: 'sr')",
+		Short:   "SAST queue status (short form: 'sr')",
 	}
 	sastrmCmd.AddCommand(scansCmd, enginesCmd, statsCmd)
 	return sastrmCmd

internal/commands/root.go

@@ -30,11 +30,11 @@ const (
 	scanTagsFlag                  = "tag"
 	scanTagsFlagSh                = "t"
 	accessKeyIDFlag               = "key"
-	accessKeyIDFlagUsage          = "The access key ID for AST"
+	accessKeyIDFlagUsage          = "The access key ID"
 	accessKeySecretFlag           = "secret"
-	accessKeySecretFlagUsage      = "The access key secret for AST"
+	accessKeySecretFlagUsage      = "The access key secret"
 	astAuthenticationURIFlag      = "auth-uri"
-	astAuthenticationURIFlagUsage = "The authentication URI for AST"
+	astAuthenticationURIFlagUsage = "The authentication URI"
 	insecureFlag                  = "insecure"
 	insecureFlagUsage             = "Ignore TLS certificate validations"
 	formatFlag                    = "format"
@@ -57,8 +57,7 @@ func NewAstCLI(
 	defaultConfigFileLocation string,
 ) *cobra.Command {
 	rootCmd := &cobra.Command{
-		Use:   "ast",
-		Short: "A CLI wrapping Checkmarx AST APIs",
+		Use: "ast",
 	}
 
 	rootCmd.PersistentFlags().BoolP(verboseFlag, verboseFlagSh, false, verboseUsage)

internal/commands/scan.go

@@ -43,7 +43,7 @@ var (
 func NewScanCommand(scansWrapper wrappers.ScansWrapper, uploadsWrapper wrappers.UploadsWrapper) *cobra.Command {
 	scanCmd := &cobra.Command{
 		Use:   "scan",
-		Short: "Manage AST scans",
+		Short: "Manage scans",
 	}
 
 	createScanCmd := &cobra.Command{

internal/commands/single_node.go

@@ -26,7 +26,7 @@ const (
 )
 
 var (
-	astRoleFlagUsage = fmt.Sprintf("The AST runtime role. Available roles are: %s",
+	astRoleFlagUsage = fmt.Sprintf("The runtime role. Available roles are: %s",
 		strings.Join([]string{
 			commonParams.ScaAgent,
 			commonParams.SastALlInOne,
@@ -37,30 +37,30 @@ var (
 func NewSingleNodeCommand(healthCheckWrapper wrappers.HealthCheckWrapper, defaultConfigFileLocation string) *cobra.Command {
 	singleNodeCmd := &cobra.Command{
 		Use:   "single-node",
-		Short: "Single Node AST",
+		Short: "Single Node",
 	}
 
 	upSingleNodeCmd := &cobra.Command{
 		Use:   "up",
-		Short: "Start AST",
+		Short: "Start the system",
 		RunE:  runUpSingleNodeCommand(defaultConfigFileLocation),
 	}
 	downSingleNodeCmd := &cobra.Command{
 		Use:   "down",
-		Short: "Stop AST",
+		Short: "Stop the system",
 		RunE:  runDownSingleNodeCommand(),
 	}
 
 	updateSingleNodeCmd := &cobra.Command{
 		Use:   "update",
-		Short: "Update AST",
+		Short: "Update the system",
 		RunE:  runUpdateSingleNodeCommand(defaultConfigFileLocation),
 	}
 
 	healthSingleNodeCmd := NewHealthCheckCommand(healthCheckWrapper)
 
-	installationConfigFileUsage := "Configuration file path for AST (optional)"
-	installationFolderUsage := "AST installation folder path"
+	installationConfigFileUsage := "Configuration file path (optional)"
+	installationFolderUsage := "Installation folder path"
 	installationFolderDefault := "./"
 
 	upSingleNodeCmd.PersistentFlags().String(configFileFlag, "", installationConfigFileUsage)
@@ -84,27 +84,27 @@ func NewSingleNodeCommand(healthCheckWrapper wrappers.HealthCheckWrapper, defaul
 
 func runUpSingleNodeCommand(defaultConfigFileLocation string) func(cmd *cobra.Command, args []string) error {
 	return func(cmd *cobra.Command, args []string) error {
-		writeToStandardOutput("Trying to start AST...")
+		writeToStandardOutput("Trying to start...")
 		err := runUpScript(cmd, defaultConfigFileLocation)
 		if err != nil {
-			msg := "Failed to start AST"
+			msg := "Failed to start"
 			return errors.Wrapf(err, msg)
 		}
-		writeToStandardOutput("AST is up!")
+		writeToStandardOutput("System is up!")
 		return nil
 	}
 }
 
 func runDownSingleNodeCommand() func(cmd *cobra.Command, args []string) error {
 	return func(cmd *cobra.Command, args []string) error {
-		writeToStandardOutput("Trying to stop AST...")
+		writeToStandardOutput("Trying to stop...")
 		err := runDownScript(cmd)
 
 		if err != nil {
-			msg := "Failed to stop AST"
+			msg := "Failed to stop"
 			return errors.Wrapf(err, msg)
 		}
-		writeToStandardOutput("AST is down!")
+		writeToStandardOutput("System is down!")
 		return nil
 	}
 }
@@ -119,7 +119,7 @@ func runUpdateSingleNodeCommand(defaultConfigFileLocation string) func(cmd *cobr
 		if err != nil {
 			return err
 		}
-		writeToStandardOutput("AST updated successfully!")
+		writeToStandardOutput("System updated successfully!")
 		return nil
 	}
 }