Update

Author: blva

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

@@ -16,10 +16,7 @@ package filter
 
 import (
 	"fmt"
-	"log"
-	"strings"
 
-	"github.com/getkin/kin-openapi/openapi3"
 	"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"
@@ -44,37 +41,20 @@ func (o *Opts) Run() error {
 		return err
 	}
 
-	filteredOAS, err := o.filter(specInfo.Spec)
+	filteredOAS, err := filter.ApplyFilters(specInfo.Spec, filter.NewMetadata(nil, o.env), filter.FiltersWithoutVersioning)
 	if err != nil {
 		return err
 	}
 
 	return openapi.Save(o.outputPath, filteredOAS, o.format, o.fs)
 }
 
-func (o *Opts) filter(oas *openapi3.T) (result *openapi3.T, err error) {
-	log.Printf("Filtering OpenAPI document")
-	return filter.ApplyFilters(oas, filter.NewMetadata(nil, o.env), filter.FiltersWithoutVersioning)
-}
-
 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)
 	}
 
-	if o.outputPath != "" && !strings.Contains(o.outputPath, openapi.DotJSON) && !strings.Contains(o.outputPath, openapi.DotYAML) {
-		return fmt.Errorf("output file must be either a JSON or YAML file, got %s", o.outputPath)
-	}
-
-	if o.format != openapi.JSON && o.format != openapi.YAML {
-		return fmt.Errorf("output format must be either 'json' or 'yaml', got %s", o.format)
-	}
-
-	if strings.Contains(o.basePath, openapi.DotYAML) {
-		o.format = openapi.YAML
-	}
-
-	return nil
+	return openapi.ValidateFormatAndOutput(o.format, o.outputPath)
 }
 
 // Builder builds the filter command with the following signature:

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

@@ -25,21 +25,9 @@ import (
 	"github.com/tufin/oasdiff/load"
 )
 
