Skip to content

Conversation

@vikramvs-gg
Copy link
Contributor

@vikramvs-gg vikramvs-gg commented Dec 29, 2025

What is the change
This change modifies the way the slurm job status is fetched in the slurm_simple_job_completion.py script. This script is used in multiple integration tests to trigger jobs on slurm cluster and validate jobs completed successfully.

Why is it needed
There were transient test failures because the job status could not be fetched. This is because the command used within the job_state function to fetch the job status returned an empty list of jobs (json.loads(stdout)["jobs"] is empty). The script expected to find details for a specific job_id, but none were found. This transient issue that can happen if the job completes and is purged from the slurm controller's active memory before the test has a chance to check its final state.

Fix done
Fixing this issue by using sacct instead of scontrol.
scontrol queries the state of jobs that are currently active or recently completed in the Slurm controller's memory. If a job finishes and is quickly purged, scontrol will find no record of it, leading to the IndexError (race condition).
sacct queries the slurm accounting database, which stores a historical record of all jobs. It is specifically designed to get the final status, exit code, and resource usage of jobs that have already finished.

NOTE: Community submissions can take up to 2 weeks to be reviewed.

Please take the following actions before submitting this pull request.

  • Fork your PR branch from the Toolkit "develop" branch (not main)
  • Test all changes with pre-commit in a local branch #
  • Confirm that "make tests" passes all tests
  • Add or modify unit tests to cover code changes
  • Ensure that unit test coverage remains above 80%
  • Update all applicable documentation
  • Follow Cluster Toolkit Contribution guidelines #

@vikramvs-gg vikramvs-gg added the release-chore To not include into release notes label Dec 29, 2025
@vikramvs-gg vikramvs-gg added the test-enhancement Tests enhancement or coverage improvement label Dec 29, 2025
@vikramvs-gg vikramvs-gg requested a review from a team as a code owner December 29, 2025 16:32
@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello @vikramvs-gg, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request significantly enhances the stability and reliability of Slurm integration tests by refactoring the job state fetching mechanism. By switching from scontrol to sacct, the system now leverages a more persistent and comprehensive source for job status information, effectively mitigating race conditions that previously led to transient test failures. This change ensures that job completion checks are robust, providing more accurate and consistent test results.

Highlights

  • Improved Slurm Job State Fetching: The method for fetching Slurm job states has been updated from scontrol to sacct in the slurm_simple_job_completion.py script. This change addresses transient test failures where scontrol would fail to find recently completed jobs.
  • Enhanced Reliability: sacct queries the Slurm accounting database, providing a historical record of all jobs, which is more reliable for checking the final status of jobs compared to scontrol that primarily queries active or recently completed jobs in memory.
  • Robust Error Handling and Logging: The job_state function now includes comprehensive error handling for JSON parsing and cases where job information is not found, returning specific states like 'NOT_FOUND' or 'PARSE_ERROR'. Debug, info, and warning logs have also been added for better visibility during test execution.
  • Improved Test Assertion Message: The assertion message in runTest has been enhanced to include the final job state, making it easier to diagnose why a job did not complete successfully during integration tests.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request addresses a race condition in Slurm job status fetching by switching from scontrol to sacct. This is a solid improvement for test reliability. The updated assertion messages are also more informative. I've added one suggestion to make the parsing of sacct output more robust by explicitly searching for the main job ID instead of assuming it's the first entry in the list, which will further prevent potential flakiness.

Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
self.assertIn("COMPLETED", self.job_state(job_id), f"Something went wrong with JobID:{job_id}.")
state = self.job_state(job_id)
self.assertIn("COMPLETED", state, f"Job {job_id} did not complete successfully. Final state is {state}.")
print(f"JobID {job_id} finished successfully.")
Copy link
Contributor

Choose a reason for hiding this comment

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

Nit: s/print/log.info ?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

release-chore To not include into release notes test-enhancement Tests enhancement or coverage improvement

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants