org.safs

Class SAFSPlus.Counters

java.lang.Object

org.safs.SAFSPlus.Counters

Direct Known Subclasses:

SeleniumPlus.Counters

Enclosing class:

SAFSPlus

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

Wrapper class providing APIs to handle DriverCounter keywords, like StartTestSuite, StartCounter, LogCounterInfo etc.
It also provides:
some convenient APIs, like PrintTestCaseSummary(String), PrintTestSuiteSummary(String) etc. by using combination of DriverCounter keywords.
CountStatusInterface instance ( GetCounterStatus(String) ) through the underlying JSAFS

Constructor Summary

Constructors

Constructor and Description
Counters()

Method Summary

Modifier and Type	Method and Description
static CountStatusInterface	GetCounterStatus(java.lang.String counterId) Retrieve all the information stored for a particular Counter.
static void	IncrementCounts(boolean passed) Increment test counters as appropriate.
static boolean	LogCounterInfo(java.lang.String counterId) Log the counter info (counts) for a specific counter.
static boolean	PrintTestCaseSummary(java.lang.String tcname) Stop capturing test activity counts for a specific application feature or test-case if it is still active, then print a summary report of all tests counted, passed, failed, and skipped, etc...
static boolean	PrintTestSuiteSummary(java.lang.String suitename) Stop capturing test activity counts for the overall suite of tests if it is still active, then print a summary report of all counted, passed, failed, and skipped tests etc...
static boolean	ResumeCounts(java.lang.String... reason) Resume counting on all active counters.
static boolean	StartCounter(java.lang.String counterId, java.lang.String... details) (Re)Start/Create an active tester-defined counter.
static boolean	StartTestCase(java.lang.String tcname) Start capturing test activity counts for a specific application feature or test-case.
static boolean	StartTestCycle(java.lang.String cyclename) Start capturing test activity counts for the named test cycle.
static boolean	StartTestSuite(java.lang.String suitename) Start capturing test activity counts for the named test suite.
static boolean	StopCounter(java.lang.String counterId, java.lang.String... details) Stop/Create a suspended tester-defined counter.
static boolean	StopTestCase(java.lang.String tcname) Stop capturing test activity counts for a specific application feature or test-case.
static boolean	StopTestCycle(java.lang.String cyclename) Stop capturing test activity counts for a specific application feature or test-cycle.
static boolean	StopTestSuite(java.lang.String suitename) Stop capturing test activity counts for a specific application feature or test-suite.
static boolean	StoreCounterInfo(java.lang.String counterId, java.lang.String varPrefix) Store the counter info (counts) for a specific counter into a DDVariable array.
static boolean	SuspendCounts(java.lang.String... reason) Suspend counting on all active counters.

Methods inherited from class java.lang.Object

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

Constructor Detail

Counters

public Counters()

Method Detail

PrintTestCaseSummary

public static boolean PrintTestCaseSummary(java.lang.String tcname)

Stop capturing test activity counts for a specific application feature or test-case if it is still active, then print a summary report of all tests counted, passed, failed, and skipped, etc...

Parameters:

tcname - The name of the test-case to start using a Counter on. The name must match a counter that was previously started.

Returns:

false only if a failure of some kind was reported in attempting to stop the counter or print the summary report into the log.

Sets prevResults TestRecordHelper to the results received or null if an error occurred.

See Also:

SAFSPlus.prevResults, StartTestCase(String)

PrintTestSuiteSummary

public static boolean PrintTestSuiteSummary(java.lang.String suitename)

Stop capturing test activity counts for the overall suite of tests if it is still active, then print a summary report of all counted, passed, failed, and skipped tests etc...

Parameters:

suitename - The name of the suite to stop (if still running) and process. The name must match a counter that was previously started.

Returns:

false only if a failure of some kind was reported in attempting to stop the counter or print the summary report into the log.

Sets prevResults TestRecordHelper to the results received or null if an error occurred.

See Also:

SAFSPlus.prevResults

IncrementCounts

