Overview Package Class Deprecated Help

sas
TestSuite

The test suite is the binding of a sas.TestPolicy and a tested object, such as a vpls.Vpls, and a set of individual tests, that together defines the rules used to generate and execute tests.

A test suite is divided into 3 sets of the tests:

This structure allows a test suite to execute complex testing that combines specific manual tests with generated tests. For example, the typical MAC learning test for a VPLS service would be:
  1. First Group: MAC Populate a specific MAC address on a specific site
  2. Policy: A set of generated tests that tests for the specific MAC address on all sites of a VPLS service
  3. Last Group: MAC purge the specific MAC address from the specific site.

Test suites may be scheduled, either by NFM-P or by the node (see sas.TestSuite.neSchedulable).

public class TestSuite

Properties
accountingFiles Specifies whether this test suite uses SAA Accounting

type=boolean
default=false
Displayed(tab/group)=Accounting Files (/Test Results)
application Specifies which application this test suite is using. It could be "STM" or "CPAM".

type=sas.Application
access=read-only
default=stm
Displayed(tab/group)=Application
applicationId Specifies which application created this test suite.

type=string
access=read-create
default=NFM-P
maximum=20
contExecution Specifies whether this test suite could be continuously executed by the node

type=boolean
default=false
Displayed(tab/group)=Continuously Executed (/Test Results)
contextFdns The list of SAPs/Sites used by OAM Context Creation.

type=Set (Pointer)
access=read-only
contextType Specifies the selected object type for context based test generation.

type=sas.OAMContextType
default=sap
continuously Specifies whether this test suite is currently being continuously executed by the node.

type=boolean
access=read-only
default=false
firstGroupExecutionSequence Specifies the order in which to execute any contained tests from the first group.

type=sas.ExecutionSequence
default=parallel
Displayed(tab/group)=First Run Execution Sequence (/Execution)
ignoreResults default="yes:false"> Specifies whether this test suite is used as an SLA tool.This value is deprecated in 10.0R1 and use probeHistory sas.TestDefinition.probeHistory instead.

DEPRECATED: 10.0 R1 - use probeHistory instead
type=boolean
lastGeneratedTime Date (time from January 1st, 1970) when test generation was last executed.

type=Date
access=read-only
default=0
Displayed(tab/group)=Last Generation
lastGroupExecutionSequence Specifies the order in which to execute any contained tests from the last group.

type=sas.ExecutionSequence
default=parallel
Displayed(tab/group)=Last Run Execution Sequence (/Execution)
latestAccountingResult

type=string
access=read-only
latestAccountingResultId Represent the mdbid of the test suite result structure.

type=long
mefMode Specifies sas test suite is supported for Performance monitoring or not.

type=boolean
default=false
Displayed(tab/group)=MEF35 Mode
neSchedulable Specifies whether this test suite is schedulable via NFM-P or the node. The associated sas.TestPolicy objects must have the same value for the neSchedulable flag.

type=boolean
access=read-create
default=false
Displayed(tab/group)=NE Schedulable
oneTimeValidate Specifies whether this is a "one time validation" test policy.

type=boolean
access=read-only
default=false
Displayed(tab/group)=One Time Validation
runFromContext Specifies whether this test suite is created from OAM Context.

type=boolean
access=read-only
default=false
Displayed(tab/group)=OAM Context Enabled
saaNeScheduleTaskScriptLocation The script used by SAA scheduled task.

type=string
access=read-only
default=
maximum=356
sas.GeneratedArtifacts-Set type=Children-Set
sas.GenerationLog-Set type=Children-Set
sas.TestBinding-Set type=Children-Set
sas.TestPolicyUsage-Set type=Children-Set
sas.TestedEntity-Set type=Children-Set
sasValidator Specifies whether this test suite is used as a validator of its own Tested Entities.

type=boolean
default=false
Displayed(tab/group)=Validation Test Suite
schedule The schedule, if any, that specifies when the test suite executes.

type=Pointer
access=read-only
default=
Displayed(tab/group)=Schedule (Schedule)
scheduleTask The schedule task, if any, that specifies the binding between the test suite and the schedule.

type=Pointer
access=read-only
default=
Displayed(tab/group)=Scheduled Task (Schedule)
sessionType

type=sas.TestSuiteSessionType
access=read-only
default=proactive
Displayed(tab/group)=Session Type (/Session Configuration)
sla default="yes:false"> Specifies whether this test suite is used as an SLA tool.This value is deprecated in 10.0R1 and use probeHistory sas.TestDefinition.probeHistory instead.

