FIXRobot package

Submodules

FIXRobot.FIXRobot module

FIXRobot is software to write testcases and test FIXEngine using FIX Protocol. FIXRobot can act as intitiator and acceptor/exchange. FIXRobot can send and receive FIX messages and will compare the actual messages with the expected messages.

class FIXRobot.FIXRobot.FIXMessageEvaluator
evalMsgType(msgTypeString)
class FIXRobot.FIXRobot.FIXRobot

FIXRobot class creates a FIX connection and/or then send and receive FIX messages

clearMessageStore()

This function is used to clear the message store.

Args:
None.
Returns:
None.
Raises:
Exception: Raises exception when error occours.
getExpectedSenderNum()

This function is used to get the next out sequence number.

Args:
None.
Returns:
None.
Raises:
Exception: Raises exception when error occours.
getExpectedTargetNum()

This function is used to get the next in sequence number.

Args:
None.
Returns:
None.
Raises:
Exception: Raises exception when error occours.
logDumpMessageStore()

This function is used to dump a copy of messages into the logs.

Args:
None.
Returns:
None.
Raises:
Exception: Raises exception when error occours.
receiveMessage(*args)

Receive FIX message from the FIX connection.

Args:
*args(vargs): FIX message is a variable argument which is mentioned
either as a message template name in the message template dictionary or as a message type name and message string.
Returns:
Message: Returns fix message which is received.
Raises:
Exception: Raises exception when error occours.
sendMessage(*args)

Send FIX message to the FIX connection.

Args:
*args(vargs): FIX message is a variable argument which is mentioned
either as a message template name in the message template dictionary or as a message type name and message string.
Returns:
Message: Returns fix message which is received.
Raises:
Exception: Raises exception when error occours.
setNextSenderMsgSeqNum(senderSeqNo)

This function is used to set the next out sequence number.

Args:
senderSeqNo(int): Out sequence number to set.
Returns:
None.
Raises:
Exception: Raises exception when error occours.
setNextTargetMsgSeqNum(targetSeqNo)

This function is used to set the next expected in sequence number.

Args:
targetSeqNo(int): In sequence number to set.
Returns:
None.
Raises:
Exception: Raises exception when error occours.
startAcceptor(conn_name)

Starts acceptor for a given connection name.

Args:
conn_name(str): FIX connection name.
Returns:
bool: The return value. True for success, False otherwise
Raises:
Exception: Raises exception when error occours.
startFIXRobot(conn_name, instanceType)

Starts a fix connection for a specified connection name and type of instance as initiator or acceptor.

Args:
conn_name(str): FIX connection name. instanceType(str): Type of the instance as initiator or acceptor.
Returns:
bool: The return value. True for success, False otherwise
Raises:
Exception: Raises exception when error occours.
startInitiator(conn_name)

Starts initiator for a given connection name.

Args:
conn_name(str): FIX connection name.
Returns:
bool: The return value. True for success, False otherwise
Raises:
Exception: Raises exception when error occours.
stopAcceptor()

Stops acceptor for a given connection name.

Args:
None.
Returns:
None.
Raises:
Exception: Raises exception when error occours.
stopInitiator()

Stops initiator for a given connection name.

Args:
None.
Returns:
None.
Raises:
Exception: Raises exception when error occours.
class FIXRobot.FIXRobot.FIXRobotProcessor

Bases: quickfix.Application

ROBOT_LIBRARY_SCOPE = 'TEST SUITE'
checkMessagePart(fixMessage, defaultApplVerID, fixGroupNumField, fixVersionEvalString, expectedFIXRobotMessageName, fixMessageString)

This function is used to compare an actual FIX message against the expected FIX message. The tag value comparison results are written to the log file and returns the status of comparison.

Args:
fixMessage(Message): Actual FIX message object to be compared. defaultApplVerID(str): FIX Application version FIX4.2, FIX5.0 etc.. fixGroupNumField(Group): Nested group name inside a FIX message object. fixVersionEvalString(str): FIX version FIX4.2, FIXT1.1 etc.. expectedFIXRobotMessageName(str): FIX message name. fixMessageString(str): Expected FIX message in string template format
Returns:
bool: Returns True if difference is found during comparison of actual and expected FIX messages and False otherwise.
Raises:
Exception: Raises exception when error occours.
clearMessageStore()

This function is used to clear the message store.

Args:
None.
Returns:
None.
Raises:
Exception: Raises exception when error occours.
execID = 0
fromAdmin(message, sessionID)

This is a callback function from quickfix library which is called when an admin message is sent.

Args:
message(Message): Sent admin FIX message object. sessionID(SessionId): FIX connection session object.
Returns:
None.
Raises:
None.
fromApp(message, sessionID)

This is a callback function from quickfix library which is called when an application message is sent.

Args:
message(Message): Received application FIX message object. sessionID(SessionId): FIX connection session object.
Returns:
None.
Raises:
None.
getExpectedSenderNum()

This function is used to get the next out sequence number.

Args:
None.
Returns:
None.
Raises:
Exception: Raises exception when error occours.
getExpectedTargetNum()

This function is used to get the next in sequence number.

Args:
None.
Returns:
None.
Raises:
Exception: Raises exception when error occours.
incomingFIXRobotMessage = None
logDumpMessageStore()

This function is used to dump a copy of messages into the logs.

Args:
None.
Returns:
None.
Raises:
Exception: Raises exception when error occours.
onCreate(sessionID)

This is a callback function from quickfix library which is called in the event of creation of a new fix connection.

Args:
sessionID(SessionId): FIX connection session object.
Returns:
None.
Raises:
None.
onLogon(sessionID)

This is a callback function from quickfix library which is called in the event of logon by the fix connection.

Args:
sessionID(SessionId): FIX connection session object.
Returns:
None.
Raises:
None.
onLogout(sessionID)

This is a callback function from quickfix library which is called in the event of logout by the fix connection.

Args:
sessionID(SessionId): FIX connection session object.
Returns:
None.
Raises:
None.
orderID = 0
presetFIXRobotMessage(presetMessage)

This function is used to set a preset message and can be used for a any future purpose.

Args:
presetMessage(str): Preset a message string.
Returns:
None.
Raises:
None.
receiveFIXRobotMessage(defaultAdminVerID, defaultApplVerID, *args)

This function is used to receive the FIX message.

Args:

defaultAdminVerID(str): FIX admin version FIX4.2, FIXT1.1 etc.. defaultApplVerID(str): FIX application version FIX4.2, FIX5.0 etc.. *args(vargs): FIX message is a variable argument which is mentioned

either as a message template name in the message template dictionary or as a message type name and message string.
Returns:
Message: Returns fix message which is received.
Raises:
Exception: Raises exception when error occours.
sendFIXRobotMessage(defaultAdminVerID, defaultApplVerID, *args)

This function is used to send the FIX message.

Args:

defaultAdminVerID(str): FIX admin version FIX4.2, FIXT1.1 etc.. defaultApplVerID(str): FIX application version FIX4.2, FIX5.0 etc.. *args(vargs): FIX message is a variable argument which is mentioned

either as a message template name in the message template dictionary or as a message type name and message string.
Returns:
Message: Returns fix message which is sent.
Raises:
Exception: Raises exception when error occours.
sessID = None
setMessagePart(fixMessage, defaultApplVerID, incomingFIXRobotMessage, outgoingFIXRobotMessage, fixMessageString)

This function is used to create a FIX message object to send from a FIX message template string and using previous incoming and outgoing FIX messages.

Args:
fixMessage(Message): FIX message object created by setting its tag values to send. defaultApplVerID(str): Application version FIX4.2, FIX5.0 etc.. incomingFIXRobotMessage(Message): To use values from incoming message to create a new FIX message to send. outgoingFIXRobotMessage(Message): To use values from outgoing message to create a new FIX message to send. fixMessageString(str): FIX message template to create a new FIX message to send.
Returns:
Message: Returns FIX message object.
Raises:
Exception: Raises exception when error occours.
setNextSenderMsgSeqNum(senderSeqNo)

This function is used to set the next out sequence number.

Args:
senderSeqNo(int): Out sequence number to set.
Returns:
None.
Raises:
Exception: Raises exception when error occours.
setNextTargetMsgSeqNum(targetSeqNo)

This function is used to set the next expected in sequence number.

Args:
targetSeqNo(int): In sequence number to set.
Returns:
None.
Raises:
Exception: Raises exception when error occours.
toAdmin(message, sessionID)

This is a callback function from quickfix library which is called when an admin message is received.

Args:
message(Message): Received admin FIX message object. sessionID(SessionId): FIX connection session object.
Returns:
None.
Raises:
None.
toApp(message, sessionID)

This is a callback function from quickfix library which is called when an application message is received.

Args:
message(Message): Received application FIX message object. sessionID(SessionId): FIX connection session object.
Returns:
None.
Raises:
None.
FIXRobot.FIXRobot.getId(inputStr)

Module contents