Merge pull request #5 from unoplat/4-add-logs

JayGhiya · web-flow · commit 1a83d247fab5 · 2024-02-23T11:08:50.000+05:30
feat: added logging
diff --git a/code/base-project/image-scan/dockerimageprocessing/image.go b/code/base-project/image-scan/dockerimageprocessing/image.go
@@ -4,22 +4,29 @@ import (
 	"encoding/json"
 	"fmt"
 
+	"go.uber.org/zap"
 	"gopkg.in/yaml.v3"
 )
 
 type ImageInfo struct {
 	Images map[string]string
+	logger *zap.Logger
 }
 
 func NewImageInfo() *ImageInfo {
+	// Initialize the zap logger
+	logger, _ := zap.NewProduction()
+	defer logger.Sync()
 	return &ImageInfo{
 		Images: make(map[string]string),
+		logger: logger,
 	}
 }
 
 func (ii *ImageInfo) UnmarshalYAML(data []byte) error {
 	var values map[string]interface{}
 	if err := yaml.Unmarshal(data, &values); err != nil {
+		ii.logger.Error("Failed to unmarshal YAML", zap.Error(err))
 		return err
 	}
 	ii.findImages(values, "", &ii.Images)
@@ -48,6 +55,7 @@ func (ii *ImageInfo) findImages(node interface{}, path string, images *map[strin
 			// Directly check for image specification here
 			imagePath, isImage := ii.constructImagePath(node)
 			if isImage {
+				ii.logger.Info("Found image specification", zap.String("path", currentNode.Path+".tag"), zap.String("imagePath", imagePath))
 				(*images)[currentNode.Path+".tag"] = imagePath
 				continue // Found an image specification, no need to go deeper in this branch
 			}
diff --git a/code/base-project/image-scan/dockerimageprocessing/image_test.go b/code/base-project/image-scan/dockerimageprocessing/image_test.go
@@ -30,10 +30,9 @@ func TestImageInfoUnmarshalYAML(t *testing.T) {
 }
 
 func TestImageInfoMarshalJSON(t *testing.T) {
-	ii := &ImageInfo{
-		Images: map[string]string{
-			"images": "example.com/myapp:latest",
-		},
+	ii := NewImageInfo()
+	ii.Images = map[string]string{
+		"images": "example.com/myapp:latest",
 	}
 	jsonData, err := ii.MarshalJSON()
 	assert.NoError(t, err)
diff --git a/code/base-project/image-scan/go.mod b/code/base-project/image-scan/go.mod
@@ -4,10 +4,12 @@ go 1.22.0
 
 require (
 	github.com/stretchr/testify v1.8.4
+	go.uber.org/zap v1.27.0
 	gopkg.in/yaml.v3 v3.0.1
 )
 
 require (
 	github.com/davecgh/go-spew v1.1.1 // indirect
 	github.com/pmezard/go-difflib v1.0.0 // indirect
+	go.uber.org/multierr v1.10.0 // indirect
 )
diff --git a/code/base-project/image-scan/go.sum b/code/base-project/image-scan/go.sum
@@ -4,6 +4,12 @@ github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZb
 github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
 github.com/stretchr/testify v1.8.4 h1:CcVxjf3Q8PM0mHUKJCdn+eZZtm5yQwehR5yeSVQQcUk=
 github.com/stretchr/testify v1.8.4/go.mod h1:sz/lmYIOXD/1dqDmKjjqLyZ2RngseejIcXlSw2iwfAo=
+go.uber.org/goleak v1.3.0 h1:2K3zAYmnTNqV73imy9J1T3WC+gmCePx2hEGkimedGto=
+go.uber.org/goleak v1.3.0/go.mod h1:CoHD4mav9JJNrW/WLlf7HGZPjdw8EucARQHekz1X6bE=
+go.uber.org/multierr v1.10.0 h1:S0h4aNzvfcFsC3dRF1jLoaov7oRaKqRGC/pUEJ2yvPQ=
+go.uber.org/multierr v1.10.0/go.mod h1:20+QtiLqy0Nd6FdQB9TLXag12DsQkrbs3htMFfDN80Y=
+go.uber.org/zap v1.27.0 h1:aJMhYGrd5QSmlpLMr2MftRKl7t8J8PTZPA732ud/XR8=
+go.uber.org/zap v1.27.0/go.mod h1:GB2qFLM7cTU87MWRP2mPIjqfIDnGu+VIO4V/SdhGo2E=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
 gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=

Original file line number	Diff line number	Diff line change
`@@ -4,22 +4,29 @@ import (`
`4`	`4`	`"encoding/json"`
`5`	`5`	`"fmt"`
`6`	`6`
	`7`	`+ "go.uber.org/zap"`
`7`	`8`	`"gopkg.in/yaml.v3"`
`8`	`9`	`)`
`9`	`10`
`10`	`11`	`type ImageInfo struct {`
`11`	`12`	`Images map[string]string`
	`13`	`+ logger *zap.Logger`
`12`	`14`	`}`
`13`	`15`
`14`	`16`	`func NewImageInfo() *ImageInfo {`
	`17`	`+ // Initialize the zap logger`
	`18`	`+ logger, _ := zap.NewProduction()`
	`19`	`+ defer logger.Sync()`
`15`	`20`	`return &ImageInfo{`
`16`	`21`	`Images: make(map[string]string),`
	`22`	`+ logger: logger,`
`17`	`23`	`}`
`18`	`24`	`}`
`19`	`25`
`20`	`26`	`func (ii *ImageInfo) UnmarshalYAML(data []byte) error {`
`21`	`27`	`var values map[string]interface{}`
`22`	`28`	`if err := yaml.Unmarshal(data, &values); err != nil {`
	`29`	`+ ii.logger.Error("Failed to unmarshal YAML", zap.Error(err))`
`23`	`30`	`return err`
`24`	`31`	`}`
`25`	`32`	`ii.findImages(values, "", &ii.Images)`
`@@ -48,6 +55,7 @@ func (ii ImageInfo) findImages(node interface{}, path string, images map[strin`
`48`	`55`	`// Directly check for image specification here`
`49`	`56`	`imagePath, isImage := ii.constructImagePath(node)`
`50`	`57`	`if isImage {`
	`58`	`+ ii.logger.Info("Found image specification", zap.String("path", currentNode.Path+".tag"), zap.String("imagePath", imagePath))`
`51`	`59`	`(*images)[currentNode.Path+".tag"] = imagePath`
`52`	`60`	`continue // Found an image specification, no need to go deeper in this branch`
`53`	`61`	`}`
Original file line number	Diff line number	Diff line change
`@@ -30,10 +30,9 @@ func TestImageInfoUnmarshalYAML(t *testing.T) {`
`30`	`30`	`}`
`31`	`31`
`32`	`32`	`func TestImageInfoMarshalJSON(t *testing.T) {`
`33`		`- ii := &ImageInfo{`
`34`		`- Images: map[string]string{`
`35`		`- "images": "example.com/myapp:latest",`
`36`		`- },`
	`33`	`+ ii := NewImageInfo()`
	`34`	`+ ii.Images = map[string]string{`
	`35`	`+ "images": "example.com/myapp:latest",`
`37`	`36`	`}`
`38`	`37`	`jsonData, err := ii.MarshalJSON()`
`39`	`38`	`assert.NoError(t, err)`
Original file line number	Diff line number	Diff line change
`@@ -4,10 +4,12 @@ go 1.22.0`
`4`	`4`
`5`	`5`	`require (`
`6`	`6`	`github.com/stretchr/testify v1.8.4`
	`7`	`+ go.uber.org/zap v1.27.0`
`7`	`8`	`gopkg.in/yaml.v3 v3.0.1`
`8`	`9`	`)`
`9`	`10`
`10`	`11`	`require (`
`11`	`12`	`github.com/davecgh/go-spew v1.1.1 // indirect`
`12`	`13`	`github.com/pmezard/go-difflib v1.0.0 // indirect`
	`14`	`+ go.uber.org/multierr v1.10.0 // indirect`
`13`	`15`	`)`