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 urllib2 
Jerome Mariette's avatar
Jerome Mariette committed
29
import types
Jerome Mariette's avatar
Jerome Mariette committed
30
import logging
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
from urlparse import urlparse
Jerome Mariette's avatar
Jerome Mariette committed
36

Jerome Mariette's avatar
Jerome Mariette committed
37
import jflow
Jerome Mariette's avatar
Jerome Mariette committed
38
39
import jflow.utils as utils
from jflow.workflows_manager import WorkflowsManager, JFlowConfigReader
40
from jflow.parameter import Parameter, date, MiltipleAppendAction
Jerome Mariette's avatar
Jerome Mariette committed
41
42
43
44
45
46
47
48
49
50
51
52

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
53

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

    PROPERTIES_FILE_NAME = "workflow.properties"
    MAKEFLOW_LOG_FILE_NAME = "Makeflow.makeflowlog"
60
    DUMP_FILE_NAME = ".workflow.dump"
Jerome Mariette's avatar
Jerome Mariette committed
61
62
63
64
65
    WORKING = ".working"
    STATUS_STARTED = "started"
    STATUS_COMPLETED = "completed"
    STATUS_FAILED = "failed"
    STATUS_ABORTED = "aborted"
Jerome Mariette's avatar
Jerome Mariette committed
66

67
    def __init__(self, args={}, id=None, function= "process", parameters_section="parameters"):
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
86
        self.function = function
        self.parameters_section = parameters_section
Jerome Mariette's avatar
Jerome Mariette committed
87
        self.comp_pckg = self._import_components()
Jerome Mariette's avatar
Jerome Mariette committed
88
89
        # intruduce --log-verbose to ba able to monitor the new version of makeflow >=4.2.2
        self.engine_arguments = ' --log-verbose '
90
        self.component_nameids_is_init = False
Jerome Mariette's avatar
Jerome Mariette committed
91
92
93
        self.component_nameids = {}
        # try to parse engine arguments
        try:
94
95
            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
96
97
98
            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
99
100
        try:
            # Add config information
101
            self.name, self.description, self.parameters = self._get_from_config(self.parameters_section)
Jerome Mariette's avatar
Jerome Mariette committed
102
103
104
        except:
            raise IOError(self.__class__.__name__ + " workflow property file not found or invalid.")
        
Jerome Mariette's avatar
Jerome Mariette committed
105
        self.id = id
Jerome Mariette's avatar
Jerome Mariette committed
106
        self.args = self._extend_and_format_args(self.parameters, args)
Jerome Mariette's avatar
Jerome Mariette committed
107
        self.args = self._prepare_input_files(self.parameters, self.args)
Jerome Mariette's avatar
Jerome Mariette committed
108
        self.metadata = self.args["metadata"]
Jerome Mariette's avatar
Jerome Mariette committed
109
110
111
112
        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
113
            if self.stderr is None:
114
                self.set_stderr()
Jerome Mariette's avatar
Jerome Mariette committed
115
            self._serialize()
116
    
117
118
119
120
121
122
123
124
125
126
127
128
129
    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
    
130
    @staticmethod
131
    def config_parser(arg_lines):
132
133
        for arg in arg_lines:
            yield arg
134
    
135
    def get_errors(self):
Frédéric Escudié's avatar
Frédéric Escudié committed
136
137
138
139
140
141
        error = {
                 "title"     : "",
                 "msg"       : list(),
                 "traceback" : list()
        }
        line_idx = 0
142
143
144
        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
145
146
147
148
149
150
            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
151
                while lines[line_idx] != lines[line_idx].lstrip():
Frédéric Escudié's avatar
Frédéric Escudié committed
152
153
154
155
                    error["traceback"].append({ 
                                               "location" : lines[line_idx].strip(),
                                               "line"     : lines[line_idx].strip()
                    })
156
                    line_idx += 2
Frédéric Escudié's avatar
Frédéric Escudié committed
157
158
159
160
161
                # 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
162
163
            line_idx += 1
        FH_stderr.close()
Frédéric Escudié's avatar
Frédéric Escudié committed
164
165
166
167
168
169
        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
170
    
Philippe Bardou's avatar
Philippe Bardou committed
171
    def get_outputs_per_components(self, web_path):
172
173
        outputs_files = {}
        for current_components in self.components:
Philippe Bardou's avatar
Philippe Bardou committed
174
            #status = self.get_component_status(current_components.get_nameid())
Philippe Bardou's avatar
Philippe Bardou committed
175
            outputs_files[current_components.get_nameid()] = current_components.get_component_outputs(web_path)
Philippe Bardou's avatar
Philippe Bardou committed
176
            #outputs_files["0"] = status["completed"]
177
178
        return outputs_files
    
Jerome Mariette's avatar
Jerome Mariette committed
179
180
181
182
183
184
185
186
187
188
189
190
191
192
    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
    
193
194
195
196
    def get_parameters_per_groups(self, parameters_section="parameters"):
        name, description, parameters = self._get_from_config(parameters_section)
        pgparameters, parameters_order = {}, []
        for param in parameters:
Jerome Mariette's avatar
Jerome Mariette committed
197
            if param.group not in parameters_order: parameters_order.append(param.group)
198
199
            if pgparameters.has_key(param.group):
                pgparameters[param.group].append(param)
Jerome Mariette's avatar
Jerome Mariette committed
200
            else:
201
202
                pgparameters[param.group] = [param]
        return [pgparameters, parameters_order]
Jerome Mariette's avatar
Jerome Mariette committed
203
    
204
    def get_exec_path(self, software):
205
206
207
208
209
        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)
210
        elif exec_path is None and utils.which(software) == None:
211
212
            sys.stderr.write("Error: '" + software + "' path connot be retrieved either in the PATH and in the application.properties file!\n")
            sys.exit(1)
213
214
215
216
217
        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)
218
        return exec_path
219
    
Jerome Mariette's avatar
Jerome Mariette committed
220
221
    def add_component(self, component_name, args=[], kwargs={}, component_prefix="default"):
        # first build and check if this component is OK
222
223
224
225
226
227
228
229
        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)
230
231
            
            # there is a dynamic component
232
            if cmpt_object.is_dynamic():
233
234
235
236
                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
237
                    self.components_to_exec.append(cmpt_object)
238
                    self.components.append(cmpt_object)
239
240
241
242
243
244
245
246
247
                    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
248
                    self.components_to_exec = []
249
                    self.components = []
250
251
252
            else:
                if self.component_nameids_is_init:
                    # add the component
253
                    self.components_to_exec.append(cmpt_object)
254
                    self.components.append(cmpt_object)
255
                elif not self.component_nameids_is_init and not self.dynamic_component_present:
Jerome Mariette's avatar
Jerome Mariette committed
256
257
258
                    if self._component_is_duplicated(cmpt_object):
                        raise ValueError("Component " + cmpt_object.__class__.__name__ + " with prefix " + 
                                            cmpt_object.prefix + " already exist in this pipeline!")
259
                    self.components_to_exec.append(cmpt_object)
260
                    self.components.append(cmpt_object)
261
262
263
264
265
266
                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

267
268
            return cmpt_object
        else:
Jerome Mariette's avatar
Jerome Mariette committed
269
            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
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
    
    def pre_process(self):
        pass
    
    def process(self):
        """ 
        Run the workflow, has to be implemented by subclasses
        """
        raise NotImplementedError
    
    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
293
294
    def wf_execution_wrapper(self):
        getattr(self, self.function)()
Jerome Mariette's avatar
Jerome Mariette committed
295
    
Jerome Mariette's avatar
Jerome Mariette committed
296
297
298
299
    def run(self):
        """
        Only require for Threading
        """
300
301
302
303
304
305
306
        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
307
                self._serialize()
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
            # 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()
340
                self.step = 3
341
342
343
344
345
                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        
346
347
                self.end_time = time.time()
                self._serialize()
348
349
350
351
        except:
            logging.getLogger("wf." + str(self.id)).exception("RunWorflowException")
            raise
            
Jerome Mariette's avatar
Jerome Mariette committed
352
    
Jerome Mariette's avatar
Jerome Mariette committed
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
    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))
Jerome Mariette's avatar
Jerome Mariette committed
374
            return [file_path, True]
Jerome Mariette's avatar
Jerome Mariette committed
375
        except:
Jerome Mariette's avatar
Jerome Mariette committed
376
            return [input, False]
Jerome Mariette's avatar
Jerome Mariette committed
377
    
Jerome Mariette's avatar
Jerome Mariette committed
378
379
380
381
    def _prepare_input_files(self, parameters, args):
        kparams = {}
        for param in parameters:
            kparams[param.name] = param
Jerome Mariette's avatar
Jerome Mariette committed
382
383
        new_args = args
        for param in args.keys():
Jerome Mariette's avatar
Jerome Mariette committed
384
385
386
387
388
389
390
391
392
393
394
395
            is_uri, is_local = False, False
            # handle url inputs
            if kparams[param].type.__name__ == "inputfile" or kparams[param].type.__name__ == "urlfile":
                if args[param].__class__.__name__ == "list":
                    for i, val in enumerate(args[param]):
                        new_args[param][i], is_uri = self._download_urlfile(args[param][i])
                else:
                    new_args[param], is_uri = self._download_urlfile(args[param])
            
            # handle upload inputs
            try: is_local = os.path.isfile(args[param])
            except: is_local = False
396
            if not is_uri and not is_local and (kparams[param].type.__name__ == "inputfile" or kparams[param].type.__name__ == "browsefile"):
Jerome Mariette's avatar
Jerome Mariette committed
397
398
399
400
401
402
403
404
                if args[param].__class__.__name__ == "list":
                    for i, val in enumerate(args[param]):
                        if args[param][i]:
                            new_args[param][i] = os.path.join(self.jflow_config_reader.get_tmp_directory(), (args[param][i]))
                else:
                    if args[param]:
                        new_args[param] = os.path.join(self.jflow_config_reader.get_tmp_directory(), (args[param]))

Jerome Mariette's avatar
Jerome Mariette committed
405
406
        return new_args
    
Jerome Mariette's avatar
Jerome Mariette committed
407
    def _extend_and_format_args(self, parameters, args):
Jerome Mariette's avatar
Jerome Mariette committed
408
        extended_args = {}
Jerome Mariette's avatar
Jerome Mariette committed
409
        for param in parameters:
Jerome Mariette's avatar
Jerome Mariette committed
410
411
412
413
            try: args[param.name] = args[param.name].encode('ascii','ignore')
            except: pass
            # if this parameter has been modified by the user
            if args.has_key(param.name):
414
                if param.action == MiltipleAppendAction:
Jerome Mariette's avatar
Jerome Mariette committed
415
416
417
418
419
420
421
                    extended_args[param.name] = []
                    for arg in args[param.name]:
                        sub_hash = {}
                        for sub_param in param.sub_parameters:
                            # find the value
                            value = None
                            for values in arg:
422
423
424
                                if values[0] == sub_param.flag: 
                                    try: value = values[1].encode('ascii','ignore')
                                    except: value = values[1]
Jerome Mariette's avatar
Jerome Mariette committed
425
426
427
                            if value == None: value = sub_param.default
                            sub_hash[sub_param.name] = value
                        extended_args[param.name].append(sub_hash)
Jerome Mariette's avatar
Jerome Mariette committed
428
                # if it's an append parameter, the result should be a list
Jerome Mariette's avatar
Jerome Mariette committed
429
                elif param.action == "append":
Jerome Mariette's avatar
Jerome Mariette committed
430
431
432
433
                    if args[param.name]:
                        try: value = args[param.name].split(",") 
                        except: value = args[param.name]
                    else: value = []
Jerome Mariette's avatar
Jerome Mariette committed
434
435
436
437
438
439
440
                    extended_args[param.name] = value
                # if it's a date
                elif param.type == date:
                    if isinstance(args[param.name], str):
                        extended_args[param.name] = date(args[param.name])
                    else:
                        extended_args[param.name] = args[param.name]
441
442
                # if it's a boolean
                elif param.type == types.BooleanType:
Jerome Mariette's avatar
Jerome Mariette committed
443
                    extended_args[param.name] = args[param.name] in [True, 1, 'true', '1', 't', 'y', 'yes']
Jerome Mariette's avatar
Jerome Mariette committed
444
                elif param.type.__name__ == "MultipleParameters":
Jerome Mariette's avatar
Jerome Mariette committed
445
446
447
448
449
                    extended_args[param.name] = {}
                    for sub_param in param.sub_parameters:
                        # find the value
                        value = None
                        for values in args[param.name]:
450
451
452
                            if values[0] == sub_param.flag:
                                try: value = values[1].encode('ascii','ignore')
                                except: value = values[1]
Jerome Mariette's avatar
Jerome Mariette committed
453
454
                        if value == None: value = sub_param.default
                        extended_args[param.name][sub_param.name] = value
Jerome Mariette's avatar
Jerome Mariette committed
455
456
457
458
                else:
                    extended_args[param.name] = args[param.name]
            # otherwise use the default
            else:
Jerome Mariette's avatar
Jerome Mariette committed
459
                if param.type.__name__ == "MultipleParameters":
Jerome Mariette's avatar
Jerome Mariette committed
460
461
462
463
464
                    extended_args[param.name] = {}
                    for sub_param in param.sub_parameters:
                        extended_args[param.name][sub_param.name] = sub_param.default
                else:
                    extended_args[param.name] = param.default
Jerome Mariette's avatar
Jerome Mariette committed
465
466
        return extended_args
    
467
    def _get_from_config(self, parameters_section):
Jerome Mariette's avatar
Jerome Mariette committed
468
469
        reader = ConfigParser()
        reader.read(self._get_property_path())
470
        parameters, param_order = [], []
Jerome Mariette's avatar
Jerome Mariette committed
471
        try:
Jerome Mariette's avatar
Jerome Mariette committed
472
            params, sub_order, excludes, hash_params = {}, {}, [], {}
Jerome Mariette's avatar
Jerome Mariette committed
473
            # first grab all parameters name
474
475
            for param in reader.items(parameters_section):
                cvalue = reader.get(parameters_section, param[0])
Jerome Mariette's avatar
Jerome Mariette committed
476
                cparam = param[0].split(".")[0]
Jerome Mariette's avatar
Jerome Mariette committed
477
                ckey = ".".join(param[0].split(".")[1:])
478
479
480
481
482
                if len(ckey.split(".")) > 1:
                    if sub_order.has_key(cparam):
                        if ckey.split(".")[0] not in sub_order[cparam]: sub_order[cparam].append(ckey.split(".")[0])
                    else:
                        sub_order[cparam] =[ckey.split(".")[0]]
Jerome Mariette's avatar
Jerome Mariette committed
483
484
                if not params.has_key(cparam):
                    params[cparam] = {ckey: cvalue}
Jerome Mariette's avatar
Jerome Mariette committed
485
                else:
Jerome Mariette's avatar
Jerome Mariette committed
486
                    params[cparam][ckey] = cvalue
487
                if cparam not in param_order: param_order.append(cparam)
Jerome Mariette's avatar
Jerome Mariette committed
488
            
489
            for param_name in param_order:
Jerome Mariette's avatar
Jerome Mariette committed
490
                sub_params, current_params, sub_objs, sub_excludes, hash_sub_params = {}, {}, [], [], {}
Jerome Mariette's avatar
Jerome Mariette committed
491
492
493
                for param in params[param_name]:
                    sub_params_values = param.split(".")
                    if len(sub_params_values) == 2:
Jerome Mariette's avatar
Jerome Mariette committed
494
                        # TODO: handle exclusive for sub parameter
495
496
497
498
499
                        key = None
                        if sub_params_values[1] == "name": 
                            key = "display_name"
                        else:
                            key = sub_params_values[1]
Jerome Mariette's avatar
Jerome Mariette committed
500
501
502
503
504
505
506
507
508
509
                        if key == "exclude":
                            found = False
                            for exclude_group in sub_excludes:
                                if sub_params_values[0] in exclude_group:
                                    exclude_group.append(params[param_name][param])
                                    found = True
                                elif params[param_name][param] in exclude_group:
                                    exclude_group.append(sub_params_values[0])
                                    found = True
                            if not found: sub_excludes.append([sub_params_values[0], params[param_name][param]])
Jerome Mariette's avatar
Jerome Mariette committed
510
                        else:
Jerome Mariette's avatar
Jerome Mariette committed
511
512
513
514
515
                            if not sub_params.has_key(sub_params_values[0]):
                                sub_params[sub_params_values[0]] = {key: params[param_name][param]}
                                sub_params[sub_params_values[0]]["name"] = sub_params_values[0]
                            else:
                                sub_params[sub_params_values[0]][key] = params[param_name][param]
Jerome Mariette's avatar
Jerome Mariette committed
516
                    else:
517
                        if param == "name": current_params["display_name"] = params[param_name][param]
Jerome Mariette's avatar
Jerome Mariette committed
518
519
520
521
522
523
524
525
526
527
                        elif param == "exclude":
                            found = False
                            for exclude_group in excludes:
                                if param_name in exclude_group:
                                    exclude_group.append(params[param_name][param])
                                    found = True
                                elif params[param_name][param] in exclude_group:
                                    exclude_group.append(param_name)
                                    found = True
                            if not found: excludes.append([param_name, params[param_name][param]])
