Test with SLURM - #726

Merged
jan-janssen merged 13 commits into
mainfrom
slurm
Jul 14, 2025
Merged

Test with SLURM#726
jan-janssen merged 13 commits into
mainfrom
slurm

Conversation

@jan-janssen

@jan-janssenjan-janssen commented Jul 13, 2025

Copy link
Copy Markdown
Member

Summary by CodeRabbit

  • Tests
    • Added new test suites for Slurm-based executors, covering serial, threaded, and parallel execution scenarios, cache management, internal memory handling, and error validation.
  • Chores
    • Expanded automated testing workflows to include Slurm-based unittests for both MPICH and OpenMPI variants, improving coverage and reliability of the test pipeline.

@coderabbitai

coderabbitaiBot commented Jul 13, 2025

Copy link
Copy Markdown
Contributor

Warning

Rate limit exceeded

@jan-janssen has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 18 minutes and 43 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 6961e16 and fc211a2.

📒 Files selected for processing (2)
  • .github/workflows/pipeline.yml (2 hunks)
  • tests/test_slurmjobexecutor.py (1 hunks)

Walkthrough

A new GitHub Actions job unittest_slurm_mpich was added to run Slurm-based tests with an MPICH environment. Two new test modules for SlurmClusterExecutor and SlurmJobExecutor were introduced, providing unit tests covering various execution scenarios. The CI workflow dependencies were updated accordingly.

Changes

File(s)Change Summary
.github/workflows/pipeline.ymlAdded unittest_slurm_mpich job; updated uml job dependencies to include it.
tests/test_slurmclusterexecutor.pyNew test module for SlurmClusterExecutor with MPI function, multiple test cases, and cache directory cleanup.
tests/test_slurmjobexecutor.pyNew test suite for SlurmJobExecutor covering serial, threaded, MPI, batch execution, and internal memory tests.

Sequence Diagram(s)

sequenceDiagram
participant CI as GitHub Actions
participant Slurm as Slurm Setup Action
participant Conda as Conda Setup
participant Tests as Test Runner
CI->>Slurm: Setup Slurm environment (MPICH)
CI->>Conda: Install Python 3.13 and dependencies (env file)
CI->>Tests: Install package (no deps/build isolation)
CI->>Tests: Run Slurm executor test modules
Tests->>Slurm: Submit and manage jobs via Slurm
Slurm->>Tests: Return test results
Tests->>CI: Report pass/fail status
Loading

Possibly related PRs

Poem

🐇 Hopping through CI with a cheerful leap,
New Slurm tests awake from their sleep.
MPI whispers, jobs align,
Executors dance in perfect time.
Cache is cleared, results in sight,
All tests pass—what a delight! 🎉🐰

✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @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.

@jan-janssenjan-janssen linked an issue Jul 13, 2025 that may be closed by this pull request

@coderabbitaicoderabbitaiBot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actionable comments posted: 4

🧹 Nitpick comments (5)
tests/test_slurmjobexecutor.py (2)

1-1: Remove unused import.

The os module is imported but never used in this file.

-import os

10-13: Simplify conditional assignment.

Use a more concise ternary operator for better readability.

-if shutil.which("srun") is not None:- skip_slurm_test = False-else:- skip_slurm_test = True+skip_slurm_test = shutil.which("srun") is None
tests/test_slurmclusterexecutor.py (3)

9-12: Simplify conditional assignment.

Use a more concise ternary operator for better readability.

-if shutil.which("srun") is not None:- skip_slurm_test = False-else:- skip_slurm_test = True+skip_slurm_test = shutil.which("srun") is None

25-28: Fix inconsistent skip message.

The skip message mentions "h5py" but the skip condition doesn't check for h5py availability.

- "h5py or mpi4py or SLRUM are not installed, so the h5py, slurm and mpi4py tests are skipped.",+ "mpi4py or SLURM are not installed, so the slurm and mpi4py tests are skipped.",

Also note the typo "SLRUM" should be "SLURM".


29-29: Consider renaming test class for clarity.

The class name TestCacheExecutorPysqa doesn't clearly indicate it's testing SlurmClusterExecutor.

-class TestCacheExecutorPysqa(unittest.TestCase):+class TestSlurmClusterExecutor(unittest.TestCase):
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between f6e96a2 and 0d83164.

📒 Files selected for processing (3)
  • .github/workflows/pipeline.yml (2 hunks)
  • tests/test_slurmclusterexecutor.py (1 hunks)
  • tests/test_slurmjobexecutor.py (1 hunks)
🧰 Additional context used
🧬 Code Graph Analysis (2)
tests/test_slurmclusterexecutor.py (4)
executorlib/executor/slurm.py (1)
  • SlurmClusterExecutor (23-205)
executorlib/standalone/serialize.py (1)
  • cloudpickle_register (9-28)
tests/test_slurmjobexecutor.py (1)
  • mpi_funct (20-25)
executorlib/task_scheduler/file/hdf.py (1)
  • dump (11-28)
tests/test_slurmjobexecutor.py (2)
executorlib/executor/slurm.py (1)
  • SlurmJobExecutor (208-387)
tests/test_slurmclusterexecutor.py (1)
  • mpi_funct (17-22)
🪛 Ruff (0.11.9)
tests/test_slurmclusterexecutor.py

9-12: Use ternary operator skip_slurm_test = False if shutil.which("srun") is not None else True instead of if-else-block

Replace if-else-block with skip_slurm_test = False if shutil.which("srun") is not None else True

(SIM108)


75-75: Undefined name dump

(F821)

tests/test_slurmjobexecutor.py

1-1: os imported but unused

Remove unused import: os

(F401)


10-13: Use ternary operator skip_slurm_test = False if shutil.which("srun") is not None else True instead of if-else-block

Replace if-else-block with skip_slurm_test = False if shutil.which("srun") is not None else True

(SIM108)

🔇 Additional comments (3)
.github/workflows/pipeline.yml (1)

267-330: LGTM on the Slurm test job structure.

The new Slurm unittest jobs follow the established pattern and include appropriate MySQL service setup and environment configuration.

tests/test_slurmjobexecutor.py (1)

39-119: Excellent test coverage for SlurmJobExecutor.

The test suite comprehensively covers various execution scenarios including serial, parallel, threaded execution, mapping, internal memory handling, and parameter validation.

tests/test_slurmclusterexecutor.py (1)

30-91: Well-structured tests for SlurmClusterExecutor.

The tests effectively cover different executor configurations, cache directory management, and file handling scenarios.

Comment thread.github/workflows/pipeline.yml Outdated
Comment thread.github/workflows/pipeline.yml Outdated
Comment threadtests/test_slurmjobexecutor.py Outdated
self.assertTrue(fs_1.done())
self.assertTrue(fs_2.done())

def test_slurm_executor_serial_no_depencies(self):

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue

Fix typo in method name.

The method name has a typo: "depencies" should be "dependencies".

- def test_slurm_executor_serial_no_depencies(self):+ def test_slurm_executor_serial_no_dependencies(self):
📝 Committable suggestion

‼️IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
deftest_slurm_executor_serial_no_depencies(self):
deftest_slurm_executor_serial_no_dependencies(self):
🤖 Prompt for AI Agents
In tests/test_slurmjobexecutor.py at line 52, the test method name contains a
typo: "depencies" should be corrected to "dependencies". Rename the method from
test_slurm_executor_serial_no_depencies to
test_slurm_executor_serial_no_dependencies to fix the spelling error.

Comment threadtests/test_slurmclusterexecutor.py
@codecov

codecovBot commented Jul 13, 2025

Copy link
Copy Markdown

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.91%. Comparing base (f6e96a2) to head (fc211a2).
Report is 2 commits behind head on main.

Additional details and impacted files
@@ Coverage Diff @@## main #726 +/- ##
=======================================
Coverage 96.91% 96.91% =======================================
Files 30 30 Lines 1363 1363 =======================================
Hits 1321 1321 Misses 42 42 

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@coderabbitaicoderabbitaiBot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actionable comments posted: 1

♻️ Duplicate comments (1)
tests/test_slurmjobexecutor.py (1)

51-51: Fix typo in method name.

The method name has a typo: "depencies" should be "dependencies".

- def test_slurm_executor_serial_no_depencies(self):+ def test_slurm_executor_serial_no_dependencies(self):
🧹 Nitpick comments (1)
tests/test_slurmclusterexecutor.py (1)

89-89: Remove extra space before closing parenthesis.

- file_path = os.path.join("executorlib_cache", file_name )+ file_path = os.path.join("executorlib_cache", file_name)
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 25a06b8 and 6961e16.

📒 Files selected for processing (3)
  • .github/workflows/pipeline.yml (2 hunks)
  • tests/test_slurmclusterexecutor.py (1 hunks)
  • tests/test_slurmjobexecutor.py (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • .github/workflows/pipeline.yml
🧰 Additional context used
🧬 Code Graph Analysis (1)
tests/test_slurmclusterexecutor.py (4)
executorlib/executor/slurm.py (1)
  • SlurmClusterExecutor (23-205)
executorlib/standalone/serialize.py (1)
  • cloudpickle_register (9-28)
executorlib/task_scheduler/file/hdf.py (1)
  • dump (11-28)
tests/test_slurmjobexecutor.py (1)
  • mpi_funct (20-25)
🪛 Ruff (0.11.9)
tests/test_slurmclusterexecutor.py

9-12: Use ternary operator skip_slurm_test = False if shutil.which("srun") is not None else True instead of if-else-block

Replace if-else-block with skip_slurm_test = False if shutil.which("srun") is not None else True

(SIM108)

tests/test_slurmjobexecutor.py

1-1: os imported but unused

Remove unused import: os

(F401)


10-13: Use ternary operator skip_slurm_test = False if shutil.which("srun") is not None else True instead of if-else-block

Replace if-else-block with skip_slurm_test = False if shutil.which("srun") is not None else True

(SIM108)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (13)
  • GitHub Check: unittest_openmpi (macos-latest, 3.13)
  • GitHub Check: unittest_openmpi (ubuntu-latest, 3.13)
  • GitHub Check: unittest_openmpi (ubuntu-latest, 3.11)
  • GitHub Check: unittest_openmpi (ubuntu-latest, 3.12)
  • GitHub Check: unittest_flux_openmpi
  • GitHub Check: unittest_mpich (macos-latest, 3.13)
  • GitHub Check: unittest_slurm_mpich
  • GitHub Check: unittest_flux_mpich
  • GitHub Check: unittest_win
  • GitHub Check: notebooks_integration
  • GitHub Check: benchmark (ubuntu-latest, 3.13, .ci_support/environment-mpich.yml)
  • GitHub Check: benchmark (ubuntu-latest, 3.13, .ci_support/environment-openmpi.yml)
  • GitHub Check: notebooks
🔇 Additional comments (5)
tests/test_slurmclusterexecutor.py (3)

9-13: The skip flag logic is correct.

The conditional check for srun availability is appropriate for skipping tests when SLURM is not installed.


23-33: SLURM submission template is properly configured.

The template includes all necessary SLURM directives and placeholders for dynamic values.


48-106: Test methods comprehensively cover SlurmClusterExecutor functionality.

The tests validate:

  • Basic MPI execution with cache management
  • Execution without working directory specification
  • Cache reuse with existing files

All assertions and test patterns are appropriate.

tests/test_slurmjobexecutor.py (2)

16-34: Helper functions are well-designed for testing.

The functions provide appropriate test cases for serial execution, MPI parallelism, and internal memory management.


40-105: Comprehensive test coverage for SlurmJobExecutor.

The test methods effectively validate:

  • Serial execution with and without dependencies
  • Thread-level parallelism
  • MPI parallel execution
  • Batch job submission via map
  • Internal memory initialization and persistence

All test patterns and assertions are appropriate.

Comment threadtests/test_slurmjobexecutor.py Outdated
@jan-janssen

Copy link
Copy Markdown
MemberAuthor

@liamhuber I added a first set of tests for the SlurmClusterExecutor and the SlurmJobExecutor, maybe this can also be used as an inspiration for adding tests for the SLURM integration in pyiron_workflow.

@liamhuberliamhuber left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Nice, this will indeed be helpful for me to test pyiron_workflow's use of executorlib!

I have security nit thought, a GitHub script simplification to try, and a question, but none of it is blocking.

Comment thread.github/workflows/pipeline.yml
Comment thread.github/workflows/pipeline.yml
Comment threadtests/test_slurmclusterexecutor.py
@jan-janssen
jan-janssen merged commit 15f648f into mainJul 14, 2025
@jan-janssen
jan-janssen deleted the slurm branch July 14, 2025 19:37
liamhuber added a commit to pyiron/pyiron_workflow that referenced this pull request Jul 17, 2025
based on Jan's work in pyiron/executorlib#726
Signed-off-by: liamhuber <liamhuber@greyhavensolutions.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Feature] Test SLURM cluster in continuous integration

2 participants

@jan-janssen@liamhuber
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content

