search

FairRootGroup / FairRoot

C++ simulation, reconstruction and analysis framework for particle physics experiments
http://fairroot.gsi.de
Other
57 stars 96 forks source link

tests: Fix #1523 #1525

Closed dennisklein closed 4 months ago

dennisklein commented 4 months ago

Largely based on the research into the problem done by @fuhlig1, thx!

Co-authored-by: @fuhlig1 Co-authored-by: @ChristianTackeGSI

coderabbitai[bot] commented 4 months ago

Walkthrough

The updates encompass improving the CMake configuration for test directories by conditionally including subdirectories based on CMake version and integrating DL_PATHS ${LD_LIBRARY_PATH} into catch_discover_tests function across various example modules. These changes aim to enhance test discovery and execution by ensuring correct dynamic library paths are set, demonstrating a structured approach to maintaining testing compatibility and functionality.

Changes

File Path Change Summary
tests/CMakeLists.txt Conditionally adds base and geobase directories based on CMake version (3.22+).
tests/base/CMakeLists.txt Updates copyright year; adds DL_PATHS option to catch_discover_tests.
tests/examples/.../pixelDetector/CMakeLists.txt Adds DL_PATHS ${LD_LIBRARY_PATH} to catch_discover_tests.
tests/examples/advanced/.../CMakeLists.txt Adds DL_PATHS ${LD_LIBRARY_PATH} to catch_discover_tests in Tutorial3, propagator modules.
tests/examples/simulation/.../CMakeLists.txt Adds DL_PATHS ${LD_LIBRARY_PATH} to catch_discover_tests in Tutorial1, 2, 4 modules.

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 .` - `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 generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@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.` 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 as PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger a review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configration 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.
dennisklein commented 4 months ago

This could benefit from factoring the catch_discover_tests call into a new macro since it should probably handle the case when ${LD_LIBRARY_PATH} is empty. :stuck_out_tongue_winking_eye: at @ChristianTackeGSI - feel free to push to this branch, if you like

fuhlig1 commented 4 months ago

@dennisklein,

you should remove the added versions of Catch2 which were probably added by accident,

dennisklein commented 4 months ago

@dennisklein,

you should remove the added versions of Catch2 which were probably added by accident,

Hm, not sure I understand?

fuhlig1 commented 4 months ago

@dennisklein, you should remove the added versions of Catch2 which were probably added by accident,

Hm, not sure I understand?

If I check the changes on

https://github.com/FairRootGroup/FairRoot/pull/1525

I see 574 changed files.

dennisklein commented 4 months ago

@dennisklein, you should remove the added versions of Catch2 which were probably added by accident,

Hm, not sure I understand?

If I check the changes on

1525

I see 574 changed files.

Yes, that is expected as Catch2 is copied into the source tree.

fuhlig1 commented 4 months ago

@dennisklein, you should remove the added versions of Catch2 which were probably added by accident,

Hm, not sure I understand?

If I check the changes on

1525

I see 574 changed files.

Yes, that is expected as Catch2 is copied into the source tree.

Okay. I see. I though Catch2 is only copied when used.

dennisklein commented 4 months ago

I though Catch2 is only copied when used.

The FetchContent mechanism of CMake could do that, but I believe it is not a good idea to have the configure and build steps do internet downloads. The git clone should be the only step to require one to be online. Otherwise, the project would become a nightmare to package. A packager would have to generate extra Catch2 source treee assets etc

Typically, instead of carrying a copy, one could also solve this by using git submodules. But those impose a new workflow on FairRoot developers which I decided to avoid so far. But I am open to changing that, if you feel dealing with git submodules would be acceptable. They come with their own trade-offs.