UpdatE

Author: blva

tools/cli/internal/cli/filter/filter.go

@@ -16,7 +16,10 @@ package filter
 
 import (
 	"fmt"
+	"log"
 
+	"github.com/getkin/kin-openapi/openapi3"
+	"github.com/mongodb/openapi/tools/cli/internal/apiversion"
 	"github.com/mongodb/openapi/tools/cli/internal/cli/flag"
 	"github.com/mongodb/openapi/tools/cli/internal/cli/usage"
 	"github.com/mongodb/openapi/tools/cli/internal/openapi"
@@ -41,20 +44,33 @@ func (o *Opts) Run() error {
 		return err
 	}
 
+	var filteredOAS *openapi3.T
 	// If a version is provided, versioning filters will also be applied.
-	filters := filter.FiltersWithoutVersioning
 	if o.version != "" {
-		filters = filter.DefaultFilters
+		filteredOAS, err = FilterForVersion(specInfo.Spec, o.version, o.env)
+	} else {
+		filters := filter.FiltersWithoutVersioning
+		metadata := filter.NewMetadata(nil, o.env)
+		filteredOAS, err = filter.ApplyFilters(specInfo.Spec, metadata, filters)
 	}
 
-	filteredOAS, err := filter.ApplyFilters(specInfo.Spec, filter.NewMetadata(nil, o.env), filters)
 	if err != nil {
 		return err
 	}
 
 	return openapi.Save(o.outputPath, filteredOAS, o.format, o.fs)
 }
 
+func FilterForVersion(oas *openapi3.T, version string, env string) (result *openapi3.T, err error) {
+	log.Printf("Filtering OpenAPI document by version %q", version)
+	apiVersion, err := apiversion.New(apiversion.WithVersion(version))
+	if err != nil {
+		return nil, err
+	}
+
+	return filter.ApplyFilters(oas, filter.NewMetadata(apiVersion, env), filter.DefaultFilters)
+}
+
 func (o *Opts) PreRunE(_ []string) error {
 	if o.basePath == "" {
 		return fmt.Errorf("no OAS detected. Please, use the flag %s to include the base OAS", flag.Base)

tools/cli/internal/cli/filter/filter_test.go

@@ -27,6 +27,7 @@ import (
 
 func TestSuccessfulFilter_Run(t *testing.T) {
 	fs := afero.NewMemMapFs()
+	t.Parallel()
 
 	opts := &Opts{
 		basePath:   "../../../test/data/base_spec.json",
@@ -42,16 +43,39 @@ func TestSuccessfulFilter_Run(t *testing.T) {
 	newSpec, err := loadRunResultOas(fs, opts.outputPath)
 	require.NoError(t, err)
 
-	// // check all paths are kept
+	// check all paths are kept
 	for _, pathItem := range newSpec.Spec.Paths.Map() {
-		// method
 		for _, operation := range pathItem.Operations() {
-			// check extension is removed
+			// check extensions are removed at the operation level
 			require.Nil(t, operation.Extensions)
 		}
 	}
 }
 
+func TestSuccessfulFilterWithVersion_Run(t *testing.T) {
+	fs := afero.NewMemMapFs()
+	t.Parallel()
+
+	opts := &Opts{
+		basePath:   "../../../test/data/base_spec.json",
+		outputPath: "filtered-oas.yaml",
+		fs:         fs,
+		env:        "dev",
+		version:    "2023-01-01",
+	}
+
+	if err := opts.Run(); err != nil {
+		t.Fatalf("Run() unexpected error: %v", err)
+	}
+
+	s, err := loadRunResultOas(fs, opts.outputPath)
+	require.NoError(t, err)
+	// assert /api/atlas/v2/groups/{groupId}:migrate does not exist in filtered spec as it is from a newer version
+	paths := s.Spec.Paths.Map()
+	require.Contains(t, paths, "/api/atlas/v2/groups")
+	require.NotContains(t, paths, "/api/atlas/v2/groups/{groupId}:migrate")
+}
+
 func TestOpts_PreRunE(t *testing.T) {
 	testCases := []struct {
 		wantErr  require.ErrorAssertionFunc

tools/cli/internal/cli/split/split.go

@@ -20,11 +20,10 @@ import (
 	"strings"
 
 	"github.com/getkin/kin-openapi/openapi3"
-	"github.com/mongodb/openapi/tools/cli/internal/apiversion"
+	"github.com/mongodb/openapi/tools/cli/internal/cli/filter"
 	"github.com/mongodb/openapi/tools/cli/internal/cli/flag"
 	"github.com/mongodb/openapi/tools/cli/internal/cli/usage"
 	"github.com/mongodb/openapi/tools/cli/internal/openapi"
-	"github.com/mongodb/openapi/tools/cli/internal/openapi/filter"
 	"github.com/spf13/afero"
 	"github.com/spf13/cobra"
 )
@@ -51,7 +50,7 @@ func (o *Opts) Run() error {
 	}
 
 	for _, version := range versions {
-		filteredOAS, err := o.filter(specInfo.Spec, version)
+		filteredOAS, err := filter.FilterForVersion(specInfo.Spec, version, o.env)
 		if err != nil {
 			return err
 		}
@@ -74,16 +73,6 @@ func (o *Opts) Run() error {
 	return nil
 }
 
-func (o *Opts) filter(oas *openapi3.T, version string) (result *openapi3.T, err error) {
-	log.Printf("Filtering OpenAPI document by version %q", version)
-	apiVersion, err := apiversion.New(apiversion.WithVersion(version))
-	if err != nil {
-		return nil, err
-	}
-
-	return filter.ApplyFilters(oas, filter.NewMetadata(apiVersion, o.env), filter.DefaultFilters)
-}
-
 func (o *Opts) saveVersionedOas(oas *openapi3.T, version string) error {
 	path := o.basePath
 	if o.outputPath != "" {