feat: show manifest relative path in summary report (#613)

* feat: show manifest relative path in summary report

* fix: typos

* fix: using standard color profile

* fix: log message

---------

Co-authored-by: Abhisek Datta <abhisek.datta@gmail.com>

Author: KunalSin9h

pkg/reporter/summary.go

@@ -4,11 +4,13 @@ import (
 	"cmp"
 	"fmt"
 	"os"
+	"path/filepath"
 	"slices"
 	"strings"
 
 	"github.com/jedib0t/go-pretty/v6/table"
 	"github.com/jedib0t/go-pretty/v6/text"
+	"github.com/safedep/dry/log"
 	"github.com/safedep/dry/semver"
 	"github.com/safedep/dry/utils"
 	"github.com/safedep/vet/gen/insightapi"
@@ -568,6 +570,12 @@ func (r *summaryReporter) addRemediationAdviceTableRows(tbl table.Writer,
 		return tagText
 	}
 
+	currentWorkingDirectory, err := os.Getwd()
+	if err != nil {
+		log.Warnf("Error getting current working directory: %s", err.Error())
+		currentWorkingDirectory = ""
+	}
+
 	for idx, sp := range sortedPackages {
 		if idx >= maxAdvice {
 			break
@@ -637,6 +645,21 @@ func (r *summaryReporter) addRemediationAdviceTableRows(tbl table.Writer,
 			}
 		}
 
+		manifestPath, err := r.packageManifestRelativePath(currentWorkingDirectory, sp.pkg.Manifest.Path)
+		if err != nil {
+			log.Warnf("Error getting manifest relative path: %s", err.Error())
+			manifestPath = sp.pkg.Manifest.GetDisplayPath()
+		}
+
+		// Add Manifest Path information just below package name
+		tbl.AppendRow(table.Row{
+			"", // Ecosystem
+			InfoText(manifestPath),
+			"", // Latest Version
+			"", // Score
+			"", // Vulnerability Info
+		})
+
 		tbl.AppendSeparator()
 	}
 }
@@ -667,6 +690,15 @@ func (r *summaryReporter) packageVulnerabilityRiskText(pkg *models.Package) stri
 	return WhiteBgText(" Unknown ")
 }
 
+func (r *summaryReporter) packageManifestRelativePath(currentWorkingDirectory, manifestFullPath string) (string, error) {
+	relPath, err := filepath.Rel(currentWorkingDirectory, manifestFullPath)
+	if err != nil {
+		return "", fmt.Errorf("error getting relative path: %w", err)
+	}
+
+	return relPath, nil
+}
+
 func (r *summaryReporter) packageVulnerabilitySampleText(pkg *models.Package) string {
 	if _, ok := r.vulnerabilityInfo[pkg.Id()]; !ok {
 		return ""

pkg/reporter/summary_test.go

@@ -0,0 +1,58 @@
+package reporter
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+)
+
+func TestManifestRelativePath(t *testing.T) {
+	testCases := []struct {
+		name string
+
+		currentWorkingDir string
+		manifestFullPath  string
+
+		expectError          bool
+		expectedRelativePath string
+	}{
+		{
+			name:              "valid current working directory",
+			currentWorkingDir: "/home/user/work/company/project/source",
+			manifestFullPath:  "/home/user/work/company/project/source/package-lock.json",
+
+			expectError:          false,
+			expectedRelativePath: "package-lock.json",
+		},
+		{
+			name:              "valid current working directory with sub dir manifest path",
+			currentWorkingDir: "/home/user/work/company/project/source",
+			manifestFullPath:  "/home/user/work/company/project/source/apps/cli/go.mod",
+
+			expectError:          false,
+			expectedRelativePath: "apps/cli/go.mod",
+		},
+		{
+			name:              "empty current working directory - error on os.Getwd()",
+			currentWorkingDir: "", // os.Getwd() failed, then currentWorkingDir = ""
+			manifestFullPath:  "/home/user/work/company/project/source/package-lock.json",
+			expectError:       true,
+		},
+	}
+
+	for _, test := range testCases {
+		t.Run(test.name, func(t *testing.T) {
+			t.Parallel()
+
+			r := &summaryReporter{}
+			relativePath, err := r.packageManifestRelativePath(test.currentWorkingDir, test.manifestFullPath)
+
+			if test.expectError {
+				assert.Error(t, err)
+			} else {
+				assert.NoError(t, err)
+				assert.Equal(t, relativePath, test.expectedRelativePath)
+			}
+		})
+	}
+}