Test with SLURM - #726

Merged
jan-janssen merged 13 commits into
mainfrom
slurm
Jul 14, 2025
Merged

Test with SLURM#726
jan-janssen merged 13 commits into
mainfrom
slurm

Conversation

@jan-janssen

@jan-janssenjan-janssen commented Jul 13, 2025

Copy link
Copy Markdown
Member

Summary by CodeRabbit

  • Tests
    • Added new test suites for Slurm-based executors, covering serial, threaded, and parallel execution scenarios, cache management, internal memory handling, and error validation.
  • Chores
    • Expanded automated testing workflows to include Slurm-based unittests for both MPICH and OpenMPI variants, improving coverage and reliability of the test pipeline.

@coderabbitai

coderabbitaiBot commented Jul 13, 2025

Copy link
Copy Markdown
Contributor

Warning

Rate limit exceeded

@jan-janssen has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 18 minutes and 43 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 6961e16 and fc211a2.

📒 Files selected for processing (2)
  • .github/workflows/pipeline.yml (2 hunks)
  • tests/test_slurmjobexecutor.py (1 hunks)

Walkthrough

A new GitHub Actions job unittest_slurm_mpich was added to run Slurm-based tests with an MPICH environment. Two new test modules for SlurmClusterExecutor and SlurmJobExecutor were introduced, providing unit tests covering various execution scenarios. The CI workflow dependencies were updated accordingly.

Changes

File(s)Change Summary
.github/workflows/pipeline.ymlAdded unittest_slurm_mpich job; updated uml job dependencies to include it.
tests/test_slurmclusterexecutor.pyNew test module for SlurmClusterExecutor with MPI function, multiple test cases, and cache directory cleanup.
tests/test_slurmjobexecutor.pyNew test suite for SlurmJobExecutor covering serial, threaded, MPI, batch execution, and internal memory tests.

Sequence Diagram(s)

sequenceDiagram
participant CI as GitHub Actions
participant Slurm as Slurm Setup Action
participant Conda as Conda Setup
participant Tests as Test Runner
CI->>Slurm: Setup Slurm environment (MPICH)
CI->>Conda: Install Python 3.13 and dependencies (env file)
CI->>Tests: Install package (no deps/build isolation)
CI->>Tests: Run Slurm executor test modules
Tests->>Slurm: Submit and manage jobs via Slurm
Slurm->>Tests: Return test results
Tests->>CI: Report pass/fail status
Loading

Possibly related PRs

Poem

🐇 Hopping through CI with a cheerful leap,
New Slurm tests awake from their sleep.
MPI whispers, jobs align,
Executors dance in perfect time.
Cache is cleared, results in sight,
All tests pass—what a delight! 🎉🐰

✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @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.

@jan-janssenjan-janssen linked an issue Jul 13, 2025 that may be closed by this pull request

@coderabbitaicoderabbitaiBot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actionable comments posted: 4

🧹 Nitpick comments (5)
tests/test_slurmjobexecutor.py (2)

1-1: Remove unused import.

The os module is imported but never used in this file.

-import os

10-13: Simplify conditional assignment.

Use a more concise ternary operator for better readability.

-if shutil.which("srun") is not None:- skip_slurm_test = False-else:- skip_slurm_test = True+skip_slurm_test = shutil.which("srun") is None
tests/test_slurmclusterexecutor.py (3)

9-12: Simplify conditional assignment.

Use a more concise ternary operator for better readability.

-if shutil.which("srun") is not None:- skip_slurm_test = False-else:- skip_slurm_test = True+skip_slurm_test = shutil.which("srun") is None

25-28: Fix inconsistent skip message.

The skip message mentions "h5py" but the skip condition doesn't check for h5py availability.

- "h5py or mpi4py or SLRUM are not installed, so the h5py, slurm and mpi4py tests are skipped.",+ "mpi4py or SLURM are not installed, so the slurm and mpi4py tests are skipped.",

Also note the typo "SLRUM" should be "SLURM".


29-29: Consider renaming test class for clarity.

The class name TestCacheExecutorPysqa doesn't clearly indicate it's testing SlurmClusterExecutor.

-class TestCacheExecutorPysqa(unittest.TestCase):+class TestSlurmClusterExecutor(unittest.TestCase):
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between f6e96a2 and 0d83164.

📒 Files selected for processing (3)
  • .github/workflows/pipeline.yml (2 hunks)
  • tests/test_slurmclusterexecutor.py (1 hunks)
  • tests/test_slurmjobexecutor.py (1 hunks)
🧰 Additional context used
🧬 Code Graph Analysis (2)
tests/test_slurmclusterexecutor.py (4)
executorlib/executor/slurm.py (1)
  • SlurmClusterExecutor (23-205)
executorlib/standalone/serialize.py (1)
  • cloudpickle_register (9-28)
tests/test_slurmjobexecutor.py (1)
  • mpi_funct (20-25)
executorlib/task_scheduler/file/hdf.py (1)
  • dump (11-28)
tests/test_slurmjobexecutor.py (2)
executorlib/executor/slurm.py (1)
  • SlurmJobExecutor (208-387)
tests/test_slurmclusterexecutor.py (1)
  • mpi_funct (17-22)
🪛 Ruff (0.11.9)
tests/test_slurmclusterexecutor.py

9-12: Use ternary operator skip_slurm_test = False if shutil.which("srun") is not None else True instead of if-else-block

Replace if-else-block with skip_slurm_test = False if shutil.which("srun") is not None else True

(SIM108)


75-75: Undefined name dump

(F821)

tests/test_slurmjobexecutor.py

1-1: os imported but unused

Remove unused import: os

(F401)


10-13: Use ternary operator skip_slurm_test = False if shutil.which("srun") is not None else True instead of if-else-block

Replace if-else-block with skip_slurm_test = False if shutil.which("srun") is not None else True

(SIM108)

🔇 Additional comments (3)
.github/workflows/pipeline.yml (1)

267-330: LGTM on the Slurm test job structure.

The new Slurm unittest jobs follow the established pattern and include appropriate MySQL service setup and environment configuration.

tests/test_slurmjobexecutor.py (1)

39-119: Excellent test coverage for SlurmJobExecutor.

The test suite comprehensively covers various execution scenarios including serial, parallel, threaded execution, mapping, internal memory handling, and parameter validation.

tests/test_slurmclusterexecutor.py (1)

30-91: Well-structured tests for SlurmClusterExecutor.

The tests effectively cover different executor configurations, cache directory management, and file handling scenarios.

Comment thread.github/workflows/pipeline.yml Outdated
Comment thread.github/workflows/pipeline.yml Outdated
Comment threadtests/test_slurmjobexecutor.py Outdated
self.assertTrue(fs_1.done())
self.assertTrue(fs_2.done())

def test_slurm_executor_serial_no_depencies(self):

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue

Fix typo in method name.

The method name has a typo: "depencies" should be "dependencies".

- def test_slurm_executor_serial_no_depencies(self):+ def test_slurm_executor_serial_no_dependencies(self):
📝 Committable suggestion

‼️IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
deftest_slurm_executor_serial_no_depencies(self):
deftest_slurm_executor_serial_no_dependencies(self):
🤖 Prompt for AI Agents
In tests/test_slurmjobexecutor.py at line 52, the test method name contains a
typo: "depencies" should be corrected to "dependencies". Rename the method from
test_slurm_executor_serial_no_depencies to
test_slurm_executor_serial_no_dependencies to fix the spelling error.

Comment threadtests/test_slurmclusterexecutor.py
@codecov

codecovBot commented Jul 13, 2025

Copy link
Copy Markdown

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.91%. Comparing base (f6e96a2) to head (fc211a2).
Report is 2 commits behind head on main.

Additional details and impacted files
@@ Coverage Diff @@## main #726 +/- ##
=======================================
Coverage 96.91% 96.91% =======================================
Files 30 30 Lines 1363 1363 =======================================
Hits 1321 1321 Misses 42 42 

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@coderabbitaicoderabbitaiBot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actionable comments posted: 1

♻️ Duplicate comments (1)
tests/test_slurmjobexecutor.py (1)

51-51: Fix typo in method name.

The method name has a typo: "depencies" should be "dependencies".

- def test_slurm_executor_serial_no_depencies(self):+ def test_slurm_executor_serial_no_dependencies(self):
🧹 Nitpick comments (1)
tests/test_slurmclusterexecutor.py (1)

89-89: Remove extra space before closing parenthesis.

- file_path = os.path.join("executorlib_cache", file_name )+ file_path = os.path.join("executorlib_cache", file_name)
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 25a06b8 and 6961e16.

📒 Files selected for processing (3)
  • .github/workflows/pipeline.yml (2 hunks)
  • tests/test_slurmclusterexecutor.py (1 hunks)
  • tests/test_slurmjobexecutor.py (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • .github/workflows/pipeline.yml
🧰 Additional context used
🧬 Code Graph Analysis (1)
tests/test_slurmclusterexecutor.py (4)
executorlib/executor/slurm.py (1)
  • SlurmClusterExecutor (23-205)
executorlib/standalone/serialize.py (1)
  • cloudpickle_register (9-28)
executorlib/task_scheduler/file/hdf.py (1)
  • dump (11-28)
tests/test_slurmjobexecutor.py (1)
  • mpi_funct (20-25)
🪛 Ruff (0.11.9)
tests/test_slurmclusterexecutor.py

9-12: Use ternary operator skip_slurm_test = False if shutil.which("srun") is not None else True instead of if-else-block

Replace if-else-block with skip_slurm_test = False if shutil.which("srun") is not None else True

(SIM108)

tests/test_slurmjobexecutor.py

1-1: os imported but unused

Remove unused import: os

(F401)


10-13: Use ternary operator skip_slurm_test = False if shutil.which("srun") is not None else True instead of if-else-block

Replace if-else-block with skip_slurm_test = False if shutil.which("srun") is not None else True

(SIM108)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (13)
  • GitHub Check: unittest_openmpi (macos-latest, 3.13)
  • GitHub Check: unittest_openmpi (ubuntu-latest, 3.13)
  • GitHub Check: unittest_openmpi (ubuntu-latest, 3.11)
  • GitHub Check: unittest_openmpi (ubuntu-latest, 3.12)
  • GitHub Check: unittest_flux_openmpi
  • GitHub Check: unittest_mpich (macos-latest, 3.13)
  • GitHub Check: unittest_slurm_mpich
  • GitHub Check: unittest_flux_mpich
  • GitHub Check: unittest_win
  • GitHub Check: notebooks_integration
  • GitHub Check: benchmark (ubuntu-latest, 3.13, .ci_support/environment-mpich.yml)
  • GitHub Check: benchmark (ubuntu-latest, 3.13, .ci_support/environment-openmpi.yml)
  • GitHub Check: notebooks
🔇 Additional comments (5)
tests/test_slurmclusterexecutor.py (3)

9-13: The skip flag logic is correct.

The conditional check for srun availability is appropriate for skipping tests when SLURM is not installed.


23-33: SLURM submission template is properly configured.

The template includes all necessary SLURM directives and placeholders for dynamic values.


48-106: Test methods comprehensively cover SlurmClusterExecutor functionality.

The tests validate:

  • Basic MPI execution with cache management
  • Execution without working directory specification
  • Cache reuse with existing files

All assertions and test patterns are appropriate.

tests/test_slurmjobexecutor.py (2)

16-34: Helper functions are well-designed for testing.

The functions provide appropriate test cases for serial execution, MPI parallelism, and internal memory management.


40-105: Comprehensive test coverage for SlurmJobExecutor.

The test methods effectively validate:

  • Serial execution with and without dependencies
  • Thread-level parallelism
  • MPI parallel execution
  • Batch job submission via map
  • Internal memory initialization and persistence

All test patterns and assertions are appropriate.

Comment threadtests/test_slurmjobexecutor.py Outdated
@jan-janssen

Copy link
Copy Markdown
MemberAuthor

@liamhuber I added a first set of tests for the SlurmClusterExecutor and the SlurmJobExecutor, maybe this can also be used as an inspiration for adding tests for the SLURM integration in pyiron_workflow.

@liamhuberliamhuber left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Nice, this will indeed be helpful for me to test pyiron_workflow's use of executorlib!

I have security nit thought, a GitHub script simplification to try, and a question, but none of it is blocking.

Comment thread.github/workflows/pipeline.yml
Comment thread.github/workflows/pipeline.yml
Comment threadtests/test_slurmclusterexecutor.py
@jan-janssen
jan-janssen merged commit 15f648f into mainJul 14, 2025
@jan-janssen
jan-janssen deleted the slurm branch July 14, 2025 19:37
liamhuber added a commit to pyiron/pyiron_workflow that referenced this pull request Jul 17, 2025
based on Jan's work in pyiron/executorlib#726
Signed-off-by: liamhuber <liamhuber@greyhavensolutions.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Feature] Test SLURM cluster in continuous integration

2 participants

@jan-janssen@liamhuber
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Test with SLURM - #726

