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