rename PkgInstalledFiles to SystemInstalledFiles for backward compati…

…bility
AliDatadog · Oct 2, 2023 · ede18a4 · ede18a4
1 parent bc4f854
commit ede18a4
Show file tree

Hide file tree

Showing 10 changed files with 26 additions and 26 deletions.
diff --git a/pkg/fanal/analyzer/analyzer.go b/pkg/fanal/analyzer/analyzer.go
@@ -149,15 +149,15 @@ type AnalysisOptions struct {
 }
 
 type AnalysisResult struct {
-	m                 sync.Mutex
-	OS                types.OS
-	Repository        *types.Repository
-	PackageInfos      []types.PackageInfo
-	Applications      []types.Application
-	Misconfigurations []types.Misconfiguration
-	Secrets           []types.Secret
-	Licenses          []types.LicenseFile
-	PkgInstalledFiles []string // A list of files installed by OS package manager
+	m                    sync.Mutex
+	OS                   types.OS
+	Repository           *types.Repository
+	PackageInfos         []types.PackageInfo
+	Applications         []types.Application
+	Misconfigurations    []types.Misconfiguration
+	Secrets              []types.Secret
+	Licenses             []types.LicenseFile
+	SystemInstalledFiles []string // A list of files installed by OS package manager
 
 	// Digests contains SHA-256 digests of unpackaged files
 	// used to search for SBOM attestation.
@@ -178,7 +178,7 @@ func NewAnalysisResult() *AnalysisResult {
 
 func (r *AnalysisResult) isEmpty() bool {
 	return lo.IsEmpty(r.OS) && r.Repository == nil && len(r.PackageInfos) == 0 && len(r.Applications) == 0 &&
-		len(r.Misconfigurations) == 0 && len(r.Secrets) == 0 && len(r.Licenses) == 0 && len(r.PkgInstalledFiles) == 0 &&
+		len(r.Misconfigurations) == 0 && len(r.Secrets) == 0 && len(r.Licenses) == 0 && len(r.SystemInstalledFiles) == 0 &&
 		r.BuildInfo == nil && len(r.Digests) == 0 && len(r.CustomResources) == 0
 }
 
@@ -272,7 +272,7 @@ func (r *AnalysisResult) Merge(newResult *AnalysisResult) {
 	r.Misconfigurations = append(r.Misconfigurations, new.Misconfigurations...)
 	r.Secrets = append(r.Secrets, new.Secrets...)
 	r.Licenses = append(r.Licenses, new.Licenses...)
-	r.PkgInstalledFiles = append(r.PkgInstalledFiles, new.PkgInstalledFiles...)
+	r.SystemInstalledFiles = append(r.SystemInstalledFiles, new.SystemInstalledFiles...)
 
 	if newResult.BuildInfo != nil {
 		if r.BuildInfo == nil {
@@ -470,7 +470,7 @@ func (ag AnalyzerGroup) PostAnalyze(ctx context.Context, compositeFS *CompositeF
 			continue
 		}
 
-		skippedFiles := result.PkgInstalledFiles
+		skippedFiles := result.SystemInstalledFiles
 		for _, app := range result.Applications {
 			skippedFiles = append(skippedFiles, app.FilePath)
 			for _, lib := range app.Libraries {

diff --git a/pkg/fanal/analyzer/analyzer_test.go b/pkg/fanal/analyzer/analyzer_test.go
@@ -347,7 +347,7 @@ func TestAnalyzerGroup_AnalyzeFile(t *testing.T) {
 						},
 					},
 				},
-				PkgInstalledFiles: []string{
+				SystemInstalledFiles: []string{
 					"lib/libc.musl-x86_64.so.1",
 					"lib/ld-musl-x86_64.so.1",
 				},

diff --git a/pkg/fanal/analyzer/pkg/apk/apk.go b/pkg/fanal/analyzer/pkg/apk/apk.go
@@ -43,7 +43,7 @@ func (a alpinePkgAnalyzer) Analyze(_ context.Context, input analyzer.AnalysisInp
 				Packages: parsedPkgs,
 			},
 		},
-		PkgInstalledFiles: installedFiles,
+		SystemInstalledFiles: installedFiles,
 	}, nil
 }
 

diff --git a/pkg/fanal/analyzer/pkg/dpkg/dpkg.go b/pkg/fanal/analyzer/pkg/dpkg/dpkg.go
@@ -52,7 +52,7 @@ var (
 )
 
 func (a dpkgAnalyzer) PostAnalyze(_ context.Context, input analyzer.PostAnalysisInput) (*analyzer.AnalysisResult, error) {
-	var PkgInstalledFiles []string
+	var SystemInstalledFiles []string
 	var packageInfos []types.PackageInfo
 
 	// parse `available` file to get digest for packages
@@ -74,7 +74,7 @@ func (a dpkgAnalyzer) PostAnalyze(_ context.Context, input analyzer.PostAnalysis
 			if err != nil {
 				return err
 			}
-			PkgInstalledFiles = append(PkgInstalledFiles, systemFiles...)
+			SystemInstalledFiles = append(SystemInstalledFiles, systemFiles...)
 			return nil
 		}
 		// parse status files
@@ -90,8 +90,8 @@ func (a dpkgAnalyzer) PostAnalyze(_ context.Context, input analyzer.PostAnalysis
 	}
 
 	return &analyzer.AnalysisResult{
-		PackageInfos:      packageInfos,
-		PkgInstalledFiles: PkgInstalledFiles,
+		PackageInfos:         packageInfos,
+		SystemInstalledFiles: SystemInstalledFiles,
 	}, nil
 
 }

diff --git a/pkg/fanal/analyzer/pkg/dpkg/dpkg_test.go b/pkg/fanal/analyzer/pkg/dpkg/dpkg_test.go
@@ -1420,7 +1420,7 @@ func Test_dpkgAnalyzer_Analyze(t *testing.T) {
 			name:      "info list",
 			testFiles: map[string]string{"./testdata/tar.list": "var/lib/dpkg/info/tar.list"},
 			want: &analyzer.AnalysisResult{
-				PkgInstalledFiles: []string{
+				SystemInstalledFiles: []string{
 					"/bin/tar",
 					"/etc",
 					"/usr/lib/mime/packages/tar",

diff --git a/pkg/fanal/analyzer/pkg/rpm/rpm.go b/pkg/fanal/analyzer/pkg/rpm/rpm.go
@@ -76,7 +76,7 @@ func (a rpmPkgAnalyzer) Analyze(_ context.Context, input analyzer.AnalysisInput)
 				Packages: parsedPkgs,
 			},
 		},
-		PkgInstalledFiles: installedFiles,
+		SystemInstalledFiles: installedFiles,
 	}, nil
 }
 

diff --git a/pkg/fanal/handler/sysfile/filter.go b/pkg/fanal/handler/sysfile/filter.go
@@ -54,7 +54,7 @@ func newSystemFileFilteringPostHandler(artifact.Option) (handler.PostHandler, er
 // Handle removes files installed by OS package manager such as yum.
 func (h systemFileFilteringPostHandler) Handle(_ context.Context, result *analyzer.AnalysisResult, blob *types.BlobInfo) error {
 	var systemFiles []string
-	for _, file := range append(result.PkgInstalledFiles, defaultSystemFiles...) {
+	for _, file := range append(result.SystemInstalledFiles, defaultSystemFiles...) {
 		// Trim leading slashes to be the same format as the path in container images.
 		systemFile := strings.TrimPrefix(file, "/")
 		// We should check the root filepath ("/") and ignore it.

diff --git a/pkg/fanal/handler/sysfile/filter_test.go b/pkg/fanal/handler/sysfile/filter_test.go
@@ -21,7 +21,7 @@ func Test_systemFileFilterHook_Hook(t *testing.T) {
 		{
 			name: "happy path",
 			result: &analyzer.AnalysisResult{
-				PkgInstalledFiles: []string{
+				SystemInstalledFiles: []string{
 					"/",
 					"/usr/bin/pydoc",
 					"/usr/bin/python",
@@ -200,7 +200,7 @@ func Test_systemFileFilterHook_Hook(t *testing.T) {
 		{
 			name: "go binaries",
 			result: &analyzer.AnalysisResult{
-				PkgInstalledFiles: []string{
+				SystemInstalledFiles: []string{
 					"usr/local/bin/goreleaser",
 				},
 			},
@@ -223,7 +223,7 @@ func Test_systemFileFilterHook_Hook(t *testing.T) {
 		{
 			name: "Rust will not be skipped",
 			result: &analyzer.AnalysisResult{
-				PkgInstalledFiles: []string{
+				SystemInstalledFiles: []string{
 					"app/Cargo.lock",
 				},
 			},

diff --git a/pkg/fanal/handler/unpackaged/unpackaged.go b/pkg/fanal/handler/unpackaged/unpackaged.go
@@ -41,7 +41,7 @@ func NewUnpackagedHandler(opt artifact.Option) (handler.PostHandler, error) {
 func (h unpackagedHook) Handle(ctx context.Context, res *analyzer.AnalysisResult, blob *types.BlobInfo) error {
 	for filePath, digest := range res.Digests {
 		// Skip files installed by OS package managers.
-		if slices.Contains(res.PkgInstalledFiles, filePath) {
+		if slices.Contains(res.SystemInstalledFiles, filePath) {
 			continue
 		}
 

diff --git a/pkg/module/serialize/types.go b/pkg/module/serialize/types.go
@@ -20,7 +20,7 @@ type AnalysisResult struct {
 	//PackageInfos         []types.PackageInfo
 	//Applications         []types.Application
 	//Secrets              []types.Secret
-	//PkgInstalledFiles []string // A list of files installed by OS package manager
+	//SystemInstalledFiles []string // A list of files installed by OS package manager
 
 	// Currently it supports custom resources only
 	CustomResources []CustomResource