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, ...
43 options = src.options.OptResult(),
47 self.options = options
48 self.product_name = product_name
49 self.product_info = product_info
50 self.build_dir = src.Path(self.product_info.build_dir)
51 self.source_dir = src.Path(self.product_info.source_dir)
52 self.install_dir = src.Path(self.product_info.install_dir)
54 self.debug_mode = False
55 if "debug" in self.product_info and self.product_info.debug == "yes":
56 self.debug_mode = True
57 self.verbose_mode = False
58 if "verbose" in self.product_info and self.product_info.verbose == "yes":
59 self.verbose_mode = True
62 # Shortcut method to log in log file.
63 def log(self, text, level, showInfo=True):
64 self.logger.write(text, level, showInfo)
65 self.logger.logTxtFile.write(src.printcolors.cleancolor(text))
69 # Shortcut method to log a command.
70 def log_command(self, command):
71 self.log("> %s\n" % command, 5)
74 # Prepares the environment.
75 # Build two environment: one for building and one for testing (launch).
76 def prepare(self, add_env_launch=False):
78 if not self.build_dir.exists():
82 self.log(' build_dir = %s\n' % str(self.build_dir), 4)
83 self.log(' install_dir = %s\n' % str(self.install_dir), 4)
86 # add products in depend and opt_depend list recursively
87 environ_info = src.product.get_product_dependencies(self.config,
90 #environ_info.append(self.product_info.name)
92 # create build environment
93 self.build_environ = src.environment.SalomeEnviron(self.config,
94 src.environment.Environ(dict(os.environ)),
96 self.build_environ.silent = (self.config.USER.output_verbose_level < 5)
97 self.build_environ.set_full_environ(self.logger, environ_info)
100 # create runtime environment
101 self.launch_environ = src.environment.SalomeEnviron(self.config,
102 src.environment.Environ(dict(os.environ)),
104 self.launch_environ.silent = True # no need to show here
105 self.launch_environ.set_full_environ(self.logger, environ_info)
107 for ee in C_COMPILE_ENV_LIST:
108 vv = self.build_environ.get(ee)
110 self.log(" %s = %s\n" % (ee, vv), 4, False)
115 # Runs cmake with the given options.
116 def cmake(self, options=""):
118 cmake_option = options
119 # cmake_option +=' -DCMAKE_VERBOSE_MAKEFILE=ON -DSALOME_CMAKE_DEBUG=ON'
120 if 'cmake_options' in self.product_info:
121 cmake_option += " %s " % " ".join(
122 self.product_info.cmake_options.split())
126 cmake_option += " -DCMAKE_BUILD_TYPE=Debug"
128 cmake_option += " -DCMAKE_BUILD_TYPE=Release"
130 # add verbose option if specified in application for this product.
131 if self.verbose_mode:
132 cmake_option += " -DCMAKE_VERBOSE_MAKEFILE=ON"
134 # In case CMAKE_GENERATOR is defined in environment,
135 # use it in spite of automatically detect it
136 if 'cmake_generator' in self.config.APPLICATION:
137 cmake_option += " -DCMAKE_GENERATOR=\"%s\"" \
138 % self.config.APPLICATION.cmake_generator
139 command = ("cmake %s -DCMAKE_INSTALL_PREFIX=%s %s" %
140 (cmake_option, self.install_dir, self.source_dir))
142 self.log_command(command)
143 # for key in sorted(self.build_environ.environ.environ.keys()):
144 # print key, " ", self.build_environ.environ.environ[key]
145 res = subprocess.call(command,
147 cwd=str(self.build_dir),
148 env=self.build_environ.environ.environ,
149 stdout=self.logger.logTxtFile,
150 stderr=subprocess.STDOUT)
152 self.put_txt_log_in_appli_log_dir("cmake")
159 # Runs build_configure with the given options.
160 def build_configure(self, options=""):
162 if 'buildconfigure_options' in self.product_info:
163 options += " %s " % self.product_info.buildconfigure_options
165 command = str('%s/build_configure') % (self.source_dir)
166 command = command + " " + options
167 self.log_command(command)
169 res = subprocess.call(command,
171 cwd=str(self.build_dir),
172 env=self.build_environ.environ.environ,
173 stdout=self.logger.logTxtFile,
174 stderr=subprocess.STDOUT)
175 self.put_txt_log_in_appli_log_dir("build_configure")
182 # Runs configure with the given options.
183 def configure(self, options=""):
185 if 'configure_options' in self.product_info:
186 options += " %s " % self.product_info.configure_options
188 command = "%s/configure --prefix=%s" % (self.source_dir,
189 str(self.install_dir))
191 command = command + " " + options
192 self.log_command(command)
194 res = subprocess.call(command,
196 cwd=str(self.build_dir),
197 env=self.build_environ.environ.environ,
198 stdout=self.logger.logTxtFile,
199 stderr=subprocess.STDOUT)
201 self.put_txt_log_in_appli_log_dir("configure")
207 def hack_libtool(self):
208 if not os.path.exists(str(self.build_dir + 'libtool')):
211 lf = open(os.path.join(str(self.build_dir), "libtool"), 'r')
212 for line in lf.readlines():
213 if 'hack_libtool' in line:
216 # fix libtool by replacing CC="<compil>" with hack_libtool function
217 hack_command='''sed -i "s%^CC=\\"\(.*\)\\"%hack_libtool() { \\n\\
218 if test \\"\$(echo \$@ | grep -E '\\\\\\-L/usr/lib(/../lib)?(64)? ')\\" == \\\"\\\" \\n\\
220 cmd=\\"\\1 \$@\\"\\n\\
222 cmd=\\"\\1 \\"\`echo \$@ | sed -r -e 's|(.*)-L/usr/lib(/../lib)?(64)? (.*)|\\\\\\1\\\\\\4 -L/usr/lib\\\\\\3|g'\`\\n\\
226 CC=\\"hack_libtool\\"%g" libtool'''
228 self.log_command(hack_command)
229 subprocess.call(hack_command,
231 cwd=str(self.build_dir),
232 env=self.build_environ.environ.environ,
233 stdout=self.logger.logTxtFile,
234 stderr=subprocess.STDOUT)
238 # Runs make to build the module.
239 def make(self, nb_proc, make_opt=""):
243 command = command + " -j" + str(nb_proc)
244 command = command + " " + make_opt
245 self.log_command(command)
246 res = subprocess.call(command,
248 cwd=str(self.build_dir),
249 env=self.build_environ.environ.environ,
250 stdout=self.logger.logTxtFile,
251 stderr=subprocess.STDOUT)
252 self.put_txt_log_in_appli_log_dir("make")
259 # Runs msbuild to build the module.
260 def wmake(self,nb_proc, opt_nb_proc = None):
262 hh = 'MSBUILD /m:%s' % str(nb_proc)
264 hh += " " + src.printcolors.printcWarning("DEBUG")
267 command = command + " /maxcpucount:" + str(nb_proc)
269 command = command + " /p:Configuration=Debug /p:Platform=x64 "
271 command = command + " /p:Configuration=Release /p:Platform=x64 "
272 command = command + " ALL_BUILD.vcxproj"
274 self.log_command(command)
275 res = subprocess.call(command,
277 cwd=str(self.build_dir),
278 env=self.build_environ.environ.environ,
279 stdout=self.logger.logTxtFile,
280 stderr=subprocess.STDOUT)
282 self.put_txt_log_in_appli_log_dir("make")
289 # Runs 'make install'.
291 if src.architecture.is_windows():
292 command = 'msbuild INSTALL.vcxproj'
294 command = command + " /p:Configuration=Debug /p:Platform=x64 "
296 command = command + " /p:Configuration=Release /p:Platform=x64 "
298 command = 'make install'
299 self.log_command(command)
301 res = subprocess.call(command,
303 cwd=str(self.build_dir),
304 env=self.build_environ.environ.environ,
305 stdout=self.logger.logTxtFile,
306 stderr=subprocess.STDOUT)
308 res_check=self.check_install()
310 self.log_command("Error in sat check install - some files are not installed!")
311 self.put_txt_log_in_appli_log_dir("makeinstall")
319 # this function checks wether a list of file patterns (specified by check_install keyword)
320 # exixts after the make install. The objective is to ensure the installation is complete.
321 # patterns are given relatively to the install dir of the product
322 def check_install(self):
324 if "check_install" in self.product_info:
325 self.log_command("Check installation of files")
326 for pattern in self.product_info.check_install:
327 # pattern is given relatively to the install dir
328 complete_pattern=os.path.join(self.product_info.install_dir, pattern)
329 self.log_command(" -> check %s" % complete_pattern)
330 # expansion of pattern : takes into account environment variables and unix shell rules
331 list_of_path=glob.glob(os.path.expandvars(complete_pattern))
333 # we expect to find at least one entry, if not we consider the test failed
335 self.logger.write("Error, sat check install failed for file pattern %s\n" % complete_pattern, 1)
336 self.log_command("Error, sat check install failed for file pattern %s" % complete_pattern)
341 def check(self, command=""):
342 if src.architecture.is_windows():
343 cmd = 'msbuild RUN_TESTS.vcxproj /p:Configuration=Release /p:Platform=x64 '
345 if self.product_info.build_source=="autotools" :
353 self.log_command(cmd)
354 self.log_command("For more detailed logs, see test logs in %s" % self.build_dir)
356 res = subprocess.call(cmd,
358 cwd=str(self.build_dir),
359 env=self.launch_environ.environ.environ,
360 stdout=self.logger.logTxtFile,
361 stderr=subprocess.STDOUT)
363 self.put_txt_log_in_appli_log_dir("makecheck")
370 # Performs a default build for this module.
371 def do_default_build(self,
372 build_conf_options="",
373 configure_options="",
375 use_autotools = False
376 if 'use_autotools' in self.product_info:
377 uc = self.product_info.use_autotools
378 if uc in ['always', 'yes']:
381 use_autotools = self.options.autotools
384 self.use_autotools = use_autotools
387 if 'use_ctest' in self.product_info:
388 uc = self.product_info.use_ctest
389 if uc in ['always', 'yes']:
392 use_ctest = self.options.ctest
394 self.use_ctest = use_ctest
398 if use_autotools: cmd = "(autotools)"
399 if use_ctest: cmd = "(ctest)"
401 self.log("\n", 4, False)
402 self.log("%(module)s: Run default compilation method %(cmd)s\n" % \
403 { "module": self.module, "cmd": cmd }, 4)
406 if not self.prepare(): return self.get_result()
407 if not self.build_configure(
408 build_conf_options): return self.get_result()
409 if not self.configure(configure_options): return self.get_result()
410 if not self.make(): return self.get_result()
411 if not self.install(): return self.get_result()
412 if not self.clean(): return self.get_result()
415 if self.config.VARS.dist_name=='Win':
416 if not self.wprepare(): return self.get_result()
417 if not self.cmake(): return self.get_result()
418 if not self.wmake(): return self.get_result()
419 if not self.install(): return self.get_result()
420 if not self.clean(): return self.get_result()
422 if not self.prepare(): return self.get_result()
423 if not self.cmake(): return self.get_result()
424 if not self.make(): return self.get_result()
425 if not self.install(): return self.get_result()
426 if not self.clean(): return self.get_result()
428 return self.get_result()
431 # Performs a build with a script.
432 def do_python_script_build(self, script, nb_proc):
434 self.logger.write(_("Compile %(product)s using script %(script)s\n") % \
435 { 'product': self.product_info.name,
436 'script': src.printcolors.printcLabel(script) }, 4)
439 product = self.product_info.name
440 pymodule = imp.load_source(product + "_compile_script", script)
441 self.nb_proc = nb_proc
442 retcode = pymodule.compil(self.config, self, self.logger)
444 __, exceptionValue, exceptionTraceback = sys.exc_info()
445 self.logger.write(str(exceptionValue), 1)
447 traceback.print_tb(exceptionTraceback)
448 traceback.print_exc()
451 self.put_txt_log_in_appli_log_dir("script")
455 def complete_environment(self, make_options):
456 assert self.build_environ is not None
457 # pass additional variables to environment
458 # (may be used by the build script)
459 self.build_environ.set("APPLICATION_NAME", self.config.APPLICATION.name)
460 self.build_environ.set("SOURCE_DIR", str(self.source_dir))
461 self.build_environ.set("INSTALL_DIR", str(self.install_dir))
462 self.build_environ.set("PRODUCT_INSTALL", str(self.install_dir))
463 self.build_environ.set("BUILD_DIR", str(self.build_dir))
464 self.build_environ.set("PRODUCT_BUILD", str(self.build_dir))
465 self.build_environ.set("MAKE_OPTIONS", make_options)
466 self.build_environ.set("DIST_NAME", self.config.VARS.dist_name)
467 self.build_environ.set("DIST_VERSION", self.config.VARS.dist_version)
468 self.build_environ.set("DIST", self.config.VARS.dist)
469 self.build_environ.set("VERSION", self.product_info.version)
470 # if product is in hpc mode, set SAT_HPC to 1
471 # in order for the compilation script to take it into account
472 if src.product.product_is_hpc(self.product_info):
473 self.build_environ.set("SAT_HPC", "1")
475 self.build_environ.set("SAT_DEBUG", "1")
476 if self.verbose_mode:
477 self.build_environ.set("SAT_VERBOSE", "1")
480 def do_batch_script_build(self, script, nb_proc):
482 if src.architecture.is_windows():
483 make_options = "/maxcpucount:%s" % nb_proc
485 make_options = "-j%s" % nb_proc
487 self.log_command(" " + _("Run build script %s\n") % script)
488 self.complete_environment(make_options)
490 res = subprocess.call(script,
492 stdout=self.logger.logTxtFile,
493 stderr=subprocess.STDOUT,
494 cwd=str(self.build_dir),
495 env=self.build_environ.environ.environ)
497 res_check=self.check_install()
499 self.log_command("Error in sat check install - some files are not installed!")
501 self.put_txt_log_in_appli_log_dir("script")
508 def do_script_build(self, script, number_of_proc=0):
509 # define make options (may not be used by the script)
510 if number_of_proc==0:
511 nb_proc = src.get_cfg_param(self.product_info,"nb_proc", 0)
513 nb_proc = self.config.VARS.nb_proc
515 nb_proc = min(number_of_proc, self.config.VARS.nb_proc)
517 extension = script.split('.')[-1]
518 if extension in ["bat","sh"]:
519 return self.do_batch_script_build(script, nb_proc)
520 if extension == "py":
521 return self.do_python_script_build(script, nb_proc)
523 msg = _("The script %s must have .sh, .bat or .py extension." % script)
524 raise src.SatException(msg)
526 def put_txt_log_in_appli_log_dir(self, file_name):
527 '''Put the txt log (that contain the system logs, like make command
528 output) in the directory <APPLICATION DIR>/LOGS/<product_name>/
530 :param file_name Str: the name of the file to write
532 if self.logger.logTxtFile == sys.__stdout__:
534 dir_where_to_put = os.path.join(self.config.APPLICATION.workdir,
536 self.product_info.name)
537 file_path = os.path.join(dir_where_to_put, file_name)
538 src.ensure_path_exists(dir_where_to_put)
539 # write the logTxtFile copy it to the destination, and then recreate
541 self.logger.logTxtFile.close()
542 shutil.move(self.logger.txtFilePath, file_path)
543 self.logger.logTxtFile = open(str(self.logger.txtFilePath), 'w')
544 self.logger.logTxtFile.write(open(file_path, "r").read())