FUZZ-7412: Updates nf-fuzzball for Fuzzball 4 compatibility - #55
Merged
Conversation
- Rename generated model imports FuzzballApiV3* -> FuzzballApiV4* - Stamp task workflow definitions as version v4 - Replace storage-class-based ephemeral filtering with the v4 local rule (persistent iff use == 'persistent' or name is set); the StorageClassService no longer exists in the v4 API - Filter path-keyed v4 mounts by their volume field
The v4 REST API only parses the path-keyed mount format in JSON; the legacy location field is a YAML/CLI-only compatibility shim.
- Translate volume:// references client-side (ephemeral -> {},
persistent/NAME -> {name}, CLASS[/NAME] -> {use[, name]}); the scope
part has no v4 equivalent and is ignored
- Stamp submitted definitions as version v4
- BREAKING: --data-volume is now required and must include an explicit
volume name (volume://SCOPE/persistent/NAME); scope-only references
cannot be resolved client-side in v4
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
✅ Snyk checks have passed. No issues have been found so far.
💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse. |
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the Nextflow nf-fuzzball plugin and the nf-fuzzball-submit helper to be compatible with Fuzzball 4 by switching to the v4 SDK/models, emitting version: v4 workflow definitions, and adopting v4’s path-keyed mount + v4 volume semantics.
Changes:
- Migrate Groovy plugin code to Fuzzball v4 models and submit
version: v4workflow definitions. - Replace storage-class-based ephemeral filtering with v4 “persistent iff
use: persistentor explicitname” filtering; filter mounts by referenced persistent volume. - Update
nf-fuzzball-submitto require a named persistent--data-volume, translatevolume://references into v4 volume blocks, and add/adjust tests + docs.
Reviewed changes
Copilot reviewed 19 out of 21 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| src/test/groovy/com/ciq/fuzzball/FuzzballExecutorSpec.groovy | Adds unit tests for v4 persistent volume + mount filtering. |
| src/main/groovy/com/ciq/fuzzball/FuzzballWorkflowDefinitionJobFactory.groovy | Switches job factory imports to v4 SDK model types. |
| src/main/groovy/com/ciq/fuzzball/FuzzballTaskHandler.groovy | Submits version: v4 per-task workflow definitions using v4 models. |
| src/main/groovy/com/ciq/fuzzball/FuzzballPluginConfig.groovy | Updates config schema types to v4 volume model. |
| src/main/groovy/com/ciq/fuzzball/FuzzballExecutor.groovy | Implements v4 persistent volume filtering and path-keyed mount filtering; removes v3 storage-class API usage. |
| README.md | Updates example invocation to include required --data-volume. |
| nf-fuzzball-submit/tests/test_workflow_definition.py | Adds coverage for v4 mounts, v4 volumes, and volume_from_reference. |
| nf-fuzzball-submit/tests/test_client_integration.py | Adds test that rejects pre-v4 servers. |
| nf-fuzzball-submit/tests/test_cli.py | Updates CLI tests for required --data-volume and new validation behavior. |
| nf-fuzzball-submit/tests/conftest.py | Updates default test args to include a named persistent data volume. |
| nf-fuzzball-submit/src/nf_fuzzball_submit/client.py | Enforces Fuzzball v4 minimum, adds volume_from_reference, updates mounts/definition version to v4. |
| nf-fuzzball-submit/src/nf_fuzzball_submit/cli.py | Makes --data-volume required and validates it must be named + non-ephemeral. |
| nf-fuzzball-submit/README.md | Updates usage examples and options table for v4 + required --data-volume. |
| nf-fuzzball-submit/pyproject.toml | Bumps nf-fuzzball-submit version to 0.4.0. |
| Makefile | Updates default OpenAPI schema URL to /v4/schema and threads spec properties through make test. |
| code-generation/groovy-okhttp-sync/modelClass.mustache | Adds @JsonIgnoreProperties(ignoreUnknown = true) to generated models. |
| code-generation/groovy-okhttp-sync/model.mustache | Adds required Jackson import for @JsonIgnoreProperties. |
| code-generation/generate | Updates default OpenAPI schema URL to /v4/schema. |
| CHANGELOG.md | Adds 0.4.0 unreleased notes describing v4 support and breaking CLI change. |
| build.gradle | Bumps plugin version to 0.4.0. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
wresch
marked this pull request as ready for review
June 12, 2026 14:04
kyleishie
approved these changes
Jun 12, 2026
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
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.
No description provided.