Wrapper tool of Selenium and Appium libraries to test web and mobile applications in a single project
|Build Status| |Coverage Status| |CodeClimate| |Documentation Status|
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.
.. |Build Status| image:: https://github.com/Telefonica/toolium/workflows/build/badge.svg?branch=master :target: https://github.com/Telefonica/toolium/actions?query=branch%3Amaster .. |Documentation Status| image:: https://readthedocs.org/projects/toolium/badge/?version=latest :target: http://toolium.readthedocs.org/en/latest .. |Coverage Status| image:: https://coveralls.io/repos/Telefonica/toolium/badge.svg?branch=master&service=github :target: https://coveralls.io/github/Telefonica/toolium?branch=master .. |CodeClimate| image:: https://api.codeclimate.com/v1/badges/3e5773b2e5272b546f8a/maintainability :target: https://codeclimate.com/github/Telefonica/toolium/maintainability
Run pip install toolium to install the latest version from PyPi <https://pypi.org/project/toolium>_. It's
highly recommendable to use a virtualenv.
The main dependencies are:
Selenium <http://docs.seleniumhq.org/>_: to test web applications in major browsers (Firefox, Chrome, Internet
Explorer, Edge or Safari)Playwright <https://playwright.dev/>_: to test web applications in major browsers (Firefox, Chrome, Edge or Safari)
as an alternative to Selenium (Beta integration in toolium)Appium-Python-Client <https://github.com/appium/python-client>_: to test mobile applications (native, hybrid or web)
in Android or iOS devices/emulators.requests <http://docs.python-requests.org>_: to test APIsYou might need to adjust the Selenium and Appium-Python-Client versions in your project.
In that case follow the compatibility matrix <https://github.com/appium/python-client?tab=readme-ov-file#compatibility-matrix>_
Using toolium-template
The easiest way of getting started is to clone toolium-template <https://github.com/Telefonica/toolium-template>_
project, run the example test and add your own tests and configuration.
.. code:: console
$ git clone git@github.com:Telefonica/toolium-template.git
$ cd toolium-template
$ pip install -r requirements.txt
Now, just follow toolium-template instructions <https://github.com/Telefonica/toolium-template#running-tests>_ to know
how to start your testing project.
Running toolium-examples
You can also clone toolium-examples <https://github.com/Telefonica/toolium-examples>_ to get more examples about how
to use the library to test web, Android or iOS applications, in different scenarios.
.. code:: console
$ git clone git@github.com:Telefonica/toolium-examples.git
$ cd toolium-examples
$ pip install -r requirements.txt
Now, just follow toolium-examples instructions <https://github.com/Telefonica/toolium-examples#running-tests>_ to run
the examples of the tests.
If you want to collaborate in Toolium development, feel free of forking it <https://github.com/Telefonica/toolium>_
and asking for a pull request.
Don't forget to run unit tests:
.. code:: console
$ git clone git@github.com:<your_github_user>/toolium.git
$ cd toolium
$ pip install -r requirements.txt
$ pip install -r requirements_dev.txt
$ python -m pytest
Finally, before accepting your contribution, we need you to sign our
Contributor License Agreement <https://raw.githubusercontent.com/telefonicaid/Licensing/master/ContributionPolicy.txt>_
and send it to ruben.gonzalezalonso@telefonica.com.
Choosing driver through a configuration file <http://toolium.readthedocs.org/en/latest/driver_configuration.html>_Page Object pattern <http://toolium.readthedocs.org/en/latest/page_objects.html>_BDD integration <http://toolium.readthedocs.org/en/latest/bdd_integration.html>_Visual testing solution <http://toolium.readthedocs.org/en/latest/visual_testing.html>_Tests result analysis <http://toolium.readthedocs.org/en/latest/tests_result_analysis.html>_Further information about features and fixes included in each release: CHANGELOG <http://toolium.readthedocs.org/en/latest/changelog.html>_.
Complete library reference and documentation available at ReadTheDocs <http://toolium.readthedocs.org>_.
FAQs
Wrapper tool of Selenium and Appium libraries to test web and mobile applications in a single project
We found that toolium demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
OpenGrep has restored fingerprint and metavariable support in JSON and SARIF outputs, making static analysis more effective for CI/CD security automation.
Security News
Security experts warn that recent classification changes obscure the true scope of the NVD backlog as CVE volume hits all-time highs.
Security Fundamentals
Attackers use obfuscation to hide malware in open source packages. Learn how to spot these techniques across npm, PyPI, Maven, and more.