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
29 from application import get_SALOME_modules
36 ARCHIVE_DIR = "ARCHIVES"
37 PROJECT_DIR = "PROJECT"
39 IGNORED_DIRS = [".git", ".svn"]
40 IGNORED_EXTENSIONS = []
42 PROJECT_TEMPLATE = """#!/usr/bin/env python
45 # The path to the archive root directory
46 root_path : $PWD + "/../"
48 project_path : $PWD + "/"
50 # Where to search the archives of the products
51 ARCHIVEPATH : $root_path + "ARCHIVES"
52 # Where to search the pyconf of the applications
53 APPLICATIONPATH : $project_path + "applications/"
54 # Where to search the pyconf of the products
55 PRODUCTPATH : $project_path + "products/"
56 # Where to search the pyconf of the jobs of the project
57 JOBPATH : $project_path + "jobs/"
58 # Where to search the pyconf of the machines of the project
59 MACHINEPATH : $project_path + "machines/"
62 LOCAL_TEMPLATE = ("""#!/usr/bin/env python
76 project_file_paths : [$VARS.salometoolsway + $VARS.sep + \"..\" + $VARS.sep"""
77 """ + \"""" + PROJECT_DIR + """\" + $VARS.sep + "project.pyconf"]
81 # Define all possible option for the package command : sat package <options>
82 parser = src.options.Options()
83 parser.add_option('b', 'binaries', 'boolean', 'binaries',
84 _('Optional: Produce a binary package.'), False)
85 parser.add_option('f', 'force_creation', 'boolean', 'force_creation',
86 _('Optional: Only binary package: produce the archive even if '
87 'there are some missing products.'), False)
88 parser.add_option('s', 'sources', 'boolean', 'sources',
89 _('Optional: Produce a compilable archive of the sources of the '
90 'application.'), False)
91 parser.add_option('', 'with_vcs', 'boolean', 'with_vcs',
92 _('Optional: Only source package: do not make archive of vcs products.'),
94 parser.add_option('p', 'project', 'string', 'project',
95 _('Optional: Produce an archive that contains a project.'), "")
96 parser.add_option('t', 'salometools', 'boolean', 'sat',
97 _('Optional: Produce an archive that contains salomeTools.'), False)
98 parser.add_option('n', 'name', 'string', 'name',
99 _('Optional: The name or full path of the archive.'), None)
100 parser.add_option('', 'add_files', 'list2', 'add_files',
101 _('Optional: The list of additional files to add to the archive.'), [])
102 parser.add_option('', 'without_commercial', 'boolean', 'without_commercial',
103 _('Optional: do not add commercial licence.'), False)
104 parser.add_option('', 'without_property', 'string', 'without_property',
105 _('Optional: Filter the products by their properties.\n\tSyntax: '
106 '--without_property <property>:<value>'))
109 def add_files(tar, name_archive, d_content, logger, f_exclude=None):
110 '''Create an archive containing all directories and files that are given in
111 the d_content argument.
113 :param tar tarfile: The tarfile instance used to make the archive.
114 :param name_archive str: The name of the archive to make.
115 :param d_content dict: The dictionary that contain all directories and files
116 to add in the archive.
118 (path_on_local_machine, path_in_archive)
119 :param logger Logger: the logging instance
120 :param f_exclude Function: the function that filters
121 :return: 0 if success, 1 if not.
124 # get the max length of the messages in order to make the display
125 max_len = len(max(d_content.keys(), key=len))
128 # loop over each directory or file stored in the d_content dictionary
129 for name in d_content.keys():
130 # display information
131 len_points = max_len - len(name)
132 logger.write(name + " " + len_points * "." + " ", 3)
133 # Get the local path and the path in archive
134 # of the directory or file to add
135 local_path, archive_path = d_content[name]
136 in_archive = os.path.join(name_archive, archive_path)
137 # Add it in the archive
139 tar.add(local_path, arcname=in_archive, exclude=f_exclude)
140 logger.write(src.printcolors.printcSuccess(_("OK")), 3)
141 except Exception as e:
142 logger.write(src.printcolors.printcError(_("KO ")), 3)
143 logger.write(str(e), 3)
145 logger.write("\n", 3)
148 def exclude_VCS_and_extensions(filename):
149 ''' The function that is used to exclude from package the link to the
150 VCS repositories (like .git)
152 :param filename Str: The filname to exclude (or not).
153 :return: True if the file has to be exclude
156 for dir_name in IGNORED_DIRS:
157 if dir_name in filename:
159 for extension in IGNORED_EXTENSIONS:
160 if filename.endswith(extension):
164 def produce_relative_launcher(config,
169 with_commercial=True):
170 '''Create a specific SALOME launcher for the binary package. This launcher
173 :param config Config: The global configuration.
174 :param logger Logger: the logging instance
175 :param file_dir str: the directory where to put the launcher
176 :param file_name str: The launcher name
177 :param binaries_dir_name str: the name of the repository where the binaries
179 :return: the path of the produced launcher
183 # get KERNEL installation path
184 kernel_root_dir = os.path.join(binaries_dir_name, "KERNEL")
186 # set kernel bin dir (considering fhs property)
187 kernel_cfg = src.product.get_product_config(config, "KERNEL")
188 if src.get_property_in_product_cfg(kernel_cfg, "fhs"):
189 bin_kernel_install_dir = os.path.join(kernel_root_dir,"bin")
191 bin_kernel_install_dir = os.path.join(kernel_root_dir,"bin","salome")
193 # Get the launcher template and do substitutions
194 withProfile = src.fileEnviron.withProfile
196 withProfile = withProfile.replace(
197 "ABSOLUTE_APPLI_PATH'] = 'KERNEL_INSTALL_DIR'",
198 "ABSOLUTE_APPLI_PATH'] = out_dir_Path + '" + config.VARS.sep + kernel_root_dir + "'")
199 withProfile = withProfile.replace(
200 " 'BIN_KERNEL_INSTALL_DIR'",
201 " out_dir_Path + '" + config.VARS.sep + bin_kernel_install_dir + "'")
203 before, after = withProfile.split(
204 "# here your local standalone environment\n")
206 # create an environment file writer
207 writer = src.environment.FileEnvWriter(config,
212 filepath = os.path.join(file_dir, file_name)
213 # open the file and write into it
214 launch_file = open(filepath, "w")
215 launch_file.write(before)
217 writer.write_cfgForPy_file(launch_file,
218 for_package = binaries_dir_name,
219 with_commercial=with_commercial)
220 launch_file.write(after)
223 # Little hack to put out_dir_Path outside the strings
224 src.replace_in_file(filepath, 'r"out_dir_Path', 'out_dir_Path + r"' )
226 # A hack to put a call to a file for distene licence.
227 # It does nothing to an application that has no distene product
228 hack_for_distene_licence(filepath)
230 # change the rights in order to make the file executable for everybody
242 def hack_for_distene_licence(filepath):
243 '''Replace the distene licence env variable by a call to a file.
245 :param filepath Str: The path to the launcher to modify.
247 shutil.move(filepath, filepath + "_old")
249 filein = filepath + "_old"
250 fin = open(filein, "r")
251 fout = open(fileout, "w")
252 text = fin.readlines()
253 # Find the Distene section
255 for i,line in enumerate(text):
256 if "# Set DISTENE License" in line:
260 # No distene product, there is nothing to do
266 del text[num_line +1]
267 del text[num_line +1]
268 text_to_insert =""" import imp
270 distene = imp.load_source('distene_licence', '/data/tmpsalome/salome/prerequis/install/LICENSE/dlim8.var.py')
271 distene.set_distene_variables(context)
274 text.insert(num_line + 1, text_to_insert)
281 def produce_relative_env_files(config,
285 '''Create some specific environment files for the binary package. These
286 files use relative paths.
288 :param config Config: The global configuration.
289 :param logger Logger: the logging instance
290 :param file_dir str: the directory where to put the files
291 :param binaries_dir_name str: the name of the repository where the binaries
293 :return: the list of path of the produced environment files
296 # create an environment file writer
297 writer = src.environment.FileEnvWriter(config,
303 filepath = writer.write_env_file("env_launch.sh",
306 for_package = binaries_dir_name)
308 # Little hack to put out_dir_Path as environment variable
309 src.replace_in_file(filepath, '"out_dir_Path', '"${out_dir_Path}' )
311 # change the rights in order to make the file executable for everybody
323 def produce_install_bin_file(config,
328 '''Create a bash shell script which do substitutions in BIRARIES dir
329 in order to use it for extra compilations.
331 :param config Config: The global configuration.
332 :param logger Logger: the logging instance
333 :param file_dir str: the directory where to put the files
334 :param d_sub, dict: the dictionnary that contains the substitutions to be done
335 :param file_name str: the name of the install script file
336 :return: the produced file
340 filepath = os.path.join(file_dir, file_name)
341 # open the file and write into it
342 # use codec utf-8 as sat variables are in unicode
343 with codecs.open(filepath, "w", 'utf-8') as installbin_file:
344 installbin_template_path = os.path.join(config.VARS.internal_dir,
345 "INSTALL_BIN.template")
347 # build the name of the directory that will contain the binaries
348 binaries_dir_name = "BINARIES-" + config.VARS.dist
349 # build the substitution loop
350 loop_cmd = "for f in $(grep -RIl"
352 loop_cmd += " -e "+ key
353 loop_cmd += ' INSTALL); do\n sed -i "\n'
355 loop_cmd += " s?" + key + "?$(pwd)/" + d_sub[key] + "?g\n"
356 loop_cmd += ' " $f\ndone'
359 d["BINARIES_DIR"] = binaries_dir_name
360 d["SUBSTITUTION_LOOP"]=loop_cmd
362 # substitute the template and write it in file
363 content=src.template.substitute(installbin_template_path, d)
364 installbin_file.write(content)
365 # change the rights in order to make the file executable for everybody
377 def product_appli_creation_script(config,
381 '''Create a script that can produce an application (EDF style) in the binary
384 :param config Config: The global configuration.
385 :param logger Logger: the logging instance
386 :param file_dir str: the directory where to put the file
387 :param binaries_dir_name str: the name of the repository where the binaries
389 :return: the path of the produced script file
392 template_name = "create_appli.py.for_bin_packages.template"
393 template_path = os.path.join(config.VARS.internal_dir, template_name)
394 text_to_fill = open(template_path, "r").read()
395 text_to_fill = text_to_fill.replace("TO BE FILLED 1",
396 '"' + binaries_dir_name + '"')
399 for product_name in get_SALOME_modules(config):
400 product_info = src.product.get_product_config(config, product_name)
402 if src.product.product_is_smesh_plugin(product_info):
405 if 'install_dir' in product_info and bool(product_info.install_dir):
406 if src.product.product_is_cpp(product_info):
408 for cpp_name in src.product.get_product_components(product_info):
409 line_to_add = ("<module name=\"" +
411 "\" gui=\"yes\" path=\"''' + "
412 "os.path.join(dir_bin_name, \"" +
413 cpp_name + "\") + '''\"/>")
416 line_to_add = ("<module name=\"" +
418 "\" gui=\"yes\" path=\"''' + "
419 "os.path.join(dir_bin_name, \"" +
420 product_name + "\") + '''\"/>")
421 text_to_add += line_to_add + "\n"
423 filled_text = text_to_fill.replace("TO BE FILLED 2", text_to_add)
425 tmp_file_path = os.path.join(file_dir, "create_appli.py")
426 ff = open(tmp_file_path, "w")
427 ff.write(filled_text)
430 # change the rights in order to make the file executable for everybody
431 os.chmod(tmp_file_path,
442 def binary_package(config, logger, options, tmp_working_dir):
443 '''Prepare a dictionary that stores all the needed directories and files to
444 add in a binary package.
446 :param config Config: The global configuration.
447 :param logger Logger: the logging instance
448 :param options OptResult: the options of the launched command
449 :param tmp_working_dir str: The temporary local directory containing some
450 specific directories or files needed in the
452 :return: the dictionary that stores all the needed directories and files to
453 add in a binary package.
454 {label : (path_on_local_machine, path_in_archive)}
458 # Get the list of product installation to add to the archive
459 l_products_name = config.APPLICATION.products.keys()
460 l_product_info = src.product.get_products_infos(l_products_name,
465 l_sources_not_present = []
466 for prod_name, prod_info in l_product_info:
468 # Add the sources of the products that have the property
469 # sources_in_package : "yes"
470 if src.get_property_in_product_cfg(prod_info,
471 "sources_in_package") == "yes":
472 if os.path.exists(prod_info.source_dir):
473 l_source_dir.append((prod_name, prod_info.source_dir))
475 l_sources_not_present.append(prod_name)
477 # ignore the native and fixed products for install directories
478 if (src.product.product_is_native(prod_info)
479 or src.product.product_is_fixed(prod_info)
480 or not src.product.product_compiles(prod_info)):
482 if src.product.check_installation(prod_info):
483 l_install_dir.append((prod_name, prod_info.install_dir))
485 l_not_installed.append(prod_name)
487 # Add also the cpp generated modules (if any)
488 if src.product.product_is_cpp(prod_info):
490 for name_cpp in src.product.get_product_components(prod_info):
491 install_dir = os.path.join(config.APPLICATION.workdir,
493 if os.path.exists(install_dir):
494 l_install_dir.append((name_cpp, install_dir))
496 l_not_installed.append(name_cpp)
498 # Print warning or error if there are some missing products
499 if len(l_not_installed) > 0:
500 text_missing_prods = ""
501 for p_name in l_not_installed:
502 text_missing_prods += "-" + p_name + "\n"
503 if not options.force_creation:
504 msg = _("ERROR: there are missing products installations:")
505 logger.write("%s\n%s" % (src.printcolors.printcError(msg),
510 msg = _("WARNING: there are missing products installations:")
511 logger.write("%s\n%s" % (src.printcolors.printcWarning(msg),
515 # Do the same for sources
516 if len(l_sources_not_present) > 0:
517 text_missing_prods = ""
518 for p_name in l_sources_not_present:
519 text_missing_prods += "-" + p_name + "\n"
520 if not options.force_creation:
521 msg = _("ERROR: there are missing products sources:")
522 logger.write("%s\n%s" % (src.printcolors.printcError(msg),
527 msg = _("WARNING: there are missing products sources:")
528 logger.write("%s\n%s" % (src.printcolors.printcWarning(msg),
532 # construct the name of the directory that will contain the binaries
533 binaries_dir_name = "BINARIES-" + config.VARS.dist
535 # construct the correlation table between the product names, there
536 # actual install directories and there install directory in archive
538 for prod_name, install_dir in l_install_dir:
539 path_in_archive = os.path.join(binaries_dir_name, prod_name)
540 d_products[prod_name + " (bin)"] = (install_dir, path_in_archive)
542 for prod_name, source_dir in l_source_dir:
543 path_in_archive = os.path.join("SOURCES", prod_name)
544 d_products[prod_name + " (sources)"] = (source_dir, path_in_archive)
546 # create the relative launcher and add it to the files to add
547 VersionSalome = src.get_salome_version(config)
548 # Case where SALOME has the launcher that uses the SalomeContext API
549 if VersionSalome >= 730:
550 launcher_name = src.get_launcher_name(config)
551 launcher_package = produce_relative_launcher(config,
556 not(options.without_commercial))
558 d_products["launcher"] = (launcher_package, launcher_name)
560 # if we mix binaries and sources, we add a copy of the launcher,
561 # prefixed with "bin",in order to avoid clashes
562 d_products["launcher (copy)"] = (launcher_package, "bin"+launcher_name)
564 # Provide a script for the creation of an application EDF style
565 appli_script = product_appli_creation_script(config,
570 d_products["appli script"] = (appli_script, "create_appli.py")
572 # Put also the environment file
573 env_file = produce_relative_env_files(config,
578 d_products["environment file"] = (env_file, "env_launch.sh")
582 def source_package(sat, config, logger, options, tmp_working_dir):
583 '''Prepare a dictionary that stores all the needed directories and files to
584 add in a source package.
586 :param config Config: The global configuration.
587 :param logger Logger: the logging instance
588 :param options OptResult: the options of the launched command
589 :param tmp_working_dir str: The temporary local directory containing some
590 specific directories or files needed in the
592 :return: the dictionary that stores all the needed directories and files to
593 add in a source package.
594 {label : (path_on_local_machine, path_in_archive)}
598 # Get all the products that are prepared using an archive
599 logger.write("Find archive products ... ")
600 d_archives, l_pinfo_vcs = get_archives(config, logger)
601 logger.write("Done\n")
603 if not options.with_vcs and len(l_pinfo_vcs) > 0:
604 # Make archives with the products that are not prepared using an archive
605 # (git, cvs, svn, etc)
606 logger.write("Construct archives for vcs products ... ")
607 d_archives_vcs = get_archives_vcs(l_pinfo_vcs,
612 logger.write("Done\n")
615 logger.write("Create the project ... ")
616 d_project = create_project_for_src_package(config,
619 logger.write("Done\n")
622 tmp_sat = add_salomeTools(config, tmp_working_dir)
623 d_sat = {"salomeTools" : (tmp_sat, "salomeTools")}
625 # Add a sat symbolic link if not win
626 if not src.architecture.is_windows():
627 tmp_satlink_path = os.path.join(tmp_working_dir, 'sat')
631 # In the jobs, os.getcwd() can fail
632 t = config.LOCAL.workdir
633 os.chdir(tmp_working_dir)
634 if os.path.lexists(tmp_satlink_path):
635 os.remove(tmp_satlink_path)
636 os.symlink(os.path.join('salomeTools', 'sat'), 'sat')
639 d_sat["sat link"] = (tmp_satlink_path, "sat")
641 d_source = src.merge_dicts(d_archives, d_archives_vcs, d_project, d_sat)
644 def get_archives(config, logger):
645 '''Find all the products that are get using an archive and all the products
646 that are get using a vcs (git, cvs, svn) repository.
648 :param config Config: The global configuration.
649 :param logger Logger: the logging instance
650 :return: the dictionary {name_product :
651 (local path of its archive, path in the package of its archive )}
652 and the list of specific configuration corresponding to the vcs
656 # Get the list of product informations
657 l_products_name = config.APPLICATION.products.keys()
658 l_product_info = src.product.get_products_infos(l_products_name,
662 for p_name, p_info in l_product_info:
663 # ignore the native and fixed products
664 if (src.product.product_is_native(p_info)
665 or src.product.product_is_fixed(p_info)):
667 if p_info.get_source == "archive":
668 archive_path = p_info.archive_info.archive_name
669 archive_name = os.path.basename(archive_path)
671 l_pinfo_vcs.append((p_name, p_info))
673 d_archives[p_name] = (archive_path,
674 os.path.join(ARCHIVE_DIR, archive_name))
675 return d_archives, l_pinfo_vcs
677 def add_salomeTools(config, tmp_working_dir):
678 '''Prepare a version of salomeTools that has a specific local.pyconf file
679 configured for a source package.
681 :param config Config: The global configuration.
682 :param tmp_working_dir str: The temporary local directory containing some
683 specific directories or files needed in the
685 :return: The path to the local salomeTools directory to add in the package
688 # Copy sat in the temporary working directory
689 sat_tmp_path = src.Path(os.path.join(tmp_working_dir, "salomeTools"))
690 sat_running_path = src.Path(config.VARS.salometoolsway)
691 sat_running_path.copy(sat_tmp_path)
693 # Update the local.pyconf file that contains the path to the project
694 local_pyconf_name = "local.pyconf"
695 local_pyconf_dir = os.path.join(tmp_working_dir, "salomeTools", "data")
696 local_pyconf_file = os.path.join(local_pyconf_dir, local_pyconf_name)
697 # Remove the .pyconf file in the root directory of salomeTools if there is
698 # any. (For example when launching jobs, a pyconf file describing the jobs
699 # can be here and is not useful)
700 files_or_dir_SAT = os.listdir(os.path.join(tmp_working_dir, "salomeTools"))
701 for file_or_dir in files_or_dir_SAT:
702 if file_or_dir.endswith(".pyconf") or file_or_dir.endswith(".txt"):
703 file_path = os.path.join(tmp_working_dir,
708 ff = open(local_pyconf_file, "w")
709 ff.write(LOCAL_TEMPLATE)
712 return sat_tmp_path.path
714 def get_archives_vcs(l_pinfo_vcs, sat, config, logger, tmp_working_dir):
715 '''For sources package that require that all products are get using an
716 archive, one has to create some archive for the vcs products.
717 So this method calls the clean and source command of sat and then create
720 :param l_pinfo_vcs List: The list of specific configuration corresponding to
722 :param sat Sat: The Sat instance that can be called to clean and source the
724 :param config Config: The global configuration.
725 :param logger Logger: the logging instance
726 :param tmp_working_dir str: The temporary local directory containing some
727 specific directories or files needed in the
729 :return: the dictionary that stores all the archives to add in the source
730 package. {label : (path_on_local_machine, path_in_archive)}
733 # clean the source directory of all the vcs products, then use the source
734 # command and thus construct an archive that will not contain the patches
735 l_prod_names = [pn for pn, __ in l_pinfo_vcs]
737 logger.write(_("clean sources\n"))
738 args_clean = config.VARS.application
739 args_clean += " --sources --products "
740 args_clean += ",".join(l_prod_names)
741 sat.clean(args_clean, batch=True, verbose=0, logger_add_link = logger)
743 logger.write(_("get sources"))
744 args_source = config.VARS.application
745 args_source += " --products "
746 args_source += ",".join(l_prod_names)
747 sat.source(args_source, batch=True, verbose=0, logger_add_link = logger)
749 # make the new archives
751 for pn, pinfo in l_pinfo_vcs:
752 path_archive = make_archive(pn, pinfo, tmp_working_dir)
753 d_archives_vcs[pn] = (path_archive,
754 os.path.join(ARCHIVE_DIR, pn + ".tgz"))
755 return d_archives_vcs
757 def make_archive(prod_name, prod_info, where):
758 '''Create an archive of a product by searching its source directory.
760 :param prod_name str: The name of the product.
761 :param prod_info Config: The specific configuration corresponding to the
763 :param where str: The path of the repository where to put the resulting
765 :return: The path of the resulting archive
768 path_targz_prod = os.path.join(where, prod_name + ".tgz")
769 tar_prod = tarfile.open(path_targz_prod, mode='w:gz')
770 local_path = prod_info.source_dir
771 tar_prod.add(local_path,
773 exclude=exclude_VCS_and_extensions)
775 return path_targz_prod
777 def create_project_for_src_package(config, tmp_working_dir, with_vcs):
778 '''Create a specific project for a source package.
780 :param config Config: The global configuration.
781 :param tmp_working_dir str: The temporary local directory containing some
782 specific directories or files needed in the
784 :param with_vcs boolean: True if the package is with vcs products (not
785 transformed into archive products)
786 :return: The dictionary
787 {"project" : (produced project, project path in the archive)}
791 # Create in the working temporary directory the full project tree
792 project_tmp_dir = os.path.join(tmp_working_dir, PROJECT_DIR)
793 products_pyconf_tmp_dir = os.path.join(project_tmp_dir,
795 compil_scripts_tmp_dir = os.path.join(project_tmp_dir,
798 env_scripts_tmp_dir = os.path.join(project_tmp_dir,
801 patches_tmp_dir = os.path.join(project_tmp_dir,
804 application_tmp_dir = os.path.join(project_tmp_dir,
806 for directory in [project_tmp_dir,
807 compil_scripts_tmp_dir,
810 application_tmp_dir]:
811 src.ensure_path_exists(directory)
813 # Create the pyconf that contains the information of the project
814 project_pyconf_name = "project.pyconf"
815 project_pyconf_file = os.path.join(project_tmp_dir, project_pyconf_name)
816 ff = open(project_pyconf_file, "w")
817 ff.write(PROJECT_TEMPLATE)
820 # Loop over the products to get there pyconf and all the scripts
821 # (compilation, environment, patches)
822 # and create the pyconf file to add to the project
823 lproducts_name = config.APPLICATION.products.keys()
824 l_products = src.product.get_products_infos(lproducts_name, config)
825 for p_name, p_info in l_products:
826 find_product_scripts_and_pyconf(p_name,
830 compil_scripts_tmp_dir,
833 products_pyconf_tmp_dir)
835 find_application_pyconf(config, application_tmp_dir)
837 d_project = {"project" : (project_tmp_dir, PROJECT_DIR )}
840 def find_product_scripts_and_pyconf(p_name,
844 compil_scripts_tmp_dir,
847 products_pyconf_tmp_dir):
848 '''Create a specific pyconf file for a given product. Get its environment
849 script, its compilation script and patches and put it in the temporary
850 working directory. This method is used in the source package in order to
851 construct the specific project.
853 :param p_name str: The name of the product.
854 :param p_info Config: The specific configuration corresponding to the
856 :param config Config: The global configuration.
857 :param with_vcs boolean: True if the package is with vcs products (not
858 transformed into archive products)
859 :param compil_scripts_tmp_dir str: The path to the temporary compilation
860 scripts directory of the project.
861 :param env_scripts_tmp_dir str: The path to the temporary environment script
862 directory of the project.
863 :param patches_tmp_dir str: The path to the temporary patch scripts
864 directory of the project.
865 :param products_pyconf_tmp_dir str: The path to the temporary product
866 scripts directory of the project.
869 # read the pyconf of the product
870 product_pyconf_path = src.find_file_in_lpath(p_name + ".pyconf",
871 config.PATHS.PRODUCTPATH)
872 product_pyconf_cfg = src.pyconf.Config(product_pyconf_path)
874 # find the compilation script if any
875 if src.product.product_has_script(p_info):
876 compil_script_path = src.Path(p_info.compil_script)
877 compil_script_path.copy(compil_scripts_tmp_dir)
878 product_pyconf_cfg[p_info.section].compil_script = os.path.basename(
879 p_info.compil_script)
880 # find the environment script if any
881 if src.product.product_has_env_script(p_info):
882 env_script_path = src.Path(p_info.environ.env_script)
883 env_script_path.copy(env_scripts_tmp_dir)
884 product_pyconf_cfg[p_info.section].environ.env_script = os.path.basename(
885 p_info.environ.env_script)
886 # find the patches if any
887 if src.product.product_has_patches(p_info):
888 patches = src.pyconf.Sequence()
889 for patch_path in p_info.patches:
890 p_path = src.Path(patch_path)
891 p_path.copy(patches_tmp_dir)
892 patches.append(os.path.basename(patch_path), "")
894 product_pyconf_cfg[p_info.section].patches = patches
897 # put in the pyconf file the resolved values
898 for info in ["git_info", "cvs_info", "svn_info"]:
900 for key in p_info[info]:
901 product_pyconf_cfg[p_info.section][info][key] = p_info[
904 # if the product is not archive, then make it become archive.
905 if src.product.product_is_vcs(p_info):
906 product_pyconf_cfg[p_info.section].get_source = "archive"
907 if not "archive_info" in product_pyconf_cfg[p_info.section]:
908 product_pyconf_cfg[p_info.section].addMapping("archive_info",
909 src.pyconf.Mapping(product_pyconf_cfg),
911 product_pyconf_cfg[p_info.section
912 ].archive_info.archive_name = p_info.name + ".tgz"
914 # write the pyconf file to the temporary project location
915 product_tmp_pyconf_path = os.path.join(products_pyconf_tmp_dir,
917 ff = open(product_tmp_pyconf_path, 'w')
918 ff.write("#!/usr/bin/env python\n#-*- coding:utf-8 -*-\n\n")
919 product_pyconf_cfg.__save__(ff, 1)
922 def find_application_pyconf(config, application_tmp_dir):
923 '''Find the application pyconf file and put it in the specific temporary
924 directory containing the specific project of a source package.
926 :param config Config: The global configuration.
927 :param application_tmp_dir str: The path to the temporary application
928 scripts directory of the project.
930 # read the pyconf of the application
931 application_name = config.VARS.application
932 application_pyconf_path = src.find_file_in_lpath(
933 application_name + ".pyconf",
934 config.PATHS.APPLICATIONPATH)
935 application_pyconf_cfg = src.pyconf.Config(application_pyconf_path)
938 application_pyconf_cfg.APPLICATION.workdir = src.pyconf.Reference(
939 application_pyconf_cfg,
941 'VARS.salometoolsway + $VARS.sep + ".."')
943 # Prevent from compilation in base
944 application_pyconf_cfg.APPLICATION.no_base = "yes"
946 # write the pyconf file to the temporary application location
947 application_tmp_pyconf_path = os.path.join(application_tmp_dir,
948 application_name + ".pyconf")
949 ff = open(application_tmp_pyconf_path, 'w')
950 ff.write("#!/usr/bin/env python\n#-*- coding:utf-8 -*-\n\n")
951 application_pyconf_cfg.__save__(ff, 1)
954 def project_package(project_file_path, tmp_working_dir):
955 '''Prepare a dictionary that stores all the needed directories and files to
956 add in a project package.
958 :param project_file_path str: The path to the local project.
959 :param tmp_working_dir str: The temporary local directory containing some
960 specific directories or files needed in the
962 :return: the dictionary that stores all the needed directories and files to
963 add in a project package.
964 {label : (path_on_local_machine, path_in_archive)}
968 # Read the project file and get the directories to add to the package
969 project_pyconf_cfg = src.pyconf.Config(project_file_path)
970 paths = {"ARCHIVEPATH" : "archives",
971 "APPLICATIONPATH" : "applications",
972 "PRODUCTPATH" : "products",
974 "MACHINEPATH" : "machines"}
975 # Loop over the project paths and add it
977 if path not in project_pyconf_cfg:
979 # Add the directory to the files to add in the package
980 d_project[path] = (project_pyconf_cfg[path], paths[path])
981 # Modify the value of the path in the package
982 project_pyconf_cfg[path] = src.pyconf.Reference(
985 'project_path + "/' + paths[path] + '"')
988 if "project_path" not in project_pyconf_cfg:
989 project_pyconf_cfg.addMapping("project_path",
990 src.pyconf.Mapping(project_pyconf_cfg),
992 project_pyconf_cfg.project_path = src.pyconf.Reference(project_pyconf_cfg,
996 # Write the project pyconf file
997 project_file_name = os.path.basename(project_file_path)
998 project_pyconf_tmp_path = os.path.join(tmp_working_dir, project_file_name)
999 ff = open(project_pyconf_tmp_path, 'w')
1000 ff.write("#!/usr/bin/env python\n#-*- coding:utf-8 -*-\n\n")
1001 project_pyconf_cfg.__save__(ff, 1)
1003 d_project["Project hat file"] = (project_pyconf_tmp_path, project_file_name)
1007 def add_readme(config, options, where):
1008 readme_path = os.path.join(where, "README")
1009 with codecs.open(readme_path, "w", 'utf-8') as f:
1011 # templates for building the header
1013 # This package was generated with sat $version
1016 # Distribution : $dist
1018 In the following, $$ROOT represents the directory where you have installed
1019 SALOME (the directory where this file is located).
1022 readme_compilation_with_binaries="""
1024 compilation based on the binaries used as prerequisites
1025 =======================================================
1027 If you fail to compile the complete application (for example because
1028 you are not root on your system and cannot install missing packages), you
1029 may try a partial compilation based on the binaries.
1030 For that it is necessary to copy the binaries from BINARIES to INSTALL,
1031 and do some substitutions on cmake and .la files (replace the build directories
1033 The procedure to do it is:
1034 1) Remove or rename INSTALL directory if it exists
1035 2) Execute the shell script install_bin.sh:
1038 3) Use SalomeTool (as explained in Sources section) and compile only the
1039 modules you need to (with -p option)
1042 readme_header_tpl=string.Template(readme_header)
1043 readme_template_path_bin_prof = os.path.join(config.VARS.internal_dir,
1044 "README_BIN.template")
1045 readme_template_path_bin_noprof = os.path.join(config.VARS.internal_dir,
1046 "README_BIN_NO_PROFILE.template")
1047 readme_template_path_src = os.path.join(config.VARS.internal_dir,
1048 "README_SRC.template")
1049 readme_template_path_pro = os.path.join(config.VARS.internal_dir,
1050 "README_PROJECT.template")
1051 readme_template_path_sat = os.path.join(config.VARS.internal_dir,
1052 "README_SAT.template")
1054 # prepare substitution dictionary
1056 d['user'] = config.VARS.user
1057 d['date'] = datetime.datetime.now().strftime("%Y-%m-%d %H:%M")
1058 d['version'] = config.INTERNAL.sat_version
1059 d['dist'] = config.VARS.dist
1060 f.write(readme_header_tpl.substitute(d)) # write the general header (common)
1062 if options.binaries or options.sources:
1063 d['application'] = config.VARS.application
1064 f.write("# Application: " + d['application'])
1065 if 'profile' in config.APPLICATION:
1066 d['launcher'] = config.APPLICATION.profile.launcher_name
1068 d['env_file'] = 'env_launch.sh'
1070 # write the specific sections
1071 if options.binaries:
1073 f.write(src.template.substitute(readme_template_path_bin_noprof, d))
1075 f.write(src.template.substitute(readme_template_path_bin_prof, d))
1078 f.write(src.template.substitute(readme_template_path_src, d))
1080 if options.binaries and options.sources:
1081 f.write(readme_compilation_with_binaries)
1084 f.write(src.template.substitute(readme_template_path_pro, d))
1087 f.write(src.template.substitute(readme_template_path_sat, d))
1091 def update_config(config, prop, value):
1092 '''Remove from config.APPLICATION.products the products that have the property given as input.
1094 :param config Config: The global config.
1095 :param prop str: The property to filter
1096 :param value str: The value of the property to filter
1098 src.check_config_has_application(config)
1099 l_product_to_remove = []
1100 for product_name in config.APPLICATION.products.keys():
1101 prod_cfg = src.product.get_product_config(config, product_name)
1102 if src.get_property_in_product_cfg(prod_cfg, prop) == value:
1103 l_product_to_remove.append(product_name)
1104 for product_name in l_product_to_remove:
1105 config.APPLICATION.products.__delitem__(product_name)
1108 '''method that is called when salomeTools is called with --help option.
1110 :return: The text to display for the package command description.
1113 return _("The package command creates an archive.\nThere are 4 kinds of "
1114 "archive, which can be mixed:\n 1- The binary archive. It contains all the product "
1115 "installation directories and a launcher,\n 2- The sources archive."
1116 " It contains the products archives, a project corresponding to "
1117 "the application and salomeTools,\n 3- The project archive. It "
1118 "contains a project (give the project file path as argument),\n 4-"
1119 " The salomeTools archive. It contains salomeTools.\n\nexample:"
1120 "\nsat package SALOME-master --bineries --sources")
1122 def run(args, runner, logger):
1123 '''method that is called when salomeTools is called with package parameter.
1127 (options, args) = parser.parse_args(args)
1129 # Check that a type of package is called, and only one
1130 all_option_types = (options.binaries,
1132 options.project not in ["", None],
1135 # Check if no option for package type
1136 if all_option_types.count(True) == 0:
1137 msg = _("Error: Precise a type for the package\nUse one of the "
1138 "following options: --binaries, --sources, --project or"
1140 logger.write(src.printcolors.printcError(msg), 1)
1141 logger.write("\n", 1)
1144 # The repository where to put the package if not Binary or Source
1145 package_default_path = runner.cfg.LOCAL.workdir
1147 # if the package contains binaries or sources:
1148 if options.binaries or options.sources:
1149 # Check that the command has been called with an application
1150 src.check_config_has_application(runner.cfg)
1152 # Display information
1153 logger.write(_("Packaging application %s\n") % src.printcolors.printcLabel(
1154 runner.cfg.VARS.application), 1)
1156 # Get the default directory where to put the packages
1157 package_default_path = os.path.join(runner.cfg.APPLICATION.workdir,
1159 src.ensure_path_exists(package_default_path)
1161 # if the package contains a project:
1163 # check that the project is visible by SAT
1164 if options.project not in runner.cfg.PROJECTS.project_file_paths:
1165 local_path = os.path.join(runner.cfg.VARS.salometoolsway,
1168 msg = _("ERROR: the project %(proj)s is not visible by salomeTools."
1169 "\nPlease add it in the %(local)s file." % {
1170 "proj" : options.project, "local" : local_path})
1171 logger.write(src.printcolors.printcError(msg), 1)
1172 logger.write("\n", 1)
1175 # Remove the products that are filtered by the --without_property option
1176 if options.without_property:
1177 [prop, value] = options.without_property.split(":")
1178 update_config(runner.cfg, prop, value)
1180 # get the name of the archive or build it
1182 if os.path.basename(options.name) == options.name:
1183 # only a name (not a path)
1184 archive_name = options.name
1185 dir_name = package_default_path
1187 archive_name = os.path.basename(options.name)
1188 dir_name = os.path.dirname(options.name)
1190 # suppress extension
1191 if archive_name[-len(".tgz"):] == ".tgz":
1192 archive_name = archive_name[:-len(".tgz")]
1193 if archive_name[-len(".tar.gz"):] == ".tar.gz":
1194 archive_name = archive_name[:-len(".tar.gz")]
1198 dir_name = package_default_path
1199 if options.binaries or options.sources:
1200 archive_name = runner.cfg.APPLICATION.name
1202 if options.binaries:
1203 archive_name += "-"+runner.cfg.VARS.dist
1206 archive_name += "-SRC"
1207 if options.with_vcs:
1208 archive_name += "-VCS"
1211 project_name, __ = os.path.splitext(
1212 os.path.basename(options.project))
1213 archive_name += ("PROJECT-" + project_name)
1216 archive_name += ("salomeTools_" + runner.cfg.INTERNAL.sat_version)
1217 if len(archive_name)==0: # no option worked
1218 msg = _("Error: Cannot name the archive\n"
1219 " check if at least one of the following options was "
1220 "selected : --binaries, --sources, --project or"
1222 logger.write(src.printcolors.printcError(msg), 1)
1223 logger.write("\n", 1)
1226 path_targz = os.path.join(dir_name, archive_name + ".tgz")
1228 src.printcolors.print_value(logger, "Package path", path_targz, 2)
1230 # Create a working directory for all files that are produced during the
1231 # package creation and that will be removed at the end of the command
1232 tmp_working_dir = os.path.join(runner.cfg.VARS.tmp_root,
1233 runner.cfg.VARS.datehour)
1234 src.ensure_path_exists(tmp_working_dir)
1235 logger.write("\n", 5)
1236 logger.write(_("The temporary working directory: %s\n" % tmp_working_dir),5)
1238 logger.write("\n", 3)
1240 msg = _("Preparation of files to add to the archive")
1241 logger.write(src.printcolors.printcLabel(msg), 2)
1242 logger.write("\n", 2)
1244 d_files_to_add={} # content of the archive
1246 # a dict to hold paths that will need to be substitute for users recompilations
1247 d_paths_to_substitute={}
1249 if options.binaries:
1250 d_bin_files_to_add = binary_package(runner.cfg,
1254 # for all binaries dir, store the substitution that will be required
1255 # for extra compilations
1256 for key in d_bin_files_to_add:
1257 if key.endswith("(bin)"):
1258 source_dir = d_bin_files_to_add[key][0]
1259 path_in_archive = d_bin_files_to_add[key][1].replace("BINARIES-" + runner.cfg.VARS.dist,"INSTALL")
1260 if os.path.basename(source_dir)==os.path.basename(path_in_archive):
1261 # if basename is the same we will just substitute the dirname
1262 d_paths_to_substitute[os.path.dirname(source_dir)]=\
1263 os.path.dirname(path_in_archive)
1265 d_paths_to_substitute[source_dir]=path_in_archive
1267 d_files_to_add.update(d_bin_files_to_add)
1270 d_files_to_add.update(source_package(runner,
1275 if options.binaries:
1276 # for archives with bin and sources we provide a shell script able to
1277 # install binaries for compilation
1278 file_install_bin=produce_install_bin_file(runner.cfg,logger,
1280 d_paths_to_substitute,
1282 d_files_to_add.update({"install_bin" : (file_install_bin, "install_bin.sh")})
1283 logger.write("substitutions that need to be done later : \n", 5)
1284 logger.write(str(d_paths_to_substitute), 5)
1285 logger.write("\n", 5)
1287 # --salomeTool option is not considered when --sources is selected, as this option
1288 # already brings salomeTool!
1290 d_files_to_add.update({"salomeTools" : (runner.cfg.VARS.salometoolsway, "")})
1294 d_files_to_add.update(project_package(options.project, tmp_working_dir))
1296 if not(d_files_to_add):
1297 msg = _("Error: Empty dictionnary to build the archive!\n")
1298 logger.write(src.printcolors.printcError(msg), 1)
1299 logger.write("\n", 1)
1302 # Add the README file in the package
1303 local_readme_tmp_path = add_readme(runner.cfg,
1306 d_files_to_add["README"] = (local_readme_tmp_path, "README")
1308 # Add the additional files of option add_files
1309 if options.add_files:
1310 for file_path in options.add_files:
1311 if not os.path.exists(file_path):
1312 msg = _("WARNING: the file %s is not accessible.\n" % file_path)
1314 file_name = os.path.basename(file_path)
1315 d_files_to_add[file_name] = (file_path, file_name)
1317 logger.write("\n", 2)
1319 logger.write(src.printcolors.printcLabel(_("Actually do the package")), 2)
1320 logger.write("\n", 2)
1323 # Creating the object tarfile
1324 tar = tarfile.open(path_targz, mode='w:gz')
1326 # get the filtering function if needed
1327 filter_function = exclude_VCS_and_extensions
1329 # Add the files to the tarfile object
1330 res = add_files(tar, archive_name, d_files_to_add, logger, f_exclude=filter_function)
1332 except KeyboardInterrupt:
1333 logger.write(src.printcolors.printcError("\nERROR: forced interruption\n"), 1)
1334 logger.write(_("Removing the temporary working directory ... "), 1)
1335 # remove the working directory
1336 shutil.rmtree(tmp_working_dir)
1337 logger.write(_("OK"), 1)
1338 logger.write(_("\n"), 1)
1341 # remove the working directory
1342 shutil.rmtree(tmp_working_dir)
1344 # Print again the path of the package
1345 logger.write("\n", 2)
1346 src.printcolors.print_value(logger, "Package path", path_targz, 2)