tcms.rpc.api.testexecution module¶
- tcms.rpc.api.testexecution.add_comment(execution_id, comment, **kwargs)[source]¶
- RPC TestExecution.add_comment(execution_id, comment)
Add comment to selected test execution.
- Parameters:
- Returns:
Serialized
django_comments.models.Comment
object- Return type:
- Raises:
PermissionDenied – if missing django_comments.add_comment permission
- tcms.rpc.api.testexecution.add_link(values, update_tracker=False, **kwargs)[source]¶
- RPC TestExecution.add_link(values)
Add new URL link to a TestExecution
- Parameters:
values (dict) – Field values for
tcms.core.contrib.linkreference.models.LinkReference
update_tracker (bool, default=False) – Automatically update Issue Tracker by placing a comment linking back to the failed TestExecution.
**kwargs – Dict providing access to the current request, protocol, entry point name and handler instance from the rpc method
- Returns:
Serialized
tcms.core.contrib.linkreference.models.LinkReference
object- Return type:
- Raises:
RuntimeError – if operation not successfull
ValueError – if input validation fails
Note
Always ‘link’ with IT instance if URL is from Kiwi TCMS own bug tracker!
- tcms.rpc.api.testexecution.filter(query)[source]¶
- RPC TestExecution.filter(query)
Perform a search and return the resulting list of test case executions.
- Parameters:
query (dict) – Field lookups for
tcms.testruns.models.TestExecution
- Returns:
List of serialized
tcms.testruns.models.TestExecution
objects- Return type:
- tcms.rpc.api.testexecution.get_comments(execution_id)[source]¶
- RPC TestExecution.get_comments(execution_id)
Get all comments for selected test execution.
- tcms.rpc.api.testexecution.get_links(query)[source]¶
- RPC TestExecution.get_links(query)
Get URL links for the specified TestExecution
- Parameters:
query (dict) – Field lookups for
tcms.core.contrib.linkreference.models.LinkReference
- Returns:
Serialized list of
tcms.core.contrib.linkreference.models.LinkReference
objects- Return type:
- tcms.rpc.api.testexecution.history(execution_id)[source]¶
- RPC TestExecution.history(execution_id)
Return the history for the selected test execution.
- Parameters:
execution_id (int) – PK of a TestExecution object
- Returns:
List of serialized
tcms.core.history.KiwiHistoricalRecords
objects- Return type:
- Raises:
PermissionDenied – if missing testruns.view_testexecution permission
- tcms.rpc.api.testexecution.properties(query)[source]¶
- RPC TestExecution.properties(query)
Return properties for a TestExecution
- Parameters:
query (dict) – Field lookups for
tcms.testruns.models.TestExecutionProperty
- Returns:
Serialized list of
tcms.testruns.models.TestExecutionProperty
objects- Return type:
- tcms.rpc.api.testexecution.remove(query)[source]¶
- RPC TestExecution.remove(query)
Remove a TestExecution.
- Parameters:
query (dict) – Field lookups for
tcms.testruns.models.TestExecution
- Raises:
PermissionDenied – if missing testruns.delete_testexecution permission
- tcms.rpc.api.testexecution.remove_comment(execution_id, comment_id=None)[source]¶
- RPC TestExecution.remove_comment(execution_id, comment_id)
Remove all or specified comment(s) from selected test execution.
- tcms.rpc.api.testexecution.remove_link(query)[source]¶
- RPC TestExecution.remove_link(query)
Remove URL link from TestExecution
- Parameters:
query (dict) – Field lookups for
tcms.core.contrib.linkreference.models.LinkReference
- tcms.rpc.api.testexecution.update(execution_id, values, **kwargs)[source]¶
- RPC TestExecution.update(execution_id, values)
Update the selected TestExecution
- Parameters:
execution_id (int) – PK of TestExecution to modify
values (dict) – Field values for
tcms.testruns.models.TestExecution
**kwargs – Dict providing access to the current request, protocol, entry point name and handler instance from the rpc method
- Returns:
Serialized
tcms.testruns.models.TestExecution
object- Return type:
- Raises:
ValueError – if data validations fail
PermissionDenied – if missing testruns.change_testexecution permission