public static void IncrementCounts(boolean passed)

Increment test counters as appropriate.

Parameters:

passed - true increments test successes, false increments test failures.

GetCounterStatus

public static CountStatusInterface GetCounterStatus(java.lang.String counterId)

Retrieve all the information stored for a particular Counter.

Parameters:

counterId - - the unique String ID of the counter to retrieve.

Returns:

CounterStatusInterface for the specified counter, or null if it does not exist.

StartCounter

public static boolean StartCounter(java.lang.String counterId,
                                   java.lang.String... details)

(Re)Start/Create an active tester-defined counter. Detailed Reference

Parameters:

counterId - -- the unique Id of the counter.

details - -- optional -- any additional (String) details or description of the counter to be logged.

Returns:

true if successful, false otherwise.

See Also:

SAFSPlus.prevResults, TestRecordData.getStatusCode(),

Example:

 
 boolean success = Counters.StartCounter(FEATURE_TEST_COUNTER, "Tracking all test records for this feature");
 ....(do some testing)
 success = Counters.StopCounter(FEATURE_TEST_COUNTER, "Testing for this feature is finished.");
 
 

StartTestCycle

public static boolean StartTestCycle(java.lang.String cyclename)

Start capturing test activity counts for the named test cycle.

Parameters:

cyclename - The name of the cycle counter to start.

Returns:

false only if a failure of some kind was reported in attempting to start the counter.

Sets prevResults TestRecordHelper to the results received or null if an error occurred.

See Also:

SAFSPlus.prevResults, TestRecordData.getStatusCode(), TestRecordData.getStatusInfo()

StartTestSuite

public static boolean StartTestSuite(java.lang.String suitename)

Start capturing test activity counts for the named test suite.

Parameters:

suitename - The name of the suite counter to start.

Returns:

false only if a failure of some kind was reported in attempting to start the counter.

Sets prevResults TestRecordHelper to the results received or null if an error occurred.

See Also:

SAFSPlus.prevResults, TestRecordData.getStatusCode(), TestRecordData.getStatusInfo()

StartTestCase

public static boolean StartTestCase(java.lang.String tcname)

Start capturing test activity counts for a specific application feature or test-case.

Parameters:

tcname - The name of the test-case to start using a Counter on.

Returns:

false only if a failure of some kind was reported in attempting to start the counter.

Sets prevResults TestRecordHelper to the results received or null if an error occurred.

See Also:

SAFSPlus.prevResults, TestRecordData.getStatusCode(), TestRecordData.getStatusInfo()

StopCounter

public static boolean StopCounter(java.lang.String counterId,
                                  java.lang.String... details)

Stop/Create a suspended tester-defined counter. Detailed Reference

Parameters:

counterId - -- the unique Id of the counter.

details - -- optional -- any additional (String) details or description of the counter to be logged.

Returns:

true if successful, false otherwise.

See Also:

SAFSPlus.prevResults, TestRecordData.getStatusCode(),

Example:

 
 boolean success = Counters.StartCounter(FEATURE_TEST_COUNTER, "Tracking all test records for this feature");
 ....(do some testing)
 success = Counters.StopCounter(FEATURE_TEST_COUNTER, "Testing for this feature is finished.");
 
 

StopTestCycle

public static boolean StopTestCycle(java.lang.String cyclename)

Stop capturing test activity counts for a specific application feature or test-cycle.

Parameters:

cyclename - The name of the test-cycle to stop. The name must match a counter that was previously started.

Returns:

false only if a failure of some kind was reported in attempting to stop the counter.

Sets prevResults TestRecordHelper to the results received or null if an error occurred.

See Also:

SAFSPlus.prevResults, StartTestCase(String), PrintTestCaseSummary(String)

StopTestSuite

public static boolean StopTestSuite(java.lang.String suitename)

Stop capturing test activity counts for a specific application feature or test-suite.

Parameters:

suitename - The name of the test-suite to stop. The name must match a counter that was previously started.

Returns:

false only if a failure of some kind was reported in attempting to stop the counter.

Sets prevResults TestRecordHelper to the results received or null if an error occurred.

See Also:

SAFSPlus.prevResults, StartTestCase(String), PrintTestCaseSummary(String)

StopTestCase

public static boolean StopTestCase(java.lang.String tcname)

Stop capturing test activity counts for a specific application feature or test-case.

Parameters:

tcname - The name of the test-case to stop. The name must match a counter that was previously started.

Returns:

false only if a failure of some kind was reported in attempting to stop the counter.

Sets prevResults TestRecordHelper to the results received or null if an error occurred.

See Also:

SAFSPlus.prevResults, StartTestCase(String), PrintTestCaseSummary(String)

SuspendCounts

public static boolean SuspendCounts(java.lang.String... reason)

Suspend counting on all active counters. Detailed Reference

Parameters:

reason - -- optional -- any additional (String) details or reason for the suspension to be logged.

Returns:

true on success, false otherwise.

See Also:

SAFSPlus.prevResults, TestRecordData.getStatusCode(),

Example:

 
 boolean success = Counters.StartCounter(FUNCTIONAL_TEST_COUNTER, "Tracking all test records for Functional Testing");
 ....(do some testing)
 success = Counters.SuspendCounts("Scenario preparation commencing.");
 ....(do some things you don't want logged or corrupting counters.)
 success = Counters.ResumeCounts("Scenario preparation complete.");
 
 

ResumeCounts

public static boolean ResumeCounts(java.lang.String... reason)

Resume counting on all active counters. Counters previously stopped with StopCounter will remain stopped. Detailed Reference

Parameters:

reason - -- optional -- any additional (String) details to be logged.

Returns:

true if successful, false otherwise.

See Also:

SAFSPlus.prevResults, TestRecordData.getStatusCode(),

Example:

 
 boolean success = Counters.StartCounter(FUNCTIONAL_TEST_COUNTER, "Tracking all test records for Functional Testing");
 ....(do some testing)
 success = Counters.SuspendCounts("Scenario preparation commencing.");
 ....(do some things you don't want logged or corrupting counters.)
 success = Counters.ResumeCounts("Scenario preparation complete.");
 
 

LogCounterInfo

public static boolean LogCounterInfo(java.lang.String counterId)

Log the counter info (counts) for a specific counter. Detailed Reference

Parameters:

counterId - -- the unique Id of the counter.

Returns:

true if successful, false otherwise.

See Also:

SAFSPlus.prevResults, TestRecordData.getStatusCode(),

Example:

 
 boolean success = Counters.StartCounter(FUNCTIONAL_TEST_COUNTER, "Tracking all test records for Functional Testing");
 ....(do your testing, then log a snapshot/final statistics)
 success = Counters.LogCounterInfo(FUNCTIONAL_TEST_COUNTER);
 
 

StoreCounterInfo

public static boolean StoreCounterInfo(java.lang.String counterId,
                                       java.lang.String varPrefix)

Store the counter info (counts) for a specific counter into a DDVariable array. Detailed Reference

Parameters:

counterId - -- the unique Id of the counter.

varPrefix - -- the unique root name for a list of DDVariables to hold the counter info.

Returns:

true if successfully executed, false otherwise.

See Also:

SAFSPlus.GetVariableValue(String), SAFSPlus.prevResults, TestRecordData.getStatusCode(),

Example:

        
        boolean success = Counters.StartCounter(FUNCTIONAL_TEST_COUNTER, "Tracking all functional test records.");
        ...(do some testing, then check counter status)
        success = Counters.StoreCounterInfo(FUNCTIONAL_TEST_COUNTER, VAR_TEST);
        if(success){
            int passes   = Integer.parseInt(GetVariableValue(VAR_TEST+".test_passes"));
            int failures = Integer.parseInt(GetVariableValue(VAR_TEST+".test_failures"));
            int tests    = Integer.parseInt(GetVariableValue(VAR_TEST+".test_records"));
        }