|
RobotTestingFramework
2.0.1
Robot Testing Framework
|
Test cases can be written using Python scripting language (e.g., .py) to be loaded and executed as separate plug-ins. This allows to have a simple test runner which loads and run the tests at run time without any needs to recompile the test runner. Using a simple example, we show how this can be done.
'examples/python-plugin' folder within the Robot Testing Framework project directory.
You need the Python development library to use the plug-ins. On most of the Linux distribution it can be easily installed using the package manager (e.g., $ sudo apt-get install python-dev). If you use Windows, try Python Releases for Windows. OSX users can also follow the instruction from http://docs.python-guide.org/en/latest/starting/install/osx/.
After installing the Python development package, you need to enable the Python plug-in system in the Robot Testing Framework and recompile it:
$ cd robot-testing-framework/build $ cmake ../ -DENABLE_PYTHON_PLUGIN=ON
Writing test cases in Python is simple. All you need is to declare a TestCase class and implement your test functional code inside the run() method. The setup() and tearDown() can be also optionally defined to setup or tear down the user defined fixture. By default, the name of the test case is the name of its plug-in file. This cane be changed by using using setName().
''' robottestingframework module is automatically imported by the python plugin loader to invoke the corresponding test case methods. To develop a new test case simply implement the following class; (setup and tearDown methods are optional) : class TestCase: def setup(self, param): return True def run(self): def tearDown(self): The following methods are for reporting, failure or assertions: robottestingframework.setName(name) : sets the test name (defualt is the test filename) robottestingframework.testReport(msg) : reports a informative message robottestingframework.testCheck(condition, msg) : reports the test message and marks the test as failed if condition is false robottestingframework.assertError(msg) : throws an error exception with message robottestingframework.asserFail(msg) : throws a failure exception with message ''' class TestCase: # setup is called before the test's run to setup # the user defined fixture # @return Boolean (True/False uppon success or failure) def setup(self, param): robottestingframework.testReport("Preparing setup...") return True # The implementation of the test goes here def run(self): robottestingframework.testCheck(5>3, "5 is bigger than 3.") robottestingframework.testCheck(5<3, "5 is smaller than 3.") # tearDown is called after the test's run to tear down # the user defined fixture def tearDown(self): robottestingframework.testReport("Tearing down...")
robottestingframework-testrunner utility (see Running test case plug-ins using robottestingframework-testrunner) already implemented in Robot Testing Framework which does the job for you. However, the following example is just for your reference and to understand better how a Python test plug-ing can be loaded and executed from the code.Your plug-in is ready and can be simply executed using the robottestingframework-testrunner utility. However, we show how to use robottestingframework::PythonPluginLoader to develop a simple test runner for loading the plug-in and running the test. It is quite simple. First create an instance of robottestingframework::plugin::PythonPluginLoader class and call its open() method with the plug-in library (i.e., .py) filename as its parameter. The robottestingframework::plugin::PythonPluginLoader loads the library and returns a pointer to the robottestingframework::TestCase implemented into the plug-in. If the Python plug-in cannot be loaded or it is not an Robot Testing Framework plug-in file, the robottestingframework::plugin::PythonPluginLoader::open() returns a null pointer and the error message can be gotten using robottestingframework::plugin::PythonPluginLoader::getLastError(). When you have an instance of your test case, it can be used to run the test as usual (see Some examples if you are not familiar with running a test case). In the following example we use a robottestingframework::TestRunner to execute our test:
Now you can compile and build the the runner. There is a CMake file in the examples/python-plugin folder which helps you to compile and build your simple test runner. Make sure that RobotTestingFramework_DIR environment variable is correctly set to point your Robot Testing Framework build or installed directory so that CMake can find the required modules to configure the project.
Now you can build and run the test as follows:
$ cd examples/python-plugin; mkdir build $ cd build; cmake ../; make; $ ./simple_run ../mytest.py Loading the plugin... Starting test runner. Test case started... [INFO] (mytest.lua) reports: Preparing setup... [INFO] (mytest.lua) checks: 5 is bigger than 3 [FAIL] (mytest.lua) checks: 5 is less than 3 [INFO] (mytest.lua) reports: Tearing down... Test case MyTest failed! Ending test runner.
1.8.13