1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
|
/*
* Robot Testing Framework
*
* Copyright (C) 2015-2019 Istituto Italiano di Tecnologia (IIT)
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*/
/**
@page robottestingframework_ruby_plugin_example Using Ruby to develop test cases
\author Ali Paikan
<br>
\section ruby-desc Description
Test cases can be written using Ruby scripting language (e.g., .rb) 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.
\note The source code of the tutorial can be also found in the
\c 'examples/ruby-plugin' folder within the Robot Testing Framework project
directory.
<br>
\section ruby-req Requirements
You need the Ruby 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 ruby-dev`).
If you use Windows, try
<a href="https://http://rubyinstaller.org/">Ruby Installer for Windows</a>.
OSX users can also follow the instruction from
https://www.ruby-lang.org/en/downloads/
After installing the Ruby development package, you need to enable the Ruby
plug-in system in the Robot Testing Framework and recompile it:
\verbatim
$ cd robot-testing-framework/build
$ cmake ../ -DENABLE_RUBY_PLUGIN=ON
\endverbatim
<br>
\section ruby-write Writing the test case in Ruby.
Writing test cases in Ruby 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()`.
\htmlonly
<!-- HTML generated using hilite.me --><div style="background: #f8f8f8; overflow:auto;width:auto;border:solid gray;border-width:.1em .1em .1em .8em;padding:.2em .6em;"><pre style="margin: 0; line-height: 125%"><span style="color: #408080; font-style: italic"># Robot Testing Framework module is automatically imported by the ruby plugin loader</span>
<span style="color: #408080; font-style: italic"># to invoke the corresponding test case methods. To develop a new </span>
<span style="color: #408080; font-style: italic"># test case simply implement the following class; (setup and tearDown </span>
<span style="color: #408080; font-style: italic"># methods are optional) :</span>
<span style="color: #408080; font-style: italic">#</span>
<span style="color: #408080; font-style: italic"># class TestCase</span>
<span style="color: #408080; font-style: italic"># def setup(param)</span>
<span style="color: #408080; font-style: italic"># ...</span>
<span style="color: #408080; font-style: italic"># return true</span>
<span style="color: #408080; font-style: italic"># end</span>
<span style="color: #408080; font-style: italic">#</span>
<span style="color: #408080; font-style: italic"># def run ... end</span>
<span style="color: #408080; font-style: italic">#</span>
<span style="color: #408080; font-style: italic"># def tearDown ... end</span>
<span style="color: #408080; font-style: italic"># end</span>
<span style="color: #408080; font-style: italic">#</span>
<span style="color: #408080; font-style: italic"># The following methods are for reporting, failure or assertions: </span>
<span style="color: #408080; font-style: italic">#</span>
<span style="color: #408080; font-style: italic"># RobotTestingFramework::setName(name) : sets the test name (defualt is the test filename)</span>
<span style="color: #408080; font-style: italic"># RobotTestingFramework::testReport(msg) : reports a informative message</span>
<span style="color: #408080; font-style: italic"># RobotTestingFramework::testCheck(condition, msg) : reports the test message and marks the test as failed if condition is false</span>
<span style="color: #408080; font-style: italic"># RobotTestingFramework::assertError(msg) : throws an error exception with message</span>
<span style="color: #408080; font-style: italic"># RobotTestingFramework::asserFail(msg) : throws a failure exception with message</span>
<span style="color: #408080; font-style: italic">#</span>
<span style="color: #008000; font-weight: bold">class</span> <span style="color: #0000FF; font-weight: bold">TestCase</span>
<span style="color: #408080; font-style: italic"># setup is called before the test's run to setup </span>
<span style="color: #408080; font-style: italic"># the user defined fixture</span>
<span style="color: #408080; font-style: italic"># @return Boolean (True/False uppon success or failure)</span>
<span style="color: #008000; font-weight: bold">def</span> <span style="color: #0000FF">setup</span>(param)
<span style="color: #19177C">robottestingframework</span>:<span style="color: #19177C">:testReport</span>(<span style="color: #BA2121">"Preparing setup..."</span>)
<span style="color: #008000; font-weight: bold">return</span> <span style="color: #008000">true</span>
<span style="color: #008000; font-weight: bold">end</span>
<span style="color: #408080; font-style: italic"># The implementation of the test goes here</span>
<span style="color: #008000; font-weight: bold">def</span> <span style="color: #0000FF">run</span>
<span style="color: #19177C">robottestingframework</span>:<span style="color: #19177C">:testCheck</span>(<span style="color: #666666">5>3</span>, <span style="color: #BA2121">"5 is bigger than 3."</span>)
<span style="color: #19177C">robottestingframework</span>:<span style="color: #19177C">:testCheck</span>(<span style="color: #666666">5<3</span>, <span style="color: #BA2121">"5 is smaller than 3."</span>)
<span style="color: #008000; font-weight: bold">end</span>
<span style="color: #408080; font-style: italic"># tearDown is called after the test's run to tear down</span>
<span style="color: #408080; font-style: italic"># the user defined fixture</span>
<span style="color: #008000; font-weight: bold">def</span> <span style="color: #0000FF">tearDown</span>
<span style="color: #19177C">robottestingframework</span>:<span style="color: #19177C">:testReport</span>(<span style="color: #BA2121">"Tearing down..."</span>)
<span style="color: #008000; font-weight: bold">end</span>
<span style="color: #008000; font-weight: bold">end</span>
</pre></div>
\endhtmlonly
<br>
\section ruby-runner Writing the test runner
\note Basically you do not need to develop a test runner.
There is the \c robottestingframework-testrunner utility (see
\ref 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 Ruby test plug-ing can be loaded and executed from the code.
Your plug-in is ready and can be simply executed using the
\c robottestingframework-testrunner utility.
However, we show how to use \c RobotTestingFramework::RubyPluginLoader to
develop a simple test runner for loading the plug-in and running the test.
It is quite simple.
First create an instance of \c RobotTestingFramework::plugin::RubyPluginLoader
class and call its \c open() method with the plug-in library (i.e., .rb)
filename as its parameter.
The \c RobotTestingFramework::plugin::RubyPluginLoader loads the library and
returns a pointer to the \c RobotTestingFramework::TestCase implemented into the
plug-in.
If the Ruby plug-in cannot be loaded or it is not an Robot Testing Framework
plug-in file, the \c RobotTestingFramework::plugin::RubyPluginLoader::open()
returns a null pointer and the error message can be gotten using
\c RobotTestingFramework::plugin::RubyPluginLoader::getLastError().
When you have an instance of your test case, it can be used to run the test as
usual (see \ref robottestingframework_examples if you are not familiar with
running a test case).
In the following example we use a \c RobotTestingFramework::TestRunner to
execute our test:.
\include ruby-plugin/run.cpp
<br>
\section ruby-build Building the test runner and run the test.
Now you can compile and build the the runner.
There is a CMake file in the \c examples/ruby-plugin folder which helps you to
compile and build your simple test runner.
Make sure that \c 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.
\include ruby-plugin/CMakeLists.txt
<br>
Now you can build and run the test as follows:.
\verbatim
$ cd examples/ruby-plugin; mkdir build
$ cd build; cmake ../; make;
$ ./simple_run ../mytest.rb
Loading the plugin....
Starting test runner.
Test case started...
[INFO] (mytest.rb) reports: Preparing setup...
[INFO] (mytest.rb) checks: 5 is bigger than 3.
[FAIL] (mytest.rb) checks: 5 is smaller than 3.
[INFO] (mytest.rb) reports: Tearing down...
Test case MyTest failed!
Ending test runner.
\endverbatim
*/
|
