QLTY Framework

Welcome to the QLTY Framework documentation!

This documentation site provides helpful information on how to set up your environment, common troubleshooting and most important: API documentation for the entire library!

This project is under constant development and we will do our best effort to keep documentation up to date.

Getting Started

• Environment setup
  • Quick Start (Automated Installation)
  • Manual Installation
  • Appium installation
  • Android studio installation
  • Xcode installation
• Running tests
  • Test execution
  • Configuration with local_settings.py
  • Command line arguments
  • ChromeDriver Management

Guides

• QLTY for mobile browsers
  • Command line platform option
  • Running appium with chromedriver auto download
  • Code organization
  • Mobile browser capabilities
• Extending documentation
  • Sphinx and reStructuredText
  • Documentation structure
  • Build the documentation
  • Clean build
  • How to document your code
  • Adding new modules to documentation
  • Customizing the theme
• Saucelabs integration
  • Configuration
  • Special capabilities
  • Tunneling
• Managed drivers
  • Tests organization
  • Creating a new driver
  • Instantiating your controllers
  • Terminating your drivers

API Documentation

• Core
  • Test reporter
  • Test runner utils
  • QLTY test case
• API
• Integrations
  • Slack integration
    • SlackIntegration
      • SlackIntegration.__init__()
      • SlackIntegration._create_payload()
      • SlackIntegration._get_button_blocks()
      • SlackIntegration._get_environment_url()
      • SlackIntegration._get_platform_emoji()
      • SlackIntegration._post_results()
      • SlackIntegration.report()
  • Saucelabs integration
    • SaucelabsHelper
      • SaucelabsHelper.get_saucelabs_appium_remote()
      • SaucelabsHelper.post_result()
  • TestRail integration
    • TestRailIntegration
      • TestRailIntegration.__init__()
      • TestRailIntegration._test_connection()
      • TestRailIntegration.add_attachment_to_result()
      • TestRailIntegration.add_result_for_case()
      • TestRailIntegration.create_test_run()
      • TestRailIntegration.resolve_case_ids()
      • TestRailIntegration.update_run()
  • Mailtrap integration
    • MailtrapIntegration
      • MailtrapIntegration.BASE_URL
      • MailtrapIntegration.__init__()
      • MailtrapIntegration._extract_verification_link()
      • MailtrapIntegration._get_message_content()
      • MailtrapIntegration._get_messages()
      • MailtrapIntegration.get_emails_for_recipient()
      • MailtrapIntegration.get_verification_link()
• Selenium
  • Selenium operations
    • SeleniumOperations
      • SeleniumOperations.__init__()
      • SeleniumOperations._bool_click()
      • SeleniumOperations._swipe_android()
      • SeleniumOperations._swipe_ios()
      • SeleniumOperations._text_to_be_present_in_elements()
      • SeleniumOperations.browser_tap()
      • SeleniumOperations.drag_and_drop()
      • SeleniumOperations.drag_and_drop_by_offset()
      • SeleniumOperations.driver
      • SeleniumOperations.get_current_url()
      • SeleniumOperations.get_element()
      • SeleniumOperations.get_elements()
      • SeleniumOperations.swipe()
      • SeleniumOperations.swipe_until_visible()
      • SeleniumOperations.switch_to_new_window()
      • SeleniumOperations.tap()
      • SeleniumOperations.tap_android_button()
      • SeleniumOperations.tap_element_at()
      • SeleniumOperations.try_fetch()
      • SeleniumOperations.wait_for()
      • SeleniumOperations.wait_for_element_to_be_visible()
      • SeleniumOperations.wait_for_element_to_not_be_visible()
      • SeleniumOperations.wait_for_text_in_elements()
  • Web element operations
    • WebElementOperations
      • WebElementOperations.__init__()
      • WebElementOperations._scroll_into_view()
      • WebElementOperations._wait_for_dropdown_option()
      • WebElementOperations.controller
      • WebElementOperations.op_browser_tap()
      • WebElementOperations.op_click_element()
      • WebElementOperations.op_get_element()
      • WebElementOperations.op_get_element_enabled()
      • WebElementOperations.op_get_element_text()
      • WebElementOperations.op_get_element_value()
      • WebElementOperations.op_get_element_visibility()
      • WebElementOperations.op_get_elements()
      • WebElementOperations.op_get_selected_dropdown_text()
      • WebElementOperations.op_is_checkbox_checked()
      • WebElementOperations.op_scroll_to_element()
      • WebElementOperations.op_select_dropdown_by_text()
      • WebElementOperations.op_select_dropdown_by_value()
      • WebElementOperations.op_set_checkbox()
      • WebElementOperations.op_swipe_until_visible()
      • WebElementOperations.op_wait_for_element_to_be_visible()
      • WebElementOperations.op_wait_for_element_to_not_be_visible()
      • WebElementOperations.op_wait_for_text_in_elements()
• QLTY Utilities
  • Argument parser
    • QLTYArgumentParser
      • QLTYArgumentParser.__init__()
      • QLTYArgumentParser._parse_arguments()
      • QLTYArgumentParser._prepare_arguments()
      • QLTYArgumentParser._print_arguments()
      • QLTYArgumentParser._validate_arguments()
  • Selenium utilities
    • ensure_chromedriver()
    • get_desktop_webdriver()
    • initialize_driver()
    • perform_action_on_picker_wheel()
    • perform_tap_back()
    • perform_tap_based_on_cords()
    • perform_tap_location()
    • switch_to_native_context()
    • wait_for_web_context()
  • Utilities
    • ANDROID_SWIPE_OFFSETS
    • BUILD_ID
    • CURRENT_TEST_RUN_ID
    • IOS_SWIPE_OFFSETS
    • dump_logs()
    • dump_screenshot()
    • dump_test_results()
    • exists()
    • get_unique_build_id()
    • get_uuid()
    • is_browser_run()
    • setup_logger()
  • Configuration
    • CURRENT_ENVIRONMENT
    • CURRENT_PLATFORM
    • DESKTOP_BROWSER
    • EXCLUDE_TAG
    • EXCLUDE_TESTS
    • HEADLESS
    • INCLUDE_TAG
    • MANAGED_DRIVERS
    • MOBILE_BROWSER
    • PROJECT_FRIENDLY_NAME
    • REPORT_ON_FAIL
    • RUNNING_ON_JENKINS
    • SAUCELABS_INTEGRATION
    • SINGLE_TEST_NAME
    • SLACK_REPORTING
    • TESTRAIL_INTEGRATION