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
27 C_COMPILE_ENV_LIST = ["CC",
36 """Class to handle all construction steps, like cmake, configure, make, ...
42 options = src.options.OptResult(),
46 self.options = options
47 self.product_info = product_info
48 self.build_dir = src.Path(self.product_info.build_dir)
49 self.source_dir = src.Path(self.product_info.source_dir)
50 self.install_dir = src.Path(self.product_info.install_dir)
52 self.debug_mode = False
53 if "debug" in self.product_info and self.product_info.debug == "yes":
54 self.debug_mode = True
55 self.verbose_mode = False
56 if "verbose" in self.product_info and self.product_info.verbose == "yes":
57 self.verbose_mode = True
60 # Shortcut method to log in log file.
61 def log(self, text, level, showInfo=True):
62 self.logger.write(text, level, showInfo)
63 self.logger.logTxtFile.write(src.printcolors.cleancolor(text))
67 # Shortcut method to log a command.
68 def log_command(self, command):
69 self.log("> %s\n" % command, 5)
72 # Prepares the environment.
73 # Build two environment: one for building and one for testing (launch).
76 if not self.build_dir.exists():
80 self.log(' build_dir = %s\n' % str(self.build_dir), 4)
81 self.log(' install_dir = %s\n' % str(self.install_dir), 4)
84 # add products in depend and opt_depend list recursively
85 environ_info = src.product.get_product_dependencies(self.config,
87 #environ_info.append(self.product_info.name)
89 # create build environment
90 self.build_environ = src.environment.SalomeEnviron(self.config,
91 src.environment.Environ(dict(os.environ)),
93 self.build_environ.silent = (self.config.USER.output_verbose_level < 5)
94 self.build_environ.set_full_environ(self.logger, environ_info)
96 # create runtime environment
97 self.launch_environ = src.environment.SalomeEnviron(self.config,
98 src.environment.Environ(dict(os.environ)),
100 self.launch_environ.silent = True # no need to show here
101 self.launch_environ.set_full_environ(self.logger, environ_info)
103 for ee in C_COMPILE_ENV_LIST:
104 vv = self.build_environ.get(ee)
106 self.log(" %s = %s\n" % (ee, vv), 4, False)
111 # Runs cmake with the given options.
112 def cmake(self, options=""):
114 cmake_option = options
115 # cmake_option +=' -DCMAKE_VERBOSE_MAKEFILE=ON -DSALOME_CMAKE_DEBUG=ON'
116 if 'cmake_options' in self.product_info:
117 cmake_option += " %s " % " ".join(
118 self.product_info.cmake_options.split())
122 cmake_option += " -DCMAKE_BUILD_TYPE=Debug"
124 cmake_option += " -DCMAKE_BUILD_TYPE=Release"
126 # add verbose option if specified in application for this product.
127 if self.verbose_mode:
128 cmake_option += " -DCMAKE_VERBOSE_MAKEFILE=ON"
130 # In case CMAKE_GENERATOR is defined in environment,
131 # use it in spite of automatically detect it
132 if 'cmake_generator' in self.config.APPLICATION:
133 cmake_option += " -DCMAKE_GENERATOR=\"%s\"" \
134 % self.config.APPLICATION.cmake_generator
135 command = ("cmake %s -DCMAKE_INSTALL_PREFIX=%s %s" %
136 (cmake_option, self.install_dir, self.source_dir))
138 self.log_command(command)
139 # for key in sorted(self.build_environ.environ.environ.keys()):
140 # print key, " ", self.build_environ.environ.environ[key]
141 res = subprocess.call(command,
143 cwd=str(self.build_dir),
144 env=self.build_environ.environ.environ,
145 stdout=self.logger.logTxtFile,
146 stderr=subprocess.STDOUT)
148 self.put_txt_log_in_appli_log_dir("cmake")
155 # Runs build_configure with the given options.
156 def build_configure(self, options=""):
158 if 'buildconfigure_options' in self.product_info:
159 options += " %s " % self.product_info.buildconfigure_options
161 command = str('%s/build_configure') % (self.source_dir)
162 command = command + " " + options
163 self.log_command(command)
165 res = subprocess.call(command,
167 cwd=str(self.build_dir),
168 env=self.build_environ.environ.environ,
169 stdout=self.logger.logTxtFile,
170 stderr=subprocess.STDOUT)
171 self.put_txt_log_in_appli_log_dir("build_configure")
178 # Runs configure with the given options.
179 def configure(self, options=""):
181 if 'configure_options' in self.product_info:
182 options += " %s " % self.product_info.configure_options
184 command = "%s/configure --prefix=%s" % (self.source_dir,
185 str(self.install_dir))
187 command = command + " " + options
188 self.log_command(command)
190 res = subprocess.call(command,
192 cwd=str(self.build_dir),
193 env=self.build_environ.environ.environ,
194 stdout=self.logger.logTxtFile,
195 stderr=subprocess.STDOUT)
197 self.put_txt_log_in_appli_log_dir("configure")
203 def hack_libtool(self):
204 if not os.path.exists(str(self.build_dir + 'libtool')):
207 lf = open(os.path.join(str(self.build_dir), "libtool"), 'r')
208 for line in lf.readlines():
209 if 'hack_libtool' in line:
212 # fix libtool by replacing CC="<compil>" with hack_libtool function
213 hack_command='''sed -i "s%^CC=\\"\(.*\)\\"%hack_libtool() { \\n\\
214 if test \\"\$(echo \$@ | grep -E '\\\\\\-L/usr/lib(/../lib)?(64)? ')\\" == \\\"\\\" \\n\\
216 cmd=\\"\\1 \$@\\"\\n\\
218 cmd=\\"\\1 \\"\`echo \$@ | sed -r -e 's|(.*)-L/usr/lib(/../lib)?(64)? (.*)|\\\\\\1\\\\\\4 -L/usr/lib\\\\\\3|g'\`\\n\\
222 CC=\\"hack_libtool\\"%g" libtool'''
224 self.log_command(hack_command)
225 subprocess.call(hack_command,
227 cwd=str(self.build_dir),
228 env=self.build_environ.environ.environ,
229 stdout=self.logger.logTxtFile,
230 stderr=subprocess.STDOUT)
234 # Runs make to build the module.
235 def make(self, nb_proc, make_opt=""):
239 command = command + " -j" + str(nb_proc)
240 command = command + " " + make_opt
241 self.log_command(command)
242 res = subprocess.call(command,
244 cwd=str(self.build_dir),
245 env=self.build_environ.environ.environ,
246 stdout=self.logger.logTxtFile,
247 stderr=subprocess.STDOUT)
248 self.put_txt_log_in_appli_log_dir("make")
255 # Runs msbuild to build the module.
256 def wmake(self,nb_proc, opt_nb_proc = None):
258 hh = 'MSBUILD /m:%s' % str(nb_proc)
260 hh += " " + src.printcolors.printcWarning("DEBUG")
263 command = command + " /maxcpucount:" + str(nb_proc)
265 command = command + " /p:Configuration=Debug /p:Platform=x64 "
267 command = command + " /p:Configuration=Release /p:Platform=x64 "
268 command = command + " ALL_BUILD.vcxproj"
270 self.log_command(command)
271 res = subprocess.call(command,
273 cwd=str(self.build_dir),
274 env=self.build_environ.environ.environ,
275 stdout=self.logger.logTxtFile,
276 stderr=subprocess.STDOUT)
278 self.put_txt_log_in_appli_log_dir("make")
285 # Runs 'make install'.
287 if src.architecture.is_windows():
288 command = 'msbuild INSTALL.vcxproj'
290 command = command + " /p:Configuration=Debug /p:Platform=x64 "
292 command = command + " /p:Configuration=Release /p:Platform=x64 "
294 command = 'make install'
295 self.log_command(command)
297 res = subprocess.call(command,
299 cwd=str(self.build_dir),
300 env=self.build_environ.environ.environ,
301 stdout=self.logger.logTxtFile,
302 stderr=subprocess.STDOUT)
304 res_check=self.check_install()
306 self.log_command("Error in sat check install - some files are not installed!")
307 self.put_txt_log_in_appli_log_dir("makeinstall")
315 # this function checks wether a list of file patterns (specified by check_install keyword)
316 # exixts after the make install. The objective is to ensure the installation is complete.
317 # patterns are given relatively to the install dir of the product
318 def check_install(self):
320 if "check_install" in self.product_info:
321 self.log_command("Check installation of files")
322 for pattern in self.product_info.check_install:
323 # pattern is given relatively to the install dir
324 complete_pattern=os.path.join(self.product_info.install_dir, pattern)
325 self.log_command(" -> check %s" % complete_pattern)
326 # expansion of pattern : takes into account environment variables and unix shell rules
327 list_of_path=glob.glob(os.path.expandvars(complete_pattern))
329 # we expect to find at least one entry, if not we consider the test failed
331 self.logger.write("Error, sat check install failed for file pattern %s\n" % complete_pattern, 1)
332 self.log_command("Error, sat check install failed for file pattern %s" % complete_pattern)
337 def check(self, command=""):
338 if src.architecture.is_windows():
339 cmd = 'msbuild RUN_TESTS.vcxproj /p:Configuration=Release /p:Platform=x64 '
341 if self.product_info.build_source=="autotools" :
349 self.log_command(cmd)
350 self.log_command("For more detailed logs, see test logs in %s" % self.build_dir)
352 res = subprocess.call(cmd,
354 cwd=str(self.build_dir),
355 env=self.launch_environ.environ.environ,
356 stdout=self.logger.logTxtFile,
357 stderr=subprocess.STDOUT)
359 self.put_txt_log_in_appli_log_dir("makecheck")
366 # Performs a default build for this module.
367 def do_default_build(self,
368 build_conf_options="",
369 configure_options="",
371 use_autotools = False
372 if 'use_autotools' in self.product_info:
373 uc = self.product_info.use_autotools
374 if uc in ['always', 'yes']:
377 use_autotools = self.options.autotools
380 self.use_autotools = use_autotools
383 if 'use_ctest' in self.product_info:
384 uc = self.product_info.use_ctest
385 if uc in ['always', 'yes']:
388 use_ctest = self.options.ctest
390 self.use_ctest = use_ctest
394 if use_autotools: cmd = "(autotools)"
395 if use_ctest: cmd = "(ctest)"
397 self.log("\n", 4, False)
398 self.log("%(module)s: Run default compilation method %(cmd)s\n" % \
399 { "module": self.module, "cmd": cmd }, 4)
402 if not self.prepare(): return self.get_result()
403 if not self.build_configure(
404 build_conf_options): return self.get_result()
405 if not self.configure(configure_options): return self.get_result()
406 if not self.make(): return self.get_result()
407 if not self.install(): return self.get_result()
408 if not self.clean(): return self.get_result()
411 if self.config.VARS.dist_name=='Win':
412 if not self.wprepare(): return self.get_result()
413 if not self.cmake(): return self.get_result()
414 if not self.wmake(): return self.get_result()
415 if not self.install(): return self.get_result()
416 if not self.clean(): return self.get_result()
418 if not self.prepare(): return self.get_result()
419 if not self.cmake(): return self.get_result()
420 if not self.make(): return self.get_result()
421 if not self.install(): return self.get_result()
422 if not self.clean(): return self.get_result()
424 return self.get_result()
427 # Performs a build with a script.
428 def do_python_script_build(self, script, nb_proc):
430 self.logger.write(_("Compile %(product)s using script %(script)s\n") % \
431 { 'product': self.product_info.name,
432 'script': src.printcolors.printcLabel(script) }, 4)
435 product = self.product_info.name
436 pymodule = imp.load_source(product + "_compile_script", script)
437 self.nb_proc = nb_proc
438 retcode = pymodule.compil(self.config, self, self.logger)
440 __, exceptionValue, exceptionTraceback = sys.exc_info()
441 self.logger.write(str(exceptionValue), 1)
443 traceback.print_tb(exceptionTraceback)
444 traceback.print_exc()
447 self.put_txt_log_in_appli_log_dir("script")
451 def complete_environment(self, make_options):
452 assert self.build_environ is not None
453 # pass additional variables to environment
454 # (may be used by the build script)
455 self.build_environ.set("APPLICATION_NAME", self.config.APPLICATION.name)
456 self.build_environ.set("SOURCE_DIR", str(self.source_dir))
457 self.build_environ.set("INSTALL_DIR", str(self.install_dir))
458 self.build_environ.set("PRODUCT_INSTALL", str(self.install_dir))
459 self.build_environ.set("BUILD_DIR", str(self.build_dir))
460 self.build_environ.set("PRODUCT_BUILD", str(self.build_dir))
461 self.build_environ.set("MAKE_OPTIONS", make_options)
462 self.build_environ.set("DIST_NAME", self.config.VARS.dist_name)
463 self.build_environ.set("DIST_VERSION", self.config.VARS.dist_version)
464 self.build_environ.set("DIST", self.config.VARS.dist)
465 self.build_environ.set("VERSION", self.product_info.version)
466 # if product is in hpc mode, set SAT_HPC to 1
467 # in order for the compilation script to take it into account
468 if src.product.product_is_hpc(self.product_info):
469 self.build_environ.set("SAT_HPC", "1")
471 self.build_environ.set("SAT_DEBUG", "1")
472 if self.verbose_mode:
473 self.build_environ.set("SAT_VERBOSE", "1")
476 def do_batch_script_build(self, script, nb_proc):
478 if src.architecture.is_windows():
479 make_options = "/maxcpucount:%s" % nb_proc
481 make_options = "-j%s" % nb_proc
483 self.log_command(" " + _("Run build script %s\n") % script)
484 self.complete_environment(make_options)
486 res = subprocess.call(script,
488 stdout=self.logger.logTxtFile,
489 stderr=subprocess.STDOUT,
490 cwd=str(self.build_dir),
491 env=self.build_environ.environ.environ)
493 res_check=self.check_install()
495 self.log_command("Error in sat check install - some files are not installed!")
497 self.put_txt_log_in_appli_log_dir("script")
504 def do_script_build(self, script, number_of_proc=0):
505 # define make options (may not be used by the script)
506 if number_of_proc==0:
507 nb_proc = src.get_cfg_param(self.product_info,"nb_proc", 0)
509 nb_proc = self.config.VARS.nb_proc
511 nb_proc = min(number_of_proc, self.config.VARS.nb_proc)
513 extension = script.split('.')[-1]
514 if extension in ["bat","sh"]:
515 return self.do_batch_script_build(script, nb_proc)
516 if extension == "py":
517 return self.do_python_script_build(script, nb_proc)
519 msg = _("The script %s must have .sh, .bat or .py extension." % script)
520 raise src.SatException(msg)
522 def put_txt_log_in_appli_log_dir(self, file_name):
523 '''Put the txt log (that contain the system logs, like make command
524 output) in the directory <APPLICATION DIR>/LOGS/<product_name>/
526 :param file_name Str: the name of the file to write
528 if self.logger.logTxtFile == sys.__stdout__:
530 dir_where_to_put = os.path.join(self.config.APPLICATION.workdir,
532 self.product_info.name)
533 file_path = os.path.join(dir_where_to_put, file_name)
534 src.ensure_path_exists(dir_where_to_put)
535 # write the logTxtFile copy it to the destination, and then recreate
537 self.logger.logTxtFile.close()
538 shutil.move(self.logger.txtFilePath, file_path)
539 self.logger.logTxtFile = open(str(self.logger.txtFilePath), 'w')
540 self.logger.logTxtFile.write(open(file_path, "r").read())