DDDriverLogCommands

Last Updated:

Driver Commands for Logging

This keyword library provides Driver Commands that can be used by all three DDE Drivers--CycleDriver, SuiteDriver, and StepDriver. That means they can be used in any keyword driven test tables regardless of the test tables level--Cycle, Suite, or Step.

Each different driver command has different parameters as described in its documentation. For reference, the first fields of ALL Driver Command test records are defined below:

Field #1
The "C" = DRIVER COMMAND record type specifier.
Field #2
The Driver Command keyword.

Example:

c , SetApplicationMap , "AppMap.map"

Driver Command parameters must be placed in the test record in the field position specified in the documentation. Some parameters are optional. However, the field associated with that parameter must be honored. If you wish to skip an optional parameter you must still provide an empty field for that parameter.

Example:

c, LaunchApplication, NOTEPAD, NOTEPAD.EXE, , , "AppMap.map"

The above example shows two optional fields after NOTEPAD.EXE which are given no value(skipped).

Note that the full availablility of all Driver Commands is now spread across several files. Together, all of these files provide all the Driver Commands available to the core framework.

DDDriverCommands
Miscellaneous and often used Commands.
DDDriverLogCommands
Commands focused on logging test execution.
DDDriverFlowCommands
Commands focused on Error Recovery and Flow Control.
DDDriverCounterCommands
Commands focused on status tracking.
DDDriverDeprecatedCommands
Commands that are still provided for backward compatibility, but are no longer supported.
DDDriverDebugCommands
Commands focused on debugging test execution.


[How To Read This Reference]
LogFailureOK
RC WR TID
Log an EXPECTED failure message.
LogMessage
RC WR TID SE2
Log a generic message
LogTestFailure
RC WR TID SE2
Log a FAILURE message. Also increments appropriate counters.
LogTestSuccess
RC WR TID SE2
Log a SUCCESS/OK message. Also increments appropriate counters.
LogTestWarning
RC WR TID SE2
Log a WARNING message. Also increments appropriate counters.
LogWarningOK
RC WR TID
Log an EXPECTED WARNING message.
ResumeLogging
RC TID SE2
Resume suspended logging.
SuspendLogging
RC TID SE2
Suspend all logging.

DDDriverLogCommands::LogFailureOK
RC WR TID

Log an EXPECTED failure message.

Log that a failure was expected and, as such, is OK.
You can optionally add an additional details description that follows the message.

Fields: [ ]=Optional with Default Value
  1. Message
    The message to log.


  2. [ Details = ]
    Additional detail to add to the message.


Examples:
[How To Read This Reference]

DDDriverLogCommands::LogMessage
RC WR TID SE2

Log a generic message

Log a generic message. You can optionally add an additional details description that follows the message.

Fields: [ ]=Optional with Default Value
  1. Message
    The message to log.


  2. [ Details = ]
    Additional detail to add to the message.


Examples:
[How To Read This Reference]

DDDriverLogCommands::LogTestFailure
RC WR TID SE2

Log a FAILURE message. Also increments appropriate counters.

Log a FAILURE message. Also increments appropriate counters.
You can optionally add an additional details description that follows the message.

Fields: [ ]=Optional with Default Value
  1. Message
    The message to log.


  2. [ Details = ]
    Additional detail to add to the message.


Examples:
[How To Read This Reference]

DDDriverLogCommands::LogTestSuccess
RC WR TID SE2

Log a SUCCESS/OK message. Also increments appropriate counters.

Log a SUCCESS/OK message. Also increments appropriate counters.
You can optionally add an additional details description that follows the message.

Fields: [ ]=Optional with Default Value
  1. Message
    The message to log.


  2. [ Details = ]
    Additional detail to add to the message.


Examples:
[How To Read This Reference]

DDDriverLogCommands::LogTestWarning
RC WR TID SE2

Log a WARNING message. Also increments appropriate counters.

Log a WARNING message. Also increments appropriate counters.
You can optionally add an additional details description that follows the message.

Fields: [ ]=Optional with Default Value
  1. Message
    The message to log.


  2. [ Details = ]
    Additional detail to add to the message.


Examples:
[How To Read This Reference]

DDDriverLogCommands::LogWarningOK
RC WR TID

Log an EXPECTED WARNING message.

Log that a WARNING was expected and, as such, is OK.
You can optionally add an additional details description that follows the message.

Fields: [ ]=Optional with Default Value
  1. Message
    The message to log.


  2. [ Details = ]
    Additional detail to add to the message.


Examples:
[How To Read This Reference]

DDDriverLogCommands::ResumeLogging
RC TID SE2

Resume suspended logging.


Fields: [ ]=Optional with Default Value
  1. [ logName = ]
    The name of a Log Facility, other than the "current" one, to resume.

    Normally, this parameter would NOT be specified, and thus ALL logging would be resumed. However, there may be the case that a test is using multiple different logs and the tester is trying to resume a specific one.

Examples:
  • C, ResumeLogging
    Resumes all suspended logging.


  • C, ResumeLogging, MainLog
    Resume only the log opened as "MainLog".


[How To Read This Reference]

DDDriverLogCommands::SuspendLogging
RC TID SE2

Suspend all logging.


Fields: [ ]=Optional with Default Value
  1. [ logName = ]
    The name of a Log Facility if other than the "current" one.

    Normally, this parameter would NOT be specified, and thus ALL logging would be suspended. However, there may be the case that a test is using multiple different logs and the tester is trying to suspend a specific one.

Examples:
  • C, SuspendLogging
    Suspend all logging.


  • C, SuspendLogging, MainLog
    Suspend only the log opened as "MainLog".


[How To Read This Reference]