Writing Robot Framework tests for Plone

plone.app.robotframework provides Robot Framework-compatible tools and resources for writing functional Selenium-tests (including acceptance tests) for Plone CMS and its add-ons.

This documentation gives you everything to get started in writing and executing functional Selenium tests (including acceptance tests) for Plone or your own Plone add-on. We depend on two testing frameworks, Robot Framework and Selenium (with Selenium2Library), and our tools and resources provided in plone.app.robotframework.

Robot Framework is a generic test automation framework for acceptance testing and acceptance test-driven development (ATDD), even for behavior driven development (BDD). It has easy-to-use plain text test syntax and utilizes the keyword-driven testing approach. Selenium is a web browser automation framework that exercises the browser as if the user was interacting with the browser.

User keywords

plone.app.robotframework ships with the following user keyword libraries as resource files:

Each user keyword library can be included as a resource with Resource plone/app/robotframework/libraryname.rst in test suite *** Settings ***.

Remote keywords

Remote keywords are a special plone.app.robotframework-way to implement Plone-specific keyword in Python for e.g. creating Plone content in test setup keywords. plone.app.robotframework comes with the following remote keyword libraries:

All remote keywords above are included by including a special test fixture plone.app.robotframework.testing.REMOTE_LIBRARY_BUNDLE_FIXTURE in bases of the used functional testing fixture, and finally with Library  Remote ${PLONE_URL}/RobotRemote-command in test suite *** Settings ***.

See testing.py in plone.app.robotframework for how to create a custom remote library bundle fixture with only selected (or custom) remote keyword libraries.

Python keywords

In addition to user keywords and remote libraries, plone.app.robotframeworks provides the following generic Python keyword libraries (their code is not dependent on Plone code base).

Each Python keyword library can be included as with Library plone.app.robotframework.LibraryClassName in test suite `*** Settings ***.

Old tutorials


While these tutorials are still useful for gettings started with Robot Framework testing for Plone, these may contain outdated instructions!