EPTF_MBT_LGen_Definitions

Purpose

Type definitions for the MBT Applib

Detailed comments

The MBT applib provides a simple FSM that can catch the reported events from the applibs and can execute all desired test steps registered by the applibs. The behavior of the FSM can be controlled via functions in the “User mapping” code, or via MBT Applib PDUs on the MBT Applib Interface: the EPTF_MBT_Tester_CT component has a EPTF_MBT_PortType to control and observe the behavior of the EPTF_MBT_LGen_CT component running the FSM f_EPTF_MBT_initLGenFsm and the applibs. The MBT applib can be used to test other applibs from their FSM API point of view, or use applibs as test harnesses.

Module paramters

tsp_EPTF_MBT_LGen_debug - boolean - Enable/disable verbose debugging
tsp_EPTG_MBT_execute_lockTimeout - float - Maximum waiting time for the f_EPTF_MBT_execute function when locking is used.

Module depends on

<EPTF_CLL_Base_Definitions>
<EPTF_CLL_Common_Definitions>
<EPTF_CLL_Scheduler_Definitions>
<EPTF_CLL_RBTScheduler_Definitions>
<EPTF_CLL_LGenBase_Definitions>
<EPTF_CLL_FBQ_Definitions>
<EPTF_CLL_Logging_Definitions>

Summary

EPTF_MBT_LGen_Definitions	Type definitions for the MBT Applib
c_EPTF_MBT_myBName	constant for the behavior name
c_EPTF_MBT_inputIdx_incomingUserRequest	constant for the input index of incomming user request
c_EPTF_MBT_inputIdx_incomingUserRequest	constant for the input name of incomming request
c_EPTF_MBT_inputIdx_incomingTestStepRequest	constant for the input index of incomming TesStep request
c_EPTF_MBT_inputName_incomingTestStepRequest	constant for the input name of TEstStep Request
c_EPTF_MBT_stepIdx_invokeTestStep	constant for the step index of invoke TestStep
c_EPTF_MBT_stepIdx_invokeTestStep	constant for the step name of invoke TestStep
c_EPTF_MBT_stepIdx_sendUserResponse	constant for the step index of send user response
c_EPTF_MBT_stepName_sendUserResponse	constant for the step name of send user response
c_EPTF_MBT_stepIdx_invokeUserFunction	constant for the step index of invoke user function
c_EPTF_MBT_stepName_invokeUserFunction	constant for the step name of invoke user function
EPTF_MBT_LGen_CT	MBT application library component type
EPTF_MBT_Tester_CT	MBT tester component type
EPTF_MBT_PortType	Messages based port to connect the Tester comopnent to the loadGen component.
EPTF_MBT_TestStepRequest	Describes the TestStep request
EPTF_MBT_UserRequest	Describes the User Request request
EPTF_MBT_UserResponse	Describes the UserResponse
EPTF_MBT_CreateFSMRequest	Describes the Create FSM request
EPTF_MBT_CreateFSMResponse	Describes the Create FSM response
EPTF_MBT_RemoveFSMRequest	Describes the Remove FSM request
EPTF_MBT_CreateFSMResponse	Describes the Remove FSM response
FsmAddr	Describes the FSM address
EPTF_MBT_TestStepResponse	Describes the TestStep Response]
EPTF_MBT_EventDispatchRequest	Describes the Event Dispatch Request
EPTF_MBT_ConfigRequest	Describes the ConfigRequest
EPTF_MBT_ConfigResponse	Describes the ConfigResponse
EPTF_MBT_CommandRequest	Describes the Command Request
EPTF_MBT_CommandResponse	Describes the Command Response
QuitCommand	Describes the Command Response
ReadyResponse	Describes the Ready Response
QuitAckResponse	Describes the Ready Response
fcb_EPTF_MBT_entityGroupCreated	Describes the function signature for entity Group created callback function
fcb_EPTF_MBT_customUserFunction	Describes the function signature for custom user function

c_EPTF_MBT_myBName

const charstring c_EPTF_MBT_myBName:="MBT_behavior"

Purpose

constant for the behavior name

c_EPTF_MBT_inputIdx_incomingUserRequest

const integer c_EPTF_MBT_inputIdx_incomingUserRequest := 0

Purpose

constant for the input index of incomming user request

