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

import inspect
import os
20
import re
Jerome Mariette's avatar
Jerome Mariette committed
21
22
23
24
25
26
27
import sys
import uuid
import pkgutil
import tempfile
import pickle
import time
import threading
Jerome Mariette's avatar
Jerome Mariette committed
28
import types
Jerome Mariette's avatar
Jerome Mariette committed
29
import logging
Jerome Mariette's avatar
Jerome Mariette committed
30

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

Jerome Mariette's avatar
Jerome Mariette committed
35
import jflow
Jerome Mariette's avatar
Jerome Mariette committed
36
import jflow.utils as utils
Jerome Mariette's avatar
Jerome Mariette committed
37
from jflow.graph import Graph
Jerome Mariette's avatar
Jerome Mariette committed
38
from jflow.workflows_manager import WorkflowsManager, JFlowConfigReader
39
from jflow.parameter import *
Jerome Mariette's avatar
Jerome Mariette committed
40
41
42
43
44
45
46
47
48
49
50
51

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
52

Jerome Mariette's avatar
Jerome Mariette committed
53
54
55
56
57
58
class Workflow(threading.Thread):
    """
    """

    PROPERTIES_FILE_NAME = "workflow.properties"
    MAKEFLOW_LOG_FILE_NAME = "Makeflow.makeflowlog"
59
    DUMP_FILE_NAME = ".workflow.dump"
Jerome Mariette's avatar
Jerome Mariette committed
60
61
62
63
64
    WORKING = ".working"
    STATUS_STARTED = "started"
    STATUS_COMPLETED = "completed"
    STATUS_FAILED = "failed"
    STATUS_ABORTED = "aborted"
65
66
    
    
67
    def __init__(self, args={}, id=None, function= "process"):
Jerome Mariette's avatar
Jerome Mariette committed
68
69
70
71
72
73
        """ 
        """
        # define as a thread
        threading.Thread.__init__(self)
        self.jflow_config_reader = JFlowConfigReader()
        self.manager = WorkflowsManager()
74
        self.components_to_exec = []
75
        self.components = []
Jerome Mariette's avatar
Jerome Mariette committed
76
77
78
79
80
81
        self.makes = {}
        self.globals = {}
        self.options = Options()
        self.status = self.STATUS_STARTED
        self.start_time = None
        self.end_time = None
82
        self.step = None
Frédéric Escudié's avatar
Frédéric Escudié committed
83
        self.stderr = None
84
        self.dynamic_component_present = False
85
        self.function = function
Jerome Mariette's avatar
Jerome Mariette committed
86
        self.comp_pckg = self._import_components()
87
        # intruduce --log-verbose to be able to monitor the new version of makeflow >=4.2.2
Jerome Mariette's avatar
Jerome Mariette committed
88
        self.engine_arguments = ' --log-verbose '
89
        self.component_nameids_is_init = False
Jerome Mariette's avatar
Jerome Mariette committed
90
91
92
        self.component_nameids = {}
        # try to parse engine arguments
        try:
93
94
            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
95
96
97
            if type: self.engine_arguments += ' -T ' + type
            if options : self.engine_arguments += ' -B "' + options + '"'
        except: self.engine_arguments = None
Jerome Mariette's avatar
Jerome Mariette committed
98
        
Jerome Mariette's avatar
Jerome Mariette committed
99
        self.id = id
100
101
102
103
104
        self.name = self.get_name()
        self.description = self.get_description()
        
        # define the parameters 
        self.params_order = []
105
        self.define_parameters(self.function)
106
107
108
109
110
        # add the metadata parameter
        self.add_parameter("metadata", "Which metadata should be linked to this workflow", is_list=True)
        # if some args are provided, let's fill the parameters
        if args: self._set_parameters(args)

Jerome Mariette's avatar
Jerome Mariette committed
111
112
113
114
        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
115
            if self.stderr is None:
116
                self.set_stderr()
Jerome Mariette's avatar
Jerome Mariette committed
117
            self._serialize()
118
    
119
120
    def add_input_file(self, name, help, file_format="any", default=None, type="inputfile", required=False, 
                       flag=None, group="default", display_name=None, is_list=False, add_to=None):
121
122
        if is_list:
            if default == None: default = []
123
124
            new_param = InputFileList(name, help, flag=flag, file_format=file_format, default=default, 
                                      type=type, required=required, group=group, display_name=display_name)
125
        else:
126
127
            new_param = InputFile(name, help, flag=flag, file_format=file_format, default=default, 
                                  type=type, required=required, group=group, display_name=display_name)
128
129
130
        # if this input should be added to a particular parameter
        if add_to:
            try:
Jerome Mariette's avatar
help ok    
Jerome Mariette committed
131
                self.__getattribute__(add_to).add_sub_parameter(new_param)
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
            except: pass
        # otherwise, add it to the class itself
        else:
            self.params_order.append(name)
            self.__setattr__(name, new_param)
    
    def add_multiple_parameter(self, name, help, required=False, flag=None, group="default", display_name=None, is_list=False):
        self.params_order.append(name)
        if is_list:
            new_param = MultiParameterList(name, help, flag=flag, required=required, group=group, display_name=display_name)
        else:
            new_param = MultiParameter(name, help, flag=flag, required=required, group=group, display_name=display_name)
        self.__setattr__(name, new_param)
    
    def add_parameter(self, name, help, default=None, type=types.StringType, choices=None, required=False, 
                      flag=None, group="default", display_name=None, is_list=False, add_to=None):
        if is_list:
            if default == None: default = []
            new_param = ParameterList(name, help, flag=flag, default=default, type=type, choices=choices, 
                                      required=required, group=group, display_name=display_name)
        else:
            new_param = Parameter(name, help, flag=flag, default=default, type=type, choices=choices, 
                                  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
158
                self.__getattribute__(add_to).add_sub_parameter(new_param)
159
160
161
162
163
164
            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
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
    def add_exclusion_rule(self, *args2exclude):
        # first of all, are this parameter exist
        params2exclude = []
        for arg2exclude in args2exclude:
            try:
                params2exclude.append(self.__getattribute__(arg2exclude))
            except: pass
        # everything is ok, let's go
        if len(params2exclude) == len(args2exclude):
            new_group = "exclude-"+uuid.uuid4().hex[:5]
            for paramsexclude in params2exclude:
                paramsexclude.group = new_group
        # it might be a mutliple param rule
        else:
            for attribute_value in self.__dict__.values():
                if issubclass(attribute_value.__class__, MultiParameter) or issubclass(attribute_value.__class__, MultiParameterList):
                    params2exclude = []
                    for sub_param in attribute_value.sub_parameters:
                        if sub_param.name in args2exclude:
                            params2exclude.append(sub_param)
                    if len(params2exclude) == len(args2exclude):
                        new_group = "exclude-"+uuid.uuid4().hex[:5]
                        flags2exclude = []
                        for paramsexclude in params2exclude:
                            paramsexclude.group = new_group
                            flags2exclude.append(paramsexclude.flag)
                        attribute_value.type.excludes[new_group] = flags2exclude
                        break
    
Jerome Mariette's avatar
Jerome Mariette committed
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
    # function in charge to download an url file
    def _download_urlfile(self, input):
        try:
            uri_object = urlparse(input)
            opener = urllib2.urlopen(input)
            block_size = 8000
            jflowconf = JFlowConfigReader()
            tmp_directory = os.path.join(jflowconf.get_tmp_directory(), os.path.basename(tempfile.NamedTemporaryFile().name))
            os.mkdir(tmp_directory) 
            file_path = os.path.join(tmp_directory, os.path.basename(uri_object.path))
            local_file = open(file_path, 'wb')
            if os.path.basename(uri_object.path) is not None and os.path.basename(uri_object.path) != "":
                metadata = opener.info()
                file_size = int(metadata.getheaders("Content-Length")[0])
                while True:
                    buffer = opener.read(block_size)
                    # End of download
                    if not buffer: break
                    # Parts of download
                    local_file.write(buffer)
                local_file.close()
                logging.getLogger("types.urlfile").debug("URL file '{0}' successfully downloaded as: {1}".format(input, file_path))
            return [file_path, True]
        except:
            return [input, False]
    
220
221
222
    def _set_parameters(self, args):
        parameters = self.get_parameters()
        for param in parameters:
Jerome Mariette's avatar
help ok    
Jerome Mariette committed
223
224
225
226
227
228
229
230
            if args[param.name]:
                try: args[param.name] = args[param.name].encode('ascii','ignore')
                except: pass
                if param.__class__ ==  Parameter:
                    new_param = Parameter(param.name, param.help, default=args[param.name], type=param.type, choices=param.choices, 
                                          required=param.required, flag=param.flag, group=param.group, display_name=param.display_name)
                    self.__setattr__(param.name, new_param)
                elif param.__class__ == InputFile:
Jerome Mariette's avatar
Jerome Mariette committed
231
232
233
234
235
236
237
238
                    # handle url inputs
                    default, is_uri = self._download_urlfile(args[param.name])
                    # handle upload inputs
                    try: is_local = os.path.isfile(args[param])
                    except: is_local = False
                    if not is_uri and not is_local and param.type.__name__ == "inputfile" or param.type.__name__ == "browsefile":
                        default = os.path.join(self.jflow_config_reader.get_tmp_directory(), (args[param.name]))
                    new_param = InputFile(param.name, param.help, file_format=param.file_format, default=default, type=param.type, 
Jerome Mariette's avatar
help ok    
Jerome Mariette committed
239
240
241
                                          choices=param.choices, required=param.required, flag=param.flag, 
                                          group=param.group, display_name=param.display_name)
                    self.__setattr__(param.name, new_param)
Jerome Mariette's avatar
Jerome Mariette committed
242
                elif param.__class__ == InputFileList:
Jerome Mariette's avatar
Jerome Mariette committed
243
244
245
246
                    path2test = args[param.name]
                    if not path2test.__class__.__name__ == "list":
                        path2test = [path2test]
                    default_vals = []
Jerome Mariette's avatar
Jerome Mariette committed
247
                    # handle url inputs
Jerome Mariette's avatar
Jerome Mariette committed
248
249
250
251
252
253
254
255
256
257
258
259
260
261
                    for path in path2test:
                        new_url, is_uri = self._download_urlfile(path)
                        if is_uri: 
                            default_vals.append(new_url)
                            path2test.remove(path)
                    # handle localfile
                    for path in path2test:    
                        if os.path.isfile(path):
                            default_vals.append(path)
                            path2test.remove(path)
                    # handle upload inputs 
                    if param.type.__name__ == "inputfile" or param.type.__name__ == "browsefile":
                        for path in path2test:
                            default_vals.append(os.path.join(self.jflow_config_reader.get_tmp_directory(), (path)))
Jerome Mariette's avatar
Jerome Mariette committed
262
                    self.__getattribute__(param.name).extend(default_vals)
263
                elif param.__class__ ==  ParameterList:
Jerome Mariette's avatar
help ok    
Jerome Mariette committed
264
                    self.__getattribute__(param.name).extend(args[param.name])
Jerome Mariette's avatar
Jerome Mariette committed
265
266
267
268
269
270
271
272
                elif param.__class__ == MultiParameter:
                    sub_args = {}
                    for sarg in args[param.name]:
                        sub_args[sarg[0]] = sarg[1]
                    for sub_param in param.sub_parameters:
                        if sub_args.has_key(sub_param.flag):
                            self.__getattribute__(param.name)[sub_param.name] = sub_args[sub_param.flag]
                        else:
Jerome Mariette's avatar
Jerome Mariette committed
273
                            self.__getattribute__(param.name)[sub_param.name] = sub_param.default
274
                elif param.__class__ == MultiParameterList:
Jerome Mariette's avatar
Jerome Mariette committed
275
276
277
278
279
280
281
282
283
284
                    for sargs in args[param.name]:
                        sub_args, final_sub_args = {}, {}
                        for sarg in sargs:
                            sub_args[sarg[0]] = sarg[1]
                        for sub_param in param.sub_parameters:
                            if sub_args.has_key(sub_param.flag):
                                final_sub_args[sub_param.name] = sub_args[sub_param.flag]
                            else:
                                final_sub_args[sub_param.name] = sub_param.default
                        self.__getattribute__(param.name).append(sub_args)
285
    
Jerome Mariette's avatar
Jerome Mariette committed
286
287
288
289
290
291
292
293
294
295
296
    def get_execution_graph(self):
        graph = Graph()
        for cpt in self.components:
            graph.add_vertex(cpt.get_nameid())
            for ioparameter in cpt.__dict__.values():
                if ( issubclass( ioparameter.__class__, InputFile ) or issubclass( ioparameter.__class__, OutputFile) 
                     or issubclass( ioparameter.__class__, InputFileList) or issubclass( ioparameter.__class__, OutputFileList) ):
                    print ioparameter.name, ioparameter.component_nameid, ioparameter.parent_component_nameid
                    graph.add_edge({ioparameter.component_nameid, ioparameter.parent_component_nameid})
        print graph
    
297
298
299
300
301
302
303
304
305
306
307
308
309
    def set_stderr(self):
        if hasattr(self, "stderr") and self.stderr is not None:
            os.rename( self.stderr, os.path.join(self.directory, str(time.time()) + "wf_stderr.old") )
        stderr = os.path.join(self.directory, "wf_stderr.txt")
        logger = logging.getLogger( "wf." + str(self.id) )
        logger.setLevel(logging.DEBUG)
        formatter = logging.Formatter( '%(asctime)s :: %(message)s' )
        file_handler = FileHandler(stderr, 'a')
        file_handler.setLevel(logging.ERROR)
        file_handler.setFormatter(formatter)
        logger.addHandler(file_handler)
        self.stderr = stderr
    
310
    @staticmethod
311
    def config_parser(arg_lines):
312
313
        for arg in arg_lines:
            yield arg
314
    
315
    def get_errors(self):
Frédéric Escudié's avatar
Frédéric Escudié committed
316
317
318
319
320
321
        error = {
                 "title"     : "",
                 "msg"       : list(),
                 "traceback" : list()
        }
        line_idx = 0
322
323
324
        FH_stderr = open( self.stderr )
        lines = FH_stderr.readlines()
        while line_idx < len(lines):
Frédéric Escudié's avatar
Frédéric Escudié committed
325
326
327
328
329
330
            if lines[line_idx].strip().endswith("RunWorflowException"):
                error["title"]     = lines[line_idx].rstrip()
                error["msg"]       = list()
                error["traceback"] = list()
                line_idx += 2 # skip : "Traceback (most recent call last):"
                # Traceback
331
                while lines[line_idx] != lines[line_idx].lstrip():
Frédéric Escudié's avatar
Frédéric Escudié committed
332
333
334
335
                    error["traceback"].append({ 
                                               "location" : lines[line_idx].strip(),
                                               "line"     : lines[line_idx].strip()
                    })
336
                    line_idx += 2
Frédéric Escudié's avatar
Frédéric Escudié committed
337
338
339
340
341
                # Error message
                while line_idx < len(lines) and not lines[line_idx].strip().endswith("RunWorflowException"):
                    error["msg"].append( lines[line_idx].strip() )
                    line_idx += 1
                line_idx -= 1
342
343
            line_idx += 1
        FH_stderr.close()
Frédéric Escudié's avatar
Frédéric Escudié committed
344
345
346
347
348
349
        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
350
    
Philippe Bardou's avatar
Philippe Bardou committed
351
    def get_outputs_per_components(self, web_path):
352
353
        outputs_files = {}
        for current_components in self.components:
Philippe Bardou's avatar
Philippe Bardou committed
354
            #status = self.get_component_status(current_components.get_nameid())
Philippe Bardou's avatar
Philippe Bardou committed
355
            outputs_files[current_components.get_nameid()] = current_components.get_component_outputs(web_path)
Philippe Bardou's avatar
Philippe Bardou committed
356
            #outputs_files["0"] = status["completed"]
357
358
        return outputs_files
    
Jerome Mariette's avatar
Jerome Mariette committed
359
360
361
362
363
364
365
366
367
368
369
370
371
372
    def __setstate__(self, state):
        self.__dict__ = state.copy()
        threading.Thread.__init__(self, name=self.name)
        
    def __getstate__(self):
        """
        Threading uses Lock Object, do not consider these objects when serializing a workflow
        """
        odict = self.__dict__.copy()
        del odict['_Thread__started']
        del odict['_Thread__block']
        del odict['_Thread__stderr']
        return odict
    
373
374
375
376
    def get_parameters_per_groups(self):
        name = self.get_name()
        description = self.get_description()
        parameters = self.get_parameters()
377
378
        pgparameters, parameters_order = {}, []
        for param in parameters:
Jerome Mariette's avatar
Jerome Mariette committed
379
            if param.group not in parameters_order: parameters_order.append(param.group)
380
381
            if pgparameters.has_key(param.group):
                pgparameters[param.group].append(param)
Jerome Mariette's avatar
Jerome Mariette committed
382
            else:
383
384
                pgparameters[param.group] = [param]
        return [pgparameters, parameters_order]
Jerome Mariette's avatar
Jerome Mariette committed
385
    
386
387
388
389
390
391
392
393
    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
    
394
    def get_exec_path(self, software):
395
396
397
398
399
        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)
400
        elif exec_path is None and utils.which(software) == None:
401
402
            sys.stderr.write("Error: '" + software + "' path connot be retrieved either in the PATH and in the application.properties file!\n")
            sys.exit(1)
403
404
405
406
407
        elif exec_path is None and utils.which(software) != None: 
            exec_path = software
        elif exec_path != None and not os.path.isfile(exec_path):
            sys.stderr.write("Error: '" + exec_path + "' set for '" + software + "' does not exists, please provide a valid path!\n")
            sys.exit(1)
408
        return exec_path
409
    
Jerome Mariette's avatar
Jerome Mariette committed
410
411
    def add_component(self, component_name, args=[], kwargs={}, component_prefix="default"):
        # first build and check if this component is OK
412
413
414
415
416
417
418
419
        if self.comp_pckg.has_key(component_name):
            my_pckge = __import__(self.comp_pckg[component_name], globals(), locals(), [component_name], -1)
            # build the object and define required field
            cmpt_object = getattr(my_pckge, component_name)()
            cmpt_object.output_directory = self.get_component_output_directory(component_name, component_prefix)
            cmpt_object.prefix = component_prefix
            if kwargs: cmpt_object.define_parameters(**kwargs)
            else: cmpt_object.define_parameters(*args)
420
421
            
            # there is a dynamic component
