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 += " -G %s -A x64 " % self.config.APPLICATION.cmake_generator
138 command = ("cmake %s -DCMAKE_INSTALL_PREFIX=%s %s" %
139 (cmake_option, self.install_dir, self.source_dir))
141 self.log_command(command)
142 # for key in sorted(self.build_environ.environ.environ.keys()):
143 # print key, " ", self.build_environ.environ.environ[key]
144 res = subprocess.call(command,
146 cwd=str(self.build_dir),
147 env=self.build_environ.environ.environ,
148 stdout=self.logger.logTxtFile,
149 stderr=subprocess.STDOUT)
151 self.put_txt_log_in_appli_log_dir("cmake")
158 # Runs build_configure with the given options.
159 def build_configure(self, options=""):
161 if 'buildconfigure_options' in self.product_info:
162 options += " %s " % self.product_info.buildconfigure_options
164 command = str('%s/build_configure') % (self.source_dir)
165 command = command + " " + options
166 self.log_command(command)
168 res = subprocess.call(command,
170 cwd=str(self.build_dir),
171 env=self.build_environ.environ.environ,
172 stdout=self.logger.logTxtFile,
173 stderr=subprocess.STDOUT)
174 self.put_txt_log_in_appli_log_dir("build_configure")
181 # Runs configure with the given options.
182 def configure(self, options=""):
184 if 'configure_options' in self.product_info:
185 options += " %s " % self.product_info.configure_options
187 command = "%s/configure --prefix=%s" % (self.source_dir,
188 str(self.install_dir))
190 command = command + " " + options
191 self.log_command(command)
193 res = subprocess.call(command,
195 cwd=str(self.build_dir),
196 env=self.build_environ.environ.environ,
197 stdout=self.logger.logTxtFile,
198 stderr=subprocess.STDOUT)
200 self.put_txt_log_in_appli_log_dir("configure")
206 def hack_libtool(self):
207 if not os.path.exists(str(self.build_dir + 'libtool')):
210 lf = open(os.path.join(str(self.build_dir), "libtool"), 'r')
211 for line in lf.readlines():
212 if 'hack_libtool' in line:
215 # fix libtool by replacing CC="<compil>" with hack_libtool function
216 hack_command='''sed -i "s%^CC=\\"\(.*\)\\"%hack_libtool() { \\n\\
217 if test \\"\$(echo \$@ | grep -E '\\\\\\-L/usr/lib(/../lib)?(64)? ')\\" == \\\"\\\" \\n\\
219 cmd=\\"\\1 \$@\\"\\n\\
221 cmd=\\"\\1 \\"\`echo \$@ | sed -r -e 's|(.*)-L/usr/lib(/../lib)?(64)? (.*)|\\\\\\1\\\\\\4 -L/usr/lib\\\\\\3|g'\`\\n\\
225 CC=\\"hack_libtool\\"%g" libtool'''
227 self.log_command(hack_command)
228 subprocess.call(hack_command,
230 cwd=str(self.build_dir),
231 env=self.build_environ.environ.environ,
232 stdout=self.logger.logTxtFile,
233 stderr=subprocess.STDOUT)
237 # Runs make to build the module.
238 def make(self, nb_proc, make_opt=""):
242 command = command + " -j" + str(nb_proc)
243 command = command + " " + make_opt
244 self.log_command(command)
245 res = subprocess.call(command,
247 cwd=str(self.build_dir),
248 env=self.build_environ.environ.environ,
249 stdout=self.logger.logTxtFile,
250 stderr=subprocess.STDOUT)
251 self.put_txt_log_in_appli_log_dir("make")
258 # Runs msbuild to build the module.
259 def wmake(self,nb_proc, opt_nb_proc = None):
261 hh = 'MSBUILD /m:%s' % str(nb_proc)
263 hh += " " + src.printcolors.printcWarning("DEBUG")
266 command = command + " /maxcpucount:" + str(nb_proc)
268 command = command + " /p:Configuration=Debug /p:Platform=x64 "
270 command = command + " /p:Configuration=Release /p:Platform=x64 "
271 command = command + " ALL_BUILD.vcxproj"
273 self.log_command(command)
274 res = subprocess.call(command,
276 cwd=str(self.build_dir),
277 env=self.build_environ.environ.environ,
278 stdout=self.logger.logTxtFile,
279 stderr=subprocess.STDOUT)
281 self.put_txt_log_in_appli_log_dir("make")
288 # Runs 'make install'.
290 if src.architecture.is_windows():
291 command = 'msbuild INSTALL.vcxproj'
293 command = command + " /p:Configuration=Debug /p:Platform=x64 "
295 command = command + " /p:Configuration=Release /p:Platform=x64 "
297 command = 'make install'
298 self.log_command(command)
300 res = subprocess.call(command,
302 cwd=str(self.build_dir),
303 env=self.build_environ.environ.environ,
304 stdout=self.logger.logTxtFile,
305 stderr=subprocess.STDOUT)
307 res_check=self.check_install()
309 self.log_command("Error in sat check install - some files are not installed!")
310 self.put_txt_log_in_appli_log_dir("makeinstall")
318 # this function checks wether a list of file patterns (specified by check_install keyword)
319 # exixts after the make install. The objective is to ensure the installation is complete.
320 # patterns are given relatively to the install dir of the product
321 def check_install(self):
323 if "check_install" in self.product_info:
324 self.log_command("Check installation of files")
325 for pattern in self.product_info.check_install:
326 # pattern is given relatively to the install dir
327 complete_pattern=os.path.join(self.product_info.install_dir, pattern)
328 self.log_command(" -> check %s" % complete_pattern)
329 # expansion of pattern : takes into account environment variables and unix shell rules
330 list_of_path=glob.glob(os.path.expandvars(complete_pattern))
332 # we expect to find at least one entry, if not we consider the test failed
334 self.logger.write("Error, sat check install failed for file pattern %s\n" % complete_pattern, 1)
335 self.log_command("Error, sat check install failed for file pattern %s" % complete_pattern)
340 def check(self, command=""):
341 if src.architecture.is_windows():
342 cmd = 'msbuild RUN_TESTS.vcxproj /p:Configuration=Release /p:Platform=x64 '
344 if self.product_info.build_source=="autotools" :
352 self.log_command(cmd)
353 self.log_command("For more detailed logs, see test logs in %s" % self.build_dir)
355 res = subprocess.call(cmd,
357 cwd=str(self.build_dir),
358 env=self.launch_environ.environ.environ,
359 stdout=self.logger.logTxtFile,
360 stderr=subprocess.STDOUT)
362 self.put_txt_log_in_appli_log_dir("makecheck")
369 # Performs a default build for this module.
370 def do_default_build(self,
371 build_conf_options="",
372 configure_options="",
374 use_autotools = False
375 if 'use_autotools' in self.product_info:
376 uc = self.product_info.use_autotools
377 if uc in ['always', 'yes']:
380 use_autotools = self.options.autotools
383 self.use_autotools = use_autotools
386 if 'use_ctest' in self.product_info:
387 uc = self.product_info.use_ctest
388 if uc in ['always', 'yes']:
391 use_ctest = self.options.ctest
393 self.use_ctest = use_ctest
397 if use_autotools: cmd = "(autotools)"
398 if use_ctest: cmd = "(ctest)"
400 self.log("\n", 4, False)
401 self.log("%(module)s: Run default compilation method %(cmd)s\n" % \
402 { "module": self.module, "cmd": cmd }, 4)
405 if not self.prepare(): return self.get_result()
406 if not self.build_configure(
407 build_conf_options): return self.get_result()
408 if not self.configure(configure_options): return self.get_result()
409 if not self.make(): return self.get_result()
410 if not self.install(): return self.get_result()
411 if not self.clean(): return self.get_result()
414 if self.config.VARS.dist_name=='Win':
415 if not self.wprepare(): return self.get_result()
416 if not self.cmake(): return self.get_result()
417 if not self.wmake(): return self.get_result()
418 if not self.install(): return self.get_result()
419 if not self.clean(): return self.get_result()
421 if not self.prepare(): return self.get_result()
422 if not self.cmake(): return self.get_result()
423 if not self.make(): return self.get_result()
424 if not self.install(): return self.get_result()
425 if not self.clean(): return self.get_result()
427 return self.get_result()
430 # Performs a build with a script.
431 def do_python_script_build(self, script, nb_proc):
433 self.logger.write(_("Compile %(product)s using script %(script)s\n") % \
434 { 'product': self.product_info.name,
435 'script': src.printcolors.printcLabel(script) }, 4)
438 product = self.product_info.name
439 pymodule = imp.load_source(product + "_compile_script", script)
440 self.nb_proc = nb_proc
441 retcode = pymodule.compil(self.config, self, self.logger)
443 __, exceptionValue, exceptionTraceback = sys.exc_info()
444 self.logger.write(str(exceptionValue), 1)
446 traceback.print_tb(exceptionTraceback)
447 traceback.print_exc()
450 self.put_txt_log_in_appli_log_dir("script")
454 def complete_environment(self, make_options):
455 assert self.build_environ is not None
456 # pass additional variables to environment
457 # (may be used by the build script)
458 self.build_environ.set("APPLICATION_NAME", self.config.APPLICATION.name)
459 self.build_environ.set("SOURCE_DIR", str(self.source_dir))
460 self.build_environ.set("INSTALL_DIR", str(self.install_dir))
461 self.build_environ.set("PRODUCT_INSTALL", str(self.install_dir))
462 self.build_environ.set("BUILD_DIR", str(self.build_dir))
463 self.build_environ.set("PRODUCT_BUILD", str(self.build_dir))
464 self.build_environ.set("MAKE_OPTIONS", make_options)
465 self.build_environ.set("DIST_NAME", self.config.VARS.dist_name)
466 self.build_environ.set("DIST_VERSION", self.config.VARS.dist_version)
467 self.build_environ.set("DIST", self.config.VARS.dist)
468 self.build_environ.set("VERSION", self.product_info.version)
469 # if product is in hpc mode, set SAT_HPC to 1
470 # in order for the compilation script to take it into account
471 if src.product.product_is_hpc(self.product_info):
472 self.build_environ.set("SAT_HPC", "1")
474 self.build_environ.set("SAT_DEBUG", "1")
475 if self.verbose_mode:
476 self.build_environ.set("SAT_VERBOSE", "1")
479 def do_batch_script_build(self, script, nb_proc):
481 if src.architecture.is_windows():
482 make_options = "/maxcpucount:%s" % nb_proc
484 make_options = "-j%s" % nb_proc
486 self.log_command(" " + _("Run build script %s\n") % script)
487 self.complete_environment(make_options)
489 res = subprocess.call(script,
491 stdout=self.logger.logTxtFile,
492 stderr=subprocess.STDOUT,
493 cwd=str(self.build_dir),
494 env=self.build_environ.environ.environ)
496 res_check=self.check_install()
498 self.log_command("Error in sat check install - some files are not installed!")
500 self.put_txt_log_in_appli_log_dir("script")
507 def do_script_build(self, script, number_of_proc=0):
508 # define make options (may not be used by the script)
509 if number_of_proc==0:
510 nb_proc = src.get_cfg_param(self.product_info,"nb_proc", 0)
512 nb_proc = self.config.VARS.nb_proc
514 nb_proc = min(number_of_proc, self.config.VARS.nb_proc)
516 extension = script.split('.')[-1]
517 if extension in ["bat","sh"]:
518 return self.do_batch_script_build(script, nb_proc)
519 if extension == "py":
520 return self.do_python_script_build(script, nb_proc)
522 msg = _("The script %s must have .sh, .bat or .py extension." % script)
523 raise src.SatException(msg)
525 def put_txt_log_in_appli_log_dir(self, file_name):
526 '''Put the txt log (that contain the system logs, like make command
527 output) in the directory <APPLICATION DIR>/LOGS/<product_name>/
529 :param file_name Str: the name of the file to write
531 if self.logger.logTxtFile == sys.__stdout__:
533 dir_where_to_put = os.path.join(self.config.APPLICATION.workdir,
535 self.product_info.name)
536 file_path = os.path.join(dir_where_to_put, file_name)
537 src.ensure_path_exists(dir_where_to_put)
538 # write the logTxtFile copy it to the destination, and then recreate
540 self.logger.logTxtFile.close()
541 shutil.move(self.logger.txtFilePath, file_path)
542 self.logger.logTxtFile = open(str(self.logger.txtFilePath), 'w')
543 self.logger.logTxtFile.write(open(file_path, "r").read())