c_EPTF_MBT_inputIdx_incomingUserRequest

Purpose

constant for the input name of incomming request

c_EPTF_MBT_inputIdx_incomingTestStepRequest

const integer c_EPTF_MBT_inputIdx_incomingTestStepRequest := 1

Purpose

constant for the input index of incomming TesStep request

c_EPTF_MBT_inputName_incomingTestStepRequest

const charstring c_EPTF_MBT_inputName_incomingTestStepRequest := "EPTF_MBT_inputName_incomingTestStepRequest"

Purpose

constant for the input name of TEstStep Request

c_EPTF_MBT_stepIdx_invokeTestStep

const integer c_EPTF_MBT_stepIdx_invokeTestStep:=0

Purpose

constant for the step index of invoke TestStep

c_EPTF_MBT_stepIdx_invokeTestStep

Purpose

constant for the step name of invoke TestStep

c_EPTF_MBT_stepIdx_sendUserResponse

const integer c_EPTF_MBT_stepIdx_sendUserResponse:=2

Purpose

constant for the step index of send user response

c_EPTF_MBT_stepName_sendUserResponse

const charstring c_EPTF_MBT_stepName_sendUserResponse :="EPTF_MBT_stepName_sendUserResponse"

Purpose

constant for the step name of send user response

c_EPTF_MBT_stepIdx_invokeUserFunction

const integer c_EPTF_MBT_stepIdx_invokeUserFunction:=1

Purpose

constant for the step index of invoke user function

c_EPTF_MBT_stepName_invokeUserFunction

const charstring c_EPTF_MBT_stepName_invokeUserFunction :="EPTF_MBT_stepName_invokeUserFunction"

Purpose

constant for the step name of invoke user function

EPTF_MBT_LGen_CT

type component EPTF_MBT_LGen_CT extends EPTF_LGenBase_CT, EPTF_Scheduler_CT, EPTF_Logging_CT, EPTF_Semaphore_CT

Purpose

MBT application library component type

Extensions

EPTF_LGenBase_CT

EPTF_Scheduler_CT

EPTF_Logging_CT

Variables

v_EPTF_MBT_initialized	boolean - component initialization state
v_EPTF_MBT_myName	charstring - component’s self name
vf_EPTF_MBT_entityGroupCreated	fcb_EPTF_MBT_entityGroupCreated - Entity Group created callback function
vf_EPTF_MBT_createUserResponse	fcb_EPTF_MBT_customUserFunction - Custom User function
v_EPTF_MBT_myBIdx	integer - self behavior index
v_EPTF_MBT_LoggingMaskId	integer - logging mask id

Timers

Ports

EPTF_MBT_PCO EPTF_MBT_PortType

Detailed Comments

EPTF_MBT_Tester_CT

type component EPTF_MBT_Tester_CT extends EPTF_Base_CT, EPTF_Semaphore_CT

Purpose

MBT tester component type

Extensions

EPTF_LGenBase_CT

EPTF_Scheduler_CT

EPTF_Logging_CT

Variables

Timers

Ports

EPTF_MBT_PCO EPTF_MBT_PortType

Detailed Comments

EPTF_MBT_PortType

type port EPTF_MBT_PortType message

Purpose

Messages based port to connect the Tester comopnent to the loadGen component.

Handled messages

inout EPTF_MBT_TestStepRequest, EPTF_MBT_TestStepResponse; inout EPTF_MBT_ConfigRequest, EPTF_MBT_ConfigResponse; inout EPTF_MBT_CommandRequest, EPTF_MBT_CommandResponse; inout EPTF_MBT_UserRequest, EPTF_MBT_UserResponse; inout EPTF_MBT_CreateFSMRequest, EPTF_MBT_CreateFSMResponse; inout EPTF_MBT_RemoveFSMRequest, EPTF_MBT_RemoveFSMResponse;

Detailed Comments

EPTF_MBT_TestStepRequest

type record EPTF_MBT_TestStepRequest

Purpose

Describes the TestStep request

Elements

stepname	charstring - Name of the requested TestStep
stepArgs	<EPTF_IntegerList> - Container for the TestStep arguments
addr	FsmAddr - Address of the FSM
lock	integer - After the test step was executed the semaphor with this id will be unlocked by the applib.

Detailed Comments

