workflow.py 59.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
Ibouniyamine Nabihoudine's avatar
Ibouniyamine Nabihoudine committed
41
42
from jflow.workflows_manager import WorkflowsManager 
from jflow.config_reader import JFlowConfigReader
43
from jflow.utils import get_octet_string_representation, get_nb_octet
44
from jflow.parameter import *
45
from cctools.util import time_format
Jerome Mariette's avatar
Jerome Mariette committed
46
47
48
49
50
51
52
53
54
55
56
57

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
58

59
60
61
62
63
64
65
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
66
        self._status = status
67
68
69
70
71
72
73
74
75
76
        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

77
78
79
    def get_components_status(self):
        return self.compts_status
    
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):
87
        return self._status
88

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

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

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

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

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

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

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

449
    @staticmethod
450
    def config_parser(arg_lines):
451
452
        for arg in arg_lines:
            yield arg
453
454
455
456
            
    @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))
457
        else: start_time = "-"
458
459
        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)
460
        else: elapsed_time = "-"
Jerome Mariette's avatar
Jerome Mariette committed
461
        elapsed_time = "-" if elapsed_time == "-" else str(datetime.timedelta(seconds=int(str(elapsed_time).split(".")[0])))
462
        if workflow.end_time: end_time = time.asctime(time.localtime(workflow.end_time))
463
464
465
        else: end_time = "-"
        if detailed:
            # Global
466
467
            title = "Workflow #" + utils.get_nb_string(workflow.id) + " (" + workflow.name + ") is " + \
                    workflow.get_status() + ", time elapsed: " + str(elapsed_time) + " (from " + start_time + \
468
469
                    " to " + end_time + ")"
            worflow_errors = ""
470
            error = workflow.get_errors()
471
            if error is not None:
Jerome Mariette's avatar
Jerome Mariette committed
472
473
                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"
474
475
476
            # By components
            components_errors = ""
            status = "Components Status :\n"
477
            components_status = workflow.get_components_status()
478
            for i, component in enumerate(workflow.get_components_nameid()):
479
                status_info = components_status[component]
480
481
482
483
484
485
486
487
488
489
490
                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
491
492
493
                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"
494
                else: running = "running:" + str(status_info["running"])
Jerome Mariette's avatar
Jerome Mariette committed
495
496
497
                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"
498
                else: waiting = "waiting:" + str(status_info["waiting"])            
Jerome Mariette's avatar
Jerome Mariette committed
499
500
501
                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"
502
                else: failed = "failed:" + str(status_info["failed"])
Jerome Mariette's avatar
Jerome Mariette committed
503
504
505
                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"
506
                else: aborted = "aborted:" + str(status_info["aborted"])
Jerome Mariette's avatar
Jerome Mariette committed
507
508
509
                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"
510
511
512
                else: completed = "completed:" + str(status_info["completed"])
                
                if display_errors and len(status_info["failed_commands"]) > 0:
513
514
                    if components_errors == "":
                        components_errors = "Failed Commands :\n"
515
                    components_errors += "  - " + component + " :\n    " + "\n    ".join(status_info["failed_commands"]) + "\n"
516
517
518
                status += "  - " + component + ", time elapsed " + time_format(status_info["time"]) + \
                    " (total:" + str(status_info["tasks"]) + ", " + waiting + ", " + running + ", " + failed + \
                    ", " + aborted + ", " + completed + ")"
519
                if i<len(workflow.get_components_nameid())-1: status += "\n"
520
521
522
            # Format str
            pretty_str = title
            pretty_str += ("\n" + worflow_errors) if worflow_errors != "" else ""
523
524
            if len(workflow.get_components_nameid()) > 0:
                pretty_str += ("\n" + status) if status != "" else ""
525
                pretty_str += ("\n" + components_errors[:-1]) if components_errors != "" else ""
Jerome Mariette's avatar
Jerome Mariette committed
526
527
            if html: return pretty_str.replace("\n", "<br />")
            else: return pretty_str
528
        else:
529
530
            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
531
                pretty_str += "\033[94m"
532
            elif workflow.get_status() == Workflow.STATUS_COMPLETED:
Jerome Mariette's avatar
Jerome Mariette committed
533
                pretty_str += "\033[92m"
534
            elif workflow.get_status() == Workflow.STATUS_FAILED:
Jerome Mariette's avatar
Jerome Mariette committed
535
                pretty_str += "\033[91m"
536
            elif workflow.get_status() == Workflow.STATUS_ABORTED:
Jerome Mariette's avatar
Jerome Mariette committed
537
                pretty_str += "\033[91m"
538
            elif workflow.get_status() == Workflow.STATUS_RESETED:
Jerome Mariette's avatar
Jerome Mariette committed
539
                pretty_str += "\033[3m"
540
            pretty_str += workflow.get_status() + "\033[0m"
Jerome Mariette's avatar
Jerome Mariette committed
541
542
            pretty_str += "\t" + elapsed_time + "\t" + start_time + "\t" + end_time
            return pretty_str
543
    
544
    def get_errors(self):
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()
                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
    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
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658

    def _get_cleaned_email_placeholders(self, text):
        """
        @summary: Returns the text after replacement of placeholders by the corresponding workflow values (method or attribute).
                  Placeholders must be an attribute or a method of the workflow between three dollars: ###attribute### or ###method()###.
                  You can add "|date" after the attribute or the method to convert a timestamp in human readable date.
                  Examples: ###id### is replaced by wf.id ; ###get_status()### is replaced by wf.get_status() ; ###start_time|date### is rplaced by wf.start_time in date format.
        @param text: [str] The text containing placeholders.
        @return: [str] The text with placeholders replaced by her real value.
        """
        new_text = text
        placeholders = re.findall("\#\#\#([^\#]+)\#\#\#", text)
        for placeholder in placeholders:
            try:
                placeholder_value = ""
                placeholder_key = placeholder
                is_date = False
                if placeholder.endswith("|date"):
                    placeholder_key = placeholder[:-5]
                    is_date = True
                # Get value
                if placeholder_key.endswith("()"):
                    placeholder_value = str(getattr(self, placeholder_key[:-2])())
                else:
                    placeholder_value = str(getattr(self, placeholder_key))
                # Apply date format
                if is_date:
                    jflow_date_format = self.jflow_config_reader.get_date_format()
                    placeholder_value = time.strftime(jflow_date_format + " %H:%M:%S", time.gmtime(float(placeholder_value)))
                new_text = new_text.replace("###" + placeholder + "###", placeholder_value)
            except:
                pass
        return new_text

659
660
    def _send_email(self):
        import smtplib
661
        from email.mime.text import MIMEText
662
        smtps, smtpp, froma, fromp, toa, subject, message = self.jflow_config_reader.get_email_options()
663
664
665
666
667
        
        if self.__to_address: toa = self.__to_address
        if self.__subject: subject = self.__subject
        if self.__message: message = self.__message
        
668
        if smtps and smtpp and froma and fromp:
669
670
            if not toa: toa = froma
            if validate_email(froma) and validate_email(toa):
671
672
673
674
675
                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:
676
                        message = Workflow.get_status_under_text_format(self, True, True, True)
677
                    message = self._get_cleaned_email_placeholders( message )
Jerome Mariette's avatar
Jerome Mariette committed
678
                    msg = MIMEText(message, 'html')
679
680
                    me = froma
                    you = toa
681
682
683
                    if not subject:
                        subject = "JFlow - Workflow #" + str(self.id) + " is " + self.get_status()
                    subject = self._get_cleaned_email_placeholders( subject )
684
685
686
687
688
689
690
                    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
691
692
693
694
695
                    # if the SMTP server does not provides TLS or identification
                    try:
                        s.starttls()
                        s.login(me, fromp)
                    except smtplib.SMTPHeloError:
696
                        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
697
                    except smtplib.SMTPAuthenticationError:
698
                        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
699
                    except smtplib.SMTPException:
700
                        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
701
                    except RuntimeError:
702
                        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
703
                    except:
704
                        self._log("Unhandled error when sending mail.", level="debug", traceback=traceback.format_exc(chain=False))
Jerome Mariette's avatar
Jerome Mariette committed
705
706
707
                    finally:
                        s.sendmail(me, [you], msg.as_string())
                        s.close()
708
                except:
709
                    self._log("Impossible to connect to smtp server '" + smtps + "'", level="debug", traceback=traceback.format_exc(chain=False))
710
    
711
712
713
714
    def get_parameters_per_groups(self):
        name = self.get_name()
        description = self.get_description()
        parameters = self.get_parameters()
715
716
        pgparameters, parameters_order = {}, []
        for param in parameters:
Jerome Mariette's avatar
Jerome Mariette committed
717
            if param.group not in parameters_order: parameters_order.append(param.group)
718
            if param.group in pgparameters:
719
                pgparameters[param.group].append(param)
Jerome Mariette's avatar
Jerome Mariette committed
720
            else:
721
722
                pgparameters[param.group] = [param]
        return [pgparameters, parameters_order]
Jerome Mariette's avatar
Jerome Mariette committed
723
    
724
725
726
    def get_parameters(self):
        params = []
        for param in self.params_order:
727
            for attribute_value in list(self.__dict__.values()):
728
729
730
731
                if (issubclass(attribute_value.__class__, AbstractParameter)) and param == attribute_value.name:
                    params.append(attribute_value)
        return params
    
732
    def get_exec_path(self, software):
733
734
735
736
737
        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)
738
        elif exec_path is None and utils.which(software) == None:
739
            raise Exception("'" + software + "' path connot be retrieved either in the PATH and in the application.properties file!")
740
741
742
        elif exec_path is None and utils.which(software) != None: 
            exec_path = software
        elif exec_path != None and not os.path.isfile(exec_path):
743
            raise Exception("'" + exec_path + "' set for '" + software + "' does not exists, please provide a valid path!")
744
        return exec_path
745
    
Jerome Mariette's avatar
Jerome Mariette committed
746
747
    def add_component(self, component_name, args=[], kwargs={}, component_prefix="default"):
        # first build and check if this component is OK
748
        if component_name in self.internal_components or component_name in self.external_components:
749
            
750
            if component_name in self.internal_components:
Jerome Mariette's avatar
Jerome Mariette committed
751
                my_pckge = __import__(self.internal_components[component_name], globals(), locals(), [component_name])
752
753
754
755
756
757
758
759
760
761
762
763
764
                # 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)
765
766
            
            # there is a dynamic component
767
            if cmpt_object.is_dynamic():
768
769
770
771
                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
772
                    self.components_to_exec.append(cmpt_object)
773
                    self.components.append(cmpt_object)
774
775
776
777
778
779
780
781
782
                    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
783
                    self.components_to_exec = []
784
                    self.components = []
785
786
787
            else:
                if self.component_nameids_is_init:
                    # add the component
788
                    self.components_to_exec.append(cmpt_object)
789
                    self.components.append(cmpt_object)
790
                elif not self.component_nameids_is_init and not self.dynamic_component_present:
Jerome Mariette's avatar
Jerome Mariette committed
791
792
793
                    if self._component_is_duplicated(cmpt_object):
                        raise ValueError("Component " + cmpt_object.__class__.__name__ + " with prefix " + 
                                            cmpt_object.prefix + " already exist in this pipeline!")
794
                    self.components_to_exec.append(cmpt_object)
795
                    self.components.append(cmpt_object)
796
797
798
799
800
801
                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

802
803
            return cmpt_object
        else:
804
            raise ImportError(component_name + " component cannot be loaded, available components are: {0}".format(
805
                                           ", ".join(list(self.internal_components.keys()) + list(self.external_components.keys()))))
Jerome Mariette's avatar
Jerome Mariette committed
806
807
808
809
810
811
812
813
    
    def pre_process(self):
        pass
    
    def process(self):
        """ 
        Run the workflow, has to be implemented by subclasses
        """
814
        raise NotImplementedError( "Workflow.process() must be implemented in " + self.__class__.__name__ )
815
816
817

    def get_name(self):
        """ 
818
        Return the workflow name.
819
        """
Jerome Mariette's avatar
Jerome Mariette committed
820
        return self.__class__.__name__.lower()
821
822
823
824
825
    
    def get_description(self):
        """ 
        Return the workflow description, has to be implemented by subclasses
        """
826
        raise NotImplementedError( "Workflow.get_description() must be implemented in " + self.__class__.__name__ )
827
    
828
    def define_parameters(self, function="process"):
829
830
831
        """ 
        Define the workflow parameters, has to be implemented by subclasses
        """
832
        raise NotImplementedError( "Workflow.define_parameters() must be implemented in " + self.__class__.__name__ )
Jerome Mariette's avatar
Jerome Mariette committed
833
834
835
836
837
838
839
840
841
842
843
844
    
    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):
845
        return list(self.component_nameids.keys())
Jerome Mariette's avatar
Jerome Mariette committed
846
    
Jerome Mariette's avatar
Jerome Mariette committed
847
848
    def wf_execution_wrapper(self):
        getattr(self, self.function)()
Jerome Mariette's avatar
Jerome Mariette committed
849
    
Jerome Mariette's avatar
Jerome Mariette committed
850
851
852
853
    def run(self):
        """
        Only require for Threading
        """
854
855
        try:
            # if this is the first time the workflow run
856
            if self.__step == None:
857
                self.start_time = time.time()
Jerome Mariette's avatar
Jerome Mariette committed
858
                self.__step = 0
859
860
                self._status = self.STATUS_STARTED
                self._postprocess_status = self.STATUS_PENDING
861
                self.end_time = None
Jerome Mariette's avatar
Jerome Mariette committed
862
863
                # if some args are provided, let's fill the parameters
                self._set_parameters(self.args)
864
                self._serialize()
865
            # if pre_processing has not been done yet
Jerome Mariette's avatar
Jerome Mariette committed
866
            if self.__step == 0:
867
868
869
                self.pre_process()
                self.__step = 1
                self._serialize()
870
            # if collecting components and running workflow has not been done yet
Jerome Mariette's avatar
Jerome Mariette committed
871
            if self.__step == 1:
872
873
874
875
876
877
878
879
880
881
882
883
884
                self.reseted_components = []
                self.components = []
                self._status = self.STATUS_STARTED
                self._postprocess_status = self.STATUS_PENDING
                self._serialize()
                self.wf_execution_wrapper()
                self.component_nameids_is_init = True
                if self.dynamic_component_present:
                    self.__step = 2
                else:
                    self._execute_weaver()
                    self.__step = 3
                self._serialize()
885
            # if the workflow was a dynamic one
Jerome Mariette's avatar
Jerome Mariette committed
886
            if self.__step == 2:
887
888
889
890
891
892
893
894
895
896
                self.reseted_components = []
                self.components = []
                self._status = self.STATUS_STARTED
                self._postprocess_status = self.STATUS_PENDING
                self._serialize()
                self.wf_execution_wrapper()
                if len(self.components_to_exec) > 0:
                    self._execute_weaver()
                self.__step = 3
                self._serialize()
897
            # if post processing has ne been done yet
Jerome Mariette's avatar
Jerome Mariette committed
898
            if self.__step == 3:
899
                try:
900
                    self._postprocess_status = self.STATUS_STARTED
901
                    self.post_process()
902
903
                    self._postprocess_status = self.STATUS_COMPLETED
                    self._status = self.STATUS_COMPLETED
Frédéric Escudié's avatar