workflow.py 30.3 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 ConfigParser import ConfigParser, NoOptionError
Jerome Mariette's avatar
Jerome Mariette committed
33
from inspect import getcallargs
Jerome Mariette's avatar
Jerome Mariette committed
34
from urlparse import urlparse
Jerome Mariette's avatar
Jerome Mariette committed
35

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

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

Jerome Mariette's avatar
Jerome Mariette committed
52

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

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

66
    def __init__(self, args={}, id=None, function= "process", parameters_section="parameters"):
Jerome Mariette's avatar
Jerome Mariette committed
67
68
69
70
71
72
        """ 
        """
        # define as a thread
        threading.Thread.__init__(self)
        self.jflow_config_reader = JFlowConfigReader()
        self.manager = WorkflowsManager()
73
        self.components_to_exec = []
74
        self.components = []
Jerome Mariette's avatar
Jerome Mariette committed
75
76
77
78
79
80
        self.makes = {}
        self.globals = {}
        self.options = Options()
        self.status = self.STATUS_STARTED
        self.start_time = None
        self.end_time = None
81
        self.step = None
82
        self.dynamic_component_present = False
83
84
        self.function = function
        self.parameters_section = parameters_section
Jerome Mariette's avatar
Jerome Mariette committed
85
86
        self.comp_pckg = self._import_components()
        self.engine_arguments = ''
87
        self.component_nameids_is_init = False
Jerome Mariette's avatar
Jerome Mariette committed
88
89
90
        self.component_nameids = {}
        # try to parse engine arguments
        try:
91
92
            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
93
94
95
            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
96
97
        try:
            # Add config information
98
            self.name, self.description, self.parameters = self._get_from_config(self.parameters_section)
Jerome Mariette's avatar
Jerome Mariette committed
99
100
101
        except:
            raise IOError(self.__class__.__name__ + " workflow property file not found or invalid.")
        
Jerome Mariette's avatar
Jerome Mariette committed
102
        self.id = id
Jerome Mariette's avatar
Jerome Mariette committed
103
        self.args = self._extend_and_format_args(self.parameters, args)
Jerome Mariette's avatar
Jerome Mariette committed
104
        self.args = self._prepare_input_files(self.args)
Jerome Mariette's avatar
Jerome Mariette committed
105
        self.metadata = self.args["metadata"]
Jerome Mariette's avatar
Jerome Mariette committed
106
107
108
109
110
        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)
            self._serialize()
111
112
    
    @staticmethod
113
    def config_parser(arg_lines):
114
115
        for arg in arg_lines:
            yield arg
116
    
117
118
119
    def get_outputs_per_components(self):
        outputs_files = {}
        for current_components in self.components:
Philippe Bardou's avatar
Philippe Bardou committed
120
            #status = self.get_component_status(current_components.get_nameid())
121
            outputs_files[current_components.get_nameid()] = current_components.get_component_outputs()
Philippe Bardou's avatar
Philippe Bardou committed
122
            #outputs_files["0"] = status["completed"]
123
124
        return outputs_files
    
Jerome Mariette's avatar
Jerome Mariette committed
125
126
127
128
129
130
131
132
133
134
135
136
137
138
    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
    
139
140
141
142
    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
143
            if param.group not in parameters_order: parameters_order.append(param.group)
144
145
            if pgparameters.has_key(param.group):
                pgparameters[param.group].append(param)
Jerome Mariette's avatar
Jerome Mariette committed
146
            else:
147
148
                pgparameters[param.group] = [param]
        return [pgparameters, parameters_order]
Jerome Mariette's avatar
Jerome Mariette committed
149
    
150
    def get_exec_path(self, software):
151
152
153
154
155
        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)
156
        elif exec_path is None and utils.which(software) == None:
157
158
            sys.stderr.write("Error: '" + software + "' path connot be retrieved either in the PATH and in the application.properties file!\n")
            sys.exit(1)
159
160
161
162
163
        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)
164
        return exec_path
165
    
Jerome Mariette's avatar
Jerome Mariette committed
166
167
    def add_component(self, component_name, args=[], kwargs={}, component_prefix="default"):
        # first build and check if this component is OK
168
169
170
171
172
173
174
175
        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)
176
177
            
            # there is a dynamic component
178
            if cmpt_object.is_dynamic():
