CLOUDP-315486: Update the foascli changelog command to generate the changelog for "upcoming" APIs

Author: andreaangiolillo

tools/cli/internal/changelog/changelog.go

@@ -19,6 +19,7 @@ import (
 	"fmt"
 	"log"
 	"os"
+	"strings"
 	"time"
 
 	"github.com/mongodb/openapi/tools/cli/internal/apiversion"
@@ -230,11 +231,6 @@ func NewEntriesBetweenRevisionVersions(revisionPath, exceptionFilePath string) (
 				continue
 			}
 
-			// Skip upcoming version. It will be included in CLOUDP-315486
-			if apiversion.IsUpcomingStabilityLevel(fromVersion) || apiversion.IsUpcomingStabilityLevel(toVersion) {
-				continue
-			}
-
 			entry, err := newEntriesBetweenVersion(revisionMetadata, fromVersion, toVersion, exceptionFilePath)
 			if err != nil {
 				return nil, err
@@ -389,6 +385,14 @@ func newBaseAndRevisionSpecs(baseMetadata, revisionMetadata *Metadata) (baseSpec
 		if err != nil {
 			return nil, nil, err
 		}
+
+		if strings.Contains(revisionMetadata.ActiveVersion, ".upcoming") {
+			// Upcoming API Spec contains only endpoints marked as "upcoming". We need to remove endpoints from
+			// the base spec that aren't present in the revision spec to avoid generating
+			// incorrect "endpoint deleted" changelog entries.
+			removePathsAndOperationsNotInRevision(baseSpec, revisionSpec)
+		}
+
 		baseSpec.Version = baseMetadata.ActiveVersion
 		revisionSpec.Version = revisionMetadata.ActiveVersion
 
@@ -412,6 +416,24 @@ func newBaseAndRevisionSpecs(baseMetadata, revisionMetadata *Metadata) (baseSpec
 	return baseSpec, revisionSpec, nil
 }
 
+// removePathsAndOperationsNotInRevision removes paths and operations not in the revision spec.
+func removePathsAndOperationsNotInRevision(baseSpec, revisionSpec *load.SpecInfo) {
+	pathsFromRevision := revisionSpec.Spec.Paths.Map()
+	for pathKeyFromBase, pathValueFromBase := range baseSpec.Spec.Paths.Map() {
+		if _, ok := pathsFromRevision[pathKeyFromBase]; !ok {
+			baseSpec.Spec.Paths.Delete(pathKeyFromBase)
+			continue
+		}
+
+		operationsFromRevision := pathsFromRevision[pathKeyFromBase].Operations()
+		for operationKeyFromBase := range pathValueFromBase.Operations() {
+			if _, ok := operationsFromRevision[operationKeyFromBase]; !ok {
+				delete(pathValueFromBase.Operations(), operationKeyFromBase)
+			}
+		}
+	}
+}
+
 func newOpeAPISpecFromPathAndVersion(path, version string) (*load.SpecInfo, error) {
 	loader := openapi.NewOpenAPI3().WithExcludedPrivatePaths()
 	return loader.CreateOpenAPISpecFromPath(fmt.Sprintf("%s/openapi-%s.json", path, version))

tools/cli/internal/changelog/merge.go

@@ -199,8 +199,8 @@ func (m *Changelog) newPathsFromDeprecatedChanges(
 	changes []*outputfilter.OasDiffEntry,
 	changelogPath *[]*Path,
 	conf map[string]*outputfilter.OperationConfigs) ([]*Path, error) {
-	depreactedChanges := m.newDeprecatedByNewerVersionOasDiffEntries(changes, conf)
-	return newMergedChanges(depreactedChanges, changeTypeDeprecated, m.BaseMetadata.ActiveVersion, changelogPath, conf)
+	deprecatedChanges := m.newDeprecatedByNewerVersionOasDiffEntries(changes, conf)
+	return newMergedChanges(deprecatedChanges, changeTypeDeprecated, m.BaseMetadata.ActiveVersion, changelogPath, conf)
 }
 
 func (m *Changelog) newOasDiffEntries() ([]*outputfilter.OasDiffEntry, error) {
@@ -252,18 +252,17 @@ func newMergedChanges(changes []*outputfilter.OasDiffEntry,
 
 	for _, change := range changes {
 		pathEntry := newPathEntry(changelogPath, change.Path, change.Operation)
-		operationdID := change.OperationID
+		operationID := change.OperationID
 
-		conf, ok := operationConfig[operationdID]
+		conf, ok := operationConfig[operationID]
 		if !ok {
-			return nil, fmt.Errorf("operation %s not found in operation config", operationdID)
+			return nil, fmt.Errorf("operation %s not found in operation config", operationID)
 		}
 
-		pathEntry.OperationID = operationdID
+		pathEntry.OperationID = operationID
 		pathEntry.Tag = conf.Tag()
 
 		pathEntryVersion := newEntryVersion(&pathEntry.Versions, version)
-		pathEntryVersion.StabilityLevel = stabilityLevelStable
 		pathEntryVersion.ChangeType = newChangeType(pathEntryVersion.ChangeType, changeType, change.ID)
 
 		versionChange := &Change{

tools/cli/test/e2e/cli/changelog_test.go

@@ -48,7 +48,7 @@ func TestChangelog(t *testing.T) {
 	t.Run("Generate Changelog with same API Version", func(t *testing.T) {
 		base := NewChangelogBasePathSameAPIVersion(t)
 		revision := NewChangelogRevisionPathSameAPIVersion(t)
-		exemptions := NewChangelogExepmtionFilePathSameAPIVersion(t)
+		exemptions := NewChangelogExemptionFilePathSameAPIVersion(t)
 		commandOut := getOutputFolder(t, "changelog")
 
 		cmd := exec.Command(cliPath,
@@ -74,7 +74,7 @@ func TestChangelog(t *testing.T) {
 	t.Run("Generate Changelog with new Preview API Version", func(t *testing.T) {
 		base := newChangelogBasePathNewPreviewAPIVersion(t)
 		revision := newChangelogRevisionPathNewPreviewAPIVersion(t)
-		exemptions := newChangelogExepmtionFilePathNewPreviewAPIVersion(t)
+		exemptions := newChangelogExemptionFilePathNewPreviewAPIVersion(t)
 		commandOut := getOutputFolder(t, "changelog")
 
 		cmd := exec.Command(cliPath,

tools/cli/test/e2e/cli/cli.go

@@ -73,7 +73,7 @@ func NewChangelogRevisionPathSameAPIVersion(t *testing.T) string {
 	return cliPath
 }
 
-func NewChangelogExepmtionFilePathSameAPIVersion(t *testing.T) string {
+func NewChangelogExemptionFilePathSameAPIVersion(t *testing.T) string {
 	t.Helper()
 	cliPath, err := filepath.Abs("../../data/changelog/same-api-version/exemptions.yaml")
 	require.NoError(t, err)
@@ -108,7 +108,7 @@ func newChangelogRevisionPathNewPreviewAPIVersion(t *testing.T) string {
 	return cliPath
 }
 
-func newChangelogExepmtionFilePathNewPreviewAPIVersion(t *testing.T) string {
+func newChangelogExemptionFilePathNewPreviewAPIVersion(t *testing.T) string {
 	t.Helper()
 	cliPath, err := filepath.Abs("../../data/changelog/new-api-preview-version/exemptions.yaml")
 	require.NoError(t, err)