workflow.py 43.4 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 inspect
import os
20
import re
Jerome Mariette's avatar
Jerome Mariette committed
21
22
23
24
25
26
27
import sys
import uuid
import pkgutil
import tempfile
import pickle
import time
import threading
Jerome Mariette's avatar
Jerome Mariette committed
28
import types
Jerome Mariette's avatar
Jerome Mariette committed
29
import logging
Jerome Mariette's avatar
Jerome Mariette committed
30
import datetime
Jerome Mariette's avatar
Jerome Mariette committed
31

32
from logging import FileHandler
Jerome Mariette's avatar
Jerome Mariette committed
33
from ConfigParser import ConfigParser, NoOptionError
Jerome Mariette's avatar
Jerome Mariette committed
34
from inspect import getcallargs
Jerome Mariette's avatar
Jerome Mariette committed
35

Jerome Mariette's avatar
Jerome Mariette committed
36
import jflow
Jerome Mariette's avatar
Jerome Mariette committed
37
import jflow.utils as utils
38
from jflow.utils import validate_email
39
from pygraph.classes.digraph import digraph
Jerome Mariette's avatar
Jerome Mariette committed
40
from jflow.workflows_manager import WorkflowsManager, JFlowConfigReader
41
from jflow.utils import get_octet_string_representation, get_nb_octet
42
from jflow.parameter import *
43
from cctools.util import time_format
Jerome Mariette's avatar
Jerome Mariette committed
44
45
46
47
48
49
50
51
52
53
54
55

from weaver.script import ABSTRACTIONS
from weaver.script import DATASETS
from weaver.script import FUNCTIONS
from weaver.script import NESTS
from weaver.script import OPTIONS
from weaver.script import STACKS
from weaver.nest import Nest
from weaver.options import Options
from cctools.makeflow import MakeflowLog
from cctools.makeflow.log import Node

Jerome Mariette's avatar
Jerome Mariette committed
56

Jerome Mariette's avatar
Jerome Mariette committed
57
58
59
60
61
62
class Workflow(threading.Thread):
    """
    """

    PROPERTIES_FILE_NAME = "workflow.properties"
    MAKEFLOW_LOG_FILE_NAME = "Makeflow.makeflowlog"
63
    DUMP_FILE_NAME = ".workflow.dump"
Jerome Mariette's avatar
Jerome Mariette committed
64
65
66
67
68
    WORKING = ".working"
    STATUS_STARTED = "started"
    STATUS_COMPLETED = "completed"
    STATUS_FAILED = "failed"
    STATUS_ABORTED = "aborted"
Jerome Mariette's avatar
Jerome Mariette committed
69
    STATUS_RESETED = "reseted"
70
71
    
    
72
    def __init__(self, args={}, id=None, function= "process"):
Jerome Mariette's avatar
Jerome Mariette committed
73
74
75
76
        # define as a thread
        threading.Thread.__init__(self)
        self.jflow_config_reader = JFlowConfigReader()
        self.manager = WorkflowsManager()
77
        self.components_to_exec = []
78
        self.components = []
Jerome Mariette's avatar
Jerome Mariette committed
79
80
81
82
83
84
        self.makes = {}
        self.globals = {}
        self.options = Options()
        self.status = self.STATUS_STARTED
        self.start_time = None
        self.end_time = None
85
        self.step = None
Frédéric Escudié's avatar
Frédéric Escudié committed
86
        self.stderr = None
Jerome Mariette's avatar
Jerome Mariette committed
87
        self.args = args
88
        self.dynamic_component_present = False
89
90
91
        self.__to_address = None
        self.__subject = None
        self.__message = None
92
        self.function = function
Jerome Mariette's avatar
Jerome Mariette committed
93
        self.comp_pckg = self._import_components()
94
        # intruduce --log-verbose to be able to monitor the new version of makeflow >=4.2.2
Jerome Mariette's avatar
Jerome Mariette committed
95
        self.engine_arguments = ' --log-verbose '
96
        self.component_nameids_is_init = False
Jerome Mariette's avatar
Jerome Mariette committed
97
        self.component_nameids = {}
98
        self.reseted_components = []
Jerome Mariette's avatar
Jerome Mariette committed
99
100
        # try to parse engine arguments
        try:
101
102
            type, options, limit_submission = self.jflow_config_reader.get_batch()
            if limit_submission : self.engine_arguments += ' -J ' + str(limit_submission)
Jerome Mariette's avatar
Jerome Mariette committed
103
104
105
            if type: self.engine_arguments += ' -T ' + type
            if options : self.engine_arguments += ' -B "' + options + '"'
        except: self.engine_arguments = None
106

Jerome Mariette's avatar
Jerome Mariette committed
107
        self.id = id
108
109
110
111
112
        self.name = self.get_name()
        self.description = self.get_description()
        
        # define the parameters 
        self.params_order = []
113
        self.define_parameters(self.function)
114
        # add the metadata parameter
115
        self.add_parameter_list("metadata", "Which metadata should be linked to this workflow")
Jerome Mariette's avatar
Jerome Mariette committed
116
        
Jerome Mariette's avatar
Jerome Mariette committed
117
118
119
120
        if self.id is not None:
            self.directory = self.manager.get_workflow_directory(self.name, self.id)
            if not os.path.isdir(self.directory):
                os.makedirs(self.directory, 0751)
Frédéric Escudié's avatar
Frédéric Escudié committed
121
            if self.stderr is None:
122
                self.set_stderr()
Jerome Mariette's avatar
Jerome Mariette committed
123
            self._serialize()
124
    
125
    def add_input_file(self, name, help, file_format="any", default=None, type="inputfile", 
126
127
128
129
                       required=False, flag=None, group="default", display_name=None, size_limit="0", add_to=None):
        # check if the size provided is correct
        try: int(get_nb_octet(size_limit))
        except: size_limit="0"
