Sort results of plan-preview

Author: kj455

pkg/app/piped/planpreview/builder.go

@@ -19,6 +19,7 @@ import (
 	"context"
 	"fmt"
 	"os"
+	"sort"
 
 	"go.uber.org/zap"
 	"google.golang.org/grpc/codes"
@@ -41,6 +42,7 @@ const (
 	workspacePattern    = "plan-preview-builder-*"
 	defaultWorkerAppNum = 3
 	maxWorkerNum        = 100
+	labelEnvKey         = "env"
 )
 
 var (
@@ -197,10 +199,25 @@ func (b *builder) build(ctx context.Context, id string, cmd model.Command_BuildP
 		results = append(results, r)
 	}
 
+	sortResults(results)
+
 	logger.Info("successfully collected plan-preview results of all applications")
 	return results, nil
 }
 
+func sortResults(results []*model.ApplicationPlanPreviewResult) {
+	sort.SliceStable(results, func(i, j int) bool {
+		a, b := results[i], results[j]
+		if a.ApplicationName != b.ApplicationName {
+			return a.ApplicationName < b.ApplicationName
+		}
+		if a.Labels[labelEnvKey] != b.Labels[labelEnvKey] {
+			return a.Labels[labelEnvKey] < b.Labels[labelEnvKey]
+		}
+		return a.ApplicationKind < b.ApplicationKind
+	})
+}
+
 func (b *builder) buildApp(ctx context.Context, worker int, command string, app *model.Application, repo git.Repo, mergedCommit string) *model.ApplicationPlanPreviewResult {
 	logger := b.logger.With(
 		zap.Int("worker", worker),

pkg/app/piped/planpreview/builder_test.go

@@ -0,0 +1,71 @@
+// Copyright 2024 The PipeCD Authors.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package planpreview
+
+import (
+	"testing"
+
+	"github.com/pipe-cd/pipecd/pkg/model"
+	"github.com/stretchr/testify/require"
+)
+
+func TestSortResults(t *testing.T) {
+	t.Parallel()
+
+	tests := []struct {
+		name     string
+		input    []*model.ApplicationPlanPreviewResult
+		expected []*model.ApplicationPlanPreviewResult
+	}{
+		{
+			name: "sort by name, kind",
+			input: []*model.ApplicationPlanPreviewResult{
+				{ApplicationName: "appB", ApplicationKind: model.ApplicationKind_CLOUDRUN},
+				{ApplicationName: "appB", ApplicationKind: model.ApplicationKind_KUBERNETES},
+				{ApplicationName: "appA", ApplicationKind: model.ApplicationKind_CLOUDRUN},
+				{ApplicationName: "appA", ApplicationKind: model.ApplicationKind_KUBERNETES},
+			},
+			expected: []*model.ApplicationPlanPreviewResult{
+				{ApplicationName: "appA", ApplicationKind: model.ApplicationKind_KUBERNETES},
+				{ApplicationName: "appA", ApplicationKind: model.ApplicationKind_CLOUDRUN},
+				{ApplicationName: "appB", ApplicationKind: model.ApplicationKind_KUBERNETES},
+				{ApplicationName: "appB", ApplicationKind: model.ApplicationKind_CLOUDRUN},
+			},
+		},
+		{
+			name: "sort by name, env, kind",
+			input: []*model.ApplicationPlanPreviewResult{
+				{ApplicationName: "appB", Labels: map[string]string{labelEnvKey: "dev"}, ApplicationKind: model.ApplicationKind_CLOUDRUN},
+				{ApplicationName: "appB", Labels: map[string]string{labelEnvKey: "dev"}, ApplicationKind: model.ApplicationKind_KUBERNETES},
+				{ApplicationName: "appA", Labels: map[string]string{labelEnvKey: "prd"}, ApplicationKind: model.ApplicationKind_CLOUDRUN},
+				{ApplicationName: "appA", Labels: map[string]string{labelEnvKey: "dev"}, ApplicationKind: model.ApplicationKind_KUBERNETES},
+			},
+			expected: []*model.ApplicationPlanPreviewResult{
+				{ApplicationName: "appA", Labels: map[string]string{labelEnvKey: "dev"}, ApplicationKind: model.ApplicationKind_KUBERNETES},
+				{ApplicationName: "appA", Labels: map[string]string{labelEnvKey: "prd"}, ApplicationKind: model.ApplicationKind_CLOUDRUN},
+				{ApplicationName: "appB", Labels: map[string]string{labelEnvKey: "dev"}, ApplicationKind: model.ApplicationKind_KUBERNETES},
+				{ApplicationName: "appB", Labels: map[string]string{labelEnvKey: "dev"}, ApplicationKind: model.ApplicationKind_CLOUDRUN},
+			},
+		},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			t.Parallel()
+			sortResults(tt.input)
+			require.Equal(t, tt.expected, tt.input)
+		})
+	}
+}