Jerome Mariette's avatar
Jerome Mariette committed
528
529
                        else: current_params[param] = params[param_name][param]
                current_params["name"] = param_name
530
531
532
                if sub_order.has_key(param_name):
                    for sub_param in sub_order[param_name]:
                        sub = Parameter(**sub_params[sub_param])
Jerome Mariette's avatar
Jerome Mariette committed
533
                        hash_sub_params[sub.name] = sub
534
                        sub_objs.append(sub)
Jerome Mariette's avatar
Jerome Mariette committed
535
536
537
538
539
                    # overwrite the group to exclude some parameters
                    for i, exclude_group in enumerate(sub_excludes):
                        group_name = "exclude-"+str(i)
                        for sparam in set(exclude_group):
                            hash_sub_params[sparam].group = group_name
Jerome Mariette's avatar
Jerome Mariette committed
540
541
                current_params["sub_parameters"] = sub_objs
                oparam = Parameter(**current_params)
Jerome Mariette's avatar
Jerome Mariette committed
542
                parameters.append(oparam)
Jerome Mariette's avatar
Jerome Mariette committed
543
544
545
546
547
548
                hash_params[oparam.name] = oparam
            # overwrite the group to exclude some parameters
            for i, exclude_group in enumerate(excludes):
                group_name = "exclude-"+str(i)
                for param in set(exclude_group):
                    hash_params[param].group = group_name
Jerome Mariette's avatar
Jerome Mariette committed
549
550
        except:
            pass
Jerome Mariette's avatar
Jerome Mariette committed
551
        # finally add the metadata parameter
Jerome Mariette's avatar
Jerome Mariette committed
552
553
        metadata = Parameter(name="metadata", flag="--metadata", help="Which metadata should be linked to this workflow", 
                             action="append", display_name="Metadata")
Jerome Mariette's avatar
Jerome Mariette committed
554
        parameters.append(metadata)
Jerome Mariette's avatar
Jerome Mariette committed
555
556
557
558
        return [reader.get("global", "name"),
                reader.get("global", "description"),
                parameters]
    
Jerome Mariette's avatar
Jerome Mariette committed
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
    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
    
583
584
585
    def get_resource(self, resource):
        return self.jflow_config_reader.get_resource(resource)
    
Jerome Mariette's avatar
Jerome Mariette committed
586
587
588
589
590
591
592
    def get_component_status(self, component_nameid):
        status = {"time": 0.0,
                  "tasks": 0,
                  "waiting": 0,
                  "running": 0,
                  "failed":0,
                  "aborted": 0,
593
594
                  "completed": 0,
                  "failed_commands": list() }
Jerome Mariette's avatar
Jerome Mariette committed
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
        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
611
                        status["failed_commands"].append( n.command )
Jerome Mariette's avatar
Jerome Mariette committed
612
613
614
615
616
                    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
617
        return status
Jerome Mariette's avatar
Jerome Mariette committed
618
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
    
    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:
650
                        for component in self.components_to_exec:
Jerome Mariette's avatar
Jerome Mariette committed
651
                            nest.symbol = component.get_nameid()
652
                            nest.batch = component.batch_options
Jerome Mariette's avatar
Jerome Mariette committed
653
654
655
656
657
658
                            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
659
                        self.end_time = time.time()
Jerome Mariette's avatar
Jerome Mariette committed
660
                        self._serialize()
Jerome Mariette's avatar
Jerome Mariette committed
661
                        raise
662
                self.components_to_exec = []  
Jerome Mariette's avatar
Jerome Mariette committed
663
664
665
666
667
668
669
670
                # 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
671
                    raise
Jerome Mariette's avatar
Jerome Mariette committed
672
673
674

    def _get_current_make(self):
        current_component, make_directory, new_make = [], None, False
675
        for component in self.components_to_exec:
Jerome Mariette's avatar
Jerome Mariette committed
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
            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()

693
694
    def _component_is_duplicated(self, component):
        if component.get_nameid() in self.component_nameids.keys():
Jerome Mariette's avatar
Jerome Mariette committed
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
            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
711
712
713
714
715
            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
716
            except Exception as e:
Jerome Mariette's avatar
Jerome Mariette committed
717
                logging.getLogger("Workflow._import_components").debug("Component <{0}> cannot be loaded: {1}".format(modname, e))
Jerome Mariette's avatar
Jerome Mariette committed
718
719
720
        # 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
721
722
723
724
725
            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
726
727
            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
728
729
730
731
732
733
734
735
736
737
738
739
        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)