Refactor removed_api_tests to tests against sorted strings to avoid flakiness (#245)

* Revert "fix removed_apis_test"

This reverts commit beb9613e0dc43e74ddcc583dfca3e59dd19c2660.

* refactor removed_apis_test to test on sorted error strings to remove flakiness

Signed-off-by: perdasilva <[email protected]>
Upstream-repository: api
Upstream-commit: cb9dc0ee2c6a5c31e04ce1ab0c2eee72d9125ffb

Author: perdasilva

staging/api/pkg/validation/internal/removed_apis_test.go

@@ -1,10 +1,13 @@
 package internal
 
 import (
-	"github.com/operator-framework/api/pkg/manifests"
-	"github.com/stretchr/testify/require"
 	"reflect"
+	"sort"
+	"strings"
 	"testing"
+
+	"github.com/operator-framework/api/pkg/manifests"
+	"github.com/stretchr/testify/require"
 )
 
 func Test_GetRemovedAPIsOn1_22From(t *testing.T) {
@@ -280,20 +283,40 @@ func TestValidateDeprecatedAPIS(t *testing.T) {
 			require.Equal(t, tt.wantWarning, len(warnsResult) > 0)
 			if tt.wantWarning {
 				require.Equal(t, len(tt.warnStrings), len(warnsResult))
+				// testing against sorted strings to address flakiness on the order
+				// of APIs listed
+				sortedWarnStrings := sortStringSlice(tt.warnStrings)
 				for _, w := range warnsResult {
 					wString := w.Error()
-					require.Contains(t, tt.warnStrings, wString)
+					require.Contains(t, sortedWarnStrings, sortString(wString))
 				}
 			}
 
 			require.Equal(t, tt.wantError, len(errsResult) > 0)
 			if tt.wantError {
 				require.Equal(t, len(tt.errStrings), len(errsResult))
+				// testing against sorted strings to address flakiness on the order
+				// of APIs listed
+				sortedErrStrings := sortStringSlice(tt.errStrings)
 				for _, err := range errsResult {
-					errString := err.Error()
-					require.Contains(t, tt.errStrings, errString)
+					errString := sortString(err.Error())
+					require.Contains(t, sortedErrStrings, errString)
 				}
 			}
 		})
 	}
 }
+
+func sortString(str string) string {
+	split := strings.Split(str, "")
+	sort.Strings(split)
+	return strings.Join(split, "")
+}
+
+func sortStringSlice(slice []string) []string {
+	var newSlice []string
+	for _, str := range slice {
+		newSlice = append(newSlice, sortString(str))
+	}
+	return newSlice
+}