Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(engines): add workflow engine versions to info endpoint #711

Merged
merged 1 commit into from
Nov 12, 2024

Conversation

Alputer
Copy link
Member

@Alputer Alputer commented Nov 5, 2024

@Alputer Alputer self-assigned this Nov 5, 2024
@Alputer Alputer changed the title feat(engines): add workflow engine versions to info endpoint (#711) feat(engines): add workflow engine versions to info endpoint Nov 5, 2024
Copy link

codecov bot commented Nov 5, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 60.22%. Comparing base (908aca2) to head (999d716).
Report is 1 commits behind head on master.

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #711      +/-   ##
==========================================
+ Coverage   60.13%   60.22%   +0.08%     
==========================================
  Files          32       32              
  Lines        3562     3570       +8     
==========================================
+ Hits         2142     2150       +8     
  Misses       1420     1420              
Files with missing lines Coverage Δ
reana_server/rest/info.py 79.03% <100.00%> (+3.10%) ⬆️

@@ -421,6 +421,10 @@
"description": "Request succeeded. The response contains general info about the cluster.",
"examples": {
"application/json": {
"adage_version": {
Copy link
Member

Choose a reason for hiding this comment

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

It would be good to make a connection to the workflow engine, so that it's apparent that Adage and Packtivity are important only for Yadage workflow engine information.

For example, instead of current output:

$ rc info --json | jq | grep -A 3 packtivity_version
  "packtivity_version": {
    "title": "Packtivity version",
    "value": "0.16.2"
  },

We could have:

  "yadage_packtivity_version": {
    "title": "Yadage Packtivity version",
    "value": "0.16.2"
  },

Or, using the word "engine" everywhere, we could do:

{
  "supported_workflow_engines": {
    "title": "List of supported workflow engines",
    "value": ["cwl", "serial", "snakemake", "yadage"]
  },
  "cwl_engine_version": {
    "title": "CWL engine version",
    "value": "3.1.20210628163208"
  },
  "cwl_engine_tool": {
    "title": "CWL engine tool",
    "value": "cwltool"
  },
  "snakemake_engine_version": {
    "title": "Snakemake engine version",
    "value": "8.24.1"
  },
  "yadage_engine_adage_version": {
    "title": "Yadage engine adage version",
    "value": "0.11.0"
  },
  "yadage_engine_version": {
    "title": "Yadage engine version",
    "value": "0.20.1"
  },
  "yadage_engine_packtivity_version": {
    "title": "Yadage engine packtivity version",
    "value": "0.16.2"
  }
}

One advantage is that this is could be a more evolution-friendly setup in case we would like to print out the supported Snakemake plugins etc one day. (Example: snakemake_engine_storage_plugin_xrootd_version and friends)

@tiborsimko tiborsimko merged commit 999d716 into reanahub:master Nov 12, 2024
14 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

info: enrich output with details about supported workflows
2 participants