update logging messages

Signed-off-by: Vivek Kumar Sahu <[email protected]>

fix small issue

Signed-off-by: Vivek Kumar Sahu <[email protected]>

Author: viveksahu26

cmd/transfer.go

@@ -157,9 +157,9 @@ func parseConfig(cmd *cobra.Command) (types.Config, error) {
 		return types.Config{}, fmt.Errorf("output adapter must be one of type: dtrack, interlynk, folder")
 	}
 	config := types.Config{
-		SourceType:      inputType,
-		DestinationType: outputType,
-		DryRun:          dr,
+		SourceAdapter:      inputType,
+		DestinationAdapter: outputType,
+		DryRun:             dr,
 	}
 
 	return config, nil

pkg/adapter/factory.go

@@ -54,10 +54,10 @@ func NewAdapter(ctx *tcontext.TransferMetadata, config types.Config) (map[types.
 	adapters := make(map[types.AdapterRole]Adapter)
 
 	// Initialize Input Adapter
-	if config.SourceType != "" {
-		logger.LogDebug(ctx.Context, "Initializing Input Adapter", "adapterType", config.SourceType)
+	if config.SourceAdapter != "" {
+		logger.LogDebug(ctx.Context, "Initializing Input Adapter", "InputAdapter", config.SourceAdapter)
 
-		switch types.AdapterType(config.SourceType) {
+		switch types.AdapterType(config.SourceAdapter) {
 
 		case types.GithubAdapterType:
 			adapters[types.InputAdapterRole] = &github.GitHubAdapter{Role: types.InputAdapterRole}
@@ -69,15 +69,15 @@ func NewAdapter(ctx *tcontext.TransferMetadata, config types.Config) (map[types.
 			adapters[types.InputAdapterRole] = &interlynk.InterlynkAdapter{Role: types.InputAdapterRole}
 
 		default:
-			return nil, fmt.Errorf("unsupported input adapter type: %s", config.SourceType)
+			return nil, fmt.Errorf("unsupported input adapter type: %s", config.SourceAdapter)
 		}
 	}
 
 	// Initialize Output Adapter
-	if config.DestinationType != "" {
-		logger.LogDebug(ctx.Context, "Initializing Output Adapter", "adapterType", config.DestinationType)
+	if config.DestinationAdapter != "" {
+		logger.LogDebug(ctx.Context, "Initializing Output Adapter", "OutputAdapter", config.DestinationAdapter)
 
-		switch types.AdapterType(config.DestinationType) {
+		switch types.AdapterType(config.DestinationAdapter) {
 
 		case types.FolderAdapterType:
 			adapters[types.OutputAdapterRole] = &ofolder.FolderAdapter{Role: types.OutputAdapterRole, Uploader: &ofolder.SequentialUploader{}}
@@ -89,7 +89,7 @@ func NewAdapter(ctx *tcontext.TransferMetadata, config types.Config) (map[types.
 			adapters[types.OutputAdapterRole] = &dependencytrack.DependencyTrackAdapter{Role: types.OutputAdapterRole, Uploader: dependencytrack.NewSequentialUploader()}
 
 		default:
-			return nil, fmt.Errorf("unsupported output adapter type: %s", config.DestinationType)
+			return nil, fmt.Errorf("unsupported output adapter type: %s", config.DestinationAdapter)
 		}
 	}
 

pkg/converter/converter.go

@@ -167,7 +167,7 @@ func serializeToCycloneDX(ctx tcontext.TransferMetadata, doc *sbom.Document) ([]
 	if err := w.WriteStreamWithOptions(doc, buf, &writer.Options{Format: formats.CDX15JSON}); err != nil {
 		return nil, fmt.Errorf("writing CycloneDX: %w", err)
 	}
-	logger.LogDebug(ctx.Context, "Converted SPDX SBOM to CycloneDX")
+	logger.LogDebug(ctx.Context, "SPDX SBOM converted to CycloneDX SBOM")
 
 	return buf.Bytes(), nil
 }

pkg/engine/transfer.go

@@ -33,7 +33,7 @@ import (
 )
 
 func TransferRun(ctx context.Context, cmd *cobra.Command, config types.Config) error {
-	logger.LogDebug(ctx, "Starting SBOM transfer process")
+	logger.LogDebug(ctx, "Starting SBOM transfer process....")
 
 	// Initialize shared context with metadata support
 	transferCtx := tcontext.NewTransferMetadata(ctx)
@@ -59,14 +59,14 @@ func TransferRun(ctx context.Context, cmd *cobra.Command, config types.Config) e
 		return fmt.Errorf("input adapter error: %w", err)
 	}
 
-	logger.LogDebug(transferCtx.Context, "input adapter instance config", "value", inputAdapterInstance)
+	logger.LogDebug(transferCtx.Context, "Input adapter instance config", "value", inputAdapterInstance)
 
 	// Parse and validate output adapter parameters
 	if err := outputAdapterInstance.ParseAndValidateParams(cmd); err != nil {
 		return fmt.Errorf("output adapter error: %w", err)
 	}
 
-	logger.LogDebug(transferCtx.Context, "output adapter instance config", "value", outputAdapterInstance)
+	logger.LogDebug(transferCtx.Context, "Output adapter instance config", "value", outputAdapterInstance)
 
 	// Fetch SBOMs lazily using the iterator
 	sbomIterator, err := inputAdapterInstance.FetchSBOMs(transferCtx)
@@ -127,7 +127,8 @@ func sbomConversion(sbomIterator iterator.SBOMIterator, transferCtx tcontext.Tra
 	logger.LogDebug(transferCtx.Context, "Processing SBOM conversion")
 
 	var convertedSBOMs []*iterator.SBOM
-
+	var totalMinifiedSBOM int
+	var totalSBOM int
 	for {
 		sbom, err := sbomIterator.Next(transferCtx.Context)
 		if err == io.EOF {
@@ -146,7 +147,7 @@ func sbomConversion(sbomIterator iterator.SBOMIterator, transferCtx tcontext.Tra
 		}
 
 		// let's check minimfied SBOM
-		sbom.Data, err = convertMinifiedJSON(transferCtx, convertedData)
+		sbom.Data, totalMinifiedSBOM, err = convertMinifiedJSON(transferCtx, convertedData, totalMinifiedSBOM)
 
 		// Update SBOM data with converted content
 		sbom.Data = convertedData
@@ -156,31 +157,29 @@ func sbomConversion(sbomIterator iterator.SBOMIterator, transferCtx tcontext.Tra
 			// transferCtx.FilePath = sbom.Path // Sync FilePath for logging
 		}
 
-		// err = os.WriteFile(sbom.Path, sbom.Data, 0o644)
-		// if err != nil {
-		// 	fmt.Println("Error writing formatted JSON:", err)
-		// }
-
+		totalSBOM++
 		convertedSBOMs = append(convertedSBOMs, sbom)
 	}
+
+	logger.LogDebug(transferCtx.Context, "Out of total SBOM", "value", totalSBOM, "total minifiedJSONSBOM converted to preety JSON", totalMinifiedSBOM)
 	logger.LogDebug(transferCtx.Context, "Successfully SBOM conversion")
 
 	return convertedSBOMs
 }
 
 func sbomProcessing(transferCtx *tcontext.TransferMetadata, config types.Config, sbomIterator iterator.SBOMIterator) iterator.SBOMIterator {
-	logger.LogDebug(transferCtx.Context, "Checking adapter eligibility for undergoing conversion layer", "adapter type", config.DestinationType)
+	logger.LogDebug(transferCtx.Context, "Checking adapter eligibility for undergoing conversion layer", "adapter type", config.DestinationAdapter)
 
 	// convert sbom to cdx for DTrack adapter only
-	if types.AdapterType(config.DestinationType) == types.DtrackAdapterType {
-		logger.LogDebug(transferCtx.Context, "Adapter eligible for conversion layer", "adapter type", config.DestinationType)
+	if types.AdapterType(config.DestinationAdapter) == types.DtrackAdapterType {
+		logger.LogDebug(transferCtx.Context, "Adapter eligible for conversion layer", "adapter type", config.DestinationAdapter)
 
 		logger.LogDebug(transferCtx.Context, "SBOM conversion will take place")
 		convertedSBOMs := sbomConversion(sbomIterator, *transferCtx)
 
 		return iterator.NewMemoryIterator(convertedSBOMs)
 	} else {
-		logger.LogDebug(transferCtx.Context, "Adapter not eligible for conversion layer", "adapter type", config.DestinationType)
+		logger.LogDebug(transferCtx.Context, "Adapter not eligible for conversion layer", "adapter type", config.DestinationAdapter)
 		logger.LogDebug(transferCtx.Context, "SBOM conversion will not take place")
 		return sbomIterator
 	}
@@ -208,19 +207,16 @@ func isMinifiedJSON(data []byte) (bool, []byte, []byte, error) {
 	return true, data, prettyJSON, nil // Minified JSON detected
 }
 
-func convertMinifiedJSON(transferCtx tcontext.TransferMetadata, data []byte) ([]byte, error) {
+func convertMinifiedJSON(transferCtx tcontext.TransferMetadata, data []byte, totalMinifiedSBOM int) ([]byte, int, error) {
 	minified, original, formatted, err := isMinifiedJSON(data)
 	if err != nil {
 		logger.LogError(transferCtx.Context, err, "Error while isMinifiedJSON")
-		return original, nil
+		return original, totalMinifiedSBOM, nil
 	}
 
 	if minified {
-		logger.LogDebug(transferCtx.Context, "Minified JSON detected! Converting to pretty format.")
-		logger.LogDebug(transferCtx.Context, "Minified JSON converted to preety JSON!")
-
-		return formatted, nil
-
+		totalMinifiedSBOM++
+		return formatted, totalMinifiedSBOM, nil
 	}
-	return original, nil
+	return original, totalMinifiedSBOM, nil
 }

pkg/source/github/adapter.go

@@ -224,16 +224,14 @@ func (g *GitHubAdapter) FetchSBOMs(ctx *tcontext.TransferMetadata) (iterator.SBO
 		return nil, fmt.Errorf("failed to get repositories: %w", err)
 	}
 
-	logger.LogDebug(ctx.Context, "Found repos", "number", len(repos))
-
 	// filtering to include/exclude repos
 	repos = g.applyRepoFilters(repos)
 
 	if len(repos) == 0 {
 		return nil, fmt.Errorf("no repositories left after applying filters")
 	}
 
-	logger.LogDebug(ctx.Context, "Listing repos of organization after filtering", "values", repos)
+	logger.LogDebug(ctx.Context, "Total repos from which SBOMs needs to be fetched after filteration", "count", len(repos), "values", repos)
 
 	processingMode := types.FetchSequential
 	var sbomIterator iterator.SBOMIterator
@@ -407,13 +405,15 @@ func (g *GitHubAdapter) fetchSBOMsConcurrently(ctx *tcontext.TransferMetadata, r
 
 // fetchSBOMsSequentially: fetch SBOMs from repositories one at a time
 func (g *GitHubAdapter) fetchSBOMsSequentially(ctx *tcontext.TransferMetadata, repos []string) (iterator.SBOMIterator, error) {
+	logger.LogDebug(ctx.Context, "Fetching SBOMs sequentially")
+
 	var sbomList []*iterator.SBOM
 
 	// Iterate over repositories one by one (sequential processing)
 	for _, repo := range repos {
 		g.Repo = repo // Set current repository
 
-		logger.LogDebug(ctx.Context, "Fetching SBOMs sequentially", "repo", repo)
+		logger.LogDebug(ctx.Context, "Repository", "value", repo)
 
 		iter := NewGitHubIterator(ctx, g, repo)
 

pkg/source/github/client.go

@@ -101,7 +101,7 @@ func NewClient(g *GitHubAdapter) *Client {
 // filter out the particular provided release asset and
 // extract SBOMs from that
 func (c *Client) FindSBOMs(ctx *tcontext.TransferMetadata) ([]SBOMAsset, error) {
-	logger.LogDebug(ctx.Context, "Fetching GitHub releases", "repo_url", c.RepoURL, "owner", c.Owner, "repo", c.Repo)
+	logger.LogDebug(ctx.Context, "Fetching SBOMs from GitHub releases", "repo_url", c.RepoURL, "owner", c.Owner, "repo", c.Repo)
 
 	releases, err := c.GetReleases(ctx, c.Owner, c.Repo)
 	if err != nil {
@@ -249,7 +249,8 @@ func (c *Client) DownloadAsset(ctx *tcontext.TransferMetadata, downloadURL strin
 }
 
 // GetSBOMs downloads and saves all SBOM files found in the repository
-func (c *Client) GetSBOMs(ctx *tcontext.TransferMetadata) (VersionedSBOMs, error) {
+func (c *Client) FetchSBOMFromReleases(ctx *tcontext.TransferMetadata) (VersionedSBOMs, error) {
+	logger.LogDebug(ctx.Context, "Initializing fetching of SBOMs from repo release page", "repository", c.Repo, "version", c.Version)
 	// Find SBOMs in releases
 	sboms, err := c.FindSBOMs(ctx)
 	if err != nil {
@@ -259,7 +260,7 @@ func (c *Client) GetSBOMs(ctx *tcontext.TransferMetadata) (VersionedSBOMs, error
 		return nil, fmt.Errorf("no SBOMs found in repository")
 	}
 
-	logger.LogDebug(ctx.Context, "Total SBOMs found in the repository", "version", c.Version, "total sboms", len(sboms))
+	logger.LogDebug(ctx.Context, "Total SBOMs found in the repository release page", "version", c.Version, "total sboms", len(sboms))
 	ctx.WithValue("total_sboms", len(sboms))
 
 	return c.downloadSBOMs(ctx, sboms)
@@ -411,11 +412,10 @@ func (c *Client) updateRepo(repo string) {
 }
 
 func (c *Client) GetAllRepositories(ctx *tcontext.TransferMetadata) ([]string, error) {
-	logger.LogDebug(ctx.Context, "Fetching all repositories for an organization", "name", c.Owner)
-
 	if c.Repo != "" {
 		return []string{c.Repo}, nil
 	}
+	logger.LogDebug(ctx.Context, "Fetching all repositories for an organization", "name", c.Owner)
 
 	apiURL := fmt.Sprintf("https://api.github.com/orgs/%s/repos", c.Owner)
 
@@ -465,5 +465,7 @@ func (c *Client) GetAllRepositories(ctx *tcontext.TransferMetadata) ([]string, e
 		return nil, fmt.Errorf("no repositories found for organization %s", c.Owner)
 	}
 
+	logger.LogDebug(ctx.Context, "Total number of repos", "count", len(repos), "in organization", c.Owner)
+
 	return repoNames, nil
 }

pkg/source/github/iterator.go

@@ -50,7 +50,7 @@ func NewGitHubIterator(ctx *tcontext.TransferMetadata, g *GitHubAdapter, repo st
 
 // FetchSBOMs fetches SBOMs for the given GitHubIterator instance
 func (it *GitHubIterator) HandleSBOMFetchingViaIterator(ctx *tcontext.TransferMetadata, method GitHubMethod) error {
-	logger.LogDebug(ctx.Context, "Fetching SBOMs using GitHub Iterator", "repo", it.client.Repo, "method", method)
+	logger.LogDebug(ctx.Context, "Fetching SBOMs using Lazy Iterator", "repo", it.client.Repo, "method", method)
 
 	var err error
 
@@ -111,7 +111,7 @@ func (it *GitHubIterator) fetchSBOMFromAPI(ctx *tcontext.TransferMetadata) error
 
 // Fetch SBOMs from GitHub Releases
 func (it *GitHubIterator) fetchSBOMFromReleases(ctx *tcontext.TransferMetadata) error {
-	sbomFiles, err := it.client.GetSBOMs(ctx)
+	sbomFiles, err := it.client.FetchSBOMFromReleases(ctx)
 	if err != nil {
 		return fmt.Errorf("error retrieving SBOMs from releases: %w", err)
 	}

pkg/target/dependencytrack/adapter.go

@@ -27,7 +27,7 @@ import (
 )
 
 type DependencyTrackAdapter struct {
-	config   *DependencyTrackConfig
+	Config   *DependencyTrackConfig
 	client   *DependencyTrackClient
 	Uploader SBOMUploader
 	Role     types.AdapterRole
@@ -36,7 +36,7 @@ type DependencyTrackAdapter struct {
 func NewDependencyTrackAdapter(config *DependencyTrackConfig, client *DependencyTrackClient) *DependencyTrackAdapter {
 	uploader := uploaderFactory["sequential"]
 	return &DependencyTrackAdapter{
-		config:   config,
+		Config:   config,
 		client:   client,
 		Uploader: uploader,
 	}
@@ -100,17 +100,17 @@ func (d *DependencyTrackAdapter) ParseAndValidateParams(cmd *cobra.Command) erro
 	cfg.ProjectVersion = projectVersion
 
 	// Set values to struct
-	d.config = cfg
+	d.Config = cfg
 
 	// Initialize the DependencyTrack client
-	client := NewDependencyTrackClient(d.config)
+	client := NewDependencyTrackClient(d.Config)
 	d.client = client
 
 	logger.LogDebug(cmd.Context(), "Dependency-Track parameters validated and assigned",
-		"url", d.config.APIURL,
-		"apiKey", d.config.APIKey,
-		"project_name", d.config.ProjectName,
-		"project_version", d.config.ProjectVersion,
+		"url", d.Config.APIURL,
+		"apiKey", d.Config.APIKey,
+		"project_name", d.Config.ProjectName,
+		"project_version", d.Config.ProjectVersion,
 	)
 	return nil
 }
@@ -121,10 +121,10 @@ func (d *DependencyTrackAdapter) FetchSBOMs(ctx *tcontext.TransferMetadata) (ite
 }
 
 func (d *DependencyTrackAdapter) UploadSBOMs(ctx *tcontext.TransferMetadata, iter iterator.SBOMIterator) error {
-	return d.Uploader.Upload(ctx, d.config, d.client, iter)
+	return d.Uploader.Upload(ctx, d.Config, d.client, iter)
 }
 
 func (d *DependencyTrackAdapter) DryRun(ctx *tcontext.TransferMetadata, iter iterator.SBOMIterator) error {
-	reporter := NewDependencyTrackReporter(d.config.APIURL, d.config.ProjectName)
+	reporter := NewDependencyTrackReporter(d.Config.APIURL, d.Config.ProjectName)
 	return reporter.DryRun(ctx.Context, iter)
 }

pkg/target/dependencytrack/client.go

@@ -57,7 +57,7 @@ func (c *DependencyTrackClient) FindProject(ctx *tcontext.TransferMetadata, proj
 		return "", err
 	}
 
-	logger.LogDebug(ctx.Context, "Total Project Found", "count", projects.TotalCount)
+	logger.LogDebug(ctx.Context, "Total Number of Projects Available in Dependency Track Platform", "count", projects.TotalCount)
 
 	for _, project := range projects.Items {
 		// lookup for the our project name with version
@@ -93,7 +93,7 @@ func (c *DependencyTrackClient) UploadSBOM(ctx *tcontext.TransferMetadata, proje
 
 // FindOrCreateProject ensures a project exists, returning its UUID after finding or creating project
 func (c *DependencyTrackClient) FindOrCreateProject(ctx *tcontext.TransferMetadata, projectName, projectVersion string) (string, error) {
-	logger.LogDebug(ctx.Context, "Finding Project", "project", projectName, "version", projectVersion)
+	logger.LogDebug(ctx.Context, "Processing finding or Creating Project", "project", projectName, "version", projectVersion)
 
 	// find project using project name and project version
 	uuid, err := c.FindProject(ctx, projectName, projectVersion)
@@ -112,7 +112,7 @@ func (c *DependencyTrackClient) FindOrCreateProject(ctx *tcontext.TransferMetada
 
 // CreateProject creates a new project if it doesn’t exist
 func (c *DependencyTrackClient) CreateProject(ctx *tcontext.TransferMetadata, projectName, projectVersion string) (string, error) {
-	logger.LogDebug(ctx.Context, "Creating Project", "project", projectName, "version", projectVersion)
+	logger.LogDebug(ctx.Context, "Initializing Project Creation", "project", projectName, "version", projectVersion)
 
 	project := dtrack.Project{
 		Name:    projectName,
@@ -125,6 +125,6 @@ func (c *DependencyTrackClient) CreateProject(ctx *tcontext.TransferMetadata, pr
 		return "", err
 	}
 
-	logger.LogDebug(ctx.Context, "Project created or verified", "project", created.Name, "version", created.Version, "uuid", created.UUID)
+	logger.LogDebug(ctx.Context, "New Project created", "project", created.Name, "version", created.Version, "uuid", created.UUID)
 	return created.UUID.String(), nil
 }

pkg/target/dependencytrack/uploader.go

@@ -75,7 +75,6 @@ func (u *SequentialUploader) Upload(ctx *tcontext.TransferMetadata, config *Depe
 				continue
 			}
 			u.createdProjects[projectName] = true
-			logger.LogDebug(ctx.Context, "Project created", "project", projectName)
 		}
 		u.mu.Unlock()
 

pkg/types/mvtypes.go

@@ -17,10 +17,10 @@ package types
 
 type Config struct {
 	// source adapter type
-	SourceType string
+	SourceAdapter string
 
 	// destination adapter type
-	DestinationType string
+	DestinationAdapter string
 
 	// dry run mode
 	DryRun bool