179
180
181
182
                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
183
                    self.components_to_exec.append(cmpt_object)
184
                    self.components.append(cmpt_object)
185
186
187
188
189
190
191
192
193
                    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
194
                    self.components_to_exec = []
195
                    self.components = []
196
197
198
            else:
                if self.component_nameids_is_init:
                    # add the component
199
                    self.components_to_exec.append(cmpt_object)
200
                    self.components.append(cmpt_object)
201
                elif not self.component_nameids_is_init and not self.dynamic_component_present:
Jerome Mariette's avatar
Jerome Mariette committed
202
203
204
                    if self._component_is_duplicated(cmpt_object):
                        raise ValueError("Component " + cmpt_object.__class__.__name__ + " with prefix " + 
                                            cmpt_object.prefix + " already exist in this pipeline!")
205
                    self.components_to_exec.append(cmpt_object)
206
                    self.components.append(cmpt_object)
207
208
209
210
211
212
                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

213
214
            return cmpt_object
        else:
Jerome Mariette's avatar
Jerome Mariette committed
215
            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
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
    
    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"):
        # first check if tmp directory exists
        if not os.path.isdir(self.jflow_config_reader.get_tmp_directory()):
            os.makedirs(self.jflow_config_reader.get_tmp_directory(), 0751)
        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
242
243
    def wf_execution_wrapper(self):
        getattr(self, self.function)()
Jerome Mariette's avatar
Jerome Mariette committed
244
    
Jerome Mariette's avatar
Jerome Mariette committed
245
246
247
248
    def run(self):
        """
        Only require for Threading
        """
Jerome Mariette's avatar
Jerome Mariette committed
249
        # if this is the first time the workflow run
250
        if self.step == None :
Jerome Mariette's avatar
Jerome Mariette committed
251
            self.start_time = time.time()
252
253
            self.step = 0
            self.status = self.STATUS_STARTED
254
            self.end_time = None
255
256
257
258
259
260
            self._serialize()
        # if pre_processing has not been done yet    
        if self.step == 0:
            self.pre_process()
            self.step = 1
            self._serialize()
261
        # if collecting components and running workflow has not been done yet
262
        if self.step == 1:
263
            try: 
Jerome Mariette's avatar
Jerome Mariette committed
264
                self.wf_execution_wrapper()
265
266
267
268
269
270
271
272
273
274
275
276
277
278
            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:
279
            try: 
Jerome Mariette's avatar
Jerome Mariette committed
280
                self.wf_execution_wrapper()
281
282
283
284
285
            except SystemExit, e: 
                self.status = self.STATUS_FAILED
                self.end_time = time.time()
                self._serialize()
                raise
286
            if len(self.components_to_exec) > 0:
287
                self._execute_weaver()
288
            self.step = 3
289
290
            self._serialize()    
        # if post processing has ne been done yet
291
        if self.step == 3:
292
293
            self.post_process()
            if self.status == self.STATUS_STARTED: self.status = self.STATUS_COMPLETED        
Jerome Mariette's avatar
Jerome Mariette committed
294
295
            self.end_time = time.time()
            self._serialize()
Jerome Mariette's avatar
Jerome Mariette committed
296
    
Jerome Mariette's avatar
Jerome Mariette committed
297
298
299
300
301
302
303
304
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
    def _download_urlfile(self, input):
        try:
            uri_object = urlparse(input)
            opener = urllib2.urlopen(input)
            block_size = 8000
            jflowconf = JFlowConfigReader()
            tmp_directory = os.path.join(jflowconf.get_tmp_directory(), os.path.basename(tempfile.NamedTemporaryFile().name))
            os.mkdir(tmp_directory) 
            file_path = os.path.join(tmp_directory, os.path.basename(uri_object.path))
            local_file = open(file_path, 'wb')
            if os.path.basename(uri_object.path) is not None and os.path.basename(uri_object.path) != "":
                metadata = opener.info()
                file_size = int(metadata.getheaders("Content-Length")[0])
                while True:
                    buffer = opener.read(block_size)
                    # End of download
                    if not buffer: break
                    # Parts of download
                    local_file.write(buffer)
                local_file.close()
                logging.getLogger("types.urlfile").debug("URL file '{0}' successfully downloaded as: {1}".format(input, file_path))
            return file_path
        except:
            return input
    
    def _prepare_input_files(self, args):
        new_args = args
        for param in args.keys():
            if args[param].__class__.__name__ == "list":
                for i, val in enumerate(args[param]):
                    new_args[param][i] = self._download_urlfile(args[param][i])
            else:
                new_args[param] = self._download_urlfile(args[param])
        return new_args
    
