fix snapshots for api-generation (#3932)

Author: jeroenvervaeke

tools/cmd/api-generator/convert_commands.go

@@ -32,12 +32,12 @@ var (
 	versionRegex = regexp.MustCompile(`^application/vnd\.atlas\.(?P<version>\d{4}-\d{2}-\d{2}|preview|upcoming)\+(?P<contentType>[\w]+)$`)
 )
 
-func specToCommands(spec *openapi3.T) (api.GroupedAndSortedCommands, error) {
+func specToCommands(now time.Time, spec *openapi3.T) (api.GroupedAndSortedCommands, error) {
 	groups := make(map[string]*api.Group, 0)
 
 	for path, item := range spec.Paths.Map() {
 		for verb, operation := range item.Operations() {
-			command, err := operationToCommand(path, verb, operation)
+			command, err := operationToCommand(now, path, verb, operation)
 			if err != nil {
 				return nil, fmt.Errorf("failed to convert operation to command: %w", err)
 			}
@@ -134,7 +134,7 @@ func extractExtensionsFromOperation(operation *openapi3.Operation) operationExte
 	return ext
 }
 
-func operationToCommand(path, verb string, operation *openapi3.Operation) (*api.Command, error) {
+func operationToCommand(now time.Time, path, verb string, operation *openapi3.Operation) (*api.Command, error) {
 	extensions := extractExtensionsFromOperation(operation)
 	if extensions.skip {
 		return nil, nil
@@ -153,7 +153,7 @@ func operationToCommand(path, verb string, operation *openapi3.Operation) (*api.
 		return nil, err
 	}
 
-	versions, err := buildVersions(operation)
+	versions, err := buildVersions(now, operation)
 	if err != nil {
 		return nil, err
 	}
@@ -366,7 +366,7 @@ func extractParameters(parameters openapi3.Parameters) (parameterSet, error) {
 }
 
 // Build versions from responses and request body.
-func buildVersions(operation *openapi3.Operation) ([]api.Version, error) {
+func buildVersions(now time.Time, operation *openapi3.Operation) ([]api.Version, error) {
 	versionsMap := make(map[string]*api.Version)
 
 	if err := processResponses(operation.Responses, versionsMap); err != nil {
@@ -379,7 +379,7 @@ func buildVersions(operation *openapi3.Operation) ([]api.Version, error) {
 
 	// filter sunsetted versions
 	for key, version := range versionsMap {
-		if version.Sunset != nil && time.Now().After(*version.Sunset) {
+		if version.Sunset != nil && now.After(*version.Sunset) {
 			delete(versionsMap, key)
 		}
 	}

tools/cmd/api-generator/main.go

@@ -29,6 +29,7 @@ import (
 	"time"
 
 	"github.com/getkin/kin-openapi/openapi3"
+	"github.com/mongodb/mongodb-atlas-cli/atlascli/tools/internal/metadatatypes"
 	"github.com/spf13/cobra"
 )
 
@@ -91,25 +92,29 @@ func run(ctx context.Context, specPath string, outputType OutputType, w io.Write
 		defer specFile.Close()
 	}
 
+	now := time.Now()
+
 	switch outputType {
 	case Commands:
-		return convertSpecToAPICommands(ctx, spec, w)
+		return convertSpecToAPICommands(ctx, now, spec, w)
 	case Metadata:
-		return convertSpecToMetadata(ctx, spec, w)
+		return convertSpecToMetadata(ctx, now, spec, w)
 	default:
 		return fmt.Errorf("'%s' is not a valid outputType", outputType)
 	}
 }
 
-func convertSpecToAPICommands(ctx context.Context, r io.Reader, w io.Writer) error {
-	return convertSpec(ctx, r, w, specToCommands, commandsTemplateContent)
+func convertSpecToAPICommands(ctx context.Context, now time.Time, r io.Reader, w io.Writer) error {
+	return convertSpec(ctx, now, r, w, specToCommands, commandsTemplateContent)
 }
 
-func convertSpecToMetadata(ctx context.Context, r io.Reader, w io.Writer) error {
-	return convertSpec(ctx, r, w, specToMetadata, metadataTemplateContent)
+func convertSpecToMetadata(ctx context.Context, now time.Time, r io.Reader, w io.Writer) error {
+	return convertSpec(ctx, now, r, w, func(_ time.Time, spec *openapi3.T) (metadatatypes.Metadata, error) {
+		return specToMetadata(spec)
+	}, metadataTemplateContent)
 }
 
-func convertSpec[T any](ctx context.Context, r io.Reader, w io.Writer, mapper func(spec *openapi3.T) (T, error), templateContent string) error {
+func convertSpec[T any](ctx context.Context, now time.Time, r io.Reader, w io.Writer, mapper func(now time.Time, spec *openapi3.T) (T, error), templateContent string) error {
 	spec, err := loadSpec(r)
 	if err != nil {
 		return fmt.Errorf("failed to load spec, error: %w", err)
@@ -121,7 +126,7 @@ func convertSpec[T any](ctx context.Context, r io.Reader, w io.Writer, mapper fu
 		}
 	}
 
-	commands, err := mapper(spec)
+	commands, err := mapper(now, spec)
 	if err != nil {
 		return fmt.Errorf("failed convert spec to api commands: %w", err)
 	}

tools/cmd/api-generator/main_test.go

@@ -22,16 +22,18 @@ import (
 	"os"
 	"path/filepath"
 	"testing"
+	"time"
 
 	"github.com/bradleyjkemp/cupaloy/v2"
 )
 
 func testSpec(t *testing.T, name, specPath string) {
 	t.Helper()
 
+	snapshotTime := time.Date(2025, time.May, 1, 0, 0, 0, 0, time.UTC)
 	snapshotter := cupaloy.New(cupaloy.SnapshotSubdirectory("testdata/.snapshots"), cupaloy.SnapshotFileExtension(".snapshot"))
 
-	outputFunctions := map[OutputType]func(ctx context.Context, r io.Reader, w io.Writer) error{
+	outputFunctions := map[OutputType]func(ctx context.Context, now time.Time, r io.Reader, w io.Writer) error{
 		Commands: convertSpecToAPICommands,
 		Metadata: convertSpecToMetadata,
 	}
@@ -46,7 +48,7 @@ func testSpec(t *testing.T, name, specPath string) {
 		})
 
 		buf := &bytes.Buffer{}
-		if err := outputTypeFunc(t.Context(), specFile, buf); err != nil {
+		if err := outputTypeFunc(t.Context(), snapshotTime, specFile, buf); err != nil {
 			t.Fatalf("failed to convert spec into %s, error: %s", outputType, err)
 		}