telenium 0.3.0

Telenium

Telenium provide a framework to remote tests or control Kivy-based application:

• Selector support using XPATH-like syntax (//BoxLayout[0]/Button[@text~="Close"])

• Create selector by touching the UI

• Query or set attribute on any widgets

• Execute remote code

• unittests support

• Integrate as a Kivy modules

• Web IDE

• Python 2 (python-jsonrpc not compatible with Python 3 yet, working on it.)

Installation

pip install telenium

Run the Telenium IDE

It will start a webserver on http://127.0.0.1:8080/ and automatically open a new tab in your favorite webbrowser. You’ll be able to configure where your main.py is, and start writing tests directly:

telenium

You can also edit telenium-json:

telenium tests/test-ui-myfeature.json

Run the application with telenium module

If you don’t use the IDE, in order to remote control your application, you need the Telenium client installed within your application.

python -m telenium.execute main.py

from os.path import dirname
from kivy.modules import Modules
from kivy.config import Config
Modules.add_path(dirname(__file__))
Config.set("modules", "telenium_client", "")

Connect to a telenium-ready application

We have a command line client to play with. After the application is started, you can connect with:

::

$ python -m telenium.client

Then play with it. cli is the telenium client where you can invoke remote commands. See the Telenium commands to see what you can do:

>>> id = cli.pick() # then click somewhere on the UI
>>> cli.click_at(id)
True
>>> cli.setattr("//Label", "color", (0, 1, 0, 1))
True

If a command returns True, it means it has been successful, otherwise it returns None.

Create unit tests

Telenium have a module you can use that ease unit tests: it launch the app and execute tests. For now, it has been tested and coded to work only locally using subprocess.

Additionnal methods: - assertExists(selector, timeout=-1) and assertNotExists(selector, timeout=-1) to check if a selector exists or not in the app. They both have a timeout parameter that, if it reach, will fail the test. - cli.wait_click(selector, timeout=-1): easy way to wait a selector to match, then click on the first widget.

Here is a real example that launch an app (default is “main.py”):

• It first go in the menu to click where it need to save a CSV (SaveButton, CascadeSaveButton then SaveCSVButton)

• Then wait at maximum 2s the popup to show with a label “Export to CSV”

• Then click on the “Close” button in the popup

• Then ensure the popup is closed by checking the label is gone.

Example:

from telenium.tests import TeleniumTestCase

class UITestCase(TeleniumTestCase):
    def test_export_csv(self):
        self.cli.wait_click("//SaveButton")
        self.cli.wait_click("//CascadeSaveButton")
        self.cli.wait_click("//SaveCSVButton")
        self.assertExists("//Label[@text~=\"Export to CSV\"]", timeout=2)
        self.cli.wait_click("//FitButton[@text=\"Close\"]", timeout=2)
        self.assertNotExists("//Label[@text~=\"Export to CSV\"]", timeout=2)

Each new TeleniumTestCase will close and start the application, so you always run from a clean app. If you always need to do something before starting the test, you can overload the init. This will be executed once before any tests in the class starts:

class UITestCase(TeleniumTestCase):
    def init(self):
        self.cli.wait_click("//PresetSelectionItem[@text!~=\"ttyUSB0 on mintel\"]",
                           timeout=10)
        self.cli.wait_click("//Button[@text=\"Connect\"]")
        self.cli.wait("//BottomLabel[@text=\"Done\"]", timeout=10)

You can also change few parameters to change/add things in your application for unit testing if needed:

class UITestCase(TeleniumTestCase):
    process_start_timeout = 5
    cmd_env = {"I_AM_RUNNING_TEST": 1}

Telenium commands

>>> cli.select("//Label")
[u"/WindowSDL/GridLayout/Label[0]", u"/WindowSDL/GridLayout/Label[1]"]

>>> cli.getattr("//Label")
u"Hello world"

>>> cli.setattr("//Label", "text", "Plop")
True

>>> cli.element("//Label")
True
>>> cli.element("//InvalidButton")
False

>>> cli.execute("app.call_one_app_method")
True

>>> cli.pick()
u'/WindowSDL/Button[0]'
>>> cli.pick(all=True)
[u'/WindowSDL/Button[0]',u'/WindowSDL']

>>> cli.click_on("//Button[0]")
True

Telenium selector syntax (XPATH)

Cheat sheet about telenium XPATH-based selector implementation.

• Select any widget that match the widget class in the hierarchy: //CLASS

• Select a widget that match the tree: /CLASS

• Select a widget with attributes /CLASS[<ATTR SELECTOR>,...]

• Index selector if there is multiple match: /CLASS[INDEX]

• Attribute exists: @attr

• Attribute equal to a value: @attr=VALUE

• Attribute not equal to a value: @attr!=VALUE

• Attribute contain a value: @attr~=VALUE

• Attribute does not contain a value: @attr!~=VALUE

• Value can be a string, but must be escaped within double quote only.

Some examples:

# Select all the boxlayout in the app
//BoxLayout

# Take the first boxlayout
//BoxLayout[0]

# Get the Button as a direct descendant of the BoxLayout
//BoxLayout[0]/Button

# Or get the 5th Button that are anywhere under the BoxLayout (may or may
# not a direct descandant)
//BoxLayout[0]//Button

# Select the button that is written "Close"
//BoxLayout[0]//Button[@text="Close"]

# Select the button that contain "Close"
//BoxLayout[0]//Button[@text~="Close"]