130
        new_param = InputFile(name, help, flag=flag, file_format=file_format, default=default, 
131
                              type=type, required=required, group=group, display_name=display_name, size_limit=size_limit)
132
133
134
135
136
137
        # if this input should be added to a particular parameter
        if add_to:
            try:
                self.__getattribute__(add_to).add_sub_parameter(new_param)
            except: pass
        # otherwise, add it to the class itself
138
        else:
139
140
141
142
            self.params_order.append(name)
            self.__setattr__(name, new_param)
            
    def add_input_file_list(self, name, help, file_format="any", default=None, type="inputfile", 
143
144
                            required=False, flag=None, group="default", display_name=None, size_limit="0", add_to=None):
        # check if the size provided is correct
145
        if default == None: default = []
146
147
        try: int(get_nb_octet(size_limit))
        except: size_limit="0"
148
        new_param = InputFileList(name, help, flag=flag, file_format=file_format, default=default, 
149
                                  type=type, required=required, group=group, display_name=display_name, size_limit=size_limit)
150
151
152
        # if this input should be added to a particular parameter
        if add_to:
            try:
Jerome Mariette's avatar
help ok    
Jerome Mariette committed
153
                self.__getattribute__(add_to).add_sub_parameter(new_param)
154
155
156
157
158
            except: pass
        # otherwise, add it to the class itself
        else:
            self.params_order.append(name)
            self.__setattr__(name, new_param)
159
160
            
    def add_multiple_parameter(self, name, help, required=False, flag=None, group="default", display_name=None):
161
        self.params_order.append(name)
162
163
164
165
166
167
        new_param = MultiParameter(name, help, flag=flag, required=required, group=group, display_name=display_name)
        self.__setattr__(name, new_param)

    def add_multiple_parameter_list(self, name, help, required=False, flag=None, group="default", display_name=None):
        self.params_order.append(name)
        new_param = MultiParameterList(name, help, flag=flag, required=required, group=group, display_name=display_name)
168
169
        self.__setattr__(name, new_param)
    
170
171
    def add_parameter(self, name, help, default=None, type=types.StringType, choices=None, 
                      required=False, flag=None, group="default", display_name=None, add_to=None):
172
        new_param = ParameterFactory.factory(name, help, flag=flag, default=default, type=type, choices=choices, 
173
174
175
176
177
178
179
                              required=required, group=group, display_name=display_name)
        # if this input should be added to a particular parameter
        if add_to:
            try:
                self.__getattribute__(add_to).add_sub_parameter(new_param)
            except: pass
        # otherwise, add it to the class itself
180
        else:
181
182
183
184
185
186
187
            self.params_order.append(name)
            self.__setattr__(name, new_param)
    
    def add_parameter_list(self, name, help, default=None, type=types.StringType, choices=None, 
                           required=False, flag=None, group="default", display_name=None, add_to=None):
        if default == None: default = []
        new_param = ParameterList(name, help, flag=flag, default=default, type=type, choices=choices, 
188
189
190
191
                                  required=required, group=group, display_name=display_name)
        # if this input should be added to a particular parameter
        if add_to:
            try:
Jerome Mariette's avatar
help ok    
Jerome Mariette committed
192
                self.__getattribute__(add_to).add_sub_parameter(new_param)
193
194
195
196
197
198
            except: pass
        # otherwise, add it to the class itself
        else:
            self.params_order.append(name)
            self.__setattr__(name, new_param)
    
Jerome Mariette's avatar
Jerome Mariette committed
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
    def add_exclusion_rule(self, *args2exclude):
        # first of all, are this parameter exist
        params2exclude = []
        for arg2exclude in args2exclude:
            try:
                params2exclude.append(self.__getattribute__(arg2exclude))
            except: pass
        # everything is ok, let's go
        if len(params2exclude) == len(args2exclude):
            new_group = "exclude-"+uuid.uuid4().hex[:5]
            for paramsexclude in params2exclude:
                paramsexclude.group = new_group
        # it might be a mutliple param rule
        else:
            for attribute_value in self.__dict__.values():
                if issubclass(attribute_value.__class__, MultiParameter) or issubclass(attribute_value.__class__, MultiParameterList):
                    params2exclude = []
                    for sub_param in attribute_value.sub_parameters:
                        if sub_param.name in args2exclude:
                            params2exclude.append(sub_param)
                    if len(params2exclude) == len(args2exclude):
                        new_group = "exclude-"+uuid.uuid4().hex[:5]
                        flags2exclude = []
                        for paramsexclude in params2exclude:
                            paramsexclude.group = new_group
                            flags2exclude.append(paramsexclude.flag)
                        attribute_value.type.excludes[new_group] = flags2exclude
                        break
227

Frédéric Escudié's avatar
Frédéric Escudié committed
228
    def _prepare_parameter(self, args, parameter, key="name"):
229
230
        new_param = None
        # Retrieve value
Frédéric Escudié's avatar
Frédéric Escudié committed
231
232
        if args.has_key(parameter.__getattribute__(key)):
            value = args[parameter.__getattribute__(key)]
233
234
235
236
237
238
239
240
241
242
        elif parameter != None:
            value = parameter.default
        else:
            value = None
        # Set new parameter
        if parameter.__class__ ==  StrParameter or parameter.__class__ == IntParameter or parameter.__class__ == FloatParameter or parameter.__class__ == BoolParameter or parameter.__class__ == DateParameter:
            new_param = ParameterFactory.factory( parameter.name, parameter.help, default=value, type=parameter.type, choices=parameter.choices, 
                                                  required=parameter.required, flag=parameter.flag, group=parameter.group, 
                                                  display_name=parameter.display_name )
        elif parameter.__class__ ==  ParameterList:
