import os
import src
+import src.debug as DBG
# Compatibility python 2/3 for input function
# input stays input for python 3 and input = raw_input for python 2
# Define all possible option for the compile command : sat compile <options>
parser = src.options.Options()
parser.add_option('p', 'products', 'list2', 'products',
- _('products to configure. This option can be'
- ' passed several time to configure several products.'))
+ _('Optional: products to compile. This option can be'
+ ' passed several time to compile several products.'))
parser.add_option('', 'with_fathers', 'boolean', 'fathers',
- _("build all necessary products to the given product (KERNEL is build before"
- " building GUI)."), False)
+ _("Optional: build all necessary products to the given product (KERNEL is "
+ "build before building GUI)."), False)
parser.add_option('', 'with_children', 'boolean', 'children',
- _("build all products using the given product (all SMESH plugins are build "
- "after SMESH)."), False)
+ _("Optional: build all products using the given product (all SMESH plugins"
+ " are build after SMESH)."), False)
parser.add_option('', 'clean_all', 'boolean', 'clean_all',
- _("clean BUILD dir and INSTALL dir before building product."), False)
+ _("Optional: clean BUILD dir and INSTALL dir before building product."),
+ False)
parser.add_option('', 'clean_install', 'boolean', 'clean_install',
- _("clean INSTALL dir before building product."), False)
+ _("Optional: clean INSTALL dir before building product."), False)
parser.add_option('', 'make_flags', 'string', 'makeflags',
- _("add extra options to the 'make' command."))
+ _("Optional: add extra options to the 'make' command."))
parser.add_option('', 'show', 'boolean', 'no_compile',
- _("DO NOT COMPILE just show if products are installed or not."), False)
-parser.add_option('', 'stop_first_fail', 'boolean', 'stop_first_fail', _("Stop"
- "s the command at first product compilation fail."), False)
+ _("Optional: DO NOT COMPILE just show if products are installed or not."),
+ False)
+parser.add_option('', 'stop_first_fail', 'boolean', 'stop_first_fail', _(
+ "Optional: Stops the command at first product compilation"
+ " fail."), False)
+parser.add_option('', 'check', 'boolean', 'check', _(
+ "Optional: execute the unit tests after compilation"), False)
+
+parser.add_option('', 'clean_build_after', 'boolean', 'clean_build_after',
+ _('Optional: remove the build directory after successful compilation'), False)
def get_products_list(options, cfg, logger):
'''method that gives the product list with their informations from
products_infos = src.product.get_products_infos(products, cfg)
products_infos = [pi for pi in products_infos if not(
- src.product.product_is_native(pi[1]) or
src.product.product_is_fixed(pi[1]))]
return products_infos
msg = _("The product %(father_name)s that is in %(product_nam"
"e)s dependencies is not present in application "
"%(appli_name)s" % {"father_name" : father_name,
- "product_name" : p_name.name,
+ "product_name" : p_name,
"appli_name" : config.VARS.application})
raise src.SatException(msg)
prod_info_father = src.product.get_product_config(config,
l_grand_fathers = get_recursive_fathers(config,
pname_pinfo_father,
without_native_fixed = without_native_fixed)
- l_fathers += l_grand_fathers
+ for item in l_grand_fathers:
+ if item not in l_fathers:
+ l_fathers.append(item)
return l_fathers
def sort_products(config, p_infos):
:param config Config: The global configuration
:param p_infos list: List of (str, Config) => (product_name, product_info)
"""
- l_prod_sorted = deepcopy_list(p_infos)
+ l_prod_sorted = src.deepcopy_list(p_infos)
for prod in p_infos:
l_fathers = get_recursive_fathers(config,
prod,
break
return l_prod_sorted
-
-def deepcopy_list(input_list):
- """ Do a deep copy of a list
-
- :param input_list List: The list to copy
- :return: The copy of the list
- :rtype: List
- """
- res = []
- for elem in input_list:
- res.append(elem)
- return res
def extend_with_fathers(config, p_infos):
- p_infos_res = deepcopy_list(p_infos)
+ p_infos_res = src.deepcopy_list(p_infos)
for p_name_p_info in p_infos:
fathers = get_recursive_fathers(config,
p_name_p_info,
return p_infos_res
def extend_with_children(config, p_infos):
- p_infos_res = deepcopy_list(p_infos)
+ p_infos_res = src.deepcopy_list(p_infos)
for p_name_p_info in p_infos:
children = get_recursive_children(config,
p_name_p_info,
p_infos_res.append(p_name_p_info_child)
return p_infos_res
+def check_dependencies(config, p_name_p_info):
+ l_depends_not_installed = []
+ fathers = get_recursive_fathers(config, p_name_p_info, without_native_fixed=True)
+ for p_name_father, p_info_father in fathers:
+ if not(src.product.check_installation(p_info_father)):
+ l_depends_not_installed.append(p_name_father)
+ return l_depends_not_installed
+
def log_step(logger, header, step):
logger.write("\r%s%s" % (header, " " * 30), 3)
logger.write("\r%s%s" % (header, step), 3)
p_name, p_info = p_name_info
# Logging
+ len_end_line = 30
logger.write("\n", 4, False)
logger.write("################ ", 4)
header = _("Compilation of %s") % src.printcolors.printcLabel(p_name)
- header += " %s " % ("." * (30 - len(p_name)))
+ header += " %s " % ("." * (len_end_line - len(p_name)))
logger.write(header, 3)
logger.write("\n", 4, False)
logger.flush()
-
+
+ # Do nothing if the product is not compilable
+ if ("properties" in p_info and
+ "compilation" in p_info.properties and
+ p_info.properties.compilation == "no"):
+
+ log_step(logger, header, "ignored")
+ logger.write("\n", 3, False)
+ continue
+
+ # Do nothing if the product is native
+ if src.product.product_is_native(p_info):
+ log_step(logger, header, "native")
+ logger.write("\n", 3, False)
+ continue
+
# Clean the build and the install directories
# if the corresponding options was called
if options.clean_all:
- log_step(logger, header, "CLEAN BUILD AND INSTALL")
+ log_step(logger, header, "CLEAN BUILD AND INSTALL ")
sat.clean(config.VARS.application +
" --products " + p_name +
- " --build --install", batch=True, verbose=0)
+ " --build --install",
+ batch=True,
+ verbose=0,
+ logger_add_link = logger)
# Clean the the install directory
# if the corresponding option was called
if options.clean_install and not options.clean_all:
- log_step(logger, header, "CLEAN INSTALL")
+ log_step(logger, header, "CLEAN INSTALL ")
sat.clean(config.VARS.application +
" --products " + p_name +
- " --install", batch=True, verbose=0)
+ " --install",
+ batch=True,
+ verbose=0,
+ logger_add_link = logger)
+
+ # Recompute the product information to get the right install_dir
+ # (it could change if there is a clean of the install directory)
+ p_info = src.product.get_product_config(config, p_name)
+
+ # Check if sources was already successfully installed
+ check_source = src.product.check_source(p_info)
+ if not check_source:
+ logger.write(_("Sources of product not found (try 'sat -h prepare') \n"))
+ res += 1 #BUG
+ continue
+
+ if src.product.product_is_salome(p_info):
+ # For salome modules, we check if the sources of configuration modules are present
+ # configuration modules have the property "configure_dependency"
+
+ # get the list of all modules in application
+ all_products_infos = src.product.get_products_infos(config.APPLICATION.products,
+ config)
+ check_source = True
+ # for configuration modules, check if sources are present
+ for product_name, product_info in all_products_infos:
+ if ("properties" in product_info and
+ "configure_dependency" in product_info.properties and
+ product_info.properties.configure_dependency == "yes"):
+ check_source = check_source and src.product.check_source(product_info)
+ if not check_source:
+ logger.write(_("\nERROR : SOURCES of %s not found! It is required for"
+ " the configuration\n" % product_name))
+ logger.write(_(" Get it with the command : sat prepare %s -p %s \n" %
+ (config.APPLICATION.name, product_name)))
+ if not check_source:
+ # if at least one configuration module is not present, we stop compilation
+ res += 1
+ continue
# Check if it was already successfully installed
if src.product.check_installation(p_info):
logger.write(_("Already installed\n"))
continue
+ # If the show option was called, do not launch the compilation
if options.no_compile:
logger.write(_("Not installed\n"))
continue
- res_prod = compile_product(sat, p_name_info, config, options, logger, header)
+ # Check if the dependencies are installed
+ l_depends_not_installed = check_dependencies(config, p_name_info)
+ if len(l_depends_not_installed) > 0:
+ log_step(logger, header, "")
+ logger.write(src.printcolors.printcError(
+ _("ERROR : the following product(s) is(are) mandatory: ")))
+ for prod_name in l_depends_not_installed:
+ logger.write(src.printcolors.printcError(prod_name + " "))
+ logger.write("\n")
+ continue
+
+ # Call the function to compile the product
+ res_prod, len_end_line, error_step = compile_product(
+ sat, p_name_info, config, options, logger, header, len_end_line)
+
if res_prod != 0:
res += 1
- if options.stop_first_fail:
- break
+ if error_step != "CHECK":
+ # Clean the install directory if there is any
+ logger.write(_(
+ "Cleaning the install directory if there is any\n"),
+ 5)
+ sat.clean(config.VARS.application +
+ " --products " + p_name +
+ " --install",
+ batch=True,
+ verbose=0,
+ logger_add_link = logger)
+ else:
+ # Clean the build directory if the compilation and tests succeed
+ if options.clean_build_after:
+ log_step(logger, header, "CLEAN BUILD")
+ sat.clean(config.VARS.application +
+ " --products " + p_name +
+ " --build",
+ batch=True,
+ verbose=0,
+ logger_add_link = logger)
+
+ # Log the result
+ if res_prod > 0:
+ logger.write("\r%s%s" % (header, " " * len_end_line), 3)
+ logger.write("\r" + header + src.printcolors.printcError("KO ") + error_step)
+ logger.write("\n==== %(KO)s in compile of %(name)s \n" %
+ { "name" : p_name , "KO" : src.printcolors.printcInfo("ERROR")}, 4)
+ if error_step == "CHECK":
+ logger.write(_("\nINSTALL directory = %s" %
+ src.printcolors.printcInfo(p_info.install_dir)), 3)
+ logger.flush()
+ else:
+ logger.write("\r%s%s" % (header, " " * len_end_line), 3)
+ logger.write("\r" + header + src.printcolors.printcSuccess("OK"))
+ logger.write(_("\nINSTALL directory = %s" %
+ src.printcolors.printcInfo(p_info.install_dir)), 3)
+ logger.write("\n==== %s \n" % src.printcolors.printcInfo("OK"), 4)
+ logger.write("\n==== Compilation of %(name)s %(OK)s \n" %
+ { "name" : p_name , "OK" : src.printcolors.printcInfo("OK")}, 4)
+ logger.flush()
+ logger.write("\n", 3, False)
+
+
+ if res_prod != 0 and options.stop_first_fail:
+ break
+
return res
-def compile_product(sat, p_name_info, config, options, logger, header):
+def compile_product(sat, p_name_info, config, options, logger, header, len_end):
'''Execute the proper configuration command(s)
in the product build directory.
:param config Config: The global configuration
:param logger Logger: The logger instance to use for the display
and logging
+ :param header Str: the header to display when logging
+ :param len_end Int: the lenght of the the end of line (used in display)
:return: 1 if it fails, else 0.
:rtype: int
'''
p_name, p_info = p_name_info
-
+
+ # Get the build procedure from the product configuration.
+ # It can be :
+ # build_sources : autotools -> build_configure, configure, make, make install
+ # build_sources : cmake -> cmake, make, make install
+ # build_sources : script -> script executions
+ res = 0
+ if (src.product.product_is_autotools(p_info) or
+ src.product.product_is_cmake(p_info)):
+ res, len_end_line, error_step = compile_product_cmake_autotools(sat,
+ p_name_info,
+ config,
+ options,
+ logger,
+ header,
+ len_end)
+ if src.product.product_has_script(p_info):
+ res, len_end_line, error_step = compile_product_script(sat,
+ p_name_info,
+ config,
+ options,
+ logger,
+ header,
+ len_end)
+
+ # Check that the install directory exists
+ if res==0 and not(os.path.exists(p_info.install_dir)):
+ res = 1
+ error_step = "NO INSTALL DIR"
+ msg = _("Error: despite the fact that all the steps ended successfully,"
+ " no install directory was found !")
+ logger.write(src.printcolors.printcError(msg), 4)
+ logger.write("\n", 4)
+ return res, len_end, error_step
+
+ # Add the config file corresponding to the dependencies/versions of the
+ # product that have been successfully compiled
+ if res==0:
+ logger.write(_("Add the config file in installation directory\n"), 5)
+ add_compile_config_file(p_info, config)
+
+ if options.check:
+ # Do the unit tests (call the check command)
+ log_step(logger, header, "CHECK")
+ res_check = sat.check(
+ config.VARS.application + " --products " + p_name,
+ verbose = 0,
+ logger_add_link = logger)
+ if res_check != 0:
+ error_step = "CHECK"
+
+ res += res_check
+
+ return res, len_end_line, error_step
+
+def compile_product_cmake_autotools(sat,
+ p_name_info,
+ config,
+ options,
+ logger,
+ header,
+ len_end):
+ '''Execute the proper build procedure for autotools or cmake
+ in the product build directory.
+
+ :param p_name_info tuple: (str, Config) => (product_name, product_info)
+ :param config Config: The global configuration
+ :param logger Logger: The logger instance to use for the display
+ and logging
+ :param header Str: the header to display when logging
+ :param len_end Int: the lenght of the the end of line (used in display)
+ :return: 1 if it fails, else 0.
+ :rtype: int
+ '''
+ p_name, p_info = p_name_info
+
# Execute "sat configure", "sat make" and "sat install"
- len_end_line = 30
res = 0
+ error_step = ""
- # Logging and sat command call for configure step
+ # Logging and sat command call for configure step
+ len_end_line = len_end
log_step(logger, header, "CONFIGURE")
res_c = sat.configure(config.VARS.application + " --products " + p_name,
- verbose = 0)
+ verbose = 0,
+ logger_add_link = logger)
log_res_step(logger, res_c)
res += res_c
- # Logging and sat command call for make step
- # Logging take account of the fact that the product has a compilation
- # script or not
- if src.product.product_has_script(p_info):
- # if the product has a compilation script,
- # it is executed during make step
- scrit_path_display = src.printcolors.printcLabel(p_info.compil_script)
- log_step(logger, header, "SCRIPT " + scrit_path_display)
- len_end_line = len(scrit_path_display)
+ if res_c > 0:
+ error_step = "CONFIGURE"
else:
- log_step(logger, header, "MAKE")
- make_arguments = config.VARS.application + " --products " + p_name
- # Get the make_flags option if there is any
- if options.makeflags:
- make_arguments += " --option -j" + options.makeflags
- res_c = sat.make(make_arguments,
- verbose = 0)
- log_res_step(logger, res_c)
- res += res_c
+ # Logging and sat command call for make step
+ # Logging take account of the fact that the product has a compilation
+ # script or not
+ if src.product.product_has_script(p_info):
+ # if the product has a compilation script,
+ # it is executed during make step
+ scrit_path_display = src.printcolors.printcLabel(
+ p_info.compil_script)
+ log_step(logger, header, "SCRIPT " + scrit_path_display)
+ len_end_line = len(scrit_path_display)
+ else:
+ log_step(logger, header, "MAKE")
+ make_arguments = config.VARS.application + " --products " + p_name
+ # Get the make_flags option if there is any
+ if options.makeflags:
+ make_arguments += " --option -j" + options.makeflags
+ res_m = sat.make(make_arguments,
+ verbose = 0,
+ logger_add_link = logger)
+ log_res_step(logger, res_m)
+ res += res_m
+
+ if res_m > 0:
+ error_step = "MAKE"
+ else:
+ # Logging and sat command call for make install step
+ log_step(logger, header, "MAKE INSTALL")
+ res_mi = sat.makeinstall(config.VARS.application +
+ " --products " +
+ p_name,
+ verbose = 0,
+ logger_add_link = logger)
- # Logging and sat command call for make install step
- log_step(logger, header, "MAKE INSTALL")
- res_c = sat.makeinstall(config.VARS.application + " --products " + p_name,
- verbose = 0)
- log_res_step(logger, res_c)
- res += res_c
-
- # Log the result
- if res > 0:
- logger.write("\r%s%s" % (header, " " * len_end_line), 3)
- logger.write("\r" + header + src.printcolors.printcError("KO"))
- logger.write("\n==== %(KO)s in compile of %(name)s \n" %
- { "name" : p_name , "KO" : src.printcolors.printcInfo("ERROR")}, 4)
- logger.flush()
- else:
- logger.write("\r%s%s" % (header, " " * len_end_line), 3)
- logger.write("\r" + header + src.printcolors.printcSuccess("OK"))
- logger.write(_("\nINSTALL directory = %s" %
- src.printcolors.printcInfo(p_info.install_dir)), 3)
- logger.write("\n==== %s \n" % src.printcolors.printcInfo("OK"), 4)
- logger.write("\n==== Compilation of %(name)s %(OK)s \n" %
- { "name" : p_name , "OK" : src.printcolors.printcInfo("OK")}, 4)
- logger.flush()
- logger.write("\n", 3, False)
+ log_res_step(logger, res_mi)
+ res += res_mi
+
+ if res_mi > 0:
+ error_step = "MAKE INSTALL"
+
+ return res, len_end_line, error_step
- return res
+def compile_product_script(sat,
+ p_name_info,
+ config,
+ options,
+ logger,
+ header,
+ len_end):
+ '''Execute the script build procedure in the product build directory.
+
+ :param p_name_info tuple: (str, Config) => (product_name, product_info)
+ :param config Config: The global configuration
+ :param logger Logger: The logger instance to use for the display
+ and logging
+ :param header Str: the header to display when logging
+ :param len_end Int: the lenght of the the end of line (used in display)
+ :return: 1 if it fails, else 0.
+ :rtype: int
+ '''
+ p_name, p_info = p_name_info
+
+ # Execute "sat configure", "sat make" and "sat install"
+ error_step = ""
+
+ # Logging and sat command call for the script step
+ scrit_path_display = src.printcolors.printcLabel(p_info.compil_script)
+ log_step(logger, header, "SCRIPT " + scrit_path_display)
+ len_end_line = len_end + len(scrit_path_display)
+ res = sat.script(config.VARS.application + " --products " + p_name,
+ verbose = 0,
+ logger_add_link = logger)
+ log_res_step(logger, res)
+
+ return res, len_end_line, error_step
+def add_compile_config_file(p_info, config):
+ '''Execute the proper configuration command(s)
+ in the product build directory.
+
+ :param p_info Config: The specific config of the product
+ :param config Config: The global configuration
+ '''
+ # Create the compile config
+ compile_cfg = src.pyconf.Config()
+ for prod_name in p_info.depend:
+ if prod_name not in compile_cfg:
+ compile_cfg.addMapping(prod_name,
+ src.pyconf.Mapping(compile_cfg),
+ "")
+ prod_dep_info = src.product.get_product_config(config, prod_name, False)
+ compile_cfg[prod_name] = prod_dep_info.version
+ # Write it in the install directory of the product
+ compile_cfg_path = os.path.join(p_info.install_dir, src.CONFIG_FILENAME)
+ f = open(compile_cfg_path, 'w')
+ compile_cfg.__save__(f)
+ f.close()
+
def description():
'''method that is called when salomeTools is called with --help option.
:return: The text to display for the compile command description.
:rtype: str
'''
- return _("The compile command constructs the products of the application")
+ return _("The compile command constructs the products of the application"
+ "\n\nexample:\nsat compile SALOME-master --products KERNEL,GUI,"
+ "MEDCOUPLING --clean_all")
def run(args, runner, logger):
'''method that is called when salomeTools is called with compile parameter.
'''
-
+ # DBG.write("compile runner.cfg", runner.cfg, True)
# Parse the options
(options, args) = parser.parse_args(args)
if (options.clean_all and
options.products is None and
not runner.options.batch):
- rep = raw_input(_("You used --clean_all without specifying a product"
+ rep = input(_("You used --clean_all without specifying a product"
" are you sure you want to continue? [Yes/No] "))
if rep.upper() != _("YES").upper():
return 0
# check that the command has been called with an application
src.check_config_has_application( runner.cfg )
+ # Print some informations
+ logger.write(_('Executing the compile commands in the build '
+ 'directories of the products of '
+ 'the application %s\n') %
+ src.printcolors.printcLabel(runner.cfg.VARS.application), 1)
+
+ info = [
+ (_("SOURCE directory"),
+ os.path.join(runner.cfg.APPLICATION.workdir, 'SOURCES')),
+ (_("BUILD directory"),
+ os.path.join(runner.cfg.APPLICATION.workdir, 'BUILD'))
+ ]
+ src.print_info(logger, info)
+
# Get the list of products to treat
products_infos = get_products_list(options, runner.cfg, logger)
# Sort the list regarding the dependencies of the products
products_infos = sort_products(runner.cfg, products_infos)
- # Print some informations
- logger.write(_('Executing the compile command in the build '
- 'directories of the application %s\n') %
- src.printcolors.printcLabel(runner.cfg.VARS.application), 1)
-
- info = [
- (_("SOURCE directory"),
- os.path.join(runner.cfg.APPLICATION.workdir, 'SOURCES')),
- (_("BUILD directory"),
- os.path.join(runner.cfg.APPLICATION.workdir, 'BUILD'))
- ]
- src.print_info(logger, info)
# Call the function that will loop over all the products and execute
# the right command(s)
'valid_result': nb_products - res,
'nb_products': nb_products }, 1)
- return res
\ No newline at end of file
+ code = res
+ if code != 0:
+ code = 1
+ return code
