TrackApps¶

This section contains source code documentation of TrackApps extension.

trackapps¶

Extension with interface to bugtracking and test management systems

class hydratk.extensions.trackapps.trackapps.Extension(core_instance=None)¶

Class Extension

_init_extension()¶

Method initializes extension

Parameters:	none –
Returns:	void

_check_dependencies()¶

Method checks dependent modules

Parameters:	none –
Returns:	bool

_uninstall()¶

Method returns additional uninstall data

Parameters:	none –
Returns:	list (files), list (modules)
Return type:	tuple

_register_actions()¶

Method registers command hooks

Parameters:	none –
Returns:	void

_register_htk_actions()¶

Method registers command hooks

Parameters:	none –
Returns:	void

_register_standalone_actions()¶

Method registers command hooks for standalone mode

Parameters:	none –
Returns:	void

init_client(app, *args, **kwargs)¶

Client factory method

Parameters:	app (str) – application, qc\|bugzilla\|mantis\|trac\|jira\|testlink args (args) – arguments kwargs (kwargs) – key value arguments
Returns:	Client
Return type:	obj
Raises:	`error` – NotImplementedError

handle_track()¶

Method handles command track

Parameters:	none –
Returns:	void

read()¶

Method handles read action

Parameters:	none –
Returns:	void

create()¶

Method create action

Parameters:	none –
Returns:	void

update()¶

Method handles update action

Parameters:	none –
Returns:	void

delete()¶

Method handles delete action

Parameters:	none –
Returns:	void

bootstrapper¶

Providing custom bootstrapper for trackapps standalone app

hydratk.extensions.trackapps.bootstrapper.run_app()¶

Methods runs trackapps standalone application

Parameters:	none –
Returns:	void

qc¶

Client for HP Quality Center

class hydratk.extensions.trackapps.qc.Client¶

Class Client

__init__()¶

Class constructor

Called when the object is initialized

Parameters:	none –

client¶: client property getter

url¶: url property getter

user¶: user property getter

passw¶: passw property getter

domain¶: domain property getter

project¶: project property getter

cookie¶: cookie property getter

return_fields¶: return_fields property getter

default_values¶: default_values property getter

is_connected¶: is_connected property getter

connect(url=None, user=None, passw=None, domain=None, project=None)¶

Method connects to QC

Parameters:	url (str) – URL user (str) – username passw (str) – password domain (str) – QC domain project (str) – QC project
Returns:	result
Return type:	bool
Raises:	`event` – track_before_connect `event` – track_after_connect

disconnect()¶

Method disconnects from QC

Parameters:	none –
Returns:	result
Return type:	bool

__weakref__¶: list of weak references to the object (if defined)

read(id=None, entity='defect', fields=None, query=None, order_by=None, limit=None, offset=None)¶

Method reads records

Parameters:	id (int) – record id entity (str) – entity type fields (list) – fields to be returned, default all query (str) – record query order_by (dict) – record ordering, key - field, value - direction asc\|desc limit (int) – record count offset (int) – record offset
Returns:	result (bool), records (list of dictionary)
Return type:	tuple
Raises:	`event` – track_before_read `event` – track_after_read

create(entity='defect', params={})¶

Method creates record

Parameters:	entity (str) – entity type params (dict) – record content, key - field name, value - field value
Returns:	record id
Return type:	int
Raises:	`event` – track_before_create `event` – track_after_create

update(id, entity='defect', params={})¶

Method updates record

Parameters:	id (int) – entity id entity (str) – entity type params (dict) – record content, key - field name, value - field value
Returns:	result
Return type:	bool
Raises:	`event` – track_before_update `event` – track_after_update

delete(id, entity='defect')¶

Method deletes record

Parameters:	id (int) – entity id entity (str) – entity type
Returns:	result
Return type:	bool
Raises:	`event` – track_before_delete `event` – track_after_delete

read_test_folder(path, entity='test-folder')¶

Method reads tests under test folder

Parameters:	path (str) – folder path entity (str) – entity type, test-folder\|test-set-folder
Returns:	result (bool), records (dict), key - test folder, value - list of tests
Return type:	tuple
Raises:	`event` – track_before_read_folder `event` – track_after_read_folder

create_test_folder(path, name, entity='test-folder')¶

Method creates test folder on path

Parameters:	path (str) – folder path name (str) – folder name entity (str) – entity type, test-folder\|test-set-folder
Returns:	folder id
Return type:	int

read_test_set(id)¶

Method reads tests under test set

Parameters:	id (int) – test set id
Returns:	result (bool), tests (list of dict)
Return type:	tuple
Raises:	`track_before_read_set` – `track_after_read_set` –

create_test_set(path, params={})¶

Method creates test set on path

Parameters:	path (str) – folder path params (dict) – test content, key - field name, value - field value
Returns:	test set id
Return type:	int

create_test(path, params={})¶

Method creates test on path

Parameters:	path (str) – folder path params (dict) – test content, key - field name, value - field value
Returns:	test id
Return type:	int

_get_folder(path, entity='test-folder')¶

Method gets folder from hierarchical path

Parameters:	path (str) – folder path, Folder1/Folder2/... entity (str) – entity type, test-folder\|test-set-folder
Returns:	dict

bugzilla¶

Client for Bugzilla

class hydratk.extensions.trackapps.bugzilla.Client¶

Class Client

__init__()¶

Class constructor

Called when the object is initialized

Parameters:	none –

client¶: client property getter

url¶: url property getter

user¶: user property getter

passw¶: passw property getter

token¶: token property getter

return_fields¶: return_fields property getter

__weakref__¶: list of weak references to the object (if defined)

default_values¶: default_values property getter

is_connected¶: is_conncted property getter

connect(url=None, user=None, passw=None)¶

Method connects to Bugzilla

Parameters:	url (str) – URL user (str) – username passw (str) – password
Returns:	result
Return type:	bool
Raises:	`event` – track_before_connect `event` – track_after_connect

disconnect()¶

Method disconnects from Bugzilla

Parameters:	none –
Returns:	result
Return type:	bool

read(id=None, fields=None, query=None, limit=None, offset=None)¶

Method reads records

Parameters:	id (int) – record id fields (list) – fields to be returned, default all query (dict) – record query, see Bugzilla doc limit (int) – record count offset (int) – record offset
Returns:	result (bool), records (list of dictionary)
Return type:	tuple
Raises:	`event` – track_before_read `event` – track_after_read

create(params={})¶

Method creates record

Parameters:	params (dict) – record content, key - field name, value - field value
Returns:	record id
Return type:	int
Raises:	`event` – track_before_create `event` – track_after_create

update(id, params={})¶

Method updates record

Parameters:	id (int) – record id params (dict) – record content, key - field name, value - field value
Returns:	result
Return type:	bool
Raises:	`event` – track_before_update `event` – track_after_update

mantis¶

Client for Mantis

class hydratk.extensions.trackapps.mantis.Client¶

Class Client

__init__()¶

Class constructor

Called when the object is initialized

Parameters:	none –

client¶: client property getter

url¶: url property getter

user¶: user property getter

passw¶: passw property getter

project¶: project property getter

project_id¶: project_id property getter

return_fields¶: return_fields property getter

default_values¶: default_values property getter

__weakref__¶: list of weak references to the object (if defined)

is_connected¶: is_connected property getter

connect(url=None, user=None, passw=None, project=None)¶

Method connects to Mantis

Parameters:	url (str) – URL user (str) – username passw (str) – password project (str) – QC project
Returns:	result
Return type:	bool
Raises:	`event` – track_before_connect `event` – track_after_connect

read(id=None, fields=None, page=-1, per_page=-1)¶

Method reads records