DEPRECATED: 10.0 R1 - use probeHistory instead
type=boolean
spanObjectPointer A pointer to the parent spanEnabled object.

type=string
access=read-only
default=
minimum=0
maximum=252
testGeneration Indicates the current status of Test generation for the entity.

type=sas.GenerationState
access=read-only
default=notGenerating
Displayed(tab/group)=Generation State
testResultStorage This value specifies whether or not the OAM NE Schedulable test results are to be logged to a file, stored in the DB, or both

type=sas.TestResultStorageEnum
default=logToDB
Displayed(tab/group)=Test Result Storage (/Test Results)
testedEntityType Defines the type of the type of objects allowed in this test suite.

type=sas.TestedEntityType
access=read-create
default=vll
Displayed(tab/group)=Entity Type
timeout Specifies the number of minutes to wait for the test suite completion

type=int
default=15
minimum=1
maximum=600
units=minutes
Displayed(tab/group)=Timeout
 
Overridden Properties
id The identifier for the STM test.

maximum=268435455
 
Properties inherited from sas.TestAggregation
nmUser
 
Properties inherited from sas.AbstractTest
administrativeState, description, displayedName, failures, globalId, id, lastRunResult, runs, weight
 
Properties inherited from ManagedObject
actionMask, children-Set, deploymentState, isFaultSquelched, name, objectFullName, selfAlarmed
 
Methods

addTest

Ensures that the given test is part of this test suite. If the test is already part of this suite, nothing changes. Otherwise, the test is added to the suite (at the end of the execution order) for the given testGroupRole.

An exception is thrown if the test part of another test aggregation.

Input Parameters:
deployer : Deployer - the deployment state
synchronousDeploy : boolean - (Optional) Specify whether to block until the changes have been fully deployed to the network. A value of "true" means to block. A value of "false" means to return immediately. Default: false (asynchronous)
clearOnDeployFailure : boolean - (Optional) Specify whether to clear any failed deployers. A value of "true" means to clear. A value of "false" means to leave the failed deployer. Default: false
deployRetries : int - (Optional) The number of times to attempt re-deployment during synchronous deployment. This parameter is meaningless in the asynchronous case. Default: 0
deployRetryInterval : long - (Optional) The number of milliseconds to wait between deployment retries. This parameter is meaningless in the asynchronous case. Default: 0
taskDescription : string - (Optional) A user friendly description of what the operation does. This information will be used by the task manager.
instanceFullName : string - the full name of the object.
testGroupRole : sas.TestGroupRole - The test group to which to add this test.
test : Pointer - The pointer to the test to add.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Exceptions:
sas.TestSuite.addTestException

addTestedEntities

Adds the tested entities (e.g. services, service tunnels, ...) to this test suite.
Input Parameters:
deployer : Deployer - the deployment state
synchronousDeploy : boolean - (Optional) Specify whether to block until the changes have been fully deployed to the network. A value of "true" means to block. A value of "false" means to return immediately. Default: false (asynchronous)
clearOnDeployFailure : boolean - (Optional) Specify whether to clear any failed deployers. A value of "true" means to clear. A value of "false" means to leave the failed deployer. Default: false
deployRetries : int - (Optional) The number of times to attempt re-deployment during synchronous deployment. This parameter is meaningless in the asynchronous case. Default: 0
deployRetryInterval : long - (Optional) The number of milliseconds to wait between deployment retries. This parameter is meaningless in the asynchronous case. Default: 0
taskDescription : string - (Optional) A user friendly description of what the operation does. This information will be used by the task manager.
instanceFullName : string - the full name of the object.
testedEntities : Set (Pointer) - A set of tested entity pointers to add.
generateTests : boolean - Whether to generate tests for each tested entity that is added. If 'true' the tests for newly added tested entities will be generated.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false

addTests

Ensures that the given tests are part of this test suite. If a test is already part of this suite, it is not added again. Otherwise, the test is added to the suite.

An exception is thrown if any test is part of another test aggregation.