422
            if cmpt_object.is_dynamic():
423
424
425
426
                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
427
                    self.components_to_exec.append(cmpt_object)
428
                    self.components.append(cmpt_object)
429
430
431
432
433
434
435
436
437
                    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
438
                    self.components_to_exec = []
439
                    self.components = []
440
441
442
            else:
                if self.component_nameids_is_init:
                    # add the component
443
                    self.components_to_exec.append(cmpt_object)
444
                    self.components.append(cmpt_object)
445
                elif not self.component_nameids_is_init and not self.dynamic_component_present:
Jerome Mariette's avatar
Jerome Mariette committed
446
447
448
                    if self._component_is_duplicated(cmpt_object):
                        raise ValueError("Component " + cmpt_object.__class__.__name__ + " with prefix " + 
                                            cmpt_object.prefix + " already exist in this pipeline!")
449
                    self.components_to_exec.append(cmpt_object)
450
                    self.components.append(cmpt_object)
451
452
453
454
455
456
                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

457
458
            return cmpt_object
        else:
Jerome Mariette's avatar
Jerome Mariette committed
459
            raise ImportError(component_name + " component cannot be loaded, available components are: {0}".format(", ".join(self.comp_pckg.keys())))
Jerome Mariette's avatar
Jerome Mariette committed
460
461
462
463
464
465
466
467
    
    def pre_process(self):
        pass
    
    def process(self):
        """ 
        Run the workflow, has to be implemented by subclasses
        """
