feat(image): add uncompressed layer size (fanal#182)

* Add uncompressed layer size

This commit will help in getting uncompressed layer sizes. Can sum up these layer sizes to get the actual image size

* Removed unnecessary exception

* refactor

Co-authored-by: knqyf263 <knqyf263@gmail.com>

Author: tonaim

applier/docker.go

@@ -71,6 +71,7 @@ func ApplyLayers(layers []types.BlobInfo) types.ArtifactDetail {
 	var mergedLayer types.ArtifactDetail
 
 	for _, layer := range layers {
+		mergedLayer.Size += layer.Size
 		for _, opqDir := range layer.OpaqueDirs {
 			_ = nestedMap.DeleteByString(opqDir, sep)
 		}

artifact/image/image.go

@@ -178,11 +178,13 @@ func (a Artifact) inspectLayer(ctx context.Context, diffID string) (types.BlobIn
 		return types.BlobInfo{}, xerrors.Errorf("unable to get uncompressed layer %s: %w", diffID, err)
 	}
 
+	// below line of code gets the size of uncompressed layer. Will sum up these layer sizes to get the size of image.
+	cr := newCountingReader(r)
 	var wg sync.WaitGroup
 	result := new(analyzer.AnalysisResult)
 	limit := semaphore.NewWeighted(parallel)
 
-	opqDirs, whFiles, err := walker.WalkLayerTar(r, func(filePath string, info os.FileInfo, opener analyzer.Opener) error {
+	opqDirs, whFiles, err := walker.WalkLayerTar(cr, func(filePath string, info os.FileInfo, opener analyzer.Opener) error {
 		if err = a.analyzer.AnalyzeFile(ctx, &wg, limit, result, filePath, info, opener); err != nil {
 			return xerrors.Errorf("failed to analyze %s: %w", filePath, err)
 		}
@@ -214,6 +216,7 @@ func (a Artifact) inspectLayer(ctx context.Context, diffID string) (types.BlobIn
 		Misconfigurations: misconfs,
 		OpaqueDirs:        opqDirs,
 		WhiteoutFiles:     whFiles,
+		Size:              cr.Size(),
 	}
 	return layerInfo, nil
 }
@@ -281,3 +284,22 @@ func (a Artifact) inspectConfig(imageID string, osFound types.OS) error {
 
 	return nil
 }
+
+type countingReader struct {
+	reader    io.Reader
+	bytesRead int
+}
+
+func newCountingReader(r io.Reader) *countingReader {
+	return &countingReader{reader: r}
+}
+
+func (r *countingReader) Read(p []byte) (n int, err error) {
+	n, err = r.reader.Read(p)
+	r.bytesRead += n
+	return n, err
+}
+
+func (r *countingReader) Size() int {
+	return r.bytesRead
+}

artifact/image/image_test.go

@@ -78,6 +78,7 @@ func TestArtifact_Inspect(t *testing.T) {
 							Applications:  []types.Application(nil),
 							OpaqueDirs:    []string(nil),
 							WhiteoutFiles: []string(nil),
+							Size:          5861888,
 						},
 					},
 					Returns: cache.ArtifactCachePutBlobReturns{},
@@ -137,6 +138,7 @@ func TestArtifact_Inspect(t *testing.T) {
 								Family: "debian",
 								Name:   "9.9",
 							},
+							Size: 3056640,
 							PackageInfos: []types.PackageInfo{
 								{
 									FilePath: "var/lib/dpkg/status.d/base",
@@ -187,6 +189,7 @@ func TestArtifact_Inspect(t *testing.T) {
 									},
 								},
 							},
+							Size: 15433728,
 						},
 					},
 				},
@@ -197,6 +200,7 @@ func TestArtifact_Inspect(t *testing.T) {
 							SchemaVersion: 1,
 							Digest:        "",
 							DiffID:        "sha256:24df0d4e20c0f42d3703bf1f1db2bdd77346c7956f74f423603d651e8e5ae8a7",
+							Size:          29696,
 							Applications: []types.Application{{Type: "composer", FilePath: "php-app/composer.lock",
 								Libraries: []types.LibraryInfo{
 									{Library: depTypes.Library{Name: "guzzlehttp/guzzle", Version: "6.2.0"}},
@@ -287,6 +291,7 @@ func TestArtifact_Inspect(t *testing.T) {
 							OpaqueDirs: []string{
 								"ruby-app/",
 							},
+							Size: 6656,
 						},
 					},
 				},
@@ -333,6 +338,7 @@ func TestArtifact_Inspect(t *testing.T) {
 							SchemaVersion: 1,
 							Digest:        "",
 							DiffID:        "sha256:932da51564135c98a49a34a193d6cd363d8fa4184d957fde16c9d8527b3f3b02",
+							Size:          3056640,
 						},
 					},
 				},
@@ -343,6 +349,7 @@ func TestArtifact_Inspect(t *testing.T) {
 							SchemaVersion: 1,
 							Digest:        "",
 							DiffID:        "sha256:dffd9992ca398466a663c87c92cfea2a2db0ae0cf33fcb99da60eec52addbfc5",
+							Size:          15433728,
 						},
 					},
 				},
@@ -354,6 +361,7 @@ func TestArtifact_Inspect(t *testing.T) {
 							Digest:        "",
 							DiffID:        "sha256:24df0d4e20c0f42d3703bf1f1db2bdd77346c7956f74f423603d651e8e5ae8a7",
 							OpaqueDirs:    []string{"php-app/"},
+							Size:          29696,
 						},
 					},
 				},
@@ -365,6 +373,7 @@ func TestArtifact_Inspect(t *testing.T) {
 							Digest:        "",
 							DiffID:        "sha256:a4595c43a874856bf95f3bfc4fbf78bbaa04c92c726276d4f64193a47ced0566",
 							OpaqueDirs:    []string{"ruby-app/"},
+							Size:          6656,
 						},
 					},
 				},
@@ -440,6 +449,7 @@ func TestArtifact_Inspect(t *testing.T) {
 							Applications:  []types.Application(nil),
 							OpaqueDirs:    []string(nil),
 							WhiteoutFiles: []string(nil),
+							Size:          5861888,
 						},
 					},
 					Returns: cache.ArtifactCachePutBlobReturns{
@@ -496,6 +506,7 @@ func TestArtifact_Inspect(t *testing.T) {
 							Applications:  []types.Application(nil),
 							OpaqueDirs:    []string(nil),
 							WhiteoutFiles: []string(nil),
+							Size:          5861888,
 						},
 					},
 					Returns: cache.ArtifactCachePutBlobReturns{},

types/artifact.go

@@ -90,6 +90,7 @@ type BlobInfo struct {
 	Misconfigurations []Misconfiguration `json:",omitempty"`
 	OpaqueDirs        []string           `json:",omitempty"`
 	WhiteoutFiles     []string           `json:",omitempty"`
+	Size              int                `json:",omitempty"`
 }
 
 // ArtifactDetail is generated by applying blobs
@@ -98,6 +99,7 @@ type ArtifactDetail struct {
 	Packages          []Package          `json:",omitempty"`
 	Applications      []Application      `json:",omitempty"`
 	Misconfigurations []Misconfiguration `json:",omitempty"`
+	Size              int                `json:",omitempty"`
 
 	// HistoryPackages are packages extracted from RUN instructions
 	HistoryPackages []Package `json:",omitempty"`