cr-connect-workflow/crc/scripts/get_workflow_status.py
mike cullerton bbd12da472 Use workflow_spec_id instead of workflow_id, since workflows can be deleted
I simplified do_task_validation since we get a random string for the workflow_spec_id
2022-03-09 11:14:54 -05:00

48 lines
1.8 KiB
Python

from crc import session
from crc.api.common import ApiError
from crc.models.workflow import WorkflowModel
from crc.scripts.script import Script
class MyScript(Script):
def get_description(self):
return """
Get the status of a workflow.
Currently, status is one of "not_started", "user_input_required", "waiting", or "complete".
You must pass a workflow_id.
Examples:
status = get_workflow_status(1)
status = get_workflow_status(search_workflow_id=1)
"""
def do_task_validate_only(self, task, study_id, workflow_id, *args, **kwargs):
if 'workflow_spec_id' in kwargs.keys() or len(args) > 0:
return 'not_started'
else:
raise ApiError.from_task(code='missing_argument',
message='You must include a workflow_spec_id when calling the `get_workflow_status` script.',
task=task)
def do_task(self, task, study_id, workflow_id, *args, **kwargs):
if 'workflow_spec_id' in kwargs.keys() or len(args) > 0:
if 'workflow_spec_id' in kwargs.keys():
workflow_spec_id = kwargs['workflow_spec_id']
else:
workflow_spec_id = args[0]
workflow_model = session.query(WorkflowModel). \
filter(WorkflowModel.workflow_spec_id == workflow_spec_id). \
filter(WorkflowModel.study_id == study_id).\
first()
if workflow_model:
return workflow_model.status.value
else:
return f'No model found for workflow {workflow_spec_id}.'
else:
raise ApiError.from_task(code='missing_argument',
message='You must include a workflow_spec_id when calling the `get_workflow_status` script.',
task=task)