CLOUDP-277336: update endpoint removed change entries to include the sunset date

Author: andreaangiolillo

tools/cli/internal/changelog/changelog.go

@@ -463,6 +463,7 @@ func findChangelogEntry(changelog []*Entry, date, operationID, version, changeCo
 
 					for _, change := range v.Changes {
 						if change.Code == changeCode {
+
 							return change
 						}
 					}

tools/cli/internal/changelog/outputfilter/squash.go

@@ -158,12 +158,12 @@ func squashEntries(entries []*OasDiffEntry) ([]*OasDiffEntry, error) {
 		}
 	}
 
-	squashedEntriesNotHidden, err := appplySquashHandlerToMap(squashHandlers, entriesByIDandOperationID)
+	squashedEntriesNotHidden, err := applySquashHandlerToMap(squashHandlers, entriesByIDandOperationID)
 	if err != nil {
 		return nil, err
 	}
 
-	squashedEntriesHidden, err := appplySquashHandlerToMap(squashHandlers, hiddenEntriesByIDandOperationID)
+	squashedEntriesHidden, err := applySquashHandlerToMap(squashHandlers, hiddenEntriesByIDandOperationID)
 	if err != nil {
 		return nil, err
 	}
@@ -174,7 +174,7 @@ func squashEntries(entries []*OasDiffEntry) ([]*OasDiffEntry, error) {
 	return squashedEntries, nil
 }
 
-func appplySquashHandlerToMap(squashHandlers []handler, entriesMap map[string]map[string][]*OasDiffEntry) ([]*OasDiffEntry, error) {
+func applySquashHandlerToMap(squashHandlers []handler, entriesMap map[string]map[string][]*OasDiffEntry) ([]*OasDiffEntry, error) {
 	squashedEntries := []*OasDiffEntry{}
 	for _, handler := range squashHandlers {
 		entryMapPerOperationID, ok := entriesMap[handler.id]
@@ -209,7 +209,7 @@ func findHandler(id string) (*handler, bool) {
 	return nil, false
 }
 
-type squashedEntries struct {
+type valuesToSquashStruct struct {
 	valuesNotSquashed []string
 	valuesToSquash    map[string]struct{}
 }
@@ -304,13 +304,13 @@ func replaceOnlyFirstOccurrence(template, valuesToAddToTemplate string) string {
 	})
 }
 
-func newSquashMap(operation string, entries []*OasDiffEntry, expectedNumberOfValues, squashIdx int) (map[string]squashedEntries, error) {
+func newSquashMap(operation string, entries []*OasDiffEntry, expectedNumberOfValues, squashIdx int) (map[string]valuesToSquashStruct, error) {
 	// 	squash_map is a dictionary where:
 	//      The key is a string generated by concatenating values extracted from each entry, excluding the one at squash_idx (the index to be squashed).
 	//      The value is a tuple:
 	//		- The first element is a list of the values that are not squashed. Example: [regionName, 200]
 	// 		- The second element is a set of values that should be squashed. Example: ("GLOBAL_EVENT_ADMIN", "ORG_MEMBER")
-	squashMap := map[string]squashedEntries{}
+	squashMap := map[string]valuesToSquashStruct{}
 
 	for _, entry := range entries {
 		values, err := extractExactValuesOrFail(operation, entry, expectedNumberOfValues)
@@ -322,7 +322,7 @@ func newSquashMap(operation string, entries []*OasDiffEntry, expectedNumberOfVal
 
 		mergedKey := strings.Join(values, "|")
 		if _, exists := squashMap[mergedKey]; !exists {
-			squashMap[mergedKey] = squashedEntries{
+			squashMap[mergedKey] = valuesToSquashStruct{
 				valuesNotSquashed: values,
 				valuesToSquash:    make(map[string]struct{}),
 			}

tools/cli/internal/changelog/outputfilter/squash_test.go

@@ -235,7 +235,7 @@ func TestNewSquashMap(t *testing.T) {
 		entries                []*OasDiffEntry
 		expectedNumberOfValues int
 		squashIdx              int
-		want                   map[string]squashedEntries
+		want                   map[string]valuesToSquashStruct
 		wantErr                require.ErrorAssertionFunc
 	}{
 		{
@@ -244,7 +244,7 @@ func TestNewSquashMap(t *testing.T) {
 			entries:                []*OasDiffEntry{},
 			expectedNumberOfValues: 0,
 			squashIdx:              0,
-			want:                   map[string]squashedEntries{},
+			want:                   map[string]valuesToSquashStruct{},
 			wantErr:                require.NoError,
 		},
 		{
@@ -255,7 +255,7 @@ func TestNewSquashMap(t *testing.T) {
 			},
 			expectedNumberOfValues: 1,
 			squashIdx:              0,
-			want: map[string]squashedEntries{
+			want: map[string]valuesToSquashStruct{
 				"": {
 					valuesNotSquashed: []string{""},
 					valuesToSquash:    map[string]struct{}{"test": {}},
@@ -273,7 +273,7 @@ func TestNewSquashMap(t *testing.T) {
 			},
 			expectedNumberOfValues: 1,
 			squashIdx:              0,
-			want: map[string]squashedEntries{
+			want: map[string]valuesToSquashStruct{
 				"": {
 					valuesNotSquashed: []string{""},
 					valuesToSquash:    map[string]struct{}{"test1": {}, "test2": {}, "test3": {}},

tools/cli/internal/changelog/sunset.go

@@ -48,7 +48,7 @@ func (m *Changelog) newOasDiffEntriesFromSunsetEndpoints(
 			changes = append(changes, &outputfilter.OasDiffEntry{
 				Date:        config.Revision.Sunset,
 				ID:          endpointRemovedCode,
-				Text:        "endpoint removed",
+				Text:        fmt.Sprintf("endpoint removed as it has reached its sunset date '%s'", config.Revision.Sunset),
 				Level:       int(checker.ERR),
 				Operation:   config.Revision.HTTPMethod,
 				OperationID: operationID,

tools/cli/internal/changelog/sunset_test.go

@@ -126,7 +126,7 @@ func TestNewOasDiffEntriesFromSunsetEndpoints(t *testing.T) {
 			Operation:   "GET",
 			OperationID: "listStreamInstances",
 			Path:        "/api/atlas/v2/groups/{id}/streams",
-			Text:        "endpoint removed",
+			Text:        "endpoint removed as it has reached its sunset date '2023-07-12'",
 		},
 	}