Merged
jan-janssen merged 13 commits into
mainfrom
slurm
Jul 14, 2025
Merged

Test with SLURM#726
jan-janssen merged 13 commits into
mainfrom
slurm

Conversation

@jan-janssen

@jan-janssenjan-janssen commented Jul 13, 2025

Copy link
Copy Markdown
Member

Summary by CodeRabbit

  • Tests
    • Added new test suites for Slurm-based executors, covering serial, threaded, and parallel execution scenarios, cache management, internal memory handling, and error validation.
  • Chores
    • Expanded automated testing workflows to include Slurm-based unittests for both MPICH and OpenMPI variants, improving coverage and reliability of the test pipeline.

@coderabbitai

coderabbitaiBot commented Jul 13, 2025

Copy link
Copy Markdown
Contributor

Warning

Rate limit exceeded

@jan-janssen has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 18 minutes and 43 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 6961e16 and fc211a2.

📒 Files selected for processing (2)
  • .github/workflows/pipeline.yml (2 hunks)
  • tests/test_slurmjobexecutor.py (1 hunks)

Walkthrough

A new GitHub Actions job unittest_slurm_mpich was added to run Slurm-based tests with an MPICH environment. Two new test modules for SlurmClusterExecutor and SlurmJobExecutor were introduced, providing unit tests covering various execution scenarios. The CI workflow dependencies were updated accordingly.

Changes

File(s)Change Summary
.github/workflows/pipeline.ymlAdded unittest_slurm_mpich job; updated uml job dependencies to include it.
tests/test_slurmclusterexecutor.pyNew test module for SlurmClusterExecutor with MPI function, multiple test cases, and cache directory cleanup.
tests/test_slurmjobexecutor.pyNew test suite for SlurmJobExecutor covering serial, threaded, MPI, batch execution, and internal memory tests.

Sequence Diagram(s)

sequenceDiagram
participant CI as GitHub Actions
participant Slurm as Slurm Setup Action
participant Conda as Conda Setup
participant Tests as Test Runner
CI->>Slurm: Setup Slurm environment (MPICH)
CI->>Conda: Install Python 3.13 and dependencies (env file)
CI->>Tests: Install package (no deps/build isolation)
CI->>Tests: Run Slurm executor test modules
Tests->>Slurm: Submit and manage jobs via Slurm
Slurm->>Tests: Return test results
Tests->>CI: Report pass/fail status
Loading

Possibly related PRs

Poem

🐇 Hopping through CI with a cheerful leap,
New Slurm tests awake from their sleep.
MPI whispers, jobs align,
Executors dance in perfect time.
Cache is cleared, results in sight,
All tests pass—what a delight! 🎉🐰

✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @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.

@jan-janssenjan-janssen linked an issue Jul 13, 2025 that may be closed by this pull request

@coderabbitaicoderabbitaiBot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actionable comments posted: 4

🧹 Nitpick comments (5)
tests/test_slurmjobexecutor.py (2)

1-1: Remove unused import.

The os module is imported but never used in this file.

-import os

10-13: Simplify conditional assignment.

Use a more concise ternary operator for better readability.

-if shutil.which("srun") is not None:- skip_slurm_test = False-else:- skip_slurm_test = True+skip_slurm_test = shutil.which("srun") is None
tests/test_slurmclusterexecutor.py (3)

9-12: Simplify conditional assignment.

Use a more concise ternary operator for better readability.

-if shutil.which("srun") is not None:- skip_slurm_test = False-else:- skip_slurm_test = True+skip_slurm_test = shutil.which("srun") is None

25-28: Fix inconsistent skip message.

The skip message mentions "h5py" but the skip condition doesn't check for h5py availability.

- "h5py or mpi4py or SLRUM are not installed, so the h5py, slurm and mpi4py tests are skipped.",+ "mpi4py or SLURM are not installed, so the slurm and mpi4py tests are skipped.",

Also note the typo "SLRUM" should be "SLURM".


29-29: Consider renaming test class for clarity.

The class name TestCacheExecutorPysqa doesn't clearly indicate it's testing SlurmClusterExecutor.

-class TestCacheExecutorPysqa(unittest.TestCase):+class TestSlurmClusterExecutor(unittest.TestCase):
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between f6e96a2 and 0d83164.

📒 Files selected for processing (3)
  • .github/workflows/pipeline.yml (2 hunks)
  • tests/test_slurmclusterexecutor.py (1 hunks)
  • tests/test_slurmjobexecutor.py (1 hunks)
🧰 Additional context used
🧬 Code Graph Analysis (2)
tests/test_slurmclusterexecutor.py (4)
executorlib/executor/slurm.py (1)
  • SlurmClusterExecutor (23-205)
executorlib/standalone/serialize.py (1)
  • cloudpickle_register (9-28)
tests/test_slurmjobexecutor.py (1)
  • mpi_funct (20-25)
executorlib/task_scheduler/file/hdf.py (1)
  • dump (11-28)
tests/test_slurmjobexecutor.py (2)
executorlib/executor/slurm.py (1)
  • SlurmJobExecutor (208-387)
tests/test_slurmclusterexecutor.py (1)
  • mpi_funct (17-22)
🪛 Ruff (0.11.9)
tests/test_slurmclusterexecutor.py

9-12: Use ternary operator skip_slurm_test = False if shutil.which("srun") is not None else True instead of if-else-block

Replace if-else-block with skip_slurm_test = False if shutil.which("srun") is not None else True

(SIM108)


75-75: Undefined name dump

(F821)

tests/test_slurmjobexecutor.py

1-1: os imported but unused

Remove unused import: os

(F401)


10-13: Use ternary operator skip_slurm_test = False if shutil.which("srun") is not None else True instead of if-else-block

Replace if-else-block with skip_slurm_test = False if shutil.which("srun") is not None else True

(SIM108)

🔇 Additional comments (3)
.github/workflows/pipeline.yml (1)

267-330: LGTM on the Slurm test job structure.

The new Slurm unittest jobs follow the established pattern and include appropriate MySQL service setup and environment configuration.

tests/test_slurmjobexecutor.py (1)

39-119: Excellent test coverage for SlurmJobExecutor.

The test suite comprehensively covers various execution scenarios including serial, parallel, threaded execution, mapping, internal memory handling, and parameter validation.

tests/test_slurmclusterexecutor.py (1)

30-91: Well-structured tests for SlurmClusterExecutor.

The tests effectively cover different executor configurations, cache directory management, and file handling scenarios.

Comment thread.github/workflows/pipeline.yml Outdated
Comment thread.github/workflows/pipeline.yml Outdated
Comment threadtests/test_slurmjobexecutor.py Outdated
self.assertTrue(fs_1.done())
self.assertTrue(fs_2.done())

def test_slurm_executor_serial_no_depencies(self):

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue

Fix typo in method name.

The method name has a typo: "depencies" should be "dependencies".

- def test_slurm_executor_serial_no_depencies(self):+ def test_slurm_executor_serial_no_dependencies(self):
📝 Committable suggestion

‼️IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
deftest_slurm_executor_serial_no_depencies(self):
deftest_slurm_executor_serial_no_dependencies(self):
🤖 Prompt for AI Agents
In tests/test_slurmjobexecutor.py at line 52, the test method name contains a
typo: "depencies" should be corrected to "dependencies". Rename the method from
test_slurm_executor_serial_no_depencies to
test_slurm_executor_serial_no_dependencies to fix the spelling error.

Comment threadtests/test_slurmclusterexecutor.py
@codecov

codecovBot commented Jul 13, 2025

Copy link
Copy Markdown

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.91%. Comparing base (f6e96a2) to head (fc211a2).
Report is 2 commits behind head on main.

Additional details and impacted files
@@ Coverage Diff @@## main #726 +/- ##
=======================================
Coverage 96.91% 96.91% =======================================
Files 30 30 Lines 1363 1363 =======================================
Hits 1321 1321 Misses 42 42 

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@coderabbitaicoderabbitaiBot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actionable comments posted: 1

♻️ Duplicate comments (1)
tests/test_slurmjobexecutor.py (1)

51-51: Fix typo in method name.

The method name has a typo: "depencies" should be "dependencies".

- def test_slurm_executor_serial_no_depencies(self):+ def test_slurm_executor_serial_no_dependencies(self):
🧹 Nitpick comments (1)
tests/test_slurmclusterexecutor.py (1)

89-89: Remove extra space before closing parenthesis.

- file_path = os.path.join("executorlib_cache", file_name )+ file_path = os.path.join("executorlib_cache", file_name)
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 25a06b8 and 6961e16.

📒 Files selected for processing (3)
  • .github/workflows/pipeline.yml (2 hunks)
  • tests/test_slurmclusterexecutor.py (1 hunks)
  • tests/test_slurmjobexecutor.py (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • .github/workflows/pipeline.yml
🧰 Additional context used
🧬 Code Graph Analysis (1)
tests/test_slurmclusterexecutor.py (4)
executorlib/executor/slurm.py (1)
  • SlurmClusterExecutor (23-205)
executorlib/standalone/serialize.py (1)
  • cloudpickle_register (9-28)
executorlib/task_scheduler/file/hdf.py (1)
  • dump (11-28)
tests/test_slurmjobexecutor.py (1)
  • mpi_funct (20-25)
🪛 Ruff (0.11.9)
tests/test_slurmclusterexecutor.py

9-12: Use ternary operator skip_slurm_test = False if shutil.which("srun") is not None else True instead of if-else-block

Replace if-else-block with skip_slurm_test = False if shutil.which("srun") is not None else True

(SIM108)

tests/test_slurmjobexecutor.py

1-1: os imported but unused

Remove unused import: os

(F401)


10-13: Use ternary operator skip_slurm_test = False if shutil.which("srun") is not None else True instead of if-else-block

Replace if-else-block with skip_slurm_test = False if shutil.which("srun") is not None else True

(SIM108)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (13)
  • GitHub Check: unittest_openmpi (macos-latest, 3.13)
  • GitHub Check: unittest_openmpi (ubuntu-latest, 3.13)
  • GitHub Check: unittest_openmpi (ubuntu-latest, 3.11)
  • GitHub Check: unittest_openmpi (ubuntu-latest, 3.12)
  • GitHub Check: unittest_flux_openmpi
  • GitHub Check: unittest_mpich (macos-latest, 3.13)
  • GitHub Check: unittest_slurm_mpich
  • GitHub Check: unittest_flux_mpich
  • GitHub Check: unittest_win
  • GitHub Check: notebooks_integration
  • GitHub Check: benchmark (ubuntu-latest, 3.13, .ci_support/environment-mpich.yml)
  • GitHub Check: benchmark (ubuntu-latest, 3.13, .ci_support/environment-openmpi.yml)
  • GitHub Check: notebooks
🔇 Additional comments (5)
tests/test_slurmclusterexecutor.py (3)

9-13: The skip flag logic is correct.

The conditional check for srun availability is appropriate for skipping tests when SLURM is not installed.


23-33: SLURM submission template is properly configured.

The template includes all necessary SLURM directives and placeholders for dynamic values.


48-106: Test methods comprehensively cover SlurmClusterExecutor functionality.

The tests validate:

  • Basic MPI execution with cache management
  • Execution without working directory specification
  • Cache reuse with existing files

All assertions and test patterns are appropriate.

tests/test_slurmjobexecutor.py (2)

16-34: Helper functions are well-designed for testing.

The functions provide appropriate test cases for serial execution, MPI parallelism, and internal memory management.


40-105: Comprehensive test coverage for SlurmJobExecutor.

The test methods effectively validate:

  • Serial execution with and without dependencies
  • Thread-level parallelism
  • MPI parallel execution
  • Batch job submission via map
  • Internal memory initialization and persistence

All test patterns and assertions are appropriate.

Comment threadtests/test_slurmjobexecutor.py Outdated
@jan-janssen

Copy link
Copy Markdown
MemberAuthor

@liamhuber I added a first set of tests for the SlurmClusterExecutor and the SlurmJobExecutor, maybe this can also be used as an inspiration for adding tests for the SLURM integration in pyiron_workflow.

@liamhuberliamhuber left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Nice, this will indeed be helpful for me to test pyiron_workflow's use of executorlib!

I have security nit thought, a GitHub script simplification to try, and a question, but none of it is blocking.

Comment thread.github/workflows/pipeline.yml
Comment thread.github/workflows/pipeline.yml
Comment threadtests/test_slurmclusterexecutor.py
@jan-janssen
jan-janssen merged commit 15f648f into mainJul 14, 2025
@jan-janssen
jan-janssen deleted the slurm branch July 14, 2025 19:37
liamhuber added a commit to pyiron/pyiron_workflow that referenced this pull request Jul 17, 2025
based on Jan's work in pyiron/executorlib#726
Signed-off-by: liamhuber <liamhuber@greyhavensolutions.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Feature] Test SLURM cluster in continuous integration

2 participants

@jan-janssen@liamhuber
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Test with SLURM - #726

