Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: increase code coverage #3517

Merged
merged 6 commits into from
Dec 27, 2024
Merged

feat: increase code coverage #3517

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
b5cbb95
increase coverage
vishvamsinh28 Dec 26, 2024
facaa13
apply coderabbit suggestions
vishvamsinh28 Dec 26, 2024
0c5d9d7
Merge branch 'master' into CoverageMax
vishvamsinh28 Dec 27, 2024
e2c7808
Merge branch 'master' into CoverageMax
vishvamsinh28 Dec 27, 2024
c863f71
function update
vishvamsinh28 Dec 27, 2024
6289c28
Update tests/build-pages.test.js
anshgoyalevil Dec 27, 2024
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
2 changes: 1 addition & 1 deletion jest.config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ module.exports = {
coverageReporters: ['text', 'lcov', 'json-summary'],
coverageDirectory: 'coverage',
collectCoverageFrom: ['scripts/**/*.js'],
coveragePathIgnorePatterns: ['scripts/compose.js'],
coveragePathIgnorePatterns: ['scripts/compose.js', 'scripts/tools/categorylist.js', 'scripts/tools/tags-color.js'],
// To disallow netlify edge function tests from running
testMatch: ['**/tests/**/*.test.*', '!**/netlify/**/*.test.*'],
};
1 change: 1 addition & 0 deletions scripts/build-pages.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ const TARGET_DIR = 'pages';
const capitalizeTags = ['table', 'tr', 'td', 'th', 'thead', 'tbody'];

// Check if target directory doesn't exist then create it
/* istanbul ignore next */
if (!fs.existsSync(TARGET_DIR)) {
fs.mkdirSync(TARGET_DIR, { recursive: true });
}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we add a test that enters this if clause?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, added a test for it

Expand Down
5 changes: 5 additions & 0 deletions tests/dashboard/build-dashboard.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -195,4 +195,9 @@ describe('GitHub Discussions Processing', () => {
localConsoleErrorSpy.mockRestore();
});

it('should handle write failures gracefully', async () => {

await expect(writeToFile).rejects.toThrow();
});

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Ensure the test invocation covers the function call.

Your test awaits writeToFile but doesn't explicitly invoke it with parameters. Clarify whether this is intentional. If your intention is to test calling writeToFile() without arguments, adjust the test as follows to ensure it actually attempts a call:

- await expect(writeToFile).rejects.toThrow();
+ await expect(writeToFile()).rejects.toThrow();

Also, remove extra blank lines for compliance with the style guide.

📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
it('should handle write failures gracefully', async () => {
await expect(writeToFile).rejects.toThrow();
});
it('should handle write failures gracefully', async () => {
await expect(writeToFile()).rejects.toThrow();
});
🧰 Tools
🪛 eslint

[error] 199-200: Delete ⏎····

(prettier/prettier)

[error] 201-202: Delete ··⏎

(prettier/prettier)

});
11 changes: 11 additions & 0 deletions tests/index.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ const buildCaseStudiesList = require('../scripts/casestudies');
const buildAdoptersList = require('../scripts/adopters');
const buildFinanceInfoList = require('../scripts/finance');
const start = require('../scripts/index');
const fs = require('fs')

jest.mock('../scripts/build-rss');
jest.mock('../scripts/build-post-list');
Expand Down Expand Up @@ -32,4 +33,14 @@ describe('start function', () => {
expect(buildAdoptersList).toHaveBeenCalled();
expect(buildFinanceInfoList).toHaveBeenCalled();
});

test('should throw an error if no finance data is found', async () => {
jest.spyOn(fs, 'readdirSync').mockReturnValue([]);

await expect(start()).rejects.toThrow('No finance data found in the finance directory.');

expect(buildFinanceInfoList).not.toHaveBeenCalled();

fs.readdirSync.mockRestore();
});
});
Loading