-func TestSuccessfulfilter_Run(t *testing.T) {
+func TestSuccessfulFilter_Run(t *testing.T) {
 	fs := afero.NewMemMapFs()
-	opts := &Opts{
-		basePath:   "../../../test/data/base_spec.json",
-		outputPath: "foas.yaml",
-		fs:         fs,
-	}
-
-	if err := opts.Run(); err != nil {
-		t.Fatalf("Run() unexpected error: %v", err)
-	}
-}
 
-func TestFilterMulitplePreviewsRun(t *testing.T) {
-	fs := afero.NewMemMapFs()
 	opts := &Opts{
 		basePath:   "../../../test/data/base_spec.json",
 		outputPath: "filtered-oas.yaml",
@@ -51,12 +39,17 @@ func TestFilterMulitplePreviewsRun(t *testing.T) {
 		t.Fatalf("Run() unexpected error: %v", err)
 	}
 
-	// private preview feature 1
-	info, err := loadRunResultOas(fs, "filtered-oas.yaml")
+	newSpec, err := loadRunResultOas(fs, opts.outputPath)
 	require.NoError(t, err)
 
-	// check all paths are kept
-	require.Len(t, info.Spec.Paths.Map(), 231)
+	// // check all paths are kept
+	for _, pathItem := range newSpec.Spec.Paths.Map() {
+		// method
+		for _, operation := range pathItem.Operations() {
+			// check extension is removed
+			require.Nil(t, operation.Extensions)
+		}
+	}
 }
 
 func TestOpts_PreRunE(t *testing.T) {
@@ -96,13 +89,14 @@ func TestInvalidFormat_PreRun(t *testing.T) {
 
 	err := opts.PreRunE(nil)
 	require.Error(t, err)
-	require.EqualError(t, err, "output format must be either 'json' or 'yaml', got html")
+	require.EqualError(t, err, "format must be either 'json', 'yaml' or 'all', got 'html'")
 }
 
 func TestInvalidPath_PreRun(t *testing.T) {
 	opts := &Opts{
 		outputPath: "foas.html",
 		basePath:   "base.json",
+		format:     "all",
 	}
 
 	err := opts.PreRunE(nil)

tools/cli/internal/cli/merge/merge.go

@@ -17,7 +17,6 @@ package merge
 import (
 	"encoding/json"
 	"fmt"
-	"strings"
 
 	"github.com/mongodb/openapi/tools/cli/internal/cli/flag"
 	"github.com/mongodb/openapi/tools/cli/internal/cli/usage"
@@ -71,11 +70,7 @@ func (o *Opts) PreRunE(_ []string) error {
 		return fmt.Errorf("no external OAS detected. Please, use the flag %s to include at least one OAS", flag.External)
 	}
 
-	if o.outputPath != "" && !strings.Contains(o.outputPath, ".json") && !strings.Contains(o.outputPath, ".yaml") {
-		return fmt.Errorf("output file must be either a JSON or YAML file, got %s", o.outputPath)
-	}
-
-	if err := openapi.ValidateFormat(o.format); err != nil {
+	if err := openapi.ValidateFormatAndOutput(o.format, o.outputPath); err != nil {
 		return err
 	}
 

tools/cli/internal/cli/merge/merge_test.go

@@ -159,6 +159,7 @@ func TestInvalidPath_PreRun(t *testing.T) {
 		outputPath:    "foas.html",
 		externalPaths: externalPaths,
 		basePath:      "base.json",
+		format:        "json",
 	}
 
 	err := opts.PreRunE(nil)

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

@@ -109,11 +109,7 @@ func (o *Opts) PreRunE(_ []string) error {
 		return fmt.Errorf("no OAS detected. Please, use the flag %s to include the base OAS", flag.Base)
 	}
 
-	if o.outputPath != "" && !strings.Contains(o.outputPath, openapi.DotJSON) && !strings.Contains(o.outputPath, openapi.DotYAML) {
-		return fmt.Errorf("output file must be either a JSON or YAML file, got %s", o.outputPath)
-	}
-
-	return openapi.ValidateFormat(o.format)
+	return openapi.ValidateFormatAndOutput(o.format, o.outputPath)
 }
 
 // Builder builds the split command with the following signature:

tools/cli/internal/openapi/file.go

@@ -131,11 +131,27 @@ func Save(path string, oas *openapi3.T, format string, fs afero.Fs) error {
 	return SaveToFile(path, format, newSpec(oas), fs)
 }
 
-// ValidateFormat validates the format of files supported.
-func ValidateFormat(format string) error {
+// ValidateFormatAndOutput validates the format and output file match.
+func ValidateFormatAndOutput(format, output string) error {
 	if format != JSON && format != YAML && format != ALL {
 		return fmt.Errorf("format must be either 'json', 'yaml' or 'all', got '%s'", format)
 	}
 
+	if output != "" && !strings.Contains(output, DotJSON) && !strings.Contains(output, DotYAML) {
+		return fmt.Errorf("output file must be either a JSON or YAML file, got %s", output)
+	}
+
+	if format == ALL || output == "" {
+		return nil
+	}
+
+	if format == JSON && !strings.Contains(output, DotJSON) {
+		return fmt.Errorf("output file and format mistmatch got format '%s' and output '%s'", format, output)
+	}
+
+	if format == YAML && !strings.Contains(output, DotYAML) {
+		return fmt.Errorf("output file and format mistmatch got format '%s' and output '%s'", format, output)
+	}
+
 	return nil
 }

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

@@ -120,7 +120,7 @@ func TestFiltersWithoutVersioning(t *testing.T) {
 	metadata := &Metadata{}
 	filters := FiltersWithoutVersioning(doc, metadata)
 
-	assert.Len(t, filters, 5)
+	assert.Len(t, filters, 4)
 }
 
 func TestFiltersToGetVersions(t *testing.T) {

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

@@ -17,7 +17,7 @@ import (
 	"github.com/getkin/kin-openapi/openapi3"
 )
 
-// OperationsFilter: is a filter that removes the x-xgen-owner-team extension from operations.
+// OperationsFilter: is a filter that removes the x-xgen-owner-team and x-xgen-changelog extension from operations.
 type OperationsFilter struct {
 	oas *openapi3.T
 }
@@ -35,6 +35,7 @@ func (f *OperationsFilter) Apply() error {
 		for _, operation := range pathItem.Operations() {
 			if operation.Extensions != nil {
 				delete(operation.Extensions, "x-xgen-owner-team")
+				delete(operation.Extensions, "x-xgen-changelog")
 			}
 		}
 	}