468
        raise NotImplementedError( "Workflow.process() must be implemented in " + self.__class__.__name__ )
469
470
471

    def get_name(self):
        """ 
472
        Return the workflow name.
473
        """
Jerome Mariette's avatar
Jerome Mariette committed
474
        return self.__class__.__name__.lower()
475
476
477
478
479
    
    def get_description(self):
        """ 
        Return the workflow description, has to be implemented by subclasses
        """
480
        raise NotImplementedError( "Workflow.get_description() must be implemented in " + self.__class__.__name__ )
481
    
482
    def define_parameters(self, function="process"):
483
484
485
        """ 
        Define the workflow parameters, has to be implemented by subclasses
        """
486
        raise NotImplementedError( "Workflow.define_parameters() must be implemented in " + self.__class__.__name__ )
Jerome Mariette's avatar
Jerome Mariette committed
487
488
489
490
491
492
493
494
495
496
497
498
499
500
    
    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
501
502
    def wf_execution_wrapper(self):
        getattr(self, self.function)()
Jerome Mariette's avatar
Jerome Mariette committed
503
    
Jerome Mariette's avatar
Jerome Mariette committed
504
505
506
507
    def run(self):
        """
        Only require for Threading
        """
508
509
510
511
512
513
514
        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
515
                self._serialize()
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
            # 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:
                try: 
                    self.wf_execution_wrapper()
                except SystemExit, e: 
                    self.status = self.STATUS_FAILED
                    self.end_time = time.time()
                    self._serialize()
                    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:
                try: 
                    self.wf_execution_wrapper()
                except SystemExit, e: 
                    self.status = self.STATUS_FAILED
                    self.end_time = time.time()
                    self._serialize()
                    raise
                if len(self.components_to_exec) > 0:
                    self._execute_weaver()
