-
Notifications
You must be signed in to change notification settings - Fork 215
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
frontend: add tests for
@apidevtools/swagger-parser
dependency
Signed-off-by: adwait-godbole <adwaitngodbole@gmail.com>
- Loading branch information
1 parent
f979bf5
commit e8ac58f
Showing
1 changed file
with
132 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,132 @@ | ||
import Swagger from '@apidevtools/swagger-parser'; | ||
import { OpenAPIV2 } from 'openapi-types'; | ||
|
||
describe('@apidevtools/swagger-parser', () => { | ||
it('should resolve $ref references', async () => { | ||
const doc: OpenAPIV2.Document = { | ||
swagger: '2.0', | ||
info: { title: 'Test API', version: '1.0.0' }, | ||
paths: {}, | ||
definitions: { | ||
'io.k8s.api.apps.v1.Deployment': { | ||
type: 'object', | ||
properties: { | ||
metadata: { $ref: '#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta' }, | ||
}, | ||
}, | ||
'io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta': { | ||
type: 'object', | ||
properties: { | ||
name: { type: 'string' }, | ||
namespace: { type: 'string' }, | ||
}, | ||
}, | ||
}, | ||
}; | ||
|
||
const result = (await Swagger.dereference(doc)) as OpenAPIV2.Document; | ||
|
||
expect(result.definitions?.['io.k8s.api.apps.v1.Deployment'].properties?.metadata).toEqual({ | ||
type: 'object', | ||
properties: { | ||
name: { type: 'string' }, | ||
namespace: { type: 'string' }, | ||
}, | ||
}); | ||
}); | ||
|
||
it('should throw an error for invalid $ref references', async () => { | ||
const doc: OpenAPIV2.Document = { | ||
swagger: '2.0', | ||
info: { title: 'Test API', version: '1.0.0' }, | ||
paths: {}, | ||
definitions: { | ||
'io.k8s.api.core.v1.Pod': { | ||
type: 'object', | ||
properties: { | ||
metadata: { $ref: '#/definitions/NonExistentRef' }, | ||
}, | ||
}, | ||
}, | ||
}; | ||
|
||
await expect(Swagger.dereference(doc)).rejects.toThrow(/Token "NonExistentRef"/); | ||
}); | ||
|
||
it('should handle deeply nested $ref references', async () => { | ||
const doc: OpenAPIV2.Document = { | ||
swagger: '2.0', | ||
info: { title: 'Test API', version: '1.0.0' }, | ||
paths: {}, | ||
definitions: { | ||
'io.k8s.api.core.v1.Pod': { | ||
type: 'object', | ||
properties: { | ||
spec: { $ref: '#/definitions/io.k8s.api.core.v1.PodSpec' }, | ||
}, | ||
}, | ||
'io.k8s.api.core.v1.PodSpec': { | ||
type: 'object', | ||
properties: { | ||
containers: { | ||
type: 'array', | ||
items: { $ref: '#/definitions/io.k8s.api.core.v1.Container' }, | ||
}, | ||
}, | ||
}, | ||
'io.k8s.api.core.v1.Container': { | ||
type: 'object', | ||
properties: { | ||
image: { type: 'string' }, | ||
}, | ||
}, | ||
}, | ||
}; | ||
|
||
const result = (await Swagger.dereference(doc)) as OpenAPIV2.Document; | ||
|
||
expect(result.definitions?.['io.k8s.api.core.v1.Pod'].properties?.spec).toEqual({ | ||
type: 'object', | ||
properties: { | ||
containers: { | ||
type: 'array', | ||
items: { type: 'object', properties: { image: { type: 'string' } } }, | ||
}, | ||
}, | ||
}); | ||
}); | ||
|
||
it('should handle circular references', async () => { | ||
const doc: OpenAPIV2.Document = { | ||
swagger: '2.0', | ||
info: { title: 'Test API', version: '1.0.0' }, | ||
paths: {}, | ||
definitions: { | ||
'io.k8s.api.core.v1.Pod': { | ||
type: 'object', | ||
properties: { | ||
metadata: { | ||
$ref: '#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta', | ||
}, | ||
}, | ||
}, | ||
'io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta': { | ||
type: 'object', | ||
properties: { | ||
ownerReferences: { | ||
$ref: '#/definitions/io.k8s.api.core.v1.Pod', | ||
}, | ||
}, | ||
}, | ||
}, | ||
}; | ||
|
||
const result = (await Swagger.dereference(doc)) as OpenAPIV2.Document; | ||
|
||
expect(result.definitions?.['io.k8s.api.core.v1.Pod'].properties?.metadata).toBeDefined(); | ||
expect( | ||
result.definitions?.['io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta'].properties | ||
?.ownerReferences | ||
).toBeDefined(); | ||
}); | ||
}); |