243
            if value == "" : value = [] # from GUI
244
245
246
247
            new_param = ParameterList( parameter.name, parameter.help, default=value, type=parameter.type, choices=parameter.choices,
                                       required=parameter.required, flag=parameter.flag, sub_parameters=parameter.sub_parameters,
                                       group=parameter.group, display_name=parameter.display_name )
        elif parameter.__class__ == InputFileList:
248
            if value == "" : value = [] # from GUI
249
250
251
252
            new_param = InputFileList( parameter.name, parameter.help, file_format=parameter.file_format, default=parameter.prepare_input_files(value),
                                       type=parameter.type, choices=parameter.choices, required=parameter.required, flag=parameter.flag,
                                       group=parameter.group, display_name=parameter.display_name, size_limit=parameter.size_limit )
        elif parameter.__class__ == InputFile:
253
            if value == "" : value = None # from GUI
254
            new_param = InputFile( parameter.name, parameter.help, file_format=parameter.file_format, default=parameter.prepare_input_file(value),
255
256
257
258
259
260
                                   type=parameter.type, choices=parameter.choices, required=parameter.required, flag=parameter.flag, 
                                   group=parameter.group, display_name=parameter.display_name )
        else:
            raise Exception( "Unknown class '" +  parameter.__class__.__name__ + "' for parameter.")
        return new_param

261
262
263
    def _set_parameters(self, args):
        parameters = self.get_parameters()
        for param in parameters:
264
            new_param = None
265
            if param.__class__ == MultiParameter:
266
                new_param = MultiParameter(param.name, param.help, required=param.required, flag=param.flag, group=param.group, display_name=param.display_name)
267
                new_param.sub_parameters = param.sub_parameters
268
269
270
271
272
273
274
                if args[param.name]:
                    sub_args = {}
                    for sarg in args[param.name]:
                        sub_args[sarg[0]] = sarg[1]
                    for sub_param in param.sub_parameters:
                        new_sub_parameter = self._prepare_parameter(sub_args, sub_param, "flag")
                        new_param[new_sub_parameter.name] = new_sub_parameter
275
            elif param.__class__ == MultiParameterList:
276
                new_param = MultiParameterList(param.name, param.help, required=param.required, flag=param.flag, group=param.group, display_name=param.display_name)
277
                new_param.sub_parameters = param.sub_parameters
278
279
                for idx, sargs in enumerate(args[param.name]):
                    new_multi_param = MultiParameter(param.name + '_' + str(idx), '', required=False, flag=None, group="default", display_name=None)
280
                    sub_args = {}
281
                    for sarg in sargs:
Jerome Mariette's avatar
Jerome Mariette committed
282
283
                        sub_args[sarg[0]] = sarg[1]
                    for sub_param in param.sub_parameters:
Frédéric Escudié's avatar
Frédéric Escudié committed
284
                        new_sub_param = self._prepare_parameter(sub_args, sub_param, "flag")
285
286
                        new_multi_param[new_sub_param.name] = new_sub_param
                    new_param.append(new_multi_param)
287
            else:
288
                new_param = self._prepare_parameter(args, param)
289
            self.__setattr__(param.name, new_param)
Frédéric Escudié's avatar
Frédéric Escudié committed
290

Jerome Mariette's avatar
Jerome Mariette committed
291
    def get_execution_graph(self):
292
293
294
        gr = digraph()
        for cpt in self.components:
            gr.add_nodes([cpt.get_nameid()])
Jerome Mariette's avatar
Jerome Mariette committed
295
296
        for cpt in self.components:
            for ioparameter in cpt.__dict__.values():
297
                if ( issubclass( ioparameter.__class__, InputFile ) or issubclass( ioparameter.__class__, InputFileList)):
298
                    for pc_nameid in ioparameter.parent_component_nameid:
299
300
301
                        try: gr.add_edge((pc_nameid, ioparameter.component_nameid))
                        except: pass
        return gr
Frédéric Escudié's avatar
Frédéric Escudié committed
302

303
304
305
306
307
308
309
310
311
312
313
314
    def set_stderr(self):
        if hasattr(self, "stderr") and self.stderr is not None:
            os.rename( self.stderr, os.path.join(self.directory, str(time.time()) + "wf_stderr.old") )
        stderr = os.path.join(self.directory, "wf_stderr.txt")
        logger = logging.getLogger( "wf." + str(self.id) )
        logger.setLevel(logging.DEBUG)
        formatter = logging.Formatter( '%(asctime)s :: %(message)s' )
        file_handler = FileHandler(stderr, 'a')
        file_handler.setLevel(logging.ERROR)
        file_handler.setFormatter(formatter)
        logger.addHandler(file_handler)
        self.stderr = stderr
Frédéric Escudié's avatar
Frédéric Escudié committed
315

316
    @staticmethod
317
    def config_parser(arg_lines):
318
319
        for arg in arg_lines:
            yield arg
Frédéric Escudié's avatar
Frédéric Escudié committed
320

Jerome Mariette's avatar
Jerome Mariette committed
321
    def get_status_under_text_format(self, detailed=False, display_errors=False, html=False):
322
323
324
325
326
        if self.start_time: start_time = time.asctime(time.localtime(self.start_time))
        else: start_time = "-"
        if self.start_time and self.end_time: elapsed_time = str(self.end_time-self.start_time)
        elif self.start_time: elapsed_time = str(time.time()-self.start_time)
        else: elapsed_time = "-"
Jerome Mariette's avatar
Jerome Mariette committed
327
        elapsed_time = "-" if elapsed_time == "-" else str(datetime.timedelta(seconds=int(str(elapsed_time).split(".")[0])))
