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.

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

Shorten test names #702

Merged
merged 1 commit into from
Sep 29, 2024
Merged

Shorten test names #702

merged 1 commit into from
Sep 29, 2024

Conversation

elazarg
Copy link
Collaborator

@elazarg elazarg commented Sep 29, 2024

Catch2 shows inconsistent number of tests. It may be only due to my Clion setup, but it shows many "not found" tests. I believe the issue has something to do with the length of the test's name, so this PR shorten it. The issue does not reproduce again, but it might not be compeletly solved either.

Summary by CodeRabbit

  • Bug Fixes
    • Simplified the formatting of test case strings for better readability.
    • Updated legacy test case strings for clarity.

These changes enhance the overall clarity of test definitions, contributing to a more streamlined testing process.

Signed-off-by: Elazar Gershuni <[email protected]>
Copy link

coderabbitai bot commented Sep 29, 2024

Walkthrough

The pull request modifies macro definitions in the src/test/test_verify.cpp file to streamline the formatting of test case strings. The changes involve removing the prefix ./check ebpf-samples/ from various test case macros and altering the string for the TEST_SECTION_LEGACY macro. These updates focus on enhancing the clarity of the test case definitions without changing the underlying test logic.

Changes

Files Change Summary
src/test/test_verify.cpp Updated multiple macro definitions to remove the prefix ./check ebpf-samples/ from test case strings and modified the TEST_SECTION_LEGACY string for clarity.

Possibly related PRs

  • Support bpf2bpf calls from ELF files #693: This PR modifies the src/test/test_verify.cpp file by introducing a new macro TEST_PROGRAM_REJECT, which is directly related to the changes made in the main PR that also focuses on macro definitions in the same file.

🐇 In the land of code where macros play,
A prefix was trimmed, brightening the way.
Test cases now clearer, with strings that align,
A hop and a skip, all functions combine!
Let's celebrate changes, with joy we declare,
For clean, simple code is a treasure we share! 🌟


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
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, 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 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 for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 2

📜 Review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE

📥 Commits

Files that changed from the base of the PR and between 7b6a27f and 61efee8.

📒 Files selected for processing (1)
  • src/test/test_verify.cpp (1 hunks)
🔇 Additional comments (7)
src/test/test_verify.cpp (7)

69-71: LGTM: Simplified test case string

The removal of the "./check ebpf-samples/" prefix from the TEST_SECTION macro definition aligns with the PR objective of shortening test names. This change simplifies the test case string without altering the functionality, potentially improving readability and reducing the risk of hitting path length limits.


74-76: LGTM: Consistent simplification of test case string

The TEST_PROGRAM macro definition has been updated in line with the changes made to TEST_SECTION. The removal of the "./check ebpf-samples/" prefix maintains consistency across macro definitions and contributes to the overall goal of shortening test names.


79-81: LGTM: Consistent simplification across macros

The TEST_PROGRAM_REJECT macro has been updated to remove the "./check ebpf-samples/" prefix, maintaining consistency with the changes made to other macros. This change contributes to the overall goal of shortening test names while preserving the macro's functionality.


84-86: LGTM: Consistent simplification of rejection test

The TEST_SECTION_REJECT macro has been updated in line with the other macro changes, removing the "./check ebpf-samples/" prefix. This change maintains consistency across all test macros and contributes to shorter, more manageable test names.


89-94: LGTM: Consistent simplification of strict rejection test

The TEST_SECTION_REJECT_IF_STRICT macro has been updated to remove the "./check ebpf-samples/" prefix, aligning with the changes made to other macros. This modification contributes to the goal of shortening test names while maintaining the macro's functionality and consistency across the test suite.


97-99: LGTM: Simplified failure test case string

The TEST_SECTION_FAIL macro has been updated to remove the "ebpf-samples/" prefix while retaining the "expect failure" prefix. This change aligns with the goal of shortening test names and maintains consistency with other macro modifications. The preservation of the "expect failure" prefix ensures that failure test cases remain clearly identifiable.


102-104: LGTM: Consistent simplification of rejection failure test

The TEST_SECTION_REJECT_FAIL macro has been updated in line with the other macro changes, removing the "ebpf-samples/" prefix while retaining the "expect failure" prefix. This modification maintains consistency across all test macros, contributes to shorter test names, and preserves the clear identification of failure test cases.

src/test/test_verify.cpp Show resolved Hide resolved
src/test/test_verify.cpp Show resolved Hide resolved
@coveralls
Copy link

Coverage Status

coverage: 90.311% (+0.001%) from 90.31%
when pulling 61efee8 on short-test-names
into 7b6a27f on main.

@elazarg elazarg merged commit 6842a10 into main Sep 29, 2024
15 checks passed
@elazarg elazarg deleted the short-test-names branch September 29, 2024 15:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants