Object Manipulation

TRAW uses a consistent pattern for creating new TestRail objects and adding them to TestRail:

• Call the relevant client method without any parameters, and a new/empty object is returned:

  new_run = client.run()
  new_result = client.result()
  new_section = client.section()
  new_milestone = client.milestone()
  # etc
  

• Configure the new object. Note most addable objects require at least one reference object in order for them to be added to TestRail. For instance, run objects require a reference to a project, result objects require a reference to a test, and sections objects require a reference to a project AND a suite if the project is not in single-suite mode:

  new_run.name = "Run Name"
  new_run.project = client.project(15)  # Project with Project ID 15
  
  new_result.comment = "Result added by TRAW"
  new_result.test = client.tests(123)  # Test with Test ID of 123
  new_result.status = client.status('passed')  # Status with Status Label of 'passed'
  
  new_section.name = "Suite Name"
  new_section.project = client.project(15)  # Project with Project ID 15, with suite-mode of 2
  new_section.suite = client.suite(456)  # Suite with Suite ID 456
  

• At this point the objects only exist locally, and have not been added to TestRail. To do so, call client.add() with the new object. TRAW will add the new object to TestRail, and upon success the TestRail API will return a new object:

  run = client.add(new_run)
  result = client.add(result)
  section = client.add(section)
  

• The returned objects will now have additional information set. Properties that have not yet been specified will be set to None:

  print("Run ID is: {0}".format(run.id))                           # "Run ID is: 12333"
  print("Run Name is: '{0}'".format(run.name))                     # "Run Name is: 'Run Name'"
  print("Run Created By user: '{0}'".format(run.created_by.name))  # "Run Created By user: 'Automation User'"
  print("Run Created On: '{0}'".format(run.created_on))            # "Run Created On: '2016-08-19 13:00:29'"
  print("Run Milestone: '{0}'".format(run.milestone))              # "Run Milestone: 'None'"
  

• Objects that support updating (runs, suites, milestones, etc) can be updated locally, and then the updates can be sent to TestRail:

  run.name = run.name + " - Updated by TRAW"
  run.milestone = client.milestone(789)
  
  updated_run = client.update(run)
  
  print("Run Name is: '{0}'".format(updated_run.name))             # "Run Name is: 'Run Name - Updated by TRAW'"
  print("Run Milestone: '{0}'".format(updated_run.milestone))      # "Run Milestone: 'Widget Testing 90% Complete'"
  print("Run Complete: '{0}'".format(updated_run.is_completed))    # "Run Completed: 'False'"
  

• Objects that can be closed (runs, plans) can be closed through the TRAW Client:

  closed_run = client.close(run)
  
  print("Run Complete: '{0}'".format(closed_run.is_completed))     # "Run Completed: 'True'"
  

• Objects that can be deleted (runs, plans, cases, etc) can be deleted through the TRAW Client. Note that no object is returned after calling client.delete(). Also note that some things (runs, plans) can either be closed or deleted, but not both, while other things (projects) can be deleted after they have been closed (assuming your user has admin privileges):

  client.delete(run)