fix: respect go get order (#30)

Signed-off-by: hectorj2f <[email protected]>

Author: hectorj2f

cmd/gobump/root.go

@@ -35,21 +35,22 @@ var rootCmd = &cobra.Command{
 		}
 		packages := strings.Split(rootFlags.packages, " ")
 		pkgVersions := map[string]*types.Package{}
-		for _, pkg := range packages {
+		for i, pkg := range packages {
 			parts := strings.Split(pkg, "@")
 			if len(parts) != 2 {
 				return fmt.Errorf("Error: Invalid package format. Each package should be in the format <package@version>. Usage: gobump --packages=\"<package1@version> <package2@version> ...\"")
 			}
 			pkgVersions[parts[0]] = &types.Package{
 				Name:    parts[0],
 				Version: parts[1],
+				Index:   i,
 			}
 		}
 
 		var replaces []string
 		if len(rootFlags.replaces) != 0 {
 			replaces = strings.Split(rootFlags.replaces, " ")
-			for _, replace := range replaces {
+			for i, replace := range replaces {
 				parts := strings.Split(replace, "=")
 				if len(parts) != 2 {
 					return fmt.Errorf("Error: Invalid replace format. Each replace should be in the format <oldpackage=newpackage@version>. Usage: gobump -replaces=\"<oldpackage=newpackage@version> ...\"")
@@ -65,6 +66,7 @@ var rootCmd = &cobra.Command{
 					Name:    rep[0],
 					Version: rep[1],
 					Replace: true,
+					Index:   i,
 				}
 			}
 		}

pkg/types/types.go

@@ -6,6 +6,7 @@ type Package struct {
 	Version string
 	Replace bool
 	Require bool
+	Index   int
 }
 
 type Config struct {

pkg/update/update.go

@@ -7,6 +7,7 @@ import (
 	"os"
 	"os/exec"
 	"path"
+	"sort"
 	"strings"
 
 	"github.com/chainguard-dev/gobump/pkg/run"
@@ -99,8 +100,11 @@ func DoUpdate(pkgVersions map[string]*types.Package, cfg *types.Config) (*modfil
 		return nil, err
 	}
 
+	depsBumpOrdered := orderPkgVersionsMap(pkgVersions)
+
 	// Replace the packages first.
-	for k, pkg := range pkgVersions {
+	for _, k := range depsBumpOrdered {
+		pkg := pkgVersions[k]
 		if pkg.Replace {
 			log.Printf("Update package: %s\n", k)
 			log.Println("Running go mod edit replace ...")
@@ -109,8 +113,9 @@ func DoUpdate(pkgVersions map[string]*types.Package, cfg *types.Config) (*modfil
 			}
 		}
 	}
-	// Bump the require or new get packages.
-	for k, pkg := range pkgVersions {
+	// Bump the require or new get packages in the specified order.
+	for _, k := range depsBumpOrdered {
+		pkg := pkgVersions[k]
 		// Skip the replace that have been updated above
 		if !pkg.Replace {
 			log.Printf("Update package: %s\n", k)
@@ -166,6 +171,17 @@ func DoUpdate(pkgVersions map[string]*types.Package, cfg *types.Config) (*modfil
 	return newModFile, nil
 }
 
+func orderPkgVersionsMap(pkgVersions map[string]*types.Package) []string {
+	depsBumpOrdered := make([]string, 0, len(pkgVersions))
+	for repo := range pkgVersions {
+		depsBumpOrdered = append(depsBumpOrdered, repo)
+	}
+	sort.SliceStable(depsBumpOrdered, func(i, j int) bool {
+		return pkgVersions[depsBumpOrdered[i]].Index < pkgVersions[depsBumpOrdered[j]].Index
+	})
+	return depsBumpOrdered
+}
+
 func getVersion(modFile *modfile.File, packageName string) string {
 	// Handle package update, including 'replace' clause
 

pkg/update/update_test.go

@@ -2,6 +2,7 @@ package update
 
 import (
 	"os/exec"
+	"reflect"
 	"testing"
 
 	"github.com/chainguard-dev/gobump/pkg/types"
@@ -58,6 +59,54 @@ func TestUpdate(t *testing.T) {
 	}
 }
 
+func TestUpdateInOrder(t *testing.T) {
+	testCases := []struct {
+		name        string
+		pkgVersions map[string]*types.Package
+		want        []string
+	}{
+		{
+			name: "standard update",
+			pkgVersions: map[string]*types.Package{
+				"github.com/google/uuid": {
+					Name:    "github.com/google/uuid",
+					Version: "v1.4.0",
+					Index:   0,
+				},
+				"k8s.io/api": {
+					OldName: "k8s.io/api",
+					Name:    "k8s.io/api",
+					Version: "v0.28.0",
+					Index:   2,
+				},
+				"k8s.io/client-go": {
+					OldName: "k8s.io/client-go",
+					Name:    "k8s.io/client-go",
+					Version: "v0.28.0",
+					Index:   1,
+				},
+			},
+			want: []string{
+				"github.com/google/uuid",
+				"k8s.io/api",
+				"k8s.io/client-go",
+			},
+		},
+	}
+
+	for _, tc := range testCases {
+		t.Run(tc.name, func(t *testing.T) {
+			tmpdir := t.TempDir()
+			copyFile(t, "testdata/aws-efs-csi-driver/go.mod", tmpdir)
+
+			got := orderPkgVersionsMap(tc.pkgVersions)
+			if len(got) != len(tc.want) || reflect.DeepEqual(got, tc.want) {
+				t.Errorf("expected %s, got %s", tc.want, got)
+			}
+		})
+	}
+}
+
 func TestGoModTidy(t *testing.T) {
 	testCases := []struct {
 		name        string