CLOUDP-259458: Sort tags alphabetically (#55)

Author: blva

tools/cli/internal/openapi/oasdiff.go

@@ -16,6 +16,7 @@ package openapi
 
 import (
 	"log"
+	"sort"
 	"strings"
 
 	"github.com/getkin/kin-openapi/openapi3"
@@ -233,7 +234,7 @@ func (o OasDiff) mergeTags() error {
 			}
 		}
 	}
-
+	sort.Sort(ByName(baseTags))
 	o.base.Spec.Tags = baseTags
 	return nil
 }
@@ -371,3 +372,9 @@ func (o OasDiff) areSchemaIdentical(name string) bool {
 	_, ok := o.specDiff.SchemasDiff.Modified[name]
 	return !ok
 }
+
+type ByName []*openapi3.Tag
+
+func (a ByName) Len() int           { return len(a) }
+func (a ByName) Swap(i, j int)      { a[i], a[j] = a[j], a[i] }
+func (a ByName) Less(i, j int) bool { return a[i].Name < a[j].Name }

tools/cli/internal/openapi/oasdiff_test.go

@@ -20,6 +20,7 @@ import (
 
 	"github.com/getkin/kin-openapi/openapi3"
 	"github.com/mongodb/openapi/tools/cli/internal/pointer"
+	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 	"github.com/tufin/oasdiff/diff"
 	"github.com/tufin/oasdiff/load"
@@ -143,13 +144,18 @@ func TestOasDiff_mergeTags(t *testing.T) {
 		inputExternal *load.SpecInfo
 		wantErr       require.ErrorAssertionFunc
 		name          string
+		expectedTags  []*openapi3.Tag
 	}{
 		{
 			name: "SuccessfulMerge",
 			inputBase: &load.SpecInfo{
 				Url: "base",
 				Spec: &openapi3.T{
 					Tags: []*openapi3.Tag{
+						{
+							Name:        "TagBase3",
+							Description: "TagBase3",
+						},
 						{
 							Name:        "TagBase1",
 							Description: "TagBase1",
@@ -181,6 +187,30 @@ func TestOasDiff_mergeTags(t *testing.T) {
 				Version: "3.0.1",
 			},
 			wantErr: require.NoError,
+			expectedTags: []*openapi3.Tag{
+				{
+					Name:        "Tag1",
+					Description: "Tag1",
+				},
+
+				{
+					Name:        "Tag2",
+					Description: "Tag2",
+				},
+				{
+					Name:        "TagBase1",
+					Description: "TagBase1",
+				},
+
+				{
+					Name:        "TagBase2",
+					Description: "TagBase2",
+				},
+				{
+					Name:        "TagBase3",
+					Description: "TagBase3",
+				},
+			},
 		},
 		{
 			name: "SuccessfulMergeEmptyTags",
@@ -305,6 +335,13 @@ func TestOasDiff_mergeTags(t *testing.T) {
 				external: tc.inputExternal,
 			}
 			tc.wantErr(t, o.mergeTags())
+			if tc.expectedTags != nil {
+				assert.Equal(t, len(o.base.Spec.Tags), len(tc.expectedTags))
+				// check tag names are the same
+				for i := range o.base.Spec.Tags {
+					assert.Equal(t, o.base.Spec.Tags[i].Name, tc.expectedTags[i].Name)
+				}
+			}
 		})
 	}
 }