tcms.rpc.api package

Kiwi TCMS RPC Service

You need to invoke it using an XML-RPC or JSON-RPC Client! For the available RPC methods checkout the Submodules section!

tcms-api is the official Python interface for Kiwi TCMS! We strongly advise that you use it instead of directly calling the RPC methods below!

How does the RPC interface work?

• The XML-RPC enpoint is at https://your-kiwi-instance.com/xml-rpc/.

• There is also a JSON RPC endpoint at https://your-kiwi-instance.com/json-rpc/.

• Most of the RPC methods, like filter are wrappers around Django’s QuerySet. They support field lookups as described in Django’s documentation. For example to get all test cases with summary starting with ‘test’:

  >>> TestCase.filter({'summary__startswith': 'test'})
  

• All RPC methods accept positional parameters as described in their documentation. This is the standard behavior for Python. Keyword arguments, where supported will be documented explicitly!

How to handle ForeignKey arguments?

The syntax of using ForeignKey in this RPC API follows Django standards:

foreignkeyname + '__' + fieldname + '__' + field_lookup_syntax

Taking TestCase.filter() for example, if the query is based on a default_tester’s username which starts with ‘John’, the syntax will look like this:

TestCase.filter({'default_tester__username__startswith': 'John'})

In this example the foreignkeyname is ‘default_tester’, fieldname is ‘username’ and field_lookup_syntax is ‘startswith’. They are joined together using double underscores ‘__’.

Subpackages

• tcms.rpc.api.forms package
  • DateTimeField
    • DateTimeField.default_error_messages
    • DateTimeField.input_formats
  • UpdateModelFormMixin
  • Submodules
    • tcms.rpc.api.forms.management module
      • BuildForm
      • BuildUpdateForm
      • ClassificationForm
      • ComponentForm
      • ComponentUpdateForm
      • ProductForm
    • tcms.rpc.api.forms.testcase module
      • CategoryForm
      • NewForm
      • UpdateForm
    • tcms.rpc.api.forms.testexecution module
      • LinkReferenceForm
    • tcms.rpc.api.forms.testplan module
      • EditPlanForm
      • PlanTypeForm
    • tcms.rpc.api.forms.testrun module
      • EnvironmentForm
      • UpdateExecutionForm
      • UpdateForm
      • UserForm

Submodules

• tcms.rpc.api.attachment module
  • remove_attachment()
• tcms.rpc.api.auth module
  • login()
  • logout()
• tcms.rpc.api.bug module
  • details()
  • report()
• tcms.rpc.api.build module
  • create()
  • filter()
  • update()
• tcms.rpc.api.category module
  • create()
  • filter()
• tcms.rpc.api.classification module
  • create()
  • filter()
• tcms.rpc.api.component module
  • create()
  • filter()
  • update()
• tcms.rpc.api.environment module
  • add_property()
    • Environment.add_property()
  • create()
  • filter()
    • Environment.filter()
  • properties()
    • Environment.properties()
  • remove_property()
    • Environment.remove_property()
• tcms.rpc.api.kiwitcms module
  • version()
• tcms.rpc.api.markdown module
  • render()
• tcms.rpc.api.plantype module
  • create()
  • filter()
• tcms.rpc.api.priority module
  • filter()
• tcms.rpc.api.product module
  • create()
  • filter()
• tcms.rpc.api.tag module
  • filter()
• tcms.rpc.api.testcase module
  • add_attachment()
  • add_comment()
    • TestCase.add_comment()
  • add_component()
  • add_notification_cc()
  • add_property()
    • TestCase.add_property()
  • add_tag()
  • comments()
    • TestCase.comments()
  • create()
  • filter()
  • get_notification_cc()
  • history()
  • list_attachments()
  • properties()
    • TestCase.properties()
  • remove()
  • remove_comment()
    • TestCase.remove_comment()
  • remove_component()
  • remove_notification_cc()
  • remove_property()
    • TestCase.remove_property()
  • remove_tag()
  • sortkeys()
  • update()
• tcms.rpc.api.testcasestatus module
  • filter()
• tcms.rpc.api.testexecution module
  • add_comment()
  • add_link()
  • filter()
  • get_comments()
  • get_links()
  • history()
  • properties()
  • remove()
  • remove_comment()
  • remove_link()
  • update()
• tcms.rpc.api.testexecutionstatus module
  • filter()
• tcms.rpc.api.testplan module
  • add_attachment()
  • add_case()
  • add_tag()
  • create()
  • filter()
  • list_attachments()
  • remove_case()
  • remove_tag()
  • tree()
  • update()
  • update_case_order()
• tcms.rpc.api.testrun module
  • add_attachment()
  • add_case()
  • add_cc()
  • add_tag()
  • annotate_executions_with_properties()
  • create()
  • filter()
  • get_cases()
  • properties()
    • TestRun.properties()
  • remove()
  • remove_case()
  • remove_cc()
  • remove_tag()
  • update()
• tcms.rpc.api.user module
  • add_attachment()
  • filter()
  • join_group()
  • update()
• tcms.rpc.api.utils module
  • tracker_from_url()
• tcms.rpc.api.version module
  • create()
  • filter()