Add utils module with SortedKeys helper (#2689)

## Changes
- Move helper sortedKeys from artifacts package to libs/utils
- Use it where it's useful.

## Tests
Existing tests.

Author: denik

bundle/artifacts/build.go

@@ -15,6 +15,7 @@ import (
 	"github.com/databricks/cli/libs/log"
 	"github.com/databricks/cli/libs/patchwheel"
 	"github.com/databricks/cli/libs/python"
+	"github.com/databricks/cli/libs/utils"
 )
 
 func Build() bundle.Mutator {
@@ -38,7 +39,7 @@ func (m *build) Apply(ctx context.Context, b *bundle.Bundle) diag.Diagnostics {
 		})
 	}
 
-	for _, artifactName := range sortedKeys(b.Config.Artifacts) {
+	for _, artifactName := range utils.SortedKeys(b.Config.Artifacts) {
 		a := b.Config.Artifacts[artifactName]
 
 		if a.BuildCommand != "" {

bundle/artifacts/prepare.go

@@ -4,7 +4,6 @@ import (
 	"context"
 	"os"
 	"path/filepath"
-	"sort"
 
 	"github.com/databricks/cli/bundle"
 	"github.com/databricks/cli/bundle/config"
@@ -13,6 +12,7 @@ import (
 	"github.com/databricks/cli/libs/diag"
 	"github.com/databricks/cli/libs/log"
 	"github.com/databricks/cli/libs/python"
+	"github.com/databricks/cli/libs/utils"
 )
 
 func Prepare() bundle.Mutator {
@@ -36,7 +36,7 @@ func (m *prepare) Apply(ctx context.Context, b *bundle.Bundle) diag.Diagnostics
 	removeFolders := make(map[string]bool, len(b.Config.Artifacts))
 	cleanupWheelFolders := make(map[string]bool, len(b.Config.Artifacts))
 
-	for _, artifactName := range sortedKeys(b.Config.Artifacts) {
+	for _, artifactName := range utils.SortedKeys(b.Config.Artifacts) {
 		artifact := b.Config.Artifacts[artifactName]
 		b.Metrics.AddBoolValue(metrics.ArtifactBuildCommandIsSet, artifact.BuildCommand != "")
 		b.Metrics.AddBoolValue(metrics.ArtifactFilesIsSet, len(artifact.Files) != 0)
@@ -89,14 +89,14 @@ func (m *prepare) Apply(ctx context.Context, b *bundle.Bundle) diag.Diagnostics
 		return diags
 	}
 
-	for _, dir := range sortedKeys(removeFolders) {
+	for _, dir := range utils.SortedKeys(removeFolders) {
 		err := os.RemoveAll(dir)
 		if err != nil {
 			log.Infof(ctx, "Failed to remove %s: %s", dir, err)
 		}
 	}
 
-	for _, dir := range sortedKeys(cleanupWheelFolders) {
+	for _, dir := range utils.SortedKeys(cleanupWheelFolders) {
 		log.Infof(ctx, "Cleaning up Python build artifacts in %s", dir)
 		python.CleanupWheelFolder(dir)
 	}
@@ -140,12 +140,3 @@ func InsertPythonArtifact(ctx context.Context, b *bundle.Bundle) error {
 
 	return nil
 }
-
-func sortedKeys[T any](m map[string]T) []string {
-	keys := make([]string, 0, len(m))
-	for k := range m {
-		keys = append(keys, k)
-	}
-	sort.Strings(keys)
-	return keys
-}

bundle/libraries/upload.go

@@ -7,7 +7,6 @@ import (
 	"os"
 	"path"
 	"path/filepath"
-	"sort"
 	"strings"
 
 	"github.com/databricks/cli/bundle"
@@ -16,6 +15,7 @@ import (
 	"github.com/databricks/cli/libs/dyn"
 	"github.com/databricks/cli/libs/filer"
 	"github.com/databricks/cli/libs/log"
+	"github.com/databricks/cli/libs/utils"
 
 	"golang.org/x/sync/errgroup"
 )
@@ -150,11 +150,7 @@ func (u *upload) Apply(ctx context.Context, b *bundle.Bundle) diag.Diagnostics {
 		return diag.FromErr(err)
 	}
 
-	sources := make([]string, 0, len(libs))
-	for source := range libs {
-		sources = append(sources, source)
-	}
-	sort.Strings(sources)
+	sources := utils.SortedKeys(libs)
 
 	errs, errCtx := errgroup.WithContext(ctx)
 	errs.SetLimit(maxFilesRequestsInFlight)

bundle/tests/include_test.go

@@ -3,14 +3,13 @@ package config_tests
 import (
 	"context"
 	"path/filepath"
-	"sort"
 	"testing"
 
 	"github.com/databricks/cli/bundle"
 	"github.com/databricks/cli/bundle/phases"
+	"github.com/databricks/cli/libs/utils"
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
-	"golang.org/x/exp/maps"
 )
 
 func TestIncludeInvalid(t *testing.T) {
@@ -25,8 +24,7 @@ func TestIncludeInvalid(t *testing.T) {
 func TestIncludeWithGlob(t *testing.T) {
 	b := load(t, "./include_with_glob")
 
-	keys := maps.Keys(b.Config.Resources.Jobs)
-	sort.Strings(keys)
+	keys := utils.SortedKeys(b.Config.Resources.Jobs)
 	assert.Equal(t, []string{"my_job"}, keys)
 
 	job := b.Config.Resources.Jobs["my_job"]
@@ -46,8 +44,7 @@ func TestIncludeForMultipleMatches(t *testing.T) {
 	b := load(t, "./include_multiple")
 
 	// Test that both jobs were loaded.
-	keys := maps.Keys(b.Config.Resources.Jobs)
-	sort.Strings(keys)
+	keys := utils.SortedKeys(b.Config.Resources.Jobs)
 	assert.Equal(t, []string{"my_first_job", "my_second_job"}, keys)
 
 	first := b.Config.Resources.Jobs["my_first_job"]

libs/dyn/dynvar/resolve.go

@@ -4,11 +4,10 @@ import (
 	"errors"
 	"fmt"
 	"slices"
-	"sort"
 	"strings"
 
 	"github.com/databricks/cli/libs/dyn"
-	"golang.org/x/exp/maps"
+	"github.com/databricks/cli/libs/utils"
 )
 
 // Resolve resolves variable references in the given input value using the provided lookup function.
@@ -102,8 +101,7 @@ func (r *resolver) resolveVariableReferences() (err error) {
 	// We sort the keys here to ensure that we always resolve the same variable reference first.
 	// This is done such that the cycle detection error is deterministic. If we did not do this,
 	// we could enter the cycle at any point in the cycle and return varying errors.
-	keys := maps.Keys(r.refs)
-	sort.Strings(keys)
+	keys := utils.SortedKeys(r.refs)
 	for _, key := range keys {
 		v, err := r.resolveRef(r.refs[key], []string{key})
 		if err != nil {

libs/utils/utils.go

@@ -0,0 +1,12 @@
+package utils
+
+import "sort"
+
+func SortedKeys[T any](m map[string]T) []string {
+	keys := make([]string, 0, len(m))
+	for k := range m {
+		keys = append(keys, k)
+	}
+	sort.Strings(keys)
+	return keys
+}