workflow.py 57.1 KB
Newer Older
Jerome Mariette's avatar
Jerome Mariette committed
1
#
Jerome Mariette's avatar
Jerome Mariette committed
2
# Copyright (C) 2015 INRA
Jerome Mariette's avatar
Jerome Mariette committed
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
# 
# 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 datetime
30
31
import logging
import traceback
Jerome Mariette's avatar
Jerome Mariette committed
32

33
from configparser import ConfigParser, NoOptionError
Jerome Mariette's avatar
Jerome Mariette committed
34
from inspect import getcallargs
35
from datetime import date as ddate
Jerome Mariette's avatar
Jerome Mariette committed
36

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

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
57

58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
class MINIWorkflow(object):
    
    def __init__(self, id, name, description, status, start_time, end_time, metadata, 
                 component_nameids, compts_status, errors):
        self.id = id
        self.name = name
        self.description = description
        self.status = status
        self.start_time = start_time
        self.end_time = end_time
        self.metadata = metadata
        self.component_nameids = component_nameids
        self.compts_status = compts_status
        self.errors = errors
        
    def get_components_nameid(self):
        return self.component_nameids

76
77
78
    def get_components_status(self):
        return self.compts_status
    
79
80
81
82
83
84
85
86
    def get_component_status(self, component_nameid):
        return self.compts_status[component_nameid]
    
    def get_errors(self):
        return self.errors
    
    def get_status(self):
        return self.status
87

88
89
class Workflow(threading.Thread):
    
Jerome Mariette's avatar
Jerome Mariette committed
90
    MAKEFLOW_LOG_FILE_NAME = "Makeflow.makeflowlog"
91
    DUMP_FILE_NAME = ".workflow.dump"
92
    STDERR_FILE_NAME = "wf_stderr.txt"
Jerome Mariette's avatar
Jerome Mariette committed
93
    WORKING = ".working"
94
    OLD_EXTENSION = ".old"
95
    DEFAULT_GROUP = "default"
96
    
97
    STATUS_PENDING = "pending"
Jerome Mariette's avatar
Jerome Mariette committed
98
99
100
101
    STATUS_STARTED = "started"
    STATUS_COMPLETED = "completed"
    STATUS_FAILED = "failed"
    STATUS_ABORTED = "aborted"
Jerome Mariette's avatar
Jerome Mariette committed
102
    STATUS_RESETED = "reseted"
103
    
Jerome Mariette's avatar
Jerome Mariette committed
104
105
106
    INPUTFILE_GRAPH_LABEL = "inputfile"
    INPUTFILES_GRAPH_LABEL = "inputfiles"
    INPUTDIRECTORY_GRAPH_LABEL = "inputdirectory"
107
108
    COMPONENT_GRAPH_LABEL = "component"
    
109
    
110
    def __init__(self, args={}, id=None, function= "process"):
Jerome Mariette's avatar
Jerome Mariette committed
111
112
113
114
        # define as a thread
        threading.Thread.__init__(self)
        self.jflow_config_reader = JFlowConfigReader()
        self.manager = WorkflowsManager()
115
        self.components_to_exec = []
116
        self.components = []
Jerome Mariette's avatar
Jerome Mariette committed
117
118
119
120
        self.makes = {}
        self.globals = {}
        self.options = Options()
        self.status = self.STATUS_STARTED
121
        self.postprocess_status = self.STATUS_PENDING
Jerome Mariette's avatar
Jerome Mariette committed
122
123
        self.start_time = None
        self.end_time = None
Jerome Mariette's avatar
Jerome Mariette committed
124
        self.__step = None
Frédéric Escudié's avatar
Frédéric Escudié committed
125
        self.stderr = None
Jerome Mariette's avatar
Jerome Mariette committed
126
        self.args = args
127
        self.dynamic_component_present = False
128
129
130
        self.__to_address = None
        self.__subject = None
        self.__message = None
131
        self.function = function
132
        # intruduce --log-verbose to be able to monitor the new version of makeflow >=4.2.2
Jerome Mariette's avatar
Jerome Mariette committed
133
        self.engine_arguments = ' --log-verbose '
134
        self.component_nameids_is_init = False
Jerome Mariette's avatar
Jerome Mariette committed
135
        self.component_nameids = {}
136
        self.reseted_components = []
Jerome Mariette's avatar
Jerome Mariette committed
137
138
        # try to parse engine arguments
        try:
139
140
            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
141
142
143
            if type: self.engine_arguments += ' -T ' + type
            if options : self.engine_arguments += ' -B "' + options + '"'
        except: self.engine_arguments = None
144

Jerome Mariette's avatar
Jerome Mariette committed
145
        self.id = id
