better changes logging

Author: aine-etke

internal/models/updates.go

@@ -0,0 +1,48 @@
+package models
+
+import (
+	"sort"
+	"strings"
+)
+
+// UpdatedItem is a struct to hold updated item information
+type UpdatedItem struct {
+	Role       string
+	OldVersion string
+	NewVersion string
+}
+
+// UpdatedItems is a slice of UpdatedItem
+type UpdatedItems []*UpdatedItem
+
+// Add adds a new UpdatedItem to UpdatedItems
+func (u UpdatedItems) Add(role, oldVersion, newVersion string) UpdatedItems {
+	return append(u, &UpdatedItem{Role: role, OldVersion: oldVersion, NewVersion: newVersion})
+}
+
+// String returns a string representation of UpdatedItems
+func (u UpdatedItems) String(prefix string) string {
+	sort.Slice(u, func(i, j int) bool {
+		return u[i].Role < u[j].Role
+	})
+
+	var msg strings.Builder
+	for _, item := range u {
+		if item.OldVersion == "" {
+			msg.WriteString("added ")
+			msg.WriteString(item.Role)
+			msg.WriteString(" (")
+			msg.WriteString(item.NewVersion)
+			msg.WriteString("); ")
+			continue
+		}
+		msg.WriteString("updated ")
+		msg.WriteString(item.Role)
+		msg.WriteString(" (")
+		msg.WriteString(item.OldVersion)
+		msg.WriteString(" -> ")
+		msg.WriteString(item.NewVersion)
+		msg.WriteString("); ")
+	}
+	return prefix + msg.String()
+}

internal/parser/files.go

@@ -48,13 +48,14 @@ func parseAdditionalFile(req models.File) models.File {
 
 // UpdateFile updates the requirements.yml file
 func UpdateFile(entries models.File, requirementsPath string) {
+	changes := models.UpdatedItems{}
 	var wg sync.WaitGroup
 	wg.Add(len(entries))
 	for i, entry := range entries {
 		go func(i int, entry *models.Entry, wg *sync.WaitGroup) {
 			newVersion := getNewVersion(entry.Src, entry.Version)
 			if newVersion != "" {
-				utils.Log(entry.Src, entry.Version, "->", newVersion)
+				changes = changes.Add(entry.GetName(), entry.Version, newVersion)
 				entry.Version = newVersion
 				entries[i] = entry
 			}
@@ -63,6 +64,10 @@ func UpdateFile(entries models.File, requirementsPath string) {
 	}
 	wg.Wait()
 
+	if len(changes) > 0 {
+		utils.Log(changes.String("requirements changes: "))
+	}
+
 	outb, err := yaml.Marshal(entries)
 	if err != nil {
 		utils.Log("ERROR: marshaling yaml", err)

internal/parser/roles.go

@@ -25,16 +25,24 @@ func InstallMissingRoles(rolesPath string, entries models.File, cleanup bool) {
 		}
 	}
 	var wg sync.WaitGroup
+	changes := models.UpdatedItems{}
 	wg.Add(len(entries))
 	for _, entry := range entries {
 		go func(entry *models.Entry, wg *sync.WaitGroup) {
 			if !entry.IsInstalled(rolesPath) {
+				if !ignoredVersions[entry.Version] {
+					changes = changes.Add(entry.GetName(), entry.GetInstallInfo(rolesPath).Version, entry.Version)
+				}
 				installRole(rolesPath, entry, cleanup)
 			}
 			wg.Done()
 		}(entry, &wg)
 	}
 	wg.Wait()
+
+	if len(changes) > 0 {
+		utils.Log(changes.String("roles updated: "))
+	}
 }
 
 // GetInstalledRoles returns all roles that are already installed