Skip to content

Commit 72c2e20

Browse files
blvablva
authored
CLOUDP-302671: Add filter command that removes x-xgen extensions from OAS (#495)
1 parent 320b534 commit 72c2e20

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

43 files changed

+60381
-49482
lines changed

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

+113
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,113 @@
1+
// Copyright 2024 MongoDB Inc
2+
//
3+
// Licensed under the Apache License, Version 2.0 (the "License");
4+
// you may not use this file except in compliance with the License.
5+
// You may obtain a copy of the License at
6+
//
7+
// http://www.apache.org/licenses/LICENSE-2.0
8+
//
9+
// Unless required by applicable law or agreed to in writing, software
10+
// distributed under the License is distributed on an "AS IS" BASIS,
11+
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
// See the License for the specific language governing permissions and
13+
// limitations under the License.
14+
15+
package filter
16+
17+
import (
18+
"fmt"
19+
"log"
20+
21+
"github.com/getkin/kin-openapi/openapi3"
22+
"github.com/mongodb/openapi/tools/cli/internal/apiversion"
23+
"github.com/mongodb/openapi/tools/cli/internal/cli/flag"
24+
"github.com/mongodb/openapi/tools/cli/internal/cli/usage"
25+
"github.com/mongodb/openapi/tools/cli/internal/openapi"
26+
"github.com/mongodb/openapi/tools/cli/internal/openapi/filter"
27+
"github.com/spf13/afero"
28+
"github.com/spf13/cobra"
29+
)
30+
31+
type Opts struct {
32+
fs afero.Fs
33+
basePath string
34+
outputPath string
35+
env string
36+
version string
37+
format string
38+
}
39+
40+
func (o *Opts) Run() error {
41+
loader := openapi.NewOpenAPI3()
42+
specInfo, err := loader.CreateOpenAPISpecFromPath(o.basePath)
43+
if err != nil {
44+
return err
45+
}
46+
47+
var filteredOAS *openapi3.T
48+
// If a version is provided, versioning filters will also be applied.
49+
if o.version != "" {
50+
filteredOAS, err = ByVersion(specInfo.Spec, o.version, o.env)
51+
} else {
52+
filters := filter.FiltersWithoutVersioning
53+
metadata := filter.NewMetadata(nil, o.env)
54+
filteredOAS, err = filter.ApplyFilters(specInfo.Spec, metadata, filters)
55+
}
56+
57+
if err != nil {
58+
return err
59+
}
60+
61+
return openapi.Save(o.outputPath, filteredOAS, o.format, o.fs)
62+
}
63+
64+
func ByVersion(oas *openapi3.T, version, env string) (result *openapi3.T, err error) {
65+
log.Printf("Filtering OpenAPI document by version %q", version)
66+
apiVersion, err := apiversion.New(apiversion.WithVersion(version))
67+
if err != nil {
68+
return nil, err
69+
}
70+
71+
return filter.ApplyFilters(oas, filter.NewMetadata(apiVersion, env), filter.DefaultFilters)
72+
}
73+
74+
func (o *Opts) PreRunE(_ []string) error {
75+
if o.basePath == "" {
76+
return fmt.Errorf("no OAS detected. Please, use the flag %s to include the base OAS", flag.Base)
77+
}
78+
79+
return openapi.ValidateFormatAndOutput(o.format, o.outputPath)
80+
}
81+
82+
// Builder builds the filter command with the following signature:
83+
// filter -s oas -o output-oas.json.
84+
func Builder() *cobra.Command {
85+
opts := &Opts{
86+
fs: afero.NewOsFs(),
87+
}
88+
89+
cmd := &cobra.Command{
90+
Use: "filter -s spec ",
91+
Short: `Filter Open API specification removing hidden endpoints and extension metadata.
92+
If a version is provided, versioning filters will also be applied.`,
93+
Args: cobra.NoArgs,
94+
PreRunE: func(_ *cobra.Command, args []string) error {
95+
return opts.PreRunE(args)
96+
},
97+
RunE: func(_ *cobra.Command, _ []string) error {
98+
return opts.Run()
99+
},
100+
}
101+
102+
cmd.Flags().StringVarP(&opts.basePath, flag.Spec, flag.SpecShort, "-", usage.Spec)
103+
cmd.Flags().StringVar(&opts.env, flag.Environment, "", usage.Environment)
104+
cmd.Flags().StringVarP(&opts.outputPath, flag.Output, flag.OutputShort, "", usage.Output)
105+
cmd.Flags().StringVar(&opts.version, flag.Version, "", usage.Version)
106+
cmd.Flags().StringVarP(&opts.format, flag.Format, flag.FormatShort, openapi.ALL, usage.Format)
107+
108+
// Required flags
109+
_ = cmd.MarkFlagRequired(flag.Output)
110+
_ = cmd.MarkFlagRequired(flag.Spec)
111+
_ = cmd.MarkFlagRequired(flag.Environment)
112+
return cmd
113+
}

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

+143
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,143 @@
1+
// Copyright 2024 MongoDB Inc
2+
//
3+
// Licensed under the Apache License, Version 2.0 (the "License");
4+
// you may not use this file except in compliance with the License.
5+
// You may obtain a copy of the License at
6+
//
7+
// http://www.apache.org/licenses/LICENSE-2.0
8+
//
9+
// Unless required by applicable law or agreed to in writing, software
10+
// distributed under the License is distributed on an "AS IS" BASIS,
11+
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
// See the License for the specific language governing permissions and
13+
// limitations under the License.
14+
15+
package filter
16+
17+
import (
18+
"net/url"
19+
"testing"
20+
21+
"github.com/getkin/kin-openapi/openapi3"
22+
"github.com/mongodb/openapi/tools/cli/internal/openapi"
23+
"github.com/spf13/afero"
24+
"github.com/stretchr/testify/require"
25+
"github.com/tufin/oasdiff/load"
26+
)
27+
28+
func TestSuccessfulFilter_Run(t *testing.T) {
29+
fs := afero.NewMemMapFs()
30+
t.Parallel()
31+
32+
opts := &Opts{
33+
basePath: "../../../test/data/base_spec.json",
34+
outputPath: "filtered-oas.yaml",
35+
fs: fs,
36+
env: "dev",
37+
}
38+
39+
if err := opts.Run(); err != nil {
40+
t.Fatalf("Run() unexpected error: %v", err)
41+
}
42+
43+
newSpec, err := loadRunResultOas(fs, opts.outputPath)
44+
require.NoError(t, err)
45+
46+
// check all paths are kept
47+
for _, pathItem := range newSpec.Spec.Paths.Map() {
48+
for _, operation := range pathItem.Operations() {
49+
// check extensions are removed at the operation level
50+
require.Nil(t, operation.Extensions)
51+
}
52+
}
53+
}
54+
55+
func TestSuccessfulFilterWithVersion_Run(t *testing.T) {
56+
fs := afero.NewMemMapFs()
57+
t.Parallel()
58+
59+
opts := &Opts{
60+
basePath: "../../../test/data/base_spec.json",
61+
outputPath: "filtered-oas.yaml",
62+
fs: fs,
63+
env: "dev",
64+
version: "2023-01-01",
65+
}
66+
67+
if err := opts.Run(); err != nil {
68+
t.Fatalf("Run() unexpected error: %v", err)
69+
}
70+
71+
s, err := loadRunResultOas(fs, opts.outputPath)
72+
require.NoError(t, err)
73+
// assert /api/atlas/v2/groups/{groupId}:migrate does not exist in filtered spec as it is from a newer version
74+
paths := s.Spec.Paths.Map()
75+
require.Contains(t, paths, "/api/atlas/v2/groups")
76+
require.NotContains(t, paths, "/api/atlas/v2/groups/{groupId}:migrate")
77+
}
78+
79+
func TestOpts_PreRunE(t *testing.T) {
80+
testCases := []struct {
81+
wantErr require.ErrorAssertionFunc
82+
basePath string
83+
name string
84+
}{
85+
{
86+
wantErr: require.Error,
87+
name: "NoBasePath",
88+
},
89+
{
90+
wantErr: require.NoError,
91+
basePath: "../../../test/data/base_spec.json",
92+
name: "Successful",
93+
},
94+
}
95+
96+
for _, tt := range testCases {
97+
t.Run(tt.name, func(t *testing.T) {
98+
o := &Opts{
99+
basePath: tt.basePath,
100+
format: "json",
101+
}
102+
tt.wantErr(t, o.PreRunE(nil))
103+
})
104+
}
105+
}
106+
107+
func TestInvalidFormat_PreRun(t *testing.T) {
108+
opts := &Opts{
109+
outputPath: "foas.json",
110+
basePath: "base.json",
111+
format: "html",
112+
}
113+
114+
err := opts.PreRunE(nil)
115+
require.Error(t, err)
116+
require.EqualError(t, err, "format must be either 'json', 'yaml' or 'all', got 'html'")
117+
}
118+
119+
func TestInvalidPath_PreRun(t *testing.T) {
120+
opts := &Opts{
121+
outputPath: "foas.html",
122+
basePath: "base.json",
123+
format: "all",
124+
}
125+
126+
err := opts.PreRunE(nil)
127+
require.Error(t, err)
128+
require.EqualError(t, err, "output file must be either a JSON or YAML file, got foas.html")
129+
}
130+
131+
func loadRunResultOas(fs afero.Fs, fileName string) (*load.SpecInfo, error) {
132+
oas := openapi.NewOpenAPI3()
133+
oas.Loader.ReadFromURIFunc = func(_ *openapi3.Loader, _ *url.URL) ([]byte, error) {
134+
f, err := fs.OpenFile(fileName, 0, 0)
135+
if err != nil {
136+
return nil, err
137+
}
138+
defer f.Close()
139+
return afero.ReadAll(f)
140+
}
141+
142+
return oas.CreateOpenAPISpecFromPath(fileName)
143+
}

‎tools/cli/internal/cli/flag/flag.go

+2
Original file line numberDiff line numberDiff line change
@@ -49,4 +49,6 @@ const (
4949
To = "to"
5050
StabilityLevel = "stability-level"
5151
StabilityLevelShort = "l"
52+
Version = "version"
53+
VersionShort = "v"
5254
)

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

+1-6
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,6 @@ package merge
1717
import (
1818
"encoding/json"
1919
"fmt"
20-
"strings"
2120

2221
"github.com/mongodb/openapi/tools/cli/internal/cli/flag"
2322
"github.com/mongodb/openapi/tools/cli/internal/cli/usage"
@@ -71,11 +70,7 @@ func (o *Opts) PreRunE(_ []string) error {
7170
return fmt.Errorf("no external OAS detected. Please, use the flag %s to include at least one OAS", flag.External)
7271
}
7372

74-
if o.outputPath != "" && !strings.Contains(o.outputPath, ".json") && !strings.Contains(o.outputPath, ".yaml") {
75-
return fmt.Errorf("output file must be either a JSON or YAML file, got %s", o.outputPath)
76-
}
77-
78-
if err := openapi.ValidateFormat(o.format); err != nil {
73+
if err := openapi.ValidateFormatAndOutput(o.format, o.outputPath); err != nil {
7974
return err
8075
}
8176

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

+1
Original file line numberDiff line numberDiff line change
@@ -159,6 +159,7 @@ func TestInvalidPath_PreRun(t *testing.T) {
159159
outputPath: "foas.html",
160160
externalPaths: externalPaths,
161161
basePath: "base.json",
162+
format: "json",
162163
}
163164

164165
err := opts.PreRunE(nil)

‎tools/cli/internal/cli/root/openapi/builder.go

+2
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ import (
2020

2121
"github.com/mongodb/openapi/tools/cli/internal/cli/breakingchanges"
2222
"github.com/mongodb/openapi/tools/cli/internal/cli/changelog"
23+
"github.com/mongodb/openapi/tools/cli/internal/cli/filter"
2324
"github.com/mongodb/openapi/tools/cli/internal/cli/merge"
2425
"github.com/mongodb/openapi/tools/cli/internal/cli/split"
2526
"github.com/mongodb/openapi/tools/cli/internal/cli/sunset"
@@ -61,6 +62,7 @@ func Builder() *cobra.Command {
6162
changelog.Builder(),
6263
breakingchanges.Builder(),
6364
sunset.Builder(),
65+
filter.Builder(),
6466
)
6567
return rootCmd
6668
}

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

+3-18
Original file line numberDiff line numberDiff line change
@@ -20,11 +20,10 @@ import (
2020
"strings"
2121

2222
"github.com/getkin/kin-openapi/openapi3"
23-
"github.com/mongodb/openapi/tools/cli/internal/apiversion"
23+
"github.com/mongodb/openapi/tools/cli/internal/cli/filter"
2424
"github.com/mongodb/openapi/tools/cli/internal/cli/flag"
2525
"github.com/mongodb/openapi/tools/cli/internal/cli/usage"
2626
"github.com/mongodb/openapi/tools/cli/internal/openapi"
27-
"github.com/mongodb/openapi/tools/cli/internal/openapi/filter"
2827
"github.com/spf13/afero"
2928
"github.com/spf13/cobra"
3029
)
@@ -51,7 +50,7 @@ func (o *Opts) Run() error {
5150
}
5251

5352
for _, version := range versions {
54-
filteredOAS, err := o.filter(specInfo.Spec, version)
53+
filteredOAS, err := filter.ByVersion(specInfo.Spec, version, o.env)
5554
if err != nil {
5655
return err
5756
}
@@ -74,16 +73,6 @@ func (o *Opts) Run() error {
7473
return nil
7574
}
7675

77-
func (o *Opts) filter(oas *openapi3.T, version string) (result *openapi3.T, err error) {
78-
log.Printf("Filtering OpenAPI document by version %q", version)
79-
apiVersion, err := apiversion.New(apiversion.WithVersion(version))
80-
if err != nil {
81-
return nil, err
82-
}
83-
84-
return filter.ApplyFilters(oas, filter.NewMetadata(apiVersion, o.env), filter.DefaultFilters)
85-
}
86-
8776
func (o *Opts) saveVersionedOas(oas *openapi3.T, version string) error {
8877
path := o.basePath
8978
if o.outputPath != "" {
@@ -109,11 +98,7 @@ func (o *Opts) PreRunE(_ []string) error {
10998
return fmt.Errorf("no OAS detected. Please, use the flag %s to include the base OAS", flag.Base)
11099
}
111100

112-
if o.outputPath != "" && !strings.Contains(o.outputPath, openapi.DotJSON) && !strings.Contains(o.outputPath, openapi.DotYAML) {
113-
return fmt.Errorf("output file must be either a JSON or YAML file, got %s", o.outputPath)
114-
}
115-
116-
return openapi.ValidateFormat(o.format)
101+
return openapi.ValidateFormatAndOutput(o.format, o.outputPath)
117102
}
118103

119104
// Builder builds the split command with the following signature:

0 commit comments

Comments
 (0)