https://github.com/kpn/py-detox-bridge

A bridge to enable python code to use the detox grey-box testing API
https://github.com/kpn/py-detox-bridge

detox e2e-tests test testing

Last synced: 2 months ago
JSON representation

A bridge to enable python code to use the detox grey-box testing API

• Host: GitHub
• URL: https://github.com/kpn/py-detox-bridge
• Owner: kpn
• License: other
• Created: 2017-07-04T10:06:57.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2023-08-04T14:13:01.000Z (over 1 year ago)
• Last Synced: 2024-10-05T22:17:45.619Z (3 months ago)
• Topics: detox, e2e-tests, test, testing
• Language: Python
• Homepage:
• Size: 2.48 MB
• Stars: 4
• Watchers: 3
• Forks: 2
• Open Issues: 2
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
Detox Python Bridge

===========================

.. image:: https://github.com/kpn-digital/py-detox-bridge/workflows/Build%20&%20test%20py-detox-bridge-workflow/badge.svg

    :target:  https://github.com/kpn-digital/py-detox-bridge/actions

.. image:: https://img.shields.io/codecov/c/github/kpn-digital/py-detox-bridge/master.svg

    :target: http://codecov.io/github/kpn-digital/py-detox-bridge?branch=master

.. image:: https://img.shields.io/pypi/v/detox-bridge.svg

    :target: https://pypi.python.org/pypi/detox-bridge

.. image:: https://readthedocs.org/projects/detox-bridge/badge/?version=latest

    :target: http://detox-bridge.readthedocs.org/en/latest/?badge=latest

A bridge to enable python code to use the detox grey-box testing API ( https://github.com/wix/detox )

Requirements

============

NVM

---

The package requires nvm to be installed. Either the NVM environment variable needs to contain the full path of the nvm.sh script, or

the NVM_DIR environment variable needs to point at the root directory of nvm containing the nvm.sh script.

NODE

----

The code emitted by this bridge requires node 7.6.0 or higher.

Python

------

3.7 is required to use the package.

Detox

-----

Follow the getting started guide from detox ( https://github.com/wix/detox/blob/master/docs/Introduction.GettingStarted.md )

Usage

=====

.. code:: python

   from detox_bridge import jsawait, by, detox, device, element, expect, node_with_detox

   app_path = "detox/examples/demo-react-native"

   # Start Node server in app_path root folder that contains node_modules

   with node_with_detox(app_path=app_path, default_timeout=10) as appserver:

       # Detox Config (we could also load this from package.json)

       ios_sim_release = {

           "binaryPath": "ios/build/Build/Products/Release-iphonesimulator/example.app",

           "type": "ios.simulator",

           "name": "iPhone 7 Plus"

       }

       configurations_obj = {"configurations": {"ios.sim.release": ios_sim_release}}

       # Longer timeout since the app may be installed

       appserver(jsawait(detox.init(configurations_obj)), timeout=360)

       # Reload react native

       appserver(jsawait(device.reloadReactNative()))

       # Expectation

       appserver(jsawait(expect(element(by.id('welcome'))).toBeVisible()))

       # Cleanup

       appserver(jsawait(detox.cleanup()))

Development

===========

Requirements

------------

Python 3.7 are required to run the suite suite.

Checkout

--------

After checkout run::

   make app_local_requirements

Running tests

-------------

To run the test suite::

    make test

Once the venv is there you can also run some tests via tox::

    venv/bin/tox -e py35 -- -k