workflow.py 40.1 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
37
from jflow.utils import validate_email
Jerome Mariette's avatar
Jerome Mariette committed
38
from jflow.graph import Graph
Jerome Mariette's avatar
Jerome Mariette committed
39
from jflow.workflows_manager import WorkflowsManager, JFlowConfigReader
40
from jflow.parameter import *
41
from cctools.util import time_format
Jerome Mariette's avatar
Jerome Mariette committed
42
43
44
45
46
47
48
49
50
51
52
53

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
54

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

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

Jerome Mariette's avatar
Jerome Mariette committed
116
117
118
119
        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
120
            if self.stderr is None:
121
                self.set_stderr()
Jerome Mariette's avatar
Jerome Mariette committed
122
            self._serialize()
123
    
124
125
126
127
128
129
130
131
132
133
    def add_input_file(self, name, help, file_format="any", default=None, type="inputfile", 
                       required=False, flag=None, group="default", display_name=None, add_to=None):
        new_param = InputFile(name, help, flag=flag, file_format=file_format, default=default, 
                              type=type, 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
134
        else:
135
136
137
138
139
140
141
            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", 
                            required=False, flag=None, group="default", display_name=None, add_to=None):
        if default == None: default = []
        new_param = InputFileList(name, help, flag=flag, file_format=file_format, default=default, 
142
                                  type=type, required=required, group=group, display_name=display_name)
143
144
145
        # if this input should be added to a particular parameter
        if add_to:
            try:
Jerome Mariette's avatar
help ok    
Jerome Mariette committed
146
                self.__getattribute__(add_to).add_sub_parameter(new_param)
147
148
149
150
151
            except: pass
        # otherwise, add it to the class itself
        else:
            self.params_order.append(name)
            self.__setattr__(name, new_param)
152
153
            
    def add_multiple_parameter(self, name, help, required=False, flag=None, group="default", display_name=None):
154
        self.params_order.append(name)
155
156
157
158
159
160
        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)
161
162
        self.__setattr__(name, new_param)
    
163
164
    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):
165
        new_param = ParameterFactory.factory(name, help, flag=flag, default=default, type=type, choices=choices, 
166
167
168
169
170
171
172
                              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
173
        else:
174
175
176
177
178
179
180
            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, 
181
182
183
184
                                  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
185
                self.__getattribute__(add_to).add_sub_parameter(new_param)
186
187
188
189
190
191
            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
192
193
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
    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
220
    
221
222
223
    def _set_parameters(self, args):
        parameters = self.get_parameters()
        for param in parameters:
224
225
            try: args[param.name] = args[param.name].encode('ascii','ignore')
            except: pass
Frédéric Escudié's avatar
Frédéric Escudié committed
226
            if param.__class__ ==  StrParameter or param.__class__ == IntParameter or param.__class__ == FloatParameter or param.__class__ == BoolParameter or param.__class__ == DateParameter:
227
228
                if args[param.name]: default = args[param.name]
                else: default = param.default
229
                new_param = ParameterFactory.factory(param.name, param.help, default=default, type=param.type, choices=param.choices, 
230
231
232
233
                                      required=param.required, flag=param.flag, group=param.group, display_name=param.display_name)
                self.__setattr__(param.name, new_param)
            elif param.__class__ == InputFile:
                if args[param.name]:
Jerome Mariette's avatar
Jerome Mariette committed
234
                    default = param.prepare_input_file(args[param.name])
Frédéric Escudié's avatar
Frédéric Escudié committed
235
                else:
236
237
238
239
240
                    default = param.default
                new_param = InputFile(param.name, param.help, file_format=param.file_format, default=default, 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)
Jerome Mariette's avatar
Jerome Mariette committed
241
242
243
            elif param.__class__ == InputFileList and args[param.name]:
                self.__setattr__(param.name, param.prepare_input_files(args[param.name]))
            elif param.__class__ ==  ParameterList and args[param.name]:
Jerome Mariette's avatar
Jerome Mariette committed
244
                    self.__setattr__(param.name, args[param.name])
245
246
247
248
249
250
            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):
Jerome Mariette's avatar
Jerome Mariette committed
251
                        value = sub_args[sub_param.flag]
252
                    else:
Jerome Mariette's avatar
Jerome Mariette committed
253
254
255
256
257
258
                        value = sub_param.default
                    if sub_param.__class__ == InputFile:
                        value = sub_param.prepare_input_file(value)
                    elif sub_param.__class__ == InputFileList:
                        value = sub_param.prepare_input_files(value)
                    self.__getattribute__(param.name)[sub_param.name] = value
259
            elif param.__class__ == MultiParameterList:
Jerome Mariette's avatar
Jerome Mariette committed
260
                final_vals = []
261
262
263
                for sargs in args[param.name]:
                    sub_args, final_sub_args = {}, {}
                    for sarg in sargs:
Jerome Mariette's avatar
Jerome Mariette committed
264
265
266
                        sub_args[sarg[0]] = sarg[1]
                    for sub_param in param.sub_parameters:
                        if sub_args.has_key(sub_param.flag):
Jerome Mariette's avatar
Jerome Mariette committed
267
                            value = sub_args[sub_param.flag] 
Jerome Mariette's avatar
Jerome Mariette committed
268
                        else:
Jerome Mariette's avatar
Jerome Mariette committed
269
270
271
272
273
274
                            value = sub_param.default
                        if sub_param.__class__ == InputFile:
                            value = sub_param.prepare_input_file(value)
                        elif sub_param.__class__ == InputFileList:
                            value = sub_param.prepare_input_files(value)
                        final_sub_args[sub_param.name] = value
Jerome Mariette's avatar
Jerome Mariette committed
275
276
                    final_vals.append(final_sub_args)
                self.__setattr__(param.name, final_vals)
Frédéric Escudié's avatar
Frédéric Escudié committed
277

Jerome Mariette's avatar
Jerome Mariette committed
278
279
280
281
282
283
284
285
    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) ):
                    graph.add_edge({ioparameter.component_nameid, ioparameter.parent_component_nameid})
286
        return graph
Frédéric Escudié's avatar
Frédéric Escudié committed
287

288
289
290
291
292
293
294
295
296
297
298
299
    def set_stderr(self):
        if hasattr(self, "stderr") and self.stderr is not None:
            os.rename( self.stderr, os.path.join(self.directory, str(time.time()) + "wf_stderr.old") )
        stderr = os.path.join(self.directory, "wf_stderr.txt")
        logger = logging.getLogger( "wf." + str(self.id) )
        logger.setLevel(logging.DEBUG)
        formatter = logging.Formatter( '%(asctime)s :: %(message)s' )
        file_handler = FileHandler(stderr, 'a')
        file_handler.setLevel(logging.ERROR)
        file_handler.setFormatter(formatter)
        logger.addHandler(file_handler)
        self.stderr = stderr
Frédéric Escudié's avatar
Frédéric Escudié committed
300

301
    @staticmethod
302
    def config_parser(arg_lines):
303
304
        for arg in arg_lines:
            yield arg
Frédéric Escudié's avatar
Frédéric Escudié committed
305

