Display workspace content for debugging (#4839)

* display workspace content for debugging

* adding verbose check

* renaming function

cmd/detectExecuteScan.go

@@ -151,8 +151,11 @@ func detectExecuteScan(config detectExecuteScanOptions, _ *telemetry.CustomData,
 		log.Entry().WithError(err).Warning("Failed to get GitHub client")
 	}
 
-	// Log config for debug purpose
-	logConfigInVerboseMode(config)
+	// Log config and workspace content for debug purpose
+	if log.IsVerbose() {
+		logConfigInVerboseMode(config)
+		logWorkspaceContent()
+	}
 
 	if config.PrivateModules != "" && config.PrivateModulesGitToken != "" {
 		//configuring go private packages

cmd/utils.go

@@ -2,6 +2,9 @@ package cmd
 
 import (
 	"os"
+	"path/filepath"
+
+	"github.com/SAP/jenkins-library/pkg/log"
 )
 
 // Deprecated: Please use piperutils.Files{} instead
@@ -12,3 +15,20 @@ func fileExists(filename string) bool {
 	}
 	return !info.IsDir()
 }
+
+func logWorkspaceContent() {
+	currentDir, err := os.Getwd()
+	if err != nil {
+		log.Entry().Errorf("Error getting current directory: %v", err)
+	}
+	log.Entry().Debugf("Contents of Workspace:")
+	filepath.Walk(currentDir, func(path string, info os.FileInfo, err error) error {
+		if err != nil {
+			log.Entry().Errorf("Error parsing current directory: %v", err)
+		}
+		mode := info.Mode()
+		log.Entry().Debugf(" %s (%s)", path, mode)
+		return nil
+	})
+
+}

cmd/whitesourceExecuteScan.go

@@ -148,6 +148,9 @@ func whitesourceExecuteScan(config ScanOptions, _ *telemetry.CustomData, commonP
 	if err != nil {
 		log.Entry().WithError(err).Warning("Failed to get GitHub client")
 	}
+	if log.IsVerbose() {
+		logWorkspaceContent()
+	}
 	utils := newWhitesourceUtils(&config, client)
 	scan := newWhitesourceScan(&config)
 	sys := ws.NewSystem(config.ServiceURL, config.OrgToken, config.UserToken, time.Duration(config.Timeout)*time.Second)

pkg/log/log.go

@@ -92,6 +92,11 @@ func SetVerbose(verbose bool) {
 	}
 }
 
+// IsVerbose returns true if DegbuLevel is enabled.
+func IsVerbose() bool {
+	return logrus.GetLevel() == logrus.DebugLevel
+}
+
 // SetFormatter specifies the log format to use for piper's output
 func SetFormatter(logFormat string) {
 	Entry().Logger.SetFormatter(&PiperLogFormatter{logFormat: logFormat})