3 # Copyright (C) 2010-2012 CEA/DEN
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.
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.
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
31 from application import get_SALOME_modules
32 from src.versionMinorMajorPatch import MinorMajorPatch as MMP
33 import src.debug as DBG
35 old_python = sys.version_info[0] == 2 and sys.version_info[1] <= 6
42 ARCHIVE_DIR = "ARCHIVES"
43 PROJECT_DIR = "PROJECT"
45 IGNORED_DIRS = [".git", ".svn"]
46 IGNORED_EXTENSIONS = []
48 PACKAGE_EXT=".tar.gz" # the extension we use for the packages
50 if src.architecture.is_windows():
51 PROJECT_TEMPLATE = """#!/usr/bin/env python
54 # The path to the archive root directory
55 root_path : $PWD + "/../"
57 project_path : $PWD + "/"
59 # Where to search the archives of the products
60 ARCHIVEPATH : $root_path + "ARCHIVES"
61 # Where to search the pyconf of the applications
62 APPLICATIONPATH : $project_path + "applications/"
63 # Where to search the pyconf of the products
64 PRODUCTPATH : $project_path + "products/"
65 # Where to search the pyconf of the jobs of the project
66 JOBPATH : $project_path + "jobs/"
67 # Where to search the pyconf of the machines of the project
68 MACHINEPATH : $project_path + "machines/"
71 PROJECT_TEMPLATE = """#!/usr/bin/env python
75 project_path : $PWD + "/"
77 # Where to search the archives of the products
78 ARCHIVEPATH : $project_path + "ARCHIVES"
79 # Where to search the pyconf of the applications
80 APPLICATIONPATH : $project_path + "applications/"
81 # Where to search the pyconf of the products
82 PRODUCTPATH : $project_path + "products/"
83 # Where to search the pyconf of the jobs of the project
84 JOBPATH : $project_path + "jobs/"
85 # Where to search the pyconf of the machines of the project
86 MACHINEPATH : $project_path + "machines/"
90 LOCAL_TEMPLATE = ("""#!/usr/bin/env python
98 archive_dir : 'default'
107 $LOCAL.workdir + $VARS.sep + \"""" + PROJECT_DIR + """\" + $VARS.sep + "project.pyconf"
112 # Define all possible option for the package command : sat package <options>
113 parser = src.options.Options()
114 parser.add_option('b', 'binaries', 'boolean', 'binaries',
115 _('Optional: Produce a binary package.'), False)
116 parser.add_option('f', 'force_creation', 'boolean', 'force_creation',
117 _('Optional: Only binary package: produce the archive even if '
118 'there are some missing products.'), False)
119 parser.add_option('s', 'sources', 'boolean', 'sources',
120 _('Optional: Produce a compilable archive of the sources of the '
121 'application.'), False)
122 parser.add_option('', 'bin_products', 'boolean', 'bin_products',
123 _('Optional: Create binary archives for all products.'), False)
124 parser.add_option('', 'with_vcs', 'boolean', 'with_vcs',
125 _('Optional: Do not make archive for products in VCS mode (git, cvs, svn). '
126 'Sat prepare will use VCS mode instead to retrieve them.'
127 '\n Also, when combined with "--bin_products" option, restrict the building of product archives to VCS products.'),
129 parser.add_option('', 'ftp', 'boolean', 'ftp',
130 _('Optional: Do not embed archives for products in archive mode.'
131 'Sat prepare will use ftp instead to retrieve them'),
133 parser.add_option('e', 'exe', 'string', 'exe',
134 _('Optional: Produce an extra launcher based upon the exe given as argument.'), "")
135 parser.add_option('p', 'project', 'string', 'project',
136 _('Optional: Produce an archive that contains a project.'), "")
137 parser.add_option('t', 'salometools', 'boolean', 'sat',
138 _('Optional: Produce an archive that contains salomeTools.'), False)
139 parser.add_option('n', 'name', 'string', 'name',
140 _('Optional: The name or full path of the archive.'), None)
141 parser.add_option('', 'add_files', 'list2', 'add_files',
142 _('Optional: The list of additional files to add to the archive.'), [])
143 parser.add_option('', 'without_properties', 'properties', 'without_properties',
144 _('Optional: Filter the products by their properties.\n\tSyntax: '
145 '--without_properties <property>:<value>'))
148 def add_files(tar, name_archive, d_content, logger, f_exclude=None):
149 '''Create an archive containing all directories and files that are given in
150 the d_content argument.
152 :param tar tarfile: The tarfile instance used to make the archive.
153 :param name_archive str: The name of the archive to make.
154 :param d_content dict: The dictionary that contain all directories and files
155 to add in the archive.
157 (path_on_local_machine, path_in_archive)
158 :param logger Logger: the logging instance
159 :param f_exclude Function: the function that filters
160 :return: 0 if success, 1 if not.
163 # get the max length of the messages in order to make the display
164 max_len = len(max(d_content.keys(), key=len))
167 # loop over each directory or file stored in the d_content dictionary
168 names = sorted(d_content.keys())
169 DBG.write("add tar names", names)
171 # used to avoid duplications (for pip install in python, or single_install_dir cases)
174 # display information
175 len_points = max_len - len(name) + 3
176 local_path, archive_path = d_content[name]
177 in_archive = os.path.join(name_archive, archive_path)
178 logger.write(name + " " + len_points * "." + " "+ in_archive + " ", 3)
179 # Get the local path and the path in archive
180 # of the directory or file to add
181 # Add it in the archive
183 key=local_path+"->"+in_archive
184 if key not in already_added:
188 exclude=exclude_VCS_and_extensions_26)
192 filter=exclude_VCS_and_extensions)
193 already_added.add(key)
194 logger.write(src.printcolors.printcSuccess(_("OK")), 3)
195 except Exception as e:
196 logger.write(src.printcolors.printcError(_("KO ")), 3)
197 logger.write(str(e), 3)
199 logger.write("\n", 3)
203 def exclude_VCS_and_extensions_26(filename):
204 ''' The function that is used to exclude from package the link to the
205 VCS repositories (like .git) (only for python 2.6)
207 :param filename Str: The filname to exclude (or not).
208 :return: True if the file has to be exclude
211 for dir_name in IGNORED_DIRS:
212 if dir_name in filename:
214 for extension in IGNORED_EXTENSIONS:
215 if filename.endswith(extension):
219 def exclude_VCS_and_extensions(tarinfo):
220 ''' The function that is used to exclude from package the link to the
221 VCS repositories (like .git)
223 :param filename Str: The filname to exclude (or not).
224 :return: None if the file has to be exclude
225 :rtype: tarinfo or None
227 filename = tarinfo.name
228 for dir_name in IGNORED_DIRS:
229 if dir_name in filename:
231 for extension in IGNORED_EXTENSIONS:
232 if filename.endswith(extension):
236 def produce_relative_launcher(config,
241 '''Create a specific SALOME launcher for the binary package. This launcher
244 :param config Config: The global configuration.
245 :param logger Logger: the logging instance
246 :param file_dir str: the directory where to put the launcher
247 :param file_name str: The launcher name
248 :param binaries_dir_name str: the name of the repository where the binaries
250 :return: the path of the produced launcher
254 # set base mode to "no" for the archive - save current mode to restore it at the end
255 if "base" in config.APPLICATION:
256 base_setting=config.APPLICATION.base
259 config.APPLICATION.base="no"
261 # get KERNEL installation path
262 kernel_info = src.product.get_product_config(config, "KERNEL")
263 kernel_base_name=os.path.basename(kernel_info.install_dir)
264 if kernel_info.install_mode == "base":
265 # case of kernel installed in base. the kernel install dir name is different in the archive
266 kernel_base_name=os.path.basename(os.path.dirname(kernel_info.install_dir))
268 kernel_root_dir = os.path.join(binaries_dir_name, kernel_base_name)
270 # set kernel bin dir (considering fhs property)
271 kernel_cfg = src.product.get_product_config(config, "KERNEL")
272 if src.get_property_in_product_cfg(kernel_cfg, "fhs"):
273 bin_kernel_install_dir = os.path.join(kernel_root_dir,"bin")
275 bin_kernel_install_dir = os.path.join(kernel_root_dir,"bin","salome")
277 # check if the application contains an application module
278 # check also if the application has a distene product,
279 # in this case get its licence file name
280 l_product_info = src.product.get_products_infos(config.APPLICATION.products.keys(), config)
281 salome_application_name="Not defined"
282 distene_licence_file_name=False
283 for prod_name, prod_info in l_product_info:
284 # look for a "salome application" and a distene product
285 if src.get_property_in_product_cfg(prod_info, "is_distene") == "yes":
286 distene_licence_file_name = src.product.product_has_licence(prod_info,
287 config.PATHS.LICENCEPATH)
288 if src.get_property_in_product_cfg(prod_info, "is_salome_application") == "yes":
289 salome_application_name=prod_info.name
291 # if the application contains an application module, we set ABSOLUTE_APPLI_PATH to it
292 # if not we set it to KERNEL_INSTALL_DIR, which is sufficient, except for salome test
293 if salome_application_name == "Not defined":
294 app_root_dir=kernel_root_dir
296 app_root_dir=os.path.join(binaries_dir_name, salome_application_name)
299 additional_env['sat_bin_kernel_install_dir'] = "out_dir_Path + " +\
300 config.VARS.sep + bin_kernel_install_dir
301 if "python3" in config.APPLICATION and config.APPLICATION.python3 == "yes":
302 additional_env['sat_python_version'] = 3
304 additional_env['sat_python_version'] = 2
306 additional_env['ABSOLUTE_APPLI_PATH'] = "out_dir_Path" + config.VARS.sep + app_root_dir
307 launcher_name = src.get_launcher_name(config)
308 additional_env['APPLI'] = "out_dir_Path" + config.VARS.sep + file_name
310 # create an environment file writer
311 writer = src.environment.FileEnvWriter(config,
317 filepath = os.path.join(file_dir, file_name)
319 writer.write_env_file(filepath,
322 additional_env=additional_env,
324 for_package = binaries_dir_name)
326 # Little hack to put out_dir_Path outside the strings
327 src.replace_in_file(filepath, 'r"out_dir_Path', 'out_dir_Path + r"' )
328 src.replace_in_file(filepath, "r'out_dir_Path + ", "out_dir_Path + r'" )
330 # A hack to put a call to a file for distene licence.
331 # It does nothing to an application that has no distene product
332 if distene_licence_file_name:
333 logger.write("Application has a distene licence file! We use it in package launcher", 5)
334 hack_for_distene_licence(filepath, distene_licence_file_name)
336 # change the rights in order to make the file executable for everybody
346 # restore modified setting by its initial value
347 config.APPLICATION.base=base_setting
351 def hack_for_distene_licence(filepath, licence_file):
352 '''Replace the distene licence env variable by a call to a file.
354 :param filepath Str: The path to the launcher to modify.
356 shutil.move(filepath, filepath + "_old")
358 filein = filepath + "_old"
359 fin = open(filein, "r")
360 fout = open(fileout, "w")
361 text = fin.readlines()
362 # Find the Distene section
364 for i,line in enumerate(text):
365 if "# Set DISTENE License" in line:
369 # No distene product, there is nothing to do
375 del text[num_line +1]
376 del text[num_line +1]
377 text_to_insert =""" try:
378 distene_licence_file=r"%s"
379 if sys.version_info[0] >= 3 and sys.version_info[1] >= 5:
380 import importlib.util
381 spec_dist = importlib.util.spec_from_file_location("distene_licence", distene_licence_file)
382 distene=importlib.util.module_from_spec(spec_dist)
383 spec_dist.loader.exec_module(distene)
386 distene = imp.load_source('distene_licence', distene_licence_file)
387 distene.set_distene_variables(context)
389 pass\n""" % licence_file
390 text.insert(num_line + 1, text_to_insert)
397 def produce_relative_env_files(config,
402 '''Create some specific environment files for the binary package. These
403 files use relative paths.
405 :param config Config: The global configuration.
406 :param logger Logger: the logging instance
407 :param file_dir str: the directory where to put the files
408 :param binaries_dir_name str: the name of the repository where the binaries
410 :param exe_name str: if given generate a launcher executing exe_name
411 :return: the list of path of the produced environment files
415 # set base mode to "no" for the archive - save current mode to restore it at the end
416 if "base" in config.APPLICATION:
417 base_setting=config.APPLICATION.base
420 config.APPLICATION.base="no"
422 # create an environment file writer
423 writer = src.environment.FileEnvWriter(config,
428 if src.architecture.is_windows():
430 filename = "env_launch.bat"
433 filename = "env_launch.sh"
436 filename=os.path.basename(exe_name)
439 filepath = writer.write_env_file(filename,
442 for_package = binaries_dir_name)
444 # Little hack to put out_dir_Path as environment variable
445 if src.architecture.is_windows() :
446 src.replace_in_file(filepath, '"out_dir_Path', '"%out_dir_Path%' )
447 src.replace_in_file(filepath, '=out_dir_Path', '=%out_dir_Path%' )
448 src.replace_in_file(filepath, ';out_dir_Path', ';%out_dir_Path%' )
450 src.replace_in_file(filepath, '"out_dir_Path', '"${out_dir_Path}' )
451 src.replace_in_file(filepath, ':out_dir_Path', ':${out_dir_Path}' )
452 src.replace_in_file(filepath, ';out_dir_Path', ';${out_dir_Path}' )
455 if src.architecture.is_windows():
456 cmd="\n\nrem Launch exe with user arguments\n%s " % exe_name + "%*"
458 cmd='\n\n# Launch exe with user arguments\n%s "$*"' % exe_name
459 with open(filepath, "a") as exe_launcher:
460 exe_launcher.write(cmd)
462 # change the rights in order to make the file executable for everybody
472 # restore modified setting by its initial value
473 config.APPLICATION.base=base_setting
477 def produce_install_bin_file(config,
482 '''Create a bash shell script which do substitutions in BIRARIES dir
483 in order to use it for extra compilations.
485 :param config Config: The global configuration.
486 :param logger Logger: the logging instance
487 :param file_dir str: the directory where to put the files
488 :param d_sub, dict: the dictionnary that contains the substitutions to be done
489 :param file_name str: the name of the install script file
490 :return: the produced file
494 filepath = os.path.join(file_dir, file_name)
495 # open the file and write into it
496 # use codec utf-8 as sat variables are in unicode
497 with codecs.open(filepath, "w", 'utf-8') as installbin_file:
498 installbin_template_path = os.path.join(config.VARS.internal_dir,
499 "INSTALL_BIN.template")
501 # build the name of the directory that will contain the binaries
502 binaries_dir_name = config.INTERNAL.config.binary_dir + config.VARS.dist
503 # build the substitution loop
504 loop_cmd = "for f in $(grep -RIl"
506 loop_cmd += " -e "+ key
507 loop_cmd += ' ' + config.INTERNAL.config.install_dir +\
510 loop_cmd += " s?" + key + "?$(pwd)/" + d_sub[key] + "?g\n"
511 loop_cmd += ' " $f\ndone'
514 d["BINARIES_DIR"] = binaries_dir_name
515 d["SUBSTITUTION_LOOP"]=loop_cmd
516 d["INSTALL_DIR"]=config.INTERNAL.config.install_dir
518 # substitute the template and write it in file
519 content=src.template.substitute(installbin_template_path, d)
520 installbin_file.write(content)
521 # change the rights in order to make the file executable for everybody
533 def product_appli_creation_script(config,
537 '''Create a script that can produce an application (EDF style) in the binary
540 :param config Config: The global configuration.
541 :param logger Logger: the logging instance
542 :param file_dir str: the directory where to put the file
543 :param binaries_dir_name str: the name of the repository where the binaries
545 :return: the path of the produced script file
548 template_name = "create_appli.py.for_bin_packages.template"
549 template_path = os.path.join(config.VARS.internal_dir, template_name)
550 text_to_fill = open(template_path, "r").read()
551 text_to_fill = text_to_fill.replace("TO BE FILLED 1",
552 '"' + binaries_dir_name + '"')
555 for product_name in get_SALOME_modules(config):
556 product_info = src.product.get_product_config(config, product_name)
558 if src.product.product_is_smesh_plugin(product_info):
561 if 'install_dir' in product_info and bool(product_info.install_dir):
562 if src.product.product_is_cpp(product_info):
564 for cpp_name in src.product.get_product_components(product_info):
565 line_to_add = ("<module name=\"" +
567 "\" gui=\"yes\" path=\"''' + "
568 "os.path.join(dir_bin_name, \"" +
569 cpp_name + "\") + '''\"/>")
572 line_to_add = ("<module name=\"" +
574 "\" gui=\"yes\" path=\"''' + "
575 "os.path.join(dir_bin_name, \"" +
576 product_name + "\") + '''\"/>")
577 text_to_add += line_to_add + "\n"
579 filled_text = text_to_fill.replace("TO BE FILLED 2", text_to_add)
581 tmp_file_path = os.path.join(file_dir, "create_appli.py")
582 ff = open(tmp_file_path, "w")
583 ff.write(filled_text)
586 # change the rights in order to make the file executable for everybody
587 os.chmod(tmp_file_path,
598 def bin_products_archives(config, logger, only_vcs):
599 '''Prepare binary packages for all products
600 :param config Config: The global configuration.
601 :return: the error status
605 logger.write("Make %s binary archives\n" % config.VARS.dist)
606 # Get the default directory where to put the packages
607 binpackage_path = os.path.join(config.APPLICATION.workdir, "PACKAGE", "products")
608 src.ensure_path_exists(binpackage_path)
609 # Get the list of product installation to add to the archive
610 l_products_name = sorted(config.APPLICATION.products.keys())
611 l_product_info = src.product.get_products_infos(l_products_name,
613 # first loop on products : filter products, analyse properties,
614 # and store the information that will be used to create the archive in the second loop
615 l_not_installed=[] # store not installed products for warning at the end
616 for prod_name, prod_info in l_product_info:
617 # ignore the native and fixed products for install directories
618 if (src.get_property_in_product_cfg(prod_info, "not_in_package") == "yes"
619 or src.product.product_is_native(prod_info)
620 or src.product.product_is_fixed(prod_info)
621 or not src.product.product_compiles(prod_info)):
623 if only_vcs and not src.product.product_is_vcs(prod_info):
625 if not src.product.check_installation(config, prod_info):
626 l_not_installed.append(prod_name)
627 continue # product is not installed, we skip it
628 # prepare call to make_bin_archive
629 path_targz_prod = os.path.join(binpackage_path, prod_name + '-' + prod_info.version.replace("/", "_") + "-" + config.VARS.dist + PACKAGE_EXT)
630 targz_prod = tarfile.open(path_targz_prod, mode='w:gz')
631 bin_path = prod_info.install_dir
632 targz_prod.add(bin_path)
634 # Python program to find MD5 hash value of a file
636 with open(path_targz_prod,"rb") as f:
637 bytes = f.read() # read file as bytes
638 readable_hash = hashlib.md5(bytes).hexdigest();
639 with open(path_targz_prod+".md5", "w") as md5sum:
640 md5sum.write("%s %s" % (readable_hash, os.path.basename(path_targz_prod)))
641 logger.write(" archive : %s (md5sum = %s)\n" % (path_targz_prod, readable_hash))
645 def binary_package(config, logger, options, tmp_working_dir):
646 '''Prepare a dictionary that stores all the needed directories and files to
647 add in a binary package.
649 :param config Config: The global configuration.
650 :param logger Logger: the logging instance
651 :param options OptResult: the options of the launched command
652 :param tmp_working_dir str: The temporary local directory containing some
653 specific directories or files needed in the
655 :return: the dictionary that stores all the needed directories and files to
656 add in a binary package.
657 {label : (path_on_local_machine, path_in_archive)}
661 # Get the list of product installation to add to the archive
662 l_products_name = sorted(config.APPLICATION.products.keys())
663 l_product_info = src.product.get_products_infos(l_products_name,
666 # suppress compile time products for binaries-only archives
667 if not options.sources:
668 update_config(config, logger, "compile_time", "yes")
673 l_sources_not_present = []
674 generate_mesa_launcher = False # a flag to know if we generate a mesa launcher
675 if ("APPLICATION" in config and
676 "properties" in config.APPLICATION and
677 "mesa_launcher_in_package" in config.APPLICATION.properties and
678 config.APPLICATION.properties.mesa_launcher_in_package == "yes") :
679 generate_mesa_launcher=True
681 # first loop on products : filter products, analyse properties,
682 # and store the information that will be used to create the archive in the second loop
683 for prod_name, prod_info in l_product_info:
684 # skip product with property not_in_package set to yes
685 if src.get_property_in_product_cfg(prod_info, "not_in_package") == "yes":
688 # skip product if github and product is not opensource
689 if config.APPLICATION.properties.github == "yes" and src.get_property_in_product_cfg(prod_info, "is_opensource") == "no":
692 # Add the sources of the products that have the property
693 # sources_in_package : "yes"
694 if src.get_property_in_product_cfg(prod_info,
695 "sources_in_package") == "yes":
696 if os.path.exists(prod_info.source_dir):
697 l_source_dir.append((prod_name, prod_info.source_dir))
699 l_sources_not_present.append(prod_name)
701 # ignore the native and fixed products for install directories
702 if (src.product.product_is_native(prod_info)
703 or src.product.product_is_fixed(prod_info)
704 or not src.product.product_compiles(prod_info)):
707 # products with single_dir property will be installed in the PRODUCTS directory of the archive
708 is_single_dir=(src.appli_test_property(config,"single_install_dir", "yes") and \
709 src.product.product_test_property(prod_info,"single_install_dir", "yes"))
710 if src.product.check_installation(config, prod_info):
711 l_install_dir.append((prod_name, prod_info.name, prod_info.install_dir,
712 is_single_dir, prod_info.install_mode))
714 l_not_installed.append(prod_name)
716 # Add also the cpp generated modules (if any)
717 if src.product.product_is_cpp(prod_info):
719 for name_cpp in src.product.get_product_components(prod_info):
720 install_dir = os.path.join(config.APPLICATION.workdir,
721 config.INTERNAL.config.install_dir,
723 if os.path.exists(install_dir):
724 l_install_dir.append((name_cpp, name_cpp, install_dir, False, "value"))
726 l_not_installed.append(name_cpp)
728 # check the name of the directory that (could) contains the binaries
729 # from previous detar
730 binaries_from_detar = os.path.join(
731 config.APPLICATION.workdir,
732 config.INTERNAL.config.binary_dir + config.VARS.dist)
733 if os.path.exists(binaries_from_detar):
735 WARNING: existing binaries directory from previous detar installation:
737 To make new package from this, you have to:
738 1) install binaries in INSTALL directory with the script "install_bin.sh"
739 see README file for more details
740 2) or recompile everything in INSTALL with "sat compile" command
741 this step is long, and requires some linux packages to be installed
743 """ % binaries_from_detar)
745 # Print warning or error if there are some missing products
746 if len(l_not_installed) > 0:
747 text_missing_prods = ""
748 for p_name in l_not_installed:
749 text_missing_prods += " - " + p_name + "\n"
750 if not options.force_creation:
751 msg = _("ERROR: there are missing product installations:")
752 logger.write("%s\n%s" % (src.printcolors.printcError(msg),
755 raise src.SatException(msg)
757 msg = _("WARNING: there are missing products installations:")
758 logger.write("%s\n%s" % (src.printcolors.printcWarning(msg),
762 # Do the same for sources
763 if len(l_sources_not_present) > 0:
764 text_missing_prods = ""
765 for p_name in l_sources_not_present:
766 text_missing_prods += "-" + p_name + "\n"
767 if not options.force_creation:
768 msg = _("ERROR: there are missing product sources:")
769 logger.write("%s\n%s" % (src.printcolors.printcError(msg),
772 raise src.SatException(msg)
774 msg = _("WARNING: there are missing products sources:")
775 logger.write("%s\n%s" % (src.printcolors.printcWarning(msg),
779 # construct the name of the directory that will contain the binaries
780 if src.architecture.is_windows():
781 binaries_dir_name = config.INTERNAL.config.binary_dir
783 binaries_dir_name = config.INTERNAL.config.binary_dir + config.VARS.dist
784 # construct the correlation table between the product names, there
785 # actual install directories and there install directory in archive
787 for prod_name, prod_info_name, install_dir, is_single_dir, install_mode in l_install_dir:
788 prod_base_name=os.path.basename(install_dir)
789 if install_mode == "base":
790 # case of a products installed in base.
791 # because the archive is in base:no mode, the name of the install dir is different inside archive
792 # we set it to the product name or by PRODUCTS if single-dir
794 prod_base_name=config.INTERNAL.config.single_install_dir
796 prod_base_name=prod_info_name
797 path_in_archive = os.path.join(binaries_dir_name, prod_base_name)
798 d_products[prod_name + " (bin)"] = (install_dir, path_in_archive)
800 for prod_name, source_dir in l_source_dir:
801 path_in_archive = os.path.join("SOURCES", prod_name)
802 d_products[prod_name + " (sources)"] = (source_dir, path_in_archive)
804 # create an archives of compilation logs, and insert it into the tarball
805 logpath=os.path.join(config.APPLICATION.workdir, "LOGS")
806 path_targz_logs = os.path.join(tmp_working_dir, "logs.tgz")
807 tar_log = tarfile.open(path_targz_logs, mode='w:gz')
808 tar_log.add(logpath, arcname="LOGS")
810 d_products["LOGS"] = (path_targz_logs, "logs.tgz")
812 # for packages of SALOME applications including KERNEL,
813 # we produce a salome launcher or a virtual application (depending on salome version)
814 if 'KERNEL' in config.APPLICATION.products:
815 VersionSalome = src.get_salome_version(config)
816 # Case where SALOME has the launcher that uses the SalomeContext API
817 if VersionSalome >= MMP([7,3,0]):
818 # create the relative launcher and add it to the files to add
819 launcher_name = src.get_launcher_name(config)
820 launcher_package = produce_relative_launcher(config,
825 d_products["launcher"] = (launcher_package, launcher_name)
827 # if the application contains mesa products, we generate in addition to the
828 # classical salome launcher a launcher using mesa and called mesa_salome
829 # (the mesa launcher will be used for remote usage through ssh).
830 if generate_mesa_launcher:
831 #if there is one : store the use_mesa property
832 restore_use_mesa_option=None
833 if ('properties' in config.APPLICATION and
834 'use_mesa' in config.APPLICATION.properties):
835 restore_use_mesa_option = config.APPLICATION.properties.use_mesa
837 # activate mesa property, and generate a mesa launcher
838 src.activate_mesa_property(config) #activate use_mesa property
839 launcher_mesa_name="mesa_"+launcher_name
840 launcher_package_mesa = produce_relative_launcher(config,
845 d_products["launcher (mesa)"] = (launcher_package_mesa, launcher_mesa_name)
847 # if there was a use_mesa value, we restore it
848 # else we set it to the default value "no"
849 if restore_use_mesa_option != None:
850 config.APPLICATION.properties.use_mesa=restore_use_mesa_option
852 config.APPLICATION.properties.use_mesa="no"
855 # if we mix binaries and sources, we add a copy of the launcher,
856 # prefixed with "bin",in order to avoid clashes
857 launcher_copy_name="bin"+launcher_name
858 launcher_package_copy = produce_relative_launcher(config,
863 d_products["launcher (copy)"] = (launcher_package_copy, launcher_copy_name)
865 # Provide a script for the creation of an application EDF style
866 appli_script = product_appli_creation_script(config,
871 d_products["appli script"] = (appli_script, "create_appli.py")
873 # Put also the environment file
874 env_file = produce_relative_env_files(config,
879 if src.architecture.is_windows():
880 filename = "env_launch.bat"
882 filename = "env_launch.sh"
883 d_products["environment file"] = (env_file, filename)
885 # If option exe, produce an extra launcher based on specified exe
887 exe_file = produce_relative_env_files(config,
893 if src.architecture.is_windows():
894 filename = os.path.basename(options.exe) + ".bat"
896 filename = os.path.basename(options.exe) + ".sh"
897 d_products["exe file"] = (exe_file, filename)
902 def source_package(sat, config, logger, options, tmp_working_dir):
903 '''Prepare a dictionary that stores all the needed directories and files to
904 add in a source package.
906 :param config Config: The global configuration.
907 :param logger Logger: the logging instance
908 :param options OptResult: the options of the launched command
909 :param tmp_working_dir str: The temporary local directory containing some
910 specific directories or files needed in the
912 :return: the dictionary that stores all the needed directories and files to
913 add in a source package.
914 {label : (path_on_local_machine, path_in_archive)}
919 # Get all the products that are prepared using an archive
920 # unless ftp mode is specified (in this case the user of the
921 # archive will get the sources through the ftp mode of sat prepare
923 logger.write("Find archive products ... ")
924 d_archives, l_pinfo_vcs = get_archives(config, logger)
925 logger.write("Done\n")
928 if not options.with_vcs and len(l_pinfo_vcs) > 0:
929 # Make archives with the products that are not prepared using an archive
930 # (git, cvs, svn, etc)
931 logger.write("Construct archives for vcs products ... ")
932 d_archives_vcs = get_archives_vcs(l_pinfo_vcs,
937 logger.write("Done\n")
940 logger.write("Create the project ... ")
941 d_project = create_project_for_src_package(config,
945 logger.write("Done\n")
948 tmp_sat = add_salomeTools(config, tmp_working_dir)
949 d_sat = {"salomeTools" : (tmp_sat, "sat")}
951 # Add a sat symbolic link if not win
952 if not src.architecture.is_windows():
956 # In the jobs, os.getcwd() can fail
957 t = config.LOCAL.workdir
958 os.chdir(tmp_working_dir)
960 # create a symlink, to avoid reference with "salomeTool/.."
962 if os.path.lexists("ARCHIVES"):
963 os.remove("ARCHIVES")
964 os.symlink("../ARCHIVES", "ARCHIVES")
967 d_sat["sat archive link"] = (os.path.join(tmp_working_dir,"PROJECT", "ARCHIVES"),
968 os.path.join("PROJECT", "ARCHIVES"))
970 d_source = src.merge_dicts(d_archives, d_archives_vcs, d_project, d_sat)
973 def get_archives(config, logger):
974 '''Find all the products that are get using an archive and all the products
975 that are get using a vcs (git, cvs, svn) repository.
977 :param config Config: The global configuration.
978 :param logger Logger: the logging instance
979 :return: the dictionary {name_product :
980 (local path of its archive, path in the package of its archive )}
981 and the list of specific configuration corresponding to the vcs
985 # Get the list of product informations
986 l_products_name = config.APPLICATION.products.keys()
987 l_product_info = src.product.get_products_infos(l_products_name,
991 for p_name, p_info in l_product_info:
992 # skip product with property not_in_package set to yes
993 if src.get_property_in_product_cfg(p_info, "not_in_package") == "yes":
995 # ignore the native and fixed products
996 if (src.product.product_is_native(p_info)
997 or src.product.product_is_fixed(p_info)):
1000 # skip product if github and product is not opensource
1001 if config.APPLICATION.properties.github == "yes" and src.get_property_in_product_cfg(p_info, "is_opensource") == "no":
1004 if p_info.get_source == "archive":
1005 archive_path = p_info.archive_info.archive_name
1006 archive_name = os.path.basename(archive_path)
1007 d_archives[p_name] = (archive_path,
1008 os.path.join(ARCHIVE_DIR, archive_name))
1009 if (src.appli_test_property(config,"pip", "yes") and
1010 src.product.product_test_property(p_info,"pip", "yes")):
1011 # if pip mode is activated, and product is managed by pip
1012 pip_wheels_dir=os.path.join(config.LOCAL.archive_dir,"wheels")
1013 if "archive_prefix" in p_info.archive_info and p_info.archive_info.archive_prefix:
1014 pip_wheel_pattern=os.path.join(pip_wheels_dir,
1015 "%s-%s*" % (p_info.archive_info.archive_prefix, p_info.version))
1017 pip_wheel_pattern=os.path.join(pip_wheels_dir,
1018 "%s-%s*" % (p_info.name, p_info.version))
1019 pip_wheel_path=glob.glob(pip_wheel_pattern)
1020 msg_pip_not_found="Error in get_archive, pip wheel for "\
1021 "product %s-%s was not found in %s directory"
1022 msg_pip_two_or_more="Error in get_archive, several pip wheels for "\
1023 "product %s-%s were found in %s directory"
1024 if len(pip_wheel_path)==0:
1025 raise src.SatException(msg_pip_not_found %\
1026 (p_info.name, p_info.version, pip_wheels_dir))
1027 if len(pip_wheel_path)>1:
1028 raise src.SatException(msg_pip_two_or_more %\
1029 (p_info.name, p_info.version, pip_wheels_dir))
1031 pip_wheel_name=os.path.basename(pip_wheel_path[0])
1032 d_archives[p_name+" (pip wheel)"]=(pip_wheel_path[0],
1033 os.path.join(ARCHIVE_DIR, "wheels", pip_wheel_name))
1035 # this product is not managed by archive,
1036 # an archive of the vcs directory will be created by get_archive_vcs
1037 l_pinfo_vcs.append((p_name, p_info))
1039 return d_archives, l_pinfo_vcs
1041 def add_salomeTools(config, tmp_working_dir):
1042 '''Prepare a version of salomeTools that has a specific local.pyconf file
1043 configured for a source package.
1045 :param config Config: The global configuration.
1046 :param tmp_working_dir str: The temporary local directory containing some
1047 specific directories or files needed in the
1049 :return: The path to the local salomeTools directory to add in the package
1052 # Copy sat in the temporary working directory
1053 sat_tmp_path = src.Path(os.path.join(tmp_working_dir, "salomeTools"))
1054 sat_running_path = src.Path(config.VARS.salometoolsway)
1055 sat_running_path.copy(sat_tmp_path)
1057 # Update the local.pyconf file that contains the path to the project
1058 local_pyconf_name = "local.pyconf"
1059 local_pyconf_dir = os.path.join(tmp_working_dir, "salomeTools", "data")
1060 local_pyconf_file = os.path.join(local_pyconf_dir, local_pyconf_name)
1061 # Remove the .pyconf file in the root directory of salomeTools if there is
1062 # any. (For example when launching jobs, a pyconf file describing the jobs
1063 # can be here and is not useful)
1064 files_or_dir_SAT = os.listdir(os.path.join(tmp_working_dir, "salomeTools"))
1065 for file_or_dir in files_or_dir_SAT:
1066 if file_or_dir.endswith(".pyconf") or file_or_dir.endswith(".txt"):
1067 file_path = os.path.join(tmp_working_dir,
1070 os.remove(file_path)
1072 ff = open(local_pyconf_file, "w")
1073 ff.write(LOCAL_TEMPLATE)
1076 return sat_tmp_path.path
1078 def get_archives_vcs(l_pinfo_vcs, sat, config, logger, tmp_working_dir):
1079 '''For sources package that require that all products are get using an
1080 archive, one has to create some archive for the vcs products.
1081 So this method calls the clean and source command of sat and then create
1084 :param l_pinfo_vcs List: The list of specific configuration corresponding to
1086 :param sat Sat: The Sat instance that can be called to clean and source the
1088 :param config Config: The global configuration.
1089 :param logger Logger: the logging instance
1090 :param tmp_working_dir str: The temporary local directory containing some
1091 specific directories or files needed in the
1093 :return: the dictionary that stores all the archives to add in the source
1094 package. {label : (path_on_local_machine, path_in_archive)}
1097 # clean the source directory of all the vcs products, then use the source
1098 # command and thus construct an archive that will not contain the patches
1099 l_prod_names = [pn for pn, __ in l_pinfo_vcs]
1100 if False: # clean is dangerous in user/SOURCES, fixed in tmp_local_working_dir
1101 logger.write(_("\nclean sources\n"))
1102 args_clean = config.VARS.application
1103 args_clean += " --sources --products "
1104 args_clean += ",".join(l_prod_names)
1105 logger.write("WARNING: get_archives_vcs clean\n '%s'\n" % args_clean, 1)
1106 sat.clean(args_clean, batch=True, verbose=0, logger_add_link = logger)
1109 logger.write(_("get sources\n"))
1110 args_source = config.VARS.application
1111 args_source += " --products "
1112 args_source += ",".join(l_prod_names)
1113 svgDir = sat.cfg.APPLICATION.workdir
1114 tmp_local_working_dir = os.path.join(sat.cfg.APPLICATION.workdir, "tmp_package") # to avoid too much big files in /tmp
1115 sat.cfg.APPLICATION.workdir = tmp_local_working_dir
1116 # DBG.write("SSS sat config.APPLICATION.workdir", sat.cfg.APPLICATION, True)
1117 # DBG.write("sat config id", id(sat.cfg), True)
1118 # shit as config is not same id() as for sat.source()
1119 # sat.source(args_source, batch=True, verbose=5, logger_add_link = logger)
1121 source.run(args_source, sat, logger) #use this mode as runner.cfg reference
1123 # make the new archives
1125 for pn, pinfo in l_pinfo_vcs:
1126 path_archive = make_archive(pn, pinfo, tmp_local_working_dir)
1127 logger.write("make archive vcs '%s'\n" % path_archive)
1128 d_archives_vcs[pn] = (path_archive,
1129 os.path.join(ARCHIVE_DIR, pn + ".tgz"))
1130 sat.cfg.APPLICATION.workdir = svgDir
1131 # DBG.write("END sat config", sat.cfg.APPLICATION, True)
1132 return d_archives_vcs
1134 def make_bin_archive(prod_name, prod_info, where):
1135 '''Create an archive of a product by searching its source directory.
1137 :param prod_name str: The name of the product.
1138 :param prod_info Config: The specific configuration corresponding to the
1140 :param where str: The path of the repository where to put the resulting
1142 :return: The path of the resulting archive
1145 path_targz_prod = os.path.join(where, prod_name + PACKAGE_EXT)
1146 tar_prod = tarfile.open(path_targz_prod, mode='w:gz')
1147 bin_path = prod_info.install_dir
1148 tar_prod.add(bin_path, arcname=path_targz_prod)
1150 return path_targz_prod
1152 def make_archive(prod_name, prod_info, where):
1153 '''Create an archive of a product by searching its source directory.
1155 :param prod_name str: The name of the product.
1156 :param prod_info Config: The specific configuration corresponding to the
1158 :param where str: The path of the repository where to put the resulting
1160 :return: The path of the resulting archive
1163 path_targz_prod = os.path.join(where, prod_name + PACKAGE_EXT)
1164 tar_prod = tarfile.open(path_targz_prod, mode='w:gz')
1165 local_path = prod_info.source_dir
1167 tar_prod.add(local_path,
1169 exclude=exclude_VCS_and_extensions_26)
1171 tar_prod.add(local_path,
1173 filter=exclude_VCS_and_extensions)
1175 return path_targz_prod
1177 def create_project_for_src_package(config, tmp_working_dir, with_vcs, with_ftp):
1178 '''Create a specific project for a source package.
1180 :param config Config: The global configuration.
1181 :param tmp_working_dir str: The temporary local directory containing some
1182 specific directories or files needed in the
1184 :param with_vcs boolean: True if the package is with vcs products (not
1185 transformed into archive products)
1186 :param with_ftp boolean: True if the package use ftp servers to get archives
1187 :return: The dictionary
1188 {"project" : (produced project, project path in the archive)}
1192 # Create in the working temporary directory the full project tree
1193 project_tmp_dir = os.path.join(tmp_working_dir, PROJECT_DIR)
1194 products_pyconf_tmp_dir = os.path.join(project_tmp_dir,
1196 compil_scripts_tmp_dir = os.path.join(project_tmp_dir,
1199 post_scripts_tmp_dir = os.path.join(project_tmp_dir,
1202 env_scripts_tmp_dir = os.path.join(project_tmp_dir,
1205 patches_tmp_dir = os.path.join(project_tmp_dir,
1208 application_tmp_dir = os.path.join(project_tmp_dir,
1210 for directory in [project_tmp_dir,
1211 compil_scripts_tmp_dir,
1212 env_scripts_tmp_dir,
1213 post_scripts_tmp_dir,
1215 application_tmp_dir]:
1216 src.ensure_path_exists(directory)
1218 # Create the pyconf that contains the information of the project
1219 project_pyconf_name = "project.pyconf"
1220 project_pyconf_file = os.path.join(project_tmp_dir, project_pyconf_name)
1221 ff = open(project_pyconf_file, "w")
1222 ff.write(PROJECT_TEMPLATE)
1223 if with_ftp and len(config.PATHS.ARCHIVEFTP) > 0:
1224 ftp_path='ARCHIVEFTP : "'+config.PATHS.ARCHIVEFTP[0]
1225 for ftpserver in config.PATHS.ARCHIVEFTP[1:]:
1226 ftp_path=ftp_path+":"+ftpserver
1228 ff.write("# ftp servers where to search for prerequisite archives\n")
1230 # add licence paths if any
1231 if len(config.PATHS.LICENCEPATH) > 0:
1232 licence_path='LICENCEPATH : "'+config.PATHS.LICENCEPATH[0]
1233 for path in config.PATHS.LICENCEPATH[1:]:
1234 licence_path=licence_path+":"+path
1236 ff.write("\n# Where to search for licences\n")
1237 ff.write(licence_path)
1242 # Loop over the products to get there pyconf and all the scripts
1243 # (compilation, environment, patches)
1244 # and create the pyconf file to add to the project
1245 lproducts_name = config.APPLICATION.products.keys()
1246 l_products = src.product.get_products_infos(lproducts_name, config)
1247 for p_name, p_info in l_products:
1248 # skip product with property not_in_package set to yes
1249 if src.get_property_in_product_cfg(p_info, "not_in_package") == "yes":
1251 find_product_scripts_and_pyconf(p_name,
1255 compil_scripts_tmp_dir,
1256 env_scripts_tmp_dir,
1257 post_scripts_tmp_dir,
1259 products_pyconf_tmp_dir)
1261 # for the application pyconf, we write directly the config
1262 # don't search for the original pyconf file
1263 # to avoid problems with overwrite sections and rm_products key
1264 write_application_pyconf(config, application_tmp_dir)
1266 d_project = {"project" : (project_tmp_dir, PROJECT_DIR )}
1269 def find_product_scripts_and_pyconf(p_name,
1273 compil_scripts_tmp_dir,
1274 env_scripts_tmp_dir,
1275 post_scripts_tmp_dir,
1277 products_pyconf_tmp_dir):
1278 '''Create a specific pyconf file for a given product. Get its environment
1279 script, its compilation script and patches and put it in the temporary
1280 working directory. This method is used in the source package in order to
1281 construct the specific project.
1283 :param p_name str: The name of the product.
1284 :param p_info Config: The specific configuration corresponding to the
1286 :param config Config: The global configuration.
1287 :param with_vcs boolean: True if the package is with vcs products (not
1288 transformed into archive products)
1289 :param compil_scripts_tmp_dir str: The path to the temporary compilation
1290 scripts directory of the project.
1291 :param env_scripts_tmp_dir str: The path to the temporary environment script
1292 directory of the project.
1293 :param post_scripts_tmp_dir str: The path to the temporary post-processing script
1294 directory of the project.
1295 :param patches_tmp_dir str: The path to the temporary patch scripts
1296 directory of the project.
1297 :param products_pyconf_tmp_dir str: The path to the temporary product
1298 scripts directory of the project.
1301 # read the pyconf of the product
1302 product_pyconf_cfg = src.pyconf.Config(p_info.from_file)
1304 # find the compilation script if any
1305 if src.product.product_has_script(p_info):
1306 compil_script_path = src.Path(p_info.compil_script)
1307 compil_script_path.copy(compil_scripts_tmp_dir)
1309 # find the environment script if any
1310 if src.product.product_has_env_script(p_info):
1311 env_script_path = src.Path(p_info.environ.env_script)
1312 env_script_path.copy(env_scripts_tmp_dir)
1314 # find the post script if any
1315 if src.product.product_has_post_script(p_info):
1316 post_script_path = src.Path(p_info.post_script)
1317 post_script_path.copy(post_scripts_tmp_dir)
1319 # find the patches if any
1320 if src.product.product_has_patches(p_info):
1321 patches = src.pyconf.Sequence()
1322 for patch_path in p_info.patches:
1323 p_path = src.Path(patch_path)
1324 p_path.copy(patches_tmp_dir)
1325 patches.append(os.path.basename(patch_path), "")
1327 if (not with_vcs) and src.product.product_is_vcs(p_info):
1328 # in non vcs mode, if the product is not archive, then make it become archive.
1330 # depending upon the incremental mode, select impacted sections
1331 if "properties" in p_info and "incremental" in p_info.properties and\
1332 p_info.properties.incremental == "yes":
1333 sections = ["default", "default_win", p_info.section, p_info.section+"_win"]
1335 sections = [p_info.section]
1336 for section in sections:
1337 if section in product_pyconf_cfg and "get_source" in product_pyconf_cfg[section]:
1338 DBG.write("sat package set archive mode to archive for product %s and section %s" %\
1340 product_pyconf_cfg[section].get_source = "archive"
1341 if not "archive_info" in product_pyconf_cfg[section]:
1342 product_pyconf_cfg[section].addMapping("archive_info",
1343 src.pyconf.Mapping(product_pyconf_cfg),
1345 product_pyconf_cfg[section].archive_info.archive_name =\
1346 p_info.name + ".tgz"
1348 # save git repositories for vcs products, even if archive is not in VCS mode
1349 # in this case the user will be able to change get_source flag and work with git
1350 if src.product.product_is_vcs(p_info):
1351 # in vcs mode we must replace explicitely the git server url
1352 # (or it will not be found later because project files are not exported in archives)
1353 for section in product_pyconf_cfg:
1354 # replace in all sections of the product pyconf the git repo definition by its substitued value (found in p_info)
1355 if "git_info" in product_pyconf_cfg[section]:
1356 for repo in product_pyconf_cfg[section].git_info:
1357 if repo in p_info.git_info:
1358 product_pyconf_cfg[section].git_info[repo] = p_info.git_info[repo]
1360 # write the pyconf file to the temporary project location
1361 product_tmp_pyconf_path = os.path.join(products_pyconf_tmp_dir,
1363 ff = open(product_tmp_pyconf_path, 'w')
1364 ff.write("#!/usr/bin/env python\n#-*- coding:utf-8 -*-\n\n")
1365 product_pyconf_cfg.__save__(ff, 1)
1369 def write_application_pyconf(config, application_tmp_dir):
1370 '''Write the application pyconf file in the specific temporary
1371 directory containing the specific project of a source package.
1373 :param config Config: The global configuration.
1374 :param application_tmp_dir str: The path to the temporary application
1375 scripts directory of the project.
1377 application_name = config.VARS.application
1378 # write the pyconf file to the temporary application location
1379 application_tmp_pyconf_path = os.path.join(application_tmp_dir,
1380 application_name + ".pyconf")
1381 with open(application_tmp_pyconf_path, 'w') as f:
1382 f.write("#!/usr/bin/env python\n#-*- coding:utf-8 -*-\n\n")
1383 res = src.pyconf.Config()
1384 app = src.pyconf.deepCopyMapping(config.APPLICATION)
1386 # set base mode to "no" for the archive
1389 # Change the workdir
1390 app.workdir = src.pyconf.Reference(
1394 res.addMapping("APPLICATION", app, "")
1395 res.__save__(f, evaluated=False)
1398 def sat_package(config, tmp_working_dir, options, logger):
1399 '''Prepare a dictionary that stores all the needed directories and files to
1400 add in a salomeTool package.
1402 :param tmp_working_dir str: The temporary local working directory
1403 :param options OptResult: the options of the launched command
1404 :return: the dictionary that stores all the needed directories and files to
1405 add in a salomeTool package.
1406 {label : (path_on_local_machine, path_in_archive)}
1411 # we include sat himself
1412 d_project["all_sat"]=(config.VARS.salometoolsway, "")
1414 # and we overwrite local.pyconf with a clean wersion.
1415 local_pyconf_tmp_path = os.path.join(tmp_working_dir, "local.pyconf")
1416 local_file_path = os.path.join(config.VARS.datadir, "local.pyconf")
1417 local_cfg = src.pyconf.Config(local_file_path)
1418 local_cfg.PROJECTS.project_file_paths=src.pyconf.Sequence(local_cfg.PROJECTS)
1419 local_cfg.LOCAL["base"] = "default"
1420 local_cfg.LOCAL["workdir"] = "default"
1421 local_cfg.LOCAL["log_dir"] = "default"
1422 local_cfg.LOCAL["archive_dir"] = "default"
1423 local_cfg.LOCAL["VCS"] = "None"
1424 local_cfg.LOCAL["tag"] = src.get_salometool_version(config)
1426 # if the archive contains a project, we write its relative path in local.pyconf
1428 project_arch_path = os.path.join("projects", options.project,
1429 os.path.basename(options.project_file_path))
1430 local_cfg.PROJECTS.project_file_paths.append(project_arch_path, "")
1432 ff = open(local_pyconf_tmp_path, 'w')
1433 local_cfg.__save__(ff, 1)
1435 d_project["local.pyconf"]=(local_pyconf_tmp_path, "data/local.pyconf")
1439 def project_package(config, name_project, project_file_path, ftp_mode, tmp_working_dir, embedded_in_sat, logger):
1440 '''Prepare a dictionary that stores all the needed directories and files to
1441 add in a project package.
1443 :param project_file_path str: The path to the local project.
1444 :param ftp_mode boolean: Do not embed archives, the archive will rely on ftp mode to retrieve them.
1445 :param tmp_working_dir str: The temporary local directory containing some
1446 specific directories or files needed in the
1448 :param embedded_in_sat boolean : the project package is embedded in a sat package
1449 :return: the dictionary that stores all the needed directories and files to
1450 add in a project package.
1451 {label : (path_on_local_machine, path_in_archive)}
1455 # Read the project file and get the directories to add to the package
1458 project_pyconf_cfg = config.PROJECTS.projects.__getattr__(name_project)
1461 WARNING: inexisting config.PROJECTS.projects.%s, try to read now from:\n%s\n""" % (name_project, project_file_path))
1462 project_pyconf_cfg = src.pyconf.Config(project_file_path)
1463 project_pyconf_cfg.PWD = os.path.dirname(project_file_path)
1465 paths = {"APPLICATIONPATH" : "applications",
1466 "PRODUCTPATH" : "products",
1468 "MACHINEPATH" : "machines"}
1470 paths["ARCHIVEPATH"] = "archives"
1472 # Loop over the project paths and add it
1473 project_file_name = os.path.basename(project_file_path)
1475 if path not in project_pyconf_cfg:
1478 dest_path = os.path.join("projects", name_project, paths[path])
1479 project_file_dest = os.path.join("projects", name_project, project_file_name)
1481 dest_path = paths[path]
1482 project_file_dest = project_file_name
1484 # Add the directory to the files to add in the package
1485 d_project[path] = (project_pyconf_cfg[path], dest_path)
1487 # Modify the value of the path in the package
1488 project_pyconf_cfg[path] = src.pyconf.Reference(
1491 'project_path + "/' + paths[path] + '"')
1493 # Modify some values
1494 if "project_path" not in project_pyconf_cfg:
1495 project_pyconf_cfg.addMapping("project_path",
1496 src.pyconf.Mapping(project_pyconf_cfg),
1498 project_pyconf_cfg.project_path = src.pyconf.Reference(project_pyconf_cfg,
1501 # we don't want to export these two fields
1502 project_pyconf_cfg.__delitem__("file_path")
1503 project_pyconf_cfg.__delitem__("PWD")
1505 project_pyconf_cfg.__delitem__("ARCHIVEPATH")
1507 # Write the project pyconf file
1508 project_pyconf_tmp_path = os.path.join(tmp_working_dir, project_file_name)
1509 ff = open(project_pyconf_tmp_path, 'w')
1510 ff.write("#!/usr/bin/env python\n#-*- coding:utf-8 -*-\n\n")
1511 project_pyconf_cfg.__save__(ff, 1)
1513 d_project["Project hat file"] = (project_pyconf_tmp_path, project_file_dest)
1517 def add_readme(config, options, where):
1518 readme_path = os.path.join(where, "README")
1519 with codecs.open(readme_path, "w", 'utf-8') as f:
1521 # templates for building the header
1523 # This package was generated with sat $version
1526 # Distribution : $dist
1528 In the following, $$ROOT represents the directory where you have installed
1529 SALOME (the directory where this file is located).
1532 if src.architecture.is_windows():
1533 readme_header = readme_header.replace('$$ROOT','%ROOT%')
1534 readme_compilation_with_binaries="""
1536 compilation based on the binaries used as prerequisites
1537 =======================================================
1539 If you fail to compile the complete application (for example because
1540 you are not root on your system and cannot install missing packages), you
1541 may try a partial compilation based on the binaries.
1542 For that it is necessary to copy the binaries from BINARIES to INSTALL,
1543 and do some substitutions on cmake and .la files (replace the build directories
1545 The procedure to do it is:
1546 1) Remove or rename INSTALL directory if it exists
1547 2) Execute the shell script install_bin.sh:
1550 3) Use SalomeTool (as explained in Sources section) and compile only the
1551 modules you need to (with -p option)
1554 readme_header_tpl=string.Template(readme_header)
1555 readme_template_path_bin = os.path.join(config.VARS.internal_dir,
1556 "README_BIN.template")
1557 readme_template_path_bin_launcher = os.path.join(config.VARS.internal_dir,
1558 "README_LAUNCHER.template")
1559 readme_template_path_bin_virtapp = os.path.join(config.VARS.internal_dir,
1560 "README_BIN_VIRTUAL_APP.template")
1561 readme_template_path_src = os.path.join(config.VARS.internal_dir,
1562 "README_SRC.template")
1563 readme_template_path_pro = os.path.join(config.VARS.internal_dir,
1564 "README_PROJECT.template")
1565 readme_template_path_sat = os.path.join(config.VARS.internal_dir,
1566 "README_SAT.template")
1568 # prepare substitution dictionary
1570 d['user'] = config.VARS.user
1571 d['date'] = datetime.datetime.now().strftime("%Y-%m-%d %H:%M")
1572 d['version'] = src.get_salometool_version(config)
1573 d['dist'] = config.VARS.dist
1574 f.write(readme_header_tpl.substitute(d)) # write the general header (common)
1576 if options.binaries or options.sources:
1577 d['application'] = config.VARS.application
1578 d['BINARIES'] = config.INTERNAL.config.binary_dir
1579 d['SEPARATOR'] = config.VARS.sep
1580 if src.architecture.is_windows():
1581 d['operatingSystem'] = 'Windows'
1582 d['PYTHON3'] = 'python3'
1583 d['ROOT'] = '%ROOT%'
1585 d['operatingSystem'] = 'Linux'
1588 f.write("# Application: " + d['application'] + "\n")
1589 if 'KERNEL' in config.APPLICATION.products:
1590 VersionSalome = src.get_salome_version(config)
1591 # Case where SALOME has the launcher that uses the SalomeContext API
1592 if VersionSalome >= MMP([7,3,0]):
1593 d['launcher'] = config.APPLICATION.profile.launcher_name
1595 d['virtual_app'] = 'runAppli' # this info is not used now)
1597 # write the specific sections
1598 if options.binaries:
1599 f.write(src.template.substitute(readme_template_path_bin, d))
1600 if "virtual_app" in d:
1601 f.write(src.template.substitute(readme_template_path_bin_virtapp, d))
1603 f.write(src.template.substitute(readme_template_path_bin_launcher, d))
1606 f.write(src.template.substitute(readme_template_path_src, d))
1608 if options.binaries and options.sources and not src.architecture.is_windows():
1609 f.write(readme_compilation_with_binaries)
1612 f.write(src.template.substitute(readme_template_path_pro, d))
1615 f.write(src.template.substitute(readme_template_path_sat, d))
1619 def update_config(config, logger, prop, value):
1620 '''Remove from config.APPLICATION.products the products that have the property given as input.
1622 :param config Config: The global config.
1623 :param prop str: The property to filter
1624 :param value str: The value of the property to filter
1626 # if there is no APPLICATION (ex sat package -t) : nothing to do
1627 if "APPLICATION" in config:
1628 l_product_to_remove = []
1629 for product_name in config.APPLICATION.products.keys():
1630 prod_cfg = src.product.get_product_config(config, product_name)
1631 if src.get_property_in_product_cfg(prod_cfg, prop) == value:
1632 l_product_to_remove.append(product_name)
1633 for product_name in l_product_to_remove:
1634 config.APPLICATION.products.__delitem__(product_name)
1635 logger.write("Remove product %s with property %s\n" % (product_name, prop), 5)
1638 '''method that is called when salomeTools is called with --help option.
1640 :return: The text to display for the package command description.
1644 The package command creates a tar file archive of a product.
1645 There are four kinds of archive, which can be mixed:
1647 1 - The binary archive.
1648 It contains the product installation directories plus a launcher.
1649 2 - The sources archive.
1650 It contains the product archives, a project (the application plus salomeTools).
1651 3 - The project archive.
1652 It contains a project (give the project file path as argument).
1653 4 - The salomeTools archive.
1654 It contains code utility salomeTools.
1657 >> sat package SALOME-master --binaries --sources""")
1659 def run(args, runner, logger):
1660 '''method that is called when salomeTools is called with package parameter.
1664 (options, args) = parser.parse_args(args)
1667 # Check that a type of package is called, and only one
1668 all_option_types = (options.binaries,
1670 options.project not in ["", None],
1672 options.bin_products)
1674 # Check if no option for package type
1675 if all_option_types.count(True) == 0:
1676 msg = _("Error: Precise a type for the package\nUse one of the "
1677 "following options: --binaries, --sources, --project or"
1678 " --salometools, --bin_products")
1679 logger.write(src.printcolors.printcError(msg), 1)
1680 logger.write("\n", 1)
1682 do_create_package = options.binaries or options.sources or options.project or options.sat
1684 if options.bin_products:
1685 ret = bin_products_archives(runner.cfg, logger, options.with_vcs)
1688 if not do_create_package:
1691 # continue to create a tar.gz package
1693 # The repository where to put the package if not Binary or Source
1694 package_default_path = runner.cfg.LOCAL.workdir
1695 # if the package contains binaries or sources:
1696 if options.binaries or options.sources or options.bin_products:
1697 # Check that the command has been called with an application
1698 src.check_config_has_application(runner.cfg)
1700 # Display information
1701 logger.write(_("Packaging application %s\n") % src.printcolors.printcLabel(
1702 runner.cfg.VARS.application), 1)
1704 # Get the default directory where to put the packages
1705 package_default_path = os.path.join(runner.cfg.APPLICATION.workdir, "PACKAGE")
1706 src.ensure_path_exists(package_default_path)
1708 # if the package contains a project:
1710 # check that the project is visible by SAT
1711 projectNameFile = options.project + ".pyconf"
1713 for i in runner.cfg.PROJECTS.project_file_paths:
1714 baseName = os.path.basename(i)
1715 if baseName == projectNameFile:
1719 if foundProject is None:
1720 local_path = os.path.join(runner.cfg.VARS.salometoolsway, "data", "local.pyconf")
1721 msg = _("""ERROR: the project %(1)s is not visible by salomeTools.
1725 Please add it in file:
1727 {"1": options.project, "2": "\n ".join(runner.cfg.PROJECTS.project_file_paths), "3": local_path})
1728 logger.write(src.printcolors.printcError(msg), 1)
1729 logger.write("\n", 1)
1732 options.project_file_path = foundProject
1733 src.printcolors.print_value(logger, "Project path", options.project_file_path, 2)
1735 # Remove the products that are filtered by the --without_properties option
1736 if options.without_properties:
1737 prop, value = options.without_properties
1738 update_config(runner.cfg, logger, prop, value)
1740 # Remove from config the products that have the not_in_package property
1741 update_config(runner.cfg, logger, "not_in_package", "yes")
1743 # get the name of the archive or build it
1745 if os.path.basename(options.name) == options.name:
1746 # only a name (not a path)
1747 archive_name = options.name
1748 dir_name = package_default_path
1750 archive_name = os.path.basename(options.name)
1751 dir_name = os.path.dirname(options.name)
1753 # suppress extension
1754 if archive_name[-len(".tgz"):] == ".tgz":
1755 archive_name = archive_name[:-len(".tgz")]
1756 if archive_name[-len(".tar.gz"):] == ".tar.gz":
1757 archive_name = archive_name[:-len(".tar.gz")]
1761 dir_name = package_default_path
1762 if options.binaries or options.sources:
1763 archive_name = runner.cfg.APPLICATION.name
1765 if options.binaries:
1766 archive_name += "-"+runner.cfg.VARS.dist
1769 archive_name += "-SRC"
1770 if options.with_vcs:
1771 archive_name += "-VCS"
1774 archive_name += ("salomeTools_" + src.get_salometool_version(runner.cfg))
1779 archive_name += ("satproject_" + options.project)
1781 if len(archive_name)==0: # no option worked
1782 msg = _("Error: Cannot name the archive\n"
1783 " check if at least one of the following options was "
1784 "selected : --binaries, --sources, --project or"
1786 logger.write(src.printcolors.printcError(msg), 1)
1787 logger.write("\n", 1)
1790 path_targz = os.path.join(dir_name, archive_name + PACKAGE_EXT)
1792 src.printcolors.print_value(logger, "Package path", path_targz, 2)
1794 # Create a working directory for all files that are produced during the
1795 # package creation and that will be removed at the end of the command
1796 tmp_working_dir = os.path.join(runner.cfg.VARS.tmp_root, runner.cfg.VARS.datehour)
1797 src.ensure_path_exists(tmp_working_dir)
1798 logger.write("\n", 5)
1799 logger.write(_("The temporary working directory: %s\n" % tmp_working_dir),5)
1801 logger.write("\n", 3)
1803 msg = _("Preparation of files to add to the archive")
1804 logger.write(src.printcolors.printcLabel(msg), 2)
1805 logger.write("\n", 2)
1807 d_files_to_add={} # content of the archive
1809 # a dict to hold paths that will need to be substitute for users recompilations
1810 d_paths_to_substitute={}
1812 if options.binaries:
1813 d_bin_files_to_add = binary_package(runner.cfg,
1817 # for all binaries dir, store the substitution that will be required
1818 # for extra compilations
1819 for key in d_bin_files_to_add:
1820 if key.endswith("(bin)"):
1821 source_dir = d_bin_files_to_add[key][0]
1822 path_in_archive = d_bin_files_to_add[key][1].replace(
1823 runner.cfg.INTERNAL.config.binary_dir + runner.cfg.VARS.dist,
1824 runner.cfg.INTERNAL.config.install_dir)
1825 if os.path.basename(source_dir)==os.path.basename(path_in_archive):
1826 # if basename is the same we will just substitute the dirname
1827 d_paths_to_substitute[os.path.dirname(source_dir)]=\
1828 os.path.dirname(path_in_archive)
1830 d_paths_to_substitute[source_dir]=path_in_archive
1832 d_files_to_add.update(d_bin_files_to_add)
1834 d_files_to_add.update(source_package(runner,
1839 if options.binaries:
1840 # for archives with bin and sources we provide a shell script able to
1841 # install binaries for compilation
1842 file_install_bin=produce_install_bin_file(runner.cfg,logger,
1844 d_paths_to_substitute,
1846 d_files_to_add.update({"install_bin" : (file_install_bin, "install_bin.sh")})
1847 logger.write("substitutions that need to be done later : \n", 5)
1848 logger.write(str(d_paths_to_substitute), 5)
1849 logger.write("\n", 5)
1851 # --salomeTool option is not considered when --sources is selected, as this option
1852 # already brings salomeTool!
1854 d_files_to_add.update(sat_package(runner.cfg, tmp_working_dir,
1858 DBG.write("config for package %s" % options.project, runner.cfg)
1859 d_files_to_add.update(project_package(runner.cfg, options.project, options.project_file_path, options.ftp, tmp_working_dir, options.sat, logger))
1861 if not(d_files_to_add):
1862 msg = _("Error: Empty dictionnary to build the archive!\n")
1863 logger.write(src.printcolors.printcError(msg), 1)
1864 logger.write("\n", 1)
1867 # Add the README file in the package
1868 local_readme_tmp_path = add_readme(runner.cfg, options, tmp_working_dir)
1869 d_files_to_add["README"] = (local_readme_tmp_path, "README")
1871 # Add the additional files of option add_files
1872 if options.add_files:
1873 for file_path in options.add_files:
1874 if not os.path.exists(file_path):
1875 msg = _("WARNING: the file %s is not accessible.\n" % file_path)
1877 file_name = os.path.basename(file_path)
1878 d_files_to_add[file_name] = (file_path, file_name)
1880 logger.write("\n", 2)
1881 logger.write(src.printcolors.printcLabel(_("Actually do the package")), 2)
1882 logger.write("\n", 2)
1883 logger.write("\nfiles and directories to add:\n%s\n\n" % PP.pformat(d_files_to_add), 5)
1887 # Creating the object tarfile
1888 tar = tarfile.open(path_targz, mode='w:gz')
1890 # get the filtering function if needed
1892 filter_function = exclude_VCS_and_extensions_26
1894 filter_function = exclude_VCS_and_extensions
1896 # Add the files to the tarfile object
1897 res = add_files(tar, archive_name, d_files_to_add, logger, f_exclude=filter_function)
1899 except KeyboardInterrupt:
1900 logger.write(src.printcolors.printcError("\nERROR: forced interruption\n"), 1)
1901 logger.write(_("Removing the temporary working directory '%s'... ") % tmp_working_dir, 1)
1902 # remove the working directory
1903 shutil.rmtree(tmp_working_dir)
1904 logger.write(_("OK"), 1)
1905 logger.write(_("\n"), 1)
1908 # case if no application, only package sat as 'sat package -t'
1910 app = runner.cfg.APPLICATION
1914 # unconditionaly remove the tmp_local_working_dir
1916 tmp_local_working_dir = os.path.join(app.workdir, "tmp_package")
1917 if os.path.isdir(tmp_local_working_dir):
1918 shutil.rmtree(tmp_local_working_dir)
1920 # remove the tmp directory, unless user has registered as developer
1921 if os.path.isdir(tmp_working_dir) and (not DBG.isDeveloper()):
1922 shutil.rmtree(tmp_working_dir)
1924 # Print again the path of the package
1925 logger.write("\n", 2)
1926 src.printcolors.print_value(logger, "Package path", path_targz, 2)