Merge pull request #171 from debricked/6621-verbose-flag

Verbose Flag for Resolution

internal/cmd/resolve/resolve.go

@@ -11,9 +11,11 @@ import (
 )
 
 var exclusions = file.Exclusions()
+var verbose bool
 
 const (
 	ExclusionFlag = "exclusion"
+	VerboseFlag   = "verbose"
 )
 
 func NewResolveCmd(resolver resolution.IResolver) *cobra.Command {
@@ -45,6 +47,7 @@ Exclude flags could alternatively be set using DEBRICKED_EXCLUSIONS="path1,path2
 
 Example: 
 $ debricked resolve . `+exampleFlags)
+	cmd.Flags().BoolVar(&verbose, VerboseFlag, true, "set to false to disable extensive resolution error messages")
 
 	viper.MustBindEnv(ExclusionFlag)
 
@@ -56,7 +59,7 @@ func RunE(resolver resolution.IResolver) func(_ *cobra.Command, args []string) e
 		if len(args) == 0 {
 			args = append(args, ".")
 		}
-		_, err := resolver.Resolve(args, viper.GetStringSlice(ExclusionFlag))
+		_, err := resolver.Resolve(args, viper.GetStringSlice(ExclusionFlag), viper.GetBool(VerboseFlag))
 
 		return err
 	}

internal/cmd/scan/scan.go

@@ -19,6 +19,7 @@ var commitAuthor string
 var repositoryUrl string
 var integrationName string
 var exclusions = file.Exclusions()
+var verbose bool
 var noResolve bool
 var noFingerprint bool
 var passOnDowntime bool
@@ -34,6 +35,7 @@ const (
 	RepositoryUrlFlag            = "repository-url"
 	IntegrationFlag              = "integration"
 	ExclusionFlag                = "exclusion"
+	VerboseFlag                  = "verbose"
 	NoResolveFlag                = "no-resolve"
 	FingerprintFlag              = "fingerprint"
 	PassOnTimeOut                = "pass-on-timeout"
@@ -89,6 +91,7 @@ Exclude flags could alternatively be set using DEBRICKED_EXCLUSIONS="path1,path2
 
 Examples: 
 $ debricked scan . `+exampleFlags)
+	cmd.Flags().BoolVar(&verbose, VerboseFlag, true, "set to false to disable extensive resolution error messages")
 	cmd.Flags().BoolVarP(&passOnDowntime, PassOnTimeOut, "p", false, "pass scan if there is a service access timeout")
 	cmd.Flags().BoolVar(&noResolve, NoResolveFlag, false, `disables resolution of manifest files that lack lock files. Resolving manifest files enables more accurate dependency scanning since the whole dependency tree will be analysed.
 For example, if there is a "go.mod" in the target path, its dependencies are going to get resolved onto a lock file, and latter scanned.`)
@@ -120,6 +123,7 @@ func RunE(s *scan.IScanner) func(_ *cobra.Command, args []string) error {
 			Resolve:                  !viper.GetBool(NoResolveFlag),
 			Fingerprint:              viper.GetBool(FingerprintFlag),
 			Exclusions:               viper.GetStringSlice(ExclusionFlag),
+			Verbose:                  viper.GetBool(VerboseFlag),
 			RepositoryName:           viper.GetString(RepositoryFlag),
 			CommitName:               viper.GetString(CommitFlag),
 			BranchName:               viper.GetString(BranchFlag),

internal/resolution/resolver.go

@@ -12,7 +12,7 @@ import (
 )
 
 type IResolver interface {
-	Resolve(paths []string, exclusions []string) (IResolution, error)
+	Resolve(paths []string, exclusions []string, verbose bool) (IResolution, error)
 }
 
 type Resolver struct {
@@ -36,7 +36,7 @@ func NewResolver(
 	}
 }
 
-func (r Resolver) Resolve(paths []string, exclusions []string) (IResolution, error) {
+func (r Resolver) Resolve(paths []string, exclusions []string, verbose bool) (IResolution, error) {
 	files, err := r.refinePaths(paths, exclusions)
 	if err != nil {
 		return nil, err
@@ -60,7 +60,7 @@ func (r Resolver) Resolve(paths []string, exclusions []string) (IResolution, err
 
 	if resolution.HasErr() {
 		jobErrList := tui.NewJobsErrorList(os.Stdout, resolution.Jobs())
-		err = jobErrList.Render()
+		err = jobErrList.Render(verbose)
 	}
 
 	return resolution, err

internal/resolution/resolver_test.go

@@ -40,7 +40,7 @@ func TestResolve(t *testing.T) {
 		NewScheduler(workers),
 	)
 
-	res, err := r.Resolve([]string{"../../go.mod"}, nil)
+	res, err := r.Resolve([]string{"../../go.mod"}, nil, true)
 	assert.NotEmpty(t, res.Jobs())
 	assert.NoError(t, err)
 }
@@ -53,7 +53,7 @@ func TestResolveInvokeError(t *testing.T) {
 		NewScheduler(workers),
 	)
 
-	_, err := r.Resolve([]string{"../../go.mod"}, nil)
+	_, err := r.Resolve([]string{"../../go.mod"}, nil, true)
 	assert.NotNil(t, err)
 }
 
@@ -65,7 +65,7 @@ func TestResolveStrategyError(t *testing.T) {
 		NewScheduler(workers),
 	)
 
-	res, err := r.Resolve([]string{"../../go.mod"}, nil)
+	res, err := r.Resolve([]string{"../../go.mod"}, nil, true)
 	assert.Empty(t, res.Jobs())
 	assert.NoError(t, err)
 }
@@ -79,7 +79,7 @@ func TestResolveScheduleError(t *testing.T) {
 		SchedulerMock{Err: errAssertion},
 	)
 
-	res, err := r.Resolve([]string{"../../go.mod"}, nil)
+	res, err := r.Resolve([]string{"../../go.mod"}, nil, true)
 	assert.NotEmpty(t, res.Jobs())
 	assert.ErrorIs(t, err, errAssertion)
 }
@@ -92,7 +92,7 @@ func TestResolveDirWithoutManifestFiles(t *testing.T) {
 		SchedulerMock{},
 	)
 
-	res, err := r.Resolve([]string{"."}, nil)
+	res, err := r.Resolve([]string{"."}, nil, true)
 	assert.Empty(t, res.Jobs())
 	assert.NoError(t, err)
 }
