File: spec_test.go

package info (click to toggle)
golang-github-go-openapi-analysis 0.23.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 2,548 kB
  • sloc: makefile: 4
file content (236 lines) | stat: -rw-r--r-- 6,184 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
package analysis_test

import (
	"io/ioutil"
	"net/http"
	"net/http/httptest"
	"os"
	"testing"

	"github.com/go-openapi/analysis"
	"github.com/go-openapi/analysis/internal/antest"
	"github.com/go-openapi/loads"
	"github.com/go-openapi/spec"
	"github.com/go-openapi/swag"
	"github.com/stretchr/testify/assert"
	"github.com/stretchr/testify/require"
)

func skipNotify(t *testing.T) {
	t.Log("To enable this long running test, use -args -enable-long in your go test command line")
}

func Test_FlattenAzure(t *testing.T) {
	if !antest.LongTestsEnabled() {
		skipNotify(t)
		t.SkipNow()
	}
	t.Parallel()

	// Local copy of https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/network/resource-manager/Microsoft.Network/stable/2020-04-01/publicIpAddress.json
	url := "../fixtures/azure/publicIpAddress.json"
	byts, err := swag.LoadFromFileOrHTTP(url)
	assert.NoError(t, err)
	swagger := &spec.Swagger{}
	require.NoError(t, swagger.UnmarshalJSON(byts))

	analyzed := analysis.New(swagger)
	require.NoError(t, analysis.Flatten(analysis.FlattenOpts{Spec: analyzed, Expand: true, BasePath: url}))

	jazon := asJSON(t, swagger)

	assertRefInJSONRegexp(t, jazon, `^(#/definitions/)|(\./example)`)

	t.Run("resolve local $ref azure", func(t *testing.T) {
		assertRefResolve(t, jazon, `\./example`, swagger, &spec.ExpandOptions{RelativeBase: url})
	})
}

func TestRemoteFlattenAzure_Expand(t *testing.T) {
	if !antest.LongTestsEnabled() {
		skipNotify(t)
		t.SkipNow()
	}
	t.Parallel()

	server := httptest.NewServer(http.FileServer(http.Dir("../fixtures/azure")))
	defer server.Close()

	basePath := server.URL + "/publicIpAddress.json"

	swagger, err := loads.Spec(basePath)
	require.NoError(t, err)

	require.NoError(t, analysis.Flatten(analysis.FlattenOpts{Spec: swagger.Analyzer, Expand: true, BasePath: basePath}))

	jazon := asJSON(t, swagger.Spec())

	assertRefInJSONRegexp(t, jazon, `^(#/definitions/)|(\./example)`)

	t.Run("resolve remote $ref azure [after expansion]", func(t *testing.T) {
		assertRefResolve(t, jazon, `\./example`, swagger.Spec(), &spec.ExpandOptions{RelativeBase: basePath})
	})
}

func TestRemoteFlattenAzure_Flatten(t *testing.T) {
	if !antest.LongTestsEnabled() {
		skipNotify(t)
		t.SkipNow()
	}
	t.Parallel()

	server := httptest.NewServer(http.FileServer(http.Dir("../fixtures/azure")))
	defer server.Close()

	basePath := server.URL + "/publicIpAddress.json"

	swagger, err := loads.Spec(basePath)
	require.NoError(t, err)

	require.NoError(t, analysis.Flatten(analysis.FlattenOpts{Spec: swagger.Analyzer, Expand: false, BasePath: basePath}))

	jazon := asJSON(t, swagger.Spec())

	assertRefInJSONRegexp(t, jazon, `^(#/definitions/)|(\./example)`)

	t.Run("resolve remote $ref azure [minimal flatten]", func(t *testing.T) {
		assertRefResolve(t, jazon, `\./example`, swagger.Spec(), &spec.ExpandOptions{RelativeBase: basePath})
	})
}

func TestIssue66(t *testing.T) {
	// no BasePath provided: assume current working directory
	file, clean := makeFileSpec(t)
	defer clean()

	// analyze and expand
	doc, err := loads.Spec(file)
	require.NoError(t, err)
	an := analysis.New(doc.Spec()) // Analyze spec
	require.NoError(t, analysis.Flatten(analysis.FlattenOpts{
		Spec:   an,
		Expand: true,
	}))
	jazon := asJSON(t, doc.Spec())
	assertNoRef(t, jazon)

	// reload and flatten
	doc, err = loads.Spec(file)
	require.NoError(t, err)
	require.NoError(t, analysis.Flatten(analysis.FlattenOpts{
		Spec:   an,
		Expand: false,
	}))
	jazon = asJSON(t, doc.Spec())
	t.Run("resolve $ref issue66", func(t *testing.T) {
		assertRefResolve(t, jazon, "", doc.Spec(), &spec.ExpandOptions{})
	})
}

func makeFileSpec(t testing.TB) (string, func()) {
	file := "./openapi.yaml"
	require.NoError(t, ioutil.WriteFile(file, fixtureIssue66(), 0600))

	return file, func() {
		_ = os.Remove(file)
	}
}

func fixtureIssue66() []byte {
	return []byte(`
x-google-endpoints:
  - name: bravo-api.endpoints.dev-srplatform.cloud.goog
    allowCors: true
host: bravo-api.endpoints.dev-srplatform.cloud.goog
swagger: '2.0'
info:
  description: Demo API for Bravo team testing
  title: BRAVO Team API
  version: 0.0.0
basePath: /bravo
x-google-allow: all
consumes:
  - application/json
produces:
  - application/json
schemes:
  - http
  - https
paths:
  /bravo-api:
    get:
      description: List expansions
      operationId: default
      responses:
        200:
          description: Default Path
          schema:
            $ref: '#/definitions/heartbeatResponse'
        403:
          description: Forbidden
        500:
          description: Internal Server Error
  /bravo-api/healthN:
    get:
      description: N Health
      operationId: healthN
      responses:
        200:
          description: Default Path
          schema:
            $ref: '#/definitions/heartbeatResponse'
        403:
          description: Forbidden
        500:
          description: Internal Server Error
  /bravo-api/internal/heartbeat:
    get:
      description: Heartbeat endpoint
      operationId: heartbeat
      produces:
        - application/json
      responses:
        200:
          description: Health Status
          schema:
            $ref: '#/definitions/heartbeatResponse'
  /bravo-api/internal/version:
    get:
      description: Version endpoint
      operationId: version
      produces:
        - application/json
      responses:
        200:
          description: Version Information
  /bravo-api/internal/cpuload:
    get:
      description: CPU Load endpoint
      operationId: cpuload
      produces:
        - application/json
      responses:
        200:
          description: Run a CPU load

definitions:
  heartbeatResponse:
    properties:
      Status:
        type: string
      ProjectID:
        type: string
      Version:
        type: string
securityDefinitions:
  okta_jwt:
    authorizationUrl: "http://okta.example.com"
    flow: "implicit"
    type: "oauth2"
    scopes:
      com.sr.messaging: 'View and manage messaging content, criteria and definitions.'
    x-google-issuer: "http://okta.example.com"
    x-google-jwks_uri: "http://okta.example.com/v1/keys"
    x-google-audiences: "http://api.example.com"
`)
}