3 # Copyright (C) 2010-2013 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
21 initial imports and utilities methods for salomeTools
30 from ftplib import FTP
33 from . import architecture
34 from . import printcolors
37 from . import ElementTree
40 from . import environment
41 from . import fileEnviron
42 from . import compilation
43 from . import test_module
44 from . import template
47 if platform.system() == "Windows" :
54 KNOWNFAILURE_STATUS = "KF"
55 TIMEOUT_STATUS = "TIMEOUT"
57 class SatException(Exception):
58 """rename Exception Class"""
61 def ensure_path_exists(p):
62 """Create a path if not existing
64 :param p str: The path.
66 if not os.path.exists(p):
69 def check_config_has_application( config, details = None ):
70 """check that the config has the key APPLICATION. Else raise an exception.
72 :param config class 'common.pyconf.Config': The config.
74 if 'APPLICATION' not in config:
75 message = _("An APPLICATION is required. Use 'config --list' to get the list of available applications.\n")
77 details.append(message)
78 raise SatException( message )
80 def check_config_has_profile( config, details = None ):
82 check that the config has the key APPLICATION.profile.
83 else, raise an exception.
85 :param config class 'common.pyconf.Config': The config.
87 check_config_has_application(config)
88 if 'profile' not in config.APPLICATION:
89 message = _("A profile section is required in your application.\n")
91 details.append(message)
92 raise SatException( message )
94 def appli_test_property(config,property_name, property_value):
95 """Generic function to test if an application has a property set to a value
96 :param config class 'common.pyconf.Config': The config.
97 :param property_name : The name of the property to check
98 :param property_value : The value of the property to test
99 :return: True if the application has the property set to property_value
102 # first check if application has property_value
103 if not ("APPLICATION" in config and
104 "properties" in config.APPLICATION and
105 property_name in config.APPLICATION.properties):
108 # then check to the property is set to property_value
109 eval_expression = 'config.APPLICATION.properties.%s == "%s"' %\
110 (property_name,property_value)
111 result = eval(eval_expression)
115 def config_has_application( config ):
116 return 'APPLICATION' in config
118 def get_cfg_param(config, param_name, default):
120 eearch for param_name value in config.
121 if param_name is not in config
123 else return the found value
125 :param config class 'common.pyconf.Config': The config.
126 :param param_name str: the name of the parameter to get the value
127 :param default str: The value to return if param_name is not in config
128 :return: see initial description of the function
131 if param_name in config:
132 return config[param_name]
135 def strSplitN(aList, nb, skip="\n "):
138 aStr = 'this-is-a-string'
140 split it by every 2nd '-' rather than every '-'
145 strValue += "%15s, " % str(v)
151 strValue = skip + strValue
154 def getProductNames(cfg, wildcards, logger):
155 """get products names using * or ? as wildcards like shell Linux"""
157 if type(wildcards) is list:
162 products = cfg.APPLICATION.products.keys()
163 for wild in wildcards:
165 for prod in products:
166 filtered = fnmatch.filter([prod], wild)
167 # print("filtered", prod, wild, filtered)
168 if len(filtered) > 0:
173 notFound[wild] = None
175 logger.warning("Empty list of products, from %s" % wilds)
176 if len(notFound.keys()) > 0:
177 strProd = strSplitN( sorted(products), 5)
178 logger.warning("products not found: %s\n availables products are:\n%s" % \
179 (sorted(notFound.keys()), strProd) )
183 def print_info(logger, info):
185 Prints the tuples that are in info variable in a formatted way.
187 :param logger Logger: The logging instance to use for the prints.
188 :param info list: The list of tuples to display
190 # find the maximum length of the first value of the tuples in info
191 smax = max(map(lambda l: len(l[0]), info))
192 # Print each item of info with good indentation
194 sp = " " * (smax - len(i[0]))
195 printcolors.print_value(logger, sp + i[0], i[1], 2)
196 logger.write("\n", 2)
198 def get_base_path(config):
200 Returns the path of the products base.
202 :param config Config: The global Config instance.
203 :return: The path of the products base.
206 if "base" not in config.LOCAL:
207 local_file_path = os.path.join(config.VARS.salometoolsway,
210 msg = _("Please define a base path in the file %s" % local_file_path)
211 raise SatException(msg)
213 base_path = os.path.abspath(config.LOCAL.base)
217 def get_launcher_name(config):
219 Returns the name of salome launcher.
221 :param config Config: The global Config instance.
222 :return: The name of salome launcher.
225 check_config_has_application(config)
226 if 'profile' in config.APPLICATION and 'launcher_name' in config.APPLICATION.profile:
227 launcher_name = config.APPLICATION.profile.launcher_name
229 launcher_name = 'salome'
233 def get_launcher_exe(config):
235 Returns the name of exe defined in profile section.
237 :param config Config: The global Config instance.
238 :return: The name of the exe to use in launcher.
241 check_config_has_application(config)
242 if 'profile' in config.APPLICATION and 'exe' in config.APPLICATION.profile:
243 exe_name = config.APPLICATION.profile.exe
250 def get_log_path(config):
252 Returns the path of the logs.
254 :param config Config: The global Config instance.
255 :return: The path of the logs.
258 if "log_dir" not in config.LOCAL:
259 local_file_path = os.path.join(config.VARS.salometoolsway,
262 msg = _("Please define a log_dir in the file %s" % local_file_path)
263 raise SatException(msg)
265 log_dir_path = os.path.abspath(config.LOCAL.log_dir)
269 def get_salometool_version(config):
270 """Return the salomeTool version.
272 :param config Config: The global Config instance.
273 :return: the description of this version of sat in terms of tag and commit
275 return config.LOCAL.tag
278 def get_salome_version(config):
279 import versionMinorMajorPatch as VMMP
281 if hasattr(config.APPLICATION, 'version_salome'):
282 version = VMMP.MinorMajorPatch(config.APPLICATION.version_salome)
284 kernel_info = product.get_product_config(config, "KERNEL")
285 aFile = os.path.join(
286 kernel_info.install_dir,
290 if not os.path.isfile(aFile):
292 with open(aFile) as f:
293 line = f.readline() # example: '[SALOME KERNEL] : 8.4.0'
294 version = VMMP.MinorMajorPatch(line.split(":")[1])
296 res = version.strCompact()
297 # print("get_salome_version %s -> %s" % (version, res))
298 return int(res) # TODO may be future avoid test(s) on integer, use MajorMinorPatch
300 def read_config_from_a_file(filePath):
302 cfg_file = pyconf.Config(filePath)
303 except pyconf.ConfigError as e:
304 raise SatException(_("Error in configuration file: %(file)s\n %(error)s") % \
305 { 'file': filePath, 'error': str(e) })
308 def get_tmp_filename(cfg, name):
309 if not os.path.exists(cfg.VARS.tmp_root):
310 os.makedirs(cfg.VARS.tmp_root)
312 return os.path.join(cfg.VARS.tmp_root, name)
315 # Utils class to simplify path manipulations.
317 def __init__(self, path):
318 self.path = str(path)
320 def __add__(self, other):
321 return Path(os.path.join(self.path, str(other)))
324 return Path(os.path.abspath(self.path))
329 def __eq__(self, other):
330 return self.path == other.path
333 return self.islink() or os.path.exists(self.path)
336 return os.path.islink(self.path)
339 return os.path.isdir(self.path)
342 return os.path.isfile(self.path)
345 return [Path(p) for p in os.listdir(self.path)]
348 return Path(os.path.dirname(self.path))
351 return Path(os.path.basename(self.path))
353 def make(self, mode=None):
354 os.makedirs(self.path)
356 os.chmod(self.path, mode)
358 def chmod(self, mode):
359 os.chmod(self.path, mode)
365 shutil.rmtree( self.path, onerror = handleRemoveReadonly )
367 def copy(self, path, smart=False):
368 if not isinstance(path, Path):
371 if os.path.islink(self.path):
372 return self.copylink(path)
373 elif os.path.isdir(self.path):
374 return self.copydir(path, smart)
376 return self.copyfile(path)
378 def smartcopy(self, path):
379 return self.copy(path, True)
383 return os.readlink(self.path)
387 def symlink(self, path):
389 os.symlink(str(path), self.path)
394 def copylink(self, path):
396 os.symlink(os.readlink(self.path), str(path))
401 def copydir(self, dst, smart=False):
411 if smart and (str(name) in [".git", "CVS", ".svn"]):
413 srcname = self + name
415 srcname.copy(dstname, smart)
420 def copyfile(self, path):
422 shutil.copy2(self.path, str(path))
427 def find_file_in_lpath(file_name, lpath, additional_dir = ""):
429 Find in all the directories in lpath list the file that has the same name
432 then return the full path of the file
435 The additional_dir (optional) is the name of the directory to add to all
438 :param file_name str: The file name to search
439 :param lpath List: The list of directories where to search
440 :param additional_dir str: The name of the additional directory
441 :return: the full path of the file or False if not found
444 for directory in lpath:
445 dir_complete = os.path.join(directory, additional_dir)
446 if not os.path.isdir(directory) or not os.path.isdir(dir_complete):
448 l_files = os.listdir(dir_complete)
449 for file_n in l_files:
450 if file_n == file_name:
451 return os.path.join(dir_complete, file_name)
454 def find_file_in_ftppath(file_name, ftppath, installation_dir, logger):
456 Find in all ftp servers in ftppath the file called file_name
457 If it is found then return the destination path of the file
458 (the place where the file was downloaded"
461 :param file_name str: The file name to search
462 :param ftppath, List: The list of ftp servers where to search
463 :param installation_dir str: The name of the installation directory
464 :return: the full path of the file or False if not found
465 :param logger Logger: The logging instance to use for the prints.
469 # make sure installation_dir exists
470 if not os.path.exists(installation_dir):
471 os.makedirs(installation_dir)
473 destination=os.path.join(installation_dir, file_name)
475 # paths in ftppath may contain several paths separated by ":"
476 # we plit them, and push all paths in bigftppath
478 for ipath in ftppath:
479 splpath=ipath.split(":")
482 for ftp_archive in bigftppath:
484 # ftp_archive has the form ftp.xxx.yyy/dir1/dir2/...
485 ftp_archive_split=ftp_archive.split("/")
486 ftp_server=ftp_archive_split[0]
487 ftp = FTP(ftp_server)
488 logger.write(" Connect to ftp server %s\n" % ftp_server, 3)
490 for directory in ftp_archive_split[1:]:
491 logger.write(" Change directory to %s\n" % directory, 3)
494 logger.error("while connecting to ftp server %s\n" % ftp_server)
497 if ftp.size(file_name) > 0:
498 # if file exists and is non empty
499 with open(destination,'wb') as dest_file:
500 ftp.retrbinary("RETR "+file_name, dest_file.write)
501 logger.write(" Archive %s was retrieved and stored in %s\n" % (file_name, destination), 3)
504 logger.error("File not found in ftp_archive %s\n" % ftp_server)
509 def handleRemoveReadonly(func, path, exc):
511 if func in (os.rmdir, os.remove) and excvalue.errno == errno.EACCES:
512 os.chmod(path, stat.S_IRWXU| stat.S_IRWXG| stat.S_IRWXO) # 0777
517 def deepcopy_list(input_list):
519 Do a deep copy of a list
521 :param input_list List: The list to copy
522 :return: The copy of the list
526 for elem in input_list:
530 def remove_item_from_list(input_list, item):
532 Remove all occurences of item from input_list
534 :param input_list List: The list to modify
535 :return: The without any item
539 for elem in input_list:
545 def parse_date(date):
547 Transform YYYYMMDD_hhmmss into YYYY-MM-DD hh:mm:ss.
549 :param date str: The date to transform
550 :return: The date in the new format
555 res = "%s-%s-%s %s:%s:%s" % (date[0:4],
563 def merge_dicts(*dict_args):
565 Given any number of dicts, shallow copy and merge into a new dict,
566 precedence goes to key value pairs in latter dicts.
569 for dictionary in dict_args:
570 result.update(dictionary)
573 def replace_in_file(filein, strin, strout):
574 """Replace <strin> by <strout> in file <filein>"""
575 shutil.move(filein, filein + "_old")
577 filein = filein + "_old"
578 fin = open(filein, "r")
579 fout = open(fileout, "w")
581 fout.write(line.replace(strin, strout))
583 def get_property_in_product_cfg(product_cfg, pprty):
584 if not "properties" in product_cfg:
586 if not pprty in product_cfg.properties:
588 return product_cfg.properties[pprty]
590 def activate_mesa_property(config):
591 """Add mesa property into application properties
593 :param config Config: The global configuration. It must have an application!
595 # Verify the existence of the file
596 if not 'properties' in config.APPLICATION:
597 config.APPLICATION.addMapping( 'properties', pyconf.Mapping(), None )
598 config.APPLICATION.properties.use_mesa="yes"