org.safs

Class SAFSPlus.Logging

java.lang.Object

org.safs.SAFSPlus.Logging

Direct Known Subclasses:

SeleniumPlus.Logging

Enclosing class:

SAFSPlus

public static class SAFSPlus.Logging
extends java.lang.Object

Wrapper class providing APIs to handle Logging keywords, like LogMessage, LogTestWarning etc.

Constructor Summary

Constructors

Constructor and Description
Logging()

Method Summary

Modifier and Type	Method and Description
static boolean	LogFailureOK(java.lang.String message, java.lang.String... details) Log a special "FAILED OK" message indicating one or more subsequent failures are EXPECTED.
static boolean	LogMessage(java.lang.String message, java.lang.String... details) Log a generic (non-test) message.
static boolean	LogTestFailure(java.lang.String message, java.lang.String... details) Log a test FAILURE message.
static boolean	LogTestSuccess(java.lang.String message, java.lang.String... details) Log a test SUCCESS message.
static boolean	LogTestWarning(java.lang.String message, java.lang.String... details) Log a test WARNING message.
static boolean	LogWarningOK(java.lang.String message, java.lang.String... details) Log a special "WARN OK" message indicating one or more subsequent warnings are EXPECTED.
static boolean	ResumeLogging() Resume all logging output.
static boolean	SetLogAllInfoMode() Set the Log facilities LOG_LEVEL to log all INFO, WARNINGS, and FAILURES.
static boolean	SetLogFailuresOnlyMode() Set the Log facilities LOG_LEVEL to log FAILURES only.
static boolean	SetLogWarningsAndFailuresMode() Set the Log facilities LOG_LEVEL to log WARNINGS and FAILURES only.
static boolean	SuspendLogging() Suspend all logging output.

Methods inherited from class java.lang.Object

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

Constructor Detail

Logging

public Logging()

Method Detail

SetLogWarningsAndFailuresMode

public static boolean SetLogWarningsAndFailuresMode()

Set the Log facilities LOG_LEVEL to log WARNINGS and FAILURES only.

Returns:

true if no known errors occurred.

SetLogFailuresOnlyMode

public static boolean SetLogFailuresOnlyMode()

Set the Log facilities LOG_LEVEL to log FAILURES only.

Returns:

true if no known errors occurred.

SetLogAllInfoMode

public static boolean SetLogAllInfoMode()

Set the Log facilities LOG_LEVEL to log all INFO, WARNINGS, and FAILURES.

Returns:

true if no known errors occurred.

LogFailureOK

public static boolean LogFailureOK(java.lang.String message,
                                   java.lang.String... details)

Log a special "FAILED OK" message indicating one or more subsequent failures are EXPECTED.

Parameters:

message - -- the message indicating one or more subsequent failures should be expected.

details - -- optional -- any additional (String) details or supporting information.

Returns:

true if successful, false otherwise.

See Also:

SAFSPlus.prevResults, TestRecordData.getStatusCode(),

Example:

 
 boolean success = Logging.LogFailureOK("The following 2 tests should fail due to bad parameters.");
 boolean success = Logging.LogFailureOK("The Login should fail.", "The userID and password are bogus.");
 
 

LogWarningOK

public static boolean LogWarningOK(java.lang.String message,
                                   java.lang.String... details)

Log a special "WARN OK" message indicating one or more subsequent warnings are EXPECTED.

Parameters:

message - -- the message indicating one or more subsequent warnings should be expected.

details - -- optional -- any additional (String) details or supporting information.

Returns:

true if successful, false otherwise.

See Also:

SAFSPlus.prevResults, TestRecordData.getStatusCode(),

Example:

 
 boolean success = Logging.LogWarningOK("The following 2 tests will produce expected warnings.");
 boolean success = Logging.LogWarningOK("The following test warning is expected.", "The optional item is not correct.");
 
 

LogTestFailure

public static boolean LogTestFailure(java.lang.String message,
                                     java.lang.String... details)

Log a test FAILURE message. Also increments TEST FAILURE counts on any active counters.

Parameters:

message - -- the simple failure message to log.

details - -- optional -- any additional (String) details or supporting information.

Returns:

true if successful, false otherwise.

See Also:

SAFSPlus.prevResults, TestRecordData.getStatusCode(),

Example:

 
 boolean success = Logging.LogTestFailure("The Login Window was NOT found.");
 boolean success = Logging.LogTestFailure("The Login Window was NOT found.", "The Login Window MUST be issued at this time.");
 
 

LogTestSuccess

public static boolean LogTestSuccess(java.lang.String message,
                                     java.lang.String... details)

Log a test SUCCESS message. Also increments TEST PASS counts on any active counters.

Parameters:

message - -- the simple success message to log.

details - -- optional -- any additional (String) details or supporting information.

Returns:

true if successful, false otherwise.

See Also:

SAFSPlus.prevResults, TestRecordData.getStatusCode(),

Example:

 
 boolean success = Logging.LogTestSuccess("The Login Window was found.");
 boolean success = Logging.LogTestSuccess("The Login Window was found.", "The Login Window MUST be issued at this time.");
 
 

LogTestWarning

public static boolean LogTestWarning(java.lang.String message,
                                     java.lang.String... details)

Log a test WARNING message. Also increments TEST WARNING counts on any active counters.

Parameters:

message - -- the simple warning message to log.

details - -- optional -- any additional (String) details or supporting information.

Returns:

true if successful, false otherwise.

See Also:

SAFSPlus.prevResults, TestRecordData.getStatusCode(),

Example:

 
 boolean success = Logging.LogTestWarning("The Login Window was not found.");
 boolean success = Logging.LogTestWarning("The Login Window was not found.", "The Login Window might not be issued if already logged in.");
 
 

LogMessage

public static boolean LogMessage(java.lang.String message,
                                 java.lang.String... details)

Log a generic (non-test) message.

Parameters:

message - -- the generic message to log.

details - -- optional -- any additional (String) details or supporting information.

Returns:

true if successful, false otherwise.

See Also:

SAFSPlus.prevResults, TestRecordData.getStatusCode(),

Example:

 
 boolean success = Logging.LogMessage("An interesting thing happened just now!");
 success = Logging.LogMessage("It was so interesting!", "The image we captured is bigger than we expected.");
 
 

SuspendLogging

public static boolean SuspendLogging()

Suspend all logging output.

Returns:

true if successful, false otherwise.

See Also:

SAFSPlus.prevResults, TestRecordData.getStatusCode(),

Example:

 
 boolean success = Logging.SuspendLogging();
 ....(do some stuff that you don't want logged or counted.)
 success = Logging.ResumeLogging();
 
 

ResumeLogging

public static boolean ResumeLogging()

Resume all logging output.

Returns:

true if successful, false otherwise.

See Also:

SAFSPlus.prevResults, TestRecordData.getStatusCode(),

Example:

 
 boolean success = Logging.SuspendLogging();
 ....(do some stuff that you don't want logged or counted.)
 success = Logging.ResumeLogging();