Merged
jan-janssen merged 13 commits into
mainfrom
slurm
Jul 14, 2025
Merged

Test with SLURM#726
jan-janssen merged 13 commits into
mainfrom
slurm

Conversation

@jan-janssen

@jan-janssenjan-janssen commented Jul 13, 2025

Copy link
Copy Markdown
Member

Summary by CodeRabbit

  • Tests
    • Added new test suites for Slurm-based executors, covering serial, threaded, and parallel execution scenarios, cache management, internal memory handling, and error validation.
  • Chores
    • Expanded automated testing workflows to include Slurm-based unittests for both MPICH and OpenMPI variants, improving coverage and reliability of the test pipeline.

@coderabbitai

coderabbitaiBot commented Jul 13, 2025

Copy link
Copy Markdown
Contributor

Warning

Rate limit exceeded

@jan-janssen has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 18 minutes and 43 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 6961e16 and fc211a2.

📒 Files selected for processing (2)
  • .github/workflows/pipeline.yml (2 hunks)
  • tests/test_slurmjobexecutor.py (1 hunks)

Walkthrough

A new GitHub Actions job unittest_slurm_mpich was added to run Slurm-based tests with an MPICH environment. Two new test modules for SlurmClusterExecutor and SlurmJobExecutor were introduced, providing unit tests covering various execution scenarios. The CI workflow dependencies were updated accordingly.

Changes

File(s)Change Summary
.github/workflows/pipeline.ymlAdded unittest_slurm_mpich job; updated uml job dependencies to include it.
tests/test_slurmclusterexecutor.pyNew test module for SlurmClusterExecutor with MPI function, multiple test cases, and cache directory cleanup.
tests/test_slurmjobexecutor.pyNew test suite for SlurmJobExecutor covering serial, threaded, MPI, batch execution, and internal memory tests.

Sequence Diagram(s)

sequenceDiagram
participant CI as GitHub Actions
participant Slurm as Slurm Setup Action
participant Conda as Conda Setup
participant Tests as Test Runner
CI->>Slurm: Setup Slurm environment (MPICH)
CI->>Conda: Install Python 3.13 and dependencies (env file)
CI->>Tests: Install package (no deps/build isolation)
CI->>Tests: Run Slurm executor test modules
Tests->>Slurm: Submit and manage jobs via Slurm
Slurm->>Tests: Return test results
Tests->>CI: Report pass/fail status
Loading

Possibly related PRs

Poem

🐇 Hopping through CI with a cheerful leap,
New Slurm tests awake from their sleep.
MPI whispers, jobs align,
Executors dance in perfect time.
Cache is cleared, results in sight,
All tests pass—what a delight! 🎉🐰

✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @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.

@jan-janssenjan-janssen linked an issue Jul 13, 2025 that may be closed by this pull request

@coderabbitaicoderabbitaiBot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actionable comments posted: 4

🧹 Nitpick comments (5)
tests/test_slurmjobexecutor.py (2)

1-1: Remove unused import.

The os module is imported but never used in this file.

-import os

10-13: Simplify conditional assignment.

Use a more concise ternary operator for better readability.

-if shutil.which("srun") is not None:- skip_slurm_test = False-else:- skip_slurm_test = True+skip_slurm_test = shutil.which("srun") is None
tests/test_slurmclusterexecutor.py (3)

9-12: Simplify conditional assignment.

Use a more concise ternary operator for better readability.

-if shutil.which("srun") is not None:- skip_slurm_test = False-else:- skip_slurm_test = True+skip_slurm_test = shutil.which("srun") is None

25-28: Fix inconsistent skip message.

The skip message mentions "h5py" but the skip condition doesn't check for h5py availability.

- "h5py or mpi4py or SLRUM are not installed, so the h5py, slurm and mpi4py tests are skipped.",+ "mpi4py or SLURM are not installed, so the slurm and mpi4py tests are skipped.",

Also note the typo "SLRUM" should be "SLURM".


29-29: Consider renaming test class for clarity.

The class name TestCacheExecutorPysqa doesn't clearly indicate it's testing SlurmClusterExecutor.

-class TestCacheExecutorPysqa(unittest.TestCase):+class TestSlurmClusterExecutor(unittest.TestCase):
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between f6e96a2 and 0d83164.

📒 Files selected for processing (3)
  • .github/workflows/pipeline.yml (2 hunks)
  • tests/test_slurmclusterexecutor.py (1 hunks)
  • tests/test_slurmjobexecutor.py (1 hunks)
🧰 Additional context used
🧬 Code Graph Analysis (2)
tests/test_slurmclusterexecutor.py (4)
executorlib/executor/slurm.py (1)
  • SlurmClusterExecutor (23-205)
executorlib/standalone/serialize.py (1)
  • cloudpickle_register (9-28)
tests/test_slurmjobexecutor.py (1)
  • mpi_funct (20-25)
executorlib/task_scheduler/file/hdf.py (1)
  • dump (11-28)
tests/test_slurmjobexecutor.py (2)
executorlib/executor/slurm.py (1)
  • SlurmJobExecutor (208-387)
tests/test_slurmclusterexecutor.py (1)
  • mpi_funct (17-22)
🪛 Ruff (0.11.9)
tests/test_slurmclusterexecutor.py

9-12: Use ternary operator skip_slurm_test = False if shutil.which("srun") is not None else True instead of if-else-block

Replace if-else-block with skip_slurm_test = False if shutil.which("srun") is not None else True

(SIM108)


75-75: Undefined name dump

(F821)

tests/test_slurmjobexecutor.py

1-1: os imported but unused

Remove unused import: os

(F401)


10-13: Use ternary operator skip_slurm_test = False if shutil.which("srun") is not None else True instead of if-else-block

Replace if-else-block with skip_slurm_test = False if shutil.which("srun") is not None else True

(SIM108)

🔇 Additional comments (3)
.github/workflows/pipeline.yml (1)

267-330: LGTM on the Slurm test job structure.

The new Slurm unittest jobs follow the established pattern and include appropriate MySQL service setup and environment configuration.

tests/test_slurmjobexecutor.py (1)

39-119: Excellent test coverage for SlurmJobExecutor.

The test suite comprehensively covers various execution scenarios including serial, parallel, threaded execution, mapping, internal memory handling, and parameter validation.

tests/test_slurmclusterexecutor.py (1)

30-91: Well-structured tests for SlurmClusterExecutor.

The tests effectively cover different executor configurations, cache directory management, and file handling scenarios.

Comment thread.github/workflows/pipeline.yml Outdated
Comment thread.github/workflows/pipeline.yml Outdated
Comment threadtests/test_slurmjobexecutor.py Outdated
self.assertTrue(fs_1.done())
self.assertTrue(fs_2.done())

def test_slurm_executor_serial_no_depencies(self):

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue

Fix typo in method name.

The method name has a typo: "depencies" should be "dependencies".

- def test_slurm_executor_serial_no_depencies(self):+ def test_slurm_executor_serial_no_dependencies(self):
📝 Committable suggestion

‼️IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
deftest_slurm_executor_serial_no_depencies(self):
deftest_slurm_executor_serial_no_dependencies(self):
🤖 Prompt for AI Agents
In tests/test_slurmjobexecutor.py at line 52, the test method name contains a
typo: "depencies" should be corrected to "dependencies". Rename the method from
test_slurm_executor_serial_no_depencies to
test_slurm_executor_serial_no_dependencies to fix the spelling error.

Comment threadtests/test_slurmclusterexecutor.py
@codecov

codecovBot commented Jul 13, 2025

Copy link
Copy Markdown

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.91%. Comparing base (f6e96a2) to head (fc211a2).
Report is 2 commits behind head on main.

Additional details and impacted files
@@ Coverage Diff @@## main #726 +/- ##
=======================================
Coverage 96.91% 96.91% =======================================
Files 30 30 Lines 1363 1363 =======================================
Hits 1321 1321 Misses 42 42 

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@coderabbitaicoderabbitaiBot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actionable comments posted: 1

♻️ Duplicate comments (1)
tests/test_slurmjobexecutor.py (1)

51-51: Fix typo in method name.

The method name has a typo: "depencies" should be "dependencies".

- def test_slurm_executor_serial_no_depencies(self):+ def test_slurm_executor_serial_no_dependencies(self):
🧹 Nitpick comments (1)
tests/test_slurmclusterexecutor.py (1)

89-89: Remove extra space before closing parenthesis.

- file_path = os.path.join("executorlib_cache", file_name )+ file_path = os.path.join("executorlib_cache", file_name)
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 25a06b8 and 6961e16.

📒 Files selected for processing (3)
  • .github/workflows/pipeline.yml (2 hunks)
  • tests/test_slurmclusterexecutor.py (1 hunks)
  • tests/test_slurmjobexecutor.py (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • .github/workflows/pipeline.yml
🧰 Additional context used
🧬 Code Graph Analysis (1)
tests/test_slurmclusterexecutor.py (4)
executorlib/executor/slurm.py (1)
  • SlurmClusterExecutor (23-205)
executorlib/standalone/serialize.py (1)
  • cloudpickle_register (9-28)
executorlib/task_scheduler/file/hdf.py (1)
  • dump (11-28)
tests/test_slurmjobexecutor.py (1)
  • mpi_funct (20-25)
🪛 Ruff (0.11.9)
tests/test_slurmclusterexecutor.py

9-12: Use ternary operator skip_slurm_test = False if shutil.which("srun") is not None else True instead of if-else-block

Replace if-else-block with skip_slurm_test = False if shutil.which("srun") is not None else True

(SIM108)

tests/test_slurmjobexecutor.py

1-1: os imported but unused

Remove unused import: os

(F401)


10-13: Use ternary operator skip_slurm_test = False if shutil.which("srun") is not None else True instead of if-else-block

Replace if-else-block with skip_slurm_test = False if shutil.which("srun") is not None else True

(SIM108)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (13)
  • GitHub Check: unittest_openmpi (macos-latest, 3.13)
  • GitHub Check: unittest_openmpi (ubuntu-latest, 3.13)
  • GitHub Check: unittest_openmpi (ubuntu-latest, 3.11)
  • GitHub Check: unittest_openmpi (ubuntu-latest, 3.12)
  • GitHub Check: unittest_flux_openmpi
  • GitHub Check: unittest_mpich (macos-latest, 3.13)
  • GitHub Check: unittest_slurm_mpich
  • GitHub Check: unittest_flux_mpich
  • GitHub Check: unittest_win
  • GitHub Check: notebooks_integration
  • GitHub Check: benchmark (ubuntu-latest, 3.13, .ci_support/environment-mpich.yml)
  • GitHub Check: benchmark (ubuntu-latest, 3.13, .ci_support/environment-openmpi.yml)
  • GitHub Check: notebooks
🔇 Additional comments (5)
tests/test_slurmclusterexecutor.py (3)

9-13: The skip flag logic is correct.

The conditional check for srun availability is appropriate for skipping tests when SLURM is not installed.


23-33: SLURM submission template is properly configured.

The template includes all necessary SLURM directives and placeholders for dynamic values.


48-106: Test methods comprehensively cover SlurmClusterExecutor functionality.

The tests validate:

  • Basic MPI execution with cache management
  • Execution without working directory specification
  • Cache reuse with existing files

All assertions and test patterns are appropriate.

tests/test_slurmjobexecutor.py (2)

16-34: Helper functions are well-designed for testing.

The functions provide appropriate test cases for serial execution, MPI parallelism, and internal memory management.


40-105: Comprehensive test coverage for SlurmJobExecutor.

The test methods effectively validate:

  • Serial execution with and without dependencies
  • Thread-level parallelism
  • MPI parallel execution
  • Batch job submission via map
  • Internal memory initialization and persistence

All test patterns and assertions are appropriate.

Comment threadtests/test_slurmjobexecutor.py Outdated
@jan-janssen

Copy link
Copy Markdown
MemberAuthor

@liamhuber I added a first set of tests for the SlurmClusterExecutor and the SlurmJobExecutor, maybe this can also be used as an inspiration for adding tests for the SLURM integration in pyiron_workflow.

@liamhuberliamhuber left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Nice, this will indeed be helpful for me to test pyiron_workflow's use of executorlib!

I have security nit thought, a GitHub script simplification to try, and a question, but none of it is blocking.

Comment thread.github/workflows/pipeline.yml
Comment thread.github/workflows/pipeline.yml
Comment threadtests/test_slurmclusterexecutor.py
@jan-janssen
jan-janssen merged commit 15f648f into mainJul 14, 2025
@jan-janssen
jan-janssen deleted the slurm branch July 14, 2025 19:37
liamhuber added a commit to pyiron/pyiron_workflow that referenced this pull request Jul 17, 2025
based on Jan's work in pyiron/executorlib#726
Signed-off-by: liamhuber <liamhuber@greyhavensolutions.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Feature] Test SLURM cluster in continuous integration

2 participants

@jan-janssen@liamhuber
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content

