Skip to content

Make direct source include optional #31

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

Merged
merged 2 commits into from
Feb 7, 2025
Merged

Conversation

kimkulling
Copy link
Owner

@kimkulling kimkulling commented Feb 7, 2025

Summary by CodeRabbit

  • Tests

    • Enhanced unit testing support with conditional dependency management to ensure robust integration of the testing framework.
  • Chores

    • Updated debug build output configurations to reflect new project directory structures for improved consistency.

@kimkulling kimkulling added the bug label Feb 7, 2025
Copy link
Contributor

coderabbitai bot commented Feb 7, 2025

Walkthrough

This pull request updates the CMake configuration by introducing conditional handling for GTest. The CMakeLists.txt now checks if GTest is available to determine the appropriate test library linkage and include directories, replacing hardcoded paths with a more flexible configuration. Additionally, the XML recipe files for both gtest and gtest_main have been modified to update the project output directory from the cppcore path to the osre path.

Changes

File(s) Change Summary
CMakeLists.txt Added conditional logic for GTest detection, setting the test_libs variable accordingly; updated test linkage to use test_libs.
contrib/googletest-1.15.2/.../gtest.lib.recipe
contrib/googletest-1.15.2/.../gtest_main.lib.recipe
Updated the <FullPath> element in XML to change the output directory from cppcore/x64/Debug to osre/x64/Debug.

Sequence Diagram(s)

sequenceDiagram
    participant CMake
    participant GTest_Finder
    CMake->>GTest_Finder: find_package(GTest)
    alt GTest Found
      GTest_Finder-->>CMake: GTest::gtest_main
      CMake->>CMake: Set test_libs = GTest::gtest_main
    else GTest Not Found
      GTest_Finder-->>CMake: Not Found
      CMake->>CMake: Set test_libs = gtest_main, include directories, etc.
    end
Loading

Poem

I’m a rabbit, hopping with code so neat,
In conditional branches, I feel the beat.
GTest now checks, with paths that align,
Output paths shifted, everything's fine.
With a leap and a jig, I celebrate this treat! 🐇✨


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between ac7ea59 and 8980906.

📒 Files selected for processing (1)
  • CMakeLists.txt (3 hunks)
🔇 Additional comments (3)
CMakeLists.txt (3)

9-10: Add Optional GTest Package Discovery
The addition of "find_package(GTest)" enables the configuration to detect an already installed GTest package. This approach is well aligned with the objective of making the direct source include optional. Consider, in the future, whether a minimum version requirement might be needed for more robust dependency management.


169-179: Implement Conditional Handling for GTest Fallback
The conditional block correctly checks if GTest is found. When available, it sets "test_libs" to "GTest::gtest_main", otherwise it falls back to using the local GTest source (by setting "test_libs" to "gtest_main", establishing "GTEST_PATH", including the proper directories, and adding the subdirectory). This conditional structure cleanly separates the two scenarios and fulfills the PR objective. Adding a brief inline comment explaining the rationale could further improve future maintainability.


194-194: Update Target Linking with Dynamic Test Library Variable
The update to "target_link_libraries" to use the "${test_libs}" variable ensures that the correct GTest main library is always linked—whether it is provided by the system or sourced from the fallback directory. This change neatly ties into the previous modifications and enhances the configuration's flexibility.


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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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.

@kimkulling kimkulling merged commit 65cf762 into master Feb 7, 2025
1 check passed
@kimkulling kimkulling deleted the bugfix/fix_gtest_linkage branch February 7, 2025 15:06
Copy link

sonarqubecloud bot commented Feb 7, 2025

@coderabbitai coderabbitai bot mentioned this pull request Feb 18, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants