Skip to content

Commit 9f956c5

Browse files
pete-woodspete-woods
committed
Fix bundling specs from an embedded FS
1 parent b7fe7bb commit 9f956c5

10 files changed

Lines changed: 189 additions & 7 deletions

File tree

‎bundler/bundler_test.go‎

Lines changed: 48 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -20,18 +20,19 @@ import (
2020
"sync"
2121
"testing"
2222

23-
"github.com/pb33f/libopenapi/datamodel/low"
23+
"github.com/stretchr/testify/assert"
24+
"github.com/stretchr/testify/require"
25+
"go.yaml.in/yaml/v4"
2426

2527
"github.com/pb33f/libopenapi"
28+
"github.com/pb33f/libopenapi/bundler/test/specs/schemawithrefs"
2629
"github.com/pb33f/libopenapi/datamodel"
2730
"github.com/pb33f/libopenapi/datamodel/high/base"
2831
v3high "github.com/pb33f/libopenapi/datamodel/high/v3"
32+
"github.com/pb33f/libopenapi/datamodel/low"
2933
"github.com/pb33f/libopenapi/index"
3034
"github.com/pb33f/libopenapi/orderedmap"
3135
"github.com/pb33f/libopenapi/utils"
32-
"github.com/stretchr/testify/assert"
33-
"github.com/stretchr/testify/require"
34-
"go.yaml.in/yaml/v4"
3536
)
3637