@@ -105,7 +105,7 @@ func TestResolveInvalidDir(t *testing.T) {
 		SchedulerMock{},
 	)
 
-	_, err := r.Resolve([]string{"invalid-dir"}, nil)
+	_, err := r.Resolve([]string{"invalid-dir"}, nil, true)
 	assert.Error(t, err)
 }
 
@@ -121,7 +121,7 @@ func TestResolveGetGroupsErr(t *testing.T) {
 		SchedulerMock{},
 	)
 
-	_, err := r.Resolve([]string{"."}, nil)
+	_, err := r.Resolve([]string{"."}, nil, true)
 	assert.ErrorIs(t, testErr, err)
 }
 
@@ -149,7 +149,7 @@ func TestResolveDirWithManifestFiles(t *testing.T) {
 
 	for _, dir := range cases {
 		t.Run(fmt.Sprintf("Case: %s", dir), func(t *testing.T) {
-			res, err := r.Resolve([]string{dir}, nil)
+			res, err := r.Resolve([]string{dir}, nil, true)
 			assert.Len(t, res.Jobs(), 1)
 			j := res.Jobs()[0]
 			assert.False(t, j.Errors().HasError())
@@ -172,7 +172,7 @@ func TestResolveDirWithExclusions(t *testing.T) {
 		SchedulerMock{},
 	)
 
-	res, err := r.Resolve([]string{"."}, []string{"dir"})
+	res, err := r.Resolve([]string{"."}, []string{"dir"}, true)
 
 	assert.Len(t, res.Jobs(), 1)
 	j := res.Jobs()[0]
@@ -199,7 +199,7 @@ func TestResolveHasResolutionErrs(t *testing.T) {
 		schedulerMock,
 	)
 
-	res, err := r.Resolve([]string{""}, []string{""})
+	res, err := r.Resolve([]string{""}, []string{""}, true)
 
 	assert.NoError(t, err)
 	assert.Len(t, res.Jobs(), 1)

internal/resolution/testdata/resolver_mock.go

@@ -12,7 +12,7 @@ type ResolverMock struct {
 	files []string
 }
 
-func (r *ResolverMock) Resolve(_ []string, _ []string) (resolution.IResolution, error) {
+func (r *ResolverMock) Resolve(_ []string, _ []string, _ bool) (resolution.IResolution, error) {
 	for _, f := range r.files {
 		createdFile, err := os.Create(f)
 		if err != nil {

internal/scan/scanner.go

@@ -47,6 +47,7 @@ type DebrickedOptions struct {
 	Fingerprint              bool
 	CallGraph                bool
 	Exclusions               []string
+	Verbose                  bool
 	RepositoryName           string
 	CommitName               string
 	BranchName               string
@@ -132,7 +133,7 @@ func (dScanner *DebrickedScanner) Scan(o IOptions) error {
 
 func (dScanner *DebrickedScanner) scanResolve(options DebrickedOptions) error {
 	if options.Resolve {
-		_, resErr := dScanner.resolver.Resolve([]string{options.Path}, options.Exclusions)
+		_, resErr := dScanner.resolver.Resolve([]string{options.Path}, options.Exclusions, options.Verbose)
 		if resErr != nil {
 			return resErr
 		}

internal/tui/resolution_error_list.go

@@ -23,7 +23,7 @@ func NewJobsErrorList(mirror io.Writer, jobs []job.IJob) JobsErrorList {
 	return JobsErrorList{mirror: mirror, jobs: jobs}
 }
 
-func (jobsErrList JobsErrorList) Render() error {
+func (jobsErrList JobsErrorList) Render(verbose bool) error {
 	var listBuffer bytes.Buffer
 
 	formattedTitle := fmt.Sprintf("%s\n", color.BlueString(title))
@@ -32,15 +32,15 @@ func (jobsErrList JobsErrorList) Render() error {
 	listBuffer.Write([]byte(underlining))
 
 	for _, j := range jobsErrList.jobs {
-		jobsErrList.addJob(&listBuffer, j)
+		jobsErrList.addJob(&listBuffer, j, verbose)
 	}
 
 	_, err := jobsErrList.mirror.Write(listBuffer.Bytes())
 
 	return err
 }
 
-func (jobsErrList JobsErrorList) addJob(list *bytes.Buffer, job job.IJob) {
+func (jobsErrList JobsErrorList) addJob(list *bytes.Buffer, job job.IJob, verbose bool) {
 	var jobString string
 	if !job.Errors().HasError() {
 		return
@@ -49,7 +49,10 @@ func (jobsErrList JobsErrorList) addJob(list *bytes.Buffer, job job.IJob) {
 	list.Write([]byte(fmt.Sprintf("%s\n", color.YellowString(job.GetFile()))))
 
 	for _, warning := range job.Errors().GetWarningErrors() {
-		err := jobsErrList.createErrorString(warning, true)
+		err := ""
+		if verbose {
+			err = jobsErrList.createErrorString(warning, true)
+		}
 		cmd := warning.Command()
 		doc := warning.Documentation()
 		status := warning.Status()
@@ -65,7 +68,10 @@ func (jobsErrList JobsErrorList) addJob(list *bytes.Buffer, job job.IJob) {
 	}
 
 	for _, critical := range job.Errors().GetCriticalErrors() {
-		err := jobsErrList.createErrorString(critical, false)
+		err := ""
+		if verbose {
+			err = jobsErrList.createErrorString(critical, false)
+		}
 		cmd := critical.Command()
 		doc := critical.Documentation()
 		status := critical.Status()

internal/tui/resolution_error_list_test.go

@@ -20,7 +20,7 @@ func TestRenderNoJobs(t *testing.T) {
 	var listBuffer bytes.Buffer
 	errList := NewJobsErrorList(&listBuffer, []job.IJob{})
 
-	err := errList.Render()
+	err := errList.Render(true)
 
 	assert.NoError(t, err)
 	output := listBuffer.String()
@@ -35,7 +35,7 @@ func TestRenderWarningJob(t *testing.T) {
 	jobMock.Errors().Warning(warningErr)
 	errList := NewJobsErrorList(&listBuffer, []job.IJob{jobMock})
 
-	err := errList.Render()
+	err := errList.Render(true)
 
 	assert.NoError(t, err)
 	output := listBuffer.String()
@@ -57,7 +57,7 @@ func TestRenderCriticalJob(t *testing.T) {
 	jobMock.Errors().Critical(warningErr)
 	errList := NewJobsErrorList(&listBuffer, []job.IJob{jobMock})
 
-	err := errList.Render()
+	err := errList.Render(true)
 
 	assert.NoError(t, err)
 	output := listBuffer.String()
@@ -71,6 +71,27 @@ func TestRenderCriticalJob(t *testing.T) {
 	assertOutput(t, output, contains)
 }
 
+func TestRenderCriticalJobNoVerbose(t *testing.T) {
+	var listBuffer bytes.Buffer
+
+	warningErr := job.NewBaseJobError("critical-message")
+	jobMock := testdata.NewJobMock("file")
+	jobMock.Errors().Critical(warningErr)
+	errList := NewJobsErrorList(&listBuffer, []job.IJob{jobMock})
+
+	err := errList.Render(false)
+
+	assert.NoError(t, err)
+	output := listBuffer.String()
+	contains := []string{
+		"file",
+		"\n* ",
+		"Critical",
+	}
+	assertOutput(t, output, contains)
+	assert.NotContains(t, output, "critical-message\n")
+}
+
 func TestRenderCriticalAndWarningJob(t *testing.T) {
 	var listBuffer bytes.Buffer
 
@@ -84,7 +105,7 @@ func TestRenderCriticalAndWarningJob(t *testing.T) {
 
 	errList := NewJobsErrorList(&listBuffer, []job.IJob{jobMock})
 
-	err := errList.Render()
+	err := errList.Render(true)
 
 	assert.NoError(t, err)
 	output := listBuffer.String()
@@ -112,7 +133,7 @@ func TestRenderCriticalAndWorkingJob(t *testing.T) {
 
 	errList := NewJobsErrorList(&listBuffer, []job.IJob{jobWithErrMock, jobWorkingMock})
 
-	err := errList.Render()
+	err := errList.Render(true)
 
 	assert.NoError(t, err)
 	output := listBuffer.String()