search

cpp-linter / cpp-linter-rs

A CLI tool that scans a batch of files with clang-tidy and/or clang-format, then provides feedback in the form of comments, annotations, summaries, and reviews.
https://cpp-linter.github.io/cpp-linter-rs/
MIT License
1 stars 0 forks source link

fix: propagate errors #47

Closed 2bndy5 closed 1 month ago

2bndy5 commented 2 months ago

This follows idiomatic rust error handling by using the anyhow library.

Summary by CodeRabbit

Release Notes

codecov[bot] commented 2 months ago

Codecov Report

Attention: Patch coverage is 93.65079% with 52 lines in your changes missing coverage. Please review.

Project coverage is 97.45%. Comparing base (6f7feb8) to head (f28d22b). Report is 4 commits behind head on main.

Files with missing lines Patch % Lines
cpp-linter/src/rest_api/github/specific_api.rs 86.87% 29 Missing :warning:
cpp-linter/src/rest_api/mod.rs 97.17% 7 Missing :warning:
cpp-linter/src/clang_tools/clang_tidy.rs 83.87% 5 Missing :warning:
cpp-linter/src/clang_tools/mod.rs 90.00% 4 Missing :warning:
cpp-linter/src/rest_api/github/mod.rs 97.43% 4 Missing :warning:
cpp-linter/src/clang_tools/clang_format.rs 91.30% 2 Missing :warning:
cpp-linter/src/run.rs 98.33% 1 Missing :warning:
Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #47 +/- ## ========================================== - Coverage 98.50% 97.45% -1.06% ========================================== Files 14 14 Lines 3144 3295 +151 ========================================== + Hits 3097 3211 +114 - Misses 47 84 +37 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

2bndy5 commented 1 month ago

I've done my best to cover the lines in this patch. There are some lines that I cannot instigate in tests. Most of the lines not covered handle the condition when Client.execute() returns an Error, which means there was a connection or redirection problem (likely rare edge cases). According to the docs:

This method fails if there was an error while sending request, redirect loop was detected or redirect limit was exhausted.

2bndy5 commented 1 month ago

FWIW, I've also been testing this branch in the test repo, and it works!

coderabbitai[bot] commented 1 month ago

Walkthrough

The changes introduce a new configuration file for managing test execution profiles, enhance error handling across various components, and update several workflows and scripts to improve functionality and robustness. Key modifications include the introduction of specific profiles for testing, adjustments to GitHub Actions workflows, and improvements in error reporting and handling within the codebase. Additionally, several structs and functions have been updated to enforce stricter type requirements and provide clearer error messages.

Changes

File Change Summary
.config/nextest.toml Introduces settings for test execution profiles, including Default, CI, and All profiles with specific filters and timeouts.
.github/workflows/bump-n-release.yml Updates the configuration path for orhun/git-cliff-action from config: cliff.toml to config: .config/cliff.toml.
.github/workflows/bump_version.py Modifies the command for generating a changelog to specify the configuration file explicitly.
.github/workflows/python-packaging.yml Adds a step to set up a Python environment using actions/setup-python@v5.
.github/workflows/run-dev-tests.yml Changes testing commands for various Clang versions to improve consistency and clarity.
cpp-linter/Cargo.toml Adds a new dependency anyhow for improved error handling.
cpp-linter/src/... Multiple files updated to enhance error handling using the anyhow crate, including changing function return types to Result and improving error messages throughout various functions and structs.
cpp-linter/tests/... Introduces new test parameters and modifies existing tests to accommodate changes in the logic and structure of the codebase.
cspell.config.yml Adds new words to the spell-check configuration to enhance capabilities.
justfile Modifies the test command to specify a profile for test execution instead of a generic argument.
node-binding/src/lib.rs Changes the return type of the main function to Result<()> for better error handling.
py-binding/src/lib.rs Updates the main function's return type to PyResult<()> for improved clarity in error reporting.

Possibly related PRs

Suggested labels

documentation

Poem

🐇 In the garden where changes bloom,
A new config file dispels the gloom.
With profiles set for tests to run,
Error handling shines like the sun.
Hops of joy in every line,
Code now dances, oh so fine! 🌼

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
🪧 Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , please review it.` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (Invoked using PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. ### Other keywords and placeholders - Add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. - Add `@coderabbitai summary` to generate the high-level summary at a specific location in the PR description. - Add `@coderabbitai` anywhere in the PR title to generate the title automatically. ### CodeRabbit Configuration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.