Merge pull request #39899 from hashicorp/td-sort-pkg-functions

Replaces `sort.Slice` and `sort.SliceStable` with `slices.SortFunc` and `slices.SortStableFunc`

.ci/semgrep/stdlib/sort.yml

@@ -0,0 +1,12 @@
+rules:
+  - id: prefer-slices-sortfunc
+    languages: [go]
+    message: Prefer slices.SortFunc to sort.Slice
+    pattern: sort.Slice(...)
+    severity: WARNING
+
+  - id: prefer-slices-sortstablefunc
+    languages: [go]
+    message: Prefer slices.SortStableFunc to sort.SliceStable
+    pattern: sort.SliceStable(...)
+    severity: WARNING

internal/generate/acctestconsts/main.go

@@ -7,8 +7,9 @@
 package main
 
 import (
+	"cmp"
 	_ "embed"
-	"sort"
+	"slices"
 	"strings"
 
 	"github.com/hashicorp/terraform-provider-aws/internal/generate/common"
@@ -23,14 +24,14 @@ var constOrQuoteTmpl string
 //go:embed semgrep.gtpl
 var semgrepTmpl string
 
-type ConstantDatum struct {
+type constantDatum struct {
 	Constant   string
 	Literal    string
 	AltLiteral string
 }
 
 type TemplateData struct {
-	Constants []ConstantDatum
+	Constants []constantDatum
 }
 
 func main() {
@@ -91,21 +92,21 @@ func main() {
 	}
 }
 
-func readConstants(filename string) ([]ConstantDatum, error) {
+func readConstants(filename string) ([]constantDatum, error) {
 	constants, err := common.ReadAllCSVData(filename)
 
 	if err != nil {
 		return nil, err
 	}
 
-	var constantList []ConstantDatum
+	var constantList []constantDatum
 
 	for _, row := range constants {
 		if row[0] == "" {
 			continue
 		}
 
-		cd := ConstantDatum{
+		cd := constantDatum{
 			Literal:  row[0],
 			Constant: row[1],
 		}
@@ -128,8 +129,8 @@ func readConstants(filename string) ([]ConstantDatum, error) {
 		constantList = append(constantList, cd)
 	}
 
-	sort.SliceStable(constantList, func(i, j int) bool {
-		return constantList[j].Constant > constantList[i].Constant
+	slices.SortStableFunc(constantList, func(a, b constantDatum) int {
+		return cmp.Compare(a.Constant, b.Constant)
 	})
 
 	return constantList, nil

internal/generate/allowsubcats/main.go

@@ -7,8 +7,9 @@
 package main
 
 import (
+	"cmp"
 	_ "embed"
-	"sort"
+	"slices"
 	"strings"
 
 	"github.com/hashicorp/terraform-provider-aws/internal/generate/common"
@@ -55,8 +56,8 @@ func main() {
 		td.Services = append(td.Services, sd)
 	}
 
-	sort.SliceStable(td.Services, func(i, j int) bool {
-		return td.Services[i].HumanFriendly < td.Services[j].HumanFriendly
+	slices.SortStableFunc(td.Services, func(a, b ServiceDatum) int {
+		return cmp.Compare(a.HumanFriendly, b.HumanFriendly)
 	})
 
 	d := g.NewUnformattedFileDestination(filename)

internal/generate/attrconsts/main.go

@@ -7,8 +7,9 @@
 package main
 
 import (
+	"cmp"
 	_ "embed"
-	"sort"
+	"slices"
 	"strings"
 
 	"github.com/hashicorp/terraform-provider-aws/internal/generate/common"
@@ -27,13 +28,13 @@ var constOrQuoteTmpl string
 //go:embed semgrep.gtpl
 var semgrepTmpl string
 
-type ConstantDatum struct {
+type constantDatum struct {
 	Constant string
 	Literal  string
 }
 
 type TemplateData struct {
-	Constants []ConstantDatum
+	Constants []constantDatum
 }
 
 func main() {
@@ -94,28 +95,28 @@ func main() {
 	}
 }
 
-func readConstants(filename string) ([]ConstantDatum, error) {
+func readConstants(filename string) ([]constantDatum, error) {
 	constants, err := common.ReadAllCSVData(filename)
 
 	if err != nil {
 		return nil, err
 	}
 
-	var constantList []ConstantDatum
+	var constantList []constantDatum
 
 	for _, row := range constants {
 		if row[0] == "" {
 			continue
 		}
 
-		constantList = append(constantList, ConstantDatum{
+		constantList = append(constantList, constantDatum{
 			Literal:  row[0],
 			Constant: row[1],
 		})
 	}
 
-	sort.SliceStable(constantList, func(i, j int) bool {
-		return constantList[j].Constant > constantList[i].Constant
+	slices.SortStableFunc(constantList, func(a, b constantDatum) int {
+		return cmp.Compare(a.Constant, b.Constant)
 	})
 
 	return constantList, nil

internal/generate/awsclient/main.go

@@ -7,8 +7,9 @@
 package main
 
 import (
+	"cmp"
 	_ "embed"
-	"sort"
+	"slices"
 
 	"github.com/hashicorp/terraform-provider-aws/internal/generate/common"
 	"github.com/hashicorp/terraform-provider-aws/names/data"
@@ -59,8 +60,8 @@ func main() {
 		td.Services = append(td.Services, s)
 	}
 
-	sort.SliceStable(td.Services, func(i, j int) bool {
-		return td.Services[i].ProviderNameUpper < td.Services[j].ProviderNameUpper
+	slices.SortStableFunc(td.Services, func(a, b ServiceDatum) int {
+		return cmp.Compare(a.ProviderNameUpper, b.ProviderNameUpper)
 	})
 
 	d := g.NewGoFileDestination(filename)

internal/generate/customends/main.go

@@ -7,8 +7,9 @@
 package main
 
 import (
+	"cmp"
 	_ "embed"
-	"sort"
+	"slices"
 	"strings"
 
 	"github.com/hashicorp/terraform-provider-aws/internal/generate/common"
@@ -72,8 +73,8 @@ func main() {
 		td.Services = append(td.Services, sd)
 	}
 
-	sort.Slice(td.Services, func(i, j int) bool {
-		return td.Services[i].ProviderPackage < td.Services[j].ProviderPackage
+	slices.SortFunc(td.Services, func(a, b serviceDatum) int {
+		return cmp.Compare(a.ProviderPackage, b.ProviderPackage)
 	})
 
 	d := g.NewUnformattedFileDestination(filename)

internal/generate/customendsfwschema/main.go

@@ -7,8 +7,9 @@
 package main
 
 import (
+	"cmp"
 	_ "embed"
-	"sort"
+	"slices"
 	"strings"
 
 	"github.com/hashicorp/terraform-provider-aws/internal/generate/common"
@@ -56,8 +57,8 @@ func main() {
 		td.Services = append(td.Services, sd)
 	}
 
-	sort.Slice(td.Services, func(i, j int) bool {
-		return td.Services[i].ProviderPackage < td.Services[j].ProviderPackage
+	slices.SortFunc(td.Services, func(a, b serviceDatum) int {
+		return cmp.Compare(a.ProviderPackage, b.ProviderPackage)
 	})
 
 	d := g.NewGoFileDestination(filename)

internal/generate/customendsschema/main.go

@@ -7,8 +7,9 @@
 package main
 
 import (
+	"cmp"
 	_ "embed"
-	"sort"
+	"slices"
 	"strings"
 
 	"github.com/hashicorp/terraform-provider-aws/internal/generate/common"
@@ -62,8 +63,8 @@ func main() {
 		td.Services = append(td.Services, sd)
 	}
 
-	sort.Slice(td.Services, func(i, j int) bool {
-		return td.Services[i].ProviderPackage < td.Services[j].ProviderPackage
+	slices.SortFunc(td.Services, func(a, b serviceDatum) int {
+		return cmp.Compare(a.ProviderPackage, b.ProviderPackage)
 	})
 
 	d := g.NewGoFileDestination(filename)

internal/generate/issuelabels/main.go

@@ -7,8 +7,9 @@
 package main
 
 import (
+	"cmp"
 	_ "embed"
-	"sort"
+	"slices"
 	"strings"
 
 	"github.com/hashicorp/terraform-provider-aws/internal/generate/common"
@@ -57,8 +58,8 @@ func main() {
 		td.Services = append(td.Services, s)
 	}
 
-	sort.SliceStable(td.Services, func(i, j int) bool {
-		return td.Services[i].ProviderPackage < td.Services[j].ProviderPackage
+	slices.SortStableFunc(td.Services, func(a, b ServiceDatum) int {
+		return cmp.Compare(a.ProviderPackage, b.ProviderPackage)
 	})
 
 	d := g.NewUnformattedFileDestination(filename)

internal/generate/namescapslist/main.go

@@ -7,9 +7,10 @@
 package main
 
 import (
+	"cmp"
 	_ "embed"
 	"fmt"
-	"sort"
+	"slices"
 	"strings"
 
 	"github.com/hashicorp/terraform-provider-aws/internal/generate/common"
@@ -91,11 +92,12 @@ func readBadCaps(filename string) ([]CapsDatum, error) {
 		})
 	}
 
-	sort.SliceStable(capsList, func(i, j int) bool {
-		if len(capsList[i].Wrong) == len(capsList[j].Wrong) {
-			return capsList[i].Wrong < capsList[j].Wrong
-		}
-		return len(capsList[j].Wrong) < len(capsList[i].Wrong)
+	slices.SortStableFunc(capsList, func(a, b CapsDatum) int {
+		return cmp.Or(
+			// Reverse length order
+			cmp.Compare(len(b.Wrong), len(a.Wrong)),
+			cmp.Compare(a.Wrong, b.Wrong),
+		)
 	})
 
 	onChunk := -1
@@ -108,11 +110,11 @@ func readBadCaps(filename string) ([]CapsDatum, error) {
 		capsList[i].Test = fmt.Sprintf(`%s%d`, "caps", onChunk)
 	}
 
-	sort.SliceStable(capsList, func(i, j int) bool {
-		if strings.EqualFold(capsList[i].Wrong, capsList[j].Wrong) {
-			return capsList[i].Wrong < capsList[j].Wrong
-		}
-		return strings.ToLower(capsList[i].Wrong) < strings.ToLower(capsList[j].Wrong)
+	slices.SortStableFunc(capsList, func(a, b CapsDatum) int {
+		return cmp.Or(
+			cmp.Compare(strings.ToLower(a.Wrong), strings.ToLower(b.Wrong)),
+			cmp.Compare(a.Wrong, b.Wrong),
+		)
 	})
 
 	return capsList, nil

internal/generate/namesconsts/main.go

@@ -7,18 +7,19 @@
 package main
 
 import (
+	"cmp"
 	_ "embed"
-	"sort"
+	"slices"
 
 	"github.com/hashicorp/terraform-provider-aws/internal/generate/common"
 	"github.com/hashicorp/terraform-provider-aws/names/data"
 )
 
 type TemplateData struct {
-	Services []ServiceDatum
+	Services []serviceDatum
 }
 
-type ServiceDatum struct {
+type serviceDatum struct {
 	ProviderPackage   string
 	ProviderNameUpper string
 	SDKID             string
@@ -49,7 +50,7 @@ func main() {
 			continue
 		}
 
-		sd := ServiceDatum{
+		sd := serviceDatum{
 			ProviderPackage:   l.ProviderPackage(),
 			ProviderNameUpper: l.ProviderNameUpper(),
 			SDKID:             l.SDKID(),
@@ -58,8 +59,8 @@ func main() {
 		td.Services = append(td.Services, sd)
 	}
 
-	sort.Slice(td.Services, func(i, j int) bool {
-		return td.Services[i].ProviderNameUpper < td.Services[j].ProviderNameUpper
+	slices.SortFunc(td.Services, func(a, b serviceDatum) int {
+		return cmp.Compare(a.ProviderNameUpper, b.ProviderNameUpper)
 	})
 
 	d := g.NewGoFileDestination(filename)

internal/generate/prlabels/main.go

@@ -7,8 +7,9 @@
 package main
 
 import (
+	"cmp"
 	_ "embed"
-	"sort"
+	"slices"
 	"strings"
 
 	"github.com/hashicorp/terraform-provider-aws/internal/generate/common"
@@ -65,8 +66,8 @@ func main() {
 		td.Services = append(td.Services, s)
 	}
 
-	sort.SliceStable(td.Services, func(i, j int) bool {
-		return td.Services[i].ProviderPackage < td.Services[j].ProviderPackage
+	slices.SortStableFunc(td.Services, func(a, b ServiceDatum) int {
+		return cmp.Compare(a.ProviderPackage, b.ProviderPackage)
 	})
 
 	d := g.NewUnformattedFileDestination(filename)