Input Parameters:
deployer : Deployer - the deployment state
synchronousDeploy : boolean - (Optional) Specify whether to block until the changes have been fully deployed to the network. A value of "true" means to block. A value of "false" means to return immediately. Default: false (asynchronous)
clearOnDeployFailure : boolean - (Optional) Specify whether to clear any failed deployers. A value of "true" means to clear. A value of "false" means to leave the failed deployer. Default: false
deployRetries : int - (Optional) The number of times to attempt re-deployment during synchronous deployment. This parameter is meaningless in the asynchronous case. Default: 0
deployRetryInterval : long - (Optional) The number of milliseconds to wait between deployment retries. This parameter is meaningless in the asynchronous case. Default: 0
taskDescription : string - (Optional) A user friendly description of what the operation does. This information will be used by the task manager.
instanceFullName : string - the full name of the object.
testGroupRole : sas.TestGroupRole - The test group to which to add these tests.
tests : Set (Pointer) - A set of test pointers to add.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Exceptions:
sas.TestSuite.addTestsException

generateTests

Generates all relevant tests for this test suite given the current set of test policies.

Tests that are no longer relevant (based on the latest test policies in the suite) are removed.

Input Parameters:
deployer : Deployer - the deployment state
synchronousDeploy : boolean - (Optional) Specify whether to block until the changes have been fully deployed to the network. A value of "true" means to block. A value of "false" means to return immediately. Default: false (asynchronous)
clearOnDeployFailure : boolean - (Optional) Specify whether to clear any failed deployers. A value of "true" means to clear. A value of "false" means to leave the failed deployer. Default: false
deployRetries : int - (Optional) The number of times to attempt re-deployment during synchronous deployment. This parameter is meaningless in the asynchronous case. Default: 0
deployRetryInterval : long - (Optional) The number of milliseconds to wait between deployment retries. This parameter is meaningless in the asynchronous case. Default: 0
taskDescription : string - (Optional) A user friendly description of what the operation does. This information will be used by the task manager.
instanceFullName : string - the full name of the object.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Exceptions:
sas.TestSuite.generateTestsException

getNumberOfTests

Returns the number of tests in this testsuite
Input Parameters:
instanceFullName : string - the full name of the object.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Output Parameters:
tests : long - The number of tests in this testsuite.
Exceptions:
sas.TestSuite.getNumberOfTestsException

removeTest

Ensures that the given test is not part of this test suite. If the test is already part of this suite, it is removed. Otherwise, the test suite remains unchanged.
Input Parameters:
deployer : Deployer - the deployment state
synchronousDeploy : boolean - (Optional) Specify whether to block until the changes have been fully deployed to the network. A value of "true" means to block. A value of "false" means to return immediately. Default: false (asynchronous)
clearOnDeployFailure : boolean - (Optional) Specify whether to clear any failed deployers. A value of "true" means to clear. A value of "false" means to leave the failed deployer. Default: false
deployRetries : int - (Optional) The number of times to attempt re-deployment during synchronous deployment. This parameter is meaningless in the asynchronous case. Default: 0
deployRetryInterval : long - (Optional) The number of milliseconds to wait between deployment retries. This parameter is meaningless in the asynchronous case. Default: 0
taskDescription : string - (Optional) A user friendly description of what the operation does. This information will be used by the task manager.
instanceFullName : string - the full name of the object.
testGroupRole : sas.TestGroupRole - The test group from which to remove this test.
test : Pointer - The pointer to the test to remove.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Exceptions:
sas.TestSuite.removeTestException

removeTests

Ensures that the given tests are not part of this test suite. If a test is already part of this suite, it is removed.
Input Parameters:
deployer : Deployer - the deployment state
synchronousDeploy : boolean - (Optional) Specify whether to block until the changes have been fully deployed to the network. A value of "true" means to block. A value of "false" means to return immediately. Default: false (asynchronous)
clearOnDeployFailure : boolean - (Optional) Specify whether to clear any failed deployers. A value of "true" means to clear. A value of "false" means to leave the failed deployer. Default: false
deployRetries : int - (Optional) The number of times to attempt re-deployment during synchronous deployment. This parameter is meaningless in the asynchronous case. Default: 0
deployRetryInterval : long - (Optional) The number of milliseconds to wait between deployment retries. This parameter is meaningless in the asynchronous case. Default: 0
taskDescription : string - (Optional) A user friendly description of what the operation does. This information will be used by the task manager.
instanceFullName : string - the full name of the object.
testGroupRole : sas.TestGroupRole - The test group from which to remove these test.
test : Set (Pointer) - A set of test pointers to remove.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Exceptions:
sas.TestSuite.removeTestsException
Methods inherited from sas.AbstractTest
execute, stop