src/product.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 '''In this file are implemented the classes and methods
  19    relative to the product notion of salomeTools
  20 '''
  21
  22 import os
  23
  24 import src
  25
  26 AVAILABLE_VCS = ['git', 'svn', 'cvs']
  27
  28 def get_product_config(config, product_name):
  29     '''Get the specific configuration of a product from the global configuration
  30
  31     :param config Config: The global configuration
  32     :param product_name str: The name of the product
  33     :return: the specific configuration of the product
  34     :rtype: Config
  35     '''
  36
  37     # Get the version of the product from the application definition
  38     version = config.APPLICATION.products[product_name]
  39     # if no version, then take the default one defined in the application
  40     if isinstance(version, bool):
  41         version = config.APPLICATION.tag
  42
  43     # Define debug and dev modes
  44     # Get the tag if a dictionary is given in APPLICATION.products for the
  45     # current product
  46     debug = 'no'
  47     dev = 'no'
  48     if isinstance(version, src.pyconf.Mapping):
  49         dic_version = version
  50         # Get the version/tag
  51         if not 'tag' in dic_version:
  52             version = config.APPLICATION.tag
  53         else:
  54             version = dic_version.tag
  55
  56         # Get the debug if any
  57         if 'debug' in dic_version:
  58             debug = dic_version.debug
  59
  60         # Get the dev if any
  61         if 'dev' in dic_version:
  62             dev = dic_version.dev
  63
  64     vv = version
  65     # substitute some character with _ in order to get the correct definition
  66     # in config.PRODUCTS. This is done because the pyconf tool does not handle
  67     # the . and - characters
  68     for c in ".-": vv = vv.replace(c, "_")
  69     full_product_name = product_name + '_' + vv
  70
  71     prod_info = None
  72     # If it exists, get the information of the product_version
  73     if full_product_name in config.PRODUCTS:
  74         # returns specific information for the given version
  75         prod_info = config.PRODUCTS[full_product_name]
  76     # Get the standard informations
  77     elif product_name in config.PRODUCTS:
  78         # returns the generic information (given version not found)
  79         prod_info = config.PRODUCTS[product_name]
  80
  81     # merge opt_depend in depend
  82     if prod_info is not None and 'opt_depend' in prod_info:
  83         for depend in prod_info.opt_depend:
  84             if depend in config.PRODUCTS:
  85                 prod_info.depend.append(depend,'')
  86
  87     # In case of a product get with a vcs, put the tag (equal to the version)
  88     if prod_info is not None and prod_info.get_source in AVAILABLE_VCS:
  89
  90         if prod_info.get_source == 'git':
  91             prod_info.git_info.tag = version
  92
  93         if prod_info.get_source == 'svn':
  94             prod_info.svn_info.tag = version
  95
  96         if prod_info.get_source == 'cvs':
  97             prod_info.cvs_info.tag = version
  98
  99     # In case of a fixed product, define the install_dir (equal to the version)
 100     if prod_info is not None and prod_info.get_source=="fixed":
 101         prod_info.install_dir = version
 102
 103     # Check if the product is defined as native in the application
 104     if prod_info is not None:
 105         if version == "native":
 106             prod_info.get_source = "native"
 107         elif prod_info.get_source == "native":
 108             msg = _("The product %(prod)s has version %(ver)s but is declared"
 109                     " as native in its definition" %
 110                 { 'prod': prod_info.name, 'ver': version})
 111             raise src.SatException(msg)
 112
 113     # If there is no definition but the product is declared as native,
 114     # construct a new definition containing only the get_source key
 115     if prod_info is None and version == "native":
 116         prod_info = src.pyconf.Config()
 117         prod_info.name = product_name
 118         prod_info.get_source = "native"
 119
 120     # If prod_info is still None, it means that there is no product definition
 121     # in the config. The user has to provide it.
 122     if prod_info is None:
 123         msg = _("No definition found for the product %s\n"
 124             "Please create a %s.pyconf file." % (product_name, product_name))
 125         raise src.SatException(msg)
 126
 127     # Set the debug, dev and version keys
 128     prod_info.debug = debug
 129     prod_info.dev = dev
 130     prod_info.version = version
 131
 132     # Set the install_dir key
 133     if "install_dir" not in prod_info:
 134         # Set it to the default value (in application directory)
 135         prod_info.install_dir = os.path.join(config.APPLICATION.workdir,
 136                                             "INSTALL",
 137                                             prod_info.name)
 138     else:
 139         if prod_info.install_dir == "base":
 140             # Get the product base of the application
 141             base_path = src.get_base_path(config)
 142             prod_info.install_dir = os.path.join(base_path,
 143                                             prod_info.name + "-" + version)
 144
 145     # If the product compiles with a script, check the script existence
 146     # and if it is executable
 147     if product_has_script(prod_info):
 148         # Check the compil_script key existence
 149         if "compil_script" not in prod_info:
 150             msg = _("No compilation script found for the product %s\n"
 151                 "Please provide a \"compil_script\" key in its definition."
 152                 % (product_name))
 153             raise src.SatException(msg)
 154
 155         # Get the path of the script
 156         script = prod_info.compil_script
 157         script_name = os.path.basename(script)
 158         if script == script_name:
 159             # Only a name is given. Search in the default directory
 160             script_path = os.path.join(
 161                     config.INTERNAL.compile.default_script_dir, script_name)
 162             prod_info.compil_script = script_path
 163
 164         # Check script existence
 165         if not os.path.exists(prod_info.compil_script):
 166             raise src.SatException(_("Compilation script not found: %s") %
 167                                    prod_info.compil_script)
 168
 169         # Check that the script is executable
 170         if not os.access(prod_info.compil_script, os.X_OK):
 171             raise src.SatException(
 172                     _("Compilation script cannot be executed: %s") %
 173                     prod_info.compil_script)
 174
 175     return prod_info
 176
 177 def get_products_infos(lproducts, config):
 178     '''Get the specific configuration of a list of products
 179
 180     :param lproducts List: The list of product names
 181     :param config Config: The global configuration
 182     :return: the list of tuples
 183              (product name, specific configuration of the product)
 184     :rtype: [(str, Config)]
 185     '''
 186     products_infos = []
 187     # Loop on product names
 188     for prod in lproducts:
 189         # Get the specific configuration of the product
 190         prod_info = get_product_config(config, prod)
 191         if prod_info is not None:
 192             products_infos.append((prod, prod_info))
 193         else:
 194             msg = _("The %s product has no definition "
 195                     "in the configuration.") % prod
 196             raise src.SatException(msg)
 197     return products_infos
 198
 199 def get_product_dependencies(config, product_info):
 200     '''Get recursively the list of products that are
 201        in the product_info dependencies
 202
 203     :param config Config: The global configuration
 204     :param product_info Config: The configuration specific to
 205                                the product
 206     :return: the list of products in dependence
 207     :rtype: list
 208     '''
 209     if "depend" not in product_info or product_info.depend == []:
 210         return []
 211     res = []
 212     for prod in product_info.depend:
 213         if prod not in res:
 214             res.append(prod)
 215         prod_info = get_product_config(config, prod)
 216         dep_prod = get_product_dependencies(config, prod_info)
 217         for prod_in_dep in dep_prod:
 218             if prod_in_dep not in res:
 219                 res.append(prod_in_dep)
 220     return res
 221
 222 def check_installation(product_info):
 223     '''Verify if a product is well installed. Checks install directory presence
 224        and some additional files if it is defined in the config
 225
 226     :param product_info Config: The configuration specific to
 227                                the product
 228     :return: True if it is well installed
 229     :rtype: boolean
 230     '''
 231     install_dir = product_info.install_dir
 232     if not os.path.exists(install_dir):
 233         return False
 234     if ("present_files" in product_info and
 235         "install" in product_info.present_files):
 236         for file_relative_path in product_info.present_files.install:
 237             file_path = os.path.join(install_dir, file_relative_path)
 238             if not os.path.exists(file_path):
 239                 return False
 240     return True
 241
 242 def product_is_sample(product_info):
 243     '''Know if a product has the sample type
 244
 245     :param product_info Config: The configuration specific to
 246                                the product
 247     :return: True if the product has the sample type, else False
 248     :rtype: boolean
 249     '''
 250     if 'type' in product_info:
 251         ptype = product_info.type
 252         return ptype.lower() == 'sample'
 253     else:
 254         return False
 255
 256 def product_is_salome(product_info):
 257     '''Know if a product is of type salome
 258
 259     :param product_info Config: The configuration specific to
 260                                the product
 261     :return: True if the product is salome, else False
 262     :rtype: boolean
 263     '''
 264     if 'type' in product_info:
 265         ptype = product_info.type
 266         return ptype.lower() == 'salome'
 267     else:
 268         return False
 269
 270 def product_is_fixed(product_info):
 271     '''Know if a product is fixed
 272
 273     :param product_info Config: The configuration specific to
 274                                the product
 275     :return: True if the product is fixed, else False
 276     :rtype: boolean
 277     '''
 278     get_src = product_info.get_source
 279     return get_src.lower() == 'fixed'
 280
 281 def product_is_native(product_info):
 282     '''Know if a product is native
 283
 284     :param product_info Config: The configuration specific to
 285                                the product
 286     :return: True if the product is native, else False
 287     :rtype: boolean
 288     '''
 289     get_src = product_info.get_source
 290     return get_src.lower() == 'native'
 291
 292 def product_is_dev(product_info):
 293     '''Know if a product is in dev mode
 294
 295     :param product_info Config: The configuration specific to
 296                                the product
 297     :return: True if the product is in dev mode, else False
 298     :rtype: boolean
 299     '''
 300     dev = product_info.dev
 301     return dev.lower() == 'yes'
 302
 303 def product_is_debug(product_info):
 304     '''Know if a product is in debug mode
 305
 306     :param product_info Config: The configuration specific to
 307                                the product
 308     :return: True if the product is in debug mode, else False
 309     :rtype: boolean
 310     '''
 311     debug = product_info.debug
 312     return debug.lower() == 'yes'
 313
 314 def product_is_autotools(product_info):
 315     '''Know if a product is compiled using the autotools
 316
 317     :param product_info Config: The configuration specific to
 318                                the product
 319     :return: True if the product is autotools, else False
 320     :rtype: boolean
 321     '''
 322     build_src = product_info.build_source
 323     return build_src.lower() == 'autotools'
 324
 325 def product_is_cmake(product_info):
 326     '''Know if a product is compiled using the cmake
 327
 328     :param product_info Config: The configuration specific to
 329                                the product
 330     :return: True if the product is cmake, else False
 331     :rtype: boolean
 332     '''
 333     build_src = product_info.build_source
 334     return build_src.lower() == 'cmake'
 335
 336 def product_has_script(product_info):
 337     '''Know if a product has a compilation script
 338
 339     :param product_info Config: The configuration specific to
 340                                the product
 341     :return: True if the product it has a compilation script, else False
 342     :rtype: boolean
 343     '''
 344     if "build_source" not in product_info:
 345         # Native case
 346         return False
 347     build_src = product_info.build_source
 348     return build_src.lower() == 'script'