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 _('Optional: The name of the application (default is APPLICATION.virtual_app.name or '
33 parser.add_option('c', 'catalog', 'string', 'catalog',
34 _('Optional: The resources catalog to use'))
35 parser.add_option('t', 'target', 'string', 'target',
36 _('Optional: The directory where to create the application (default is '
37 'APPLICATION.workdir)'))
38 parser.add_option('', 'gencat', 'string', 'gencat',
39 _("Optional: Create a resources catalog for the specified machines "
40 "(separated with ',')\n\tNOTICE: this command will ssh to retrieve "
41 "information to each machine in the list"))
42 parser.add_option('m', 'module', 'list2', 'modules',
43 _("Optional: the restricted list of module(s) to include in the "
45 parser.add_option('', 'use_mesa', 'boolean', 'use_mesa',
46 _("Optional: Create a launcher that will use mesa products\n\t"
47 "It can be usefull whan salome is used on a remote machine through ssh"))
50 # Creates an alias for runAppli.
51 def make_alias(appli_path, alias_path, force=False):
52 assert len(alias_path) > 0, "Bad name for alias"
53 if os.path.exists(alias_path) and not force:
54 raise src.SatException(_("Cannot create the alias '%s'\n") % alias_path)
55 else: # find relative path
56 os.symlink(appli_path, alias_path)
59 # add the definition of a module to out stream.
60 def add_module_to_appli(out, module, has_gui, module_path, logger, flagline):
61 if not os.path.exists(module_path):
63 logger.write("\n", 3, False)
65 logger.write(" " + src.printcolors.printcWarning(_(
66 "WARNING: module %s not installed") % module) + "\n", 3)
68 out.write(' <module name="%s" gui="%s" path="%s"/>\n' % (module,
74 # Creates the config file to create an application with the list of modules.
75 def create_config_file(config, modules, env_files, logger):
78 if 'SAMPLES' in config.APPLICATION.products:
79 samples = src.product.get_product_config(config, 'SAMPLES').source_dir
81 config_file = src.get_tmp_filename(config, "appli_config.xml")
82 f = open(config_file, "w")
84 f.write('<application>\n')
85 for env_file in env_files:
86 if env_file.endswith("cfg"):
87 f.write('<context path="%s"/>\n' % env_file)
89 f.write('<prerequisites path="%s"/>\n' % env_file)
91 f.write('<resources path="CatalogResources.xml"/>\n')
92 f.write('<modules>\n')
96 mm = src.product.get_product_config(config, m)
97 # do not include in virtual application application module!
98 if src.get_property_in_product_cfg(mm, "is_salome_application") == "yes":
100 # do not include products that do not compile
101 if not src.product.product_compiles(mm):
104 if src.product.product_is_smesh_plugin(mm):
107 if 'install_dir' in mm and bool(mm.install_dir):
108 if src.product.product_is_cpp(mm):
110 for aa in src.product.get_product_components(mm):
111 install_dir = os.path.join(config.APPLICATION.workdir,
113 mp = os.path.join(install_dir, aa)
114 flagline = add_module_to_appli(f,
123 gui = src.get_cfg_param(mm, "has_gui", "yes")
124 flagline = add_module_to_appli(f, m, gui, mp, logger, flagline)
126 f.write('</modules>\n')
127 f.write('<samples path="%s"/>\n' % samples)
128 f.write('</application>\n')
134 # Customizes the application by editing SalomeApp.xml.
135 def customize_app(config, appli_dir, logger):
136 if 'configure' not in config.APPLICATION.virtual_app \
137 or len(config.APPLICATION.virtual_app.configure) == 0:
140 # shortcut to get an element (section or parameter) from parent.
141 def get_element(parent, name, strtype):
142 for c in parent.getchildren():
143 if c.attrib['name'] == name:
146 # element not found create it
147 elt = add_simple_node(parent, strtype)
148 elt.attrib['name'] = name
151 # shortcut method to create a node
152 def add_simple_node(parent, node_name, text=None):
153 n = etree.Element(node_name)
156 n.text = text.strip("\n\t").decode("UTF-8")
158 sys.stderr.write("################ %s %s\n" % (node_name, text))
164 app_file = os.path.join(appli_dir, "SalomeApp.xml")
165 tree = etree.parse(app_file)
166 document = tree.getroot()
167 assert document is not None, "document tag not found"
169 logger.write("\n", 4)
170 for section_name in config.APPLICATION.virtual_app.configure:
171 for parameter_name in config.APPLICATION.virtual_app.configure[section_name]:
172 parameter_value = config.APPLICATION.virtual_app.configure[section_name][parameter_name]
173 logger.write(" configure: %s/%s = %s\n" % (section_name,
176 section = get_element(document, section_name, "section")
177 parameter = get_element(section, parameter_name, "parameter")
178 parameter.attrib['value'] = parameter_value
181 f = open(app_file, "w")
182 f.write("<?xml version='1.0' encoding='utf-8'?>\n")
183 f.write(etree.tostring(document, encoding='utf-8'))
187 # Generates the application with the config_file.
188 def generate_application(config, appli_dir, config_file, logger):
189 target_dir = os.path.dirname(appli_dir)
191 install_KERNEL_dir = src.product.get_product_config(config,
192 'KERNEL').install_dir
193 script = os.path.join(install_KERNEL_dir, "bin", "salome", "appli_gen.py")
194 if not os.path.exists(script):
195 raise src.SatException(_("KERNEL is not installed"))
197 # Add SALOME python in the environment in order to avoid python version
198 # problems at appli_gen.py call
199 if 'Python' in config.APPLICATION.products:
200 envi = src.environment.SalomeEnviron(config,
201 src.environment.Environ(
204 envi.set_a_product('Python', logger)
206 command = "python %s --prefix=%s --config=%s" % (script,
209 logger.write("\n>" + command + "\n", 5, False)
210 res = subprocess.call(command,
213 env=envi.environ.environ,
214 stdout=logger.logTxtFile,
215 stderr=subprocess.STDOUT)
218 raise src.SatException(_("Cannot create application, code = %d\n") % res)
224 def write_step(logger, message, level=3, pad=50):
225 logger.write("%s %s " % (message, '.' * (pad - len(message.decode("UTF-8")))), level)
229 # Creates a SALOME application.
230 def create_application(config, appli_dir, catalog, logger, display=True):
232 SALOME_modules = get_SALOME_modules(config)
234 warn = ['KERNEL', 'GUI']
237 if w not in SALOME_modules:
238 msg = _("WARNING: module %s is required to create application\n") % w
239 logger.write(src.printcolors.printcWarning(msg), 2)
241 # generate the launch file
242 retcode = generate_launch_file(config,
249 cmd = src.printcolors.printcLabel("%s/salome" % appli_dir)
252 logger.write("\n", 3, False)
253 logger.write(_("To launch the application, type:\n"), 3, False)
254 logger.write(" %s" % (cmd), 3, False)
255 logger.write("\n", 3, False)
258 def get_SALOME_modules(config):
260 for product in config.APPLICATION.products:
261 product_info = src.product.get_product_config(config, product)
262 if (src.product.product_is_salome(product_info) or
263 src.product.product_is_generated(product_info)):
264 l_modules.append(product)
268 # Obsolescent way of creating the application.
269 # This method will use appli_gen to create the application directory.
270 def generate_launch_file(config, appli_dir, catalog, logger, l_SALOME_modules):
273 if len(catalog) > 0 and not os.path.exists(catalog):
274 raise IOError(_("Catalog not found: %s") % catalog)
276 write_step(logger, _("Creating environment files"))
277 status = src.KO_STATUS
279 # build the application (the name depends upon salome version
280 env_file = os.path.join(config.APPLICATION.workdir, "env_launch")
281 VersionSalome = src.get_salome_version(config)
282 if VersionSalome>=820:
283 # for salome 8+ we use a salome context file for the virtual app
284 app_shell=["cfg", "bash"]
285 env_files=[env_file+".cfg", env_file+".sh"]
288 env_files=[env_file+".sh"]
292 # generate only shells the user wants (by default bash, csh, batch)
293 # the environ command will only generate file compatible
294 # with the current system.
295 environ.write_all_source_files(config,
299 status = src.OK_STATUS
301 logger.write(src.printcolors.printc(status) + "\n", 2, False)
304 write_step(logger, _("Building application"), level=2)
305 cf = create_config_file(config, l_SALOME_modules, env_files, logger)
307 # create the application directory
308 os.makedirs(appli_dir)
310 # generate the application
311 status = src.KO_STATUS
313 retcode = generate_application(config, appli_dir, cf, logger)
314 customize_app(config, appli_dir, logger)
315 status = src.OK_STATUS
317 logger.write(src.printcolors.printc(status) + "\n", 2, False)
319 # copy the catalog if one
321 shutil.copy(catalog, os.path.join(appli_dir, "CatalogResources.xml"))
328 # Generates the catalog from a list of machines.
329 def generate_catalog(machines, config, logger):
330 # remove empty machines
331 machines = map(lambda l: l.strip(), machines)
332 machines = filter(lambda l: len(l) > 0, machines)
334 src.printcolors.print_value(logger,
335 _("Generate Resources Catalog"),
338 cmd = '"cat /proc/cpuinfo | grep MHz ; cat /proc/meminfo | grep MemTotal"'
339 user = getpass.getuser()
341 catfile = src.get_tmp_filename(config, "CatalogResources.xml")
342 catalog = file(catfile, "w")
343 catalog.write("<!DOCTYPE ResourcesCatalog>\n<resources>\n")
345 if not src.architecture.is_windows():
346 logger.write(" ssh %s " % (k + " ").ljust(20, '.'), 4)
349 ssh_cmd = 'ssh -o "StrictHostKeyChecking no" %s %s' % (k, cmd)
350 p = subprocess.Popen(ssh_cmd, shell=True,
351 stdin=subprocess.PIPE,
352 stdout=subprocess.PIPE,
353 stderr=subprocess.PIPE)
356 machine_access = (p.returncode == 0)
357 if not machine_access:
358 logger.write(src.printcolors.printc(src.KO_STATUS) + "\n", 4)
359 logger.write(" " + src.printcolors.printcWarning(p.stderr.read()),
362 logger.write(src.printcolors.printc(src.OK_STATUS) + "\n", 4)
363 lines = p.stdout.readlines()
364 freq = lines[0][:-1].split(':')[-1].split('.')[0].strip()
365 nb_proc = len(lines) -1
366 memory = lines[-1].split(':')[-1].split()[0].strip()
367 memory = int(memory) / 1000
369 catalog.write(" <machine\n")
370 catalog.write(" protocol=\"ssh\"\n")
371 catalog.write(" nbOfNodes=\"1\"\n")
372 catalog.write(" mode=\"interactif\"\n")
373 catalog.write(" OS=\"LINUX\"\n")
375 if (not src.architecture.is_windows()) and machine_access:
376 catalog.write(" CPUFreqMHz=\"%s\"\n" % freq)
377 catalog.write(" nbOfProcPerNode=\"%s\"\n" % nb_proc)
378 catalog.write(" memInMB=\"%s\"\n" % memory)
380 catalog.write(" userName=\"%s\"\n" % user)
381 catalog.write(" name=\"%s\"\n" % k)
382 catalog.write(" hostname=\"%s\"\n" % k)
383 catalog.write(" >\n")
384 catalog.write(" </machine>\n")
386 catalog.write("</resources>\n")
390 ##################################################
393 # Describes the command
395 '''method that is called when salomeTools is called with --help option.
397 :return: The text to display for the application command description.
400 return _("The application command creates a SALOME application.\n"
401 "WARNING: it works only for SALOME 6. Use the \"launcher\" "
402 "command for newer versions of SALOME\n\nexample:\nsat application"
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 APPLICATION.virtual_app does not exists create one
421 if "virtual_app" not in runner.cfg.APPLICATION:
422 msg = _("The section APPLICATION.virtual_app 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.APPLICATION.virtual_app['modules'] = options.modules
436 # activate mesa use in the generated application
438 src.activate_mesa_property(runner.cfg)
440 # set name and application_name
442 runner.cfg.APPLICATION.virtual_app['name'] = options.name
443 runner.cfg.APPLICATION.virtual_app['application_name'] = options.name + "_appdir"
445 application_name = src.get_cfg_param(runner.cfg.APPLICATION.virtual_app,
447 runner.cfg.APPLICATION.virtual_app.name + "_appdir")
448 appli_dir = os.path.join(target_dir, application_name)
450 src.printcolors.print_value(logger,
451 _("Application directory"),
456 catalog, catalog_src = "", ""
458 # use catalog specified in the command line
459 catalog = options.catalog
461 # generate catalog for given list of computers
462 catalog_src = options.gencat
463 catalog = generate_catalog(options.gencat.split(","),
465 elif 'catalog' in runner.cfg.APPLICATION.virtual_app:
466 # use catalog specified in the product
467 if runner.cfg.APPLICATION.virtual_app.catalog.endswith(".xml"):
469 catalog = runner.cfg.APPLICATION.virtual_app.catalog
471 # catalog as a list of computers
472 catalog_src = runner.cfg.APPLICATION.virtual_app.catalog
473 mlist = filter(lambda l: len(l.strip()) > 0,
474 runner.cfg.APPLICATION.virtual_app.catalog.split(","))
476 catalog = generate_catalog(runner.cfg.APPLICATION.virtual_app.catalog.split(","),
479 # display which catalog is used
481 catalog = os.path.realpath(catalog)
482 if len(catalog_src) > 0:
483 src.printcolors.print_value(logger,
484 _("Resources Catalog"),
488 src.printcolors.print_value(logger,
489 _("Resources Catalog"),
493 logger.write("\n", 3, False)
497 # remove previous application
498 if os.path.exists(appli_dir):
499 write_step(logger, _("Removing previous application directory"))
502 shutil.rmtree(appli_dir)
505 logger.write(src.printcolors.printc(rres) + "\n", 3, False)
507 # generate the application
509 try: # try/except/finally not supported in all version of python
510 retcode = create_application(runner.cfg, appli_dir, catalog, logger)
511 except Exception as exc:
512 details.append(str(exc))
515 logger.write("\n", 3, False)