enriquegh / testobject-python-api

TestObject Python client library

testobject-python-api

NOTE: This project is now archived. Please consider using Sauce Labs' Unified Platform instead.

A Python library client for TestObject API

For more on the API you can visit TestObject's docs here.

Getting Started

Installing

To install on your machine run:

pip install testobject

Once installed you can run something like:

import testobject
client = testobject.TestObject('myusername','my_api_key', password='password')
# Password only needed if using Session Reports
response = client.devices.get_devices()
devices = response.json()
us_devices = devices['US']

Running the tests

Tests are done with pytest. To run these simply run:

pytest

Docs

Get All Devices

response = client.devices.get_devices()
devices = response.json()
us_devices = devices['US']

Get Available Devices

response = client.devices.get_available_devices()
devices = response.json()
us_devices = devices['US']

Get Device

response = client.devices.get_device('iPhone_5_free')
device = response.json()

Get Session Reports

response = client.devices.get_session_reports(last_days=30, offset=1, limit=50)
reports = response.json()

Update Appium Suite

data = {}
data['title'] = "New Suite Title"
response = client.suites.update_suite(suite_number,data)
content = response.json()

Start Appium Suite Report

report = {'className': 'TOTestClass', 'dataCenterId': 'US', 'methodName': 'testMethod', 'deviceId': 'iPhone_5_free'}
data = [report] # If more than one test and/or class add more reports to the data list
response = to.suites.start_suite(suite_number, data)
content = response.json()

Stop Appium Suite Report

response = to.suites.stop_suite(suite_number, suite_report_number)
content = response.json()

Stop Appium Suite Test

response = to.suites.stop_suite_test(suite_number, suite_report_number, suite_test_number, True)
content = response.json()

Skip Appium Suite Test

response = to.suites.stop_suite_test(suite_number, suite_report_number, suite_test_number)
content = response.json()

Skip Appium Test Report

response = to.watcher.skip_test_report(appium_session_id)

Send Appium Test Report

response = to.watcher.report_test_result(appium_session_id,True)

Upload Application to Project

response = to.storage.upload_app(upload_app_path, display_name, False)

Get Test Report

response = to.reports.get_test_report(test_report_id)

Get Screenshot

response = to.reports.get_screenshot(test_report_id, screenshot_id)

Get Session Video

response = to.reports.get_video(video_id)

Get Appium Log

response = to.reports.get_appium_log(test_report_id)

Get Device Log

response = to.reports.get_device_log(test_report_id)

Get Device Vitals Log

response = to.reports.get_vitals_log(test_report_id)

Get XCUITest Log

response = to.reports.get_xcuitest_log(test_report_id)

Authors

• Enrique Gonzalez - Maintainer - enriquegh

License

This project is licensed under the MIT License - see the LICENSE file for details

testobject-python-api's Issues

Add upload to storage endpoint

See here.

Fix requests deprecation warning

Something about how requests are being sent isn't liked by the requests package.
Example:
https://ci.appveyor.com/project/enriquegh/testobject-python-api/builds/21760290

Make request method return a Response object rather than just json

This makes the wrapper for flexible and gives the user more things to do with whatever TO is sending. Another big reason is that one of the watcher methods doesn't respond with any content and this breaks the request logic since it can't parse the text into json.

Get TestObject reports through wrapper API

As of now, in the wrapper API, we do not have a way to capture reports of devices (rest/v1/devices/reports).

This issue is to track the functionality to implement the same.