Test geobase shapes

[fuhlig1]

Add tests for the various shapes defined for the FairRoot ASCII file interface. Beside the constructor only the functions to read, print and write the shape parameters are currently tested.

Checklist:

• [ ] Followed the Contributing Guidelines

Summary by CodeRabbit

• New Features

  • Introduced configurations for CTest setup, including test output size, build type, and coverage.
  • Added new test cases for various geometric shapes in the FairGeo module.
  • Introduced classes for testing geometric shapes and sets.

• Bug Fixes

  • Fixed spacing and added const qualifiers to methods in FairGeoRotation and FairGeoVector for improved code readability and const-correctness.

• Chores

  • Updated CMakeLists to conditionally include filesystem in Boost dependencies.
  • Added "third_party" to the CTest coverage exclude list.
  • Disabled certain tests temporarily for FairGeoSet.

• Refactor

  • Changed assertions from REQUIRE to CHECK in test files to improve testing logic.

• Documentation

  • Added detailed comments and documentation for new test functions and configurations.

[coderabbitai[bot]]

Walkthrough

## Walkthrough The recent changes focus on enhancing the `FairRoot` project's build system and testing framework. Updates include adding the `filesystem` dependency, expanding test configurations, and introducing new test cases and utilities for geometric shapes. These changes aim to boost testing coverage, improve build flexibility, and enhance overall code maintainability. ## Changes | File(s) | Change Summary | |----------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `CMakeLists.txt` | Introduced `BUILD_TESTING` condition to include `filesystem` in `boost_dependencies` when building `BASEMQ` or `EXAMPLES`. | | `CTestCustom.cmake` | Added `"third_party"` to the `CTEST_CUSTOM_COVERAGE_EXCLUDE` list. | | `FairRoot_profile_test.cmake` | Added configurations for CTest setup, build options, test repetitions, and result submissions. | | `fairroot/geobase/FairGeoRotation.h`, `fairroot/geobase/FairGeoVector.h` | Updated spacing and added `const` qualifiers to certain methods for improved const-correctness. | | `tests/geobase/CMakeLists.txt` | Modified target link libraries to include `Boost::filesystem`, added test suite configurations, and temporarily disabled specific tests. | | `tests/geobase/FairTestGeo.cxx`, `tests/geobase/FairTestGeo.h` | Introduced `FairTestGeo` class inheriting from `FairGeoSet` with constructor and destructor definitions. | | `tests/geobase/checks_FairGeoBasicShape.h` | Added functions for checking `FairGeoTransform` and `FairGeoBasicShape` operations, including validation of transformation matrices and shape parameters. | | `tests/geobase/checks_FairGeoSet.h` | Changed assertions from `REQUIRE` to `CHECK` for enhanced testing logic flexibility. | | `tests/geobase/data/testdet_brick.geo`, `tests/geobase/data/testmedia.geo` | Added geometric shapes and material data entries for testing purposes. | | `tests/geobase/generate_TestInput.h` | Provided functions for generating volume parameters, creating temporary files, and comparing files for geometric shape testing. | | `tests/geobase/tests_FairGeoSet.cxx`, `tests/geobase/tests_FairGeoShapes.cxx` | Introduced test cases for `FairTestGeo` and various geometric shapes in the `FairGeo` module, focusing on construction and read/write functionality. |

---

Recent Review Details

**Configuration used: CodeRabbit UI** **Review profile: CHILL**

Commits

Files that changed from the base of the PR and between 5a21a653322f06654fa5c470d266aea3e7700c57 and cef9ed77a90dde7e003d5310cb4ee058b66ced90.

Files selected for processing (15)

* CMakeLists.txt (2 hunks) * CTestCustom.cmake (1 hunks) * FairRoot_profile_test.cmake (1 hunks) * fairroot/geobase/FairGeoRotation.h (4 hunks) * fairroot/geobase/FairGeoVector.h (1 hunks) * tests/geobase/CMakeLists.txt (1 hunks) * tests/geobase/FairTestGeo.cxx (1 hunks) * tests/geobase/FairTestGeo.h (1 hunks) * tests/geobase/checks_FairGeoBasicShape.h (1 hunks) * tests/geobase/checks_FairGeoSet.h (1 hunks) * tests/geobase/data/testdet_brick.geo (1 hunks) * tests/geobase/data/testmedia.geo (1 hunks) * tests/geobase/generate_TestInput.h (1 hunks) * tests/geobase/tests_FairGeoSet.cxx (1 hunks) * tests/geobase/tests_FairGeoShapes.cxx (1 hunks)

Files skipped from review as they are similar to previous changes (15)

* CMakeLists.txt * CTestCustom.cmake * FairRoot_profile_test.cmake * fairroot/geobase/FairGeoRotation.h * fairroot/geobase/FairGeoVector.h * tests/geobase/CMakeLists.txt * tests/geobase/FairTestGeo.cxx * tests/geobase/FairTestGeo.h * tests/geobase/checks_FairGeoBasicShape.h * tests/geobase/checks_FairGeoSet.h * tests/geobase/data/testdet_brick.geo * tests/geobase/data/testmedia.geo * tests/geobase/generate_TestInput.h * tests/geobase/tests_FairGeoSet.cxx * tests/geobase/tests_FairGeoShapes.cxx

--- 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]

Suggestion based on https://www.conventionalcommits.org/en/v1.0.0/#summary:

• test(geobase): Add more coverage
• fix(geobase): Add missing const qualifier
• build: Add boost filesystem as test dependency
• test(geobase): Cover the shape classes
• build: Add CMake script to run coverage analysis

[fuhlig1]

Where to put the following block?

• test(geobase): Add more coverage
• fix(geobase): Add missing const qualifier
• build: Add boost filesystem as test dependency
• test(geobase): Cover the shape classes
• build: Add CMake script to run coverage analysis

[dennisklein]

Where to put the following block?

• test(geobase): Add more coverage
• fix(geobase): Add missing const qualifier
• build: Add boost filesystem as test dependency
• test(geobase): Cover the shape classes
• build: Add CMake script to run coverage analysis

It is a suggestion for the title lines of your commits.

[dennisklein]

If we adopt the conventional commits spec, it would help

• the release manager to more easily categorize each commit, and
• guide the developer by choosing the commit granularity

Radek started to using the fix: prefix in his latest PR, and I reviewed yours right after and thought, I'll put an example of how it could look like. Would be interested on your opinion on https://www.conventionalcommits.org/en/v1.0.0/#summary! Btw, there are also linters supporting it, e.g. https://jorisroovers.com/gitlint/latest/rules/contrib_rules/#ct1-contrib-title-conventional-commits

[fuhlig1]

Please take a look at the clang format output of the CI.

Please also take a look at why so many test runs fail (I haven't, to be honest).

The tests are failing due to some problems of our CI cluster. Many of the jobs were not started.

[fuhlig1]

Please take a look at the clang format output of the CI.

Please also take a look at why so many test runs fail (I haven't, to be honest).

The format should be correct now.