Source code for idmtools_platform_comps.ssmt_work_items.icomps_workflowitem

"""idmtools ICOMPSWorkflowItem.

Copyright 2021, Bill & Melinda Gates Foundation. All rights reserved.
"""
from uuid import UUID
import json
from abc import ABC
from dataclasses import field, dataclass
from idmtools.assets.file_list import FileList
from idmtools.entities.iworkflow_item import IWorkflowItem


@dataclass
class ICOMPSWorkflowItem(IWorkflowItem, ABC):
    """
    Interface of idmtools work item.
    """

    name: str = field(default="idmtools workflow item")
    work_order: dict = field(default_factory=lambda: {})
    work_item_type: str = field(default=None)
    plugin_key: str = field(default="1.0.0.0_RELEASE")

    def __post_init__(self, item_name: str, asset_collection_id: UUID, asset_files: FileList, user_files: FileList):
        """Constructor."""
        super().__post_init__(item_name, asset_collection_id, asset_files, user_files)
        self.work_order = self.work_order or {}

    def __repr__(self):
        """Workitem as string."""
        return f"<WorkItem {self.uid}>"

    def get_base_work_order(self):
        """Get the base work order."""
        base_wo = {"WorkItem_Type": self.work_item_type}
        return base_wo

    def load_work_order(self, wo_file):
        """Load work order from a file."""
        self.work_order = json.load(open(wo_file, 'rb'))

    def set_work_order(self, wo):
        """
        Update wo for the name with value.

        Args:
            wo: user wo
        Returns: None
        """
        self.work_order = wo

    def update_work_order(self, name, value):
        """
        Update wo for the name with value.

        Args:
            name: wo arg name
            value: wo arg value

        Returns: None
        """
        self.work_order[name] = value

    def clear_wo_args(self):
        """
        Clear all existing wo args.

        Returns: None

        """
        self.work_order = {}