Test with SLURM - #726

Merged
jan-janssen merged 13 commits into
mainfrom
slurm
Jul 14, 2025
Merged

Test with SLURM#726
jan-janssen merged 13 commits into
mainfrom
slurm

Conversation

@jan-janssen

@jan-janssenjan-janssen commented Jul 13, 2025

Copy link
Copy Markdown
Member

Summary by CodeRabbit

  • Tests
    • Added new test suites for Slurm-based executors, covering serial, threaded, and parallel execution scenarios, cache management, internal memory handling, and error validation.
  • Chores
    • Expanded automated testing workflows to include Slurm-based unittests for both MPICH and OpenMPI variants, improving coverage and reliability of the test pipeline.

@coderabbitai

coderabbitaiBot commented Jul 13, 2025

Copy link
Copy Markdown
Contributor

Warning

Rate limit exceeded

@jan-janssen has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 18 minutes and 43 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 6961e16 and fc211a2.

📒 Files selected for processing (2)
  • .github/workflows/pipeline.yml (2 hunks)
  • tests/test_slurmjobexecutor.py (1 hunks)

Walkthrough

A new GitHub Actions job unittest_slurm_mpich was added to run Slurm-based tests with an MPICH environment. Two new test modules for SlurmClusterExecutor and SlurmJobExecutor were introduced, providing unit tests covering various execution scenarios. The CI workflow dependencies were updated accordingly.

Changes

File(s)Change Summary
.github/workflows/pipeline.ymlAdded unittest_slurm_mpich job; updated uml job dependencies to include it.
tests/test_slurmclusterexecutor.pyNew test module for SlurmClusterExecutor with MPI function, multiple test cases, and cache directory cleanup.
tests/test_slurmjobexecutor.pyNew test suite for SlurmJobExecutor covering serial, threaded, MPI, batch execution, and internal memory tests.

Sequence Diagram(s)

sequenceDiagram
participant CI as GitHub Actions
participant Slurm as Slurm Setup Action
participant Conda as Conda Setup
participant Tests as Test Runner
CI->>Slurm: Setup Slurm environment (MPICH)
CI->>Conda: Install Python 3.13 and dependencies (env file)
CI->>Tests: Install package (no deps/build isolation)
CI->>Tests: Run Slurm executor test modules
Tests->>Slurm: Submit and manage jobs via Slurm
Slurm->>Tests: Return test results
Tests->>CI: Report pass/fail status
Loading

Possibly related PRs

Poem

🐇 Hopping through CI with a cheerful leap,
New Slurm tests awake from their sleep.
MPI whispers, jobs align,
Executors dance in perfect time.
Cache is cleared, results in sight,
All tests pass—what a delight! 🎉🐰

✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @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.

@jan-janssenjan-janssen linked an issue Jul 13, 2025 that may be closed by this pull request

@coderabbitaicoderabbitaiBot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actionable comments posted: 4

🧹 Nitpick comments (5)
tests/test_slurmjobexecutor.py (2)

1-1: Remove unused import.

The os module is imported but never used in this file.

-import os

10-13: Simplify conditional assignment.

Use a more concise ternary operator for better readability.

-if shutil.which("srun") is not None:- skip_slurm_test = False-else:- skip_slurm_test = True+skip_slurm_test = shutil.which("srun") is None
tests/test_slurmclusterexecutor.py (3)

9-12: Simplify conditional assignment.

Use a more concise ternary operator for better readability.

-if shutil.which("srun") is not None:- skip_slurm_test = False-else:- skip_slurm_test = True+skip_slurm_test = shutil.which("srun") is None

25-28: Fix inconsistent skip message.

The skip message mentions "h5py" but the skip condition doesn't check for h5py availability.

- "h5py or mpi4py or SLRUM are not installed, so the h5py, slurm and mpi4py tests are skipped.",+ "mpi4py or SLURM are not installed, so the slurm and mpi4py tests are skipped.",

Also note the typo "SLRUM" should be "SLURM".


29-29: Consider renaming test class for clarity.

The class name TestCacheExecutorPysqa doesn't clearly indicate it's testing SlurmClusterExecutor.

-class TestCacheExecutorPysqa(unittest.TestCase):+class TestSlurmClusterExecutor(unittest.TestCase):
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between f6e96a2 and 0d83164.

📒 Files selected for processing (3)
  • .github/workflows/pipeline.yml (2 hunks)
  • tests/test_slurmclusterexecutor.py (1 hunks)
  • tests/test_slurmjobexecutor.py (1 hunks)
🧰 Additional context used
🧬 Code Graph Analysis (2)
tests/test_slurmclusterexecutor.py (4)
executorlib/executor/slurm.py (1)
  • SlurmClusterExecutor (23-205)
executorlib/standalone/serialize.py (1)
  • cloudpickle_register (9-28)
tests/test_slurmjobexecutor.py (1)
  • mpi_funct (20-25)
executorlib/task_scheduler/file/hdf.py (1)
  • dump (11-28)
tests/test_slurmjobexecutor.py (2)
executorlib/executor/slurm.py (1)
  • SlurmJobExecutor (208-387)
tests/test_slurmclusterexecutor.py (1)
  • mpi_funct (17-22)
🪛 Ruff (0.11.9)
tests/test_slurmclusterexecutor.py

9-12: Use ternary operator skip_slurm_test = False if shutil.which("srun") is not None else True instead of if-else-block

Replace if-else-block with skip_slurm_test = False if shutil.which("srun") is not None else True

(SIM108)


75-75: Undefined name dump

(F821)

tests/test_slurmjobexecutor.py

1-1: os imported but unused

Remove unused import: os

(F401)


10-13: Use ternary operator skip_slurm_test = False if shutil.which("srun") is not None else True instead of if-else-block

Replace if-else-block with skip_slurm_test = False if shutil.which("srun") is not None else True

(SIM108)

🔇 Additional comments (3)
.github/workflows/pipeline.yml (1)

267-330: LGTM on the Slurm test job structure.

The new Slurm unittest jobs follow the established pattern and include appropriate MySQL service setup and environment configuration.

tests/test_slurmjobexecutor.py (1)

39-119: Excellent test coverage for SlurmJobExecutor.

The test suite comprehensively covers various execution scenarios including serial, parallel, threaded execution, mapping, internal memory handling, and parameter validation.

tests/test_slurmclusterexecutor.py (1)

30-91: Well-structured tests for SlurmClusterExecutor.

The tests effectively cover different executor configurations, cache directory management, and file handling scenarios.

Comment thread.github/workflows/pipeline.yml Outdated
Comment thread.github/workflows/pipeline.yml Outdated
Comment threadtests/test_slurmjobexecutor.py Outdated
self.assertTrue(fs_1.done())
self.assertTrue(fs_2.done())

def test_slurm_executor_serial_no_depencies(self):

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue

Fix typo in method name.

The method name has a typo: "depencies" should be "dependencies".

- def test_slurm_executor_serial_no_depencies(self):+ def test_slurm_executor_serial_no_dependencies(self):
📝 Committable suggestion

‼️IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
deftest_slurm_executor_serial_no_depencies(self):
deftest_slurm_executor_serial_no_dependencies(self):
🤖 Prompt for AI Agents
In tests/test_slurmjobexecutor.py at line 52, the test method name contains a
typo: "depencies" should be corrected to "dependencies". Rename the method from
test_slurm_executor_serial_no_depencies to
test_slurm_executor_serial_no_dependencies to fix the spelling error.

Comment threadtests/test_slurmclusterexecutor.py
@codecov

codecovBot commented Jul 13, 2025

Copy link
Copy Markdown

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.91%. Comparing base (f6e96a2) to head (fc211a2).
Report is 2 commits behind head on main.

Additional details and impacted files
@@ Coverage Diff @@## main #726 +/- ##
=======================================
Coverage 96.91% 96.91% =======================================
Files 30 30 Lines 1363 1363 =======================================
Hits 1321 1321 Misses 42 42 

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@coderabbitaicoderabbitaiBot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actionable comments posted: 1

♻️ Duplicate comments (1)
tests/test_slurmjobexecutor.py (1)

51-51: Fix typo in method name.

The method name has a typo: "depencies" should be "dependencies".

- def test_slurm_executor_serial_no_depencies(self):+ def test_slurm_executor_serial_no_dependencies(self):
🧹 Nitpick comments (1)
tests/test_slurmclusterexecutor.py (1)

89-89: Remove extra space before closing parenthesis.

- file_path = os.path.join("executorlib_cache", file_name )+ file_path = os.path.join("executorlib_cache", file_name)
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 25a06b8 and 6961e16.

📒 Files selected for processing (3)
  • .github/workflows/pipeline.yml (2 hunks)
  • tests/test_slurmclusterexecutor.py (1 hunks)
  • tests/test_slurmjobexecutor.py (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • .github/workflows/pipeline.yml
🧰 Additional context used
🧬 Code Graph Analysis (1)
tests/test_slurmclusterexecutor.py (4)
executorlib/executor/slurm.py (1)
  • SlurmClusterExecutor (23-205)
executorlib/standalone/serialize.py (1)
  • cloudpickle_register (9-28)
executorlib/task_scheduler/file/hdf.py (1)
  • dump (11-28)
tests/test_slurmjobexecutor.py (1)
  • mpi_funct (20-25)
🪛 Ruff (0.11.9)
tests/test_slurmclusterexecutor.py

9-12: Use ternary operator skip_slurm_test = False if shutil.which("srun") is not None else True instead of if-else-block

Replace if-else-block with skip_slurm_test = False if shutil.which("srun") is not None else True

(SIM108)

tests/test_slurmjobexecutor.py

1-1: os imported but unused

Remove unused import: os

(F401)


10-13: Use ternary operator skip_slurm_test = False if shutil.which("srun") is not None else True instead of if-else-block

Replace if-else-block with skip_slurm_test = False if shutil.which("srun") is not None else True

(SIM108)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (13)
  • GitHub Check: unittest_openmpi (macos-latest, 3.13)
  • GitHub Check: unittest_openmpi (ubuntu-latest, 3.13)
  • GitHub Check: unittest_openmpi (ubuntu-latest, 3.11)
  • GitHub Check: unittest_openmpi (ubuntu-latest, 3.12)
  • GitHub Check: unittest_flux_openmpi
  • GitHub Check: unittest_mpich (macos-latest, 3.13)
  • GitHub Check: unittest_slurm_mpich
  • GitHub Check: unittest_flux_mpich
  • GitHub Check: unittest_win
  • GitHub Check: notebooks_integration
  • GitHub Check: benchmark (ubuntu-latest, 3.13, .ci_support/environment-mpich.yml)
  • GitHub Check: benchmark (ubuntu-latest, 3.13, .ci_support/environment-openmpi.yml)
  • GitHub Check: notebooks
🔇 Additional comments (5)
tests/test_slurmclusterexecutor.py (3)

9-13: The skip flag logic is correct.

The conditional check for srun availability is appropriate for skipping tests when SLURM is not installed.


23-33: SLURM submission template is properly configured.

The template includes all necessary SLURM directives and placeholders for dynamic values.


48-106: Test methods comprehensively cover SlurmClusterExecutor functionality.

The tests validate:

  • Basic MPI execution with cache management
  • Execution without working directory specification
  • Cache reuse with existing files

All assertions and test patterns are appropriate.

tests/test_slurmjobexecutor.py (2)

16-34: Helper functions are well-designed for testing.

The functions provide appropriate test cases for serial execution, MPI parallelism, and internal memory management.


40-105: Comprehensive test coverage for SlurmJobExecutor.

The test methods effectively validate:

  • Serial execution with and without dependencies
  • Thread-level parallelism
  • MPI parallel execution
  • Batch job submission via map
  • Internal memory initialization and persistence

All test patterns and assertions are appropriate.

Comment threadtests/test_slurmjobexecutor.py Outdated
@jan-janssen

Copy link
Copy Markdown
MemberAuthor

@liamhuber I added a first set of tests for the SlurmClusterExecutor and the SlurmJobExecutor, maybe this can also be used as an inspiration for adding tests for the SLURM integration in pyiron_workflow.

@liamhuberliamhuber left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Nice, this will indeed be helpful for me to test pyiron_workflow's use of executorlib!

I have security nit thought, a GitHub script simplification to try, and a question, but none of it is blocking.

Comment thread.github/workflows/pipeline.yml
Comment thread.github/workflows/pipeline.yml
Comment threadtests/test_slurmclusterexecutor.py
@jan-janssen
jan-janssen merged commit 15f648f into mainJul 14, 2025
@jan-janssen
jan-janssen deleted the slurm branch July 14, 2025 19:37
liamhuber added a commit to pyiron/pyiron_workflow that referenced this pull request Jul 17, 2025
based on Jan's work in pyiron/executorlib#726
Signed-off-by: liamhuber <liamhuber@greyhavensolutions.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Feature] Test SLURM cluster in continuous integration

2 participants

@jan-janssen@liamhuber
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Test with SLURM - #726

