src/nepi/resources/linux/application.py

   1 #
   2 #    NEPI, a framework to manage network experiments
   3 #    Copyright (C) 2013 INRIA
   4 #
   5 #    This program is free software: you can redistribute it and/or modify
   6 #    it under the terms of the GNU General Public License as published by
   7 #    the Free Software Foundation, either version 3 of the License, or
   8 #    (at your option) any later version.
   9 #
  10 #    This program 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
  13 #    GNU General Public License for more details.
  14 #
  15 #    You should have received a copy of the GNU General Public License
  16 #    along with this program.  If not, see <http://www.gnu.org/licenses/>.
  17 #
  18 # Author: Alina Quereilhac <alina.quereilhac@inria.fr>
  19
  20 from nepi.execution.attribute import Attribute, Flags, Types
  21 from nepi.execution.trace import Trace, TraceAttr
  22 from nepi.execution.resource import ResourceManager, clsinit, ResourceState, \
  23     reschedule_delay
  24 from nepi.resources.linux.node import LinuxNode
  25 from nepi.util.sshfuncs import ProcStatus
  26 from nepi.util.timefuncs import tnow, tdiffsec
  27
  28 import os
  29 import subprocess
  30
  31 # TODO: Resolve wildcards in commands!!
  32
  33 @clsinit
  34 class LinuxApplication(ResourceManager):
  35     """
  36     .. class:: Class Args :
  37
  38         :param ec: The Experiment controller
  39         :type ec: ExperimentController
  40         :param guid: guid of the RM
  41         :type guid: int
  42
  43     .. note::
  44
  45     A LinuxApplication RM represents a process that can be executed in
  46     a remote Linux host using SSH.
  47
  48     The LinuxApplication RM takes care of uploadin sources and any files
  49     needed to run the experiment, to the remote host.
  50     It also allows to provide source compilation (build) and installation
  51     instructions, and takes care of automating the sources build and
  52     installation tasks for the user.
  53
  54     It is important to note that files uploaded to the remote host have
  55     two possible scopes: single-experiment or multi-experiment.
  56     Single experiment files are those that will not be re-used by other
  57     experiments. Multi-experiment files are those that will.
  58     Sources and shared files are always made available to all experiments.
  59
  60     Directory structure:
  61
  62     The directory structure used by LinuxApplication RM at the Linux
  63     host is the following:
  64
  65         ${HOME}/nepi-usr --> Base directory for multi-experiment files
  66                       |
  67         ${LIB}        |- /lib --> Base directory for libraries
  68         ${BIN}        |- /bin --> Base directory for binary files
  69         ${SRC}        |- /src --> Base directory for sources
  70         ${SHARE}      |- /share --> Base directory for other files
  71
  72         ${HOME}/nepi-exp --> Base directory for single-experiment files
  73                       |
  74         ${EXP_HOME}   |- /<exp-id>  --> Base directory for experiment exp-id
  75                           |
  76         ${APP_HOME}       |- /<app-guid> --> Base directory for application
  77                                |     specific files (e.g. command.sh, input)
  78                                |
  79         ${RUN_HOME}            |- /<run-id> --> Base directory for run specific
  80
  81     """
  82
  83     _rtype = "LinuxApplication"
  84
  85     @classmethod
  86     def _register_attributes(cls):
  87         command = Attribute("command", "Command to execute at application start. "
  88                 "Note that commands will be executed in the ${RUN_HOME} directory, "
  89                 "make sure to take this into account when using relative paths. ",
  90                 flags = Flags.ExecReadOnly)
  91         forward_x11 = Attribute("forwardX11", "Enables X11 forwarding for SSH connections",
  92                 flags = Flags.ExecReadOnly)
  93         env = Attribute("env", "Environment variables string for command execution",
  94                 flags = Flags.ExecReadOnly)
  95         sudo = Attribute("sudo", "Run with root privileges",
  96                 flags = Flags.ExecReadOnly)
  97         depends = Attribute("depends",
  98                 "Space-separated list of packages required to run the application",
  99                 flags = Flags.ExecReadOnly)
 100         sources = Attribute("sources",
 101                 "Space-separated list of regular files to be uploaded to ${SRC} "
 102                 "directory prior to building. Archives won't be expanded automatically. "
 103                 "Sources are globally available for all experiments unless "
 104                 "cleanHome is set to True (This will delete all sources). ",
 105                 flags = Flags.ExecReadOnly)
 106         files = Attribute("files",
 107                 "Space-separated list of regular miscellaneous files to be uploaded "
 108                 "to ${SHARE} directory. "
 109                 "Files are globally available for all experiments unless "
 110                 "cleanHome is set to True (This will delete all files). ",
 111                 flags = Flags.ExecReadOnly)
 112         libs = Attribute("libs",
 113                 "Space-separated list of libraries (e.g. .so files) to be uploaded "
 114                 "to ${LIB} directory. "
 115                 "Libraries are globally available for all experiments unless "
 116                 "cleanHome is set to True (This will delete all files). ",
 117                 flags = Flags.ExecReadOnly)
 118         bins = Attribute("bins",
 119                 "Space-separated list of binary files to be uploaded "
 120                 "to ${BIN} directory. "
 121                 "Binaries are globally available for all experiments unless "
 122                 "cleanHome is set to True (This will delete all files). ",
 123                 flags = Flags.ExecReadOnly)
 124         code = Attribute("code",
 125                 "Plain text source code to be uploaded to the ${APP_HOME} directory. ",
 126                 flags = Flags.ExecReadOnly)
 127         build = Attribute("build",
 128                 "Build commands to execute after deploying the sources. "
 129                 "Sources are uploaded to the ${SRC} directory and code "
 130                 "is uploaded to the ${APP_HOME} directory. \n"
 131                 "Usage example: tar xzf ${SRC}/my-app.tgz && cd my-app && "
 132                 "./configure && make && make clean.\n"
 133                 "Make sure to make the build commands return with a nonzero exit "
 134                 "code on error.",
 135                 flags = Flags.ReadOnly)
 136         install = Attribute("install",
 137                 "Commands to transfer built files to their final destinations. "
 138                 "Install commands are executed after build commands. ",
 139                 flags = Flags.ReadOnly)
 140         stdin = Attribute("stdin", "Standard input for the 'command'",
 141                 flags = Flags.ExecReadOnly)
 142         tear_down = Attribute("tearDown", "Command to be executed just before "
 143                 "releasing the resource",
 144                 flags = Flags.ReadOnly)
 145
 146         cls._register_attribute(command)
 147         cls._register_attribute(forward_x11)
 148         cls._register_attribute(env)
 149         cls._register_attribute(sudo)
 150         cls._register_attribute(depends)
 151         cls._register_attribute(sources)
 152         cls._register_attribute(code)
 153         cls._register_attribute(files)
 154         cls._register_attribute(bins)
 155         cls._register_attribute(libs)
 156         cls._register_attribute(build)
 157         cls._register_attribute(install)
 158         cls._register_attribute(stdin)
 159         cls._register_attribute(tear_down)
 160
 161     @classmethod
 162     def _register_traces(cls):
 163         stdout = Trace("stdout", "Standard output stream")
 164         stderr = Trace("stderr", "Standard error stream")
 165
 166         cls._register_trace(stdout)
 167         cls._register_trace(stderr)
 168
 169     def __init__(self, ec, guid):
 170         super(LinuxApplication, self).__init__(ec, guid)
 171         self._pid = None
 172         self._ppid = None
 173         self._home = "app-%s" % self.guid
 174         # whether the command should run in foreground attached
 175         # to a terminal
 176         self._in_foreground = False
 177
 178         # whether to use sudo to kill the application process
 179         self._sudo_kill = False
 180
 181         # keep a reference to the running process handler when
 182         # the command is not executed as remote daemon in background
 183         self._proc = None
 184
 185         # timestamp of last state check of the application
 186         self._last_state_check = tnow()
 187
 188     def log_message(self, msg):
 189         return " guid %d - host %s - %s " % (self.guid,
 190                 self.node.get("hostname"), msg)
 191
 192     @property
 193     def node(self):
 194         node = self.get_connected(LinuxNode.rtype())
 195         if node: return node[0]
 196         return None
 197
 198     @property
 199     def app_home(self):
 200         return os.path.join(self.node.exp_home, self._home)
 201
 202     @property
 203     def run_home(self):
 204         return os.path.join(self.app_home, self.ec.run_id)
 205
 206     @property
 207     def pid(self):
 208         return self._pid
 209
 210     @property
 211     def ppid(self):
 212         return self._ppid
 213
 214     @property
 215     def in_foreground(self):
 216         """ Returns True if the command needs to be executed in foreground.
 217         This means that command will be executed using 'execute' instead of
 218         'run' ('run' executes a command in background and detached from the
 219         terminal)
 220
 221         When using X11 forwarding option, the command can not run in background
 222         and detached from a terminal, since we need to keep the terminal attached
 223         to interact with it.
 224         """
 225         return self.get("forwardX11") or self._in_foreground
 226
 227     def trace(self, name, attr = TraceAttr.ALL, block = 512, offset = 0):
 228         self.info("Retrieving '%s' trace %s " % (name, attr))
 229
 230         path = os.path.join(self.run_home, name)
 231
 232         command = "(test -f %s && echo 'success') || echo 'error'" % path
 233         (out, err), proc = self.node.execute(command)
 234
 235         if (err and proc.poll()) or out.find("error") != -1:
 236             msg = " Couldn't find trace %s " % name
 237             self.error(msg, out, err)
 238             return None
 239
 240         if attr == TraceAttr.PATH:
 241             return path
 242
 243         if attr == TraceAttr.ALL:
 244             (out, err), proc = self.node.check_output(self.run_home, name)
 245
 246             if proc.poll():
 247                 msg = " Couldn't read trace %s " % name
 248                 self.error(msg, out, err)
 249                 return None
 250
 251             return out
 252
 253         if attr == TraceAttr.STREAM:
 254             cmd = "dd if=%s bs=%d count=1 skip=%d" % (path, block, offset)
 255         elif attr == TraceAttr.SIZE:
 256             cmd = "stat -c%%s %s " % path
 257
 258         (out, err), proc = self.node.execute(cmd)
 259
 260         if proc.poll():
 261             msg = " Couldn't find trace %s " % name
 262             self.error(msg, out, err)
 263             return None
 264
 265         if attr == TraceAttr.SIZE:
 266             out = int(out.strip())
 267
 268         return out
 269
 270     def provision(self):
 271         # create run dir for application
 272         self.node.mkdir(self.run_home)
 273
 274         # List of all the provision methods to invoke
 275         steps = [
 276             # upload sources
 277             self.upload_sources,
 278             # upload files
 279             self.upload_files,
 280             # upload binaries
 281             self.upload_binaries,
 282             # upload libraries
 283             self.upload_libraries,
 284             # upload code
 285             self.upload_code,
 286             # upload stdin
 287             self.upload_stdin,
 288             # install dependencies
 289             self.install_dependencies,
 290             # build
 291             self.build,
 292             # Install
 293             self.install]
 294
 295         command = []
 296
 297         # Since provisioning takes a long time, before
 298         # each step we check that the EC is still
 299         for step in steps:
 300             if self.ec.finished:
 301                 raise RuntimeError, "EC finished"
 302
 303             ret = step()
 304             if ret:
 305                 command.append(ret)
 306
 307         # upload deploy script
 308         deploy_command = ";".join(command)
 309         self.execute_deploy_command(deploy_command)
 310
 311         # upload start script
 312         self.upload_start_command()
 313
 314         self.info("Provisioning finished")
 315
 316         super(LinuxApplication, self).provision()
 317
 318     def upload_start_command(self):
 319         # Upload command to remote bash script
 320         # - only if command can be executed in background and detached
 321         command = self.get("command")
 322
 323         if command and not self.in_foreground:
 324             self.info("Uploading command '%s'" % command)
 325
 326             # replace application specific paths in the command
 327             command = self.replace_paths(command)
 328
 329             # replace application specific paths in the environment
 330             env = self.get("env")
 331             env = env and self.replace_paths(env)
 332
 333             shfile = os.path.join(self.app_home, "start.sh")
 334
 335             self.node.upload_command(command,
 336                     shfile = shfile,
 337                     env = env)
 338
 339     def execute_deploy_command(self, command):
 340         if command:
 341             # Upload the command to a bash script and run it
 342             # in background ( but wait until the command has
 343             # finished to continue )
 344             shfile = os.path.join(self.app_home, "deploy.sh")
 345             self.node.run_and_wait(command, self.run_home,
 346                     shfile = shfile,
 347                     overwrite = False,
 348                     pidfile = "deploy_pidfile",
 349                     ecodefile = "deploy_exitcode",
 350                     stdout = "deploy_stdout",
 351                     stderr = "deploy_stderr")
 352
 353     def upload_sources(self):
 354         sources = self.get("sources")
 355
 356         command = ""
 357
 358         if sources:
 359             self.info("Uploading sources ")
 360
 361             sources = sources.split(' ')
 362
 363             # Separate sources that should be downloaded from
 364             # the web, from sources that should be uploaded from
 365             # the local machine
 366             command = []
 367             for source in list(sources):
 368                 if source.startswith("http") or source.startswith("https"):
 369                     # remove the hhtp source from the sources list
 370                     sources.remove(source)
 371
 372                     command.append( " ( "
 373                             # Check if the source already exists
 374                             " ls ${SRC}/%(basename)s "
 375                             " || ( "
 376                             # If source doesn't exist, download it and check
 377                             # that it it downloaded ok
 378                             "   wget -c --directory-prefix=${SRC} %(source)s && "
 379                             "   ls ${SRC}/%(basename)s "
 380                             " ) ) " % {
 381                                 "basename": os.path.basename(source),
 382                                 "source": source
 383                                 })
 384
 385             command = " && ".join(command)
 386
 387             # replace application specific paths in the command
 388             command = self.replace_paths(command)
 389
 390             if sources:
 391                 sources = ' '.join(sources)
 392                 self.node.upload(sources, self.node.src_dir, overwrite = False)
 393
 394         return command
 395
 396     def upload_files(self):
 397         files = self.get("files")
 398
 399         if files:
 400             self.info("Uploading files %s " % files)
 401             self.node.upload(files, self.node.share_dir, overwrite = False)
 402
 403     def upload_libraries(self):
 404         libs = self.get("libs")
 405
 406         if libs:
 407             self.info("Uploading libraries %s " % libaries)
 408             self.node.upload(libs, self.node.lib_dir, overwrite = False)
 409
 410     def upload_binaries(self):
 411         bins = self.get("bins")
 412
 413         if bins:
 414             self.info("Uploading binaries %s " % binaries)
 415             self.node.upload(bins, self.node.bin_dir, overwrite = False)
 416
 417     def upload_code(self):
 418         code = self.get("code")
 419
 420         if code:
 421             self.info("Uploading code")
 422
 423             dst = os.path.join(self.app_home, "code")
 424             self.node.upload(code, dst, overwrite = False, text = True)
 425
 426     def upload_stdin(self):
 427         stdin = self.get("stdin")
 428         if stdin:
 429             # create dir for sources
 430             self.info("Uploading stdin")
 431
 432             # upload stdin file to ${SHARE_DIR} directory
 433             basename = os.path.basename(stdin)
 434             dst = os.path.join(self.node.share_dir, basename)
 435             self.node.upload(stdin, dst, overwrite = False, text = True)
 436
 437             # create "stdin" symlink on ${APP_HOME} directory
 438             command = "( cd %s ; ln -s %s stdin )" % ( self.app_home, dst)
 439
 440             return command
 441
 442     def install_dependencies(self):
 443         depends = self.get("depends")
 444         if depends:
 445             self.info("Installing dependencies %s" % depends)
 446             self.node.install_packages(depends, self.app_home, self.run_home)
 447
 448     def build(self):
 449         build = self.get("build")
 450
 451         if build:
 452             self.info("Building sources ")
 453
 454             # replace application specific paths in the command
 455             return self.replace_paths(build)
 456
 457     def install(self):
 458         install = self.get("install")
 459
 460         if install:
 461             self.info("Installing sources ")
 462
 463             # replace application specific paths in the command
 464             return self.replace_paths(install)
 465
 466     def deploy(self):
 467         # Wait until node is associated and deployed
 468         node = self.node
 469         if not node or node.state < ResourceState.READY:
 470             self.debug("---- RESCHEDULING DEPLOY ---- node state %s " % self.node.state )
 471             self.ec.schedule(reschedule_delay, self.deploy)
 472         else:
 473             try:
 474                 command = self.get("command") or ""
 475                 self.info("Deploying command '%s' " % command)
 476                 self.discover()
 477                 self.provision()
 478             except:
 479                 self.fail()
 480                 raise
 481
 482             super(LinuxApplication, self).deploy()
 483
 484     def start(self):
 485         command = self.get("command")
 486
 487         self.info("Starting command '%s'" % command)
 488
 489         if not command:
 490             # If no command was given (i.e. Application was used for dependency
 491             # installation), then the application is directly marked as FINISHED
 492             self._state = ResourceState.FINISHED
 493         else:
 494
 495             if self.in_foreground:
 496                 self._run_in_foreground()
 497             else:
 498                 self._run_in_background()
 499
 500             super(LinuxApplication, self).start()
 501
 502     def _run_in_foreground(self):
 503         command = self.get("command")
 504         sudo = self.get("sudo") or False
 505         x11 = self.get("forwardX11")
 506
 507         # For a command being executed in foreground, if there is stdin,
 508         # it is expected to be text string not a file or pipe
 509         stdin = self.get("stdin") or None
 510
 511         # Command will be launched in foreground and attached to the
 512         # terminal using the node 'execute' in non blocking mode.
 513
 514         # We save the reference to the process in self._proc
 515         # to be able to kill the process from the stop method.
 516         # We also set blocking = False, since we don't want the
 517         # thread to block until the execution finishes.
 518         (out, err), self._proc = self.execute_command(self, command,
 519                 env = env,
 520                 sudo = sudo,
 521                 stdin = stdin,
 522                 forward_x11 = x11,
 523                 blocking = False)
 524
 525         if self._proc.poll():
 526             self.fail()
 527             self.error(msg, out, err)
 528             raise RuntimeError, msg
 529
 530     def _run_in_background(self):
 531         command = self.get("command")
 532         env = self.get("env")
 533         sudo = self.get("sudo") or False
 534
 535         stdout = "stdout"
 536         stderr = "stderr"
 537         stdin = os.path.join(self.app_home, "stdin") if self.get("stdin") \
 538                 else None
 539
 540         # Command will be run as a daemon in baground and detached from any
 541         # terminal.
 542         # The command to run was previously uploaded to a bash script
 543         # during deployment, now we launch the remote script using 'run'
 544         # method from the node.
 545         cmd = "bash %s" % os.path.join(self.app_home, "start.sh")
 546         (out, err), proc = self.node.run(cmd, self.run_home,
 547             stdin = stdin,
 548             stdout = stdout,
 549             stderr = stderr,
 550             sudo = sudo)
 551
 552         # check if execution errors occurred
 553         msg = " Failed to start command '%s' " % command
 554
 555         if proc.poll():
 556             self.fail()
 557             self.error(msg, out, err)
 558             raise RuntimeError, msg
 559
 560         # Wait for pid file to be generated
 561         pid, ppid = self.node.wait_pid(self.run_home)
 562         if pid: self._pid = int(pid)
 563         if ppid: self._ppid = int(ppid)
 564
 565         # If the process is not running, check for error information
 566         # on the remote machine
 567         if not self.pid or not self.ppid:
 568             (out, err), proc = self.node.check_errors(self.run_home,
 569                     stderr = stderr)
 570
 571             # Out is what was written in the stderr file
 572             if err:
 573                 self.fail()
 574                 msg = " Failed to start command '%s' " % command
 575                 self.error(msg, out, err)
 576                 raise RuntimeError, msg
 577
 578     def stop(self):
 579         """ Stops application execution
 580         """
 581         command = self.get('command') or ''
 582
 583         if self.state == ResourceState.STARTED:
 584
 585             stopped = True
 586
 587             self.info("Stopping command '%s'" % command)
 588
 589             # If the command is running in foreground (it was launched using
 590             # the node 'execute' method), then we use the handler to the Popen
 591             # process to kill it. Else we send a kill signal using the pid and ppid
 592             # retrieved after running the command with the node 'run' method
 593
 594             if self._proc:
 595                 self._proc.kill()
 596             else:
 597                 # Only try to kill the process if the pid and ppid
 598                 # were retrieved
 599                 if self.pid and self.ppid:
 600                     (out, err), proc = self.node.kill(self.pid, self.ppid, sudo =
 601                             self._sudo_kill)
 602
 603                     if out or err:
 604                         # check if execution errors occurred
 605                         msg = " Failed to STOP command '%s' " % self.get("command")
 606                         self.error(msg, out, err)
 607                         self.fail()
 608                         stopped = False
 609
 610             if stopped:
 611                 super(LinuxApplication, self).stop()
 612
 613     def release(self):
 614         self.info("Releasing resource")
 615
 616         tear_down = self.get("tearDown")
 617         if tear_down:
 618             self.node.execute(tear_down)
 619
 620         self.stop()
 621
 622         if self.state == ResourceState.STOPPED:
 623             super(LinuxApplication, self).release()
 624
 625     @property
 626     def state(self):
 627         """ Returns the state of the application
 628         """
 629         if self._state == ResourceState.STARTED:
 630             if self.in_foreground:
 631                 # Check if the process we used to execute the command
 632                 # is still running ...
 633                 retcode = self._proc.poll()
 634
 635                 # retcode == None -> running
 636                 # retcode > 0 -> error
 637                 # retcode == 0 -> finished
 638                 if retcode:
 639                     out = ""
 640                     msg = " Failed to execute command '%s'" % self.get("command")
 641                     err = self._proc.stderr.read()
 642                     self.error(msg, out, err)
 643                     self.fail()
 644                 elif retcode == 0:
 645                     self._state = ResourceState.FINISHED
 646
 647             else:
 648                 # We need to query the status of the command we launched in
 649                 # background. In oredr to avoid overwhelming the remote host and
 650                 # the local processor with too many ssh queries, the state is only
 651                 # requested every 'state_check_delay' seconds.
 652                 state_check_delay = 0.5
 653                 if tdiffsec(tnow(), self._last_state_check) > state_check_delay:
 654                     # check if execution errors occurred
 655                     (out, err), proc = self.node.check_errors(self.run_home)
 656
 657                     if err:
 658                         msg = " Failed to execute command '%s'" % self.get("command")
 659                         self.error(msg, out, err)
 660                         self.fail()
 661
 662                     elif self.pid and self.ppid:
 663                         # No execution errors occurred. Make sure the background
 664                         # process with the recorded pid is still running.
 665                         status = self.node.status(self.pid, self.ppid)
 666
 667                         if status == ProcStatus.FINISHED:
 668                             self._state = ResourceState.FINISHED
 669
 670                     self._last_state_check = tnow()
 671
 672         return self._state
 673
 674     def execute_command(self, command,
 675             env = None,
 676             sudo = False,
 677             stdin = None,
 678             forward_x11 = False,
 679             blocking = False):
 680
 681         environ = ""
 682         if env:
 683             environ = self.node.format_environment(env, inline = True)
 684         command = environ + command
 685         command = self.replace_paths(command)
 686
 687         return self.node.execute(command,
 688                 sudo = sudo,
 689                 stdin = stdin,
 690                 forward_x11 = forward_x11,
 691                 blocking = blocking)
 692
 693     def replace_paths(self, command):
 694         """
 695         Replace all special path tags with shell-escaped actual paths.
 696         """
 697         return ( command
 698             .replace("${USR}", self.node.usr_dir)
 699             .replace("${LIB}", self.node.lib_dir)
 700             .replace("${BIN}", self.node.bin_dir)
 701             .replace("${SRC}", self.node.src_dir)
 702             .replace("${SHARE}", self.node.share_dir)
 703             .replace("${EXP}", self.node.exp_dir)
 704             .replace("${EXP_HOME}", self.node.exp_home)
 705             .replace("${APP_HOME}", self.app_home)
 706             .replace("${RUN_HOME}", self.run_home)
 707             .replace("${NODE_HOME}", self.node.node_home)
 708             .replace("${HOME}", self.node.home_dir)
 709             )
 710
 711     def valid_connection(self, guid):
 712         # TODO: Validate!
 713         return True
 714