Jerome Mariette's avatar
Jerome Mariette committed
332
    def _extend_and_format_args(self, parameters, args):
Jerome Mariette's avatar
Jerome Mariette committed
333
        extended_args = {}
Jerome Mariette's avatar
Jerome Mariette committed
334
        for param in parameters:
Jerome Mariette's avatar
Jerome Mariette committed
335
336
337
338
            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):
339
                if param.action == MiltipleAppendAction:
Jerome Mariette's avatar
Jerome Mariette committed
340
341
342
343
344
345
346
                    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:
347
348
349
                                if values[0] == sub_param.flag: 
                                    try: value = values[1].encode('ascii','ignore')
                                    except: value = values[1]
Jerome Mariette's avatar
Jerome Mariette committed
350
351
352
                            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
353
                # if it's an append parameter, the result should be a list
Jerome Mariette's avatar
Jerome Mariette committed
354
                elif param.action == "append":
Jerome Mariette's avatar
Jerome Mariette committed
355
356
357
358
                    if args[param.name]:
                        try: value = args[param.name].split(",") 
                        except: value = args[param.name]
                    else: value = []
Jerome Mariette's avatar
Jerome Mariette committed
359
360
361
362
363
364
365
                    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]
366
367
                # if it's a boolean
                elif param.type == types.BooleanType:
Jerome Mariette's avatar
Jerome Mariette committed
368
                    extended_args[param.name] = args[param.name] in [True, 1, 'true', '1', 't', 'y', 'yes']
Jerome Mariette's avatar
Jerome Mariette committed
369
                elif param.type.__name__ == "MultipleParameters":
Jerome Mariette's avatar
Jerome Mariette committed
370
371
372
373
374
                    extended_args[param.name] = {}
                    for sub_param in param.sub_parameters:
                        # find the value
                        value = None
                        for values in args[param.name]:
375
376
377
                            if values[0] == sub_param.flag:
                                try: value = values[1].encode('ascii','ignore')
                                except: value = values[1]
Jerome Mariette's avatar
Jerome Mariette committed
378
379
                        if value == None: value = sub_param.default
                        extended_args[param.name][sub_param.name] = value
Jerome Mariette's avatar
Jerome Mariette committed
380
381
382
383
                else:
                    extended_args[param.name] = args[param.name]
            # otherwise use the default
            else:
Jerome Mariette's avatar
Jerome Mariette committed
384
                if param.type.__name__ == "MultipleParameters":
Jerome Mariette's avatar
Jerome Mariette committed
385
386
387
388
389
                    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
390
391
        return extended_args
    
392
    def _get_from_config(self, parameters_section):
Jerome Mariette's avatar
Jerome Mariette committed
393
394
        reader = ConfigParser()
        reader.read(self._get_property_path())
395
        parameters, param_order = [], []
Jerome Mariette's avatar
Jerome Mariette committed
396
        try:
Jerome Mariette's avatar
Jerome Mariette committed
397
            params, sub_order, excludes, hash_params = {}, {}, [], {}
Jerome Mariette's avatar
Jerome Mariette committed
398
            # first grab all parameters name
399
400
            for param in reader.items(parameters_section):
                cvalue = reader.get(parameters_section, param[0])
Jerome Mariette's avatar
Jerome Mariette committed
401
                cparam = param[0].split(".")[0]
Jerome Mariette's avatar
Jerome Mariette committed
402
                ckey = ".".join(param[0].split(".")[1:])
403
404
405
406
407
                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
408
409
                if not params.has_key(cparam):
                    params[cparam] = {ckey: cvalue}
Jerome Mariette's avatar
Jerome Mariette committed
410
                else:
Jerome Mariette's avatar
Jerome Mariette committed
411
                    params[cparam][ckey] = cvalue
412
                if cparam not in param_order: param_order.append(cparam)
Jerome Mariette's avatar
Jerome Mariette committed
413
            
414
            for param_name in param_order:
Jerome Mariette's avatar
Jerome Mariette committed
415
                sub_params, current_params, sub_objs, sub_excludes, hash_sub_params = {}, {}, [], [], {}
Jerome Mariette's avatar
Jerome Mariette committed
416
417
418
                for param in params[param_name]:
                    sub_params_values = param.split(".")
                    if len(sub_params_values) == 2:
Jerome Mariette's avatar
Jerome Mariette committed
419
                        # TODO: handle exclusive for sub parameter
420
421
422
423
424
                        key = None
                        if sub_params_values[1] == "name": 
                            key = "display_name"
                        else:
                            key = sub_params_values[1]
Jerome Mariette's avatar
Jerome Mariette committed
425
426
427
428
429
430
431
432
433
434
                        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
435
                        else:
Jerome Mariette's avatar
Jerome Mariette committed
436
437
438
439
440
                            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
441
                    else:
442
                        if param == "name": current_params["display_name"] = params[param_name][param]
Jerome Mariette's avatar
Jerome Mariette committed
443
444
445
446
447
448
449
450
451
452
                        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
453
454
                        else: current_params[param] = params[param_name][param]
                current_params["name"] = param_name
455
456
457
                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
458
                        hash_sub_params[sub.name] = sub
459
                        sub_objs.append(sub)
Jerome Mariette's avatar
Jerome Mariette committed
460
461
462
463
464
                    # 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
465
466
                current_params["sub_parameters"] = sub_objs
                oparam = Parameter(**current_params)
Jerome Mariette's avatar
Jerome Mariette committed
467
                parameters.append(oparam)
Jerome Mariette's avatar
Jerome Mariette committed
468
469
470
471
472
473
                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
474
475
        except:
            pass
Jerome Mariette's avatar
Jerome Mariette committed
476
        # finally add the metadata parameter
Jerome Mariette's avatar
Jerome Mariette committed
477
478
        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
479
        parameters.append(metadata)
Jerome Mariette's avatar
Jerome Mariette committed
480
481
482
483
        return [reader.get("global", "name"),
                reader.get("global", "description"),
                parameters]
    
Jerome Mariette's avatar
Jerome Mariette committed
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
    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
    
508
509
510
    def get_resource(self, resource):
        return self.jflow_config_reader.get_resource(resource)
    
Jerome Mariette's avatar
Jerome Mariette committed
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
    def get_component_status(self, component_nameid):
        status = {"time": 0.0,
                  "tasks": 0,
                  "waiting": 0,
                  "running": 0,
                  "failed":0,
                  "aborted": 0,
                  "completed": 0}
        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
                    elif n.state == Node.ABORTED:
                        status["aborted"] += 1
                    elif n.state == Node.COMPLETED:
                        status["completed"] += 1
        except: pass
        return status        
    
    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:
573
                        for component in self.components_to_exec:
Jerome Mariette's avatar
Jerome Mariette committed
574
                            nest.symbol = component.get_nameid()
575
                            nest.batch = component.batch_options
Jerome Mariette's avatar
Jerome Mariette committed
576
577
578
579
580
581
                            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
582
                        self.end_time = time.time()
Jerome Mariette's avatar
Jerome Mariette committed
583
                        self._serialize()
Jerome Mariette's avatar
Jerome Mariette committed
584
                        raise
585
                self.components_to_exec = []  
Jerome Mariette's avatar
Jerome Mariette committed
586
587
588
589
590
591
592
593
                # 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
594
                    raise
Jerome Mariette's avatar
Jerome Mariette committed
595
596
597

    def _get_current_make(self):
        current_component, make_directory, new_make = [], None, False
598
        for component in self.components_to_exec:
Jerome Mariette's avatar
Jerome Mariette committed
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
            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()

616
617
    def _component_is_duplicated(self, component):
        if component.get_nameid() in self.component_nameids.keys():
Jerome Mariette's avatar
Jerome Mariette committed
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
            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
634
635
636
637
638
            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
639
            except Exception as e:
Jerome Mariette's avatar
Jerome Mariette committed
640
                logging.getLogger("Workflow._import_components").debug("Component <{0}> cannot be loaded: {1}".format(modname, e))
Jerome Mariette's avatar
Jerome Mariette committed
641
642
643
        # 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
644
645
646
647
648
            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
649
650
            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
651
652
653
654
655
656
657
658
659
660
661
662
        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)