Merged
jan-janssen merged 13 commits into
mainfrom
slurm
Jul 14, 2025
Merged

Test with SLURM#726
jan-janssen merged 13 commits into
mainfrom
slurm

Conversation

@jan-janssen

@jan-janssenjan-janssen commented Jul 13, 2025

Copy link
Copy Markdown
Member

Summary by CodeRabbit

  • Tests
    • Added new test suites for Slurm-based executors, covering serial, threaded, and parallel execution scenarios, cache management, internal memory handling, and error validation.
  • Chores
    • Expanded automated testing workflows to include Slurm-based unittests for both MPICH and OpenMPI variants, improving coverage and reliability of the test pipeline.

@coderabbitai

coderabbitaiBot commented Jul 13, 2025

Copy link
Copy Markdown
Contributor

Warning

Rate limit exceeded

@jan-janssen has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 18 minutes and 43 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 6961e16 and fc211a2.

📒 Files selected for processing (2)
  • .github/workflows/pipeline.yml (2 hunks)
  • tests/test_slurmjobexecutor.py (1 hunks)

Walkthrough

A new GitHub Actions job unittest_slurm_mpich was added to run Slurm-based tests with an MPICH environment. Two new test modules for SlurmClusterExecutor and SlurmJobExecutor were introduced, providing unit tests covering various execution scenarios. The CI workflow dependencies were updated accordingly.

Changes

File(s)Change Summary
.github/workflows/pipeline.ymlAdded unittest_slurm_mpich job; updated uml job dependencies to include it.
tests/test_slurmclusterexecutor.pyNew test module for SlurmClusterExecutor with MPI function, multiple test cases, and cache directory cleanup.
tests/test_slurmjobexecutor.pyNew test suite for SlurmJobExecutor covering serial, threaded, MPI, batch execution, and internal memory tests.

Sequence Diagram(s)

sequenceDiagram
participant CI as GitHub Actions
participant Slurm as Slurm Setup Action
participant Conda as Conda Setup
participant Tests as Test Runner
CI->>Slurm: Setup Slurm environment (MPICH)
CI->>Conda: Install Python 3.13 and dependencies (env file)
CI->>Tests: Install package (no deps/build isolation)
CI->>Tests: Run Slurm executor test modules
Tests->>Slurm: Submit and manage jobs via Slurm
Slurm->>Tests: Return test results
Tests->>CI: Report pass/fail status
Loading

Possibly related PRs

Poem

🐇 Hopping through CI with a cheerful leap,
New Slurm tests awake from their sleep.
MPI whispers, jobs align,
Executors dance in perfect time.
Cache is cleared, results in sight,
All tests pass—what a delight! 🎉🐰

✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @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.

@jan-janssenjan-janssen linked an issue Jul 13, 2025 that may be closed by this pull request

@coderabbitaicoderabbitaiBot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actionable comments posted: 4

🧹 Nitpick comments (5)
tests/test_slurmjobexecutor.py (2)

1-1: Remove unused import.

The os module is imported but never used in this file.

-import os

10-13: Simplify conditional assignment.

Use a more concise ternary operator for better readability.

-if shutil.which("srun") is not None:- skip_slurm_test = False-else:- skip_slurm_test = True+skip_slurm_test = shutil.which("srun") is None
tests/test_slurmclusterexecutor.py (3)

9-12: Simplify conditional assignment.

Use a more concise ternary operator for better readability.

-if shutil.which("srun") is not None:- skip_slurm_test = False-else:- skip_slurm_test = True+skip_slurm_test = shutil.which("srun") is None

25-28: Fix inconsistent skip message.

The skip message mentions "h5py" but the skip condition doesn't check for h5py availability.

- "h5py or mpi4py or SLRUM are not installed, so the h5py, slurm and mpi4py tests are skipped.",+ "mpi4py or SLURM are not installed, so the slurm and mpi4py tests are skipped.",

Also note the typo "SLRUM" should be "SLURM".


29-29: Consider renaming test class for clarity.

The class name TestCacheExecutorPysqa doesn't clearly indicate it's testing SlurmClusterExecutor.

-class TestCacheExecutorPysqa(unittest.TestCase):+class TestSlurmClusterExecutor(unittest.TestCase):
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between f6e96a2 and 0d83164.

📒 Files selected for processing (3)
  • .github/workflows/pipeline.yml (2 hunks)
  • tests/test_slurmclusterexecutor.py (1 hunks)
  • tests/test_slurmjobexecutor.py (1 hunks)
🧰 Additional context used
🧬 Code Graph Analysis (2)
tests/test_slurmclusterexecutor.py (4)
executorlib/executor/slurm.py (1)
  • SlurmClusterExecutor (23-205)
executorlib/standalone/serialize.py (1)
  • cloudpickle_register (9-28)
tests/test_slurmjobexecutor.py (1)
  • mpi_funct (20-25)
executorlib/task_scheduler/file/hdf.py (1)
  • dump (11-28)
tests/test_slurmjobexecutor.py (2)
executorlib/executor/slurm.py (1)
  • SlurmJobExecutor (208-387)
tests/test_slurmclusterexecutor.py (1)
  • mpi_funct (17-22)
🪛 Ruff (0.11.9)
tests/test_slurmclusterexecutor.py

9-12: Use ternary operator skip_slurm_test = False if shutil.which("srun") is not None else True instead of if-else-block

Replace if-else-block with skip_slurm_test = False if shutil.which("srun") is not None else True

(SIM108)


75-75: Undefined name dump

(F821)

tests/test_slurmjobexecutor.py

1-1: os imported but unused

Remove unused import: os

(F401)


10-13: Use ternary operator skip_slurm_test = False if shutil.which("srun") is not None else True instead of if-else-block

Replace if-else-block with skip_slurm_test = False if shutil.which("srun") is not None else True

(SIM108)

🔇 Additional comments (3)
.github/workflows/pipeline.yml (1)

267-330: LGTM on the Slurm test job structure.

The new Slurm unittest jobs follow the established pattern and include appropriate MySQL service setup and environment configuration.

tests/test_slurmjobexecutor.py (1)

39-119: Excellent test coverage for SlurmJobExecutor.

The test suite comprehensively covers various execution scenarios including serial, parallel, threaded execution, mapping, internal memory handling, and parameter validation.

tests/test_slurmclusterexecutor.py (1)

30-91: Well-structured tests for SlurmClusterExecutor.

The tests effectively cover different executor configurations, cache directory management, and file handling scenarios.

Comment thread.github/workflows/pipeline.yml Outdated
Comment thread.github/workflows/pipeline.yml Outdated
Comment threadtests/test_slurmjobexecutor.py Outdated
self.assertTrue(fs_1.done())
self.assertTrue(fs_2.done())

def test_slurm_executor_serial_no_depencies(self):

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue

Fix typo in method name.

The method name has a typo: "depencies" should be "dependencies".

- def test_slurm_executor_serial_no_depencies(self):+ def test_slurm_executor_serial_no_dependencies(self):
📝 Committable suggestion

‼️IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
deftest_slurm_executor_serial_no_depencies(self):
deftest_slurm_executor_serial_no_dependencies(self):
🤖 Prompt for AI Agents
In tests/test_slurmjobexecutor.py at line 52, the test method name contains a
typo: "depencies" should be corrected to "dependencies". Rename the method from
test_slurm_executor_serial_no_depencies to
test_slurm_executor_serial_no_dependencies to fix the spelling error.

Comment threadtests/test_slurmclusterexecutor.py
@codecov

codecovBot commented Jul 13, 2025

Copy link
Copy Markdown

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.91%. Comparing base (f6e96a2) to head (fc211a2).
Report is 2 commits behind head on main.

Additional details and impacted files
@@ Coverage Diff @@## main #726 +/- ##
=======================================
Coverage 96.91% 96.91% =======================================
Files 30 30 Lines 1363 1363 =======================================
Hits 1321 1321 Misses 42 42 

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@coderabbitaicoderabbitaiBot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actionable comments posted: 1

♻️ Duplicate comments (1)
tests/test_slurmjobexecutor.py (1)

51-51: Fix typo in method name.

The method name has a typo: "depencies" should be "dependencies".

- def test_slurm_executor_serial_no_depencies(self):+ def test_slurm_executor_serial_no_dependencies(self):
🧹 Nitpick comments (1)
tests/test_slurmclusterexecutor.py (1)

89-89: Remove extra space before closing parenthesis.

- file_path = os.path.join("executorlib_cache", file_name )+ file_path = os.path.join("executorlib_cache", file_name)
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 25a06b8 and 6961e16.

📒 Files selected for processing (3)
  • .github/workflows/pipeline.yml (2 hunks)
  • tests/test_slurmclusterexecutor.py (1 hunks)
  • tests/test_slurmjobexecutor.py (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • .github/workflows/pipeline.yml
🧰 Additional context used
🧬 Code Graph Analysis (1)
tests/test_slurmclusterexecutor.py (4)
executorlib/executor/slurm.py (1)
  • SlurmClusterExecutor (23-205)
executorlib/standalone/serialize.py (1)
  • cloudpickle_register (9-28)
executorlib/task_scheduler/file/hdf.py (1)
  • dump (11-28)
tests/test_slurmjobexecutor.py (1)
  • mpi_funct (20-25)
🪛 Ruff (0.11.9)
tests/test_slurmclusterexecutor.py

9-12: Use ternary operator skip_slurm_test = False if shutil.which("srun") is not None else True instead of if-else-block

Replace if-else-block with skip_slurm_test = False if shutil.which("srun") is not None else True

(SIM108)

tests/test_slurmjobexecutor.py

1-1: os imported but unused

Remove unused import: os

(F401)


10-13: Use ternary operator skip_slurm_test = False if shutil.which("srun") is not None else True instead of if-else-block

Replace if-else-block with skip_slurm_test = False if shutil.which("srun") is not None else True

(SIM108)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (13)
  • GitHub Check: unittest_openmpi (macos-latest, 3.13)
  • GitHub Check: unittest_openmpi (ubuntu-latest, 3.13)
  • GitHub Check: unittest_openmpi (ubuntu-latest, 3.11)
  • GitHub Check: unittest_openmpi (ubuntu-latest, 3.12)
  • GitHub Check: unittest_flux_openmpi
  • GitHub Check: unittest_mpich (macos-latest, 3.13)
  • GitHub Check: unittest_slurm_mpich
  • GitHub Check: unittest_flux_mpich
  • GitHub Check: unittest_win
  • GitHub Check: notebooks_integration
  • GitHub Check: benchmark (ubuntu-latest, 3.13, .ci_support/environment-mpich.yml)
  • GitHub Check: benchmark (ubuntu-latest, 3.13, .ci_support/environment-openmpi.yml)
  • GitHub Check: notebooks
🔇 Additional comments (5)
tests/test_slurmclusterexecutor.py (3)

9-13: The skip flag logic is correct.

The conditional check for srun availability is appropriate for skipping tests when SLURM is not installed.


23-33: SLURM submission template is properly configured.

The template includes all necessary SLURM directives and placeholders for dynamic values.


48-106: Test methods comprehensively cover SlurmClusterExecutor functionality.

The tests validate:

  • Basic MPI execution with cache management
  • Execution without working directory specification
  • Cache reuse with existing files

All assertions and test patterns are appropriate.

tests/test_slurmjobexecutor.py (2)

16-34: Helper functions are well-designed for testing.

The functions provide appropriate test cases for serial execution, MPI parallelism, and internal memory management.


40-105: Comprehensive test coverage for SlurmJobExecutor.

The test methods effectively validate:

  • Serial execution with and without dependencies
  • Thread-level parallelism
  • MPI parallel execution
  • Batch job submission via map
  • Internal memory initialization and persistence

All test patterns and assertions are appropriate.

Comment threadtests/test_slurmjobexecutor.py Outdated
@jan-janssen

Copy link
Copy Markdown
MemberAuthor

@liamhuber I added a first set of tests for the SlurmClusterExecutor and the SlurmJobExecutor, maybe this can also be used as an inspiration for adding tests for the SLURM integration in pyiron_workflow.

@liamhuberliamhuber left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Nice, this will indeed be helpful for me to test pyiron_workflow's use of executorlib!

I have security nit thought, a GitHub script simplification to try, and a question, but none of it is blocking.

Comment thread.github/workflows/pipeline.yml
Comment thread.github/workflows/pipeline.yml
Comment threadtests/test_slurmclusterexecutor.py
@jan-janssen
jan-janssen merged commit 15f648f into mainJul 14, 2025
@jan-janssen
jan-janssen deleted the slurm branch July 14, 2025 19:37
liamhuber added a commit to pyiron/pyiron_workflow that referenced this pull request Jul 17, 2025
based on Jan's work in pyiron/executorlib#726
Signed-off-by: liamhuber <liamhuber@greyhavensolutions.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Feature] Test SLURM cluster in continuous integration

2 participants

@jan-janssen@liamhuber
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Test with SLURM - #726

