feat: add layer-wise filesystem information to the analysis json file (…

…wagoodman#458) Add layer-wise filesystem information to the analysis which is written to a JSON file when running dive with `-j` or `--json` flag. Co-authored-by: Akash Nayak <[email protected]>
joschi · Nov 7, 2024 · 0f48a70 · 0f48a70
1 parent 8a6ee09
commit 0f48a70
Show file tree

Hide file tree

Showing 5 changed files with 4,587 additions and 29 deletions.
diff --git a/dive/filetree/file_info.go b/dive/filetree/file_info.go
@@ -11,15 +11,15 @@ import (
 
 // FileInfo contains tar metadata for a specific FileNode
 type FileInfo struct {
-	Path     string
-	TypeFlag byte
-	Linkname string
-	hash     uint64
-	Size     int64
-	Mode     os.FileMode
-	Uid      int
-	Gid      int
-	IsDir    bool
+	Path     string      `json:"path"`
+	TypeFlag byte        `json:"typeFlag"`
+	Linkname string      `json:"linkName"`
+	hash     uint64      //`json:"hash"`
+	Size     int64       `json:"size"`
+	Mode     os.FileMode `json:"fileMode"`
+	Uid      int         `json:"uid"`
+	Gid      int         `json:"gid"`
+	IsDir    bool        `json:"isDir"`
 }
 
 // NewFileInfoFromTarHeader extracts the metadata from a tar header and file contents and generates a new FileInfo object.

diff --git a/dive/filetree/node_data.go b/dive/filetree/node_data.go
@@ -5,7 +5,7 @@ var GlobalFileTreeCollapse bool
 // NodeData is the payload for a FileNode
 type NodeData struct {
 	ViewInfo ViewInfo
-	FileInfo FileInfo
+	FileInfo FileInfo `json:"fileInfo"`
 	DiffType DiffType
 }
 

diff --git a/runtime/export/export.go b/runtime/export/export.go
@@ -3,6 +3,9 @@ package export
 import (
 	"encoding/json"
 
+	"github.com/sirupsen/logrus"
+
+	"github.com/wagoodman/dive/dive/filetree"
 	diveImage "github.com/wagoodman/dive/dive/image"
 )
 
@@ -11,6 +14,7 @@ type export struct {
 	Image image   `json:"image"`
 }
 
+// NewExport exports the analysis to a JSON
 func NewExport(analysis *diveImage.AnalysisResult) *export {
 	data := export{
 		Layer: make([]layer, len(analysis.Layers)),
@@ -24,12 +28,22 @@ func NewExport(analysis *diveImage.AnalysisResult) *export {
 
 	// export layers in order
 	for idx, curLayer := range analysis.Layers {
+		layerFileList := make([]filetree.FileInfo, 0)
+		visitor := func(node *filetree.FileNode) error {
+			layerFileList = append(layerFileList, node.Data.FileInfo)
+			return nil
+		}
+		err := curLayer.Tree.VisitDepthChildFirst(visitor, nil)
+		if err != nil {
+			logrus.Errorf("Unable to propagate layer tree: %+v", err)
+		}
 		data.Layer[idx] = layer{
 			Index:     curLayer.Index,
 			ID:        curLayer.Id,
 			DigestID:  curLayer.Digest,
 			SizeBytes: curLayer.Size,
 			Command:   curLayer.Command,
+			FileList:  layerFileList,
 		}
 	}