feat: add AutoBuild(Failed)?Count

Author: iseki0

cmd/murphy/internal/internalcmd/scanner_scan.go

@@ -4,6 +4,10 @@ import (
 	"context"
 	"encoding/json"
 	"fmt"
+	"os"
+	"path/filepath"
+	"time"
+
 	"github.com/murphysecurity/murphysec/cmd/murphy/internal/common"
 	"github.com/murphysecurity/murphysec/env"
 	"github.com/murphysecurity/murphysec/infra/exitcode"
@@ -15,9 +19,6 @@ import (
 	"github.com/murphysecurity/murphysec/utils"
 	"github.com/murphysecurity/murphysec/utils/must"
 	"github.com/spf13/cobra"
-	"os"
-	"path/filepath"
-	"time"
 )
 
 func scannerScanCmd() *cobra.Command {
@@ -76,13 +77,17 @@ func scannerScanRun(cmd *cobra.Command, args []string) {
 		ScannerShouldEnableMavenBackupScan  bool                          `json:"scanner_should_enable_maven_backup_scan"`
 		ScannerShouldEnableGradleBackupScan bool                          `json:"scanner_should_enable_gradle_backup_scan"`
 		ScanWarnings                        []scanerr.Param               `json:"scan_warnings"`
+		AutoBuildCount                      int                           `json:"auto_build_count"`
+		AutoBuildFailedCount                int                           `json:"auto_build_failed_count"`
 	}
 	w := wrapper{
 		Modules:                             utils.NoNilSlice(scantask.Modules),
 		ComponentCodeFragment:               utils.NoNilSlice(scantask.CodeFragments),
 		ScannerShouldEnableMavenBackupScan:  env.ScannerShouldEnableMavenBackupScan,
 		ScannerShouldEnableGradleBackupScan: env.ScannerShouldEnableGradleBackupScan,
 		ScanWarnings:                        scanerr.GetAll(ctx),
+		AutoBuildCount:                      scantask.AutoBuildCount,
+		AutoBuildFailedCount:                scantask.AutoBuildFailedCount,
 	}
 	if env.WaitAfterScannerScan {
 		logger.Warn("client will wait here!")

model/inspection_task.go

@@ -8,6 +8,7 @@ import (
 type InspectionTask struct {
 	scanTask      *ScanTask
 	inspectionDir string
+	noCopy
 }
 
 func (i *InspectionTask) MavenModuleName() []string {
@@ -63,3 +64,27 @@ func (i *InspectionTask) AddModule(module Module) {
 	module.ModulePath = filepath.ToSlash(module.ModulePath)
 	i.scanTask.Modules = append(i.scanTask.Modules, module)
 }
+
+type RegisteredAutoBuild struct {
+	task   *ScanTask
+	marked bool
+	noCopy
+}
+
+func (r *RegisteredAutoBuild) MarkFailed() {
+	if r.marked {
+		return
+	}
+	r.marked = true
+	r.task.AutoBuildFailedCount++
+}
+
+func (r *RegisteredAutoBuild) MarkDisabled() {
+	r.marked = true
+	r.task.AutoBuildCount--
+}
+
+func (i *InspectionTask) RegisterAutoBuild() *RegisteredAutoBuild {
+	i.scanTask.AutoBuildCount++
+	return &RegisteredAutoBuild{task: i.scanTask}
+}

model/nocopy.go

@@ -0,0 +1,6 @@
+package model
+
+type noCopy struct{}
+
+func (*noCopy) Lock()   {}
+func (*noCopy) Unlock() {}

model/scantask.go

@@ -22,6 +22,10 @@ type ScanTask struct {
 	IsInternalCmd   bool
 	IsAutonomous    bool
 	MavenModuleName []string
+
+	AutoBuildCount int
+
+	AutoBuildFailedCount int
 }
 
 func (s *ScanTask) BuildInspectionTask(dir string) *InspectionTask {

module/gradle/gradle.go

@@ -5,6 +5,14 @@ import (
 	"context"
 	_ "embed"
 	"fmt"
+	"io"
+	"io/fs"
+	"os"
+	"path"
+	"path/filepath"
+	"strings"
+	"sync"
+
 	"github.com/murphysecurity/murphysec/env"
 	"github.com/murphysecurity/murphysec/infra/logctx"
 	"github.com/murphysecurity/murphysec/infra/sl"
@@ -14,13 +22,6 @@ import (
 	"golang.org/x/exp/slices"
 	"golang.org/x/sync/errgroup"
 	"gopkg.in/yaml.v3"
-	"io"
-	"io/fs"
-	"os"
-	"path"
-	"path/filepath"
-	"strings"
-	"sync"
 )
 
 type Inspector struct{}
@@ -47,9 +48,11 @@ func (Inspector) InspectProject(ctx context.Context) error {
 		useGradle = false
 	}
 	if useGradle {
+		registeredAutoBuild := task.RegisterAutoBuild()
 		logger.Info(gradleEnv.Version.String())
 		rs, e = evalGradleDependencies(ctx, dir, gradleEnv)
 		if e != nil {
+			registeredAutoBuild.MarkFailed()
 			logger.Warnf("gradle failed: %s", e)
 		}
 	}

module/maven/maven.go

@@ -49,12 +49,15 @@ func ScanMavenProject(ctx context.Context, task *model.InspectionTask) ([]model.
 	var useBackupResolver = false
 	var deps *DepsMap
 
+	registeredAutoBuild := task.RegisterAutoBuild()
 	// check maven version, skip maven scan if check fail
 	mvnCmdInfo, e := CheckMvnCommand(ctx, task.IsNoBuild())
 	if e != nil {
 		if errors.Is(e, ErrMvnDisabled) {
 			scanerr.Add(ctx, scanerr.Param{Kind: scanerr.KindBuildDisabled})
+			registeredAutoBuild.MarkDisabled()
 		} else if errors.Is(e, ErrMvnNotFound) {
+			registeredAutoBuild.MarkFailed()
 			scanerr.Add(ctx, scanerr.Param{Kind: scanerr.KindMavenNotFound})
 			log.Sugar().Warnf("Mvn command not found %v", e)
 		}
@@ -64,6 +67,7 @@ func ScanMavenProject(ctx context.Context, task *model.InspectionTask) ([]model.
 		var e error
 		deps, e = ScanDepsByPluginCommand(ctx, dir, mvnCmdInfo)
 		if e != nil {
+			registeredAutoBuild.MarkFailed()
 			log.Error("Scan maven dependencies failed", zap.Error(e))
 			useBackupResolver = true
 		}