146
147
        self.name = self.get_name()
        self.description = self.get_description()
Ibouniyamine Nabihoudine's avatar
Ibouniyamine Nabihoudine committed
148
        self.__group = self.jflow_config_reader.get_workflow_group(self.__class__.__name__) or self.DEFAULT_GROUP
149
150
151
        
        # define the parameters 
        self.params_order = []
Jerome Mariette's avatar
Jerome Mariette committed
152
153
        if self.function != None:
            self.define_parameters(self.function)
154
        # add the metadata parameter
155
        self.metadata = []
Jerome Mariette's avatar
Jerome Mariette committed
156
        
Jerome Mariette's avatar
Jerome Mariette committed
157
158
159
        if self.id is not None:
            self.directory = self.manager.get_workflow_directory(self.name, self.id)
            if not os.path.isdir(self.directory):
160
                os.makedirs(self.directory, 0o751)
Frédéric Escudié's avatar
Frédéric Escudié committed
161
            if self.stderr is None:
162
                self.stderr = self._set_stderr()
Jerome Mariette's avatar
Jerome Mariette committed
163
            self._serialize()
Jerome Mariette's avatar
Jerome Mariette committed
164
            
165
166
        self.internal_components = self._import_internal_components()
        self.external_components = self._import_external_components()
167

168
169
    def get_workflow_group(self):
        return self.__group
170
            
Jerome Mariette's avatar
Jerome Mariette committed
171
    def add_input_directory(self, name, help, default=None, required=False, flag=None, 
172
173
174
                            group="default", display_name=None, get_files_fn=None, add_to=None):
        new_param = InputDirectory(name, help, flag=flag, default=default, required=required, 
                                   group=group, display_name=display_name, get_files_fn=get_files_fn)
Jerome Mariette's avatar
Jerome Mariette committed
175
176
177
178
179
180
181
182
183
184
185
        new_param.linkTrace_nameid = 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
        else:
            self.params_order.append(name)
            self.__setattr__(name, new_param)
    
186
    def add_input_file(self, name, help, file_format="any", default=None, type="inputfile", 
187
188
189
190
                       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"
191
        new_param = InputFile(name, help, flag=flag, file_format=file_format, default=default, 
192
                              type=type, required=required, group=group, display_name=display_name, size_limit=size_limit)
Frédéric Escudié's avatar
Frédéric Escudié committed
193
        new_param.linkTrace_nameid = name
194
195
196
197
198
199
        # 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
200
        else:
201
202
203
204
            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", 
205
206
                            required=False, flag=None, group="default", display_name=None, size_limit="0", add_to=None):
        # check if the size provided is correct
207
        if default == None: default = []
208
209
        try: int(get_nb_octet(size_limit))
        except: size_limit="0"
210
211
212
213
214
215
216
        if default == None:
            inputs = []
        elif issubclass(default.__class__, list):
            inputs = [IOFile(file, file_format, name, None) for file in default]
        else:
            inputs = [IOFile(default, file_format, name, None)]
        new_param = InputFileList(name, help, flag=flag, file_format=file_format, default=inputs, 
217
                                  type=type, required=required, group=group, display_name=display_name, size_limit=size_limit)
Frédéric Escudié's avatar
Frédéric Escudié committed
218
        new_param.linkTrace_nameid = name
219
220
221
        # if this input should be added to a particular parameter
        if add_to:
            try:
Jerome Mariette's avatar
help ok    
Jerome Mariette committed
222
                self.__getattribute__(add_to).add_sub_parameter(new_param)
223
224
225
226
227
            except: pass
        # otherwise, add it to the class itself
        else:
            self.params_order.append(name)
            self.__setattr__(name, new_param)
228
229
            
    def add_multiple_parameter(self, name, help, required=False, flag=None, group="default", display_name=None):
230
        self.params_order.append(name)
231
232
233
234
235
236
        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)
237
238
        self.__setattr__(name, new_param)
    
239
    def add_parameter(self, name, help, default=None, type=str, choices=None, 
240
                      required=False, flag=None, group="default", display_name=None, add_to=None):
