testCase - Documentation

Constructor

new testCase()

Methods

add(caseDataopt) → {string}

Add a new test test case

Example

import {SideeX} from "sideex-api"
var sideex = new SideeX();
sideex.file.testSuite.add();
sideex.file.testCase.add();

Parameters:

Name	Type	Attributes	Description
`caseData`	object	<optional>	The detail of test case

Returns:

caseIdString - The id of test case

Type: string

copy(srcCaseIdStringsopt, dstSuiteIdStringopt)

Copy the test case

Example

import {SideeX} from "sideex-api"
var sideex = new SideeX();
sideex.file.testSuite.add();
sideex.file.testCase.add();
sideex.file.testCase.copy("case-0", "suite-0");
console.log(sideex.file.testCase.getCasesOrder());

Parameters:

Name	Type	Attributes	Default	Description
`srcCaseIdStrings`	Array.<string>	<optional>	`selectedCasesId`	The id of test cases for source
`dstSuiteIdString`	string	<optional>	`selectedSuiteId`	The id of test suite for destination

cut(srcCaseIdStringsopt, dstSuiteIdStringopt)

Cut the test case

Example

import {SideeX} from "sideex-api"
var sideex = new SideeX();
sideex.file.testSuite.add();
sideex.file.testCase.add();
sideex.file.testCase.cut("case-0", "suite-0");
console.log(sideex.file.testCase.getCasesOrder());

Parameters:

Name	Type	Attributes	Default	Description
`srcCaseIdStrings`	Array.<string>	<optional>	`selectedCasesId`	The id of test cases for source
`dstSuiteIdString`	string	<optional>	`selectedSuiteId`	The id of destination test suite to paste

get(caseIdString) → {object}

Get the details of the test case

Example

import {SideeX} from "sideex-api"
var sideex = new SideeX();
sideex.file.testSuite.add();
sideex.file.testCase.add();
console.log(sideex.file.testCase.get("case-0"));

Parameters:

Name	Type	Description
`caseIdString`	string	The id of test case

Returns:

caseData - The detail of test case

Type: object

getCaseIdString(caseName, suiteIdStringopt) → {string}

Get id by test case name

Parameters:

Name	Type	Attributes	Default	Description
`caseName`	string			The name of test case
`suiteIdString`	string	<optional>	`selectedSuiteId`	The id of test suite

Returns:

caseIdString - The id of test case

Type: string

getCasesOrder() → {Array.<string>}

Properties:

Name	Type	Description
`caseIdStrings`	Array.<string>	The ids of test cases

Get the test cases' order

Example

import {SideeX} from "sideex-api"
var sideex = new SideeX();
sideex.file.testSuite.add();
sideex.file.testCase.add();
sideex.file.testCase.add();
console.log(sideex.file.testCase.getCasesOrder());

Returns:

caseIdStrings - The ids of test cases

Type: Array.<string>

getSelected() → {Array.<string>}

Get selected test cases

Example

import {SideeX} from "sideex-api"
var sideex = new SideeX();
sideex.file.testSuite.add();
sideex.file.testCase.add();
sideex.file.testCase.setSelected("case-0");
console.log(sideex.file.testCase.getSelected());

Returns:

caseIdStrings - The id of test cases

Type: Array.<string>

remove(caseIdString)

Remove the test case

Example

import {SideeX} from "sideex-api"
var sideex = new SideeX();
sideex.file.testSuite.add();
sideex.file.testCase.add();
sideex.file.testCase.add();
sideex.file.testCase.remove("case-0");
console.log(sideex.file.testCase.getCasesOrder());

Parameters:

Name	Type	Description
`caseIdString`	string	The id of test case

rename(caseIdString, newCaseName) → {string}

Rename the test case

Example

import {SideeX} from "sideex-api"
var sideex = new SideeX();
sideex.file.testSuite.add();
sideex.file.testCase.add();
console.log(sideex.file.testCase.rename("case-0", "sideex"));
console.log(sideex.file.testCase.get("case-0"));

Parameters:

Name	Type	Description
`caseIdString`	string	The id of test case
`newCaseName`	string	The new name for test case

Returns:

newCaseName

Type: string

setSelected(caseIdStrings)

Change selected test cases

Example

import {SideeX} from "sideex-api"
var sideex = new SideeX();
sideex.file.testSuite.add();
sideex.file.testCase.add();
sideex.file.testCase.setSelected("case-0");
console.log(sideex.file.testCase.getSelected());

Parameters:

Name	Type	Description
`caseIdStrings`	Array.<string>	The id of test cases

Type Definitions

caseData

Properties:

Name	Type	Description
`caseData.title`	string	The title of test case
`caseData.commands`	Array.<string>	The commands of test case
`caseData.suiteIdString`	string	The suite id where it belongs to
`caseData.modified`	boolean	Is this case modified
`caseData.status`	string	The status of test case

caseData

The detail of test case

Type:

object

caseIdString

The id of test case

Type:

string

selectedCasesId

The test cases' id that currently selected

Type:

Array.<string>

selectedSuiteId

The test suite id that currently selected

Type:

string

suiteIdString

The id of test suite

Type:

string