-
-
Notifications
You must be signed in to change notification settings - Fork 694
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'master' into buildPostTest
- Loading branch information
Showing
3 changed files
with
298 additions
and
55 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,79 @@ | ||
| const createToolRepositoryData = ({ | ||
| name = '.asyncapi-tool', | ||
| refId = '61855e7365a881e98c2fe667a658a0005753d873', | ||
| owner = 'asyncapi', | ||
| repoName = 'example-repo', | ||
| description = 'Example repository', | ||
| path = '.asyncapi-tool' | ||
| } = {}) => ({ | ||
| name, | ||
| url: `https://api.github.com/repositories/351453552/contents/${path}?ref=${refId}`, | ||
| repository: { | ||
| full_name: `${owner}/${repoName}`, | ||
| html_url: `https://github.com/${owner}/${repoName}`, | ||
| description, | ||
| owner: { login: owner } | ||
| }, | ||
| path | ||
| }); | ||
|
|
||
| const createToolFileContent = ({ | ||
| title = 'Example Tool', | ||
| description = 'This is an example tool.', | ||
| repoUrl = null, | ||
| categories = ['Category1'], | ||
| hasCommercial = false, | ||
| additionalLinks = {}, | ||
| additionalFilters = {} | ||
| } = {}) => ({ | ||
| title, | ||
| description, | ||
| links: { | ||
| repoUrl: repoUrl || `https://github.com/asyncapi/${encodeURIComponent(title.toLowerCase().replace(/\s+/g, '-'))}`, | ||
| ...additionalLinks | ||
| }, | ||
| filters: { categories, hasCommercial, ...additionalFilters } | ||
| }); | ||
|
|
||
| const createExpectedToolObject = ({ | ||
| title = 'Example Tool', | ||
| description = 'This is an example tool.', | ||
| repoUrl = null, | ||
| categories = ['Category1'], | ||
| hasCommercial = false, | ||
| isAsyncAPIOwner = true, | ||
| additionalLinks = {}, | ||
| additionalFilters = {} | ||
| } = {}) => | ||
| createToolFileContent({ | ||
| title, | ||
| description, | ||
| repoUrl, | ||
| categories, | ||
| hasCommercial, | ||
| additionalLinks, | ||
| additionalFilters: { isAsyncAPIOwner, ...additionalFilters } | ||
| }); | ||
|
|
||
| const createMockData = (tools = []) => ({ | ||
| items: tools.map((tool) => | ||
| typeof tool === 'string' | ||
| ? createToolRepositoryData({ name: `.asyncapi-tool-${tool}`, repoName: tool }) | ||
| : createToolRepositoryData(tool) | ||
| ) | ||
| }); | ||
|
|
||
| const createMalformedYAML = ({ | ||
| title = 'Malformed Tool', | ||
| description = 'This tool has malformed YAML.', | ||
| repoUrl = 'https://github.com/asyncapi/malformed-repo' } = {}) => ` | ||
| title: ${title} | ||
| description: ${description} | ||
| links: | ||
| repoUrl: ${repoUrl} | ||
| filters: | ||
| categories: | ||
| - Category1 | ||
| `; | ||
|
|
||
| module.exports = { createToolFileContent, createExpectedToolObject, createMockData, createMalformedYAML }; |
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,161 @@ | ||
| const axios = require('axios'); | ||
| const { convertTools, createToolObject } = require('../../scripts/tools/tools-object'); | ||
| const { | ||
| createToolFileContent, | ||
| createExpectedToolObject, | ||
| createMockData, | ||
| createMalformedYAML | ||
| } = require('../helper/toolsObjectData'); | ||
|
|
||
| jest.mock('axios'); | ||
| jest.mock('../../scripts/tools/categorylist', () => ({ | ||
| categoryList: [ | ||
| { name: 'Category1', tag: 'Category1', description: 'Description for Category1' }, | ||
| { name: 'Others', tag: 'Others', description: 'Other tools category' }, | ||
| ] | ||
| })); | ||
|
|
||
| describe('Tools Object', () => { | ||
| beforeEach(() => { | ||
| axios.get.mockClear(); | ||
| console.error = jest.fn(); | ||
| }); | ||
|
|
||
| const mockToolData = (toolContent, toolNames = ['valid-tool']) => { | ||
| const mockData = createMockData(toolNames.map((name) => ({ name: `.asyncapi-tool-${name}`, repoName: name }))); | ||
| axios.get.mockResolvedValue({ data: toolContent }); | ||
| return mockData; | ||
| }; | ||
|
|
||
| it('should create a tool object with provided parameters', async () => { | ||
| const toolFile = createToolFileContent({ | ||
| title: 'Test Tool', | ||
| description: 'Test Description', | ||
| hasCommercial: true, | ||
| additionalLinks: { docsUrl: 'https://docs.example.com' } | ||
| }); | ||
|
|
||
| const expected = createExpectedToolObject({ | ||
| title: 'Test Tool', | ||
| description: 'Test Description', | ||
| hasCommercial: true, | ||
| additionalLinks: { docsUrl: 'https://docs.example.com' } | ||
| }); | ||
|
|
||
| const result = await createToolObject( | ||
| toolFile, | ||
| expected.links.repoUrl, | ||
| 'Repository Description', | ||
| true | ||
| ); | ||
|
|
||
| expect(result).toEqual(expected); | ||
| }); | ||
|
|
||
| it('should convert tools data correctly', async () => { | ||
| const toolContent = createToolFileContent({ title: 'Valid Tool', categories: ['Category1'] }); | ||
| const mockData = mockToolData(toolContent); | ||
|
|
||
| const result = await convertTools(mockData); | ||
|
|
||
| expect(result.Category1.toolsList).toHaveLength(1); | ||
| expect(result.Category1.toolsList[0].title).toBe('Valid Tool'); | ||
| }); | ||
|
|
||
| it('should assign tool to Others category if no matching category is found', async () => { | ||
| const toolContent = createToolFileContent({ title: 'Unknown Category Tool', categories: ['UnknownCategory'] }); | ||
| const mockData = mockToolData(toolContent); | ||
|
|
||
| const result = await convertTools(mockData); | ||
|
|
||
| expect(result.Others.toolsList).toHaveLength(1); | ||
| expect(result.Others.toolsList[0].title).toBe('Unknown Category Tool'); | ||
| }); | ||
|
|
||
| it('should log errors for invalid .asyncapi-tool file', async () => { | ||
| const invalidContent = createToolFileContent({ | ||
| title: 'Invalid Tool', | ||
| additionalFilters: { invalidField: true } | ||
| }); | ||
| const mockData = mockToolData(invalidContent); | ||
|
|
||
| await convertTools(mockData); | ||
|
|
||
| expect(console.error).toHaveBeenCalledWith(expect.stringContaining('Script is not failing')); | ||
| expect(console.error).toHaveBeenCalledWith(expect.stringContaining('Invalid .asyncapi-tool file')); | ||
| }); | ||
|
|
||
| it('should add duplicate tool objects to the same category', async () => { | ||
| const toolContent = createToolFileContent({ | ||
| title: 'Duplicate Tool', | ||
| categories: ['Category1'] | ||
| }); | ||
|
|
||
| const mockData = createMockData([ | ||
| { name: '.asyncapi-tool-dup1', repoName: 'dup1' }, | ||
| { name: '.asyncapi-tool-dup2', repoName: 'dup2' } | ||
| ]); | ||
|
|
||
| axios.get.mockResolvedValue({ data: toolContent }); | ||
|
|
||
| const result = await convertTools(mockData); | ||
|
|
||
| expect(result.Category1.toolsList).toHaveLength(2); | ||
| expect(result.Category1.toolsList[0].title).toBe('Duplicate Tool'); | ||
| expect(result.Category1.toolsList[1].title).toBe('Duplicate Tool'); | ||
| }); | ||
|
|
||
| it('should add tool to Others category only once', async () => { | ||
| const toolContent = createToolFileContent({ | ||
| title: 'Duplicate Tool in Others', | ||
| categories: ['UnknownCategory'] | ||
| }); | ||
|
|
||
| const mockData = mockToolData(toolContent); | ||
|
|
||
| const result = await convertTools(mockData); | ||
|
|
||
| expect(result.Others.toolsList).toHaveLength(1); | ||
| expect(result.Others.toolsList[0].title).toBe('Duplicate Tool in Others'); | ||
| }); | ||
|
|
||
| it('should throw an error if axios.get fails', async () => { | ||
| const mockData = createMockData([{ | ||
| name: '.asyncapi-tool-error', | ||
| repoName: 'error-tool' | ||
| }]); | ||
|
|
||
| axios.get.mockRejectedValue(new Error('Network Error')); | ||
|
|
||
| await expect(convertTools(mockData)).rejects.toThrow('Network Error'); | ||
| }); | ||
|
|
||
| it('should handle malformed JSON in tool file', async () => { | ||
| const malformedContent = createMalformedYAML(); | ||
| await expect(convertTools(malformedContent)).rejects.toThrow(); | ||
| }); | ||
|
|
||
| it('should use repository description when tool description is missing', async () => { | ||
| const toolFile = createToolFileContent({ | ||
| title: 'No Description Tool', | ||
| description: '', | ||
| }); | ||
|
|
||
| const repositoryDescription = 'Fallback Repository Description'; | ||
| const mockData = createMockData([{ | ||
| name: '.asyncapi-tool-no-description', | ||
| repoName: 'no-description', | ||
| description: repositoryDescription | ||
| }]); | ||
|
|
||
| axios.get.mockResolvedValue({ data: toolFile }); | ||
|
|
||
| const result = await convertTools(mockData); | ||
|
|
||
| const toolObject = result.Category1.toolsList[0]; | ||
|
|
||
| expect(toolObject.description).toBe(repositoryDescription); | ||
| expect(toolObject.title).toBe('No Description Tool'); | ||
| }); | ||
|
|
||
| }); |