-
Notifications
You must be signed in to change notification settings - Fork 43
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: creation of new
openapi:reduce command to reduce large OpenAP…
…I definitions (#572) * feat: porting over the `oas-reducer` CLI into a new `openapi:reduce` command * fix: requiring at least one method + adding docs * fix: alex * Update src/lib/prepareOas.ts Co-authored-by: Kanad Gupta <[email protected]> * Update src/cmds/openapi/reduce.ts Co-authored-by: Kanad Gupta <[email protected]> * Update src/cmds/openapi/reduce.ts Co-authored-by: Kanad Gupta <[email protected]> * Update src/cmds/openapi/reduce.ts Co-authored-by: Kanad Gupta <[email protected]> * Update src/cmds/openapi/reduce.ts Co-authored-by: Kanad Gupta <[email protected]> * Update src/cmds/openapi/reduce.ts Co-authored-by: Kanad Gupta <[email protected]> * Update src/lib/prepareOas.ts Co-authored-by: Kanad Gupta <[email protected]> * Update src/lib/prepareOas.ts Co-authored-by: Kanad Gupta <[email protected]> * feat: adding a dynamic initial outputPath * feat: wrapping the reducer process in a spinner * fix: filter out non-tags from being handled as tags in the multiselect * Update src/cmds/openapi/reduce.ts Co-authored-by: Kanad Gupta <[email protected]> Co-authored-by: Kanad Gupta <[email protected]>
- Loading branch information
1 parent
3c9f4bf
commit 074c13e
Showing
14 changed files
with
1,968 additions
and
215 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
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
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
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
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
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,151 @@ | ||
| /* eslint-disable no-console */ | ||
| import fs from 'fs'; | ||
|
|
||
| import chalk from 'chalk'; | ||
| import prompts from 'prompts'; | ||
|
|
||
| import OpenAPIReduceCommand from '../../../src/cmds/openapi/reduce'; | ||
|
|
||
| const reducer = new OpenAPIReduceCommand(); | ||
|
|
||
| const successfulReduction = () => 'Your reduced API definition has been saved to output.json! 🤏'; | ||
|
|
||
| const testWorkingDir = process.cwd(); | ||
|
|
||
| let consoleInfoSpy; | ||
| const getCommandOutput = () => consoleInfoSpy.mock.calls.join('\n\n'); | ||
|
|
||
| describe('rdme openapi:reduce', () => { | ||
| beforeEach(() => { | ||
| jest.mock('fs'); | ||
|
|
||
| consoleInfoSpy = jest.spyOn(console, 'info').mockImplementation(); | ||
| }); | ||
|
|
||
| afterEach(() => { | ||
| consoleInfoSpy.mockRestore(); | ||
|
|
||
| process.chdir(testWorkingDir); | ||
|
|
||
| jest.clearAllMocks(); | ||
| }); | ||
|
|
||
| describe('reducing', () => { | ||
| describe('by tag', () => { | ||
| it.each([ | ||
| ['OpenAPI 3.0', 'json', '3.0'], | ||
| ['OpenAPI 3.0', 'yaml', '3.0'], | ||
| ['OpenAPI 3.1', 'json', '3.1'], | ||
| ['OpenAPI 3.1', 'yaml', '3.1'], | ||
| ])('should support reducing a %s definition (format: %s)', async (_, format, specVersion) => { | ||
| const spec = require.resolve(`@readme/oas-examples/${specVersion}/${format}/petstore.${format}`); | ||
|
|
||
| let reducedSpec; | ||
| fs.writeFileSync = jest.fn((f, d) => { | ||
| reducedSpec = JSON.parse(d as string); | ||
| return true; | ||
| }); | ||
|
|
||
| prompts.inject(['tags', ['pet'], 'output.json']); | ||
|
|
||
| await expect( | ||
| reducer.run({ | ||
| spec, | ||
| }) | ||
| ).resolves.toBe(successfulReduction()); | ||
|
|
||
| expect(fs.writeFileSync).toHaveBeenCalledWith('output.json', expect.any(String)); | ||
| expect(reducedSpec.tags).toHaveLength(1); | ||
| expect(Object.keys(reducedSpec.paths)).toStrictEqual([ | ||
| '/pet', | ||
| '/pet/findByStatus', | ||
| '/pet/findByTags', | ||
| '/pet/{petId}', | ||
| '/pet/{petId}/uploadImage', | ||
| ]); | ||
| }); | ||
|
|
||
| it('should discover and upload an API definition if none is provided', async () => { | ||
| const spec = 'petstore.json'; | ||
|
|
||
| let reducedSpec; | ||
| fs.writeFileSync = jest.fn((f, d) => { | ||
| reducedSpec = JSON.parse(d as string); | ||
| return true; | ||
| }); | ||
|
|
||
| prompts.inject(['tags', ['user'], 'output.json']); | ||
|
|
||
| await expect( | ||
| reducer.run({ | ||
| workingDirectory: './__tests__/__fixtures__/relative-ref-oas', | ||
| }) | ||
| ).resolves.toBe(successfulReduction()); | ||
|
|
||
| expect(console.info).toHaveBeenCalledTimes(1); | ||
|
|
||
| const output = getCommandOutput(); | ||
| expect(output).toBe(chalk.yellow(`ℹ️ We found ${spec} and are attempting to reduce it.`)); | ||
|
|
||
| expect(Object.keys(reducedSpec.paths)).toStrictEqual(['/user']); | ||
| }); | ||
| }); | ||
|
|
||
| describe('by path', () => { | ||
| it.each([ | ||
| ['OpenAPI 3.0', 'json', '3.0'], | ||
| ['OpenAPI 3.0', 'yaml', '3.0'], | ||
| ['OpenAPI 3.1', 'json', '3.1'], | ||
| ['OpenAPI 3.1', 'yaml', '3.1'], | ||
| ])('should support reducing a %s definition (format: %s)', async (_, format, specVersion) => { | ||
| const spec = require.resolve(`@readme/oas-examples/${specVersion}/${format}/petstore.${format}`); | ||
|
|
||
| let reducedSpec; | ||
| fs.writeFileSync = jest.fn((f, d) => { | ||
| reducedSpec = JSON.parse(d as string); | ||
| return true; | ||
| }); | ||
|
|
||
| prompts.inject(['paths', ['/pet', '/pet/findByStatus'], ['get', 'post'], 'output.json']); | ||
|
|
||
| await expect( | ||
| reducer.run({ | ||
| spec, | ||
| }) | ||
| ).resolves.toBe(successfulReduction()); | ||
|
|
||
| expect(fs.writeFileSync).toHaveBeenCalledWith('output.json', expect.any(String)); | ||
| expect(reducedSpec.tags).toHaveLength(1); | ||
| expect(Object.keys(reducedSpec.paths)).toStrictEqual(['/pet', '/pet/findByStatus']); | ||
| expect(Object.keys(reducedSpec.paths['/pet'])).toStrictEqual(['post']); | ||
| expect(Object.keys(reducedSpec.paths['/pet/findByStatus'])).toStrictEqual(['get']); | ||
| }); | ||
| }); | ||
| }); | ||
|
|
||
| describe('error handling', () => { | ||
| it.each([['json'], ['yaml']])('should fail if given a Swagger 2.0 definition (format: %s)', async format => { | ||
| const spec = require.resolve(`@readme/oas-examples/2.0/${format}/petstore.${format}`); | ||
|
|
||
| await expect( | ||
| reducer.run({ | ||
| spec, | ||
| }) | ||
| ).rejects.toStrictEqual(new Error('Sorry, this reducer feature in rdme only supports OpenAPI 3.0+ definitions.')); | ||
| }); | ||
|
|
||
| it('should fail if you attempt to reduce a spec to nothing', async () => { | ||
| const spec = require.resolve('@readme/oas-examples/3.0/json/petstore.json'); | ||
|
|
||
| prompts.inject(['tags', ['unknown-tag'], 'output.json']); | ||
|
|
||
| await expect( | ||
| reducer.run({ | ||
| spec, | ||
| }) | ||
| ).rejects.toStrictEqual( | ||
| new Error('All paths in the API definition were removed. Did you supply the right path name to reduce by?') | ||
| ); | ||
| }); | ||
| }); | ||
| }); |
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
Oops, something went wrong.