Add utilities objects [AI]#1590
Open
douglasjacobsen wants to merge 3 commits into
Open
Conversation
douglasjacobsen
force-pushed
the
utilities-objects
branch
from
9db1e36 to
652204f
Compare
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Code Review
This pull request introduces the concept of external utilities (dependencies) to Ramble, adding a new UtilityBase class, a bootstrap pipeline, workspace commands, configuration schemas, and documentation. The review feedback highlights several critical issues that need to be addressed: directory name mismatches (bootstrapped_utilities vs. bootstrapped_tools) that affect archiving and deployment; logic bugs in UtilityBase that ignore conditional environment modifications; potential TypeErrors from unfiltered fetch arguments and unhashable lists in configuration tuples; inconsistent configuration option names; and the need for robust command parsing using shlex.split.
Ramble Performance Test MetricsResults produced with commit: 6788f25
|
Codecov Report❌ Patch coverage is Additional details and impacted files@@ Coverage Diff @@
## develop #1590 +/- ##
===========================================
- Coverage 92.95% 92.93% -0.03%
===========================================
Files 344 357 +13
Lines 33258 34159 +901
===========================================
+ Hits 30916 31744 +828
- Misses 2342 2415 +73 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
douglasjacobsen
force-pushed
the
utilities-objects
branch
3 times, most recently
from
7643893 to
fce4051
Compare
douglasjacobsen
force-pushed
the
utilities-objects
branch
2 times, most recently
from
c3a2937 to
ec3b0d5
Compare
Collaborator
Author
|
/genini review |
douglasjacobsen
force-pushed
the
utilities-objects
branch
from
ec3b0d5 to
8705a45
Compare
This commit adds a new object type representing bootstrapped or required external utilities. These can be dependencies that an experiment needs to run on a certain system, or dependencies that Ramble should fetch as part of setting up the experiments. Other objects can require utilities, and when they do they are allowed to specify minimum and maximum versions (or to pin the version at a specific value). A new pipeline is defined `ramble workspace bootstrap` which can be used to bootstrap any utilities that would be bootstrapped. Bootstrapping also happens as part of the setup pipeline.
Changes include: - Updated Sphinx conf.py to auto-generate utility_list.html and base_utility_list.html. - Added utilities.rst to the Basics section outlining how to configure utility bootstrapping. - Added a Developer Guide detailing the UtilityBase API, env modifications, and declarative version checking. - Added a tutorial for creating utility definitions from scratch.
douglasjacobsen
force-pushed
the
utilities-objects
branch
from
8705a45 to
6788f25
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This merge adds utilities as a new object type. Utilities represent external dependencies that experiments (or other objects) can require. These can include things like spack (package managers) or pdsh. A language, documentation, and tests are added to help developers create new utilities.