306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
    def get_status_under_text_format(self, detailed=False, display_errors=False):
        if self.start_time: start_time = time.asctime(time.localtime(self.start_time))
        else: start_time = "-"
        if self.start_time and self.end_time: elapsed_time = str(self.end_time-self.start_time)
        elif self.start_time: elapsed_time = str(time.time()-self.start_time)
        else: elapsed_time = "-"
        if self.end_time: end_time = time.asctime(time.localtime(self.end_time))
        else: end_time = "-"
        if detailed:
            # Global
            title = "Workflow #" + utils.get_nb_string(self.id) + " (" + self.name + ") is " + \
                    self.get_status() + ", time elapsed: " + str(elapsed_time) + " (from " + start_time + \
                    " to " + end_time + ")"
            worflow_errors = ""
            error = self.get_errors()
            if error is not None:
                worflow_errors = "Workflow Error :\n  \033[91m" + error["location"] + "\n    " + "\n    ".join(error["msg"]) + "\033[0m"
            # By components
            components_errors = ""
            status = "Components Status :\n"
            for i, component in enumerate(self.get_components_nameid()):
                status_info = self.get_component_status(component)
                try: perc_waiting = (status_info["waiting"]*100.0)/status_info["tasks"]
                except: perc_waiting = 0
                try: perc_running = (status_info["running"]*100.0)/status_info["tasks"]
                except: perc_running = 0
                try: perc_failed = (status_info["failed"]*100.0)/status_info["tasks"]
                except: perc_failed = 0
                try: perc_aborted = (status_info["aborted"]*100.0)/status_info["tasks"]
                except: perc_aborted = 0
                try: perc_completed = (status_info["completed"]*100.0)/status_info["tasks"]
                except: perc_completed = 0
                
                if status_info["running"] > 0: running = "\033[94mrunning:" + str(status_info["running"]) + "\033[0m"
                else: running = "running:" + str(status_info["running"])
                if status_info["waiting"] > 0: waiting = "\033[93mwaiting:" + str(status_info["waiting"]) + "\033[0m"
                else: waiting = "waiting:" + str(status_info["waiting"])            
                if status_info["failed"] > 0: failed = "\033[91mfailed:" + str(status_info["failed"]) + "\033[0m"
                else: failed = "failed:" + str(status_info["failed"])
                if status_info["aborted"] > 0: aborted = "\033[95maborted:" + str(status_info["aborted"]) + "\033[0m"
                else: aborted = "aborted:" + str(status_info["aborted"])
                if status_info["completed"] == status_info["tasks"] and status_info["completed"] > 0: completed = "\033[92mcompleted:" + str(status_info["completed"]) + "\033[0m"
                else: completed = "completed:" + str(status_info["completed"])
                
                if display_errors and len(status_info["failed_commands"]) > 0:
                    if components_errors == "" :
                        components_errors = "Failed Commands :\n"  
                    components_errors += "  - " + component + " :\n    " + "\n    ".join(status_info["failed_commands"])
                status += "  - " + component + ", time elapsed " + time_format(status_info["time"]) + \
                    " (total:" + str(status_info["tasks"]) + ", " + waiting + ", " + running + ", " + failed + \
                    ", " + aborted + ", " + completed + ")"
                if i<len(self.get_components_nameid())-1: status += "\n"
            # Format str
            pretty_str = title
            pretty_str += ("\n" + worflow_errors) if worflow_errors != "" else ""
            pretty_str += ("\n" + status) if status != "" else ""
            pretty_str += ("\n" + components_errors) if components_errors != "" else ""
            return pretty_str
        else:
            return utils.get_nb_string(self.id) + "\t" + self.name + "\t" + self.get_status() + \
                "\t" + elapsed_time + "\t" + start_time + "\t" + end_time
    
368
    def get_errors(self):
Frédéric Escudié's avatar
Frédéric Escudié committed
369
370
371
372
373
374
        error = {
                 "title"     : "",
                 "msg"       : list(),
                 "traceback" : list()
        }
        line_idx = 0
375
376
377
        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
378
379
380
381
382
383
            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
384
                while lines[line_idx] != lines[line_idx].lstrip():
Frédéric Escudié's avatar
Frédéric Escudié committed
385
386
387
388
                    error["traceback"].append({ 
                                               "location" : lines[line_idx].strip(),
                                               "line"     : lines[line_idx].strip()
                    })
389
                    line_idx += 2
Frédéric Escudié's avatar
Frédéric Escudié committed
390
391
392
393
394
                # 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
395
396
            line_idx += 1
        FH_stderr.close()
Frédéric Escudié's avatar
Frédéric Escudié committed
397
398
399
400
401
402
        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
403
    
404
    def get_outputs_per_components(self):
405
406
        outputs_files = {}
        for current_components in self.components:
Philippe Bardou's avatar
Philippe Bardou committed
407
            #status = self.get_component_status(current_components.get_nameid())
408
            outputs_files[current_components.get_nameid()] = current_components.get_output_files()
Philippe Bardou's avatar
Philippe Bardou committed
409
            #outputs_files["0"] = status["completed"]
410
411
        return outputs_files
    
Jerome Mariette's avatar
Jerome Mariette committed
412
413
414
415
416
417
418
419
420
421
422
423
424
425
    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
    
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
    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        
        smtps, froma, toa, subject, message = self.jflow_config_reader.get_email_options()
        
        if self.__to_address: toa = self.__to_address
        if self.__subject: subject = self.__subject
        if self.__message: message = self.__message
        
        if smtps and froma:
            if not toa: toa = froma
            if validate_email(froma) and validate_email(toa):
                # 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:
                    message = self.get_status_under_text_format(True, True)
                msg = MIMEText(message)
                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)
                s.sendmail(me, [you], msg.as_string())
                s.quit()
        
