Toolium

Toolium is a Python wrapper tool of Selenium, Playwright and Appium libraries to test web and mobile applications in a single project. It provides a way of choosing and configuring the driver through a configuration file, implements a Page Object pattern and includes a simple visual testing solution.

Getting Started

Run pip install toolium to install the latest version from PyPi. It’s highly recommended to use a virtualenv.

The main dependencies are:

• Selenium: to test web applications in major browsers (Firefox, Chrome, Internet Explorer, Edge or Safari)

• Playwright: to test web applications in major browsers (Firefox, Chrome, Edge or Safari) as an alternative to Selenium (Beta integration in toolium)

• Appium-Python-Client: to test mobile applications (native, hybrid or web) in Android or iOS devices/emulators.

• requests: to test APIs

You might need to adjust the Selenium and Appium-Python-Client versions in your project. In that case, follow the compatibility matrix

Using toolium-template

The easiest way to get started is to clone toolium-template project, run the example test and add your own tests and configuration.

$ git clone git@github.com:Telefonica/toolium-template.git
$ cd toolium-template
$ pip install -r requirements.txt

Now, just follow the toolium-template instructions to know how to start your testing project.

Running toolium-examples

You can also clone toolium-examples to get more examples about how to use the library to test web, Android or iOS applications, in different scenarios.

$ git clone git@github.com:Telefonica/toolium-examples.git
$ cd toolium-examples
$ pip install -r requirements.txt

Now, just follow the toolium-examples instructions to run the test examples.

Contributing

If you want to collaborate in Toolium development, feel free to fork it and create a pull request.

Then clone the repository and install the dependencies in your virtualenv:

$ git clone git@github.com:<your_github_user>/toolium.git
$ cd toolium
$ pip install -r requirements.txt
$ pip install -r requirements_dev.txt

Before submitting your changes, make sure the code follows the project’s style by running Ruff:

$ ruff check --fix .    # Fix linting issues
$ ruff format .         # Format code

Then run the unit tests:

$ python -m pytest

Finally, before accepting your contribution, we need you to sign our Contributor License Agreement and send it to ruben.gonzalezalonso@telefonica.com.

Main Features

• Choosing driver through a configuration file

• Page Object pattern

• Tests runners integration

• AI utils

• Visual testing solution

• Tests result analysis

Library Reference

• toolium packages
  • behave
    • environment
  • pageelements
    • page_element
    • button_page_element
    • checkbox_page_element
    • group_page_element
    • input_radio_page_element
    • input_text_page_element
    • link_page_element
    • select_page_element
    • text_page_element
    • page_elements
      • Playwright pageelements
  • pageobjects
    • page_object
    • common_object
      • CommonObject
    • mobile_page_object
  • utils
    • dataset
    • download_files
    • driver_utils
    • driver_wait_utils
    • path_utils
      • get_valid_filename()
      • makedirs_safe()
    • poeditor
  • ai_utils
    • accuracy
    • openai
      • openai_request()
    • prompt_injection
    • text_similarity
      • assert_text_similarity()
      • get_text_similarity_with_azure_openai()
      • get_text_similarity_with_openai()
      • get_text_similarity_with_sentence_transformers()
      • get_text_similarity_with_spacy()
    • text_readability
      • assert_text_readability()
      • get_text_readability_with_spacy()
• toolium modules
  • config_driver
  • config_files
    • ConfigFiles
      • ConfigFiles.set_config_directory()
      • ConfigFiles.set_config_log_filename()
      • ConfigFiles.set_config_properties_filenames()
      • ConfigFiles.set_output_directory()
      • ConfigFiles.set_output_log_filename()
      • ConfigFiles.set_visual_baseline_directory()
  • config_parser
    • ExtendedConfigParser
      • ExtendedConfigParser.deepcopy()
      • ExtendedConfigParser.get()
      • ExtendedConfigParser.get_config_from_file()
      • ExtendedConfigParser.get_optional()
      • ExtendedConfigParser.getboolean_optional()
      • ExtendedConfigParser.has_option()
      • ExtendedConfigParser.items()
      • ExtendedConfigParser.options()
      • ExtendedConfigParser.optionxform()
      • ExtendedConfigParser.remove_option()
      • ExtendedConfigParser.set()
      • ExtendedConfigParser.translate_config_variables()
      • ExtendedConfigParser.update_properties()
      • ExtendedConfigParser.update_toolium_system_properties()
  • driver_wrapper
  • driver_wrappers_pool
    • DriverWrappersPool
      • DriverWrappersPool.add_wrapper()
      • DriverWrappersPool.capture_screenshots()
      • DriverWrappersPool.close_drivers()
      • DriverWrappersPool.config_directory
      • DriverWrappersPool.configure_common_directories()
      • DriverWrappersPool.configure_visual_directories()
      • DriverWrappersPool.connect_default_driver_wrapper()
      • DriverWrappersPool.download_videos()
      • DriverWrappersPool.driver_wrappers
      • DriverWrappersPool.get_configured_value()
      • DriverWrappersPool.get_default_config_directory()
      • DriverWrappersPool.get_default_wrapper()
      • DriverWrappersPool.initialize_config_files()
      • DriverWrappersPool.is_empty()
      • DriverWrappersPool.logs_directory
      • DriverWrappersPool.output_directory
      • DriverWrappersPool.remove_drivers()
      • DriverWrappersPool.save_all_ggr_logs()
      • DriverWrappersPool.save_all_webdriver_logs()
      • DriverWrappersPool.save_all_webdriver_or_ggr_logs()
      • DriverWrappersPool.screenshots_directory
      • DriverWrappersPool.screenshots_number
      • DriverWrappersPool.stop_drivers()
      • DriverWrappersPool.videos_directory
      • DriverWrappersPool.videos_number
      • DriverWrappersPool.visual_baseline_directory
      • DriverWrappersPool.visual_number
      • DriverWrappersPool.visual_output_directory
  • jira
  • pytest_fixtures
  • selenoid
    • Selenoid
      • Selenoid.download_file()
      • Selenoid.download_session_log()
      • Selenoid.download_session_video()
      • Selenoid.get_selenoid_info()
      • Selenoid.get_selenoid_option()
      • Selenoid.is_the_session_still_active()
  • test_cases
  • visual_test

Indices and Tables

• Index

• Module Index

• Search Page