Merged
jan-janssen merged 13 commits into
mainfrom
slurm
Jul 14, 2025
Merged

Test with SLURM#726
jan-janssen merged 13 commits into
mainfrom
slurm

Conversation

@jan-janssen

@jan-janssenjan-janssen commented Jul 13, 2025

Copy link
Copy Markdown
Member

Summary by CodeRabbit

  • Tests
    • Added new test suites for Slurm-based executors, covering serial, threaded, and parallel execution scenarios, cache management, internal memory handling, and error validation.
  • Chores
    • Expanded automated testing workflows to include Slurm-based unittests for both MPICH and OpenMPI variants, improving coverage and reliability of the test pipeline.

@coderabbitai

coderabbitaiBot commented Jul 13, 2025

Copy link
Copy Markdown
Contributor

Warning

Rate limit exceeded

@jan-janssen has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 18 minutes and 43 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 6961e16 and fc211a2.

📒 Files selected for processing (2)
  • .github/workflows/pipeline.yml (2 hunks)
  • tests/test_slurmjobexecutor.py (1 hunks)

Walkthrough

A new GitHub Actions job unittest_slurm_mpich was added to run Slurm-based tests with an MPICH environment. Two new test modules for SlurmClusterExecutor and SlurmJobExecutor were introduced, providing unit tests covering various execution scenarios. The CI workflow dependencies were updated accordingly.

Changes

File(s)Change Summary
.github/workflows/pipeline.ymlAdded unittest_slurm_mpich job; updated uml job dependencies to include it.
tests/test_slurmclusterexecutor.pyNew test module for SlurmClusterExecutor with MPI function, multiple test cases, and cache directory cleanup.
tests/test_slurmjobexecutor.pyNew test suite for SlurmJobExecutor covering serial, threaded, MPI, batch execution, and internal memory tests.

Sequence Diagram(s)

sequenceDiagram
participant CI as GitHub Actions
participant Slurm as Slurm Setup Action
participant Conda as Conda Setup
participant Tests as Test Runner
CI->>Slurm: Setup Slurm environment (MPICH)
CI->>Conda: Install Python 3.13 and dependencies (env file)
CI->>Tests: Install package (no deps/build isolation)
CI->>Tests: Run Slurm executor test modules
Tests->>Slurm: Submit and manage jobs via Slurm
Slurm->>Tests: Return test results
Tests->>CI: Report pass/fail status
Loading

Possibly related PRs

Poem

🐇 Hopping through CI with a cheerful leap,
New Slurm tests awake from their sleep.
MPI whispers, jobs align,
Executors dance in perfect time.
Cache is cleared, results in sight,
All tests pass—what a delight! 🎉🐰

✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @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.

@jan-janssenjan-janssen linked an issue Jul 13, 2025 that may be closed by this pull request

@coderabbitaicoderabbitaiBot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actionable comments posted: 4

🧹 Nitpick comments (5)
tests/test_slurmjobexecutor.py (2)

1-1: Remove unused import.

The os module is imported but never used in this file.

-import os

10-13: Simplify conditional assignment.

Use a more concise ternary operator for better readability.

-if shutil.which("srun") is not None:- skip_slurm_test = False-else:- skip_slurm_test = True+skip_slurm_test = shutil.which("srun") is None
tests/test_slurmclusterexecutor.py (3)

9-12: Simplify conditional assignment.

Use a more concise ternary operator for better readability.

-if shutil.which("srun") is not None:- skip_slurm_test = False-else:- skip_slurm_test = True+skip_slurm_test = shutil.which("srun") is None

25-28: Fix inconsistent skip message.

The skip message mentions "h5py" but the skip condition doesn't check for h5py availability.

- "h5py or mpi4py or SLRUM are not installed, so the h5py, slurm and mpi4py tests are skipped.",+ "mpi4py or SLURM are not installed, so the slurm and mpi4py tests are skipped.",

Also note the typo "SLRUM" should be "SLURM".


29-29: Consider renaming test class for clarity.

The class name TestCacheExecutorPysqa doesn't clearly indicate it's testing SlurmClusterExecutor.

-class TestCacheExecutorPysqa(unittest.TestCase):+class TestSlurmClusterExecutor(unittest.TestCase):
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between f6e96a2 and 0d83164.

📒 Files selected for processing (3)
  • .github/workflows/pipeline.yml (2 hunks)
  • tests/test_slurmclusterexecutor.py (1 hunks)
  • tests/test_slurmjobexecutor.py (1 hunks)
🧰 Additional context used
🧬 Code Graph Analysis (2)
tests/test_slurmclusterexecutor.py (4)
executorlib/executor/slurm.py (1)
  • SlurmClusterExecutor (23-205)
executorlib/standalone/serialize.py (1)
  • cloudpickle_register (9-28)
tests/test_slurmjobexecutor.py (1)
  • mpi_funct (20-25)
executorlib/task_scheduler/file/hdf.py (1)
  • dump (11-28)
tests/test_slurmjobexecutor.py (2)
executorlib/executor/slurm.py (1)
  • SlurmJobExecutor (208-387)
tests/test_slurmclusterexecutor.py (1)
  • mpi_funct (17-22)
🪛 Ruff (0.11.9)
tests/test_slurmclusterexecutor.py

9-12: Use ternary operator skip_slurm_test = False if shutil.which("srun") is not None else True instead of if-else-block

Replace if-else-block with skip_slurm_test = False if shutil.which("srun") is not None else True

(SIM108)


75-75: Undefined name dump

(F821)

tests/test_slurmjobexecutor.py

1-1: os imported but unused

Remove unused import: os

(F401)


10-13: Use ternary operator skip_slurm_test = False if shutil.which("srun") is not None else True instead of if-else-block

Replace if-else-block with skip_slurm_test = False if shutil.which("srun") is not None else True

(SIM108)

🔇 Additional comments (3)
.github/workflows/pipeline.yml (1)

267-330: LGTM on the Slurm test job structure.

The new Slurm unittest jobs follow the established pattern and include appropriate MySQL service setup and environment configuration.

tests/test_slurmjobexecutor.py (1)

39-119: Excellent test coverage for SlurmJobExecutor.

The test suite comprehensively covers various execution scenarios including serial, parallel, threaded execution, mapping, internal memory handling, and parameter validation.

tests/test_slurmclusterexecutor.py (1)

30-91: Well-structured tests for SlurmClusterExecutor.

The tests effectively cover different executor configurations, cache directory management, and file handling scenarios.

Comment thread.github/workflows/pipeline.yml Outdated
Comment thread.github/workflows/pipeline.yml Outdated
Comment threadtests/test_slurmjobexecutor.py Outdated
self.assertTrue(fs_1.done())
self.assertTrue(fs_2.done())

def test_slurm_executor_serial_no_depencies(self):

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue

Fix typo in method name.

The method name has a typo: "depencies" should be "dependencies".

- def test_slurm_executor_serial_no_depencies(self):+ def test_slurm_executor_serial_no_dependencies(self):
📝 Committable suggestion

‼️IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
deftest_slurm_executor_serial_no_depencies(self):
deftest_slurm_executor_serial_no_dependencies(self):
🤖 Prompt for AI Agents
In tests/test_slurmjobexecutor.py at line 52, the test method name contains a
typo: "depencies" should be corrected to "dependencies". Rename the method from
test_slurm_executor_serial_no_depencies to
test_slurm_executor_serial_no_dependencies to fix the spelling error.

Comment threadtests/test_slurmclusterexecutor.py
@codecov

codecovBot commented Jul 13, 2025

Copy link
Copy Markdown

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.91%. Comparing base (f6e96a2) to head (fc211a2).
Report is 2 commits behind head on main.

Additional details and impacted files
@@ Coverage Diff @@## main #726 +/- ##
=======================================
Coverage 96.91% 96.91% =======================================
Files 30 30 Lines 1363 1363 =======================================
Hits 1321 1321 Misses 42 42 

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@coderabbitaicoderabbitaiBot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actionable comments posted: 1

♻️ Duplicate comments (1)
tests/test_slurmjobexecutor.py (1)

51-51: Fix typo in method name.

The method name has a typo: "depencies" should be "dependencies".

- def test_slurm_executor_serial_no_depencies(self):+ def test_slurm_executor_serial_no_dependencies(self):
🧹 Nitpick comments (1)
tests/test_slurmclusterexecutor.py (1)

89-89: Remove extra space before closing parenthesis.

- file_path = os.path.join("executorlib_cache", file_name )+ file_path = os.path.join("executorlib_cache", file_name)
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 25a06b8 and 6961e16.

📒 Files selected for processing (3)
  • .github/workflows/pipeline.yml (2 hunks)
  • tests/test_slurmclusterexecutor.py (1 hunks)
  • tests/test_slurmjobexecutor.py (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • .github/workflows/pipeline.yml
🧰 Additional context used
🧬 Code Graph Analysis (1)
tests/test_slurmclusterexecutor.py (4)
executorlib/executor/slurm.py (1)
  • SlurmClusterExecutor (23-205)
executorlib/standalone/serialize.py (1)
  • cloudpickle_register (9-28)
executorlib/task_scheduler/file/hdf.py (1)
  • dump (11-28)
tests/test_slurmjobexecutor.py (1)
  • mpi_funct (20-25)
🪛 Ruff (0.11.9)
tests/test_slurmclusterexecutor.py

9-12: Use ternary operator skip_slurm_test = False if shutil.which("srun") is not None else True instead of if-else-block

Replace if-else-block with skip_slurm_test = False if shutil.which("srun") is not None else True

(SIM108)

tests/test_slurmjobexecutor.py

1-1: os imported but unused

Remove unused import: os

(F401)


10-13: Use ternary operator skip_slurm_test = False if shutil.which("srun") is not None else True instead of if-else-block

Replace if-else-block with skip_slurm_test = False if shutil.which("srun") is not None else True

(SIM108)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (13)
  • GitHub Check: unittest_openmpi (macos-latest, 3.13)
  • GitHub Check: unittest_openmpi (ubuntu-latest, 3.13)
  • GitHub Check: unittest_openmpi (ubuntu-latest, 3.11)
  • GitHub Check: unittest_openmpi (ubuntu-latest, 3.12)
  • GitHub Check: unittest_flux_openmpi
  • GitHub Check: unittest_mpich (macos-latest, 3.13)
  • GitHub Check: unittest_slurm_mpich
  • GitHub Check: unittest_flux_mpich
  • GitHub Check: unittest_win
  • GitHub Check: notebooks_integration
  • GitHub Check: benchmark (ubuntu-latest, 3.13, .ci_support/environment-mpich.yml)
  • GitHub Check: benchmark (ubuntu-latest, 3.13, .ci_support/environment-openmpi.yml)
  • GitHub Check: notebooks
🔇 Additional comments (5)
tests/test_slurmclusterexecutor.py (3)

9-13: The skip flag logic is correct.

The conditional check for srun availability is appropriate for skipping tests when SLURM is not installed.


23-33: SLURM submission template is properly configured.

The template includes all necessary SLURM directives and placeholders for dynamic values.


48-106: Test methods comprehensively cover SlurmClusterExecutor functionality.

The tests validate:

  • Basic MPI execution with cache management
  • Execution without working directory specification
  • Cache reuse with existing files

All assertions and test patterns are appropriate.

tests/test_slurmjobexecutor.py (2)

16-34: Helper functions are well-designed for testing.

The functions provide appropriate test cases for serial execution, MPI parallelism, and internal memory management.


40-105: Comprehensive test coverage for SlurmJobExecutor.

The test methods effectively validate:

  • Serial execution with and without dependencies
  • Thread-level parallelism
  • MPI parallel execution
  • Batch job submission via map
  • Internal memory initialization and persistence

All test patterns and assertions are appropriate.

Comment threadtests/test_slurmjobexecutor.py Outdated
@jan-janssen

Copy link
Copy Markdown
MemberAuthor

@liamhuber I added a first set of tests for the SlurmClusterExecutor and the SlurmJobExecutor, maybe this can also be used as an inspiration for adding tests for the SLURM integration in pyiron_workflow.

@liamhuberliamhuber left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Nice, this will indeed be helpful for me to test pyiron_workflow's use of executorlib!

I have security nit thought, a GitHub script simplification to try, and a question, but none of it is blocking.

Comment thread.github/workflows/pipeline.yml
Comment thread.github/workflows/pipeline.yml
Comment threadtests/test_slurmclusterexecutor.py
@jan-janssen
jan-janssen merged commit 15f648f into mainJul 14, 2025
@jan-janssen
jan-janssen deleted the slurm branch July 14, 2025 19:37
liamhuber added a commit to pyiron/pyiron_workflow that referenced this pull request Jul 17, 2025
based on Jan's work in pyiron/executorlib#726
Signed-off-by: liamhuber <liamhuber@greyhavensolutions.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Feature] Test SLURM cluster in continuous integration

2 participants

@jan-janssen@liamhuber
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content

