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

Add unit tests for _get_type_id #9

Merged
merged 3 commits into from
Dec 3, 2024
Merged

Add unit tests for _get_type_id #9

merged 3 commits into from
Dec 3, 2024

Conversation

maksimdrachov
Copy link
Member

@maksimdrachov maksimdrachov commented Dec 2, 2024

Summary by CodeRabbit

  • Tests
    • Added new assertions to existing test cases to verify the expected type ID for the repeat(), poll(), and defer() methods in the event loop testing suite.

Copy link

coderabbitai bot commented Dec 3, 2024

Walkthrough

This pull request introduces a new constexpr array named expected_type_id in the tests/test_olg_scheduler.cpp file, which holds the expected type ID for the return types of the repeat(), poll(), and defer() methods. New assertions are added to the EventLoopBasic, EventLoopPoll, and EventLoopDefer_single_overdue test cases to verify that the actual type ID matches the expected type ID. The existing logic and structure of the tests remain unchanged, ensuring the overall functionality of the event loop continues to operate as before.

Changes

File Change Summary
tests/test_olg_scheduler.cpp Introduced a constexpr array expected_type_id and added assertions in multiple test cases to verify type IDs using EXPECT_THAT with ElementsAreArray.

Possibly related PRs

  • Add _get_type_id to Impl #8: The main PR introduces assertions that utilize the _get_type_id_() method, which is added in this retrieved PR, establishing a direct connection between the two changes.

Suggested reviewers

  • serges147

Poem

🐇 In the land of code where bunnies play,
New tests hop in to brighten the day.
With type IDs checked, all snug and tight,
Our event loop dances, a joyous sight!
So let’s celebrate with a cheerful cheer,
For every new test brings us closer, my dear! 🌟


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 3197240 and 16a51a2.

📒 Files selected for processing (1)
  • tests/test_olg_scheduler.cpp (5 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • tests/test_olg_scheduler.cpp

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

🧹 Outside diff range and nitpick comments (1)
tests/test_olg_scheduler.cpp (1)

89-90: Document the significance of the type ID value

The hardcoded type ID array lacks documentation explaining its significance. What does this value represent? Is it a hash? UUID? How was it generated? This context is crucial for maintainability.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between d71dcfa and 8b4a8d1.

📒 Files selected for processing (1)
  • tests/test_olg_scheduler.cpp (1 hunks)

tests/test_olg_scheduler.cpp Outdated Show resolved Hide resolved
// Check the type ID.
constexpr std::array<std::uint8_t, 16> expected_type_id =
{0xB6, 0x87, 0x48, 0xA6, 0x7A, 0xDB, 0x4D, 0xF1, 0xB3, 0x1D, 0xA9, 0x8D, 0x50, 0xA7, 0x82, 0x47};
const auto actual_type_id = Event<Loop::time_point>::_get_type_id_();
Copy link

Choose a reason for hiding this comment

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

💡 Codebase verification

Based on the search results, I can generate the final response:

Method naming convention appears to be inconsistent with the codebase

The codebase consistently uses camelCase for method names (e.g., getDeadline(), getTree(), getParentNode()), while _get_type_id_() is the only method using underscores. This method appears in only two places:

  • include/olg_scheduler/olg_scheduler.hpp (definition)
  • tests/test_olg_scheduler.cpp (usage)
🔗 Analysis chain

Verify method naming convention

The method _get_type_id_() uses double underscores which is an unconventional naming pattern. Consider verifying if this aligns with the project's naming conventions.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check for similar method naming patterns in the codebase

# Search for methods with double underscores
rg -g '*.{cpp,hpp,h}' '_\w+_\(\)' 

# Search for other get methods to verify naming convention
rg -g '*.{cpp,hpp,h}' 'get[A-Z]\w+\(\)'

Length of output: 6155

Copy link
Collaborator

@serges147 serges147 left a comment

Choose a reason for hiding this comment

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

ElementsAreArray is needed if C arrays are compared. For c++ collections you can use ElementsAre (there is already using testing::ElementsAre; BTW).

@maksimdrachov
Copy link
Member Author

maksimdrachov commented Dec 3, 2024

It seems to me like it's cleaner to use ElementsAreArray? (That way I only have to define the type ID only once)

image

If I replace with ElementsAre, I get the following compilation error:

image

@maksimdrachov maksimdrachov merged commit 9a63e04 into master Dec 3, 2024
15 checks passed
@maksimdrachov maksimdrachov deleted the unit-tests branch December 3, 2024 16:24
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