search

FairRootGroup / FairRoot

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

Add unit tests #1520

Closed fuhlig1 closed 4 months ago

fuhlig1 commented 5 months ago

Add unit tests for classes derived from FairGeoSet. This is the first step to restructure these classes.

Checklist:

fuhlig1 commented 5 months ago

@dennisklein,

please have a look at the unit tests since this my first usage of the catch2 framework. Currently the tests are only testing the functions from the derived classes but not the code from the base class.

coderabbitai[bot] commented 5 months ago
Walkthrough ## Walkthrough The update enhances the project's testing framework by introducing new test suites covering a range of functionalities from basic geometrical properties to advanced simulation features. These additions ensure thorough validation of constructors and member functions across various classes and libraries, contributing to improved testing coverage and reliability of the software. ## Changes | Files | Change Summary | |-------|----------------| | `tests/CMakeLists.txt` | Added subdirectories for simulation, advanced topics, and specific modules. | | `tests/examples/MQ/pixelDetector/...` | Introduced test suite for `FairRoot::ExPixel` library with `test_PixelGeo.cxx` executable and configurations. | | `tests/examples/advanced/Tutorial3/...`
`tests/examples/advanced/propagator/...` | Added test suites for `FairRoot::ExTestDetector` and `FairRoot::ExPropagator` libraries with necessary executables and linking configurations. | | `tests/examples/simulation/...` | New test suites for `FairRoot::ExSimulation1`, `ExSimulation2`, and `ExSimulation4` libraries, including executables and library linking for various `TutorialDetGeo` classes. | | `tests/examples/.../test_*.cxx` | Introduced unit tests for `PixelGeo`, `FairTestDetectorGeo`, `FairTutPropGeo`, and various `TutorialDetGeo` classes to validate constructors and member functions. | ## Possibly related issues - **github/FairRootGroup/FairRoot#1418**: The changes in this update address the objective of improving stability and reliability by enhancing testing coverage and validation of constructors and member functions across different classes and libraries, aligning with the overall goal of addressing memory management issues and preventing program crashes in the FairRoot project.
Recent Review Details **Configuration used: CodeRabbit UI**
Commits Files that changed from the base of the PR and between 5a3fc300e62a7c0e013b7bb702410252a7e88eda and f203e830b64f95a14d0b3d6c943b76b5000fce6c.
Files selected for processing (17) * CMakeLists.txt (4 hunks) * tests/CMakeLists.txt (2 hunks) * tests/examples/CMakeLists.txt (1 hunks) * tests/examples/MQ/pixelDetector/CMakeLists.txt (1 hunks) * tests/examples/MQ/pixelDetector/test_PixelGeo.cxx (1 hunks) * tests/examples/advanced/Tutorial3/CMakeLists.txt (1 hunks) * tests/examples/advanced/Tutorial3/test_FairTestDetectorGeo.cxx (1 hunks) * tests/examples/advanced/propagator/CMakeLists.txt (1 hunks) * tests/examples/advanced/propagator/test_FairTutPropGeo.cxx (1 hunks) * tests/examples/simulation/Tutorial1/CMakeLists.txt (1 hunks) * tests/examples/simulation/Tutorial1/test_FairTutorialDet1Geo.cxx (1 hunks) * tests/examples/simulation/Tutorial2/CMakeLists.txt (1 hunks) * tests/examples/simulation/Tutorial2/test_FairTutorialDet2Geo.cxx (1 hunks) * tests/examples/simulation/Tutorial4/CMakeLists.txt (1 hunks) * tests/examples/simulation/Tutorial4/test_FairTutorialDet4Geo.cxx (1 hunks) * tests/geobase/CMakeLists.txt (1 hunks) * tests/geobase/checks_FairGeoSet.h (1 hunks)
Files skipped from review as they are similar to previous changes (17) * CMakeLists.txt * tests/CMakeLists.txt * tests/examples/CMakeLists.txt * tests/examples/MQ/pixelDetector/CMakeLists.txt * tests/examples/MQ/pixelDetector/test_PixelGeo.cxx * tests/examples/advanced/Tutorial3/CMakeLists.txt * tests/examples/advanced/Tutorial3/test_FairTestDetectorGeo.cxx * tests/examples/advanced/propagator/CMakeLists.txt * tests/examples/advanced/propagator/test_FairTutPropGeo.cxx * tests/examples/simulation/Tutorial1/CMakeLists.txt * tests/examples/simulation/Tutorial1/test_FairTutorialDet1Geo.cxx * tests/examples/simulation/Tutorial2/CMakeLists.txt * tests/examples/simulation/Tutorial2/test_FairTutorialDet2Geo.cxx * tests/examples/simulation/Tutorial4/CMakeLists.txt * tests/examples/simulation/Tutorial4/test_FairTutorialDet4Geo.cxx * tests/geobase/CMakeLists.txt * tests/geobase/checks_FairGeoSet.h
--- 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

The Tutorial1 test suite does not link properly on some systems, disabled it for now until we understand it, see #1523.