328
329
330
331
332
333
334
335
336
337
        if self.end_time: end_time = time.asctime(time.localtime(self.end_time))
        else: end_time = "-"
        if detailed:
            # Global
            title = "Workflow #" + utils.get_nb_string(self.id) + " (" + self.name + ") is " + \
                    self.get_status() + ", time elapsed: " + str(elapsed_time) + " (from " + start_time + \
                    " to " + end_time + ")"
            worflow_errors = ""
            error = self.get_errors()
            if error is not None:
Jerome Mariette's avatar
Jerome Mariette committed
338
339
                if html: worflow_errors = "Workflow Error :\n  <span style='color:#ff0000'>" + error["location"] + "\n    " + "\n    ".join(error["msg"]) + "</span>"
                else: worflow_errors = "Workflow Error :\n  \033[91m" + error["location"] + "\n    " + "\n    ".join(error["msg"]) + "\033[0m"
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
            # By components
            components_errors = ""
            status = "Components Status :\n"
            for i, component in enumerate(self.get_components_nameid()):
                status_info = self.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
                
Jerome Mariette's avatar
Jerome Mariette committed
356
357
358
                if status_info["running"] > 0: 
                    if html: running = "<span style='color:#3b3bff'>running:" + str(status_info["running"]) + "</span>"
                    else: running = "\033[94mrunning:" + str(status_info["running"]) + "\033[0m"
359
                else: running = "running:" + str(status_info["running"])
Jerome Mariette's avatar
Jerome Mariette committed
360
361
362
                if status_info["waiting"] > 0: 
                    if html: waiting = "<span style='color:#ffea00'>waiting:" + str(status_info["waiting"]) + "</span>"
                    else: waiting = "\033[93mwaiting:" + str(status_info["waiting"]) + "\033[0m"
363
                else: waiting = "waiting:" + str(status_info["waiting"])            
Jerome Mariette's avatar
Jerome Mariette committed
364
365
366
                if status_info["failed"] > 0: 
                    if html: failed = "<span style='color:#ff0000'>failed:" + str(status_info["failed"]) + "</span>"
                    else: failed = "\033[91mfailed:" + str(status_info["failed"]) + "\033[0m"
367
                else: failed = "failed:" + str(status_info["failed"])
Jerome Mariette's avatar
Jerome Mariette committed
368
369
370
                if status_info["aborted"] > 0: 
                    if html: aborted = "<span style='color:#ff01ba'>aborted:" + str(status_info["aborted"]) + "</span>"
                    else: aborted = "\033[95maborted:" + str(status_info["aborted"]) + "\033[0m"
371
                else: aborted = "aborted:" + str(status_info["aborted"])
Jerome Mariette's avatar
Jerome Mariette committed
372
373
374
                if status_info["completed"] == status_info["tasks"] and status_info["completed"] > 0: 
                    if html: completed = "<span style='color:#14ac00'>completed:" + str(status_info["completed"]) + "</span>"
                    else: completed = "\033[92mcompleted:" + str(status_info["completed"]) + "\033[0m"
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
                else: completed = "completed:" + str(status_info["completed"])
                
                if display_errors and len(status_info["failed_commands"]) > 0:
                    if components_errors == "" :
                        components_errors = "Failed Commands :\n"  
                    components_errors += "  - " + component + " :\n    " + "\n    ".join(status_info["failed_commands"])
                status += "  - " + component + ", time elapsed " + time_format(status_info["time"]) + \
                    " (total:" + str(status_info["tasks"]) + ", " + waiting + ", " + running + ", " + failed + \
                    ", " + aborted + ", " + completed + ")"
                if i<len(self.get_components_nameid())-1: status += "\n"
            # Format str
            pretty_str = title
            pretty_str += ("\n" + worflow_errors) if worflow_errors != "" else ""
            pretty_str += ("\n" + status) if status != "" else ""
            pretty_str += ("\n" + components_errors) if components_errors != "" else ""
Jerome Mariette's avatar
Jerome Mariette committed
390
391
            if html: return pretty_str.replace("\n", "<br />")
            else: return pretty_str
392
        else:
Jerome Mariette's avatar
Jerome Mariette committed
393
394
395
396
397
398
399
400
401
402
403
404
405
406
            pretty_str = utils.get_nb_string(self.id) + "\t" + self.name + "\t"
            if self.get_status() == self.STATUS_STARTED:
                pretty_str += "\033[94m"
            elif self.get_status() == self.STATUS_COMPLETED:
                pretty_str += "\033[92m"
            elif self.get_status() == self.STATUS_FAILED:
                pretty_str += "\033[91m"
            elif self.get_status() == self.STATUS_ABORTED:
                pretty_str += "\033[91m"
            elif self.get_status() == self.STATUS_RESETED:
                pretty_str += "\033[3m"
            pretty_str += self.get_status() + "\033[0m"
            pretty_str += "\t" + elapsed_time + "\t" + start_time + "\t" + end_time
            return pretty_str
407
    
408
    def get_errors(self):
Frédéric Escudié's avatar
Frédéric Escudié committed
409
410
411
412
413
414
        error = {
                 "title"     : "",
                 "msg"       : list(),
                 "traceback" : list()
        }
        line_idx = 0
415
416
417
        FH_stderr = open( self.stderr )
        lines = FH_stderr.readlines()
        while line_idx < len(lines):
Frédéric Escudié's avatar
Frédéric Escudié committed
418
419
420
421
422
423
            if lines[line_idx].strip().endswith("RunWorflowException"):
                error["title"]     = lines[line_idx].rstrip()
                error["msg"]       = list()
                error["traceback"] = list()
                line_idx += 2 # skip : "Traceback (most recent call last):"
                # Traceback
424
                while lines[line_idx] != lines[line_idx].lstrip():
