Fixed file diff/analysis output

Author: cftorres

differs/aptDiff.go

@@ -4,6 +4,7 @@ import (
 	"bufio"
 	"os"
 	"path/filepath"
+	"strconv"
 	"strings"
 
 	"github.com/GoogleCloudPlatform/container-diff/utils"
@@ -81,7 +82,15 @@ func parseLine(text string, currPackage string, packages map[string]utils.Packag
 			if !ok {
 				currPackageInfo = utils.PackageInfo{}
 			}
-			currPackageInfo.Size = value
+			var size int64
+			var err error
+			size, err = strconv.ParseInt(value, 10, 64)
+			if err != nil {
+				glog.Errorf("Could not get size for %s: %s", currPackage, err)
+				size = -1
+			}
+			// Installed-Size is in KB, so we convert it to bytes to keep consistent with the tool's size units
+			currPackageInfo.Size = size * 1024 
 			packages[currPackage] = currPackageInfo
 			return currPackage
 		default:

differs/nodeDiff.go

@@ -5,7 +5,6 @@ import (
 	"io/ioutil"
 	"os"
 	"path/filepath"
-	"strconv"
 	"strings"
 
 	"github.com/GoogleCloudPlatform/container-diff/utils"
@@ -55,8 +54,7 @@ func (a NodeAnalyzer) getPackages(image utils.Image) (map[string]map[string]util
 			var currInfo utils.PackageInfo
 			currInfo.Version = packageJSON.Version
 			packagePath := strings.TrimSuffix(currPackage, "package.json")
-			size := utils.GetSize(packagePath)
-			currInfo.Size = strconv.FormatInt(size, 10)
+			currInfo.Size = utils.GetSize(packagePath)
 			mapPath := strings.Replace(packagePath, path, "", 1)
 			// Check if other package version already recorded
 			if _, ok := packages[packageJSON.Name]; !ok {

differs/pipDiff.go

@@ -5,7 +5,6 @@ import (
 	"path/filepath"
 	"reflect"
 	"regexp"
-	"strconv"
 	"strings"
 
 	"github.com/GoogleCloudPlatform/container-diff/utils"
@@ -66,13 +65,12 @@ func (a PipAnalyzer) getPackages(image utils.Image) (map[string]map[string]utils
 
 				// Retrieves size for actual package/script corresponding to each dist-info metadata directory
 				// by taking the file entry alphabetically before it (for a package) or after it (for a script)
-				var size string
+				var size int64
 				if i-1 >= 0 && contents[i-1].Name() == packageName {
 					packagePath := filepath.Join(pythonPath, packageName)
-					intSize := utils.GetSize(packagePath)
-					size = strconv.FormatInt(intSize, 10)
+					size = utils.GetSize(packagePath)
 				} else if i+1 < len(contents) && contents[i+1].Name() == packageName+".py" {
-					size = strconv.FormatInt(contents[i+1].Size(), 10)
+					size = contents[i+1].Size()
 
 				} else {
 					glog.Errorf("Could not find Python package %s for corresponding metadata info", packageName)

utils/analyze_output_utils.go

@@ -1,5 +1,9 @@
 package utils
 
+import (
+	"code.cloudfoundry.org/bytefmt"
+)
+
 type AnalyzeResult interface {
 	GetStruct() AnalyzeResult
 	OutputText(analyzeType string) error
@@ -16,7 +20,7 @@ func (r ListAnalyzeResult) GetStruct() AnalyzeResult {
 }
 
 func (r ListAnalyzeResult) OutputText(analyzeType string) error {
-	return TemplateOutput(r)
+	return TemplateOutput(r, "ListAnalyze")
 }
 
 type MultiVersionPackageAnalyzeResult struct {
@@ -30,7 +34,7 @@ func (r MultiVersionPackageAnalyzeResult) GetStruct() AnalyzeResult {
 }
 
 func (r MultiVersionPackageAnalyzeResult) OutputText(analyzeType string) error {
-	return TemplateOutput(r)
+	return TemplateOutput(r, "MultiVersionPackageAnalyze")
 }
 
 type SingleVersionPackageAnalyzeResult struct {
@@ -44,7 +48,7 @@ func (r SingleVersionPackageAnalyzeResult) GetStruct() AnalyzeResult {
 }
 
 func (r SingleVersionPackageAnalyzeResult) OutputText(diffType string) error {
-	return TemplateOutput(r)
+	return TemplateOutput(r, "SingleVersionPackageAnalyze")
 }
 
 type FileAnalyzeResult struct {
@@ -58,5 +62,36 @@ func (r FileAnalyzeResult) GetStruct() AnalyzeResult {
 }
 
 func (r FileAnalyzeResult) OutputText(analyzeType string) error {
-	return TemplateOutput(r)
+	analysis := r.Analysis
+	strAnalysis := stringifyDirectoryEntries(analysis)
+
+	strResult := struct {
+		Image string
+		AnalyzeType string
+		Analysis []StrDirectoryEntry
+	}{
+		Image: r.Image,
+		AnalyzeType: r.AnalyzeType,
+		Analysis: strAnalysis,
+	}
+	return TemplateOutput(strResult, "FileAnalyze")
+}
+
+type StrDirectoryEntry struct {
+	Name string
+	Size string
+}
+
+func stringifyDirectoryEntries(entries []DirectoryEntry) (strEntries []StrDirectoryEntry) {
+	for _, entry := range entries {
+		size := entry.Size
+		strSize := "unknown"
+		if size != -1 {
+			strSize = bytefmt.ByteSize(uint64(size))
+		}
+
+		strEntry := StrDirectoryEntry{Name: entry.Name, Size: strSize}
+		strEntries = append(strEntries, strEntry)
+	}
+	return
 }

utils/diff_output_utils.go

@@ -1,5 +1,9 @@
 package utils
 
+import (
+	"code.cloudfoundry.org/bytefmt"
+)
+
 type DiffResult interface {
 	GetStruct() DiffResult
 	OutputText(diffType string) error
@@ -17,7 +21,7 @@ func (r MultiVersionPackageDiffResult) GetStruct() DiffResult {
 }
 
 func (r MultiVersionPackageDiffResult) OutputText(diffType string) error {
-	return TemplateOutput(r)
+	return TemplateOutput(r, "MultiVersionPackageDiff")
 }
 
 type SingleVersionPackageDiffResult struct {
@@ -32,7 +36,7 @@ func (r SingleVersionPackageDiffResult) GetStruct() DiffResult {
 }
 
 func (r SingleVersionPackageDiffResult) OutputText(diffType string) error {
-	return TemplateOutput(r)
+	return TemplateOutput(r, "SingleVersionPackageDiff")
 }
 
 type HistDiffResult struct {
@@ -47,7 +51,7 @@ func (r HistDiffResult) GetStruct() DiffResult {
 }
 
 func (r HistDiffResult) OutputText(diffType string) error {
-	return TemplateOutput(r)
+	return TemplateOutput(r, "HistDiff")
 }
 
 type DirDiffResult struct {
@@ -62,5 +66,58 @@ func (r DirDiffResult) GetStruct() DiffResult {
 }
 
 func (r DirDiffResult) OutputText(diffType string) error {
-	return TemplateOutput(r)
+	diff := r.Diff
+
+	strAdds := stringifyDirectoryEntries(diff.Adds)
+	strDels := stringifyDirectoryEntries(diff.Dels)
+	strMods := stringifyEntryDiffs(diff.Mods)
+
+	type StrDiff struct {
+		Adds []StrDirectoryEntry
+		Dels []StrDirectoryEntry
+		Mods []StrEntryDiff
+	}
+	
+	strResult := struct {
+		Image1 string
+		Image2 string
+		DiffType string
+		Diff StrDiff
+	}{
+		Image1: r.Image1,
+		Image2: r.Image2,
+		DiffType: r.DiffType,
+		Diff: StrDiff{
+			Adds: strAdds,
+			Dels: strDels,
+			Mods: strMods,
+		},
+	}
+	return TemplateOutput(strResult, "DirDiff")
+}
+
+type StrEntryDiff struct {
+	Name string
+	Size1 string
+	Size2 string
+}
+
+func stringifyEntryDiffs(entries []EntryDiff) (strEntries []StrEntryDiff) {
+	for _, entry := range entries {
+		size1 := entry.Size1
+		strSize1 := "unknown"
+		if size1 != -1 {
+			strSize1 = bytefmt.ByteSize(uint64(size1))
+		}
+
+		size2 := entry.Size2
+		strSize2 := "unknown"
+		if size2 != -1 {
+			strSize2 = bytefmt.ByteSize(uint64(size2))
+		}
+
+		strEntry := StrEntryDiff{Name: entry.Name, Size1: strSize1, Size2: strSize2}
+		strEntries = append(strEntries, strEntry)
+	}
+	return
 }

utils/format_utils.go

@@ -6,22 +6,21 @@ import (
 	"errors"
 	"html/template"
 	"os"
-	"reflect"
 	"strings"
 	"text/tabwriter"
 
 	"github.com/golang/glog"
 )
 
 var templates = map[string]string{
-	"utils.SingleVersionPackageDiffResult":    SingleVersionDiffOutput,
-	"utils.MultiVersionPackageDiffResult":     MultiVersionDiffOutput,
-	"utils.HistDiffResult":                    HistoryDiffOutput,
-	"utils.DirDiffResult":                     FSDiffOutput,
-	"utils.ListAnalyzeResult":                 ListAnalysisOutput,
-	"utils.FileAnalyzeResult":                 FileAnalysisOutput,
-	"utils.MultiVersionPackageAnalyzeResult":  MultiVersionPackageOutput,
-	"utils.SingleVersionPackageAnalyzeResult": SingleVersionPackageOutput,
+	"SingleVersionPackageDiff":    SingleVersionDiffOutput,
+	"MultiVersionPackageDiff":     MultiVersionDiffOutput,
+	"HistDiff":                    HistoryDiffOutput,
+	"DirDiff":                     FSDiffOutput,
+	"ListAnalyze":                 ListAnalysisOutput,
+	"FileAnalyze":                 FileAnalysisOutput,
+	"MultiVersionPackageAnalyze":  MultiVersionPackageOutput,
+	"SingleVersionPackageAnalyze": SingleVersionPackageOutput,
 }
 
 func JSONify(diff interface{}) error {
@@ -35,16 +34,15 @@ func JSONify(diff interface{}) error {
 	return nil
 }
 
-func getTemplate(diff interface{}) (string, error) {
-	diffType := reflect.TypeOf(diff).String()
-	if template, ok := templates[diffType]; ok {
+func getTemplate(templateType string) (string, error) {
+	if template, ok := templates[templateType]; ok {
 		return template, nil
 	}
 	return "", errors.New("No available template")
 }
 
-func TemplateOutput(diff interface{}) error {
-	outputTmpl, err := getTemplate(diff)
+func TemplateOutput(diff interface{}, templateType string) error {
+	outputTmpl, err := getTemplate(templateType)
 	if err != nil {
 		glog.Error(err)
 

utils/package_diff_utils.go

@@ -40,7 +40,7 @@ type Info struct {
 // PackageInfo stores the specific metadata about a package.
 type PackageInfo struct {
 	Version string
-	Size    string
+	Size    int64
 }
 
 func multiVersionDiff(infoDiff []MultiVersionInfo, packageName string, map1, map2 map[string]PackageInfo) []MultiVersionInfo {