py/umpire/service/shop_floor.py

# Copyright (c) 2014 The Chromium OS Authors. All rights reserved.
# Use of this source code is governed by a BSD-style license that can be
# found in the LICENSE file.


"""Shop floor service for launching shop floor XMLRPC in bundles."""


import os

import factory_common  # pylint: disable=W0611
from cros.factory.umpire.service import umpire_service


# TODO(rongchang): Check why symlink doesn't work.
SHOP_FLOOR_FCGI = 'usr/local/factory/py/umpire/shop_floor_launcher.py'
PROCESS_NAME_PREFIX = 'shop_floor_'


class ShopFloorService(umpire_service.UmpireService):

  """Shop floor service.

  Example:
    shopfloor_service = GetServiceInstance('shop_floor')
    procs = svc.CreateProcesses(umpire_config_attrdict, umpire_env)
    shopfloor_service.Start(procs)
  """

  def __init__(self):
    super(ShopFloorService, self).__init__()
    self.properties['num_shopfloor_handlers'] = 0

  def CreateProcesses(self, dummy_config, env):
    """Creates list of shop floor processes via config.

    Args:
      dummy_config: Umpire config AttrDict object.
      env: UmpireEnv object.

    Returns:
      A list of ServiceProcess.
    """
    active_bundles = env.config.GetActiveBundles()
    processes = []
    for bundle in active_bundles:
      # Get toolkit path and shop floor handler.
      toolkit_dir = env.GetBundleDeviceToolkit(bundle['id'])
      handler = bundle['shop_floor']['handler']
      if not (toolkit_dir and handler):
        continue
      # Prepare handler configuration.
      handler_config = bundle['shop_floor'].get('handler_config', dict())
      # Convert {'mount_point': '/path/to/dir'} to process parameters:
      #   ['--mount_point', '/path/to/dir']
      process_parameters = sum([['--%s' % key, value] for key, value in
                                handler_config.iteritems()], list())
      # Allocate port and token.
      (fcgi_port, token) = env.shop_floor_manager.Allocate(bundle['id'])
      # Set process configuration.
      proc_config = {
          'executable': os.path.join(toolkit_dir, SHOP_FLOOR_FCGI),
          'name': PROCESS_NAME_PREFIX + bundle['id'],
          'args': ['--module', handler] + process_parameters,
          'path': env.umpire_data_dir}
      proc = umpire_service.ServiceProcess(self)
      proc.SetNonhashArgs(['--port', str(fcgi_port), '--token', token])
      proc.SetConfig(proc_config)
      # Adds release callbacks on error and stopped state.
      def ReleaseResource(release_port):
        env.shop_floor_manager.Release(release_port)

      proc.AddStateCallback(
          [umpire_service.State.ERROR, umpire_service.State.STOPPED],
          ReleaseResource,
          fcgi_port)
      processes.append(proc)
    self.properties['num_shopfloor_handlers'] = len(processes)
    return processes

# Create a shop floor service instance
_service_instance = ShopFloorService()