241
        new_param = ParameterFactory.factory(name, help, flag=flag, default=default, type=type, choices=choices, 
242
243
244
245
246
247
248
                              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
249
        else:
250
251
252
            self.params_order.append(name)
            self.__setattr__(name, new_param)
    
253
    def add_parameter_list(self, name, help, default=None, type=str, choices=None, 
254
255
256
                           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, 
257
258
259
260
                                  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
261
                self.__getattribute__(add_to).add_sub_parameter(new_param)
262
263
264
265
266
267
            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
268
    def add_exclusion_rule(self, *args2exclude):
Jerome Mariette's avatar
Jerome Mariette committed
269
        # first of all, does this parameter exist
Jerome Mariette's avatar
Jerome Mariette committed
270
271
272
273
274
275
276
277
278
279
280
281
        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:
282
            self._log("Exclusion rule cannot be applied within a MultiParameter or a MultiParameterList", raisee=True)
Jerome Mariette's avatar
Jerome Mariette committed
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
        # save this for MultiParameter internal exclusion rules, works on command line, not supported on gui
#             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
298

Frédéric Escudié's avatar
Frédéric Escudié committed
299
    def _prepare_parameter(self, args, parameter, key="name"):
300
301
        new_param = None
        # Retrieve value
302
        if parameter.__getattribute__(key) in args:
Frédéric Escudié's avatar
Frédéric Escudié committed
303
            value = args[parameter.__getattribute__(key)]
Jerome Mariette's avatar
Jerome Mariette committed
304
        elif parameter.default != None:
305
306
307
308
            value = parameter.default
        else:
            value = None
        # Set new parameter
Frédéric Escudié's avatar
Frédéric Escudié committed
309
310
        if parameter.__class__ in [StrParameter, IntParameter, FloatParameter, BoolParameter, DateParameter]:
            if value == "" and parameter.__class__ in [IntParameter, FloatParameter, BoolParameter, DateParameter] : value = None # from GUI
311
312
313
314
            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:
315
            if value == "" : value = [] # from GUI
316
317
318
319
            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:
320
            if value == "" : value = [] # from GUI
321
            iovalues = []
Ibouniyamine Nabihoudine's avatar
Ibouniyamine Nabihoudine committed
322
            prepared_files = parameter.prepare(value)
323
            for file in prepared_files:
324
325
                iovalues.append(IOFile(file, parameter.file_format, parameter.linkTrace_nameid, None))
            new_param = InputFileList( parameter.name, parameter.help, file_format=parameter.file_format, default=iovalues,
326
327
                                       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 )
328
            new_param.linkTrace_nameid = parameter.linkTrace_nameid            
329
        elif parameter.__class__ == InputFile:
330
            if value == "" : value = None # from GUI
Ibouniyamine Nabihoudine's avatar
Ibouniyamine Nabihoudine committed
331
            prepared_file = parameter.prepare(value)
332
            new_param = InputFile( parameter.name, parameter.help, file_format=parameter.file_format, default=prepared_file,
333
334
                                   type=parameter.type, choices=parameter.choices, required=parameter.required, flag=parameter.flag, 
                                   group=parameter.group, display_name=parameter.display_name )
335
            new_param.linkTrace_nameid = parameter.linkTrace_nameid
Jerome Mariette's avatar
Jerome Mariette committed
336
337
        elif parameter.__class__ == InputDirectory:
            if value == "" : value = None # from GUI
Ibouniyamine Nabihoudine's avatar
Ibouniyamine Nabihoudine committed
338
            prepared_directory = parameter.prepare(value)
339
            new_param = InputDirectory( parameter.name, parameter.help, default=prepared_directory, choices=parameter.choices, 
Jerome Mariette's avatar
Jerome Mariette committed
340
                                        required=parameter.required, flag=parameter.flag, group=parameter.group, 
341
                                        display_name=parameter.display_name, get_files_fn=parameter.get_files_fn)
Jerome Mariette's avatar
Jerome Mariette committed
342
            new_param.linkTrace_nameid = parameter.linkTrace_nameid
343
344
345
346
        else:
            raise Exception( "Unknown class '" +  parameter.__class__.__name__ + "' for parameter.")
        return new_param

347
348
349
    def _set_parameters(self, args):
        parameters = self.get_parameters()
        for param in parameters:
350
            new_param = None
351
            if param.__class__ == MultiParameter:
352
                new_param = MultiParameter(param.name, param.help, required=param.required, flag=param.flag, group=param.group, display_name=param.display_name)
353
                new_param.sub_parameters = param.sub_parameters
354
                if param.name in args:
355
356
357
358
359
360
                    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
361
            elif param.__class__ == MultiParameterList:
362
                new_param = MultiParameterList(param.name, param.help, required=param.required, flag=param.flag, group=param.group, display_name=param.display_name)
363
                new_param.sub_parameters = param.sub_parameters
364
                if param.name in args:
365
366
367
368
369
370
371
372
373
                    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)
                        sub_args = {}
                        for sarg in sargs:
                            sub_args[sarg[0]] = sarg[1]
                        for sub_param in param.sub_parameters:
                            new_sub_param = self._prepare_parameter(sub_args, sub_param, "flag")
                            new_multi_param[new_sub_param.name] = new_sub_param
                        new_param.append(new_multi_param)
374
            else:
375
                new_param = self._prepare_parameter(args, param)
376
            self.__setattr__(param.name, new_param)
Frédéric Escudié's avatar
Frédéric Escudié committed
377

Jerome Mariette's avatar
Jerome Mariette committed
378
    def get_execution_graph(self):
379
        gr = digraph()
380
381
        # build a all_nodes table to store all nodes
        all_nodes = {}
382
        for ioparameter in list(self.__dict__.values()):
383
384
            if issubclass(ioparameter.__class__, InputFile):
                gr.add_node(ioparameter.name)
Jerome Mariette's avatar
Jerome Mariette committed
385
                gr.add_node_attribute(ioparameter.name, self.INPUTFILE_GRAPH_LABEL)
386
                gr.add_node_attribute(ioparameter.name, ioparameter.display_name)
387
                all_nodes[ioparameter.name] = None
388
389
            elif issubclass(ioparameter.__class__, InputFileList):
                gr.add_node(ioparameter.name)
Jerome Mariette's avatar
Jerome Mariette committed
390
391
392
393
394
395
                gr.add_node_attribute(ioparameter.name, self.INPUTFILES_GRAPH_LABEL)
                gr.add_node_attribute(ioparameter.name, ioparameter.display_name)
                all_nodes[ioparameter.name] = None
            elif issubclass(ioparameter.__class__, InputDirectory):
                gr.add_node(ioparameter.name)
                gr.add_node_attribute(ioparameter.name, self.INPUTDIRECTORY_GRAPH_LABEL)
396
                gr.add_node_attribute(ioparameter.name, ioparameter.display_name)
397
                all_nodes[ioparameter.name] = None
Philippe Bardou's avatar
Philippe Bardou committed
398
            elif issubclass(ioparameter.__class__, MultiParameter):
Jerome Mariette's avatar
Jerome Mariette committed
399
400
401
402
403
404
405
406
407
408
                for subparam in ioparameter.sub_parameters:
                    gr.add_node(subparam.name)
                    all_nodes[subparam.name] = None
                    if issubclass(subparam.__class__, InputFile):
                        gr.add_node_attribute(subparam.name, self.INPUTFILE_GRAPH_LABEL)
                    elif issubclass(subparam.__class__, InputFileList):
                        gr.add_node_attribute(subparam.name, self.INPUTFILES_GRAPH_LABEL)
                    elif issubclass(subparam.__class__, InputDirectory):
                        gr.add_node_attribute(subparam.name, self.INPUTDIRECTORY_GRAPH_LABEL)
                    gr.add_node_attribute(subparam.name, subparam.display_name)
Philippe Bardou's avatar
Philippe Bardou committed
409
410
411
412
413
414
415
416
417
            elif issubclass(ioparameter.__class__, MultiParameterList):
                for subparam in ioparameter.sub_parameters:
                    gr.add_node(subparam.name)
                    all_nodes[subparam.name] = None                        
                    if issubclass(subparam.__class__, InputDirectory):
                        gr.add_node_attribute(subparam.name, self.INPUTDIRECTORY_GRAPH_LABEL)
                    else:
                        gr.add_node_attribute(subparam.name, self.INPUTFILES_GRAPH_LABEL)
                    gr.add_node_attribute(subparam.name, subparam.display_name)
418
        for cpt in self.components:
419
420
            gr.add_node(cpt.get_nameid())
            gr.add_node_attribute(cpt.get_nameid(), self.COMPONENT_GRAPH_LABEL)
421
            gr.add_node_attribute(cpt.get_nameid(), cpt.get_nameid())
422
            all_nodes[cpt.get_nameid()] = None
Jerome Mariette's avatar
Jerome Mariette committed
423
        for cpt in self.components:
424
            for ioparameter in list(cpt.__dict__.values()):
Jerome Mariette's avatar
Jerome Mariette committed
425
                if issubclass( ioparameter.__class__, InputFile ) or issubclass( ioparameter.__class__, InputFileList) or issubclass( ioparameter.__class__, InputDirectory):
Frédéric Escudié's avatar
Frédéric Escudié committed
426
427
                    for parent in ioparameter.parent_linkTrace_nameid:
                        try: gr.add_edge((parent, ioparameter.linkTrace_nameid))
Frédéric Escudié's avatar
Frédéric Escudié committed
428
                        except: pass
429
430
431
432
                elif issubclass( ioparameter.__class__, InputObject) or issubclass( ioparameter.__class__, InputObjectList):
                    for parent in ioparameter.parent_linkTrace_nameid:
                        try: gr.add_edge((parent, ioparameter.linkTrace_nameid))
                        except: pass
433
434
        # check if all nodes are connected
        for edge in gr.edges():
435
            if edge[0] in all_nodes:
436
                del all_nodes[edge[0]]
437
            if edge[1] in all_nodes:
438
439
                del all_nodes[edge[1]]
        # then remove all unconnected nodes: to delete inputs not defined by the user
440
        for orphan_node in list(all_nodes.keys()):
441
            gr.del_node(orphan_node)
442
        return gr
Frédéric Escudié's avatar
Frédéric Escudié committed
443

Jerome Mariette's avatar
Jerome Mariette committed
444
445
    def delete(self):
        if self.get_status() in [self.STATUS_COMPLETED, self.STATUS_FAILED, self.STATUS_ABORTED]:
Jerome Mariette's avatar
Jerome Mariette committed
446
            utils.robust_rmtree(self.directory)
Jerome Mariette's avatar
Jerome Mariette committed
447

448
    @staticmethod
449
    def config_parser(arg_lines):
450
451
        for arg in arg_lines:
            yield arg
452
453
454
455
            
    @staticmethod
    def get_status_under_text_format(workflow, detailed=False, display_errors=False, html=False):
        if workflow.start_time: start_time = time.asctime(time.localtime(workflow.start_time))
456
        else: start_time = "-"
457
458
        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)
