starboard/win/win32/launcher.py

#
# Copyright 2017 The Cobalt Authors. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""Starboard win-win32 launcher."""

from __future__ import print_function

import os
import socket
import subprocess
import sys
import traceback

from starboard.shared.win32 import mini_dump_printer
from starboard.tools import abstract_launcher


class Launcher(abstract_launcher.AbstractLauncher):
  """Run an application on Windows."""

  def __init__(self, platform, target_name, config, device_id, **kwargs):
    super(Launcher, self).__init__(platform, target_name, config, device_id,
                                   **kwargs)
    self.executable_path = self.GetTargetPath()

    self.executable_mini_dump_path = self.executable_path + '.dmp'
    if os.path.exists(self.executable_mini_dump_path):
      self.LogLn('Found previous crash mini dump: deleting.')
      os.remove(self.executable_mini_dump_path)

  def Run(self):
    """Runs launcher's executable_path."""
    self.LogLn('\n***Running Launcher***')
    self.proc = subprocess.Popen(  # pylint: disable=consider-using-with
        [self.executable_path] + self.target_command_line_params,
        stdout=self.output_file,
        stderr=self.output_file,
        universal_newlines=True)
    self.pid = self.proc.pid
    self.proc.communicate()
    self.proc.poll()
    rtn_code = self.proc.returncode
    self.DetectAndHandleCrashDump()
    self.LogLn('Finished running executable.')
    return rtn_code

  def Kill(self):
    self.LogLn('\n***Killing Launcher***')
    if self.pid:
      try:
        self.proc.kill()
      except OSError:
        self.LogLn('Error killing launcher with SIGKILL:')
        traceback.print_exc(file=sys.stdout)
        # If for some reason Kill() fails then os_.exit(1) will kill the
        # child process without cleanup. Otherwise the process will hang.
        os._exit(1)  # pylint: disable=protected-access
    else:
      self.LogLn('Kill() called before Run(), cannot kill.')

  def Log(self, s):
    self.output_file.write(s)

  def LogLn(self, s):
    self.Log(s + '\n')

  def DetectAndHandleCrashDump(self):
    if not os.path.exists(self.executable_mini_dump_path):
      return
    self.LogLn('\n*** Found crash dump! ***\nMinDumpPath:' +
               self.executable_mini_dump_path)
    mini_dump_printer.PrintMiniDump(self.executable_mini_dump_path,
                                    self.executable_path, self.output_file)

  def GetDeviceIp(self):
    """Gets the device IP."""
    return socket.gethostbyname(socket.getfqdn())

  def GetDeviceOutputPath(self):
    return os.getenv('TMP')