Skip to content

feat: Milestone 5 - workflow manifest integration and example workflows - #85

Open
DhanashreePetare wants to merge 4 commits into
dbpedia:gsoc-2026from
DhanashreePetare:gsoc-2026
Open

feat: Milestone 5 - workflow manifest integration and example workflows #85
DhanashreePetare wants to merge 4 commits into
dbpedia:gsoc-2026from
DhanashreePetare:gsoc-2026

Conversation

@DhanashreePetare

Copy link
Copy Markdown
Collaborator

Pull Request

Description

Integrates ManifestContext into the workflow engine, so workflow run --manifest path.jsonld (or a manifest: key inside the YAML file itself) produces one unified manifest covering every step in the run, not just a single command. Each manifest file entry is tagged with dbus:stepName so multi-step runs stay traceable to which step produced or failed on which file. A readable console summary is now printed automatically after every workflow run, no flag required.

Adds five tested, real-world example workflows matching the proposal's named use cases: reproducible research download, automated nightly publishing pipeline, batch deployment with retry, CI/CD integration, and failure debugging.

Related Issues
Issue #80

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • This change requires a documentation update
  • Housekeeping

Checklist:

  • My code follows the ruff code style of this project.
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation (if applicable)
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
    • poetry run pytest - all tests passed
    • poetry run ruff check - no linting errors

@coderabbitai

coderabbitai Bot commented Aug 19, 2026

Copy link
Copy Markdown

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: a2a1fe41-cf34-4ddf-80b1-3cc50934073e

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review

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

Comment @coderabbitai help to get the list of available commands.

@Integer-Ctrl Integer-Ctrl 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.

Overall error on replaying manifest produced by example workflows
databusclient manifest replay ./manifests/[...].jsonld Error: Manifest field dbus:replayParams must be an object.

Comment thread examples/workflows/reproducible-research-download.yml
Comment thread examples/workflows/failure-debugging.yml
Comment thread tests/test_manifest_summary.py Outdated
Comment on lines +153 to +172
def test_summary_lists_failed_file_details_without_step_name():
"""Single-command manifests (not workflows) have no dbus:stepName --
confirm the failed-file line still renders cleanly without it."""
manifest = {
"dbus:command": "download",
"dcterms:issued": {"@value": "2024-03-24T10:00:00Z"},
"dbus:executionResult": {"dbus:succeeded": 0, "dbus:failed": 1, "dbus:totalBytes": 0},
"dataid:distribution": {
"dataid:file": [
{
"dcat:downloadURL": "https://a.org/missing.ttl",
"dbus:status": "failed",
"dbus:errorMessage": "404 Not Found",
},
]
},
}
output = format_summary(manifest)
assert "Failed files:" in output
assert "https://a.org/missing.ttl: 404 Not Found" in output

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.

I tried to reproduce this test manually. Workflow:

manifest: ./manifests/download.jsonld
steps:
  - name: download1
    command: download
    uri:
      - https://a.org/missing.ttl
    localdir: ./workflow-output/download
    validate-checksum: true

Execution & summary:

(databus-python-client) fhofer@pop-os ~/ddrive/dev/infai/dbpedia/databus-python-client (remotes/dhanashree/gsoc-2026*?) $ databusclient workflow run ./examples/workflows/download.yml                                                                      
SPARQL endpoint https://a.org/sparql
accountId not supported yet
Workflow complete.
  download1: success

Command  : workflow
Executed : 2026-08-24T12:27:47.344982+00:00
Files    : 0 succeeded · 0 failed
Status   : completed

Manifest written to ./manifests/download.jsonld
(databus-python-client) fhofer@pop-os ~/ddrive/dev/infai/dbpedia/databus-python-client (remotes/dhanashree/gsoc-2026*?) $ databusclient manifest summary ./manifests/download.jsonld 
Command  : workflow
Executed : 2026-08-24T12:27:47.344982+00:00
Files    : 0 succeeded · 0 failed
Status   : completed

Download 404s are not traced. Therefore, the example may be misleading, indicating that a 404 error should be tracked.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

Fixed, test added to test_download.py for this.

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.

Could you just replace https://example.org/missing.ttl with https://databus.dbpedia.org/account/notexisting

  1. Cool to use examples related to the DBpedia databus
  2. The client checks the path length to decide whether a group, artifact, etc should be downloaded. For https://example.org/missing.ttl, missing.ttl is interpreted as accoutn which leads to accountId not supported yet (see execution & summary above)

Since you call dl._download_file directly, it does produce a 404. Just for the consistency :)

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

Done — updated the test URL in both test_download.py and test_manifest_summary.py.

Comment thread databusclient/manifest/summary.py Outdated
Sign up for free to 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.

2 participants