459
        else: elapsed_time = "-"
Jerome Mariette's avatar
Jerome Mariette committed
460
        elapsed_time = "-" if elapsed_time == "-" else str(datetime.timedelta(seconds=int(str(elapsed_time).split(".")[0])))
461
        if workflow.end_time: end_time = time.asctime(time.localtime(workflow.end_time))
462
463
464
        else: end_time = "-"
        if detailed:
            # Global
465
466
            title = "Workflow #" + utils.get_nb_string(workflow.id) + " (" + workflow.name + ") is " + \
                    workflow.get_status() + ", time elapsed: " + str(elapsed_time) + " (from " + start_time + \
467
468
                    " to " + end_time + ")"
            worflow_errors = ""
469
            error = workflow.get_errors()
470
            if error is not None:
Jerome Mariette's avatar
Jerome Mariette committed
471
472
                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"
473
474
475
            # By components
            components_errors = ""
            status = "Components Status :\n"
476
            components_status = workflow.get_components_status()
477
            for i, component in enumerate(workflow.get_components_nameid()):
478
                status_info = components_status[component]
479
480
481
482
483
484
485
486
487
488
489
                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
490
491
492
                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"
493
                else: running = "running:" + str(status_info["running"])
Jerome Mariette's avatar
Jerome Mariette committed
494
495
496
                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"
497
                else: waiting = "waiting:" + str(status_info["waiting"])            
Jerome Mariette's avatar
Jerome Mariette committed
498
499
500
                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"
501
                else: failed = "failed:" + str(status_info["failed"])
Jerome Mariette's avatar
Jerome Mariette committed
502
503
504
                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"
505
                else: aborted = "aborted:" + str(status_info["aborted"])
Jerome Mariette's avatar
Jerome Mariette committed
506
507
508
                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"
509
510
511
                else: completed = "completed:" + str(status_info["completed"])
                
                if display_errors and len(status_info["failed_commands"]) > 0:
512
513
                    if components_errors == "":
                        components_errors = "Failed Commands :\n"
514
                    components_errors += "  - " + component + " :\n    " + "\n    ".join(status_info["failed_commands"]) + "\n"
515
516
517
                status += "  - " + component + ", time elapsed " + time_format(status_info["time"]) + \
                    " (total:" + str(status_info["tasks"]) + ", " + waiting + ", " + running + ", " + failed + \
                    ", " + aborted + ", " + completed + ")"
518
                if i<len(workflow.get_components_nameid())-1: status += "\n"
519
520
521
            # Format str
            pretty_str = title
            pretty_str += ("\n" + worflow_errors) if worflow_errors != "" else ""
522
523
            if len(workflow.get_components_nameid()) > 0:
                pretty_str += ("\n" + status) if status != "" else ""
524
                pretty_str += ("\n" + components_errors[:-1]) if components_errors != "" else ""
Jerome Mariette's avatar
Jerome Mariette committed
525
526
            if html: return pretty_str.replace("\n", "<br />")
            else: return pretty_str
527
        else:
528
529
            pretty_str = utils.get_nb_string(workflow.id) + "\t" + workflow.name + "\t"
            if workflow.get_status() == Workflow.STATUS_STARTED:
Jerome Mariette's avatar
Jerome Mariette committed
530
                pretty_str += "\033[94m"
531
            elif workflow.get_status() == Workflow.STATUS_COMPLETED:
Jerome Mariette's avatar
Jerome Mariette committed
532
                pretty_str += "\033[92m"
533
            elif workflow.get_status() == Workflow.STATUS_FAILED:
Jerome Mariette's avatar
Jerome Mariette committed
534
                pretty_str += "\033[91m"
535
            elif workflow.get_status() == Workflow.STATUS_ABORTED:
Jerome Mariette's avatar
Jerome Mariette committed
536
                pretty_str += "\033[91m"
537
            elif workflow.get_status() == Workflow.STATUS_RESETED:
Jerome Mariette's avatar
Jerome Mariette committed
538
                pretty_str += "\033[3m"
539
            pretty_str += workflow.get_status() + "\033[0m"
Jerome Mariette's avatar
Jerome Mariette committed
540
541
            pretty_str += "\t" + elapsed_time + "\t" + start_time + "\t" + end_time
            return pretty_str
542
    
543
    def get_errors(self):
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
        if os.path.isfile(self.stderr):
            error = {
                "title"     : "",
                "msg"       : list(),
                "traceback" : list()
            }
            line_idx = 0
            FH_stderr = open( self.stderr )
            lines = FH_stderr.readlines()
            while line_idx < len(lines):
                if lines[line_idx].strip().startswith("##"):
                    error["title"]     = lines[line_idx].rstrip()
                    error["msg"]       = list()
                    error["traceback"] = list()
                    # skip all lines before the traceback
                    while not lines[line_idx].startswith("Traceback"):
                        line_idx += 1
                    # skip : "Traceback (most recent call last):"
                    line_idx += 1    
                    while lines[line_idx] != lines[line_idx].lstrip():
                        error["traceback"].append({ 
                                                   "location" : lines[line_idx].strip(),
                                                   "line"     : lines[line_idx].strip()
                        })
                        line_idx += 2
                    # Error message
                    while line_idx < len(lines) and not lines[line_idx].strip().startswith("##"):
                        try:
                            error["msg"].append( lines[line_idx].strip().split(":", 1)[1][1:] )
                        except:
                            error["msg"].append( lines[line_idx].strip() )
                        line_idx += 1
                    line_idx -= 1
                line_idx += 1
            FH_stderr.close()
            last_stack_location = ""
            if len(error["traceback"]) > 0:
                last_stack_location = error["traceback"][-1]["location"].strip()
                self.status = self.STATUS_FAILED
                return { "msg" : error["msg"], "location" : last_stack_location }
            else:
                return None
Frédéric Escudié's avatar
Frédéric Escudié committed
586
587
        else:
            return None
588
                
589
    def get_outputs_per_components(self):
590
591
        outputs_files = {}
        for current_components in self.components:
Philippe Bardou's avatar
Philippe Bardou committed
592
            #status = self.get_component_status(current_components.get_nameid())
593
            outputs_files[current_components.get_nameid()] = current_components.get_output_files()
Philippe Bardou's avatar
Philippe Bardou committed
594
            #outputs_files["0"] = status["completed"]
595
596
        return outputs_files
    
Jerome Mariette's avatar
Jerome Mariette committed
597
598
    def __setstate__(self, state):
        self.__dict__ = state.copy()
599
        self.external_components = self._import_external_components()
Jerome Mariette's avatar
Jerome Mariette committed
600
601
602
603
604
605
606
        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()
607
        del odict['_started']
608
609
610
611
        if '_tstate_lock' in odict: # python 3.4
            del odict['_tstate_lock']
        else: # python 3.2
            del odict['_block']
612
613
        del odict['_stderr']
        if 'external_components' in odict:
614
            del odict['external_components']
Jerome Mariette's avatar
Jerome Mariette committed
615
616
        return odict
    
617
618
619
620
621
622
623
624
625
626
627
628
629
    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        
630
        smtps, smtpp, froma, fromp, toa, subject, message = self.jflow_config_reader.get_email_options()
631
632
633
634
635
        
        if self.__to_address: toa = self.__to_address
        if self.__subject: subject = self.__subject
        if self.__message: message = self.__message
        
636
        if smtps and smtpp and froma and fromp:
637
638
            if not toa: toa = froma
            if validate_email(froma) and validate_email(toa):
639
640
641
642
643
                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:
644
                        message = Workflow.get_status_under_text_format(self, True, True, True)
Jerome Mariette's avatar
Jerome Mariette committed
645
                    msg = MIMEText(message, 'html')
646
647
648
649
650
651
652
653
654
655
                    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()
Jerome Mariette's avatar
Jerome Mariette committed
656
657
658
659
660
                    # if the SMTP server does not provides TLS or identification
                    try:
                        s.starttls()
                        s.login(me, fromp)
                    except smtplib.SMTPHeloError:
661
                        self._log("The server didn't reply properly to the HELO greeting.", level="debug", traceback=traceback.format_exc(chain=False))
Jerome Mariette's avatar
Jerome Mariette committed
662
                    except smtplib.SMTPAuthenticationError:
663
                        self._log("The server didn't accept the username/password combination.", level="debug", traceback=traceback.format_exc(chain=False))
Jerome Mariette's avatar
Jerome Mariette committed
664
                    except smtplib.SMTPException:
665
                        self._log("No suitable authentication method was found, or the server does not support the STARTTLS extension.", level="debug", traceback=traceback.format_exc(chain=False))
Jerome Mariette's avatar
Jerome Mariette committed
666
                    except RuntimeError:
667
                        self._log("SSL/TLS support is not available to your Python interpreter.", level="debug", traceback=traceback.format_exc(chain=False))
Jerome Mariette's avatar
Jerome Mariette committed
668
                    except:
669
                        self._log("Unhandled error when sending mail.", level="debug", traceback=traceback.format_exc(chain=False))
Jerome Mariette's avatar
Jerome Mariette committed
670
671
672
                    finally:
                        s.sendmail(me, [you], msg.as_string())
                        s.close()
673
                except:
674
                    self._log("Impossible to connect to smtp server '" + smtps + "'", level="debug", traceback=traceback.format_exc(chain=False))
675
    
676
677
678
679
    def get_parameters_per_groups(self):
        name = self.get_name()
        description = self.get_description()
        parameters = self.get_parameters()
680
681
        pgparameters, parameters_order = {}, []
        for param in parameters:
Jerome Mariette's avatar
Jerome Mariette committed
682
            if param.group not in parameters_order: parameters_order.append(param.group)
683
            if param.group in pgparameters:
684
                pgparameters[param.group].append(param)
Jerome Mariette's avatar
Jerome Mariette committed
685
            else:
686
687
                pgparameters[param.group] = [param]
        return [pgparameters, parameters_order]
Jerome Mariette's avatar
Jerome Mariette committed
688
    
689
690
691
    def get_parameters(self):
        params = []
        for param in self.params_order:
692
            for attribute_value in list(self.__dict__.values()):
693
694
695
696
                if (issubclass(attribute_value.__class__, AbstractParameter)) and param == attribute_value.name:
                    params.append(attribute_value)
        return params
    
697
    def get_exec_path(self, software):
698
699
700
701
702
        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)
703
        elif exec_path is None and utils.which(software) == None:
704
            raise Exception("'" + software + "' path connot be retrieved either in the PATH and in the application.properties file!")
705
706
707
        elif exec_path is None and utils.which(software) != None: 
            exec_path = software
        elif exec_path != None and not os.path.isfile(exec_path):
708
            raise Exception("'" + exec_path + "' set for '" + software + "' does not exists, please provide a valid path!")
709
        return exec_path
710
    
Jerome Mariette's avatar
Jerome Mariette committed
711
712
    def add_component(self, component_name, args=[], kwargs={}, component_prefix="default"):
        # first build and check if this component is OK
713
        if component_name in self.internal_components or component_name in self.external_components:
714
            
715
            if component_name in self.internal_components:
Jerome Mariette's avatar
Jerome Mariette committed
716
                my_pckge = __import__(self.internal_components[component_name], globals(), locals(), [component_name])
717
718
719
720
721
722
723
724
725
726
727
728
729
                # 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)
            # external components
            else :
                cmpt_object = self.external_components[component_name]()
                cmpt_object.output_directory = self.get_component_output_directory(component_name, component_prefix)
                cmpt_object.prefix = component_prefix
                # can't use positional arguments with external components
                cmpt_object.define_parameters(**kwargs)
730
731
            
            # there is a dynamic component
732
            if cmpt_object.is_dynamic():
733
734
735
736
                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
737
                    self.components_to_exec.append(cmpt_object)
738
                    self.components.append(cmpt_object)
739
740
741
742
743
744
745
746
747
                    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
748
                    self.components_to_exec = []
749
                    self.components = []
750
751
752
            else:
                if self.component_nameids_is_init:
                    # add the component
753
                    self.components_to_exec.append(cmpt_object)
754
                    self.components.append(cmpt_object)
755
                elif not self.component_nameids_is_init and not self.dynamic_component_present:
Jerome Mariette's avatar
Jerome Mariette committed
756
757
758
                    if self._component_is_duplicated(cmpt_object):
                        raise ValueError("Component " + cmpt_object.__class__.__name__ + " with prefix " + 
                                            cmpt_object.prefix + " already exist in this pipeline!")
759
                    self.components_to_exec.append(cmpt_object)
760
                    self.components.append(cmpt_object)
