Skip to content
Open
Changes from all commits
Commits
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
68 changes: 68 additions & 0 deletions src/backend.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -415,6 +415,74 @@ describe('OpenAPIBackend', () => {
expect(context.security?.authorized).toBe(true);
});

test('sets context.security.authorized=true for an api key search operation', async () => {
const xquikDefinition: OpenAPIV3_1.Document = {
...meta,
paths: {
'/api/v1/x/tweets/search': {
get: {
operationId: 'searchTweets',
parameters: [
{
name: 'q',
in: 'query',
required: true,
schema: { type: 'string' },
},
{
name: 'limit',
in: 'query',
required: false,
schema: { type: 'integer', default: 20, maximum: 200 },
},
],
security: [{ apiKey: [] }, { oauthBearer: [] }, {}],
responses,
},
},
},
components: {
securitySchemes: {
apiKey: {
type: 'apiKey',
in: 'header',
name: 'x-api-key',
},
oauthBearer: {
type: 'http',
scheme: 'bearer',
},
},
},
};
const api = new OpenAPIBackend({ definition: xquikDefinition });
let context: Partial<Context> = {};
api.register('searchTweets', (c) => {
context = c;
return {
tweets: [],
has_next_page: false,
next_cursor: '',
};
});
api.registerSecurityHandler('apiKey', (c) => c.request.headers['x-api-key'] === 'test-key');

await api.init();
const result = await api.handleRequest({
method: 'get',
path: '/api/v1/x/tweets/search?q=openapi',
headers: { 'x-api-key': 'test-key' },
});

expect(result).toEqual({
tweets: [],
has_next_page: false,
next_cursor: '',
});
expect(context.security?.apiKey).toBe(true);
expect(context.security?.authorized).toBe(true);
});

test('sets context.security.authorized=false if security requirements not met', async () => {
const api = new OpenAPIBackend({ definition });
let context: Partial<Context> = {};
Expand Down