Salome HOME
compilation : show something for native products
[tools/sat.git] / commands / compile.py
1 #!/usr/bin/env python
2 #-*- coding:utf-8 -*-
3 #  Copyright (C) 2010-2012  CEA/DEN
4 #
5 #  This library is free software; you can redistribute it and/or
6 #  modify it under the terms of the GNU Lesser General Public
7 #  License as published by the Free Software Foundation; either
8 #  version 2.1 of the License.
9 #
10 #  This library is distributed in the hope that it will be useful,
11 #  but WITHOUT ANY WARRANTY; without even the implied warranty of
12 #  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13 #  Lesser General Public License for more details.
14 #
15 #  You should have received a copy of the GNU Lesser General Public
16 #  License along with this library; if not, write to the Free Software
17 #  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
18
19 import os
20
21 import src
22
23 # Compatibility python 2/3 for input function
24 # input stays input for python 3 and input = raw_input for python 2
25 try: 
26     input = raw_input
27 except NameError: 
28     pass
29
30 # Define all possible option for the compile command :  sat compile <options>
31 parser = src.options.Options()
32 parser.add_option('p', 'products', 'list2', 'products',
33     _('products to configure. This option can be'
34     ' passed several time to configure several products.'))
35 parser.add_option('', 'with_fathers', 'boolean', 'fathers',
36     _("build all necessary products to the given product (KERNEL is build before"
37       " building GUI)."), False)
38 parser.add_option('', 'with_children', 'boolean', 'children',
39     _("build all products using the given product (all SMESH plugins are build "
40       "after SMESH)."), False)
41 parser.add_option('', 'clean_all', 'boolean', 'clean_all',
42     _("clean BUILD dir and INSTALL dir before building product."), False)
43 parser.add_option('', 'clean_install', 'boolean', 'clean_install',
44     _("clean INSTALL dir before building product."), False)
45 parser.add_option('', 'make_flags', 'string', 'makeflags',
46     _("add extra options to the 'make' command."))
47 parser.add_option('', 'show', 'boolean', 'no_compile',
48     _("DO NOT COMPILE just show if products are installed or not."), False)
49 parser.add_option('', 'stop_first_fail', 'boolean', 'stop_first_fail', _("Stop"
50                     "s the command at first product compilation fail."), False)
51
52 def get_products_list(options, cfg, logger):
53     '''method that gives the product list with their informations from 
54        configuration regarding the passed options.
55     
56     :param options Options: The Options instance that stores the commands 
57                             arguments
58     :param cfg Config: The global configuration
59     :param logger Logger: The logger instance to use for the display and 
60                           logging
61     :return: The list of (product name, product_informations).
62     :rtype: List
63     '''
64     # Get the products to be prepared, regarding the options
65     if options.products is None:
66         # No options, get all products sources
67         products = cfg.APPLICATION.products
68     else:
69         # if option --products, check that all products of the command line
70         # are present in the application.
71         products = options.products
72         for p in products:
73             if p not in cfg.APPLICATION.products:
74                 raise src.SatException(_("Product %(product)s "
75                             "not defined in application %(application)s") %
76                         { 'product': p, 'application': cfg.VARS.application} )
77     
78     # Construct the list of tuple containing 
79     # the products name and their definition
80     products_infos = src.product.get_products_infos(products, cfg)
81     
82     products_infos = [pi for pi in products_infos if not(
83                                      src.product.product_is_fixed(pi[1]))]
84     
85     return products_infos
86
87 def get_children(config, p_name_p_info):
88     l_res = []
89     p_name, __ = p_name_p_info
90     # Get all products of the application
91     products = config.APPLICATION.products
92     products_infos = src.product.get_products_infos(products, config)
93     for p_name_potential_child, p_info_potential_child in products_infos:
94         if ("depend" in p_info_potential_child and 
95                 p_name in p_info_potential_child.depend):
96             l_res.append(p_name_potential_child)
97     return l_res
98
99 def get_recursive_children(config, p_name_p_info, without_native_fixed=False):
100     """ Get the recursive list of the product that depend on 
101         the product defined by prod_info
102     
103     :param config Config: The global configuration
104     :param prod_info Config: The specific config of the product
105     :param without_native_fixed boolean: If true, do not include the fixed
106                                          or native products in the result
107     :return: The list of product_informations.
108     :rtype: List
109     """
110     p_name, __ = p_name_p_info
111     # Initialization of the resulting list
112     l_children = []
113     
114     # Get the direct children (not recursive)
115     l_direct_children = get_children(config, p_name_p_info)
116     # Minimal case : no child
117     if l_direct_children == []:
118         return []
119     # Add the children and call the function to get the children of the
120     # children
121     for child_name in l_direct_children:
122         l_children_name = [pn_pi[0] for pn_pi in l_children]
123         if child_name not in l_children_name:
124             if child_name not in config.APPLICATION.products:
125                 msg = _("The product %(child_name)s that is in %(product_nam"
126                         "e)s children is not present in application "
127                         "%(appli_name)s" % {"child_name" : child_name, 
128                                     "product_name" : p_name.name, 
129                                     "appli_name" : config.VARS.application})
130                 raise src.SatException(msg)
131             prod_info_child = src.product.get_product_config(config,
132                                                               child_name)
133             pname_pinfo_child = (prod_info_child.name, prod_info_child)
134             # Do not append the child if it is native or fixed and 
135             # the corresponding parameter is called
136             if without_native_fixed:
137                 if not(src.product.product_is_native(prod_info_child) or 
138                        src.product.product_is_fixed(prod_info_child)):
139                     l_children.append(pname_pinfo_child)
140             else:
141                 l_children.append(pname_pinfo_child)
142             # Get the children of the children
143             l_grand_children = get_recursive_children(config,
144                                 pname_pinfo_child,
145                                 without_native_fixed = without_native_fixed)
146             l_children += l_grand_children
147     return l_children
148
149 def get_recursive_fathers(config, p_name_p_info, without_native_fixed=False):
150     """ Get the recursive list of the dependencies of the product defined by
151         prod_info
152     
153     :param config Config: The global configuration
154     :param prod_info Config: The specific config of the product
155     :param without_native_fixed boolean: If true, do not include the fixed
156                                          or native products in the result
157     :return: The list of product_informations.
158     :rtype: List
159     """
160     p_name, p_info = p_name_p_info
161     # Initialization of the resulting list
162     l_fathers = []
163     # Minimal case : no dependencies
164     if "depend" not in p_info or p_info.depend == []:
165         return []
166     # Add the dependencies and call the function to get the dependencies of the
167     # dependencies
168     for father_name in p_info.depend:
169         l_fathers_name = [pn_pi[0] for pn_pi in l_fathers]
170         if father_name not in l_fathers_name:
171             if father_name not in config.APPLICATION.products:
172                 msg = _("The product %(father_name)s that is in %(product_nam"
173                         "e)s dependencies is not present in application "
174                         "%(appli_name)s" % {"father_name" : father_name, 
175                                     "product_name" : p_name, 
176                                     "appli_name" : config.VARS.application})
177                 raise src.SatException(msg)
178             prod_info_father = src.product.get_product_config(config,
179                                                               father_name)
180             pname_pinfo_father = (prod_info_father.name, prod_info_father)
181             # Do not append the father if it is native or fixed and 
182             # the corresponding parameter is called
183             if without_native_fixed:
184                 if not(src.product.product_is_native(prod_info_father) or 
185                        src.product.product_is_fixed(prod_info_father)):
186                     l_fathers.append(pname_pinfo_father)
187             else:
188                 l_fathers.append(pname_pinfo_father)
189             # Get the dependencies of the dependency
190             l_grand_fathers = get_recursive_fathers(config,
191                                 pname_pinfo_father,
192                                 without_native_fixed = without_native_fixed)
193             for item in l_grand_fathers:
194                 if item not in l_fathers:
195                     l_fathers.append(item)
196     return l_fathers
197
198 def sort_products(config, p_infos):
199     """ Sort the p_infos regarding the dependencies between the products
200     
201     :param config Config: The global configuration
202     :param p_infos list: List of (str, Config) => (product_name, product_info)
203     """
204     l_prod_sorted = src.deepcopy_list(p_infos)
205     for prod in p_infos:
206         l_fathers = get_recursive_fathers(config,
207                                           prod,
208                                           without_native_fixed=True)
209         l_fathers = [father for father in l_fathers if father in p_infos]
210         if l_fathers == []:
211             continue
212         for p_sorted in l_prod_sorted:
213             if p_sorted in l_fathers:
214                 l_fathers.remove(p_sorted)
215             if l_fathers==[]:
216                 l_prod_sorted.remove(prod)
217                 l_prod_sorted.insert(l_prod_sorted.index(p_sorted)+1, prod)
218                 break
219         
220     return l_prod_sorted
221
222 def extend_with_fathers(config, p_infos):
223     p_infos_res = src.deepcopy_list(p_infos)
224     for p_name_p_info in p_infos:
225         fathers = get_recursive_fathers(config,
226                                         p_name_p_info,
227                                         without_native_fixed=True)
228         for p_name_p_info_father in fathers:
229             if p_name_p_info_father not in p_infos_res:
230                 p_infos_res.append(p_name_p_info_father)
231     return p_infos_res
232
233 def extend_with_children(config, p_infos):
234     p_infos_res = src.deepcopy_list(p_infos)
235     for p_name_p_info in p_infos:
236         children = get_recursive_children(config,
237                                         p_name_p_info,
238                                         without_native_fixed=True)
239         for p_name_p_info_child in children:
240             if p_name_p_info_child not in p_infos_res:
241                 p_infos_res.append(p_name_p_info_child)
242     return p_infos_res    
243
244 def check_dependencies(config, p_name_p_info):
245     l_depends_not_installed = []
246     fathers = get_recursive_fathers(config, p_name_p_info, without_native_fixed=True)
247     for p_name_father, p_info_father in fathers:
248         if not(src.product.check_installation(p_info_father)):
249             l_depends_not_installed.append(p_name_father)
250     return l_depends_not_installed
251
252 def log_step(logger, header, step):
253     logger.write("\r%s%s" % (header, " " * 30), 3)
254     logger.write("\r%s%s" % (header, step), 3)
255     logger.write("\n==== %s \n" % src.printcolors.printcInfo(step), 4)
256     logger.flush()
257
258 def log_res_step(logger, res):
259     if res == 0:
260         logger.write("%s \n" % src.printcolors.printcSuccess("OK"), 4)
261         logger.flush()
262     else:
263         logger.write("%s \n" % src.printcolors.printcError("KO"), 4)
264         logger.flush()
265
266 def compile_all_products(sat, config, options, products_infos, logger):
267     '''Execute the proper configuration commands 
268        in each product build directory.
269
270     :param config Config: The global configuration
271     :param products_info list: List of 
272                                  (str, Config) => (product_name, product_info)
273     :param logger Logger: The logger instance to use for the display and logging
274     :return: the number of failing commands.
275     :rtype: int
276     '''
277     res = 0
278     for p_name_info in products_infos:
279         
280         p_name, p_info = p_name_info
281         
282         # Logging
283         len_end_line = 30
284         logger.write("\n", 4, False)
285         logger.write("################ ", 4)
286         header = _("Compilation of %s") % src.printcolors.printcLabel(p_name)
287         header += " %s " % ("." * (len_end_line - len(p_name)))
288         logger.write(header, 3)
289         logger.write("\n", 4, False)
290         logger.flush()
291
292         # Do nothing if the product is not compilable
293         if ("properties" in p_info and "compilation" in p_info.properties and 
294                                             p_info.properties.compilation == "no"):
295             log_step(logger, header, "ignored")
296             logger.write("\n", 3, False)
297             continue
298
299         # Do nothing if the product is native
300         if src.product.product_is_native(p_info):
301             log_step(logger, header, "native")
302             logger.write("\n", 3, False)
303             continue
304
305         # Clean the build and the install directories 
306         # if the corresponding options was called
307         if options.clean_all:
308             log_step(logger, header, "CLEAN BUILD AND INSTALL")
309             sat.clean(config.VARS.application + 
310                       " --products " + p_name + 
311                       " --build --install", batch=True, verbose=0)
312         
313         # Clean the the install directory 
314         # if the corresponding option was called
315         if options.clean_install and not options.clean_all:
316             log_step(logger, header, "CLEAN INSTALL")
317             sat.clean(config.VARS.application + 
318                       " --products " + p_name + 
319                       " --install", batch=True, verbose=0)
320         
321         # Check if it was already successfully installed
322         if src.product.check_installation(p_info):
323             logger.write(_("Already installed\n"))
324             continue
325         
326         # If the show option was called, do not launch the compilation
327         if options.no_compile:
328             logger.write(_("Not installed\n"))
329             continue
330         
331         # Check if the dependencies are installed
332         l_depends_not_installed = check_dependencies(config, p_name_info)
333         if len(l_depends_not_installed) > 0:
334             log_step(logger, header, "")
335             logger.write(src.printcolors.printcError(
336                     _("ERROR : the following product(s) is(are) mandatory: ")))
337             for prod_name in l_depends_not_installed:
338                 logger.write(src.printcolors.printcError(prod_name + " "))
339             logger.write("\n")
340             continue
341         
342         # Call the function to compile the product
343         res_prod, len_end_line, error_step = compile_product(sat,
344                                                              p_name_info,
345                                                              config,
346                                                              options,
347                                                              logger,
348                                                              header,
349                                                              len_end_line)
350         
351         if res_prod != 0:
352             # Clean the install directory if there is any
353             logger.write(_("Cleaning the install directory if there is any\n"),
354                          5)
355             sat.clean(config.VARS.application + 
356                       " --products " + p_name + 
357                       " --install", batch=True, verbose=0)
358             res += 1
359             
360         # Log the result
361         if res_prod > 0:
362             logger.write("\r%s%s" % (header, " " * len_end_line), 3)
363             logger.write("\r" + header + src.printcolors.printcError("KO ") + error_step)
364             logger.write("\n==== %(KO)s in compile of %(name)s \n" %
365                 { "name" : p_name , "KO" : src.printcolors.printcInfo("ERROR")}, 4)
366             logger.flush()
367         else:
368             logger.write("\r%s%s" % (header, " " * len_end_line), 3)
369             logger.write("\r" + header + src.printcolors.printcSuccess("OK"))
370             logger.write(_("\nINSTALL directory = %s" % 
371                            src.printcolors.printcInfo(p_info.install_dir)), 3)
372             logger.write("\n==== %s \n" % src.printcolors.printcInfo("OK"), 4)
373             logger.write("\n==== Compilation of %(name)s %(OK)s \n" %
374                 { "name" : p_name , "OK" : src.printcolors.printcInfo("OK")}, 4)
375             logger.flush()
376         logger.write("\n", 3, False)
377         
378         
379         if res_prod != 0 and options.stop_first_fail:
380             break
381         
382     return res
383
384 def compile_product(sat, p_name_info, config, options, logger, header, len_end):
385     '''Execute the proper configuration command(s) 
386        in the product build directory.
387     
388     :param p_name_info tuple: (str, Config) => (product_name, product_info)
389     :param config Config: The global configuration
390     :param logger Logger: The logger instance to use for the display 
391                           and logging
392     :return: 1 if it fails, else 0.
393     :rtype: int
394     '''
395     
396     p_name, p_info = p_name_info
397        
398     # Execute "sat configure", "sat make" and "sat install"
399     res = 0
400     error_step = ""
401     
402     # Logging and sat command call for configure step
403     len_end_line = len_end
404     log_step(logger, header, "CONFIGURE")
405     res_c = sat.configure(config.VARS.application + " --products " + p_name,
406                           verbose = 0,
407                           logger_add_link = logger)
408     log_res_step(logger, res_c)
409     res += res_c
410     
411     if res_c > 0:
412         error_step = "CONFIGURE"
413     else:    
414         # Logging and sat command call for make step
415         # Logging take account of the fact that the product has a compilation 
416         # script or not
417         if src.product.product_has_script(p_info):
418             # if the product has a compilation script, 
419             # it is executed during make step
420             scrit_path_display = src.printcolors.printcLabel(
421                                                         p_info.compil_script)
422             log_step(logger, header, "SCRIPT " + scrit_path_display)
423             len_end_line = len(scrit_path_display)
424         else:
425             log_step(logger, header, "MAKE")
426         make_arguments = config.VARS.application + " --products " + p_name
427         # Get the make_flags option if there is any
428         if options.makeflags:
429             make_arguments += " --option -j" + options.makeflags
430         res_m = sat.make(make_arguments,
431                          verbose = 0,
432                          logger_add_link = logger)
433         log_res_step(logger, res_m)
434         res += res_m
435         
436         if res_m > 0:
437             error_step = "MAKE"
438         else: 
439             # Logging and sat command call for make install step
440             log_step(logger, header, "MAKE INSTALL")
441             res_mi = sat.makeinstall(config.VARS.application + 
442                                      " --products " + 
443                                      p_name,
444                                     verbose = 0,
445                                     logger_add_link = logger)
446
447             log_res_step(logger, res_mi)
448             res += res_mi
449             
450             if res_mi > 0:
451                 error_step = "MAKE INSTALL"
452
453     # Check that the install directory exists
454     if res==0 and not(os.path.exists(p_info.install_dir)):
455         res = 1
456         error_step = "NO INSTALL DIR"
457         msg = _("Error: despite the fact that all the steps ended successfully,"
458                 " no install directory was found !")
459         logger.write(src.printcolors.printcError(msg), 4)
460         logger.write("\n", 4)
461     
462     # Add the config file corresponding to the dependencies/versions of the 
463     # product that have been successfully compiled
464     if res==0:       
465         logger.write(_("Add the config file in installation directory\n"), 5)
466         add_compile_config_file(p_info, config)
467     
468     return res, len_end_line, error_step
469
470 def add_compile_config_file(p_info, config):
471     '''Execute the proper configuration command(s) 
472        in the product build directory.
473     
474     :param p_info Config: The specific config of the product
475     :param config Config: The global configuration
476     '''
477     # Create the compile config
478     compile_cfg = src.pyconf.Config()
479     for prod_name in p_info.depend:
480         if prod_name not in compile_cfg:
481             compile_cfg.addMapping(prod_name,
482                                    src.pyconf.Mapping(compile_cfg),
483                                    "")
484         prod_dep_info = src.product.get_product_config(config, prod_name, False)
485         compile_cfg[prod_name] = prod_dep_info.version
486     # Write it in the install directory of the product
487     compile_cfg_path = os.path.join(p_info.install_dir, src.CONFIG_FILENAME)
488     f = open(compile_cfg_path, 'w')
489     compile_cfg.__save__(f)
490     f.close()
491     
492 def description():
493     '''method that is called when salomeTools is called with --help option.
494     
495     :return: The text to display for the compile command description.
496     :rtype: str
497     '''
498     return _("The compile command constructs the products of the application")
499   
500 def run(args, runner, logger):
501     '''method that is called when salomeTools is called with compile parameter.
502     '''
503     
504     # Parse the options
505     (options, args) = parser.parse_args(args)
506
507     # Warn the user if he invoked the clean_all option 
508     # without --products option
509     if (options.clean_all and 
510         options.products is None and 
511         not runner.options.batch):
512         rep = input(_("You used --clean_all without specifying a product"
513                           " are you sure you want to continue? [Yes/No] "))
514         if rep.upper() != _("YES").upper():
515             return 0
516         
517     # check that the command has been called with an application
518     src.check_config_has_application( runner.cfg )
519
520     # Print some informations
521     logger.write(_('Executing the compile commands in the build '
522                                 'directories of the products of '
523                                 'the application %s\n') % 
524                 src.printcolors.printcLabel(runner.cfg.VARS.application), 1)
525     
526     info = [
527             (_("SOURCE directory"),
528              os.path.join(runner.cfg.APPLICATION.workdir, 'SOURCES')),
529             (_("BUILD directory"),
530              os.path.join(runner.cfg.APPLICATION.workdir, 'BUILD'))
531             ]
532     src.print_info(logger, info)
533
534     # Get the list of products to treat
535     products_infos = get_products_list(options, runner.cfg, logger)
536
537     if options.fathers:
538         # Extend the list with all recursive dependencies of the given products
539         products_infos = extend_with_fathers(runner.cfg, products_infos)
540
541     if options.children:
542         # Extend the list with all products that use the given products
543         products_infos = extend_with_children(runner.cfg, products_infos)
544
545     # Sort the list regarding the dependencies of the products
546     products_infos = sort_products(runner.cfg, products_infos)
547
548     
549     # Call the function that will loop over all the products and execute
550     # the right command(s)
551     res = compile_all_products(runner, runner.cfg, options, products_infos, logger)
552     
553     # Print the final state
554     nb_products = len(products_infos)
555     if res == 0:
556         final_status = "OK"
557     else:
558         final_status = "KO"
559    
560     logger.write(_("\nCompilation: %(status)s (%(valid_result)d/%(nb_products)d)\n") % \
561         { 'status': src.printcolors.printc(final_status), 
562           'valid_result': nb_products - res,
563           'nb_products': nb_products }, 1)    
564     
565     code = res
566     if code != 0:
567         code = 1
568     return code