548
                self.step = 3
549
550
551
552
553
                self._serialize()
            # if post processing has ne been done yet
            if self.step == 3:
                self.post_process()
                if self.status == self.STATUS_STARTED: self.status = self.STATUS_COMPLETED        
554
555
                self.end_time = time.time()
                self._serialize()
556
557
558
        except:
            logging.getLogger("wf." + str(self.id)).exception("RunWorflowException")
            raise
Jerome Mariette's avatar
Jerome Mariette committed
559
    
Jerome Mariette's avatar
Jerome Mariette committed
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
    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)
            if self.STATUS_ABORTED in make_states:
                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
    
584
585
586
    def get_resource(self, resource):
        return self.jflow_config_reader.get_resource(resource)
    
Jerome Mariette's avatar
Jerome Mariette committed
587
588
589
590
591
592
593
    def get_component_status(self, component_nameid):
        status = {"time": 0.0,
                  "tasks": 0,
                  "waiting": 0,
                  "running": 0,
                  "failed":0,
                  "aborted": 0,
594
595
                  "completed": 0,
                  "failed_commands": list() }
Jerome Mariette's avatar
Jerome Mariette committed
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
        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
612
                        status["failed_commands"].append( n.command )
Jerome Mariette's avatar
Jerome Mariette committed
613
614
615
616
617
                    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
618
        return status
Jerome Mariette's avatar
Jerome Mariette committed
619
620
621
622
623
624
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
    
    def makeflow_pretty_print_node(self, dag, node):
        sys.stdout.write('{0:>10} {1} {2}\n'.format('NODE', node.id, node.symbol))
        
        for output_file in sorted(node.output_files):
            sys.stdout.write('{0:>10} {1:>10} {2}\n'.format('', 'OUTPUT', output_file))
    
        for input_file in sorted(node.input_files):
            sys.stdout.write('{0:>10} {1:>10} {2}\n'.format('', 'INPUT', input_file))
            
        sys.stdout.write('{0:>10} {1:>10} {2}\n'.format('', 'COMMAND', node.command))

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

        # Load built-ins
        self._import('abstraction', ABSTRACTIONS)
        self._import('dataset', DATASETS)
        self._import('function', FUNCTIONS)
        self._import('nest', NESTS)
        self._import('options', OPTIONS)
        self._import('stack', STACKS)
                
        # Execute nest
        with Nest(current_working_directory, wrapper=engine_wrapper, path=self.jflow_config_reader.get_makeflow_path()) as nest:
            with self.options:
                if new_make:
                    try:
