CLOUDP-311374: Update foascli version to list 'upcoming' apis

Author: andreaangiolillo

tools/cli/internal/apiversion/stabilitylevel.go

@@ -22,6 +22,7 @@ import (
 const (
 	StableStabilityLevel         = "stable"
 	PreviewStabilityLevel        = "preview"
+	UpcomingStabilityLevel       = "upcoming"
 	PrivatePreviewStabilityLevel = "private-preview"
 	PublicPreviewStabilityLevel  = "public-preview"
 )
@@ -30,7 +31,8 @@ var supportedValues = []string{StableStabilityLevel, PublicPreviewStabilityLevel
 
 // IsPreviewStabilityLevel checks if the version is a preview version, public or private.
 func IsPreviewStabilityLevel(value string) bool {
-	return IsPrivatePreviewStabilityLevel(value) || IsPublicPreviewStabilityLevel(value)
+	lowerCaseValue := strings.ToLower(value)
+	return IsPrivatePreviewStabilityLevel(lowerCaseValue) || IsPublicPreviewStabilityLevel(lowerCaseValue)
 }
 
 // IsPrivatePreviewStabilityLevel checks if the version is a private preview version.
@@ -40,18 +42,24 @@ func IsPrivatePreviewStabilityLevel(value string) bool {
 
 // IsPublicPreviewStabilityLevel checks if the version is a public preview version.
 func IsPublicPreviewStabilityLevel(value string) bool {
-	return strings.EqualFold(value, PublicPreviewStabilityLevel) || strings.EqualFold(value, PreviewStabilityLevel)
+	lowerCaseValue := strings.ToLower(value)
+	return strings.EqualFold(lowerCaseValue, PublicPreviewStabilityLevel) || strings.EqualFold(lowerCaseValue, PreviewStabilityLevel)
 }
 
 // IsStableStabilityLevel checks if the version is a stable version.
 func IsStableStabilityLevel(value string) bool {
-	return strings.EqualFold(value, StableStabilityLevel)
+	return strings.EqualFold(strings.ToLower(value), StableStabilityLevel)
+}
+
+// IsUpcomingStabilityLevel checks if the version is an "upcoming" version.
+func IsUpcomingStabilityLevel(value string) bool {
+	return strings.Contains(strings.ToLower(value), UpcomingStabilityLevel)
 }
 
-// IsValidStabilityLevel checks if the version is a valid stability level.
 // ValidateStabilityLevel checks if the version is a valid stability level.
 func ValidateStabilityLevel(value string) error {
-	if IsStableStabilityLevel(value) || IsPreviewStabilityLevel(value) {
+	lowerCaseValue := strings.ToLower(value)
+	if IsStableStabilityLevel(lowerCaseValue) || IsPreviewStabilityLevel(lowerCaseValue) {
 		return nil
 	}
 

tools/cli/internal/apiversion/version.go

@@ -36,7 +36,12 @@ const (
 	previewDate = "3000-01-01"
 )
 
-var contentPattern = regexp.MustCompile(`application/vnd\.atlas\.((\d{4})-(\d{2})-(\d{2})|preview)\+(.+)`)
+// This regex will match:
+//  1. application/vnd.atlas.2025-01-01.json
+//  2. application/vnd.atlas.preview.json
+//  3. application/vnd.atlas.2025-01-01.upcoming.json
+//  4. application/vnd.atlas.2025-01-01.upcoming.yaml
+var contentPattern = regexp.MustCompile(`application/vnd\.atlas\.((\d{4})-(\d{2})-(\d{2})(\.upcoming)?|preview)\+(.+)`)
 
 // Option is a function that sets a value on the APIVersion.
 type Option func(v *APIVersion) error

tools/cli/internal/cli/versions/versions.go

@@ -88,6 +88,10 @@ func (o *Opts) filterStabilityLevelVersions(apiVersions []string) []string {
 			if (apiversion.IsPublicPreviewStabilityLevel(stabilityLevel)) && apiversion.IsPublicPreviewStabilityLevel(v) {
 				out = append(out, v)
 			}
+
+			if apiversion.IsUpcomingStabilityLevel(stabilityLevel) && apiversion.IsUpcomingStabilityLevel(v) {
+				out = append(out, v)
+			}
 		}
 	}
 
@@ -145,7 +149,7 @@ func (o *Opts) PreRunE(_ []string) error {
 }
 
 // Builder builds the versions command with the following signature:
-// versions -s oas --env dev|qa|staging|prod -stability-level STABLE|PREVIEW.
+// versions -s oas --env dev|qa|staging|prod -stability-level STABLE|UPCOMING|PREVIEW.
 func Builder() *cobra.Command {
 	opts := &Opts{
 		fs: afero.NewOsFs(),

tools/cli/internal/openapi/filter/info.go

@@ -11,6 +11,7 @@
 // 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 filter
 
 import (

tools/cli/internal/openapi/versions.go

@@ -16,7 +16,9 @@ package openapi
 
 import (
 	"fmt"
+	"log"
 	"sort"
+	"strings"
 
 	"github.com/getkin/kin-openapi/openapi3"
 	"github.com/mongodb/openapi/tools/cli/internal/apiversion"
@@ -75,7 +77,34 @@ func extractVersions(oas *openapi3.T) ([]string, error) {
 		}
 	}
 
-	return mapKeysToSortedSlice(versions), nil
+	return mapKeysToSortedSlice(filterUpcomingVersions(versions)), nil
+}
+
+// filterUpcomingVersions removes the "YYYY.MM.DD.upcoming" apis version if the
+// related stable api YYYY.MM.DD is available.
+func filterUpcomingVersions(apiVersions map[string]struct{}) map[string]struct{} {
+	apiVersionSet := make(map[string]struct{}, len(apiVersions))
+	upcomingVersions := make([]string, 0, len(apiVersions))
+
+	for v := range apiVersions {
+		if apiversion.IsUpcomingStabilityLevel(strings.ToLower(v)) {
+			upcomingVersions = append(upcomingVersions, v)
+			continue
+		}
+		apiVersionSet[v] = struct{}{}
+	}
+
+	for _, upcomingVersion := range upcomingVersions {
+		date := strings.ReplaceAll(upcomingVersion, ".upcoming", "")
+		if _, ok := apiVersionSet[date]; !ok {
+			apiVersionSet[upcomingVersion] = struct{}{}
+		} else {
+			log.Printf("The API Version %[1]q was removed as the Stable API Version %[2]q was detected."+
+				" Please, remove %[1]q from the OpenAPI Spec.\n", upcomingVersion, date)
+		}
+	}
+
+	return apiVersionSet
 }
 
 // mapKeysToSortedSlice converts map keys to a sorted slice.

tools/cli/internal/openapi/versions_test.go

@@ -39,6 +39,18 @@ func TestVersions_PublicPreview(t *testing.T) {
 	assert.Equal(t, []string{"2023-01-01", "2023-02-01", "preview"}, versions)
 }
 
+func TestVersions_UpcomingAPI(t *testing.T) {
+	versions, err := ExtractVersionsWithEnv(NewVersionedResponsesWithUpcoming(t), "")
+	require.NoError(t, err)
+	assert.Equal(t, []string{"2023-01-01", "2025-09-22.upcoming"}, versions)
+}
+
+func TestVersions_UpcomingAndStableAPI(t *testing.T) {
+	versions, err := ExtractVersionsWithEnv(NewVersionedResponsesWithUpcomingAndStable(t), "")
+	require.NoError(t, err)
+	assert.Equal(t, []string{"2023-01-01", "2025-09-22"}, versions)
+}
+
 func TestVersions_InvalidPreviewData(t *testing.T) {
 	r := NewVersionedResponses(t)
 	// override the extension so something invalid like "public": true
@@ -194,3 +206,80 @@ func NewVersionedResponses(t *testing.T) *openapi3.T {
 
 	return oas
 }
+
+func NewVersionedResponsesWithUpcoming(t *testing.T) *openapi3.T {
+	t.Helper()
+	inputPath := &openapi3.Paths{}
+
+	extension := map[string]any{
+		"x-xgen-version": "2023-01-01",
+	}
+	response := &openapi3.ResponseRef{
+		Value: &openapi3.Response{
+			Extensions: extension,
+			Content: map[string]*openapi3.MediaType{
+				"application/vnd.atlas.2023-01-01+json":          {},
+				"application/vnd.atlas.2025-09-22.upcoming+json": {},
+			},
+		},
+	}
+
+	responses := &openapi3.Responses{}
+	responses.Set("200", response)
+
+	inputPath.Set("pathBase1", &openapi3.PathItem{
+		Extensions:  nil,
+		Ref:         "",
+		Summary:     "pathBase1",
+		Description: "pathBase1Description",
+		Get: &openapi3.Operation{
+			Tags:      []string{"tag1"},
+			Responses: responses,
+		},
+	})
+
+	oas := &openapi3.T{
+		Paths: inputPath,
+	}
+
+	return oas
+}
+
+func NewVersionedResponsesWithUpcomingAndStable(t *testing.T) *openapi3.T {
+	t.Helper()
+	inputPath := &openapi3.Paths{}
+
+	extension := map[string]any{
+		"x-xgen-version": "2023-01-01",
+	}
+	response := &openapi3.ResponseRef{
+		Value: &openapi3.Response{
+			Extensions: extension,
+			Content: map[string]*openapi3.MediaType{
+				"application/vnd.atlas.2023-01-01+json":          {},
+				"application/vnd.atlas.2025-09-22.upcoming+json": {},
+				"application/vnd.atlas.2025-09-22+json":          {},
+			},
+		},
+	}
+
+	responses := &openapi3.Responses{}
+	responses.Set("200", response)
+
+	inputPath.Set("pathBase1", &openapi3.PathItem{
+		Extensions:  nil,
+		Ref:         "",
+		Summary:     "pathBase1",
+		Description: "pathBase1Description",
+		Get: &openapi3.Operation{
+			Tags:      []string{"tag1"},
+			Responses: responses,
+		},
+	})
+
+	oas := &openapi3.T{
+		Paths: inputPath,
+	}
+
+	return oas
+}