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
26 import src.debug as DBG
28 # Define all possible option for patch command : sat patch <options>
29 parser = src.options.Options()
30 parser.add_option('p', 'products', 'list2', 'products',
31 _('Optional: products from which to get the sources. This option accepts a comma separated list.'))
33 def get_source_for_dev(config, product_info, source_dir, logger, pad):
34 '''The method called if the product is in development mode
36 :param config Config: The global configuration
37 :param product_info Config: The configuration specific to
38 the product to be prepared
39 :param source_dir Path: The Path instance corresponding to the
40 directory where to put the sources
41 :param logger Logger: The logger instance to use for the display and logging
42 :param pad int: The gap to apply for the terminal display
43 :return: True if it succeed, else False
47 # Call the function corresponding to get the sources with True checkout
48 retcode = get_product_sources(config,
55 logger.write("\n", 3, False)
56 # +2 because product name is followed by ': '
57 logger.write(" " * (pad+2), 3, False)
59 logger.write('dev: %s ... ' %
60 src.printcolors.printcInfo(product_info.source_dir), 3, False)
65 def get_source_from_git(config,
72 '''The method called if the product is to be get in git mode
74 :param product_info Config: The configuration specific to
75 the product to be prepared
76 :param source_dir Path: The Path instance corresponding to the
77 directory where to put the sources
78 :param logger Logger: The logger instance to use for the display and logging
79 :param pad int: The gap to apply for the terminal display
80 :param is_dev boolean: True if the product is in development mode
81 :param environ src.environment.Environ: The environment to source when
83 :return: True if it succeed, else False
90 if ("APPLICATION" in config and
91 "properties" in config.APPLICATION and
92 "repo_dev" in config.APPLICATION.properties and
93 config.APPLICATION.properties.repo_dev == "yes") :
96 # Get the repository address.
97 # If the application has the repo_dev property
98 # Or if the product is in dev mode
99 # Then we use repo_dev if the key exists
100 if (is_dev or use_repo_dev) and 'repo_dev' in product_info.git_info:
101 coflag = src.printcolors.printcHighlight(coflag.upper())
102 repo_git = product_info.git_info.repo_dev
104 repo_git = product_info.git_info.repo
107 # Display informations
108 logger.write('%s:%s' % (coflag, src.printcolors.printcInfo(repo_git)), 3,
110 logger.write(' ' * (pad + 50 - len(repo_git)), 3, False)
111 logger.write(' tag:%s' % src.printcolors.printcInfo(
112 product_info.git_info.tag),
115 logger.write(' %s. ' % ('.' * (10 - len(product_info.git_info.tag))), 3,
118 logger.write('\n', 5, False)
121 if "git_options" in product_info.git_info:
122 git_options = product_info.git_info.git_options
125 # what do we do with git tree structure and history
126 if is_dev and "sub_dir" in product_info.git_info:
127 logger.error("dev mode for product is incompatible with 'sub_dir' option")
130 if not is_dev and "sub_dir" in product_info.git_info:
131 sub_dir = product_info.git_info.sub_dir
134 # Call the system function that do the extraction in git mode
135 retcode = src.system.git_extract(repo_git,
136 product_info.git_info.tag, git_options,
137 source_dir, logger, environ)
139 # Call the system function that do the extraction of a sub_dir in git mode
140 logger.write("sub_dir:%s " % sub_dir, 3)
141 retcode = src.system.git_extract_sub_dir(repo_git,
142 product_info.git_info.tag,git_options,
143 source_dir, sub_dir, logger, environ)
148 def get_source_from_archive(config, product_info, source_dir, logger):
149 '''The method called if the product is to be get in archive mode
151 :param config Config: The global configuration
152 :param product_info Config: The configuration specific to
153 the product to be prepared
154 :param source_dir Path: The Path instance corresponding to the
155 directory where to put the sources
156 :param logger Logger: The logger instance to use for the display and logging
157 :return: True if it succeed, else False
161 # check if pip should be used : pip mode id activated if the application and product have pip property
162 if (src.appli_test_property(config,"pip", "yes") and
163 src.product.product_test_property(product_info,"pip", "yes")):
164 pip_msg = "PIP : do nothing, product will be downloaded later at compile time "
165 logger.write(pip_msg, 3)
168 # check archive exists
169 if not os.path.exists(product_info.archive_info.archive_name):
170 # The archive is not found on local file system (ARCHIVEPATH)
172 logger.write("\n The archive is not found on local file system, we try ftp\n", 3)
173 ret=src.find_file_in_ftppath(product_info.archive_info.archive_name,
174 config.PATHS.ARCHIVEFTP, config.LOCAL.archive_dir, logger)
176 # archive was found on ftp and stored in ret
177 product_info.archive_info.archive_name=ret
179 raise src.SatException(_("Archive not found in ARCHIVEPATH, nor on ARCHIVEFTP: '%s'") %
180 product_info.archive_info.archive_name)
182 logger.write('arc:%s ... ' %
183 src.printcolors.printcInfo(product_info.archive_info.archive_name),
187 # Call the system function that do the extraction in archive mode
188 retcode, NameExtractedDirectory = src.system.archive_extract(
189 product_info.archive_info.archive_name,
190 source_dir.dir(), logger)
192 # Rename the source directory if
193 # it does not match with product_info.source_dir
194 if (NameExtractedDirectory.replace('/', '') !=
195 os.path.basename(product_info.source_dir)):
196 shutil.move(os.path.join(os.path.dirname(product_info.source_dir),
197 NameExtractedDirectory),
198 product_info.source_dir)
202 def get_source_from_dir(product_info, source_dir, logger):
204 if "dir_info" not in product_info:
205 msg = _("Error: you must put a dir_info section"
206 " in the file %s.pyconf" % product_info.name)
207 logger.write("\n%s\n" % src.printcolors.printcError(msg), 1)
210 if "dir" not in product_info.dir_info:
211 msg = _("Error: you must put a dir in the dir_info section"
212 " in the file %s.pyconf" % product_info.name)
213 logger.write("\n%s\n" % src.printcolors.printcError(msg), 1)
216 # check that source exists
217 if not os.path.exists(product_info.dir_info.dir):
218 msg = _("Error: the dir %s defined in the file"
219 " %s.pyconf does not exists" % (product_info.dir_info.dir,
221 logger.write("\n%s\n" % src.printcolors.printcError(msg), 1)
224 logger.write('DIR: %s ... ' % src.printcolors.printcInfo(
225 product_info.dir_info.dir), 3)
228 retcode = src.Path(product_info.dir_info.dir).copy(source_dir)
232 def get_source_from_cvs(user,
239 '''The method called if the product is to be get in cvs mode
241 :param user str: The user to use in for the cvs command
242 :param product_info Config: The configuration specific to
243 the product to be prepared
244 :param source_dir Path: The Path instance corresponding to the
245 directory where to put the sources
246 :param checkout boolean: If True, get the source in checkout mode
247 :param logger Logger: The logger instance to use for the display and logging
248 :param pad int: The gap to apply for the terminal display
249 :param environ src.environment.Environ: The environment to source when
251 :return: True if it succeed, else False
254 # Get the protocol to use in the command
255 if "protocol" in product_info.cvs_info:
256 protocol = product_info.cvs_info.protocol
260 # Construct the line to display
261 if "protocol" in product_info.cvs_info:
262 cvs_line = "%s:%s@%s:%s" % \
263 (protocol, user, product_info.cvs_info.server,
264 product_info.cvs_info.product_base)
266 cvs_line = "%s / %s" % (product_info.cvs_info.server,
267 product_info.cvs_info.product_base)
270 if checkout: coflag = src.printcolors.printcHighlight(coflag.upper())
272 logger.write('%s:%s' % (coflag, src.printcolors.printcInfo(cvs_line)),
275 logger.write(' ' * (pad + 50 - len(cvs_line)), 3, False)
276 logger.write(' src:%s' %
277 src.printcolors.printcInfo(product_info.cvs_info.source),
280 logger.write(' ' * (pad + 1 - len(product_info.cvs_info.source)), 3, False)
281 logger.write(' tag:%s' %
282 src.printcolors.printcInfo(product_info.cvs_info.tag),
285 # at least one '.' is visible
286 logger.write(' %s. ' % ('.' * (10 - len(product_info.cvs_info.tag))),
290 logger.write('\n', 5, False)
292 # Call the system function that do the extraction in cvs mode
293 retcode = src.system.cvs_extract(protocol, user,
294 product_info.cvs_info.server,
295 product_info.cvs_info.product_base,
296 product_info.cvs_info.tag,
297 product_info.cvs_info.source,
298 source_dir, logger, checkout, environ)
301 def get_source_from_svn(user,
307 '''The method called if the product is to be get in svn mode
309 :param user str: The user to use in for the svn command
310 :param product_info Config: The configuration specific to
311 the product to be prepared
312 :param source_dir Path: The Path instance corresponding to the
313 directory where to put the sources
314 :param checkout boolean: If True, get the source in checkout mode
315 :param logger Logger: The logger instance to use for the display and logging
316 :param environ src.environment.Environ: The environment to source when
318 :return: True if it succeed, else False
322 if checkout: coflag = src.printcolors.printcHighlight(coflag.upper())
324 logger.write('%s:%s ... ' % (coflag,
325 src.printcolors.printcInfo(
326 product_info.svn_info.repo)),
330 logger.write('\n', 5, False)
331 # Call the system function that do the extraction in svn mode
332 retcode = src.system.svn_extract(user,
333 product_info.svn_info.repo,
334 product_info.svn_info.tag,
341 def get_product_sources(config,
348 '''Get the product sources.
350 :param config Config: The global configuration
351 :param product_info Config: The configuration specific to
352 the product to be prepared
353 :param is_dev boolean: True if the product is in development mode
354 :param source_dir Path: The Path instance corresponding to the
355 directory where to put the sources
356 :param logger Logger: The logger instance to use for the display and logging
357 :param pad int: The gap to apply for the terminal display
358 :param checkout boolean: If True, get the source in checkout mode
359 :return: True if it succeed, else False
363 # Get the application environment
364 logger.write(_("Set the application environment\n"), 5)
365 env_appli = src.environment.SalomeEnviron(config,
366 src.environment.Environ(dict(os.environ)))
367 env_appli.set_application_env(logger)
369 # Call the right function to get sources regarding the product settings
370 if not checkout and is_dev:
371 return get_source_for_dev(config,
377 if product_info.get_source == "git":
378 return get_source_from_git(config, product_info, source_dir, logger, pad,
381 if product_info.get_source == "archive":
382 return get_source_from_archive(config, product_info, source_dir, logger)
384 if product_info.get_source == "dir":
385 return get_source_from_dir(product_info, source_dir, logger)
387 if product_info.get_source == "cvs":
388 cvs_user = config.USER.cvs_user
389 return get_source_from_cvs(cvs_user, product_info, source_dir,
390 checkout, logger, pad, env_appli)
392 if product_info.get_source == "svn":
393 svn_user = config.USER.svn_user
394 return get_source_from_svn(svn_user, product_info, source_dir,
395 checkout, logger, env_appli)
397 if product_info.get_source == "native":
398 # for native products we check the corresponding system packages are installed
399 logger.write("Native : Checking system packages are installed\n" , 3)
400 check_cmd=src.system.get_pkg_check_cmd(config.VARS.dist_name) # (either rmp or apt)
401 run_pkg,build_pkg=src.product.check_system_dep(config.VARS.dist, check_cmd, product_info)
404 logger.write(" - "+pkg + " : " + run_pkg[pkg], 1)
405 if "KO" in run_pkg[pkg]:
407 for pkg in build_pkg:
408 logger.write(" - "+pkg + " : " + build_pkg[pkg], 1)
409 if "KO" in build_pkg[pkg]:
412 logger.error("some system dependencies are missing, please install them with "+\
416 if product_info.get_source == "fixed":
418 logger.write('%s ' % src.printcolors.printc(src.OK_STATUS),
421 msg = "FIXED : %s\n" % product_info.install_dir
423 if not os.path.isdir(product_info.install_dir):
424 logger.warning("The fixed path do not exixts!! Please check it : %s\n" % product_info.install_dir)
429 # if the get_source is not in [git, archive, cvs, svn, fixed, native]
430 logger.write(_("Unknown get source method \"%(get)s\" for product %(product)s") % \
431 { 'get': product_info.get_source, 'product': product_info.name }, 3, False)
432 logger.write(" ... ", 3, False)
436 def get_all_product_sources(config, products, logger):
437 '''Get all the product sources.
439 :param config Config: The global configuration
440 :param products List: The list of tuples (product name, product informations)
441 :param logger Logger: The logger instance to be used for the logging
442 :return: the tuple (number of success, dictionary product_name/success_fail)
446 # Initialize the variables that will count the fails and success
450 # Get the maximum name length in order to format the terminal display
451 max_product_name_len = 1
452 if len(products) > 0:
453 max_product_name_len = max(map(lambda l: len(l), products[0])) + 4
455 # The loop on all the products from which to get the sources
456 # DBG.write("source.get_all_product_sources config id", id(config), True)
457 for product_name, product_info in products:
458 # get product name, product informations and the directory where to put
460 if (not (src.product.product_is_fixed(product_info) or
461 src.product.product_is_native(product_info))):
462 source_dir = src.Path(product_info.source_dir)
464 source_dir = src.Path('')
467 logger.write('%s: ' % src.printcolors.printcLabel(product_name), 3)
468 logger.write(' ' * (max_product_name_len - len(product_name)), 3, False)
469 logger.write("\n", 4, False)
471 # Remove the existing source directory if
472 # the product is not in development mode
473 is_dev = src.product.product_is_dev(product_info)
474 if source_dir.exists():
475 logger.write('%s ' % src.printcolors.printc(src.OK_STATUS), 3, False)
476 msg = _("INFO : Not doing anything because the source directory already exists:\n %s\n") % source_dir
478 good_result = good_result + 1
479 # Do not get the sources and go to next product
482 # Call to the function that get the sources for one product
483 retcode = get_product_sources(config, product_info, is_dev,
484 source_dir, logger, max_product_name_len,
488 if 'no_rpath' in product_info.keys():
489 if product_info.no_rpath:
490 hack_no_rpath(config, product_info, logger)
493 # Check that the sources are correctly get using the files to be tested
494 # in product information
496 check_OK, wrong_path = check_sources(product_info, logger)
498 # Print the missing file path
499 msg = _("The required file %s does not exists. " % wrong_path)
500 logger.write(src.printcolors.printcError("\nERROR: ") + msg, 3)
504 results[product_name] = retcode
506 # The case where it succeed
508 good_result = good_result + 1
510 # The case where it failed
514 if not(src.product.product_is_fixed(product_info) or
515 src.product.product_is_native(product_info)):
516 logger.write('%s\n' % src.printcolors.printc(res), 3, False)
518 return good_result, results
520 def check_sources(product_info, logger):
521 '''Check that the sources are correctly get, using the files to be tested
522 in product information
524 :param product_info Config: The configuration specific to
525 the product to be prepared
526 :return: True if the files exists (or no files to test is provided).
529 # Get the files to test if there is any
530 if ("present_files" in product_info and
531 "source" in product_info.present_files):
532 l_files_to_be_tested = product_info.present_files.source
533 for file_path in l_files_to_be_tested:
534 # The path to test is the source directory
535 # of the product joined the file path provided
536 path_to_test = os.path.join(product_info.source_dir, file_path)
537 logger.write(_("\nTesting existence of file: \n"), 5)
538 logger.write(path_to_test, 5)
539 if not os.path.exists(path_to_test):
540 return False, path_to_test
541 logger.write(src.printcolors.printcSuccess(" OK\n"), 5)
545 '''method that is called when salomeTools is called with --help option.
547 :return: The text to display for the source command description.
550 return _("The source command gets the sources of the application products "
551 "from cvs, git or an archive.\n\nexample:"
552 "\nsat source SALOME-master --products KERNEL,GUI")
554 def run(args, runner, logger):
555 '''method that is called when salomeTools is called with source parameter.
557 DBG.write("source.run()", args)
559 (options, args) = parser.parse_args(args)
561 # check that the command has been called with an application
562 src.check_config_has_application( runner.cfg )
564 # Print some informations
565 logger.write(_('Getting sources of the application %s\n') %
566 src.printcolors.printcLabel(runner.cfg.VARS.application), 1)
567 src.printcolors.print_value(logger, 'workdir',
568 runner.cfg.APPLICATION.workdir, 2)
569 logger.write("\n", 2, False)
571 # Get the products list with products informations regarding the options
572 products_infos = src.product.get_products_list(options, runner.cfg, logger)
574 # Call to the function that gets all the sources
575 good_result, results = get_all_product_sources(runner.cfg, products_infos, logger)
577 # Display the results (how much passed, how much failed, etc...)
578 status = src.OK_STATUS
581 logger.write("\n", 2, False)
582 if good_result == len(products_infos):
583 res_count = "%d / %d" % (good_result, good_result)
585 status = src.KO_STATUS
586 res_count = "%d / %d" % (good_result, len(products_infos))
588 for product in results:
589 if results[product] == 0 or results[product] is None:
590 details.append(product)
592 result = len(products_infos) - good_result
595 logger.write(_("Getting sources of the application:"), 1)
596 logger.write(" " + src.printcolors.printc(status), 1, False)
597 logger.write(" (%s)\n" % res_count, 1, False)
600 logger.write(_("Following sources haven't been get:\n"), 2)
601 logger.write(" ".join(details), 2)
602 logger.write("\n", 2, False)