Test with SLURM - #726

Merged
jan-janssen merged 13 commits into
mainfrom
slurm
Jul 14, 2025
Merged

Test with SLURM#726
jan-janssen merged 13 commits into
mainfrom
slurm

Conversation

@jan-janssen

@jan-janssenjan-janssen commented Jul 13, 2025

Copy link
Copy Markdown
Member

Summary by CodeRabbit

  • Tests
    • Added new test suites for Slurm-based executors, covering serial, threaded, and parallel execution scenarios, cache management, internal memory handling, and error validation.
  • Chores
    • Expanded automated testing workflows to include Slurm-based unittests for both MPICH and OpenMPI variants, improving coverage and reliability of the test pipeline.

@coderabbitai

coderabbitaiBot commented Jul 13, 2025

Copy link
Copy Markdown
Contributor

Warning

Rate limit exceeded

@jan-janssen has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 18 minutes and 43 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 6961e16 and fc211a2.

📒 Files selected for processing (2)
  • .github/workflows/pipeline.yml (2 hunks)
  • tests/test_slurmjobexecutor.py (1 hunks)

Walkthrough

A new GitHub Actions job unittest_slurm_mpich was added to run Slurm-based tests with an MPICH environment. Two new test modules for SlurmClusterExecutor and SlurmJobExecutor were introduced, providing unit tests covering various execution scenarios. The CI workflow dependencies were updated accordingly.

Changes

File(s)Change Summary
.github/workflows/pipeline.ymlAdded unittest_slurm_mpich job; updated uml job dependencies to include it.
tests/test_slurmclusterexecutor.pyNew test module for SlurmClusterExecutor with MPI function, multiple test cases, and cache directory cleanup.
tests/test_slurmjobexecutor.pyNew test suite for SlurmJobExecutor covering serial, threaded, MPI, batch execution, and internal memory tests.

Sequence Diagram(s)

sequenceDiagram
participant CI as GitHub Actions
participant Slurm as Slurm Setup Action
participant Conda as Conda Setup
participant Tests as Test Runner
CI->>Slurm: Setup Slurm environment (MPICH)
CI->>Conda: Install Python 3.13 and dependencies (env file)
CI->>Tests: Install package (no deps/build isolation)
CI->>Tests: Run Slurm executor test modules
Tests->>Slurm: Submit and manage jobs via Slurm
Slurm->>Tests: Return test results
Tests->>CI: Report pass/fail status
Loading

Possibly related PRs

Poem

🐇 Hopping through CI with a cheerful leap,
New Slurm tests awake from their sleep.
MPI whispers, jobs align,
Executors dance in perfect time.
Cache is cleared, results in sight,
All tests pass—what a delight! 🎉🐰

✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @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.

@jan-janssenjan-janssen linked an issue Jul 13, 2025 that may be closed by this pull request

@coderabbitaicoderabbitaiBot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actionable comments posted: 4

🧹 Nitpick comments (5)
tests/test_slurmjobexecutor.py (2)

1-1: Remove unused import.

The os module is imported but never used in this file.

-import os

10-13: Simplify conditional assignment.

Use a more concise ternary operator for better readability.

-if shutil.which("srun") is not None:- skip_slurm_test = False-else:- skip_slurm_test = True+skip_slurm_test = shutil.which("srun") is None
tests/test_slurmclusterexecutor.py (3)

9-12: Simplify conditional assignment.

Use a more concise ternary operator for better readability.

-if shutil.which("srun") is not None:- skip_slurm_test = False-else:- skip_slurm_test = True+skip_slurm_test = shutil.which("srun") is None

25-28: Fix inconsistent skip message.

The skip message mentions "h5py" but the skip condition doesn't check for h5py availability.

- "h5py or mpi4py or SLRUM are not installed, so the h5py, slurm and mpi4py tests are skipped.",+ "mpi4py or SLURM are not installed, so the slurm and mpi4py tests are skipped.",

Also note the typo "SLRUM" should be "SLURM".


29-29: Consider renaming test class for clarity.

The class name TestCacheExecutorPysqa doesn't clearly indicate it's testing SlurmClusterExecutor.

-class TestCacheExecutorPysqa(unittest.TestCase):+class TestSlurmClusterExecutor(unittest.TestCase):
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between f6e96a2 and 0d83164.

📒 Files selected for processing (3)
  • .github/workflows/pipeline.yml (2 hunks)
  • tests/test_slurmclusterexecutor.py (1 hunks)
  • tests/test_slurmjobexecutor.py (1 hunks)
🧰 Additional context used
🧬 Code Graph Analysis (2)
tests/test_slurmclusterexecutor.py (4)
executorlib/executor/slurm.py (1)
  • SlurmClusterExecutor (23-205)
executorlib/standalone/serialize.py (1)
  • cloudpickle_register (9-28)
tests/test_slurmjobexecutor.py (1)
  • mpi_funct (20-25)
executorlib/task_scheduler/file/hdf.py (1)
  • dump (11-28)
tests/test_slurmjobexecutor.py (2)
executorlib/executor/slurm.py (1)
  • SlurmJobExecutor (208-387)
tests/test_slurmclusterexecutor.py (1)
  • mpi_funct (17-22)
🪛 Ruff (0.11.9)
tests/test_slurmclusterexecutor.py

9-12: Use ternary operator skip_slurm_test = False if shutil.which("srun") is not None else True instead of if-else-block

Replace if-else-block with skip_slurm_test = False if shutil.which("srun") is not None else True

(SIM108)


75-75: Undefined name dump

(F821)

tests/test_slurmjobexecutor.py

1-1: os imported but unused

Remove unused import: os

(F401)


10-13: Use ternary operator skip_slurm_test = False if shutil.which("srun") is not None else True instead of if-else-block

Replace if-else-block with skip_slurm_test = False if shutil.which("srun") is not None else True

(SIM108)

🔇 Additional comments (3)
.github/workflows/pipeline.yml (1)

267-330: LGTM on the Slurm test job structure.

The new Slurm unittest jobs follow the established pattern and include appropriate MySQL service setup and environment configuration.

tests/test_slurmjobexecutor.py (1)

39-119: Excellent test coverage for SlurmJobExecutor.

The test suite comprehensively covers various execution scenarios including serial, parallel, threaded execution, mapping, internal memory handling, and parameter validation.

tests/test_slurmclusterexecutor.py (1)

30-91: Well-structured tests for SlurmClusterExecutor.

The tests effectively cover different executor configurations, cache directory management, and file handling scenarios.

Comment thread.github/workflows/pipeline.yml Outdated
Comment thread.github/workflows/pipeline.yml Outdated
Comment threadtests/test_slurmjobexecutor.py Outdated
self.assertTrue(fs_1.done())
self.assertTrue(fs_2.done())

def test_slurm_executor_serial_no_depencies(self):

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue

Fix typo in method name.

The method name has a typo: "depencies" should be "dependencies".

- def test_slurm_executor_serial_no_depencies(self):+ def test_slurm_executor_serial_no_dependencies(self):
📝 Committable suggestion

‼️IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
deftest_slurm_executor_serial_no_depencies(self):
deftest_slurm_executor_serial_no_dependencies(self):
🤖 Prompt for AI Agents
In tests/test_slurmjobexecutor.py at line 52, the test method name contains a
typo: "depencies" should be corrected to "dependencies". Rename the method from
test_slurm_executor_serial_no_depencies to
test_slurm_executor_serial_no_dependencies to fix the spelling error.

Comment threadtests/test_slurmclusterexecutor.py
@codecov

codecovBot commented Jul 13, 2025

Copy link
Copy Markdown

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.91%. Comparing base (f6e96a2) to head (fc211a2).
Report is 2 commits behind head on main.

Additional details and impacted files
@@ Coverage Diff @@## main #726 +/- ##
=======================================
Coverage 96.91% 96.91% =======================================
Files 30 30 Lines 1363 1363 =======================================
Hits 1321 1321 Misses 42 42 

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@coderabbitaicoderabbitaiBot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actionable comments posted: 1

♻️ Duplicate comments (1)
tests/test_slurmjobexecutor.py (1)

51-51: Fix typo in method name.

The method name has a typo: "depencies" should be "dependencies".

- def test_slurm_executor_serial_no_depencies(self):+ def test_slurm_executor_serial_no_dependencies(self):
🧹 Nitpick comments (1)
tests/test_slurmclusterexecutor.py (1)

89-89: Remove extra space before closing parenthesis.

- file_path = os.path.join("executorlib_cache", file_name )+ file_path = os.path.join("executorlib_cache", file_name)
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 25a06b8 and 6961e16.

📒 Files selected for processing (3)
  • .github/workflows/pipeline.yml (2 hunks)
  • tests/test_slurmclusterexecutor.py (1 hunks)
  • tests/test_slurmjobexecutor.py (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • .github/workflows/pipeline.yml
🧰 Additional context used
🧬 Code Graph Analysis (1)
tests/test_slurmclusterexecutor.py (4)
executorlib/executor/slurm.py (1)
  • SlurmClusterExecutor (23-205)
executorlib/standalone/serialize.py (1)
  • cloudpickle_register (9-28)
executorlib/task_scheduler/file/hdf.py (1)
  • dump (11-28)
tests/test_slurmjobexecutor.py (1)
  • mpi_funct (20-25)
🪛 Ruff (0.11.9)
tests/test_slurmclusterexecutor.py

9-12: Use ternary operator skip_slurm_test = False if shutil.which("srun") is not None else True instead of if-else-block

Replace if-else-block with skip_slurm_test = False if shutil.which("srun") is not None else True

(SIM108)

tests/test_slurmjobexecutor.py

1-1: os imported but unused

Remove unused import: os

(F401)


10-13: Use ternary operator skip_slurm_test = False if shutil.which("srun") is not None else True instead of if-else-block

Replace if-else-block with skip_slurm_test = False if shutil.which("srun") is not None else True

(SIM108)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (13)
  • GitHub Check: unittest_openmpi (macos-latest, 3.13)
  • GitHub Check: unittest_openmpi (ubuntu-latest, 3.13)
  • GitHub Check: unittest_openmpi (ubuntu-latest, 3.11)
  • GitHub Check: unittest_openmpi (ubuntu-latest, 3.12)
  • GitHub Check: unittest_flux_openmpi
  • GitHub Check: unittest_mpich (macos-latest, 3.13)
  • GitHub Check: unittest_slurm_mpich
  • GitHub Check: unittest_flux_mpich
  • GitHub Check: unittest_win
  • GitHub Check: notebooks_integration
  • GitHub Check: benchmark (ubuntu-latest, 3.13, .ci_support/environment-mpich.yml)
  • GitHub Check: benchmark (ubuntu-latest, 3.13, .ci_support/environment-openmpi.yml)
  • GitHub Check: notebooks
🔇 Additional comments (5)
tests/test_slurmclusterexecutor.py (3)

9-13: The skip flag logic is correct.

The conditional check for srun availability is appropriate for skipping tests when SLURM is not installed.


23-33: SLURM submission template is properly configured.

The template includes all necessary SLURM directives and placeholders for dynamic values.


48-106: Test methods comprehensively cover SlurmClusterExecutor functionality.

The tests validate:

  • Basic MPI execution with cache management
  • Execution without working directory specification
  • Cache reuse with existing files

All assertions and test patterns are appropriate.

tests/test_slurmjobexecutor.py (2)

16-34: Helper functions are well-designed for testing.

The functions provide appropriate test cases for serial execution, MPI parallelism, and internal memory management.


40-105: Comprehensive test coverage for SlurmJobExecutor.

The test methods effectively validate:

  • Serial execution with and without dependencies
  • Thread-level parallelism
  • MPI parallel execution
  • Batch job submission via map
  • Internal memory initialization and persistence

All test patterns and assertions are appropriate.

Comment threadtests/test_slurmjobexecutor.py Outdated
@jan-janssen

Copy link
Copy Markdown
MemberAuthor

@liamhuber I added a first set of tests for the SlurmClusterExecutor and the SlurmJobExecutor, maybe this can also be used as an inspiration for adding tests for the SLURM integration in pyiron_workflow.

@liamhuberliamhuber left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Nice, this will indeed be helpful for me to test pyiron_workflow's use of executorlib!

I have security nit thought, a GitHub script simplification to try, and a question, but none of it is blocking.

Comment thread.github/workflows/pipeline.yml
Comment thread.github/workflows/pipeline.yml
Comment threadtests/test_slurmclusterexecutor.py
@jan-janssen
jan-janssen merged commit 15f648f into mainJul 14, 2025
@jan-janssen
jan-janssen deleted the slurm branch July 14, 2025 19:37
liamhuber added a commit to pyiron/pyiron_workflow that referenced this pull request Jul 17, 2025
based on Jan's work in pyiron/executorlib#726
Signed-off-by: liamhuber <liamhuber@greyhavensolutions.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Feature] Test SLURM cluster in continuous integration

2 participants

@jan-janssen@liamhuber