Constructor
new testSuite()
Methods
add(suiteDataopt) → {string}
Add a new test test suite
Example
import {SideeX} from "sideex-api"
var sideex = new SideeX();
console.log(sideex.file.testSuite.add());Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
suiteData |
object |
<optional> |
The detail of test suite |
Returns:
suiteIdString - The id of test suite
- Type
- string
close(suiteIdStrings)
Close test suites
Example
import {SideeX} from "sideex-api"
var sideex = new SideeX();
sideex.file.testSuite.add();
console.log(sideex.file.testSuite.getSuitesOrder());
sideex.file.testSuite.close("suite-0");
console.log(sideex.file.testSuite.getSuitesOrder());Parameters:
| Name | Type | Description |
|---|---|---|
suiteIdStrings |
Array.<string> | The ids of test suites |
closeAll()
Close all of the test suites
Example
import {SideeX} from "sideex-api"
var sideex = new SideeX();
sideex.file.testSuite.add();
sideex.file.testSuite.add();
console.log(sideex.file.testSuite.getSuitesOrder());
sideex.file.testSuite.closeAll();
console.log(sideex.file.testSuite.getSuitesOrder());copy(suiteIdStringsopt)
Copy the test suite
Example
import {SideeX} from "sideex-api"
var sideex = new SideeX();
sideex.file.testSuite.add();
sideex.file.testSuite.copy("suite-0");
console.log(sideex.file.testSuite.getSuitesOrder());Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
suiteIdStrings |
Array.<string> |
<optional> |
selectedSuitesId
|
The id of test case to copy and paste |
get(suiteIdString) → {object}
Get the detail of the test suite
Example
import {SideeX} from "sideex-api"
var sideex = new SideeX();
sideex.file.testSuite.add();
sideex.file.testSuite.get("suite-0");Parameters:
| Name | Type | Description |
|---|---|---|
suiteIdString |
string | The id of test suite |
Returns:
suiteData - The detail of test suite
- Type
- object
getSelected() → {Array.<string>}
Get selected test suites
Example
import {SideeX} from "sideex-api"
var sideex = new SideeX();
sideex.file.testSuite.add();
sideex.file.testSuite.setSelected("suite-0");
console.log(sideex.file.testSuite.getSelected());Returns:
suiteIdStrings - The ids of test suites
- Type
- Array.<string>
getSuiteIdString(suiteName) → {string}
Get id by test suite name
Parameters:
| Name | Type | Description |
|---|---|---|
suiteName |
string | The name of test suite |
Returns:
suiteIdString - The id of test suite
- Type
- string
getSuitesOrder() → {Array.<string>}
Get the test suites' order
Example
import {SideeX} from "sideex-api"
var sideex = new SideeX();
sideex.file.testSuite.add();
sideex.file.testSuite.add();
console.log(sideex.file.testSuite.getSuitesOrder());Returns:
suiteIdStrings - The ids of test suites
- Type
- Array.<string>
load(jsonString)
Load the file for playback
Example
import {SideeX} from "sideex-api"
var sideex = new SideeX();
sideex.recorder.start();
//record commands.
sideex.recorder.stop();
//you have to have a test suite first, or just record one.
let jsonString = sideex.file.testSuite.save();
sideex.file.testSuite.load(jsonString);
sideex.playback.start();Parameters:
| Name | Type | Description |
|---|---|---|
jsonString |
string | String of JSON object |
rename(suiteIdString, newSuiteName) → {string}
Rename the test suite
Parameters:
| Name | Type | Description |
|---|---|---|
suiteIdString |
string | The id of test suite |
newSuiteName |
string | The new name for test suite |
Returns:
newSuiteName - The new name for test suite
- Type
- string
save() → {string}
Save the file
Example
import {SideeX} from "sideex-api"
var sideex = new SideeX();
//you have to have a test suite first, or just record one.
let jsonString = sideex.file.testSuite.save();
sideex.file.testSuite.load(jsonString);
sideex.playback.start();Returns:
- String of JSON object
- Type
- string
setSelected(suiteIdStrings)
Change selected test suites
Example
import {SideeX} from "sideex-api"
var sideex = new SideeX();
sideex.file.testSuite.add();
sideex.file.testSuite.setSelected("suite-0");
console.log(sideex.file.testSuite.getSelected());Parameters:
| Name | Type | Description |
|---|---|---|
suiteIdStrings |
Array.<string> | The ids of test suites |
Type Definitions
jsonString
jsonString
- String of JSON object
Type:
- string
selectedSuitesId
selectedSuitesId
- The test suites' id that currently selected
Type:
- Array.<string>
suiteData
Properties:
| Name | Type | Description |
|---|---|---|
suiteData.filename |
string | The filename of test suite |
suiteData.title |
string | The title of test suite |
suiteData.cases |
Array.<string> | The test cases in the test suite |
suiteData.modified |
boolean | Is this test suite modified |
suiteData.status |
string | The status of test suite |
suiteData
- The detail of test suite
Type:
- object
suiteIdString
suiteIdString
- The id of test suite
Type:
- string
suiteIdStrings
suiteIdStrings
- The id of test suites
Type:
- Array.<string>