Package com.testoptimal.exec.mscript

Class Exec

java.lang.Object
com.testoptimal.exec.mscript.Exec
public class Exec extends Object

Provides system functions for MScript.

  • Constructor Summary

    Constructors
    Constructor
    Description
    Exec(com.testoptimal.exec.mscript.MbtScriptExecutor scriptExec_p)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    abort(String msg_p)
    cause model execution to abort and trigger Error if declared.
    String
    genMSC(String chartLabel_p, String fileName_p)
    generate Message Sequence Chart (MSC) from the home/start state to the current state.
    String
    genMSC(String chartLabel_p, String fileName_p, String skinName_p)
    generate Message Sequence Chart (MSC) from the home/start state to the current state.
    String
    genMSC(String chartLabel_p, String fileName_p, String skinName_p, String bkgColor_p)
    generate Message Sequence Chart (MSC) from the home/start state to the current state.
    String
    genPath(String fileName_p)
    generate traversal graph from home/start state to the current state.
    com.testoptimal.exec.FSM.TravBase
    getCurTraverseObj()
    returns the current traversal object which is a wrapper of either state or transition.
    com.testoptimal.exec.ExecutionSetting
    getExecSetting()
    returns the model execution settings for the current execution
    List<String>
    getLastFailure()
    returns the list of check failures
    String
    getModelName()
    returns the name of this model
    String
    getPathName()
    set current test path name.
    String
    getReportFolderPath()
    returns the report folder file path for the current running model.
    com.testoptimal.stats.exec.ModelExec
    getStats()
    returns the model execution stats collection object.
    void
    log(Object msg_p)
    logs a message to model log
    void
    setPathName(String name_p)
     
    void
    setSeed(long seed_p)
    initialize random number generator used by the sequencer to the specific seed.
    String
    trace()
    returns the trace in a string of the traversals separated by comma leading up to the current state/transition.
    String
    trace(int maxTraceCount_p, String delimiter_p)
    returns the trace in a string of last maxLogCount_p traversals leading up to the current state/transition.

    Methods inherited from class java.lang.Object

    equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • Exec

      public Exec(com.testoptimal.exec.mscript.MbtScriptExecutor scriptExec_p)

  • Method Details

    • log

      public void log(Object msg_p)
      logs a message to model log
      Parameters:
      msg_p - message or object with .toString() implementation

    • abort

      public void abort(String msg_p) throws Exception
      cause model execution to abort and trigger Error if declared.
      Parameters:
      msg_p - request MBT execution to be aborted.
      Throws:
      Exception

    • trace

      public String trace() throws Exception
      returns the trace in a string of the traversals separated by comma leading up to the current state/transition.

      Example: place in MBT_FAIL or MBT_ERROR triggers to print out the test sequence transitions that led to the current state/transition where the error/failure occurred.

      Example: 

       $EXEC.trace()
      Returns:
      String, example output as follows 'transName(transUID)'.

      ContinueShopping(U101),AddItem(U112)

      Throws:
      Exception

    • trace

      public String trace(int maxTraceCount_p, String delimiter_p) throws Exception
      returns the trace in a string of last maxLogCount_p traversals leading up to the current state/transition. Trace sequence is separated by the specified delimiter.

      Example: place in MBT_FAIL or MBT_ERROR triggers to print out the test sequence transitions that led to the current state/transition where the error/failure occurred. 

       $EXEC.trace(5,'|')
      Parameters:
      maxTraceCount_p - max number of traversals
      delimiter_p - delimiter to be used to separate the traversals.
      Returns:
      String, example output as follows 'transName:transUID'.

      ContinueShopping:U101|AddItem:U112

      Throws:
      Exception

    • genPath

      public String genPath(String fileName_p) throws Exception
      generate traversal graph from home/start state to the current state. Typically you would call this function in the final state's trigger to generate a test path that corresponds to a test case/scenario.

      Parameters:
      fileName_p - name of the image file without extension. You may include "." in the file name, but the system will always add file extension that matches the image even if you have supplied the right extension.
      Returns:
      file name to the image generated and stored in the report folder of the model.
      Throws:
      Exception

    • genMSC

      public String genMSC(String chartLabel_p, String fileName_p) throws Exception
      generate Message Sequence Chart (MSC) from the home/start state to the current state. Typically you would call this function in the final state's trigger to generate a test sequence that corresponds to a test case / scenario.
      Parameters:
      chartLabel_p - chart label
      fileName_p - name of the image file without extension. You may include "." in the file name, but the system will add file extension that matches the image even if you have supplied the right extension.
      Returns:
      file name to the image generated and stored in the report folder of the model.
      Throws:
      Exception

    • genMSC

      public String genMSC(String chartLabel_p, String fileName_p, String skinName_p) throws Exception
      generate Message Sequence Chart (MSC) from the home/start state to the current state. Typically you would call this function in the final state's trigger to generate a test sequence that corresponds to a test case / scenario.
      Parameters:
      chartLabel_p - chart label
      fileName_p - name of the image file without extension. You may include "." in the file name, but the system will add file extension that matches the image even if you have supplied the right extension.
      skinName_p - name of the skin (Rose or BlueModern) to style the MSC.
      Returns:
      file name to the image generated and stored in the report folder of the model.
      Throws:
      Exception

    • genMSC

      public String genMSC(String chartLabel_p, String fileName_p, String skinName_p, String bkgColor_p) throws Exception
      generate Message Sequence Chart (MSC) from the home/start state to the current state. Typically you would call this function in the final state's trigger to generate a test sequence that corresponds to a test case / scenario.
      Parameters:
      chartLabel_p - chart label
      fileName_p - name of the image file without extension. You may include "." in the file name, but the system will add file extension that matches the image even if you have supplied the right extension.
      skinName_p - name of the skin (Rose or BlueModern) to style the MSC.
      bkgColor_p - background color to be used for MSC, use HTML color code
      Returns:
      file name to the image generated and stored in the report folder of the model.
      Throws:
      Exception

    • setSeed

      public void setSeed(long seed_p)
      initialize random number generator used by the sequencer to the specific seed. By default system uses the default seed for the random number generator. Changing the random number generator seed will affect the actual test sequence generated while maintaining the same test coverage of the model. At times you may wish to try different seed just to get a different variation from the test sequence generated with the default seed.

      This function is usually called in the MBT_start trigger. However you may call it anywhere in MScript.

      Parameters:
      seed_p -

    • getStats

      public com.testoptimal.stats.exec.ModelExec getStats() throws Exception
      returns the model execution stats collection object.
      Returns:
      Throws:
      Exception

    • getReportFolderPath

      public String getReportFolderPath()
      returns the report folder file path for the current running model.

    • setPathName

      public void setPathName(String name_p)
      Parameters:
      name_p - sets the name for the current test path (test case)

    • getPathName

      public String getPathName()
      set current test path name.
      Returns:
      name of the current test path

    • getCurTraverseObj

      public com.testoptimal.exec.FSM.TravBase getCurTraverseObj()
      returns the current traversal object which is a wrapper of either state or transition. Use this traversal object to log success/failure.
      Returns:

    • getLastFailure

      public List<String> getLastFailure()
      returns the list of check failures
      Returns:

    • getExecSetting

      public com.testoptimal.exec.ExecutionSetting getExecSetting()
      returns the model execution settings for the current execution
      Returns:

    • getModelName

      public String getModelName()
      returns the name of this model
      Returns: