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
26 from src import ElementTree as etree
29 parser = src.options.Options()
30 parser.add_option('n', 'name', 'string', 'name',
31 _('The name of the application (default is APPLI.name or runAppli)'))
32 parser.add_option('c', 'catalog', 'string', 'catalog',
33 _('The resources catalog to use'))
34 parser.add_option('t', 'target', 'string', 'target',
35 _('The directory where to create the application (default is PRODUCT.out_dir)'))
36 parser.add_option('', 'gencat', 'string', 'gencat',
37 _("""Create a resources catalog for the specified machines (separated with ',')
38 \tNOTICE: this command will ssh to retrieve information to each machine in the list"""))
39 parser.add_option('m', 'module', 'list2', 'modules',
40 _("module(s) to include in the application"))
43 # Creates an alias for runAppli.
44 def make_alias(appli_path, alias_path, force=False):
45 assert len(alias_path) > 0, "Bad name for alias"
46 if os.path.exists(alias_path) and not force:
47 raise src.SatException(_("Cannot create the alias '%s'\n") % alias_path)
48 else: # find relative path
49 os.symlink(appli_path, alias_path)
52 # add the definition of a module to out stream.
53 def add_module_to_appli(out, module, has_gui, module_path, logger, flagline):
54 if not os.path.exists(module_path):
56 logger.write("\n", 3, False)
58 logger.write(" " + src.printcolors.printcWarning(_(
59 "WARNING: module %s not installed") % module) + "\n", 3)
61 out.write(' <module name="%s" gui="%s" path="%s"/>\n' % (module,
67 # Creates the config file to create an application with the list of modules.
68 def create_config_file(config, modules, env_file, logger):
71 if 'SAMPLES' in config.APPLICATION.products:
72 samples = src.product.get_product_config(config, 'SAMPLES').source_dir
74 config_file = src.get_tmp_filename(config, "appli_config.xml")
75 f = open(config_file, "w")
77 f.write('<application>\n')
78 f.write('<prerequisites path="%s"/>\n' % env_file)
79 f.write('<resources path="CatalogResources.xml"/>\n')
80 f.write('<modules>\n')
84 mm = src.product.get_product_config(config, m)
85 if src.product.product_is_smesh_plugin(mm):
88 if 'install_dir' in mm and bool(mm.install_dir) :
89 if src.product.product_is_cpp(mm):
91 for aa in src.product.get_product_components(mm):
92 install_dir = os.path.join(config.APPLICATION.workdir,
94 mp = os.path.join(install_dir, aa)
95 flagline = add_module_to_appli(f,
104 gui = src.get_cfg_param(mm, "has_gui", "yes")
105 flagline = add_module_to_appli(f, m, gui, mp, logger, flagline)
107 f.write('</modules>\n')
108 f.write('<samples path="%s"/>\n' % samples)
109 f.write('</application>\n')
115 # Customizes the application by editing SalomeApp.xml.
116 def customize_app(config, appli_dir, logger):
117 if 'configure' not in config.APPLI \
118 or len(config.APPLI.configure) == 0:
121 # shortcut to get an element (section or parameter) from parent.
122 def get_element(parent, name, strtype):
123 for c in parent.getchildren():
124 if c.attrib['name'] == name:
127 # element not found create it
128 elt = add_simple_node(parent, strtype)
129 elt.attrib['name'] = name
132 # shortcut method to create a node
133 def add_simple_node(parent, node_name, text=None):
134 n = etree.Element(node_name)
137 n.text = text.strip("\n\t").decode("UTF-8")
139 sys.stderr.write("################ %s %s\n" % (node_name, text))
145 app_file = os.path.join(appli_dir, "SalomeApp.xml")
146 tree = etree.parse(app_file)
147 document = tree.getroot()
148 assert document is not None, "document tag not found"
150 logger.write("\n", 4)
151 for section_name in config.APPLI.configure:
152 for parameter_name in config.APPLI.configure[section_name]:
153 parameter_value = config.APPLI.configure[section_name][parameter_name]
154 logger.write(" configure: %s/%s = %s\n" % (section_name,
157 section = get_element(document, section_name, "section")
158 parameter = get_element(section, parameter_name, "parameter")
159 parameter.attrib['value'] = parameter_value
162 f = open(app_file, "w")
163 f.write("<?xml version='1.0' encoding='utf-8'?>\n")
164 f.write(etree.tostring(document, encoding='utf-8'))
168 # Generates the application with the config_file.
169 def generate_application(config, appli_dir, config_file, logger):
170 target_dir = os.path.dirname(appli_dir)
172 install_KERNEL_dir = src.product.get_product_config(config,
173 'KERNEL').install_dir
174 script = os.path.join(install_KERNEL_dir, "bin", "salome", "appli_gen.py")
175 if not os.path.exists(script):
176 raise src.SatException(_("KERNEL is not installed"))
178 # Add SALOME python in the environment in order to avoid python version
179 # problems at appli_gen.py call
180 if 'Python' in config.APPLICATION.products:
181 envi = src.environment.SalomeEnviron(config,
182 src.environment.Environ(
185 envi.set_a_product('Python', logger)
187 command = "python %s --prefix=%s --config=%s" % (script,
190 logger.write("\n>" + command + "\n", 5, False)
191 res = subprocess.call(command,
194 env=envi.environ.environ,
195 stdout=logger.logTxtFile,
196 stderr=subprocess.STDOUT)
199 raise src.SatException(_("Cannot create application, code = %d\n") % res)
205 def write_step(logger, message, level=3, pad=50):
206 logger.write("%s %s " % (message, '.' * (pad - len(message.decode("UTF-8")))), level)
210 # Creates a SALOME application.
211 def create_application(config, appli_dir, catalog, logger, display=True):
213 SALOME_modules = get_SALOME_modules(config)
215 warn = ['KERNEL', 'GUI']
218 if w not in SALOME_modules:
219 msg = _("WARNING: module %s is required to create application\n") % w
220 logger.write(src.printcolors.printcWarning(msg), 2)
222 # generate the launch file
223 retcode = generate_launch_file(config,
230 cmd = src.printcolors.printcLabel("%s/runAppli" % appli_dir)
233 logger.write("\n", 3, False)
234 logger.write(_("To launch the application, type:\n"), 3, False)
235 logger.write(" %s" % (cmd), 3, False)
236 logger.write("\n", 3, False)
239 def get_SALOME_modules(config):
241 for product in config.APPLICATION.products:
242 product_info = src.product.get_product_config(config, product)
243 if src.product.product_is_SALOME(product_info):
244 l_modules.append(product)
248 # Obsolescent way of creating the application.
249 # This method will use appli_gen to create the application directory.
250 def generate_launch_file(config, appli_dir, catalog, logger, l_SALOME_modules):
253 if len(catalog) > 0 and not os.path.exists(catalog):
254 raise IOError(_("Catalog not found: %s") % catalog)
256 write_step(logger, _("Creating environment files"))
257 status = src.KO_STATUS
260 # generate only shells the user wants (by default bash, csh, batch)
261 # the environ command will only generate file compatible
262 # with the current system.
263 environ.write_all_source_files(config,
266 status = src.OK_STATUS
268 logger.write(src.printcolors.printc(status) + "\n", 2, False)
270 # build the application
271 env_file = os.path.join(config.APPLICATION.workdir, "env_launch.sh")
272 write_step(logger, _("Building application"), level=2)
273 cf = create_config_file(config, l_SALOME_modules, env_file, logger)
275 # create the application directory
276 os.makedirs(appli_dir)
278 # generate the application
279 status = src.KO_STATUS
281 retcode = generate_application(config, appli_dir, cf, logger)
282 customize_app(config, appli_dir, logger)
283 status = src.OK_STATUS
285 logger.write(src.printcolors.printc(status) + "\n", 2, False)
287 # copy the catalog if one
289 shutil.copy(catalog, os.path.join(appli_dir, "CatalogResources.xml"))
295 # Generates a launcher that sources Salome's python and calls original launcher
296 def generate_sourcing_launcher(config, appli_dir, logger) :
298 # Rename original launcher
299 launcher_name = os.path.join( appli_dir,
302 config.APPLI.launch_alias_name )
303 original_launcher = launcher_name + "-original"
304 os.rename( launcher_name, original_launcher )
307 f = open(launcher_name, "w")
309 # Write the set up of the environment
310 env = src.environment.SalomeEnviron( config,
311 src.fileEnviron.get_file_environ(
316 env.set_a_product( "Python", logger)
318 # Write the call to the original launcher
320 f.write( "# This is the call to the original launcher\n")
321 f.write( original_launcher + " $*" )
324 # Write the cleaning of the environment
329 os.chmod(launcher_name, stat.S_IRWXU| stat.S_IRWXG| stat.S_IRWXO) # 0777
334 # Generates the catalog from a list of machines.
335 def generate_catalog(machines, config, logger):
336 # remove empty machines
337 machines = map(lambda l: l.strip(), machines)
338 machines = filter(lambda l: len(l) > 0, machines)
340 src.printcolors.print_value(logger,
341 _("Generate Resources Catalog"),
344 cmd = '"cat /proc/cpuinfo | grep MHz ; cat /proc/meminfo | grep MemTotal"'
345 user = getpass.getuser()
347 catfile = src.get_tmp_filename(config, "CatalogResources.xml")
348 catalog = file(catfile, "w")
349 catalog.write("<!DOCTYPE ResourcesCatalog>\n<resources>\n")
351 logger.write(" ssh %s " % (k + " ").ljust(20, '.'), 4)
354 ssh_cmd = 'ssh -o "StrictHostKeyChecking no" %s %s' % (k, cmd)
355 p = subprocess.Popen(ssh_cmd, shell=True,
356 stdin=subprocess.PIPE,
357 stdout=subprocess.PIPE,
358 stderr=subprocess.PIPE)
361 if p.returncode != 0:
362 logger.write(src.printcolors.printc(src.KO_STATUS) + "\n", 4)
363 logger.write(" " + src.printcolors.printcWarning(p.stderr.read()),
366 logger.write(src.printcolors.printc(src.OK_STATUS) + "\n", 4)
367 lines = p.stdout.readlines()
368 freq = lines[0][:-1].split(':')[-1].split('.')[0].strip()
369 nb_proc = len(lines) -1
370 memory = lines[-1].split(':')[-1].split()[0].strip()
371 memory = int(memory) / 1000
373 catalog.write(" <machine\n")
374 catalog.write(" protocol=\"ssh\"\n")
375 catalog.write(" nbOfNodes=\"1\"\n")
376 catalog.write(" mode=\"interactif\"\n")
377 catalog.write(" OS=\"LINUX\"\n")
378 catalog.write(" CPUFreqMHz=\"%s\"\n" % freq)
379 catalog.write(" nbOfProcPerNode=\"%s\"\n" % nb_proc)
380 catalog.write(" memInMB=\"%s\"\n" % memory)
381 catalog.write(" userName=\"%s\"\n" % user)
382 catalog.write(" name=\"%s\"\n" % k)
383 catalog.write(" hostname=\"%s\"\n" % k)
384 catalog.write(" >\n")
385 catalog.write(" </machine>\n")
387 catalog.write("</resources>\n")
391 ##################################################
394 # Describes the command
396 '''method that is called when salomeTools is called with --help option.
398 :return: The text to display for the application command description.
401 return _("""The application command creates a SALOME application.\n"""
402 """WARNING: it works only for SALOME 6. Use the "launcher" """
403 """command for newer versions of SALOME""")
407 def run(args, runner, logger):
408 '''method that is called when salomeTools is called with application
412 (options, args) = parser.parse_args(args)
415 src.check_config_has_application( runner.cfg )
417 application = src.printcolors.printcLabel(runner.cfg.VARS.application)
418 logger.write(_("Building application for %s\n") % application, 1)
420 # if section APPLI does not exists create one
421 if "APPLI" not in runner.cfg:
422 msg = _("The section APPLI is not defined in the product.")
423 logger.write(src.printcolors.printcError(msg), 1)
424 logger.write("\n", 1)
427 # get application dir
428 target_dir = runner.cfg.APPLICATION.workdir
430 target_dir = options.target
432 # set list of modules
434 runner.cfg.APPLI['modules'] = options.modules
436 # set name and application_name
438 runner.cfg.APPLI['name'] = options.name
439 runner.cfg.APPLI['application_name'] = options.name + "_appdir"
441 application_name = src.get_cfg_param(runner.cfg.APPLI,
443 runner.cfg.APPLI.name + "_appdir")
444 appli_dir = os.path.join(target_dir, application_name)
446 src.printcolors.print_value(logger,
447 _("Application directory"),
452 catalog, catalog_src = "", ""
454 # use catalog specified in the command line
455 catalog = options.catalog
457 # generate catalog for given list of computers
458 catalog_src = options.gencat
459 catalog = generate_catalog(options.gencat.split(","),
461 elif 'catalog' in runner.cfg.APPLI:
462 # use catalog specified in the product
463 if runner.cfg.APPLI.catalog.endswith(".xml"):
465 catalog = runner.cfg.APPLI.catalog
467 # catalog as a list of computers
468 catalog_src = runner.cfg.APPLI.catalog
469 mlist = filter(lambda l: len(l.strip()) > 0,
470 runner.cfg.APPLI.catalog.split(","))
472 catalog = generate_catalog(runner.cfg.APPLI.catalog.split(","),
475 # display which catalog is used
477 catalog = os.path.realpath(catalog)
478 if len(catalog_src) > 0:
479 src.printcolors.print_value(logger,
480 _("Resources Catalog"),
484 src.printcolors.print_value(logger,
485 _("Resources Catalog"),
489 logger.write("\n", 3, False)
493 # remove previous application
494 if os.path.exists(appli_dir):
495 write_step(logger, _("Removing previous application directory"))
498 shutil.rmtree(appli_dir)
501 logger.write(src.printcolors.printc(rres) + "\n", 3, False)
503 # generate the application
505 try: # try/except/finally not supported in all version of python
506 retcode = create_application(runner.cfg, appli_dir, catalog, logger)
507 except Exception as exc:
508 details.append(str(exc))
511 logger.write("\n", 3, False)