transitionRejectTest.py

#!/usr/local/bin/python
#
#                               Copyright 2005
#                                     by
#                        The Board of Trustees of the
#                     Leland Stanford Junior University.
#                            All rights reserved.
#

__facility__ = "Online"
__abstract__ = "Application for testing rejecting of transitions"
__author__   = "R. Claus <Claus@SLAC.Stanford.edu> SLAC - GLAST LAT I&T/Online"
__date__     = "February 1, 2005"       # Created
__version__  = "$Revision: 1.1 $"
__release__  = "$Name: R04-12-00 $"
__credits__  = "SLAC"

import LATTE.copyright_SLAC

from qt import qApp

import            threading
import logging as log

from   LATTE.runcontrol.rcTransitions  import rcTransitions
from   LATTE.runcontrol.ArgumentImpl   import ArgumentImpl

from support.SimpleGasuExample   import *
from support.MiniGLTExample      import *


#  This class puts up a GUI for inputting a value of some sort.  It is used by
#  the userApplication example to get the number of self triggers to take.
class userArgument(ArgumentImpl):
  "GUI for getting the user to input some sort of value."
  def __init__(self, parent = None, name = None, modal = 0, fl = 0):
    ArgumentImpl.__init__(self, parent, name, modal, fl)
    self.__value = 0
    self.setCaption("Enter value:")

  def CancelButtonClicked(self):
    self.__value = None
    self.close()


class userArgText(object):
  "Text user interface for getting the user to input some sort of value"
  def __init__(self):
    pass

  def getValue(self, caption, value = None):
    if value is None:
      ans = raw_input("%s: " % (caption))
      if ans == '':  return None
      return int(ans)
    else:
      ans = raw_input("%s[%s]: " % (caption, str(value)))
      if ans == '':  return value
      return int(ans)


#  Null application implementation.
class userApplication(rcTransitions):
  "Implmentation class for Null application"
  def __init__(self, rc, userId, debug):
    rcTransitions.__init__(self, rc, userId, debug)
    self.__state    = 1
    self.__doneOnce = False

  def getName(self):
    return __name__

  def setup(self):
    log.debug("userApplication.setup()")

    self.__doneOnce = False

    if self.rc is None:
      self.__arg = userArgText()
    else:
      self.__arg = self.rc.createGUI(userArgument, self.rc, self.getName(), 1)

    caption = "Select when to reject the transition:\n  1 = Setup\n  2 = StartRun\n  3 = StopRun\n  4 = Teardown\n  5 = Pause\n  6 = Resume\n  7 = Stop\n\n"
    if self.rc is None:
      self.__state = self.__arg.getValue(caption, self.__state)
    else:
      self.__state = self.rc.execGUImethod(self.__arg.getValue, caption, self.__state)

    if not self.__doneOnce and self.__state == 1:
      self.__doneOnce = True
      print
      print "Rejecting the SETUP transition - Should end up in RESET state"
      print
      return self.__state

    # Two choices for the trigger, GEM and MiniGLT
    if self.lat.existsGEM():
      self.trigger( SimpleGasuExample() )
    else:
      self.trigger( MiniGLTExample() )

    # A state transition can be rejected by not returning None
    return None

  def startRun(self):
    log.debug("userApplication.startRun()")

    if not self.__doneOnce and self.__state == 2:
      self.__doneOnce = True
      print
      print "Rejecting the START_RUN transition - Should end up in STOPPED state"
      print
      return self.__state

    # A state transition can be rejected by not returning None
    return None

  def stopRun(self):
    log.debug("userApplication.stopRun()")

    # Set the test completion status value
    self.setCompletionStatus(self.COMPL_STATUS_PASSED)

    if not self.__doneOnce and self.__state == 3:
      self.__doneOnce = True
      print
      print "Can't reject the STOP_RUN transition - Should end up in STOPPED state"
      print
      return self.__state

    # The STOP_RUN transition can not be rejected

  def teardown(self):
    log.debug("userApplication.teardown()")

    if not self.__doneOnce and self.__state == 4:
      self.__doneOnce = True
      print
      print "Rejecting the TEARDOWN transition - Should end up in STOPPED state"
      print
      return self.__state

  def pause(self):
    log.debug("userApplication.pause()")

    if not self.__doneOnce and self.__state == 5:
      self.__doneOnce = True
      print
      print "Rejecting the PAUSE transition - Should end up in RUNNING state"
      print
      return self.__state

  def resume(self):
    log.debug("userApplication.resume()")

    if not self.__doneOnce and self.__state == 6:
      self.__doneOnce = True
      print
      print "Rejecting the RESUME transition - Should end up in PAUSED state"
      print
      return self.__state

    # Issue self trigger to make up for the one that was lost during PAUSE
    self.trigger().solicit()

  def stop(self):
    log.debug("userApplication.stop()")

    if not self.__doneOnce and self.__state == 7:
      self.__doneOnce = True
      print
      print "Can't reject the STOP transition - Should end up in STOPPED state"
      print
      return self.__state

    return self.stopRun()


# Standalone mode:
if __name__ == "__main__":
  import os
  import logging as log
  log.basicConfig()
  log.getLogger("").setLevel(log.DEBUG)
  ua = userApplication(None, 321, 0)
  prefs = {'datasave': 1, 'datadir':os.path.join(os.environ['ONLINE_ROOT'],'temp')}
  ua.setPrefs(prefs)
  ua.rcSetup(os.path.join(os.environ['ONLINE_ROOT'], 'repos/simpleTemSchema.xml'))
  ua.rcStartRun()
  ua.rcStopRun()
  ua.rcTeardown()

# History:
#     $Log: transitionRejectTest.py,v $
#     Revision 1.1  2005/02/02 00:39:28  claus
#     Test rejecting of state transition requests.
#
#     Revision 1.1  2004/08/23 21:04:24  claus
#     Test exception handling.
#
#

---