651
                        for component in self.components_to_exec:
Jerome Mariette's avatar
Jerome Mariette committed
652
                            nest.symbol = component.get_nameid()
653
                            nest.batch = component.batch_options
Jerome Mariette's avatar
Jerome Mariette committed
654
655
656
657
658
659
                            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
660
                        self.end_time = time.time()
Jerome Mariette's avatar
Jerome Mariette committed
661
                        self._serialize()
Jerome Mariette's avatar
Jerome Mariette committed
662
                        raise
663
                self.components_to_exec = []  
Jerome Mariette's avatar
Jerome Mariette committed
664
665
666
667
668
669
670
671
                # Once a weaver script is compiled, serialize the workflow
                self._serialize()
                try:
                    nest.execute(self.engine_arguments, exit_on_failure=True)
                except:
                    self.status = self.STATUS_FAILED
                    self.end_time = time.time()
                    self._serialize()
Jerome Mariette's avatar
Jerome Mariette committed
672
                    raise
Jerome Mariette's avatar
Jerome Mariette committed
673
674
675

    def _get_current_make(self):
        current_component, make_directory, new_make = [], None, False
676
        for component in self.components_to_exec:
Jerome Mariette's avatar
Jerome Mariette committed
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
            current_component.append(component.get_nameid())
        for make in self.makes:
            if set(current_component) == set(self.makes[make]):
                make_directory = make
        # If the components in the queue have already been compiled
        if make_directory is None:
            make_directory = uuid.uuid4().hex[:10]
            self.makes[make_directory] = current_component
            new_make = True
        return [make_directory, new_make]
    
    def _serialize(self):
        self.dump_path = os.path.join(self.directory, self.DUMP_FILE_NAME)
        workflow_dump = open(self.dump_path, "wb")
        pickle.dump(self, workflow_dump)
        workflow_dump.close()

694
695
    def _component_is_duplicated(self, component):
        if component.get_nameid() in self.component_nameids.keys():
Jerome Mariette's avatar
Jerome Mariette committed
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
            return True
        return False

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

    def _import_components(self):
        pckge = {}
        # then import pipeline packages
        pipeline_dir = os.path.dirname(inspect.getfile(self.__class__))
        for importer, modname, ispkg in pkgutil.iter_modules([os.path.join(pipeline_dir, "components")], "workflows." + 
                                                             os.path.basename(pipeline_dir) + ".components."):
Jerome Mariette's avatar
Jerome Mariette committed
712
713
714
715
716
            try:
                m = __import__(modname)
                for class_name, obj in inspect.getmembers(sys.modules[modname], inspect.isclass):
                    if issubclass(obj, jflow.component.Component) and obj.__name__ != jflow.component.Component.__name__:
                        pckge[class_name] = modname
Jerome Mariette's avatar
Jerome Mariette committed
717
            except Exception as e:
Jerome Mariette's avatar
Jerome Mariette committed
718
                logging.getLogger("Workflow._import_components").debug("Component <{0}> cannot be loaded: {1}".format(modname, e))
Jerome Mariette's avatar
Jerome Mariette committed
719
720
721
        # finally import workflows shared packages
        workflows_dir = os.path.dirname(os.path.dirname(inspect.getfile(self.__class__)))
        for importer, modname, ispkg in pkgutil.iter_modules([os.path.join(workflows_dir, "components")], "workflows.components."):
Jerome Mariette's avatar
Jerome Mariette committed
722
723
724
725
726
            try:
                m = __import__(modname)
                for class_name, obj in inspect.getmembers(sys.modules[modname], inspect.isclass):
                    if issubclass(obj, jflow.component.Component) and obj.__name__ != jflow.component.Component.__name__:
                        pckge[class_name] = modname
Jerome Mariette's avatar
Jerome Mariette committed
727
728
            except Exception as e:
                logging.getLogger("Workflow._import_components").debug("Component <{0}> cannot be loaded: {1}".format(modname, e))
Jerome Mariette's avatar
Jerome Mariette committed
729
730
731
732
733
734
735
736
737
738
739
740
        return pckge

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

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