public interface ILauncher
ILauncher
interface. This MUST be implemented by any launcher.
Any launcher implementation should inherits from CLauncher
which
implements this interface.CLauncher
Modifier and Type | Method and Description |
---|---|
boolean |
canScanPhysicalTests() |
CReturnStatus |
initialize(int sutId,
java.lang.String sutName,
java.lang.String sutVersion)
The
initialize method is executed once at the instanciation of the launcher. |
CReturnStatus |
postRun(int testId,
java.lang.String testPath,
java.lang.String testName)
The
postRun step is executed after all the testcases have been executed. |
CReturnStatus |
preRun(int testId,
java.lang.String testPath,
java.lang.String testName,
java.util.Vector<CTestAttribute> attributes,
java.lang.String additionalInfo)
The
preRun step is executed before all the testcases are
run. |
CReturnStatus |
run(int testId,
java.lang.String testPath,
java.lang.String testName,
int testcaseId,
int testcaseIndex,
java.lang.String testcaseName,
java.util.Vector<CTestcaseParam> params,
java.lang.String additionalInfo)
The
run step is the main entry point to execute a particular testcase. |
java.util.Vector<com.xqual.xagent.CScannedTest> |
scanPhysicalTests() |
CReturnStatus |
terminate()
The
terminate method is executed once when the launcher is not anymore used. |
CReturnStatus initialize(int sutId, java.lang.String sutName, java.lang.String sutVersion)
initialize
method is executed once at the instanciation of the launcher.
You can put there all operations of initialization that needs to be done before everything else.
sutId
- the id of the SUT as appearing in XStudio (note that that it can be ignored most of the time)sutName
- the name of the SUT as appearing in XStudiosutVersion
- the version of the SUT as appearing in XStudioCReturnStatus
CReturnStatus preRun(int testId, java.lang.String testPath, java.lang.String testName, java.util.Vector<CTestAttribute> attributes, java.lang.String additionalInfo)
preRun
step is executed before all the testcases are
run.
You can put there all operations of initialization that needs to be done before all testcases are executed.
testId
- the Id of the test (note that that it can be ignored most of the time)testPath
- an absolute path giving the base location of the testtestName
- the name of the test (this is generally used to retrieve a specific file on the disk)additionalInfo
- an optional additional information attached to the testCReturnStatus
CReturnStatus run(int testId, java.lang.String testPath, java.lang.String testName, int testcaseId, int testcaseIndex, java.lang.String testcaseName, java.util.Vector<CTestcaseParam> params, java.lang.String additionalInfo)
run
step is the main entry point to execute a particular testcase.
The testcase must handle correctly all cleanup tasks (apart from operations
previously executed in preRun
testId
- the Id of the test (note that that it can be ignored most of the time)testPath
- an absolute path giving the base location of the testtestName
- the name of the test (this is generally used to retrieve a specific file on the disk)testcaseId
- the Id of the testcase (note that that it can be ignored most of the time)testcaseIndex
- an index giving specifying which test case to runtestcaseName
- the name of the test case to runparams
- the param with their values associated to this testcaseadditionalInfo
- an optional additional information attached to the testCReturnStatus
CReturnStatus postRun(int testId, java.lang.String testPath, java.lang.String testName)
postRun
step is executed after all the testcases have been executed.
You can put there all operations of cleanup necessary to bring back the SUT to its initial state.
It's a good idea to rollback what were previously done in the
preRun
step.
testId
- the Id of the test (note that that it can be ignored most of the time)testPath
- an absolute path giving the base location of the testtestName
- the name of the test (this is generally used to retrieve a specific file on the disk)CReturnStatus
CReturnStatus terminate()
terminate
method is executed once when the launcher is not anymore used.
You can put there all operations of termination that needs to be done after all the tests have been executed.
CReturnStatus
boolean canScanPhysicalTests()
java.util.Vector<com.xqual.xagent.CScannedTest> scanPhysicalTests()