Frédéric Escudié's avatar
Frédéric Escudié committed
425
426
427
428
                    error["traceback"].append({ 
                                               "location" : lines[line_idx].strip(),
                                               "line"     : lines[line_idx].strip()
                    })
429
                    line_idx += 2
Frédéric Escudié's avatar
Frédéric Escudié committed
430
431
432
433
434
                # Error message
                while line_idx < len(lines) and not lines[line_idx].strip().endswith("RunWorflowException"):
                    error["msg"].append( lines[line_idx].strip() )
                    line_idx += 1
                line_idx -= 1
435
436
            line_idx += 1
        FH_stderr.close()
Frédéric Escudié's avatar
Frédéric Escudié committed
437
438
439
440
441
442
        last_stack_location = ""
        if len(error["traceback"]) > 0:
            last_stack_location = error["traceback"][-1]["location"].strip()
            return { "msg" : error["msg"], "location" : last_stack_location }
        else:
            return None
443
    
444
    def get_outputs_per_components(self):
445
446
        outputs_files = {}
        for current_components in self.components:
Philippe Bardou's avatar
Philippe Bardou committed
447
            #status = self.get_component_status(current_components.get_nameid())
448
            outputs_files[current_components.get_nameid()] = current_components.get_output_files()
Philippe Bardou's avatar
Philippe Bardou committed
449
            #outputs_files["0"] = status["completed"]
450
451
        return outputs_files
    
Jerome Mariette's avatar
Jerome Mariette committed
452
453
454
455
456
457
458
459
460
461
462
463
464
465
    def __setstate__(self, state):
        self.__dict__ = state.copy()
        threading.Thread.__init__(self, name=self.name)
        
    def __getstate__(self):
        """
        Threading uses Lock Object, do not consider these objects when serializing a workflow
        """
        odict = self.__dict__.copy()
        del odict['_Thread__started']
        del odict['_Thread__block']
        del odict['_Thread__stderr']
        return odict
    
466
467
468
469
470
471
472
473
474
475
476
477
478
    def set_to_address(self, to_address):
        self.__to_address = to_address

    def set_subject(self, subject):
        self.__subject = subject

    def set_message(self, message):
        self.__message = message
    
    def _send_email(self):
        
        import smtplib
        from email.mime.text import MIMEText        
479
        smtps, smtpp, froma, fromp, toa, subject, message = self.jflow_config_reader.get_email_options()
480
481
482
483
484
        
        if self.__to_address: toa = self.__to_address
        if self.__subject: subject = self.__subject
        if self.__message: message = self.__message
        
485
        if smtps and smtpp and froma and fromp:
486
487
            if not toa: toa = froma
            if validate_email(froma) and validate_email(toa):
488
489
490
491
492
                try:
                    # Open a plain text file for reading.  For this example, assume that
                    # the text file contains only ASCII characters.
                    # Create a text/plain message
                    if not message:
Jerome Mariette's avatar
Jerome Mariette committed
493
494
                        message = self.get_status_under_text_format(True, True, True)
                    msg = MIMEText(message, 'html')
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
                    me = froma
                    you = toa
                    if not subject: subject = "JFlow - Workflow #" + str(self.id) + " is " + self.status
                    msg['Subject'] = subject
                    msg['From'] = me
                    msg['To'] = you
                    # Send the message via our own SMTP server, but don't include the
                    # envelope header.
                    s = smtplib.SMTP(smtps, smtpp)
                    s.ehlo()
                    s.starttls()
                    s.login(me, fromp)
                    s.sendmail(me, [you], msg.as_string())
                    s.close()
                except:
                    logging.getLogger("wf." + str(self.id)).debug("Impossible to connect to smtp server '" + smtps + "'")
          
512
513
514
515
    def get_parameters_per_groups(self):
        name = self.get_name()
        description = self.get_description()
        parameters = self.get_parameters()
516
517
        pgparameters, parameters_order = {}, []
        for param in parameters:
Jerome Mariette's avatar
Jerome Mariette committed
518
            if param.group not in parameters_order: parameters_order.append(param.group)
519
520
            if pgparameters.has_key(param.group):
                pgparameters[param.group].append(param)
Jerome Mariette's avatar
Jerome Mariette committed
521
            else:
522
523
                pgparameters[param.group] = [param]
        return [pgparameters, parameters_order]
Jerome Mariette's avatar
Jerome Mariette committed
524
    
525
526
527
528
529
530
531
532
    def get_parameters(self):
        params = []
        for param in self.params_order:
            for attribute_value in self.__dict__.values():
                if (issubclass(attribute_value.__class__, AbstractParameter)) and param == attribute_value.name:
                    params.append(attribute_value)
        return params
    
533
    def get_exec_path(self, software):
534
535
536
537
538
        exec_path = self.jflow_config_reader.get_exec(software)
        if exec_path is None and os.path.isfile(os.path.join(os.path.dirname(inspect.getfile(self.__class__)), "../bin", software)):
            exec_path = os.path.join(os.path.dirname(inspect.getfile(self.__class__)), "../bin", software)
        elif exec_path is None and os.path.isfile(os.path.join(os.path.dirname(inspect.getfile(self.__class__)), "bin", software)):
            exec_path = os.path.join(os.path.dirname(inspect.getfile(self.__class__)), "bin", software)
539
        elif exec_path is None and utils.which(software) == None:
Jerome Mariette's avatar
Jerome Mariette committed
540
            utils.display_error_message("'" + software + "' path connot be retrieved either in the PATH and in the application.properties file!")
541
542
543
        elif exec_path is None and utils.which(software) != None: 
            exec_path = software
        elif exec_path != None and not os.path.isfile(exec_path):