466
467
468
469
    def get_parameters_per_groups(self):
        name = self.get_name()
        description = self.get_description()
        parameters = self.get_parameters()
470
471
        pgparameters, parameters_order = {}, []
        for param in parameters:
Jerome Mariette's avatar
Jerome Mariette committed
472
            if param.group not in parameters_order: parameters_order.append(param.group)
473
474
            if pgparameters.has_key(param.group):
                pgparameters[param.group].append(param)
Jerome Mariette's avatar
Jerome Mariette committed
475
            else:
476
477
                pgparameters[param.group] = [param]
        return [pgparameters, parameters_order]
Jerome Mariette's avatar
Jerome Mariette committed
478
    
479
480
481
482
483
484
485
486
    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
    
487
    def get_exec_path(self, software):
488
489
490
491
492
        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)
493
        elif exec_path is None and utils.which(software) == None:
494
495
            sys.stderr.write("Error: '" + software + "' path connot be retrieved either in the PATH and in the application.properties file!\n")
            sys.exit(1)
496
497
498
499
500
        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)
501
        return exec_path
502
    
Jerome Mariette's avatar
Jerome Mariette committed
503
504
    def add_component(self, component_name, args=[], kwargs={}, component_prefix="default"):
        # first build and check if this component is OK
505
506
507
508
509
510
511
512
        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)
513
514
            
            # there is a dynamic component
515
            if cmpt_object.is_dynamic():
516
517
518
519
                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
520
                    self.components_to_exec.append(cmpt_object)
521
                    self.components.append(cmpt_object)
522
523
524
525
526
527
528
529
530
                    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
531
                    self.components_to_exec = []
532
                    self.components = []
533
534
535
            else:
                if self.component_nameids_is_init:
                    # add the component
536
                    self.components_to_exec.append(cmpt_object)
537
                    self.components.append(cmpt_object)
538
                elif not self.component_nameids_is_init and not self.dynamic_component_present:
Jerome Mariette's avatar
Jerome Mariette committed
539
540
541
                    if self._component_is_duplicated(cmpt_object):
                        raise ValueError("Component " + cmpt_object.__class__.__name__ + " with prefix " + 
                                            cmpt_object.prefix + " already exist in this pipeline!")
542
                    self.components_to_exec.append(cmpt_object)
543
                    self.components.append(cmpt_object)
544
545
546
547
548
549
                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

550
551
            return cmpt_object
        else:
Jerome Mariette's avatar
Jerome Mariette committed
552
            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
553
554
555
556
557
558
559
560
    
    def pre_process(self):
        pass
    
    def process(self):
        """ 
        Run the workflow, has to be implemented by subclasses
        """
561
        raise NotImplementedError( "Workflow.process() must be implemented in " + self.__class__.__name__ )
562
563
564

    def get_name(self):
        """ 
565
        Return the workflow name.
566
        """
Jerome Mariette's avatar
Jerome Mariette committed
567
        return self.__class__.__name__.lower()
568
569
570
571
572
    
    def get_description(self):
        """ 
        Return the workflow description, has to be implemented by subclasses
        """
573
        raise NotImplementedError( "Workflow.get_description() must be implemented in " + self.__class__.__name__ )
574
    
575
    def define_parameters(self, function="process"):
576
577
578
        """ 
        Define the workflow parameters, has to be implemented by subclasses
        """
579
        raise NotImplementedError( "Workflow.define_parameters() must be implemented in " + self.__class__.__name__ )
Jerome Mariette's avatar
Jerome Mariette committed
580
581
582
583
584
585
586
587
588
589
590
591
592
593
    
    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
594
595
    def wf_execution_wrapper(self):
        getattr(self, self.function)()
Jerome Mariette's avatar
Jerome Mariette committed
596
    
Jerome Mariette's avatar
Jerome Mariette committed
597
598
599
600
    def run(self):
        """
        Only require for Threading
        """
601
602
603
604
605
606
607
        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