3738
// Test helper functions to reduce duplication across DigitalOcean tests
@@ -2209,8 +2210,8 @@ func TestCopySchemaToComponents_NameCollision(t *testing.T) {
22092210
func TestCalculateCollisionNameInline_NumericSuffix(t *testing.T) {
22102211
// Test: When filename-based name also collides, use numeric suffix
22112212
existingNames := map[string]bool{
2212-
"Cat": true,
2213-
"Cat__external": true, // Filename-based collision also exists
2213+
"Cat": true,
2214+
"Cat__external": true, // Filename-based collision also exists
22142215
"Cat__external__1": true, // First numeric suffix also taken (format: name__basename__N)
22152216
}
22162217

@@ -2284,3 +2285,44 @@ components:
22842285
assert.Equal(t, "#node", itemsSchema.DynamicRef, "DynamicRef should be '#node'")
22852286
}
22862287

2288+
func TestBundleDocument_Embedded(t *testing.T) {
2289+
expected, err := os.ReadFile("test/specs/schemawithrefs_expected.yaml")
2290+
require.NoError(t, err)
2291+
2292+
tests := []struct {
2293+
name string
2294+
config *datamodel.DocumentConfiguration
2295+
}{
2296+
{
2297+
name: "directory",
2298+
config: &datamodel.DocumentConfiguration{
2299+
BasePath: "test/specs/schemawithrefs",
2300+
AllowFileReferences: true,
2301+
},
2302+
},
2303+
{
2304+
name: "embed",
2305+
config: &datamodel.DocumentConfiguration{
2306+
LocalFS: schemawithrefs.Files,
2307+
AllowFileReferences: true,
2308+
},
2309+
},
2310+
}
2311+
2312+
for _, tt := range tests {
2313+
t.Run(tt.name, func(t *testing.T) {
2314+
doc, err := libopenapi.NewDocumentWithConfiguration(schemawithrefs.Schema, tt.config)
2315+
require.NoError(t, err)
2316+
2317+
t.Run("v3", func(t *testing.T) {
2318+
v3, err := doc.BuildV3Model()
2319+
require.NoError(t, err)
2320+
2321+
b, err := BundleDocument(&v3.Model)
2322+
require.NoError(t, err)
2323+
2324+
assert.Equal(t, string(b), string(expected))
2325+
})
2326+
})
2327+
}
2328+
}

‎bundler/test/specs/schemawithrefs/description.yaml‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
introduction: |
2+
# Title
3+
4+
Description

‎bundler/test/specs/schemawithrefs/openapi.yaml‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
openapi: "3.0.0"
2+
3+
info:
4+
title: Test API
5+
version: "2.0"
6+
description:
7+
$ref: "description.yaml#/introduction"
8+
paths:
9+
/v2/actions/{action_id}:
10+
get:
11+
$ref: "resources/actions/actions_get.yaml"

‎bundler/test/specs/schemawithrefs/resources/actions/actions_get.yaml‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
operationId: actions_get
2+
3+
summary: Retrieve an action
4+
5+
description: The description for this endpoint
6+
7+
tags:
8+
- Actions
9+
10+
parameters:
11+
- $ref: 'parameters.yaml#/action_id'
12+
13+
responses:
14+
'200':
15+
$ref: 'responses/action.yaml'
16+

‎bundler/test/specs/schemawithrefs/resources/actions/models/action.yaml‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
type: object
2+
3+
properties:
4+
id:
5+
type: integer
6+
description: A description of id
7+
example: 36804636
8+
9+
status:
10+
type: string
11+
description: A description of status
12+
enum:
13+
- started
14+
- completed
15+
- errored
16+
example: completed
17+
default: started

‎bundler/test/specs/schemawithrefs/resources/actions/parameters.yaml‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
action_id:
2+
in: path
3+
name: action_id
4+
description: A unique numeric ID that can be used to identify and reference an action.
5+
required: true
6+
schema:
7+
type: integer
8+
minimum: 1
9+
example: 36804636

‎bundler/test/specs/schemawithrefs/resources/actions/responses/action.yaml‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
description: >-
2+
The result will be a JSON object with an action key.
3+
This will be set to an action object containing the standard action attributes.
4+
5+
content:
6+
application/json:
7+
schema:
8+
properties:
9+
action:
10+
$ref: '../models/action.yaml'

‎bundler/test/specs/schemawithrefs/schema.go‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
package schemawithrefs
2+
3+
import (
4+
"embed"
5+
)
6+
7+
//go:embed openapi.yaml
8+
var Schema []byte
9+
10+
//go:embed description.yaml resources
11+
var Files embed.FS

‎bundler/test/specs/schemawithrefs_expected.yaml‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
openapi: "3.0.0"
2+
info:
3+
title: Test API
4+
version: "2.0"
5+
description: ""
6+
paths:
7+
/v2/actions/{action_id}:
8+
get:
9+
operationId: actions_get
10+
summary: Retrieve an action
11+
description: The description for this endpoint
12+
tags:
13+
- Actions
14+
parameters:
15+
- in: path
16+
name: action_id
17+
description: A unique numeric ID that can be used to identify and reference an action.
18+
required: true
19+
schema:
20+
type: integer
21+
minimum: 1
22+
example: 36804636
23+
responses:
24+
'200':
25+
description: >-
26+
The result will be a JSON object with an action key. This will be set to an action object containing the standard action attributes.
27+
content:
28+
application/json:
29+
schema:
30+
properties:
31+
action:
32+
type: object
33+
properties:
34+
id:
35+
type: integer
36+
description: A description of id
37+
example: 36804636
38+
status:
39+
type: string
40+
description: A description of status
41+
enum:
42+
- started
43+
- completed
44+
- errored
45+
example: completed
46+
default: started

‎datamodel/low/v3/create_document.go‎

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,23 @@ func createDocument(info *datamodel.SpecInfo, config *datamodel.DocumentConfigur
106106
cwd, _ = filepath.Abs(config.BasePath)
107107
// if a supplied local filesystem is provided, add it to the rolodex.
108108
if config.LocalFS != nil {
109-
rolodex.AddLocalFS(cwd, config.LocalFS)
109+
var localFS index.RolodexFS
110+
if fs, ok := config.LocalFS.(index.RolodexFS); ok {
111+
localFS = fs
112+
} else {
113+
// create a local filesystem
114+
localFSConf := index.LocalFSConfig{
115+
BaseDirectory: cwd,
116+
IndexConfig: idxConfig,
117+
FileFilters: config.FileFilter,
118+
DirFS: config.LocalFS,
119+
}
120+
121+
localFS, _ = index.NewLocalFSWithConfig(&localFSConf)
122+
idxConfig.AllowFileLookup = true
123+
}
124+
125+
rolodex.AddLocalFS(cwd, localFS)
110126
} else {
111127

112128
// create a local filesystem

0 commit comments

Comments
 (0)