EPTF_MBT_UserRequest

type record EPTF_MBT_UserRequest

Purpose

Describes the User Request request

Elements

functionName	charstring - Name of the requested function
functionArgs	<EPTF_IntegerList> - Container for the function arguments
addr	FsmAddr - Address of the FSM

Detailed Comments

EPTF_MBT_UserResponse

type record EPTF_MBT_UserResponse {}

Purpose

Describes the UserResponse

Elements

Detailed Comments

EPTF_MBT_CreateFSMRequest

type record EPTF_MBT_CreateFSMRequest

Purpose

Describes the Create FSM request

Elements

entityGroupName	charstring - Name of the target entity group
eIdx	integer - Index of the target entity
fsmName	charstring - Name of the FSM to be activated

EPTF_MBT_CreateFSMResponse

type record EPTF_MBT_CreateFSMResponse

Purpose

Describes the Create FSM response

Elements

result	integer - The result (-1 in case of error)
addr	FsmAddr - The address of the activated FSM

EPTF_MBT_RemoveFSMRequest

type record EPTF_MBT_RemoveFSMRequest

Purpose

Describes the Remove FSM request

Elements

addr	FsmAddr - The address of the FSM to be removed

EPTF_MBT_CreateFSMResponse

Purpose

Describes the Remove FSM response

Elements

result

integer - The result (-1 in case of error)

FsmAddr

type record FsmAddr

Purpose

Describes the FSM address

Elements

entityGroupName	charstring - Name of the entity group
eIdx	integer - entity index
fIdx	integer - fsm index

Detailed Comments

EPTF_MBT_TestStepResponse

type record EPTF_MBT_TestStepResponse

Purpose

Describes the TestStep Response]

Elements

bName	charstring - Name of the behavior
iName	charstring - Name of the Event
addr	FsmAddr - Address of the FSM, where the event was reported.

Detailed Comments

EPTF_MBT_EventDispatchRequest

type record EPTF_MBT_EventDispatchRequest

Purpose

Describes the Event Dispatch Request

Elements

bName	charstring - Name of the behavior
iName	integer - Index of the Event
addr	FsmAddr - Address of the FSM, where the event was reported.

Detailed Comments

EPTF_MBT_ConfigRequest

type record EPTF_MBT_ConfigRequest

Purpose

Describes the ConfigRequest

Elements

entityGroupName	charstring - Name of the behavior
noEntities	integer - Number of entities within the group
behaviors	<EPTF_CharstringList> - List of behavior that should be allocate to the group
fsmName	charstring - Name of the FSM to be assignedto teh entity group

Detailed Comments

EPTF_MBT_ConfigResponse

type record EPTF_MBT_ConfigResponse {}

Purpose

Describes the ConfigResponse

Elements

Detailed Comments

EPTF_MBT_CommandRequest

type union EPTF_MBT_CommandRequest

Purpose

Describes the Command Request

Elements

quit comamnd that terminates the execution

Detailed Comments

EPTF_MBT_CommandResponse

type union EPTF_MBT_CommandResponse

Purpose

Describes the Command Response

Elements

ready - ReadyResponse - Ready indication
quitAck - QuitAckResponse - Ack for the quit command

Detailed Comments

QuitCommand

type record QuitCommand {}

Purpose

Describes the Command Response

Elements

Detailed Comments

ReadyResponse

type record ReadyResponse {}

Purpose

Describes the Ready Response

Elements

Detailed Comments

QuitAckResponse

type record QuitAckResponse {}

Purpose

Describes the Ready Response

Elements

Detailed Comments

fcb_EPTF_MBT_entityGroupCreated

type function fcb_EPTF_MBT_entityGroupCreated(
in EPTF_MBT_ConfigRequest p_req
) runs on self

Purpose

Describes the function signature for entity Group created callback function

Elements

p_req

EPTF_MBT_ConfigRequest - describes the requetsed configuration

Detailed Comments

fcb_EPTF_MBT_customUserFunction

type function fcb_EPTF_MBT_customUserFunction (
in EPTF_LGenBase_TestStepArgs pl_ptr
) runs on self return boolean

Purpose

Describes the function signature for custom user function

Elements

pl_ptr

<EPTF_LGenBase_TestStepArgs> - describes the requetsed configuration