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)
122 # what do we do with git tree structure and history
123 if is_dev and "sub_dir" in product_info.git_info:
124 logger.error("dev mode for product is incompatible with 'sub_dir' option")
127 if not is_dev and "sub_dir" in product_info.git_info:
128 sub_dir = product_info.git_info.sub_dir
131 # Call the system function that do the extraction in git mode
132 retcode = src.system.git_extract(repo_git,
133 product_info.git_info.tag,
134 source_dir, logger, environ)
136 # Call the system function that do the extraction of a sub_dir in git mode
137 logger.write("sub_dir:%s " % sub_dir, 3)
138 retcode = src.system.git_extract_sub_dir(repo_git,
139 product_info.git_info.tag,
140 source_dir, sub_dir, logger, environ)
145 def get_source_from_archive(config, product_info, source_dir, logger):
146 '''The method called if the product is to be get in archive mode
148 :param config Config: The global configuration
149 :param product_info Config: The configuration specific to
150 the product to be prepared
151 :param source_dir Path: The Path instance corresponding to the
152 directory where to put the sources
153 :param logger Logger: The logger instance to use for the display and logging
154 :return: True if it succeed, else False
158 # check if pip should be used : pip mode id activated if the application and product have pip property
159 if (src.appli_test_property(config,"pip", "yes") and
160 src.product.product_test_property(product_info,"pip", "yes")):
161 # download whl in local archive dir
162 pip_download_cmd="pip download --disable-pip-version-check --destination-directory %s --no-deps %s==%s " %\
163 (config.LOCAL.archive_dir, product_info.name, product_info.version)
164 logger.write(pip_download_cmd, 3, False)
165 res_pip = (subprocess.call(pip_download_cmd,
167 cwd=config.LOCAL.workdir,
168 stdout=logger.logTxtFile,
169 stderr=subprocess.STDOUT) == 0)
172 # check archive exists
173 if not os.path.exists(product_info.archive_info.archive_name):
174 # The archive is not found on local file system (ARCHIVEPATH)
176 logger.write("\n The archive is not found on local file system, we try ftp\n", 3)
177 ret=src.find_file_in_ftppath(product_info.archive_info.archive_name,
178 config.PATHS.ARCHIVEFTP, config.LOCAL.archive_dir, logger)
180 # archive was found on ftp and stored in ret
181 product_info.archive_info.archive_name=ret
183 raise src.SatException(_("Archive not found in ARCHIVEPATH, nor on ARCHIVEFTP: '%s'") %
184 product_info.archive_info.archive_name)
186 logger.write('arc:%s ... ' %
187 src.printcolors.printcInfo(product_info.archive_info.archive_name),
191 # Call the system function that do the extraction in archive mode
192 retcode, NameExtractedDirectory = src.system.archive_extract(
193 product_info.archive_info.archive_name,
194 source_dir.dir(), logger)
196 # Rename the source directory if
197 # it does not match with product_info.source_dir
198 if (NameExtractedDirectory.replace('/', '') !=
199 os.path.basename(product_info.source_dir)):
200 shutil.move(os.path.join(os.path.dirname(product_info.source_dir),
201 NameExtractedDirectory),
202 product_info.source_dir)
206 def get_source_from_dir(product_info, source_dir, logger):
208 if "dir_info" not in product_info:
209 msg = _("Error: you must put a dir_info section"
210 " in the file %s.pyconf" % product_info.name)
211 logger.write("\n%s\n" % src.printcolors.printcError(msg), 1)
214 if "dir" not in product_info.dir_info:
215 msg = _("Error: you must put a dir in the dir_info section"
216 " in the file %s.pyconf" % product_info.name)
217 logger.write("\n%s\n" % src.printcolors.printcError(msg), 1)
220 # check that source exists
221 if not os.path.exists(product_info.dir_info.dir):
222 msg = _("Error: the dir %s defined in the file"
223 " %s.pyconf does not exists" % (product_info.dir_info.dir,
225 logger.write("\n%s\n" % src.printcolors.printcError(msg), 1)
228 logger.write('DIR: %s ... ' % src.printcolors.printcInfo(
229 product_info.dir_info.dir), 3)
232 retcode = src.Path(product_info.dir_info.dir).copy(source_dir)
236 def get_source_from_cvs(user,
243 '''The method called if the product is to be get in cvs mode
245 :param user str: The user to use in for the cvs command
246 :param product_info Config: The configuration specific to
247 the product to be prepared
248 :param source_dir Path: The Path instance corresponding to the
249 directory where to put the sources
250 :param checkout boolean: If True, get the source in checkout mode
251 :param logger Logger: The logger instance to use for the display and logging
252 :param pad int: The gap to apply for the terminal display
253 :param environ src.environment.Environ: The environment to source when
255 :return: True if it succeed, else False
258 # Get the protocol to use in the command
259 if "protocol" in product_info.cvs_info:
260 protocol = product_info.cvs_info.protocol
264 # Construct the line to display
265 if "protocol" in product_info.cvs_info:
266 cvs_line = "%s:%s@%s:%s" % \
267 (protocol, user, product_info.cvs_info.server,
268 product_info.cvs_info.product_base)
270 cvs_line = "%s / %s" % (product_info.cvs_info.server,
271 product_info.cvs_info.product_base)
274 if checkout: coflag = src.printcolors.printcHighlight(coflag.upper())
276 logger.write('%s:%s' % (coflag, src.printcolors.printcInfo(cvs_line)),
279 logger.write(' ' * (pad + 50 - len(cvs_line)), 3, False)
280 logger.write(' src:%s' %
281 src.printcolors.printcInfo(product_info.cvs_info.source),
284 logger.write(' ' * (pad + 1 - len(product_info.cvs_info.source)), 3, False)
285 logger.write(' tag:%s' %
286 src.printcolors.printcInfo(product_info.cvs_info.tag),
289 # at least one '.' is visible
290 logger.write(' %s. ' % ('.' * (10 - len(product_info.cvs_info.tag))),
294 logger.write('\n', 5, False)
296 # Call the system function that do the extraction in cvs mode
297 retcode = src.system.cvs_extract(protocol, user,
298 product_info.cvs_info.server,
299 product_info.cvs_info.product_base,
300 product_info.cvs_info.tag,
301 product_info.cvs_info.source,
302 source_dir, logger, checkout, environ)
305 def get_source_from_svn(user,
311 '''The method called if the product is to be get in svn mode
313 :param user str: The user to use in for the svn command
314 :param product_info Config: The configuration specific to
315 the product to be prepared
316 :param source_dir Path: The Path instance corresponding to the
317 directory where to put the sources
318 :param checkout boolean: If True, get the source in checkout mode
319 :param logger Logger: The logger instance to use for the display and logging
320 :param environ src.environment.Environ: The environment to source when
322 :return: True if it succeed, else False
326 if checkout: coflag = src.printcolors.printcHighlight(coflag.upper())
328 logger.write('%s:%s ... ' % (coflag,
329 src.printcolors.printcInfo(
330 product_info.svn_info.repo)),
334 logger.write('\n', 5, False)
335 # Call the system function that do the extraction in svn mode
336 retcode = src.system.svn_extract(user,
337 product_info.svn_info.repo,
338 product_info.svn_info.tag,
345 def get_product_sources(config,
352 '''Get the product sources.
354 :param config Config: The global configuration
355 :param product_info Config: The configuration specific to
356 the product to be prepared
357 :param is_dev boolean: True if the product is in development mode
358 :param source_dir Path: The Path instance corresponding to the
359 directory where to put the sources
360 :param logger Logger: The logger instance to use for the display and logging
361 :param pad int: The gap to apply for the terminal display
362 :param checkout boolean: If True, get the source in checkout mode
363 :return: True if it succeed, else False
367 # Get the application environment
368 logger.write(_("Set the application environment\n"), 5)
369 env_appli = src.environment.SalomeEnviron(config,
370 src.environment.Environ(dict(os.environ)))
371 env_appli.set_application_env(logger)
373 # Call the right function to get sources regarding the product settings
374 if not checkout and is_dev:
375 return get_source_for_dev(config,
381 if product_info.get_source == "git":
382 return get_source_from_git(config, product_info, source_dir, logger, pad,
385 if product_info.get_source == "archive":
386 return get_source_from_archive(config, product_info, source_dir, logger)
388 if product_info.get_source == "dir":
389 return get_source_from_dir(product_info, source_dir, logger)
391 if product_info.get_source == "cvs":
392 cvs_user = config.USER.cvs_user
393 return get_source_from_cvs(cvs_user,
401 if product_info.get_source == "svn":
402 svn_user = config.USER.svn_user
403 return get_source_from_svn(svn_user, product_info, source_dir,
408 if product_info.get_source == "native":
410 logger.write('%s ' % src.printcolors.printc(src.OK_STATUS),
413 msg = _('INFORMATION : Not doing anything because the product'
414 ' is of type "native".\n')
418 if product_info.get_source == "fixed":
420 logger.write('%s ' % src.printcolors.printc(src.OK_STATUS),
423 msg = "FIXED : %s\n" % product_info.install_dir
425 if not os.path.isdir(product_info.install_dir):
426 logger.warning("The fixed path do not exixts!! Please check it : %s\n" % product_info.install_dir)
431 # if the get_source is not in [git, archive, cvs, svn, fixed, native]
432 logger.write(_("Unknown get source method \"%(get)s\" for product %(product)s") % \
433 { 'get': product_info.get_source, 'product': product_info.name }, 3, False)
434 logger.write(" ... ", 3, False)
438 def get_all_product_sources(config, products, logger):
439 '''Get all the product sources.
441 :param config Config: The global configuration
442 :param products List: The list of tuples (product name, product informations)
443 :param logger Logger: The logger instance to be used for the logging
444 :return: the tuple (number of success, dictionary product_name/success_fail)
448 # Initialize the variables that will count the fails and success
452 # Get the maximum name length in order to format the terminal display
453 max_product_name_len = 1
454 if len(products) > 0:
455 max_product_name_len = max(map(lambda l: len(l), products[0])) + 4
457 # The loop on all the products from which to get the sources
458 # DBG.write("source.get_all_product_sources config id", id(config), True)
459 for product_name, product_info in products:
460 # get product name, product informations and the directory where to put
462 if (not (src.product.product_is_fixed(product_info) or
463 src.product.product_is_native(product_info))):
464 source_dir = src.Path(product_info.source_dir)
466 source_dir = src.Path('')
469 logger.write('%s: ' % src.printcolors.printcLabel(product_name), 3)
470 logger.write(' ' * (max_product_name_len - len(product_name)), 3, False)
471 logger.write("\n", 4, False)
473 # Remove the existing source directory if
474 # the product is not in development mode
475 is_dev = src.product.product_is_dev(product_info)
476 if source_dir.exists():
477 logger.write('%s ' % src.printcolors.printc(src.OK_STATUS), 3, False)
478 msg = _("INFO : Not doing anything because the source directory already exists:\n %s\n") % source_dir
480 good_result = good_result + 1
481 # Do not get the sources and go to next product
484 # Call to the function that get the sources for one product
485 retcode = get_product_sources(config,
490 max_product_name_len,
494 if 'no_rpath' in product_info.keys():
495 if product_info.no_rpath:
496 hack_no_rpath(config, product_info, logger)
499 # Check that the sources are correctly get using the files to be tested
500 # in product information
502 check_OK, wrong_path = check_sources(product_info, logger)
504 # Print the missing file path
505 msg = _("The required file %s does not exists. " % wrong_path)
506 logger.write(src.printcolors.printcError("\nERROR: ") + msg, 3)
510 results[product_name] = retcode
512 # The case where it succeed
514 good_result = good_result + 1
516 # The case where it failed
520 if not(src.product.product_is_fixed(product_info) or
521 src.product.product_is_native(product_info)):
522 logger.write('%s\n' % src.printcolors.printc(res), 3, False)
524 return good_result, results
526 def check_sources(product_info, logger):
527 '''Check that the sources are correctly get, using the files to be tested
528 in product information
530 :param product_info Config: The configuration specific to
531 the product to be prepared
532 :return: True if the files exists (or no files to test is provided).
535 # Get the files to test if there is any
536 if ("present_files" in product_info and
537 "source" in product_info.present_files):
538 l_files_to_be_tested = product_info.present_files.source
539 for file_path in l_files_to_be_tested:
540 # The path to test is the source directory
541 # of the product joined the file path provided
542 path_to_test = os.path.join(product_info.source_dir, file_path)
543 logger.write(_("\nTesting existence of file: \n"), 5)
544 logger.write(path_to_test, 5)
545 if not os.path.exists(path_to_test):
546 return False, path_to_test
547 logger.write(src.printcolors.printcSuccess(" OK\n"), 5)
551 '''method that is called when salomeTools is called with --help option.
553 :return: The text to display for the source command description.
556 return _("The source command gets the sources of the application products "
557 "from cvs, git or an archive.\n\nexample:"
558 "\nsat source SALOME-master --products KERNEL,GUI")
560 def run(args, runner, logger):
561 '''method that is called when salomeTools is called with source parameter.
563 DBG.write("source.run()", args)
565 (options, args) = parser.parse_args(args)
567 # check that the command has been called with an application
568 src.check_config_has_application( runner.cfg )
570 # Print some informations
571 logger.write(_('Getting sources of the application %s\n') %
572 src.printcolors.printcLabel(runner.cfg.VARS.application), 1)
573 src.printcolors.print_value(logger, 'workdir',
574 runner.cfg.APPLICATION.workdir, 2)
575 logger.write("\n", 2, False)
577 # Get the products list with products informations regarding the options
578 products_infos = src.product.get_products_list(options, runner.cfg, logger)
580 # Call to the function that gets all the sources
581 good_result, results = get_all_product_sources(runner.cfg,
585 # Display the results (how much passed, how much failed, etc...)
586 status = src.OK_STATUS
589 logger.write("\n", 2, False)
590 if good_result == len(products_infos):
591 res_count = "%d / %d" % (good_result, good_result)
593 status = src.KO_STATUS
594 res_count = "%d / %d" % (good_result, len(products_infos))
596 for product in results:
597 if results[product] == 0 or results[product] is None:
598 details.append(product)
600 result = len(products_infos) - good_result
603 logger.write(_("Getting sources of the application:"), 1)
604 logger.write(" " + src.printcolors.printc(status), 1, False)
605 logger.write(" (%s)\n" % res_count, 1, False)
608 logger.write(_("Following sources haven't been get:\n"), 2)
609 logger.write(" ".join(details), 2)
610 logger.write("\n", 2, False)