Skip to content

tests: use mock servers for schema loading #311

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
HNO3Miracle wants to merge 1 commit into
base: main
Choose a base branch
from
Open

tests: use mock servers for schema loading #311

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 11 additions & 5 deletions schema_validation/openapi_schemas/load_schema.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,16 +16,23 @@ import (
_ "embed"
)

var schema30, schema31 string
const (
defaultSchema30URL = "https://raw.githubusercontent.com/pb33f/openapi-specification/main/schemas/v3.0/schema.json"
defaultSchema31URL = "https://raw.githubusercontent.com/pb33f/openapi-specification/main/schemas/v3.1/schema.json"
)

var (
schema30, schema31 string
schema30URL, schema31URL = defaultSchema30URL, defaultSchema31URL
)

// LoadSchema3_0 loads the latest OpenAPI 3.0 specification. The latest version is fetched from the OpenAPI repo.
// and if there is no change in the schema, the local version is returned, otherwise the remote version is returned.
func LoadSchema3_0(schema string) string {
if schema30 != "" {
return schema30
}
remoteSpec := "https://raw.githubusercontent.com/pb33f/openapi-specification/main/schemas/v3.0/schema.json"
schema30 = extractSchema(remoteSpec, schema)
schema30 = extractSchema(schema30URL, schema)
return schema30
}

Expand All @@ -35,8 +42,7 @@ func LoadSchema3_1(schema string) string {
if schema31 != "" {
return schema31
}
remoteSpec := "https://raw.githubusercontent.com/pb33f/openapi-specification/main/schemas/v3.1/schema.json"
schema31 = extractSchema(remoteSpec, schema)
schema31 = extractSchema(schema31URL, schema)
return schema31
}

Expand Down
17 changes: 12 additions & 5 deletions schema_validation/openapi_schemas/load_schema_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,10 +47,11 @@ func TestLoadSchema3_0_RemoteDifferent(t *testing.T) {
remoteSchema := `{"title": "OpenAPI 3.0"}`
server := mockServer(remoteSchema, http.StatusOK)
defer server.Close()
schema30URL = server.URL
t.Cleanup(func() { schema30URL = defaultSchema30URL })

// Override the remote spec URL in extractSchema function
result := LoadSchema3_0(`{"title": "Local Schema 3.0"}`)
require.NotEqual(t, remoteSchema, result)
require.Equal(t, remoteSchema, result)
}

// Test LoadSchema3_0 when the remote schema is the same as the local schema
Expand All @@ -64,9 +65,11 @@ func TestLoadSchema3_0_RemoteSame(t *testing.T) {

server := mockServer(remoteSchema, http.StatusOK)
defer server.Close()
schema30URL = server.URL
t.Cleanup(func() { schema30URL = defaultSchema30URL })

result := LoadSchema3_0(localSchema)
require.NotEqual(t, localSchema, result)
require.Equal(t, localSchema, result)
}

// Test LoadSchema3_1 when the remote schema is different from the local schema
Expand All @@ -78,10 +81,12 @@ func TestLoadSchema3_1_RemoteDifferent(t *testing.T) {
remoteSchema := `{"title": "OpenAPI 3.1"}`
server := mockServer(remoteSchema, http.StatusOK)
defer server.Close()
schema31URL = server.URL
t.Cleanup(func() { schema31URL = defaultSchema31URL })

// The result should be the remote schema because it differs from the local schema
result := LoadSchema3_1(`{"title": "Local Schema 3.1"}`)
require.NotEqual(t, remoteSchema, result)
require.Equal(t, remoteSchema, result)
}

// Test LoadSchema3_1 when the remote schema is the same as the local schema
Expand All @@ -95,10 +100,12 @@ func TestLoadSchema3_1_RemoteSame(t *testing.T) {

server := mockServer(remoteSchema, http.StatusOK)
defer server.Close()
schema31URL = server.URL
t.Cleanup(func() { schema31URL = defaultSchema31URL })

// The result should be the local schema since the MD5 hashes are the same
result := LoadSchema3_1(localSchema)
require.NotEqual(t, localSchema, result)
require.Equal(t, localSchema, result)
}

// Test extractSchema when the remote schema differs from the local schema
Expand Down
Loading