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     # Set the debug and dev keys
 121     if prod_info is not None:
 122         prod_info.debug = debug
 123         prod_info.dev = dev
 124
 125     # Set the install_dir key
 126     if "install_dir" not in prod_info:
 127         # Set it to the default value (in application directory)
 128         prod_info.install_dir = os.path.join(config.APPLICATION.workdir,
 129                                             "INSTALL",
 130                                             prod_info.name)
 131     else:
 132         if prod_info.install_dir == "base":
 133             # Get the product base of the application
 134             base_path = src.get_base_path(config)
 135             prod_info.install_dir = os.path.join(base_path,
 136                                             prod_info.name)
 137
 138     return prod_info
 139
 140 def get_products_infos(lproducts, config):
 141     '''Get the specific configuration of a list of products
 142
 143     :param lproducts List: The list of product names
 144     :param config Config: The global configuration
 145     :return: the list of tuples
 146              (product name, specific configuration of the product)
 147     :rtype: [(str, Config)]
 148     '''
 149     products_infos = []
 150     # Loop on product names
 151     for prod in lproducts:
 152         # Get the specific configuration of the product
 153         prod_info = get_product_config(config, prod)
 154         if prod_info is not None:
 155             products_infos.append((prod, prod_info))
 156         else:
 157             msg = _("The %s product has no definition in the configuration.") % prod
 158             raise src.SatException(msg)
 159     return products_infos
 160
 161
 162 def product_is_sample(product_info):
 163     '''Know if a product has the sample type
 164
 165     :param product_info Config: The configuration specific to
 166                                the product
 167     :return: True if the product has the sample type, else False
 168     :rtype: boolean
 169     '''
 170     if 'type' in product_info:
 171         ptype = product_info.type
 172         return ptype.lower() == 'sample'
 173     else:
 174         return False
 175
 176 def product_is_fixed(product_info):
 177     '''Know if a product is fixed
 178
 179     :param product_info Config: The configuration specific to
 180                                the product
 181     :return: True if the product is fixed, else False
 182     :rtype: boolean
 183     '''
 184     get_src = product_info.get_source
 185     return get_src.lower() == 'fixed'
 186
 187 def product_is_native(product_info):
 188     '''Know if a product is native
 189
 190     :param product_info Config: The configuration specific to
 191                                the product
 192     :return: True if the product is native, else False
 193     :rtype: boolean
 194     '''
 195     get_src = product_info.get_source
 196     return get_src.lower() == 'native'
 197
 198 def product_is_dev(product_info):
 199     '''Know if a product is in dev mode
 200
 201     :param product_info Config: The configuration specific to
 202                                the product
 203     :return: True if the product is in dev mode, else False
 204     :rtype: boolean
 205     '''
 206     dev = product_info.dev
 207     return dev.lower() == 'yes'
 208
 209 def product_is_debug(product_info):
 210     '''Know if a product is in debug mode
 211
 212     :param product_info Config: The configuration specific to
 213                                the product
 214     :return: True if the product is in debug mode, else False
 215     :rtype: boolean
 216     '''
 217     debug = product_info.debug
 218     return debug.lower() == 'yes'