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

test: Python test fixes: GSF + EDM4hep #4088

Merged
merged 1 commit into from
Feb 13, 2025

Conversation

paulgessinger
Copy link
Member

@paulgessinger paulgessinger commented Feb 13, 2025

This fixes a few small issues with the GSF debugger (shebangs) and using the python interpreter that runs pytest (otherwise modules might not be available).

It also forces DD4hep to write EDM4hep for the EDM4hep ddsim run, which gives a better error message if DD4hep was built without EDM4hep.

--- END COMMIT MESSAGE ---

Any further description goes here, @-mentions are ok here!

  • Use a conventional commits prefix: quick summary
    • We mostly use feat, fix, refactor, docs, chore and build types.
  • A milestone will be assigned by one of the maintainers

Summary by CodeRabbit

  • Tests

    • Improved execution of testing scripts by explicitly using the current Python interpreter.
    • Enforced simulation output settings for more consistent test outcomes.
  • Chores

    • Updated script headers to reliably detect and use the user's Python environment for smoother execution across different setups.

This fixes a few small issues with the GSF debugger (shebangs) and using
the python interpreter that runs pytest (otherwise modules might not be
available).

It also forces DD4hep to write EDM4hep for the EDM4hep ddsim run, which
gives a better error message if DD4hep was built without EDM4hep.
@paulgessinger paulgessinger added this to the next milestone Feb 13, 2025
Copy link

coderabbitai bot commented Feb 13, 2025

Walkthrough

Modified the code, we have. In the tests, subprocess calls now explicitly use the current Python interpreter, and an EDM4HEP configuration flag is set for simulation tests. The shebang lines in two debugger scripts have been updated to use the environment’s Python interpreter. Remain the overall logic of the tests and scripts, they do.

Changes

File(s) Change Summary
Examples/Python/tests/test_misc.py Modified subprocess calls in test_gsf_debugger to include sys.executable for explicit interpreter usage.
Examples/Python/tests/test_reader.py Added setting of forceEDM4HEP to True in the EDM4HEP simulation configuration.
Examples/Scripts/GsfDebugger/... (make_gsf_verbose_log.py, src/main.py) Updated shebang lines to use /usr/bin/env python3 for dynamic interpreter resolution.

Sequence Diagram(s)

sequenceDiagram
    participant T as Test Runner
    participant P as Python Interpreter (sys.executable)
    participant S as Script (gsf_script/debugger)
    T->>P: Call with script path
    P->>S: Execute script with provided interpreter
    S-->>P: Return execution result
    P-->>T: Pass along result
Loading

Suggested labels

Component - Examples, automerge, Track Fitting

Suggested reviewers

  • andiwand

Poem

In code we trust, change we embrace,
A new interpreter path, a twist in the chase.
Debuggers now follow a smarter course,
With flags set true, simhits gain force.
Hmmm, improvements spark, like stars in space ✨
May the code be with you, in every case!


📜 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 260a143 and f0166d6.

📒 Files selected for processing (4)
  • Examples/Python/tests/test_misc.py (2 hunks)
  • Examples/Python/tests/test_reader.py (1 hunks)
  • Examples/Scripts/GsfDebugger/make_gsf_verbose_log.py (1 hunks)
  • Examples/Scripts/GsfDebugger/src/main.py (1 hunks)
✅ Files skipped from review due to trivial changes (2)
  • Examples/Scripts/GsfDebugger/make_gsf_verbose_log.py
  • Examples/Scripts/GsfDebugger/src/main.py
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: merge-sentinel
🔇 Additional comments (2)
Examples/Python/tests/test_misc.py (1)

47-47: Approve these changes, I do!

Wise modifications these are, using sys.executable to ensure the correct Python interpreter runs our scripts. Prevent environment-related issues, this will.

Also applies to: 57-57

Examples/Python/tests/test_reader.py (1)

281-281:

❓ Verification inconclusive

Approve this change, I do! Yet verify we must.

Enforce EDM4hep output generation, this change does. But verify that DD4hep with EDM4hep support is present, we should.


🏁 Script executed:

#!/bin/bash
# Check if DD4hep is compiled with EDM4hep support
python3 -c "from DDSim.DD4hepSimulation import DD4hepSimulation; sim = DD4hepSimulation(); print('EDM4hep output format:', sim.outputConfig.supportedFormats)"

Length of output: 285


Approval Pending: Manual Verification Required!
Approve the change, I do. Yet, confirm manually that your DD4hep build with EDM4hep support, you have. The verification script, a "ModuleNotFoundError" it raised, showing the DDSim module missing, hmm. Review your build configuration and dependency installation, you must.

✨ Finishing Touches
  • 📝 Generate Docstrings (Beta)

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.

Copy link
Member

@benjaminhuth benjaminhuth left a comment

Choose a reason for hiding this comment

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

LGTM!

@github-actions github-actions bot added the Component - Examples Affects the Examples module label Feb 13, 2025
Copy link

📊: Physics performance monitoring for f0166d6

Full contents

physmon summary

@kodiakhq kodiakhq bot merged commit 9b97473 into acts-project:main Feb 13, 2025
49 checks passed
@paulgessinger paulgessinger modified the milestones: next, v39.1.0 Feb 14, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component - Examples Affects the Examples module
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants