workflow.py 53.7 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 logging
Jerome Mariette's avatar
Jerome Mariette committed
30
import datetime
Jerome Mariette's avatar
Jerome Mariette committed
31

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

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

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

Jerome Mariette's avatar
Jerome Mariette committed
56

57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
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

    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
83

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

Jerome Mariette's avatar
Jerome Mariette committed
139
        self.id = id
140
141
142
143
144
        self.name = self.get_name()
        self.description = self.get_description()
        
        # define the parameters 
        self.params_order = []
145
        self.define_parameters(self.function)
146
        # add the metadata parameter
147
        self.metadata = []
Jerome Mariette's avatar
Jerome Mariette committed
148
        
Jerome Mariette's avatar
Jerome Mariette committed
149
150
151
152
        if self.id is not None:
            self.directory = self.manager.get_workflow_directory(self.name, self.id)
            if not os.path.isdir(self.directory):
                os.makedirs(self.directory, 0751)
Frédéric Escudié's avatar
Frédéric Escudié committed
153
            if self.stderr is None:
154
                self.stderr = self._set_stderr()
Jerome Mariette's avatar
Jerome Mariette committed
155
            self._serialize()
Jerome Mariette's avatar
Jerome Mariette committed
156
            
157
158
159
        self.internal_components = self._import_internal_components()
        self.external_components = self._import_external_components()
        
160
    
Jerome Mariette's avatar
Jerome Mariette committed
161
    def add_input_directory(self, name, help, default=None, required=False, flag=None, 
162
163
164
                            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
165
166
167
168
169
170
171
172
173
174
175
        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)
    
176
    def add_input_file(self, name, help, file_format="any", default=None, type="inputfile", 
177
178
179
180
                       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"
181
        new_param = InputFile(name, help, flag=flag, file_format=file_format, default=default, 
182
                              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
183
        new_param.linkTrace_nameid = name
184
185
186
187
188
189
        # 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
190
        else:
191
192
193
194
            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", 
195
196
                            required=False, flag=None, group="default", display_name=None, size_limit="0", add_to=None):
        # check if the size provided is correct
197
        if default == None: default = []
198
199
        try: int(get_nb_octet(size_limit))
        except: size_limit="0"
200
201
202
203
204
205
206
        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, 
207
                                  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
208
        new_param.linkTrace_nameid = name
209
210
211
        # if this input should be added to a particular parameter
        if add_to:
            try:
Jerome Mariette's avatar
help ok    
Jerome Mariette committed
212
                self.__getattribute__(add_to).add_sub_parameter(new_param)
213
214
215
216
217
            except: pass
        # otherwise, add it to the class itself
        else:
            self.params_order.append(name)
            self.__setattr__(name, new_param)
218
219
            
    def add_multiple_parameter(self, name, help, required=False, flag=None, group="default", display_name=None):
220
        self.params_order.append(name)
221
222
223
224
225
226
        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)
227
228
        self.__setattr__(name, new_param)
    
229
230
    def add_parameter(self, name, help, default=None, type=types.StringType, choices=None, 
                      required=False, flag=None, group="default", display_name=None, add_to=None):
231
        new_param = ParameterFactory.factory(name, help, flag=flag, default=default, type=type, choices=choices, 
232
233
234
235
236
237
238
                              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
239
        else:
240
241
242
243
244
245
246
            self.params_order.append(name)
            self.__setattr__(name, new_param)
    
    def add_parameter_list(self, name, help, default=None, type=types.StringType, choices=None, 
                           required=False, flag=None, group="default", display_name=None, add_to=None):
        if default == None: default = []
        new_param = ParameterList(name, help, flag=flag, default=default, type=type, choices=choices, 
247
248
249
250
                                  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
251
                self.__getattribute__(add_to).add_sub_parameter(new_param)
252
253
254
255
256
257
            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
258
    def add_exclusion_rule(self, *args2exclude):
Jerome Mariette's avatar
Jerome Mariette committed
259
        # first of all, does this parameter exist
Jerome Mariette's avatar
Jerome Mariette committed
260
261
262
263
264
265
266
267
268
269
270
271
        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:
Jerome Mariette's avatar
Jerome Mariette committed
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
            logging.getLogger("wf." + str(self.__class__.__name__)).exception("Exclusion rule cannot be applied within a MultiParameter or a MultiParameterList")
            raise
        # 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
289

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

338
339
340
    def _set_parameters(self, args):
        parameters = self.get_parameters()
        for param in parameters:
341
            new_param = None
342
            if param.__class__ == MultiParameter:
343
                new_param = MultiParameter(param.name, param.help, required=param.required, flag=param.flag, group=param.group, display_name=param.display_name)
344
                new_param.sub_parameters = param.sub_parameters
Jerome Mariette's avatar
Jerome Mariette committed
345
                if args.has_key(param.name):
346
347
348
349
350
351
                    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
352
            elif param.__class__ == MultiParameterList:
353
                new_param = MultiParameterList(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
356
357
358
359
360
361
362
363
364
                if args.has_key(param.name):
                    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)
365
            else:
366
                new_param = self._prepare_parameter(args, param)
367
            self.__setattr__(param.name, new_param)
Frédéric Escudié's avatar
Frédéric Escudié committed
368

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

Jerome Mariette's avatar
Jerome Mariette committed
431
432
    def delete(self):
        if self.get_status() in [self.STATUS_COMPLETED, self.STATUS_FAILED, self.STATUS_ABORTED]:
433
434
            # first close the open files
            self.stderrfh.close()
Jerome Mariette's avatar
Jerome Mariette committed
435
            utils.robust_rmtree(self.directory)
Jerome Mariette's avatar
Jerome Mariette committed
436

437
    @staticmethod
438
    def config_parser(arg_lines):
439
440
        for arg in arg_lines:
            yield arg
441
442
443
444
            
    @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))
445
        else: start_time = "-"
446
447
        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)
448
        else: elapsed_time = "-"
Jerome Mariette's avatar
Jerome Mariette committed
449
        elapsed_time = "-" if elapsed_time == "-" else str(datetime.timedelta(seconds=int(str(elapsed_time).split(".")[0])))
450
        if workflow.end_time: end_time = time.asctime(time.localtime(workflow.end_time))
451
452
453
        else: end_time = "-"
        if detailed:
            # Global
454
455
            title = "Workflow #" + utils.get_nb_string(workflow.id) + " (" + workflow.name + ") is " + \
                    workflow.get_status() + ", time elapsed: " + str(elapsed_time) + " (from " + start_time + \
456
457
                    " to " + end_time + ")"
            worflow_errors = ""
458
            error = workflow.get_errors()
459
            if error is not None:
Jerome Mariette's avatar
Jerome Mariette committed
460
461
                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"
462
463
464
            # By components
            components_errors = ""
            status = "Components Status :\n"
465
466
            for i, component in enumerate(workflow.get_components_nameid()):
                status_info = workflow.get_component_status(component)
467
468
469
470
471
472
473
474
475
476
477
                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
478
479
480
                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"
481
                else: running = "running:" + str(status_info["running"])
Jerome Mariette's avatar
Jerome Mariette committed
482
483
484
                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"
485
                else: waiting = "waiting:" + str(status_info["waiting"])            
Jerome Mariette's avatar
Jerome Mariette committed
486
487
488
                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"
489
                else: failed = "failed:" + str(status_info["failed"])
Jerome Mariette's avatar
Jerome Mariette committed
490
491
492
                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"
493
                else: aborted = "aborted:" + str(status_info["aborted"])
Jerome Mariette's avatar
Jerome Mariette committed
494
495
496
                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"
497
498
499
500
501
502
503
504
505
                else: completed = "completed:" + str(status_info["completed"])
                
                if display_errors and len(status_info["failed_commands"]) > 0:
                    if components_errors == "" :
                        components_errors = "Failed Commands :\n"  
                    components_errors += "  - " + component + " :\n    " + "\n    ".join(status_info["failed_commands"])
                status += "  - " + component + ", time elapsed " + time_format(status_info["time"]) + \
                    " (total:" + str(status_info["tasks"]) + ", " + waiting + ", " + running + ", " + failed + \
                    ", " + aborted + ", " + completed + ")"
506
                if i<len(workflow.get_components_nameid())-1: status += "\n"
507
508
509
510
511
            # Format str
            pretty_str = title
            pretty_str += ("\n" + worflow_errors) if worflow_errors != "" else ""
            pretty_str += ("\n" + status) if status != "" else ""
            pretty_str += ("\n" + components_errors) if components_errors != "" else ""
Jerome Mariette's avatar
Jerome Mariette committed
512
513
            if html: return pretty_str.replace("\n", "<br />")
            else: return pretty_str
514
        else:
515
516
            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
517
                pretty_str += "\033[94m"
518
            elif workflow.get_status() == Workflow.STATUS_COMPLETED:
Jerome Mariette's avatar
Jerome Mariette committed
519
                pretty_str += "\033[92m"
520
            elif workflow.get_status() == Workflow.STATUS_FAILED:
Jerome Mariette's avatar
Jerome Mariette committed
521
                pretty_str += "\033[91m"
522
            elif workflow.get_status() == Workflow.STATUS_ABORTED:
Jerome Mariette's avatar
Jerome Mariette committed
523
                pretty_str += "\033[91m"
524
            elif workflow.get_status() == Workflow.STATUS_RESETED:
Jerome Mariette's avatar
Jerome Mariette committed
525
                pretty_str += "\033[3m"
526
            pretty_str += workflow.get_status() + "\033[0m"
Jerome Mariette's avatar
Jerome Mariette committed
527
528
            pretty_str += "\t" + elapsed_time + "\t" + start_time + "\t" + end_time
            return pretty_str
529
    
530
    def get_errors(self):
Frédéric Escudié's avatar
Frédéric Escudié committed
531
532
533
534
535
536
        error = {
                 "title"     : "",
                 "msg"       : list(),
                 "traceback" : list()
        }
        line_idx = 0
537
538
539
        FH_stderr = open( self.stderr )
        lines = FH_stderr.readlines()
        while line_idx < len(lines):
540
            if lines[line_idx].strip().startswith("##"):
Frédéric Escudié's avatar
Frédéric Escudié committed
541
542
543
                error["title"]     = lines[line_idx].rstrip()
                error["msg"]       = list()
                error["traceback"] = list()
544
545
546
547
548
                # 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    
549
                while lines[line_idx] != lines[line_idx].lstrip():
Frédéric Escudié's avatar
Frédéric Escudié committed
550
551
552
553
                    error["traceback"].append({ 
                                               "location" : lines[line_idx].strip(),
                                               "line"     : lines[line_idx].strip()
                    })
554
                    line_idx += 2
Frédéric Escudié's avatar
Frédéric Escudié committed
555
                # Error message
556
                while line_idx < len(lines) and not lines[line_idx].strip().startswith("##"):
557
558
559
560
                    try:
                        error["msg"].append( lines[line_idx].strip().split(":", 1)[1][1:] )
                    except:
                        error["msg"].append( lines[line_idx].strip() )
Frédéric Escudié's avatar
Frédéric Escudié committed
561
562
                    line_idx += 1
                line_idx -= 1
563
564
            line_idx += 1
        FH_stderr.close()
Frédéric Escudié's avatar
Frédéric Escudié committed
565
566
567
        last_stack_location = ""
        if len(error["traceback"]) > 0:
            last_stack_location = error["traceback"][-1]["location"].strip()
568
            self.status = self.STATUS_FAILED
Frédéric Escudié's avatar
Frédéric Escudié committed
569
570
571
            return { "msg" : error["msg"], "location" : last_stack_location }
        else:
            return None
572
    
573
    def get_outputs_per_components(self):
574
575
        outputs_files = {}
        for current_components in self.components:
Philippe Bardou's avatar
Philippe Bardou committed
576
            #status = self.get_component_status(current_components.get_nameid())
577
            outputs_files[current_components.get_nameid()] = current_components.get_output_files()
Philippe Bardou's avatar
Philippe Bardou committed
578
            #outputs_files["0"] = status["completed"]
579
580
        return outputs_files
    
Jerome Mariette's avatar
Jerome Mariette committed
581
582
    def __setstate__(self, state):
        self.__dict__ = state.copy()
583
        self.external_components = self._import_external_components()
584
        self.stderr = self._set_stderr(True)
Jerome Mariette's avatar
Jerome Mariette committed
585
586
587
588
589
590
591
592
593
594
        threading.Thread.__init__(self, name=self.name)
        
    def __getstate__(self):
        """
        Threading uses Lock Object, do not consider these objects when serializing a workflow
        """
        odict = self.__dict__.copy()
        del odict['_Thread__started']
        del odict['_Thread__block']
        del odict['_Thread__stderr']
595
596
        if odict.has_key('external_components') :
            del odict['external_components']
597
598
        if odict.has_key('stderrfh') :
            del odict['stderrfh']
Jerome Mariette's avatar
Jerome Mariette committed
599
600
        return odict
    
601
602
603
604
605
606
607
608
609
610
611
612
613
    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        
614
        smtps, smtpp, froma, fromp, toa, subject, message = self.jflow_config_reader.get_email_options()
615
616
617
618
619
        
        if self.__to_address: toa = self.__to_address
        if self.__subject: subject = self.__subject
        if self.__message: message = self.__message
        
620
        if smtps and smtpp and froma and fromp:
621
622
            if not toa: toa = froma
            if validate_email(froma) and validate_email(toa):
623
624
625
626
627
                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:
628
                        message = Workflow.get_status_under_text_format(self, True, True, True)
Jerome Mariette's avatar
Jerome Mariette committed
629
                    msg = MIMEText(message, 'html')
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
                    me = froma
                    you = toa
                    if not subject: subject = "JFlow - Workflow #" + str(self.id) + " is " + self.status
                    msg['Subject'] = subject
                    msg['From'] = me
                    msg['To'] = you
                    # Send the message via our own SMTP server, but don't include the
                    # envelope header.
                    s = smtplib.SMTP(smtps, smtpp)
                    s.ehlo()
                    s.starttls()
                    s.login(me, fromp)
                    s.sendmail(me, [you], msg.as_string())
                    s.close()
                except:
                    logging.getLogger("wf." + str(self.id)).debug("Impossible to connect to smtp server '" + smtps + "'")
646
    
647
648
649
650
    def get_parameters_per_groups(self):
        name = self.get_name()
        description = self.get_description()
        parameters = self.get_parameters()
651
652
        pgparameters, parameters_order = {}, []
        for param in parameters:
Jerome Mariette's avatar
Jerome Mariette committed
653
            if param.group not in parameters_order: parameters_order.append(param.group)
654
655
            if pgparameters.has_key(param.group):
                pgparameters[param.group].append(param)
Jerome Mariette's avatar
Jerome Mariette committed
656
            else:
657
658
                pgparameters[param.group] = [param]
        return [pgparameters, parameters_order]
Jerome Mariette's avatar
Jerome Mariette committed
659
    
660
661
662
663
664
665
666
667
    def get_parameters(self):
        params = []
        for param in self.params_order:
            for attribute_value in self.__dict__.values():
                if (issubclass(attribute_value.__class__, AbstractParameter)) and param == attribute_value.name:
                    params.append(attribute_value)
        return params
    
668
    def get_exec_path(self, software):
669
670
671
672
673
        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)
674
        elif exec_path is None and utils.which(software) == None:
675
            raise Exception("'" + software + "' path connot be retrieved either in the PATH and in the application.properties file!")
676
677
678
        elif exec_path is None and utils.which(software) != None: 
            exec_path = software
        elif exec_path != None and not os.path.isfile(exec_path):
679
            raise Exception("'" + exec_path + "' set for '" + software + "' does not exists, please provide a valid path!")
680
        return exec_path
681
    
Jerome Mariette's avatar
Jerome Mariette committed
682
683
    def add_component(self, component_name, args=[], kwargs={}, component_prefix="default"):
        # first build and check if this component is OK
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
        if self.internal_components.has_key(component_name) or self.external_components.has_key(component_name):
            
            if self.internal_components.has_key(component_name) :
                my_pckge = __import__(self.internal_components[component_name], globals(), locals(), [component_name], -1)
                # build the object and define required field
                cmpt_object = getattr(my_pckge, component_name)()
                cmpt_object.output_directory = self.get_component_output_directory(component_name, component_prefix)
                cmpt_object.prefix = component_prefix
                if kwargs: cmpt_object.define_parameters(**kwargs)
                else: cmpt_object.define_parameters(*args)
            # 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)
701
702
            
            # there is a dynamic component
703
            if cmpt_object.is_dynamic():
704
705
706
707
                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
708
                    self.components_to_exec.append(cmpt_object)
709
                    self.components.append(cmpt_object)
710
711
712
713
714
715
716
717
718
                    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
719
                    self.components_to_exec = []
720
                    self.components = []
721
722
723
            else:
                if self.component_nameids_is_init:
                    # add the component
724
                    self.components_to_exec.append(cmpt_object)
725
                    self.components.append(cmpt_object)
726
                elif not self.component_nameids_is_init and not self.dynamic_component_present:
Jerome Mariette's avatar
Jerome Mariette committed
727
728
729
                    if self._component_is_duplicated(cmpt_object):
                        raise ValueError("Component " + cmpt_object.__class__.__name__ + " with prefix " + 
                                            cmpt_object.prefix + " already exist in this pipeline!")
730
                    self.components_to_exec.append(cmpt_object)
731
                    self.components.append(cmpt_object)
732
733
734
735
736
737
                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

738
739
            return cmpt_object
        else:
740
741
            raise ImportError(component_name + " component cannot be loaded, available components are: {0}".format(
                                           ", ".join(self.internal_components.keys() + self.external_components.keys())))
Jerome Mariette's avatar
Jerome Mariette committed
742
743
744
745
746
747
748
749
    
    def pre_process(self):
        pass
    
    def process(self):
        """ 
        Run the workflow, has to be implemented by subclasses
        """
750
        raise NotImplementedError( "Workflow.process() must be implemented in " + self.__class__.__name__ )
751
752
753

    def get_name(self):
        """ 
754
        Return the workflow name.
755
        """
Jerome Mariette's avatar
Jerome Mariette committed
756
        return self.__class__.__name__.lower()
757
758
759
760
761
    
    def get_description(self):
        """ 
        Return the workflow description, has to be implemented by subclasses
        """
762
        raise NotImplementedError( "Workflow.get_description() must be implemented in " + self.__class__.__name__ )
763
    
764
    def define_parameters(self, function="process"):
765
766
767
        """ 
        Define the workflow parameters, has to be implemented by subclasses
        """
768
        raise NotImplementedError( "Workflow.define_parameters() must be implemented in " + self.__class__.__name__ )
Jerome Mariette's avatar
Jerome Mariette committed
769
770
771
772
773
774
775
776
777
778
779
780
781
782
    
    def post_process(self):
        pass
    
    def get_temporary_file(self, suffix=".txt"):
        tempfile_name = os.path.basename(tempfile.NamedTemporaryFile(suffix=suffix).name)
        return os.path.join(self.jflow_config_reader.get_tmp_directory(), tempfile_name)

    def get_component_output_directory(self, component_name, component_prefix):
        return os.path.join(self.directory, component_name + "_" + component_prefix)
    
    def get_components_nameid(self):
        return self.component_nameids.keys()
    
Jerome Mariette's avatar
Jerome Mariette committed
783
784
    def wf_execution_wrapper(self):
        getattr(self, self.function)()
Jerome Mariette's avatar
Jerome Mariette committed
785
    
Jerome Mariette's avatar
Jerome Mariette committed
786
787
788
789
    def run(self):
        """
        Only require for Threading
        """
790
791
792
793
794
795
796
        try:
            # if this is the first time the workflow run
            if self.step == None :
                self.start_time = time.time()
                self.step = 0
                self.status = self.STATUS_STARTED
                self.end_time = None
Jerome Mariette's avatar
Jerome Mariette committed
797
798
                # if some args are provided, let's fill the parameters
                self._set_parameters(self.args)
799
                self._serialize()
800
801
802
803
804
805
806
            # if pre_processing has not been done yet
            if self.step == 0:
                self.pre_process()
                self.step = 1
                self._serialize()
            # if collecting components and running workflow has not been done yet
            if self.step == 1:
807
808
                try:
                    self.reseted_components = []
809
                    self.components = []
Jerome Mariette's avatar
Jerome Mariette committed
810
                    self.status = self.STATUS_STARTED
811
812
813
814
815
                    self.wf_execution_wrapper()
                except SystemExit, e: 
                    self.status = self.STATUS_FAILED
                    self.end_time = time.time()
                    self._serialize()
816
                    self._send_email()
817
818
819
820
821
822
823
824
825
826
                    raise
                self.component_nameids_is_init = True
                if self.dynamic_component_present:
                    self.step = 2
                else:
                    self._execute_weaver()
                    self.step = 3
                self._serialize() 
            # if the workflow was a dynamic one
            if self.step == 2:
827
828
                try:
                    self.reseted_components = []
829
                    self.components = []
Jerome Mariette's avatar
Jerome Mariette committed
830
                    self.status = self.STATUS_STARTED
831
832
833
834
835
                    self.wf_execution_wrapper()
                except SystemExit, e: 
                    self.status = self.STATUS_FAILED
                    self.end_time = time.time()
                    self._serialize()
836
                    self._send_email()
837
838
839
                    raise
                if len(self.components_to_exec) > 0:
                    self._execute_weaver()
840
                self.step = 3
841
842
843
844
                self._serialize()
            # if post processing has ne been done yet
            if self.step == 3:
                self.post_process()
845
                if self.status == self.STATUS_STARTED: self.status = self.STATUS_COMPLETED
846
847
                self.end_time = time.time()
                self._serialize()
848
                self._send_email()
849
850
851
        except Exception as e:
            logging.getLogger("wf." + str(self.id)).exception(str(e))
            utils.display_error_message(str(e))
852

Jerome Mariette's avatar
Jerome Mariette committed
853
854
855
856
857
858
859
860
861
862
863
    def _update_status_from_log(self):
        # first update the status from weaver folders
        # TODO update self.end_time
        try:
            working_directory = os.path.join(self.directory, self.WORKING)
            make_states = []
            for wdir in os.listdir(working_directory):
                log_path = os.path.join(working_directory, wdir, self.MAKEFLOW_LOG_FILE_NAME)
                log = MakeflowLog(log_path)
                log.parse()
                make_states.append(log.state)
Jerome Mariette's avatar
Jerome Mariette committed
864
865
866
            if len(self.reseted_components) > 0:
                self.status = self.STATUS_RESETED
            elif self.STATUS_ABORTED in make_states:
Jerome Mariette's avatar
Jerome Mariette committed
867
868
869
870
871
872
873
874
875
876
877
878
                self.status = self.STATUS_ABORTED
            elif self.STATUS_FAILED in make_states:
                self.status = self.STATUS_FAILED
            elif self.status != self.STATUS_COMPLETED:
                self.status = self.STATUS_STARTED
        except: pass
        self._serialize()

    def get_status(self):
        self._update_status_from_log()
        return self.status
    
879
880
881
    def get_resource(self, resource):
        return self.jflow_config_reader.get_resource(resource)
    
Jerome Mariette's avatar
Jerome Mariette committed
882
883
884
885
886
887
888
    def get_component_status(self, component_nameid):
        status = {"time": 0.0,
                  "tasks": 0,
                  "waiting": 0,
                  "running": 0,
                  "failed":0,
                  "aborted": 0,
889
890
                  "completed": 0,
                  "failed_commands": list() }
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
        if component_nameid not in self.reseted_components:
            try:
                log = MakeflowLog(self.component_nameids[component_nameid])
                log.parse()
                symbols = set(n.symbol for n in log.nodes if n.symbol)
                if not symbols: return None
                for n in log.nodes:
                    if not n.symbol: continue
                    if n.symbol == component_nameid:
                        status["tasks"] += 1
                        status["time"]  += n.elapsed_time
                        if n.state == Node.WAITING:
                            status["waiting"] += 1
                        elif n.state == Node.RUNNING:
                            status["running"] += 1
                        elif n.state == Node.FAILED:
                            status["failed"] += 1
                            status["failed_commands"].append( n.command )
                        elif n.state == Node.ABORTED:
                            status["aborted"] += 1
                        elif n.state == Node.COMPLETED:
                            status["completed"] += 1
            except: pass
Frédéric Escudié's avatar
Frédéric Escudié committed
914
        return status
Jerome Mariette's avatar
Jerome Mariette committed
915
    
916
917
918
919
920
921
922
923
924
    def reset_component(self, component_name):
        # first reinit the step to the execution step
        self.step = 1
        found = False
        for cpt in self.components:
            if cpt.get_nameid() == component_name:
                cpt.reset()
                found = True
        if not found:
925
            raise Exception("Impossible to reset component '" + component_name + "'! This one is not part of the workflow!")
926
        self.reseted_components.append(component_name)
Jerome Mariette's avatar
Jerome Mariette committed
927
        self.status = self.STATUS_RESETED
928
929
        self._serialize()
    
930
931
932
933
934
935
936
937
    def minimize(self):
        compts_status = {}
        for i, component in enumerate(self.get_components_nameid()):
            compts_status[component] = self.get_component_status(component)
        return MINIWorkflow(self.id, self.name, self.description, self.get_status(), self.start_time, 
                            self.end_time, self.metadata, self.get_components_nameid(), compts_status, 
                            self.get_errors())
    
Jerome Mariette's avatar
Jerome Mariette committed
938
939
940
941
942
943
944
945
946
947
948
    def makeflow_pretty_print_node(self, dag, node):
        sys.stdout.write('{0:>10} {1} {2}\n'.format('NODE', node.id, node.symbol))
        
        for output_file in sorted(node.output_files):
            sys.stdout.write('{0:>10} {1:>10} {2}\n'.format('', 'OUTPUT', output_file))
    
        for input_file in sorted(node.input_files):
            sys.stdout.write('{0:>10} {1:>10} {2}\n'.format('', 'INPUT', input_file))
            
        sys.stdout.write('{0:>10} {1:>10} {2}\n'.format('', 'COMMAND', node.command))

949
950
951
952
953
    def _set_stderr(self, keep_same_error_file=False):
        # if it is specified to keep the same error file, keep with it
        if not keep_same_error_file:
            if hasattr(self, "stderr") and self.stderr is not None:
                os.rename( self.stderr, os.path.join(self.directory, str(time.time()) + self.STDERR_FILE_NAME + self.OLD_EXTENSION) )
954
        
955
956
957
958
        stderr = os.path.join(self.directory, self.STDERR_FILE_NAME)
        logger = logging.getLogger( "wf." + str(self.id) )
        logger.setLevel(logging.DEBUG)
        formatter = logging.Formatter( '## %(asctime)s :: %(message)s' )
959
960
961
962
963
        if self.stderrfh is not None:
            self.stderrfh = FileHandler(stderr, 'a')
            self.stderrfh.setLevel(logging.ERROR)
            self.stderrfh.setFormatter(formatter)
            logger.addHandler(self.stderrfh)
964
965
        return stderr

Jerome Mariette's avatar
Jerome Mariette committed
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
    def _execute_weaver(self, engine_wrapper=None):
        # Add nest path and path to script to Python module path to allow
        # for importing modules outside of $PYTHONPATH
        make_directory, new_make = self._get_current_make()
        current_working_directory = os.path.join(os.path.join(self.directory, self.WORKING), make_directory)
        sys.path.insert(0, os.path.abspath(os.path.dirname(current_working_directory)))

        # Load built-ins
        self._import('abstraction', ABSTRACTIONS)
        self._import('dataset', DATASETS)
        self._import('function', FUNCTIONS)
        self._import('nest', NESTS)
        self._import('options', OPTIONS)
        self._import('stack', STACKS)
                
        # Execute nest
        with Nest(current_working_directory, wrapper=engine_wrapper, path=self.jflow_config_reader.get_makeflow_path()) as nest:
            with self.options:
                if new_make:
                    try:
986
                        for component in self.components_to_exec:
Jerome Mariette's avatar
Jerome Mariette committed
987
                            nest.symbol = component.get_nameid()
988
                            nest.batch = component.batch_options
Jerome Mariette's avatar
Jerome Mariette committed
989
990
991
992
993
994
                            self.component_nameids[component.get_nameid()] = os.path.join(current_working_directory, self.MAKEFLOW_LOG_FILE_NAME)
                            component.execute()
                        # create the DAG
                        nest.compile()
                    except Exception as e:
                        self.status = self.STATUS_FAILED
Jerome Mariette's avatar
Jerome Mariette committed
995
                        self.end_time = time.time()
Jerome Mariette's avatar
Jerome Mariette committed
996
                        self._serialize()