feat: order by key when printing labels

go.mod

@@ -1,6 +1,6 @@
 module github.com/hetznercloud/cli
 
-go 1.22
+go 1.23
 
 toolchain go1.23.5
 

internal/cmd/certificate/describe.go

@@ -49,7 +49,7 @@ var DescribeCmd = base.DescribeCmd{
 		if len(cert.Labels) == 0 {
 			cmd.Print("  No labels\n")
 		} else {
-			for key, value := range cert.Labels {
+			for key, value := range util.IterateInOrder(cert.Labels) {
 				cmd.Printf("  %s:\t%s\n", key, value)
 			}
 		}

internal/cmd/firewall/describe.go

@@ -37,7 +37,7 @@ var DescribeCmd = base.DescribeCmd{
 		if len(firewall.Labels) == 0 {
 			cmd.Print("  No labels\n")
 		} else {
-			for key, value := range firewall.Labels {
+			for key, value := range util.IterateInOrder(firewall.Labels) {
 				cmd.Printf("  %s: %s\n", key, value)
 			}
 		}

internal/cmd/floatingip/describe.go

@@ -62,7 +62,7 @@ var DescribeCmd = base.DescribeCmd{
 		if len(floatingIP.Labels) == 0 {
 			cmd.Print("  No labels\n")
 		} else {
-			for key, value := range floatingIP.Labels {
+			for key, value := range util.IterateInOrder(floatingIP.Labels) {
 				cmd.Printf("  %s: %s\n", key, value)
 			}
 		}

internal/cmd/image/describe.go

@@ -74,7 +74,7 @@ var DescribeCmd = base.DescribeCmd{
 		if len(image.Labels) == 0 {
 			cmd.Print("  No labels\n")
 		} else {
-			for key, value := range image.Labels {
+			for key, value := range util.IterateInOrder(image.Labels) {
 				cmd.Printf("  %s: %s\n", key, value)
 			}
 		}

internal/cmd/loadbalancer/describe.go

@@ -157,7 +157,7 @@ var DescribeCmd = base.DescribeCmd{
 		if len(loadBalancer.Labels) == 0 {
 			cmd.Print("  No labels\n")
 		} else {
-			for key, value := range loadBalancer.Labels {
+			for key, value := range util.IterateInOrder(loadBalancer.Labels) {
 				cmd.Printf("  %s: %s\n", key, value)
 			}
 		}

internal/cmd/network/describe.go

@@ -66,7 +66,7 @@ var DescribeCmd = base.DescribeCmd{
 		if len(network.Labels) == 0 {
 			cmd.Print("  No labels\n")
 		} else {
-			for key, value := range network.Labels {
+			for key, value := range util.IterateInOrder(network.Labels) {
 				cmd.Printf("  %s: %s\n", key, value)
 			}
 		}

internal/cmd/placementgroup/describe.go

@@ -35,7 +35,7 @@ var DescribeCmd = base.DescribeCmd{
 		if len(placementGroup.Labels) == 0 {
 			cmd.Print("  No labels\n")
 		} else {
-			for key, value := range placementGroup.Labels {
+			for key, value := range util.IterateInOrder(placementGroup.Labels) {
 				cmd.Printf("  %s: %s\n", key, value)
 			}
 		}

internal/cmd/primaryip/describe.go

@@ -57,7 +57,7 @@ var DescribeCmd = base.DescribeCmd{
 		if len(primaryIP.Labels) == 0 {
 			cmd.Print("  No labels\n")
 		} else {
-			for key, value := range primaryIP.Labels {
+			for key, value := range util.IterateInOrder(primaryIP.Labels) {
 				cmd.Printf("  %s: %s\n", key, value)
 			}
 		}

internal/cmd/server/describe.go

@@ -186,7 +186,7 @@ var DescribeCmd = base.DescribeCmd{
 		if len(server.Labels) == 0 {
 			cmd.Print("  No labels\n")
 		} else {
-			for key, value := range server.Labels {
+			for key, value := range util.IterateInOrder(server.Labels) {
 				cmd.Printf("  %s: %s\n", key, value)
 			}
 		}

internal/cmd/sshkey/describe.go

@@ -37,7 +37,7 @@ var DescribeCmd = base.DescribeCmd{
 		if len(sshKey.Labels) == 0 {
 			cmd.Print("  No labels\n")
 		} else {
-			for key, value := range sshKey.Labels {
+			for key, value := range util.IterateInOrder(sshKey.Labels) {
 				cmd.Printf("  %s: %s\n", key, value)
 			}
 		}

internal/cmd/util/util.go

@@ -5,8 +5,10 @@ import (
 	"encoding/json"
 	"fmt"
 	"io"
+	"iter"
+	"maps"
 	"reflect"
-	"sort"
+	"slices"
 	"strings"
 	"text/template"
 	"time"
@@ -148,13 +150,7 @@ func SplitLabelVars(label string) (string, string) {
 
 func LabelsToString(labels map[string]string) string {
 	var labelsString []string
-	keys := make([]string, 0, len(labels))
-	for key := range labels {
-		keys = append(keys, key)
-	}
-	sort.Strings(keys)
-	for _, key := range keys {
-		value := labels[key]
+	for key, value := range IterateInOrder(labels) {
 		if value == "" {
 			labelsString = append(labelsString, key)
 		} else {
@@ -369,3 +365,15 @@ func ToStringSliceDelimited(val any) []string {
 		return AnyToStringSlice(val)
 	}
 }
+
+// IterateInOrder returns an iterator that iterates over the map in order of the keys.
+func IterateInOrder[M ~map[K]V, K cmp.Ordered, V any](m M) iter.Seq2[K, V] {
+	keys := slices.Sorted(maps.Keys(m))
+	return func(yield func(K, V) bool) {
+		for _, k := range keys {
+			if !yield(k, m[k]) {
+				return
+			}
+		}
+	}
+}

internal/cmd/util/util_test.go

@@ -454,3 +454,28 @@ func TestPrice(t *testing.T) {
 		})
 	}
 }
+
+func TestSortLabels(t *testing.T) {
+	labels := map[string]string{
+		"c": "baz",
+		"a": "foo",
+		"z": "qux",
+		"b": "bar",
+	}
+	expected := [][]string{
+		{"a", "foo"},
+		{"b", "bar"},
+		{"c", "baz"},
+		{"z", "qux"},
+	}
+
+	i := 0
+	for k, v := range util.IterateInOrder(labels) {
+		require.Less(t, i, 4)
+		exp := expected[i]
+		i++
+
+		assert.Equal(t, exp[0], k, "key not equal")
+		assert.Equal(t, exp[1], v, "value not equal")
+	}
+}

internal/cmd/volume/describe.go

@@ -53,7 +53,7 @@ var DescribeCmd = base.DescribeCmd{
 		if len(volume.Labels) == 0 {
 			cmd.Print("  No labels\n")
 		} else {
-			for key, value := range volume.Labels {
+			for key, value := range util.IterateInOrder(volume.Labels) {
 				cmd.Printf("  %s: %s\n", key, value)
 			}
 		}