cr-connect-workflow/crc/scripts/set_study_status.py

from crc import session
from crc.api.common import ApiError
from crc.models.study import StudyModel, StudyStatus
from crc.scripts.script import Script


class MyScript(Script):

    def get_description(self):
        return """Set the status of the current study. 
        Status can be one of `in_progress`, `hold`, `open_for_enrollment`, or `abandoned`."""

    def do_task_validate_only(self, task, study_id, workflow_id, *args, **kwargs):

        new_status = None
        if 'status' in kwargs.keys() or len(args) > 0:
            if 'status' in kwargs.keys():
                new_status = kwargs['status']
            elif len(args) > 0:
                new_status = args[0]
            try:
                study_status = getattr(StudyStatus, new_status)

            except AttributeError as ae:
                raise ApiError.from_task(code='invalid_argument',
                                         message=f"We could not find a status matching `{new_status}`. Original message: {ae}",
                                         task=task)
            return study_status.value
        else:
            raise ApiError.from_task(code='missing_argument',
                                     message='You must include the new status when calling `set_study_status` script. '
                                             'The new status must be one of `in_progress`, `hold`, `open_for_enrollment`, or `abandoned`.',
                                     task=task)

    def do_task(self, task, study_id, workflow_id, *args, **kwargs):

        # Get new status
        new_status = None
        if 'status' in kwargs.keys() or len(args) > 0:
            if 'new_status' in kwargs.keys():
                new_status = kwargs['new_status']
            elif len(args) > 0:
                new_status = args[0]

            # Get StudyStatus object for new_status
            try:
                study_status = getattr(StudyStatus, new_status)

            # Invalid argument
            except AttributeError as ae:
                raise ApiError.from_task(code='invalid_argument',
                                         message=f"We could not find a status matching `{new_status}`. Original message: {ae}"
                                         'The new status must be one of `in_progress`, `hold`, `open_for_enrollment`, or `abandoned`.',
                                         task=task)

            # Set new status
            study_model = session.query(StudyModel).filter(StudyModel.id == study_id).first()
            study_model.status = study_status
            session.commit()

            return study_model.status.value

        # Missing argument
        else:
            raise ApiError.from_task(code='missing_argument',
                                     message='You must include the new status when calling `set_study_status` script. '
                                             'The new status must be one of `in_progress`, `hold`, `open_for_enrollment`, or `abandoned`.',
                                     task=task)