jflow_cli.py 6.7 KB
Newer Older
Jerome Mariette's avatar
Jerome Mariette committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
#
# Copyright (C) 2012 INRA
# 
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
# 
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
# 
# You should have received a copy of the GNU General Public License
# along with this program.  If not, see <http://www.gnu.org/licenses/>.
#

import sys
import argparse
Jerome Mariette's avatar
Jerome Mariette committed
20
import time
Jerome Mariette's avatar
Jerome Mariette committed
21
22
23
24
25
26
27
28

try:
    import _preamble
except ImportError:
    sys.exc_clear()

from jflow.workflows_manager import WorkflowsManager
from jflow.workflow import Workflow
Jerome Mariette's avatar
Jerome Mariette committed
29
30
import jflow.utils as utils
from cctools.util import time_format
Jerome Mariette's avatar
Jerome Mariette committed
31
32


Jerome Mariette's avatar
Jerome Mariette committed
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
def display_workflow_status(workflow, detailed=False):
    if workflow.start_time: start_time = time.asctime(time.localtime(workflow.start_time))
    else: start_time = "-"
    if workflow.start_time and workflow.end_time: elapsed_time = str(workflow.end_time-workflow.start_time)
    elif workflow.start_time: elapsed_time = str(time.time()-workflow.start_time)
    else: elapsed_time = "-"
    if workflow.end_time: end_time = time.asctime(time.localtime(workflow.end_time))
    else: end_time = "-"
    if detailed:
        status = "Workflow #" + utils.get_nb_string(workflow.id) + " (" + workflow.name + ") is " + \
                workflow.get_status() + ", time elapsed: " + str(elapsed_time) + " (from " + start_time + \
                " to " + end_time + "):\n"
        for i, component in enumerate(workflow.get_components_nameid()):
            status_info = workflow.get_component_status(component)
            try: perc_waiting = (status_info["waiting"]*100.0)/status_info["tasks"]
            except: perc_waiting = 0
            try: perc_running = (status_info["running"]*100.0)/status_info["tasks"]
            except: perc_running = 0
            try: perc_failed = (status_info["failed"]*100.0)/status_info["tasks"]
            except: perc_failed = 0
            try: perc_aborted = (status_info["aborted"]*100.0)/status_info["tasks"]
            except: perc_aborted = 0
            try: perc_completed = (status_info["completed"]*100.0)/status_info["tasks"]
            except: perc_completed = 0
            
            if status_info["running"] > 0: running = "\033[94mrunning:" + str(status_info["running"]) + "\033[0m"
            else: running = "running:" + str(status_info["running"])
            if status_info["waiting"] > 0: waiting = "\033[93mwaiting:" + str(status_info["waiting"]) + "\033[0m"
            else: waiting = "waiting:" + str(status_info["waiting"])            
            if status_info["failed"] > 0: failed = "\033[91mfailed:" + str(status_info["failed"]) + "\033[0m"
            else: failed = "failed:" + str(status_info["failed"])
            if status_info["aborted"] > 0: aborted = "\033[95maborted:" + str(status_info["aborted"]) + "\033[0m"
            else: aborted = "aborted:" + str(status_info["aborted"])
            if status_info["completed"] == status_info["tasks"] and status_info["completed"] > 0: completed = "\033[92mcompleted:" + str(status_info["completed"]) + "\033[0m"
            else: completed = "completed:" + str(status_info["completed"])
                        
            status += "  - " + component + ", time elapsed " + time_format(status_info["time"]) + \
                " (total:" + str(status_info["tasks"]) + ", " + waiting + ", " + running + ", " + failed + \
                ", " + aborted + ", " + completed + ")"
            if i<len(workflow.get_components_nameid())-1: status += "\n"
        return status
    else:
        return utils.get_nb_string(workflow.id) + "\t" + workflow.name + "\t" + workflow.get_status() + \
            "\t" + elapsed_time + "\t" + start_time + "\t" + end_time

Jerome Mariette's avatar
Jerome Mariette committed
78
79
if __name__ == '__main__':

Jerome Mariette's avatar
Jerome Mariette committed
80
81
82
    # Create a workflow manager to get access to our workflows
    wfmanager = WorkflowsManager()
    
Jerome Mariette's avatar
Jerome Mariette committed
83
    # Create the top-level parser
84
    parser = argparse.ArgumentParser(fromfile_prefix_chars='@')
Jerome Mariette's avatar
Jerome Mariette committed
85
86
    subparsers = parser.add_subparsers(title='Available sub commands')
    
Jerome Mariette's avatar
Jerome Mariette committed
87
88
89
90
91
92
93
94
95
96
97
98
99
100
    # Add rerun workflow availability
    sub_parser = subparsers.add_parser("rerun", help="rerun a sepcific workflow")
    sub_parser.add_argument("--workflow-id", type=str, help="Which workflow should be rerun",
                            required=True, dest="workflow_id")
    sub_parser.set_defaults(cmd_object="rerun")

    # Add status workflow availability
    sub_parser = subparsers.add_parser("status", help="monitor a specific workflow")
    sub_parser.add_argument("--workflow-id", type=str, help="Which workflow status should be displayed",
                            default=None, dest="workflow_id")
    sub_parser.add_argument("--all", action="store_true", help="Display all workflows status",
                            default=False, dest="all")
    sub_parser.set_defaults(cmd_object="status")
    
Jerome Mariette's avatar
Jerome Mariette committed
101
    # Add available pipelines
Jerome Mariette's avatar
Jerome Mariette committed
102
103
    wf_instances = wfmanager.get_available_workflows()
    wf_classes = []
Jerome Mariette's avatar
Jerome Mariette committed
104
    for instance in wf_instances:
105
        parser.convert_arg_line_to_args = instance.__class__.config_parser
Jerome Mariette's avatar
Jerome Mariette committed
106
        wf_classes.append(instance.__class__.__name__)
Jerome Mariette's avatar
Jerome Mariette committed
107
108
109
        # create the subparser for each applications
        sub_parser = subparsers.add_parser(instance.name, help=instance.description)
        for param in instance.parameters:
110
            sub_parser.add_argument(param.flag, **param.export_to_argparse())
111
        sub_parser.set_defaults(cmd_object=instance.__class__.__name__, cmd_class=instance.__class__)
Jerome Mariette's avatar
Jerome Mariette committed
112

113
114
115
116
117
118
    args = vars(parser.parse_args())
    if args.has_key("cmd_class"):
        # re parse args with the right parser
        parser.convert_arg_line_to_args = args["cmd_class"].config_parser
        args = vars(parser.parse_args())
        
Jerome Mariette's avatar
Jerome Mariette committed
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
    if args["cmd_object"] in wf_classes:
        wfmanager.run_workflow(args["cmd_object"], args)
    elif args["cmd_object"] == "rerun":
        wfmanager.rerun_workflow(args["workflow_id"])
    elif args["cmd_object"] == "status":
        if args["workflow_id"]:
            workflow = wfmanager.get_workflow(args["workflow_id"])
            print display_workflow_status(workflow, True)
        else:
            workflows = wfmanager.get_workflows()
            if len(workflows) > 0:
                status = "ID\tNAME\tSTATUS\tELAPSED_TIME\tSTART_TIME\tEND_TIME\n"
                for i, workflow in enumerate(workflows):
                    status += display_workflow_status(workflow)
                    if i<len(workflows)-1: status += "\n"
            else: status = "no workflow available"
            print status
Jerome Mariette's avatar
Jerome Mariette committed
136