608
                self._serialize()
609
610
611
612
613
614
615
            # 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:
616
617
                try:
                    self.reseted_components = []
618
                    self.components = []
Jerome Mariette's avatar
Jerome Mariette committed
619
                    self.status = self.STATUS_STARTED
620
621
622
623
624
                    self.wf_execution_wrapper()
                except SystemExit, e: 
                    self.status = self.STATUS_FAILED
                    self.end_time = time.time()
                    self._serialize()
625
                    self._send_email()
626
627
628
629
630
631
632
633
634
635
                    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:
636
637
                try:
                    self.reseted_components = []
638
                    self.components = []
Jerome Mariette's avatar
Jerome Mariette committed
639
                    self.status = self.STATUS_STARTED
640
641
642
643
644
                    self.wf_execution_wrapper()
                except SystemExit, e: 
                    self.status = self.STATUS_FAILED
                    self.end_time = time.time()
                    self._serialize()
645
                    self._send_email()
646
647
648
                    raise
                if len(self.components_to_exec) > 0:
                    self._execute_weaver()
649
                self.step = 3
650
651
652
653
654
                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        
655
656
                self.end_time = time.time()
                self._serialize()
657
                self._send_email()
658
659
660
        except:
            logging.getLogger("wf." + str(self.id)).exception("RunWorflowException")
            raise
Jerome Mariette's avatar
Jerome Mariette committed
661
    
Jerome Mariette's avatar
Jerome Mariette committed
662
663
664
665
666
667
668
669
670
671
672
    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
673
674
675
            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
676
677
678
679
680
681
682
683
684
685
686
687
                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
    
688
689
690
    def get_resource(self, resource):
        return self.jflow_config_reader.get_resource(resource)
    
Jerome Mariette's avatar
Jerome Mariette committed
691
692
693
694
695
696
697
    def get_component_status(self, component_nameid):
        status = {"time": 0.0,
                  "tasks": 0,
                  "waiting": 0,
                  "running": 0,
                  "failed":0,
                  "aborted": 0,
698
699
                  "completed": 0,
                  "failed_commands": list() }
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
        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
723
        return status
Jerome Mariette's avatar
Jerome Mariette committed
724
    
725
726
727
728
729
730
731
732
733
734
735
    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:
            sys.stderr.write("Impossible to reset component '" + component_name + "'! This one is not part of the workflow\n")
            sys.exit(1)
736
        self.reseted_components.append(component_name)
Jerome Mariette's avatar
Jerome Mariette committed
737
        self.status = self.STATUS_RESETED
738
739
        self._serialize()
    
Jerome Mariette's avatar
Jerome Mariette committed
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
    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:
771
                        for component in self.components_to_exec:
Jerome Mariette's avatar
Jerome Mariette committed
772
                            nest.symbol = component.get_nameid()
773
                            nest.batch = component.batch_options
Jerome Mariette's avatar
Jerome Mariette committed
774
775
776
777
778
779
                            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
780
                        self.end_time = time.time()
Jerome Mariette's avatar
Jerome Mariette committed
781
                        self._serialize()
Jerome Mariette's avatar
Jerome Mariette committed
782
                        raise
783
                self.components_to_exec = []  
Jerome Mariette's avatar
Jerome Mariette committed
784
785
786
787
788
789
790
791
                # 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
792
                    raise
Jerome Mariette's avatar
Jerome Mariette committed
793
794
795

    def _get_current_make(self):
        current_component, make_directory, new_make = [], None, False
796
        for component in self.components_to_exec:
Jerome Mariette's avatar
Jerome Mariette committed
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
            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()

814
815
    def _component_is_duplicated(self, component):
        if component.get_nameid() in self.component_nameids.keys():
Jerome Mariette's avatar
Jerome Mariette committed
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
            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
832
833
834
835
836
            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
837
            except Exception as e:
Jerome Mariette's avatar
Jerome Mariette committed
838
                logging.getLogger("Workflow._import_components").debug("Component <{0}> cannot be loaded: {1}".format(modname, e))
Jerome Mariette's avatar
Jerome Mariette committed
839
840
841
        # 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
842
843
844
845
846
            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
847
848
            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
849
850
851
852
853
854
855
856
857
858
859
860
        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)