Jerome Mariette's avatar
Jerome Mariette committed
544
            utils.display_error_message("'" + exec_path + "' set for '" + software + "' does not exists, please provide a valid path!")
545
        return exec_path
546
    
Jerome Mariette's avatar
Jerome Mariette committed
547
548
    def add_component(self, component_name, args=[], kwargs={}, component_prefix="default"):
        # first build and check if this component is OK
549
550
551
552
553
554
555
556
        if self.comp_pckg.has_key(component_name):
            my_pckge = __import__(self.comp_pckg[component_name], globals(), locals(), [component_name], -1)
            # build the object and define required field
            cmpt_object = getattr(my_pckge, component_name)()
            cmpt_object.output_directory = self.get_component_output_directory(component_name, component_prefix)
            cmpt_object.prefix = component_prefix
            if kwargs: cmpt_object.define_parameters(**kwargs)
            else: cmpt_object.define_parameters(*args)
557
558
            
            # there is a dynamic component
559
            if cmpt_object.is_dynamic():
560
561
562
563
                self.dynamic_component_present = True
                # if already init, add the component to the list and check if weaver should be executed
                if self.component_nameids_is_init:
                    # add the component
564
                    self.components_to_exec.append(cmpt_object)
565
                    self.components.append(cmpt_object)
566
567
568
569
570
571
572
573
574
                    self._execute_weaver()
                    # update outputs
                    for output in cmpt_object.get_dynamic_outputs():
                        output.update()
                else:
                    if self._component_is_duplicated(cmpt_object):
                        raise ValueError("Component " + cmpt_object.__class__.__name__ + " with prefix " + 
                                            cmpt_object.prefix + " already exist in this pipeline!")
                    self.component_nameids[cmpt_object.get_nameid()] = None
575
                    self.components_to_exec = []
576
                    self.components = []
577
578
579
            else:
                if self.component_nameids_is_init:
                    # add the component
580
                    self.components_to_exec.append(cmpt_object)
581
                    self.components.append(cmpt_object)
582
                elif not self.component_nameids_is_init and not self.dynamic_component_present:
Jerome Mariette's avatar
Jerome Mariette committed
583
584
585
                    if self._component_is_duplicated(cmpt_object):
                        raise ValueError("Component " + cmpt_object.__class__.__name__ + " with prefix " + 
                                            cmpt_object.prefix + " already exist in this pipeline!")
586
                    self.components_to_exec.append(cmpt_object)
587
                    self.components.append(cmpt_object)
588
589
590
591
592
593
                else:
                    if self._component_is_duplicated(cmpt_object):
                        raise ValueError("Component " + cmpt_object.__class__.__name__ + " with prefix " + 
                                            cmpt_object.prefix + " already exist in this pipeline!")
                    self.component_nameids[cmpt_object.get_nameid()] = None

594
595
            return cmpt_object
        else:
Jerome Mariette's avatar
Jerome Mariette committed
596
            raise ImportError(component_name + " component cannot be loaded, available components are: {0}".format(", ".join(self.comp_pckg.keys())))
Jerome Mariette's avatar
Jerome Mariette committed
597
598
599
600
601
602
603
604
    
    def pre_process(self):
        pass
    
    def process(self):
        """ 
        Run the workflow, has to be implemented by subclasses
        """
605
        raise NotImplementedError( "Workflow.process() must be implemented in " + self.__class__.__name__ )
606
607
608

    def get_name(self):
        """ 
609
        Return the workflow name.
610
        """
Jerome Mariette's avatar
Jerome Mariette committed
611
        return self.__class__.__name__.lower()
612
613
614
615
616
    
    def get_description(self):
        """ 
        Return the workflow description, has to be implemented by subclasses
        """
617
        raise NotImplementedError( "Workflow.get_description() must be implemented in " + self.__class__.__name__ )
618
    
619
    def define_parameters(self, function="process"):
620
621
622
        """ 
        Define the workflow parameters, has to be implemented by subclasses
        """
623
        raise NotImplementedError( "Workflow.define_parameters() must be implemented in " + self.__class__.__name__ )
Jerome Mariette's avatar
Jerome Mariette committed
624
625
626
627
628
629
630
631
632
633
634
635
636
637
    
    def post_process(self):
        pass
    
    def get_temporary_file(self, suffix=".txt"):
        tempfile_name = os.path.basename(tempfile.NamedTemporaryFile(suffix=suffix).name)
        return os.path.join(self.jflow_config_reader.get_tmp_directory(), tempfile_name)

    def get_component_output_directory(self, component_name, component_prefix):
        return os.path.join(self.directory, component_name + "_" + component_prefix)
    
    def get_components_nameid(self):
        return self.component_nameids.keys()
    
Jerome Mariette's avatar
Jerome Mariette committed
638
639
    def wf_execution_wrapper(self):
        getattr(self, self.function)()
Jerome Mariette's avatar
Jerome Mariette committed
640
    
Jerome Mariette's avatar
Jerome Mariette committed
641
642
643
644
    def run(self):
        """
        Only require for Threading
        """
645
646
647
648
649
650
651
        try:
            # if this is the first time the workflow run
            if self.step == None :
                self.start_time = time.time()
                self.step = 0
                self.status = self.STATUS_STARTED
                self.end_time = None
Jerome Mariette's avatar
Jerome Mariette committed
652
653
                # if some args are provided, let's fill the parameters
                self._set_parameters(self.args)
654
                self._serialize()
655
656
657
658
659
660
661
            # if pre_processing has not been done yet
            if self.step == 0:
                self.pre_process()
                self.step = 1
                self._serialize()
            # if collecting components and running workflow has not been done yet
            if self.step == 1:
662
663
                try:
                    self.reseted_components = []
664
                    self.components = []