761
762
763
764
765
766
                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

767
768
            return cmpt_object
        else:
769
            raise ImportError(component_name + " component cannot be loaded, available components are: {0}".format(
770
                                           ", ".join(list(self.internal_components.keys()) + list(self.external_components.keys()))))
Jerome Mariette's avatar
Jerome Mariette committed
771
772
773
774
775
776
777
778
    
    def pre_process(self):
        pass
    
    def process(self):
        """ 
        Run the workflow, has to be implemented by subclasses
        """
779
        raise NotImplementedError( "Workflow.process() must be implemented in " + self.__class__.__name__ )
780
781
782

    def get_name(self):
        """ 
783
        Return the workflow name.
784
        """
Jerome Mariette's avatar
Jerome Mariette committed
785
        return self.__class__.__name__.lower()
786
787
788
789
790
    
    def get_description(self):
        """ 
        Return the workflow description, has to be implemented by subclasses
        """
791
        raise NotImplementedError( "Workflow.get_description() must be implemented in " + self.__class__.__name__ )
792
    
793
    def define_parameters(self, function="process"):
794
795
796
        """ 
        Define the workflow parameters, has to be implemented by subclasses
        """
797
        raise NotImplementedError( "Workflow.define_parameters() must be implemented in " + self.__class__.__name__ )
Jerome Mariette's avatar
Jerome Mariette committed
798
799
800
801
802
803
804
805
806
807
808
809
    
    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):
810
        return list(self.component_nameids.keys())
Jerome Mariette's avatar
Jerome Mariette committed
811
    
Jerome Mariette's avatar
Jerome Mariette committed
812
813
    def wf_execution_wrapper(self):
        getattr(self, self.function)()
Jerome Mariette's avatar
Jerome Mariette committed
814
    
Jerome Mariette's avatar
Jerome Mariette committed
815
816
817
818
    def run(self):
        """
        Only require for Threading
        """
819
820
        try:
            # if this is the first time the workflow run
Jerome Mariette's avatar
Jerome Mariette committed
821
            if self.__step == None :
822
                self.start_time = time.time()
Jerome Mariette's avatar
Jerome Mariette committed
823
                self.__step = 0
824
                self.status = self.STATUS_STARTED
825
                self.postprocess_status = self.STATUS_PENDING
826
                self.end_time = None
Jerome Mariette's avatar
Jerome Mariette committed
827
828
                # if some args are provided, let's fill the parameters
                self._set_parameters(self.args)
829
                self._serialize()
830
            # if pre_processing has not been done yet
Jerome Mariette's avatar
Jerome Mariette committed
831
            if self.__step == 0:
832
                self.pre_process()
Jerome Mariette's avatar
Jerome Mariette committed
833
                self.__step = 1
834
835
                self._serialize()
            # if collecting components and running workflow has not been done yet
Jerome Mariette's avatar
Jerome Mariette committed
836
            if self.__step == 1:
837
838
                try:
                    self.reseted_components = []
839
                    self.components = []
Jerome Mariette's avatar
Jerome Mariette committed
840
                    self.status = self.STATUS_STARTED
841
                    self.postprocess_status = self.STATUS_PENDING
842
                    self.wf_execution_wrapper()
843
                except SystemExit: 
844
845
846
                    self.status = self.STATUS_FAILED
                    self.end_time = time.time()
                    self._serialize()
847
                    self._send_email()
848
849
850
                    raise
                self.component_nameids_is_init = True
                if self.dynamic_component_present:
Jerome Mariette's avatar
Jerome Mariette committed
851
                    self.__step = 2
852
853
                else:
                    self._execute_weaver()
Jerome Mariette's avatar
Jerome Mariette committed
854
                    self.__step = 3
855
856
                self._serialize() 
            # if the workflow was a dynamic one
Jerome Mariette's avatar
Jerome Mariette committed
857
            if self.__step == 2:
858
859
                try:
                    self.reseted_components = []
860
                    self.components = []
Jerome Mariette's avatar
Jerome Mariette committed
861
                    self.status = self.STATUS_STARTED
862
                    self.postprocess_status = self.STATUS_PENDING
863
                    self.wf_execution_wrapper()
864
                except SystemExit: 
865
866
867
                    self.status = self.STATUS_FAILED
                    self.end_time = time.time()
                    self._serialize()
868
                    self._send_email()
869
870
871
                    raise
                if len(self.components_to_exec) > 0:
                    self._execute_weaver()
Jerome Mariette's avatar
Jerome Mariette committed
872
                self.__step = 3
873
874
                self._serialize()
            # if post processing has ne been done yet
Jerome Mariette's avatar
Jerome Mariette committed
875
            if self.__step == 3: