|
| 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 | +package filter |
| 15 | + |
| 16 | +import ( |
| 17 | + "testing" |
| 18 | + |
| 19 | + "github.com/getkin/kin-openapi/openapi3" |
| 20 | + "github.com/mongodb/openapi/tools/cli/internal/apiversion" |
| 21 | + "github.com/stretchr/testify/assert" |
| 22 | + "github.com/stretchr/testify/require" |
| 23 | +) |
| 24 | + |
| 25 | +func TestNewMetadata(t *testing.T) { |
| 26 | + version := &apiversion.APIVersion{} |
| 27 | + env := "test-env" |
| 28 | + metadata := NewMetadata(version, env) |
| 29 | + |
| 30 | + assert.Equal(t, version, metadata.targetVersion) |
| 31 | + assert.Equal(t, env, metadata.targetEnv) |
| 32 | +} |
| 33 | + |
| 34 | +func TestValidateMetadata(t *testing.T) { |
| 35 | + t.Run("Valid metadata", func(t *testing.T) { |
| 36 | + metadata := &Metadata{ |
| 37 | + targetEnv: "dev", |
| 38 | + } |
| 39 | + err := validateMetadata(metadata) |
| 40 | + assert.NoError(t, err) |
| 41 | + }) |
| 42 | + |
| 43 | + t.Run("Nil metadata", func(t *testing.T) { |
| 44 | + err := validateMetadata(nil) |
| 45 | + require.ErrorContains(t, err, "metadata is nil") |
| 46 | + }) |
| 47 | +} |
| 48 | + |
| 49 | +func TestDuplicateOas(t *testing.T) { |
| 50 | + doc := &openapi3.T{ |
| 51 | + Info: &openapi3.Info{ |
| 52 | + Title: "Test API", |
| 53 | + Version: "1.0.0", |
| 54 | + }, |
| 55 | + } |
| 56 | + |
| 57 | + duplicateDoc, err := duplicateOas(doc) |
| 58 | + require.NoError(t, err) |
| 59 | + require.NotNil(t, duplicateDoc) |
| 60 | + assert.Equal(t, doc.Info.Title, duplicateDoc.Info.Title) |
| 61 | + assert.Equal(t, doc.Info.Version, duplicateDoc.Info.Version) |
| 62 | +} |
| 63 | + |
| 64 | +func TestApplyFilters(t *testing.T) { |
| 65 | + doc := &openapi3.T{ |
| 66 | + Info: &openapi3.Info{ |
| 67 | + Title: "Test API", |
| 68 | + Version: "1.0.0", |
| 69 | + }, |
| 70 | + } |
| 71 | + metadata := &Metadata{} |
| 72 | + |
| 73 | + t.Run("Nil document", func(t *testing.T) { |
| 74 | + _, err := ApplyFilters(nil, metadata, DefaultFilters) |
| 75 | + require.ErrorContains(t, err, "openapi document is nil") |
| 76 | + }) |
| 77 | + |
| 78 | + t.Run("Nil metadata", func(t *testing.T) { |
| 79 | + _, err := ApplyFilters(doc, nil, DefaultFilters) |
| 80 | + require.ErrorContains(t, err, "metadata is nil") |
| 81 | + }) |
| 82 | + |
| 83 | + t.Run("Invalid metadata", func(t *testing.T) { |
| 84 | + _, err := ApplyFilters(doc, metadata, DefaultFilters) |
| 85 | + require.ErrorContains(t, err, "target environment is empty") |
| 86 | + }) |
| 87 | + |
| 88 | + t.Run("Missing versioning metadata", func(t *testing.T) { |
| 89 | + metadata := &Metadata{ |
| 90 | + targetEnv: "dev", |
| 91 | + } |
| 92 | + _, err := ApplyFilters(doc, metadata, DefaultFilters) |
| 93 | + require.ErrorContains(t, err, "failed to validate metadata for filter *filter.VersioningExtensionFilter with: target version is nil") |
| 94 | + }) |
| 95 | + |
| 96 | + t.Run("Valid metadata for default filters", func(t *testing.T) { |
| 97 | + version, err := apiversion.New(apiversion.WithVersion("2023-11-15")) |
| 98 | + require.NoError(t, err) |
| 99 | + metadata := &Metadata{ |
| 100 | + targetEnv: "dev", |
| 101 | + targetVersion: version, |
| 102 | + } |
| 103 | + |
| 104 | + filteredDoc, err := ApplyFilters(doc, metadata, DefaultFilters) |
| 105 | + require.NoError(t, err) |
| 106 | + assert.NotNil(t, filteredDoc) |
| 107 | + }) |
| 108 | +} |
| 109 | + |
| 110 | +func TestDefaultFilters(t *testing.T) { |
| 111 | + doc := &openapi3.T{} |
| 112 | + metadata := &Metadata{} |
| 113 | + filters := DefaultFilters(doc, metadata) |
| 114 | + |
| 115 | + assert.Len(t, filters, 7) |
| 116 | +} |
| 117 | + |
| 118 | +func TestFiltersWithoutVersioning(t *testing.T) { |
| 119 | + doc := &openapi3.T{} |
| 120 | + metadata := &Metadata{} |
| 121 | + filters := FiltersWithoutVersioning(doc, metadata) |
| 122 | + |
| 123 | + assert.Len(t, filters, 5) |
| 124 | +} |
| 125 | + |
| 126 | +func TestFiltersToGetVersions(t *testing.T) { |
| 127 | + doc := &openapi3.T{} |
| 128 | + metadata := &Metadata{} |
| 129 | + filters := FiltersToGetVersions(doc, metadata) |
| 130 | + |
| 131 | + assert.Len(t, filters, 1) |
| 132 | +} |
0 commit comments