EasyQA Python 2 Client Library

This document describes Python 2 library that wraps EasyQA REST API.

Installation

$ pip install easyqa

Authenticating

fields

[required]

• base_url - Your server url (default is easyqa cloud(https://app.geteasyqa.com))
• email - Your email
• password - Your password
• project_token - Your project token. How find project token

from easyqa.session import Session
easyqa = Session(login='<your email>', password='<your password>', base_url='<your server>', project_token='<your project token>')

Methods

Issues

Get issue

Get issues from project

# get all issues from project
easyqa.get_issues()

Get issue by id

fields

[required]

• issue_id - Issue ID

# get one issue by id
easyqa.get_issue_by_id(issue_id)

# get one issue by id in project
easyqa.get_issue_by_id_in_project(issue_id)

Create issue

fields

[required]

• summary - Issue summary

[optional]

• test_object_id - ID test object on site
• description - Issue description
• issue_type - Type of issue ('bug', 'documentation', 'task', 'feature', 'usability_problem', 'crash')
• priority - Issue priority ('low', 'medium', 'high', 'critical')
• assigner_id - Issue assigner ID
• file - File which will be attached to issue

# create one issue
easyqa.create_issue(summary, **kwargs)

examples

# create one issue with optional fields
easyqa.create_issue(summary='Test', description='test description')

Update issue

fields

[required]

• issue_id - Issue ID
• summary - Issue summary

[optional]

• test_object_id - ID test object on site
• description - Issue description
• issue_type - Type of issue ('bug', 'documentation', 'task', 'feature', 'usability_problem', 'crash')
• priority - Issue priority ('low', 'medium', 'high', 'critical')
• assigner_id - Issue assigner ID
• status_id - Status ID
• file - File which will be attached to issue

# Update issue by id
easyqa.update_issue_by_id(issue_id, summary, **kwargs)

examples

# update one issue with optional fields
easyqa.update_issue_by_id(issue_id=2, summary='Test', description='test description')

# update one issue by id in project with optional fields
easyqa.update_issue_by_id_in_project(issue_id=2, summary='Test', description='test description')

Delete issue

fields

[required]

• issue_id - Issue ID

examples

# delete one issue
easyqa.delete_issue_by_id(issue_id=2)

# delete one issue by id in project
easyqa.delete_issue_by_id_in_project(issue_id=3)

Attachment

Create Attachment

fields

[required]

• issue_id - Issue ID
• attach_file - File

examples

# create attachment
easyqa.create_issue_attachment(issue_id=1, attach_file'text.txt')

Delete Attachment

fields

[required]

• attachment_id - Attachment ID

examples

# delete attachment
easyqa.delete_attachment(attachment_id=12)

Organization

Get Organization

Get organizations

# get all your organizations
easyqa.get_organizations()

Get organization by id

fields

[required]

• id - Organization ID

examples

# get one organization by id
easyqa.show_organization(id)

Create organization

fields

[required]

• title - Organization title

[optional]

• description - Organization description

examples

# create one organization 
easyqa.create_organization(title='Test')

# create one organization with optional fields
easyqa.create_issue(title='Test', description='test description')

Update organization

fields

[required]

• id - Organization id

[optional]

• title - Organization title
• description - Organization description

examples

# update one organization 
easyqa.update_organization(id=1, title='Test', description='test description')

Delete organization

fields

[required]

• id - Organization id

examples

# delete one organization
easyqa.delete_organization(id=2)

Project

Get Project

Get all your Projects

# get all your projects
easyqa.get_projects()

Get project by id

fields

[required]

• id - Projects ID

examples

# get one project by id
easyqa.show_project(id)

Create project

fields

[required]

• org_id - Organization id
• title - Project title

examples

# create one project 
easyqa.create_project(org_id=1, title='Test')

Update project

fields

[required]

• org_id - Organization id

[optional]

• title - Project title

examples

# update one project 
easyqa.update_project(org_id=1, title='updated project')

Delete project

fields

[required]

• id - Project id

examples

# delete one project
easyqa.delete_project(id=2)

Roles

Get Roles

fields

[required]

• organization_id - Organization id

examples

# get all roles from organizations
easyqa.get_roles(organization_id=1)

Get role by id

fields

[required]

• id - Role ID

examples

# get one organization by id
easyqa.show_role(id=1)

Create organization role

fields

[required]

• organization_id - Organization id
• user_id - User id
• role - Role (available: 'user', 'admin')

examples

# create organization role
easyqa.create_organization_role(organization_id=1, user_id=12, role='user')

Create project role

fields

[required]

• organization_id - Organization id
• user_id - User id
• role - Role (available: 'developer', 'tester', 'viewer', 'project_manager')

examples

# create project role
easyqa.create_project_role(organization_id=1, user_id=12, role='tester')

Update project role

fields

[required]

• id - role id
• role - Role (available: 'developer', 'tester', 'viewer', 'project_manager')

examples

# update project role
easyqa.update_project_role(id=2, role='tester')

Delete project role

fields

[required]

• id - role id

examples

# delete project role
easyqa.delete_role(id=2)

Test cases

Get Test cases

fields

[required]

• test_module_id - Test module ID

examples

# get all test cases from module
easyqa.get_test_cases(test_module_id=1)

Get test case by id

fields

[required]

• id - Test case ID

examples

# get one test case by id
easyqa.show_test_case(id=1)

Create test case

fields

[required]

• test_module_id - Test module ID
• title - Title of the test case

[optional]

• test_case - Test case attributes
• pre_steps - Pre steps to test case
• steps - Steps to test case
• expected_result - Expected test case result
• case_type - Type of test case

examples

# create test case
easyqa.create_test_case(test_module_id=1, title='test', steps='1. Sit in a Vulture Droid\n 2. Go to Lothal')

Update test case

fields

[required]

• id - Test case ID
• title - Title of the test case

[optional]

• test_case - Test case attributes
• pre_steps - Pre steps to test case
• steps - Steps to test case
• expected_result - Expected test case result
• case_type - Type of test case

examples

# update test case
easyqa.update_test_case(test_module_id=1, title='test', pre_steps='1. Sit in a Vulture Droid\n 2. Go to Lothal')

Delete test case

fields

[required]

• id - test case id

examples

# delete test case
easyqa.delete_test_case(id=2)

Statuses

Get Statuses

fields

examples

# get all statuses
easyqa.get_statuses()

Get status by id

fields

[required]

• id - Status id

examples

# get one status by id
easyqa.show_statuses(id=1)

Create status

fields

[required]

• name - Status name

examples

# create status
easyqa.create_status(name='synthesizing')

Update status

fields

[required]

• name - Status name
• id - Status id

examples

# update status
easyqa.update_status(id=4, name='synthesizing')

Delete status

fields

[required]

• id - Status id

examples

# delete status
easyqa.delete_status(id=2)

Test Modules

Get Test Modules

fields

[required]

• test_plan_id - ID of test plan

examples

# get all test module from test plan
easyqa.get_test_modules(test_plan_id=1)

Get test module by id

fields

[required]

• id - Test module id

examples

# get one test module by id
easyqa.show_test_module(id=1)

Create test module

fields

[required]

• test_plan_id - ID of test plan
• title - Title of the test module

[optional]

• description - Description of the test module
• test_module - Test module attributes
• parent_id - Id of parent test module (If you give this parameter, this test module will be nested in parent test module)

examples

# create test module
easyqa.create_test_module(test_plan_id=1, title='test', description='Super module')

Update test module

fields

[required]

• id - Test module id
• title - Title of the test module

[optional]

• description - Description of the test module
• test_module - Test module attributes
• parent_id - Id of parent test module (If you give this parameter, this test module will be nested in parent test module)

examples

# update test module
easyqa.update_test_module(test_plan_id=1, title='test', description='Super module2')

Delete test module

fields

[required]

• id - test module id

examples

# delete test module
easyqa.delete_test_module(id=2)

Test Plan

Get Test Plan

examples

# get all test plans from project
easyqa.get_test_plans()

Get Test Plan by id

fields

[required]

• id - test_plan id

examples

# get Test Plan by id from project
easyqa.show_test_plan(id=3)

Create test plan

fields

[required]

• title - Title of the test plan

[optional]

• description - Description of the test plan

examples

# create test plan
easyqa.create_test_plan(title='test', description='Super test plan')

Update test plan

fields

[required]

• id - Test plan id
• title - Title of the test plan

[optional]

• description - Description of the test plan

examples

# update test plan
easyqa.update_test_plan(id=2, title='test', description='Super test plan')

Delete test plan

fields

[required]

• id - Test plan id

examples

# delete test plan
easyqa.delete_test_plan(id=2)

Test Object

Get Test Object

examples

# get all test objects from project
easyqa.get_test_objects()

Get Test Object by id

fields

[required]

• id - test object id

examples

# get Test Object by id from project
easyqa.show_test_object(id=3)

Create test object link

fields

[required]

• link - Your link to site

examples

# create test object link
easyqa.create_test_object_link(link='http://champlin.info')

Create test object file

fields

[required]

• build_file - Path to ipa or apk file

examples

# create test object link
    easyqa.create_test_object_file(build_file='one.apk')

Delete test object

fields

[required]

• id - Test object id

examples

# delete test object
easyqa.delete_test_object(id=2)

Test Run

Get Test Runs

examples

# get all test runs from project
easyqa.get_test_runs()

Get Test run by id

fields

[required]

• test_run_id - test run id

examples

# get Test run by id from project
easyqa.show_test_run(test_run_id=3)

Create test run

fields

[required]

• title - Title of the test run

[optional]

• description - Description of the test run
• test_run_results_attributes - Attributes of test cases. If you want include they to this test run
• ...

examples

# create test run
easyqa.create_test_run(title='Run')

Update test run

fields

[required]

• id - Test run id
• title - Title of the test run

[optional]

• description - Description of the test run
• test_run_results_attributes - Attributes of test cases. If you want include they to this test run
• ...

examples

# update test run
easyqa.update_test_run(title='Run')

Delete test run

fields

[required]

• id - Test run id

examples

# delete test run
easyqa.delete_test_run(id=2)

Test Run result

Get Test Run result from test run

fields

[required]

• test_run_id - test run id

examples

# get all test run result from test run
easyqa.get_test_run_results(test_run_id=12)

Get Test run result by id

fields

[required]

• test_run_result_id - test run result id

examples

# get Test run result by id from test run
easyqa.show_test_run_result(test_run_result_id=3)

Update test run result

fields

[required]

• test_run_results_id - Test run result id

[optional]

• result_status - Status of test run results, might be in "pass", "block", "untested" and "fail"
• test_case_id - Test case id

examples

# update test run result
easyqa.update_test_run_result(test_run_results_id=21, test_case_id=12)

Delete test run results

fields

[required]

• id - Test run result id

examples

# delete test run results
easyqa.delete_test_run_result(id=2)