Parameters:	id (int) – record id fields (list) – fields to be returned, default all page (int) – page number per_page (int) – records per page
Returns:	result (bool), records (list of dictionary)
Return type:	tuple
Raises:	`event` – track_before_read `event` – track_after_read

create(params)¶

Method creates record

Parameters:	params (dict) – record content, key - field name, value - field value
Returns:	record id
Return type:	int
Raises:	`event` – track_before_create `event` – track_after_create

update(id, params={})¶

Method updates record

Parameters:	id (int) – record id params (dict) – record content, key - field name, value - field value
Returns:	result
Return type:	bool
Raises:	`event` – track_before_update `event` – track_after_update

delete(id)¶

Method deletes record

Parameters:	id (int) – record id
Returns:	result
Return type:	bool
Raises:	`event` – track_before_delete `event` – track_after_delete

_parse_record(rec, fields=None)¶

Method parses record

Parameters:	rec (xml) – record in xml form fields (list) – fields to be returned, default all
Returns:	parsed record
Return type:	dict

_toxml(params)¶

Method creates record in xml

Parameters:	params (dict) – record content, key - field name, value - field value
Returns:	record
Return type:	xml

trac¶

Client for Trac

class hydratk.extensions.trackapps.trac.Client¶

Class Client

__init__()¶

Class constructor

Called when the object is initialized

Parameters:	none –

client¶: client property getter

url¶: url property getter

user¶: user property getter

passw¶: passw property getter

project¶: project property getter

__weakref__¶: list of weak references to the object (if defined)

return_fields¶: return_fields property getter

default_values¶: default_values property getter

is_connected¶: is_connected property getter

connect(url=None, user=None, passw=None, project=None)¶

Method connects to Trac

Parameters:	url (str) – URL user (str) – username passw (str) – password project (str) – project
Returns:	result
Return type:	bool
Raises:	`event` – track_before_connect `event` – track_after_connect

read(id=None, fields=None, query=None)¶

Method reads records

Parameters:	id (int) – record id fields (list) – fields to be returned, default all query (str) – query, see Trac doc
Returns:	result (bool), records (list of dictionary)
Return type:	tuple
Raises:	`event` – track_before_read `event` – track_after_read

create(params={})¶

Method creates record

Parameters:	params (dict) – record content, key - field name, value - field value
Returns:	record id
Return type:	int
Raises:	`event` – track_before_create `event` – track_after_create

update(id, params={})¶

Method updates record

Parameters:	id (int) – record id params (dict) – record content, key - field name, value - field value
Returns:	result
Return type:	bool
Raises:	`event` – track_before_update `event` – track_after_update

delete(id)¶

Method deletes record

Parameters:	id (int) – record id
Returns:	result
Return type:	bool
Raises:	`event` – track_before_delete `event` – track_after_delete

jira¶

Client for Jira

class hydratk.extensions.trackapps.jira.Client¶

Class Client

__init__()¶

Class constructor

Called when the object is initialized

Parameters:	none –

client¶: client property getter

url¶: url property getter

user¶: user property getter

passw¶: passw property getter

__weakref__¶: list of weak references to the object (if defined)

project¶: project property getter

return_fields¶: return_fields property getter

default_values¶: default_values property getter

is_connected¶: is_connected property getter

connect(url=None, user=None, passw=None, project=None)¶

Method connects to Jira

Parameters:	url (str) – URL user (str) – username passw (str) – password project (str) – project
Returns:	result
Return type:	bool
Raises:	`event` – track_before_connect `event` – track_after_connect

read(id=None, fields=None, query=None, limit=None, offset=None)¶

Method reads records

Parameters:	id (int) – record id fields (list) – fields to be returned, default all query (str) – record query, see Jira doc limit (int) – record count offset (int) – record offset
Returns:	result (bool), records (list of dictionary)
Return type:	tuple
Raises:	`event` – track_before_read `event` – track_after_read

create(params={})¶

Method creates record

Parameters:	params (dict) – record content, key - field name, value - field value
Returns:	record id
Return type:	int
Raises:	`event` – track_before_create `event` – track_after_create

update(id, params={})¶

Method updates record

Parameters:	id (int) – record id params (dict) – record content, key - field name, value - field value
Returns:	result
Return type:	bool
Raises:	`event` – track_before_update `event` – track_after_update

testlink¶

Client for TestLink

class hydratk.extensions.trackapps.testlink.Client¶

Class Client

__init__()¶

Class constructor

Called when the object is initialized

Parameters:	none –

client¶: client property getter

url¶: url property getter

dev_key¶: dev key property getter

project¶: project property getter

project_id¶: project id property getter

return_fields¶: return_fields property getter

default_values¶: default_values property getter

is_connected¶: is_connected property getter

connect(url=None, dev_key=None, project=None)¶

Method connects to TestLink

Parameters:	url (str) – URL dev_key (str) – development key to access API project (str) – project
Returns:	result
Return type:	bool
Raises:	`event` – track_before_connect `event` – track_after_connect

read_test_suite(path, steps=True, fields=None)¶

Method reads tests under test suite

Parameters:	path (str) – suite path steps (bool) – get steps fields (list) – test fields to be returned, default all
Returns:	result (bool), records (dict), key - test suite, value - list of tests
Return type:	tuple
Raises:	`event` – track_before_read_suite `event` – track_after_read_suite

create_test_suite(path, name, details=None)¶

Method creates test folder on path

Parameters:	path (str) – suite path name (str) – suite name details (str) – suite details
Returns:	suite id
Return type:	int
Raises:	`event` – track_before_create `event` – track_after_create

read_test_plan(plan=None, plan_id=None, build_id=None, fields=None)¶

Method reads tests under plan

Parameters:	plan (str) – plan name, will be translated to plan_id plan_id (int) – plan_id build_id (int) – build id, latest build will be used if not specified fields (list) – test fields to be returned, default all
Returns:	result (bool), records (list of dict)
Return type:	tuple
Raises:	`event` – track_before_read_plan `event` – track_after_read_plan

__weakref__¶: list of weak references to the object (if defined)

create_test_plan(name, notes=None)¶

Method creates test plan

Parameters:	name (str) – plan name notes (str) – plan notes
Returns:	plan id
Return type:	int
Raises:	`event` – track_before_create `event` – track_after_create

create_build(plan, name, notes=None)¶

Method creates build

Parameters:	plan (int) – plan id name (str) – build name notes (str) – build notes
Returns:	build id
Return type:	int
Raises:	`event` – track_before_create `event` – track_after_create

read_test(id, fields=None)¶

Method reads test

Parameters:	id (int) – test id fields (list) – fields to be returned default all
Returns:	result (bool), test (dict)
Return type:	tuple
Raises:	`event` – track_before_read `event` – track_after_read

create_test(path, params={}, steps=[])¶

Method creates test

Parameters:	path (str) – suite path params (dict) – params, key - field name, value - field value steps (list) – list of dict, key - field name, value - field value
Returns:	test id
Return type:	int
Raises:	`event` – track_before_create `event` – track_after_create

add_test_to_plan(test, plan=None, plan_id=None)¶

Method adds test to plan

Parameters:	test (int) – test id plan (str) – plan name plan_id (int) – plan_id
Returns:	result
Return type:	bool
Raises:	`event` – track_before_update `event` – track_after_update

update_test_execution(test, status, notes=None, plan=None, plan_id=None, build_id=None)¶

Method updates test execution

Parameters:	test (int) – test id status (str) – status, p\|f\|b (passed\|failed\|blocked) notes (str) – execution notes plan (str) – plan name, will be translated to id plan_id (int) – plan id build_id (int) – build id, latest build will be used if not specified
Returns:	result
Return type:	bool

_get_suite(path)¶

Method gets suite from hierarchical path

Parameters:	path (str) – suite path, Suite1/Suite2/...
Returns:	suite id
Return type:	int