commands/source.py

   1 #!/usr/bin/env python
   2 #-*- coding:utf-8 -*-
   3 #  Copyright (C) 2010-2012  CEA/DEN
   4 #
   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.
   9 #
  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.
  14 #
  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
  18
  19 import os
  20 import shutil
  21 import re
  22 import subprocess
  23
  24 import src
  25 import prepare
  26 import src.debug as DBG
  27
  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.'))
  32
  33 def get_source_for_dev(config, product_info, source_dir, logger, pad):
  34     '''The method called if the product is in development mode
  35
  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
  44     :rtype: boolean
  45     '''
  46
  47     # Call the function corresponding to get the sources with True checkout
  48     retcode = get_product_sources(config,
  49                                  product_info,
  50                                  True,
  51                                  source_dir,
  52                                  logger,
  53                                  pad,
  54                                  checkout=True)
  55     logger.write("\n", 3, False)
  56     # +2 because product name is followed by ': '
  57     logger.write(" " * (pad+2), 3, False)
  58
  59     logger.write('dev: %s ... ' %
  60                  src.printcolors.printcInfo(product_info.source_dir), 3, False)
  61     logger.flush()
  62
  63     return retcode
  64
  65 def get_source_from_git(config,
  66                         product_info,
  67                         source_dir,
  68                         logger,
  69                         pad,
  70                         is_dev=False,
  71                         environ = None):
  72     '''The method called if the product is to be get in git mode
  73
  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
  82                                                 extracting.
  83     :return: True if it succeed, else False
  84     :rtype: boolean
  85     '''
  86     # The str to display
  87     coflag = 'git'
  88
  89     use_repo_dev=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") :
  94                 use_repo_dev=True
  95
  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
 103     else:
 104         repo_git = product_info.git_info.repo
 105
 106
 107     # Display informations
 108     logger.write('%s:%s' % (coflag, src.printcolors.printcInfo(repo_git)), 3,
 109                  False)
 110     logger.write(' ' * (pad + 50 - len(repo_git)), 3, False)
 111     logger.write(' tag:%s' % src.printcolors.printcInfo(
 112                                                     product_info.git_info.tag),
 113                  3,
 114                  False)
 115     logger.write(' %s. ' % ('.' * (10 - len(product_info.git_info.tag))), 3,
 116                  False)
 117     logger.flush()
 118     logger.write('\n', 5, False)
 119
 120     sub_dir = None
 121
 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")
 125         return False
 126
 127     if not is_dev and "sub_dir" in product_info.git_info:
 128         sub_dir = product_info.git_info.sub_dir
 129
 130     if sub_dir  is None:
 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)
 135     else:
 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)
 141
 142
 143     return retcode
 144
 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
 147
 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
 155     :rtype: boolean
 156     '''
 157
 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         pip_msg = "PIP : do nothing, product will be downloaded later at compile time "
 162         logger.write(pip_msg, 3)
 163         return True
 164
 165     # check archive exists
 166     if not os.path.exists(product_info.archive_info.archive_name):
 167         # The archive is not found on local file system (ARCHIVEPATH)
 168         # We try ftp!
 169         logger.write("\n   The archive is not found on local file system, we try ftp\n", 3)
 170         ret=src.find_file_in_ftppath(product_info.archive_info.archive_name,
 171                                      config.PATHS.ARCHIVEFTP, config.LOCAL.archive_dir, logger)
 172         if ret:
 173             # archive was found on ftp and stored in ret
 174             product_info.archive_info.archive_name=ret
 175         else:
 176             raise src.SatException(_("Archive not found in ARCHIVEPATH, nor on ARCHIVEFTP: '%s'") %
 177                                    product_info.archive_info.archive_name)
 178
 179     logger.write('arc:%s ... ' %
 180                  src.printcolors.printcInfo(product_info.archive_info.archive_name),
 181                  3,
 182                  False)
 183     logger.flush()
 184     # Call the system function that do the extraction in archive mode
 185     retcode, NameExtractedDirectory = src.system.archive_extract(
 186                                     product_info.archive_info.archive_name,
 187                                     source_dir.dir(), logger)
 188
 189     # Rename the source directory if
 190     # it does not match with product_info.source_dir
 191     if (NameExtractedDirectory.replace('/', '') !=
 192             os.path.basename(product_info.source_dir)):
 193         shutil.move(os.path.join(os.path.dirname(product_info.source_dir),
 194                                  NameExtractedDirectory),
 195                     product_info.source_dir)
 196
 197     return retcode
 198
 199 def get_source_from_dir(product_info, source_dir, logger):
 200
 201     if "dir_info" not in product_info:
 202         msg = _("Error: you must put a dir_info section"
 203                 " in the file %s.pyconf" % product_info.name)
 204         logger.write("\n%s\n" % src.printcolors.printcError(msg), 1)
 205         return False
 206
 207     if "dir" not in product_info.dir_info:
 208         msg = _("Error: you must put a dir in the dir_info section"
 209                 " in the file %s.pyconf" % product_info.name)
 210         logger.write("\n%s\n" % src.printcolors.printcError(msg), 1)
 211         return False
 212
 213     # check that source exists
 214     if not os.path.exists(product_info.dir_info.dir):
 215         msg = _("Error: the dir %s defined in the file"
 216                 " %s.pyconf does not exists" % (product_info.dir_info.dir,
 217                                                 product_info.name))
 218         logger.write("\n%s\n" % src.printcolors.printcError(msg), 1)
 219         return False
 220
 221     logger.write('DIR: %s ... ' % src.printcolors.printcInfo(
 222                                            product_info.dir_info.dir), 3)
 223     logger.flush()
 224
 225     retcode = src.Path(product_info.dir_info.dir).copy(source_dir)
 226
 227     return retcode
 228
 229 def get_source_from_cvs(user,
 230                         product_info,
 231                         source_dir,
 232                         checkout,
 233                         logger,
 234                         pad,
 235                         environ = None):
 236     '''The method called if the product is to be get in cvs mode
 237
 238     :param user str: The user to use in for the cvs command
 239     :param product_info Config: The configuration specific to
 240                                the product to be prepared
 241     :param source_dir Path: The Path instance corresponding to the
 242                             directory where to put the sources
 243     :param checkout boolean: If True, get the source in checkout mode
 244     :param logger Logger: The logger instance to use for the display and logging
 245     :param pad int: The gap to apply for the terminal display
 246     :param environ src.environment.Environ: The environment to source when
 247                                                 extracting.
 248     :return: True if it succeed, else False
 249     :rtype: boolean
 250     '''
 251     # Get the protocol to use in the command
 252     if "protocol" in product_info.cvs_info:
 253         protocol = product_info.cvs_info.protocol
 254     else:
 255         protocol = "pserver"
 256
 257     # Construct the line to display
 258     if "protocol" in product_info.cvs_info:
 259         cvs_line = "%s:%s@%s:%s" % \
 260             (protocol, user, product_info.cvs_info.server,
 261              product_info.cvs_info.product_base)
 262     else:
 263         cvs_line = "%s / %s" % (product_info.cvs_info.server,
 264                                 product_info.cvs_info.product_base)
 265
 266     coflag = 'cvs'
 267     if checkout: coflag = src.printcolors.printcHighlight(coflag.upper())
 268
 269     logger.write('%s:%s' % (coflag, src.printcolors.printcInfo(cvs_line)),
 270                  3,
 271                  False)
 272     logger.write(' ' * (pad + 50 - len(cvs_line)), 3, False)
 273     logger.write(' src:%s' %
 274                  src.printcolors.printcInfo(product_info.cvs_info.source),
 275                  3,
 276                  False)
 277     logger.write(' ' * (pad + 1 - len(product_info.cvs_info.source)), 3, False)
 278     logger.write(' tag:%s' %
 279                     src.printcolors.printcInfo(product_info.cvs_info.tag),
 280                  3,
 281                  False)
 282     # at least one '.' is visible
 283     logger.write(' %s. ' % ('.' * (10 - len(product_info.cvs_info.tag))),
 284                  3,
 285                  False)
 286     logger.flush()
 287     logger.write('\n', 5, False)
 288
 289     # Call the system function that do the extraction in cvs mode
 290     retcode = src.system.cvs_extract(protocol, user,
 291                                  product_info.cvs_info.server,
 292                                  product_info.cvs_info.product_base,
 293                                  product_info.cvs_info.tag,
 294                                  product_info.cvs_info.source,
 295                                  source_dir, logger, checkout, environ)
 296     return retcode
 297
 298 def get_source_from_svn(user,
 299                         product_info,
 300                         source_dir,
 301                         checkout,
 302                         logger,
 303                         environ = None):
 304     '''The method called if the product is to be get in svn mode
 305
 306     :param user str: The user to use in for the svn command
 307     :param product_info Config: The configuration specific to
 308                                the product to be prepared
 309     :param source_dir Path: The Path instance corresponding to the
 310                             directory where to put the sources
 311     :param checkout boolean: If True, get the source in checkout mode
 312     :param logger Logger: The logger instance to use for the display and logging
 313     :param environ src.environment.Environ: The environment to source when
 314                                                 extracting.
 315     :return: True if it succeed, else False
 316     :rtype: boolean
 317     '''
 318     coflag = 'svn'
 319     if checkout: coflag = src.printcolors.printcHighlight(coflag.upper())
 320
 321     logger.write('%s:%s ... ' % (coflag,
 322                                  src.printcolors.printcInfo(
 323                                             product_info.svn_info.repo)),
 324                  3,
 325                  False)
 326     logger.flush()
 327     logger.write('\n', 5, False)
 328     # Call the system function that do the extraction in svn mode
 329     retcode = src.system.svn_extract(user,
 330                                      product_info.svn_info.repo,
 331                                      product_info.svn_info.tag,
 332                                      source_dir,
 333                                      logger,
 334                                      checkout,
 335                                      environ)
 336     return retcode
 337
 338 def get_product_sources(config,
 339                        product_info,
 340                        is_dev,
 341                        source_dir,
 342                        logger,
 343                        pad,
 344                        checkout=False):
 345     '''Get the product sources.
 346
 347     :param config Config: The global configuration
 348     :param product_info Config: The configuration specific to
 349                                the product to be prepared
 350     :param is_dev boolean: True if the product is in development mode
 351     :param source_dir Path: The Path instance corresponding to the
 352                             directory where to put the sources
 353     :param logger Logger: The logger instance to use for the display and logging
 354     :param pad int: The gap to apply for the terminal display
 355     :param checkout boolean: If True, get the source in checkout mode
 356     :return: True if it succeed, else False
 357     :rtype: boolean
 358     '''
 359
 360     # Get the application environment
 361     logger.write(_("Set the application environment\n"), 5)
 362     env_appli = src.environment.SalomeEnviron(config,
 363                                       src.environment.Environ(dict(os.environ)))
 364     env_appli.set_application_env(logger)
 365
 366     # Call the right function to get sources regarding the product settings
 367     if not checkout and is_dev:
 368         return get_source_for_dev(config,
 369                                    product_info,
 370                                    source_dir,
 371                                    logger,
 372                                    pad)
 373
 374     if product_info.get_source == "git":
 375         return get_source_from_git(config, product_info, source_dir, logger, pad,
 376                                     is_dev,env_appli)
 377
 378     if product_info.get_source == "archive":
 379         return get_source_from_archive(config, product_info, source_dir, logger)
 380
 381     if product_info.get_source == "dir":
 382         return get_source_from_dir(product_info, source_dir, logger)
 383
 384     if product_info.get_source == "cvs":
 385         cvs_user = config.USER.cvs_user
 386         return get_source_from_cvs(cvs_user,
 387                                     product_info,
 388                                     source_dir,
 389                                     checkout,
 390                                     logger,
 391                                     pad,
 392                                     env_appli)
 393
 394     if product_info.get_source == "svn":
 395         svn_user = config.USER.svn_user
 396         return get_source_from_svn(svn_user, product_info, source_dir,
 397                                     checkout,
 398                                     logger,
 399                                     env_appli)
 400
 401     if product_info.get_source == "native":
 402         # skip
 403         logger.write('%s  ' % src.printcolors.printc(src.OK_STATUS),
 404                      3,
 405                      False)
 406         msg = _('INFORMATION : Not doing anything because the product'
 407                 ' is of type "native".\n')
 408         logger.write(msg, 3)
 409         return True
 410
 411     if product_info.get_source == "fixed":
 412         # skip
 413         logger.write('%s  ' % src.printcolors.printc(src.OK_STATUS),
 414                      3,
 415                      False)
 416         msg = "FIXED : %s\n" % product_info.install_dir
 417
 418         if not os.path.isdir(product_info.install_dir):
 419             logger.warning("The fixed path do not exixts!! Please check it : %s\n" % product_info.install_dir)
 420         else:
 421             logger.write(msg, 3)
 422         return True
 423
 424     # if the get_source is not in [git, archive, cvs, svn, fixed, native]
 425     logger.write(_("Unknown get source method \"%(get)s\" for product %(product)s") % \
 426         { 'get': product_info.get_source, 'product': product_info.name }, 3, False)
 427     logger.write(" ... ", 3, False)
 428     logger.flush()
 429     return False
 430
 431 def get_all_product_sources(config, products, logger):
 432     '''Get all the product sources.
 433
 434     :param config Config: The global configuration
 435     :param products List: The list of tuples (product name, product informations)
 436     :param logger Logger: The logger instance to be used for the logging
 437     :return: the tuple (number of success, dictionary product_name/success_fail)
 438     :rtype: (int,dict)
 439     '''
 440
 441     # Initialize the variables that will count the fails and success
 442     results = dict()
 443     good_result = 0
 444
 445     # Get the maximum name length in order to format the terminal display
 446     max_product_name_len = 1
 447     if len(products) > 0:
 448         max_product_name_len = max(map(lambda l: len(l), products[0])) + 4
 449
 450     # The loop on all the products from which to get the sources
 451     # DBG.write("source.get_all_product_sources config id", id(config), True)
 452     for product_name, product_info in products:
 453         # get product name, product informations and the directory where to put
 454         # the sources
 455         if (not (src.product.product_is_fixed(product_info) or
 456                  src.product.product_is_native(product_info))):
 457             source_dir = src.Path(product_info.source_dir)
 458         else:
 459             source_dir = src.Path('')
 460
 461         # display and log
 462         logger.write('%s: ' % src.printcolors.printcLabel(product_name), 3)
 463         logger.write(' ' * (max_product_name_len - len(product_name)), 3, False)
 464         logger.write("\n", 4, False)
 465
 466         # Remove the existing source directory if
 467         # the product is not in development mode
 468         is_dev = src.product.product_is_dev(product_info)
 469         if source_dir.exists():
 470             logger.write('%s  ' % src.printcolors.printc(src.OK_STATUS), 3, False)
 471             msg = _("INFO : Not doing anything because the source directory already exists:\n    %s\n") % source_dir
 472             logger.write(msg, 3)
 473             good_result = good_result + 1
 474             # Do not get the sources and go to next product
 475             continue
 476
 477         # Call to the function that get the sources for one product
 478         retcode = get_product_sources(config,
 479                                      product_info,
 480                                      is_dev,
 481                                      source_dir,
 482                                      logger,
 483                                      max_product_name_len,
 484                                      checkout=False)
 485
 486         '''
 487         if 'no_rpath' in product_info.keys():
 488             if product_info.no_rpath:
 489                 hack_no_rpath(config, product_info, logger)
 490         '''
 491
 492         # Check that the sources are correctly get using the files to be tested
 493         # in product information
 494         if retcode:
 495             check_OK, wrong_path = check_sources(product_info, logger)
 496             if not check_OK:
 497                 # Print the missing file path
 498                 msg = _("The required file %s does not exists. " % wrong_path)
 499                 logger.write(src.printcolors.printcError("\nERROR: ") + msg, 3)
 500                 retcode = False
 501
 502         # show results
 503         results[product_name] = retcode
 504         if retcode:
 505             # The case where it succeed
 506             res = src.OK_STATUS
 507             good_result = good_result + 1
 508         else:
 509             # The case where it failed
 510             res = src.KO_STATUS
 511
 512         # print the result
 513         if not(src.product.product_is_fixed(product_info) or
 514                src.product.product_is_native(product_info)):
 515             logger.write('%s\n' % src.printcolors.printc(res), 3, False)
 516
 517     return good_result, results
 518
 519 def check_sources(product_info, logger):
 520     '''Check that the sources are correctly get, using the files to be tested
 521        in product information
 522
 523     :param product_info Config: The configuration specific to
 524                                 the product to be prepared
 525     :return: True if the files exists (or no files to test is provided).
 526     :rtype: boolean
 527     '''
 528     # Get the files to test if there is any
 529     if ("present_files" in product_info and
 530         "source" in product_info.present_files):
 531         l_files_to_be_tested = product_info.present_files.source
 532         for file_path in l_files_to_be_tested:
 533             # The path to test is the source directory
 534             # of the product joined the file path provided
 535             path_to_test = os.path.join(product_info.source_dir, file_path)
 536             logger.write(_("\nTesting existence of file: \n"), 5)
 537             logger.write(path_to_test, 5)
 538             if not os.path.exists(path_to_test):
 539                 return False, path_to_test
 540             logger.write(src.printcolors.printcSuccess(" OK\n"), 5)
 541     return True, ""
 542
 543 def description():
 544     '''method that is called when salomeTools is called with --help option.
 545
 546     :return: The text to display for the source command description.
 547     :rtype: str
 548     '''
 549     return _("The source command gets the sources of the application products "
 550              "from cvs, git or an archive.\n\nexample:"
 551              "\nsat source SALOME-master --products KERNEL,GUI")
 552
 553 def run(args, runner, logger):
 554     '''method that is called when salomeTools is called with source parameter.
 555     '''
 556     DBG.write("source.run()", args)
 557     # Parse the options
 558     (options, args) = parser.parse_args(args)
 559
 560     # check that the command has been called with an application
 561     src.check_config_has_application( runner.cfg )
 562
 563     # Print some informations
 564     logger.write(_('Getting sources of the application %s\n') %
 565                 src.printcolors.printcLabel(runner.cfg.VARS.application), 1)
 566     src.printcolors.print_value(logger, 'workdir',
 567                                 runner.cfg.APPLICATION.workdir, 2)
 568     logger.write("\n", 2, False)
 569
 570     # Get the products list with products informations regarding the options
 571     products_infos = src.product.get_products_list(options, runner.cfg, logger)
 572
 573     # Call to the function that gets all the sources
 574     good_result, results = get_all_product_sources(runner.cfg,
 575                                                   products_infos,
 576                                                   logger)
 577
 578     # Display the results (how much passed, how much failed, etc...)
 579     status = src.OK_STATUS
 580     details = []
 581
 582     logger.write("\n", 2, False)
 583     if good_result == len(products_infos):
 584         res_count = "%d / %d" % (good_result, good_result)
 585     else:
 586         status = src.KO_STATUS
 587         res_count = "%d / %d" % (good_result, len(products_infos))
 588
 589         for product in results:
 590             if results[product] == 0 or results[product] is None:
 591                 details.append(product)
 592
 593     result = len(products_infos) - good_result
 594
 595     # write results
 596     logger.write(_("Getting sources of the application:"), 1)
 597     logger.write(" " + src.printcolors.printc(status), 1, False)
 598     logger.write(" (%s)\n" % res_count, 1, False)
 599
 600     if len(details) > 0:
 601         logger.write(_("Following sources haven't been get:\n"), 2)
 602         logger.write(" ".join(details), 2)
 603         logger.write("\n", 2, False)
 604
 605     return result