Module: tools

Methods

---

<static> checkTestrail(cb)

Check testrail cases consistency with implemented tests.

Parameters:

Name	Type	Description
cb	function	Callback function.

Source:

• tools.js, line 188

---

<static> fakeLoad()

Make fake load of tests in order to collect tests, fixtures, steps, etc.

Source:

• tools.js, line 162

---

<static> listFixtures( [filter] [, namesOnly])

Get list of available fixtures.

Parameters:

Name	Type	Argument	Default	Description
filter	string	<optional>		String chunk to filter fixtures.
namesOnly	boolean	<optional>	false	Flag to filter by fixture names only.

Source:

• tools.js, line 127

Returns:

Type

array.<object>

---

<static> listPlugins()

Print list of available plugins.

Source:

• tools.js, line 96

---

<static> listSteps( [filter] [, namesOnly])

Get list of steps data, where step data is an object with keys: name - name of step, decription - short details of steps, doc - documentation of step.

Parameters:

Name	Type	Argument	Default	Description
filter	string	<optional>		String chunk to filter steps.
namesOnly	boolean	<optional>	false	Flag to filter by step names only.

Source:

• tools.js, line 38

Returns:

Type

array.<object>

---

<static> listTests( [filter])

Print list of implemented test cases.

Parameters:

Name	Type	Argument	Description
filter	string	<optional>	String chunk to filter test cases.

Source:

• tools.js, line 70

---

<static> printFixtures( [filter] [, namesOnly])

Print list of fixtures in stdout.

Parameters:

Name	Type	Argument	Default	Description
filter	string	<optional>		String chunk to filter fixtures.
namesOnly	boolean	<optional>	false	Flag to filter by fixture names only.

Source:

• tools.js, line 142

---

<static> printSteps( [filter] [, namesOnly])

Print list of steps in stdout.

Parameters:

Name	Type	Argument	Default	Description
filter	string	<optional>		String chunk to filter steps.
namesOnly	boolean	<optional>	false	Flag to filter by step names only.

Source:

• tools.js, line 55