Jerome Mariette's avatar
Jerome Mariette committed
665
                    self.status = self.STATUS_STARTED
666
667
668
669
670
                    self.wf_execution_wrapper()
                except SystemExit, e: 
                    self.status = self.STATUS_FAILED
                    self.end_time = time.time()
                    self._serialize()
671
                    self._send_email()
672
673
674
675
676
677
678
679
680
681
                    raise
                self.component_nameids_is_init = True
                if self.dynamic_component_present:
                    self.step = 2
                else:
                    self._execute_weaver()
                    self.step = 3
                self._serialize() 
            # if the workflow was a dynamic one
            if self.step == 2:
682
683
                try:
                    self.reseted_components = []
684
                    self.components = []
Jerome Mariette's avatar
Jerome Mariette committed
685
                    self.status = self.STATUS_STARTED
686
687
688
689
690
                    self.wf_execution_wrapper()
                except SystemExit, e: 
                    self.status = self.STATUS_FAILED
                    self.end_time = time.time()
                    self._serialize()
691
                    self._send_email()
692
693
694
                    raise
                if len(self.components_to_exec) > 0:
                    self._execute_weaver()
695
                self.step = 3
696
697
698
699
                self._serialize()
            # if post processing has ne been done yet
            if self.step == 3:
                self.post_process()
700
                if self.status == self.STATUS_STARTED: self.status = self.STATUS_COMPLETED
701
702
                self.end_time = time.time()
                self._serialize()
703
                self._send_email()
704
705
706
        except:
            logging.getLogger("wf." + str(self.id)).exception("RunWorflowException")
            raise
707

Jerome Mariette's avatar
Jerome Mariette committed
708
709
710
711
712
713
714
715
716
717
718
    def _update_status_from_log(self):
        # first update the status from weaver folders
        # TODO update self.end_time
        try:
            working_directory = os.path.join(self.directory, self.WORKING)
            make_states = []
            for wdir in os.listdir(working_directory):
                log_path = os.path.join(working_directory, wdir, self.MAKEFLOW_LOG_FILE_NAME)
                log = MakeflowLog(log_path)
                log.parse()
                make_states.append(log.state)
Jerome Mariette's avatar
Jerome Mariette committed
719
720
721
            if len(self.reseted_components) > 0:
                self.status = self.STATUS_RESETED
            elif self.STATUS_ABORTED in make_states:
Jerome Mariette's avatar
Jerome Mariette committed
722
723
724
725
726
727
728
729
730
731
732
733
                self.status = self.STATUS_ABORTED
            elif self.STATUS_FAILED in make_states:
                self.status = self.STATUS_FAILED
            elif self.status != self.STATUS_COMPLETED:
                self.status = self.STATUS_STARTED
        except: pass
        self._serialize()

    def get_status(self):
        self._update_status_from_log()
        return self.status
    
734
735
736
    def get_resource(self, resource):
        return self.jflow_config_reader.get_resource(resource)
    
Jerome Mariette's avatar
Jerome Mariette committed
737
738
739
740
741
742
743
    def get_component_status(self, component_nameid):
        status = {"time": 0.0,
                  "tasks": 0,
                  "waiting": 0,
                  "running": 0,
                  "failed":0,
                  "aborted": 0,
744
745
                  "completed": 0,
                  "failed_commands": list() }
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
        if component_nameid not in self.reseted_components:
            try:
                log = MakeflowLog(self.component_nameids[component_nameid])
                log.parse()
                symbols = set(n.symbol for n in log.nodes if n.symbol)
                if not symbols: return None
                for n in log.nodes:
                    if not n.symbol: continue
                    if n.symbol == component_nameid:
                        status["tasks"] += 1
                        status["time"]  += n.elapsed_time
                        if n.state == Node.WAITING:
                            status["waiting"] += 1
                        elif n.state == Node.RUNNING:
                            status["running"] += 1
                        elif n.state == Node.FAILED:
                            status["failed"] += 1
                            status["failed_commands"].append( n.command )
                        elif n.state == Node.ABORTED:
                            status["aborted"] += 1
                        elif n.state == Node.COMPLETED:
                            status["completed"] += 1
            except: pass
Frédéric Escudié's avatar
Frédéric Escudié committed
769
        return status
Jerome Mariette's avatar
Jerome Mariette committed
770
    
771
772
773
774
775
776
777
778
779
    def reset_component(self, component_name):
        # first reinit the step to the execution step
        self.step = 1
        found = False
        for cpt in self.components:
            if cpt.get_nameid() == component_name:
                cpt.reset()
                found = True
        if not found:
Jerome Mariette's avatar
Jerome Mariette committed
780
            utils.display_error_message("Impossible to reset component '" + component_name + "'! This one is not part of the workflow")
781
        self.reseted_components.append(component_name)
Jerome Mariette's avatar
Jerome Mariette committed
782
        self.status = self.STATUS_RESETED
783
784
        self._serialize()
    
Jerome Mariette's avatar
Jerome Mariette committed
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
    def makeflow_pretty_print_node(self, dag, node):
        sys.stdout.write('{0:>10} {1} {2}\n'.format('NODE', node.id, node.symbol))
        
        for output_file in sorted(node.output_files):
            sys.stdout.write('{0:>10} {1:>10} {2}\n'.format('', 'OUTPUT', output_file))
    
        for input_file in sorted(node.input_files):
            sys.stdout.write('{0:>10} {1:>10} {2}\n'.format('', 'INPUT', input_file))
            
        sys.stdout.write('{0:>10} {1:>10} {2}\n'.format('', 'COMMAND', node.command))

    def _execute_weaver(self, engine_wrapper=None):
        # Add nest path and path to script to Python module path to allow
        # for importing modules outside of $PYTHONPATH
        make_directory, new_make = self._get_current_make()
        current_working_directory = os.path.join(os.path.join(self.directory, self.WORKING), make_directory)
        sys.path.insert(0, os.path.abspath(os.path.dirname(current_working_directory)))

        # Load built-ins
        self._import('abstraction', ABSTRACTIONS)
        self._import('dataset', DATASETS)
        self._import('function', FUNCTIONS)
        self._import('nest', NESTS)
        self._import('options', OPTIONS)
        self._import('stack', STACKS)
                
        # Execute nest
        with Nest(current_working_directory, wrapper=engine_wrapper, path=self.jflow_config_reader.get_makeflow_path()) as nest:
            with self.options:
                if new_make:
                    try:
816
                        for component in self.components_to_exec:
Jerome Mariette's avatar
Jerome Mariette committed
817
                            nest.symbol = component.get_nameid()
818
                            nest.batch = component.batch_options
Jerome Mariette's avatar
Jerome Mariette committed
819
820
821
822
823
824
                            self.component_nameids[component.get_nameid()] = os.path.join(current_working_directory, self.MAKEFLOW_LOG_FILE_NAME)
                            component.execute()
                        # create the DAG
                        nest.compile()
                    except Exception as e:
                        self.status = self.STATUS_FAILED
Jerome Mariette's avatar
Jerome Mariette committed
825
                        self.end_time = time.time()
Jerome Mariette's avatar
Jerome Mariette committed
826
                        self._serialize()
Jerome Mariette's avatar
Jerome Mariette committed
827
                        raise
828
                self.components_to_exec = []  
Jerome Mariette's avatar
Jerome Mariette committed
829
830
831
832
833
834
835
836
                # Once a weaver script is compiled, serialize the workflow
                self._serialize()
                try:
                    nest.execute(self.engine_arguments, exit_on_failure=True)
                except:
                    self.status = self.STATUS_FAILED
                    self.end_time = time.time()
                    self._serialize()
Jerome Mariette's avatar
Jerome Mariette committed
837
                    raise
Jerome Mariette's avatar
Jerome Mariette committed
838
839
840

    def _get_current_make(self):
        current_component, make_directory, new_make = [], None, False
841
        for component in self.components_to_exec:
Jerome Mariette's avatar
Jerome Mariette committed
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
            current_component.append(component.get_nameid())
        for make in self.makes:
            if set(current_component) == set(self.makes[make]):
                make_directory = make
        # If the components in the queue have already been compiled
        if make_directory is None:
            make_directory = uuid.uuid4().hex[:10]
            self.makes[make_directory] = current_component
            new_make = True
        return [make_directory, new_make]
    
    def _serialize(self):
        self.dump_path = os.path.join(self.directory, self.DUMP_FILE_NAME)
        workflow_dump = open(self.dump_path, "wb")
        pickle.dump(self, workflow_dump)
        workflow_dump.close()

859
860
    def _component_is_duplicated(self, component):
        if component.get_nameid() in self.component_nameids.keys():
Jerome Mariette's avatar
Jerome Mariette committed
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
            return True
        return False

    def _get_property_path(self):
        """ 
        Return(type:string):  the path to the workflow properties file, None if does not exist
        """
        property_file = os.path.join(os.path.dirname(inspect.getfile(self.__class__)), self.PROPERTIES_FILE_NAME)
        return property_file if os.path.isfile(property_file) else None

    def _import_components(self):
        pckge = {}
        # then import pipeline packages
        pipeline_dir = os.path.dirname(inspect.getfile(self.__class__))
        for importer, modname, ispkg in pkgutil.iter_modules([os.path.join(pipeline_dir, "components")], "workflows." + 
                                                             os.path.basename(pipeline_dir) + ".components."):
Jerome Mariette's avatar
Jerome Mariette committed
877
878
879
880
881
            try:
                m = __import__(modname)
                for class_name, obj in inspect.getmembers(sys.modules[modname], inspect.isclass):
                    if issubclass(obj, jflow.component.Component) and obj.__name__ != jflow.component.Component.__name__:
                        pckge[class_name] = modname
Jerome Mariette's avatar
Jerome Mariette committed
882
            except Exception as e:
Jerome Mariette's avatar
Jerome Mariette committed
883
                logging.getLogger("Workflow._import_components").debug("Component <{0}> cannot be loaded: {1}".format(modname, e))
Jerome Mariette's avatar
Jerome Mariette committed
884
885
886
        # finally import workflows shared packages
        workflows_dir = os.path.dirname(os.path.dirname(inspect.getfile(self.__class__)))
        for importer, modname, ispkg in pkgutil.iter_modules([os.path.join(workflows_dir, "components")], "workflows.components."):
Jerome Mariette's avatar
Jerome Mariette committed
887
888
889
890
891
            try:
                m = __import__(modname)
                for class_name, obj in inspect.getmembers(sys.modules[modname], inspect.isclass):
                    if issubclass(obj, jflow.component.Component) and obj.__name__ != jflow.component.Component.__name__:
                        pckge[class_name] = modname
Jerome Mariette's avatar
Jerome Mariette committed
892
893
            except Exception as e:
                logging.getLogger("Workflow._import_components").debug("Component <{0}> cannot be loaded: {1}".format(modname, e))
Jerome Mariette's avatar
Jerome Mariette committed
894
895
896
897
898
899
900
901
902
903
904
        return pckge

    def _import(self, module, symbols):
        """ Import ``symbols`` from ``module`` into global namespace. """
        # Import module
        m = 'weaver.{0}'.format(module)
        m = __import__(m, self.globals, self.globals, symbols, -1)

        # Import symbols from module into global namespace, which we store as
        # an attribute for later use (i.e. during compile)
        for symbol in symbols:
905
            self.globals[symbol] = getattr(m, symbol)